@backstage/plugin-catalog-graph 0.4.6-next.1 → 0.4.6-next.2

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @backstage/plugin-catalog-graph
 
+## 0.4.6-next.2
+
+### Patch Changes
+
+- 8d474d3: Add function to `EntityRelationsGraph` filter that excludes entities from graph
+- d44a20a: Added additional plugin metadata to `package.json`.
+- Updated dependencies
+  - @backstage/core-components@0.14.8-next.2
+  - @backstage/plugin-catalog-react@1.12.1-next.2
+  - @backstage/frontend-plugin-api@0.6.6-next.2
+  - @backstage/core-compat-api@0.2.6-next.2
+  - @backstage/catalog-client@1.6.5
+  - @backstage/catalog-model@1.5.0
+  - @backstage/core-plugin-api@1.9.3-next.0
+  - @backstage/types@1.1.1
+
 ## 0.4.6-next.1
 
 ### Patch Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-graph",
-  "version": "0.4.6-next.1",
+  "version": "0.4.6-next.2",
   "main": "../dist/alpha.esm.js",
   "module": "../dist/alpha.esm.js",
   "types": "../dist/alpha.d.ts"

package/dist/components/CatalogGraphCard/CatalogGraphCard.esm.js

@@ -36,6 +36,7 @@ const CatalogGraphCard = (props) => {
     direction = Direction.LEFT_RIGHT,
     kinds,
     relations,
+    entityFilter,
     height,
     className,
     rootEntityNames,
@@ -104,6 +105,7 @@ const CatalogGraphCard = (props) => {
         mergeRelations,
         direction,
         relationPairs,
+        entityFilter,
         zoom
       }
     )

