From a9da252cb4c2816ca4e8b3ed01deda296427d900 Mon Sep 17 00:00:00 2001 From: Camila Belo Date: Mon, 20 Nov 2023 09:37:24 +0100 Subject: [PATCH] refator: group core component ref in a object Signed-off-by: Camila Belo --- .../examples/notFoundErrorPageExtension.tsx | 4 ++-- .../src/collectLegacyComponents.tsx | 13 ++++------- .../src/extensions/CoreRoutes.tsx | 4 ++-- .../src/extensions/components.tsx | 13 ++++------- packages/frontend-plugin-api/api-report.md | 16 +++++-------- .../src/components/ComponentRef.tsx | 23 +++++++++++-------- .../src/components/index.ts | 8 +------ 7 files changed, 35 insertions(+), 46 deletions(-) diff --git a/packages/app-next/src/examples/notFoundErrorPageExtension.tsx b/packages/app-next/src/examples/notFoundErrorPageExtension.tsx index c076b059f4..b1e88b6457 100644 --- a/packages/app-next/src/examples/notFoundErrorPageExtension.tsx +++ b/packages/app-next/src/examples/notFoundErrorPageExtension.tsx @@ -17,7 +17,7 @@ import React from 'react'; import { createComponentExtension, - coreNotFoundErrorPageComponentRef, + coreComponentsRefs, } from '@backstage/frontend-plugin-api'; import { Box, Typography } from '@material-ui/core'; import { Button } from '@backstage/core-components'; @@ -57,6 +57,6 @@ export function CustomNotFoundErrorPage() { } export default createComponentExtension({ - ref: coreNotFoundErrorPageComponentRef, + ref: coreComponentsRefs.notFoundErrorPage, component: async () => CustomNotFoundErrorPage, }); diff --git a/packages/core-compat-api/src/collectLegacyComponents.tsx b/packages/core-compat-api/src/collectLegacyComponents.tsx index 97c3ee22ad..17a354f52d 100644 --- a/packages/core-compat-api/src/collectLegacyComponents.tsx +++ b/packages/core-compat-api/src/collectLegacyComponents.tsx @@ -18,20 +18,17 @@ import { Extension, ComponentRef, createComponentExtension, - coreProgressComponentRef, - coreBootErrorPageComponentRef, - coreNotFoundErrorPageComponentRef, - coreErrorBoundaryFallbackComponentRef, + coreComponentsRefs, } from '@backstage/frontend-plugin-api'; import { AppComponents } from '@backstage/core-plugin-api'; type ComponentTypes = T[keyof T]; const refs: Record> = { - Progress: coreProgressComponentRef, - BootErrorPage: coreBootErrorPageComponentRef, - NotFoundErrorPage: coreNotFoundErrorPageComponentRef, - ErrorBoundaryFallback: coreErrorBoundaryFallbackComponentRef, + Progress: coreComponentsRefs.progress, + BootErrorPage: coreComponentsRefs.bootErrorPage, + NotFoundErrorPage: coreComponentsRefs.notFoundErrorPage, + ErrorBoundaryFallback: coreComponentsRefs.errorBoundaryFallback, }; /** @public */ diff --git a/packages/frontend-app-api/src/extensions/CoreRoutes.tsx b/packages/frontend-app-api/src/extensions/CoreRoutes.tsx index 37b0e5d62f..9acd27b6bf 100644 --- a/packages/frontend-app-api/src/extensions/CoreRoutes.tsx +++ b/packages/frontend-app-api/src/extensions/CoreRoutes.tsx @@ -19,7 +19,7 @@ import { createExtension, coreExtensionData, createExtensionInput, - coreNotFoundErrorPageComponentRef, + coreComponentsRefs, useApi, componentsApiRef, } from '@backstage/frontend-plugin-api'; @@ -42,7 +42,7 @@ export const CoreRoutes = createExtension({ const Routes = () => { const componentsApi = useApi(componentsApiRef); const NotFoundErrorPage = componentsApi.getComponent( - coreNotFoundErrorPageComponentRef, + coreComponentsRefs.notFoundErrorPage, ); const element = useRoutes([ diff --git a/packages/frontend-app-api/src/extensions/components.tsx b/packages/frontend-app-api/src/extensions/components.tsx index 5bd4431a28..cf34859aa0 100644 --- a/packages/frontend-app-api/src/extensions/components.tsx +++ b/packages/frontend-app-api/src/extensions/components.tsx @@ -16,31 +16,28 @@ import { createComponentExtension, - coreProgressComponentRef, - coreBootErrorPageComponentRef, - coreNotFoundErrorPageComponentRef, - coreErrorBoundaryFallbackComponentRef, + coreComponentsRefs, } from '@backstage/frontend-plugin-api'; // eslint-disable-next-line @backstage/no-relative-monorepo-imports import { components as defaultComponents } from '../../../app-defaults/src/defaults'; // eslint-disable-next-line @backstage/no-relative-monorepo-imports export const DefaultProgressComponent = createComponentExtension({ - ref: coreProgressComponentRef, + ref: coreComponentsRefs.progress, component: async () => defaultComponents.Progress, }); export const DefaultBootErrorPageComponent = createComponentExtension({ - ref: coreBootErrorPageComponentRef, + ref: coreComponentsRefs.bootErrorPage, component: async () => defaultComponents.BootErrorPage, }); export const DefaultNotFoundErrorPageComponent = createComponentExtension({ - ref: coreNotFoundErrorPageComponentRef, + ref: coreComponentsRefs.notFoundErrorPage, component: async () => defaultComponents.NotFoundErrorPage, }); export const DefaultErrorBoundaryComponent = createComponentExtension({ - ref: coreErrorBoundaryFallbackComponentRef, + ref: coreComponentsRefs.errorBoundaryFallback, component: async () => defaultComponents.ErrorBoundaryFallback, }); diff --git a/packages/frontend-plugin-api/api-report.md b/packages/frontend-plugin-api/api-report.md index 3d89c415fa..fe92a9cb44 100644 --- a/packages/frontend-plugin-api/api-report.md +++ b/packages/frontend-plugin-api/api-report.md @@ -331,7 +331,12 @@ export type CoreBootErrorPageComponent = ComponentType< >; // @public (undocumented) -export const coreBootErrorPageComponentRef: ComponentRef; +export const coreComponentsRefs: { + progress: ComponentRef; + bootErrorPage: ComponentRef; + notFoundErrorPage: ComponentRef; + errorBoundaryFallback: ComponentRef; +}; // @public (undocumented) export type CoreErrorBoundaryFallbackComponent = ComponentType< @@ -342,9 +347,6 @@ export type CoreErrorBoundaryFallbackComponent = ComponentType< }> >; -// @public (undocumented) -export const coreErrorBoundaryFallbackComponentRef: ComponentRef; - // @public (undocumented) export const coreExtensionData: { reactElement: ConfigurableExtensionDataRef; @@ -368,15 +370,9 @@ export type CoreNotFoundErrorPageComponent = ComponentType< PropsWithChildren<{}> >; -// @public (undocumented) -export const coreNotFoundErrorPageComponentRef: ComponentRef; - // @public (undocumented) export type CoreProgressComponent = ComponentType>; -// @public (undocumented) -export const coreProgressComponentRef: ComponentRef; - // @public (undocumented) export function createApiExtension< TConfig extends {}, diff --git a/packages/frontend-plugin-api/src/components/ComponentRef.tsx b/packages/frontend-plugin-api/src/components/ComponentRef.tsx index 13588ba779..2db85b9a42 100644 --- a/packages/frontend-plugin-api/src/components/ComponentRef.tsx +++ b/packages/frontend-plugin-api/src/components/ComponentRef.tsx @@ -40,24 +40,29 @@ export function createComponentRef(options: { }; } -/** @public */ -export const coreProgressComponentRef = - createComponentRef({ id: 'core.components.progress' }); +const coreProgressComponentRef = createComponentRef({ + id: 'core.components.progress', +}); -/** @public */ -export const coreBootErrorPageComponentRef = +const coreBootErrorPageComponentRef = createComponentRef({ id: 'core.components.bootErrorPage', }); -/** @public */ -export const coreNotFoundErrorPageComponentRef = +const coreNotFoundErrorPageComponentRef = createComponentRef({ id: 'core.components.notFoundErrorPage', }); -/** @public */ -export const coreErrorBoundaryFallbackComponentRef = +const coreErrorBoundaryFallbackComponentRef = createComponentRef({ id: 'core.components.errorBoundaryFallback', }); + +/** @public */ +export const coreComponentsRefs = { + progress: coreProgressComponentRef, + bootErrorPage: coreBootErrorPageComponentRef, + notFoundErrorPage: coreNotFoundErrorPageComponentRef, + errorBoundaryFallback: coreErrorBoundaryFallbackComponentRef, +}; diff --git a/packages/frontend-plugin-api/src/components/index.ts b/packages/frontend-plugin-api/src/components/index.ts index 4bee5c5f7b..e0b3d09543 100644 --- a/packages/frontend-plugin-api/src/components/index.ts +++ b/packages/frontend-plugin-api/src/components/index.ts @@ -14,13 +14,7 @@ * limitations under the License. */ -export { - coreProgressComponentRef, - coreBootErrorPageComponentRef, - coreErrorBoundaryFallbackComponentRef, - coreNotFoundErrorPageComponentRef, - type ComponentRef, -} from './ComponentRef'; +export { coreComponentsRefs, type ComponentRef } from './ComponentRef'; export { ExtensionError } from './ExtensionError';