@backstage/plugin-search 0.7.4 → 0.8.0

package/CHANGELOG.md

@@ -1,5 +1,73 @@
 # @backstage/plugin-search
 
+## 0.8.0
+
+### Minor Changes
+
+- 520e21aaea: The following exports has now been fully deleted from this package and can be import from `@backstage/plugin-search-react` instead.
+
+  `SearchApi` interface.
+  `searchApiRef`
+  `SearchContextProvider`
+  `useSearch`
+
+  `SearchContext` has now been fully deleted from this package and is no longer exported publicly. Use `SearchContextProvider` when access to the context is needed.
+
+### Patch Changes
+
+- 7c7919777e: build(deps-dev): bump `@testing-library/react-hooks` from 7.0.2 to 8.0.0
+- 24254fd433: build(deps): bump `@testing-library/user-event` from 13.5.0 to 14.0.0
+- 5c062f275e: Support customizing the content of the `SidebarSearchModal`
+- 38e01f2f70: Switch to `SearchDocument` type in `DefaultResultListItem` props
+- 230ad0826f: Bump to using `@types/node` v16
+- ab230a433f: The following exports has been moved to `@backstage/plugin-search-react` and will be removed in the next release. import from `@backstage/plugin-search-react` instead.
+
+  - `SearchApi` interface.
+  - `searchApiRef`
+  - `SearchContext`
+  - `SearchContextProvider`
+  - `useSearch`
+
+- Updated dependencies
+  - @backstage/plugin-catalog-react@1.0.1
+  - @backstage/catalog-model@1.0.1
+  - @backstage/core-components@0.9.3
+  - @backstage/core-plugin-api@1.0.1
+  - @backstage/plugin-search-react@0.1.0
+  - @backstage/plugin-search-common@0.3.3
+
+## 0.7.5-next.1
+
+### Patch Changes
+
+- 24254fd433: build(deps): bump `@testing-library/user-event` from 13.5.0 to 14.0.0
+- 5c062f275e: Support customizing the content of the `SidebarSearchModal`
+- 230ad0826f: Bump to using `@types/node` v16
+- ab230a433f: The following exports has been moved to `@backstage/plugin-search-react` and will be removed in the next release. import from `@backstage/plugin-search-react` instead.
+
+  - `SearchApi` interface.
+  - `searchApiRef`
+  - `SearchContext`
+  - `SearchContextProvider`
+  - `useSearch`
+
+- Updated dependencies
+  - @backstage/core-components@0.9.3-next.2
+  - @backstage/core-plugin-api@1.0.1-next.0
+  - @backstage/plugin-catalog-react@1.0.1-next.3
+  - @backstage/plugin-search-react@0.1.0-next.0
+
+## 0.7.5-next.0
+
+### Patch Changes
+
+- 38e01f2f70: Switch to `SearchDocument` type in `DefaultResultListItem` props
+- Updated dependencies
+  - @backstage/catalog-model@1.0.1-next.0
+  - @backstage/plugin-search-common@0.3.3-next.0
+  - @backstage/plugin-catalog-react@1.0.1-next.0
+  - @backstage/core-components@0.9.3-next.0
+
 ## 0.7.4
 
 ### Patch Changes

package/dist/esm/{index-6c1324ea.esm.js → index-1c49a9c7.esm.js}

@@ -1,14 +1,11 @@
-import { createApiRef, useApi, AnalyticsContext, useAnalytics, configApiRef, createRouteRef, createPlugin, createApiFactory, discoveryApiRef, identityApiRef, createRoutableExtension, createComponentExtension, useRouteRef } from '@backstage/core-plugin-api';
-import { ResponseError } from '@backstage/errors';
-import qs from 'qs';
-import React, { createContext, useState, useCallback, useEffect, useContext, useRef, Fragment, cloneElement } from 'react';
+import React, { useEffect, useState, useCallback, useRef, Fragment, cloneElement } from 'react';
 import FilterListIcon from '@material-ui/icons/FilterList';
 import { makeStyles, IconButton, Typography, Card, CardHeader, Button, Divider, CardContent, Select, MenuItem, List, ListItem, Checkbox, ListItemText, InputBase, InputAdornment, TextField, Chip, FormControl, FormLabel, FormControlLabel, InputLabel, ListItemIcon, Box, Dialog, useTheme, DialogTitle, Paper, DialogContent, Grid, DialogActions, Accordion, AccordionSummary, AccordionDetails, Tabs, Tab } from '@material-ui/core';
 import useDebounce from 'react-use/lib/useDebounce';
