@backstage/plugin-search 1.7.1 → 1.7.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,16 @@
1
1
  # @backstage/plugin-search
2
2
 
3
+ ## 1.7.2
4
+
5
+ ### Patch Changes
6
+
7
+ - 6b60bd7: Replaced old config schema values from existing extensions and blueprints.
8
+ - Updated dependencies
9
+ - @backstage/ui@0.14.1
10
+ - @backstage/frontend-plugin-api@0.16.1
11
+ - @backstage/plugin-catalog-react@2.1.3
12
+ - @backstage/plugin-search-react@1.11.2
13
+
3
14
  ## 1.7.1
4
15
 
5
16
  ### Patch Changes
package/dist/alpha.d.ts CHANGED
@@ -22,8 +22,8 @@ declare const searchPage: _backstage_frontend_plugin_api.OverridableExtensionDef
22
22
  };
23
23
  configInput: {
24
24
  noTrack?: boolean | undefined;
25
- title?: string | undefined;
26
25
  path?: string | undefined;
26
+ title?: string | undefined;
27
27
  };
28
28
  output: _backstage_frontend_plugin_api.ExtensionDataRef<string, "core.routing.path", {}> | _backstage_frontend_plugin_api.ExtensionDataRef<_backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams>, "core.routing.ref", {
29
29
  optional: true;
@@ -85,8 +85,12 @@ declare const searchPage: _backstage_frontend_plugin_api.OverridableExtensionDef
85
85
  declare const searchNavItem: _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
86
86
  kind: "nav-item";
87
87
  name: undefined;
88
- config: {};
89
- configInput: {};
88
+ config: {
89
+ title: string | undefined;
90
+ };
91
+ configInput: {
92
+ title?: string | undefined;
93
+ };
90
94
  output: _backstage_frontend_plugin_api.ExtensionDataRef<{
91
95
  title: string;
92
96
  icon: _backstage_frontend_plugin_api.IconComponent;
@@ -115,8 +119,12 @@ declare const _default: _backstage_frontend_plugin_api.OverridableFrontendPlugin
115
119
  "nav-item:search": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
116
120
  kind: "nav-item";
117
121
  name: undefined;
118
- config: {};
119
- configInput: {};
122
+ config: {
123
+ title: string | undefined;
124
+ };
125
+ configInput: {
126
+ title?: string | undefined;
127
+ };
120
128
  output: _backstage_frontend_plugin_api.ExtensionDataRef<{
121
129
  title: string;
122
130
  icon: _backstage_frontend_plugin_api.IconComponent;
@@ -137,8 +145,8 @@ declare const _default: _backstage_frontend_plugin_api.OverridableFrontendPlugin
137
145
  };
138
146
  configInput: {
139
147
  noTrack?: boolean | undefined;
140
- title?: string | undefined;
141
148
  path?: string | undefined;
149
+ title?: string | undefined;
142
150
  };
143
151
  output: _backstage_frontend_plugin_api.ExtensionDataRef<string, "core.routing.path", {}> | _backstage_frontend_plugin_api.ExtensionDataRef<_backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams>, "core.routing.ref", {
144
152
  optional: true;
package/dist/alpha.esm.js CHANGED
@@ -4,6 +4,7 @@ import Grid from '@material-ui/core/Grid';
4
4
  import Paper from '@material-ui/core/Paper';
5
5
  import { makeStyles } from '@material-ui/core/styles';
6
6
  import SearchIcon from '@material-ui/icons/Search';
7
+ import { z } from 'zod/v4';
7
8
  import { useSidebarPinState, Content, CatalogIcon, DocsIcon } from '@backstage/core-components';
8
9
  import { fetchApiRef, discoveryApiRef, useApi } from '@backstage/core-plugin-api';
9
10
  import { ApiBlueprint, PageBlueprint, createExtensionInput, NavItemBlueprint, createFrontendPlugin, configApiRef } from '@backstage/frontend-plugin-api';
@@ -35,10 +36,8 @@ const useSearchPageStyles = makeStyles((theme) => ({
35
36
  }
36
37
  }));
37
38
  const searchPage = PageBlueprint.makeWithOverrides({
38
- config: {
39
- schema: {
40
- noTrack: (z) => z.boolean().default(false)
41
- }
39
+ configSchema: {
40
+ noTrack: z.boolean().default(false)
42
41
  },
43
42
  inputs: {
44
43
  items: createExtensionInput([SearchResultListItemBlueprint.dataRefs.item]),
@@ -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';\n\nimport {\n CatalogIcon,\n Content,\n DocsIcon,\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 NavItemBlueprint,\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 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 path: '/search',\n routeRef: 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 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 {\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={[\n 'API',\n 'Component',\n 'Domain',\n 'Group',\n 'Location',\n 'Resource',\n 'System',\n 'Template',\n 'User',\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 const searchNavItem = NavItemBlueprint.make({\n params: {\n routeRef: rootRouteRef,\n title: 'Search',\n icon: SearchIcon,\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, searchNavItem],\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,MAAA,EAAQ;AAAA,IACN,MAAA,EAAQ;AAAA,MACN,SAAS,CAAA,CAAA,KAAK,CAAA,CAAE,OAAA,EAAQ,CAAE,QAAQ,KAAK;AAAA;AACzC,GACF;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,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,qBACrB;AAAA,oBACA;AAAA,sBACE,KAAA,EAAO,UAAA;AAAA,sBACP,IAAA,EAAM,eAAA;AAAA,sBACN,IAAA,sBAAO,QAAA,EAAA,EAAS;AAAA;AAClB,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,MAAA,EAAQ;AAAA,sBACN,KAAA;AAAA,sBACA,WAAA;AAAA,sBACA,QAAA;AAAA,sBACA,OAAA;AAAA,sBACA,UAAA;AAAA,sBACA,UAAA;AAAA,sBACA,QAAA;AAAA,sBACA,UAAA;AAAA,sBACA;AAAA;AACF;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;AAGM,MAAM,aAAA,GAAgB,iBAAiB,IAAA,CAAK;AAAA,EACjD,MAAA,EAAQ;AAAA,IACN,QAAA,EAAU,YAAA;AAAA,IACV,KAAA,EAAO,QAAA;AAAA,IACP,IAAA,EAAM;AAAA;AAEV,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,UAAA,EAAY,aAAa,CAAA;AAAA,EACjD,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 DocsIcon,\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 NavItemBlueprint,\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 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 {\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={[\n 'API',\n 'Component',\n 'Domain',\n 'Group',\n 'Location',\n 'Resource',\n 'System',\n 'Template',\n 'User',\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 const searchNavItem = NavItemBlueprint.make({\n params: {\n routeRef: rootRouteRef,\n title: 'Search',\n icon: SearchIcon,\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, searchNavItem],\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":";;;;;;;;;;;;;;;;;;;AAwEO,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,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,qBACrB;AAAA,oBACA;AAAA,sBACE,KAAA,EAAO,UAAA;AAAA,sBACP,IAAA,EAAM,eAAA;AAAA,sBACN,IAAA,sBAAO,QAAA,EAAA,EAAS;AAAA;AAClB,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,MAAA,EAAQ;AAAA,sBACN,KAAA;AAAA,sBACA,WAAA;AAAA,sBACA,QAAA;AAAA,sBACA,OAAA;AAAA,sBACA,UAAA;AAAA,sBACA,UAAA;AAAA,sBACA,QAAA;AAAA,sBACA,UAAA;AAAA,sBACA;AAAA;AACF;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;AAGM,MAAM,aAAA,GAAgB,iBAAiB,IAAA,CAAK;AAAA,EACjD,MAAA,EAAQ;AAAA,IACN,QAAA,EAAU,YAAA;AAAA,IACV,KAAA,EAAO,QAAA;AAAA,IACP,IAAA,EAAM;AAAA;AAEV,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,UAAA,EAAY,aAAa,CAAA;AAAA,EACjD,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.1";
2
+ var version = "1.7.2";
3
3
  var description = "The Backstage plugin that provides your backstage app with search";
4
4
  var backstage = {
5
5
  role: "frontend-plugin",
@@ -70,7 +70,8 @@ var dependencies = {
70
70
  "@material-ui/core": "^4.12.2",
71
71
  "@material-ui/icons": "^4.9.1",
72
72
  qs: "^6.9.4",
73
- "react-use": "^17.2.4"
73
+ "react-use": "^17.2.4",
74
+ zod: "^3.25.76 || ^4.0.0"
74
75
  };
75
76
  var devDependencies = {
76
77
  "@backstage/cli": "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.1",
3
+ "version": "1.7.2",
4
4
  "description": "The Backstage plugin that provides your backstage app with search",
5
5
  "backstage": {
6
6
  "role": "frontend-plugin",
@@ -73,17 +73,18 @@
73
73
  "@backstage/core-components": "^0.18.9",
74
74
  "@backstage/core-plugin-api": "^1.12.5",
75
75
  "@backstage/errors": "^1.3.0",
76
- "@backstage/frontend-plugin-api": "^0.16.0",
77
- "@backstage/plugin-catalog-react": "^2.1.2",
76
+ "@backstage/frontend-plugin-api": "^0.16.1",
77
+ "@backstage/plugin-catalog-react": "^2.1.3",
78
78
  "@backstage/plugin-search-common": "^1.2.23",
79
- "@backstage/plugin-search-react": "^1.11.1",
79
+ "@backstage/plugin-search-react": "^1.11.2",
80
80
  "@backstage/types": "^1.2.2",
81
- "@backstage/ui": "^0.14.0",
81
+ "@backstage/ui": "^0.14.1",
82
82
  "@backstage/version-bridge": "^1.0.12",
83
83
  "@material-ui/core": "^4.12.2",
84
84
  "@material-ui/icons": "^4.9.1",
85
85
  "qs": "^6.9.4",
86
- "react-use": "^17.2.4"
86
+ "react-use": "^17.2.4",
87
+ "zod": "^3.25.76 || ^4.0.0"
87
88
  },
88
89
  "devDependencies": {
89
90
  "@backstage/cli": "^0.36.1",