diff --git a/workspaces/confluence/plugins/confluence/api-report.md b/workspaces/confluence/plugins/confluence/api-report.md index 18c40b08aa..af5134e7b5 100644 --- a/workspaces/confluence/plugins/confluence/api-report.md +++ b/workspaces/confluence/plugins/confluence/api-report.md @@ -9,22 +9,25 @@ import { default as React_2 } from 'react'; import { ReactNode } from 'react'; import { ResultHighlight } from '@backstage/plugin-search-common'; -// Warning: (ae-missing-release-tag) "confluencePlugin" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// -// @public (undocumented) +// @public export const confluencePlugin: BackstagePlugin<{}, {}, {}>; +// @public (undocumented) +export interface ConfluenceResultItemProps { + // (undocumented) + highlight?: ResultHighlight; + // (undocumented) + icon?: ReactNode; + // (undocumented) + result?: IndexableDocument; +} + // @public export const ConfluenceSearchIcon: () => React_2.JSX.Element; -// Warning: (ae-forgotten-export) The symbol "ConfluenceResultItemProps" needs to be exported by the entry point index.d.ts -// Warning: (ae-missing-release-tag) "ConfluenceSearchResultListItem" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// -// @public (undocumented) +// @public export const ConfluenceSearchResultListItem: ({ result, highlight, }: ConfluenceResultItemProps) => React_2.JSX.Element | null; - -// (No @packageDocumentation comment for this package) ``` diff --git a/workspaces/confluence/plugins/confluence/src/index.ts b/workspaces/confluence/plugins/confluence/src/index.ts index 82946c9db9..5f84cc18bc 100644 --- a/workspaces/confluence/plugins/confluence/src/index.ts +++ b/workspaces/confluence/plugins/confluence/src/index.ts @@ -1,3 +1,10 @@ +/** + * Confluence frontend plugin. + * + * @packageDocumentation + */ + export { confluencePlugin } from './plugin'; export { ConfluenceSearchIcon } from './icons'; export { ConfluenceSearchResultListItem } from './search/ConfluenceSearchResultListItem'; +export type { ConfluenceResultItemProps } from './search/ConfluenceSearchResultListItem'; \ No newline at end of file diff --git a/workspaces/confluence/plugins/confluence/src/plugin.ts b/workspaces/confluence/plugins/confluence/src/plugin.ts index 9981ed44fe..16a635aeb7 100644 --- a/workspaces/confluence/plugins/confluence/src/plugin.ts +++ b/workspaces/confluence/plugins/confluence/src/plugin.ts @@ -1,5 +1,10 @@ import { createPlugin } from '@backstage/core-plugin-api'; +/** + * The Backstage plugin that holds Confluence specific components + * + * @public + */ export const confluencePlugin = createPlugin({ id: 'confluence', }); diff --git a/workspaces/confluence/plugins/confluence/src/search/ConfluenceSearchResultListItem.tsx b/workspaces/confluence/plugins/confluence/src/search/ConfluenceSearchResultListItem.tsx index bfffd01674..596b183e23 100644 --- a/workspaces/confluence/plugins/confluence/src/search/ConfluenceSearchResultListItem.tsx +++ b/workspaces/confluence/plugins/confluence/src/search/ConfluenceSearchResultListItem.tsx @@ -36,6 +36,9 @@ const useStyles = makeStyles({ }, }); +/** + * @public + */ export type IndexableConfluenceDocument = IndexableDocument & { spaceName: string; lastModified: string; @@ -48,12 +51,20 @@ export type IndexableConfluenceDocument = IndexableDocument & { }[]; }; +/** + * @public + */ export interface ConfluenceResultItemProps { result?: IndexableDocument; highlight?: ResultHighlight; icon?: ReactNode; } +/** + * A component to display an Confluence search result. + * + * @public + */ export const ConfluenceSearchResultListItem = ({ result, highlight,