@backstage/plugin-search 1.7.7-next.1 → 1.7.7-next.2

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.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,15 @@
1
1
  # @backstage/plugin-search
2
2
 
3
+ ## 1.7.7-next.2
4
+
5
+ ### Patch Changes
6
+
7
+ - a178067: Added a Home page search bar widget blueprint for the new frontend system.
8
+ - Updated dependencies
9
+ - @backstage/core-plugin-api@1.12.9-next.1
10
+ - @backstage/plugin-catalog-react@3.2.1-next.3
11
+ - @backstage/plugin-home-react@0.1.41-next.2
12
+
3
13
  ## 1.7.7-next.1
4
14
 
5
15
  ### Patch Changes
package/dist/alpha.d.ts CHANGED
@@ -1,3 +1,4 @@
1
+ import * as _backstage_plugin_home_react_alpha from '@backstage/plugin-home-react/alpha';
1
2
  import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
2
3
  import * as _backstage_plugin_search_react_alpha from '@backstage/plugin-search-react/alpha';
3
4
  import * as react from 'react';
@@ -94,6 +95,15 @@ declare const _default: _backstage_frontend_plugin_api.OverridableFrontendPlugin
94
95
  inputs: {};
95
96
  params: <TApi, TImpl extends TApi, TDeps extends { [name in string]: unknown; }>(params: _backstage_frontend_plugin_api.ApiFactory<TApi, TImpl, TDeps>) => _backstage_frontend_plugin_api.ExtensionBlueprintParams<_backstage_frontend_plugin_api.AnyApiFactory>;
96
97
  }>;
98
+ "home-page-widget:search/search-bar": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
99
+ kind: "home-page-widget";
100
+ name: "search-bar";
101
+ config: {};
102
+ configInput: {};
103
+ output: _backstage_frontend_plugin_api.ExtensionDataRef<_backstage_plugin_home_react_alpha.HomePageWidgetData, "home.widget.data", {}>;
104
+ inputs: {};
105
+ params: _backstage_plugin_home_react_alpha.HomePageWidgetBlueprintParams;
106
+ }>;
97
107
  "page:search": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
98
108
  config: {
99
109
  noTrack: boolean;
package/dist/alpha.esm.js CHANGED
@@ -11,6 +11,7 @@ import { ApiBlueprint, PageBlueprint, createExtensionInput, createFrontendPlugin
11
11
  import { catalogApiRef, CATALOG_FILTER_EXISTS } from '@backstage/plugin-catalog-react';
12
12
  import { searchApiRef, SearchContextProvider, useSearch, SearchBar, SearchFilter, SearchPagination, SearchResult, SearchResultPager, DefaultResultListItem } from '@backstage/plugin-search-react';
13
13
  import { SearchFilterResultTypeBlueprint, SearchFilterBlueprint, SearchResultListItemBlueprint } from '@backstage/plugin-search-react/alpha';
14
+ import { HomePageWidgetBlueprint } from '@backstage/plugin-home-react/alpha';
14
15
  import { rootRouteRef } from './plugin.esm.js';
15
16
  import { SearchClient } from './apis.esm.js';
16
17
  import { SearchType } from './components/SearchType/SearchType.esm.js';
@@ -169,12 +170,28 @@ const searchPage = PageBlueprint.makeWithOverrides({
169
170
  });
170
171
  }
171
172
  });
