@backstage/plugin-search 0.8.2-next.2 → 0.9.1-next.1

package/CHANGELOG.md

@@ -1,5 +1,58 @@
 # @backstage/plugin-search
 
+## 0.9.1-next.1
+
+### Patch Changes
+
+- 509c4092f0: To allow people to use a global search context in the search modal, the code for the search modal has been changed to only create a local search context if there is no parent context already defined.
+
+  If you want to continue using a local context even if you define a global one, you will have to wrap the modal in a new local context manually:
+
+  ```tsx
+  <SearchContextProvider>
+    <SearchModal toggleModal={toggleModal} />
+  </SearchContextProvider>
+  ```
+
+- Updated dependencies
+  - @backstage/core-components@0.9.6-next.1
+  - @backstage/catalog-model@1.1.0-next.1
+  - @backstage/errors@1.1.0-next.0
+  - @backstage/theme@0.2.16-next.0
+  - @backstage/plugin-catalog-react@1.1.2-next.1
+  - @backstage/plugin-search-common@0.3.6-next.0
+  - @backstage/plugin-search-react@0.2.2-next.1
+
+## 0.9.1-next.0
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/catalog-model@1.1.0-next.0
+  - @backstage/core-components@0.9.6-next.0
+  - @backstage/plugin-catalog-react@1.1.2-next.0
+  - @backstage/plugin-search-react@0.2.2-next.0
+
+## 0.9.0
+
+### Minor Changes
+
+- 2dc4818541: The pre-alpha `<SearchPageNext>`, `<SearchBarNext>`, `etc...` components have been removed. In the unlikely event you were still using/referencing them, please update to using their non-`*Next` equivalents from either `@backstage/plugin-search-react` or `@backstage/plugin-search`.
+
+### Patch Changes
+
+- 8809159148: Components `<DefaultResultListItem>`, `<SearchBar>` (including `<SearchBarBase>`), `<SearchFilter>` (including `.Checkbox`, `.Select`, and `.Autocomplete` static prop components), `<SearchResult>`, and `<SearchResultPager>` are now exported from `@backstage/plugin-search-react`. They are now deprecated in `@backstage/plugin-search` and will be removed in a future release.
+- 8f7b1835df: Updated dependency `msw` to `^0.41.0`.
+- 5388e6bdc5: Fixed a bug that could cause analytics events in other parts of Backstage to capture nonsensical values resembling search modal state under some circumstances.
+- 915700f64f: In order to simplify analytics on top of the search experience in Backstage, the provided `<*ResultListItem />` component now captures a `discover` analytics event instead of a `click` event. This event includes the result rank as its `value` and, like a click, the URL/path clicked to as its `to` attribute.
+- Updated dependencies
+  - @backstage/plugin-catalog-react@1.1.1
+  - @backstage/plugin-search-common@0.3.5
+  - @backstage/plugin-search-react@0.2.1
+  - @backstage/core-components@0.9.5
+  - @backstage/core-plugin-api@1.0.3
+  - @backstage/catalog-model@1.0.3
+
 ## 0.8.2-next.2
 
 ### Patch Changes

package/README.md

