@backstage/plugin-catalog-react 1.19.1 → 1.19.2-next.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @backstage/plugin-catalog-react
 
+## 1.19.2-next.0
+
+### Patch Changes
+
+- 77eebdc: Support `filter` parameter on the `EntityHeaderBlueprint`
+- a3a878d: Adding `type` as an override to the `convertLegacyEntityCardExtension`
+- Updated dependencies
+  - @backstage/core-compat-api@0.4.5-next.0
+  - @backstage/integration-react@1.2.9
+  - @backstage/frontend-plugin-api@0.10.4
+  - @backstage/frontend-test-utils@0.3.5-next.0
+
 ## 1.19.1
 
 ### Patch Changes

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

@@ -1,14 +1,28 @@
 import { createExtensionBlueprint, coreExtensionData, ExtensionBoundary } from '@backstage/frontend-plugin-api';
+import { resolveEntityFilterData } from './resolveEntityFilterData.esm.js';
+import { createEntityPredicateSchema } from '../predicates/createEntityPredicateSchema.esm.js';
+import { entityFilterFunctionDataRef, entityFilterExpressionDataRef } from './extensionData.esm.js';
 
 const EntityHeaderBlueprint = createExtensionBlueprint({
   kind: "entity-header",
-  attachTo: { id: "page:catalog/entity", input: "header" },
+  attachTo: { id: "page:catalog/entity", input: "headers" },
   dataRefs: {
+    filterFunction: entityFilterFunctionDataRef,
     element: coreExtensionData.reactElement
   },
-  output: [coreExtensionData.reactElement.optional()],
-  *factory(params, { node }) {
-    const { loader } = params;
+  config: {
+    schema: {
+      filter: (z) => createEntityPredicateSchema(z).optional()
+    }
+  },
+  output: [
+    entityFilterFunctionDataRef.optional(),
+    entityFilterExpressionDataRef.optional(),
+    coreExtensionData.reactElement.optional()
+  ],
+  *factory(params, { node, config }) {
+    const { loader, filter } = params;
+    yield* resolveEntityFilterData(filter, config, node);
     if (loader) {
       yield coreExtensionData.reactElement(
         ExtensionBoundary.lazy(node, loader)

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

@@ -1 +1 @@
-{"version":3,"file":"EntityHeaderBlueprint.esm.js","sources":["../../../src/alpha/blueprints/EntityHeaderBlueprint.tsx"],"sourcesContent":["/*\n * Copyright 2025 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 {\n  createExtensionBlueprint,\n  coreExtensionData,\n  ExtensionBoundary,\n} from '@backstage/frontend-plugin-api';\n\n/** @alpha */\nexport const EntityHeaderBlueprint = createExtensionBlueprint({\n  kind: 'entity-header',\n  attachTo: { id: 'page:catalog/entity', input: 'header' },\n  dataRefs: {\n    element: coreExtensionData.reactElement,\n  },\n  output: [coreExtensionData.reactElement.optional()],\n  *factory(\n    params: {\n      loader: () => Promise<JSX.Element>;\n    },\n    { node },\n  ) {\n    const { loader } = params;\n    if (loader) {\n      yield coreExtensionData.reactElement(\n        ExtensionBoundary.lazy(node, loader),\n      );\n    }\n  },\n});\n"],"names":[],"mappings":";;AAuBO,MAAM,wBAAwB,wBAAyB,CAAA;AAAA,EAC5D,IAAM,EAAA,eAAA;AAAA,EACN,QAAU,EAAA,EAAE,EAAI,EAAA,qBAAA,EAAuB,OAAO,QAAS,EAAA;AAAA,EACvD,QAAU,EAAA;AAAA,IACR,SAAS,iBAAkB,CAAA;AAAA,GAC7B;AAAA,EACA,MAAQ,EAAA,CAAC,iBAAkB,CAAA,YAAA,CAAa,UAAU,CAAA;AAAA,EAClD,CAAC,OAAA,CACC,MAGA,EAAA,EAAE,MACF,EAAA;AACA,IAAM,MAAA,EAAE,QAAW,GAAA,MAAA;AACnB,IAAA,IAAI,MAAQ,EAAA;AACV,MAAA,MAAM,iBAAkB,CAAA,YAAA;AAAA,QACtB,iBAAA,CAAkB,IAAK,CAAA,IAAA,EAAM,MAAM;AAAA,OACrC;AAAA;AACF;AAEJ,CAAC;;;;"}
+{"version":3,"file":"EntityHeaderBlueprint.esm.js","sources":["../../../src/alpha/blueprints/EntityHeaderBlueprint.tsx"],"sourcesContent":["/*\n * Copyright 2025 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 {\n  createExtensionBlueprint,\n  coreExtensionData,\n  ExtensionBoundary,\n} from '@backstage/frontend-plugin-api';\nimport { EntityPredicate } from '../predicates/types';\nimport { Entity } from '@backstage/catalog-model';\nimport { resolveEntityFilterData } from './resolveEntityFilterData';\nimport { createEntityPredicateSchema } from '../predicates/createEntityPredicateSchema';\nimport {\n  entityFilterExpressionDataRef,\n  entityFilterFunctionDataRef,\n} from './extensionData';\n\n/** @alpha */\nexport const EntityHeaderBlueprint = createExtensionBlueprint({\n  kind: 'entity-header',\n  attachTo: { id: 'page:catalog/entity', input: 'headers' },\n  dataRefs: {\n    filterFunction: entityFilterFunctionDataRef,\n    element: coreExtensionData.reactElement,\n  },\n  config: {\n    schema: {\n      filter: z => createEntityPredicateSchema(z).optional(),\n    },\n  },\n  output: [\n    entityFilterFunctionDataRef.optional(),\n    entityFilterExpressionDataRef.optional(),\n    coreExtensionData.reactElement.optional(),\n  ],\n  *factory(\n    params: {\n      loader: () => Promise<JSX.Element>;\n      filter?: EntityPredicate | ((entity: Entity) => boolean);\n    },\n    { node, config },\n  ) {\n    const { loader, filter } = params;\n\n    yield* resolveEntityFilterData(filter, config, node);\n\n    if (loader) {\n      yield coreExtensionData.reactElement(\n        ExtensionBoundary.lazy(node, loader),\n      );\n    }\n  },\n});\n"],"names":[],"mappings":";;;;;AA+BO,MAAM,wBAAwB,wBAAyB,CAAA;AAAA,EAC5D,IAAM,EAAA,eAAA;AAAA,EACN,QAAU,EAAA,EAAE,EAAI,EAAA,qBAAA,EAAuB,OAAO,SAAU,EAAA;AAAA,EACxD,QAAU,EAAA;AAAA,IACR,cAAgB,EAAA,2BAAA;AAAA,IAChB,SAAS,iBAAkB,CAAA;AAAA,GAC7B;AAAA,EACA,MAAQ,EAAA;AAAA,IACN,MAAQ,EAAA;AAAA,MACN,MAAQ,EAAA,CAAA,CAAA,KAAK,2BAA4B,CAAA,CAAC,EAAE,QAAS;AAAA;AACvD,GACF;AAAA,EACA,MAAQ,EAAA;AAAA,IACN,4BAA4B,QAAS,EAAA;AAAA,IACrC,8BAA8B,QAAS,EAAA;AAAA,IACvC,iBAAA,CAAkB,aAAa,QAAS;AAAA,GAC1C;AAAA,EACA,CAAC,OACC,CAAA,MAAA,EAIA,EAAE,IAAA,EAAM,QACR,EAAA;AACA,IAAM,MAAA,EAAE,MAAQ,EAAA,MAAA,EAAW,GAAA,MAAA;AAE3B,IAAO,OAAA,uBAAA,CAAwB,MAAQ,EAAA,MAAA,EAAQ,IAAI,CAAA;AAEnD,IAAA,IAAI,MAAQ,EAAA;AACV,MAAA,MAAM,iBAAkB,CAAA,YAAA;AAAA,QACtB,iBAAA,CAAkB,IAAK,CAAA,IAAA,EAAM,MAAM;AAAA,OACrC;AAAA;AACF;AAEJ,CAAC;;;;"}

package/dist/alpha/converters/convertLegacyEntityCardExtension.esm.js

@@ -26,7 +26,8 @@ function convertLegacyEntityCardExtension(LegacyExtension, overrides) {
     name: overrides?.name ?? name,
     params: {
       filter: overrides?.filter,
-      loader: async () => compatWrapper(element)
+      loader: async () => compatWrapper(element),
+      type: overrides?.type
     }
   });
 }

package/dist/alpha/converters/convertLegacyEntityCardExtension.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"convertLegacyEntityCardExtension.esm.js","sources":["../../../src/alpha/converters/convertLegacyEntityCardExtension.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 { compatWrapper } from '@backstage/core-compat-api';\nimport { BackstagePlugin, getComponentData } from '@backstage/core-plugin-api';\nimport { ExtensionDefinition } from '@backstage/frontend-plugin-api';\nimport { ComponentType } from 'react';\nimport { EntityCardBlueprint } from '../blueprints/EntityCardBlueprint';\nimport kebabCase from 'lodash/kebabCase';\nimport { EntityPredicate } from '../predicates/types';\nimport { Entity } from '@backstage/catalog-model';\n\n/** @alpha */\nexport function convertLegacyEntityCardExtension(\n  LegacyExtension: ComponentType<{}>,\n  overrides?: {\n    name?: string;\n    filter?: string | EntityPredicate | ((entity: Entity) => boolean);\n  },\n): ExtensionDefinition {\n  const element = <LegacyExtension />;\n\n  const extName = getComponentData<string>(element, 'core.extensionName');\n  if (!extName) {\n    throw new Error('Extension has no name');\n  }\n\n  const plugin = getComponentData<BackstagePlugin>(element, 'core.plugin');\n  const pluginId = plugin?.getId();\n\n  const match = extName.match(/^Entity(.*)Card$/);\n  const infix = match?.[1] ?? extName;\n\n  let name: string | undefined = infix;\n  if (\n    pluginId &&\n    name\n      .toLocaleLowerCase('en-US')\n      .startsWith(pluginId.toLocaleLowerCase('en-US'))\n  ) {\n    name = name.slice(pluginId.length);\n    if (!name) {\n      name = undefined;\n    }\n  }\n  name = name && kebabCase(name);\n\n  return EntityCardBlueprint.make({\n    name: overrides?.name ?? name,\n    params: {\n      filter: overrides?.filter,\n      loader: async () => compatWrapper(element),\n    },\n  });\n}\n"],"names":[],"mappings":";;;;;;AA0BgB,SAAA,gCAAA,CACd,iBACA,SAIqB,EAAA;AACrB,EAAM,MAAA,OAAA,uBAAW,eAAgB,EAAA,EAAA,CAAA;AAEjC,EAAM,MAAA,OAAA,GAAU,gBAAyB,CAAA,OAAA,EAAS,oBAAoB,CAAA;AACtE,EAAA,IAAI,CAAC,OAAS,EAAA;AACZ,IAAM,MAAA,IAAI,MAAM,uBAAuB,CAAA;AAAA;AAGzC,EAAM,MAAA,MAAA,GAAS,gBAAkC,CAAA,OAAA,EAAS,aAAa,CAAA;AACvE,EAAM,MAAA,QAAA,GAAW,QAAQ,KAAM,EAAA;AAE/B,EAAM,MAAA,KAAA,GAAQ,OAAQ,CAAA,KAAA,CAAM,kBAAkB,CAAA;AAC9C,EAAM,MAAA,KAAA,GAAQ,KAAQ,GAAA,CAAC,CAAK,IAAA,OAAA;AAE5B,EAAA,IAAI,IAA2B,GAAA,KAAA;AAC/B,EACE,IAAA,QAAA,IACA,IACG,CAAA,iBAAA,CAAkB,OAAO,CAAA,CACzB,WAAW,QAAS,CAAA,iBAAA,CAAkB,OAAO,CAAC,CACjD,EAAA;AACA,IAAO,IAAA,GAAA,IAAA,CAAK,KAAM,CAAA,QAAA,CAAS,MAAM,CAAA;AACjC,IAAA,IAAI,CAAC,IAAM,EAAA;AACT,MAAO,IAAA,GAAA,KAAA,CAAA;AAAA;AACT;AAEF,EAAO,IAAA,GAAA,IAAA,IAAQ,UAAU,IAAI,CAAA;AAE7B,EAAA,OAAO,oBAAoB,IAAK,CAAA;AAAA,IAC9B,IAAA,EAAM,WAAW,IAAQ,IAAA,IAAA;AAAA,IACzB,MAAQ,EAAA;AAAA,MACN,QAAQ,SAAW,EAAA,MAAA;AAAA,MACnB,MAAA,EAAQ,YAAY,aAAA,CAAc,OAAO;AAAA;AAC3C,GACD,CAAA;AACH;;;;"}
+{"version":3,"file":"convertLegacyEntityCardExtension.esm.js","sources":["../../../src/alpha/converters/convertLegacyEntityCardExtension.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 { compatWrapper } from '@backstage/core-compat-api';\nimport { BackstagePlugin, getComponentData } from '@backstage/core-plugin-api';\nimport { ExtensionDefinition } from '@backstage/frontend-plugin-api';\nimport { ComponentType } from 'react';\nimport { EntityCardBlueprint } from '../blueprints/EntityCardBlueprint';\nimport kebabCase from 'lodash/kebabCase';\nimport { EntityPredicate } from '../predicates/types';\nimport { Entity } from '@backstage/catalog-model';\nimport { EntityCardType } from '../blueprints/extensionData';\n\n/** @alpha */\nexport function convertLegacyEntityCardExtension(\n  LegacyExtension: ComponentType<{}>,\n  overrides?: {\n    name?: string;\n    filter?: string | EntityPredicate | ((entity: Entity) => boolean);\n    type?: EntityCardType;\n  },\n): ExtensionDefinition {\n  const element = <LegacyExtension />;\n\n  const extName = getComponentData<string>(element, 'core.extensionName');\n  if (!extName) {\n    throw new Error('Extension has no name');\n  }\n\n  const plugin = getComponentData<BackstagePlugin>(element, 'core.plugin');\n  const pluginId = plugin?.getId();\n\n  const match = extName.match(/^Entity(.*)Card$/);\n  const infix = match?.[1] ?? extName;\n\n  let name: string | undefined = infix;\n  if (\n    pluginId &&\n    name\n      .toLocaleLowerCase('en-US')\n      .startsWith(pluginId.toLocaleLowerCase('en-US'))\n  ) {\n    name = name.slice(pluginId.length);\n    if (!name) {\n      name = undefined;\n    }\n  }\n  name = name && kebabCase(name);\n\n  return EntityCardBlueprint.make({\n    name: overrides?.name ?? name,\n    params: {\n      filter: overrides?.filter,\n      loader: async () => compatWrapper(element),\n      type: overrides?.type,\n    },\n  });\n}\n"],"names":[],"mappings":";;;;;;AA2BgB,SAAA,gCAAA,CACd,iBACA,SAKqB,EAAA;AACrB,EAAM,MAAA,OAAA,uBAAW,eAAgB,EAAA,EAAA,CAAA;AAEjC,EAAM,MAAA,OAAA,GAAU,gBAAyB,CAAA,OAAA,EAAS,oBAAoB,CAAA;AACtE,EAAA,IAAI,CAAC,OAAS,EAAA;AACZ,IAAM,MAAA,IAAI,MAAM,uBAAuB,CAAA;AAAA;AAGzC,EAAM,MAAA,MAAA,GAAS,gBAAkC,CAAA,OAAA,EAAS,aAAa,CAAA;AACvE,EAAM,MAAA,QAAA,GAAW,QAAQ,KAAM,EAAA;AAE/B,EAAM,MAAA,KAAA,GAAQ,OAAQ,CAAA,KAAA,CAAM,kBAAkB,CAAA;AAC9C,EAAM,MAAA,KAAA,GAAQ,KAAQ,GAAA,CAAC,CAAK,IAAA,OAAA;AAE5B,EAAA,IAAI,IAA2B,GAAA,KAAA;AAC/B,EACE,IAAA,QAAA,IACA,IACG,CAAA,iBAAA,CAAkB,OAAO,CAAA,CACzB,WAAW,QAAS,CAAA,iBAAA,CAAkB,OAAO,CAAC,CACjD,EAAA;AACA,IAAO,IAAA,GAAA,IAAA,CAAK,KAAM,CAAA,QAAA,CAAS,MAAM,CAAA;AACjC,IAAA,IAAI,CAAC,IAAM,EAAA;AACT,MAAO,IAAA,GAAA,KAAA,CAAA;AAAA;AACT;AAEF,EAAO,IAAA,GAAA,IAAA,IAAQ,UAAU,IAAI,CAAA;AAE7B,EAAA,OAAO,oBAAoB,IAAK,CAAA;AAAA,IAC9B,IAAA,EAAM,WAAW,IAAQ,IAAA,IAAA;AAAA,IACzB,MAAQ,EAAA;AAAA,MACN,QAAQ,SAAW,EAAA,MAAA;AAAA,MACnB,MAAA,EAAQ,YAAY,aAAA,CAAc,OAAO,CAAA;AAAA,MACzC,MAAM,SAAW,EAAA;AAAA;AACnB,GACD,CAAA;AACH;;;;"}

package/dist/alpha.d.ts

@@ -204,14 +204,24 @@ declare const EntityHeaderBlueprint: _backstage_frontend_plugin_api.ExtensionBlu
     name: undefined;
     params: {
         loader: () => Promise<JSX.Element>;
+        filter?: EntityPredicate | ((entity: Entity) => boolean);
     };
-    output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<react.JSX.Element, "core.reactElement", {
+    output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<(entity: Entity) => boolean, "catalog.entity-filter-function", {
+        optional: true;
+    }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
+        optional: true;
+    }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<react.JSX.Element, "core.reactElement", {
         optional: true;
     }>;
     inputs: {};
-    config: {};
-    configInput: {};
+    config: {
+        filter: EntityPredicate | undefined;
+    };
+    configInput: {
+        filter?: EntityPredicate | undefined;
+    };
     dataRefs: {
+        filterFunction: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<(entity: Entity) => boolean, "catalog.entity-filter-function", {}>;
         element: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<react.JSX.Element, "core.reactElement", {}>;
     };
 }>;
@@ -287,6 +297,7 @@ declare const EntityIconLinkBlueprint: _backstage_frontend_plugin_api.ExtensionB
 declare function convertLegacyEntityCardExtension(LegacyExtension: ComponentType<{}>, overrides?: {
     name?: string;
     filter?: string | EntityPredicate | ((entity: Entity) => boolean);
+    type?: EntityCardType;
 }): ExtensionDefinition;
 
 /** @alpha */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-react",
-  "version": "1.19.1",
+  "version": "1.19.2-next.0",
   "description": "A frontend library that helps other Backstage plugins interact with the catalog",
   "backstage": {
     "role": "web-library",
@@ -73,20 +73,20 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/catalog-client": "^1.10.2",
-    "@backstage/catalog-model": "^1.7.5",
-    "@backstage/core-compat-api": "^0.4.4",
-    "@backstage/core-components": "^0.17.4",
-    "@backstage/core-plugin-api": "^1.10.9",
-    "@backstage/errors": "^1.2.7",
-    "@backstage/frontend-plugin-api": "^0.10.4",
-    "@backstage/frontend-test-utils": "^0.3.4",
-    "@backstage/integration-react": "^1.2.9",
-    "@backstage/plugin-catalog-common": "^1.1.5",
-    "@backstage/plugin-permission-common": "^0.9.1",
-    "@backstage/plugin-permission-react": "^0.4.36",
-    "@backstage/types": "^1.2.1",
-    "@backstage/version-bridge": "^1.0.11",
+    "@backstage/catalog-client": "1.10.2",
+    "@backstage/catalog-model": "1.7.5",
+    "@backstage/core-compat-api": "0.4.5-next.0",
+    "@backstage/core-components": "0.17.4",
+    "@backstage/core-plugin-api": "1.10.9",
+    "@backstage/errors": "1.2.7",
+    "@backstage/frontend-plugin-api": "0.10.4",
+    "@backstage/frontend-test-utils": "0.3.5-next.0",
+    "@backstage/integration-react": "1.2.9",
+    "@backstage/plugin-catalog-common": "1.1.5",
+    "@backstage/plugin-permission-common": "0.9.1",
+    "@backstage/plugin-permission-react": "0.4.36",
+    "@backstage/types": "1.2.1",
+    "@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",
@@ -100,11 +100,11 @@
     "zen-observable": "^0.10.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.33.1",
-    "@backstage/core-app-api": "^1.18.0",
-    "@backstage/plugin-catalog-common": "^1.1.5",
-    "@backstage/plugin-scaffolder-common": "^1.6.0",
-    "@backstage/test-utils": "^1.7.10",
+    "@backstage/cli": "0.33.1",
+    "@backstage/core-app-api": "1.18.0",
+    "@backstage/plugin-catalog-common": "1.1.5",
+    "@backstage/plugin-scaffolder-common": "1.6.0",
+    "@backstage/test-utils": "1.7.10",
     "@testing-library/dom": "^10.0.0",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^16.0.0",