@statelyai/layout 0.1.2 → 0.2.0

package/dist/{index-8xYkohbz.d.mts → index-BSH2bloA.d.mts}

@@ -1,6 +1,66 @@
 import { LayoutConstraints } from "@statelyai/graph/layout";
 import { EntityRect, Graph, GraphEdge, GraphNode, GraphPatch, GraphPort, Point, VisualGraph } from "@statelyai/graph";
 
+//#region src/constraints.d.ts
+type GeometryReference = {
+  nodeId: string;
+} | {
+  edgeId: string;
+  part: "label";
+};
+type ConstraintStrength = "required" | "strong" | "medium" | "weak";
+type GeometryAttribute = "x" | "y" | "centerX" | "centerY" | "right" | "bottom";
+interface ConstraintBase {
+  id: string;
+  strength?: ConstraintStrength;
+}
+interface AlignConstraint extends ConstraintBase {
+  kind: "align";
+  entities: readonly GeometryReference[];
+  axis: "x" | "y";
+  anchor?: "start" | "center" | "end";
+}
+interface DistributeConstraint extends ConstraintBase {
+  kind: "distribute";
+  entities: readonly GeometryReference[];
+  axis: "x" | "y";
+  spacing?: "gaps" | "centers";
+  gap?: number;
+}
+interface PinConstraint extends ConstraintBase {
+  kind: "pin";
+  entity: GeometryReference;
+  x?: number;
+  y?: number;
+}
+interface LinearConstraint extends ConstraintBase {
+  kind: "linear";
+  terms: readonly {
+    entity: GeometryReference;
+    attribute: GeometryAttribute;
+    coefficient: number;
+  }[];
+  relation: "eq" | "le" | "ge";
+  value: number;
+}
+interface WaypointConstraint extends ConstraintBase {
+  kind: "waypoint";
+  edgeId: string;
+  point: {
+    x: number;
+    y: number;
+  };
+}
+type LayoutConstraint = AlignConstraint | DistributeConstraint | PinConstraint | LinearConstraint | WaypointConstraint;
+/** Serializable constraint constructors; graph geometry stays in @statelyai/graph. */
+declare const c: {
+  align: (value: Omit<AlignConstraint, "kind">) => AlignConstraint;
+  distribute: (value: Omit<DistributeConstraint, "kind">) => DistributeConstraint;
+  pin: (value: Omit<PinConstraint, "kind">) => PinConstraint;
+  linear: (value: Omit<LinearConstraint, "kind">) => LinearConstraint;
+  waypoint: (value: Omit<WaypointConstraint, "kind">) => WaypointConstraint;
+};
+//#endregion
 //#region src/types.d.ts
 type AnyGraph = Graph<unknown, unknown, unknown, unknown>;
 type LayoutDirection = "up" | "down" | "left" | "right";
