@backstage/plugin-search-react 0.0.0-nightly-20240820021901 → 0.0.0-nightly-20240821021909

package/CHANGELOG.md

@@ -1,6 +1,14 @@
 # @backstage/plugin-search-react
 
-## 0.0.0-nightly-20240820021901
+## 0.0.0-nightly-20240821021909
+
+### Patch Changes
+
+- 5446061: The `/alpha` export no longer export extension creators for the new frontend system, existing usage should be switched to use the equivalent extension blueprint instead. For more information see the [new frontend system 1.30 migration documentation](https://backstage.io/docs/frontend-system/architecture/migrations#130).
+- Updated dependencies
+  - @backstage/frontend-plugin-api@0.0.0-nightly-20240821021909
+
+## 1.7.14
 
 ### Patch Changes
 
@@ -9,9 +17,9 @@
 - 3123c16: Fix package metadata
 - 6349099: Added config input type to the extensions
 - Updated dependencies
-  - @backstage/frontend-plugin-api@0.0.0-nightly-20240820021901
-  - @backstage/core-components@0.0.0-nightly-20240820021901
-  - @backstage/plugin-search-common@0.0.0-nightly-20240820021901
+  - @backstage/frontend-plugin-api@0.7.0
+  - @backstage/core-components@0.14.10
+  - @backstage/plugin-search-common@1.2.14
   - @backstage/core-plugin-api@1.9.3
   - @backstage/theme@0.5.6
   - @backstage/types@1.1.1

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-search-react__alpha",
-  "version": "0.0.0-nightly-20240820021901",
+  "version": "0.0.0-nightly-20240821021909",
   "main": "../dist/alpha.esm.js",
   "module": "../dist/alpha.esm.js",
   "types": "../dist/alpha.d.ts"

package/dist/alpha.d.ts

@@ -1,6 +1,5 @@
 /// <reference types="react" />
 import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api';
-import { PortableSchema } from '@backstage/frontend-plugin-api';
 import { ListItemProps } from '@material-ui/core/ListItem';
 import { SearchDocument, SearchResult } from '@backstage/plugin-search-common';
 
@@ -52,69 +51,4 @@ declare const SearchResultListItemBlueprint: _backstage_frontend_plugin_api.Exte
     }, "search.search-result-list-item.item", {}>;
 }>;
 
-/**
- * @alpha
- * @deprecated Use {@link SearchResultListItemBlueprint} instead
- */
-type SearchResultItemExtensionOptions<TConfig extends {
-    noTrack?: boolean;
-}> = {
-    /**
-     * The extension namespace.
-     */
-    namespace?: string;
-    /**
-     * The extension name.
-     */
-    name?: string;
-    /**
-     * The extension attachment point (e.g., search modal or page).
-     */
-    attachTo?: {
-        id: string;
-        input: string;
-    };
-    /**
-     * Optional extension config schema.
-     */
-    configSchema?: PortableSchema<TConfig>;
-    /**
-     * The extension component.
-     */
-    component: (options: {
-        config: TConfig;
-    }) => Promise<SearchResultItemExtensionComponent>;
-    /**
-     * When an extension defines a predicate, it returns true if the result should be rendered by that extension.
-     * Defaults to a predicate that returns true, which means it renders all sorts of results.
-     */
-    predicate?: SearchResultItemExtensionPredicate;
-};
-/**
- * Creates items for the search result list.
- *
- * @alpha
- * @deprecated Use {@link SearchResultListItemBlueprint} instead
- */
-declare function createSearchResultListItemExtension<TConfig extends {
-    noTrack?: boolean;
-}>(options: SearchResultItemExtensionOptions<TConfig>): _backstage_frontend_plugin_api.ExtensionDefinition<TConfig, TConfig, never, never, {
-    kind?: string | undefined;
-    namespace?: string | undefined;
-    name?: string | undefined;
-}>;
-/**
- * @alpha
- * @deprecated Use {@link SearchResultListItemBlueprint} instead
- */
-declare namespace createSearchResultListItemExtension {
-    /**
-     * @deprecated Use {@link SearchResultListItemBlueprint#dataRefs.item}  instead
-     */
-    const itemDataRef: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<{
-        predicate?: SearchResultItemExtensionPredicate | undefined;
-        component: SearchResultItemExtensionComponent;
-    }, "search.search-result-list-item.item", {}>;
-}
-
-export { type BaseSearchResultListItemProps, type SearchResultItemExtensionComponent, type SearchResultItemExtensionOptions, type SearchResultItemExtensionPredicate, SearchResultListItemBlueprint, type SearchResultListItemBlueprintParams, createSearchResultListItemExtension };
+export { type BaseSearchResultListItemProps, type SearchResultItemExtensionComponent, type SearchResultItemExtensionPredicate, SearchResultListItemBlueprint, type SearchResultListItemBlueprintParams };

package/dist/alpha.esm.js

