@statelyai/graph 0.4.0 → 0.5.0

package/dist/schemas.d.mts

@@ -4,10 +4,17 @@ import * as z from "zod";
 declare const NodeSchema: z.ZodObject<{
   type: z.ZodLiteral<"node">;
   id: z.ZodString;
-  parentId: z.ZodNullable<z.ZodString>;
-  initialNodeId: z.ZodNullable<z.ZodString>;
+  parentId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+  initialNodeId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
   label: z.ZodString;
   data: z.ZodAny;
+  x: z.ZodOptional<z.ZodNumber>;
+  y: z.ZodOptional<z.ZodNumber>;
+  width: z.ZodOptional<z.ZodNumber>;
+  height: z.ZodOptional<z.ZodNumber>;
+  shape: z.ZodOptional<z.ZodString>;
+  color: z.ZodOptional<z.ZodString>;
+  style: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>>;
 }, z.core.$strip>;
 declare const EdgeSchema: z.ZodObject<{
   type: z.ZodLiteral<"edge">;
@@ -16,6 +23,12 @@ declare const EdgeSchema: z.ZodObject<{
   targetId: z.ZodString;
   label: z.ZodString;
   data: z.ZodAny;
+  x: z.ZodOptional<z.ZodNumber>;
+  y: z.ZodOptional<z.ZodNumber>;
+  width: z.ZodOptional<z.ZodNumber>;
+  height: z.ZodOptional<z.ZodNumber>;
+  color: z.ZodOptional<z.ZodString>;
+  style: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>>;
 }, z.core.$strip>;
 declare const GraphSchema: z.ZodObject<{
   id: z.ZodString;
@@ -27,10 +40,17 @@ declare const GraphSchema: z.ZodObject<{
   nodes: z.ZodArray<z.ZodObject<{
     type: z.ZodLiteral<"node">;
     id: z.ZodString;
-    parentId: z.ZodNullable<z.ZodString>;
-    initialNodeId: z.ZodNullable<z.ZodString>;
+    parentId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    initialNodeId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     label: z.ZodString;
     data: z.ZodAny;
+    x: z.ZodOptional<z.ZodNumber>;
+    y: z.ZodOptional<z.ZodNumber>;
+    width: z.ZodOptional<z.ZodNumber>;
+    height: z.ZodOptional<z.ZodNumber>;
+    shape: z.ZodOptional<z.ZodString>;
+    color: z.ZodOptional<z.ZodString>;
+    style: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>>;
   }, z.core.$strip>>;
   edges: z.ZodArray<z.ZodObject<{
     type: z.ZodLiteral<"edge">;
@@ -39,8 +59,21 @@ declare const GraphSchema: z.ZodObject<{
     targetId: z.ZodString;
     label: z.ZodString;
     data: z.ZodAny;
+    x: z.ZodOptional<z.ZodNumber>;
+    y: z.ZodOptional<z.ZodNumber>;
+    width: z.ZodOptional<z.ZodNumber>;
+    height: z.ZodOptional<z.ZodNumber>;
+    color: z.ZodOptional<z.ZodString>;
+    style: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>>;
   }, z.core.$strip>>;
   data: z.ZodAny;
+  direction: z.ZodOptional<z.ZodEnum<{
+    up: "up";
+    down: "down";
+    left: "left";
+    right: "right";
+  }>>;
+  style: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>>;
 }, z.core.$strip>;
 //#endregion
 export { EdgeSchema, GraphSchema, NodeSchema };

package/dist/schemas.mjs

@@ -1,13 +1,21 @@
 import * as z from "zod";
 
 //#region src/schemas.ts
+const StyleSchema = z.record(z.string(), z.union([z.string(), z.number()]));
 const NodeSchema = z.object({
 	type: z.literal("node"),
 	id: z.string(),
-	parentId: z.string().nullable(),
-	initialNodeId: z.string().nullable(),
+	parentId: z.string().nullable().optional(),
+	initialNodeId: z.string().nullable().optional(),
 	label: z.string(),
-	data: z.any()
+	data: z.any(),
+	x: z.number().optional(),
+	y: z.number().optional(),
+	width: z.number().optional(),
+	height: z.number().optional(),
+	shape: z.string().optional(),
+	color: z.string().optional(),
+	style: StyleSchema.optional()
 });
 const EdgeSchema = z.object({
 	type: z.literal("edge"),
@@ -15,7 +23,13 @@ const EdgeSchema = z.object({
 	sourceId: z.string(),
 	targetId: z.string(),
 	label: z.string(),
-	data: z.any()
+	data: z.any(),
+	x: z.number().optional(),
+	y: z.number().optional(),
+	width: z.number().optional(),
+	height: z.number().optional(),
+	color: z.string().optional(),
+	style: StyleSchema.optional()
 });
 const GraphSchema = z.object({
 	id: z.string(),
@@ -23,7 +37,14 @@ const GraphSchema = z.object({
 	initialNodeId: z.string().nullable(),
 	nodes: z.array(NodeSchema),
 	edges: z.array(EdgeSchema),
-	data: z.any()
+	data: z.any(),
+	direction: z.enum([
+		"up",
+		"down",
+		"left",
+		"right"
+	]).optional(),
+	style: StyleSchema.optional()
 });
 
 //#endregion

package/dist/{types-Bq_fmLwW.d.mts → types-FBZCrmnG.d.mts}

@@ -228,22 +228,22 @@ type GraphPatch<TNodeData = any, TEdgeData = any> = {
  * };
  * ```
  */
-interface GraphFormatConverter<TSerial> {
+interface GraphFormatConverter<TSerial, N = any, E = any, G = any> {
   /** Convert a Graph to the serialized format. */
-  to(graph: Graph): TSerial;
+  to(graph: Graph<N, E, G>): TSerial;
   /** Convert from the serialized format to a Graph. */
-  from(input: TSerial): Graph;
+  from(input: TSerial): Graph<N, E, G>;
 }
 /**
  * A bidirectional converter between `VisualGraph` and a serialized format.
  *
  * Use this for formats that carry position/size data (e.g. xyflow, cytoscape).
  */
-interface VisualGraphFormatConverter<TSerial> {
+interface VisualGraphFormatConverter<TSerial, N = any, E = any, G = any> {
   /** Convert a VisualGraph to the serialized format. */
-  to(graph: VisualGraph): TSerial;
+  to(graph: VisualGraph<N, E, G>): TSerial;
   /** Convert from the serialized format to a VisualGraph. */
-  from(input: TSerial): VisualGraph;
+  from(input: TSerial): VisualGraph<N, E, G>;
 }
 interface TransitionOptions<TState, TEvent> {
   /** Initial state to begin BFS exploration from. */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@statelyai/graph",
   "type": "module",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "A TypeScript-first graph library with plain JSON-serializable objects",
   "author": "David Khourshid <david@stately.ai>",
   "license": "MIT",
@@ -30,6 +30,7 @@
     "./d3": "./dist/formats/d3/index.mjs",
     "./dot": "./dist/formats/dot/index.mjs",
     "./edge-list": "./dist/formats/edge-list/index.mjs",
+    "./elk": "./dist/formats/elk/index.mjs",
     "./gexf": "./dist/formats/gexf/index.mjs",
     "./gml": "./dist/formats/gml/index.mjs",
     "./graphml": "./dist/formats/graphml/index.mjs",
@@ -60,6 +61,7 @@
     "d3-array": "^3.2.4",
     "d3-force": "^3.0.0",
     "dotparser": "^1.1.1",
+    "elkjs": "^0.11.1",
     "fast-xml-parser": "^5.3.4",
     "tsdown": "^0.18.1",
     "tsx": "^4.21.0",
@@ -72,6 +74,7 @@
     "cytoscape": "^3.0.0",
     "d3-force": "^3.0.0",
     "dotparser": "^1.0.0",
+    "elkjs": "^0.9.0 || ^0.10.0 || ^0.11.0",
     "fast-xml-parser": "^5.0.0",
     "zod": "^4.0.0"
   },
@@ -85,6 +88,9 @@
     "dotparser": {
       "optional": true
     },
+    "elkjs": {
+      "optional": true
+    },
     "fast-xml-parser": {
       "optional": true
     },

package/schemas/edge.schema.json

@@ -18,7 +18,38 @@
     "label": {
       "type": "string"
     },
-    "data": {}
+    "data": {},
+    "x": {
+      "type": "number"
+    },
+    "y": {
+      "type": "number"
+    },
+    "width": {
+      "type": "number"
+    },
+    "height": {
+      "type": "number"
+    },
+    "color": {
+      "type": "string"
+    },
+    "style": {
+      "type": "object",
+      "propertyNames": {
+        "type": "string"
+      },
+      "additionalProperties": {
+        "anyOf": [
+          {
+            "type": "string"
+          },
+          {
+            "type": "number"
+          }
+        ]
+      }
+    }
   },
   "required": [
     "type",

package/schemas/graph.schema.json

@@ -12,6 +12,16 @@
         "undirected"
       ]
     },
+    "initialNodeId": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
     "nodes": {
       "type": "array",
       "items": {
@@ -34,15 +44,58 @@
               }
             ]
           },
+          "initialNodeId": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
           "label": {
             "type": "string"
           },
-          "data": {}
+          "data": {},
+          "x": {
+            "type": "number"
+          },
+          "y": {
+            "type": "number"
+          },
+          "width": {
+            "type": "number"
+          },
+          "height": {
+            "type": "number"
+          },
+          "shape": {
+            "type": "string"
+          },
+          "color": {
+            "type": "string"
+          },
+          "style": {
+            "type": "object",
+            "propertyNames": {
+              "type": "string"
+            },
+            "additionalProperties": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "number"
+                }
+              ]
+            }
+          }
         },
         "required": [
           "type",
           "id",
-          "parentId",
           "label",
           "data"
         ],
@@ -70,7 +123,38 @@
           "label": {
             "type": "string"
           },
-          "data": {}
+          "data": {},
+          "x": {
+            "type": "number"
+          },
+          "y": {
+            "type": "number"
+          },
+          "width": {
+            "type": "number"
+          },
+          "height": {
+            "type": "number"
+          },
+          "color": {
+            "type": "string"
+          },
+          "style": {
+            "type": "object",
+            "propertyNames": {
+              "type": "string"
+            },
+            "additionalProperties": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "number"
+                }
+              ]
+            }
+          }
         },
         "required": [
           "type",
@@ -83,11 +167,37 @@
         "additionalProperties": false
       }
     },
-    "data": {}
+    "data": {},
+    "direction": {
+      "type": "string",
+      "enum": [
+        "up",
+        "down",
+        "left",
+        "right"
+      ]
+    },
+    "style": {
+      "type": "object",
+      "propertyNames": {
+        "type": "string"
+      },
+      "additionalProperties": {
+        "anyOf": [
+          {
+            "type": "string"
+          },
+          {
+            "type": "number"
+          }
+        ]
+      }
+    }
   },
   "required": [
     "id",
     "type",
+    "initialNodeId",
     "nodes",
     "edges",
     "data"

package/schemas/node.schema.json

@@ -19,15 +19,58 @@
         }
       ]
     },
+    "initialNodeId": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
     "label": {
       "type": "string"
     },
-    "data": {}
+    "data": {},
+    "x": {
+      "type": "number"
+    },
+    "y": {
+      "type": "number"
+    },
+    "width": {
+      "type": "number"
+    },
+    "height": {
+      "type": "number"
+    },
+    "shape": {
+      "type": "string"
+    },
+    "color": {
+      "type": "string"
+    },
+    "style": {
+      "type": "object",
+      "propertyNames": {
+        "type": "string"
+      },
+      "additionalProperties": {
+        "anyOf": [
+          {
+            "type": "string"
+          },
+          {
+            "type": "number"
+          }
+        ]
+      }
+    }
   },
   "required": [
     "type",
     "id",
-    "parentId",
     "label",
     "data"
   ],