@statelyai/graph 0.13.0 → 1.0.0

package/dist/schemas.mjs

@@ -1,7 +1,16 @@
 import * as z from "zod";
 
 //#region src/schemas.ts
-const StyleSchema = z.record(z.string(), z.union([z.string(), z.number()]));
+const StyleSchema = z.record(z.string(), z.union([
+	z.string(),
+	z.number(),
+	z.boolean()
+]));
+const ModeSchema = z.enum([
+	"directed",
+	"undirected",
+	"bidirectional"
+]);
 const PortDirectionSchema = z.enum([
 	"in",
 	"out",
@@ -43,6 +52,7 @@ const EdgeSchema = z.object({
 	weight: z.number().optional(),
 	sourcePort: z.string().optional(),
 	targetPort: z.string().optional(),
+	mode: ModeSchema.optional(),
 	data: z.any(),
 	x: z.number().optional(),
 	y: z.number().optional(),
@@ -53,7 +63,7 @@ const EdgeSchema = z.object({
 });
 const GraphSchema = z.object({
 	id: z.string(),
-	type: z.enum(["directed", "undirected"]),
+	mode: ModeSchema,
 	initialNodeId: z.string().nullable().optional(),
 	nodes: z.array(NodeSchema),
 	edges: z.array(EdgeSchema),

package/dist/{types-CnZ01raw.d.mts → types-3-FS9NV2.d.mts}

@@ -1,4 +1,15 @@
 //#region src/types.d.ts
+/**
+ * Directedness of a graph or an individual edge.
+ *
+ * - `'directed'` — edge points from source to target.
+ * - `'undirected'` — edge has no direction; traversable both ways.
+ * - `'bidirectional'` — edge points both ways (arrows on both ends).
+ *
+ * Set at the graph level as the default ({@link Graph.mode}); individual edges
+ * may override it ({@link GraphEdge.mode}).
+ */
+type GraphMode = 'directed' | 'undirected' | 'bidirectional';
 interface EntityRect {
   x: number;
   y: number;
@@ -11,7 +22,7 @@ interface GraphEntity {
   y?: number;
   width?: number;
   height?: number;
-  style?: Record<string, string | number>;
+  style?: Record<string, string | number | boolean>;
 }
 /** Visual entity base — required position/size. */
 interface VisualGraphEntity {
@@ -19,7 +30,7 @@ interface VisualGraphEntity {
   y: number;
   width: number;
   height: number;
-  style?: Record<string, string | number>;
+  style?: Record<string, string | number | boolean>;
 }
 type PortDirection = 'in' | 'out' | 'inout';
 interface PortConfig<TPortData = any> extends GraphEntity {
@@ -42,13 +53,14 @@ interface VisualPort<TPortData = any> extends GraphPort<TPortData> {
 }
 interface GraphConfig<TNodeData = any, TEdgeData = any, TGraphData = any, TPortData = any> {
   id?: string;
-  type?: 'directed' | 'undirected';
+  /** Default directedness for all edges. Defaults to `'directed'`. */
+  mode?: GraphMode;
   initialNodeId?: string;
   nodes?: NodeConfig<TNodeData, TPortData>[];
   edges?: EdgeConfig<TEdgeData>[];
   data?: TGraphData;
   direction?: 'up' | 'down' | 'left' | 'right';
-  style?: Record<string, string | number>;
+  style?: Record<string, string | number | boolean>;
 }
 interface NodeConfig<TNodeData = any, TPortData = any> extends GraphEntity {
   id: string;
@@ -87,18 +99,24 @@ interface EdgeConfig<TEdgeData = any> extends GraphEntity {
   sourcePort?: string;
   /** Port name on the target node this edge connects to. */
   targetPort?: string;
+  /**
+   * Per-edge directedness override. When absent, the edge inherits the graph's
+   * {@link GraphConfig.mode}.
+   */
+  mode?: GraphMode;
   data?: TEdgeData;
   color?: string;
 }
 interface Graph<TNodeData = any, TEdgeData = any, TGraphData = any, TPortData = any> {
   id: string;
-  type: 'directed' | 'undirected';
+  /** Default directedness for all edges. */
+  mode: GraphMode;
   initialNodeId?: string | null;
   nodes: GraphNode<TNodeData, TPortData>[];
   edges: GraphEdge<TEdgeData>[];
   data: TGraphData;
   direction?: 'up' | 'down' | 'left' | 'right';
-  style?: Record<string, string | number>;
+  style?: Record<string, string | number | boolean>;
 }
 interface GraphNode<TNodeData = any, TPortData = any> extends GraphEntity {
   type: 'node';
@@ -127,6 +145,11 @@ interface GraphEdge<TEdgeData = any> extends GraphEntity {
   sourcePort?: string;
   /** Port name on the target node this edge connects to. */
   targetPort?: string;
+  /**
+   * Per-edge directedness override. When absent, the edge inherits the graph's
+   * {@link Graph.mode}.
+   */
+  mode?: GraphMode;
   data: TEdgeData;
   color?: string;
 }
@@ -352,4 +375,4 @@ interface TransitionOptions<TState, TEvent> {
   id?: string;
 }
 //#endregion
-export { VisualEdge as A, NodeConfig as C, SinglePathOptions as D, PortDirection as E, VisualNode as F, VisualPort as I, WalkContext as L, VisualGraphConfig as M, VisualGraphEntity as N, TransitionOptions as O, VisualGraphFormatConverter as P, WalkOptions as R, NodeChange as S, PortConfig as T, GraphPatch as _, EdgeChange as a, GraphStep as b, EntitiesUpdate as c, GraphConfig as d, GraphDiff as f, GraphNode as g, GraphFormatConverter as h, DeleteNodeOptions as i, VisualGraph as j, TraversalOptions as k, EntityRect as l, GraphEntity as m, AllPairsShortestPathsOptions as n, EdgeConfig as o, GraphEdge as p, CoverageStats as r, EntitiesConfig as s, AStarOptions as t, Graph as u, GraphPath as v, PathOptions as w, MSTOptions as x, GraphPort as y, WeightedWalkOptions as z };
+export { TraversalOptions as A, WeightedWalkOptions as B, NodeChange as C, PortDirection as D, PortConfig as E, VisualGraphFormatConverter as F, VisualNode as I, VisualPort as L, VisualGraph as M, VisualGraphConfig as N, SinglePathOptions as O, VisualGraphEntity as P, WalkContext as R, MSTOptions as S, PathOptions as T, GraphNode as _, EdgeChange as a, GraphPort as b, EntitiesUpdate as c, GraphConfig as d, GraphDiff as f, GraphMode as g, GraphFormatConverter as h, DeleteNodeOptions as i, VisualEdge as j, TransitionOptions as k, EntityRect as l, GraphEntity as m, AllPairsShortestPathsOptions as n, EdgeConfig as o, GraphEdge as p, CoverageStats as r, EntitiesConfig as s, AStarOptions as t, Graph as u, GraphPatch as v, NodeConfig as w, GraphStep as x, GraphPath as y, WalkOptions as z };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@statelyai/graph",
   "type": "module",
-  "version": "0.13.0",
+  "version": "1.0.0",
   "description": "A TypeScript-first graph library with plain JSON-serializable objects",
   "author": "David Khourshid <david@stately.ai>",
   "license": "MIT",
@@ -28,6 +28,7 @@
     "./adjacency-list": "./dist/formats/adjacency-list/index.mjs",
     "./converter": "./dist/formats/converter/index.mjs",
     "./cytoscape": "./dist/formats/cytoscape/index.mjs",
+    "./d2": "./dist/formats/d2/index.mjs",
     "./d3": "./dist/formats/d3/index.mjs",
     "./dot": "./dist/formats/dot/index.mjs",
     "./edge-list": "./dist/formats/edge-list/index.mjs",

package/schemas/edge.schema.json

@@ -34,6 +34,14 @@
     "targetPort": {
       "type": "string"
     },
+    "mode": {
+      "type": "string",
+      "enum": [
+        "directed",
+        "undirected",
+        "bidirectional"
+      ]
+    },
     "data": {},
     "x": {
       "type": "number"
@@ -62,6 +70,9 @@
           },
           {
             "type": "number"
+          },
+          {
+            "type": "boolean"
           }
         ]
       }

package/schemas/graph.schema.json

@@ -5,11 +5,12 @@
     "id": {
       "type": "string"
     },
-    "type": {
+    "mode": {
       "type": "string",
       "enum": [
         "directed",
-        "undirected"
+        "undirected",
+        "bidirectional"
       ]
     },
     "initialNodeId": {
@@ -95,6 +96,9 @@
                 },
                 {
                   "type": "number"
+                },
+                {
+                  "type": "boolean"
                 }
               ]
             }
@@ -143,6 +147,9 @@
                       },
                       {
                         "type": "number"
+                      },
+                      {
+                        "type": "boolean"
                       }
                     ]
                   }
@@ -202,6 +209,14 @@
           "targetPort": {
             "type": "string"
           },
+          "mode": {
+            "type": "string",
+            "enum": [
+              "directed",
+              "undirected",
+              "bidirectional"
+            ]
+          },
           "data": {},
           "x": {
             "type": "number"
@@ -230,6 +245,9 @@
                 },
                 {
                   "type": "number"
+                },
+                {
+                  "type": "boolean"
                 }
               ]
             }
@@ -267,6 +285,9 @@
           },
           {
             "type": "number"
+          },
+          {
+            "type": "boolean"
           }
         ]
       }
@@ -274,7 +295,7 @@
   },
   "required": [
     "id",
-    "type",
+    "mode",
     "nodes",
     "edges",
     "data"

package/schemas/node.schema.json

@@ -70,6 +70,9 @@
           },
           {
             "type": "number"
+          },
+          {
+            "type": "boolean"
           }
         ]
       }
@@ -118,6 +121,9 @@
                 },
                 {
                   "type": "number"
+                },
+                {
+                  "type": "boolean"
                 }
               ]
             }