package/dist/components/CatalogGraphCard/CatalogGraphCard.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"CatalogGraphCard.esm.js","sources":["../../../src/components/CatalogGraphCard/CatalogGraphCard.tsx"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  getCompoundEntityRef,\n  parseEntityRef,\n  stringifyEntityRef,\n} from '@backstage/catalog-model';\nimport { InfoCard, InfoCardVariants } from '@backstage/core-components';\nimport { useAnalytics, useRouteRef } from '@backstage/core-plugin-api';\nimport {\n  humanizeEntityRef,\n  useEntity,\n  entityRouteRef,\n} from '@backstage/plugin-catalog-react';\nimport { makeStyles, Theme } from '@material-ui/core/styles';\nimport qs from 'qs';\nimport React, { MouseEvent, useCallback } from 'react';\nimport { useNavigate } from 'react-router-dom';\nimport { catalogGraphRouteRef } from '../../routes';\nimport {\n  ALL_RELATION_PAIRS,\n  Direction,\n  EntityNode,\n  EntityRelationsGraph,\n} from '../EntityRelationsGraph';\nimport { EntityRelationsGraphProps } from '../EntityRelationsGraph';\n\nconst useStyles = makeStyles<Theme, { height: number | undefined }>(\n  {\n    card: ({ height }) => ({\n      display: 'flex',\n      flexDirection: 'column',\n      maxHeight: height,\n      minHeight: height,\n    }),\n    graph: {\n      flex: 1,\n      minHeight: 0,\n    },\n  },\n  { name: 'PluginCatalogGraphCatalogGraphCard' },\n);\n\nexport const CatalogGraphCard = (\n  props: Partial<EntityRelationsGraphProps> & {\n    variant?: InfoCardVariants;\n    height?: number;\n    title?: string;\n  },\n) => {\n  const {\n    variant = 'gridItem',\n    relationPairs = ALL_RELATION_PAIRS,\n    maxDepth = 1,\n    unidirectional = true,\n    mergeRelations = true,\n    direction = Direction.LEFT_RIGHT,\n    kinds,\n    relations,\n    height,\n    className,\n    rootEntityNames,\n    onNodeClick,\n    title = 'Relations',\n    zoom = 'enable-on-click',\n  } = props;\n\n  const { entity } = useEntity();\n  const entityName = getCompoundEntityRef(entity);\n  const catalogEntityRoute = useRouteRef(entityRouteRef);\n  const catalogGraphRoute = useRouteRef(catalogGraphRouteRef);\n  const navigate = useNavigate();\n  const classes = useStyles({ height });\n  const analytics = useAnalytics();\n\n  const defaultOnNodeClick = useCallback(\n    (node: EntityNode, _: MouseEvent<unknown>) => {\n      const nodeEntityName = parseEntityRef(node.id);\n      const path = catalogEntityRoute({\n        kind: nodeEntityName.kind.toLocaleLowerCase('en-US'),\n        namespace: nodeEntityName.namespace.toLocaleLowerCase('en-US'),\n        name: nodeEntityName.name,\n      });\n      analytics.captureEvent(\n        'click',\n        node.entity.metadata.title ?? humanizeEntityRef(nodeEntityName),\n        { attributes: { to: path } },\n      );\n      navigate(path);\n    },\n    [catalogEntityRoute, navigate, analytics],\n  );\n\n  const catalogGraphParams = qs.stringify(\n    {\n      rootEntityRefs: [stringifyEntityRef(entity)],\n      maxDepth: maxDepth,\n      unidirectional,\n      mergeRelations,\n      selectedKinds: kinds,\n      selectedRelations: relations,\n      direction,\n    },\n    { arrayFormat: 'brackets', addQueryPrefix: true },\n  );\n  const catalogGraphUrl = `${catalogGraphRoute()}${catalogGraphParams}`;\n\n  return (\n    <InfoCard\n      title={title}\n      cardClassName={classes.card}\n      variant={variant}\n      noPadding\n      deepLink={{\n        title: 'View graph',\n        link: catalogGraphUrl,\n      }}\n    >\n      <EntityRelationsGraph\n        {...props}\n        rootEntityNames={rootEntityNames || entityName}\n        onNodeClick={onNodeClick || defaultOnNodeClick}\n        className={className || classes.graph}\n        maxDepth={maxDepth}\n        unidirectional={unidirectional}\n        mergeRelations={mergeRelations}\n        direction={direction}\n        relationPairs={relationPairs}\n        zoom={zoom}\n      />\n    </InfoCard>\n  );\n};\n"],"names":[],"mappings":";;;;;;;;;;;;;AAyCA,MAAM,SAAY,GAAA,UAAA;AAAA,EAChB;AAAA,IACE,IAAM,EAAA,CAAC,EAAE,MAAA,EAAc,MAAA;AAAA,MACrB,OAAS,EAAA,MAAA;AAAA,MACT,aAAe,EAAA,QAAA;AAAA,MACf,SAAW,EAAA,MAAA;AAAA,MACX,SAAW,EAAA,MAAA;AAAA,KACb,CAAA;AAAA,IACA,KAAO,EAAA;AAAA,MACL,IAAM,EAAA,CAAA;AAAA,MACN,SAAW,EAAA,CAAA;AAAA,KACb;AAAA,GACF;AAAA,EACA,EAAE,MAAM,oCAAqC,EAAA;AAC/C,CAAA,CAAA;AAEa,MAAA,gBAAA,GAAmB,CAC9B,KAKG,KAAA;AACH,EAAM,MAAA;AAAA,IACJ,OAAU,GAAA,UAAA;AAAA,IACV,aAAgB,GAAA,kBAAA;AAAA,IAChB,QAAW,GAAA,CAAA;AAAA,IACX,cAAiB,GAAA,IAAA;AAAA,IACjB,cAAiB,GAAA,IAAA;AAAA,IACjB,YAAY,SAAU,CAAA,UAAA;AAAA,IACtB,KAAA;AAAA,IACA,SAAA;AAAA,IACA,MAAA;AAAA,IACA,SAAA;AAAA,IACA,eAAA;AAAA,IACA,WAAA;AAAA,IACA,KAAQ,GAAA,WAAA;AAAA,IACR,IAAO,GAAA,iBAAA;AAAA,GACL,GAAA,KAAA,CAAA;AAEJ,EAAM,MAAA,EAAE,MAAO,EAAA,GAAI,SAAU,EAAA,CAAA;AAC7B,EAAM,MAAA,UAAA,GAAa,qBAAqB,MAAM,CAAA,CAAA;AAC9C,EAAM,MAAA,kBAAA,GAAqB,YAAY,cAAc,CAAA,CAAA;AACrD,EAAM,MAAA,iBAAA,GAAoB,YAAY,oBAAoB,CAAA,CAAA;AAC1D,EAAA,MAAM,WAAW,WAAY,EAAA,CAAA;AAC7B,EAAA,MAAM,OAAU,GAAA,SAAA,CAAU,EAAE,MAAA,EAAQ,CAAA,CAAA;AACpC,EAAA,MAAM,YAAY,YAAa,EAAA,CAAA;AAE/B,EAAA,MAAM,kBAAqB,GAAA,WAAA;AAAA,IACzB,CAAC,MAAkB,CAA2B,KAAA;AAC5C,MAAM,MAAA,cAAA,GAAiB,cAAe,CAAA,IAAA,CAAK,EAAE,CAAA,CAAA;AAC7C,MAAA,MAAM,OAAO,kBAAmB,CAAA;AAAA,QAC9B,IAAM,EAAA,cAAA,CAAe,IAAK,CAAA,iBAAA,CAAkB,OAAO,CAAA;AAAA,QACnD,SAAW,EAAA,cAAA,CAAe,SAAU,CAAA,iBAAA,CAAkB,OAAO,CAAA;AAAA,QAC7D,MAAM,cAAe,CAAA,IAAA;AAAA,OACtB,CAAA,CAAA;AACD,MAAU,SAAA,CAAA,YAAA;AAAA,QACR,OAAA;AAAA,QACA,IAAK,CAAA,MAAA,CAAO,QAAS,CAAA,KAAA,IAAS,kBAAkB,cAAc,CAAA;AAAA,QAC9D,EAAE,UAAA,EAAY,EAAE,EAAA,EAAI,MAAO,EAAA;AAAA,OAC7B,CAAA;AACA,MAAA,QAAA,CAAS,IAAI,CAAA,CAAA;AAAA,KACf;AAAA,IACA,CAAC,kBAAoB,EAAA,QAAA,EAAU,SAAS,CAAA;AAAA,GAC1C,CAAA;AAEA,EAAA,MAAM,qBAAqB,EAAG,CAAA,SAAA;AAAA,IAC5B;AAAA,MACE,cAAgB,EAAA,CAAC,kBAAmB,CAAA,MAAM,CAAC,CAAA;AAAA,MAC3C,QAAA;AAAA,MACA,cAAA;AAAA,MACA,cAAA;AAAA,MACA,aAAe,EAAA,KAAA;AAAA,MACf,iBAAmB,EAAA,SAAA;AAAA,MACnB,SAAA;AAAA,KACF;AAAA,IACA,EAAE,WAAA,EAAa,UAAY,EAAA,cAAA,EAAgB,IAAK,EAAA;AAAA,GAClD,CAAA;AACA,EAAA,MAAM,eAAkB,GAAA,CAAA,EAAG,iBAAkB,EAAC,GAAG,kBAAkB,CAAA,CAAA,CAAA;AAEnE,EACE,uBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,QAAA;AAAA,IAAA;AAAA,MACC,KAAA;AAAA,MACA,eAAe,OAAQ,CAAA,IAAA;AAAA,MACvB,OAAA;AAAA,MACA,SAAS,EAAA,IAAA;AAAA,MACT,QAAU,EAAA;AAAA,QACR,KAAO,EAAA,YAAA;AAAA,QACP,IAAM,EAAA,eAAA;AAAA,OACR;AAAA,KAAA;AAAA,oBAEA,KAAA,CAAA,aAAA;AAAA,MAAC,oBAAA;AAAA,MAAA;AAAA,QACE,GAAG,KAAA;AAAA,QACJ,iBAAiB,eAAmB,IAAA,UAAA;AAAA,QACpC,aAAa,WAAe,IAAA,kBAAA;AAAA,QAC5B,SAAA,EAAW,aAAa,OAAQ,CAAA,KAAA;AAAA,QAChC,QAAA;AAAA,QACA,cAAA;AAAA,QACA,cAAA;AAAA,QACA,SAAA;AAAA,QACA,aAAA;AAAA,QACA,IAAA;AAAA,OAAA;AAAA,KACF;AAAA,GACF,CAAA;AAEJ;;;;"}
+{"version":3,"file":"CatalogGraphCard.esm.js","sources":["../../../src/components/CatalogGraphCard/CatalogGraphCard.tsx"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  getCompoundEntityRef,\n  parseEntityRef,\n  stringifyEntityRef,\n} from '@backstage/catalog-model';\nimport { InfoCard, InfoCardVariants } from '@backstage/core-components';\nimport { useAnalytics, useRouteRef } from '@backstage/core-plugin-api';\nimport {\n  humanizeEntityRef,\n  useEntity,\n  entityRouteRef,\n} from '@backstage/plugin-catalog-react';\nimport { makeStyles, Theme } from '@material-ui/core/styles';\nimport qs from 'qs';\nimport React, { MouseEvent, useCallback } from 'react';\nimport { useNavigate } from 'react-router-dom';\nimport { catalogGraphRouteRef } from '../../routes';\nimport {\n  ALL_RELATION_PAIRS,\n  Direction,\n  EntityNode,\n  EntityRelationsGraph,\n} from '../EntityRelationsGraph';\nimport { EntityRelationsGraphProps } from '../EntityRelationsGraph';\n\nconst useStyles = makeStyles<Theme, { height: number | undefined }>(\n  {\n    card: ({ height }) => ({\n      display: 'flex',\n      flexDirection: 'column',\n      maxHeight: height,\n      minHeight: height,\n    }),\n    graph: {\n      flex: 1,\n      minHeight: 0,\n    },\n  },\n  { name: 'PluginCatalogGraphCatalogGraphCard' },\n);\n\nexport const CatalogGraphCard = (\n  props: Partial<EntityRelationsGraphProps> & {\n    variant?: InfoCardVariants;\n    height?: number;\n    title?: string;\n  },\n) => {\n  const {\n    variant = 'gridItem',\n    relationPairs = ALL_RELATION_PAIRS,\n    maxDepth = 1,\n    unidirectional = true,\n    mergeRelations = true,\n    direction = Direction.LEFT_RIGHT,\n    kinds,\n    relations,\n    entityFilter,\n    height,\n    className,\n    rootEntityNames,\n    onNodeClick,\n    title = 'Relations',\n    zoom = 'enable-on-click',\n  } = props;\n\n  const { entity } = useEntity();\n  const entityName = getCompoundEntityRef(entity);\n  const catalogEntityRoute = useRouteRef(entityRouteRef);\n  const catalogGraphRoute = useRouteRef(catalogGraphRouteRef);\n  const navigate = useNavigate();\n  const classes = useStyles({ height });\n  const analytics = useAnalytics();\n\n  const defaultOnNodeClick = useCallback(\n    (node: EntityNode, _: MouseEvent<unknown>) => {\n      const nodeEntityName = parseEntityRef(node.id);\n      const path = catalogEntityRoute({\n        kind: nodeEntityName.kind.toLocaleLowerCase('en-US'),\n        namespace: nodeEntityName.namespace.toLocaleLowerCase('en-US'),\n        name: nodeEntityName.name,\n      });\n      analytics.captureEvent(\n        'click',\n        node.entity.metadata.title ?? humanizeEntityRef(nodeEntityName),\n        { attributes: { to: path } },\n      );\n      navigate(path);\n    },\n    [catalogEntityRoute, navigate, analytics],\n  );\n\n  const catalogGraphParams = qs.stringify(\n    {\n      rootEntityRefs: [stringifyEntityRef(entity)],\n      maxDepth: maxDepth,\n      unidirectional,\n      mergeRelations,\n      selectedKinds: kinds,\n      selectedRelations: relations,\n      direction,\n    },\n    { arrayFormat: 'brackets', addQueryPrefix: true },\n  );\n  const catalogGraphUrl = `${catalogGraphRoute()}${catalogGraphParams}`;\n\n  return (\n    <InfoCard\n      title={title}\n      cardClassName={classes.card}\n      variant={variant}\n      noPadding\n      deepLink={{\n        title: 'View graph',\n        link: catalogGraphUrl,\n      }}\n    >\n      <EntityRelationsGraph\n        {...props}\n        rootEntityNames={rootEntityNames || entityName}\n        onNodeClick={onNodeClick || defaultOnNodeClick}\n        className={className || classes.graph}\n        maxDepth={maxDepth}\n        unidirectional={unidirectional}\n        mergeRelations={mergeRelations}\n        direction={direction}\n        relationPairs={relationPairs}\n        entityFilter={entityFilter}\n        zoom={zoom}\n      />\n    </InfoCard>\n  );\n};\n"],"names":[],"mappings":";;;;;;;;;;;;;AAyCA,MAAM,SAAY,GAAA,UAAA;AAAA,EAChB;AAAA,IACE,IAAM,EAAA,CAAC,EAAE,MAAA,EAAc,MAAA;AAAA,MACrB,OAAS,EAAA,MAAA;AAAA,MACT,aAAe,EAAA,QAAA;AAAA,MACf,SAAW,EAAA,MAAA;AAAA,MACX,SAAW,EAAA,MAAA;AAAA,KACb,CAAA;AAAA,IACA,KAAO,EAAA;AAAA,MACL,IAAM,EAAA,CAAA;AAAA,MACN,SAAW,EAAA,CAAA;AAAA,KACb;AAAA,GACF;AAAA,EACA,EAAE,MAAM,oCAAqC,EAAA;AAC/C,CAAA,CAAA;AAEa,MAAA,gBAAA,GAAmB,CAC9B,KAKG,KAAA;AACH,EAAM,MAAA;AAAA,IACJ,OAAU,GAAA,UAAA;AAAA,IACV,aAAgB,GAAA,kBAAA;AAAA,IAChB,QAAW,GAAA,CAAA;AAAA,IACX,cAAiB,GAAA,IAAA;AAAA,IACjB,cAAiB,GAAA,IAAA;AAAA,IACjB,YAAY,SAAU,CAAA,UAAA;AAAA,IACtB,KAAA;AAAA,IACA,SAAA;AAAA,IACA,YAAA;AAAA,IACA,MAAA;AAAA,IACA,SAAA;AAAA,IACA,eAAA;AAAA,IACA,WAAA;AAAA,IACA,KAAQ,GAAA,WAAA;AAAA,IACR,IAAO,GAAA,iBAAA;AAAA,GACL,GAAA,KAAA,CAAA;AAEJ,EAAM,MAAA,EAAE,MAAO,EAAA,GAAI,SAAU,EAAA,CAAA;AAC7B,EAAM,MAAA,UAAA,GAAa,qBAAqB,MAAM,CAAA,CAAA;AAC9C,EAAM,MAAA,kBAAA,GAAqB,YAAY,cAAc,CAAA,CAAA;AACrD,EAAM,MAAA,iBAAA,GAAoB,YAAY,oBAAoB,CAAA,CAAA;AAC1D,EAAA,MAAM,WAAW,WAAY,EAAA,CAAA;AAC7B,EAAA,MAAM,OAAU,GAAA,SAAA,CAAU,EAAE,MAAA,EAAQ,CAAA,CAAA;AACpC,EAAA,MAAM,YAAY,YAAa,EAAA,CAAA;AAE/B,EAAA,MAAM,kBAAqB,GAAA,WAAA;AAAA,IACzB,CAAC,MAAkB,CAA2B,KAAA;AAC5C,MAAM,MAAA,cAAA,GAAiB,cAAe,CAAA,IAAA,CAAK,EAAE,CAAA,CAAA;AAC7C,MAAA,MAAM,OAAO,kBAAmB,CAAA;AAAA,QAC9B,IAAM,EAAA,cAAA,CAAe,IAAK,CAAA,iBAAA,CAAkB,OAAO,CAAA;AAAA,QACnD,SAAW,EAAA,cAAA,CAAe,SAAU,CAAA,iBAAA,CAAkB,OAAO,CAAA;AAAA,QAC7D,MAAM,cAAe,CAAA,IAAA;AAAA,OACtB,CAAA,CAAA;AACD,MAAU,SAAA,CAAA,YAAA;AAAA,QACR,OAAA;AAAA,QACA,IAAK,CAAA,MAAA,CAAO,QAAS,CAAA,KAAA,IAAS,kBAAkB,cAAc,CAAA;AAAA,QAC9D,EAAE,UAAA,EAAY,EAAE,EAAA,EAAI,MAAO,EAAA;AAAA,OAC7B,CAAA;AACA,MAAA,QAAA,CAAS,IAAI,CAAA,CAAA;AAAA,KACf;AAAA,IACA,CAAC,kBAAoB,EAAA,QAAA,EAAU,SAAS,CAAA;AAAA,GAC1C,CAAA;AAEA,EAAA,MAAM,qBAAqB,EAAG,CAAA,SAAA;AAAA,IAC5B;AAAA,MACE,cAAgB,EAAA,CAAC,kBAAmB,CAAA,MAAM,CAAC,CAAA;AAAA,MAC3C,QAAA;AAAA,MACA,cAAA;AAAA,MACA,cAAA;AAAA,MACA,aAAe,EAAA,KAAA;AAAA,MACf,iBAAmB,EAAA,SAAA;AAAA,MACnB,SAAA;AAAA,KACF;AAAA,IACA,EAAE,WAAA,EAAa,UAAY,EAAA,cAAA,EAAgB,IAAK,EAAA;AAAA,GAClD,CAAA;AACA,EAAA,MAAM,eAAkB,GAAA,CAAA,EAAG,iBAAkB,EAAC,GAAG,kBAAkB,CAAA,CAAA,CAAA;AAEnE,EACE,uBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,QAAA;AAAA,IAAA;AAAA,MACC,KAAA;AAAA,MACA,eAAe,OAAQ,CAAA,IAAA;AAAA,MACvB,OAAA;AAAA,MACA,SAAS,EAAA,IAAA;AAAA,MACT,QAAU,EAAA;AAAA,QACR,KAAO,EAAA,YAAA;AAAA,QACP,IAAM,EAAA,eAAA;AAAA,OACR;AAAA,KAAA;AAAA,oBAEA,KAAA,CAAA,aAAA;AAAA,MAAC,oBAAA;AAAA,MAAA;AAAA,QACE,GAAG,KAAA;AAAA,QACJ,iBAAiB,eAAmB,IAAA,UAAA;AAAA,QACpC,aAAa,WAAe,IAAA,kBAAA;AAAA,QAC5B,SAAA,EAAW,aAAa,OAAQ,CAAA,KAAA;AAAA,QAChC,QAAA;AAAA,QACA,cAAA;AAAA,QACA,cAAA;AAAA,QACA,SAAA;AAAA,QACA,aAAA;AAAA,QACA,YAAA;AAAA,QACA,IAAA;AAAA,OAAA;AAAA,KACF;AAAA,GACF,CAAA;AAEJ;;;;"}

package/dist/components/CatalogGraphPage/CatalogGraphPage.esm.js

@@ -76,7 +76,11 @@ const useStyles = makeStyles(
   { name: "PluginCatalogGraphCatalogGraphPage" }
 );
 const CatalogGraphPage = (props) => {
-  const { relationPairs = ALL_RELATION_PAIRS, initialState } = props;
+  const {
+    relationPairs = ALL_RELATION_PAIRS,
+    initialState,
+    entityFilter
+  } = props;
   const navigate = useNavigate();
   const classes = useStyles();
   const catalogEntityRoute = useRouteRef(entityRouteRef);
@@ -197,6 +201,7 @@ const CatalogGraphPage = (props) => {
       onNodeClick,
       direction,
       relationPairs,
+      entityFilter,
       className: classes.graph,
       zoom: "enabled",
       curve

package/dist/components/CatalogGraphPage/CatalogGraphPage.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"CatalogGraphPage.esm.js","sources":["../../../src/components/CatalogGraphPage/CatalogGraphPage.tsx"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { parseEntityRef } from '@backstage/catalog-model';\nimport {\n  Content,\n  ContentHeader,\n  Header,\n  Page,\n  SupportButton,\n} from '@backstage/core-components';\nimport { useAnalytics, useRouteRef } from '@backstage/core-plugin-api';\nimport {\n  entityRouteRef,\n  humanizeEntityRef,\n} from '@backstage/plugin-catalog-react';\nimport Grid from '@material-ui/core/Grid';\nimport Paper from '@material-ui/core/Paper';\nimport Typography from '@material-ui/core/Typography';\nimport { makeStyles } from '@material-ui/core/styles';\nimport FilterListIcon from '@material-ui/icons/FilterList';\nimport ZoomOutMap from '@material-ui/icons/ZoomOutMap';\nimport ToggleButton from '@material-ui/lab/ToggleButton';\nimport React, { MouseEvent, useCallback } from 'react';\nimport { useNavigate } from 'react-router-dom';\nimport {\n  ALL_RELATION_PAIRS,\n  Direction,\n  EntityNode,\n  EntityRelationsGraph,\n  EntityRelationsGraphProps,\n} from '../EntityRelationsGraph';\nimport { CurveFilter } from './CurveFilter';\nimport { DirectionFilter } from './DirectionFilter';\nimport { MaxDepthFilter } from './MaxDepthFilter';\nimport { SelectedKindsFilter } from './SelectedKindsFilter';\nimport { SelectedRelationsFilter } from './SelectedRelationsFilter';\nimport { SwitchFilter } from './SwitchFilter';\nimport { useCatalogGraphPage } from './useCatalogGraphPage';\n\nconst useStyles = makeStyles(\n  theme => ({\n    content: {\n      minHeight: 0,\n    },\n    container: {\n      height: '100%',\n      maxHeight: '100%',\n      minHeight: 0,\n    },\n    fullHeight: {\n      maxHeight: '100%',\n      display: 'flex',\n      minHeight: 0,\n    },\n    graphWrapper: {\n      position: 'relative',\n      flex: 1,\n      minHeight: 0,\n      display: 'flex',\n    },\n    graph: {\n      flex: 1,\n      minHeight: 0,\n    },\n    legend: {\n      position: 'absolute',\n      bottom: 0,\n      right: 0,\n      padding: theme.spacing(1),\n      '& .icon': {\n        verticalAlign: 'bottom',\n      },\n    },\n    filters: {\n      display: 'grid',\n      gridGap: theme.spacing(1),\n      gridAutoRows: 'auto',\n      [theme.breakpoints.up('lg')]: {\n        display: 'block',\n      },\n      [theme.breakpoints.only('md')]: {\n        gridTemplateColumns: 'repeat(3, 1fr)',\n      },\n      [theme.breakpoints.only('sm')]: {\n        gridTemplateColumns: 'repeat(2, 1fr)',\n      },\n      [theme.breakpoints.down('xs')]: {\n        gridTemplateColumns: 'repeat(1, 1fr)',\n      },\n    },\n  }),\n  { name: 'PluginCatalogGraphCatalogGraphPage' },\n);\n\nexport const CatalogGraphPage = (\n  props: {\n    initialState?: {\n      selectedRelations?: string[];\n      selectedKinds?: string[];\n      rootEntityRefs?: string[];\n      maxDepth?: number;\n      unidirectional?: boolean;\n      mergeRelations?: boolean;\n      direction?: Direction;\n      showFilters?: boolean;\n      curve?: 'curveStepBefore' | 'curveMonotoneX';\n    };\n  } & Partial<EntityRelationsGraphProps>,\n) => {\n  const { relationPairs = ALL_RELATION_PAIRS, initialState } = props;\n\n  const navigate = useNavigate();\n  const classes = useStyles();\n  const catalogEntityRoute = useRouteRef(entityRouteRef);\n  const {\n    maxDepth,\n    setMaxDepth,\n    selectedKinds,\n    setSelectedKinds,\n    selectedRelations,\n    setSelectedRelations,\n    unidirectional,\n    setUnidirectional,\n    mergeRelations,\n    setMergeRelations,\n    direction,\n    setDirection,\n    curve,\n    setCurve,\n    rootEntityNames,\n    setRootEntityNames,\n    showFilters,\n    toggleShowFilters,\n  } = useCatalogGraphPage({ initialState });\n  const analytics = useAnalytics();\n  const onNodeClick = useCallback(\n    (node: EntityNode, event: MouseEvent<unknown>) => {\n      const nodeEntityName = parseEntityRef(node.id);\n\n      if (event.shiftKey) {\n        const path = catalogEntityRoute({\n          kind: nodeEntityName.kind.toLocaleLowerCase('en-US'),\n          namespace: nodeEntityName.namespace.toLocaleLowerCase('en-US'),\n          name: nodeEntityName.name,\n        });\n\n        analytics.captureEvent(\n          'click',\n          node.entity.metadata.title ?? humanizeEntityRef(nodeEntityName),\n          { attributes: { to: path } },\n        );\n        navigate(path);\n      } else {\n        analytics.captureEvent(\n          'click',\n          node.entity.metadata.title ?? humanizeEntityRef(nodeEntityName),\n        );\n        setRootEntityNames([nodeEntityName]);\n      }\n    },\n    [catalogEntityRoute, navigate, setRootEntityNames, analytics],\n  );\n\n  return (\n    <Page themeId=\"home\">\n      <Header\n        title=\"Catalog Graph\"\n        subtitle={rootEntityNames.map(e => humanizeEntityRef(e)).join(', ')}\n      />\n      <Content stretch className={classes.content}>\n        <ContentHeader\n          titleComponent={\n            <ToggleButton\n              value=\"show filters\"\n              selected={showFilters}\n              onChange={() => toggleShowFilters()}\n            >\n              <FilterListIcon /> Filters\n            </ToggleButton>\n          }\n        >\n          <SupportButton>\n            Start tracking your component in by adding it to the software\n            catalog.\n          </SupportButton>\n        </ContentHeader>\n        <Grid container alignItems=\"stretch\" className={classes.container}>\n          {showFilters && (\n            <Grid item xs={12} lg={2} className={classes.filters}>\n              <MaxDepthFilter value={maxDepth} onChange={setMaxDepth} />\n              <SelectedKindsFilter\n                value={selectedKinds}\n                onChange={setSelectedKinds}\n              />\n              <SelectedRelationsFilter\n                value={selectedRelations}\n                onChange={setSelectedRelations}\n                relationPairs={relationPairs}\n              />\n              <DirectionFilter value={direction} onChange={setDirection} />\n              <CurveFilter value={curve} onChange={setCurve} />\n              <SwitchFilter\n                value={unidirectional}\n                onChange={setUnidirectional}\n                label=\"Simplified\"\n              />\n              <SwitchFilter\n                value={mergeRelations}\n                onChange={setMergeRelations}\n                label=\"Merge Relations\"\n              />\n            </Grid>\n          )}\n          <Grid item xs className={classes.fullHeight}>\n            <Paper className={classes.graphWrapper}>\n              <Typography\n                variant=\"caption\"\n                color=\"textSecondary\"\n                display=\"block\"\n                className={classes.legend}\n              >\n                <ZoomOutMap className=\"icon\" /> Use pinch &amp; zoom to move\n                around the diagram. Click to change active node, shift click to\n                navigate to entity.\n              </Typography>\n              <EntityRelationsGraph\n                {...props}\n                rootEntityNames={rootEntityNames}\n                maxDepth={maxDepth}\n                kinds={\n                  selectedKinds && selectedKinds.length > 0\n                    ? selectedKinds\n                    : undefined\n                }\n                relations={\n                  selectedRelations && selectedRelations.length > 0\n                    ? selectedRelations\n                    : undefined\n                }\n                mergeRelations={mergeRelations}\n                unidirectional={unidirectional}\n                onNodeClick={onNodeClick}\n                direction={direction}\n                relationPairs={relationPairs}\n                className={classes.graph}\n                zoom=\"enabled\"\n                curve={curve}\n              />\n            </Paper>\n          </Grid>\n        </Grid>\n      </Content>\n    </Page>\n  );\n};\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAqDA,MAAM,SAAY,GAAA,UAAA;AAAA,EAChB,CAAU,KAAA,MAAA;AAAA,IACR,OAAS,EAAA;AAAA,MACP,SAAW,EAAA,CAAA;AAAA,KACb;AAAA,IACA,SAAW,EAAA;AAAA,MACT,MAAQ,EAAA,MAAA;AAAA,MACR,SAAW,EAAA,MAAA;AAAA,MACX,SAAW,EAAA,CAAA;AAAA,KACb;AAAA,IACA,UAAY,EAAA;AAAA,MACV,SAAW,EAAA,MAAA;AAAA,MACX,OAAS,EAAA,MAAA;AAAA,MACT,SAAW,EAAA,CAAA;AAAA,KACb;AAAA,IACA,YAAc,EAAA;AAAA,MACZ,QAAU,EAAA,UAAA;AAAA,MACV,IAAM,EAAA,CAAA;AAAA,MACN,SAAW,EAAA,CAAA;AAAA,MACX,OAAS,EAAA,MAAA;AAAA,KACX;AAAA,IACA,KAAO,EAAA;AAAA,MACL,IAAM,EAAA,CAAA;AAAA,MACN,SAAW,EAAA,CAAA;AAAA,KACb;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,QAAU,EAAA,UAAA;AAAA,MACV,MAAQ,EAAA,CAAA;AAAA,MACR,KAAO,EAAA,CAAA;AAAA,MACP,OAAA,EAAS,KAAM,CAAA,OAAA,CAAQ,CAAC,CAAA;AAAA,MACxB,SAAW,EAAA;AAAA,QACT,aAAe,EAAA,QAAA;AAAA,OACjB;AAAA,KACF;AAAA,IACA,OAAS,EAAA;AAAA,MACP,OAAS,EAAA,MAAA;AAAA,MACT,OAAA,EAAS,KAAM,CAAA,OAAA,CAAQ,CAAC,CAAA;AAAA,MACxB,YAAc,EAAA,MAAA;AAAA,MACd,CAAC,KAAM,CAAA,WAAA,CAAY,EAAG,CAAA,IAAI,CAAC,GAAG;AAAA,QAC5B,OAAS,EAAA,OAAA;AAAA,OACX;AAAA,MACA,CAAC,KAAM,CAAA,WAAA,CAAY,IAAK,CAAA,IAAI,CAAC,GAAG;AAAA,QAC9B,mBAAqB,EAAA,gBAAA;AAAA,OACvB;AAAA,MACA,CAAC,KAAM,CAAA,WAAA,CAAY,IAAK,CAAA,IAAI,CAAC,GAAG;AAAA,QAC9B,mBAAqB,EAAA,gBAAA;AAAA,OACvB;AAAA,MACA,CAAC,KAAM,CAAA,WAAA,CAAY,IAAK,CAAA,IAAI,CAAC,GAAG;AAAA,QAC9B,mBAAqB,EAAA,gBAAA;AAAA,OACvB;AAAA,KACF;AAAA,GACF,CAAA;AAAA,EACA,EAAE,MAAM,oCAAqC,EAAA;AAC/C,CAAA,CAAA;AAEa,MAAA,gBAAA,GAAmB,CAC9B,KAaG,KAAA;AACH,EAAA,MAAM,EAAE,aAAA,GAAgB,kBAAoB,EAAA,YAAA,EAAiB,GAAA,KAAA,CAAA;AAE7D,EAAA,MAAM,WAAW,WAAY,EAAA,CAAA;AAC7B,EAAA,MAAM,UAAU,SAAU,EAAA,CAAA;AAC1B,EAAM,MAAA,kBAAA,GAAqB,YAAY,cAAc,CAAA,CAAA;AACrD,EAAM,MAAA;AAAA,IACJ,QAAA;AAAA,IACA,WAAA;AAAA,IACA,aAAA;AAAA,IACA,gBAAA;AAAA,IACA,iBAAA;AAAA,IACA,oBAAA;AAAA,IACA,cAAA;AAAA,IACA,iBAAA;AAAA,IACA,cAAA;AAAA,IACA,iBAAA;AAAA,IACA,SAAA;AAAA,IACA,YAAA;AAAA,IACA,KAAA;AAAA,IACA,QAAA;AAAA,IACA,eAAA;AAAA,IACA,kBAAA;AAAA,IACA,WAAA;AAAA,IACA,iBAAA;AAAA,GACE,GAAA,mBAAA,CAAoB,EAAE,YAAA,EAAc,CAAA,CAAA;AACxC,EAAA,MAAM,YAAY,YAAa,EAAA,CAAA;AAC/B,EAAA,MAAM,WAAc,GAAA,WAAA;AAAA,IAClB,CAAC,MAAkB,KAA+B,KAAA;AAChD,MAAM,MAAA,cAAA,GAAiB,cAAe,CAAA,IAAA,CAAK,EAAE,CAAA,CAAA;AAE7C,MAAA,IAAI,MAAM,QAAU,EAAA;AAClB,QAAA,MAAM,OAAO,kBAAmB,CAAA;AAAA,UAC9B,IAAM,EAAA,cAAA,CAAe,IAAK,CAAA,iBAAA,CAAkB,OAAO,CAAA;AAAA,UACnD,SAAW,EAAA,cAAA,CAAe,SAAU,CAAA,iBAAA,CAAkB,OAAO,CAAA;AAAA,UAC7D,MAAM,cAAe,CAAA,IAAA;AAAA,SACtB,CAAA,CAAA;AAED,QAAU,SAAA,CAAA,YAAA;AAAA,UACR,OAAA;AAAA,UACA,IAAK,CAAA,MAAA,CAAO,QAAS,CAAA,KAAA,IAAS,kBAAkB,cAAc,CAAA;AAAA,UAC9D,EAAE,UAAA,EAAY,EAAE,EAAA,EAAI,MAAO,EAAA;AAAA,SAC7B,CAAA;AACA,QAAA,QAAA,CAAS,IAAI,CAAA,CAAA;AAAA,OACR,MAAA;AACL,QAAU,SAAA,CAAA,YAAA;AAAA,UACR,OAAA;AAAA,UACA,IAAK,CAAA,MAAA,CAAO,QAAS,CAAA,KAAA,IAAS,kBAAkB,cAAc,CAAA;AAAA,SAChE,CAAA;AACA,QAAmB,kBAAA,CAAA,CAAC,cAAc,CAAC,CAAA,CAAA;AAAA,OACrC;AAAA,KACF;AAAA,IACA,CAAC,kBAAA,EAAoB,QAAU,EAAA,kBAAA,EAAoB,SAAS,CAAA;AAAA,GAC9D,CAAA;AAEA,EACE,uBAAA,KAAA,CAAA,aAAA,CAAC,IAAK,EAAA,EAAA,OAAA,EAAQ,MACZ,EAAA,kBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,MAAA;AAAA,IAAA;AAAA,MACC,KAAM,EAAA,eAAA;AAAA,MACN,QAAA,EAAU,gBAAgB,GAAI,CAAA,CAAA,CAAA,KAAK,kBAAkB,CAAC,CAAC,CAAE,CAAA,IAAA,CAAK,IAAI,CAAA;AAAA,KAAA;AAAA,qBAEnE,KAAA,CAAA,aAAA,CAAA,OAAA,EAAA,EAAQ,SAAO,IAAC,EAAA,SAAA,EAAW,QAAQ,OAClC,EAAA,kBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,aAAA;AAAA,IAAA;AAAA,MACC,cACE,kBAAA,KAAA,CAAA,aAAA;AAAA,QAAC,YAAA;AAAA,QAAA;AAAA,UACC,KAAM,EAAA,cAAA;AAAA,UACN,QAAU,EAAA,WAAA;AAAA,UACV,QAAA,EAAU,MAAM,iBAAkB,EAAA;AAAA,SAAA;AAAA,4CAEjC,cAAe,EAAA,IAAA,CAAA;AAAA,QAAE,UAAA;AAAA,OACpB;AAAA,KAAA;AAAA,oBAGF,KAAA,CAAA,aAAA,CAAC,qBAAc,wEAGf,CAAA;AAAA,GAEF,kBAAA,KAAA,CAAA,aAAA,CAAC,IAAK,EAAA,EAAA,SAAA,EAAS,IAAC,EAAA,UAAA,EAAW,SAAU,EAAA,SAAA,EAAW,OAAQ,CAAA,SAAA,EAAA,EACrD,WACC,oBAAA,KAAA,CAAA,aAAA,CAAC,IAAK,EAAA,EAAA,IAAA,EAAI,IAAC,EAAA,EAAA,EAAI,EAAI,EAAA,EAAA,EAAI,CAAG,EAAA,SAAA,EAAW,OAAQ,CAAA,OAAA,EAAA,kBAC1C,KAAA,CAAA,aAAA,CAAA,cAAA,EAAA,EAAe,KAAO,EAAA,QAAA,EAAU,QAAU,EAAA,WAAA,EAAa,CACxD,kBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,mBAAA;AAAA,IAAA;AAAA,MACC,KAAO,EAAA,aAAA;AAAA,MACP,QAAU,EAAA,gBAAA;AAAA,KAAA;AAAA,GAEZ,kBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,uBAAA;AAAA,IAAA;AAAA,MACC,KAAO,EAAA,iBAAA;AAAA,MACP,QAAU,EAAA,oBAAA;AAAA,MACV,aAAA;AAAA,KAAA;AAAA,GAEF,kBAAA,KAAA,CAAA,aAAA,CAAC,eAAgB,EAAA,EAAA,KAAA,EAAO,WAAW,QAAU,EAAA,YAAA,EAAc,CAC3D,kBAAA,KAAA,CAAA,aAAA,CAAC,WAAY,EAAA,EAAA,KAAA,EAAO,KAAO,EAAA,QAAA,EAAU,UAAU,CAC/C,kBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,YAAA;AAAA,IAAA;AAAA,MACC,KAAO,EAAA,cAAA;AAAA,MACP,QAAU,EAAA,iBAAA;AAAA,MACV,KAAM,EAAA,YAAA;AAAA,KAAA;AAAA,GAER,kBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,YAAA;AAAA,IAAA;AAAA,MACC,KAAO,EAAA,cAAA;AAAA,MACP,QAAU,EAAA,iBAAA;AAAA,MACV,KAAM,EAAA,iBAAA;AAAA,KAAA;AAAA,GAEV,CAAA,kBAED,KAAA,CAAA,aAAA,CAAA,IAAA,EAAA,EAAK,MAAI,IAAC,EAAA,EAAA,EAAE,IAAC,EAAA,SAAA,EAAW,QAAQ,UAC/B,EAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,KAAM,EAAA,EAAA,SAAA,EAAW,QAAQ,YACxB,EAAA,kBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,UAAA;AAAA,IAAA;AAAA,MACC,OAAQ,EAAA,SAAA;AAAA,MACR,KAAM,EAAA,eAAA;AAAA,MACN,OAAQ,EAAA,OAAA;AAAA,MACR,WAAW,OAAQ,CAAA,MAAA;AAAA,KAAA;AAAA,oBAEnB,KAAA,CAAA,aAAA,CAAC,UAAW,EAAA,EAAA,SAAA,EAAU,MAAO,EAAA,CAAA;AAAA,IAAE,+GAAA;AAAA,GAIjC,kBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,oBAAA;AAAA,IAAA;AAAA,MACE,GAAG,KAAA;AAAA,MACJ,eAAA;AAAA,MACA,QAAA;AAAA,MACA,KACE,EAAA,aAAA,IAAiB,aAAc,CAAA,MAAA,GAAS,IACpC,aACA,GAAA,KAAA,CAAA;AAAA,MAEN,SACE,EAAA,iBAAA,IAAqB,iBAAkB,CAAA,MAAA,GAAS,IAC5C,iBACA,GAAA,KAAA,CAAA;AAAA,MAEN,cAAA;AAAA,MACA,cAAA;AAAA,MACA,WAAA;AAAA,MACA,SAAA;AAAA,MACA,aAAA;AAAA,MACA,WAAW,OAAQ,CAAA,KAAA;AAAA,MACnB,IAAK,EAAA,SAAA;AAAA,MACL,KAAA;AAAA,KAAA;AAAA,GAEJ,CACF,CACF,CACF,CACF,CAAA,CAAA;AAEJ;;;;"}
+{"version":3,"file":"CatalogGraphPage.esm.js","sources":["../../../src/components/CatalogGraphPage/CatalogGraphPage.tsx"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { parseEntityRef } from '@backstage/catalog-model';\nimport {\n  Content,\n  ContentHeader,\n  Header,\n  Page,\n  SupportButton,\n} from '@backstage/core-components';\nimport { useAnalytics, useRouteRef } from '@backstage/core-plugin-api';\nimport {\n  entityRouteRef,\n  humanizeEntityRef,\n} from '@backstage/plugin-catalog-react';\nimport Grid from '@material-ui/core/Grid';\nimport Paper from '@material-ui/core/Paper';\nimport Typography from '@material-ui/core/Typography';\nimport { makeStyles } from '@material-ui/core/styles';\nimport FilterListIcon from '@material-ui/icons/FilterList';\nimport ZoomOutMap from '@material-ui/icons/ZoomOutMap';\nimport ToggleButton from '@material-ui/lab/ToggleButton';\nimport React, { MouseEvent, useCallback } from 'react';\nimport { useNavigate } from 'react-router-dom';\nimport {\n  ALL_RELATION_PAIRS,\n  Direction,\n  EntityNode,\n  EntityRelationsGraph,\n  EntityRelationsGraphProps,\n} from '../EntityRelationsGraph';\nimport { CurveFilter } from './CurveFilter';\nimport { DirectionFilter } from './DirectionFilter';\nimport { MaxDepthFilter } from './MaxDepthFilter';\nimport { SelectedKindsFilter } from './SelectedKindsFilter';\nimport { SelectedRelationsFilter } from './SelectedRelationsFilter';\nimport { SwitchFilter } from './SwitchFilter';\nimport { useCatalogGraphPage } from './useCatalogGraphPage';\n\nconst useStyles = makeStyles(\n  theme => ({\n    content: {\n      minHeight: 0,\n    },\n    container: {\n      height: '100%',\n      maxHeight: '100%',\n      minHeight: 0,\n    },\n    fullHeight: {\n      maxHeight: '100%',\n      display: 'flex',\n      minHeight: 0,\n    },\n    graphWrapper: {\n      position: 'relative',\n      flex: 1,\n      minHeight: 0,\n      display: 'flex',\n    },\n    graph: {\n      flex: 1,\n      minHeight: 0,\n    },\n    legend: {\n      position: 'absolute',\n      bottom: 0,\n      right: 0,\n      padding: theme.spacing(1),\n      '& .icon': {\n        verticalAlign: 'bottom',\n      },\n    },\n    filters: {\n      display: 'grid',\n      gridGap: theme.spacing(1),\n      gridAutoRows: 'auto',\n      [theme.breakpoints.up('lg')]: {\n        display: 'block',\n      },\n      [theme.breakpoints.only('md')]: {\n        gridTemplateColumns: 'repeat(3, 1fr)',\n      },\n      [theme.breakpoints.only('sm')]: {\n        gridTemplateColumns: 'repeat(2, 1fr)',\n      },\n      [theme.breakpoints.down('xs')]: {\n        gridTemplateColumns: 'repeat(1, 1fr)',\n      },\n    },\n  }),\n  { name: 'PluginCatalogGraphCatalogGraphPage' },\n);\n\nexport const CatalogGraphPage = (\n  props: {\n    initialState?: {\n      selectedRelations?: string[];\n      selectedKinds?: string[];\n      rootEntityRefs?: string[];\n      maxDepth?: number;\n      unidirectional?: boolean;\n      mergeRelations?: boolean;\n      direction?: Direction;\n      showFilters?: boolean;\n      curve?: 'curveStepBefore' | 'curveMonotoneX';\n    };\n  } & Partial<EntityRelationsGraphProps>,\n) => {\n  const {\n    relationPairs = ALL_RELATION_PAIRS,\n    initialState,\n    entityFilter,\n  } = props;\n\n  const navigate = useNavigate();\n  const classes = useStyles();\n  const catalogEntityRoute = useRouteRef(entityRouteRef);\n  const {\n    maxDepth,\n    setMaxDepth,\n    selectedKinds,\n    setSelectedKinds,\n    selectedRelations,\n    setSelectedRelations,\n    unidirectional,\n    setUnidirectional,\n    mergeRelations,\n    setMergeRelations,\n    direction,\n    setDirection,\n    curve,\n    setCurve,\n    rootEntityNames,\n    setRootEntityNames,\n    showFilters,\n    toggleShowFilters,\n  } = useCatalogGraphPage({ initialState });\n  const analytics = useAnalytics();\n  const onNodeClick = useCallback(\n    (node: EntityNode, event: MouseEvent<unknown>) => {\n      const nodeEntityName = parseEntityRef(node.id);\n\n      if (event.shiftKey) {\n        const path = catalogEntityRoute({\n          kind: nodeEntityName.kind.toLocaleLowerCase('en-US'),\n          namespace: nodeEntityName.namespace.toLocaleLowerCase('en-US'),\n          name: nodeEntityName.name,\n        });\n\n        analytics.captureEvent(\n          'click',\n          node.entity.metadata.title ?? humanizeEntityRef(nodeEntityName),\n          { attributes: { to: path } },\n        );\n        navigate(path);\n      } else {\n        analytics.captureEvent(\n          'click',\n          node.entity.metadata.title ?? humanizeEntityRef(nodeEntityName),\n        );\n        setRootEntityNames([nodeEntityName]);\n      }\n    },\n    [catalogEntityRoute, navigate, setRootEntityNames, analytics],\n  );\n\n  return (\n    <Page themeId=\"home\">\n      <Header\n        title=\"Catalog Graph\"\n        subtitle={rootEntityNames.map(e => humanizeEntityRef(e)).join(', ')}\n      />\n      <Content stretch className={classes.content}>\n        <ContentHeader\n          titleComponent={\n            <ToggleButton\n              value=\"show filters\"\n              selected={showFilters}\n              onChange={() => toggleShowFilters()}\n            >\n              <FilterListIcon /> Filters\n            </ToggleButton>\n          }\n        >\n          <SupportButton>\n            Start tracking your component in by adding it to the software\n            catalog.\n          </SupportButton>\n        </ContentHeader>\n        <Grid container alignItems=\"stretch\" className={classes.container}>\n          {showFilters && (\n            <Grid item xs={12} lg={2} className={classes.filters}>\n              <MaxDepthFilter value={maxDepth} onChange={setMaxDepth} />\n              <SelectedKindsFilter\n                value={selectedKinds}\n                onChange={setSelectedKinds}\n              />\n              <SelectedRelationsFilter\n                value={selectedRelations}\n                onChange={setSelectedRelations}\n                relationPairs={relationPairs}\n              />\n              <DirectionFilter value={direction} onChange={setDirection} />\n              <CurveFilter value={curve} onChange={setCurve} />\n              <SwitchFilter\n                value={unidirectional}\n                onChange={setUnidirectional}\n                label=\"Simplified\"\n              />\n              <SwitchFilter\n                value={mergeRelations}\n                onChange={setMergeRelations}\n                label=\"Merge Relations\"\n              />\n            </Grid>\n          )}\n          <Grid item xs className={classes.fullHeight}>\n            <Paper className={classes.graphWrapper}>\n              <Typography\n                variant=\"caption\"\n                color=\"textSecondary\"\n                display=\"block\"\n                className={classes.legend}\n              >\n                <ZoomOutMap className=\"icon\" /> Use pinch &amp; zoom to move\n                around the diagram. Click to change active node, shift click to\n                navigate to entity.\n              </Typography>\n              <EntityRelationsGraph\n                {...props}\n                rootEntityNames={rootEntityNames}\n                maxDepth={maxDepth}\n                kinds={\n                  selectedKinds && selectedKinds.length > 0\n                    ? selectedKinds\n                    : undefined\n                }\n                relations={\n                  selectedRelations && selectedRelations.length > 0\n                    ? selectedRelations\n                    : undefined\n                }\n                mergeRelations={mergeRelations}\n                unidirectional={unidirectional}\n                onNodeClick={onNodeClick}\n                direction={direction}\n                relationPairs={relationPairs}\n                entityFilter={entityFilter}\n                className={classes.graph}\n                zoom=\"enabled\"\n                curve={curve}\n              />\n            </Paper>\n          </Grid>\n        </Grid>\n      </Content>\n    </Page>\n  );\n};\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAqDA,MAAM,SAAY,GAAA,UAAA;AAAA,EAChB,CAAU,KAAA,MAAA;AAAA,IACR,OAAS,EAAA;AAAA,MACP,SAAW,EAAA,CAAA;AAAA,KACb;AAAA,IACA,SAAW,EAAA;AAAA,MACT,MAAQ,EAAA,MAAA;AAAA,MACR,SAAW,EAAA,MAAA;AAAA,MACX,SAAW,EAAA,CAAA;AAAA,KACb;AAAA,IACA,UAAY,EAAA;AAAA,MACV,SAAW,EAAA,MAAA;AAAA,MACX,OAAS,EAAA,MAAA;AAAA,MACT,SAAW,EAAA,CAAA;AAAA,KACb;AAAA,IACA,YAAc,EAAA;AAAA,MACZ,QAAU,EAAA,UAAA;AAAA,MACV,IAAM,EAAA,CAAA;AAAA,MACN,SAAW,EAAA,CAAA;AAAA,MACX,OAAS,EAAA,MAAA;AAAA,KACX;AAAA,IACA,KAAO,EAAA;AAAA,MACL,IAAM,EAAA,CAAA;AAAA,MACN,SAAW,EAAA,CAAA;AAAA,KACb;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,QAAU,EAAA,UAAA;AAAA,MACV,MAAQ,EAAA,CAAA;AAAA,MACR,KAAO,EAAA,CAAA;AAAA,MACP,OAAA,EAAS,KAAM,CAAA,OAAA,CAAQ,CAAC,CAAA;AAAA,MACxB,SAAW,EAAA;AAAA,QACT,aAAe,EAAA,QAAA;AAAA,OACjB;AAAA,KACF;AAAA,IACA,OAAS,EAAA;AAAA,MACP,OAAS,EAAA,MAAA;AAAA,MACT,OAAA,EAAS,KAAM,CAAA,OAAA,CAAQ,CAAC,CAAA;AAAA,MACxB,YAAc,EAAA,MAAA;AAAA,MACd,CAAC,KAAM,CAAA,WAAA,CAAY,EAAG,CAAA,IAAI,CAAC,GAAG;AAAA,QAC5B,OAAS,EAAA,OAAA;AAAA,OACX;AAAA,MACA,CAAC,KAAM,CAAA,WAAA,CAAY,IAAK,CAAA,IAAI,CAAC,GAAG;AAAA,QAC9B,mBAAqB,EAAA,gBAAA;AAAA,OACvB;AAAA,MACA,CAAC,KAAM,CAAA,WAAA,CAAY,IAAK,CAAA,IAAI,CAAC,GAAG;AAAA,QAC9B,mBAAqB,EAAA,gBAAA;AAAA,OACvB;AAAA,MACA,CAAC,KAAM,CAAA,WAAA,CAAY,IAAK,CAAA,IAAI,CAAC,GAAG;AAAA,QAC9B,mBAAqB,EAAA,gBAAA;AAAA,OACvB;AAAA,KACF;AAAA,GACF,CAAA;AAAA,EACA,EAAE,MAAM,oCAAqC,EAAA;AAC/C,CAAA,CAAA;AAEa,MAAA,gBAAA,GAAmB,CAC9B,KAaG,KAAA;AACH,EAAM,MAAA;AAAA,IACJ,aAAgB,GAAA,kBAAA;AAAA,IAChB,YAAA;AAAA,IACA,YAAA;AAAA,GACE,GAAA,KAAA,CAAA;AAEJ,EAAA,MAAM,WAAW,WAAY,EAAA,CAAA;AAC7B,EAAA,MAAM,UAAU,SAAU,EAAA,CAAA;AAC1B,EAAM,MAAA,kBAAA,GAAqB,YAAY,cAAc,CAAA,CAAA;AACrD,EAAM,MAAA;AAAA,IACJ,QAAA;AAAA,IACA,WAAA;AAAA,IACA,aAAA;AAAA,IACA,gBAAA;AAAA,IACA,iBAAA;AAAA,IACA,oBAAA;AAAA,IACA,cAAA;AAAA,IACA,iBAAA;AAAA,IACA,cAAA;AAAA,IACA,iBAAA;AAAA,IACA,SAAA;AAAA,IACA,YAAA;AAAA,IACA,KAAA;AAAA,IACA,QAAA;AAAA,IACA,eAAA;AAAA,IACA,kBAAA;AAAA,IACA,WAAA;AAAA,IACA,iBAAA;AAAA,GACE,GAAA,mBAAA,CAAoB,EAAE,YAAA,EAAc,CAAA,CAAA;AACxC,EAAA,MAAM,YAAY,YAAa,EAAA,CAAA;AAC/B,EAAA,MAAM,WAAc,GAAA,WAAA;AAAA,IAClB,CAAC,MAAkB,KAA+B,KAAA;AAChD,MAAM,MAAA,cAAA,GAAiB,cAAe,CAAA,IAAA,CAAK,EAAE,CAAA,CAAA;AAE7C,MAAA,IAAI,MAAM,QAAU,EAAA;AAClB,QAAA,MAAM,OAAO,kBAAmB,CAAA;AAAA,UAC9B,IAAM,EAAA,cAAA,CAAe,IAAK,CAAA,iBAAA,CAAkB,OAAO,CAAA;AAAA,UACnD,SAAW,EAAA,cAAA,CAAe,SAAU,CAAA,iBAAA,CAAkB,OAAO,CAAA;AAAA,UAC7D,MAAM,cAAe,CAAA,IAAA;AAAA,SACtB,CAAA,CAAA;AAED,QAAU,SAAA,CAAA,YAAA;AAAA,UACR,OAAA;AAAA,UACA,IAAK,CAAA,MAAA,CAAO,QAAS,CAAA,KAAA,IAAS,kBAAkB,cAAc,CAAA;AAAA,UAC9D,EAAE,UAAA,EAAY,EAAE,EAAA,EAAI,MAAO,EAAA;AAAA,SAC7B,CAAA;AACA,QAAA,QAAA,CAAS,IAAI,CAAA,CAAA;AAAA,OACR,MAAA;AACL,QAAU,SAAA,CAAA,YAAA;AAAA,UACR,OAAA;AAAA,UACA,IAAK,CAAA,MAAA,CAAO,QAAS,CAAA,KAAA,IAAS,kBAAkB,cAAc,CAAA;AAAA,SAChE,CAAA;AACA,QAAmB,kBAAA,CAAA,CAAC,cAAc,CAAC,CAAA,CAAA;AAAA,OACrC;AAAA,KACF;AAAA,IACA,CAAC,kBAAA,EAAoB,QAAU,EAAA,kBAAA,EAAoB,SAAS,CAAA;AAAA,GAC9D,CAAA;AAEA,EACE,uBAAA,KAAA,CAAA,aAAA,CAAC,IAAK,EAAA,EAAA,OAAA,EAAQ,MACZ,EAAA,kBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,MAAA;AAAA,IAAA;AAAA,MACC,KAAM,EAAA,eAAA;AAAA,MACN,QAAA,EAAU,gBAAgB,GAAI,CAAA,CAAA,CAAA,KAAK,kBAAkB,CAAC,CAAC,CAAE,CAAA,IAAA,CAAK,IAAI,CAAA;AAAA,KAAA;AAAA,qBAEnE,KAAA,CAAA,aAAA,CAAA,OAAA,EAAA,EAAQ,SAAO,IAAC,EAAA,SAAA,EAAW,QAAQ,OAClC,EAAA,kBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,aAAA;AAAA,IAAA;AAAA,MACC,cACE,kBAAA,KAAA,CAAA,aAAA;AAAA,QAAC,YAAA;AAAA,QAAA;AAAA,UACC,KAAM,EAAA,cAAA;AAAA,UACN,QAAU,EAAA,WAAA;AAAA,UACV,QAAA,EAAU,MAAM,iBAAkB,EAAA;AAAA,SAAA;AAAA,4CAEjC,cAAe,EAAA,IAAA,CAAA;AAAA,QAAE,UAAA;AAAA,OACpB;AAAA,KAAA;AAAA,oBAGF,KAAA,CAAA,aAAA,CAAC,qBAAc,wEAGf,CAAA;AAAA,GAEF,kBAAA,KAAA,CAAA,aAAA,CAAC,IAAK,EAAA,EAAA,SAAA,EAAS,IAAC,EAAA,UAAA,EAAW,SAAU,EAAA,SAAA,EAAW,OAAQ,CAAA,SAAA,EAAA,EACrD,WACC,oBAAA,KAAA,CAAA,aAAA,CAAC,IAAK,EAAA,EAAA,IAAA,EAAI,IAAC,EAAA,EAAA,EAAI,EAAI,EAAA,EAAA,EAAI,CAAG,EAAA,SAAA,EAAW,OAAQ,CAAA,OAAA,EAAA,kBAC1C,KAAA,CAAA,aAAA,CAAA,cAAA,EAAA,EAAe,KAAO,EAAA,QAAA,EAAU,QAAU,EAAA,WAAA,EAAa,CACxD,kBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,mBAAA;AAAA,IAAA;AAAA,MACC,KAAO,EAAA,aAAA;AAAA,MACP,QAAU,EAAA,gBAAA;AAAA,KAAA;AAAA,GAEZ,kBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,uBAAA;AAAA,IAAA;AAAA,MACC,KAAO,EAAA,iBAAA;AAAA,MACP,QAAU,EAAA,oBAAA;AAAA,MACV,aAAA;AAAA,KAAA;AAAA,GAEF,kBAAA,KAAA,CAAA,aAAA,CAAC,eAAgB,EAAA,EAAA,KAAA,EAAO,WAAW,QAAU,EAAA,YAAA,EAAc,CAC3D,kBAAA,KAAA,CAAA,aAAA,CAAC,WAAY,EAAA,EAAA,KAAA,EAAO,KAAO,EAAA,QAAA,EAAU,UAAU,CAC/C,kBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,YAAA;AAAA,IAAA;AAAA,MACC,KAAO,EAAA,cAAA;AAAA,MACP,QAAU,EAAA,iBAAA;AAAA,MACV,KAAM,EAAA,YAAA;AAAA,KAAA;AAAA,GAER,kBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,YAAA;AAAA,IAAA;AAAA,MACC,KAAO,EAAA,cAAA;AAAA,MACP,QAAU,EAAA,iBAAA;AAAA,MACV,KAAM,EAAA,iBAAA;AAAA,KAAA;AAAA,GAEV,CAAA,kBAED,KAAA,CAAA,aAAA,CAAA,IAAA,EAAA,EAAK,MAAI,IAAC,EAAA,EAAA,EAAE,IAAC,EAAA,SAAA,EAAW,QAAQ,UAC/B,EAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,KAAM,EAAA,EAAA,SAAA,EAAW,QAAQ,YACxB,EAAA,kBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,UAAA;AAAA,IAAA;AAAA,MACC,OAAQ,EAAA,SAAA;AAAA,MACR,KAAM,EAAA,eAAA;AAAA,MACN,OAAQ,EAAA,OAAA;AAAA,MACR,WAAW,OAAQ,CAAA,MAAA;AAAA,KAAA;AAAA,oBAEnB,KAAA,CAAA,aAAA,CAAC,UAAW,EAAA,EAAA,SAAA,EAAU,MAAO,EAAA,CAAA;AAAA,IAAE,+GAAA;AAAA,GAIjC,kBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,oBAAA;AAAA,IAAA;AAAA,MACE,GAAG,KAAA;AAAA,MACJ,eAAA;AAAA,MACA,QAAA;AAAA,MACA,KACE,EAAA,aAAA,IAAiB,aAAc,CAAA,MAAA,GAAS,IACpC,aACA,GAAA,KAAA,CAAA;AAAA,MAEN,SACE,EAAA,iBAAA,IAAqB,iBAAkB,CAAA,MAAA,GAAS,IAC5C,iBACA,GAAA,KAAA,CAAA;AAAA,MAEN,cAAA;AAAA,MACA,cAAA;AAAA,MACA,WAAA;AAAA,MACA,SAAA;AAAA,MACA,aAAA;AAAA,MACA,YAAA;AAAA,MACA,WAAW,OAAQ,CAAA,KAAA;AAAA,MACnB,IAAK,EAAA,SAAA;AAAA,MACL,KAAA;AAAA,KAAA;AAAA,GAEJ,CACF,CACF,CACF,CACF,CAAA,CAAA;AAEJ;;;;"}

package/dist/components/EntityRelationsGraph/EntityRelationsGraph.esm.js

@@ -52,6 +52,7 @@ const EntityRelationsGraph = (props) => {
     mergeRelations = true,
     kinds,
     relations,
+    entityFilter,
     direction = Direction.LEFT_RIGHT,
     onNodeClick,
     relationPairs = ALL_RELATION_PAIRS,
@@ -76,6 +77,7 @@ const EntityRelationsGraph = (props) => {
     mergeRelations,
     kinds,
     relations,
+    entityFilter,
     onNodeClick,
     relationPairs
   });

package/dist/components/EntityRelationsGraph/EntityRelationsGraph.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"EntityRelationsGraph.esm.js","sources":["../../../src/components/EntityRelationsGraph/EntityRelationsGraph.tsx"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  CompoundEntityRef,\n  stringifyEntityRef,\n} from '@backstage/catalog-model';\nimport {\n  DependencyGraph,\n  DependencyGraphTypes,\n} from '@backstage/core-components';\nimport { errorApiRef, useApi } from '@backstage/core-plugin-api';\nimport CircularProgress from '@material-ui/core/CircularProgress';\nimport { makeStyles, useTheme } from '@material-ui/core/styles';\nimport classNames from 'classnames';\nimport React, { MouseEvent, useEffect, useMemo } from 'react';\nimport { DefaultRenderLabel } from './DefaultRenderLabel';\nimport { DefaultRenderNode } from './DefaultRenderNode';\nimport { ALL_RELATION_PAIRS, RelationPairs } from './relations';\nimport { Direction, EntityEdge, EntityNode } from './types';\nimport { useEntityRelationNodesAndEdges } from './useEntityRelationNodesAndEdges';\n\nconst useStyles = makeStyles(\n  theme => ({\n    progress: {\n      position: 'absolute',\n      left: '50%',\n      top: '50%',\n      marginLeft: '-20px',\n      marginTop: '-20px',\n    },\n    container: {\n      position: 'relative',\n      width: '100%',\n      display: 'flex',\n      flexDirection: 'column',\n    },\n    graph: {\n      width: '100%',\n      flex: 1,\n      // Right now there is no good way to style edges between nodes, we have to\n      // fall back to these hacks:\n      '& path[marker-end]': {\n        transition: 'filter 0.1s ease-in-out',\n      },\n      '& path[marker-end]:hover': {\n        filter: `drop-shadow(2px 2px 4px ${theme.palette.primary.dark});`,\n      },\n      '& g[data-testid=label]': {\n        transition: 'transform 0s',\n      },\n    },\n  }),\n  { name: 'PluginCatalogGraphEntityRelationsGraph' },\n);\n\n/**\n * @public\n */\nexport type EntityRelationsGraphProps = {\n  rootEntityNames: CompoundEntityRef | CompoundEntityRef[];\n  maxDepth?: number;\n  unidirectional?: boolean;\n  mergeRelations?: boolean;\n  kinds?: string[];\n  relations?: string[];\n  direction?: Direction;\n  onNodeClick?: (value: EntityNode, event: MouseEvent<unknown>) => void;\n  relationPairs?: RelationPairs;\n  className?: string;\n  zoom?: 'enabled' | 'disabled' | 'enable-on-click';\n  renderNode?: DependencyGraphTypes.RenderNodeFunction<EntityNode>;\n  renderLabel?: DependencyGraphTypes.RenderLabelFunction<EntityEdge>;\n  curve?: 'curveStepBefore' | 'curveMonotoneX';\n  showArrowHeads?: boolean;\n};\n\n/**\n * Core building block for custom entity relations diagrams.\n *\n * @public\n */\nexport const EntityRelationsGraph = (props: EntityRelationsGraphProps) => {\n  const {\n    rootEntityNames,\n    maxDepth = 2,\n    unidirectional = true,\n    mergeRelations = true,\n    kinds,\n    relations,\n    direction = Direction.LEFT_RIGHT,\n    onNodeClick,\n    relationPairs = ALL_RELATION_PAIRS,\n    className,\n    zoom = 'enabled',\n    renderNode,\n    renderLabel,\n    curve,\n    showArrowHeads,\n  } = props;\n\n  const theme = useTheme();\n  const classes = useStyles();\n  const rootEntityRefs = useMemo(\n    () =>\n      (Array.isArray(rootEntityNames)\n        ? rootEntityNames\n        : [rootEntityNames]\n      ).map(e => stringifyEntityRef(e)),\n    [rootEntityNames],\n  );\n  const errorApi = useApi(errorApiRef);\n  const { loading, error, nodes, edges } = useEntityRelationNodesAndEdges({\n    rootEntityRefs,\n    maxDepth,\n    unidirectional,\n    mergeRelations,\n    kinds,\n    relations,\n    onNodeClick,\n    relationPairs,\n  });\n\n  useEffect(() => {\n    if (error) {\n      errorApi.post(error);\n    }\n  }, [errorApi, error]);\n\n  return (\n    <div className={classNames(classes.container, className)}>\n      {loading && <CircularProgress className={classes.progress} />}\n      {nodes && edges && (\n        <DependencyGraph\n          nodes={nodes}\n          edges={edges}\n          renderNode={renderNode || DefaultRenderNode}\n          renderLabel={renderLabel || DefaultRenderLabel}\n          direction={direction}\n          className={classes.graph}\n          paddingX={theme.spacing(4)}\n          paddingY={theme.spacing(4)}\n          labelPosition={DependencyGraphTypes.LabelPosition.RIGHT}\n          labelOffset={theme.spacing(1)}\n          zoom={zoom}\n          curve={curve}\n          showArrowHeads={showArrowHeads}\n        />\n      )}\n    </div>\n  );\n};\n"],"names":[],"mappings":";;;;;;;;;;;;;AAmCA,MAAM,SAAY,GAAA,UAAA;AAAA,EAChB,CAAU,KAAA,MAAA;AAAA,IACR,QAAU,EAAA;AAAA,MACR,QAAU,EAAA,UAAA;AAAA,MACV,IAAM,EAAA,KAAA;AAAA,MACN,GAAK,EAAA,KAAA;AAAA,MACL,UAAY,EAAA,OAAA;AAAA,MACZ,SAAW,EAAA,OAAA;AAAA,KACb;AAAA,IACA,SAAW,EAAA;AAAA,MACT,QAAU,EAAA,UAAA;AAAA,MACV,KAAO,EAAA,MAAA;AAAA,MACP,OAAS,EAAA,MAAA;AAAA,MACT,aAAe,EAAA,QAAA;AAAA,KACjB;AAAA,IACA,KAAO,EAAA;AAAA,MACL,KAAO,EAAA,MAAA;AAAA,MACP,IAAM,EAAA,CAAA;AAAA;AAAA;AAAA,MAGN,oBAAsB,EAAA;AAAA,QACpB,UAAY,EAAA,yBAAA;AAAA,OACd;AAAA,MACA,0BAA4B,EAAA;AAAA,QAC1B,MAAQ,EAAA,CAAA,wBAAA,EAA2B,KAAM,CAAA,OAAA,CAAQ,QAAQ,IAAI,CAAA,EAAA,CAAA;AAAA,OAC/D;AAAA,MACA,wBAA0B,EAAA;AAAA,QACxB,UAAY,EAAA,cAAA;AAAA,OACd;AAAA,KACF;AAAA,GACF,CAAA;AAAA,EACA,EAAE,MAAM,wCAAyC,EAAA;AACnD,CAAA,CAAA;AA4Ba,MAAA,oBAAA,GAAuB,CAAC,KAAqC,KAAA;AACxE,EAAM,MAAA;AAAA,IACJ,eAAA;AAAA,IACA,QAAW,GAAA,CAAA;AAAA,IACX,cAAiB,GAAA,IAAA;AAAA,IACjB,cAAiB,GAAA,IAAA;AAAA,IACjB,KAAA;AAAA,IACA,SAAA;AAAA,IACA,YAAY,SAAU,CAAA,UAAA;AAAA,IACtB,WAAA;AAAA,IACA,aAAgB,GAAA,kBAAA;AAAA,IAChB,SAAA;AAAA,IACA,IAAO,GAAA,SAAA;AAAA,IACP,UAAA;AAAA,IACA,WAAA;AAAA,IACA,KAAA;AAAA,IACA,cAAA;AAAA,GACE,GAAA,KAAA,CAAA;AAEJ,EAAA,MAAM,QAAQ,QAAS,EAAA,CAAA;AACvB,EAAA,MAAM,UAAU,SAAU,EAAA,CAAA;AAC1B,EAAA,MAAM,cAAiB,GAAA,OAAA;AAAA,IACrB,MACG,CAAA,KAAA,CAAM,OAAQ,CAAA,eAAe,CAC1B,GAAA,eAAA,GACA,CAAC,eAAe,CAClB,EAAA,GAAA,CAAI,CAAK,CAAA,KAAA,kBAAA,CAAmB,CAAC,CAAC,CAAA;AAAA,IAClC,CAAC,eAAe,CAAA;AAAA,GAClB,CAAA;AACA,EAAM,MAAA,QAAA,GAAW,OAAO,WAAW,CAAA,CAAA;AACnC,EAAA,MAAM,EAAE,OAAS,EAAA,KAAA,EAAO,KAAO,EAAA,KAAA,KAAU,8BAA+B,CAAA;AAAA,IACtE,cAAA;AAAA,IACA,QAAA;AAAA,IACA,cAAA;AAAA,IACA,cAAA;AAAA,IACA,KAAA;AAAA,IACA,SAAA;AAAA,IACA,WAAA;AAAA,IACA,aAAA;AAAA,GACD,CAAA,CAAA;AAED,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,IAAI,KAAO,EAAA;AACT,MAAA,QAAA,CAAS,KAAK,KAAK,CAAA,CAAA;AAAA,KACrB;AAAA,GACC,EAAA,CAAC,QAAU,EAAA,KAAK,CAAC,CAAA,CAAA;AAEpB,EAAA,2CACG,KAAI,EAAA,EAAA,SAAA,EAAW,UAAW,CAAA,OAAA,CAAQ,WAAW,SAAS,CAAA,EAAA,EACpD,OAAW,oBAAA,KAAA,CAAA,aAAA,CAAC,oBAAiB,SAAW,EAAA,OAAA,CAAQ,QAAU,EAAA,CAAA,EAC1D,SAAS,KACR,oBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,eAAA;AAAA,IAAA;AAAA,MACC,KAAA;AAAA,MACA,KAAA;AAAA,MACA,YAAY,UAAc,IAAA,iBAAA;AAAA,MAC1B,aAAa,WAAe,IAAA,kBAAA;AAAA,MAC5B,SAAA;AAAA,MACA,WAAW,OAAQ,CAAA,KAAA;AAAA,MACnB,QAAA,EAAU,KAAM,CAAA,OAAA,CAAQ,CAAC,CAAA;AAAA,MACzB,QAAA,EAAU,KAAM,CAAA,OAAA,CAAQ,CAAC,CAAA;AAAA,MACzB,aAAA,EAAe,qBAAqB,aAAc,CAAA,KAAA;AAAA,MAClD,WAAA,EAAa,KAAM,CAAA,OAAA,CAAQ,CAAC,CAAA;AAAA,MAC5B,IAAA;AAAA,MACA,KAAA;AAAA,MACA,cAAA;AAAA,KAAA;AAAA,GAGN,CAAA,CAAA;AAEJ;;;;"}
+{"version":3,"file":"EntityRelationsGraph.esm.js","sources":["../../../src/components/EntityRelationsGraph/EntityRelationsGraph.tsx"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  CompoundEntityRef,\n  Entity,\n  stringifyEntityRef,\n} from '@backstage/catalog-model';\nimport {\n  DependencyGraph,\n  DependencyGraphTypes,\n} from '@backstage/core-components';\nimport { errorApiRef, useApi } from '@backstage/core-plugin-api';\nimport CircularProgress from '@material-ui/core/CircularProgress';\nimport { makeStyles, useTheme } from '@material-ui/core/styles';\nimport classNames from 'classnames';\nimport React, { MouseEvent, useEffect, useMemo } from 'react';\nimport { DefaultRenderLabel } from './DefaultRenderLabel';\nimport { DefaultRenderNode } from './DefaultRenderNode';\nimport { ALL_RELATION_PAIRS, RelationPairs } from './relations';\nimport { Direction, EntityEdge, EntityNode } from './types';\nimport { useEntityRelationNodesAndEdges } from './useEntityRelationNodesAndEdges';\n\nconst useStyles = makeStyles(\n  theme => ({\n    progress: {\n      position: 'absolute',\n      left: '50%',\n      top: '50%',\n      marginLeft: '-20px',\n      marginTop: '-20px',\n    },\n    container: {\n      position: 'relative',\n      width: '100%',\n      display: 'flex',\n      flexDirection: 'column',\n    },\n    graph: {\n      width: '100%',\n      flex: 1,\n      // Right now there is no good way to style edges between nodes, we have to\n      // fall back to these hacks:\n      '& path[marker-end]': {\n        transition: 'filter 0.1s ease-in-out',\n      },\n      '& path[marker-end]:hover': {\n        filter: `drop-shadow(2px 2px 4px ${theme.palette.primary.dark});`,\n      },\n      '& g[data-testid=label]': {\n        transition: 'transform 0s',\n      },\n    },\n  }),\n  { name: 'PluginCatalogGraphEntityRelationsGraph' },\n);\n\n/**\n * @public\n */\nexport type EntityRelationsGraphProps = {\n  rootEntityNames: CompoundEntityRef | CompoundEntityRef[];\n  maxDepth?: number;\n  unidirectional?: boolean;\n  mergeRelations?: boolean;\n  kinds?: string[];\n  relations?: string[];\n  entityFilter?: (entity: Entity) => boolean;\n  direction?: Direction;\n  onNodeClick?: (value: EntityNode, event: MouseEvent<unknown>) => void;\n  relationPairs?: RelationPairs;\n  className?: string;\n  zoom?: 'enabled' | 'disabled' | 'enable-on-click';\n  renderNode?: DependencyGraphTypes.RenderNodeFunction<EntityNode>;\n  renderLabel?: DependencyGraphTypes.RenderLabelFunction<EntityEdge>;\n  curve?: 'curveStepBefore' | 'curveMonotoneX';\n  showArrowHeads?: boolean;\n};\n\n/**\n * Core building block for custom entity relations diagrams.\n *\n * @public\n */\nexport const EntityRelationsGraph = (props: EntityRelationsGraphProps) => {\n  const {\n    rootEntityNames,\n    maxDepth = 2,\n    unidirectional = true,\n    mergeRelations = true,\n    kinds,\n    relations,\n    entityFilter,\n    direction = Direction.LEFT_RIGHT,\n    onNodeClick,\n    relationPairs = ALL_RELATION_PAIRS,\n    className,\n    zoom = 'enabled',\n    renderNode,\n    renderLabel,\n    curve,\n    showArrowHeads,\n  } = props;\n\n  const theme = useTheme();\n  const classes = useStyles();\n  const rootEntityRefs = useMemo(\n    () =>\n      (Array.isArray(rootEntityNames)\n        ? rootEntityNames\n        : [rootEntityNames]\n      ).map(e => stringifyEntityRef(e)),\n    [rootEntityNames],\n  );\n  const errorApi = useApi(errorApiRef);\n  const { loading, error, nodes, edges } = useEntityRelationNodesAndEdges({\n    rootEntityRefs,\n    maxDepth,\n    unidirectional,\n    mergeRelations,\n    kinds,\n    relations,\n    entityFilter,\n    onNodeClick,\n    relationPairs,\n  });\n\n  useEffect(() => {\n    if (error) {\n      errorApi.post(error);\n    }\n  }, [errorApi, error]);\n\n  return (\n    <div className={classNames(classes.container, className)}>\n      {loading && <CircularProgress className={classes.progress} />}\n      {nodes && edges && (\n        <DependencyGraph\n          nodes={nodes}\n          edges={edges}\n          renderNode={renderNode || DefaultRenderNode}\n          renderLabel={renderLabel || DefaultRenderLabel}\n          direction={direction}\n          className={classes.graph}\n          paddingX={theme.spacing(4)}\n          paddingY={theme.spacing(4)}\n          labelPosition={DependencyGraphTypes.LabelPosition.RIGHT}\n          labelOffset={theme.spacing(1)}\n          zoom={zoom}\n          curve={curve}\n          showArrowHeads={showArrowHeads}\n        />\n      )}\n    </div>\n  );\n};\n"],"names":[],"mappings":";;;;;;;;;;;;;AAoCA,MAAM,SAAY,GAAA,UAAA;AAAA,EAChB,CAAU,KAAA,MAAA;AAAA,IACR,QAAU,EAAA;AAAA,MACR,QAAU,EAAA,UAAA;AAAA,MACV,IAAM,EAAA,KAAA;AAAA,MACN,GAAK,EAAA,KAAA;AAAA,MACL,UAAY,EAAA,OAAA;AAAA,MACZ,SAAW,EAAA,OAAA;AAAA,KACb;AAAA,IACA,SAAW,EAAA;AAAA,MACT,QAAU,EAAA,UAAA;AAAA,MACV,KAAO,EAAA,MAAA;AAAA,MACP,OAAS,EAAA,MAAA;AAAA,MACT,aAAe,EAAA,QAAA;AAAA,KACjB;AAAA,IACA,KAAO,EAAA;AAAA,MACL,KAAO,EAAA,MAAA;AAAA,MACP,IAAM,EAAA,CAAA;AAAA;AAAA;AAAA,MAGN,oBAAsB,EAAA;AAAA,QACpB,UAAY,EAAA,yBAAA;AAAA,OACd;AAAA,MACA,0BAA4B,EAAA;AAAA,QAC1B,MAAQ,EAAA,CAAA,wBAAA,EAA2B,KAAM,CAAA,OAAA,CAAQ,QAAQ,IAAI,CAAA,EAAA,CAAA;AAAA,OAC/D;AAAA,MACA,wBAA0B,EAAA;AAAA,QACxB,UAAY,EAAA,cAAA;AAAA,OACd;AAAA,KACF;AAAA,GACF,CAAA;AAAA,EACA,EAAE,MAAM,wCAAyC,EAAA;AACnD,CAAA,CAAA;AA6Ba,MAAA,oBAAA,GAAuB,CAAC,KAAqC,KAAA;AACxE,EAAM,MAAA;AAAA,IACJ,eAAA;AAAA,IACA,QAAW,GAAA,CAAA;AAAA,IACX,cAAiB,GAAA,IAAA;AAAA,IACjB,cAAiB,GAAA,IAAA;AAAA,IACjB,KAAA;AAAA,IACA,SAAA;AAAA,IACA,YAAA;AAAA,IACA,YAAY,SAAU,CAAA,UAAA;AAAA,IACtB,WAAA;AAAA,IACA,aAAgB,GAAA,kBAAA;AAAA,IAChB,SAAA;AAAA,IACA,IAAO,GAAA,SAAA;AAAA,IACP,UAAA;AAAA,IACA,WAAA;AAAA,IACA,KAAA;AAAA,IACA,cAAA;AAAA,GACE,GAAA,KAAA,CAAA;AAEJ,EAAA,MAAM,QAAQ,QAAS,EAAA,CAAA;AACvB,EAAA,MAAM,UAAU,SAAU,EAAA,CAAA;AAC1B,EAAA,MAAM,cAAiB,GAAA,OAAA;AAAA,IACrB,MACG,CAAA,KAAA,CAAM,OAAQ,CAAA,eAAe,CAC1B,GAAA,eAAA,GACA,CAAC,eAAe,CAClB,EAAA,GAAA,CAAI,CAAK,CAAA,KAAA,kBAAA,CAAmB,CAAC,CAAC,CAAA;AAAA,IAClC,CAAC,eAAe,CAAA;AAAA,GAClB,CAAA;AACA,EAAM,MAAA,QAAA,GAAW,OAAO,WAAW,CAAA,CAAA;AACnC,EAAA,MAAM,EAAE,OAAS,EAAA,KAAA,EAAO,KAAO,EAAA,KAAA,KAAU,8BAA+B,CAAA;AAAA,IACtE,cAAA;AAAA,IACA,QAAA;AAAA,IACA,cAAA;AAAA,IACA,cAAA;AAAA,IACA,KAAA;AAAA,IACA,SAAA;AAAA,IACA,YAAA;AAAA,IACA,WAAA;AAAA,IACA,aAAA;AAAA,GACD,CAAA,CAAA;AAED,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,IAAI,KAAO,EAAA;AACT,MAAA,QAAA,CAAS,KAAK,KAAK,CAAA,CAAA;AAAA,KACrB;AAAA,GACC,EAAA,CAAC,QAAU,EAAA,KAAK,CAAC,CAAA,CAAA;AAEpB,EAAA,2CACG,KAAI,EAAA,EAAA,SAAA,EAAW,UAAW,CAAA,OAAA,CAAQ,WAAW,SAAS,CAAA,EAAA,EACpD,OAAW,oBAAA,KAAA,CAAA,aAAA,CAAC,oBAAiB,SAAW,EAAA,OAAA,CAAQ,QAAU,EAAA,CAAA,EAC1D,SAAS,KACR,oBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,eAAA;AAAA,IAAA;AAAA,MACC,KAAA;AAAA,MACA,KAAA;AAAA,MACA,YAAY,UAAc,IAAA,iBAAA;AAAA,MAC1B,aAAa,WAAe,IAAA,kBAAA;AAAA,MAC5B,SAAA;AAAA,MACA,WAAW,OAAQ,CAAA,KAAA;AAAA,MACnB,QAAA,EAAU,KAAM,CAAA,OAAA,CAAQ,CAAC,CAAA;AAAA,MACzB,QAAA,EAAU,KAAM,CAAA,OAAA,CAAQ,CAAC,CAAA;AAAA,MACzB,aAAA,EAAe,qBAAqB,aAAc,CAAA,KAAA;AAAA,MAClD,WAAA,EAAa,KAAM,CAAA,OAAA,CAAQ,CAAC,CAAA;AAAA,MAC5B,IAAA;AAAA,MACA,KAAA;AAAA,MACA,cAAA;AAAA,KAAA;AAAA,GAGN,CAAA,CAAA;AAEJ;;;;"}

package/dist/components/EntityRelationsGraph/useEntityRelationGraph.esm.js

@@ -1,9 +1,15 @@
 import { useEffect } from 'react';
 import { useEntityStore } from './useEntityStore.esm.js';
+import { pickBy } from 'lodash';
 
 function useEntityRelationGraph({
   rootEntityRefs,
-  filter: { maxDepth = Number.POSITIVE_INFINITY, relations, kinds } = {}
+  filter: {
+    maxDepth = Number.POSITIVE_INFINITY,
+    relations,
+    kinds,
+    entityFilter
+  } = {}
 }) {
   const { entities, loading, error, requestEntities } = useEntityStore();
   useEffect(() => {
@@ -19,6 +25,9 @@ function useEntityRelationGraph({
         const entity = entities[entityRef];
         processedEntityRefs.add(entityRef);
         if (entity && entity.relations) {
+          if (entityFilter && !entityFilter(entity)) {
+            continue;
+          }
           for (const rel of entity.relations) {
             if ((!relations || relations.includes(rel.type)) && (!kinds || kinds.some(
               (kind) => rel.targetRef.startsWith(
@@ -36,9 +45,18 @@ function useEntityRelationGraph({
       ++depth;
     }
     requestEntities([...expectedEntities]);
-  }, [entities, rootEntityRefs, maxDepth, relations, kinds, requestEntities]);
-  return {
+  }, [
     entities,
+    rootEntityRefs,
+    maxDepth,
+    relations,
+    kinds,
+    entityFilter,
+    requestEntities
+  ]);
+  const filteredEntities = entityFilter ? pickBy(entities, (value, _key) => entityFilter(value)) : entities;
+  return {
+    entities: filteredEntities,
     loading,
     error
   };

package/dist/components/EntityRelationsGraph/useEntityRelationGraph.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"useEntityRelationGraph.esm.js","sources":["../../../src/components/EntityRelationsGraph/useEntityRelationGraph.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { Entity } from '@backstage/catalog-model';\nimport { useEffect } from 'react';\nimport { useEntityStore } from './useEntityStore';\n\n/**\n * Discover the graph of entities connected by relations, starting from a set of\n * root entities. Filters are used to select which relations to includes.\n * Returns all discovered entities once they are loaded.\n */\nexport function useEntityRelationGraph({\n  rootEntityRefs,\n  filter: { maxDepth = Number.POSITIVE_INFINITY, relations, kinds } = {},\n}: {\n  rootEntityRefs: string[];\n  filter?: {\n    maxDepth?: number;\n    relations?: string[];\n    kinds?: string[];\n  };\n}): {\n  entities?: { [ref: string]: Entity };\n  loading: boolean;\n  error?: Error;\n} {\n  const { entities, loading, error, requestEntities } = useEntityStore();\n\n  useEffect(() => {\n    const expectedEntities = new Set([...rootEntityRefs]);\n    const processedEntityRefs = new Set<string>();\n\n    let nextDepthRefQueue = [...rootEntityRefs];\n    let depth = 0;\n\n    while (\n      nextDepthRefQueue.length > 0 &&\n      (!isFinite(maxDepth) || depth < maxDepth)\n    ) {\n      const entityRefQueue = nextDepthRefQueue;\n      nextDepthRefQueue = [];\n\n      while (entityRefQueue.length > 0) {\n        const entityRef = entityRefQueue.shift()!;\n        const entity = entities[entityRef];\n\n        processedEntityRefs.add(entityRef);\n\n        if (entity && entity.relations) {\n          for (const rel of entity.relations) {\n            if (\n              (!relations || relations.includes(rel.type)) &&\n              (!kinds ||\n                kinds.some(kind =>\n                  rel.targetRef.startsWith(\n                    `${kind.toLocaleLowerCase('en-US')}:`,\n                  ),\n                ))\n            ) {\n              if (!processedEntityRefs.has(rel.targetRef)) {\n                nextDepthRefQueue.push(rel.targetRef);\n                expectedEntities.add(rel.targetRef);\n              }\n            }\n          }\n        }\n      }\n\n      ++depth;\n    }\n\n    requestEntities([...expectedEntities]);\n  }, [entities, rootEntityRefs, maxDepth, relations, kinds, requestEntities]);\n\n  return {\n    entities,\n    loading,\n    error,\n  };\n}\n"],"names":[],"mappings":";;;AAwBO,SAAS,sBAAuB,CAAA;AAAA,EACrC,cAAA;AAAA,EACA,MAAA,EAAQ,EAAE,QAAW,GAAA,MAAA,CAAO,mBAAmB,SAAW,EAAA,KAAA,KAAU,EAAC;AACvE,CAWE,EAAA;AACA,EAAA,MAAM,EAAE,QAAU,EAAA,OAAA,EAAS,KAAO,EAAA,eAAA,KAAoB,cAAe,EAAA,CAAA;AAErE,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,MAAM,mCAAuB,IAAA,GAAA,CAAI,CAAC,GAAG,cAAc,CAAC,CAAA,CAAA;AACpD,IAAM,MAAA,mBAAA,uBAA0B,GAAY,EAAA,CAAA;AAE5C,IAAI,IAAA,iBAAA,GAAoB,CAAC,GAAG,cAAc,CAAA,CAAA;AAC1C,IAAA,IAAI,KAAQ,GAAA,CAAA,CAAA;AAEZ,IACE,OAAA,iBAAA,CAAkB,SAAS,CAC1B,KAAA,CAAC,SAAS,QAAQ,CAAA,IAAK,QAAQ,QAChC,CAAA,EAAA;AACA,MAAA,MAAM,cAAiB,GAAA,iBAAA,CAAA;AACvB,MAAA,iBAAA,GAAoB,EAAC,CAAA;AAErB,MAAO,OAAA,cAAA,CAAe,SAAS,CAAG,EAAA;AAChC,QAAM,MAAA,SAAA,GAAY,eAAe,KAAM,EAAA,CAAA;AACvC,QAAM,MAAA,MAAA,GAAS,SAAS,SAAS,CAAA,CAAA;AAEjC,QAAA,mBAAA,CAAoB,IAAI,SAAS,CAAA,CAAA;AAEjC,QAAI,IAAA,MAAA,IAAU,OAAO,SAAW,EAAA;AAC9B,UAAW,KAAA,MAAA,GAAA,IAAO,OAAO,SAAW,EAAA;AAClC,YACG,IAAA,CAAA,CAAC,aAAa,SAAU,CAAA,QAAA,CAAS,IAAI,IAAI,CAAA,MACzC,CAAC,KAAA,IACA,KAAM,CAAA,IAAA;AAAA,cAAK,CAAA,IAAA,KACT,IAAI,SAAU,CAAA,UAAA;AAAA,gBACZ,CAAG,EAAA,IAAA,CAAK,iBAAkB,CAAA,OAAO,CAAC,CAAA,CAAA,CAAA;AAAA,eACpC;AAAA,aAEJ,CAAA,EAAA;AACA,cAAA,IAAI,CAAC,mBAAA,CAAoB,GAAI,CAAA,GAAA,CAAI,SAAS,CAAG,EAAA;AAC3C,gBAAkB,iBAAA,CAAA,IAAA,CAAK,IAAI,SAAS,CAAA,CAAA;AACpC,gBAAiB,gBAAA,CAAA,GAAA,CAAI,IAAI,SAAS,CAAA,CAAA;AAAA,eACpC;AAAA,aACF;AAAA,WACF;AAAA,SACF;AAAA,OACF;AAEA,MAAE,EAAA,KAAA,CAAA;AAAA,KACJ;AAEA,IAAgB,eAAA,CAAA,CAAC,GAAG,gBAAgB,CAAC,CAAA,CAAA;AAAA,GACvC,EAAG,CAAC,QAAU,EAAA,cAAA,EAAgB,UAAU,SAAW,EAAA,KAAA,EAAO,eAAe,CAAC,CAAA,CAAA;AAE1E,EAAO,OAAA;AAAA,IACL,QAAA;AAAA,IACA,OAAA;AAAA,IACA,KAAA;AAAA,GACF,CAAA;AACF;;;;"}
+{"version":3,"file":"useEntityRelationGraph.esm.js","sources":["../../../src/components/EntityRelationsGraph/useEntityRelationGraph.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { Entity } from '@backstage/catalog-model';\nimport { useEffect } from 'react';\nimport { useEntityStore } from './useEntityStore';\nimport { pickBy } from 'lodash';\n\n/**\n * Discover the graph of entities connected by relations, starting from a set of\n * root entities. Filters are used to select which relations to includes.\n * Returns all discovered entities once they are loaded.\n */\nexport function useEntityRelationGraph({\n  rootEntityRefs,\n  filter: {\n    maxDepth = Number.POSITIVE_INFINITY,\n    relations,\n    kinds,\n    entityFilter,\n  } = {},\n}: {\n  rootEntityRefs: string[];\n  filter?: {\n    maxDepth?: number;\n    relations?: string[];\n    kinds?: string[];\n    entityFilter?: (entity: Entity) => boolean;\n  };\n}): {\n  entities?: { [ref: string]: Entity };\n  loading: boolean;\n  error?: Error;\n} {\n  const { entities, loading, error, requestEntities } = useEntityStore();\n\n  useEffect(() => {\n    const expectedEntities = new Set([...rootEntityRefs]);\n    const processedEntityRefs = new Set<string>();\n\n    let nextDepthRefQueue = [...rootEntityRefs];\n    let depth = 0;\n\n    while (\n      nextDepthRefQueue.length > 0 &&\n      (!isFinite(maxDepth) || depth < maxDepth)\n    ) {\n      const entityRefQueue = nextDepthRefQueue;\n      nextDepthRefQueue = [];\n\n      while (entityRefQueue.length > 0) {\n        const entityRef = entityRefQueue.shift()!;\n        const entity = entities[entityRef];\n\n        processedEntityRefs.add(entityRef);\n\n        if (entity && entity.relations) {\n          // If the entity is filtered out then no need to check any\n          // of its outgoing relationships to other entities\n          if (entityFilter && !entityFilter(entity)) {\n            continue;\n          }\n          for (const rel of entity.relations) {\n            if (\n              (!relations || relations.includes(rel.type)) &&\n              (!kinds ||\n                kinds.some(kind =>\n                  rel.targetRef.startsWith(\n                    `${kind.toLocaleLowerCase('en-US')}:`,\n                  ),\n                ))\n            ) {\n              if (!processedEntityRefs.has(rel.targetRef)) {\n                nextDepthRefQueue.push(rel.targetRef);\n                expectedEntities.add(rel.targetRef);\n              }\n            }\n          }\n        }\n      }\n\n      ++depth;\n    }\n    requestEntities([...expectedEntities]);\n  }, [\n    entities,\n    rootEntityRefs,\n    maxDepth,\n    relations,\n    kinds,\n    entityFilter,\n    requestEntities,\n  ]);\n\n  const filteredEntities = entityFilter\n    ? pickBy(entities, (value, _key) => entityFilter(value))\n    : entities;\n\n  return {\n    entities: filteredEntities,\n    loading,\n    error,\n  };\n}\n"],"names":[],"mappings":";;;;AAyBO,SAAS,sBAAuB,CAAA;AAAA,EACrC,cAAA;AAAA,EACA,MAAQ,EAAA;AAAA,IACN,WAAW,MAAO,CAAA,iBAAA;AAAA,IAClB,SAAA;AAAA,IACA,KAAA;AAAA,IACA,YAAA;AAAA,MACE,EAAC;AACP,CAYE,EAAA;AACA,EAAA,MAAM,EAAE,QAAU,EAAA,OAAA,EAAS,KAAO,EAAA,eAAA,KAAoB,cAAe,EAAA,CAAA;AAErE,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,MAAM,mCAAuB,IAAA,GAAA,CAAI,CAAC,GAAG,cAAc,CAAC,CAAA,CAAA;AACpD,IAAM,MAAA,mBAAA,uBAA0B,GAAY,EAAA,CAAA;AAE5C,IAAI,IAAA,iBAAA,GAAoB,CAAC,GAAG,cAAc,CAAA,CAAA;AAC1C,IAAA,IAAI,KAAQ,GAAA,CAAA,CAAA;AAEZ,IACE,OAAA,iBAAA,CAAkB,SAAS,CAC1B,KAAA,CAAC,SAAS,QAAQ,CAAA,IAAK,QAAQ,QAChC,CAAA,EAAA;AACA,MAAA,MAAM,cAAiB,GAAA,iBAAA,CAAA;AACvB,MAAA,iBAAA,GAAoB,EAAC,CAAA;AAErB,MAAO,OAAA,cAAA,CAAe,SAAS,CAAG,EAAA;AAChC,QAAM,MAAA,SAAA,GAAY,eAAe,KAAM,EAAA,CAAA;AACvC,QAAM,MAAA,MAAA,GAAS,SAAS,SAAS,CAAA,CAAA;AAEjC,QAAA,mBAAA,CAAoB,IAAI,SAAS,CAAA,CAAA;AAEjC,QAAI,IAAA,MAAA,IAAU,OAAO,SAAW,EAAA;AAG9B,UAAA,IAAI,YAAgB,IAAA,CAAC,YAAa,CAAA,MAAM,CAAG,EAAA;AACzC,YAAA,SAAA;AAAA,WACF;AACA,UAAW,KAAA,MAAA,GAAA,IAAO,OAAO,SAAW,EAAA;AAClC,YACG,IAAA,CAAA,CAAC,aAAa,SAAU,CAAA,QAAA,CAAS,IAAI,IAAI,CAAA,MACzC,CAAC,KAAA,IACA,KAAM,CAAA,IAAA;AAAA,cAAK,CAAA,IAAA,KACT,IAAI,SAAU,CAAA,UAAA;AAAA,gBACZ,CAAG,EAAA,IAAA,CAAK,iBAAkB,CAAA,OAAO,CAAC,CAAA,CAAA,CAAA;AAAA,eACpC;AAAA,aAEJ,CAAA,EAAA;AACA,cAAA,IAAI,CAAC,mBAAA,CAAoB,GAAI,CAAA,GAAA,CAAI,SAAS,CAAG,EAAA;AAC3C,gBAAkB,iBAAA,CAAA,IAAA,CAAK,IAAI,SAAS,CAAA,CAAA;AACpC,gBAAiB,gBAAA,CAAA,GAAA,CAAI,IAAI,SAAS,CAAA,CAAA;AAAA,eACpC;AAAA,aACF;AAAA,WACF;AAAA,SACF;AAAA,OACF;AAEA,MAAE,EAAA,KAAA,CAAA;AAAA,KACJ;AACA,IAAgB,eAAA,CAAA,CAAC,GAAG,gBAAgB,CAAC,CAAA,CAAA;AAAA,GACpC,EAAA;AAAA,IACD,QAAA;AAAA,IACA,cAAA;AAAA,IACA,QAAA;AAAA,IACA,SAAA;AAAA,IACA,KAAA;AAAA,IACA,YAAA;AAAA,IACA,eAAA;AAAA,GACD,CAAA,CAAA;AAED,EAAM,MAAA,gBAAA,GAAmB,YACrB,GAAA,MAAA,CAAO,QAAU,EAAA,CAAC,OAAO,IAAS,KAAA,YAAA,CAAa,KAAK,CAAC,CACrD,GAAA,QAAA,CAAA;AAEJ,EAAO,OAAA;AAAA,IACL,QAAU,EAAA,gBAAA;AAAA,IACV,OAAA;AAAA,IACA,KAAA;AAAA,GACF,CAAA;AACF;;;;"}

package/dist/components/EntityRelationsGraph/useEntityRelationNodesAndEdges.esm.js

@@ -11,6 +11,7 @@ function useEntityRelationNodesAndEdges({
   mergeRelations = true,
   kinds,
   relations,
+  entityFilter,
   onNodeClick,
   relationPairs = ALL_RELATION_PAIRS
 }) {
@@ -20,7 +21,8 @@ function useEntityRelationNodesAndEdges({
     filter: {
       maxDepth,
       kinds,
-      relations
+      relations,
+      entityFilter
     }
   });
   useDebounce(

package/dist/components/EntityRelationsGraph/useEntityRelationNodesAndEdges.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"useEntityRelationNodesAndEdges.esm.js","sources":["../../../src/components/EntityRelationsGraph/useEntityRelationNodesAndEdges.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { MouseEvent, useState } from 'react';\nimport useDebounce from 'react-use/esm/useDebounce';\nimport { RelationPairs, ALL_RELATION_PAIRS } from './relations';\nimport { EntityEdge, EntityNode } from './types';\nimport { useEntityRelationGraph } from './useEntityRelationGraph';\nimport { DEFAULT_NAMESPACE } from '@backstage/catalog-model';\n\n/**\n * Generate nodes and edges to render the entity graph.\n */\nexport function useEntityRelationNodesAndEdges({\n  rootEntityRefs,\n  maxDepth = Number.POSITIVE_INFINITY,\n  unidirectional = true,\n  mergeRelations = true,\n  kinds,\n  relations,\n  onNodeClick,\n  relationPairs = ALL_RELATION_PAIRS,\n}: {\n  rootEntityRefs: string[];\n  maxDepth?: number;\n  unidirectional?: boolean;\n  mergeRelations?: boolean;\n  kinds?: string[];\n  relations?: string[];\n  onNodeClick?: (value: EntityNode, event: MouseEvent<unknown>) => void;\n  relationPairs?: RelationPairs;\n}): {\n  loading: boolean;\n  nodes?: EntityNode[];\n  edges?: EntityEdge[];\n  error?: Error;\n} {\n  const [nodesAndEdges, setNodesAndEdges] = useState<{\n    nodes?: EntityNode[];\n    edges?: EntityEdge[];\n  }>({});\n  const { entities, loading, error } = useEntityRelationGraph({\n    rootEntityRefs,\n    filter: {\n      maxDepth,\n      kinds,\n      relations,\n    },\n  });\n\n  useDebounce(\n    () => {\n      if (!entities || Object.keys(entities).length === 0) {\n        setNodesAndEdges({});\n        return;\n      }\n\n      const nodes = Object.entries(entities).map(([entityRef, entity]) => {\n        const focused = rootEntityRefs.includes(entityRef);\n        const node: EntityNode = {\n          id: entityRef,\n          entity,\n          focused,\n          color: focused ? 'secondary' : 'primary',\n          // @deprecated\n          kind: entity.kind,\n          name: entity.metadata.name,\n          namespace: entity.metadata.namespace || DEFAULT_NAMESPACE,\n          title: entity.metadata.title,\n          spec: entity.spec,\n        };\n\n        if (onNodeClick) {\n          node.onClick = event => onNodeClick(node, event);\n        }\n\n        return node;\n      });\n\n      const edges: EntityEdge[] = [];\n      const visitedNodes = new Set<string>();\n      const nodeQueue = [...rootEntityRefs];\n\n      while (nodeQueue.length > 0) {\n        const entityRef = nodeQueue.pop()!;\n        const entity = entities[entityRef];\n        visitedNodes.add(entityRef);\n\n        if (entity) {\n          entity?.relations?.forEach(rel => {\n            // Check if the related entity should be displayed, if not, ignore\n            // the relation too\n            if (!entities[rel.targetRef]) {\n              return;\n            }\n\n            if (relations && !relations.includes(rel.type)) {\n              return;\n            }\n\n            if (\n              kinds &&\n              !kinds.some(kind =>\n                rel.targetRef.startsWith(`${kind.toLocaleLowerCase('en-US')}:`),\n              )\n            ) {\n              return;\n            }\n\n            if (!unidirectional || !visitedNodes.has(rel.targetRef)) {\n              if (mergeRelations) {\n                const pair = relationPairs.find(\n                  ([l, r]) => l === rel.type || r === rel.type,\n                ) ?? [rel.type];\n                const [left] = pair;\n\n                edges.push({\n                  from: left === rel.type ? entityRef : rel.targetRef,\n                  to: left === rel.type ? rel.targetRef : entityRef,\n                  relations: pair,\n                  label: 'visible',\n                });\n              } else {\n                edges.push({\n                  from: entityRef,\n                  to: rel.targetRef,\n                  relations: [rel.type],\n                  label: 'visible',\n                });\n              }\n            }\n\n            if (!visitedNodes.has(rel.targetRef)) {\n              nodeQueue.push(rel.targetRef);\n              visitedNodes.add(rel.targetRef);\n            }\n\n            // if unidirectional add missing relations as entities are only visited once\n            if (unidirectional) {\n              const findIndex = edges.findIndex(\n                edge =>\n                  entityRef === edge.from &&\n                  rel.targetRef === edge.to &&\n                  !edge.relations.includes(rel.type),\n              );\n              if (findIndex >= 0) {\n                if (mergeRelations) {\n                  const pair = relationPairs.find(\n                    ([l, r]) => l === rel.type || r === rel.type,\n                  ) ?? [rel.type];\n                  edges[findIndex].relations = [\n                    ...edges[findIndex].relations,\n                    ...pair,\n                  ];\n                } else {\n                  edges[findIndex].relations = [\n                    ...edges[findIndex].relations,\n                    rel.type,\n                  ];\n                }\n              }\n            }\n          });\n        }\n      }\n\n      // Reduce edges as the dependency graph anyway ignores duplicated edges regarding from / to\n      // Additionally, this will improve rendering speed for the dependency graph\n      const finalEdges = edges.reduce((previousEdges, currentEdge) => {\n        const indexFound = previousEdges.findIndex(\n          previousEdge =>\n            previousEdge.from === currentEdge.from &&\n            previousEdge.to === currentEdge.to,\n        );\n        if (indexFound >= 0) {\n          previousEdges[indexFound] = {\n            ...previousEdges[indexFound],\n            relations: Array.from(\n              new Set([\n                ...previousEdges[indexFound].relations,\n                ...currentEdge.relations,\n              ]),\n            ),\n          };\n          return previousEdges;\n        }\n        return [...previousEdges, currentEdge];\n      }, [] as EntityEdge[]);\n\n      setNodesAndEdges({ nodes, edges: finalEdges });\n    },\n    100,\n    [\n      entities,\n      rootEntityRefs,\n      kinds,\n      relations,\n      unidirectional,\n      mergeRelations,\n      onNodeClick,\n      relationPairs,\n    ],\n  );\n\n  return {\n    loading,\n    error,\n    ...nodesAndEdges,\n  };\n}\n"],"names":[],"mappings":";;;;;;AAyBO,SAAS,8BAA+B,CAAA;AAAA,EAC7C,cAAA;AAAA,EACA,WAAW,MAAO,CAAA,iBAAA;AAAA,EAClB,cAAiB,GAAA,IAAA;AAAA,EACjB,cAAiB,GAAA,IAAA;AAAA,EACjB,KAAA;AAAA,EACA,SAAA;AAAA,EACA,WAAA;AAAA,EACA,aAAgB,GAAA,kBAAA;AAClB,CAcE,EAAA;AACA,EAAA,MAAM,CAAC,aAAe,EAAA,gBAAgB,CAAI,GAAA,QAAA,CAGvC,EAAE,CAAA,CAAA;AACL,EAAA,MAAM,EAAE,QAAA,EAAU,OAAS,EAAA,KAAA,KAAU,sBAAuB,CAAA;AAAA,IAC1D,cAAA;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,QAAA;AAAA,MACA,KAAA;AAAA,MACA,SAAA;AAAA,KACF;AAAA,GACD,CAAA,CAAA;AAED,EAAA,WAAA;AAAA,IACE,MAAM;AACJ,MAAA,IAAI,CAAC,QAAY,IAAA,MAAA,CAAO,KAAK,QAAQ,CAAA,CAAE,WAAW,CAAG,EAAA;AACnD,QAAA,gBAAA,CAAiB,EAAE,CAAA,CAAA;AACnB,QAAA,OAAA;AAAA,OACF;AAEA,MAAM,MAAA,KAAA,GAAQ,MAAO,CAAA,OAAA,CAAQ,QAAQ,CAAA,CAAE,IAAI,CAAC,CAAC,SAAW,EAAA,MAAM,CAAM,KAAA;AAClE,QAAM,MAAA,OAAA,GAAU,cAAe,CAAA,QAAA,CAAS,SAAS,CAAA,CAAA;AACjD,QAAA,MAAM,IAAmB,GAAA;AAAA,UACvB,EAAI,EAAA,SAAA;AAAA,UACJ,MAAA;AAAA,UACA,OAAA;AAAA,UACA,KAAA,EAAO,UAAU,WAAc,GAAA,SAAA;AAAA;AAAA,UAE/B,MAAM,MAAO,CAAA,IAAA;AAAA,UACb,IAAA,EAAM,OAAO,QAAS,CAAA,IAAA;AAAA,UACtB,SAAA,EAAW,MAAO,CAAA,QAAA,CAAS,SAAa,IAAA,iBAAA;AAAA,UACxC,KAAA,EAAO,OAAO,QAAS,CAAA,KAAA;AAAA,UACvB,MAAM,MAAO,CAAA,IAAA;AAAA,SACf,CAAA;AAEA,QAAA,IAAI,WAAa,EAAA;AACf,UAAA,IAAA,CAAK,OAAU,GAAA,CAAA,KAAA,KAAS,WAAY,CAAA,IAAA,EAAM,KAAK,CAAA,CAAA;AAAA,SACjD;AAEA,QAAO,OAAA,IAAA,CAAA;AAAA,OACR,CAAA,CAAA;AAED,MAAA,MAAM,QAAsB,EAAC,CAAA;AAC7B,MAAM,MAAA,YAAA,uBAAmB,GAAY,EAAA,CAAA;AACrC,MAAM,MAAA,SAAA,GAAY,CAAC,GAAG,cAAc,CAAA,CAAA;AAEpC,MAAO,OAAA,SAAA,CAAU,SAAS,CAAG,EAAA;AAC3B,QAAM,MAAA,SAAA,GAAY,UAAU,GAAI,EAAA,CAAA;AAChC,QAAM,MAAA,MAAA,GAAS,SAAS,SAAS,CAAA,CAAA;AACjC,QAAA,YAAA,CAAa,IAAI,SAAS,CAAA,CAAA;AAE1B,QAAA,IAAI,MAAQ,EAAA;AACV,UAAQ,MAAA,EAAA,SAAA,EAAW,QAAQ,CAAO,GAAA,KAAA;AAGhC,YAAA,IAAI,CAAC,QAAA,CAAS,GAAI,CAAA,SAAS,CAAG,EAAA;AAC5B,cAAA,OAAA;AAAA,aACF;AAEA,YAAA,IAAI,aAAa,CAAC,SAAA,CAAU,QAAS,CAAA,GAAA,CAAI,IAAI,CAAG,EAAA;AAC9C,cAAA,OAAA;AAAA,aACF;AAEA,YACE,IAAA,KAAA,IACA,CAAC,KAAM,CAAA,IAAA;AAAA,cAAK,CAAA,IAAA,KACV,IAAI,SAAU,CAAA,UAAA,CAAW,GAAG,IAAK,CAAA,iBAAA,CAAkB,OAAO,CAAC,CAAG,CAAA,CAAA,CAAA;AAAA,aAEhE,EAAA;AACA,cAAA,OAAA;AAAA,aACF;AAEA,YAAA,IAAI,CAAC,cAAkB,IAAA,CAAC,aAAa,GAAI,CAAA,GAAA,CAAI,SAAS,CAAG,EAAA;AACvD,cAAA,IAAI,cAAgB,EAAA;AAClB,gBAAA,MAAM,OAAO,aAAc,CAAA,IAAA;AAAA,kBACzB,CAAC,CAAC,CAAG,EAAA,CAAC,MAAM,CAAM,KAAA,GAAA,CAAI,IAAQ,IAAA,CAAA,KAAM,GAAI,CAAA,IAAA;AAAA,iBAC1C,IAAK,CAAC,GAAA,CAAI,IAAI,CAAA,CAAA;AACd,gBAAM,MAAA,CAAC,IAAI,CAAI,GAAA,IAAA,CAAA;AAEf,gBAAA,KAAA,CAAM,IAAK,CAAA;AAAA,kBACT,IAAM,EAAA,IAAA,KAAS,GAAI,CAAA,IAAA,GAAO,YAAY,GAAI,CAAA,SAAA;AAAA,kBAC1C,EAAI,EAAA,IAAA,KAAS,GAAI,CAAA,IAAA,GAAO,IAAI,SAAY,GAAA,SAAA;AAAA,kBACxC,SAAW,EAAA,IAAA;AAAA,kBACX,KAAO,EAAA,SAAA;AAAA,iBACR,CAAA,CAAA;AAAA,eACI,MAAA;AACL,gBAAA,KAAA,CAAM,IAAK,CAAA;AAAA,kBACT,IAAM,EAAA,SAAA;AAAA,kBACN,IAAI,GAAI,CAAA,SAAA;AAAA,kBACR,SAAA,EAAW,CAAC,GAAA,CAAI,IAAI,CAAA;AAAA,kBACpB,KAAO,EAAA,SAAA;AAAA,iBACR,CAAA,CAAA;AAAA,eACH;AAAA,aACF;AAEA,YAAA,IAAI,CAAC,YAAA,CAAa,GAAI,CAAA,GAAA,CAAI,SAAS,CAAG,EAAA;AACpC,cAAU,SAAA,CAAA,IAAA,CAAK,IAAI,SAAS,CAAA,CAAA;AAC5B,cAAa,YAAA,CAAA,GAAA,CAAI,IAAI,SAAS,CAAA,CAAA;AAAA,aAChC;AAGA,YAAA,IAAI,cAAgB,EAAA;AAClB,cAAA,MAAM,YAAY,KAAM,CAAA,SAAA;AAAA,gBACtB,CACE,IAAA,KAAA,SAAA,KAAc,IAAK,CAAA,IAAA,IACnB,GAAI,CAAA,SAAA,KAAc,IAAK,CAAA,EAAA,IACvB,CAAC,IAAA,CAAK,SAAU,CAAA,QAAA,CAAS,IAAI,IAAI,CAAA;AAAA,eACrC,CAAA;AACA,cAAA,IAAI,aAAa,CAAG,EAAA;AAClB,gBAAA,IAAI,cAAgB,EAAA;AAClB,kBAAA,MAAM,OAAO,aAAc,CAAA,IAAA;AAAA,oBACzB,CAAC,CAAC,CAAG,EAAA,CAAC,MAAM,CAAM,KAAA,GAAA,CAAI,IAAQ,IAAA,CAAA,KAAM,GAAI,CAAA,IAAA;AAAA,mBAC1C,IAAK,CAAC,GAAA,CAAI,IAAI,CAAA,CAAA;AACd,kBAAM,KAAA,CAAA,SAAS,EAAE,SAAY,GAAA;AAAA,oBAC3B,GAAG,KAAM,CAAA,SAAS,CAAE,CAAA,SAAA;AAAA,oBACpB,GAAG,IAAA;AAAA,mBACL,CAAA;AAAA,iBACK,MAAA;AACL,kBAAM,KAAA,CAAA,SAAS,EAAE,SAAY,GAAA;AAAA,oBAC3B,GAAG,KAAM,CAAA,SAAS,CAAE,CAAA,SAAA;AAAA,oBACpB,GAAI,CAAA,IAAA;AAAA,mBACN,CAAA;AAAA,iBACF;AAAA,eACF;AAAA,aACF;AAAA,WACD,CAAA,CAAA;AAAA,SACH;AAAA,OACF;AAIA,MAAA,MAAM,UAAa,GAAA,KAAA,CAAM,MAAO,CAAA,CAAC,eAAe,WAAgB,KAAA;AAC9D,QAAA,MAAM,aAAa,aAAc,CAAA,SAAA;AAAA,UAC/B,kBACE,YAAa,CAAA,IAAA,KAAS,YAAY,IAClC,IAAA,YAAA,CAAa,OAAO,WAAY,CAAA,EAAA;AAAA,SACpC,CAAA;AACA,QAAA,IAAI,cAAc,CAAG,EAAA;AACnB,UAAA,aAAA,CAAc,UAAU,CAAI,GAAA;AAAA,YAC1B,GAAG,cAAc,UAAU,CAAA;AAAA,YAC3B,WAAW,KAAM,CAAA,IAAA;AAAA,kCACX,GAAI,CAAA;AAAA,gBACN,GAAG,aAAc,CAAA,UAAU,CAAE,CAAA,SAAA;AAAA,gBAC7B,GAAG,WAAY,CAAA,SAAA;AAAA,eAChB,CAAA;AAAA,aACH;AAAA,WACF,CAAA;AACA,UAAO,OAAA,aAAA,CAAA;AAAA,SACT;AACA,QAAO,OAAA,CAAC,GAAG,aAAA,EAAe,WAAW,CAAA,CAAA;AAAA,OACvC,EAAG,EAAkB,CAAA,CAAA;AAErB,MAAA,gBAAA,CAAiB,EAAE,KAAA,EAAO,KAAO,EAAA,UAAA,EAAY,CAAA,CAAA;AAAA,KAC/C;AAAA,IACA,GAAA;AAAA,IACA;AAAA,MACE,QAAA;AAAA,MACA,cAAA;AAAA,MACA,KAAA;AAAA,MACA,SAAA;AAAA,MACA,cAAA;AAAA,MACA,cAAA;AAAA,MACA,WAAA;AAAA,MACA,aAAA;AAAA,KACF;AAAA,GACF,CAAA;AAEA,EAAO,OAAA;AAAA,IACL,OAAA;AAAA,IACA,KAAA;AAAA,IACA,GAAG,aAAA;AAAA,GACL,CAAA;AACF;;;;"}
+{"version":3,"file":"useEntityRelationNodesAndEdges.esm.js","sources":["../../../src/components/EntityRelationsGraph/useEntityRelationNodesAndEdges.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { MouseEvent, useState } from 'react';\nimport useDebounce from 'react-use/esm/useDebounce';\nimport { RelationPairs, ALL_RELATION_PAIRS } from './relations';\nimport { EntityEdge, EntityNode } from './types';\nimport { useEntityRelationGraph } from './useEntityRelationGraph';\nimport { Entity, DEFAULT_NAMESPACE } from '@backstage/catalog-model';\n\n/**\n * Generate nodes and edges to render the entity graph.\n */\nexport function useEntityRelationNodesAndEdges({\n  rootEntityRefs,\n  maxDepth = Number.POSITIVE_INFINITY,\n  unidirectional = true,\n  mergeRelations = true,\n  kinds,\n  relations,\n  entityFilter,\n  onNodeClick,\n  relationPairs = ALL_RELATION_PAIRS,\n}: {\n  rootEntityRefs: string[];\n  maxDepth?: number;\n  unidirectional?: boolean;\n  mergeRelations?: boolean;\n  kinds?: string[];\n  relations?: string[];\n  entityFilter?: (entity: Entity) => boolean;\n  onNodeClick?: (value: EntityNode, event: MouseEvent<unknown>) => void;\n  relationPairs?: RelationPairs;\n}): {\n  loading: boolean;\n  nodes?: EntityNode[];\n  edges?: EntityEdge[];\n  error?: Error;\n} {\n  const [nodesAndEdges, setNodesAndEdges] = useState<{\n    nodes?: EntityNode[];\n    edges?: EntityEdge[];\n  }>({});\n  const { entities, loading, error } = useEntityRelationGraph({\n    rootEntityRefs,\n    filter: {\n      maxDepth,\n      kinds,\n      relations,\n      entityFilter,\n    },\n  });\n\n  useDebounce(\n    () => {\n      if (!entities || Object.keys(entities).length === 0) {\n        setNodesAndEdges({});\n        return;\n      }\n\n      const nodes = Object.entries(entities).map(([entityRef, entity]) => {\n        const focused = rootEntityRefs.includes(entityRef);\n        const node: EntityNode = {\n          id: entityRef,\n          entity,\n          focused,\n          color: focused ? 'secondary' : 'primary',\n          // @deprecated\n          kind: entity.kind,\n          name: entity.metadata.name,\n          namespace: entity.metadata.namespace || DEFAULT_NAMESPACE,\n          title: entity.metadata.title,\n          spec: entity.spec,\n        };\n\n        if (onNodeClick) {\n          node.onClick = event => onNodeClick(node, event);\n        }\n\n        return node;\n      });\n\n      const edges: EntityEdge[] = [];\n      const visitedNodes = new Set<string>();\n      const nodeQueue = [...rootEntityRefs];\n\n      while (nodeQueue.length > 0) {\n        const entityRef = nodeQueue.pop()!;\n        const entity = entities[entityRef];\n        visitedNodes.add(entityRef);\n\n        if (entity) {\n          entity?.relations?.forEach(rel => {\n            // Check if the related entity should be displayed, if not, ignore\n            // the relation too\n            if (!entities[rel.targetRef]) {\n              return;\n            }\n\n            if (relations && !relations.includes(rel.type)) {\n              return;\n            }\n\n            if (\n              kinds &&\n              !kinds.some(kind =>\n                rel.targetRef.startsWith(`${kind.toLocaleLowerCase('en-US')}:`),\n              )\n            ) {\n              return;\n            }\n\n            if (!unidirectional || !visitedNodes.has(rel.targetRef)) {\n              if (mergeRelations) {\n                const pair = relationPairs.find(\n                  ([l, r]) => l === rel.type || r === rel.type,\n                ) ?? [rel.type];\n                const [left] = pair;\n\n                edges.push({\n                  from: left === rel.type ? entityRef : rel.targetRef,\n                  to: left === rel.type ? rel.targetRef : entityRef,\n                  relations: pair,\n                  label: 'visible',\n                });\n              } else {\n                edges.push({\n                  from: entityRef,\n                  to: rel.targetRef,\n                  relations: [rel.type],\n                  label: 'visible',\n                });\n              }\n            }\n\n            if (!visitedNodes.has(rel.targetRef)) {\n              nodeQueue.push(rel.targetRef);\n              visitedNodes.add(rel.targetRef);\n            }\n\n            // if unidirectional add missing relations as entities are only visited once\n            if (unidirectional) {\n              const findIndex = edges.findIndex(\n                edge =>\n                  entityRef === edge.from &&\n                  rel.targetRef === edge.to &&\n                  !edge.relations.includes(rel.type),\n              );\n              if (findIndex >= 0) {\n                if (mergeRelations) {\n                  const pair = relationPairs.find(\n                    ([l, r]) => l === rel.type || r === rel.type,\n                  ) ?? [rel.type];\n                  edges[findIndex].relations = [\n                    ...edges[findIndex].relations,\n                    ...pair,\n                  ];\n                } else {\n                  edges[findIndex].relations = [\n                    ...edges[findIndex].relations,\n                    rel.type,\n                  ];\n                }\n              }\n            }\n          });\n        }\n      }\n\n      // Reduce edges as the dependency graph anyway ignores duplicated edges regarding from / to\n      // Additionally, this will improve rendering speed for the dependency graph\n      const finalEdges = edges.reduce((previousEdges, currentEdge) => {\n        const indexFound = previousEdges.findIndex(\n          previousEdge =>\n            previousEdge.from === currentEdge.from &&\n            previousEdge.to === currentEdge.to,\n        );\n        if (indexFound >= 0) {\n          previousEdges[indexFound] = {\n            ...previousEdges[indexFound],\n            relations: Array.from(\n              new Set([\n                ...previousEdges[indexFound].relations,\n                ...currentEdge.relations,\n              ]),\n            ),\n          };\n          return previousEdges;\n        }\n        return [...previousEdges, currentEdge];\n      }, [] as EntityEdge[]);\n\n      setNodesAndEdges({ nodes, edges: finalEdges });\n    },\n    100,\n    [\n      entities,\n      rootEntityRefs,\n      kinds,\n      relations,\n      unidirectional,\n      mergeRelations,\n      onNodeClick,\n      relationPairs,\n    ],\n  );\n\n  return {\n    loading,\n    error,\n    ...nodesAndEdges,\n  };\n}\n"],"names":[],"mappings":";;;;;;AAyBO,SAAS,8BAA+B,CAAA;AAAA,EAC7C,cAAA;AAAA,EACA,WAAW,MAAO,CAAA,iBAAA;AAAA,EAClB,cAAiB,GAAA,IAAA;AAAA,EACjB,cAAiB,GAAA,IAAA;AAAA,EACjB,KAAA;AAAA,EACA,SAAA;AAAA,EACA,YAAA;AAAA,EACA,WAAA;AAAA,EACA,aAAgB,GAAA,kBAAA;AAClB,CAeE,EAAA;AACA,EAAA,MAAM,CAAC,aAAe,EAAA,gBAAgB,CAAI,GAAA,QAAA,CAGvC,EAAE,CAAA,CAAA;AACL,EAAA,MAAM,EAAE,QAAA,EAAU,OAAS,EAAA,KAAA,KAAU,sBAAuB,CAAA;AAAA,IAC1D,cAAA;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,QAAA;AAAA,MACA,KAAA;AAAA,MACA,SAAA;AAAA,MACA,YAAA;AAAA,KACF;AAAA,GACD,CAAA,CAAA;AAED,EAAA,WAAA;AAAA,IACE,MAAM;AACJ,MAAA,IAAI,CAAC,QAAY,IAAA,MAAA,CAAO,KAAK,QAAQ,CAAA,CAAE,WAAW,CAAG,EAAA;AACnD,QAAA,gBAAA,CAAiB,EAAE,CAAA,CAAA;AACnB,QAAA,OAAA;AAAA,OACF;AAEA,MAAM,MAAA,KAAA,GAAQ,MAAO,CAAA,OAAA,CAAQ,QAAQ,CAAA,CAAE,IAAI,CAAC,CAAC,SAAW,EAAA,MAAM,CAAM,KAAA;AAClE,QAAM,MAAA,OAAA,GAAU,cAAe,CAAA,QAAA,CAAS,SAAS,CAAA,CAAA;AACjD,QAAA,MAAM,IAAmB,GAAA;AAAA,UACvB,EAAI,EAAA,SAAA;AAAA,UACJ,MAAA;AAAA,UACA,OAAA;AAAA,UACA,KAAA,EAAO,UAAU,WAAc,GAAA,SAAA;AAAA;AAAA,UAE/B,MAAM,MAAO,CAAA,IAAA;AAAA,UACb,IAAA,EAAM,OAAO,QAAS,CAAA,IAAA;AAAA,UACtB,SAAA,EAAW,MAAO,CAAA,QAAA,CAAS,SAAa,IAAA,iBAAA;AAAA,UACxC,KAAA,EAAO,OAAO,QAAS,CAAA,KAAA;AAAA,UACvB,MAAM,MAAO,CAAA,IAAA;AAAA,SACf,CAAA;AAEA,QAAA,IAAI,WAAa,EAAA;AACf,UAAA,IAAA,CAAK,OAAU,GAAA,CAAA,KAAA,KAAS,WAAY,CAAA,IAAA,EAAM,KAAK,CAAA,CAAA;AAAA,SACjD;AAEA,QAAO,OAAA,IAAA,CAAA;AAAA,OACR,CAAA,CAAA;AAED,MAAA,MAAM,QAAsB,EAAC,CAAA;AAC7B,MAAM,MAAA,YAAA,uBAAmB,GAAY,EAAA,CAAA;AACrC,MAAM,MAAA,SAAA,GAAY,CAAC,GAAG,cAAc,CAAA,CAAA;AAEpC,MAAO,OAAA,SAAA,CAAU,SAAS,CAAG,EAAA;AAC3B,QAAM,MAAA,SAAA,GAAY,UAAU,GAAI,EAAA,CAAA;AAChC,QAAM,MAAA,MAAA,GAAS,SAAS,SAAS,CAAA,CAAA;AACjC,QAAA,YAAA,CAAa,IAAI,SAAS,CAAA,CAAA;AAE1B,QAAA,IAAI,MAAQ,EAAA;AACV,UAAQ,MAAA,EAAA,SAAA,EAAW,QAAQ,CAAO,GAAA,KAAA;AAGhC,YAAA,IAAI,CAAC,QAAA,CAAS,GAAI,CAAA,SAAS,CAAG,EAAA;AAC5B,cAAA,OAAA;AAAA,aACF;AAEA,YAAA,IAAI,aAAa,CAAC,SAAA,CAAU,QAAS,CAAA,GAAA,CAAI,IAAI,CAAG,EAAA;AAC9C,cAAA,OAAA;AAAA,aACF;AAEA,YACE,IAAA,KAAA,IACA,CAAC,KAAM,CAAA,IAAA;AAAA,cAAK,CAAA,IAAA,KACV,IAAI,SAAU,CAAA,UAAA,CAAW,GAAG,IAAK,CAAA,iBAAA,CAAkB,OAAO,CAAC,CAAG,CAAA,CAAA,CAAA;AAAA,aAEhE,EAAA;AACA,cAAA,OAAA;AAAA,aACF;AAEA,YAAA,IAAI,CAAC,cAAkB,IAAA,CAAC,aAAa,GAAI,CAAA,GAAA,CAAI,SAAS,CAAG,EAAA;AACvD,cAAA,IAAI,cAAgB,EAAA;AAClB,gBAAA,MAAM,OAAO,aAAc,CAAA,IAAA;AAAA,kBACzB,CAAC,CAAC,CAAG,EAAA,CAAC,MAAM,CAAM,KAAA,GAAA,CAAI,IAAQ,IAAA,CAAA,KAAM,GAAI,CAAA,IAAA;AAAA,iBAC1C,IAAK,CAAC,GAAA,CAAI,IAAI,CAAA,CAAA;AACd,gBAAM,MAAA,CAAC,IAAI,CAAI,GAAA,IAAA,CAAA;AAEf,gBAAA,KAAA,CAAM,IAAK,CAAA;AAAA,kBACT,IAAM,EAAA,IAAA,KAAS,GAAI,CAAA,IAAA,GAAO,YAAY,GAAI,CAAA,SAAA;AAAA,kBAC1C,EAAI,EAAA,IAAA,KAAS,GAAI,CAAA,IAAA,GAAO,IAAI,SAAY,GAAA,SAAA;AAAA,kBACxC,SAAW,EAAA,IAAA;AAAA,kBACX,KAAO,EAAA,SAAA;AAAA,iBACR,CAAA,CAAA;AAAA,eACI,MAAA;AACL,gBAAA,KAAA,CAAM,IAAK,CAAA;AAAA,kBACT,IAAM,EAAA,SAAA;AAAA,kBACN,IAAI,GAAI,CAAA,SAAA;AAAA,kBACR,SAAA,EAAW,CAAC,GAAA,CAAI,IAAI,CAAA;AAAA,kBACpB,KAAO,EAAA,SAAA;AAAA,iBACR,CAAA,CAAA;AAAA,eACH;AAAA,aACF;AAEA,YAAA,IAAI,CAAC,YAAA,CAAa,GAAI,CAAA,GAAA,CAAI,SAAS,CAAG,EAAA;AACpC,cAAU,SAAA,CAAA,IAAA,CAAK,IAAI,SAAS,CAAA,CAAA;AAC5B,cAAa,YAAA,CAAA,GAAA,CAAI,IAAI,SAAS,CAAA,CAAA;AAAA,aAChC;AAGA,YAAA,IAAI,cAAgB,EAAA;AAClB,cAAA,MAAM,YAAY,KAAM,CAAA,SAAA;AAAA,gBACtB,CACE,IAAA,KAAA,SAAA,KAAc,IAAK,CAAA,IAAA,IACnB,GAAI,CAAA,SAAA,KAAc,IAAK,CAAA,EAAA,IACvB,CAAC,IAAA,CAAK,SAAU,CAAA,QAAA,CAAS,IAAI,IAAI,CAAA;AAAA,eACrC,CAAA;AACA,cAAA,IAAI,aAAa,CAAG,EAAA;AAClB,gBAAA,IAAI,cAAgB,EAAA;AAClB,kBAAA,MAAM,OAAO,aAAc,CAAA,IAAA;AAAA,oBACzB,CAAC,CAAC,CAAG,EAAA,CAAC,MAAM,CAAM,KAAA,GAAA,CAAI,IAAQ,IAAA,CAAA,KAAM,GAAI,CAAA,IAAA;AAAA,mBAC1C,IAAK,CAAC,GAAA,CAAI,IAAI,CAAA,CAAA;AACd,kBAAM,KAAA,CAAA,SAAS,EAAE,SAAY,GAAA;AAAA,oBAC3B,GAAG,KAAM,CAAA,SAAS,CAAE,CAAA,SAAA;AAAA,oBACpB,GAAG,IAAA;AAAA,mBACL,CAAA;AAAA,iBACK,MAAA;AACL,kBAAM,KAAA,CAAA,SAAS,EAAE,SAAY,GAAA;AAAA,oBAC3B,GAAG,KAAM,CAAA,SAAS,CAAE,CAAA,SAAA;AAAA,oBACpB,GAAI,CAAA,IAAA;AAAA,mBACN,CAAA;AAAA,iBACF;AAAA,eACF;AAAA,aACF;AAAA,WACD,CAAA,CAAA;AAAA,SACH;AAAA,OACF;AAIA,MAAA,MAAM,UAAa,GAAA,KAAA,CAAM,MAAO,CAAA,CAAC,eAAe,WAAgB,KAAA;AAC9D,QAAA,MAAM,aAAa,aAAc,CAAA,SAAA;AAAA,UAC/B,kBACE,YAAa,CAAA,IAAA,KAAS,YAAY,IAClC,IAAA,YAAA,CAAa,OAAO,WAAY,CAAA,EAAA;AAAA,SACpC,CAAA;AACA,QAAA,IAAI,cAAc,CAAG,EAAA;AACnB,UAAA,aAAA,CAAc,UAAU,CAAI,GAAA;AAAA,YAC1B,GAAG,cAAc,UAAU,CAAA;AAAA,YAC3B,WAAW,KAAM,CAAA,IAAA;AAAA,kCACX,GAAI,CAAA;AAAA,gBACN,GAAG,aAAc,CAAA,UAAU,CAAE,CAAA,SAAA;AAAA,gBAC7B,GAAG,WAAY,CAAA,SAAA;AAAA,eAChB,CAAA;AAAA,aACH;AAAA,WACF,CAAA;AACA,UAAO,OAAA,aAAA,CAAA;AAAA,SACT;AACA,QAAO,OAAA,CAAC,GAAG,aAAA,EAAe,WAAW,CAAA,CAAA;AAAA,OACvC,EAAG,EAAkB,CAAA,CAAA;AAErB,MAAA,gBAAA,CAAiB,EAAE,KAAA,EAAO,KAAO,EAAA,UAAA,EAAY,CAAA,CAAA;AAAA,KAC/C;AAAA,IACA,GAAA;AAAA,IACA;AAAA,MACE,QAAA;AAAA,MACA,cAAA;AAAA,MACA,KAAA;AAAA,MACA,SAAA;AAAA,MACA,cAAA;AAAA,MACA,cAAA;AAAA,MACA,WAAA;AAAA,MACA,aAAA;AAAA,KACF;AAAA,GACF,CAAA;AAEA,EAAO,OAAA;AAAA,IACL,OAAA;AAAA,IACA,KAAA;AAAA,IACA,GAAG,aAAA;AAAA,GACL,CAAA;AACF;;;;"}

package/dist/index.d.ts

@@ -133,6 +133,7 @@ type EntityRelationsGraphProps = {
     mergeRelations?: boolean;
     kinds?: string[];
     relations?: string[];
+    entityFilter?: (entity: Entity) => boolean;
     direction?: Direction;
     onNodeClick?: (value: EntityNode, event: MouseEvent<unknown>) => void;
     relationPairs?: RelationPairs;

package/package.json

@@ -1,8 +1,12 @@
 {
   "name": "@backstage/plugin-catalog-graph",
-  "version": "0.4.6-next.1",
+  "version": "0.4.6-next.2",
   "backstage": {
-    "role": "frontend-plugin"
+    "role": "frontend-plugin",
+    "pluginId": "catalog-graph",
+    "pluginPackages": [
+      "@backstage/plugin-catalog-graph"
+    ]
   },
   "publishConfig": {
     "access": "public"
@@ -46,11 +50,11 @@
   "dependencies": {
     "@backstage/catalog-client": "^1.6.5",
     "@backstage/catalog-model": "^1.5.0",
-    "@backstage/core-compat-api": "^0.2.6-next.1",
-    "@backstage/core-components": "^0.14.8-next.1",
+    "@backstage/core-compat-api": "^0.2.6-next.2",
+    "@backstage/core-components": "^0.14.8-next.2",
     "@backstage/core-plugin-api": "^1.9.3-next.0",
-    "@backstage/frontend-plugin-api": "^0.6.6-next.1",
-    "@backstage/plugin-catalog-react": "^1.12.1-next.1",
+    "@backstage/frontend-plugin-api": "^0.6.6-next.2",
+    "@backstage/plugin-catalog-react": "^1.12.1-next.2",
     "@backstage/types": "^1.1.1",
     "@material-ui/core": "^4.12.2",
     "@material-ui/icons": "^4.9.1",
@@ -63,11 +67,11 @@
     "react-use": "^17.2.4"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.26.7-next.2",
+    "@backstage/cli": "^0.26.7-next.3",
     "@backstage/core-app-api": "^1.12.6-next.0",
-    "@backstage/dev-utils": "^1.0.33-next.1",
-    "@backstage/plugin-catalog": "^1.21.0-next.2",
-    "@backstage/test-utils": "^1.5.6-next.1",
+    "@backstage/dev-utils": "^1.0.33-next.2",
+    "@backstage/plugin-catalog": "^1.21.0-next.3",
+    "@backstage/test-utils": "^1.5.6-next.2",
     "@testing-library/dom": "^10.0.0",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^15.0.0",