@backstage/plugin-search 1.4.22 → 1.4.23-next.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/dist/alpha.d.ts +28 -0
  3. package/dist/alpha.esm.js +16 -4
  4. package/dist/alpha.esm.js.map +1 -1
  5. package/package.json +15 -15
package/CHANGELOG.md CHANGED
@@ -1,5 +1,22 @@
1
1
  # @backstage/plugin-search
2
2
 
3
+ ## 1.4.23-next.0
4
+
5
+ ### Patch Changes
6
+
7
+ - 63e1012: Added new extension points to extend search filters `SearchFilterBlueprint` and `SearchFilterResultTypeBlueprint`
8
+ - Updated dependencies
9
+ - @backstage/plugin-search-react@1.8.6-next.0
10
+ - @backstage/frontend-plugin-api@0.9.5-next.0
11
+ - @backstage/core-compat-api@0.3.6-next.0
12
+ - @backstage/core-components@0.16.3
13
+ - @backstage/core-plugin-api@1.10.3
14
+ - @backstage/errors@1.2.7
15
+ - @backstage/types@1.2.1
16
+ - @backstage/version-bridge@1.0.10
17
+ - @backstage/plugin-catalog-react@1.15.2-next.0
18
+ - @backstage/plugin-search-common@1.2.17
19
+
3
20
  ## 1.4.22
4
21
 
5
22
  ### Patch Changes
package/dist/alpha.d.ts CHANGED
@@ -38,6 +38,20 @@ declare const searchPage: _backstage_frontend_plugin_api.ExtensionDefinition<{
38
38
  singleton: false;
39
39
  optional: false;
40
40
  }>;
41
+ resultTypes: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.ConfigurableExtensionDataRef<{
42
+ value: string;
43
+ name: string;
44
+ icon: JSX.Element;
45
+ }, "search.filters.result-types.type", {}>, {
46
+ singleton: false;
47
+ optional: false;
48
+ }>;
49
+ searchFilters: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.ConfigurableExtensionDataRef<{
50
+ component: _backstage_plugin_search_react_alpha.SearchFilterExtensionComponent;
51
+ }, "search.filters.filter", {}>, {
52
+ singleton: false;
53
+ optional: false;
54
+ }>;
41
55
  };
42
56
  kind: "page";
43
57
  name: undefined;
@@ -119,6 +133,20 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
119
133
  singleton: false;
120
134
  optional: false;
121
135
  }>;
136
+ resultTypes: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.ConfigurableExtensionDataRef<{
137
+ value: string;
138
+ name: string;
139
+ icon: JSX.Element;
140
+ }, "search.filters.result-types.type", {}>, {
141
+ singleton: false;
142
+ optional: false;
143
+ }>;
144
+ searchFilters: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.ConfigurableExtensionDataRef<{
145
+ component: _backstage_plugin_search_react_alpha.SearchFilterExtensionComponent;
146
+ }, "search.filters.filter", {}>, {
147
+ singleton: false;
148
+ optional: false;
149
+ }>;
122
150
  };
123
151
  kind: "page";
124
152
  name: undefined;
package/dist/alpha.esm.js CHANGED
@@ -8,7 +8,7 @@ import { createApiFactory, discoveryApiRef, fetchApiRef, useApi } from '@backsta
8
8
  import { ApiBlueprint, PageBlueprint, createExtensionInput, NavItemBlueprint, createFrontendPlugin } from '@backstage/frontend-plugin-api';
9
9
  import { catalogApiRef, CATALOG_FILTER_EXISTS } from '@backstage/plugin-catalog-react';
10
10
  import { searchApiRef, SearchContextProvider, useSearch, SearchBar, SearchFilter, SearchPagination, SearchResult, SearchResultPager, DefaultResultListItem } from '@backstage/plugin-search-react';
11
- import { SearchResultListItemBlueprint } from '@backstage/plugin-search-react/alpha';
11
+ import { SearchResultListItemBlueprint, SearchFilterResultTypeBlueprint, SearchFilterBlueprint } from '@backstage/plugin-search-react/alpha';
12
12
  import { rootRouteRef } from './plugin.esm.js';
13
13
  import { SearchClient } from './apis.esm.js';
14
14
  import { SearchType } from './components/SearchType/SearchType.esm.js';
@@ -42,7 +42,13 @@ const searchPage = PageBlueprint.makeWithOverrides({
42
42
  }
43
43
  },
44
44
  inputs: {
45
- items: createExtensionInput([SearchResultListItemBlueprint.dataRefs.item])
45
+ items: createExtensionInput([SearchResultListItemBlueprint.dataRefs.item]),
46
+ resultTypes: createExtensionInput([
47
+ SearchFilterResultTypeBlueprint.dataRefs.resultType
48
+ ]),
49
+ searchFilters: createExtensionInput([
50
+ SearchFilterBlueprint.dataRefs.searchFilters
51
+ ])
46
52
  },