+import { useAnalytics, useApi, configApiRef, createRouteRef, createPlugin, createApiFactory, discoveryApiRef, identityApiRef, createRoutableExtension, createComponentExtension, useRouteRef } from '@backstage/core-plugin-api';
 import SearchIcon from '@material-ui/icons/Search';
 import ClearButton from '@material-ui/icons/Clear';
-import useAsync from 'react-use/lib/useAsync';
-import usePrevious from 'react-use/lib/usePrevious';
+import { useSearch, SearchContextProvider, searchApiRef } from '@backstage/plugin-search-react';
 import { Autocomplete, Alert } from '@material-ui/lab';
 import useAsyncFn from 'react-use/lib/useAsyncFn';
 import LaunchIcon from '@material-ui/icons/Launch';
@@ -17,9 +14,13 @@ import { Link, Progress, ResponseErrorPanel, EmptyState, useContent, Table, useQ
 import TextTruncate from 'react-text-truncate';
 import ArrowBackIosIcon from '@material-ui/icons/ArrowBackIos';
 import ArrowForwardIosIcon from '@material-ui/icons/ArrowForwardIos';
+import { ResponseError } from '@backstage/errors';
+import qs from 'qs';
+import usePrevious from 'react-use/lib/usePrevious';
 import { useOutlet, useLocation } from 'react-router';
 import InputBase$1 from '@material-ui/core/InputBase';
 import IconButton$1 from '@material-ui/core/IconButton';
+import useAsync from 'react-use/lib/useAsync';
 import { catalogApiRef } from '@backstage/plugin-catalog-react';
 import { DEFAULT_NAMESPACE } from '@backstage/catalog-model';
 import useEffectOnce from 'react-use/lib/useEffectOnce';
@@ -27,28 +28,6 @@ import ExpandMoreIcon from '@material-ui/icons/ExpandMore';
 import AllIcon from '@material-ui/icons/FontDownload';
 import { useNavigate } from 'react-router-dom';
 
-const searchApiRef = createApiRef({
-  id: "plugin.search.queryservice"
-});
-class SearchClient {
-  constructor(options) {
-    this.discoveryApi = options.discoveryApi;
-    this.identityApi = options.identityApi;
-  }
-  async query(query) {
-    const { token } = await this.identityApi.getCredentials();
-    const queryString = qs.stringify(query);
-    const url = `${await this.discoveryApi.getBaseUrl("search/query")}?${queryString}`;
-    const response = await fetch(url, {
-      headers: token ? { Authorization: `Bearer ${token}` } : {}
-    });
-    if (!response.ok) {
-      throw await ResponseError.fromResponse(response);
-    }
-    return response.json();
-  }
-}
-
 const useStyles$b = makeStyles((theme) => ({
   filters: {
     width: "250px",
@@ -147,73 +126,6 @@ const Filters$1 = ({
   }))))));
 };
 
