@elicdavis/node-flow 0.2.1 → 0.2.3

package/dist/index.d.mts

@@ -156,95 +156,6 @@ interface Box {
 }
 declare function InBox(box: Box, position: Vector2): boolean;
 
-declare enum PortType {
-    Input = "INPUT",
-    Output = "OUTPUT",
-    InputArray = "INPUTARRAY"
-}
-interface PortStyle {
-    size?: number;
-    fillColor?: string;
-    borderColor?: string;
-    borderSize?: number;
-}
-type ConnectionChangeCallback = (connection: Connection, connectionIndex: number, port: Port, portType: PortType, node: FlowNode) => void;
-interface PortConfig {
-    name?: string;
-    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>;
-    /**
-     * Leaves the port off the node until something is connected to it.
-     */
-    hidden?: boolean;
-    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 function typeSetsCompatible(a: Array<string>, b: Array<string>): boolean;
-declare function portConfigTypes(config: PortConfig): Array<string>;
-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, index?: number): void;
-    replaceConnection(connection: Connection, index: number): void;
-    addConnectionAddedListener(callback: ConnectionChangeCallback): void;
-    connections(): Array<Connection>;
-    /**
-     * How many wires the port has room for: one per connection on an array
-     * input, so each can be told apart and picked up on its own.
-     */
-    slots(): number;
-    setHidden(hidden: boolean): void;
-    /**
-     * A port asked to hide still shows while anything is connected to it.
-     */
-    hidden(): boolean;
-    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;
-    render(ctx: CanvasRenderingContext2D, position: Vector2, camera: Camera, mousePosition: Vector2 | undefined, postProcess: PassSubsystem): Box;
-}
-
 /**
  * Where the pointer is, in canvas pixels, and whether it is over the widget.
  * A press that starts on a widget keeps reporting to it until it is let go,
@@ -299,17 +210,6 @@ declare abstract class WidgetBase implements Widget {
     protected onClick(pointer: WidgetPointer): void;
 }
 
-interface StrokeStyleConfig {
-    size?: number;
-    color?: string;
-}
-
-interface BoxStyleConfig {
-    border?: StrokeStyleConfig;
-    color?: string;
-    radius?: number;
-}
-
 interface ValueWidgetConfig<T> {
     /**
      * A node property the widget shows and edits. Setting the property from
@@ -533,6 +433,119 @@ declare class WidgetFactory {
 }
 declare const GlobalWidgetFactory: WidgetFactory;
 
+declare enum PortType {
+    Input = "INPUT",
+    Output = "OUTPUT",
+    InputArray = "INPUTARRAY"
+}
+interface PortStyle {
+    size?: number;
+    fillColor?: string;
+    borderColor?: string;
+    borderSize?: number;
+}
+type ConnectionChangeCallback = (connection: Connection, connectionIndex: number, port: Port, portType: PortType, node: FlowNode) => void;
+interface PortConfig {
+    name?: string;
+    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>;
+    /**
+     * Leaves the port off the node until something is connected to it.
+     */
+    hidden?: boolean;
+    /**
+     * A widget drawn on the port's own row while nothing is connected to
+     * it, for a value the port holds on its own. Input ports only.
+     */
+    widget?: WidgetConfig;
+    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 function typeSetsCompatible(a: Array<string>, b: Array<string>): boolean;
+declare function portConfigTypes(config: PortConfig): Array<string>;
+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, index?: number): void;
+    replaceConnection(connection: Connection, index: number): void;
+    addConnectionAddedListener(callback: ConnectionChangeCallback): void;
+    connections(): Array<Connection>;
+    /**
+     * How many wires the port has room for: one per connection on an array
+     * input, so each can be told apart and picked up on its own.
+     */
+    slots(): number;
+    setHidden(hidden: boolean): void;
+    setWidget(widget: Widget | null): void;
+    widget(): Widget | null;
+    /**
+     * The widget stands in for a wire, so it leaves once one is connected.
+     */
+    widgetShown(): boolean;
+    /**
+     * A port asked to hide still shows while anything is connected to it,
+     * and while its node is showing its hidden ports.
+     */
+    hidden(): boolean;
+    tucked(): boolean;
+    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;
+    render(ctx: CanvasRenderingContext2D, position: Vector2, camera: Camera, mousePosition: Vector2 | undefined, postProcess: PassSubsystem): Box;
+}
+
+interface StrokeStyleConfig {
+    size?: number;
+    color?: string;
+}
+
+interface BoxStyleConfig {
+    border?: StrokeStyleConfig;
+    color?: string;
+    radius?: number;
+}
+
 interface Metadata {
     [name: string]: any;
 }
