@backstage/plugin-catalog-react 0.6.9 → 0.6.12

package/CHANGELOG.md

@@ -1,5 +1,63 @@
 # @backstage/plugin-catalog-react
 
+## 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
+
+- fe2a6532ff: Add Override Components for Components in @backstage/plugin-catalog-react
+- 4ce51ab0f1: Internal refactor of the `react-use` imports to use `react-use/lib/*` instead.
+- Updated dependencies
+  - @backstage/core-plugin-api@0.4.1
+  - @backstage/core-components@0.8.3
+
 ## 0.6.9
 
 ### Patch Changes

package/dist/index.cjs.js

@@ -11,12 +11,17 @@ var React = require('react');
 var lab = require('@material-ui/lab');
 var versionBridge = require('@backstage/version-bridge');
 var reactRouter = require('react-router');
-var reactUse = require('react-use');
+var useAsyncRetry = require('react-use/lib/useAsyncRetry');
 var qs = require('qs');
+var useAsyncFn = require('react-use/lib/useAsyncFn');
+var useDebounce = require('react-use/lib/useDebounce');
+var useMountedState = require('react-use/lib/useMountedState');
+var useAsync = require('react-use/lib/useAsync');
 var isEqual = require('lodash/isEqual');
 var coreComponents = require('@backstage/core-components');
 var core = require('@material-ui/core');
-var jwtDecoder = require('jwt-decode');
+var useObservable = require('react-use/lib/useObservable');
+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');
@@ -33,9 +38,14 @@ function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'defau
 
 var ObservableImpl__default = /*#__PURE__*/_interopDefaultLegacy(ObservableImpl);
 var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
+var useAsyncRetry__default = /*#__PURE__*/_interopDefaultLegacy(useAsyncRetry);
 var qs__default = /*#__PURE__*/_interopDefaultLegacy(qs);
+var useAsyncFn__default = /*#__PURE__*/_interopDefaultLegacy(useAsyncFn);
+var useDebounce__default = /*#__PURE__*/_interopDefaultLegacy(useDebounce);
+var useMountedState__default = /*#__PURE__*/_interopDefaultLegacy(useMountedState);
+var useAsync__default = /*#__PURE__*/_interopDefaultLegacy(useAsync);
 var isEqual__default = /*#__PURE__*/_interopDefaultLegacy(isEqual);
-var jwtDecoder__default = /*#__PURE__*/_interopDefaultLegacy(jwtDecoder);
+var useObservable__default = /*#__PURE__*/_interopDefaultLegacy(useObservable);
 var CheckBoxIcon__default = /*#__PURE__*/_interopDefaultLegacy(CheckBoxIcon);
 var CheckBoxOutlineBlankIcon__default = /*#__PURE__*/_interopDefaultLegacy(CheckBoxOutlineBlankIcon);
 var ExpandMoreIcon__default = /*#__PURE__*/_interopDefaultLegacy(ExpandMoreIcon);
