@elicdavis/node-flow 0.1.14 → 0.1.16

package/.mocharc.json

@@ -0,0 +1,5 @@
+{
+    "require": "ts-node/register",
+    "spec": "test/**/*.test.ts",
+    "extension": ["ts"]
+}

package/dist/index.d.mts

@@ -44,12 +44,19 @@ interface ContextMenuConfig {
     items?: Array<ContextMenuItemConfig>;
 }
 
+/** Serializable camera orientation for save/restore. */
+interface CameraOrientation {
+    position: Vector2;
+    zoom: number;
+}
 declare class Camera {
     zoom: number;
     position: Vector2;
     constructor();
     screenSpaceToGraphSpace(screenPosition: Vector2, out: Vector2): void;
     graphSpaceToScreenSpace(graphPosition: Vector2, out: Vector2): void;
+    getOrientation(): CameraOrientation;
+    setOrientation(orientation: CameraOrientation): void;
     reset(): void;
 }
 
@@ -65,6 +72,7 @@ interface ConnectionRendererParams {
     outPort: Port | null;
 }
 type ConnectionRenderer = (params: ConnectionRendererParams) => void;
+declare function DefaultConnectionRenderer(connectionSize: number, connectionColor: string | undefined, mouseOverSize: number, mouseOverColor: string | undefined): ConnectionRenderer;
 declare class Connection {
     #private;
     constructor(inNode: FlowNode | null, inNodePortIndex: number, outNode: FlowNode | null, outNodePortIndex: number, renderer: ConnectionRenderer);
@@ -163,14 +171,43 @@ interface PortConfig {
     type?: string;
     description?: string;
     array?: boolean;
+    /**
+     * Lets this port connect to a port of any type, instead of only to one
+     * declaring the same `type` string. For a port whose type is decided by
+     * whatever gets wired into it, where `type` is a placeholder shown to
+     * the user rather than a promise about the values passing through.
+     */
+    anyType?: boolean;
+    /**
+     * Every type this port takes, when it takes more than one. For a port
+     * that works on a single value or an array of them, where `type` is
+     * only the one it happens to be showing.
+     *
+     * An empty or absent list means the port takes exactly its `type`,
+     * unless `anyType` says otherwise.
+     */
+    acceptedTypes?: Array<string>;
     emptyStyle?: PortStyle;
     filledStyle?: PortStyle;
     onConnectionAdded?: ConnectionChangeCallback;
     onConnectionRemoved?: ConnectionChangeCallback;
 }
+/**
+ * Whether two ports may be connected, going by their types alone. Each port
+ * offers the set of types it takes - one entry for an ordinary port, several
+ * for a port that takes more than one, and none at all for a port that takes
+ * anything. They connect when those sets overlap.
+ */
+declare function portsCompatible(a: Port | undefined | null, b: Port | undefined | null): boolean;
 declare class Port {
     #private;
     constructor(node: FlowNode, portType: PortType, config?: PortConfig);
+    setDataType(type: string): void;
+    setAnyType(anyType: boolean): void;
+    /**
+     * Scope accepted types to singular type
+     */
+    settleOn(type: string): void;
     addConnection(connection: Connection): void;
     replaceConnection(connection: Connection, index: number): void;
     addConnectionAddedListener(callback: ConnectionChangeCallback): void;
@@ -178,6 +215,12 @@ declare class Port {
     addConnectionRemovedListener(callback: ConnectionChangeCallback): void;
     clearConnection(connection: Connection): void;
     getDataType(): string;
+    acceptsAnyType(): boolean;
+    /**
+     * Every type this port takes. Empty means it takes anything.
+     */
+    acceptedTypes(): Array<string>;
+    setAcceptedTypes(types: Array<string>): void;
     getPortType(): PortType;
     getDisplayName(): string;
     filledStyleColor(): string;
@@ -306,8 +349,14 @@ declare class FlowNode {
     addInput(config: PortConfig): Port;
     addOutput(config: PortConfig): Port;
     addWidget(widget: Widget): void;
+    insertWidget(index: number, widget: Widget): void;
     removeWidget(widget: Widget): void;
+    removeWidgetAt(index: number): Widget | undefined;
+    moveWidget(from: number, to: number): void;
+    clearWidgets(): void;
     getWidget(index: number): Widget;
+    widgets(): ReadonlyArray<Widget>;
+    indexOfWidget(widget: Widget): number;
     widgetCount(): number;
     translate(delta: Vector2): void;
     inBounds(ctx: CanvasRenderingContext2D, camera: Camera, position: Vector2): NodeIntersection;
@@ -505,6 +554,18 @@ declare class NodeFlowGraph {
      * state used by Ctrl+click and box-select styling via FlowNode.selected()).
      */
     getSelectedNodes(): Array<FlowNode>;
+    /**
+     * Returns a copy of the current camera orientation (screen-space pan + zoom).
+     */
+    getCamera(): CameraOrientation;
+    /**
+     * Restores a previously saved camera orientation.
+     */
+    setCamera(orientation: CameraOrientation): void;
+    /**
+     * Resets the camera to the default orientation (origin, zoom 1).
+     */
+    resetCamera(): void;
     /**
      * Adjusts camera position and zoom so all nodes fit in view (~10% padding).
      * Falls back to camera.reset() when there are no nodes.
@@ -828,4 +889,4 @@ declare class WidgetFactory {
 }
 declare const GlobalWidgetFactory: WidgetFactory;
 
-export { ButtonWidget, ColorWidget, type ContextMenuConfig, type ContextMenuItemConfig, ContextMenuItemState, FlowNode, type FlowNodeConfig, type FlowNodeGraphConfiguration, type FlowNodeStyle, type FlowNodeTitleConfig, FlowNote, type FlowNoteConfig, GlobalWidgetFactory, type GraphRenderer, ImageWidget, MessageType, NodeFlowGraph, type NodeIntersection, type NodeMessageConfig, NodeState, type NoteAddedCallback, type NoteContentChangeCallback, type NoteDragStartCallback, type NoteDragStopCallback, type NoteRemovedCallback, type NoteSubsystemConfig, type NoteWidthChangeCallback, NumberWidget, Publisher, type PublisherConfig, SliderWidget, StringWidget, TextWidget, Theme, ToggleWidget, type WidgetConfig };
+export { type Box, ButtonWidget, type ButtonWidgetConfig, type CameraOrientation, ColorWidget, type ColorWidgetConfig, Connection, type ConnectionRenderer, type ConnectionRendererParams, type ContextMenuConfig, type ContextMenuItemConfig, ContextMenuItemState, DefaultConnectionRenderer, FlowNode, type FlowNodeConfig, type FlowNodeGraphConfiguration, type FlowNodeStyle, type FlowNodeTitleConfig, FlowNote, type FlowNoteConfig, GlobalWidgetFactory, type GraphRenderer, ImageWidget, type ImageWidgetConfig, MessageType, type NodeCreatedCallback, NodeFactory, type NodeFactoryConfig, NodeFlowGraph, type NodeIntersection, type NodeMessageConfig, NodeState, type NoteAddedCallback, type NoteContentChangeCallback, type NoteDragStartCallback, type NoteDragStopCallback, type NoteRemovedCallback, type NoteSubsystemConfig, type NoteWidthChangeCallback, NumberWidget, type NumberWidgetConfig, Port, type PortConfig, type PortStyle, PortType, Publisher, type PublisherConfig, SliderWidget, type SliderWidgetConfig, StringWidget, type StringWidgetConfig, TextWidget, type TextWidgetConfig, Theme, type ToggleStyleConfig, ToggleWidget, type ToggleWidgetConfig, type Vector2, type Widget, type WidgetBuilder, type WidgetConfig, WidgetFactory, portsCompatible };

package/dist/index.d.ts

@@ -44,12 +44,19 @@ interface ContextMenuConfig {
     items?: Array<ContextMenuItemConfig>;
 }
 
+/** Serializable camera orientation for save/restore. */
+interface CameraOrientation {
+    position: Vector2;
+    zoom: number;
+}
 declare class Camera {
     zoom: number;
     position: Vector2;
     constructor();
     screenSpaceToGraphSpace(screenPosition: Vector2, out: Vector2): void;
     graphSpaceToScreenSpace(graphPosition: Vector2, out: Vector2): void;
+    getOrientation(): CameraOrientation;
+    setOrientation(orientation: CameraOrientation): void;
     reset(): void;
 }
 
@@ -65,6 +72,7 @@ interface ConnectionRendererParams {
     outPort: Port | null;
 }
 type ConnectionRenderer = (params: ConnectionRendererParams) => void;
+declare function DefaultConnectionRenderer(connectionSize: number, connectionColor: string | undefined, mouseOverSize: number, mouseOverColor: string | undefined): ConnectionRenderer;
 declare class Connection {
     #private;
     constructor(inNode: FlowNode | null, inNodePortIndex: number, outNode: FlowNode | null, outNodePortIndex: number, renderer: ConnectionRenderer);
@@ -163,14 +171,43 @@ interface PortConfig {
     type?: string;
     description?: string;
     array?: boolean;
+    /**
+     * Lets this port connect to a port of any type, instead of only to one
+     * declaring the same `type` string. For a port whose type is decided by
+     * whatever gets wired into it, where `type` is a placeholder shown to
+     * the user rather than a promise about the values passing through.
+     */
+    anyType?: boolean;
+    /**
+     * Every type this port takes, when it takes more than one. For a port
+     * that works on a single value or an array of them, where `type` is
+     * only the one it happens to be showing.
+     *
+     * An empty or absent list means the port takes exactly its `type`,
+     * unless `anyType` says otherwise.
+     */
+    acceptedTypes?: Array<string>;
     emptyStyle?: PortStyle;
     filledStyle?: PortStyle;
     onConnectionAdded?: ConnectionChangeCallback;
     onConnectionRemoved?: ConnectionChangeCallback;
 }
+/**
+ * Whether two ports may be connected, going by their types alone. Each port
+ * offers the set of types it takes - one entry for an ordinary port, several
+ * for a port that takes more than one, and none at all for a port that takes
+ * anything. They connect when those sets overlap.
+ */
+declare function portsCompatible(a: Port | undefined | null, b: Port | undefined | null): boolean;
 declare class Port {
     #private;
     constructor(node: FlowNode, portType: PortType, config?: PortConfig);
+    setDataType(type: string): void;
+    setAnyType(anyType: boolean): void;
+    /**
+     * Scope accepted types to singular type
+     */
+    settleOn(type: string): void;
     addConnection(connection: Connection): void;
     replaceConnection(connection: Connection, index: number): void;
     addConnectionAddedListener(callback: ConnectionChangeCallback): void;
@@ -178,6 +215,12 @@ declare class Port {
     addConnectionRemovedListener(callback: ConnectionChangeCallback): void;
     clearConnection(connection: Connection): void;
     getDataType(): string;
+    acceptsAnyType(): boolean;
+    /**
+     * Every type this port takes. Empty means it takes anything.
+     */
+    acceptedTypes(): Array<string>;
+    setAcceptedTypes(types: Array<string>): void;
     getPortType(): PortType;
     getDisplayName(): string;
     filledStyleColor(): string;
@@ -306,8 +349,14 @@ declare class FlowNode {
     addInput(config: PortConfig): Port;
     addOutput(config: PortConfig): Port;
     addWidget(widget: Widget): void;
+    insertWidget(index: number, widget: Widget): void;
     removeWidget(widget: Widget): void;
+    removeWidgetAt(index: number): Widget | undefined;
+    moveWidget(from: number, to: number): void;
+    clearWidgets(): void;
     getWidget(index: number): Widget;
+    widgets(): ReadonlyArray<Widget>;
+    indexOfWidget(widget: Widget): number;
     widgetCount(): number;
     translate(delta: Vector2): void;
     inBounds(ctx: CanvasRenderingContext2D, camera: Camera, position: Vector2): NodeIntersection;
@@ -505,6 +554,18 @@ declare class NodeFlowGraph {
      * state used by Ctrl+click and box-select styling via FlowNode.selected()).
      */
     getSelectedNodes(): Array<FlowNode>;
+    /**
+     * Returns a copy of the current camera orientation (screen-space pan + zoom).
+     */
+    getCamera(): CameraOrientation;
+    /**
+     * Restores a previously saved camera orientation.
+     */
+    setCamera(orientation: CameraOrientation): void;
+    /**
+     * Resets the camera to the default orientation (origin, zoom 1).
+     */
+    resetCamera(): void;
     /**
      * Adjusts camera position and zoom so all nodes fit in view (~10% padding).
      * Falls back to camera.reset() when there are no nodes.
@@ -828,4 +889,4 @@ declare class WidgetFactory {
 }
 declare const GlobalWidgetFactory: WidgetFactory;
 
-export { ButtonWidget, ColorWidget, type ContextMenuConfig, type ContextMenuItemConfig, ContextMenuItemState, FlowNode, type FlowNodeConfig, type FlowNodeGraphConfiguration, type FlowNodeStyle, type FlowNodeTitleConfig, FlowNote, type FlowNoteConfig, GlobalWidgetFactory, type GraphRenderer, ImageWidget, MessageType, NodeFlowGraph, type NodeIntersection, type NodeMessageConfig, NodeState, type NoteAddedCallback, type NoteContentChangeCallback, type NoteDragStartCallback, type NoteDragStopCallback, type NoteRemovedCallback, type NoteSubsystemConfig, type NoteWidthChangeCallback, NumberWidget, Publisher, type PublisherConfig, SliderWidget, StringWidget, TextWidget, Theme, ToggleWidget, type WidgetConfig };
+export { type Box, ButtonWidget, type ButtonWidgetConfig, type CameraOrientation, ColorWidget, type ColorWidgetConfig, Connection, type ConnectionRenderer, type ConnectionRendererParams, type ContextMenuConfig, type ContextMenuItemConfig, ContextMenuItemState, DefaultConnectionRenderer, FlowNode, type FlowNodeConfig, type FlowNodeGraphConfiguration, type FlowNodeStyle, type FlowNodeTitleConfig, FlowNote, type FlowNoteConfig, GlobalWidgetFactory, type GraphRenderer, ImageWidget, type ImageWidgetConfig, MessageType, type NodeCreatedCallback, NodeFactory, type NodeFactoryConfig, NodeFlowGraph, type NodeIntersection, type NodeMessageConfig, NodeState, type NoteAddedCallback, type NoteContentChangeCallback, type NoteDragStartCallback, type NoteDragStopCallback, type NoteRemovedCallback, type NoteSubsystemConfig, type NoteWidthChangeCallback, NumberWidget, type NumberWidgetConfig, Port, type PortConfig, type PortStyle, PortType, Publisher, type PublisherConfig, SliderWidget, type SliderWidgetConfig, StringWidget, type StringWidgetConfig, TextWidget, type TextWidgetConfig, Theme, type ToggleStyleConfig, ToggleWidget, type ToggleWidgetConfig, type Vector2, type Widget, type WidgetBuilder, type WidgetConfig, WidgetFactory, portsCompatible };