@3plate/graph-core 0.1.0 → 0.1.4

package/dist/index.d.cts

@@ -0,0 +1,193 @@
+type Side = 'source' | 'target';
+type MergeOrder = Side[];
+type NodeAlign = 'natural' | 'top' | 'bottom' | 'left' | 'right';
+type Orientation = 'TB' | 'BT' | 'LR' | 'RL';
+type Nav = 'first' | 'last' | 'prev' | 'next';
+type LayoutStep = 'alignChildren' | 'alignParents' | 'compact';
+
+type MarkerType = 'arrow' | 'circle' | 'diamond' | 'bar' | 'none';
+
+type APIArguments<N, E> = {
+    options?: APIOptions<N, E>;
+    nodes?: N[];
+    edges?: E[];
+    history?: Update<N, E>[];
+    root: string;
+};
+type APIOptions<N, E> = {
+    graph?: GraphOptions;
+    canvas?: CanvasOptions<N>;
+    props?: PropsOptions<N, E>;
+};
+type GraphOptions = {
+    mergeOrder?: MergeOrder;
+    nodeMargin?: number;
+    dummyNodeSize?: number;
+    nodeAlign?: NodeAlign;
+    edgeSpacing?: number;
+    turnRadius?: number;
+    orientation?: Orientation;
+    layerMargin?: number;
+    alignIterations?: number;
+    alignThreshold?: number;
+    separateTrackSets?: boolean;
+    markerSize?: number;
+    layoutSteps?: LayoutStep[] | null;
+};
+type RenderNode<N> = (node: N) => HTMLElement;
+type ColorMode = 'light' | 'dark' | 'system';
+/** Canvas background and general colors */
+type CanvasTheme = {
+    /** Canvas background color */
+    bg?: string;
+    /** Shadow color for floating elements */
+    shadow?: string;
+};
+/** Node styling properties */
+type NodeTheme = {
+    /** Node background color */
+    bg?: string;
+    /** Node border color */
+    border?: string;
+    /** Node border color on hover */
+    borderHover?: string;
+    /** Node border color when selected */
+    borderSelected?: string;
+    /** Node text color */
+    text?: string;
+    /** Node secondary text color */
+    textMuted?: string;
+};
+/** Port styling properties */
+type PortTheme = {
+    /** Port background color */
+    bg?: string;
+    /** Port background color on hover */
+    bgHover?: string;
+};
+/** Edge styling properties */
+type EdgeTheme = {
+    /** Edge stroke color */
+    color?: string;
+};
+/** Combined theme with all customizable properties */
+type ThemeVars = CanvasTheme & NodeTheme & PortTheme & EdgeTheme;
+type CanvasOptions<N> = {
+    width?: number | string;
+    height?: number | string;
+    /** Padding inside the canvas viewport (default: 20) */
+    padding?: number;
+    classPrefix?: string;
+    markerSize?: number;
+    editable?: boolean;
+    panZoom?: boolean;
+    renderNode?: RenderNode<N>;
+    colorMode?: ColorMode;
+    theme?: ThemeVars;
+    nodeTypes?: Record<string, ThemeVars>;
+    edgeTypes?: Record<string, ThemeVars>;
+};
+type PropsOptions<N, E> = {
+    node?: GetNodeProps<N>;
+    edge?: GetEdgeProps<N, E>;
+};
+type Update<N, E> = {
+    addNodes?: N[];
+    removeNodes?: N[];
+    updateNodes?: N[];
+    addEdges?: E[];
+    removeEdges?: E[];
+    updateEdges?: E[];
+    description?: string;
+};
+type NodeProps<N> = {
+    id?: string;
+    title?: string;
+    text?: string;
+    type?: string;
+    ports?: {
+        in?: (string | PortProps)[];
+        out?: (string | PortProps)[];
+    };
+    render?: RenderNode<N>;
+};
+type EdgeEnd<N> = string | N | {
+    id: string;
+    port?: string;
+    marker?: MarkerType;
+} | {
+    node: N;
+    port?: string;
+    marker?: MarkerType;
+};
+type EdgeProps<N> = {
+    id?: string;
+    label?: string;
+    source: EdgeEnd<N>;
+    target: EdgeEnd<N>;
+    type?: string;
+};
+type PortProps = {
+    id: string;
+    label?: string;
+};
+type GetNodeProps<N> = (node: N) => NodeProps<N>;
+type GetEdgeProps<N, E> = (edge: E) => EdgeProps<N>;
+
+declare class Updater<N, E> {
+    update: Update<N, E>;
+    constructor();
+    describe(desc: string): Updater<N, E>;
+    addNode(node: any): Updater<N, E>;
+    deleteNode(node: any): Updater<N, E>;
+    updateNode(node: any): Updater<N, E>;
+    addEdge(edge: any): Updater<N, E>;
+    deleteEdge(edge: any): Updater<N, E>;
+    updateEdge(edge: any): Updater<N, E>;
+    static add<N, E>(nodes: N[], edges: E[]): Updater<N, E>;
+}
+
+declare class API<N, E> {
+    private state;
+    private seq;
+    private index;
+    private canvas;
+    private options;
+    private history;
+    private nodeIds;
+    private edgeIds;
+    private nodeVersions;
+    private nextNodeId;
+    private nextEdgeId;
+    private root;
+    constructor(args: APIArguments<N, E>);
+    init(): Promise<void>;
+    nav(nav: Nav): void;
+    private applyDiff;
+    addNode(node: any): Promise<void>;
+    deleteNode(node: any): Promise<void>;
+    updateNode(node: any): Promise<void>;
+    addEdge(edge: any): Promise<void>;
+    deleteEdge(edge: any): Promise<void>;
+    applyUpdate(update: Update<N, E>): Promise<void>;
+    private setNodePositions;
+    update(callback: (updater: Updater<N, E>) => void): Promise<void>;
+    private measureNodes;
+    private parseNode;
+    private parseEdge;
+    private parseEdgeEnd;
+    private parseStringEdge;
+    private parsePorts;
+    private getNodeId;
+    private getEdgeId;
+    private _addNode;
+    private _removeNode;
+    private _updateNode;
+    private _addEdge;
+    private _removeEdge;
+    private _updateEdge;
+}
+
+declare function graph<N, E>(args?: APIArguments<N, E>): Promise<API<N, E>>;
+
+export { graph as default, graph };