@@ -13,14 +13,17 @@ Run `yarn dev` in the root directory, and then navigate to [/search](http://loca
 This search plugin is primarily responsible for the following:
 
 - Providing a `<SearchPage />` routable extension.
-- Exposing various search-related components (like `<SearchBar />`,
-  `<SearchFilter />`, etc), which can be composed by a Backstage App or by
+- Exposing various search-related components (like `<SearchModal />`,
+  `<SidebarSearch />`, etc), which can be composed by a Backstage App or by
   other Backstage Plugins to power search experiences of all kinds.
-- Exposing a `<SearchContextProvider />`, which manages search state and API
-  communication with the Backstage backend.
 
-Don't forget, a lot of functionality is available in backend plugins:
+Don't forget, a lot of functionality is available in web libraries and backend plugins:
 
+- `@backstage/plugin-search-react`, which is responsible for:
+  - Exposing a `<SearchContextProvider />`, which manages search state and API
+    communication with the Backstage backend.
+  - Exposing the `SearchApi` and its corresponding ref.
+  - Exposing reusable components, such as `<SearchBar>` and `<SearchFilter>`, etc.
 - `@backstage/plugin-search-backend-node`, which is responsible for the search
   index management
 - `@backstage/plugin-search-backend`, which is responsible for query processing

package/dist/esm/{index-b9062edb.esm.js → index-2e41707a.esm.js}

@@ -1,31 +1,30 @@
-export { S as SearchPage } from './index-c59424ea.esm.js';
+export { S as SearchPage } from './index-5187be91.esm.js';
 import 'react';
 import '@material-ui/icons/FilterList';
 import '@material-ui/core';
-import 'react-use/lib/useDebounce';
-import '@backstage/core-plugin-api';
-import '@material-ui/icons/Search';
-import '@material-ui/icons/Clear';
 import '@backstage/plugin-search-react';
-import '@material-ui/lab';
-import 'react-use/lib/useAsyncFn';
 import '@material-ui/icons/Launch';
 import '@material-ui/core/styles';
+import '@backstage/core-plugin-api';
 import '@backstage/core-components';
-import '@material-ui/icons/ArrowBackIos';
-import '@material-ui/icons/ArrowForwardIos';
 import '@backstage/errors';
 import 'qs';
 import '@backstage/version-bridge';
 import 'react-use/lib/usePrevious';
 import 'react-router';
+import 'react-use/lib/useDebounce';
 import '@material-ui/core/InputBase';
 import '@material-ui/core/IconButton';
+import '@material-ui/icons/Search';
+import '@material-ui/icons/Clear';
+import '@material-ui/lab';
 import 'react-use/lib/useAsync';
 import '@backstage/plugin-catalog-react';
 import '@backstage/catalog-model';
+import '@material-ui/icons/ArrowBackIos';
+import '@material-ui/icons/ArrowForwardIos';
 import 'react-use/lib/useEffectOnce';
 import '@material-ui/icons/ExpandMore';
 import '@material-ui/icons/FontDownload';
 import 'react-router-dom';
-//# sourceMappingURL=index-b9062edb.esm.js.map
+//# sourceMappingURL=index-2e41707a.esm.js.map

package/dist/esm/index-2e41707a.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-2e41707a.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/esm/{index-1c96b52b.esm.js → index-30f1f9c5.esm.js}

@@ -1,29 +1,28 @@
 import React from 'react';
 import SearchIcon from '@material-ui/icons/Search';
 import { SidebarItem } from '@backstage/core-components';
-import { d as SearchModalProvider, u as useSearchModal, e as SearchModal } from './index-c59424ea.esm.js';
+import { a as SearchModalProvider, u as useSearchModal, b as SearchModal } from './index-5187be91.esm.js';
 import '@material-ui/icons/FilterList';
 import '@material-ui/core';
-import 'react-use/lib/useDebounce';
-import '@backstage/core-plugin-api';
-import '@material-ui/icons/Clear';
 import '@backstage/plugin-search-react';
-import '@material-ui/lab';
-import 'react-use/lib/useAsyncFn';
 import '@material-ui/icons/Launch';
 import '@material-ui/core/styles';
-import '@material-ui/icons/ArrowBackIos';
-import '@material-ui/icons/ArrowForwardIos';
+import '@backstage/core-plugin-api';
 import '@backstage/errors';
 import 'qs';
 import '@backstage/version-bridge';
 import 'react-use/lib/usePrevious';
 import 'react-router';
+import 'react-use/lib/useDebounce';
 import '@material-ui/core/InputBase';
 import '@material-ui/core/IconButton';
+import '@material-ui/icons/Clear';
+import '@material-ui/lab';
 import 'react-use/lib/useAsync';
 import '@backstage/plugin-catalog-react';
 import '@backstage/catalog-model';
+import '@material-ui/icons/ArrowBackIos';
+import '@material-ui/icons/ArrowForwardIos';
 import 'react-use/lib/useEffectOnce';
 import '@material-ui/icons/ExpandMore';
 import '@material-ui/icons/FontDownload';
@@ -50,4 +49,4 @@ const SidebarSearchModal = (props) => {
 };
 
 export { SidebarSearchModal };
-//# sourceMappingURL=index-1c96b52b.esm.js.map
+//# sourceMappingURL=index-30f1f9c5.esm.js.map

package/dist/esm/index-30f1f9c5.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-30f1f9c5.esm.js","sources":["../../src/components/SidebarSearchModal/SidebarSearchModal.tsx"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport React from 'react';\nimport SearchIcon from '@material-ui/icons/Search';\nimport { SidebarItem } from '@backstage/core-components';\nimport { IconComponent } from '@backstage/core-plugin-api';\nimport {\n  SearchModal,\n  SearchModalChildrenProps,\n  SearchModalProvider,\n  useSearchModal,\n} from '../SearchModal';\n\n/**\n * Props for {@link SidebarSearchModal}.\n *\n * @public\n */\nexport type SidebarSearchModalProps = {\n  icon?: IconComponent;\n  children?: (props: SearchModalChildrenProps) => JSX.Element;\n};\n\nconst SidebarSearchModalContent = (props: SidebarSearchModalProps) => {\n  const { state, toggleModal } = useSearchModal();\n  const Icon = props.icon ? props.icon : SearchIcon;\n\n  return (\n    <>\n      <SidebarItem\n        className=\"search-icon\"\n        icon={Icon}\n        text=\"Search\"\n        onClick={toggleModal}\n      />\n      <SearchModal\n        {...state}\n        toggleModal={toggleModal}\n        children={props.children}\n      />\n    </>\n  );\n};\n\nexport const SidebarSearchModal = (props: SidebarSearchModalProps) => {\n  return (\n    <SearchModalProvider>\n      <SidebarSearchModalContent {...props} />\n    </SearchModalProvider>\n  );\n};\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAQA,MAAM,yBAAyB,GAAG,CAAC,KAAK,KAAK;AAC7C,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,cAAc,EAAE,CAAC;AAClD,EAAE,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,GAAG,UAAU,CAAC;AACpD,EAAE,uBAAuB,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,kBAAkB,KAAK,CAAC,aAAa,CAAC,WAAW,EAAE;AACpH,IAAI,SAAS,EAAE,aAAa;AAC5B,IAAI,IAAI,EAAE,IAAI;AACd,IAAI,IAAI,EAAE,QAAQ;AAClB,IAAI,OAAO,EAAE,WAAW;AACxB,GAAG,CAAC,kBAAkB,KAAK,CAAC,aAAa,CAAC,WAAW,EAAE;AACvD,IAAI,GAAG,KAAK;AACZ,IAAI,WAAW;AACf,IAAI,QAAQ,EAAE,KAAK,CAAC,QAAQ;AAC5B,GAAG,CAAC,CAAC,CAAC;AACN,CAAC,CAAC;AACU,MAAC,kBAAkB,GAAG,CAAC,KAAK,KAAK;AAC7C,EAAE,uBAAuB,KAAK,CAAC,aAAa,CAAC,mBAAmB,EAAE,IAAI,kBAAkB,KAAK,CAAC,aAAa,CAAC,yBAAyB,EAAE;AACvI,IAAI,GAAG,KAAK;AACZ,GAAG,CAAC,CAAC,CAAC;AACN;;;;"}

