@3plate/graph-core 0.1.0 → 0.1.2

package/dist/index.d.cts

@@ -0,0 +1,133 @@
+type Side = 'source' | 'target';
+type MergeOrder = Side[];
+type NodeAlign = 'natural' | 'top' | 'bottom' | 'left' | 'right';
+type Orientation = 'TB' | 'BT' | 'LR' | 'RL';
+
+type LayoutStep = 'alignChildren' | 'alignParents' | 'compact';
+
+type GraphOptions = {
+    mergeOrder?: MergeOrder;
+    nodeMargin?: number;
+    dummyNodeSize?: number;
+    defaultPortOffset?: number;
+    nodeAlign?: NodeAlign;
+    edgeSpacing?: number;
+    turnRadius?: number;
+    orientation?: Orientation;
+    layerMargin?: number;
+    alignIterations?: number;
+    alignThreshold?: number;
+    separateTrackSets?: boolean;
+    layoutSteps?: LayoutStep[] | null;
+};
+
+type EdgeAttributes = {
+    width?: number;
+    style?: string;
+    color?: string;
+    turnRadius?: number;
+    sourceTerminal?: string | null;
+    targetTerminal?: string | null;
+};
+type NodeAttributes = {
+    strokeWidth?: number;
+    strokeStyle?: string;
+};
+type RenderNode<N> = (node: N) => HTMLElement;
+type EdgeStyle = (type: string) => EdgeAttributes;
+type NodeStyle<N> = (node: N) => NodeAttributes;
+type PortStyle = 'inside' | 'outside' | 'custom';
+type CanvasOptions<N> = {
+    renderNode?: RenderNode<N>;
+    nodeStyle?: NodeStyle<N>;
+    edgeStyle?: EdgeStyle;
+    width?: number | string;
+    height?: number | string;
+    portStyle?: PortStyle;
+    classPrefix?: string;
+};
+
+type StructuredNode<P> = {
+    id: string;
+    title?: string;
+    text?: string;
+    ports?: {
+        in?: P[];
+        out?: P[];
+    };
+};
+type StructuredEdge = {
+    source: {
+        id: string;
+        port?: string;
+    };
+    target: {
+        id: string;
+        port?: string;
+    };
+    type?: string;
+};
+type StructuredPort = {
+    id: string;
+    label: string;
+};
+type Nav = 'first' | 'last' | 'prev' | 'next';
+type NodeProps<N, P> = (node: N) => StructuredNode<P>;
+type EdgeProps<E> = (edge: E) => StructuredEdge;
+type PortProps<P> = (port: P) => StructuredPort;
+type APIOptions<N, E, P> = GraphOptions & CanvasOptions<N> & {
+    nodeProps?: NodeProps<N, P>;
+    edgeProps?: EdgeProps<E>;
+    portProps?: PortProps<P>;
+};
+type APIArguments<N, E, P> = APIOptions<N, E, P> & {
+    nodes?: N[];
+    edges?: E[];
+};
+declare class API<N, E, P> {
+    private state;
+    private seq;
+    private index;
+    private canvas;
+    private _options;
+    options: Required<APIOptions<N, E, P>>;
+    constructor(options: APIOptions<N, E, P>);
+    render(): HTMLElement;
+    nav(nav: Nav): void;
+    private applyDiff;
+    addNode(node: N): Promise<void>;
+    deleteNode(node: N): Promise<void>;
+    updateNode(node: N): Promise<void>;
+    addEdge(edge: E): Promise<void>;
+    deleteEdge(edge: E): Promise<void>;
+    update(callback: (update: Update<N, E>) => void): Promise<void>;
+    private measureNodes;
+    private getDims;
+    private _updateNode;
+    private _updateEdge;
+    private _addNode;
+    private _removeNode;
+    private _addEdge;
+    private _removeEdge;
+    private _onOptionChange;
+}
+declare class Update<N, E> {
+    addedNodes: N[];
+    removedNodes: N[];
+    updatedNodes: N[];
+    addedEdges: E[];
+    removedEdges: E[];
+    updatedEdges: E[];
+    desc?: string;
+    constructor();
+    describe(desc: string): void;
+    addNode(node: N): void;
+    deleteNode(node: N): void;
+    updateNode(node: N): void;
+    addEdge(edge: E): void;
+    deleteEdge(edge: E): void;
+    updateEdge(edge: E): void;
+}
+declare function graph<N, E, P>(args?: APIArguments<N, E, P>): Promise<API<N, E, P>>;
+
+export { graph as default, graph };

package/dist/index.d.ts

