@elicdavis/node-flow 0.2.0 → 0.2.2

package/dist/index.d.mts

@@ -227,9 +227,11 @@ declare class Port {
     slots(): number;
     setHidden(hidden: boolean): void;
     /**
-     * A port asked to hide still shows while anything is connected to it.
+     * 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;
@@ -289,6 +291,7 @@ declare abstract class WidgetBase implements Widget {
     protected box(): Box;
     protected canvas(): HTMLCanvasElement | null;
     protected scale(): number;
+    protected editText(value: string, onCommit: (text: string) => void): void;
     protected onPointerDown(pointer: WidgetPointer): void;
     protected onPointerMove(pointer: WidgetPointer): void;
     protected onPointerUp(pointer: WidgetPointer): void;
@@ -643,6 +646,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;
@@ -1088,7 +1094,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>;
@@ -1136,10 +1142,17 @@ interface InPlaceEditConfig {
     value: string;
     onCommit: (text: string) => void;
 }
+interface InPlaceEdit {
+    input: HTMLInputElement;
+    /**
+     * Moves the input over where the widget was just drawn, in canvas pixels.
+     */
+    place(box: Box, scale: number): void;
+}
 /**
  * Lays a text input over a widget. Enter or clicking away keeps what was
  * typed; Escape throws it away.
  */
-declare function editInPlace(config: InPlaceEditConfig): HTMLInputElement | null;
+declare function editInPlace(config: InPlaceEditConfig): InPlaceEdit | null;
 
-export { type BevelColors, type Box, ButtonWidget, type ButtonWidgetConfig, type CameraOrientation, ColorWidget, type ColorWidgetConfig, Connection, type ConnectionRenderer, type ConnectionRendererParams, type ContextMenuConfig, type ContextMenuItemConfig, ContextMenuItemState, type CopyCallback, CursorStyle, type DanglingConnection, DefaultConnectionRenderer, DefaultTheme, type FieldLook, FlowNode, type FlowNodeConfig, type FlowNodeGraphConfiguration, type FlowNodeStyle, type FlowNodeTitleConfig, FlowNote, type FlowNoteConfig, GlobalWidgetFactory, type GraphRenderer, GraphView, ImageWidget, type ImageWidgetConfig, InBox, type InPlaceEditConfig, type InternalConnection, MessageType, Minimap, type MinimapConfig, type NodeCreatedCallback, NodeFactory, type NodeFactoryConfig, NodeFlowGraph, type NodeIntersection, type NodeMenuFilter, type NodeMessageConfig, NodeState, type NoteAddedCallback, type NoteContentChangeCallback, type NoteDragStartCallback, type NoteDragStopCallback, type NoteRemovedCallback, type NoteSubsystemConfig, type NoteWidthChangeCallback, NumberWidget, type NumberWidgetConfig, type PasteCallback, Port, type PortConfig, type PortStyle, PortType, Publisher, type PublisherConfig, RowWidget, type RowWidgetConfig, type RowWidgetFactoryConfig, SliderWidget, type SliderWidgetConfig, StringWidget, type StringWidgetConfig, TextWidget, type TextWidgetConfig, Theme, type ThemeConfig, type ThemeValues, ToggleWidget, type ToggleWidgetConfig, ValueWidget, type ValueWidgetConfig, type Vector2, type Widget, WidgetBase, type WidgetBuilder, type WidgetConfig, type WidgetConfigs, WidgetFactory, type WidgetPointer, type WidgetTypes, drawField, drawFieldBox, drawFieldText, editInPlace, formatNumber, onThemeChange, portConfigTypes, portsCompatible, renderContinuously, requestRender, setTheme, themeVersion, typeSetsCompatible, widgetFont };
+export { type BevelColors, type Box, ButtonWidget, type ButtonWidgetConfig, type CameraOrientation, ColorWidget, type ColorWidgetConfig, Connection, type ConnectionRenderer, type ConnectionRendererParams, type ContextMenuConfig, type ContextMenuItemConfig, ContextMenuItemState, type CopyCallback, CursorStyle, type DanglingConnection, DefaultConnectionRenderer, DefaultTheme, type FieldLook, FlowNode, type FlowNodeConfig, type FlowNodeGraphConfiguration, type FlowNodeStyle, type FlowNodeTitleConfig, FlowNote, type FlowNoteConfig, GlobalWidgetFactory, type GraphRenderer, GraphView, ImageWidget, type ImageWidgetConfig, InBox, type InPlaceEdit, type InPlaceEditConfig, type InternalConnection, MessageType, Minimap, type MinimapConfig, type NodeCreatedCallback, NodeFactory, type NodeFactoryConfig, NodeFlowGraph, type NodeIntersection, type NodeMenuFilter, type NodeMessageConfig, NodeState, type NoteAddedCallback, type NoteContentChangeCallback, type NoteDragStartCallback, type NoteDragStopCallback, type NoteRemovedCallback, type NoteSubsystemConfig, type NoteWidthChangeCallback, NumberWidget, type NumberWidgetConfig, type PasteCallback, Port, type PortConfig, type PortStyle, PortType, Publisher, type PublisherConfig, RowWidget, type RowWidgetConfig, type RowWidgetFactoryConfig, SliderWidget, type SliderWidgetConfig, StringWidget, type StringWidgetConfig, TextWidget, type TextWidgetConfig, Theme, type ThemeConfig, type ThemeValues, ToggleWidget, type ToggleWidgetConfig, ValueWidget, type ValueWidgetConfig, type Vector2, type Widget, WidgetBase, type WidgetBuilder, type WidgetConfig, type WidgetConfigs, WidgetFactory, type WidgetPointer, type WidgetTypes, drawField, drawFieldBox, drawFieldText, editInPlace, formatNumber, onThemeChange, portConfigTypes, portsCompatible, renderContinuously, requestRender, setTheme, themeVersion, typeSetsCompatible, widgetFont };

