From 0025a3c5953181032cb62833ab922172fc3ecc9c Mon Sep 17 00:00:00 2001 From: Camila Belo Date: Tue, 28 Nov 2023 10:50:42 +0100 Subject: [PATCH] docs: update api reports Signed-off-by: Camila Belo --- packages/frontend-plugin-api/api-report.md | 20 +++++++++++++------ .../src/apis/definitions/ComponentsApi.ts | 2 +- 2 files changed, 15 insertions(+), 7 deletions(-) diff --git a/packages/frontend-plugin-api/api-report.md b/packages/frontend-plugin-api/api-report.md index b5c63f9d22..e1ed76d82c 100644 --- a/packages/frontend-plugin-api/api-report.md +++ b/packages/frontend-plugin-api/api-report.md @@ -13,7 +13,6 @@ import { AnyApiRef } from '@backstage/core-plugin-api'; import { ApiFactory } from '@backstage/core-plugin-api'; import { ApiHolder } from '@backstage/core-plugin-api'; import { ApiRef } from '@backstage/core-plugin-api'; -import { ApiRef as ApiRef_2 } from '@backstage/core-plugin-api/src/apis/system/types'; import { ApiRefConfig } from '@backstage/core-plugin-api'; import { AppTheme } from '@backstage/core-plugin-api'; import { AppThemeApi } from '@backstage/core-plugin-api'; @@ -300,7 +299,7 @@ export interface ComponentsApi { } // @public -export const componentsApiRef: ApiRef_2; +export const componentsApiRef: ApiRef; export { ConfigApi }; @@ -409,10 +408,19 @@ export function createComponentExtension< disabled?: boolean; inputs?: TInputs; configSchema?: PortableSchema; - component: (values: { - config: TConfig; - inputs: Expand>; - }) => Promise; + component: + | { + lazy: (values: { + config: TConfig; + inputs: Expand>; + }) => Promise; + } + | { + sync: (values: { + config: TConfig; + inputs: Expand>; + }) => TRef['T']; + }; }): Extension; // @public (undocumented) diff --git a/packages/frontend-plugin-api/src/apis/definitions/ComponentsApi.ts b/packages/frontend-plugin-api/src/apis/definitions/ComponentsApi.ts index 452e692389..b55ed96549 100644 --- a/packages/frontend-plugin-api/src/apis/definitions/ComponentsApi.ts +++ b/packages/frontend-plugin-api/src/apis/definitions/ComponentsApi.ts @@ -14,8 +14,8 @@ * limitations under the License. */ +import { createApiRef } from '@backstage/core-plugin-api'; import { ComponentRef } from '../../components'; -import { createApiRef } from '../system'; /** * API for looking up components based on component refs.