@infrascan/shared-types 0.2.4 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @infrascan/shared-types
 
+## 0.3.0
+
+### Minor Changes
+
+- [#75](https://github.com/infrascan/infrascan/pull/75) [`4634235`](https://github.com/infrascan/infrascan/commit/4634235d61bd6bd817c6fb9e62add778218b69b6) Thanks [@lfarrel6](https://github.com/lfarrel6)! - Add graph model interface to shared types package
+
 ## 0.2.4
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@infrascan/shared-types",
-  "version": "0.2.4",
+  "version": "0.3.0",
   "description": "Shared types for multiple infrascan packages",
   "main": "src/index.ts",
   "scripts": {

package/src/graph.ts

@@ -68,3 +68,38 @@ export type EdgeTarget = {
   name: string;
   target: string;
 };
+
+export interface Node {
+  id: string,
+  name: string,
+  metadata: Record<string, unknown>;
+  service?: string,
+  type?: string,
+  parent?: string | Node,
+  children?: Record<string, Node>,
+  incomingEdges: Record<string, Edge<Node>>,
+  outgoingEdges: Record<string, Edge<Node>>,
+}
+
+export interface Edge<T extends string | Node> {
+  id: string,
+  name?: string,
+  metadata: Record<string, unknown>,
+  source: T,
+  target: T
+}
+
+export interface Graph {
+  nodes: Node[],
+  edges: Edge<Node>[],
+  addNode: (node: Pick<Node, "id" | "name" | "metadata" | "parent" | "service" | "type">) => void,
+  addEdge: (edge: Pick<Edge<string>, "name" | "source" | "target" | "metadata">) => void,
+  addChild: (parent: string, child: string) => void,
+  getNode: (id: string) => Node | undefined,
+  mapNodesById: (id: string, mapperFn: (node: Node) => Node[]) => void,
+  removeEdge: (id: string) => Edge<Node>,
+  removeNode: (id: string) => Node,
+  serialize: () => string
+};
+
+export type GraphSerializer<T> = (graph: Graph) => T;