package/dist/index.d.ts

@@ -1,51 +1,193 @@
-interface EdgeProps {
-    sourceId: string;
-    targetId: string;
+type Side = 'source' | 'target';
+type MergeOrder = Side[];
+type NodeAlign = 'natural' | 'top' | 'bottom' | 'left' | 'right';
+type Orientation = 'TB' | 'BT' | 'LR' | 'RL';
+type Nav = 'first' | 'last' | 'prev' | 'next';
+type LayoutStep = 'alignChildren' | 'alignParents' | 'compact';
+
+type MarkerType = 'arrow' | 'circle' | 'diamond' | 'bar' | 'none';
+
+type APIArguments<N, E> = {
+    options?: APIOptions<N, E>;
+    nodes?: N[];
+    edges?: E[];
+    history?: Update<N, E>[];
+    root: string;
+};
+type APIOptions<N, E> = {
+    graph?: GraphOptions;
+    canvas?: CanvasOptions<N>;
+    props?: PropsOptions<N, E>;
+};
+type GraphOptions = {
+    mergeOrder?: MergeOrder;
+    nodeMargin?: number;
+    dummyNodeSize?: number;
+    nodeAlign?: NodeAlign;
+    edgeSpacing?: number;
+    turnRadius?: number;
+    orientation?: Orientation;
+    layerMargin?: number;
+    alignIterations?: number;
+    alignThreshold?: number;
+    separateTrackSets?: boolean;
+    markerSize?: number;
+    layoutSteps?: LayoutStep[] | null;
+};
+type RenderNode<N> = (node: N) => HTMLElement;
+type ColorMode = 'light' | 'dark' | 'system';
+/** Canvas background and general colors */
+type CanvasTheme = {
+    /** Canvas background color */
+    bg?: string;
+    /** Shadow color for floating elements */
+    shadow?: string;
+};
+/** Node styling properties */
+type NodeTheme = {
+    /** Node background color */
+    bg?: string;
+    /** Node border color */
+    border?: string;
+    /** Node border color on hover */
+    borderHover?: string;
+    /** Node border color when selected */
+    borderSelected?: string;
+    /** Node text color */
+    text?: string;
+    /** Node secondary text color */
+    textMuted?: string;
+};
+/** Port styling properties */
+type PortTheme = {
+    /** Port background color */
+    bg?: string;
+    /** Port background color on hover */
+    bgHover?: string;
+};
+/** Edge styling properties */
+type EdgeTheme = {
+    /** Edge stroke color */
+    color?: string;
+};
+/** Combined theme with all customizable properties */
+type ThemeVars = CanvasTheme & NodeTheme & PortTheme & EdgeTheme;
+type CanvasOptions<N> = {
+    width?: number | string;
+    height?: number | string;
+    /** Padding inside the canvas viewport (default: 20) */
+    padding?: number;
+    classPrefix?: string;
+    markerSize?: number;
+    editable?: boolean;
+    panZoom?: boolean;
+    renderNode?: RenderNode<N>;
+    colorMode?: ColorMode;
+    theme?: ThemeVars;
+    nodeTypes?: Record<string, ThemeVars>;
+    edgeTypes?: Record<string, ThemeVars>;
+};
+type PropsOptions<N, E> = {
+    node?: GetNodeProps<N>;
+    edge?: GetEdgeProps<N, E>;
+};
+type Update<N, E> = {
+    addNodes?: N[];
+    removeNodes?: N[];
+    updateNodes?: N[];
+    addEdges?: E[];
+    removeEdges?: E[];
+    updateEdges?: E[];
+    description?: string;
+};
+type NodeProps<N> = {
+    id?: string;
+    title?: string;
+    text?: string;
+    type?: string;
+    ports?: {
+        in?: (string | PortProps)[];
+        out?: (string | PortProps)[];
+    };
+    render?: RenderNode<N>;
+};
+type EdgeEnd<N> = string | N | {
+    id: string;
+    port?: string;
+    marker?: MarkerType;
+} | {
+    node: N;
+    port?: string;
+    marker?: MarkerType;
+};
+type EdgeProps<N> = {
+    id?: string;
     label?: string;
-    sourcePort?: string;
-    targetPort?: string;
-}
-type EdgeExtractor<E> = (edge: E) => EdgeProps;
-declare class GraphEdge<N, E> {
+    source: EdgeEnd<N>;
+    target: EdgeEnd<N>;
+    type?: string;
+};
+type PortProps = {
     id: string;
-    props: EdgeProps;
-    data: E;
-    source: GraphNode<N, E>;
-    target: GraphNode<N, E>;
-    constructor(props: EdgeProps, data: E, source: GraphNode<N, E>, target: GraphNode<N, E>);
-}
+    label?: string;
+};
+type GetNodeProps<N> = (node: N) => NodeProps<N>;
+type GetEdgeProps<N, E> = (edge: E) => EdgeProps<N>;
 
