@backstage/plugin-search-react 1.9.6-next.0 → 1.10.0

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @backstage/plugin-search-react
 
+## 1.10.0
+
+### Minor Changes
+
+- a521911: Add support for customizable icons in `SearchResultListItemBlueprint` and related components
+
+### Patch Changes
+
+- 05f60e1: Refactored constructor parameter properties to explicit property declarations for compatibility with TypeScript's `erasableSyntaxOnly` setting. This internal refactoring maintains all existing functionality while ensuring TypeScript compilation compatibility.
+- Updated dependencies
+  - @backstage/frontend-plugin-api@0.13.0
+  - @backstage/core-components@0.18.3
+  - @backstage/core-plugin-api@1.12.0
+  - @backstage/plugin-search-common@1.2.21
+
+## 1.10.0-next.1
+
+### Minor Changes
+
+- a521911: Add support for customizable icons in `SearchResultListItemBlueprint` and related components
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/core-components@0.18.3-next.1
+  - @backstage/core-plugin-api@1.11.2-next.1
+  - @backstage/frontend-plugin-api@0.12.2-next.1
+
 ## 1.9.6-next.0
 
 ### Patch Changes

package/dist/alpha/blueprints/SearchResultListItemBlueprint.esm.js

@@ -31,7 +31,7 @@ const SearchResultListItemBlueprint = createExtensionBlueprint({
           rank: props.rank,
           result: props.result,
           noTrack: config.noTrack,
-          children: /* @__PURE__ */ jsx(ExtensionComponent, { ...props })
+          children: /* @__PURE__ */ jsx(ExtensionComponent, { icon: params.icon, ...props })
         }
       ) })
     });

