Skip to content

Commit

Permalink
Fixed frontend plugin api report
Browse files Browse the repository at this point in the history
Signed-off-by: Florian JUDITH <[email protected]>
  • Loading branch information
Florian JUDITH committed Aug 7, 2024
1 parent d4ac9ab commit 03cfc14
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 9 deletions.
21 changes: 12 additions & 9 deletions workspaces/confluence/plugins/confluence/api-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
```
7 changes: 7 additions & 0 deletions workspaces/confluence/plugins/confluence/src/index.ts
Original file line number Diff line number Diff line change
@@ -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';
5 changes: 5 additions & 0 deletions workspaces/confluence/plugins/confluence/src/plugin.ts
Original file line number Diff line number Diff line change
@@ -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',
});
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ const useStyles = makeStyles({
},
});

/**
* @public
*/
export type IndexableConfluenceDocument = IndexableDocument & {
spaceName: string;
lastModified: string;
Expand All @@ -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,
Expand Down

0 comments on commit 03cfc14

Please sign in to comment.