@backstage/plugin-catalog-react 0.6.10 → 0.6.13-next.0

package/CHANGELOG.md

@@ -1,5 +1,60 @@
 # @backstage/plugin-catalog-react
 
+## 0.6.13-next.0
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/core-components@0.8.7-next.0
+
+## 0.6.12
+
+### Patch Changes
+
+- 3d87019269: The `entityRouteRef` is now a well-known route that should be imported directly from `@backstage/plugin-catalog-react`. It is guaranteed to be globally unique across duplicate installations of the `@backstage/plugin-catalog-react`, starting at this version.
+
+  Deprecated `entityRoute` in favor of `entityRouteRef`.
+
+  Deprecated `rootRoute` and `catalogRouteRef`. If you want to refer to the catalog index page from a public plugin you now need to use an `ExternalRouteRef` instead. For private plugins it is possible to take the shortcut of referring directly to `catalogPlugin.routes.indexPage` instead.
+
+- 2916a83b9c: Deprecated `loadIdentityOwnerRefs`, since they can now be retrieved as `ownershipEntityRefs` from `identityApi.getBackstageIdentity()` instead.
+- 51fbedc445: Migrated usage of deprecated `IdentityApi` methods.
+- c54c0d9d10: Add useEntityPermission hook
+- Updated dependencies
+  - @backstage/plugin-permission-react@0.3.0
+  - @backstage/core-components@0.8.5
+  - @backstage/integration@0.7.2
+  - @backstage/plugin-permission-common@0.4.0
+  - @backstage/core-plugin-api@0.6.0
+  - @backstage/catalog-model@0.9.10
+  - @backstage/catalog-client@0.5.5
+
+## 0.6.12-next.0
+
+### Patch Changes
+
+- 2916a83b9c: Deprecated `loadIdentityOwnerRefs`, since they can now be retrieved as `ownershipEntityRefs` from `identityApi.getBackstageIdentity()` instead.
+- 51fbedc445: Migrated usage of deprecated `IdentityApi` methods.
+- Updated dependencies
+  - @backstage/core-components@0.8.5-next.0
+  - @backstage/core-plugin-api@0.6.0-next.0
+  - @backstage/catalog-model@0.9.10-next.0
+  - @backstage/catalog-client@0.5.5-next.0
+  - @backstage/integration@0.7.2-next.0
+
+## 0.6.11
+
+### Patch Changes
+
+- 5333451def: Cleaned up API exports
+- Updated dependencies
+  - @backstage/integration@0.7.1
+  - @backstage/core-components@0.8.4
+  - @backstage/core-plugin-api@0.5.0
+  - @backstage/errors@0.2.0
+  - @backstage/catalog-client@0.5.4
+  - @backstage/catalog-model@0.9.9
+
 ## 0.6.10
 
 ### Patch Changes

package/dist/index.cjs.js

@@ -21,7 +21,7 @@ var isEqual = require('lodash/isEqual');
 var coreComponents = require('@backstage/core-components');
 var core = require('@material-ui/core');
 var useObservable = require('react-use/lib/useObservable');
-var jwtDecoder = require('jwt-decode');
+var pluginPermissionReact = require('@backstage/plugin-permission-react');
 var CheckBoxIcon = require('@material-ui/icons/CheckBox');
 var CheckBoxOutlineBlankIcon = require('@material-ui/icons/CheckBoxOutlineBlank');
 var ExpandMoreIcon = require('@material-ui/icons/ExpandMore');
