From 382e3a94b35e1920f2eb16279ffef95cf40e77ff Mon Sep 17 00:00:00 2001 From: Emma Indal Date: Thu, 2 Dec 2021 14:26:32 +0100 Subject: [PATCH] [Search] export search api interface (#8334) * export api interface from plugin Signed-off-by: Emma Indal * add changeset Signed-off-by: Emma Indal * export as type Signed-off-by: Emma Indal * update api reports Signed-off-by: Emma Indal --- .changeset/search-hip-schools-burn.md | 5 +++++ plugins/search/api-report.md | 9 ++++++++- plugins/search/src/index.ts | 1 + 3 files changed, 14 insertions(+), 1 deletion(-) create mode 100644 .changeset/search-hip-schools-burn.md diff --git a/.changeset/search-hip-schools-burn.md b/.changeset/search-hip-schools-burn.md new file mode 100644 index 0000000000..12cef5f5ca --- /dev/null +++ b/.changeset/search-hip-schools-burn.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-search': patch +--- + +Export SearchApi interface from plugin diff --git a/plugins/search/api-report.md b/plugins/search/api-report.md index d8742bec83..3db26579e3 100644 --- a/plugins/search/api-report.md +++ b/plugins/search/api-report.md @@ -74,7 +74,14 @@ export const HomePageSearchBar: ({ // @public (undocumented) export const Router: () => JSX.Element; -// Warning: (ae-forgotten-export) The symbol "SearchApi" needs to be exported by the entry point index.d.ts +// Warning: (ae-missing-release-tag) "SearchApi" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export interface SearchApi { + // (undocumented) + query(query: SearchQuery): Promise; +} + // Warning: (ae-missing-release-tag) "searchApiRef" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) diff --git a/plugins/search/src/index.ts b/plugins/search/src/index.ts index 09cf204017..f5c58450fc 100644 --- a/plugins/search/src/index.ts +++ b/plugins/search/src/index.ts @@ -21,6 +21,7 @@ */ export { searchApiRef } from './apis'; +export type { SearchApi } from './apis'; export { Filters, FiltersButton,