package/dist/alpha/blueprints/SearchResultListItemBlueprint.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"SearchResultListItemBlueprint.esm.js","sources":["../../../src/alpha/blueprints/SearchResultListItemBlueprint.tsx"],"sourcesContent":["/*\n * Copyright 2024 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 { lazy } from 'react';\nimport {\n  createExtensionBlueprint,\n  ExtensionBoundary,\n} from '@backstage/frontend-plugin-api';\nimport {\n  SearchResultItemExtensionComponent,\n  SearchResultItemExtensionPredicate,\n  searchResultListItemDataRef,\n} from './types';\nimport {\n  SearchResultListItemExtension,\n  SearchResultListItemExtensionProps,\n} from '../../extensions';\n\n/** @alpha */\nexport interface SearchResultListItemBlueprintParams {\n  /**\n   * The extension component.\n   */\n  component: (options: {\n    config: { noTrack?: boolean };\n  }) => Promise<SearchResultItemExtensionComponent>;\n  /**\n   * When an extension defines a predicate, it returns true if the result should be rendered by that extension.\n   * Defaults to a predicate that returns true, which means it renders all sorts of results.\n   */\n  predicate?: SearchResultItemExtensionPredicate;\n}\n\n/**\n * @alpha\n * Creates SearchResultListItem extensions\n */\nexport const SearchResultListItemBlueprint = createExtensionBlueprint({\n  kind: 'search-result-list-item',\n  attachTo: {\n    id: 'page:search',\n    input: 'items',\n  },\n  config: {\n    schema: {\n      noTrack: z => z.boolean().default(false),\n    },\n  },\n  output: [searchResultListItemDataRef],\n  dataRefs: {\n    item: searchResultListItemDataRef,\n  },\n  *factory(params: SearchResultListItemBlueprintParams, { config, node }) {\n    const ExtensionComponent = lazy(() =>\n      params.component({ config }).then(component => ({ default: component })),\n    );\n\n    yield searchResultListItemDataRef({\n      predicate: params.predicate,\n      component: (props: SearchResultListItemExtensionProps) => (\n        <ExtensionBoundary node={node}>\n          <SearchResultListItemExtension\n            rank={props.rank}\n            result={props.result}\n            noTrack={config.noTrack}\n          >\n            <ExtensionComponent {...props} />\n          </SearchResultListItemExtension>\n        </ExtensionBoundary>\n      ),\n    });\n  },\n});\n"],"names":[],"mappings":";;;;;;AAkDO,MAAM,gCAAgC,wBAAA,CAAyB;AAAA,EACpE,IAAA,EAAM,yBAAA;AAAA,EACN,QAAA,EAAU;AAAA,IACR,EAAA,EAAI,aAAA;AAAA,IACJ,KAAA,EAAO;AAAA,GACT;AAAA,EACA,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,CAAC,2BAA2B,CAAA;AAAA,EACpC,QAAA,EAAU;AAAA,IACR,IAAA,EAAM;AAAA,GACR;AAAA,EACA,CAAC,OAAA,CAAQ,MAAA,EAA6C,EAAE,MAAA,EAAQ,MAAK,EAAG;AACtE,IAAA,MAAM,kBAAA,GAAqB,IAAA;AAAA,MAAK,MAC9B,MAAA,CAAO,SAAA,CAAU,EAAE,MAAA,EAAQ,CAAA,CAAE,IAAA,CAAK,CAAA,SAAA,MAAc,EAAE,OAAA,EAAS,SAAA,EAAU,CAAE;AAAA,KACzE;AAEA,IAAA,MAAM,2BAAA,CAA4B;AAAA,MAChC,WAAW,MAAA,CAAO,SAAA;AAAA,MAClB,SAAA,EAAW,CAAC,KAAA,qBACV,GAAA,CAAC,qBAAkB,IAAA,EACjB,QAAA,kBAAA,GAAA;AAAA,QAAC,6BAAA;AAAA,QAAA;AAAA,UACC,MAAM,KAAA,CAAM,IAAA;AAAA,UACZ,QAAQ,KAAA,CAAM,MAAA;AAAA,UACd,SAAS,MAAA,CAAO,OAAA;AAAA,UAEhB,QAAA,kBAAA,GAAA,CAAC,kBAAA,EAAA,EAAoB,GAAG,KAAA,EAAO;AAAA;AAAA,OACjC,EACF;AAAA,KAEH,CAAA;AAAA,EACH;AACF,CAAC;;;;"}
+{"version":3,"file":"SearchResultListItemBlueprint.esm.js","sources":["../../../src/alpha/blueprints/SearchResultListItemBlueprint.tsx"],"sourcesContent":["/*\n * Copyright 2024 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 { lazy, JSX } from 'react';\nimport {\n  createExtensionBlueprint,\n  ExtensionBoundary,\n} from '@backstage/frontend-plugin-api';\nimport {\n  SearchResultItemExtensionComponent,\n  SearchResultItemExtensionPredicate,\n  searchResultListItemDataRef,\n} from './types';\nimport {\n  SearchResultListItemExtension,\n  SearchResultListItemExtensionProps,\n} from '../../extensions';\n\n/** @alpha */\nexport interface SearchResultListItemBlueprintParams {\n  /**\n   * The extension component.\n   */\n  component: (options: {\n    config: { noTrack?: boolean };\n  }) => Promise<SearchResultItemExtensionComponent>;\n  /**\n   * When an extension defines a predicate, it returns true if the result should be rendered by that extension.\n   * Defaults to a predicate that returns true, which means it renders all sorts of results.\n   */\n  predicate?: SearchResultItemExtensionPredicate;\n\n  /**\n   * The icon of the result item.\n   */\n  icon?: JSX.Element;\n}\n\n/**\n * @alpha\n * Creates SearchResultListItem extensions\n */\nexport const SearchResultListItemBlueprint = createExtensionBlueprint({\n  kind: 'search-result-list-item',\n  attachTo: {\n    id: 'page:search',\n    input: 'items',\n  },\n  config: {\n    schema: {\n      noTrack: z => z.boolean().default(false),\n    },\n  },\n  output: [searchResultListItemDataRef],\n  dataRefs: {\n    item: searchResultListItemDataRef,\n  },\n  *factory(params: SearchResultListItemBlueprintParams, { config, node }) {\n    const ExtensionComponent = lazy(() =>\n      params.component({ config }).then(component => ({ default: component })),\n    );\n\n    yield searchResultListItemDataRef({\n      predicate: params.predicate,\n      component: (props: SearchResultListItemExtensionProps) => (\n        <ExtensionBoundary node={node}>\n          <SearchResultListItemExtension\n            rank={props.rank}\n            result={props.result}\n            noTrack={config.noTrack}\n          >\n            <ExtensionComponent icon={params.icon} {...props} />\n          </SearchResultListItemExtension>\n        </ExtensionBoundary>\n      ),\n    });\n  },\n});\n"],"names":[],"mappings":";;;;;;AAuDO,MAAM,gCAAgC,wBAAA,CAAyB;AAAA,EACpE,IAAA,EAAM,yBAAA;AAAA,EACN,QAAA,EAAU;AAAA,IACR,EAAA,EAAI,aAAA;AAAA,IACJ,KAAA,EAAO;AAAA,GACT;AAAA,EACA,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,CAAC,2BAA2B,CAAA;AAAA,EACpC,QAAA,EAAU;AAAA,IACR,IAAA,EAAM;AAAA,GACR;AAAA,EACA,CAAC,OAAA,CAAQ,MAAA,EAA6C,EAAE,MAAA,EAAQ,MAAK,EAAG;AACtE,IAAA,MAAM,kBAAA,GAAqB,IAAA;AAAA,MAAK,MAC9B,MAAA,CAAO,SAAA,CAAU,EAAE,MAAA,EAAQ,CAAA,CAAE,IAAA,CAAK,CAAA,SAAA,MAAc,EAAE,OAAA,EAAS,SAAA,EAAU,CAAE;AAAA,KACzE;AAEA,IAAA,MAAM,2BAAA,CAA4B;AAAA,MAChC,WAAW,MAAA,CAAO,SAAA;AAAA,MAClB,SAAA,EAAW,CAAC,KAAA,qBACV,GAAA,CAAC,qBAAkB,IAAA,EACjB,QAAA,kBAAA,GAAA;AAAA,QAAC,6BAAA;AAAA,QAAA;AAAA,UACC,MAAM,KAAA,CAAM,IAAA;AAAA,UACZ,QAAQ,KAAA,CAAM,MAAA;AAAA,UACd,SAAS,MAAA,CAAO,OAAA;AAAA,UAEhB,8BAAC,kBAAA,EAAA,EAAmB,IAAA,EAAM,MAAA,CAAO,IAAA,EAAO,GAAG,KAAA,EAAO;AAAA;AAAA,OACpD,EACF;AAAA,KAEH,CAAA;AAAA,EACH;AACF,CAAC;;;;"}