@@ -118,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 {
@@ -187,7 +197,7 @@ const useEntityFromUrl = () => {
     error,
     loading,
     retry: refresh
-  } = reactUse.useAsyncRetry(() => catalogApi.getEntityByName({ kind, namespace, name }), [catalogApi, kind, namespace, name]);
+  } = useAsyncRetry__default["default"](() => catalogApi.getEntityByName({ kind, namespace, name }), [catalogApi, kind, namespace, name]);
   React.useEffect(() => {
     if (!name) {
       errorApi.post(new Error("No name provided!"));
@@ -281,7 +291,7 @@ const EntityListContext = React.createContext(void 0);
 const EntityListProvider = ({
   children
 }) => {
-  const isMounted = reactUse.useMountedState();
+  const isMounted = useMountedState__default["default"]();
   const catalogApi = corePluginApi.useApi(catalogApiRef);
   const [requestedFilters, setRequestedFilters] = React.useState({});
   const [outputState, setOutputState] = React.useState(() => {
@@ -296,7 +306,7 @@ const EntityListProvider = ({
       queryParameters: (_a = query.filters) != null ? _a : {}
     };
   });
-  const [{ loading, error }, refresh] = reactUse.useAsyncFn(async () => {
+  const [{ loading, error }, refresh] = useAsyncFn__default["default"](async () => {
     var _a;
     const compacted = lodash.compact(Object.values(requestedFilters));
     const entityFilter = reduceEntityFilters(compacted);
@@ -336,7 +346,7 @@ const EntityListProvider = ({
       (_a = window.history) == null ? void 0 : _a.replaceState(null, document.title, newUrl);
     }
   }, [catalogApi, requestedFilters, outputState], { loading: true });
-  reactUse.useDebounce(refresh, 10, [requestedFilters]);
+  useDebounce__default["default"](refresh, 10, [requestedFilters]);
   const updateFilters = React.useCallback((update) => {
     setRequestedFilters((prevFilters) => {
       const newFilters = typeof update === "function" ? update(prevFilters) : update;
@@ -546,7 +556,7 @@ function useEntityTypeFilter() {
     error,
     loading,
     value: entities
-  } = reactUse.useAsync(async () => {
+  } = useAsync__default["default"](async () => {
     if (kind) {
       const items = await catalogApi.getEntities({
         filter: { kind },
@@ -603,7 +613,7 @@ function useEntityKinds() {
     error,
     loading,
     value: kinds
-  } = reactUse.useAsync(async () => {
+  } = useAsync__default["default"](async () => {
     const entities = await catalogApi.getEntities({ fields: ["kind"] }).then((response) => response.items);
     return [...new Set(entities.map((e) => e.kind))].sort();
   });
@@ -613,11 +623,13 @@ function useEntityKinds() {
 function useOwnUser() {
   const catalogApi = corePluginApi.useApi(catalogApiRef);
   const identityApi = corePluginApi.useApi(corePluginApi.identityApiRef);
-  return reactUse.useAsync(() => 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;
@@ -627,7 +639,7 @@ function useRelatedEntities(entity, { type, kind }) {
     loading,
     value: entities,
     error
-  } = reactUse.useAsync(async () => {
+  } = useAsync__default["default"](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")));
     if (!relations) {
       return [];
@@ -668,7 +680,7 @@ function getEntityRef$1(entityOrRef) {
 }
 function useStarredEntities() {
   const starredEntitiesApi = corePluginApi.useApi(starredEntitiesApiRef);
-  const starredEntities = reactUse.useObservable(starredEntitiesApi.starredEntitie$(), /* @__PURE__ */ new Set());
+  const starredEntities = useObservable__default["default"](starredEntitiesApi.starredEntitie$(), /* @__PURE__ */ new Set());
   const isStarredEntity = React.useCallback((entityOrRef) => starredEntities.has(getEntityRef$1(entityOrRef)), [starredEntities]);
   const toggleStarredEntity = React.useCallback((entityOrRef) => starredEntitiesApi.toggleStarred(getEntityRef$1(entityOrRef)).then(), [starredEntitiesApi]);
   return {
@@ -701,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();
@@ -749,10 +736,10 @@ async function loadCatalogOwnerRefs(catalogApi, identityOwnerRefs) {
 function useEntityOwnership() {
   const identityApi = corePluginApi.useApi(corePluginApi.identityApiRef);
   const catalogApi = corePluginApi.useApi(catalogApiRef);
-  const { loading, value: refs } = reactUse.useAsync(async () => {
-    const identityRefs = await loadIdentityOwnerRefs(identityApi);
-    const catalogRefs = await loadCatalogOwnerRefs(catalogApi, identityRefs);
-    return /* @__PURE__ */ new Set([...identityRefs, ...catalogRefs]);
+  const { loading, value: refs } = useAsync__default["default"](async () => {
+    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 : []);
@@ -772,7 +759,7 @@ function useEntityOwnership() {
 function useOwnedEntities(allowedKinds) {
   const identityApi = corePluginApi.useApi(corePluginApi.identityApiRef);
   const catalogApi = corePluginApi.useApi(catalogApiRef);
-  const { loading, value: refs } = reactUse.useAsync(async () => {
+  const { loading, value: refs } = useAsync__default["default"](async () => {
     const identityRefs = await loadIdentityOwnerRefs(identityApi);
     const catalogRefs = await loadCatalogOwnerRefs(catalogApi, identityRefs);
     const catalogs = await catalogApi.getEntities(allowedKinds ? {
@@ -793,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
@@ -945,7 +948,7 @@ const EntitySearchBar = () => {
   const classes = useStyles$4();
   const { filters, updateFilters } = useEntityListProvider();
   const [search, setSearch] = React.useState((_b = (_a = filters.text) == null ? void 0 : _a.value) != null ? _b : "");
-  reactUse.useDebounce(() => {
+  useDebounce__default["default"](() => {
     updateFilters({
       text: search.length ? new EntityTextFilter(search) : void 0
     });
@@ -1268,7 +1271,7 @@ function useUnregisterEntityDialogState(entity) {
   const locationRef = (_a = entity.metadata.annotations) == null ? void 0 : _a[catalogModel.ORIGIN_LOCATION_ANNOTATION];
   const uid = entity.metadata.uid;
   const isBootstrap = locationRef === "bootstrap:bootstrap";
-  const prerequisites = reactUse.useAsync(async () => {
+  const prerequisites = useAsync__default["default"](async () => {
     const locationPromise = catalogApi.getOriginLocationByEntity(entity);
     let colocatedEntitiesPromise;
     if (!locationRef) {
@@ -1662,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;