-const SearchContext = createContext(void 0);
-const searchInitialState = {
-  term: "",
-  pageCursor: void 0,
-  filters: {},
-  types: []
-};
-const SearchContextProvider = ({
-  initialState = searchInitialState,
-  children
-}) => {
-  var _a, _b, _c, _d;
-  const searchApi = useApi(searchApiRef);
-  const [pageCursor, setPageCursor] = useState(initialState.pageCursor);
-  const [filters, setFilters] = useState(initialState.filters);
-  const [term, setTerm] = useState(initialState.term);
-  const [types, setTypes] = useState(initialState.types);
-  const prevTerm = usePrevious(term);
-  const result = useAsync(() => searchApi.query({
-    term,
-    filters,
-    pageCursor,
-    types
-  }), [term, filters, types, pageCursor]);
-  const hasNextPage = !result.loading && !result.error && ((_a = result.value) == null ? void 0 : _a.nextPageCursor);
-  const hasPreviousPage = !result.loading && !result.error && ((_b = result.value) == null ? void 0 : _b.previousPageCursor);
-  const fetchNextPage = useCallback(() => {
-    var _a2;
-    setPageCursor((_a2 = result.value) == null ? void 0 : _a2.nextPageCursor);
-  }, [(_c = result.value) == null ? void 0 : _c.nextPageCursor]);
-  const fetchPreviousPage = useCallback(() => {
-    var _a2;
-    setPageCursor((_a2 = result.value) == null ? void 0 : _a2.previousPageCursor);
-  }, [(_d = result.value) == null ? void 0 : _d.previousPageCursor]);
-  useEffect(() => {
-    if (term && prevTerm && term !== prevTerm) {
-      setPageCursor(void 0);
-    }
-  }, [term, prevTerm, initialState.pageCursor]);
-  const value = {
-    result,
-    filters,
-    setFilters,
-    term,
-    setTerm,
-    types,
-    setTypes,
-    pageCursor,
-    setPageCursor,
-    fetchNextPage: hasNextPage ? fetchNextPage : void 0,
-    fetchPreviousPage: hasPreviousPage ? fetchPreviousPage : void 0
-  };
-  return /* @__PURE__ */ React.createElement(AnalyticsContext, {
-    attributes: { searchTypes: types.sort().join(",") }
-  }, /* @__PURE__ */ React.createElement(SearchContext.Provider, {
-    value,
-    children
-  }));
-};
-const useSearch = () => {
-  const context = useContext(SearchContext);
-  if (context === void 0) {
-    throw new Error("useSearch must be used within a SearchContextProvider");
-  }
-  return context;
-};
-
 const TrackSearch = ({ children }) => {
   const analytics = useAnalytics();
   const { term } = useSearch();
@@ -225,10 +137,6 @@ const TrackSearch = ({ children }) => {
   return /* @__PURE__ */ React.createElement(React.Fragment, null, children);
 };
 
-const useSearchContextCheck = () => {
-  const context = useContext(SearchContext);
-  return context !== void 0;
-};
 const SearchBarBase = ({
   onChange,
   onKeyDown,
@@ -243,7 +151,7 @@ const SearchBarBase = ({
 }) => {
   const configApi = useApi(configApiRef);
   const [value, setValue] = useState(defaultValue);
-  const hasSearchContext = useSearchContextCheck();
+  const hasSearchContext = useSearch();
   useEffect(() => {
     setValue((prevValue) => prevValue !== defaultValue ? defaultValue : prevValue);
   }, [defaultValue]);
@@ -596,6 +504,25 @@ const SearchResultPager = () => {
   }, "Next"));
 };
 
+class SearchClient {
+  constructor(options) {
+    this.discoveryApi = options.discoveryApi;
+    this.identityApi = options.identityApi;
+  }
+  async query(query) {
+    const { token } = await this.identityApi.getCredentials();
+    const queryString = qs.stringify(query);
+    const url = `${await this.discoveryApi.getBaseUrl("search/query")}?${queryString}`;
+    const response = await fetch(url, {
+      headers: token ? { Authorization: `Bearer ${token}` } : {}
+    });
+    if (!response.ok) {
+      throw await ResponseError.fromResponse(response);
+    }
+    return response.json();
+  }
+}
+
 const rootRouteRef = createRouteRef({
   id: "search"
 });
@@ -620,54 +547,54 @@ const searchPlugin = createPlugin({
 });
 const SearchPage$1 = searchPlugin.provide(createRoutableExtension({
   name: "SearchPage",
-  component: () => import('./index-c59968b8.esm.js').then((m) => m.SearchPage),
+  component: () => import('./index-e04b2cd4.esm.js').then((m) => m.SearchPage),
   mountPoint: rootRouteRef
 }));
 const SearchPageNext = searchPlugin.provide(createRoutableExtension({
   name: "SearchPageNext",
-  component: () => import('./index-c59968b8.esm.js').then((m) => m.SearchPage),
+  component: () => import('./index-e04b2cd4.esm.js').then((m) => m.SearchPage),
   mountPoint: rootNextRouteRef
 }));
 searchPlugin.provide(createComponentExtension({
   name: "SearchBar",
   component: {
-    lazy: () => import('./index-5c70689c.esm.js').then((m) => m.SearchBar)
+    lazy: () => import('./index-b51ef5f2.esm.js').then((m) => m.SearchBar)
   }
 }));
 const SearchBarNext = searchPlugin.provide(createComponentExtension({
   name: "SearchBarNext",
   component: {
-    lazy: () => import('./index-5c70689c.esm.js').then((m) => m.SearchBar)
+    lazy: () => import('./index-b51ef5f2.esm.js').then((m) => m.SearchBar)
   }
 }));
 const SearchResult$1 = searchPlugin.provide(createComponentExtension({
   name: "SearchResult",
   component: {
-    lazy: () => import('./index-ecefd17e.esm.js').then((m) => m.SearchResult)
+    lazy: () => import('./index-21e72471.esm.js').then((m) => m.SearchResult)
   }
 }));
 searchPlugin.provide(createComponentExtension({
   name: "SearchResultNext",
   component: {
-    lazy: () => import('./index-ecefd17e.esm.js').then((m) => m.SearchResult)
+    lazy: () => import('./index-21e72471.esm.js').then((m) => m.SearchResult)
   }
 }));
 const SidebarSearchModal = searchPlugin.provide(createComponentExtension({
   name: "SidebarSearchModal",
   component: {
-    lazy: () => import('./index-6dc0dac9.esm.js').then((m) => m.SidebarSearchModal)
+    lazy: () => import('./index-9b2b2a0c.esm.js').then((m) => m.SidebarSearchModal)
   }
 }));
 const DefaultResultListItem = searchPlugin.provide(createComponentExtension({
   name: "DefaultResultListItem",
   component: {
-    lazy: () => import('./index-5122e36b.esm.js').then((m) => m.DefaultResultListItem)
+    lazy: () => import('./index-ad938c17.esm.js').then((m) => m.DefaultResultListItem)
   }
 }));
 const HomePageSearchBar = searchPlugin.provide(createComponentExtension({
   name: "HomePageSearchBar",
   component: {
-    lazy: () => import('./index-c88298b1.esm.js').then((m) => m.HomePageSearchBar)
+    lazy: () => import('./index-ca20fb56.esm.js').then((m) => m.HomePageSearchBar)
   }
 }));
 
@@ -740,8 +667,10 @@ const Modal = ({ toggleModal }) => {
 const SearchModal = ({
   open = true,
   hidden,
-  toggleModal
+  toggleModal,
+  children
 }) => {
+  var _a;
   const classes = useStyles$7();
   return /* @__PURE__ */ React.createElement(Dialog, {
     classes: {
@@ -753,7 +682,7 @@ const SearchModal = ({
     maxWidth: "lg",
     open,
     hidden
-  }, open && /* @__PURE__ */ React.createElement(SearchContextProvider, null, /* @__PURE__ */ React.createElement(Modal, {
+  }, open && /* @__PURE__ */ React.createElement(SearchContextProvider, null, (_a = children && children({ toggleModal })) != null ? _a : /* @__PURE__ */ React.createElement(Modal, {
     toggleModal
   })));
 };
@@ -1323,7 +1252,8 @@ const SearchTypeTabs = (props) => {
     indicatorColor: "primary",
     value: types.length === 0 ? "" : types[0],
     onChange: changeTab
-  }, definedTypes.map((type) => /* @__PURE__ */ React.createElement(Tab, {
+  }, definedTypes.map((type, idx) => /* @__PURE__ */ React.createElement(Tab, {
+    key: idx,
     className: classes.tab,
     disableRipple: true,
     label: type.name,
@@ -1419,5 +1349,5 @@ const SidebarSearch = (props) => {
   });
 };
 
-export { DefaultResultListItem$1 as D, Filters$1 as F, HomePageSearchBar as H, SearchPage as S, SearchBar$1 as a, SearchBarBase as b, SearchResultComponent as c, SearchModal as d, FiltersButton$1 as e, SearchContextProvider as f, useSearch as g, SearchFilter as h, SearchFilterNext as i, SearchResultPager as j, SearchType as k, SidebarSearch as l, DefaultResultListItem as m, SearchBarNext as n, SearchPage$1 as o, SearchPageNext as p, searchPlugin as q, rootRouteRef as r, searchApiRef as s, SearchResult$1 as t, useSearchModal as u, SidebarSearchModal as v };
-//# sourceMappingURL=index-6c1324ea.esm.js.map
+export { DefaultResultListItem$1 as D, Filters$1 as F, HomePageSearchBar as H, SearchPage as S, SearchBar$1 as a, SearchBarBase as b, SearchResultComponent as c, SearchModal as d, FiltersButton$1 as e, SearchFilter as f, SearchFilterNext as g, SearchResultPager as h, SearchType as i, SidebarSearch as j, DefaultResultListItem as k, SearchBarNext as l, SearchPage$1 as m, SearchPageNext as n, SearchResult$1 as o, SidebarSearchModal as p, rootRouteRef as r, searchPlugin as s, useSearchModal as u };
+//# sourceMappingURL=index-1c49a9c7.esm.js.map