package/dist/index.d.ts

@@ -227,9 +227,11 @@ declare class Port {
     slots(): number;
     setHidden(hidden: boolean): void;
     /**
-     * A port asked to hide still shows while anything is connected to it.
+     * 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;
@@ -289,6 +291,7 @@ declare abstract class WidgetBase implements Widget {
     protected box(): Box;
     protected canvas(): HTMLCanvasElement | null;
     protected scale(): number;
+    protected editText(value: string, onCommit: (text: string) => void): void;
     protected onPointerDown(pointer: WidgetPointer): void;
     protected onPointerMove(pointer: WidgetPointer): void;
     protected onPointerUp(pointer: WidgetPointer): void;
@@ -643,6 +646,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;
@@ -1088,7 +1094,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>;
@@ -1136,10 +1142,17 @@ interface InPlaceEditConfig {
     value: string;
     onCommit: (text: string) => void;
 }
+interface InPlaceEdit {
+    input: HTMLInputElement;
+    /**
+     * Moves the input over where the widget was just drawn, in canvas pixels.
+     */
+    place(box: Box, scale: number): void;
+}
 /**
  * Lays a text input over a widget. Enter or clicking away keeps what was
  * typed; Escape throws it away.
  */
-declare function editInPlace(config: InPlaceEditConfig): HTMLInputElement | null;
+declare function editInPlace(config: InPlaceEditConfig): InPlaceEdit | null;
 
