@backstage/plugin-catalog-graph 0.4.5-next.1 → 0.4.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +23 -0
- package/alpha/package.json +1 -1
- package/dist/components/EntityRelationsGraph/DefaultRenderLabel.esm.js +1 -1
- package/dist/components/EntityRelationsGraph/DefaultRenderLabel.esm.js.map +1 -1
- package/dist/components/EntityRelationsGraph/useEntityRelationNodesAndEdges.esm.js +41 -2
- package/dist/components/EntityRelationsGraph/useEntityRelationNodesAndEdges.esm.js.map +1 -1
- package/package.json +12 -12
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,28 @@
|
|
|
1
1
|
# @backstage/plugin-catalog-graph
|
|
2
2
|
|
|
3
|
+
## 0.4.5
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 39564b3: Allow multiple edges with different type (e.g. `ownedBy` and `applicationOwnerBy`) to have the same source and target node.
|
|
8
|
+
- Updated dependencies
|
|
9
|
+
- @backstage/core-compat-api@0.2.5
|
|
10
|
+
- @backstage/core-components@0.14.7
|
|
11
|
+
- @backstage/catalog-model@1.5.0
|
|
12
|
+
- @backstage/plugin-catalog-react@1.12.0
|
|
13
|
+
- @backstage/catalog-client@1.6.5
|
|
14
|
+
- @backstage/frontend-plugin-api@0.6.5
|
|
15
|
+
|
|
16
|
+
## 0.4.5-next.2
|
|
17
|
+
|
|
18
|
+
### Patch Changes
|
|
19
|
+
|
|
20
|
+
- Updated dependencies
|
|
21
|
+
- @backstage/plugin-catalog-react@1.12.0-next.2
|
|
22
|
+
- @backstage/core-components@0.14.7-next.2
|
|
23
|
+
- @backstage/core-compat-api@0.2.5-next.1
|
|
24
|
+
- @backstage/frontend-plugin-api@0.6.5-next.1
|
|
25
|
+
|
|
3
26
|
## 0.4.5-next.1
|
|
4
27
|
|
|
5
28
|
### Patch Changes
|
package/alpha/package.json
CHANGED
|
@@ -17,7 +17,7 @@ function DefaultRenderLabel({
|
|
|
17
17
|
edge: { relations }
|
|
18
18
|
}) {
|
|
19
19
|
const classes = useStyles();
|
|
20
|
-
return /* @__PURE__ */ React.createElement("text", { className: classes.text, textAnchor: "middle" }, relations.map((r, i) => /* @__PURE__ */ React.createElement("tspan", { key: r, className: classNames(i
|
|
20
|
+
return /* @__PURE__ */ React.createElement("text", { className: classes.text, textAnchor: "middle" }, relations.map((r, i) => /* @__PURE__ */ React.createElement("tspan", { key: r, className: classNames(i % 2 !== 0 && classes.secondary) }, i > 0 && /* @__PURE__ */ React.createElement("tspan", null, " / "), r)));
|
|
21
21
|
}
|
|
22
22
|
|
|
23
23
|
export { DefaultRenderLabel };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"DefaultRenderLabel.esm.js","sources":["../../../src/components/EntityRelationsGraph/DefaultRenderLabel.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 */\nimport { DependencyGraphTypes } from '@backstage/core-components';\nimport makeStyles from '@material-ui/core/styles/makeStyles';\nimport React from 'react';\nimport { EntityEdgeData } from './types';\nimport classNames from 'classnames';\n\nconst useStyles = makeStyles(\n theme => ({\n text: {\n fill: theme.palette.textContrast,\n },\n secondary: {\n fill: theme.palette.textSubtle,\n },\n }),\n { name: 'PluginCatalogGraphCustomLabel' },\n);\n\nexport function DefaultRenderLabel({\n edge: { relations },\n}: DependencyGraphTypes.RenderLabelProps<EntityEdgeData>) {\n const classes = useStyles();\n return (\n <text className={classes.text} textAnchor=\"middle\">\n {relations.map((r, i) => (\n <tspan key={r} className={classNames(i
|
|
1
|
+
{"version":3,"file":"DefaultRenderLabel.esm.js","sources":["../../../src/components/EntityRelationsGraph/DefaultRenderLabel.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 */\nimport { DependencyGraphTypes } from '@backstage/core-components';\nimport makeStyles from '@material-ui/core/styles/makeStyles';\nimport React from 'react';\nimport { EntityEdgeData } from './types';\nimport classNames from 'classnames';\n\nconst useStyles = makeStyles(\n theme => ({\n text: {\n fill: theme.palette.textContrast,\n },\n secondary: {\n fill: theme.palette.textSubtle,\n },\n }),\n { name: 'PluginCatalogGraphCustomLabel' },\n);\n\nexport function DefaultRenderLabel({\n edge: { relations },\n}: DependencyGraphTypes.RenderLabelProps<EntityEdgeData>) {\n const classes = useStyles();\n return (\n <text className={classes.text} textAnchor=\"middle\">\n {relations.map((r, i) => (\n <tspan key={r} className={classNames(i % 2 !== 0 && classes.secondary)}>\n {i > 0 && <tspan> / </tspan>}\n {r}\n </tspan>\n ))}\n </text>\n );\n}\n"],"names":[],"mappings":";;;;AAqBA,MAAM,SAAY,GAAA,UAAA;AAAA,EAChB,CAAU,KAAA,MAAA;AAAA,IACR,IAAM,EAAA;AAAA,MACJ,IAAA,EAAM,MAAM,OAAQ,CAAA,YAAA;AAAA,KACtB;AAAA,IACA,SAAW,EAAA;AAAA,MACT,IAAA,EAAM,MAAM,OAAQ,CAAA,UAAA;AAAA,KACtB;AAAA,GACF,CAAA;AAAA,EACA,EAAE,MAAM,+BAAgC,EAAA;AAC1C,CAAA,CAAA;AAEO,SAAS,kBAAmB,CAAA;AAAA,EACjC,IAAA,EAAM,EAAE,SAAU,EAAA;AACpB,CAA0D,EAAA;AACxD,EAAA,MAAM,UAAU,SAAU,EAAA,CAAA;AAC1B,EAAA,uBACG,KAAA,CAAA,aAAA,CAAA,MAAA,EAAA,EAAK,SAAW,EAAA,OAAA,CAAQ,MAAM,UAAW,EAAA,QAAA,EAAA,EACvC,SAAU,CAAA,GAAA,CAAI,CAAC,CAAA,EAAG,CACjB,qBAAA,KAAA,CAAA,aAAA,CAAC,WAAM,GAAK,EAAA,CAAA,EAAG,SAAW,EAAA,UAAA,CAAW,CAAI,GAAA,CAAA,KAAM,CAAK,IAAA,OAAA,CAAQ,SAAS,CAClE,EAAA,EAAA,CAAA,GAAI,CAAK,oBAAA,KAAA,CAAA,aAAA,CAAC,OAAM,EAAA,IAAA,EAAA,KAAG,CACnB,EAAA,CACH,CACD,CACH,CAAA,CAAA;AAEJ;;;;"}
|
|
@@ -58,7 +58,7 @@ function useEntityRelationNodesAndEdges({
|
|
|
58
58
|
visitedNodes.add(entityRef);
|
|
59
59
|
if (entity) {
|
|
60
60
|
(_a = entity == null ? void 0 : entity.relations) == null ? void 0 : _a.forEach((rel) => {
|
|
61
|
-
var _a2;
|
|
61
|
+
var _a2, _b;
|
|
62
62
|
if (!entities[rel.targetRef]) {
|
|
63
63
|
return;
|
|
64
64
|
}
|
|
@@ -95,10 +95,49 @@ function useEntityRelationNodesAndEdges({
|
|
|
95
95
|
nodeQueue.push(rel.targetRef);
|
|
96
96
|
visitedNodes.add(rel.targetRef);
|
|
97
97
|
}
|
|
98
|
+
if (unidirectional) {
|
|
99
|
+
const findIndex = edges.findIndex(
|
|
100
|
+
(edge) => entityRef === edge.from && rel.targetRef === edge.to && !edge.relations.includes(rel.type)
|
|
101
|
+
);
|
|
102
|
+
if (findIndex >= 0) {
|
|
103
|
+
if (mergeRelations) {
|
|
104
|
+
const pair = (_b = relationPairs.find(
|
|
105
|
+
([l, r]) => l === rel.type || r === rel.type
|
|
106
|
+
)) != null ? _b : [rel.type];
|
|
107
|
+
edges[findIndex].relations = [
|
|
108
|
+
...edges[findIndex].relations,
|
|
109
|
+
...pair
|
|
110
|
+
];
|
|
111
|
+
} else {
|
|
112
|
+
edges[findIndex].relations = [
|
|
113
|
+
...edges[findIndex].relations,
|
|
114
|
+
rel.type
|
|
115
|
+
];
|
|
116
|
+
}
|
|
117
|
+
}
|
|
118
|
+
}
|
|
98
119
|
});
|
|
99
120
|
}
|
|
100
121
|
}
|
|
101
|
-
|
|
122
|
+
const finalEdges = edges.reduce((previousEdges, currentEdge) => {
|
|
123
|
+
const indexFound = previousEdges.findIndex(
|
|
124
|
+
(previousEdge) => previousEdge.from === currentEdge.from && previousEdge.to === currentEdge.to
|
|
125
|
+
);
|
|
126
|
+
if (indexFound >= 0) {
|
|
127
|
+
previousEdges[indexFound] = {
|
|
128
|
+
...previousEdges[indexFound],
|
|
129
|
+
relations: Array.from(
|
|
130
|
+
/* @__PURE__ */ new Set([
|
|
131
|
+
...previousEdges[indexFound].relations,
|
|
132
|
+
...currentEdge.relations
|
|
133
|
+
])
|
|
134
|
+
)
|
|
135
|
+
};
|
|
136
|
+
return previousEdges;
|
|
137
|
+
}
|
|
138
|
+
return [...previousEdges, currentEdge];
|
|
139
|
+
}, []);
|
|
140
|
+
setNodesAndEdges({ nodes, edges: finalEdges });
|
|
102
141
|
},
|
|
103
142
|
100,
|
|
104
143
|
[
|
|
@@ -1 +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 }\n }\n\n setNodesAndEdges({ nodes, edges });\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":["_a"],"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;AA/DV,MAAA,IAAA,EAAA,CAAA;AAgEM,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,CAAA,EAAA,GAAA,MAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,MAAA,CAAA,SAAA,KAAR,IAAmB,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,OAAA,CAAQ,CAAO,GAAA,KAAA;AArG5C,YAAAA,IAAAA,GAAAA,CAAAA;AAwGY,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,gBAAM,MAAA,IAAA,GAAA,CAAOA,MAAA,aAAc,CAAA,IAAA;AAAA,kBACzB,CAAC,CAAC,CAAG,EAAA,CAAC,MAAM,CAAM,KAAA,GAAA,CAAI,IAAQ,IAAA,CAAA,KAAM,GAAI,CAAA,IAAA;AAAA,iBAD7B,KAAA,IAAA,GAAAA,GAER,GAAA,CAAC,IAAI,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;AAAA,WACF,CAAA,CAAA;AAAA,SACF;AAAA,OACF;AAEA,MAAiB,gBAAA,CAAA,EAAE,KAAO,EAAA,KAAA,EAAO,CAAA,CAAA;AAAA,KACnC;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;;;;"}
|
|
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":["_a"],"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;AA/DV,MAAA,IAAA,EAAA,CAAA;AAgEM,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,CAAA,EAAA,GAAA,MAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,MAAA,CAAA,SAAA,KAAR,IAAmB,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,OAAA,CAAQ,CAAO,GAAA,KAAA;AArG5C,YAAA,IAAAA,GAAA,EAAA,EAAA,CAAA;AAwGY,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,gBAAM,MAAA,IAAA,GAAA,CAAOA,MAAA,aAAc,CAAA,IAAA;AAAA,kBACzB,CAAC,CAAC,CAAG,EAAA,CAAC,MAAM,CAAM,KAAA,GAAA,CAAI,IAAQ,IAAA,CAAA,KAAM,GAAI,CAAA,IAAA;AAAA,iBAD7B,KAAA,IAAA,GAAAA,GAER,GAAA,CAAC,IAAI,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,QAAO,EAAc,GAAA,aAAA,CAAA,IAAA;AAAA,oBACzB,CAAC,CAAC,CAAG,EAAA,CAAC,MAAM,CAAM,KAAA,GAAA,CAAI,IAAQ,IAAA,CAAA,KAAM,GAAI,CAAA,IAAA;AAAA,mBAD7B,KAAA,IAAA,GAAA,EAAA,GAER,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,WACF,CAAA,CAAA;AAAA,SACF;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/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-catalog-graph",
|
|
3
|
-
"version": "0.4.5
|
|
3
|
+
"version": "0.4.5",
|
|
4
4
|
"backstage": {
|
|
5
5
|
"role": "frontend-plugin"
|
|
6
6
|
},
|
|
@@ -44,13 +44,13 @@
|
|
|
44
44
|
"test": "backstage-cli package test"
|
|
45
45
|
},
|
|
46
46
|
"dependencies": {
|
|
47
|
-
"@backstage/catalog-client": "^1.6.5
|
|
48
|
-
"@backstage/catalog-model": "^1.5.0
|
|
49
|
-
"@backstage/core-compat-api": "^0.2.5
|
|
50
|
-
"@backstage/core-components": "^0.14.
|
|
47
|
+
"@backstage/catalog-client": "^1.6.5",
|
|
48
|
+
"@backstage/catalog-model": "^1.5.0",
|
|
49
|
+
"@backstage/core-compat-api": "^0.2.5",
|
|
50
|
+
"@backstage/core-components": "^0.14.7",
|
|
51
51
|
"@backstage/core-plugin-api": "^1.9.2",
|
|
52
|
-
"@backstage/frontend-plugin-api": "^0.6.5
|
|
53
|
-
"@backstage/plugin-catalog-react": "^1.
|
|
52
|
+
"@backstage/frontend-plugin-api": "^0.6.5",
|
|
53
|
+
"@backstage/plugin-catalog-react": "^1.12.0",
|
|
54
54
|
"@backstage/types": "^1.1.1",
|
|
55
55
|
"@material-ui/core": "^4.12.2",
|
|
56
56
|
"@material-ui/icons": "^4.9.1",
|
|
@@ -63,11 +63,11 @@
|
|
|
63
63
|
"react-use": "^17.2.4"
|
|
64
64
|
},
|
|
65
65
|
"devDependencies": {
|
|
66
|
-
"@backstage/cli": "^0.26.5
|
|
67
|
-
"@backstage/core-app-api": "^1.12.
|
|
68
|
-
"@backstage/dev-utils": "^1.0.32
|
|
69
|
-
"@backstage/plugin-catalog": "^1.
|
|
70
|
-
"@backstage/test-utils": "^1.5.5
|
|
66
|
+
"@backstage/cli": "^0.26.5",
|
|
67
|
+
"@backstage/core-app-api": "^1.12.5",
|
|
68
|
+
"@backstage/dev-utils": "^1.0.32",
|
|
69
|
+
"@backstage/plugin-catalog": "^1.20.0",
|
|
70
|
+
"@backstage/test-utils": "^1.5.5",
|
|
71
71
|
"@testing-library/dom": "^10.0.0",
|
|
72
72
|
"@testing-library/jest-dom": "^6.0.0",
|
|
73
73
|
"@testing-library/react": "^15.0.0",
|