@backstage/plugin-catalog 0.6.17 → 0.7.3

package/CHANGELOG.md

@@ -1,5 +1,75 @@
 # @backstage/plugin-catalog
 
+## 0.7.3
+
+### Patch Changes
+
+- 38d6df6bb9: Remove the "View Api" icon in the AboutCard, as the information is misleading for some users and is
+  duplicated in the tabs above.
+- a125278b81: Refactor out the deprecated path and icon from RouteRefs
+- Updated dependencies
+  - @backstage/catalog-client@0.5.2
+  - @backstage/catalog-model@0.9.7
+  - @backstage/plugin-catalog-react@0.6.4
+  - @backstage/core-components@0.7.4
+  - @backstage/core-plugin-api@0.2.0
+  - @backstage/integration-react@0.1.14
+
+## 0.7.2
+
+### Patch Changes
+
+- 36e67d2f24: Internal updates to apply more strict checks to throw errors.
+- Updated dependencies
+  - @backstage/core-components@0.7.1
+  - @backstage/errors@0.1.3
+  - @backstage/core-plugin-api@0.1.11
+  - @backstage/plugin-catalog-react@0.6.1
+  - @backstage/catalog-model@0.9.5
+
+## 0.7.1
+
+### Patch Changes
+
+- 82fbda923e: Introduce a new `StarredEntitiesApi` that is used in the `useStarredEntities` hook.
+  The `@backstage/plugin-catalog` installs a default implementation that is backed by the `StorageApi`, but one can also override the `starredEntitiesApiRef`.
+
+  This change also updates the storage format from a custom string to an entity reference and moves the location in the local storage.
+  A migration will convert the previously starred entities to the location on the first load of Backstage.
+
+- 93a13dfb42: Support `material-ui` overrides in SystemDiagramCard and EmptityLinksEmptyState components
+- b03b9f19e0: added sorting in entity `Name` column by `metadata.title` if present
+- Updated dependencies
+  - @backstage/plugin-catalog-react@0.6.0
+  - @backstage/core-components@0.7.0
+  - @backstage/theme@0.2.11
+  - @backstage/integration-react@0.1.12
+
+## 0.7.0
+
+### Minor Changes
+
+- bb0f6b8a0f: Updates the `<EntitySwitch if={asyncMethod}/>` to accept asynchronous `if` functions.
+
+  Adds the new `getEntityAncestors` method to `CatalogClient`.
+
+  Updates the `<EntityProcessingErrorsPanel />` to make use of the ancestry endpoint to display errors for entities further up the ancestry tree. This makes it easier to discover issues where for example the origin location has been removed or malformed.
+
+  `hasCatalogProcessingErrors()` is now changed to be asynchronous so any calls outside the already established entitySwitch need to be awaited.
+
+### Patch Changes
+
+- 5aae9bb61e: Name column will now render entity `metadata.title` if its present
+- 1c5c5b23fb: Replace deprecated material UI components used by LinksCard to remove errors from console log
+- ca0559444c: Avoid usage of `.to*Case()`, preferring `.toLocale*Case('en-US')` instead.
+- 81a41ec249: Added a `name` key to all extensions in order to improve Analytics API metadata.
+- Updated dependencies
+  - @backstage/core-components@0.6.1
+  - @backstage/core-plugin-api@0.1.10
+  - @backstage/plugin-catalog-react@0.5.2
+  - @backstage/catalog-model@0.9.4
+  - @backstage/catalog-client@0.5.0
+
 ## 0.6.17
 
 ### Patch Changes

package/dist/esm/{index-6a9a7783.esm.js → index-0e602309.esm.js}

@@ -1,13 +1,12 @@
-import { RELATION_PART_OF, RELATION_OWNED_BY, RELATION_PROVIDES_API, RELATION_CONSUMES_API, ENTITY_DEFAULT_NAMESPACE, LOCATION_ANNOTATION, stringifyEntityRef } from '@backstage/catalog-model';
+import { RELATION_PART_OF, RELATION_OWNED_BY, ENTITY_DEFAULT_NAMESPACE, LOCATION_ANNOTATION, stringifyEntityRef, compareEntityToRef } from '@backstage/catalog-model';
 import { Link, HeaderIconLinkRow, OverflowTooltip, WarningPanel, CodeSnippet, Table, Page, Header, Progress, RoutedTabs, Content, HeaderLabel, ResponseErrorPanel, HeaderTabs, PageWithHeader, ContentHeader, CreateButton, SupportButton } from '@backstage/core-components';