47
53
  factory(originalFactory, { config, inputs }) {
48
54
  return originalFactory({
@@ -55,6 +61,12 @@ const searchPage = PageBlueprint.makeWithOverrides({
55
61
  );
56
62
  return value?.get(SearchResultListItemBlueprint.dataRefs.item).component ?? DefaultResultListItem;
57
63
  };
64
+ const resultTypes = inputs.resultTypes.map(
65
+ (item) => item.get(SearchFilterResultTypeBlueprint.dataRefs.resultType)
66
+ );
67
+ const additionalSearchFilters = inputs.searchFilters.map(
68
+ (item) => item.get(SearchFilterBlueprint.dataRefs.searchFilters).component
69
+ );
58
70
  const Component = () => {
59
71
  const classes = useSearchPageStyles();
60
72
  const { isMobile } = useSidebarPinState();
@@ -77,7 +89,7 @@ const searchPage = PageBlueprint.makeWithOverrides({
77
89
  name: "Documentation",
78
90
  icon: /* @__PURE__ */ React.createElement(DocsIcon, null)
79
91
  }
80
- ]
92
+ ].concat(resultTypes)
81
93
  }
82
94
  ), /* @__PURE__ */ React.createElement(Paper, { className: classes.filters }, types.includes("techdocs") && /* @__PURE__ */ React.createElement(
83
95
  SearchFilter.Select,
@@ -115,7 +127,7 @@ const searchPage = PageBlueprint.makeWithOverrides({
115
127
  name: "lifecycle",
116
128
  values: ["experimental", "production"]
117
129
  }
118
- ))), /* @__PURE__ */ React.createElement(Grid, { item: true, xs: true }, /* @__PURE__ */ React.createElement(SearchPagination, null), /* @__PURE__ */ React.createElement(SearchResult, null, ({ results }) => /* @__PURE__ */ React.createElement(React.Fragment, null, results.map((result, index) => {
130
+ ), additionalSearchFilters.map((SearchFilterComponent) => /* @__PURE__ */ React.createElement(SearchFilterComponent, { className: classes.filter })))), /* @__PURE__ */ React.createElement(Grid, { item: true, xs: true }, /* @__PURE__ */ React.createElement(SearchPagination, null), /* @__PURE__ */ React.createElement(SearchResult, null, ({ results }) => /* @__PURE__ */ React.createElement(React.Fragment, null, results.map((result, index) => {
119
131
  const { noTrack } = config;
120
132
  const { document, ...rest } = result;
121
133
  const SearchResultListItem = getResultItemComponent(result);
package/dist/alpha.esm.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"alpha.esm.js","sources":["../src/alpha.tsx"],"sourcesContent":["/*\n * Copyright 2023 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 from 'react';\n\nimport Grid from '@material-ui/core/Grid';\nimport Paper from '@material-ui/core/Paper';\nimport { makeStyles, Theme } from '@material-ui/core/styles';\nimport SearchIcon from '@material-ui/icons/Search';\n\nimport {\n CatalogIcon,\n Content,\n DocsIcon,\n Header,\n Page,\n useSidebarPinState,\n} from '@backstage/core-components';\nimport {\n useApi,\n discoveryApiRef,\n fetchApiRef,\n createApiFactory,\n} from '@backstage/core-plugin-api';\n\nimport {\n createFrontendPlugin,\n ApiBlueprint,\n createExtensionInput,\n PageBlueprint,\n NavItemBlueprint,\n} from '@backstage/frontend-plugin-api';\n\nimport {\n catalogApiRef,\n CATALOG_FILTER_EXISTS,\n} from '@backstage/plugin-catalog-react';\n\nimport {\n DefaultResultListItem,\n SearchBar,\n SearchFilter,\n SearchPagination,\n SearchResult as SearchResults,\n SearchResultPager,\n useSearch,\n SearchContextProvider,\n} from '@backstage/plugin-search-react';\nimport { SearchResult } from '@backstage/plugin-search-common';\nimport { searchApiRef } from '@backstage/plugin-search-react';\nimport { SearchResultListItemBlueprint } from '@backstage/plugin-search-react/alpha';\n\nimport { rootRouteRef } from './plugin';\nimport { SearchClient } from './apis';\nimport { SearchType } from './components/SearchType';\nimport { UrlUpdater } from './components/SearchPage/SearchPage';\nimport {\n compatWrapper,\n convertLegacyRouteRef,\n convertLegacyRouteRefs,\n} from '@backstage/core-compat-api';\n\n/** @alpha */\nexport const searchApi = ApiBlueprint.make({\n params: {\n factory: createApiFactory({\n api: searchApiRef,\n deps: { discoveryApi: discoveryApiRef, fetchApi: fetchApiRef },\n factory: ({ discoveryApi, fetchApi }) =>\n new SearchClient({ discoveryApi, fetchApi }),\n }),\n },\n});\n\nconst useSearchPageStyles = makeStyles((theme: Theme) => ({\n filter: {\n '& + &': {\n marginTop: theme.spacing(2.5),\n },\n },\n filters: {\n padding: theme.spacing(2),\n marginTop: theme.spacing(2),\n },\n}));\n\n/** @alpha */\nexport const searchPage = PageBlueprint.makeWithOverrides({\n config: {\n schema: {\n noTrack: z => z.boolean().default(false),\n },\n },\n inputs: {\n items: createExtensionInput([SearchResultListItemBlueprint.dataRefs.item]),\n },\n factory(originalFactory, { config, inputs }) {\n return originalFactory({\n defaultPath: '/search',\n routeRef: convertLegacyRouteRef(rootRouteRef),\n loader: async () => {\n const getResultItemComponent = (result: SearchResult) => {\n const value = inputs.items.find(item =>\n item\n ?.get(SearchResultListItemBlueprint.dataRefs.item)\n .predicate?.(result),\n );\n return (\n value?.get(SearchResultListItemBlueprint.dataRefs.item).component ??\n DefaultResultListItem\n );\n };\n\n const Component = () => {\n const classes = useSearchPageStyles();\n const { isMobile } = useSidebarPinState();\n const { types } = useSearch();\n const catalogApi = useApi(catalogApiRef);\n\n return (\n <Page themeId=\"home\">\n {!isMobile && <Header title=\"Search\" />}\n <Content>\n <Grid container direction=\"row\">\n <Grid item xs={12}>\n <SearchBar debounceTime={100} />\n </Grid>\n {!isMobile && (\n <Grid item xs={3}>\n <SearchType.Accordion\n name=\"Result Type\"\n defaultValue=\"software-catalog\"\n showCounts\n types={[\n {\n value: 'software-catalog',\n name: 'Software Catalog',\n icon: <CatalogIcon />,\n },\n {\n value: 'techdocs',\n name: 'Documentation',\n icon: <DocsIcon />,\n },\n ]}\n />\n <Paper className={classes.filters}>\n {types.includes('techdocs') && (\n <SearchFilter.Select\n className={classes.filter}\n label=\"Entity\"\n name=\"name\"\n values={async () => {\n // Return a list of entities which are documented.\n const { items } = await catalogApi.getEntities({\n fields: ['metadata.name'],\n filter: {\n 'metadata.annotations.backstage.io/techdocs-ref':\n CATALOG_FILTER_EXISTS,\n },\n });\n\n const names = items.map(\n entity => entity.metadata.name,\n );\n names.sort();\n return names;\n }}\n />\n )}\n <SearchFilter.Select\n className={classes.filter}\n label=\"Kind\"\n name=\"kind\"\n values={['Component', 'Template']}\n />\n <SearchFilter.Checkbox\n className={classes.filter}\n label=\"Lifecycle\"\n name=\"lifecycle\"\n values={['experimental', 'production']}\n />\n </Paper>\n </Grid>\n )}\n <Grid item xs>\n <SearchPagination />\n <SearchResults>\n {({ results }) => (\n <>\n {results.map((result, index) => {\n const { noTrack } = config;\n const { document, ...rest } = result;\n const SearchResultListItem =\n getResultItemComponent(result);\n return (\n <SearchResultListItem\n {...rest}\n key={index}\n result={document}\n noTrack={noTrack}\n />\n );\n })}\n </>\n )}\n </SearchResults>\n <SearchResultPager />\n </Grid>\n </Grid>\n </Content>\n </Page>\n );\n };\n\n return compatWrapper(\n <SearchContextProvider>\n <UrlUpdater />\n <Component />\n </SearchContextProvider>,\n );\n },\n });\n },\n});\n\n/** @alpha */\nexport const searchNavItem = NavItemBlueprint.make({\n params: {\n routeRef: convertLegacyRouteRef(rootRouteRef),\n title: 'Search',\n icon: SearchIcon,\n },\n});\n\n/** @alpha */\nexport default createFrontendPlugin({\n id: 'search',\n extensions: [searchApi, searchPage, searchNavItem],\n routes: convertLegacyRouteRefs({\n root: rootRouteRef,\n }),\n});\n"],"names":["SearchResults"],"mappings":";;;;;;;;;;;;;;;;;AA4Ea,MAAA,SAAA,GAAY,aAAa,IAAK,CAAA;AAAA,EACzC,MAAQ,EAAA;AAAA,IACN,SAAS,gBAAiB,CAAA;AAAA,MACxB,GAAK,EAAA,YAAA;AAAA,MACL,IAAM,EAAA,EAAE,YAAc,EAAA,eAAA,EAAiB,UAAU,WAAY,EAAA;AAAA,MAC7D,OAAA,EAAS,CAAC,EAAE,YAAc,EAAA,QAAA,EACxB,KAAA,IAAI,YAAa,CAAA,EAAE,YAAc,EAAA,QAAA,EAAU;AAAA,KAC9C;AAAA;AAEL,CAAC;AAED,MAAM,mBAAA,GAAsB,UAAW,CAAA,CAAC,KAAkB,MAAA;AAAA,EACxD,MAAQ,EAAA;AAAA,IACN,OAAS,EAAA;AAAA,MACP,SAAA,EAAW,KAAM,CAAA,OAAA,CAAQ,GAAG;AAAA;AAC9B,GACF;AAAA,EACA,OAAS,EAAA;AAAA,IACP,OAAA,EAAS,KAAM,CAAA,OAAA,CAAQ,CAAC,CAAA;AAAA,IACxB,SAAA,EAAW,KAAM,CAAA,OAAA,CAAQ,CAAC;AAAA;AAE9B,CAAE,CAAA,CAAA;AAGW,MAAA,UAAA,GAAa,cAAc,iBAAkB,CAAA;AAAA,EACxD,MAAQ,EAAA;AAAA,IACN,MAAQ,EAAA;AAAA,MACN,SAAS,CAAK,CAAA,KAAA,CAAA,CAAE,OAAQ,EAAA,CAAE,QAAQ,KAAK;AAAA;AACzC,GACF;AAAA,EACA,MAAQ,EAAA;AAAA,IACN,OAAO,oBAAqB,CAAA,CAAC,6BAA8B,CAAA,QAAA,CAAS,IAAI,CAAC;AAAA,GAC3E;AAAA,EACA,OAAQ,CAAA,eAAA,EAAiB,EAAE,MAAA,EAAQ,QAAU,EAAA;AAC3C,IAAA,OAAO,eAAgB,CAAA;AAAA,MACrB,WAAa,EAAA,SAAA;AAAA,MACb,QAAA,EAAU,sBAAsB,YAAY,CAAA;AAAA,MAC5C,QAAQ,YAAY;AAClB,QAAM,MAAA,sBAAA,GAAyB,CAAC,MAAyB,KAAA;AACvD,UAAM,MAAA,KAAA,GAAQ,OAAO,KAAM,CAAA,IAAA;AAAA,YAAK,CAAA,IAAA,KAC9B,MACI,GAAI,CAAA,6BAAA,CAA8B,SAAS,IAAI,CAAA,CAChD,YAAY,MAAM;AAAA,WACvB;AACA,UAAA,OACE,OAAO,GAAI,CAAA,6BAAA,CAA8B,QAAS,CAAA,IAAI,EAAE,SACxD,IAAA,qBAAA;AAAA,SAEJ;AAEA,QAAA,MAAM,YAAY,MAAM;AACtB,UAAA,MAAM,UAAU,mBAAoB,EAAA;AACpC,UAAM,MAAA,EAAE,QAAS,EAAA,GAAI,kBAAmB,EAAA;AACxC,UAAM,MAAA,EAAE,KAAM,EAAA,GAAI,SAAU,EAAA;AAC5B,UAAM,MAAA,UAAA,GAAa,OAAO,aAAa,CAAA;AAEvC,UAAA,2CACG,IAAK,EAAA,EAAA,OAAA,EAAQ,MACX,EAAA,EAAA,CAAC,4BAAa,KAAA,CAAA,aAAA,CAAA,MAAA,EAAA,EAAO,KAAM,EAAA,QAAA,EAAS,mBACpC,KAAA,CAAA,aAAA,CAAA,OAAA,EAAA,IAAA,sCACE,IAAK,EAAA,EAAA,SAAA,EAAS,MAAC,SAAU,EAAA,KAAA,EAAA,kBACvB,KAAA,CAAA,aAAA,CAAA,IAAA,EAAA,EAAK,MAAI,IAAC,EAAA,EAAA,EAAI,EACb,EAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,aAAU,YAAc,EAAA,GAAA,EAAK,CAChC,CAAA,EACC,CAAC,QACA,oBAAA,KAAA,CAAA,aAAA,CAAC,QAAK,IAAI,EAAA,IAAA,EAAC,IAAI,CACb,EAAA,kBAAA,KAAA,CAAA,aAAA;AAAA,YAAC,UAAW,CAAA,SAAA;AAAA,YAAX;AAAA,cACC,IAAK,EAAA,aAAA;AAAA,cACL,YAAa,EAAA,kBAAA;AAAA,cACb,UAAU,EAAA,IAAA;AAAA,cACV,KAAO,EAAA;AAAA,gBACL;AAAA,kBACE,KAAO,EAAA,kBAAA;AAAA,kBACP,IAAM,EAAA,kBAAA;AAAA,kBACN,IAAA,sCAAO,WAAY,EAAA,IAAA;AAAA,iBACrB;AAAA,gBACA;AAAA,kBACE,KAAO,EAAA,UAAA;AAAA,kBACP,IAAM,EAAA,eAAA;AAAA,kBACN,IAAA,sCAAO,QAAS,EAAA,IAAA;AAAA;AAClB;AACF;AAAA,WACF,sCACC,KAAM,EAAA,EAAA,SAAA,EAAW,QAAQ,OACvB,EAAA,EAAA,KAAA,CAAM,QAAS,CAAA,UAAU,CACxB,oBAAA,KAAA,CAAA,aAAA;AAAA,YAAC,YAAa,CAAA,MAAA;AAAA,YAAb;AAAA,cACC,WAAW,OAAQ,CAAA,MAAA;AAAA,cACnB,KAAM,EAAA,QAAA;AAAA,cACN,IAAK,EAAA,MAAA;AAAA,cACL,QAAQ,YAAY;AAElB,gBAAA,MAAM,EAAE,KAAA,EAAU,GAAA,MAAM,WAAW,WAAY,CAAA;AAAA,kBAC7C,MAAA,EAAQ,CAAC,eAAe,CAAA;AAAA,kBACxB,MAAQ,EAAA;AAAA,oBACN,gDACE,EAAA;AAAA;AACJ,iBACD,CAAA;AAED,gBAAA,MAAM,QAAQ,KAAM,CAAA,GAAA;AAAA,kBAClB,CAAA,MAAA,KAAU,OAAO,QAAS,CAAA;AAAA,iBAC5B;AACA,gBAAA,KAAA,CAAM,IAAK,EAAA;AACX,gBAAO,OAAA,KAAA;AAAA;AACT;AAAA,WAGJ,kBAAA,KAAA,CAAA,aAAA;AAAA,YAAC,YAAa,CAAA,MAAA;AAAA,YAAb;AAAA,cACC,WAAW,OAAQ,CAAA,MAAA;AAAA,cACnB,KAAM,EAAA,MAAA;AAAA,cACN,IAAK,EAAA,MAAA;AAAA,cACL,MAAA,EAAQ,CAAC,WAAA,EAAa,UAAU;AAAA;AAAA,WAElC,kBAAA,KAAA,CAAA,aAAA;AAAA,YAAC,YAAa,CAAA,QAAA;AAAA,YAAb;AAAA,cACC,WAAW,OAAQ,CAAA,MAAA;AAAA,cACnB,KAAM,EAAA,WAAA;AAAA,cACN,IAAK,EAAA,WAAA;AAAA,cACL,MAAA,EAAQ,CAAC,cAAA,EAAgB,YAAY;AAAA;AAAA,WAEzC,CACF,CAEF,kBAAA,KAAA,CAAA,aAAA,CAAC,QAAK,IAAI,EAAA,IAAA,EAAC,EAAE,EAAA,IAAA,EAAA,kBACV,KAAA,CAAA,aAAA,CAAA,gBAAA,EAAA,IAAiB,mBACjB,KAAA,CAAA,aAAA,CAAAA,YAAA,EAAA,IAAA,EACE,CAAC,EAAE,OAAQ,EAAA,+DAEP,OAAQ,CAAA,GAAA,CAAI,CAAC,MAAA,EAAQ,KAAU,KAAA;AAC9B,YAAM,MAAA,EAAE,SAAY,GAAA,MAAA;AACpB,YAAA,MAAM,EAAE,QAAA,EAAU,GAAG,IAAA,EAAS,GAAA,MAAA;AAC9B,YAAM,MAAA,oBAAA,GACJ,uBAAuB,MAAM,CAAA;AAC/B,YACE,uBAAA,KAAA,CAAA,aAAA;AAAA,cAAC,oBAAA;AAAA,cAAA;AAAA,gBACE,GAAG,IAAA;AAAA,gBACJ,GAAK,EAAA,KAAA;AAAA,gBACL,MAAQ,EAAA,QAAA;AAAA,gBACR;AAAA;AAAA,aACF;AAAA,WAEH,CACH,CAEJ,CAAA,sCACC,iBAAkB,EAAA,IAAA,CACrB,CACF,CACF,CACF,CAAA;AAAA,SAEJ;AAEA,QAAO,OAAA,aAAA;AAAA,8CACJ,qBACC,EAAA,IAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,gBAAW,CACZ,kBAAA,KAAA,CAAA,aAAA,CAAC,eAAU,CACb;AAAA,SACF;AAAA;AACF,KACD,CAAA;AAAA;AAEL,CAAC;AAGY,MAAA,aAAA,GAAgB,iBAAiB,IAAK,CAAA;AAAA,EACjD,MAAQ,EAAA;AAAA,IACN,QAAA,EAAU,sBAAsB,YAAY,CAAA;AAAA,IAC5C,KAAO,EAAA,QAAA;AAAA,IACP,IAAM,EAAA;AAAA;AAEV,CAAC;AAGD,YAAe,oBAAqB,CAAA;AAAA,EAClC,EAAI,EAAA,QAAA;AAAA,EACJ,UAAY,EAAA,CAAC,SAAW,EAAA,UAAA,EAAY,aAAa,CAAA;AAAA,EACjD,QAAQ,sBAAuB,CAAA;AAAA,IAC7B,IAAM,EAAA;AAAA,GACP;AACH,CAAC,CAAA;;;;"}
1
+ {"version":3,"file":"alpha.esm.js","sources":["../src/alpha.tsx"],"sourcesContent":["/*\n * Copyright 2023 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 from 'react';\n\nimport Grid from '@material-ui/core/Grid';\nimport Paper from '@material-ui/core/Paper';\nimport { makeStyles, Theme } from '@material-ui/core/styles';\nimport SearchIcon from '@material-ui/icons/Search';\n\nimport {\n CatalogIcon,\n Content,\n DocsIcon,\n Header,\n Page,\n useSidebarPinState,\n} from '@backstage/core-components';\nimport {\n useApi,\n discoveryApiRef,\n fetchApiRef,\n createApiFactory,\n} from '@backstage/core-plugin-api';\n\nimport {\n createFrontendPlugin,\n ApiBlueprint,\n createExtensionInput,\n PageBlueprint,\n NavItemBlueprint,\n} from '@backstage/frontend-plugin-api';\n\nimport {\n catalogApiRef,\n CATALOG_FILTER_EXISTS,\n} from '@backstage/plugin-catalog-react';\n\nimport {\n DefaultResultListItem,\n SearchBar,\n SearchFilter,\n SearchPagination,\n SearchResult as SearchResults,\n SearchResultPager,\n useSearch,\n SearchContextProvider,\n} from '@backstage/plugin-search-react';\nimport { SearchResult } from '@backstage/plugin-search-common';\nimport { searchApiRef } from '@backstage/plugin-search-react';\nimport {\n SearchResultListItemBlueprint,\n SearchFilterResultTypeBlueprint,\n SearchFilterBlueprint,\n} from '@backstage/plugin-search-react/alpha';\n\nimport { rootRouteRef } from './plugin';\nimport { SearchClient } from './apis';\nimport { SearchType } from './components/SearchType';\nimport { UrlUpdater } from './components/SearchPage/SearchPage';\nimport {\n compatWrapper,\n convertLegacyRouteRef,\n convertLegacyRouteRefs,\n} from '@backstage/core-compat-api';\n\n/** @alpha */\nexport const searchApi = ApiBlueprint.make({\n params: {\n factory: createApiFactory({\n api: searchApiRef,\n deps: { discoveryApi: discoveryApiRef, fetchApi: fetchApiRef },\n factory: ({ discoveryApi, fetchApi }) =>\n new SearchClient({ discoveryApi, fetchApi }),\n }),\n },\n});\n\nconst useSearchPageStyles = makeStyles((theme: Theme) => ({\n filter: {\n '& + &': {\n marginTop: theme.spacing(2.5),\n },\n },\n filters: {\n padding: theme.spacing(2),\n marginTop: theme.spacing(2),\n },\n}));\n\n/** @alpha */\nexport const searchPage = PageBlueprint.makeWithOverrides({\n config: {\n schema: {\n noTrack: z => z.boolean().default(false),\n },\n },\n inputs: {\n items: createExtensionInput([SearchResultListItemBlueprint.dataRefs.item]),\n resultTypes: createExtensionInput([\n SearchFilterResultTypeBlueprint.dataRefs.resultType,\n ]),\n searchFilters: createExtensionInput([\n SearchFilterBlueprint.dataRefs.searchFilters,\n ]),\n },\n factory(originalFactory, { config, inputs }) {\n return originalFactory({\n defaultPath: '/search',\n routeRef: convertLegacyRouteRef(rootRouteRef),\n loader: async () => {\n const getResultItemComponent = (result: SearchResult) => {\n const value = inputs.items.find(item =>\n item\n ?.get(SearchResultListItemBlueprint.dataRefs.item)\n .predicate?.(result),\n );\n return (\n value?.get(SearchResultListItemBlueprint.dataRefs.item).component ??\n DefaultResultListItem\n );\n };\n\n const resultTypes = inputs.resultTypes.map(item =>\n item.get(SearchFilterResultTypeBlueprint.dataRefs.resultType),\n );\n\n const additionalSearchFilters = inputs.searchFilters.map(\n item =>\n item.get(SearchFilterBlueprint.dataRefs.searchFilters).component,\n );\n\n const Component = () => {\n const classes = useSearchPageStyles();\n const { isMobile } = useSidebarPinState();\n const { types } = useSearch();\n const catalogApi = useApi(catalogApiRef);\n\n return (\n <Page themeId=\"home\">\n {!isMobile && <Header title=\"Search\" />}\n <Content>\n <Grid container direction=\"row\">\n <Grid item xs={12}>\n <SearchBar debounceTime={100} />\n </Grid>\n {!isMobile && (\n <Grid item xs={3}>\n <SearchType.Accordion\n name=\"Result Type\"\n defaultValue=\"software-catalog\"\n showCounts\n types={[\n {\n value: 'software-catalog',\n name: 'Software Catalog',\n icon: <CatalogIcon />,\n },\n {\n value: 'techdocs',\n name: 'Documentation',\n icon: <DocsIcon />,\n },\n ].concat(resultTypes)}\n />\n <Paper className={classes.filters}>\n {types.includes('techdocs') && (\n <SearchFilter.Select\n className={classes.filter}\n label=\"Entity\"\n name=\"name\"\n values={async () => {\n // Return a list of entities which are documented.\n const { items } = await catalogApi.getEntities({\n fields: ['metadata.name'],\n filter: {\n 'metadata.annotations.backstage.io/techdocs-ref':\n CATALOG_FILTER_EXISTS,\n },\n });\n\n const names = items.map(\n entity => entity.metadata.name,\n );\n names.sort();\n return names;\n }}\n />\n )}\n <SearchFilter.Select\n className={classes.filter}\n label=\"Kind\"\n name=\"kind\"\n values={['Component', 'Template']}\n />\n <SearchFilter.Checkbox\n className={classes.filter}\n label=\"Lifecycle\"\n name=\"lifecycle\"\n values={['experimental', 'production']}\n />\n {additionalSearchFilters.map(SearchFilterComponent => (\n <SearchFilterComponent className={classes.filter} />\n ))}\n </Paper>\n </Grid>\n )}\n <Grid item xs>\n <SearchPagination />\n <SearchResults>\n {({ results }) => (\n <>\n {results.map((result, index) => {\n const { noTrack } = config;\n const { document, ...rest } = result;\n const SearchResultListItem =\n getResultItemComponent(result);\n return (\n <SearchResultListItem\n {...rest}\n key={index}\n result={document}\n noTrack={noTrack}\n />\n );\n })}\n </>\n )}\n </SearchResults>\n <SearchResultPager />\n </Grid>\n </Grid>\n </Content>\n </Page>\n );\n };\n\n return compatWrapper(\n <SearchContextProvider>\n <UrlUpdater />\n <Component />\n </SearchContextProvider>,\n );\n },\n });\n },\n});\n\n/** @alpha */\nexport const searchNavItem = NavItemBlueprint.make({\n params: {\n routeRef: convertLegacyRouteRef(rootRouteRef),\n title: 'Search',\n icon: SearchIcon,\n },\n});\n\n/** @alpha */\nexport default createFrontendPlugin({\n id: 'search',\n extensions: [searchApi, searchPage, searchNavItem],\n routes: convertLegacyRouteRefs({\n root: rootRouteRef,\n }),\n});\n"],"names":["SearchResults"],"mappings":";;;;;;;;;;;;;;;;;AAgFa,MAAA,SAAA,GAAY,aAAa,IAAK,CAAA;AAAA,EACzC,MAAQ,EAAA;AAAA,IACN,SAAS,gBAAiB,CAAA;AAAA,MACxB,GAAK,EAAA,YAAA;AAAA,MACL,IAAM,EAAA,EAAE,YAAc,EAAA,eAAA,EAAiB,UAAU,WAAY,EAAA;AAAA,MAC7D,OAAA,EAAS,CAAC,EAAE,YAAc,EAAA,QAAA,EACxB,KAAA,IAAI,YAAa,CAAA,EAAE,YAAc,EAAA,QAAA,EAAU;AAAA,KAC9C;AAAA;AAEL,CAAC;AAED,MAAM,mBAAA,GAAsB,UAAW,CAAA,CAAC,KAAkB,MAAA;AAAA,EACxD,MAAQ,EAAA;AAAA,IACN,OAAS,EAAA;AAAA,MACP,SAAA,EAAW,KAAM,CAAA,OAAA,CAAQ,GAAG;AAAA;AAC9B,GACF;AAAA,EACA,OAAS,EAAA;AAAA,IACP,OAAA,EAAS,KAAM,CAAA,OAAA,CAAQ,CAAC,CAAA;AAAA,IACxB,SAAA,EAAW,KAAM,CAAA,OAAA,CAAQ,CAAC;AAAA;AAE9B,CAAE,CAAA,CAAA;AAGW,MAAA,UAAA,GAAa,cAAc,iBAAkB,CAAA;AAAA,EACxD,MAAQ,EAAA;AAAA,IACN,MAAQ,EAAA;AAAA,MACN,SAAS,CAAK,CAAA,KAAA,CAAA,CAAE,OAAQ,EAAA,CAAE,QAAQ,KAAK;AAAA;AACzC,GACF;AAAA,EACA,MAAQ,EAAA;AAAA,IACN,OAAO,oBAAqB,CAAA,CAAC,6BAA8B,CAAA,QAAA,CAAS,IAAI,CAAC,CAAA;AAAA,IACzE,aAAa,oBAAqB,CAAA;AAAA,MAChC,gCAAgC,QAAS,CAAA;AAAA,KAC1C,CAAA;AAAA,IACD,eAAe,oBAAqB,CAAA;AAAA,MAClC,sBAAsB,QAAS,CAAA;AAAA,KAChC;AAAA,GACH;AAAA,EACA,OAAQ,CAAA,eAAA,EAAiB,EAAE,MAAA,EAAQ,QAAU,EAAA;AAC3C,IAAA,OAAO,eAAgB,CAAA;AAAA,MACrB,WAAa,EAAA,SAAA;AAAA,MACb,QAAA,EAAU,sBAAsB,YAAY,CAAA;AAAA,MAC5C,QAAQ,YAAY;AAClB,QAAM,MAAA,sBAAA,GAAyB,CAAC,MAAyB,KAAA;AACvD,UAAM,MAAA,KAAA,GAAQ,OAAO,KAAM,CAAA,IAAA;AAAA,YAAK,CAAA,IAAA,KAC9B,MACI,GAAI,CAAA,6BAAA,CAA8B,SAAS,IAAI,CAAA,CAChD,YAAY,MAAM;AAAA,WACvB;AACA,UAAA,OACE,OAAO,GAAI,CAAA,6BAAA,CAA8B,QAAS,CAAA,IAAI,EAAE,SACxD,IAAA,qBAAA;AAAA,SAEJ;AAEA,QAAM,MAAA,WAAA,GAAc,OAAO,WAAY,CAAA,GAAA;AAAA,UAAI,CACzC,IAAA,KAAA,IAAA,CAAK,GAAI,CAAA,+BAAA,CAAgC,SAAS,UAAU;AAAA,SAC9D;AAEA,QAAM,MAAA,uBAAA,GAA0B,OAAO,aAAc,CAAA,GAAA;AAAA,UACnD,UACE,IAAK,CAAA,GAAA,CAAI,qBAAsB,CAAA,QAAA,CAAS,aAAa,CAAE,CAAA;AAAA,SAC3D;AAEA,QAAA,MAAM,YAAY,MAAM;AACtB,UAAA,MAAM,UAAU,mBAAoB,EAAA;AACpC,UAAM,MAAA,EAAE,QAAS,EAAA,GAAI,kBAAmB,EAAA;AACxC,UAAM,MAAA,EAAE,KAAM,EAAA,GAAI,SAAU,EAAA;AAC5B,UAAM,MAAA,UAAA,GAAa,OAAO,aAAa,CAAA;AAEvC,UAAA,2CACG,IAAK,EAAA,EAAA,OAAA,EAAQ,MACX,EAAA,EAAA,CAAC,4BAAa,KAAA,CAAA,aAAA,CAAA,MAAA,EAAA,EAAO,KAAM,EAAA,QAAA,EAAS,mBACpC,KAAA,CAAA,aAAA,CAAA,OAAA,EAAA,IAAA,sCACE,IAAK,EAAA,EAAA,SAAA,EAAS,MAAC,SAAU,EAAA,KAAA,EAAA,kBACvB,KAAA,CAAA,aAAA,CAAA,IAAA,EAAA,EAAK,MAAI,IAAC,EAAA,EAAA,EAAI,EACb,EAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,aAAU,YAAc,EAAA,GAAA,EAAK,CAChC,CAAA,EACC,CAAC,QACA,oBAAA,KAAA,CAAA,aAAA,CAAC,QAAK,IAAI,EAAA,IAAA,EAAC,IAAI,CACb,EAAA,kBAAA,KAAA,CAAA,aAAA;AAAA,YAAC,UAAW,CAAA,SAAA;AAAA,YAAX;AAAA,cACC,IAAK,EAAA,aAAA;AAAA,cACL,YAAa,EAAA,kBAAA;AAAA,cACb,UAAU,EAAA,IAAA;AAAA,cACV,KAAO,EAAA;AAAA,gBACL;AAAA,kBACE,KAAO,EAAA,kBAAA;AAAA,kBACP,IAAM,EAAA,kBAAA;AAAA,kBACN,IAAA,sCAAO,WAAY,EAAA,IAAA;AAAA,iBACrB;AAAA,gBACA;AAAA,kBACE,KAAO,EAAA,UAAA;AAAA,kBACP,IAAM,EAAA,eAAA;AAAA,kBACN,IAAA,sCAAO,QAAS,EAAA,IAAA;AAAA;AAClB,eACF,CAAE,OAAO,WAAW;AAAA;AAAA,WACtB,sCACC,KAAM,EAAA,EAAA,SAAA,EAAW,QAAQ,OACvB,EAAA,EAAA,KAAA,CAAM,QAAS,CAAA,UAAU,CACxB,oBAAA,KAAA,CAAA,aAAA;AAAA,YAAC,YAAa,CAAA,MAAA;AAAA,YAAb;AAAA,cACC,WAAW,OAAQ,CAAA,MAAA;AAAA,cACnB,KAAM,EAAA,QAAA;AAAA,cACN,IAAK,EAAA,MAAA;AAAA,cACL,QAAQ,YAAY;AAElB,gBAAA,MAAM,EAAE,KAAA,EAAU,GAAA,MAAM,WAAW,WAAY,CAAA;AAAA,kBAC7C,MAAA,EAAQ,CAAC,eAAe,CAAA;AAAA,kBACxB,MAAQ,EAAA;AAAA,oBACN,gDACE,EAAA;AAAA;AACJ,iBACD,CAAA;AAED,gBAAA,MAAM,QAAQ,KAAM,CAAA,GAAA;AAAA,kBAClB,CAAA,MAAA,KAAU,OAAO,QAAS,CAAA;AAAA,iBAC5B;AACA,gBAAA,KAAA,CAAM,IAAK,EAAA;AACX,gBAAO,OAAA,KAAA;AAAA;AACT;AAAA,WAGJ,kBAAA,KAAA,CAAA,aAAA;AAAA,YAAC,YAAa,CAAA,MAAA;AAAA,YAAb;AAAA,cACC,WAAW,OAAQ,CAAA,MAAA;AAAA,cACnB,KAAM,EAAA,MAAA;AAAA,cACN,IAAK,EAAA,MAAA;AAAA,cACL,MAAA,EAAQ,CAAC,WAAA,EAAa,UAAU;AAAA;AAAA,WAElC,kBAAA,KAAA,CAAA,aAAA;AAAA,YAAC,YAAa,CAAA,QAAA;AAAA,YAAb;AAAA,cACC,WAAW,OAAQ,CAAA,MAAA;AAAA,cACnB,KAAM,EAAA,WAAA;AAAA,cACN,IAAK,EAAA,WAAA;AAAA,cACL,MAAA,EAAQ,CAAC,cAAA,EAAgB,YAAY;AAAA;AAAA,WAEtC,EAAA,uBAAA,CAAwB,GAAI,CAAA,CAAA,qBAAA,yCAC1B,qBAAsB,EAAA,EAAA,SAAA,EAAW,OAAQ,CAAA,MAAA,EAAQ,CACnD,CACH,CACF,CAAA,sCAED,IAAK,EAAA,EAAA,IAAA,EAAI,IAAC,EAAA,EAAA,EAAE,IACX,EAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,gBAAiB,EAAA,IAAA,CAAA,sCACjBA,YACE,EAAA,IAAA,EAAA,CAAC,EAAE,OAAA,uBAEC,KAAA,CAAA,aAAA,CAAA,KAAA,CAAA,QAAA,EAAA,IAAA,EAAA,OAAA,CAAQ,GAAI,CAAA,CAAC,QAAQ,KAAU,KAAA;AAC9B,YAAM,MAAA,EAAE,SAAY,GAAA,MAAA;AACpB,YAAA,MAAM,EAAE,QAAA,EAAU,GAAG,IAAA,EAAS,GAAA,MAAA;AAC9B,YAAM,MAAA,oBAAA,GACJ,uBAAuB,MAAM,CAAA;AAC/B,YACE,uBAAA,KAAA,CAAA,aAAA;AAAA,cAAC,oBAAA;AAAA,cAAA;AAAA,gBACE,GAAG,IAAA;AAAA,gBACJ,GAAK,EAAA,KAAA;AAAA,gBACL,MAAQ,EAAA,QAAA;AAAA,gBACR;AAAA;AAAA,aACF;AAAA,WAEH,CACH,CAEJ,CAAA,sCACC,iBAAkB,EAAA,IAAA,CACrB,CACF,CACF,CACF,CAAA;AAAA,SAEJ;AAEA,QAAO,OAAA,aAAA;AAAA,8CACJ,qBACC,EAAA,IAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,gBAAW,CACZ,kBAAA,KAAA,CAAA,aAAA,CAAC,eAAU,CACb;AAAA,SACF;AAAA;AACF,KACD,CAAA;AAAA;AAEL,CAAC;AAGY,MAAA,aAAA,GAAgB,iBAAiB,IAAK,CAAA;AAAA,EACjD,MAAQ,EAAA;AAAA,IACN,QAAA,EAAU,sBAAsB,YAAY,CAAA;AAAA,IAC5C,KAAO,EAAA,QAAA;AAAA,IACP,IAAM,EAAA;AAAA;AAEV,CAAC;AAGD,YAAe,oBAAqB,CAAA;AAAA,EAClC,EAAI,EAAA,QAAA;AAAA,EACJ,UAAY,EAAA,CAAC,SAAW,EAAA,UAAA,EAAY,aAAa,CAAA;AAAA,EACjD,QAAQ,sBAAuB,CAAA;AAAA,IAC7B,IAAM,EAAA;AAAA,GACP;AACH,CAAC,CAAA;;;;"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-search",
3
- "version": "1.4.22",
3
+ "version": "1.4.23-next.0",
4
4
  "description": "The Backstage plugin that provides your backstage app with search",
5
5
  "backstage": {
6
6
  "role": "frontend-plugin",
@@ -67,26 +67,26 @@
67
67
  "test": "backstage-cli package test"
68
68
  },
69
69
  "dependencies": {
70
- "@backstage/core-compat-api": "^0.3.5",
71
- "@backstage/core-components": "^0.16.3",
72
- "@backstage/core-plugin-api": "^1.10.3",
73
- "@backstage/errors": "^1.2.7",
74
- "@backstage/frontend-plugin-api": "^0.9.4",
75
- "@backstage/plugin-catalog-react": "^1.15.1",
76
- "@backstage/plugin-search-common": "^1.2.17",
77
- "@backstage/plugin-search-react": "^1.8.5",
78
- "@backstage/types": "^1.2.1",
79
- "@backstage/version-bridge": "^1.0.10",
70
+ "@backstage/core-compat-api": "0.3.6-next.0",
71
+ "@backstage/core-components": "0.16.3",
72
+ "@backstage/core-plugin-api": "1.10.3",
73
+ "@backstage/errors": "1.2.7",
74
+ "@backstage/frontend-plugin-api": "0.9.5-next.0",
75
+ "@backstage/plugin-catalog-react": "1.15.2-next.0",
76
+ "@backstage/plugin-search-common": "1.2.17",
77
+ "@backstage/plugin-search-react": "1.8.6-next.0",
78
+ "@backstage/types": "1.2.1",
79
+ "@backstage/version-bridge": "1.0.10",
80
80
  "@material-ui/core": "^4.12.2",
81
81
  "@material-ui/icons": "^4.9.1",
82
82
  "qs": "^6.9.4",
83
83
  "react-use": "^17.2.4"
84
84
  },
85
85
  "devDependencies": {
86
- "@backstage/cli": "^0.29.5",
87
- "@backstage/core-app-api": "^1.15.4",
88
- "@backstage/dev-utils": "^1.1.6",
89
- "@backstage/test-utils": "^1.7.4",
86
+ "@backstage/cli": "0.30.0-next.0",
87
+ "@backstage/core-app-api": "1.15.4",
88
+ "@backstage/dev-utils": "1.1.7-next.0",
89
+ "@backstage/test-utils": "1.7.4",
90
90
  "@testing-library/dom": "^10.0.0",
91
91
  "@testing-library/jest-dom": "^6.0.0",
92
92
  "@testing-library/react": "^16.0.0",