@backstage/plugin-catalog-react 1.8.5 → 1.9.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,49 @@
 # @backstage/plugin-catalog-react
 
+## 1.9.0-next.0
+
+### Minor Changes
+
+- 1e5b7d993a: Added an `EntityPresentationApi` and associated `entityPresentationApiRef`. This
+  API lets you control how references to entities (e.g. in links, headings,
+  iconography etc) are represented in the user interface.
+
+  Usage of this API is initially added to the `EntityRefLink` and `EntityRefLinks`
+  components, so that they can render richer, more correct representation of
+  entity refs. There's also a new `EntityDisplayName` component, which works just like
+  the `EntityRefLink` but without the link.
+
+  Along with that change, the `fetchEntities` and `getTitle` props of
+  `EntityRefLinksProps` are deprecated and no longer used, since the same need
+  instead is fulfilled (and by default always enabled) by the
+  `entityPresentationApiRef`.
+
+- 1fd53fa0c6: The `UserListPicker` component has undergone improvements to enhance its performance.
+
+  The previous implementation inferred the number of owned and starred entities based on the entities available in the `EntityListContext`. The updated version no longer relies on the `EntityListContext` for inference, allowing for better decoupling.
+
+  The component now loads the entities' count asynchronously, resulting in improved performance and responsiveness. For this purpose, some of the exported filters such as `EntityTagFilter`, `EntityOwnerFilter`, `EntityLifecycleFilter` and `EntityNamespaceFilter` have now the `getCatalogFilters` method implemented.
+
+### Patch Changes
+
+- 6c2b872153: Add official support for React 18.
+- 0bf6ebda88: Added new APIs at the `/alpha` subpath for creating entity page cards and content for the new frontend system.
+- 71c97e7d73: The `spec.type` field in entities will now always be rendered as a string.
+- Updated dependencies
+  - @backstage/core-components@0.13.7-next.0
+  - @backstage/frontend-plugin-api@0.3.0-next.0
+  - @backstage/core-plugin-api@1.8.0-next.0
+  - @backstage/plugin-permission-react@0.4.17-next.0
+  - @backstage/version-bridge@1.0.7-next.0
+  - @backstage/theme@0.4.4-next.0
+  - @backstage/integration@1.7.1
+  - @backstage/catalog-client@1.4.5
+  - @backstage/catalog-model@1.4.3
+  - @backstage/errors@1.2.3
+  - @backstage/types@1.1.1
+  - @backstage/plugin-catalog-common@1.0.17
+  - @backstage/plugin-permission-common@0.7.9
+
 ## 1.8.5
 
 ### Patch Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-react",
-  "version": "1.8.5",
+  "version": "1.9.0-next.0",
   "main": "../dist/alpha.esm.js",
   "module": "../dist/alpha.esm.js",
   "types": "../dist/alpha.d.ts"

package/dist/alpha.d.ts

@@ -1,3 +1,6 @@
+/// <reference types="react" />
+import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api';
+import { AnyExtensionInputMap, ExtensionInputValues, RouteRef } from '@backstage/frontend-plugin-api';
 import { Entity } from '@backstage/catalog-model';
 import { ResourcePermission } from '@backstage/plugin-permission-common';
 
@@ -12,6 +15,14 @@ import { ResourcePermission } from '@backstage/plugin-permission-common';
  */
 declare function isOwnerOf(owner: Entity, entity: Entity): boolean;
 
+/**
+ * Utility type to expand type aliases into their equivalent type.
+ * @ignore
+ */
+type Expand<T> = T extends infer O ? {
+    [K in keyof O]: O[K];
+} : never;
+
 /**
  * A thin wrapper around the
  * {@link @backstage/plugin-permission-react#usePermission} hook which uses the
@@ -29,4 +40,58 @@ declare function useEntityPermission(permission: ResourcePermission<'catalog-ent
     error?: Error;
 };
 
-export { isOwnerOf, useEntityPermission };
+/** @alpha */
+declare const entityContentTitleExtensionDataRef: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, {}>;
+/** @alpha */
+declare const entityFilterExtensionDataRef: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<(ctx: {
+    entity: Entity;
+}) => boolean, {}>;
+/** @alpha */
+declare function createEntityCardExtension<TInputs extends AnyExtensionInputMap>(options: {
+    id: string;
+    attachTo?: {
+        id: string;
+        input: string;
+    };
+    disabled?: boolean;
+    inputs?: TInputs;
+    filter?: (ctx: {
+        entity: Entity;
+    }) => boolean;
+    loader: (options: {
+        inputs: Expand<ExtensionInputValues<TInputs>>;
+    }) => Promise<JSX.Element>;
+}): _backstage_frontend_plugin_api.Extension<{
+    filter?: {
+        isKind?: string | undefined;
+        isType?: string | undefined;
+    }[] | undefined;
+}>;
+/** @alpha */
+declare function createEntityContentExtension<TInputs extends AnyExtensionInputMap>(options: {
+    id: string;
+    attachTo?: {
+        id: string;
+        input: string;
+    };
+    disabled?: boolean;
+    inputs?: TInputs;
+    routeRef?: RouteRef;
+    defaultPath: string;
+    defaultTitle: string;
+    filter?: (ctx: {
+        entity: Entity;
+    }) => boolean;
+    loader: (options: {
+        inputs: Expand<ExtensionInputValues<TInputs>>;
+    }) => Promise<JSX.Element>;
+}): _backstage_frontend_plugin_api.Extension<{
+    title: string;
+    path: string;
+    filter?: {
+        isKind?: string | undefined;
+        isType?: string | undefined;
+    }[] | undefined;
+}>;
+
+export { createEntityCardExtension, createEntityContentExtension, entityContentTitleExtensionDataRef, entityFilterExtensionDataRef, isOwnerOf, useEntityPermission };

package/dist/alpha.esm.js

@@ -1,9 +1,10 @@
+import React, { lazy } from 'react';
+import { createExtensionDataRef, createExtension, coreExtensionData, createSchemaFromZod, ExtensionBoundary } from '@backstage/frontend-plugin-api';
 import { RELATION_MEMBER_OF, getCompoundEntityRef, stringifyEntityRef, RELATION_OWNED_BY } from '@backstage/catalog-model';
 import { g as getEntityRelations, a as useAsyncEntity } from './esm/useEntity-de64059a.esm.js';
 import { usePermission } from '@backstage/plugin-permission-react';
 import '@backstage/core-plugin-api';
 import '@backstage/version-bridge';
