diff --git a/plugins/techdocs/api-report.md b/plugins/techdocs/api-report.md index 087cdf803a..4bb3bebc57 100644 --- a/plugins/techdocs/api-report.md +++ b/plugins/techdocs/api-report.md @@ -264,11 +264,55 @@ export const TechDocsCustomHome: ({ // @public (undocumented) export const TechDocsIndexPage: () => JSX.Element; +// Warning: (ae-missing-release-tag) "TechDocsPage" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export const TechDocsPage: ({ children }: TechDocsPageProps) => JSX.Element; + // Warning: (ae-missing-release-tag) "TechdocsPage" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export const TechdocsPage: () => JSX.Element; +// Warning: (ae-missing-release-tag) "TechDocsPageHeader" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export const TechDocsPageHeader: ({ + entityId, + entityMetadata, + techDocsMetadata, +}: TechDocsPageHeaderProps) => JSX.Element; + +// Warning: (ae-missing-release-tag) "TechDocsPageHeaderProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export type TechDocsPageHeaderProps = { + entityId: EntityName; + entityMetadata?: TechDocsEntityMetadata; + techDocsMetadata?: TechDocsMetadata; +}; + +// Warning: (ae-missing-release-tag) "TechDocsPageProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export type TechDocsPageProps = { + children?: TechDocsPageRenderFunction | React_2.ReactNode; +}; + +// Warning: (ae-missing-release-tag) "TechDocsPageRenderFunction" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export type TechDocsPageRenderFunction = ({ + techdocsMetadataValue, + entityMetadataValue, + entityId, +}: { + techdocsMetadataValue?: TechDocsMetadata | undefined; + entityMetadataValue?: TechDocsEntityMetadata | undefined; + entityId: EntityName; + onReady: () => void; +}) => JSX.Element; + // Warning: (ae-forgotten-export) The symbol "Props" needs to be exported by the entry point index.d.ts // Warning: (ae-missing-release-tag) "TechDocsPageWrapper" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // @@ -301,7 +345,9 @@ export { techdocsPlugin }; // Warning: (ae-missing-release-tag) "TechDocsReaderPage" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) -export const TechDocsReaderPage: () => JSX.Element; +export const TechDocsReaderPage: ({ + children, +}: TechDocsPageProps) => JSX.Element; // Warning: (ae-missing-release-tag) "TechDocsStorageApi" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // diff --git a/plugins/techdocs/src/reader/components/TechDocsPage.tsx b/plugins/techdocs/src/reader/components/TechDocsPage.tsx index 7755900b96..e73e03fbcc 100644 --- a/plugins/techdocs/src/reader/components/TechDocsPage.tsx +++ b/plugins/techdocs/src/reader/components/TechDocsPage.tsx @@ -26,7 +26,7 @@ import { EntityName } from '@backstage/catalog-model'; import { useApi } from '@backstage/core-plugin-api'; import { Page } from '@backstage/core-components'; -type RenderFunction = ({ +export type TechDocsPageRenderFunction = ({ techdocsMetadataValue, entityMetadataValue, entityId, @@ -37,11 +37,11 @@ type RenderFunction = ({ onReady: () => void; }) => JSX.Element; -type Props = { - children?: RenderFunction | React.ReactNode; +export type TechDocsPageProps = { + children?: TechDocsPageRenderFunction | React.ReactNode; }; -export const TechDocsPage = ({ children }: Props) => { +export const TechDocsPage = ({ children }: TechDocsPageProps) => { const outlet = useOutlet(); const [documentReady, setDocumentReady] = useState(false); diff --git a/plugins/techdocs/src/reader/components/TechDocsPageHeader.tsx b/plugins/techdocs/src/reader/components/TechDocsPageHeader.tsx index 34d564bdfe..ef2e4f0b73 100644 --- a/plugins/techdocs/src/reader/components/TechDocsPageHeader.tsx +++ b/plugins/techdocs/src/reader/components/TechDocsPageHeader.tsx @@ -27,7 +27,7 @@ import React from 'react'; import { rootRouteRef } from '../../routes'; import { TechDocsEntityMetadata, TechDocsMetadata } from '../../types'; -type TechDocsPageHeaderProps = { +export type TechDocsPageHeaderProps = { entityId: EntityName; entityMetadata?: TechDocsEntityMetadata; techDocsMetadata?: TechDocsMetadata;