-import { createExternalRouteRef, useElementFilter, useApi, alertApiRef, useRouteRef, attachComponentData, configApiRef, createPlugin, createApiFactory, discoveryApiRef, identityApiRef, createRoutableExtension, createComponentExtension } from '@backstage/core-plugin-api';
+import { createExternalRouteRef, useElementFilter, useApi, alertApiRef, useRouteRef, attachComponentData, useApiHolder, configApiRef, createPlugin, createApiFactory, discoveryApiRef, identityApiRef, storageApiRef, createRoutableExtension, createComponentExtension } from '@backstage/core-plugin-api';
 import { scmIntegrationsApiRef, ScmIntegrationIcon } from '@backstage/integration-react';
-import { getEntityRelations, EntityRefLinks, useEntity, catalogApiRef, getEntitySourceLocation, getEntityMetadataEditUrl, useEntityKinds, useEntityListProvider, EntityKindFilter, EntityRefLink, useStarredEntities, formatEntityRefTitle, getEntityMetadataViewUrl, favoriteEntityIcon, favoriteEntityTooltip, useEntityCompoundName, EntityContext, UnregisterEntityDialog, FavoriteEntity, catalogRouteRef, EntityListProvider, EntityTypePicker, UserListPicker, EntityOwnerPicker, EntityLifecyclePicker, EntityTagPicker, rootRoute, entityRoute, AsyncEntityProvider, useEntityFromUrl, entityRouteRef } from '@backstage/plugin-catalog-react';
+import { getEntityRelations, EntityRefLinks, useEntity, catalogApiRef, getEntitySourceLocation, getEntityMetadataEditUrl, useEntityKinds, useEntityListProvider, EntityKindFilter, formatEntityRefTitle, EntityRefLink, useStarredEntities, getEntityMetadataViewUrl, favoriteEntityIcon, favoriteEntityTooltip, useEntityCompoundName, EntityContext, UnregisterEntityDialog, FavoriteEntity, catalogRouteRef, EntityListProvider, EntityTypePicker, UserListPicker, EntityOwnerPicker, EntityLifecyclePicker, EntityTagPicker, AsyncEntityProvider, useEntityFromUrl, starredEntitiesApiRef, DefaultStarredEntitiesApi, entityRouteRef } from '@backstage/plugin-catalog-react';
 import { makeStyles, Typography, Grid, Chip, Card, CardHeader, IconButton, Divider, CardContent, createStyles, capitalize, Select, InputBase, MenuItem, ListItem, ListItemText, Box, ListItemIcon, Popover, MenuList, Dialog, DialogTitle, DialogActions, Button, useMediaQuery, useTheme, Drawer, Link as Link$1 } from '@material-ui/core';
 import CachedIcon from '@material-ui/icons/Cached';
 import DocsIcon from '@material-ui/icons/Description';
 import EditIcon from '@material-ui/icons/Edit';
-import ExtensionIcon from '@material-ui/icons/Extension';
 import React, { useCallback, useState, useEffect, useMemo, useContext } from 'react';
 import OpenInNew from '@material-ui/icons/OpenInNew';
 import { capitalize as capitalize$1 } from 'lodash';
@@ -16,7 +15,9 @@ import { useNavigate, useParams, Navigate, matchRoutes, useRoutes, Routes, Route
 import { makeStyles as makeStyles$1 } from '@material-ui/core/styles';
 import Cancel from '@material-ui/icons/Cancel';
 import MoreVert from '@material-ui/icons/MoreVert';
+import { assertError } from '@backstage/errors';
 import { ENTITY_STATUS_CATALOG_PROCESSING_TYPE, CatalogClient } from '@backstage/catalog-client';
+import { useAsync } from 'react-use';
 import { Helmet } from 'react-helmet';
 import FilterListIcon from '@material-ui/icons/FilterList';
 import IlloSvgUrl from '../components/EntityNotFound/Illo/illo.svg';
@@ -80,6 +81,12 @@ class CatalogClientWrapper {
       token: (_a = options == null ? void 0 : options.token) != null ? _a : await this.identityApi.getIdToken()
     });
   }