@@ -644,6 +657,9 @@ declare class FlowNode {
     calculateBounds(ctx: CanvasRenderingContext2D, camera: Camera): Box;
     addInput(config: PortConfig): Port;
     addOutput(config: PortConfig): Port;
+    hiddenPortsShown(): boolean;
+    setHiddenPortsShown(shown: boolean): void;
+    hiddenPortCount(): number;
     addWidget(widget: Widget): void;
     insertWidget(index: number, widget: Widget): void;
     removeWidget(widget: Widget): void;
@@ -1089,7 +1105,7 @@ declare const defaults: {
 };
 type ThemeValues = typeof defaults;
 type DeepPartial<T> = {
-    [K in keyof T]?: T[K] extends object | null ? (null extends T[K] ? T[K] : DeepPartial<T[K]>) : T[K];
+    [K in keyof T]?: T[K] extends BevelColors | null ? T[K] : T[K] extends object ? DeepPartial<T[K]> : T[K];
 };
 type ThemeConfig = DeepPartial<ThemeValues>;
 declare const DefaultTheme: Readonly<ThemeValues>;

package/dist/index.d.ts

@@ -156,95 +156,6 @@ interface Box {
 }
 declare function InBox(box: Box, position: Vector2): boolean;
 
-declare enum PortType {
-    Input = "INPUT",
-    Output = "OUTPUT",
-    InputArray = "INPUTARRAY"
-}
-interface PortStyle {
-    size?: number;
-    fillColor?: string;
-    borderColor?: string;
-    borderSize?: number;
-}
-type ConnectionChangeCallback = (connection: Connection, connectionIndex: number, port: Port, portType: PortType, node: FlowNode) => void;
-interface PortConfig {
-    name?: string;
-    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>;
-    /**
-     * Leaves the port off the node until something is connected to it.
-     */
-    hidden?: boolean;
-    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 function typeSetsCompatible(a: Array<string>, b: Array<string>): boolean;
-declare function portConfigTypes(config: PortConfig): Array<string>;
-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, index?: number): void;
-    replaceConnection(connection: Connection, index: number): void;
-    addConnectionAddedListener(callback: ConnectionChangeCallback): void;
-    connections(): Array<Connection>;
-    /**
-     * How many wires the port has room for: one per connection on an array
-     * input, so each can be told apart and picked up on its own.
-     */
-    slots(): number;
-    setHidden(hidden: boolean): void;
-    /**
-     * A port asked to hide still shows while anything is connected to it.
-     */
-    hidden(): boolean;
-    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;
-    render(ctx: CanvasRenderingContext2D, position: Vector2, camera: Camera, mousePosition: Vector2 | undefined, postProcess: PassSubsystem): Box;
-}
-
 /**
  * Where the pointer is, in canvas pixels, and whether it is over the widget.
  * A press that starts on a widget keeps reporting to it until it is let go,
@@ -299,17 +210,6 @@ declare abstract class WidgetBase implements Widget {
     protected onClick(pointer: WidgetPointer): void;
 }
 
-interface StrokeStyleConfig {
-    size?: number;
-    color?: string;
-}
-
-interface BoxStyleConfig {
-    border?: StrokeStyleConfig;
-    color?: string;
-    radius?: number;
-}
-
 interface ValueWidgetConfig<T> {
     /**
      * A node property the widget shows and edits. Setting the property from
@@ -533,6 +433,119 @@ declare class WidgetFactory {
 }
 declare const GlobalWidgetFactory: WidgetFactory;
 
+declare enum PortType {
+    Input = "INPUT",
+    Output = "OUTPUT",
+    InputArray = "INPUTARRAY"
+}
+interface PortStyle {
+    size?: number;
+    fillColor?: string;
+    borderColor?: string;
+    borderSize?: number;
+}
+type ConnectionChangeCallback = (connection: Connection, connectionIndex: number, port: Port, portType: PortType, node: FlowNode) => void;
+interface PortConfig {
+    name?: string;
+    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>;
+    /**
+     * Leaves the port off the node until something is connected to it.
+     */
+    hidden?: boolean;
+    /**
+     * A widget drawn on the port's own row while nothing is connected to
+     * it, for a value the port holds on its own. Input ports only.
+     */
+    widget?: WidgetConfig;
+    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 function typeSetsCompatible(a: Array<string>, b: Array<string>): boolean;
+declare function portConfigTypes(config: PortConfig): Array<string>;
+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, index?: number): void;
+    replaceConnection(connection: Connection, index: number): void;
+    addConnectionAddedListener(callback: ConnectionChangeCallback): void;
+    connections(): Array<Connection>;
+    /**
+     * How many wires the port has room for: one per connection on an array
+     * input, so each can be told apart and picked up on its own.
+     */
+    slots(): number;
+    setHidden(hidden: boolean): void;
+    setWidget(widget: Widget | null): void;
+    widget(): Widget | null;
+    /**
+     * The widget stands in for a wire, so it leaves once one is connected.
+     */
+    widgetShown(): boolean;
+    /**
+     * A port asked to hide still shows while anything is connected to it,
+     * and while its node is showing its hidden ports.
+     */
+    hidden(): boolean;
+    tucked(): boolean;
+    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;
+    render(ctx: CanvasRenderingContext2D, position: Vector2, camera: Camera, mousePosition: Vector2 | undefined, postProcess: PassSubsystem): Box;
+}
+
+interface StrokeStyleConfig {
+    size?: number;
+    color?: string;
+}
+
+interface BoxStyleConfig {
+    border?: StrokeStyleConfig;
+    color?: string;
+    radius?: number;
+}
+
 interface Metadata {
     [name: string]: any;
 }
@@ -644,6 +657,9 @@ declare class FlowNode {
     calculateBounds(ctx: CanvasRenderingContext2D, camera: Camera): Box;
     addInput(config: PortConfig): Port;
     addOutput(config: PortConfig): Port;
+    hiddenPortsShown(): boolean;
+    setHiddenPortsShown(shown: boolean): void;
+    hiddenPortCount(): number;
     addWidget(widget: Widget): void;
     insertWidget(index: number, widget: Widget): void;
     removeWidget(widget: Widget): void;
@@ -1089,7 +1105,7 @@ declare const defaults: {
 };
 type ThemeValues = typeof defaults;
 type DeepPartial<T> = {
-    [K in keyof T]?: T[K] extends object | null ? (null extends T[K] ? T[K] : DeepPartial<T[K]>) : T[K];
+    [K in keyof T]?: T[K] extends BevelColors | null ? T[K] : T[K] extends object ? DeepPartial<T[K]> : T[K];
 };
 type ThemeConfig = DeepPartial<ThemeValues>;
 declare const DefaultTheme: Readonly<ThemeValues>;