@@ -11,8 +71,16 @@ type LayoutScope = {
   previous: VisualGraph;
 } | {
   mode: "partial";
-  previous: VisualGraph;
-  nodeIds: readonly string[];
+  /** Missing current geometry falls back to these matching entity IDs. */
+  previous?: VisualGraph;
+  /** Position permission only. Omitted or empty selects no nodes. */
+  nodeIds?: readonly string[];
+  /** Edge selection never grants permission to move endpoints. */
+  edgeIds?: readonly string[];
+  /** Defaults to affected; automatic changes obey edgeGeometry. */
+  routing?: "selected" | "affected";
+  /** Defaults to both; dimensions remain fixed. */
+  edgeGeometry?: "routes" | "labels" | "both";
 } | {
   mode: "route-only";
   previous: VisualGraph;
@@ -24,6 +92,8 @@ interface LayoutDiagnostic {
   message: string;
   entityIds?: readonly string[];
   phase?: string;
+  constraintIds?: readonly string[];
+  geometry?: "node" | "routes" | "labels";
 }
 interface LayoutPhaseMetrics {
   id: string;
@@ -36,6 +106,8 @@ interface LayoutMetrics {
   phases: readonly LayoutPhaseMetrics[];
 }
 interface LayoutCapabilities {
+  /** Common geometry constraints; absent means unsupported. */
+  constraints?: boolean;
   full: boolean;
   incremental: boolean;
   partial: boolean;
@@ -50,6 +122,7 @@ interface LayoutAlgorithm<Options = unknown> {
 }
 interface LayoutExecutionContext {
   readonly scope: LayoutScope;
+  readonly constraints?: readonly LayoutConstraint[];
   readonly signal?: AbortSignal;
   readonly diagnostics: LayoutDiagnostic[];
   measurePhase<T>(id: string, run: () => T): T;
@@ -60,6 +133,7 @@ interface LayoutRequest<N = unknown, E = unknown, G = unknown, P = unknown, O =
   algorithm?: string | LayoutAlgorithm<O>;
   options?: O;
   scope?: LayoutScope;
+  constraints?: readonly LayoutConstraint[];
   signal?: AbortSignal;
 }
 interface LayoutResult<N = unknown, E = unknown, G = unknown, P = unknown> {
@@ -1209,4 +1283,4 @@ declare function placeNodesWithNetworkSimplex(input: LayeredPhaseInput, order: L
 declare function getLayeredLayout<N, E, G, P>(graph: Graph<N, E, G, P> | VisualGraph<N, E, G, P>, options?: LayeredLayoutOptions): VisualGraph<N, E, G, P>;
 declare const layeredAlgorithm: LayoutAlgorithm<LayeredLayoutOptions>;
 //#endregion
-export { LayeringStrategy as $, routeEdgesOrthogonally as A, LayerOrder as B, breakCyclesWithModelOrderDepthFirstSearch as C, minimizeCrossingsWithModelOrder as D, minimizeCrossingsWithMedian as E, CycleBreaker as F, LayoutPadding as G, LayeredPhaseInput as H, EdgeRouter as I, NodeSize as J, NodePlacement as K, EdgeRoutes as L, routeEdgesWithSplines as M, AcyclicOrientation as N, placeNodesInLayers as O, CrossingMinimizer as P, LayeredAdvancedOptions as Q, LayerAssigner as R, breakCyclesWithModelOrderBreadthFirstSearch as S, minimizeCrossingsWithBarycenter as T, LayeredSpacing as U, LayeredLayoutOptions as V, LayeredStrategies as W, CycleBreakingStrategy as X, CrossingMinimizationStrategy as Y, EdgeRoutingStyle as Z, breakCyclesByStronglyConnectedNodeType as _, LayoutResult as _t, placeNodesWithBrandesKoepf as a, ElkLayeredOptionName as at, breakCyclesInteractively as b, assignLayersWithNetworkSimplex as c, AnyGraph as ct, assignLayersByLongestPath as d, LayoutDiagnostic as dt, NodePlacementStrategy as et, assignLayersByLongestPathToSink as f, LayoutDirection as ft, breakCyclesByStronglyConnectedConnectivity as g, LayoutRequest as gt, breakCyclesByModelOrder as h, LayoutPhaseMetrics as ht, placeNodesWithLinearSegments as i, ElkLayeredOptionId as it, routeEdgesWithPolylines as j, placeNodesInteractively as k, assignLayersByBreadthFirstModelOrder as l, LayoutAlgorithm as lt, assignLayersWithCoffmanGraham as m, LayoutMetrics as mt, layeredAlgorithm as n, toElkLayeredOptions as nt, assignLayersWithStretchWidth as o, ElkLayeredOptionValueByName as ot, assignLayersInteractively as p, LayoutExecutionContext as pt, NodePlacer as q, placeNodesWithNetworkSimplex as r, elkLayeredEnumValues as rt, assignLayersWithMinWidth as s, elkLayeredOptionDefinitions as st, getLayeredLayout as t, fromElkLayeredOptionId as tt, assignLayersByDepthFirstModelOrder as u, LayoutCapabilities as ut, breakCyclesGreedily as v, LayoutScope as vt, minimizeCrossingsInteractively as w, breakCyclesWithDepthFirstSearch as x, breakCyclesGreedilyByModelOrder as y, LayerAssignment as z };
+export { LayeringStrategy as $, routeEdgesOrthogonally as A, LayerOrder as B, breakCyclesWithModelOrderDepthFirstSearch as C, GeometryReference as Ct, minimizeCrossingsWithModelOrder as D, WaypointConstraint as Dt, minimizeCrossingsWithMedian as E, PinConstraint as Et, CycleBreaker as F, LayoutPadding as G, LayeredPhaseInput as H, EdgeRouter as I, NodeSize as J, NodePlacement as K, EdgeRoutes as L, routeEdgesWithSplines as M, AcyclicOrientation as N, placeNodesInLayers as O, c as Ot, CrossingMinimizer as P, LayeredAdvancedOptions as Q, LayerAssigner as R, breakCyclesWithModelOrderBreadthFirstSearch as S, GeometryAttribute as St, minimizeCrossingsWithBarycenter as T, LinearConstraint as Tt, LayeredSpacing as U, LayeredLayoutOptions as V, LayeredStrategies as W, CycleBreakingStrategy as X, CrossingMinimizationStrategy as Y, EdgeRoutingStyle as Z, breakCyclesByStronglyConnectedNodeType as _, LayoutResult as _t, placeNodesWithBrandesKoepf as a, ElkLayeredOptionName as at, breakCyclesInteractively as b, ConstraintStrength as bt, assignLayersWithNetworkSimplex as c, AnyGraph as ct, assignLayersByLongestPath as d, LayoutDiagnostic as dt, NodePlacementStrategy as et, assignLayersByLongestPathToSink as f, LayoutDirection as ft, breakCyclesByStronglyConnectedConnectivity as g, LayoutRequest as gt, breakCyclesByModelOrder as h, LayoutPhaseMetrics as ht, placeNodesWithLinearSegments as i, ElkLayeredOptionId as it, routeEdgesWithPolylines as j, placeNodesInteractively as k, assignLayersByBreadthFirstModelOrder as l, LayoutAlgorithm as lt, assignLayersWithCoffmanGraham as m, LayoutMetrics as mt, layeredAlgorithm as n, toElkLayeredOptions as nt, assignLayersWithStretchWidth as o, ElkLayeredOptionValueByName as ot, assignLayersInteractively as p, LayoutExecutionContext as pt, NodePlacer as q, placeNodesWithNetworkSimplex as r, elkLayeredEnumValues as rt, assignLayersWithMinWidth as s, elkLayeredOptionDefinitions as st, getLayeredLayout as t, fromElkLayeredOptionId as tt, assignLayersByDepthFirstModelOrder as u, LayoutCapabilities as ut, breakCyclesGreedily as v, LayoutScope as vt, minimizeCrossingsInteractively as w, LayoutConstraint as wt, breakCyclesWithDepthFirstSearch as x, DistributeConstraint as xt, breakCyclesGreedilyByModelOrder as y, AlignConstraint as yt, LayerAssignment as z };