+  async getEntityAncestors(request, options) {
+    var _a;
+    return await this.client.getEntityAncestors(request, {
+      token: (_a = options == null ? void 0 : options.token) != null ? _a : await this.identityApi.getIdToken()
+    });
+  }
 }
 
 const createComponentRouteRef = createExternalRouteRef({
@@ -235,9 +242,6 @@ function AboutCard({variant}) {
   const viewTechdocLink = useRouteRef(viewTechDocRouteRef);
   const entitySourceLocation = getEntitySourceLocation(entity, scmIntegrationsApi);
   const entityMetadataEditUrl = getEntityMetadataEditUrl(entity);
-  const providesApiRelations = getEntityRelations(entity, RELATION_PROVIDES_API);
-  const consumesApiRelations = getEntityRelations(entity, RELATION_CONSUMES_API);
-  const hasApis = providesApiRelations.length > 0 || consumesApiRelations.length > 0;
   const viewInSource = {
     label: "View Source",
     disabled: !entitySourceLocation,
@@ -256,13 +260,6 @@ function AboutCard({variant}) {
       name: entity.metadata.name
     })
   };
-  const viewApi = {
-    title: hasApis ? "" : "No APIs available",
-    label: "View API",
-    disabled: !hasApis,
-    icon: /* @__PURE__ */ React.createElement(ExtensionIcon, null),
-    href: "api"
-  };
   let cardClass = "";
   if (variant === "gridItem") {
     cardClass = classes.gridItemCard;
@@ -296,7 +293,7 @@ function AboutCard({variant}) {
       to: entityMetadataEditUrl != null ? entityMetadataEditUrl : "#"
     }, /* @__PURE__ */ React.createElement(EditIcon, null))),
     subheader: /* @__PURE__ */ React.createElement(HeaderIconLinkRow, {
-      links: [viewInSource, viewInTechDocs, viewApi]
+      links: [viewInSource, viewInTechDocs]
     })
   }), /* @__PURE__ */ React.createElement(Divider, null), /* @__PURE__ */ React.createElement(CardContent, {
     className: cardContentClass
@@ -373,14 +370,27 @@ const CatalogResultListItem = ({result}) => {
 };
 
 function createNameColumn(props) {
+  function formatContent(entity) {
+    var _a;
+    return ((_a = entity.metadata) == null ? void 0 : _a.title) || formatEntityRefTitle(entity, {
+      defaultKind: props == null ? void 0 : props.defaultKind
+    });
+  }
   return {
     title: "Name",
     field: "resolved.name",
     highlight: true,
-    render: ({entity}) => /* @__PURE__ */ React.createElement(EntityRefLink, {
-      entityRef: entity,
-      defaultKind: (props == null ? void 0 : props.defaultKind) || "Component"
-    })
+    customSort({entity: entity1}, {entity: entity2}) {
+      return formatContent(entity1).localeCompare(formatContent(entity2));
+    },
+    render: ({entity}) => {
+      var _a;
+      return /* @__PURE__ */ React.createElement(EntityRefLink, {
+        entityRef: entity,
+        defaultKind: (props == null ? void 0 : props.defaultKind) || "Component",
+        title: (_a = entity.metadata) == null ? void 0 : _a.title
+      });
+    }
   };
 }
 function createSystemColumn() {
@@ -765,6 +775,7 @@ const DeleteEntityDialog = ({
       await catalogApi.removeEntityByUid(uid);
       onConfirm();
     } catch (err) {
+      assertError(err);
       alertApi.post({message: err.message});
     } finally {
       setBusy(false);
@@ -810,21 +821,53 @@ const EntityOrphanWarning = () => {
   }));
 };
 
-const errorfilter = (i) => i.error && i.level === "error" && i.type === ENTITY_STATUS_CATALOG_PROCESSING_TYPE;
-const hasCatalogProcessingErrors = (entity) => {
-  var _a, _b;
-  return ((_b = (_a = entity == null ? void 0 : entity.status) == null ? void 0 : _a.items) == null ? void 0 : _b.filter(errorfilter).length) > 0;
+const errorFilter = (i) => i.error && i.level === "error" && i.type === ENTITY_STATUS_CATALOG_PROCESSING_TYPE;
+async function getOwnAndAncestorsErrors(entityRef, catalogApi) {
+  const ancestors = await catalogApi.getEntityAncestors({entityRef});
+  const items = ancestors.items.map((item) => {
+    var _a, _b;
+    const statuses = (_b = (_a = item.entity.status) == null ? void 0 : _a.items) != null ? _b : [];
+    const errors = statuses.filter(errorFilter).map((e) => e.error).filter((e) => Boolean(e));
+    return {errors, entity: item.entity};
+  }).filter((item) => item.errors.length > 0);
+  return {items};
+}
+const hasCatalogProcessingErrors = async (entity, context) => {
+  const catalogApi = context.apis.get(catalogApiRef);
+  if (!catalogApi) {
+    throw new Error(`No implementation available for ${catalogApiRef}`);
+  }
+  const errors = await getOwnAndAncestorsErrors(stringifyEntityRef(entity), catalogApi);
+  return errors.items.length > 0;
 };
 const EntityProcessingErrorsPanel = () => {
-  var _a, _b;
   const {entity} = useEntity();
-  const catalogProcessingErrors = ((_b = (_a = entity == null ? void 0 : entity.status) == null ? void 0 : _a.items) == null ? void 0 : _b.filter(errorfilter)) || [];
-  return /* @__PURE__ */ React.createElement(React.Fragment, null, catalogProcessingErrors.map(({error}, index) => /* @__PURE__ */ React.createElement(Box, {
+  const entityRef = stringifyEntityRef(entity);
+  const catalogApi = useApi(catalogApiRef);
+  const {loading, error, value} = useAsync(async () => {
+    return getOwnAndAncestorsErrors(entityRef, catalogApi);
+  }, [entityRef, catalogApi]);
+  if (error) {
+    return /* @__PURE__ */ React.createElement(Box, {
+      mb: 1
+    }, /* @__PURE__ */ React.createElement(ResponseErrorPanel, {
+      error
+    }));
+  }
+  if (loading || !value) {
+    return null;
+  }
+  return /* @__PURE__ */ React.createElement(React.Fragment, null, value.items.map((ancestorError, index) => /* @__PURE__ */ React.createElement(Box, {
     key: index,
     mb: 1
-  }, /* @__PURE__ */ React.createElement(ResponseErrorPanel, {
-    error
-  }))));
+  }, !compareEntityToRef(entity, stringifyEntityRef(ancestorError.entity)) && /* @__PURE__ */ React.createElement(Box, {
+    p: 1
+  }, "The error below originates from", " ", /* @__PURE__ */ React.createElement(EntityRefLink, {
+    entityRef: ancestorError.entity
+  })), ancestorError.errors.map((e, i) => /* @__PURE__ */ React.createElement(ResponseErrorPanel, {
+    key: i,
+    error: e
+  })))));
 };
 
 const getSelectedIndexOrDefault = (matchedRoute, tabs, defaultIndex = 0) => {
@@ -971,22 +1014,53 @@ const ENTITY_SWITCH_KEY = "core.backstage.entitySwitch";
 const EntitySwitchCase = (_) => null;
 attachComponentData(EntitySwitchCase, ENTITY_SWITCH_KEY, true);
 const EntitySwitch = ({children}) => {
-  var _a;
+  var _a, _b;
   const {entity} = useEntity();
-  const switchCases = useElementFilter(children, (collection) => collection.selectByComponentData({
+  const apis = useApiHolder();
+  const results = useElementFilter(children, (collection) => collection.selectByComponentData({
     key: ENTITY_SWITCH_KEY,
     withStrictError: "Child of EntitySwitch is not an EntitySwitch.Case"
   }).getElements().flatMap((element) => {
+    var _a2;
     const {if: condition, children: elementsChildren} = element.props;
-    return [{if: condition, children: elementsChildren}];
-  }));
-  const matchingCase = switchCases.find((switchCase) => switchCase.if ? switchCase.if(entity) : true);
-  return (_a = matchingCase == null ? void 0 : matchingCase.children) != null ? _a : null;
+    return [
+      {
+        if: (_a2 = condition == null ? void 0 : condition(entity, {apis})) != null ? _a2 : true,
+        children: elementsChildren
+      }
+    ];
+  }), [apis, entity]);
+  const hasAsyncCases = results.some((r) => typeof r.if === "object" && "then" in r.if);
+  if (hasAsyncCases) {
+    return /* @__PURE__ */ React.createElement(AsyncEntitySwitch, {
+      results
+    });
+  }
+  return (_b = (_a = results.find((r) => r.if)) == null ? void 0 : _a.children) != null ? _b : null;
 };
+function AsyncEntitySwitch({results}) {
+  const {loading, value} = useAsync(async () => {
+    var _a;
+    const promises = results.map(async ({if: condition, children: output}) => {
+      try {
+        if (await condition) {
+          return output;
+        }
+      } catch {
+      }
+      return null;
+    });
+    return (_a = (await Promise.all(promises)).find(Boolean)) != null ? _a : null;
+  }, [results]);
+  if (loading || !value) {
+    return null;
+  }
+  return value;
+}
 EntitySwitch.Case = EntitySwitchCase;
 
 function strCmp(a, b) {
-  return Boolean(a && (a == null ? void 0 : a.toLowerCase()) === (b == null ? void 0 : b.toLowerCase()));
+  return Boolean(a && (a == null ? void 0 : a.toLocaleLowerCase("en-US")) === (b == null ? void 0 : b.toLocaleLowerCase("en-US")));
 }
 function isKind(kind) {
   return (entity) => strCmp(entity == null ? void 0 : entity.kind, kind);
@@ -1174,10 +1248,10 @@ const EntityLoader = (props) => /* @__PURE__ */ React.createElement(AsyncEntityP
 const Router = ({
   EntityPage = DefaultEntityPage
 }) => /* @__PURE__ */ React.createElement(Routes, null, /* @__PURE__ */ React.createElement(Route$1, {
-  path: `${rootRoute.path}`,
+  path: "/",
   element: /* @__PURE__ */ React.createElement(CatalogPage, null)
 }), /* @__PURE__ */ React.createElement(Route$1, {
-  path: `${entityRoute.path}`,
+  path: "/:namespace/:kind/:name",
   element: /* @__PURE__ */ React.createElement(EntityLoader, null, /* @__PURE__ */ React.createElement(EntityPageSwitch, {
     EntityPage
   }))
@@ -1196,6 +1270,11 @@ const catalogPlugin = createPlugin({
         client: new CatalogClient({discoveryApi}),
         identityApi
       })
+    }),
+    createApiFactory({
+      api: starredEntitiesApiRef,
+      deps: {storageApi: storageApiRef},
+      factory: ({storageApi}) => new DefaultStarredEntitiesApi({storageApi})
     })
   ],
   routes: {
@@ -1208,63 +1287,75 @@ const catalogPlugin = createPlugin({
   }
 });
 const CatalogIndexPage = catalogPlugin.provide(createRoutableExtension({
-  component: () => import('./index-bb04d347.esm.js').then((m) => m.CatalogPage),
+  name: "CatalogIndexPage",
+  component: () => import('./index-a5cb6379.esm.js').then((m) => m.CatalogPage),
   mountPoint: catalogRouteRef
 }));
 const CatalogEntityPage = catalogPlugin.provide(createRoutableExtension({
+  name: "CatalogEntityPage",
   component: () => import('./index-7b0e3438.esm.js').then((m) => m.CatalogEntityPage),
   mountPoint: entityRouteRef
 }));
 const EntityAboutCard = catalogPlugin.provide(createComponentExtension({
+  name: "EntityAboutCard",
   component: {
-    lazy: () => import('./index-937795b4.esm.js').then((m) => m.AboutCard)
+    lazy: () => import('./index-66b84bce.esm.js').then((m) => m.AboutCard)
   }
 }));
 const EntityLinksCard = catalogPlugin.provide(createComponentExtension({
+  name: "EntityLinksCard",
   component: {
-    lazy: () => import('./index-d2181250.esm.js').then((m) => m.EntityLinksCard)
+    lazy: () => import('./index-f9a9eace.esm.js').then((m) => m.EntityLinksCard)
   }
 }));
 const EntityHasSystemsCard = catalogPlugin.provide(createComponentExtension({
+  name: "EntityHasSystemsCard",
   component: {
     lazy: () => import('./index-55d1a69b.esm.js').then((m) => m.HasSystemsCard)
   }
 }));
 const EntityHasComponentsCard = catalogPlugin.provide(createComponentExtension({
+  name: "EntityHasComponentsCard",
   component: {
     lazy: () => import('./index-e3a14e6d.esm.js').then((m) => m.HasComponentsCard)
   }
 }));
 const EntityHasSubcomponentsCard = catalogPlugin.provide(createComponentExtension({
+  name: "EntityHasSubcomponentsCard",
   component: {
     lazy: () => import('./index-ef2084a6.esm.js').then((m) => m.HasSubcomponentsCard)
   }
 }));
 const EntityHasResourcesCard = catalogPlugin.provide(createComponentExtension({
+  name: "EntityHasResourcesCard",
   component: {
     lazy: () => import('./index-f2f98d41.esm.js').then((m) => m.HasResourcesCard)
   }
 }));
 const EntityDependsOnComponentsCard = catalogPlugin.provide(createComponentExtension({
+  name: "EntityDependsOnComponentsCard",
   component: {
     lazy: () => import('./index-99e3a23f.esm.js').then((m) => m.DependsOnComponentsCard)
   }
 }));
 const EntityDependencyOfComponentsCard = catalogPlugin.provide(createComponentExtension({
+  name: "EntityDependencyOfComponentsCard",
   component: {
     lazy: () => import('./index-112e4b31.esm.js').then((m) => m.DependencyOfComponentsCard)
   }
 }));
 const EntityDependsOnResourcesCard = catalogPlugin.provide(createComponentExtension({
+  name: "EntityDependsOnResourcesCard",
   component: {
     lazy: () => import('./index-8f587acc.esm.js').then((m) => m.DependsOnResourcesCard)
   }
 }));
 const EntitySystemDiagramCard = catalogPlugin.provide(createComponentExtension({
+  name: "EntitySystemDiagramCard",
   component: {
-    lazy: () => import('./index-99bc5767.esm.js').then((m) => m.SystemDiagramCard)
+    lazy: () => import('./index-fc057bf8.esm.js').then((m) => m.SystemDiagramCard)
   }
 }));
 
 export { AboutCard as A, EntityOrphanWarning as B, CatalogPage as C, isOrphan as D, EntityAboutCard as E, EntityProcessingErrorsPanel as F, hasCatalogProcessingErrors as G, EntityPageLayout as H, EntitySwitch as I, isKind as J, isNamespace as K, isComponentType as L, FilteredEntityLayout as M, FilterContainer as N, EntityListContainer as O, Router as R, AboutContent as a, AboutField as b, CatalogClientWrapper as c, CatalogTable as d, CatalogEntityPage as e, CatalogIndexPage as f, catalogPlugin as g, EntityDependencyOfComponentsCard as h, EntityDependsOnComponentsCard as i, EntityDependsOnResourcesCard as j, EntityHasComponentsCard as k, EntityHasResourcesCard as l, EntityHasSubcomponentsCard as m, EntityHasSystemsCard as n, EntityLinksCard as o, EntitySystemDiagramCard as p, CatalogKindHeader as q, CatalogResultListItem as r, createNameColumn as s, createSystemColumn as t, createOwnerColumn as u, createSpecTypeColumn as v, createSpecLifecycleColumn as w, createMetadataDescriptionColumn as x, createTagsColumn as y, EntityLayout as z };
-//# sourceMappingURL=index-6a9a7783.esm.js.map
+//# sourceMappingURL=index-0e602309.esm.js.map