package/dist/alpha/blueprints/types.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.esm.js","sources":["../../../src/alpha/blueprints/types.ts"],"sourcesContent":["/*\n * Copyright 2024 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 { ListItemProps } from '@material-ui/core/ListItem';\nimport { SearchDocument, SearchResult } from '@backstage/plugin-search-common';\nimport { createExtensionDataRef } from '@backstage/frontend-plugin-api';\n\n/** @alpha */\nexport type BaseSearchResultListItemProps<T = {}> = T & {\n  rank?: number;\n  result?: SearchDocument;\n} & Omit<ListItemProps, 'button'>;\n\n/** @alpha */\nexport type SearchResultItemExtensionComponent = <\n  P extends BaseSearchResultListItemProps,\n>(\n  props: P,\n) => JSX.Element | null;\n\n/** @alpha */\nexport type SearchResultItemExtensionPredicate = (\n  result: SearchResult,\n) => boolean;\n\n/** @alpha */\nexport const searchResultListItemDataRef = createExtensionDataRef<{\n  predicate?: SearchResultItemExtensionPredicate;\n  component: SearchResultItemExtensionComponent;\n}>().with({ id: 'search.search-result-list-item.item' });\n\n/** @alpha */\nexport const searchResultTypeDataRef = createExtensionDataRef<{\n  value: string;\n  name: string;\n  icon: JSX.Element;\n}>().with({ id: 'search.filters.result-types.type' });\n\n/** @alpha */\nexport type SearchFilterExtensionComponentProps = {\n  className: string;\n};\n\n/** @alpha */\nexport type SearchFilterExtensionComponent = (\n  props: SearchFilterExtensionComponentProps,\n) => JSX.Element;\n\n/** @alpha */\nexport const searchFilterDataRef = createExtensionDataRef<{\n  component: SearchFilterExtensionComponent;\n}>().with({ id: 'search.filters.filter' });\n"],"names":[],"mappings":";;AAuCO,MAAM,8BAA8B,sBAAA,EAGxC,CAAE,KAAK,EAAE,EAAA,EAAI,uCAAuC;AAGhD,MAAM,0BAA0B,sBAAA,EAIpC,CAAE,KAAK,EAAE,EAAA,EAAI,oCAAoC;AAa7C,MAAM,sBAAsB,sBAAA,EAEhC,CAAE,KAAK,EAAE,EAAA,EAAI,yBAAyB;;;;"}
+{"version":3,"file":"types.esm.js","sources":["../../../src/alpha/blueprints/types.ts"],"sourcesContent":["/*\n * Copyright 2024 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 { JSX } from 'react';\nimport { ListItemProps } from '@material-ui/core/ListItem';\nimport { SearchDocument, SearchResult } from '@backstage/plugin-search-common';\nimport { createExtensionDataRef } from '@backstage/frontend-plugin-api';\n\n/** @alpha */\nexport type BaseSearchResultListItemProps<T = {}> = T & {\n  rank?: number;\n  result?: SearchDocument;\n  icon?: JSX.Element;\n} & Omit<ListItemProps, 'button'>;\n\n/** @alpha */\nexport type SearchResultItemExtensionComponent = <\n  P extends BaseSearchResultListItemProps,\n>(\n  props: P,\n) => JSX.Element | null;\n\n/** @alpha */\nexport type SearchResultItemExtensionPredicate = (\n  result: SearchResult,\n) => boolean;\n\n/** @alpha */\nexport const searchResultListItemDataRef = createExtensionDataRef<{\n  predicate?: SearchResultItemExtensionPredicate;\n  component: SearchResultItemExtensionComponent;\n  icon?: JSX.Element;\n}>().with({ id: 'search.search-result-list-item.item' });\n\n/** @alpha */\nexport const searchResultTypeDataRef = createExtensionDataRef<{\n  value: string;\n  name: string;\n  icon: JSX.Element;\n}>().with({ id: 'search.filters.result-types.type' });\n\n/** @alpha */\nexport type SearchFilterExtensionComponentProps = {\n  className: string;\n};\n\n/** @alpha */\nexport type SearchFilterExtensionComponent = (\n  props: SearchFilterExtensionComponentProps,\n) => JSX.Element;\n\n/** @alpha */\nexport const searchFilterDataRef = createExtensionDataRef<{\n  component: SearchFilterExtensionComponent;\n}>().with({ id: 'search.filters.filter' });\n"],"names":[],"mappings":";;AAyCO,MAAM,8BAA8B,sBAAA,EAIxC,CAAE,KAAK,EAAE,EAAA,EAAI,uCAAuC;AAGhD,MAAM,0BAA0B,sBAAA,EAIpC,CAAE,KAAK,EAAE,EAAA,EAAI,oCAAoC;AAa7C,MAAM,sBAAsB,sBAAA,EAEhC,CAAE,KAAK,EAAE,EAAA,EAAI,yBAAyB;;;;"}