@@ -1,51 +1,133 @@
-interface EdgeProps {
-    sourceId: string;
-    targetId: string;
-    label?: string;
-    sourcePort?: string;
-    targetPort?: string;
-}
-type EdgeExtractor<E> = (edge: E) => EdgeProps;
-declare class GraphEdge<N, E> {
-    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>);
-}
+type Side = 'source' | 'target';
+type MergeOrder = Side[];
+type NodeAlign = 'natural' | 'top' | 'bottom' | 'left' | 'right';
+type Orientation = 'TB' | 'BT' | 'LR' | 'RL';
+
+type LayoutStep = 'alignChildren' | 'alignParents' | 'compact';
+
+type GraphOptions = {
+    mergeOrder?: MergeOrder;
+    nodeMargin?: number;
+    dummyNodeSize?: number;
+    defaultPortOffset?: number;
+    nodeAlign?: NodeAlign;
+    edgeSpacing?: number;
+    turnRadius?: number;
+    orientation?: Orientation;
+    layerMargin?: number;
+    alignIterations?: number;
+    alignThreshold?: number;
+    separateTrackSets?: boolean;
+    layoutSteps?: LayoutStep[] | null;
+};
 
-interface NodeProps {
+type EdgeAttributes = {
+    width?: number;
+    style?: string;
+    color?: string;
+    turnRadius?: number;
+    sourceTerminal?: string | null;
+    targetTerminal?: string | null;
+};
+type NodeAttributes = {
+    strokeWidth?: number;
+    strokeStyle?: string;
+};
+type RenderNode<N> = (node: N) => HTMLElement;
+type EdgeStyle = (type: string) => EdgeAttributes;
+type NodeStyle<N> = (node: N) => NodeAttributes;
+type PortStyle = 'inside' | 'outside' | 'custom';
+type CanvasOptions<N> = {
+    renderNode?: RenderNode<N>;
+    nodeStyle?: NodeStyle<N>;
+    edgeStyle?: EdgeStyle;
+    width?: number | string;
+    height?: number | string;
+    portStyle?: PortStyle;
+    classPrefix?: string;
+};
+
+type StructuredNode<P> = {
     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);
+    title?: string;
+    text?: string;
+    ports?: {
+        in?: P[];
+        out?: P[];
+    };
+};
+type StructuredEdge = {
+    source: {
+        id: string;
+        port?: string;
+    };
+    target: {
+        id: string;
+        port?: string;
+    };
+    type?: string;
+};
+type StructuredPort = {
+    id: string;
+    label: string;
+};
+type Nav = 'first' | 'last' | 'prev' | 'next';
+type NodeProps<N, P> = (node: N) => StructuredNode<P>;
+type EdgeProps<E> = (edge: E) => StructuredEdge;
+type PortProps<P> = (port: P) => StructuredPort;
+type APIOptions<N, E, P> = GraphOptions & CanvasOptions<N> & {
+    nodeProps?: NodeProps<N, P>;
+    edgeProps?: EdgeProps<E>;
+    portProps?: PortProps<P>;
+};
+type APIArguments<N, E, P> = APIOptions<N, E, P> & {
+    nodes?: N[];
+    edges?: E[];
+};
+declare class API<N, E, P> {
+    private state;
+    private seq;
+    private index;
+    private canvas;
+    private _options;
+    options: Required<APIOptions<N, E, P>>;
+    constructor(options: APIOptions<N, E, P>);
+    render(): HTMLElement;
+    nav(nav: Nav): void;
+    private applyDiff;
+    addNode(node: N): Promise<void>;
+    deleteNode(node: N): Promise<void>;
+    updateNode(node: N): Promise<void>;
+    addEdge(edge: E): Promise<void>;
+    deleteEdge(edge: E): Promise<void>;
+    update(callback: (update: Update<N, E>) => void): Promise<void>;
+    private measureNodes;
+    private getDims;
+    private _updateNode;
+    private _updateEdge;
+    private _addNode;
+    private _removeNode;
+    private _addEdge;
+    private _removeEdge;
+    private _onOptionChange;
 }
-
-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;
+declare class Update<N, E> {
+    addedNodes: N[];
+    removedNodes: N[];
+    updatedNodes: N[];
+    addedEdges: E[];
+    removedEdges: E[];
+    updatedEdges: E[];
+    desc?: string;
     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;
+    describe(desc: string): void;
+    addNode(node: N): void;
+    deleteNode(node: N): void;
+    updateNode(node: N): void;
+    addEdge(edge: E): void;
+    deleteEdge(edge: E): void;
+    updateEdge(edge: E): void;
 }
+declare function graph<N, E, P>(args?: APIArguments<N, E, P>): Promise<API<N, E, P>>;
 
-export { type EdgeExtractor, type EdgeProps, Graph, GraphEdge, GraphNode, type NodeExtractor, type NodeProps };
+export { graph as default, graph };