-export { type BevelColors, type Box, ButtonWidget, type ButtonWidgetConfig, type CameraOrientation, ColorWidget, type ColorWidgetConfig, Connection, type ConnectionRenderer, type ConnectionRendererParams, type ContextMenuConfig, type ContextMenuItemConfig, ContextMenuItemState, type CopyCallback, CursorStyle, type DanglingConnection, DefaultConnectionRenderer, DefaultTheme, type FieldLook, FlowNode, type FlowNodeConfig, type FlowNodeGraphConfiguration, type FlowNodeStyle, type FlowNodeTitleConfig, FlowNote, type FlowNoteConfig, GlobalWidgetFactory, type GraphRenderer, GraphView, ImageWidget, type ImageWidgetConfig, InBox, type InPlaceEditConfig, type InternalConnection, MessageType, Minimap, type MinimapConfig, type NodeCreatedCallback, NodeFactory, type NodeFactoryConfig, NodeFlowGraph, type NodeIntersection, type NodeMenuFilter, type NodeMessageConfig, NodeState, type NoteAddedCallback, type NoteContentChangeCallback, type NoteDragStartCallback, type NoteDragStopCallback, type NoteRemovedCallback, type NoteSubsystemConfig, type NoteWidthChangeCallback, NumberWidget, type NumberWidgetConfig, type PasteCallback, Port, type PortConfig, type PortStyle, PortType, Publisher, type PublisherConfig, RowWidget, type RowWidgetConfig, type RowWidgetFactoryConfig, SliderWidget, type SliderWidgetConfig, StringWidget, type StringWidgetConfig, TextWidget, type TextWidgetConfig, Theme, type ThemeConfig, type ThemeValues, ToggleWidget, type ToggleWidgetConfig, ValueWidget, type ValueWidgetConfig, type Vector2, type Widget, WidgetBase, type WidgetBuilder, type WidgetConfig, type WidgetConfigs, WidgetFactory, type WidgetPointer, type WidgetTypes, drawField, drawFieldBox, drawFieldText, editInPlace, formatNumber, onThemeChange, portConfigTypes, portsCompatible, renderContinuously, requestRender, setTheme, themeVersion, typeSetsCompatible, widgetFont };
+export { type BevelColors, type Box, ButtonWidget, type ButtonWidgetConfig, type CameraOrientation, ColorWidget, type ColorWidgetConfig, Connection, type ConnectionRenderer, type ConnectionRendererParams, type ContextMenuConfig, type ContextMenuItemConfig, ContextMenuItemState, type CopyCallback, CursorStyle, type DanglingConnection, DefaultConnectionRenderer, DefaultTheme, type FieldLook, FlowNode, type FlowNodeConfig, type FlowNodeGraphConfiguration, type FlowNodeStyle, type FlowNodeTitleConfig, FlowNote, type FlowNoteConfig, GlobalWidgetFactory, type GraphRenderer, GraphView, ImageWidget, type ImageWidgetConfig, InBox, type InPlaceEdit, type InPlaceEditConfig, type InternalConnection, MessageType, Minimap, type MinimapConfig, type NodeCreatedCallback, NodeFactory, type NodeFactoryConfig, NodeFlowGraph, type NodeIntersection, type NodeMenuFilter, type NodeMessageConfig, NodeState, type NoteAddedCallback, type NoteContentChangeCallback, type NoteDragStartCallback, type NoteDragStopCallback, type NoteRemovedCallback, type NoteSubsystemConfig, type NoteWidthChangeCallback, NumberWidget, type NumberWidgetConfig, type PasteCallback, Port, type PortConfig, type PortStyle, PortType, Publisher, type PublisherConfig, RowWidget, type RowWidgetConfig, type RowWidgetFactoryConfig, SliderWidget, type SliderWidgetConfig, StringWidget, type StringWidgetConfig, TextWidget, type TextWidgetConfig, Theme, type ThemeConfig, type ThemeValues, ToggleWidget, type ToggleWidgetConfig, ValueWidget, type ValueWidgetConfig, type Vector2, type Widget, WidgetBase, type WidgetBuilder, type WidgetConfig, type WidgetConfigs, WidgetFactory, type WidgetPointer, type WidgetTypes, drawField, drawFieldBox, drawFieldText, editInPlace, formatNumber, onThemeChange, portConfigTypes, portsCompatible, renderContinuously, requestRender, setTheme, themeVersion, typeSetsCompatible, widgetFont };