-import 'react';
 
 function isOwnerOf(owner, entity) {
   const possibleOwners = new Set(
@@ -46,5 +47,115 @@ function useEntityPermission(permission) {
   return { loading: false, allowed, error: permissionError };
 }
 
-export { isOwnerOf, useEntityPermission };
+const entityContentTitleExtensionDataRef = createExtensionDataRef("plugin.catalog.entity.content.title");
+const entityFilterExtensionDataRef = createExtensionDataRef("plugin.catalog.entity.filter");
+function applyFilter(a, b) {
+  if (!a) {
+    return true;
+  }
+  return a.toLocaleLowerCase("en-US") === (b == null ? void 0 : b.toLocaleLowerCase("en-US"));
+}
+function buildFilter(config, filterFunc) {
+  return (ctx) => {
+    var _a;
+    const configuredFilterMatch = (_a = config.filter) == null ? void 0 : _a.some((filter) => {
+      var _a2, _b;
+      const kindMatch = applyFilter(filter.isKind, ctx.entity.kind);
+      const typeMatch = applyFilter(
+        filter.isType,
+        (_b = (_a2 = ctx.entity.spec) == null ? void 0 : _a2.type) == null ? void 0 : _b.toString()
+      );
+      return kindMatch && typeMatch;
+    });
+    if (configuredFilterMatch) {
+      return true;
+    }
+    if (filterFunc) {
+      return filterFunc(ctx);
+    }
+    return true;
+  };
+}
+function createEntityCardExtension(options) {
+  var _a, _b;
+  const id = `entity.cards.${options.id}`;
+  return createExtension({
+    id,
+    attachTo: (_a = options.attachTo) != null ? _a : {
+      id: "entity.content.overview",
+      input: "cards"
+    },
+    disabled: (_b = options.disabled) != null ? _b : true,
+    output: {
+      element: coreExtensionData.reactElement,
+      filter: entityFilterExtensionDataRef
+    },
+    inputs: options.inputs,
+    configSchema: createSchemaFromZod(
+      (z) => z.object({
+        filter: z.array(
+          z.object({
+            isKind: z.string().optional(),
+            isType: z.string().optional()
+          })
+        ).optional()
+      })
+    ),
+    factory({ bind, config, inputs, source }) {
+      const ExtensionComponent = lazy(
+        () => options.loader({ inputs }).then((element) => ({ default: () => element }))
+      );
+      bind({
+        element: /* @__PURE__ */ React.createElement(ExtensionBoundary, { id, source }, /* @__PURE__ */ React.createElement(ExtensionComponent, null)),
+        filter: buildFilter(config, options.filter)
+      });
+    }
+  });
+}
+function createEntityContentExtension(options) {
+  var _a, _b;
+  const id = `entity.content.${options.id}`;
+  return createExtension({
+    id,
+    attachTo: (_a = options.attachTo) != null ? _a : {
+      id: "plugin.catalog.page.entity",
+      input: "contents"
+    },
+    disabled: (_b = options.disabled) != null ? _b : true,
+    output: {
+      element: coreExtensionData.reactElement,
+      path: coreExtensionData.routePath,
+      routeRef: coreExtensionData.routeRef.optional(),
+      title: entityContentTitleExtensionDataRef,
+      filter: entityFilterExtensionDataRef
+    },
+    inputs: options.inputs,
+    configSchema: createSchemaFromZod(
+      (z) => z.object({
+        path: z.string().default(options.defaultPath),
+        title: z.string().default(options.defaultTitle),
+        filter: z.array(
+          z.object({
+            isKind: z.string().optional(),
+            isType: z.string().optional()
+          })
+        ).optional()
+      })
+    ),
+    factory({ bind, config, inputs, source }) {
+      const ExtensionComponent = lazy(
+        () => options.loader({ inputs }).then((element) => ({ default: () => element }))
+      );
+      bind({
+        path: config.path,
+        title: config.title,
+        routeRef: options.routeRef,
+        element: /* @__PURE__ */ React.createElement(ExtensionBoundary, { id, source, routable: true }, /* @__PURE__ */ React.createElement(ExtensionComponent, null)),
+        filter: buildFilter(config, options.filter)
+      });
+    }
+  });
+}
+
+export { createEntityCardExtension, createEntityContentExtension, entityContentTitleExtensionDataRef, entityFilterExtensionDataRef, isOwnerOf, useEntityPermission };
 //# sourceMappingURL=alpha.esm.js.map

package/dist/alpha.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"alpha.esm.js","sources":["../src/utils/isOwnerOf.ts","../src/hooks/useEntityPermission.ts"],"sourcesContent":["/*\n * Copyright 2020 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  Entity,\n  getCompoundEntityRef,\n  RELATION_MEMBER_OF,\n  RELATION_OWNED_BY,\n  stringifyEntityRef,\n} from '@backstage/catalog-model';\nimport { getEntityRelations } from './getEntityRelations';\n\n/**\n * Returns true if the `owner` argument is a direct owner on the `entity` argument.\n *\n * @alpha\n * @remarks\n *\n * Note that this ownership is not the same as using the claims in the auth-resolver, it only will take into account ownership as expressed by direct entity relations.\n * It doesn't know anything about the additional groups that a user might belong to which the claims contain.\n */\nexport function isOwnerOf(owner: Entity, entity: Entity) {\n  const possibleOwners = new Set(\n    [\n      ...getEntityRelations(owner, RELATION_MEMBER_OF, { kind: 'group' }),\n      ...(owner ? [getCompoundEntityRef(owner)] : []),\n    ].map(stringifyEntityRef),\n  );\n\n  const owners = getEntityRelations(entity, RELATION_OWNED_BY).map(\n    stringifyEntityRef,\n  );\n\n  for (const ownerItem of owners) {\n    if (possibleOwners.has(ownerItem)) {\n      return true;\n    }\n  }\n\n  return false;\n}\n","/*\n * Copyright 2022 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 { stringifyEntityRef } from '@backstage/catalog-model';\nimport { ResourcePermission } from '@backstage/plugin-permission-common';\nimport { usePermission } from '@backstage/plugin-permission-react';\nimport { useAsyncEntity } from './useEntity';\n\n/**\n * A thin wrapper around the\n * {@link @backstage/plugin-permission-react#usePermission} hook which uses the\n * current entity in context to make an authorization request for the given\n * {@link @backstage/plugin-catalog-common#CatalogEntityPermission}.\n *\n * Note: this hook blocks the permission request until the entity has loaded in\n * context. If you have the entityRef and need concurrent requests, use the\n * `usePermission` hook directly.\n * @alpha\n */\nexport function useEntityPermission(\n  // TODO(joeporpeglia) Replace with `CatalogEntityPermission` when the issue described in\n  // https://github.com/backstage/backstage/pull/10128 is fixed.\n  permission: ResourcePermission<'catalog-entity'>,\n): {\n  loading: boolean;\n  allowed: boolean;\n  error?: Error;\n} {\n  const {\n    entity,\n    loading: loadingEntity,\n    error: entityError,\n  } = useAsyncEntity();\n  const {\n    allowed,\n    loading: loadingPermission,\n    error: permissionError,\n  } = usePermission({\n    permission,\n    resourceRef: entity ? stringifyEntityRef(entity) : undefined,\n  });\n\n  if (loadingEntity || loadingPermission) {\n    return { loading: true, allowed: false };\n  }\n  if (entityError) {\n    return { loading: false, allowed: false, error: entityError };\n  }\n  return { loading: false, allowed, error: permissionError };\n}\n"],"names":[],"mappings":";;;;;;;AAkCgB,SAAA,SAAA,CAAU,OAAe,MAAgB,EAAA;AACvD,EAAA,MAAM,iBAAiB,IAAI,GAAA;AAAA,IACzB;AAAA,MACE,GAAG,kBAAmB,CAAA,KAAA,EAAO,oBAAoB,EAAE,IAAA,EAAM,SAAS,CAAA;AAAA,MAClE,GAAI,KAAQ,GAAA,CAAC,qBAAqB,KAAK,CAAC,IAAI,EAAC;AAAA,KAC/C,CAAE,IAAI,kBAAkB,CAAA;AAAA,GAC1B,CAAA;AAEA,EAAA,MAAM,MAAS,GAAA,kBAAA,CAAmB,MAAQ,EAAA,iBAAiB,CAAE,CAAA,GAAA;AAAA,IAC3D,kBAAA;AAAA,GACF,CAAA;AAEA,EAAA,KAAA,MAAW,aAAa,MAAQ,EAAA;AAC9B,IAAI,IAAA,cAAA,CAAe,GAAI,CAAA,SAAS,CAAG,EAAA;AACjC,MAAO,OAAA,IAAA,CAAA;AAAA,KACT;AAAA,GACF;AAEA,EAAO,OAAA,KAAA,CAAA;AACT;;ACrBO,SAAS,oBAGd,UAKA,EAAA;AACA,EAAM,MAAA;AAAA,IACJ,MAAA;AAAA,IACA,OAAS,EAAA,aAAA;AAAA,IACT,KAAO,EAAA,WAAA;AAAA,MACL,cAAe,EAAA,CAAA;AACnB,EAAM,MAAA;AAAA,IACJ,OAAA;AAAA,IACA,OAAS,EAAA,iBAAA;AAAA,IACT,KAAO,EAAA,eAAA;AAAA,MACL,aAAc,CAAA;AAAA,IAChB,UAAA;AAAA,IACA,WAAa,EAAA,MAAA,GAAS,kBAAmB,CAAA,MAAM,CAAI,GAAA,KAAA,CAAA;AAAA,GACpD,CAAA,CAAA;AAED,EAAA,IAAI,iBAAiB,iBAAmB,EAAA;AACtC,IAAA,OAAO,EAAE,OAAA,EAAS,IAAM,EAAA,OAAA,EAAS,KAAM,EAAA,CAAA;AAAA,GACzC;AACA,EAAA,IAAI,WAAa,EAAA;AACf,IAAA,OAAO,EAAE,OAAS,EAAA,KAAA,EAAO,OAAS,EAAA,KAAA,EAAO,OAAO,WAAY,EAAA,CAAA;AAAA,GAC9D;AACA,EAAA,OAAO,EAAE,OAAA,EAAS,KAAO,EAAA,OAAA,EAAS,OAAO,eAAgB,EAAA,CAAA;AAC3D;;;;"}
+{"version":3,"file":"alpha.esm.js","sources":["../src/utils/isOwnerOf.ts","../src/hooks/useEntityPermission.ts","../src/alpha.tsx"],"sourcesContent":["/*\n * Copyright 2020 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  Entity,\n  getCompoundEntityRef,\n  RELATION_MEMBER_OF,\n  RELATION_OWNED_BY,\n  stringifyEntityRef,\n} from '@backstage/catalog-model';\nimport { getEntityRelations } from './getEntityRelations';\n\n/**\n * Returns true if the `owner` argument is a direct owner on the `entity` argument.\n *\n * @alpha\n * @remarks\n *\n * Note that this ownership is not the same as using the claims in the auth-resolver, it only will take into account ownership as expressed by direct entity relations.\n * It doesn't know anything about the additional groups that a user might belong to which the claims contain.\n */\nexport function isOwnerOf(owner: Entity, entity: Entity) {\n  const possibleOwners = new Set(\n    [\n      ...getEntityRelations(owner, RELATION_MEMBER_OF, { kind: 'group' }),\n      ...(owner ? [getCompoundEntityRef(owner)] : []),\n    ].map(stringifyEntityRef),\n  );\n\n  const owners = getEntityRelations(entity, RELATION_OWNED_BY).map(\n    stringifyEntityRef,\n  );\n\n  for (const ownerItem of owners) {\n    if (possibleOwners.has(ownerItem)) {\n      return true;\n    }\n  }\n\n  return false;\n}\n","/*\n * Copyright 2022 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 { stringifyEntityRef } from '@backstage/catalog-model';\nimport { ResourcePermission } from '@backstage/plugin-permission-common';\nimport { usePermission } from '@backstage/plugin-permission-react';\nimport { useAsyncEntity } from './useEntity';\n\n/**\n * A thin wrapper around the\n * {@link @backstage/plugin-permission-react#usePermission} hook which uses the\n * current entity in context to make an authorization request for the given\n * {@link @backstage/plugin-catalog-common#CatalogEntityPermission}.\n *\n * Note: this hook blocks the permission request until the entity has loaded in\n * context. If you have the entityRef and need concurrent requests, use the\n * `usePermission` hook directly.\n * @alpha\n */\nexport function useEntityPermission(\n  // TODO(joeporpeglia) Replace with `CatalogEntityPermission` when the issue described in\n  // https://github.com/backstage/backstage/pull/10128 is fixed.\n  permission: ResourcePermission<'catalog-entity'>,\n): {\n  loading: boolean;\n  allowed: boolean;\n  error?: Error;\n} {\n  const {\n    entity,\n    loading: loadingEntity,\n    error: entityError,\n  } = useAsyncEntity();\n  const {\n    allowed,\n    loading: loadingPermission,\n    error: permissionError,\n  } = usePermission({\n    permission,\n    resourceRef: entity ? stringifyEntityRef(entity) : undefined,\n  });\n\n  if (loadingEntity || loadingPermission) {\n    return { loading: true, allowed: false };\n  }\n  if (entityError) {\n    return { loading: false, allowed: false, error: entityError };\n  }\n  return { loading: false, allowed, error: permissionError };\n}\n","/*\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  AnyExtensionInputMap,\n  ExtensionBoundary,\n  ExtensionInputValues,\n  RouteRef,\n  coreExtensionData,\n  createExtension,\n  createExtensionDataRef,\n  createSchemaFromZod,\n} from '@backstage/frontend-plugin-api';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { Expand } from '../../../packages/frontend-plugin-api/src/types';\nimport { Entity } from '@backstage/catalog-model';\n\nexport { isOwnerOf } from './utils';\nexport { useEntityPermission } from './hooks/useEntityPermission';\n\n/** @alpha */\nexport const entityContentTitleExtensionDataRef =\n  createExtensionDataRef<string>('plugin.catalog.entity.content.title');\n\n/** @alpha */\nexport const entityFilterExtensionDataRef = createExtensionDataRef<\n  (ctx: { entity: Entity }) => boolean\n>('plugin.catalog.entity.filter');\n\nfunction applyFilter(a?: string, b?: string): boolean {\n  if (!a) {\n    return true;\n  }\n  return a.toLocaleLowerCase('en-US') === b?.toLocaleLowerCase('en-US');\n}\n\n// TODO: Only two hardcoded isKind and isType filters are available for now\n//       This is just an initial config filter implementation and needs to be revisited\nfunction buildFilter(\n  config: { filter?: { isKind?: string; isType?: string }[] },\n  filterFunc?: (ctx: { entity: Entity }) => boolean,\n) {\n  return (ctx: { entity: Entity }) => {\n    const configuredFilterMatch = config.filter?.some(filter => {\n      const kindMatch = applyFilter(filter.isKind, ctx.entity.kind);\n      const typeMatch = applyFilter(\n        filter.isType,\n        ctx.entity.spec?.type?.toString(),\n      );\n      return kindMatch && typeMatch;\n    });\n    if (configuredFilterMatch) {\n      return true;\n    }\n    if (filterFunc) {\n      return filterFunc(ctx);\n    }\n    return true;\n  };\n}\n\n// TODO: Figure out how to merge with provided config schema\n/** @alpha */\nexport function createEntityCardExtension<\n  TInputs extends AnyExtensionInputMap,\n>(options: {\n  id: string;\n  attachTo?: { id: string; input: string };\n  disabled?: boolean;\n  inputs?: TInputs;\n  filter?: (ctx: { entity: Entity }) => boolean;\n  loader: (options: {\n    inputs: Expand<ExtensionInputValues<TInputs>>;\n  }) => Promise<JSX.Element>;\n}) {\n  const id = `entity.cards.${options.id}`;\n\n  return createExtension({\n    id,\n    attachTo: options.attachTo ?? {\n      id: 'entity.content.overview',\n      input: 'cards',\n    },\n    disabled: options.disabled ?? true,\n    output: {\n      element: coreExtensionData.reactElement,\n      filter: entityFilterExtensionDataRef,\n    },\n    inputs: options.inputs,\n    configSchema: createSchemaFromZod(z =>\n      z.object({\n        filter: z\n          .array(\n            z.object({\n              isKind: z.string().optional(),\n              isType: z.string().optional(),\n            }),\n          )\n          .optional(),\n      }),\n    ),\n    factory({ bind, config, inputs, source }) {\n      const ExtensionComponent = lazy(() =>\n        options\n          .loader({ inputs })\n          .then(element => ({ default: () => element })),\n      );\n\n      bind({\n        element: (\n          <ExtensionBoundary id={id} source={source}>\n            <ExtensionComponent />\n          </ExtensionBoundary>\n        ),\n        filter: buildFilter(config, options.filter),\n      });\n    },\n  });\n}\n\n/** @alpha */\nexport function createEntityContentExtension<\n  TInputs extends AnyExtensionInputMap,\n>(options: {\n  id: string;\n  attachTo?: { id: string; input: string };\n  disabled?: boolean;\n  inputs?: TInputs;\n  routeRef?: RouteRef;\n  defaultPath: string;\n  defaultTitle: string;\n  filter?: (ctx: { entity: Entity }) => boolean;\n  loader: (options: {\n    inputs: Expand<ExtensionInputValues<TInputs>>;\n  }) => Promise<JSX.Element>;\n}) {\n  const id = `entity.content.${options.id}`;\n\n  return createExtension({\n    id,\n    attachTo: options.attachTo ?? {\n      id: 'plugin.catalog.page.entity',\n      input: 'contents',\n    },\n    disabled: options.disabled ?? true,\n    output: {\n      element: coreExtensionData.reactElement,\n      path: coreExtensionData.routePath,\n      routeRef: coreExtensionData.routeRef.optional(),\n      title: entityContentTitleExtensionDataRef,\n      filter: entityFilterExtensionDataRef,\n    },\n    inputs: options.inputs,\n    configSchema: createSchemaFromZod(z =>\n      z.object({\n        path: z.string().default(options.defaultPath),\n        title: z.string().default(options.defaultTitle),\n        filter: z\n          .array(\n            z.object({\n              isKind: z.string().optional(),\n              isType: z.string().optional(),\n            }),\n          )\n          .optional(),\n      }),\n    ),\n    factory({ bind, config, inputs, source }) {\n      const ExtensionComponent = lazy(() =>\n        options\n          .loader({ inputs })\n          .then(element => ({ default: () => element })),\n      );\n\n      bind({\n        path: config.path,\n        title: config.title,\n        routeRef: options.routeRef,\n        element: (\n          <ExtensionBoundary id={id} source={source} routable>\n            <ExtensionComponent />\n          </ExtensionBoundary>\n        ),\n        filter: buildFilter(config, options.filter),\n      });\n    },\n  });\n}\n"],"names":["_a"],"mappings":";;;;;;;;AAkCgB,SAAA,SAAA,CAAU,OAAe,MAAgB,EAAA;AACvD,EAAA,MAAM,iBAAiB,IAAI,GAAA;AAAA,IACzB;AAAA,MACE,GAAG,kBAAmB,CAAA,KAAA,EAAO,oBAAoB,EAAE,IAAA,EAAM,SAAS,CAAA;AAAA,MAClE,GAAI,KAAQ,GAAA,CAAC,qBAAqB,KAAK,CAAC,IAAI,EAAC;AAAA,KAC/C,CAAE,IAAI,kBAAkB,CAAA;AAAA,GAC1B,CAAA;AAEA,EAAA,MAAM,MAAS,GAAA,kBAAA,CAAmB,MAAQ,EAAA,iBAAiB,CAAE,CAAA,GAAA;AAAA,IAC3D,kBAAA;AAAA,GACF,CAAA;AAEA,EAAA,KAAA,MAAW,aAAa,MAAQ,EAAA;AAC9B,IAAI,IAAA,cAAA,CAAe,GAAI,CAAA,SAAS,CAAG,EAAA;AACjC,MAAO,OAAA,IAAA,CAAA;AAAA,KACT;AAAA,GACF;AAEA,EAAO,OAAA,KAAA,CAAA;AACT;;ACrBO,SAAS,oBAGd,UAKA,EAAA;AACA,EAAM,MAAA;AAAA,IACJ,MAAA;AAAA,IACA,OAAS,EAAA,aAAA;AAAA,IACT,KAAO,EAAA,WAAA;AAAA,MACL,cAAe,EAAA,CAAA;AACnB,EAAM,MAAA;AAAA,IACJ,OAAA;AAAA,IACA,OAAS,EAAA,iBAAA;AAAA,IACT,KAAO,EAAA,eAAA;AAAA,MACL,aAAc,CAAA;AAAA,IAChB,UAAA;AAAA,IACA,WAAa,EAAA,MAAA,GAAS,kBAAmB,CAAA,MAAM,CAAI,GAAA,KAAA,CAAA;AAAA,GACpD,CAAA,CAAA;AAED,EAAA,IAAI,iBAAiB,iBAAmB,EAAA;AACtC,IAAA,OAAO,EAAE,OAAA,EAAS,IAAM,EAAA,OAAA,EAAS,KAAM,EAAA,CAAA;AAAA,GACzC;AACA,EAAA,IAAI,WAAa,EAAA;AACf,IAAA,OAAO,EAAE,OAAS,EAAA,KAAA,EAAO,OAAS,EAAA,KAAA,EAAO,OAAO,WAAY,EAAA,CAAA;AAAA,GAC9D;AACA,EAAA,OAAO,EAAE,OAAA,EAAS,KAAO,EAAA,OAAA,EAAS,OAAO,eAAgB,EAAA,CAAA;AAC3D;;AC3Ba,MAAA,kCAAA,GACX,uBAA+B,qCAAqC,EAAA;AAGzD,MAAA,4BAAA,GAA+B,uBAE1C,8BAA8B,EAAA;AAEhC,SAAS,WAAA,CAAY,GAAY,CAAqB,EAAA;AACpD,EAAA,IAAI,CAAC,CAAG,EAAA;AACN,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AACA,EAAA,OAAO,CAAE,CAAA,iBAAA,CAAkB,OAAO,CAAA,MAAM,uBAAG,iBAAkB,CAAA,OAAA,CAAA,CAAA,CAAA;AAC/D,CAAA;AAIA,SAAS,WAAA,CACP,QACA,UACA,EAAA;AACA,EAAA,OAAO,CAAC,GAA4B,KAAA;AAxDtC,IAAA,IAAA,EAAA,CAAA;AAyDI,IAAA,MAAM,qBAAwB,GAAA,CAAA,EAAA,GAAA,MAAA,CAAO,MAAP,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAe,KAAK,CAAU,MAAA,KAAA;AAzDhE,MAAA,IAAAA,GAAA,EAAA,EAAA,CAAA;AA0DM,MAAA,MAAM,YAAY,WAAY,CAAA,MAAA,CAAO,MAAQ,EAAA,GAAA,CAAI,OAAO,IAAI,CAAA,CAAA;AAC5D,MAAA,MAAM,SAAY,GAAA,WAAA;AAAA,QAChB,MAAO,CAAA,MAAA;AAAA,QACP,CAAA,EAAA,GAAA,CAAAA,MAAA,GAAI,CAAA,MAAA,CAAO,SAAX,IAAAA,GAAAA,KAAAA,CAAAA,GAAAA,GAAAA,CAAiB,SAAjB,IAAuB,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,QAAA,EAAA;AAAA,OACzB,CAAA;AACA,MAAA,OAAO,SAAa,IAAA,SAAA,CAAA;AAAA,KACtB,CAAA,CAAA;AACA,IAAA,IAAI,qBAAuB,EAAA;AACzB,MAAO,OAAA,IAAA,CAAA;AAAA,KACT;AACA,IAAA,IAAI,UAAY,EAAA;AACd,MAAA,OAAO,WAAW,GAAG,CAAA,CAAA;AAAA,KACvB;AACA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT,CAAA;AACF,CAAA;AAIO,SAAS,0BAEd,OASC,EAAA;AAxFH,EAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AAyFE,EAAM,MAAA,EAAA,GAAK,CAAgB,aAAA,EAAA,OAAA,CAAQ,EAAE,CAAA,CAAA,CAAA;AAErC,EAAA,OAAO,eAAgB,CAAA;AAAA,IACrB,EAAA;AAAA,IACA,QAAA,EAAA,CAAU,EAAQ,GAAA,OAAA,CAAA,QAAA,KAAR,IAAoB,GAAA,EAAA,GAAA;AAAA,MAC5B,EAAI,EAAA,yBAAA;AAAA,MACJ,KAAO,EAAA,OAAA;AAAA,KACT;AAAA,IACA,QAAA,EAAA,CAAU,EAAQ,GAAA,OAAA,CAAA,QAAA,KAAR,IAAoB,GAAA,EAAA,GAAA,IAAA;AAAA,IAC9B,MAAQ,EAAA;AAAA,MACN,SAAS,iBAAkB,CAAA,YAAA;AAAA,MAC3B,MAAQ,EAAA,4BAAA;AAAA,KACV;AAAA,IACA,QAAQ,OAAQ,CAAA,MAAA;AAAA,IAChB,YAAc,EAAA,mBAAA;AAAA,MAAoB,CAAA,CAAA,KAChC,EAAE,MAAO,CAAA;AAAA,QACP,QAAQ,CACL,CAAA,KAAA;AAAA,UACC,EAAE,MAAO,CAAA;AAAA,YACP,MAAQ,EAAA,CAAA,CAAE,MAAO,EAAA,CAAE,QAAS,EAAA;AAAA,YAC5B,MAAQ,EAAA,CAAA,CAAE,MAAO,EAAA,CAAE,QAAS,EAAA;AAAA,WAC7B,CAAA;AAAA,UAEF,QAAS,EAAA;AAAA,OACb,CAAA;AAAA,KACH;AAAA,IACA,QAAQ,EAAE,IAAA,EAAM,MAAQ,EAAA,MAAA,EAAQ,QAAU,EAAA;AACxC,MAAA,MAAM,kBAAqB,GAAA,IAAA;AAAA,QAAK,MAC9B,OAAA,CACG,MAAO,CAAA,EAAE,MAAO,EAAC,CACjB,CAAA,IAAA,CAAK,CAAY,OAAA,MAAA,EAAE,OAAS,EAAA,MAAM,SAAU,CAAA,CAAA;AAAA,OACjD,CAAA;AAEA,MAAK,IAAA,CAAA;AAAA,QACH,yBACG,KAAA,CAAA,aAAA,CAAA,iBAAA,EAAA,EAAkB,IAAQ,MACzB,EAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,wBAAmB,CACtB,CAAA;AAAA,QAEF,MAAQ,EAAA,WAAA,CAAY,MAAQ,EAAA,OAAA,CAAQ,MAAM,CAAA;AAAA,OAC3C,CAAA,CAAA;AAAA,KACH;AAAA,GACD,CAAA,CAAA;AACH,CAAA;AAGO,SAAS,6BAEd,OAYC,EAAA;AArJH,EAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AAsJE,EAAM,MAAA,EAAA,GAAK,CAAkB,eAAA,EAAA,OAAA,CAAQ,EAAE,CAAA,CAAA,CAAA;AAEvC,EAAA,OAAO,eAAgB,CAAA;AAAA,IACrB,EAAA;AAAA,IACA,QAAA,EAAA,CAAU,EAAQ,GAAA,OAAA,CAAA,QAAA,KAAR,IAAoB,GAAA,EAAA,GAAA;AAAA,MAC5B,EAAI,EAAA,4BAAA;AAAA,MACJ,KAAO,EAAA,UAAA;AAAA,KACT;AAAA,IACA,QAAA,EAAA,CAAU,EAAQ,GAAA,OAAA,CAAA,QAAA,KAAR,IAAoB,GAAA,EAAA,GAAA,IAAA;AAAA,IAC9B,MAAQ,EAAA;AAAA,MACN,SAAS,iBAAkB,CAAA,YAAA;AAAA,MAC3B,MAAM,iBAAkB,CAAA,SAAA;AAAA,MACxB,QAAA,EAAU,iBAAkB,CAAA,QAAA,CAAS,QAAS,EAAA;AAAA,MAC9C,KAAO,EAAA,kCAAA;AAAA,MACP,MAAQ,EAAA,4BAAA;AAAA,KACV;AAAA,IACA,QAAQ,OAAQ,CAAA,MAAA;AAAA,IAChB,YAAc,EAAA,mBAAA;AAAA,MAAoB,CAAA,CAAA,KAChC,EAAE,MAAO,CAAA;AAAA,QACP,MAAM,CAAE,CAAA,MAAA,EAAS,CAAA,OAAA,CAAQ,QAAQ,WAAW,CAAA;AAAA,QAC5C,OAAO,CAAE,CAAA,MAAA,EAAS,CAAA,OAAA,CAAQ,QAAQ,YAAY,CAAA;AAAA,QAC9C,QAAQ,CACL,CAAA,KAAA;AAAA,UACC,EAAE,MAAO,CAAA;AAAA,YACP,MAAQ,EAAA,CAAA,CAAE,MAAO,EAAA,CAAE,QAAS,EAAA;AAAA,YAC5B,MAAQ,EAAA,CAAA,CAAE,MAAO,EAAA,CAAE,QAAS,EAAA;AAAA,WAC7B,CAAA;AAAA,UAEF,QAAS,EAAA;AAAA,OACb,CAAA;AAAA,KACH;AAAA,IACA,QAAQ,EAAE,IAAA,EAAM,MAAQ,EAAA,MAAA,EAAQ,QAAU,EAAA;AACxC,MAAA,MAAM,kBAAqB,GAAA,IAAA;AAAA,QAAK,MAC9B,OAAA,CACG,MAAO,CAAA,EAAE,MAAO,EAAC,CACjB,CAAA,IAAA,CAAK,CAAY,OAAA,MAAA,EAAE,OAAS,EAAA,MAAM,SAAU,CAAA,CAAA;AAAA,OACjD,CAAA;AAEA,MAAK,IAAA,CAAA;AAAA,QACH,MAAM,MAAO,CAAA,IAAA;AAAA,QACb,OAAO,MAAO,CAAA,KAAA;AAAA,QACd,UAAU,OAAQ,CAAA,QAAA;AAAA,QAClB,OAAA,sCACG,iBAAkB,EAAA,EAAA,EAAA,EAAQ,QAAgB,QAAQ,EAAA,IAAA,EAAA,kBAChD,KAAA,CAAA,aAAA,CAAA,kBAAA,EAAA,IAAmB,CACtB,CAAA;AAAA,QAEF,MAAQ,EAAA,WAAA,CAAY,MAAQ,EAAA,OAAA,CAAQ,MAAM,CAAA;AAAA,OAC3C,CAAA,CAAA;AAAA,KACH;AAAA,GACD,CAAA,CAAA;AACH;;;;"}

package/dist/index.d.ts

@@ -1,11 +1,12 @@
+/// <reference types="react" />
 import { CatalogApi } from '@backstage/catalog-client';
 export { CATALOG_FILTER_EXISTS, CatalogApi } from '@backstage/catalog-client';
 import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
-import { ApiRef } from '@backstage/core-plugin-api';
-import { Observable } from '@backstage/types';
-import React, { PropsWithChildren, ReactNode, ComponentProps } from 'react';
+import { ApiRef, IconComponent } from '@backstage/core-plugin-api';
 import * as _backstage_catalog_model from '@backstage/catalog-model';
 import { Entity, CompoundEntityRef } from '@backstage/catalog-model';
+import { Observable } from '@backstage/types';
+import React, { PropsWithChildren, ReactNode, ComponentProps } from 'react';
 import { LinkProps, InfoCardVariants, TableColumn, TableOptions } from '@backstage/core-components';
 import { IconButton, TextFieldProps } from '@material-ui/core';
 import { Overrides } from '@material-ui/core/styles/overrides';
@@ -18,6 +19,143 @@ import { ScmIntegrationRegistry } from '@backstage/integration';
  */
 declare const catalogApiRef: _backstage_core_plugin_api.ApiRef<CatalogApi>;
 
+/**
+ * An API that handles how to represent entities in the interface.
+ *
+ * @public
+ */
+declare const entityPresentationApiRef: ApiRef<EntityPresentationApi>;
+/**
+ * The visual presentation of an entity reference at some point in time.
+ *
+ * @public
+ */
+interface EntityRefPresentationSnapshot {
+    /**
+     * The ref to the entity that this snapshot represents.
+     *
+     * @remarks
+     *
+     * Note that when the input data was broken or had missing vital pieces of
+     * information, this string may contain placeholders such as "unknown". You
+     * can therefore not necessarily assume that the ref is completely valid and
+     * usable for example for forming a clickable link to the entity.
+     */
+    entityRef: string;
+    /**
+     * A string that can be used as a plain representation of the entity, for
+     * example in a header or a link.
+     *
+     * @remarks
+     *
+     * The title may be short and not contain all of the information that the
+     * entity holds. When rendering the primary title, you may also want to
+     * make sure to add more contextual information nearby such as the icon or
+     * secondary title, since the primary could for example just be the
+     * `metadata.name` of the entity which might be ambiguous to the reader.
+     */
+    primaryTitle: string;
+    /**
+     * Optionally, some additional textual information about the entity, to be
+     * used as a clarification on top of the primary title.
+     *
+     * @remarks
+     *
+     * This text can for example be rendered in a tooltip or be used as a
+     * subtitle. It may not be sufficient to display on its own; it should
+     * typically be used in conjunction with the primary title. It can contain
+     * such information as the entity ref and/or a `spec.type` etc.
+     */
+    secondaryTitle?: string;
+    /**
+     * Optionally, an icon that represents the kind/type of entity.
+     *
+     * @remarks
+     *
+     * This icon should ideally be easily recognizable as the kind of entity, and
+     * be used consistently throughout the Backstage interface. It can be rendered
+     * both in larger formats such as in a header, or in smaller formats such as
+     * inline with regular text, so bear in mind that the legibility should be
+     * high in both cases.
+     *
+     * A value of `false` here indicates the desire to not have an icon present
+     * for the given implementation. A value of `undefined` leaves it at the
+     * discretion of the display layer to choose what to do (such as for example
+     * showing a fallback icon).
+     */
+    Icon?: IconComponent | undefined | false;
+}
+/**
+ * The visual presentation of an entity reference.
+ *
+ * @public
+ */
+interface EntityRefPresentation {
+    /**
+     * The representation that's suitable to use for this entity right now.
+     */
+    snapshot: EntityRefPresentationSnapshot;
+    /**
+     * Some presentation implementations support emitting updated snapshots over
+     * time, for example after retrieving additional data from the catalog or
+     * elsewhere.
+     */
+    update$?: Observable<EntityRefPresentationSnapshot>;
+}
+/**
+ * An API that decides how to visually represent entities in the interface.
+ *
+ * @remarks
+ *
+ * Most consumers will want to use the {@link useEntityPresentation} hook
+ * instead of this interface directly.
+ *
+ * @public
+ */
+interface EntityPresentationApi {
+    /**
+     * Fetches the presentation for an entity.
+     *
+     * @param entityOrRef - Either an entity, or a string ref to it. If you pass
+     *   in an entity, it is assumed that it is not a partial one - i.e. only pass
+     *   in an entity if you know that it was fetched in such a way that it
+     *   contains all of the fields that the representation renderer needs.
+     * @param context - Contextual information that may affect the presentation.
+     */
+    forEntity(entityOrRef: Entity | string, context?: {
+        defaultKind?: string;
+        defaultNamespace?: string;
+    }): EntityRefPresentation;
+}
+
+/**
+ * This returns the default representation of an entity.
+ *
+ * @public
+ * @param entityOrRef - Either an entity, or a ref to it.
+ * @param context - Contextual information that may affect the presentation.
+ */
+declare function defaultEntityPresentation(entityOrRef: Entity | CompoundEntityRef | string, context?: {
+    defaultKind?: string;
+    defaultNamespace?: string;
+}): EntityRefPresentationSnapshot;
+
+/**
+ * Returns information about how to represent an entity in the interface.
+ *
+ * @public
+ * @param entityOrRef - The entity to represent, or an entity ref to it. If you
+ *   pass in an entity, it is assumed that it is NOT a partial one - i.e. only
+ *   pass in an entity if you know that it was fetched in such a way that it
+ *   contains all of the fields that the representation renderer needs.
+ * @param context - Optional context that control details of the presentation.
+ * @returns A snapshot of the entity presentation, which may change over time
+ */
+declare function useEntityPresentation(entityOrRef: Entity | CompoundEntityRef | string, context?: {
+    defaultKind?: string;
+    defaultNamespace?: string;
+}): EntityRefPresentationSnapshot;
+
 /**
  * An API to store starred entities
  *
@@ -107,6 +245,32 @@ type EntityOwnerPickerProps = {
 /** @public */
 declare const EntityOwnerPicker: (props?: EntityOwnerPickerProps) => React.JSX.Element | null;
 
+/**
+ * The available style class keys for {@link EntityDisplayName}, under the name
+ * "CatalogReactEntityDisplayName".
+ *
+ * @public
+ */
+type CatalogReactEntityDisplayNameClassKey = 'root' | 'icon';
+/**
+ * Props for {@link EntityDisplayName}.
+ *
+ * @public
+ */
+type EntityDisplayNameProps = {
+    entityRef: Entity | CompoundEntityRef | string;
+    noIcon?: boolean;
+    noTooltip?: boolean;
+    defaultKind?: string;
+    defaultNamespace?: string;
+};
+/**
+ * Shows a nice representation of a reference to an entity.
+ *
+ * @public
+ */
+declare const EntityDisplayName: (props: EntityDisplayNameProps) => JSX.Element;
+
 /**
  * Props for {@link EntityRefLink}.
  *
@@ -115,6 +279,8 @@ declare const EntityOwnerPicker: (props?: EntityOwnerPickerProps) => React.JSX.E
 type EntityRefLinkProps = {
     entityRef: Entity | CompoundEntityRef | string;
     defaultKind?: string;
+    defaultNamespace?: string;
+    /** @deprecated This option should no longer be used; presentation is requested through the {@link entityPresentationApiRef} instead */
     title?: string;
     children?: React.ReactNode;
 } & Omit<LinkProps, 'to'>;
