Merge pull request #6076 from backstage/rugvip/allreports

scripts/api-extractor: create and check API reports for all(most) plugins
2021-06-17 15:46:11 +02:00
parent 79a5fc65a8 d8d7226fce
commit 820de63018
55 changed files with 5261 additions and 22 deletions
@@ -0,0 +1,102 @@
+## API Report File for "@backstage/plugin-search"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { ApiRef } from '@backstage/core';
+import { AsyncState } from 'react-use/lib/useAsync';
+import { BackstagePlugin } from '@backstage/core';
+import { IndexableDocument } from '@backstage/search-common';
+import { JsonObject } from '@backstage/config';
+import { default as React_2 } from 'react';
+import { ReactElement } from 'react';
+import { RouteRef } from '@backstage/core';
+import { SearchQuery } from '@backstage/search-common';
+import { SearchResult as SearchResult_2 } from '@backstage/search-common';
+import { SearchResultSet } from '@backstage/search-common';
+
+// @public (undocumented)
+export const DefaultResultListItem: ({ result }: {
+    result: IndexableDocument;
+}) => JSX.Element;
+
+// @public (undocumented)
+export const Filters: ({ filters, filterOptions, resetFilters, updateSelected, updateChecked, }: FiltersProps) => JSX.Element;
+
+// @public (undocumented)
+export const FiltersButton: ({ numberOfSelectedFilters, handleToggleFilters, }: FiltersButtonProps) => JSX.Element;
+
+// @public (undocumented)
+export type FiltersState = {
+    selected: string;
+    checked: Array<string>;
+};
+
+// @public (undocumented)
+export const Router: () => JSX.Element;
+
+// @public (undocumented)
+export const searchApiRef: ApiRef<SearchApi>;
+
+// @public (undocumented)
+export const SearchBar: ({ className, debounceTime }: Props) => JSX.Element;
+
+// @public @deprecated (undocumented)
+export const SearchBarNext: ({ className, debounceTime }: {
+    className?: string | undefined;
+    debounceTime?: number | undefined;
+}) => JSX.Element;
+
+// @public (undocumented)
+export const SearchContextProvider: ({ initialState, children, }: React_2.PropsWithChildren<{
+    initialState?: SettableSearchContext | undefined;
+}>) => JSX.Element;
+
+// @public (undocumented)
+export const SearchFilter: {
+    ({ component: Element, ...props }: Props_2): JSX.Element;
+    Checkbox(props: Omit<Props_2, 'component'> & Component): JSX.Element;
+    Select(props: Omit<Props_2, 'component'> & Component): JSX.Element;
+};
+
+// @public @deprecated (undocumented)
+export const SearchFilterNext: {
+    ({ component: Element, ...props }: Props_2): JSX.Element;
+    Checkbox(props: Omit<Props_2, 'component'> & Component): JSX.Element;
+    Select(props: Omit<Props_2, 'component'> & Component): JSX.Element;
+};
+
+// @public (undocumented)
+export const SearchPage: () => JSX.Element;
+
+// @public @deprecated (undocumented)
+export const SearchPageNext: () => JSX.Element;
+
+// @public (undocumented)
+const searchPlugin: BackstagePlugin<{
+    root: RouteRef<undefined>;
+    nextRoot: RouteRef<undefined>;
+}, {}>;
+
+export { searchPlugin as plugin }
+
+export { searchPlugin }
+
+// @public (undocumented)
+export const SearchResult: ({ children }: {
+    children: (results: {
+        results: SearchResult_2[];
+    }) => JSX.Element;
+}) => JSX.Element;
+
+// @public (undocumented)
+export const SidebarSearch: () => JSX.Element;
+
+// @public (undocumented)
+export const useSearch: () => SearchContextValue;
+
+
+// (No @packageDocumentation comment for this package)
+
+```