Merge pull request #6076 from backstage/rugvip/allreports

scripts/api-extractor: create and check API reports for all(most) plugins
2021-06-17 15:46:11 +02:00
parent 79a5fc65a8 d8d7226fce
commit 820de63018
55 changed files with 5261 additions and 22 deletions
@@ -0,0 +1,186 @@
+## API Report File for "@backstage/plugin-lighthouse"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { ApiRef } from '@backstage/core';
+import { BackstagePlugin } from '@backstage/core';
+import { Config } from '@backstage/config';
+import { Entity } from '@backstage/catalog-model';
+import { InfoCardVariants } from '@backstage/core';
+import { RouteRef } from '@backstage/core';
+
+// @public (undocumented)
+export type Audit = AuditRunning | AuditFailed | AuditCompleted;
+
+// @public (undocumented)
+export interface AuditCompleted extends AuditBase {
+    // (undocumented)
+    categories: Record<LighthouseCategoryId, LighthouseCategoryAbbr>;
+    // (undocumented)
+    report: Object;
+    // (undocumented)
+    status: 'COMPLETED';
+    // (undocumented)
+    timeCompleted: string;
+}
+
+// @public (undocumented)
+export interface AuditFailed extends AuditBase {
+    // (undocumented)
+    status: 'FAILED';
+    // (undocumented)
+    timeCompleted: string;
+}
+
+// @public (undocumented)
+export interface AuditRunning extends AuditBase {
+    // (undocumented)
+    status: 'RUNNING';
+}
+
+// @public (undocumented)
+export const EmbeddedRouter: (_props: Props) => JSX.Element;
+
+// @public (undocumented)
+export const EntityLastLighthouseAuditCard: ({ dense, variant, }: {
+    dense?: boolean | undefined;
+    variant?: InfoCardVariants| undefined;
+}) => JSX.Element;
+
+// @public (undocumented)
+export const EntityLighthouseContent: (_props: {
+    entity?: Entity| undefined;
+}) => JSX.Element;
+
+// @public (undocumented)
+export class FetchError extends Error {
+    // (undocumented)
+    static forResponse(resp: Response): Promise<FetchError>;
+    // (undocumented)
+    get name(): string;
+}
+
+// @public (undocumented)
+const isLighthouseAvailable: (entity: Entity) => boolean;
+
+export { isLighthouseAvailable }
+
+export { isLighthouseAvailable as isPluginApplicableToEntity }
+
+// @public (undocumented)
+export interface LASListRequest {
+    // (undocumented)
+    limit?: number;
+    // (undocumented)
+    offset?: number;
+}
+
+// @public (undocumented)
+export interface LASListResponse<Item> {
+    // (undocumented)
+    items: Item[];
+    // (undocumented)
+    limit: number;
+    // (undocumented)
+    offset: number;
+    // (undocumented)
+    total: number;
+}
+
+// @public (undocumented)
+export const LastLighthouseAuditCard: ({ dense, variant, }: {
+    dense?: boolean | undefined;
+    variant?: InfoCardVariants | undefined;
+}) => JSX.Element;
+
+// @public (undocumented)
+export type LighthouseApi = {
+    url: string;
+    getWebsiteList: (listOptions: LASListRequest) => Promise<WebsiteListResponse>;
+    getWebsiteForAuditId: (auditId: string) => Promise<Website>;
+    triggerAudit: (payload: TriggerAuditPayload) => Promise<Audit>;
+    getWebsiteByUrl: (websiteUrl: string) => Promise<Website>;
+};
+
+// @public (undocumented)
+export const lighthouseApiRef: ApiRef<LighthouseApi>;
+
+// @public (undocumented)
+export interface LighthouseCategoryAbbr {
+    // (undocumented)
+    id: LighthouseCategoryId;
+    // (undocumented)
+    score: number;
+    // (undocumented)
+    title: string;
+}
+
+// @public (undocumented)
+export type LighthouseCategoryId = 'pwa' | 'seo' | 'performance' | 'accessibility' | 'best-practices';
+
+// @public (undocumented)
+export const LighthousePage: () => JSX.Element;
+
+// @public (undocumented)
+const lighthousePlugin: BackstagePlugin<{
+    root: RouteRef<undefined>;
+    entityContent: RouteRef<undefined>;
+}, {}>;
+
+export { lighthousePlugin }
+
+export { lighthousePlugin as plugin }
+
+// @public (undocumented)
+export class LighthouseRestApi implements LighthouseApi {
+    constructor(url: string);
+    // (undocumented)
+    static fromConfig(config: Config): LighthouseRestApi;
+    // (undocumented)
+    getWebsiteByUrl(websiteUrl: string): Promise<Website>;
+    // (undocumented)
+    getWebsiteForAuditId(auditId: string): Promise<Website>;
+    // (undocumented)
+    getWebsiteList({ limit, offset, }?: LASListRequest): Promise<WebsiteListResponse>;
+    // (undocumented)
+    triggerAudit(payload: TriggerAuditPayload): Promise<Audit>;
+    // (undocumented)
+    url: string;
+}
+
+// @public (undocumented)
+export const Router: () => JSX.Element;
+
+// @public (undocumented)
+export interface TriggerAuditPayload {
+    // (undocumented)
+    options: {
+        lighthouseConfig: {
+            settings: {
+                emulatedFormFactor: string;
+            };
+        };
+    };
+    // (undocumented)
+    url: string;
+}
+
+// @public (undocumented)
+export interface Website {
+    // (undocumented)
+    audits: Audit[];
+    // (undocumented)
+    lastAudit: Audit;
+    // (undocumented)
+    url: string;
+}
+
+// @public (undocumented)
+export type WebsiteListResponse = LASListResponse<Website>;
+
+
+// (No @packageDocumentation comment for this package)
+
+```