@backstage/plugin-catalog-react 0.0.0-nightly-20220223022848 → 0.0.0-nightly-20220224022833

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # @backstage/plugin-catalog-react
 
-## 0.0.0-nightly-20220223022848
+## 0.0.0-nightly-20220224022833
 
 ### Minor Changes
 
@@ -9,17 +9,24 @@
 
   **BREAKING**: The individual table column factories (e.g. `createEntityRefColumn`) are now no longer available directly, but only through `EntityTable.columns`.
 
+- c4276915c0: **BREAKING**: Deleted the deprecated `loadIdentityOwnerRefs` function which is replaced by `ownershipEntityRefs` from `identityApi.getBackstageIdentity()`.
+
+  Deprecated the `loadCatalogOwnerRefs` hook as membership references should be added as `ent` inside `claims` sections of the `SignInResolver` when issuing tokens. See https://backstage.io/docs/auth/identity-resolver for more details on how to prepare your `SignInResolver` if not done already. Usage of the `loadCatalogOwnerRefs` hook should be replaced by `ownershipEntityRefs` from `identityApi.getBackstageIdentity()` instead.
+
 ### Patch Changes
 
 - a8331830f1: Deprecated the `useEntityKinds` hook due to low usage and utility value.
 - 6e1cbc12a6: Updated according to the new `getEntityFacets` catalog API method
 - b776ce5aab: Deprecated the `useEntityListProvider` hook which is now renamed to `useEntityList`
 - 2d339b5f2c: Deprecated `useEntityFromUrl` and the `useEntityCompoundName` hooks as these have very low utility value.
-- Updated dependencies
-  - @backstage/core-components@0.0.0-nightly-20220223022848
-  - @backstage/catalog-model@0.0.0-nightly-20220223022848
-  - @backstage/integration@0.0.0-nightly-20220223022848
-  - @backstage/catalog-client@0.0.0-nightly-20220223022848
+- d4f67fa728: Deprecated the `useOwnedEntities` hook which is replaced by the IdentityAPI.
+  Deprecated the `useOwnUser` hook due to low external value.
+- 919cf2f836: Minor updates to match the new `targetRef` field of relations, and to stop consuming the `target` field
+- Updated dependencies
+  - @backstage/core-components@0.0.0-nightly-20220224022833
+  - @backstage/catalog-model@0.0.0-nightly-20220224022833
+  - @backstage/catalog-client@0.0.0-nightly-20220224022833
+  - @backstage/integration@0.0.0-nightly-20220224022833
 
 ## 0.6.15
 

package/dist/index.d.ts

@@ -2,7 +2,7 @@
 import { CatalogApi, GetEntitiesResponse } 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, StorageApi, IdentityApi } from '@backstage/core-plugin-api';
+import { ApiRef, StorageApi } from '@backstage/core-plugin-api';
 import { Observable } from '@backstage/types';
 import * as _backstage_catalog_model from '@backstage/catalog-model';
 import { Entity, EntityName, UserEntity } from '@backstage/catalog-model';
