@backstage/plugin-catalog-react 0.6.7 → 0.6.11

package/CHANGELOG.md

@@ -1,5 +1,48 @@
 # @backstage/plugin-catalog-react
 
+## 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
+
+- c6fdddec77: When a user has zero owned entities when viewing an entity kind in the catalog
+  page, it will be automatically redirected to see all the entities. Furthermore,
+  for the kind User and Group there are no longer the owned selector.
+- Updated dependencies
+  - @backstage/integration@0.7.0
+
+## 0.6.8
+
+### Patch Changes
+
+- 3491a36ab9: added useOwnedEntities hook to get the list of entities of the logged-in user
+- Updated dependencies
+  - @backstage/core-plugin-api@0.4.0
+  - @backstage/core-components@0.8.2
+  - @backstage/catalog-client@0.5.3
+
 ## 0.6.7
 
 ### Patch Changes

package/dist/index.cjs.js

@@ -11,11 +11,16 @@ 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 useObservable = require('react-use/lib/useObservable');
 var jwtDecoder = require('jwt-decode');
 var CheckBoxIcon = require('@material-ui/icons/CheckBox');
 var CheckBoxOutlineBlankIcon = require('@material-ui/icons/CheckBoxOutlineBlank');
@@ -33,8 +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 useObservable__default = /*#__PURE__*/_interopDefaultLegacy(useObservable);
 var jwtDecoder__default = /*#__PURE__*/_interopDefaultLegacy(jwtDecoder);
 var CheckBoxIcon__default = /*#__PURE__*/_interopDefaultLegacy(CheckBoxIcon);
 var CheckBoxOutlineBlankIcon__default = /*#__PURE__*/_interopDefaultLegacy(CheckBoxOutlineBlankIcon);
@@ -187,7 +198,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 +292,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 +307,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 +347,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 +557,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 +614,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,7 +624,7 @@ function useEntityKinds() {
 function useOwnUser() {
   const catalogApi = corePluginApi.useApi(catalogApiRef);
   const identityApi = corePluginApi.useApi(corePluginApi.identityApiRef);
-  return reactUse.useAsync(() => catalogApi.getEntityByName({
+  return useAsync__default["default"](() => catalogApi.getEntityByName({
     kind: "User",
     namespace: "default",
     name: identityApi.getUserId()
@@ -627,7 +638,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 +679,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 {
@@ -749,7 +760,7 @@ 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 { loading, value: refs } = useAsync__default["default"](async () => {
     const identityRefs = await loadIdentityOwnerRefs(identityApi);
     const catalogRefs = await loadCatalogOwnerRefs(catalogApi, identityRefs);
     return /* @__PURE__ */ new Set([...identityRefs, ...catalogRefs]);
@@ -769,6 +780,30 @@ function useEntityOwnership() {
   return React.useMemo(() => ({ loading, isOwnedEntity }), [loading, isOwnedEntity]);
 }
 
+function useOwnedEntities(allowedKinds) {
+  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);
+    const catalogs = await catalogApi.getEntities(allowedKinds ? {
+      filter: {
+        kind: allowedKinds,
+        [`relations.${catalogModel.RELATION_OWNED_BY}`]: [...identityRefs, ...catalogRefs]
+      }
+    } : {
+      filter: {
+        [`relations.${catalogModel.RELATION_OWNED_BY}`]: [...identityRefs, ...catalogRefs]
+      }
+    });
+    return catalogs;
+  }, []);
+  const ownedEntities = React.useMemo(() => {
+    return refs;
+  }, [refs]);
+  return React.useMemo(() => ({ loading, ownedEntities }), [loading, ownedEntities]);
+}
+
 const EntityKindPicker = ({
   initialFilter,
   hidden
@@ -921,7 +956,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
     });
@@ -1244,7 +1279,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) {
@@ -1493,22 +1528,24 @@ const UserListPicker = ({
   const classes = useStyles();
   const configApi = corePluginApi.useApi(corePluginApi.configApiRef);
   const orgName = (_a = configApi.getOptionalString("organization.name")) != null ? _a : "Company";
+  const { filters, updateFilters, backendEntities, queryParameters } = useEntityListProvider();
+  const userAndGroupFilterIds = ["starred", "all"];
   const filterGroups = getFilterGroups(orgName).map((filterGroup) => ({
     ...filterGroup,
-    items: filterGroup.items.filter(({ id }) => !availableFilters || availableFilters.includes(id))
+    items: filterGroup.items.filter(({ id }) => ["group", "user"].some((kind) => kind === queryParameters.kind) ? userAndGroupFilterIds.includes(id) : !availableFilters || availableFilters.includes(id))
   })).filter(({ items }) => !!items.length);
-  const { filters, updateFilters, backendEntities, queryParameters } = useEntityListProvider();
   const { isStarredEntity } = useStarredEntities();
   const { isOwnedEntity } = useEntityOwnership();
-  const [selectedUserFilter, setSelectedUserFilter] = React.useState((_b = [queryParameters.user].flat()[0]) != null ? _b : initialFilter);
   const ownedFilter = React.useMemo(() => new UserListFilter("owned", isOwnedEntity, isStarredEntity), [isOwnedEntity, isStarredEntity]);
   const starredFilter = React.useMemo(() => new UserListFilter("starred", isOwnedEntity, isStarredEntity), [isOwnedEntity, isStarredEntity]);
+  const [entitiesWithoutUserFilter, setEntitiesWithoutUserFilter] = React.useState(backendEntities);
+  const totalOwnedUserEntities = entitiesWithoutUserFilter.filter((entity) => ownedFilter.filterEntity(entity)).length;
+  const [selectedUserFilter, setSelectedUserFilter] = React.useState(totalOwnedUserEntities > 0 ? (_b = [queryParameters.user].flat()[0]) != null ? _b : initialFilter : "all");
   React.useEffect(() => {
     updateFilters({
       user: selectedUserFilter ? new UserListFilter(selectedUserFilter, isOwnedEntity, isStarredEntity) : void 0
     });
   }, [selectedUserFilter, isOwnedEntity, isStarredEntity, updateFilters]);
-  const [entitiesWithoutUserFilter, setEntitiesWithoutUserFilter] = React.useState(backendEntities);
   React.useEffect(() => {
     const filterFn = reduceEntityFilters(lodash.compact(Object.values({ ...filters, user: void 0 })));
     setEntitiesWithoutUserFilter(backendEntities.filter(filterFn));
@@ -1516,7 +1553,7 @@ const UserListPicker = ({
   function getFilterCount(id) {
     switch (id) {
       case "owned":
-        return entitiesWithoutUserFilter.filter((entity) => ownedFilter.filterEntity(entity)).length;
+        return totalOwnedUserEntities;
       case "starred":
         return entitiesWithoutUserFilter.filter((entity) => starredFilter.filterEntity(entity)).length;
       default:
@@ -1638,6 +1675,7 @@ exports.useEntityListProvider = useEntityListProvider;
 exports.useEntityOwnership = useEntityOwnership;
 exports.useEntityTypeFilter = useEntityTypeFilter;
 exports.useOwnUser = useOwnUser;
+exports.useOwnedEntities = useOwnedEntities;
 exports.useRelatedEntities = useRelatedEntities;
 exports.useStarredEntities = useStarredEntities;
 exports.useStarredEntity = useStarredEntity;