173
+ const homePageSearchBarWidget = HomePageWidgetBlueprint.make({
174
+ name: "search-bar",
175
+ params: {
176
+ name: "HomePageSearchBar",
177
+ title: "Search",
178
+ description: "A search bar that navigates to the search page on submit",
179
+ components: () => import('./components/HomePageComponent/index.esm.js').then((m) => ({
180
+ Content: m.HomePageSearchBar
181
+ })),
182
+ componentProps: {
183
+ Renderer: ({
184
+ Content: SearchContent
185
+ }) => /* @__PURE__ */ jsx(SearchContent, {})
186
+ }
187
+ }
188
+ });
172
189
  var alpha = createFrontendPlugin({
173
190
  pluginId: "search",
174
191
  title: "Search",
175
192
  icon: /* @__PURE__ */ jsx(SearchIcon, { fontSize: "inherit" }),
176
193
  info: { packageJson: () => import('./package.json.esm.js') },
177
- extensions: [searchApi, searchPage],
194
+ extensions: [searchApi, searchPage, homePageSearchBarWidget],
178
195
  routes: {
179
196
  root: rootRouteRef
180
197
  }
@@ -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 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';\nimport { z } from 'zod/v4';\n\nimport {\n CatalogIcon,\n Content,\n useSidebarPinState,\n} from '@backstage/core-components';\nimport {\n useApi,\n discoveryApiRef,\n fetchApiRef,\n} from '@backstage/core-plugin-api';\n\nimport {\n createFrontendPlugin,\n ApiBlueprint,\n createExtensionInput,\n PageBlueprint,\n configApiRef,\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';\n\n/** @alpha */\nexport const searchApi = ApiBlueprint.make({\n params: defineParams =>\n defineParams({\n api: searchApiRef,\n deps: { discoveryApi: discoveryApiRef, fetchApi: fetchApiRef },\n factory: ({ discoveryApi, fetchApi }) =>\n new SearchClient({ discoveryApi, fetchApi }),\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 configSchema: {\n noTrack: z.boolean().default(false),\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 path: '/search',\n routeRef: rootRouteRef,\n title: 'Search',\n icon: <SearchIcon fontSize=\"inherit\" />,\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 const configApi = useApi(configApiRef);\n\n return (\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={configApi.getOptionalString(\n 'search.defaultType',\n )}\n showCounts\n types={[\n {\n value: 'software-catalog',\n name: 'Software Catalog',\n icon: <CatalogIcon />,\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={async () => {\n const { facets } = await catalogApi.getEntityFacets({\n facets: ['kind'],\n });\n return (facets.kind ?? [])\n .map(facet => facet.value)\n .sort((a, b) => a.localeCompare(b));\n }}\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 );\n };\n\n return (\n <SearchContextProvider>\n <UrlUpdater />\n <Component />\n </SearchContextProvider>\n );\n },\n });\n },\n});\n\n/** @alpha */\nexport default createFrontendPlugin({\n pluginId: 'search',\n title: 'Search',\n icon: <SearchIcon fontSize=\"inherit\" />,\n info: { packageJson: () => import('../package.json') },\n extensions: [searchApi, searchPage],\n routes: {\n root: rootRouteRef,\n },\n});\n\nimport { searchTranslationRef as _searchTranslationRef } from './translation';\n\n/**\n * @alpha\n * @deprecated Import from `@backstage/plugin-search` instead.\n */\nexport const searchTranslationRef = _searchTranslationRef;\n"],"names":["SearchResults","_searchTranslationRef"],"mappings":";;;;;;;;;;;;;;;;;;;AAsEO,MAAM,SAAA,GAAY,aAAa,IAAA,CAAK;AAAA,EACzC,MAAA,EAAQ,kBACN,YAAA,CAAa;AAAA,IACX,GAAA,EAAK,YAAA;AAAA,IACL,IAAA,EAAM,EAAE,YAAA,EAAc,eAAA,EAAiB,UAAU,WAAA,EAAY;AAAA,IAC7D,OAAA,EAAS,CAAC,EAAE,YAAA,EAAc,QAAA,EAAS,KACjC,IAAI,YAAA,CAAa,EAAE,YAAA,EAAc,QAAA,EAAU;AAAA,GAC9C;AACL,CAAC;AAED,MAAM,mBAAA,GAAsB,UAAA,CAAW,CAAC,KAAA,MAAkB;AAAA,EACxD,MAAA,EAAQ;AAAA,IACN,OAAA,EAAS;AAAA,MACP,SAAA,EAAW,KAAA,CAAM,OAAA,CAAQ,GAAG;AAAA;AAC9B,GACF;AAAA,EACA,OAAA,EAAS;AAAA,IACP,OAAA,EAAS,KAAA,CAAM,OAAA,CAAQ,CAAC,CAAA;AAAA,IACxB,SAAA,EAAW,KAAA,CAAM,OAAA,CAAQ,CAAC;AAAA;AAE9B,CAAA,CAAE,CAAA;AAGK,MAAM,UAAA,GAAa,cAAc,iBAAA,CAAkB;AAAA,EACxD,YAAA,EAAc;AAAA,IACZ,OAAA,EAAS,CAAA,CAAE,OAAA,EAAQ,CAAE,QAAQ,KAAK;AAAA,GACpC;AAAA,EACA,MAAA,EAAQ;AAAA,IACN,OAAO,oBAAA,CAAqB,CAAC,6BAAA,CAA8B,QAAA,CAAS,IAAI,CAAC,CAAA;AAAA,IACzE,aAAa,oBAAA,CAAqB;AAAA,MAChC,gCAAgC,QAAA,CAAS;AAAA,KAC1C,CAAA;AAAA,IACD,eAAe,oBAAA,CAAqB;AAAA,MAClC,sBAAsB,QAAA,CAAS;AAAA,KAChC;AAAA,GACH;AAAA,EACA,OAAA,CAAQ,eAAA,EAAiB,EAAE,MAAA,EAAQ,QAAO,EAAG;AAC3C,IAAA,OAAO,eAAA,CAAgB;AAAA,MACrB,IAAA,EAAM,SAAA;AAAA,MACN,QAAA,EAAU,YAAA;AAAA,MACV,KAAA,EAAO,QAAA;AAAA,MACP,IAAA,kBAAM,GAAA,CAAC,UAAA,EAAA,EAAW,QAAA,EAAS,SAAA,EAAU,CAAA;AAAA,MACrC,QAAQ,YAAY;AAClB,QAAA,MAAM,sBAAA,GAAyB,CAAC,MAAA,KAAyB;AACvD,UAAA,MAAM,KAAA,GAAQ,OAAO,KAAA,CAAM,IAAA;AAAA,YAAK,CAAA,IAAA,KAC9B,MACI,GAAA,CAAI,6BAAA,CAA8B,SAAS,IAAI,CAAA,CAChD,YAAY,MAAM;AAAA,WACvB;AACA,UAAA,OACE,OAAO,GAAA,CAAI,6BAAA,CAA8B,QAAA,CAAS,IAAI,EAAE,SAAA,IACxD,qBAAA;AAAA,QAEJ,CAAA;AAEA,QAAA,MAAM,WAAA,GAAc,OAAO,WAAA,CAAY,GAAA;AAAA,UAAI,CAAA,IAAA,KACzC,IAAA,CAAK,GAAA,CAAI,+BAAA,CAAgC,SAAS,UAAU;AAAA,SAC9D;AAEA,QAAA,MAAM,uBAAA,GAA0B,OAAO,aAAA,CAAc,GAAA;AAAA,UACnD,UACE,IAAA,CAAK,GAAA,CAAI,qBAAA,CAAsB,QAAA,CAAS,aAAa,CAAA,CAAE;AAAA,SAC3D;AAEA,QAAA,MAAM,YAAY,MAAM;AACtB,UAAA,MAAM,UAAU,mBAAA,EAAoB;AACpC,UAAA,MAAM,EAAE,QAAA,EAAS,GAAI,kBAAA,EAAmB;AACxC,UAAA,MAAM,EAAE,KAAA,EAAM,GAAI,SAAA,EAAU;AAC5B,UAAA,MAAM,UAAA,GAAa,OAAO,aAAa,CAAA;AACvC,UAAA,MAAM,SAAA,GAAY,OAAO,YAAY,CAAA;AAErC,UAAA,2BACG,OAAA,EAAA,EACC,QAAA,kBAAA,IAAA,CAAC,QAAK,SAAA,EAAS,IAAA,EAAC,WAAU,KAAA,EACxB,QAAA,EAAA;AAAA,4BAAA,GAAA,CAAC,IAAA,EAAA,EAAK,MAAI,IAAA,EAAC,EAAA,EAAI,IACb,QAAA,kBAAA,GAAA,CAAC,SAAA,EAAA,EAAU,YAAA,EAAc,GAAA,EAAK,CAAA,EAChC,CAAA;AAAA,YACC,CAAC,QAAA,oBACA,IAAA,CAAC,QAAK,IAAA,EAAI,IAAA,EAAC,IAAI,CAAA,EACb,QAAA,EAAA;AAAA,8BAAA,GAAA;AAAA,gBAAC,UAAA,CAAW,SAAA;AAAA,gBAAX;AAAA,kBACC,IAAA,EAAK,aAAA;AAAA,kBACL,cAAc,SAAA,CAAU,iBAAA;AAAA,oBACtB;AAAA,mBACF;AAAA,kBACA,UAAA,EAAU,IAAA;AAAA,kBACV,KAAA,EAAO;AAAA,oBACL;AAAA,sBACE,KAAA,EAAO,kBAAA;AAAA,sBACP,IAAA,EAAM,kBAAA;AAAA,sBACN,IAAA,sBAAO,WAAA,EAAA,EAAY;AAAA;AACrB,mBACF,CAAE,OAAO,WAAW;AAAA;AAAA,eACtB;AAAA,8BACA,IAAA,CAAC,KAAA,EAAA,EAAM,SAAA,EAAW,OAAA,CAAQ,OAAA,EACvB,QAAA,EAAA;AAAA,gBAAA,KAAA,CAAM,QAAA,CAAS,UAAU,CAAA,oBACxB,GAAA;AAAA,kBAAC,YAAA,CAAa,MAAA;AAAA,kBAAb;AAAA,oBACC,WAAW,OAAA,CAAQ,MAAA;AAAA,oBACnB,KAAA,EAAM,QAAA;AAAA,oBACN,IAAA,EAAK,MAAA;AAAA,oBACL,QAAQ,YAAY;AAElB,sBAAA,MAAM,EAAE,KAAA,EAAM,GAAI,MAAM,WAAW,WAAA,CAAY;AAAA,wBAC7C,MAAA,EAAQ,CAAC,eAAe,CAAA;AAAA,wBACxB,MAAA,EAAQ;AAAA,0BACN,gDAAA,EACE;AAAA;AACJ,uBACD,CAAA;AAED,sBAAA,MAAM,QAAQ,KAAA,CAAM,GAAA;AAAA,wBAClB,CAAA,MAAA,KAAU,OAAO,QAAA,CAAS;AAAA,uBAC5B;AACA,sBAAA,KAAA,CAAM,IAAA,EAAK;AACX,sBAAA,OAAO,KAAA;AAAA,oBACT;AAAA;AAAA,iBACF;AAAA,gCAEF,GAAA;AAAA,kBAAC,YAAA,CAAa,MAAA;AAAA,kBAAb;AAAA,oBACC,WAAW,OAAA,CAAQ,MAAA;AAAA,oBACnB,KAAA,EAAM,MAAA;AAAA,oBACN,IAAA,EAAK,MAAA;AAAA,oBACL,QAAQ,YAAY;AAClB,sBAAA,MAAM,EAAE,MAAA,EAAO,GAAI,MAAM,WAAW,eAAA,CAAgB;AAAA,wBAClD,MAAA,EAAQ,CAAC,MAAM;AAAA,uBAChB,CAAA;AACD,sBAAA,OAAA,CAAQ,OAAO,IAAA,IAAQ,EAAC,EACrB,GAAA,CAAI,WAAS,KAAA,CAAM,KAAK,CAAA,CACxB,IAAA,CAAK,CAAC,CAAA,EAAG,CAAA,KAAM,CAAA,CAAE,aAAA,CAAc,CAAC,CAAC,CAAA;AAAA,oBACtC;AAAA;AAAA,iBACF;AAAA,gCACA,GAAA;AAAA,kBAAC,YAAA,CAAa,QAAA;AAAA,kBAAb;AAAA,oBACC,WAAW,OAAA,CAAQ,MAAA;AAAA,oBACnB,KAAA,EAAM,WAAA;AAAA,oBACN,IAAA,EAAK,WAAA;AAAA,oBACL,MAAA,EAAQ,CAAC,cAAA,EAAgB,YAAY;AAAA;AAAA,iBACvC;AAAA,gBACC,uBAAA,CAAwB,IAAI,CAAA,qBAAA,qBAC3B,GAAA,CAAC,yBAAsB,SAAA,EAAW,OAAA,CAAQ,QAAQ,CACnD;AAAA,eAAA,EACH;AAAA,aAAA,EACF,CAAA;AAAA,4BAEF,IAAA,CAAC,IAAA,EAAA,EAAK,IAAA,EAAI,IAAA,EAAC,IAAE,IAAA,EACX,QAAA,EAAA;AAAA,8BAAA,GAAA,CAAC,gBAAA,EAAA,EAAiB,CAAA;AAAA,8BAClB,GAAA,CAACA,YAAA,EAAA,EACE,QAAA,EAAA,CAAC,EAAE,OAAA,EAAQ,qBACV,GAAA,CAAA,QAAA,EAAA,EACG,QAAA,EAAA,OAAA,CAAQ,GAAA,CAAI,CAAC,MAAA,EAAQ,KAAA,KAAU;AAC9B,gBAAA,MAAM,EAAE,SAAQ,GAAI,MAAA;AACpB,gBAAA,MAAM,EAAE,QAAA,EAAU,GAAG,IAAA,EAAK,GAAI,MAAA;AAC9B,gBAAA,MAAM,oBAAA,GACJ,uBAAuB,MAAM,CAAA;AAC/B,gBAAA,uBACE,aAAA;AAAA,kBAAC,oBAAA;AAAA,kBAAA;AAAA,oBACE,GAAG,IAAA;AAAA,oBACJ,GAAA,EAAK,KAAA;AAAA,oBACL,MAAA,EAAQ,QAAA;AAAA,oBACR;AAAA;AAAA,iBACF;AAAA,cAEJ,CAAC,GACH,CAAA,EAEJ,CAAA;AAAA,kCACC,iBAAA,EAAA,EAAkB;AAAA,aAAA,EACrB;AAAA,WAAA,EACF,CAAA,EACF,CAAA;AAAA,QAEJ,CAAA;AAEA,QAAA,4BACG,qBAAA,EAAA,EACC,QAAA,EAAA;AAAA,0BAAA,GAAA,CAAC,UAAA,EAAA,EAAW,CAAA;AAAA,8BACX,SAAA,EAAA,EAAU;AAAA,SAAA,EACb,CAAA;AAAA,MAEJ;AAAA,KACD,CAAA;AAAA,EACH;AACF,CAAC;AAGD,YAAe,oBAAA,CAAqB;AAAA,EAClC,QAAA,EAAU,QAAA;AAAA,EACV,KAAA,EAAO,QAAA;AAAA,EACP,IAAA,kBAAM,GAAA,CAAC,UAAA,EAAA,EAAW,QAAA,EAAS,SAAA,EAAU,CAAA;AAAA,EACrC,MAAM,EAAE,WAAA,EAAa,MAAM,OAAO,uBAAiB,CAAA,EAAE;AAAA,EACrD,UAAA,EAAY,CAAC,SAAA,EAAW,UAAU,CAAA;AAAA,EAClC,MAAA,EAAQ;AAAA,IACN,IAAA,EAAM;AAAA;AAEV,CAAC,CAAA;AAQM,MAAM,oBAAA,GAAuBC;;;;"}
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 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';\nimport { z } from 'zod/v4';\n\nimport {\n CatalogIcon,\n Content,\n useSidebarPinState,\n} from '@backstage/core-components';\nimport {\n useApi,\n discoveryApiRef,\n fetchApiRef,\n} from '@backstage/core-plugin-api';\n\nimport {\n createFrontendPlugin,\n ApiBlueprint,\n createExtensionInput,\n PageBlueprint,\n configApiRef,\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';\nimport { HomePageWidgetBlueprint } from '@backstage/plugin-home-react/alpha';\n\nimport { rootRouteRef } from './plugin';\nimport { SearchClient } from './apis';\nimport { SearchType } from './components/SearchType';\nimport { UrlUpdater } from './components/SearchPage/SearchPage';\n\n/** @alpha */\nexport const searchApi = ApiBlueprint.make({\n params: defineParams =>\n defineParams({\n api: searchApiRef,\n deps: { discoveryApi: discoveryApiRef, fetchApi: fetchApiRef },\n factory: ({ discoveryApi, fetchApi }) =>\n new SearchClient({ discoveryApi, fetchApi }),\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 configSchema: {\n noTrack: z.boolean().default(false),\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 path: '/search',\n routeRef: rootRouteRef,\n title: 'Search',\n icon: <SearchIcon fontSize=\"inherit\" />,\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 const configApi = useApi(configApiRef);\n\n return (\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={configApi.getOptionalString(\n 'search.defaultType',\n )}\n showCounts\n types={[\n {\n value: 'software-catalog',\n name: 'Software Catalog',\n icon: <CatalogIcon />,\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={async () => {\n const { facets } = await catalogApi.getEntityFacets({\n facets: ['kind'],\n });\n return (facets.kind ?? [])\n .map(facet => facet.value)\n .sort((a, b) => a.localeCompare(b));\n }}\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 );\n };\n\n return (\n <SearchContextProvider>\n <UrlUpdater />\n <Component />\n </SearchContextProvider>\n );\n },\n });\n },\n});\n\nconst homePageSearchBarWidget = HomePageWidgetBlueprint.make({\n name: 'search-bar',\n params: {\n name: 'HomePageSearchBar',\n title: 'Search',\n description: 'A search bar that navigates to the search page on submit',\n components: () =>\n import('./components/HomePageComponent').then(m => ({\n Content: m.HomePageSearchBar,\n })),\n componentProps: {\n Renderer: ({\n Content: SearchContent,\n }: {\n Content: () => JSX.Element;\n }) => <SearchContent />,\n },\n },\n});\n\n/** @alpha */\nexport default createFrontendPlugin({\n pluginId: 'search',\n title: 'Search',\n icon: <SearchIcon fontSize=\"inherit\" />,\n info: { packageJson: () => import('../package.json') },\n extensions: [searchApi, searchPage, homePageSearchBarWidget],\n routes: {\n root: rootRouteRef,\n },\n});\n\nimport { searchTranslationRef as _searchTranslationRef } from './translation';\n\n/**\n * @alpha\n * @deprecated Import from `@backstage/plugin-search` instead.\n */\nexport const searchTranslationRef = _searchTranslationRef;\n"],"names":["SearchResults","_searchTranslationRef"],"mappings":";;;;;;;;;;;;;;;;;;;;AAuEO,MAAM,SAAA,GAAY,aAAa,IAAA,CAAK;AAAA,EACzC,MAAA,EAAQ,kBACN,YAAA,CAAa;AAAA,IACX,GAAA,EAAK,YAAA;AAAA,IACL,IAAA,EAAM,EAAE,YAAA,EAAc,eAAA,EAAiB,UAAU,WAAA,EAAY;AAAA,IAC7D,OAAA,EAAS,CAAC,EAAE,YAAA,EAAc,QAAA,EAAS,KACjC,IAAI,YAAA,CAAa,EAAE,YAAA,EAAc,QAAA,EAAU;AAAA,GAC9C;AACL,CAAC;AAED,MAAM,mBAAA,GAAsB,UAAA,CAAW,CAAC,KAAA,MAAkB;AAAA,EACxD,MAAA,EAAQ;AAAA,IACN,OAAA,EAAS;AAAA,MACP,SAAA,EAAW,KAAA,CAAM,OAAA,CAAQ,GAAG;AAAA;AAC9B,GACF;AAAA,EACA,OAAA,EAAS;AAAA,IACP,OAAA,EAAS,KAAA,CAAM,OAAA,CAAQ,CAAC,CAAA;AAAA,IACxB,SAAA,EAAW,KAAA,CAAM,OAAA,CAAQ,CAAC;AAAA;AAE9B,CAAA,CAAE,CAAA;AAGK,MAAM,UAAA,GAAa,cAAc,iBAAA,CAAkB;AAAA,EACxD,YAAA,EAAc;AAAA,IACZ,OAAA,EAAS,CAAA,CAAE,OAAA,EAAQ,CAAE,QAAQ,KAAK;AAAA,GACpC;AAAA,EACA,MAAA,EAAQ;AAAA,IACN,OAAO,oBAAA,CAAqB,CAAC,6BAAA,CAA8B,QAAA,CAAS,IAAI,CAAC,CAAA;AAAA,IACzE,aAAa,oBAAA,CAAqB;AAAA,MAChC,gCAAgC,QAAA,CAAS;AAAA,KAC1C,CAAA;AAAA,IACD,eAAe,oBAAA,CAAqB;AAAA,MAClC,sBAAsB,QAAA,CAAS;AAAA,KAChC;AAAA,GACH;AAAA,EACA,OAAA,CAAQ,eAAA,EAAiB,EAAE,MAAA,EAAQ,QAAO,EAAG;AAC3C,IAAA,OAAO,eAAA,CAAgB;AAAA,MACrB,IAAA,EAAM,SAAA;AAAA,MACN,QAAA,EAAU,YAAA;AAAA,MACV,KAAA,EAAO,QAAA;AAAA,MACP,IAAA,kBAAM,GAAA,CAAC,UAAA,EAAA,EAAW,QAAA,EAAS,SAAA,EAAU,CAAA;AAAA,MACrC,QAAQ,YAAY;AAClB,QAAA,MAAM,sBAAA,GAAyB,CAAC,MAAA,KAAyB;AACvD,UAAA,MAAM,KAAA,GAAQ,OAAO,KAAA,CAAM,IAAA;AAAA,YAAK,CAAA,IAAA,KAC9B,MACI,GAAA,CAAI,6BAAA,CAA8B,SAAS,IAAI,CAAA,CAChD,YAAY,MAAM;AAAA,WACvB;AACA,UAAA,OACE,OAAO,GAAA,CAAI,6BAAA,CAA8B,QAAA,CAAS,IAAI,EAAE,SAAA,IACxD,qBAAA;AAAA,QAEJ,CAAA;AAEA,QAAA,MAAM,WAAA,GAAc,OAAO,WAAA,CAAY,GAAA;AAAA,UAAI,CAAA,IAAA,KACzC,IAAA,CAAK,GAAA,CAAI,+BAAA,CAAgC,SAAS,UAAU;AAAA,SAC9D;AAEA,QAAA,MAAM,uBAAA,GAA0B,OAAO,aAAA,CAAc,GAAA;AAAA,UACnD,UACE,IAAA,CAAK,GAAA,CAAI,qBAAA,CAAsB,QAAA,CAAS,aAAa,CAAA,CAAE;AAAA,SAC3D;AAEA,QAAA,MAAM,YAAY,MAAM;AACtB,UAAA,MAAM,UAAU,mBAAA,EAAoB;AACpC,UAAA,MAAM,EAAE,QAAA,EAAS,GAAI,kBAAA,EAAmB;AACxC,UAAA,MAAM,EAAE,KAAA,EAAM,GAAI,SAAA,EAAU;AAC5B,UAAA,MAAM,UAAA,GAAa,OAAO,aAAa,CAAA;AACvC,UAAA,MAAM,SAAA,GAAY,OAAO,YAAY,CAAA;AAErC,UAAA,2BACG,OAAA,EAAA,EACC,QAAA,kBAAA,IAAA,CAAC,QAAK,SAAA,EAAS,IAAA,EAAC,WAAU,KAAA,EACxB,QAAA,EAAA;AAAA,4BAAA,GAAA,CAAC,IAAA,EAAA,EAAK,MAAI,IAAA,EAAC,EAAA,EAAI,IACb,QAAA,kBAAA,GAAA,CAAC,SAAA,EAAA,EAAU,YAAA,EAAc,GAAA,EAAK,CAAA,EAChC,CAAA;AAAA,YACC,CAAC,QAAA,oBACA,IAAA,CAAC,QAAK,IAAA,EAAI,IAAA,EAAC,IAAI,CAAA,EACb,QAAA,EAAA;AAAA,8BAAA,GAAA;AAAA,gBAAC,UAAA,CAAW,SAAA;AAAA,gBAAX;AAAA,kBACC,IAAA,EAAK,aAAA;AAAA,kBACL,cAAc,SAAA,CAAU,iBAAA;AAAA,oBACtB;AAAA,mBACF;AAAA,kBACA,UAAA,EAAU,IAAA;AAAA,kBACV,KAAA,EAAO;AAAA,oBACL;AAAA,sBACE,KAAA,EAAO,kBAAA;AAAA,sBACP,IAAA,EAAM,kBAAA;AAAA,sBACN,IAAA,sBAAO,WAAA,EAAA,EAAY;AAAA;AACrB,mBACF,CAAE,OAAO,WAAW;AAAA;AAAA,eACtB;AAAA,8BACA,IAAA,CAAC,KAAA,EAAA,EAAM,SAAA,EAAW,OAAA,CAAQ,OAAA,EACvB,QAAA,EAAA;AAAA,gBAAA,KAAA,CAAM,QAAA,CAAS,UAAU,CAAA,oBACxB,GAAA;AAAA,kBAAC,YAAA,CAAa,MAAA;AAAA,kBAAb;AAAA,oBACC,WAAW,OAAA,CAAQ,MAAA;AAAA,oBACnB,KAAA,EAAM,QAAA;AAAA,oBACN,IAAA,EAAK,MAAA;AAAA,oBACL,QAAQ,YAAY;AAElB,sBAAA,MAAM,EAAE,KAAA,EAAM,GAAI,MAAM,WAAW,WAAA,CAAY;AAAA,wBAC7C,MAAA,EAAQ,CAAC,eAAe,CAAA;AAAA,wBACxB,MAAA,EAAQ;AAAA,0BACN,gDAAA,EACE;AAAA;AACJ,uBACD,CAAA;AAED,sBAAA,MAAM,QAAQ,KAAA,CAAM,GAAA;AAAA,wBAClB,CAAA,MAAA,KAAU,OAAO,QAAA,CAAS;AAAA,uBAC5B;AACA,sBAAA,KAAA,CAAM,IAAA,EAAK;AACX,sBAAA,OAAO,KAAA;AAAA,oBACT;AAAA;AAAA,iBACF;AAAA,gCAEF,GAAA;AAAA,kBAAC,YAAA,CAAa,MAAA;AAAA,kBAAb;AAAA,oBACC,WAAW,OAAA,CAAQ,MAAA;AAAA,oBACnB,KAAA,EAAM,MAAA;AAAA,oBACN,IAAA,EAAK,MAAA;AAAA,oBACL,QAAQ,YAAY;AAClB,sBAAA,MAAM,EAAE,MAAA,EAAO,GAAI,MAAM,WAAW,eAAA,CAAgB;AAAA,wBAClD,MAAA,EAAQ,CAAC,MAAM;AAAA,uBAChB,CAAA;AACD,sBAAA,OAAA,CAAQ,OAAO,IAAA,IAAQ,EAAC,EACrB,GAAA,CAAI,WAAS,KAAA,CAAM,KAAK,CAAA,CACxB,IAAA,CAAK,CAAC,CAAA,EAAG,CAAA,KAAM,CAAA,CAAE,aAAA,CAAc,CAAC,CAAC,CAAA;AAAA,oBACtC;AAAA;AAAA,iBACF;AAAA,gCACA,GAAA;AAAA,kBAAC,YAAA,CAAa,QAAA;AAAA,kBAAb;AAAA,oBACC,WAAW,OAAA,CAAQ,MAAA;AAAA,oBACnB,KAAA,EAAM,WAAA;AAAA,oBACN,IAAA,EAAK,WAAA;AAAA,oBACL,MAAA,EAAQ,CAAC,cAAA,EAAgB,YAAY;AAAA;AAAA,iBACvC;AAAA,gBACC,uBAAA,CAAwB,IAAI,CAAA,qBAAA,qBAC3B,GAAA,CAAC,yBAAsB,SAAA,EAAW,OAAA,CAAQ,QAAQ,CACnD;AAAA,eAAA,EACH;AAAA,aAAA,EACF,CAAA;AAAA,4BAEF,IAAA,CAAC,IAAA,EAAA,EAAK,IAAA,EAAI,IAAA,EAAC,IAAE,IAAA,EACX,QAAA,EAAA;AAAA,8BAAA,GAAA,CAAC,gBAAA,EAAA,EAAiB,CAAA;AAAA,8BAClB,GAAA,CAACA,YAAA,EAAA,EACE,QAAA,EAAA,CAAC,EAAE,OAAA,EAAQ,qBACV,GAAA,CAAA,QAAA,EAAA,EACG,QAAA,EAAA,OAAA,CAAQ,GAAA,CAAI,CAAC,MAAA,EAAQ,KAAA,KAAU;AAC9B,gBAAA,MAAM,EAAE,SAAQ,GAAI,MAAA;AACpB,gBAAA,MAAM,EAAE,QAAA,EAAU,GAAG,IAAA,EAAK,GAAI,MAAA;AAC9B,gBAAA,MAAM,oBAAA,GACJ,uBAAuB,MAAM,CAAA;AAC/B,gBAAA,uBACE,aAAA;AAAA,kBAAC,oBAAA;AAAA,kBAAA;AAAA,oBACE,GAAG,IAAA;AAAA,oBACJ,GAAA,EAAK,KAAA;AAAA,oBACL,MAAA,EAAQ,QAAA;AAAA,oBACR;AAAA;AAAA,iBACF;AAAA,cAEJ,CAAC,GACH,CAAA,EAEJ,CAAA;AAAA,kCACC,iBAAA,EAAA,EAAkB;AAAA,aAAA,EACrB;AAAA,WAAA,EACF,CAAA,EACF,CAAA;AAAA,QAEJ,CAAA;AAEA,QAAA,4BACG,qBAAA,EAAA,EACC,QAAA,EAAA;AAAA,0BAAA,GAAA,CAAC,UAAA,EAAA,EAAW,CAAA;AAAA,8BACX,SAAA,EAAA,EAAU;AAAA,SAAA,EACb,CAAA;AAAA,MAEJ;AAAA,KACD,CAAA;AAAA,EACH;AACF,CAAC;AAED,MAAM,uBAAA,GAA0B,wBAAwB,IAAA,CAAK;AAAA,EAC3D,IAAA,EAAM,YAAA;AAAA,EACN,MAAA,EAAQ;AAAA,IACN,IAAA,EAAM,mBAAA;AAAA,IACN,KAAA,EAAO,QAAA;AAAA,IACP,WAAA,EAAa,0DAAA;AAAA,IACb,YAAY,MACV,OAAO,6CAAgC,CAAA,CAAE,KAAK,CAAA,CAAA,MAAM;AAAA,MAClD,SAAS,CAAA,CAAE;AAAA,KACb,CAAE,CAAA;AAAA,IACJ,cAAA,EAAgB;AAAA,MACd,UAAU,CAAC;AAAA,QACT,OAAA,EAAS;AAAA,OACX,yBAEO,aAAA,EAAA,EAAc;AAAA;AACvB;AAEJ,CAAC,CAAA;AAGD,YAAe,oBAAA,CAAqB;AAAA,EAClC,QAAA,EAAU,QAAA;AAAA,EACV,KAAA,EAAO,QAAA;AAAA,EACP,IAAA,kBAAM,GAAA,CAAC,UAAA,EAAA,EAAW,QAAA,EAAS,SAAA,EAAU,CAAA;AAAA,EACrC,MAAM,EAAE,WAAA,EAAa,MAAM,OAAO,uBAAiB,CAAA,EAAE;AAAA,EACrD,UAAA,EAAY,CAAC,SAAA,EAAW,UAAA,EAAY,uBAAuB,CAAA;AAAA,EAC3D,MAAA,EAAQ;AAAA,IACN,IAAA,EAAM;AAAA;AAEV,CAAC,CAAA;AAQM,MAAM,oBAAA,GAAuBC;;;;"}
@@ -1,5 +1,5 @@
1
1
  var name = "@backstage/plugin-search";
2
- var version = "1.7.7-next.1";
2
+ var version = "1.7.7-next.2";
3
3
  var description = "The Backstage plugin that provides your backstage app with search";
4
4
  var backstage = {
5
5
  role: "frontend-plugin",
@@ -62,6 +62,7 @@ var dependencies = {
62
62
  "@backstage/errors": "workspace:^",
63
63
  "@backstage/frontend-plugin-api": "workspace:^",
64
64
  "@backstage/plugin-catalog-react": "workspace:^",
65
+ "@backstage/plugin-home-react": "workspace:^",
65
66
  "@backstage/plugin-search-common": "workspace:^",
66
67
  "@backstage/plugin-search-react": "workspace:^",
67
68
  "@backstage/types": "workspace:^",
@@ -1 +1 @@
1
- {"version":3,"file":"package.json.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
1
+ {"version":3,"file":"package.json.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-search",
3
- "version": "1.7.7-next.1",
3
+ "version": "1.7.7-next.2",
4
4
  "description": "The Backstage plugin that provides your backstage app with search",
5
5
  "backstage": {
6
6
  "role": "frontend-plugin",
@@ -71,10 +71,11 @@
71
71
  },
72
72
  "dependencies": {
73
73
  "@backstage/core-components": "0.18.13-next.2",
74
- "@backstage/core-plugin-api": "1.12.9-next.0",
74
+ "@backstage/core-plugin-api": "1.12.9-next.1",
75
75
  "@backstage/errors": "1.3.1",
76
76
  "@backstage/frontend-plugin-api": "0.18.0-next.0",
77
- "@backstage/plugin-catalog-react": "3.2.1-next.2",
77
+ "@backstage/plugin-catalog-react": "3.2.1-next.3",
78
+ "@backstage/plugin-home-react": "0.1.41-next.2",
78
79
  "@backstage/plugin-search-common": "1.2.24",
79
80
  "@backstage/plugin-search-react": "1.11.7-next.1",
80
81
  "@backstage/types": "1.2.2",