@backstage/plugin-catalog-react 0.6.14 → 0.6.15

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @backstage/plugin-catalog-react
 
+## 0.6.15
+
+### Patch Changes
+
+- 1ed305728b: Bump `node-fetch` to version 2.6.7 and `cross-fetch` to version 3.1.5
+- c77c5c7eb6: Added `backstage.role` to `package.json`
+- 538ca90790: Use updated type names from `@backstage/catalog-client`
+- edbc03814a: Replace usage of `serializeEntityRef` with `stringifyEntityRef`
+- 244d24ebc4: Import `Location` from the `@backstage/catalog-client` package.
+- deaf6065db: Adapt to the new `CatalogApi.getLocationByRef`
+- 216725b434: Updated to use new names for `parseLocationRef` and `stringifyLocationRef`
+- e72d371296: Use `TemplateEntityV1beta2` from `@backstage/plugin-scaffolder-common` instead
+  of `@backstage/catalog-model`.
+- 98d1aa1ea1: Fix CatalogPage showing all components when owned filter was pre-selected
+- 27eccab216: Replaces use of deprecated catalog-model constants.
+- 7aeb491394: Replace use of deprecated `ENTITY_DEFAULT_NAMESPACE` constant with `DEFAULT_NAMESPACE`.
+- Updated dependencies
+  - @backstage/catalog-client@0.7.0
+  - @backstage/core-components@0.8.9
+  - @backstage/core-plugin-api@0.6.1
+  - @backstage/errors@0.2.1
+  - @backstage/integration@0.7.3
+  - @backstage/plugin-permission-common@0.5.0
+  - @backstage/plugin-permission-react@0.3.1
+  - @backstage/catalog-model@0.10.0
+  - @backstage/types@0.1.2
+  - @backstage/version-bridge@0.1.2
+
 ## 0.6.14
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import { CatalogApi, CatalogListResponse } from '@backstage/catalog-client';
+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';
@@ -516,11 +516,10 @@ declare function useEntityOwnership(): {
  * @public
  *
  * @param allowedKinds - Array of allowed kinds to filter the entities
- * @returns CatalogListResponse<Entity>
  */
 declare function useOwnedEntities(allowedKinds?: string[]): {
     loading: boolean;
-    ownedEntities: CatalogListResponse<Entity> | undefined;
+    ownedEntities: GetEntitiesResponse | undefined;
 };
 
 /**

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, ENTITY_DEFAULT_NAMESPACE, VIEW_URL_ANNOTATION, EDIT_URL_ANNOTATION, SOURCE_LOCATION_ANNOTATION, parseLocationReference, RELATION_MEMBER_OF, getEntityName, RELATION_OWNED_BY, serializeEntityRef, parseEntityRef, RELATION_PART_OF, LOCATION_ANNOTATION, ORIGIN_LOCATION_ANNOTATION } from '@backstage/catalog-model';
+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 { isArray, isString, compact, isEqual, groupBy, chunk } from 'lodash';
 import React, { createContext, useEffect, useState, useMemo, useCallback, useContext, forwardRef, useRef, useLayoutEffect, Fragment } from 'react';
 import { Alert, Autocomplete } from '@material-ui/lab';
@@ -117,7 +117,7 @@ function entityRouteParams(entity) {
   var _a, _b;
   return {
     kind: entity.kind.toLocaleLowerCase("en-US"),
-    namespace: (_b = (_a = entity.metadata.namespace) == null ? void 0 : _a.toLocaleLowerCase("en-US")) != null ? _b : ENTITY_DEFAULT_NAMESPACE,
+    namespace: (_b = (_a = entity.metadata.namespace) == null ? void 0 : _a.toLocaleLowerCase("en-US")) != null ? _b : DEFAULT_NAMESPACE,
     name: entity.metadata.name
   };
 }
@@ -219,11 +219,11 @@ function reduceEntityFilters(filters) {
 
 function getEntityMetadataViewUrl(entity) {
   var _a;
-  return (_a = entity.metadata.annotations) == null ? void 0 : _a[VIEW_URL_ANNOTATION];
+  return (_a = entity.metadata.annotations) == null ? void 0 : _a[ANNOTATION_VIEW_URL];
 }
 function getEntityMetadataEditUrl(entity) {
   var _a;
-  return (_a = entity.metadata.annotations) == null ? void 0 : _a[EDIT_URL_ANNOTATION];
+  return (_a = entity.metadata.annotations) == null ? void 0 : _a[ANNOTATION_EDIT_URL];
 }
 
 function getEntityRelations(entity, relationType, filter) {
@@ -237,12 +237,12 @@ function getEntityRelations(entity, relationType, filter) {
 
 function getEntitySourceLocation(entity, scmIntegrationsApi) {
   var _a;
-  const sourceLocation = (_a = entity.metadata.annotations) == null ? void 0 : _a[SOURCE_LOCATION_ANNOTATION];
+  const sourceLocation = (_a = entity.metadata.annotations) == null ? void 0 : _a[ANNOTATION_SOURCE_LOCATION];
   if (!sourceLocation) {
     return void 0;
   }
   try {
-    const sourceLocationRef = parseLocationReference(sourceLocation);
+    const sourceLocationRef = parseLocationRef(sourceLocation);
     const integration = scmIntegrationsApi.byUrl(sourceLocationRef.target);
     return {
       locationTargetUrl: sourceLocationRef.target,
@@ -367,15 +367,12 @@ function formatEntityRefTitle(entityRef, opts) {
     namespace = entityRef.namespace;
     name = entityRef.name;
   }
-  if (namespace === ENTITY_DEFAULT_NAMESPACE) {
+  if (namespace === DEFAULT_NAMESPACE) {
     namespace = void 0;
   }
   kind = kind.toLocaleLowerCase("en-US");
-  return `${serializeEntityRef({
-    kind: defaultKind && defaultKind.toLocaleLowerCase("en-US") === kind ? void 0 : kind,
-    name,
-    namespace
-  })}`;
+  kind = defaultKind && defaultKind.toLocaleLowerCase("en-US") === kind ? void 0 : kind;
+  return `${kind ? `${kind}:` : ""}${namespace ? `${namespace}/` : ""}${name}`;
 }
 
 const EntityRefLink = forwardRef((props, ref) => {
@@ -397,7 +394,7 @@ const EntityRefLink = forwardRef((props, ref) => {
   kind = kind.toLocaleLowerCase("en-US");
   const routeParams = {
     kind,
-    namespace: (_a = namespace == null ? void 0 : namespace.toLocaleLowerCase("en-US")) != null ? _a : ENTITY_DEFAULT_NAMESPACE,
+    namespace: (_a = namespace == null ? void 0 : namespace.toLocaleLowerCase("en-US")) != null ? _a : DEFAULT_NAMESPACE,
     name
   };
   const formattedEntityRefTitle = formatEntityRefTitle(entityRef, {
@@ -612,7 +609,7 @@ function useOwnUser() {
     const identity = await identityApi.getBackstageIdentity();
     return catalogApi.getEntityByName(parseEntityRef(identity.userEntityRef, {
       defaultKind: "User",
-      defaultNamespace: ENTITY_DEFAULT_NAMESPACE
+      defaultNamespace: DEFAULT_NAMESPACE
     }));
   }, [catalogApi, identityApi]);
 }
@@ -1357,7 +1354,7 @@ function CustomNode({ node }) {
   const onClick = () => {
     navigate(entityRoute({
       kind: node.kind,
-      namespace: node.metadata.namespace || ENTITY_DEFAULT_NAMESPACE,
+      namespace: node.metadata.namespace || DEFAULT_NAMESPACE,
       name: node.metadata.name
     }));
   };
@@ -1482,16 +1479,16 @@ function useColocated(entity) {
   var _a, _b;
   const catalogApi = useApi(catalogApiRef);
   const currentEntityRef = stringifyEntityRef(entity);
-  const location = (_a = entity.metadata.annotations) == null ? void 0 : _a[LOCATION_ANNOTATION];
-  const origin = (_b = entity.metadata.annotations) == null ? void 0 : _b[ORIGIN_LOCATION_ANNOTATION];
+  const location = (_a = entity.metadata.annotations) == null ? void 0 : _a[ANNOTATION_LOCATION];
+  const origin = (_b = entity.metadata.annotations) == null ? void 0 : _b[ANNOTATION_ORIGIN_LOCATION];
   const { loading, error, value } = useAsync(async () => {
     if (!location && !origin) {
       return [];
     }
     const response = await catalogApi.getEntities({
       filter: [
-        ...location ? [{ [`metadata.annotations.${LOCATION_ANNOTATION}`]: location }] : [],
-        ...origin ? [{ [`metadata.annotations.${ORIGIN_LOCATION_ANNOTATION}`]: origin }] : []
+        ...location ? [{ [`metadata.annotations.${ANNOTATION_LOCATION}`]: location }] : [],
+        ...origin ? [{ [`metadata.annotations.${ANNOTATION_ORIGIN_LOCATION}`]: origin }] : []
       ]
     });
     return response.items;
@@ -1546,11 +1543,11 @@ function Contents$1(props) {
   }
   const atLocation = colocatedEntities.filter((e) => {
     var _a;
-    return ((_a = e.metadata.annotations) == null ? void 0 : _a[LOCATION_ANNOTATION]) === location;
+    return ((_a = e.metadata.annotations) == null ? void 0 : _a[ANNOTATION_LOCATION]) === location;
   });
   const atOrigin = colocatedEntities.filter((e) => {
     var _a;
-    return ((_a = e.metadata.annotations) == null ? void 0 : _a[ORIGIN_LOCATION_ANNOTATION]) === originLocation;
+    return ((_a = e.metadata.annotations) == null ? void 0 : _a[ANNOTATION_ORIGIN_LOCATION]) === originLocation;
   });
   return /* @__PURE__ */ React.createElement(React.Fragment, null, atLocation.length > 0 && /* @__PURE__ */ React.createElement(EntityList, {
     entities: atLocation,
@@ -1813,16 +1810,16 @@ function InspectEntityDialog(props) {
 function useUnregisterEntityDialogState(entity) {
   var _a;
   const catalogApi = useApi(catalogApiRef);
-  const locationRef = (_a = entity.metadata.annotations) == null ? void 0 : _a[ORIGIN_LOCATION_ANNOTATION];
+  const locationRef = (_a = entity.metadata.annotations) == null ? void 0 : _a[ANNOTATION_ORIGIN_LOCATION];
   const uid = entity.metadata.uid;
   const isBootstrap = locationRef === "bootstrap:bootstrap";
   const prerequisites = useAsync(async () => {
-    const locationPromise = catalogApi.getOriginLocationByEntity(entity);
+    const locationPromise = catalogApi.getLocationByRef(locationRef);
     let colocatedEntitiesPromise;
     if (!locationRef) {
       colocatedEntitiesPromise = Promise.resolve([]);
     } else {
-      const locationAnnotationFilter = `metadata.annotations.${ORIGIN_LOCATION_ANNOTATION}`;
+      const locationAnnotationFilter = `metadata.annotations.${ANNOTATION_ORIGIN_LOCATION}`;
       colocatedEntitiesPromise = catalogApi.getEntities({
         filter: { [locationAnnotationFilter]: locationRef },
         fields: [
@@ -2065,14 +2062,21 @@ const UserListPicker = ({
   const classes = useStyles();
   const configApi = useApi(configApiRef);
   const orgName = (_a = configApi.getOptionalString("organization.name")) != null ? _a : "Company";
-  const { filters, updateFilters, backendEntities, queryParameters, loading } = useEntityListProvider();
+  const {
+    filters,
+    updateFilters,
+    backendEntities,
+    queryParameters,
+    loading: loadingBackendEntities
+  } = useEntityListProvider();
   const userAndGroupFilterIds = ["starred", "all"];
   const filterGroups = getFilterGroups(orgName).map((filterGroup) => ({
     ...filterGroup,
     items: filterGroup.items.filter(({ id }) => ["group", "user"].some((kind) => kind === queryParameters.kind) ? userAndGroupFilterIds.includes(id) : !availableFilters || availableFilters.includes(id))
   })).filter(({ items }) => !!items.length);
   const { isStarredEntity } = useStarredEntities();
-  const { isOwnedEntity } = useEntityOwnership();
+  const { isOwnedEntity, loading: loadingEntityOwnership } = useEntityOwnership();
+  const loading = loadingBackendEntities || loadingEntityOwnership;
   const ownedFilter = useMemo(() => new UserListFilter("owned", isOwnedEntity, isStarredEntity), [isOwnedEntity, isStarredEntity]);
   const starredFilter = useMemo(() => new UserListFilter("starred", isOwnedEntity, isStarredEntity), [isOwnedEntity, isStarredEntity]);
   const queryParamUserFilter = useMemo(() => [queryParameters.user].flat()[0], [queryParameters]);