From a6560422c91cf26089900cea08c32b8525ac1409 Mon Sep 17 00:00:00 2001 From: Dominik Pfaffenbauer Date: Wed, 25 Jan 2023 16:19:58 +0100 Subject: [PATCH] update api-report Signed-off-by: Dominik Pfaffenbauer --- plugins/lighthouse/api-report.md | 156 +------------------------------ 1 file changed, 1 insertion(+), 155 deletions(-) diff --git a/plugins/lighthouse/api-report.md b/plugins/lighthouse/api-report.md index e9089c7e92..4ab851472a 100644 --- a/plugins/lighthouse/api-report.md +++ b/plugins/lighthouse/api-report.md @@ -7,50 +7,11 @@ import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; -import { Config } from '@backstage/config'; import { Entity } from '@backstage/catalog-model'; import { InfoCardVariants } from '@backstage/core-components'; +import { LighthouseApi } from '@backstage/plugin-lighthouse-common'; import { RouteRef } from '@backstage/core-plugin-api'; -// @public (undocumented) -export type Audit = AuditRunning | AuditFailed | AuditCompleted; - -// @public (undocumented) -export interface AuditBase { - // (undocumented) - id: string; - // (undocumented) - timeCreated: string; - // (undocumented) - url: string; -} - -// @public (undocumented) -export interface AuditCompleted extends AuditBase { - // (undocumented) - categories: Record; - // (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: () => JSX.Element; @@ -63,93 +24,20 @@ export const EntityLastLighthouseAuditCard: (props: { // @public (undocumented) export const EntityLighthouseContent: () => JSX.Element; -// @public (undocumented) -export class FetchError extends Error { - // (undocumented) - static forResponse(resp: Response): Promise; - // (undocumented) - get name(): string; -} - -// @public (undocumented) -export type FormFactor = 'mobile' | 'desktop'; - // @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 { - // (undocumented) - items: Item[]; - // (undocumented) - limit: number; - // (undocumented) - offset: number; - // (undocumented) - total: number; -} - // @public (undocumented) export const LastLighthouseAuditCard: (props: { dense?: boolean; variant?: InfoCardVariants; }) => JSX.Element; -// @public (undocumented) -export type LighthouseApi = { - url: string; - getWebsiteList: (listOptions: LASListRequest) => Promise; - getWebsiteForAuditId: (auditId: string) => Promise; - triggerAudit: (payload: TriggerAuditPayload) => Promise; - getWebsiteByUrl: (websiteUrl: string) => Promise; -}; - // @public (undocumented) export const lighthouseApiRef: ApiRef; -// @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 type LighthouseConfigSettings = { - formFactor: FormFactor; - screenEmulation: - | { - mobile: boolean; - width: number; - height: number; - deviceScaleFactor: number; - disabled: boolean; - } - | undefined; - emulatedFormFactor: FormFactor; -}; - // @public (undocumented) export const LighthousePage: () => JSX.Element; @@ -165,48 +53,6 @@ const lighthousePlugin: BackstagePlugin< 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; - // (undocumented) - getWebsiteForAuditId(auditId: string): Promise; - // (undocumented) - getWebsiteList(options?: LASListRequest): Promise; - // (undocumented) - triggerAudit(payload: TriggerAuditPayload): Promise; - // (undocumented) - url: string; -} - // @public (undocumented) export const Router: () => JSX.Element; - -// @public (undocumented) -export interface TriggerAuditPayload { - // (undocumented) - options: { - lighthouseConfig: { - settings: LighthouseConfigSettings; - }; - }; - // (undocumented) - url: string; -} - -// @public (undocumented) -export interface Website { - // (undocumented) - audits: Audit[]; - // (undocumented) - lastAudit: Audit; - // (undocumented) - url: string; -} - -// @public (undocumented) -export type WebsiteListResponse = LASListResponse; ```