@backstage/plugin-search-react 1.5.2-next.0 → 1.5.2-next.2

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @backstage/plugin-search-react
 
+## 1.5.2-next.2
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/core-components@0.12.6-next.2
+  - @backstage/core-plugin-api@1.5.1-next.1
+  - @backstage/theme@0.2.19-next.0
+  - @backstage/types@1.0.2
+  - @backstage/version-bridge@1.0.4-next.0
+  - @backstage/plugin-search-common@1.2.3-next.0
+
+## 1.5.2-next.1
+
+### Patch Changes
+
+- e0c6e8b9c3c: Update peer dependencies
+- Updated dependencies
+  - @backstage/core-components@0.12.6-next.1
+  - @backstage/core-plugin-api@1.5.1-next.0
+  - @backstage/version-bridge@1.0.4-next.0
+  - @backstage/theme@0.2.19-next.0
+  - @backstage/types@1.0.2
+  - @backstage/plugin-search-common@1.2.3-next.0
+
 ## 1.5.2-next.0
 
 ### Patch Changes

package/dist/index.d.ts

@@ -34,7 +34,7 @@ declare class MockSearchApi implements SearchApi {
  * @public
  * Extends props for any search result list item extension
  */
-declare type SearchResultListItemExtensionProps<Props extends {} = {}> = Props & PropsWithChildren<{
+type SearchResultListItemExtensionProps<Props extends {} = {}> = Props & PropsWithChildren<{
     rank?: number;
     result?: SearchDocument;
     noTrack?: boolean;
@@ -43,7 +43,7 @@ declare type SearchResultListItemExtensionProps<Props extends {} = {}> = Props &
  * @public
  * Options for {@link createSearchResultListItemExtension}.
  */
-declare type SearchResultListItemExtensionOptions<Component extends (props: any) => JSX.Element | null> = {
+type SearchResultListItemExtensionOptions<Component extends (props: any) => JSX.Element | null> = {
     /**
      * The extension name.
      */
@@ -73,7 +73,7 @@ declare const useSearchResultListItemExtensions: (children: ReactNode) => (resul
  * @public
  * Props for {@link SearchResultListItemExtensions}
  */
-declare type SearchResultListItemExtensionsProps = Omit<ListProps, 'results'> & {
+type SearchResultListItemExtensionsProps = Omit<ListProps, 'results'> & {
     /**
      * Search result list.
      */
@@ -91,7 +91,7 @@ declare const SearchResultListItemExtensions: (props: SearchResultListItemExtens
  *
  * @public
  */
-declare type HighlightedSearchResultTextProps = {
+type HighlightedSearchResultTextProps = {
     text: string;
     preTag: string;
     postTag: string;
@@ -106,7 +106,7 @@ declare const HighlightedSearchResultText: (props: HighlightedSearchResultTextPr
  *
  * @public
  */
-declare type SearchBarBaseProps = Omit<InputBaseProps, 'onChange'> & {
+type SearchBarBaseProps = Omit<InputBaseProps, 'onChange'> & {
     debounceTime?: number;
     clearButton?: boolean;
     onClear?: () => void;
@@ -126,7 +126,7 @@ declare const SearchBarBase: ForwardRefExoticComponent<SearchBarBaseProps>;
  *
  * @public
  */
-declare type SearchBarProps = Partial<SearchBarBaseProps>;
+type SearchBarProps = Partial<SearchBarBaseProps>;
 /**
  * Recommended search bar when you use the Search Provider or Search Context.
  *
@@ -139,7 +139,7 @@ declare const SearchBar: ForwardRefExoticComponent<SearchBarProps>;
  *
  * @public
  */
-declare type SearchAutocompleteProps<Option> = Omit<AutocompleteProps<Option, undefined, undefined, boolean>, 'renderInput' | 'disableClearable' | 'multiple'> & {
+type SearchAutocompleteProps<Option> = Omit<AutocompleteProps<Option, undefined, undefined, boolean>, 'renderInput' | 'disableClearable' | 'multiple'> & {
     'data-testid'?: string;
     inputPlaceholder?: SearchBarProps['placeholder'];
     inputDebounceTime?: SearchBarProps['debounceTime'];
@@ -149,7 +149,7 @@ declare type SearchAutocompleteProps<Option> = Omit<AutocompleteProps<Option, un
  *
  * @public
  */
-declare type SearchAutocompleteComponent = <Option>(props: SearchAutocompleteProps<Option>) => JSX.Element;
+type SearchAutocompleteComponent = <Option>(props: SearchAutocompleteProps<Option>) => JSX.Element;
 /**
  * Recommended search autocomplete when you use the Search Provider or Search Context.
  *
@@ -162,7 +162,7 @@ declare const SearchAutocomplete: SearchAutocompleteComponent;
  *
  * @public
  */
-declare type SearchAutocompleteDefaultOptionProps = {
+type SearchAutocompleteDefaultOptionProps = {
     icon?: ReactNode;
     primaryText: ListItemTextProps['primary'];
     primaryTextTypographyProps?: ListItemTextProps['primaryTypographyProps'];
@@ -180,7 +180,7 @@ declare const SearchAutocompleteDefaultOption: (props: SearchAutocompleteDefault
 /**
  * @public
  */
-declare type SearchAutocompleteFilterProps = SearchFilterComponentProps & {
+type SearchAutocompleteFilterProps = SearchFilterComponentProps & {
     filterSelectedOptions?: boolean;
     limitTags?: number;
     multiple?: boolean;
@@ -193,7 +193,7 @@ declare const AutocompleteFilter: (props: SearchAutocompleteFilterProps) => JSX.
 /**
  * @public
  */
-declare type SearchFilterComponentProps = {
+type SearchFilterComponentProps = {
     className?: string;
     name: string;
     label?: string;
@@ -214,7 +214,7 @@ declare type SearchFilterComponentProps = {
 /**
  * @public
  */
-declare type SearchFilterWrapperProps = SearchFilterComponentProps & {
+type SearchFilterWrapperProps = SearchFilterComponentProps & {
     component: (props: SearchFilterComponentProps) => ReactElement;
     debug?: boolean;
 };
@@ -247,7 +247,7 @@ declare const SearchFilter: {
  * A page limit option, this value must not be greater than 100.
  * @public
  */
-declare type SearchPaginationLimitOption<Current extends number = 101, Accumulator extends number[] = []> = Accumulator['length'] extends Current ? Accumulator[number] : SearchPaginationLimitOption<Current, [
+type SearchPaginationLimitOption<Current extends number = 101, Accumulator extends number[] = []> = Accumulator['length'] extends Current ? Accumulator[number] : SearchPaginationLimitOption<Current, [
     ...Accumulator,
     Accumulator['length']
 ]>;
@@ -255,7 +255,7 @@ declare type SearchPaginationLimitOption<Current extends number = 101, Accumulat
  * A page limit text, this function is called with a "\{ from, to, page, count \}" object.
  * @public
  */
-declare type SearchPaginationLimitText = (params: {
+type SearchPaginationLimitText = (params: {
     from: number;
     to: number;
     page: number;
@@ -265,7 +265,7 @@ declare type SearchPaginationLimitText = (params: {
  * Props for {@link SearchPaginationBase}.
  * @public
  */
-declare type SearchPaginationBaseProps = {
+type SearchPaginationBaseProps = {
     /**
      * The component class name.
      */
@@ -325,7 +325,7 @@ declare const SearchPaginationBase: (props: SearchPaginationBaseProps) => JSX.El
  * Props for {@link SearchPagination}.
  * @public
  */
-declare type SearchPaginationProps = Omit<SearchPaginationBaseProps, 'pageLimit' | 'onPageLimitChange' | 'pageCursor' | 'onPageCursorChange' | 'hasNextPage'>;
+type SearchPaginationProps = Omit<SearchPaginationBaseProps, 'pageLimit' | 'onPageLimitChange' | 'pageCursor' | 'onPageCursorChange' | 'hasNextPage'>;
 /**
  * A component for setting the search context page limit and cursor.
  * @param props - See {@link SearchPaginationProps}.
@@ -337,7 +337,7 @@ declare const SearchPagination: (props: SearchPaginationProps) => JSX.Element;
  * Props for {@link SearchResultContext}
  * @public
  */
-declare type SearchResultContextProps = {
+type SearchResultContextProps = {
     /**
      * A child function that receives an asynchronous result set and returns a react element.
      */
@@ -368,7 +368,7 @@ declare const SearchResultContext: (props: SearchResultContextProps) => JSX.Elem
  * Props for {@link SearchResultApi}
  * @public
  */
-declare type SearchResultApiProps = SearchResultContextProps & {
+type SearchResultApiProps = SearchResultContextProps & {
     query: Partial<SearchQuery>;
 };
 /**
@@ -396,7 +396,7 @@ declare const SearchResultApi: (props: SearchResultApiProps) => JSX.Element | nu
  * Props for {@link SearchResultState}
  * @public
  */
-declare type SearchResultStateProps = SearchResultContextProps & Partial<SearchResultApiProps>;
+type SearchResultStateProps = SearchResultContextProps & Partial<SearchResultApiProps>;
 /**
  * Call a child render function passing a search state as an argument.
  * @remarks By default, results are taken from context, but when a "query" prop is set, results are requested from the search api.
@@ -440,7 +440,7 @@ declare const SearchResultState: (props: SearchResultStateProps) => JSX.Element;
  * Props for {@link SearchResult}
  * @public
  */
-declare type SearchResultProps = Pick<SearchResultStateProps, 'query'> & Omit<SearchResultListItemExtensionsProps, 'results' | 'children'> & {
+type SearchResultProps = Pick<SearchResultStateProps, 'query'> & Omit<SearchResultListItemExtensionsProps, 'results' | 'children'> & {
     children?: ReactNode | ((resultSet: SearchResultSet) => JSX.Element);
     noResultsComponent?: JSX.Element;
 };
@@ -462,7 +462,7 @@ declare const SearchResult: (props: SearchResultProps) => JSX.Element;
  * Props for {@link SearchResultListLayout}
  * @public
  */
-declare type SearchResultListLayoutProps = ListProps & {
+type SearchResultListLayoutProps = ListProps & {
     /**
      * If defined, will render a default error panel.
      */
@@ -498,7 +498,7 @@ declare const SearchResultListLayout: (props: SearchResultListLayoutProps) => JS
  * Props for {@link SearchResultList}.
  * @public
  */
-declare type SearchResultListProps = Pick<SearchResultStateProps, 'query'> & Omit<SearchResultListLayoutProps, 'loading' | 'error' | 'resultItems'>;
+type SearchResultListProps = Pick<SearchResultStateProps, 'query'> & Omit<SearchResultListLayoutProps, 'loading' | 'error' | 'resultItems'>;
 /**
  * Given a query, search for results and render them as a list.
  * @param props - See {@link SearchResultListProps}.
@@ -510,7 +510,7 @@ declare const SearchResultList: (props: SearchResultListProps) => JSX.Element;
  * Props for {@link SearchResultGroupFilterFieldLayout}
  * @public
  */
-declare type SearchResultGroupFilterFieldLayoutProps = PropsWithChildren<{
+type SearchResultGroupFilterFieldLayoutProps = PropsWithChildren<{
     label: string;
     value?: JsonValue;
     onDelete: () => void;
@@ -525,14 +525,14 @@ declare const SearchResultGroupFilterFieldLayout: (props: SearchResultGroupFilte
  * Common props for a result group filter field.
  * @public
  */
-declare type SearchResultGroupFilterFieldPropsWith<T> = T & SearchResultGroupFilterFieldLayoutProps & {
+type SearchResultGroupFilterFieldPropsWith<T> = T & SearchResultGroupFilterFieldLayoutProps & {
     onChange: (value: JsonValue) => void;
 };
 /**
  * Props for {@link SearchResultGroupTextFilterField}.
  * @public
  */
-declare type SearchResultGroupTextFilterFieldProps = SearchResultGroupFilterFieldPropsWith<{}>;
+type SearchResultGroupTextFilterFieldProps = SearchResultGroupFilterFieldPropsWith<{}>;
 /**
  * A text field that can be used as filter on search result groups.
  * @param props - See {@link SearchResultGroupTextFilterFieldProps}.
@@ -553,7 +553,7 @@ declare const SearchResultGroupTextFilterField: (props: SearchResultGroupTextFil
  * Props for {@link SearchResultGroupTextFilterField}.
  * @public
  */
-declare type SearchResultGroupSelectFilterFieldProps = SearchResultGroupFilterFieldPropsWith<{
+type SearchResultGroupSelectFilterFieldProps = SearchResultGroupFilterFieldPropsWith<{
     children: ReactNode;
 }>;
 /**
@@ -579,7 +579,7 @@ declare const SearchResultGroupSelectFilterField: (props: SearchResultGroupSelec
  * Props for {@link SearchResultGroupLayout}
  * @public
  */
-declare type SearchResultGroupLayoutProps<FilterOption> = ListProps & {
+type SearchResultGroupLayoutProps<FilterOption> = ListProps & {
     /**
      * If defined, will render a default error panel.
      */
@@ -652,7 +652,7 @@ declare function SearchResultGroupLayout<FilterOption>(props: SearchResultGroupL
  * Props for {@link SearchResultGroup}.
  * @public
  */
-declare type SearchResultGroupProps<FilterOption> = Pick<SearchResultStateProps, 'query'> & Omit<SearchResultGroupLayoutProps<FilterOption>, 'loading' | 'error' | 'resultItems' | 'filterFields'>;
+type SearchResultGroupProps<FilterOption> = Pick<SearchResultStateProps, 'query'> & Omit<SearchResultGroupLayoutProps<FilterOption>, 'loading' | 'error' | 'resultItems' | 'filterFields'>;
 /**
  * Given a query, search for results and render them as a group.
  * @param props - See {@link SearchResultGroupProps}.
@@ -670,7 +670,7 @@ declare const SearchResultPager: () => JSX.Element;
  *
  * @public
  */
-declare type DefaultResultListItemProps = {
+type DefaultResultListItemProps = {
     icon?: ReactNode;
     secondaryAction?: ReactNode;
     result?: SearchDocument;
@@ -688,7 +688,7 @@ declare const HigherOrderDefaultResultListItem: (props: DefaultResultListItemPro
  *
  * @public
  */
-declare type SearchContextValue = {
+type SearchContextValue = {
     result: AsyncState<SearchResultSet>;
     setTerm: React.Dispatch<React.SetStateAction<string>>;
     setTypes: React.Dispatch<React.SetStateAction<string[]>>;
@@ -702,7 +702,7 @@ declare type SearchContextValue = {
  *
  * @public
  */
-declare type SearchContextState = {
+type SearchContextState = {
     term: string;
     types: string[];
     filters: JsonObject;
@@ -726,7 +726,7 @@ declare const useSearchContextCheck: () => boolean;
  *
  * @public
  */
-declare type SearchContextProviderProps = PropsWithChildren<{
+type SearchContextProviderProps = PropsWithChildren<{
     /**
      * State initialized by a local context.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-search-react",
-  "version": "1.5.2-next.0",
+  "version": "1.5.2-next.2",
   "main": "dist/index.esm.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -31,28 +31,30 @@
     "start": "backstage-cli package start"
   },
   "dependencies": {
-    "@backstage/core-components": "^0.12.6-next.0",
-    "@backstage/core-plugin-api": "^1.5.0",
-    "@backstage/plugin-search-common": "^1.2.2",
-    "@backstage/theme": "^0.2.18",
+    "@backstage/core-components": "^0.12.6-next.2",
+    "@backstage/core-plugin-api": "^1.5.1-next.1",
+    "@backstage/plugin-search-common": "^1.2.3-next.0",
+    "@backstage/theme": "^0.2.19-next.0",
     "@backstage/types": "^1.0.2",
-    "@backstage/version-bridge": "^1.0.3",
+    "@backstage/version-bridge": "^1.0.4-next.0",
     "@material-ui/core": "^4.12.2",
     "@material-ui/icons": "^4.9.1",
     "@material-ui/lab": "4.0.0-alpha.61",
+    "@types/react": "^16.13.1 || ^17.0.0",
     "lodash": "^4.17.21",
     "qs": "^6.9.4",
     "react-use": "^17.3.2"
   },
   "peerDependencies": {
-    "@types/react": "^16.13.1 || ^17.0.0",
     "react": "^16.13.1 || ^17.0.0",
+    "react-dom": "^16.13.1 || ^17.0.0",
     "react-router-dom": "6.0.0-beta.0 || ^6.3.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.22.6-next.0",
-    "@backstage/core-app-api": "^1.7.0-next.0",
-    "@backstage/test-utils": "^1.3.0-next.0",
+    "@backstage/cli": "^0.22.6-next.2",
+    "@backstage/core-app-api": "^1.7.0-next.2",
+    "@backstage/test-utils": "^1.3.0-next.2",
+    "@testing-library/dom": "^8.0.0",
     "@testing-library/jest-dom": "^5.10.1",
     "@testing-library/react": "^12.1.3",
     "@testing-library/react-hooks": "^8.0.0",