package/dist/alpha.d.ts

@@ -1,4 +1,6 @@
 import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api';
+import * as react from 'react';
+import { JSX as JSX$1 } from 'react';
 import { ListItemProps } from '@material-ui/core/ListItem';
 import { SearchDocument, SearchResult } from '@backstage/plugin-search-common';
 import * as _backstage_core_plugin_api_alpha from '@backstage/core-plugin-api/alpha';
@@ -7,9 +9,10 @@ import * as _backstage_core_plugin_api_alpha from '@backstage/core-plugin-api/al
 type BaseSearchResultListItemProps<T = {}> = T & {
     rank?: number;
     result?: SearchDocument;
+    icon?: JSX$1.Element;
 } & Omit<ListItemProps, 'button'>;
 /** @alpha */
-type SearchResultItemExtensionComponent = <P extends BaseSearchResultListItemProps>(props: P) => JSX.Element | null;
+type SearchResultItemExtensionComponent = <P extends BaseSearchResultListItemProps>(props: P) => JSX$1.Element | null;
 /** @alpha */
 type SearchResultItemExtensionPredicate = (result: SearchResult) => boolean;
 /** @alpha */
@@ -17,7 +20,7 @@ type SearchFilterExtensionComponentProps = {
     className: string;
 };
 /** @alpha */