@@ -1,3 +1,2 @@
-export { createSearchResultListItemExtension } from './alpha/extensions.esm.js';
 export { SearchResultListItemBlueprint } from './alpha/blueprints/SearchResultListItemBlueprint.esm.js';
 //# sourceMappingURL=alpha.esm.js.map

package/dist/alpha.esm.js.map

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-search-react",
-  "version": "0.0.0-nightly-20240820021901",
+  "version": "0.0.0-nightly-20240821021909",
   "backstage": {
     "role": "web-library",
     "pluginId": "search",
@@ -55,10 +55,10 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/core-components": "^0.0.0-nightly-20240820021901",
+    "@backstage/core-components": "^0.14.10",
     "@backstage/core-plugin-api": "^1.9.3",
-    "@backstage/frontend-plugin-api": "^0.0.0-nightly-20240820021901",
-    "@backstage/plugin-search-common": "^0.0.0-nightly-20240820021901",
+    "@backstage/frontend-plugin-api": "^0.0.0-nightly-20240821021909",
+    "@backstage/plugin-search-common": "^1.2.14",
     "@backstage/theme": "^0.5.6",
     "@backstage/types": "^1.1.1",
     "@backstage/version-bridge": "^1.0.8",
@@ -71,11 +71,11 @@
     "react-use": "^17.3.2"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.0.0-nightly-20240820021901",
-    "@backstage/core-app-api": "^0.0.0-nightly-20240820021901",
-    "@backstage/frontend-app-api": "^0.0.0-nightly-20240820021901",
-    "@backstage/frontend-test-utils": "^0.0.0-nightly-20240820021901",
-    "@backstage/test-utils": "^0.0.0-nightly-20240820021901",
+    "@backstage/cli": "^0.27.0",
+    "@backstage/core-app-api": "^1.14.2",
+    "@backstage/frontend-app-api": "^0.0.0-nightly-20240821021909",
+    "@backstage/frontend-test-utils": "^0.0.0-nightly-20240821021909",
+    "@backstage/test-utils": "^1.5.10",
     "@testing-library/dom": "^10.0.0",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^15.0.0",

package/dist/alpha/extensions.esm.js

@@ -1,50 +0,0 @@
-import React, { lazy } from 'react';
-import { createSchemaFromZod, createExtension, ExtensionBoundary } from '@backstage/frontend-plugin-api';
-import { SearchResultListItemExtension } from '../extensions.esm.js';
-import { searchResultListItemDataRef } from './blueprints/types.esm.js';
-
-function createSearchResultListItemExtension(options) {
-  const configSchema = "configSchema" in options ? options.configSchema : createSchemaFromZod(
-    (z) => z.object({
-      noTrack: z.boolean().default(false)
-    })
-  );
-  return createExtension({
-    kind: "search-result-list-item",
-    namespace: options.namespace,
-    name: options.name,
-    attachTo: options.attachTo ?? {
-      id: "page:search",
-      input: "items"
-    },
-    configSchema,
-    output: {
-      item: createSearchResultListItemExtension.itemDataRef
-    },
-    factory({ config, node }) {
-      const ExtensionComponent = lazy(
-        () => options.component({ config }).then((component) => ({ default: component }))
-      );
-      return {
-        item: {
-          predicate: options.predicate,
-          component: (props) => /* @__PURE__ */ React.createElement(ExtensionBoundary, { node }, /* @__PURE__ */ React.createElement(
-            SearchResultListItemExtension,
-            {
-              rank: props.rank,
-              result: props.result,
-              noTrack: config.noTrack
-            },
-            /* @__PURE__ */ React.createElement(ExtensionComponent, { ...props })
-          ))
-        }
-      };
-    }
-  });
-}
-((createSearchResultListItemExtension2) => {
-  createSearchResultListItemExtension2.itemDataRef = searchResultListItemDataRef;
-})(createSearchResultListItemExtension || (createSearchResultListItemExtension = {}));
-
-export { createSearchResultListItemExtension };
-//# sourceMappingURL=extensions.esm.js.map

package/dist/alpha/extensions.esm.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"extensions.esm.js","sources":["../../src/alpha/extensions.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, { lazy } from 'react';\nimport {\n  ExtensionBoundary,\n  PortableSchema,\n  createExtension,\n  createSchemaFromZod,\n} from '@backstage/frontend-plugin-api';\nimport {\n  SearchResultItemExtensionComponent,\n  SearchResultItemExtensionPredicate,\n} from './blueprints';\nimport { SearchResultListItemExtension } from '../extensions';\nimport { searchResultListItemDataRef } from './blueprints/types';\n\n/**\n * @alpha\n * @deprecated Use {@link SearchResultListItemBlueprint} instead\n */\nexport type SearchResultItemExtensionOptions<\n  TConfig extends { noTrack?: boolean },\n> = {\n  /**\n   * The extension namespace.\n   */\n  namespace?: string;\n  /**\n   * The extension name.\n   */\n  name?: string;\n  /**\n   * The extension attachment point (e.g., search modal or page).\n   */\n  attachTo?: { id: string; input: string };\n  /**\n   * Optional extension config schema.\n   */\n  configSchema?: PortableSchema<TConfig>;\n  /**\n   * The extension component.\n   */\n  component: (options: {\n    config: TConfig;\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 * Creates items for the search result list.\n *\n * @alpha\n * @deprecated Use {@link SearchResultListItemBlueprint} instead\n */\nexport function createSearchResultListItemExtension<\n  TConfig extends { noTrack?: boolean },\n>(options: SearchResultItemExtensionOptions<TConfig>) {\n  const configSchema =\n    'configSchema' in options\n      ? options.configSchema\n      : (createSchemaFromZod(z =>\n          z.object({\n            noTrack: z.boolean().default(false),\n          }),\n        ) as PortableSchema<TConfig>);\n\n  return createExtension({\n    kind: 'search-result-list-item',\n    namespace: options.namespace,\n    name: options.name,\n    attachTo: options.attachTo ?? {\n      id: 'page:search',\n      input: 'items',\n    },\n    configSchema,\n    output: {\n      item: createSearchResultListItemExtension.itemDataRef,\n    },\n    factory({ config, node }) {\n      const ExtensionComponent = lazy(() =>\n        options\n          .component({ config })\n          .then(component => ({ default: component })),\n      ) as unknown as SearchResultItemExtensionComponent;\n\n      return {\n        item: {\n          predicate: options.predicate,\n          component: props => (\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  });\n}\n\n/**\n * @alpha\n * @deprecated Use {@link SearchResultListItemBlueprint} instead\n */\nexport namespace createSearchResultListItemExtension {\n  /**\n   * @deprecated Use {@link SearchResultListItemBlueprint#dataRefs.item}  instead\n   */\n  export const itemDataRef = searchResultListItemDataRef;\n}\n"],"names":["createSearchResultListItemExtension"],"mappings":";;;;;AAwEO,SAAS,oCAEd,OAAoD,EAAA;AACpD,EAAA,MAAM,YACJ,GAAA,cAAA,IAAkB,OACd,GAAA,OAAA,CAAQ,YACP,GAAA,mBAAA;AAAA,IAAoB,CAAA,CAAA,KACnB,EAAE,MAAO,CAAA;AAAA,MACP,OAAS,EAAA,CAAA,CAAE,OAAQ,EAAA,CAAE,QAAQ,KAAK,CAAA;AAAA,KACnC,CAAA;AAAA,GACH,CAAA;AAEN,EAAA,OAAO,eAAgB,CAAA;AAAA,IACrB,IAAM,EAAA,yBAAA;AAAA,IACN,WAAW,OAAQ,CAAA,SAAA;AAAA,IACnB,MAAM,OAAQ,CAAA,IAAA;AAAA,IACd,QAAA,EAAU,QAAQ,QAAY,IAAA;AAAA,MAC5B,EAAI,EAAA,aAAA;AAAA,MACJ,KAAO,EAAA,OAAA;AAAA,KACT;AAAA,IACA,YAAA;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,MAAM,mCAAoC,CAAA,WAAA;AAAA,KAC5C;AAAA,IACA,OAAQ,CAAA,EAAE,MAAQ,EAAA,IAAA,EAAQ,EAAA;AACxB,MAAA,MAAM,kBAAqB,GAAA,IAAA;AAAA,QAAK,MAC9B,OAAA,CACG,SAAU,CAAA,EAAE,MAAO,EAAC,CACpB,CAAA,IAAA,CAAK,CAAc,SAAA,MAAA,EAAE,OAAS,EAAA,SAAA,EAAY,CAAA,CAAA;AAAA,OAC/C,CAAA;AAEA,MAAO,OAAA;AAAA,QACL,IAAM,EAAA;AAAA,UACJ,WAAW,OAAQ,CAAA,SAAA;AAAA,UACnB,SAAW,EAAA,CAAA,KAAA,qBACR,KAAA,CAAA,aAAA,CAAA,iBAAA,EAAA,EAAkB,IACjB,EAAA,kBAAA,KAAA,CAAA,aAAA;AAAA,YAAC,6BAAA;AAAA,YAAA;AAAA,cACC,MAAM,KAAM,CAAA,IAAA;AAAA,cACZ,QAAQ,KAAM,CAAA,MAAA;AAAA,cACd,SAAS,MAAO,CAAA,OAAA;AAAA,aAAA;AAAA,4BAEhB,KAAA,CAAA,aAAA,CAAC,kBAAoB,EAAA,EAAA,GAAG,KAAO,EAAA,CAAA;AAAA,WAEnC,CAAA;AAAA,SAEJ;AAAA,OACF,CAAA;AAAA,KACF;AAAA,GACD,CAAA,CAAA;AACH,CAAA;AAAA,CAMO,CAAUA,oCAAV,KAAA;AAIE,EAAMA,qCAAA,WAAc,GAAA,2BAAA,CAAA;AAAA,CAJZ,EAAA,mCAAA,KAAA,mCAAA,GAAA,EAAA,CAAA,CAAA;;;;"}