-interface NodeProps {
-    id: string;
-    inPorts?: string[];
-    outPorts?: string[];
-}
-type NodeExtractor<N> = (node: N) => NodeProps;
-declare class GraphNode<N, E> {
-    props: NodeProps;
-    data: N;
-    pred: Map<GraphEdge<N, E>, GraphNode<N, E> | null> | undefined;
-    succ: Map<GraphEdge<N, E>, GraphNode<N, E> | null> | undefined;
-    prior: GraphNode<N, E> | undefined;
-    constructor(props: NodeProps, data: N);
+declare class Updater<N, E> {
+    update: Update<N, E>;
+    constructor();
+    describe(desc: string): Updater<N, E>;
+    addNode(node: any): Updater<N, E>;
+    deleteNode(node: any): Updater<N, E>;
+    updateNode(node: any): Updater<N, E>;
+    addEdge(edge: any): Updater<N, E>;
+    deleteEdge(edge: any): Updater<N, E>;
+    updateEdge(edge: any): Updater<N, E>;
+    static add<N, E>(nodes: N[], edges: E[]): Updater<N, E>;
 }
 
-declare class Graph<N, E> {
-    nodeMap: Map<string, GraphNode<N, E> | null> | undefined;
-    edgeMap: Map<string, GraphEdge<N, E> | null> | undefined;
-    prior: Graph<N, E> | undefined;
-    complete: boolean;
-    numNodes: number;
-    numEdges: number;
-    constructor();
-    isEmpty(): boolean;
-    _walk<T>(mapFn: (graph: Graph<N, E>) => Map<string, T | null> | undefined): IterableIterator<T>;
-    nodes(): IterableIterator<GraphNode<N, E>>;
-    edges(): IterableIterator<GraphEdge<N, E>>;
-    getNode(id: string): GraphNode<N, E> | undefined;
-    getEdge(id: string): GraphEdge<N, E> | undefined;
-    hasNode(id: string): boolean;
-    hasEdge(id: string): boolean;
+declare class API<N, E> {
+    private state;
+    private seq;
+    private index;
+    private canvas;
+    private options;
+    private history;
+    private nodeIds;
+    private edgeIds;
+    private nodeVersions;
+    private nextNodeId;
+    private nextEdgeId;
+    private root;
+    constructor(args: APIArguments<N, E>);
+    init(): Promise<void>;
+    nav(nav: Nav): void;
+    private applyDiff;
+    addNode(node: any): Promise<void>;
+    deleteNode(node: any): Promise<void>;
+    updateNode(node: any): Promise<void>;
+    addEdge(edge: any): Promise<void>;
+    deleteEdge(edge: any): Promise<void>;
+    applyUpdate(update: Update<N, E>): Promise<void>;
+    private setNodePositions;
+    update(callback: (updater: Updater<N, E>) => void): Promise<void>;
+    private measureNodes;
+    private parseNode;
+    private parseEdge;
+    private parseEdgeEnd;
+    private parseStringEdge;
+    private parsePorts;
+    private getNodeId;
+    private getEdgeId;
+    private _addNode;
+    private _removeNode;
+    private _updateNode;
+    private _addEdge;
+    private _removeEdge;
+    private _updateEdge;
 }
 
-export { type EdgeExtractor, type EdgeProps, Graph, GraphEdge, GraphNode, type NodeExtractor, type NodeProps };
+declare function graph<N, E>(args?: APIArguments<N, E>): Promise<API<N, E>>;
+
+export { graph as default, graph };