-type SearchFilterExtensionComponent = (props: SearchFilterExtensionComponentProps) => JSX.Element;
+type SearchFilterExtensionComponent = (props: SearchFilterExtensionComponentProps) => JSX$1.Element;
 
 /** @alpha */
 interface SearchResultListItemBlueprintParams {
@@ -34,6 +37,10 @@ interface SearchResultListItemBlueprintParams {
      * Defaults to a predicate that returns true, which means it renders all sorts of results.
      */
     predicate?: SearchResultItemExtensionPredicate;
+    /**
+     * The icon of the result item.
+     */
+    icon?: JSX$1.Element;
 }
 /**
  * @alpha
@@ -45,6 +52,7 @@ declare const SearchResultListItemBlueprint: _backstage_frontend_plugin_api.Exte
     output: _backstage_frontend_plugin_api.ExtensionDataRef<{
         predicate?: SearchResultItemExtensionPredicate;
         component: SearchResultItemExtensionComponent;
+        icon?: JSX$1.Element;
     }, "search.search-result-list-item.item", {}>;
     inputs: {};
     config: {
@@ -57,6 +65,7 @@ declare const SearchResultListItemBlueprint: _backstage_frontend_plugin_api.Exte
         item: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<{
             predicate?: SearchResultItemExtensionPredicate;
             component: SearchResultItemExtensionComponent;
+            icon?: JSX$1.Element;
         }, "search.search-result-list-item.item", {}>;
     };
 }>;
@@ -85,7 +94,7 @@ declare const SearchFilterResultTypeBlueprint: _backstage_frontend_plugin_api.Ex
     output: _backstage_frontend_plugin_api.ExtensionDataRef<{
         value: string;
         name: string;
-        icon: JSX.Element;
+        icon: react.JSX.Element;
     }, "search.filters.result-types.type", {}>;
     inputs: {};
     config: {};
@@ -94,7 +103,7 @@ declare const SearchFilterResultTypeBlueprint: _backstage_frontend_plugin_api.Ex
         resultType: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<{
             value: string;
             name: string;
-            icon: JSX.Element;
+            icon: react.JSX.Element;
         }, "search.filters.result-types.type", {}>;
     };
 }>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-search-react",
-  "version": "1.9.6-next.0",
+  "version": "1.10.0",
   "backstage": {
     "role": "web-library",
     "pluginId": "search",
@@ -64,13 +64,13 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/core-components": "0.18.3-next.0",
-    "@backstage/core-plugin-api": "1.11.2-next.0",
-    "@backstage/frontend-plugin-api": "0.12.2-next.0",
-    "@backstage/plugin-search-common": "1.2.21-next.0",
-    "@backstage/theme": "0.7.0",
-    "@backstage/types": "1.2.2",
-    "@backstage/version-bridge": "1.0.11",
+    "@backstage/core-components": "^0.18.3",
+    "@backstage/core-plugin-api": "^1.12.0",
+    "@backstage/frontend-plugin-api": "^0.13.0",
+    "@backstage/plugin-search-common": "^1.2.21",
+    "@backstage/theme": "^0.7.0",
+    "@backstage/types": "^1.2.2",
+    "@backstage/version-bridge": "^1.0.11",
     "@material-ui/core": "^4.12.2",
     "@material-ui/icons": "^4.9.1",
     "@material-ui/lab": "4.0.0-alpha.61",
@@ -80,11 +80,11 @@
     "uuid": "^11.0.2"
   },
   "devDependencies": {
-    "@backstage/cli": "0.34.5-next.0",
-    "@backstage/core-app-api": "1.19.2-next.0",
-    "@backstage/frontend-app-api": "0.13.2-next.0",
-    "@backstage/frontend-test-utils": "0.4.1-next.0",
-    "@backstage/test-utils": "1.7.13-next.0",
+    "@backstage/cli": "^0.34.5",
+    "@backstage/core-app-api": "^1.19.2",
+    "@backstage/frontend-app-api": "^0.13.2",
+    "@backstage/frontend-test-utils": "^0.4.1",
+    "@backstage/test-utils": "^1.7.13",
     "@testing-library/dom": "^10.0.0",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^16.0.0",