@@ -46,7 +46,6 @@ var useMountedState__default = /*#__PURE__*/_interopDefaultLegacy(useMountedStat
 var useAsync__default = /*#__PURE__*/_interopDefaultLegacy(useAsync);
 var isEqual__default = /*#__PURE__*/_interopDefaultLegacy(isEqual);
 var useObservable__default = /*#__PURE__*/_interopDefaultLegacy(useObservable);
-var jwtDecoder__default = /*#__PURE__*/_interopDefaultLegacy(jwtDecoder);
 var CheckBoxIcon__default = /*#__PURE__*/_interopDefaultLegacy(CheckBoxIcon);
 var CheckBoxOutlineBlankIcon__default = /*#__PURE__*/_interopDefaultLegacy(CheckBoxOutlineBlankIcon);
 var ExpandMoreIcon__default = /*#__PURE__*/_interopDefaultLegacy(ExpandMoreIcon);
@@ -129,11 +128,11 @@ const rootRoute = corePluginApi.createRouteRef({
   id: "catalog"
 });
 const catalogRouteRef = rootRoute;
-const entityRoute = corePluginApi.createRouteRef({
+const entityRouteRef = versionBridge.getOrCreateGlobalSingleton("catalog:entity-route-ref", () => corePluginApi.createRouteRef({
   id: "catalog:entity",
   params: ["namespace", "kind", "name"]
-});
-const entityRouteRef = entityRoute;
+}));
+const entityRoute = entityRouteRef;
 function entityRouteParams(entity) {
   var _a, _b;
   return {
@@ -624,11 +623,13 @@ function useEntityKinds() {
 function useOwnUser() {
   const catalogApi = corePluginApi.useApi(catalogApiRef);
   const identityApi = corePluginApi.useApi(corePluginApi.identityApiRef);
-  return useAsync__default["default"](() => catalogApi.getEntityByName({
-    kind: "User",
-    namespace: "default",
-    name: identityApi.getUserId()
-  }), [catalogApi, identityApi]);
+  return useAsync__default["default"](async () => {
+    const identity = await identityApi.getBackstageIdentity();
+    return catalogApi.getEntityByName(catalogModel.parseEntityRef(identity.userEntityRef, {
+      defaultKind: "User",
+      defaultNamespace: catalogModel.ENTITY_DEFAULT_NAMESPACE
+    }));
+  }, [catalogApi, identityApi]);
 }
 
 const BATCH_SIZE = 20;
@@ -712,34 +713,9 @@ function useStarredEntity(entityOrRef) {
   };
 }
 
-function extendUserId(id) {
-  try {
-    const ref = catalogModel.parseEntityRef(id, {
-      defaultKind: "User",
-      defaultNamespace: "default"
-    });
-    return catalogModel.stringifyEntityRef(ref);
-  } catch {
-    return id;
-  }
-}
 async function loadIdentityOwnerRefs(identityApi) {
-  const id = identityApi.getUserId();
-  const token = await identityApi.getIdToken();
-  const result = [];
-  if (id) {
-    result.push(extendUserId(id));
-  }
-  if (token) {
-    try {
-      const decoded = jwtDecoder__default["default"](token);
-      if (decoded == null ? void 0 : decoded.ent) {
-        [decoded.ent].flat().filter((x) => typeof x === "string").map((x) => x.toLocaleLowerCase("en-US")).forEach((x) => result.push(x));
-      }
-    } catch {
-    }
-  }
-  return result;
+  const identity = await identityApi.getBackstageIdentity();
+  return identity.ownershipEntityRefs;
 }
 async function loadCatalogOwnerRefs(catalogApi, identityOwnerRefs) {
   const result = new Array();
@@ -761,9 +737,9 @@ function useEntityOwnership() {
   const identityApi = corePluginApi.useApi(corePluginApi.identityApiRef);
   const catalogApi = corePluginApi.useApi(catalogApiRef);
   const { loading, value: refs } = useAsync__default["default"](async () => {
-    const identityRefs = await loadIdentityOwnerRefs(identityApi);
-    const catalogRefs = await loadCatalogOwnerRefs(catalogApi, identityRefs);
-    return /* @__PURE__ */ new Set([...identityRefs, ...catalogRefs]);
+    const { ownershipEntityRefs } = await identityApi.getBackstageIdentity();
+    const catalogRefs = await loadCatalogOwnerRefs(catalogApi, ownershipEntityRefs);
+    return /* @__PURE__ */ new Set([...ownershipEntityRefs, ...catalogRefs]);
   }, []);
   const isOwnedEntity = React.useMemo(() => {
     const myOwnerRefs = new Set(refs != null ? refs : []);
@@ -804,6 +780,22 @@ function useOwnedEntities(allowedKinds) {
   return React.useMemo(() => ({ loading, ownedEntities }), [loading, ownedEntities]);
 }
 
+function useEntityPermission(permission) {
+  const { entity, loading: loadingEntity, error: entityError } = useEntity();
+  const {
+    allowed,
+    loading: loadingPermission,
+    error: permissionError
+  } = pluginPermissionReact.usePermission(permission, entity ? catalogModel.stringifyEntityRef(entity) : void 0);
+  if (loadingEntity || loadingPermission) {
+    return { loading: true, allowed: false };
+  }
+  if (entityError) {
+    return { loading: false, allowed: false, error: entityError };
+  }
+  return { loading: false, allowed, error: permissionError };
+}
+
 const EntityKindPicker = ({
   initialFilter,
   hidden
@@ -1673,6 +1665,7 @@ exports.useEntityFromUrl = useEntityFromUrl;
 exports.useEntityKinds = useEntityKinds;
 exports.useEntityListProvider = useEntityListProvider;
 exports.useEntityOwnership = useEntityOwnership;
+exports.useEntityPermission = useEntityPermission;
 exports.useEntityTypeFilter = useEntityTypeFilter;
 exports.useOwnUser = useOwnUser;
 exports.useOwnedEntities = useOwnedEntities;