package/dist/esm/{index-c08cd99a.esm.js → index-50da964c.esm.js}

@@ -1,30 +1,29 @@
 import React, { useCallback, useState } from 'react';
 import { makeStyles } from '@material-ui/core/styles';
-import { r as rootRouteRef, b as SearchBarBase } from './index-c59424ea.esm.js';
+import { SearchBarBase } from '@backstage/plugin-search-react';
 import qs from 'qs';
 import { useNavigate } from 'react-router-dom';
+import { r as rootRouteRef } from './index-5187be91.esm.js';
 import { useRouteRef } from '@backstage/core-plugin-api';
 import '@material-ui/icons/FilterList';
 import '@material-ui/core';
-import 'react-use/lib/useDebounce';
-import '@material-ui/icons/Search';
-import '@material-ui/icons/Clear';
-import '@backstage/plugin-search-react';
-import '@material-ui/lab';
-import 'react-use/lib/useAsyncFn';
 import '@material-ui/icons/Launch';
 import '@backstage/core-components';
-import '@material-ui/icons/ArrowBackIos';
-import '@material-ui/icons/ArrowForwardIos';
 import '@backstage/errors';
 import '@backstage/version-bridge';
 import 'react-use/lib/usePrevious';
 import 'react-router';
+import 'react-use/lib/useDebounce';
 import '@material-ui/core/InputBase';
 import '@material-ui/core/IconButton';
+import '@material-ui/icons/Search';
+import '@material-ui/icons/Clear';
+import '@material-ui/lab';
 import 'react-use/lib/useAsync';
 import '@backstage/plugin-catalog-react';
 import '@backstage/catalog-model';
+import '@material-ui/icons/ArrowBackIos';
+import '@material-ui/icons/ArrowForwardIos';
 import 'react-use/lib/useEffectOnce';
 import '@material-ui/icons/ExpandMore';
 import '@material-ui/icons/FontDownload';
@@ -65,4 +64,4 @@ const HomePageSearchBar = ({ ...props }) => {
 };
 
 export { HomePageSearchBar };