@@ -92,7 +92,7 @@ declare const EntityOwnerPicker: () => JSX.Element | null;
  * @public
  */
 declare type EntityRefLinkProps = {
-    entityRef: Entity | EntityName;
+    entityRef: Entity | EntityName | string;
     defaultKind?: string;
     title?: string;
     children?: React.ReactNode;
@@ -513,11 +513,12 @@ declare function useEntityKinds(): {
 /**
  * Get the catalog User entity (if any) that matches the logged-in user.
  * @public
+ * @deprecated due to low external usage.
  */
 declare function useOwnUser(): AsyncState<UserEntity | undefined>;
 
 /** @public */
-declare function useRelatedEntities(entity: Entity, { type, kind }: {
+declare function useRelatedEntities(entity: Entity, relationFilter: {
     type?: string;
     kind?: string;
 }): {
@@ -539,18 +540,6 @@ declare function useStarredEntity(entityOrRef: Entity | EntityName | string): {
     isStarredEntity: boolean;
 };
 
-/**
- * Takes the relevant parts of the Backstage identity, and translates them into
- * a list of entity refs on string form that represent the user's ownership
- * connections.
- *
- * @public
- * @deprecated Use `ownershipEntityRefs` from `identityApi.getBackstageIdentity()` instead.
- *
- * @param identityApi - The IdentityApi implementation
- * @returns IdentityOwner refs as a string array
- */
-declare function loadIdentityOwnerRefs(identityApi: IdentityApi): Promise<string[]>;
 /**
  * Takes the relevant parts of the User entity corresponding to the Backstage
  * identity, and translates them into a list of entity refs on string form that
@@ -561,6 +550,7 @@ declare function loadIdentityOwnerRefs(identityApi: IdentityApi): Promise<string
  * @param catalogApi - The Catalog API implementation
  * @param identityOwnerRefs - List of identity owner refs as strings
  * @returns OwnerRefs as a string array
+ * @deprecated Use `ownershipEntityRefs` from `identityApi.getBackstageIdentity()` instead.
  */
 declare function loadCatalogOwnerRefs(catalogApi: CatalogApi, identityOwnerRefs: string[]): Promise<string[]>;
 /**
@@ -586,6 +576,7 @@ declare function useEntityOwnership(): {
  * @public
  *
  * @param allowedKinds - Array of allowed kinds to filter the entities
+ * @deprecated Use `ownershipEntityRefs` from `identityApi.getBackstageIdentity()` instead.
  */
 declare function useOwnedEntities(allowedKinds?: string[]): {
     loading: boolean;
@@ -670,6 +661,7 @@ declare function getEntityMetadataEditUrl(entity: Entity): string | undefined;
 
 /**
  * Get the related entity references.
+ *
  * @public
  */
 declare function getEntityRelations(entity: Entity | undefined, relationType: string, filter?: {
@@ -703,4 +695,4 @@ declare type BackstageOverrides = Overrides & {
     [Name in keyof CatalogReactComponentsNameToClassKey]?: Partial<StyleRules<CatalogReactComponentsNameToClassKey[Name]>>;
 };
 
-export { AsyncEntityProvider, AsyncEntityProviderProps, BackstageOverrides, CatalogReactComponentsNameToClassKey, CatalogReactEntityLifecyclePickerClassKey, CatalogReactEntityOwnerPickerClassKey, CatalogReactEntitySearchBarClassKey, CatalogReactEntityTagPickerClassKey, CatalogReactUserListPickerClassKey, DefaultEntityFilters, DefaultStarredEntitiesApi, EntityFilter, EntityKindFilter, EntityKindPicker, EntityKindPickerProps, EntityLifecycleFilter, EntityLifecyclePicker, EntityListContext, EntityListContextProps, EntityListProvider, EntityLoadingStatus, EntityOwnerFilter, EntityOwnerPicker, EntityProvider, EntityProviderProps, EntityRefLink, EntityRefLinkProps, EntityRefLinks, EntityRefLinksProps, EntitySearchBar, EntitySourceLocation, EntityTable, EntityTableProps, EntityTagFilter, EntityTagPicker, EntityTextFilter, EntityTypeFilter, EntityTypePicker, EntityTypePickerProps, EntityTypeReturn, FavoriteEntity, FavoriteEntityProps, InspectEntityDialog, MockEntityListContextProvider, StarredEntitiesApi, UnregisterEntityDialog, UnregisterEntityDialogProps, UserListFilter, UserListFilterKind, UserListPicker, UserListPickerProps, catalogApiRef, catalogRouteRef, columnFactories, entityRoute, entityRouteParams, entityRouteRef, favoriteEntityIcon, favoriteEntityTooltip, formatEntityRefTitle, getEntityMetadataEditUrl, getEntityMetadataViewUrl, getEntityRelations, getEntitySourceLocation, isOwnerOf, loadCatalogOwnerRefs, loadIdentityOwnerRefs, reduceCatalogFilters, reduceEntityFilters, rootRoute, starredEntitiesApiRef, useEntity, useEntityCompoundName, useEntityFromUrl, useEntityKinds, useEntityList, useEntityListProvider, useEntityOwnership, useEntityPermission, useEntityTypeFilter, useOwnUser, useOwnedEntities, useRelatedEntities, useStarredEntities, useStarredEntity };
+export { AsyncEntityProvider, AsyncEntityProviderProps, BackstageOverrides, CatalogReactComponentsNameToClassKey, CatalogReactEntityLifecyclePickerClassKey, CatalogReactEntityOwnerPickerClassKey, CatalogReactEntitySearchBarClassKey, CatalogReactEntityTagPickerClassKey, CatalogReactUserListPickerClassKey, DefaultEntityFilters, DefaultStarredEntitiesApi, EntityFilter, EntityKindFilter, EntityKindPicker, EntityKindPickerProps, EntityLifecycleFilter, EntityLifecyclePicker, EntityListContext, EntityListContextProps, EntityListProvider, EntityLoadingStatus, EntityOwnerFilter, EntityOwnerPicker, EntityProvider, EntityProviderProps, EntityRefLink, EntityRefLinkProps, EntityRefLinks, EntityRefLinksProps, EntitySearchBar, EntitySourceLocation, EntityTable, EntityTableProps, EntityTagFilter, EntityTagPicker, EntityTextFilter, EntityTypeFilter, EntityTypePicker, EntityTypePickerProps, EntityTypeReturn, FavoriteEntity, FavoriteEntityProps, InspectEntityDialog, MockEntityListContextProvider, StarredEntitiesApi, UnregisterEntityDialog, UnregisterEntityDialogProps, UserListFilter, UserListFilterKind, UserListPicker, UserListPickerProps, catalogApiRef, catalogRouteRef, columnFactories, entityRoute, entityRouteParams, entityRouteRef, favoriteEntityIcon, favoriteEntityTooltip, formatEntityRefTitle, getEntityMetadataEditUrl, getEntityMetadataViewUrl, getEntityRelations, getEntitySourceLocation, isOwnerOf, loadCatalogOwnerRefs, reduceCatalogFilters, reduceEntityFilters, rootRoute, starredEntitiesApiRef, useEntity, useEntityCompoundName, useEntityFromUrl, useEntityKinds, useEntityList, useEntityListProvider, useEntityOwnership, useEntityPermission, useEntityTypeFilter, useOwnUser, useOwnedEntities, useRelatedEntities, useStarredEntities, useStarredEntity };

package/dist/index.esm.js

@@ -1,7 +1,7 @@
 export { CATALOG_FILTER_EXISTS } from '@backstage/catalog-client';
 import { createApiRef, createRouteRef, useRouteRefParams, useApi, errorApiRef, useRouteRef, identityApiRef, alertApiRef, useApp, configApiRef } from '@backstage/core-plugin-api';
 import ObservableImpl from 'zen-observable';
-import { stringifyEntityRef, DEFAULT_NAMESPACE, ANNOTATION_VIEW_URL, ANNOTATION_EDIT_URL, ANNOTATION_SOURCE_LOCATION, parseLocationRef, RELATION_MEMBER_OF, getEntityName, RELATION_OWNED_BY, parseEntityRef, RELATION_PART_OF, ANNOTATION_LOCATION, ANNOTATION_ORIGIN_LOCATION } from '@backstage/catalog-model';
+import { stringifyEntityRef, DEFAULT_NAMESPACE, ANNOTATION_VIEW_URL, ANNOTATION_EDIT_URL, parseEntityRef, ANNOTATION_SOURCE_LOCATION, parseLocationRef, RELATION_MEMBER_OF, getEntityName, RELATION_OWNED_BY, RELATION_PART_OF, ANNOTATION_LOCATION, ANNOTATION_ORIGIN_LOCATION } from '@backstage/catalog-model';
 import { isArray, isString, compact, isEqual, groupBy, chunk } from 'lodash';
 import React, { useEffect, createContext, useState, useMemo, useCallback, useContext, forwardRef, useRef, useLayoutEffect, Fragment } from 'react';
 import { Alert, Autocomplete } from '@material-ui/lab';
@@ -207,10 +207,10 @@ function getEntityMetadataEditUrl(entity) {
 }
 
 function getEntityRelations(entity, relationType, filter) {
-  var _a, _b;
-  let entityNames = ((_b = (_a = entity == null ? void 0 : entity.relations) == null ? void 0 : _a.filter((r) => r.type === relationType)) == null ? void 0 : _b.map((r) => r.target)) || [];
+  var _a;
+  let entityNames = ((_a = entity == null ? void 0 : entity.relations) == null ? void 0 : _a.filter((r) => r.type === relationType).map((r) => parseEntityRef(r.targetRef))) || [];
   if (filter == null ? void 0 : filter.kind) {
-    entityNames = entityNames == null ? void 0 : entityNames.filter((e) => e.kind.toLocaleLowerCase("en-US") === filter.kind.toLocaleLowerCase("en-US"));
+    entityNames = entityNames.filter((e) => e.kind.toLocaleLowerCase("en-US") === filter.kind.toLocaleLowerCase("en-US"));
   }
   return entityNames;
 }
@@ -368,7 +368,12 @@ const EntityRefLink = forwardRef((props, ref) => {
   let kind;
   let namespace;
   let name;
-  if ("metadata" in entityRef) {
+  if (typeof entityRef === "string") {
+    const parsed = parseEntityRef(entityRef);
+    kind = parsed.kind;
+    namespace = parsed.namespace;
+    name = parsed.name;
+  } else if ("metadata" in entityRef) {
     kind = entityRef.kind;
     namespace = entityRef.metadata.namespace;
     name = entityRef.metadata.name;
@@ -378,14 +383,9 @@ const EntityRefLink = forwardRef((props, ref) => {
     name = entityRef.name;
   }
   kind = kind.toLocaleLowerCase("en-US");
-  const routeParams = {
-    kind,
-    namespace: (_a = namespace == null ? void 0 : namespace.toLocaleLowerCase("en-US")) != null ? _a : DEFAULT_NAMESPACE,
-    name
-  };
-  const formattedEntityRefTitle = formatEntityRefTitle(entityRef, {
-    defaultKind
-  });
+  namespace = (_a = namespace == null ? void 0 : namespace.toLocaleLowerCase("en-US")) != null ? _a : DEFAULT_NAMESPACE;
+  const routeParams = { kind, namespace, name };
+  const formattedEntityRefTitle = formatEntityRefTitle({ kind, namespace, name }, { defaultKind });
   const link = /* @__PURE__ */ React.createElement(Link, {
     ...linkProps,
     ref,
@@ -590,14 +590,18 @@ function useOwnUser() {
 }
 
 const BATCH_SIZE = 20;
-function useRelatedEntities(entity, { type, kind }) {
+function useRelatedEntities(entity, relationFilter) {
+  var _a, _b;
+  const filterByTypeLower = (_a = relationFilter == null ? void 0 : relationFilter.type) == null ? void 0 : _a.toLocaleLowerCase("en-US");
+  const filterByKindLower = (_b = relationFilter == null ? void 0 : relationFilter.kind) == null ? void 0 : _b.toLocaleLowerCase("en-US");
   const catalogApi = useApi(catalogApiRef);
   const {
     loading,
     value: entities,
     error
   } = useAsync(async () => {
-    const relations = entity.relations && entity.relations.filter((r) => (!type || r.type.toLocaleLowerCase("en-US") === type.toLocaleLowerCase("en-US")) && (!kind || r.target.kind.toLocaleLowerCase("en-US") === kind.toLocaleLowerCase("en-US")));
+    var _a2;
+    const relations = (_a2 = entity.relations) == null ? void 0 : _a2.map((r) => ({ type: r.type, target: parseEntityRef(r.targetRef) })).filter((r) => (!filterByTypeLower || r.type.toLocaleLowerCase("en-US") === filterByTypeLower) && (!filterByKindLower || r.target.kind === filterByKindLower));
     if (!relations) {
       return [];
     }
@@ -624,7 +628,7 @@ function useRelatedEntities(entity, { type, kind }) {
       });
     }));
     return results.flatMap((r) => r.items);
-  }, [entity, type]);
+  }, [entity, filterByTypeLower, filterByKindLower]);
   return {
     entities,
     loading,
@@ -670,10 +674,6 @@ function useStarredEntity(entityOrRef) {
   };
 }
 
-async function loadIdentityOwnerRefs(identityApi) {
-  const identity = await identityApi.getBackstageIdentity();
-  return identity.ownershipEntityRefs;
-}
 async function loadCatalogOwnerRefs(catalogApi, identityOwnerRefs) {
   const result = new Array();
   const primaryUserRef = identityOwnerRefs.find((ref) => ref.startsWith("user:"));
@@ -717,7 +717,8 @@ function useOwnedEntities(allowedKinds) {
   const identityApi = useApi(identityApiRef);
   const catalogApi = useApi(catalogApiRef);
   const { loading, value: refs } = useAsync(async () => {
-    const identityRefs = await loadIdentityOwnerRefs(identityApi);
+    const identity = await identityApi.getBackstageIdentity();
+    const identityRefs = identity.ownershipEntityRefs;
     const catalogRefs = await loadCatalogOwnerRefs(catalogApi, identityRefs);
     const catalogs = await catalogApi.getEntities(allowedKinds ? {
       filter: {
@@ -1225,11 +1226,32 @@ const FavoriteEntity = (props) => {
   }, favoriteEntityIcon(isStarredEntity)));
 };
 
-function EntityKindIcon(props) {
-  var _a;
+const DEFAULT_ICON = WorkIcon;
+function getKind(kind, entityRef) {
+  if (kind) {
+    return kind.toLocaleLowerCase("en-US");
+  }
+  if (entityRef) {
+    try {
+      return parseEntityRef(entityRef).kind.toLocaleLowerCase("en-US");
+    } catch {
+      return void 0;
+    }
+  }
+  return void 0;
+}
+function useIcon(kind, entityRef) {
   const app = useApp();
-  const { kind, ...otherProps } = props;
-  const Icon = (_a = app.getSystemIcon(`kind:${kind.toLocaleLowerCase("en-US")}`)) != null ? _a : WorkIcon;
+  const actualKind = getKind(kind, entityRef);
+  if (!actualKind) {
+    return DEFAULT_ICON;
+  }
+  const icon = app.getSystemIcon(`kind:${actualKind}`);
+  return icon || DEFAULT_ICON;
+}
+function EntityKindIcon(props) {
+  const { kind, entityRef, ...otherProps } = props;
+  const Icon = useIcon(kind, entityRef);
   return /* @__PURE__ */ React.createElement(Icon, {
     ...otherProps
   });
@@ -1567,7 +1589,7 @@ function OverviewPage(props) {
     relations = [],
     status = {}
   } = props.entity;
-  const groupedRelations = groupBy$1(sortBy(relations, (r) => stringifyEntityRef(r.target)), "type");
+  const groupedRelations = groupBy$1(sortBy(relations, (r) => r.targetRef), "type");
   return /* @__PURE__ */ React.createElement(React.Fragment, null, /* @__PURE__ */ React.createElement(DialogContentText, {
     variant: "h2"
   }, "Overview"), /* @__PURE__ */ React.createElement("div", {
@@ -1627,12 +1649,12 @@ function OverviewPage(props) {
     dense: true,
     subheader: /* @__PURE__ */ React.createElement(ListSubheader, null, type)
   }, groupRelations.map((group) => /* @__PURE__ */ React.createElement(ListItem, {
-    key: stringifyEntityRef(group.target)
+    key: group.targetRef
   }, /* @__PURE__ */ React.createElement(ListItemIcon, null, /* @__PURE__ */ React.createElement(EntityKindIcon, {
-    kind: group.target.kind
+    entityRef: group.targetRef
   })), /* @__PURE__ */ React.createElement(ListItemText, {
     primary: /* @__PURE__ */ React.createElement(EntityRefLink, {
-      entityRef: group.target
+      entityRef: group.targetRef
     })
   }))))))), !!((_b = status.items) == null ? void 0 : _b.length) && /* @__PURE__ */ React.createElement(Container, {
     title: "Status",
@@ -2130,5 +2152,5 @@ const MockEntityListContextProvider = ({
   }, children);
 };
 
-export { AsyncEntityProvider, DefaultStarredEntitiesApi, EntityKindFilter, EntityKindPicker, EntityLifecycleFilter, EntityLifecyclePicker, EntityListContext, EntityListProvider, EntityOwnerFilter, EntityOwnerPicker, EntityProvider, EntityRefLink, EntityRefLinks, EntitySearchBar, EntityTable, EntityTagFilter, EntityTagPicker, EntityTextFilter, EntityTypeFilter, EntityTypePicker, FavoriteEntity, InspectEntityDialog, MockEntityListContextProvider, UnregisterEntityDialog, UserListFilter, UserListPicker, catalogApiRef, catalogRouteRef, columnFactories, entityRoute, entityRouteParams, entityRouteRef, favoriteEntityIcon, favoriteEntityTooltip, formatEntityRefTitle, getEntityMetadataEditUrl, getEntityMetadataViewUrl, getEntityRelations, getEntitySourceLocation, isOwnerOf, loadCatalogOwnerRefs, loadIdentityOwnerRefs, reduceCatalogFilters, reduceEntityFilters, rootRoute, starredEntitiesApiRef, useEntity, useEntityCompoundName, useEntityFromUrl, useEntityKinds, useEntityList, useEntityListProvider, useEntityOwnership, useEntityPermission, useEntityTypeFilter, useOwnUser, useOwnedEntities, useRelatedEntities, useStarredEntities, useStarredEntity };
+export { AsyncEntityProvider, DefaultStarredEntitiesApi, EntityKindFilter, EntityKindPicker, EntityLifecycleFilter, EntityLifecyclePicker, EntityListContext, EntityListProvider, EntityOwnerFilter, EntityOwnerPicker, EntityProvider, EntityRefLink, EntityRefLinks, EntitySearchBar, EntityTable, EntityTagFilter, EntityTagPicker, EntityTextFilter, EntityTypeFilter, EntityTypePicker, FavoriteEntity, InspectEntityDialog, MockEntityListContextProvider, UnregisterEntityDialog, UserListFilter, UserListPicker, catalogApiRef, catalogRouteRef, columnFactories, entityRoute, entityRouteParams, entityRouteRef, favoriteEntityIcon, favoriteEntityTooltip, formatEntityRefTitle, getEntityMetadataEditUrl, getEntityMetadataViewUrl, getEntityRelations, getEntitySourceLocation, isOwnerOf, loadCatalogOwnerRefs, reduceCatalogFilters, reduceEntityFilters, rootRoute, starredEntitiesApiRef, useEntity, useEntityCompoundName, useEntityFromUrl, useEntityKinds, useEntityList, useEntityListProvider, useEntityOwnership, useEntityPermission, useEntityTypeFilter, useOwnUser, useOwnedEntities, useRelatedEntities, useStarredEntities, useStarredEntity };
 //# sourceMappingURL=index.esm.js.map