@statelyai/graph 0.7.0 → 0.9.0

package/dist/{types-DkKjaQW3.d.mts → types-BzckPChi.d.mts}

@@ -5,31 +5,59 @@ interface EntityRect {
   width: number;
   height: number;
 }
-interface GraphConfig<TNodeData = any, TEdgeData = any, TGraphData = any> {
+/** Config-level base — shared optional visual/style props for nodes, edges, ports. */
+interface GraphEntityConfig {
+  x?: number;
+  y?: number;
+  width?: number;
+  height?: number;
+  style?: Record<string, string | number>;
+}
+/** Resolved entity base — optional visual props (non-visual graphs may omit). */
+interface GraphEntity extends GraphEntityConfig {}
+/** Visual entity base — required position/size. */
+interface VisualGraphEntity {
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+  style?: Record<string, string | number>;
+}
+type PortDirection = 'in' | 'out' | 'inout';
+interface PortConfig<TPortData = any> extends GraphEntityConfig {
+  name: string;
+  direction?: PortDirection;
+  label?: string;
+  data?: TPortData;
+}
+interface GraphPort<TPortData = any> extends GraphEntity {
+  name: string;
+  direction: PortDirection;
+  label?: string;
+  data: TPortData;
+}
+interface VisualPort<TPortData = any> extends Omit<GraphPort<TPortData>, keyof EntityRect>, VisualGraphEntity {}
+interface GraphConfig<TNodeData = any, TEdgeData = any, TGraphData = any, TPortData = any> {
   id?: string;
   type?: 'directed' | 'undirected';
   initialNodeId?: string;
-  nodes?: NodeConfig<TNodeData>[];
+  nodes?: NodeConfig<TNodeData, TPortData>[];
   edges?: EdgeConfig<TEdgeData>[];
   data?: TGraphData;
   direction?: 'up' | 'down' | 'left' | 'right';
   style?: Record<string, string | number>;
 }
-interface NodeConfig<TNodeData = any> {
+interface NodeConfig<TNodeData = any, TPortData = any> extends GraphEntityConfig {
   id: string;
   parentId?: string | null;
   initialNodeId?: string;
   label?: string;
   data?: TNodeData;
-  x?: number;
-  y?: number;
-  width?: number;
-  height?: number;
+  ports?: PortConfig<TPortData>[];
   shape?: string;
   color?: string;
-  style?: Record<string, string | number>;
 }
-interface EdgeConfig<TEdgeData = any> {
+interface EdgeConfig<TEdgeData = any> extends GraphEntityConfig {
   /**
    * The id of the edge.
    */
@@ -52,40 +80,35 @@ interface EdgeConfig<TEdgeData = any> {
    * When `getWeight` is not provided, algorithms default to `edge.weight ?? 1`.
    */
   weight?: number;
+  /** Port name on the source node this edge connects from. */
+  sourcePort?: string;
+  /** Port name on the target node this edge connects to. */
+  targetPort?: string;
   data?: TEdgeData;
-  x?: number;
-  y?: number;
-  width?: number;
-  height?: number;
   color?: string;
-  style?: Record<string, string | number>;
 }
-interface Graph<TNodeData = any, TEdgeData = any, TGraphData = any> {
+interface Graph<TNodeData = any, TEdgeData = any, TGraphData = any, TPortData = any> {
   id: string;
   type: 'directed' | 'undirected';
   initialNodeId?: string | null;
-  nodes: GraphNode<TNodeData>[];
+  nodes: GraphNode<TNodeData, TPortData>[];
   edges: GraphEdge<TEdgeData>[];
   data: TGraphData;
   direction?: 'up' | 'down' | 'left' | 'right';
   style?: Record<string, string | number>;
 }
-interface GraphNode<TNodeData = any> {
+interface GraphNode<TNodeData = any, TPortData = any> extends GraphEntity {
   type: 'node';
   id: string;
   parentId?: string | null;
   initialNodeId?: string | null;
   label?: string;
   data: TNodeData;
-  x?: number;
-  y?: number;
-  width?: number;
-  height?: number;
+  ports?: GraphPort<TPortData>[];
   shape?: string;
   color?: string;
-  style?: Record<string, string | number>;
 }
-interface GraphEdge<TEdgeData = any> {
+interface GraphEdge<TEdgeData = any> extends GraphEntity {
   type: 'edge';
   id: string;
   sourceId: string;
@@ -97,35 +120,35 @@ interface GraphEdge<TEdgeData = any> {
    * When `getWeight` is not provided, algorithms default to `edge.weight ?? 1`.
    */
   weight?: number;
+  /** Port name on the source node this edge connects from. */
+  sourcePort?: string;
+  /** Port name on the target node this edge connects to. */
+  targetPort?: string;
   data: TEdgeData;
-  x?: number;
-  y?: number;
-  width?: number;
-  height?: number;
   color?: string;
-  style?: Record<string, string | number>;
 }
-interface VisualNode<TNodeData = any> extends Omit<GraphNode<TNodeData>, keyof EntityRect>, EntityRect {
+interface VisualNode<TNodeData = any, TPortData = any> extends Omit<GraphNode<TNodeData, TPortData>, keyof EntityRect>, VisualGraphEntity {
   shape?: string;
+  ports?: VisualPort<TPortData>[];
 }
-interface VisualEdge<TEdgeData = any> extends Omit<GraphEdge<TEdgeData>, keyof EntityRect>, EntityRect {}
-interface VisualGraph<TNodeData = any, TEdgeData = any, TGraphData = any> extends Omit<Graph<TNodeData, TEdgeData, TGraphData>, 'nodes' | 'edges'> {
-  nodes: VisualNode<TNodeData>[];
+interface VisualEdge<TEdgeData = any> extends Omit<GraphEdge<TEdgeData>, keyof EntityRect>, VisualGraphEntity {}
+interface VisualGraph<TNodeData = any, TEdgeData = any, TGraphData = any, TPortData = any> extends Omit<Graph<TNodeData, TEdgeData, TGraphData, TPortData>, 'nodes' | 'edges'> {
+  nodes: VisualNode<TNodeData, TPortData>[];
   edges: VisualEdge<TEdgeData>[];
   direction: 'up' | 'down' | 'left' | 'right';
 }
-interface VisualGraphConfig<TNodeData = any, TEdgeData = any, TGraphData = any> extends GraphConfig<TNodeData, TEdgeData, TGraphData> {
+interface VisualGraphConfig<TNodeData = any, TEdgeData = any, TGraphData = any, TPortData = any> extends GraphConfig<TNodeData, TEdgeData, TGraphData, TPortData> {
   direction?: 'up' | 'down' | 'left' | 'right';
 }
 interface DeleteNodeOptions {
   reparent?: boolean;
 }
-interface EntitiesConfig<TNodeData = any, TEdgeData = any> {
-  nodes?: NodeConfig<TNodeData>[];
+interface EntitiesConfig<TNodeData = any, TEdgeData = any, TPortData = any> {
+  nodes?: NodeConfig<TNodeData, TPortData>[];
   edges?: EdgeConfig<TEdgeData>[];
 }
-interface EntitiesUpdate<TNodeData = any, TEdgeData = any> {
-  nodes?: (Partial<Omit<NodeConfig<TNodeData>, 'id'>> & {
+interface EntitiesUpdate<TNodeData = any, TEdgeData = any, TPortData = any> {
+  nodes?: (Partial<Omit<NodeConfig<TNodeData, TPortData>, 'id'>> & {
     id: string;
   })[];
   edges?: (Partial<Omit<EdgeConfig<TEdgeData>, 'id'>> & {
@@ -314,4 +337,4 @@ interface TransitionOptions<TState, TEvent> {
   id?: string;
 }
 //#endregion
-export { VisualNode as A, SinglePathOptions as C, VisualGraph as D, VisualEdge as E, WalkOptions as M, WeightedWalkOptions as N, VisualGraphConfig as O, PathOptions as S, TraversalOptions as T, GraphPath as _, EdgeChange as a, NodeChange as b, EntitiesUpdate as c, GraphConfig as d, GraphDiff as f, GraphPatch as g, GraphNode as h, DeleteNodeOptions as i, WalkContext as j, VisualGraphFormatConverter as k, EntityRect as l, GraphFormatConverter as m, AllPairsShortestPathsOptions as n, EdgeConfig as o, GraphEdge as p, CoverageStats as r, EntitiesConfig as s, AStarOptions as t, Graph as u, GraphStep as v, TransitionOptions as w, NodeConfig as x, MSTOptions as y };
+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, GraphFormatConverter as g, GraphEntityConfig 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.7.0",
+  "version": "0.9.0",
   "description": "A TypeScript-first graph library with plain JSON-serializable objects",
   "author": "David Khourshid <david@stately.ai>",
   "license": "MIT",
@@ -50,6 +50,7 @@
     "schemas"
   ],
   "devDependencies": {
+    "publint": "^0.3.15",
     "@changesets/changelog-github": "^0.5.2",
     "@changesets/cli": "^2.29.8",
     "@types/d3-array": "^3.2.2",
@@ -103,6 +104,8 @@
     "dev": "tsdown --watch",
     "test": "vitest",
     "typecheck": "tsc --noEmit",
+    "verify": "pnpm typecheck && pnpm test -- --run && pnpm build && pnpm validate:package",
+    "validate:package": "publint && tsx scripts/smoke-package.ts",
     "generate-schema": "tsx scripts/generate-json-schema.ts",
     "changeset": "changeset",
     "version": "changeset version",