@@ -130,17 +296,14 @@ declare const EntityRefLink: (props: EntityRefLinkProps) => JSX.Element;
  *
  * @public
  */
-type EntityRefLinksProps<TRef extends string | CompoundEntityRef | Entity> = ({
+type EntityRefLinksProps<TRef extends string | CompoundEntityRef | Entity> = {
     defaultKind?: string;
     entityRefs: TRef[];
-    fetchEntities?: false;
+    /** @deprecated This option is no longer used; presentation is handled by entityPresentationApiRef instead */
+    fetchEntities?: boolean;
+    /** @deprecated This option is no longer used; presentation is handled by entityPresentationApiRef instead */
     getTitle?(entity: TRef): string | undefined;
-} | {
-    defaultKind?: string;
-    entityRefs: TRef[];
-    fetchEntities: true;
-    getTitle(entity: Entity): string | undefined;
-}) & Omit<LinkProps, 'to'>;
+} & Omit<LinkProps, 'to'>;
 /**
  * Shows a list of clickable links to entities.
  *
@@ -375,6 +538,7 @@ declare class EntityTagFilter implements EntityFilter {
     readonly values: string[];
     constructor(values: string[]);
     filterEntity(entity: Entity): boolean;
+    getCatalogFilters(): Record<string, string | string[]>;
     toQueryValue(): string[];
 }
 /**
@@ -396,6 +560,7 @@ declare class EntityTextFilter implements EntityFilter {
 declare class EntityOwnerFilter implements EntityFilter {
     readonly values: string[];
     constructor(values: string[]);
+    getCatalogFilters(): Record<string, string | string[]>;
     filterEntity(entity: Entity): boolean;
     /**
      * Get the URL query parameter value. May be a mix of full and humanized entity refs.
@@ -410,6 +575,7 @@ declare class EntityOwnerFilter implements EntityFilter {
 declare class EntityLifecycleFilter implements EntityFilter {
     readonly values: string[];
     constructor(values: string[]);
+    getCatalogFilters(): Record<string, string | string[]>;
     filterEntity(entity: Entity): boolean;
     toQueryValue(): string[];
 }
@@ -420,11 +586,27 @@ declare class EntityLifecycleFilter implements EntityFilter {
 declare class EntityNamespaceFilter implements EntityFilter {
     readonly values: string[];
     constructor(values: string[]);
+    getCatalogFilters(): Record<string, string | string[]>;
     filterEntity(entity: Entity): boolean;
     toQueryValue(): string[];
 }
+/**
+ * @public
+ */
+declare class EntityUserFilter implements EntityFilter {
+    readonly value: UserListFilterKind;
+    readonly refs?: string[] | undefined;
+    private constructor();
+    static owned(ownershipEntityRefs: string[]): EntityUserFilter;
+    static all(): EntityUserFilter;
+    static starred(starredEntityRefs: string[]): EntityUserFilter;
+    getCatalogFilters(): Record<string, string[]>;
+    filterEntity(entity: Entity): boolean;
+    toQueryValue(): string;
+}
 /**
  * Filters entities based on whatever the user has starred or owns them.
+ * @deprecated use EntityUserFilter
  * @public
  */
 declare class UserListFilter implements EntityFilter {
@@ -442,6 +624,7 @@ declare class UserListFilter implements EntityFilter {
 declare class EntityOrphanFilter implements EntityFilter {
     readonly value: boolean;
     constructor(value: boolean);
+    getCatalogFilters(): Record<string, string | string[]>;
     filterEntity(entity: Entity): boolean;
 }
 /**
@@ -458,7 +641,7 @@ declare class EntityErrorFilter implements EntityFilter {
 type DefaultEntityFilters = {
     kind?: EntityKindFilter;
     type?: EntityTypeFilter;
-    user?: UserListFilter;
+    user?: UserListFilter | EntityUserFilter;
     owners?: EntityOwnerFilter;
     lifecycles?: EntityLifecycleFilter;
     tags?: EntityTagFilter;
@@ -676,6 +859,7 @@ declare function MockEntityListContextProvider<T extends DefaultEntityFilters =
 /** @public */
 type CatalogReactComponentsNameToClassKey = {
     CatalogReactUserListPicker: CatalogReactUserListPickerClassKey;
+    CatalogReactEntityDisplayName: CatalogReactEntityDisplayNameClassKey;
     CatalogReactEntityLifecyclePicker: CatalogReactEntityLifecyclePickerClassKey;
     CatalogReactEntitySearchBar: CatalogReactEntitySearchBarClassKey;
     CatalogReactEntityTagPicker: CatalogReactEntityTagPickerClassKey;
@@ -704,4 +888,4 @@ type EntitySourceLocation = {
 /** @public */
 declare function getEntitySourceLocation(entity: Entity, scmIntegrationsApi: ScmIntegrationRegistry): EntitySourceLocation | undefined;
 
-export { AllowedEntityFilters, AsyncEntityProvider, AsyncEntityProviderProps, BackstageOverrides, CatalogFilterLayout, CatalogReactComponentsNameToClassKey, CatalogReactEntityLifecyclePickerClassKey, CatalogReactEntityNamespacePickerClassKey, CatalogReactEntityOwnerPickerClassKey, CatalogReactEntityProcessingStatusPickerClassKey, CatalogReactEntitySearchBarClassKey, CatalogReactEntityTagPickerClassKey, CatalogReactUserListPickerClassKey, DefaultEntityFilters, EntityAutocompletePicker, EntityAutocompletePickerProps, EntityErrorFilter, EntityFilter, EntityKindFilter, EntityKindPicker, EntityKindPickerProps, EntityLifecycleFilter, EntityLifecyclePicker, EntityListContext, EntityListContextProps, EntityListProvider, EntityLoadingStatus, EntityNamespaceFilter, EntityNamespacePicker, EntityOrphanFilter, EntityOwnerFilter, EntityOwnerPicker, EntityOwnerPickerProps, EntityPeekAheadPopover, EntityPeekAheadPopoverProps, EntityProcessingStatusPicker, EntityProvider, EntityProviderProps, EntityRefLink, EntityRefLinkProps, EntityRefLinks, EntityRefLinksProps, EntitySearchBar, EntitySourceLocation, EntityTable, EntityTableProps, EntityTagFilter, EntityTagPicker, EntityTagPickerProps, EntityTextFilter, EntityTypeFilter, EntityTypePicker, EntityTypePickerProps, FavoriteEntity, FavoriteEntityProps, InspectEntityDialog, MockEntityListContextProvider, MockStarredEntitiesApi, StarredEntitiesApi, UnregisterEntityDialog, UnregisterEntityDialogProps, UserListFilter, UserListFilterKind, UserListPicker, UserListPickerProps, catalogApiRef, columnFactories, entityRouteParams, entityRouteRef, getEntityRelations, getEntitySourceLocation, humanizeEntityRef, starredEntitiesApiRef, useAsyncEntity, useEntity, useEntityList, useEntityOwnership, useEntityTypeFilter, useRelatedEntities, useStarredEntities, useStarredEntity };
+export { AllowedEntityFilters, AsyncEntityProvider, AsyncEntityProviderProps, BackstageOverrides, CatalogFilterLayout, CatalogReactComponentsNameToClassKey, CatalogReactEntityDisplayNameClassKey, CatalogReactEntityLifecyclePickerClassKey, CatalogReactEntityNamespacePickerClassKey, CatalogReactEntityOwnerPickerClassKey, CatalogReactEntityProcessingStatusPickerClassKey, CatalogReactEntitySearchBarClassKey, CatalogReactEntityTagPickerClassKey, CatalogReactUserListPickerClassKey, DefaultEntityFilters, EntityAutocompletePicker, EntityAutocompletePickerProps, EntityDisplayName, EntityDisplayNameProps, EntityErrorFilter, EntityFilter, EntityKindFilter, EntityKindPicker, EntityKindPickerProps, EntityLifecycleFilter, EntityLifecyclePicker, EntityListContext, EntityListContextProps, EntityListProvider, EntityLoadingStatus, EntityNamespaceFilter, EntityNamespacePicker, EntityOrphanFilter, EntityOwnerFilter, EntityOwnerPicker, EntityOwnerPickerProps, EntityPeekAheadPopover, EntityPeekAheadPopoverProps, EntityPresentationApi, EntityProcessingStatusPicker, EntityProvider, EntityProviderProps, EntityRefLink, EntityRefLinkProps, EntityRefLinks, EntityRefLinksProps, EntityRefPresentation, EntityRefPresentationSnapshot, EntitySearchBar, EntitySourceLocation, EntityTable, EntityTableProps, EntityTagFilter, EntityTagPicker, EntityTagPickerProps, EntityTextFilter, EntityTypeFilter, EntityTypePicker, EntityTypePickerProps, EntityUserFilter, FavoriteEntity, FavoriteEntityProps, InspectEntityDialog, MockEntityListContextProvider, MockStarredEntitiesApi, StarredEntitiesApi, UnregisterEntityDialog, UnregisterEntityDialogProps, UserListFilter, UserListFilterKind, UserListPicker, UserListPickerProps, catalogApiRef, columnFactories, defaultEntityPresentation, entityPresentationApiRef, entityRouteParams, entityRouteRef, getEntityRelations, getEntitySourceLocation, humanizeEntityRef, starredEntitiesApiRef, useAsyncEntity, useEntity, useEntityList, useEntityOwnership, useEntityPresentation, useEntityTypeFilter, useRelatedEntities, useStarredEntities, useStarredEntity };