-//# sourceMappingURL=index-c08cd99a.esm.js.map
+//# sourceMappingURL=index-50da964c.esm.js.map

package/dist/esm/index-50da964c.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-50da964c.esm.js","sources":["../../src/components/util.ts","../../src/components/HomePageComponent/HomePageSearchBar.tsx"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport qs from 'qs';\nimport { useCallback } from 'react';\nimport { useNavigate } from 'react-router-dom';\nimport { rootRouteRef } from '../plugin';\n\nimport { useRouteRef } from '@backstage/core-plugin-api';\n\nexport const useNavigateToQuery = () => {\n  const searchRoute = useRouteRef(rootRouteRef);\n  const navigate = useNavigate();\n  return useCallback(\n    ({ query }: { query: string }): void => {\n      const queryString = qs.stringify({ query }, { addQueryPrefix: true });\n\n      navigate(`${searchRoute()}${queryString}`);\n    },\n    [navigate, searchRoute],\n  );\n};\n","/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport React, { useCallback, useState } from 'react';\nimport { makeStyles } from '@material-ui/core/styles';\nimport {\n  SearchBarBase,\n  SearchBarBaseProps,\n} from '@backstage/plugin-search-react';\nimport { useNavigateToQuery } from '../util';\n\nconst useStyles = makeStyles({\n  root: {\n    border: '1px solid #555',\n    borderRadius: '6px',\n    fontSize: '1.5em',\n  },\n});\n\n/**\n * Props for {@link HomePageSearchBar}.\n *\n * @public\n */\nexport type HomePageSearchBarProps = Partial<\n  Omit<SearchBarBaseProps, 'onChange' | 'onSubmit'>\n>;\n\n/**\n * The search bar created specifically for the composable home page.\n */\nexport const HomePageSearchBar = ({ ...props }: HomePageSearchBarProps) => {\n  const classes = useStyles(props);\n  const [query, setQuery] = useState('');\n  const handleSearch = useNavigateToQuery();\n\n  const handleSubmit = () => {\n    handleSearch({ query });\n  };\n\n  const handleChange = useCallback(\n    value => {\n      setQuery(value);\n    },\n    [setQuery],\n  );\n\n  return (\n    <SearchBarBase\n      classes={{ root: classes.root }}\n      value={query}\n      onSubmit={handleSubmit}\n      onChange={handleChange}\n      {...props}\n    />\n  );\n};\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAKO,MAAM,kBAAkB,GAAG,MAAM;AACxC,EAAE,MAAM,WAAW,GAAG,WAAW,CAAC,YAAY,CAAC,CAAC;AAChD,EAAE,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;AACjC,EAAE,OAAO,WAAW,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK;AACpC,IAAI,MAAM,WAAW,GAAG,EAAE,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC;AAC1E,IAAI,QAAQ,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;AAC/C,GAAG,EAAE,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC;AAC9B,CAAC;;ACND,MAAM,SAAS,GAAG,UAAU,CAAC;AAC7B,EAAE,IAAI,EAAE;AACR,IAAI,MAAM,EAAE,gBAAgB;AAC5B,IAAI,YAAY,EAAE,KAAK;AACvB,IAAI,QAAQ,EAAE,OAAO;AACrB,GAAG;AACH,CAAC,CAAC,CAAC;AACS,MAAC,iBAAiB,GAAG,CAAC,EAAE,GAAG,KAAK,EAAE,KAAK;AACnD,EAAE,MAAM,OAAO,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;AACnC,EAAE,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC;AACzC,EAAE,MAAM,YAAY,GAAG,kBAAkB,EAAE,CAAC;AAC5C,EAAE,MAAM,YAAY,GAAG,MAAM;AAC7B,IAAI,YAAY,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;AAC5B,GAAG,CAAC;AACJ,EAAE,MAAM,YAAY,GAAG,WAAW,CAAC,CAAC,KAAK,KAAK;AAC9C,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC;AACpB,GAAG,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;AACjB,EAAE,uBAAuB,KAAK,CAAC,aAAa,CAAC,aAAa,EAAE;AAC5D,IAAI,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE;AACnC,IAAI,KAAK,EAAE,KAAK;AAChB,IAAI,QAAQ,EAAE,YAAY;AAC1B,IAAI,QAAQ,EAAE,YAAY;AAC1B,IAAI,GAAG,KAAK;AACZ,GAAG,CAAC,CAAC;AACL;;;;"}