paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 32 Packages Projects Releases Wiki Activity

Clean up API report, export types.

Browse Source 
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
This commit is contained in:
Eric Peterson
2021-09-30 10:27:06 +02:00
parent 5098f4a7c9
commit 16b5b3d11a
3 changed files with 52 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/techdocs/api-report.md
+47 -1
View File
@@ -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)
//
plugins/techdocs/src/reader/components/TechDocsPage.tsx
+4 -4
View File
@@ -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<boolean>(false);
plugins/techdocs/src/reader/components/TechDocsPageHeader.tsx
+1 -1
View File
@@ -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;