@elicdavis/node-flow 0.2.3 → 0.2.4

package/dist/index.d.mts

@@ -488,7 +488,22 @@ interface PortConfig {
  */
 declare function portsCompatible(a: Port | undefined | null, b: Port | undefined | null): boolean;
 declare function typeSetsCompatible(a: Array<string>, b: Array<string>): boolean;
+/**
+ * Lets an output of type `from` feed an input of type `to`, and only that
+ * way round.
+ */
+interface Cast {
+    from: string;
+    to: string;
+}
+/**
+ * Whether an output may feed an input: their types overlap, or a cast takes
+ * one of the output's types to one of the input's.
+ */
+declare function portsConnect(output: Port | undefined | null, input: Port | undefined | null, casts?: Array<Cast>): boolean;
+declare function typeSetsConnect(output: Array<string>, input: Array<string>, casts?: Array<Cast>): boolean;
 declare function portConfigTypes(config: PortConfig): Array<string>;
+declare function portTypeColor(type: string): string;
 declare class Port {
     #private;
     constructor(node: FlowNode, portType: PortType, config?: PortConfig);
@@ -625,6 +640,8 @@ declare class FlowNode {
     metadata(): any;
     selected(): boolean;
     select(): void;
+    highlighted(): boolean;
+    setHighlighted(highlighted: boolean): void;
     raiseDragStoppedEvent(): void;
     addTitleChangeListener(callback: TitleChangeCallback): void;
     addInfoChangeListener(callback: InfoChangeCallback): void;
@@ -699,6 +716,7 @@ declare class FlowNode {
 
 type NodeAddedCallback = (node: FlowNode) => void;
 type NodeRemovedCallback = (node: FlowNode) => void;
+type NodeHoverCallback = (node: FlowNode | null) => void;
 /**
  * A connection between two nodes of a copied set, by their position in that
  * set rather than by node, so it can be rebuilt against the copies.
@@ -732,15 +750,19 @@ interface ConnectionRendererConfiguration {
 interface NodeSubsystemConfig {
     idleConnection?: ConnectionRendererConfiguration;
     nodes?: NodeFactoryConfig;
+    casts?: Array<Cast>;
 }
 declare class NodeSubsystem {
     #private;
     constructor(postProcessPass: PassSubsystem, config?: NodeSubsystemConfig);
+    setCasts(casts: Array<Cast>): void;
+    casts(): Array<Cast>;
     addPublisher(identifier: string, publisher: Publisher): void;
     addOnNodeCreatedListener(callback: NodeCreatedCallback): void;
     nodeFactory(): NodeFactory;
     addOnNodeAddedListener(callback: NodeAddedCallback): void;
     addOnNodeRemovedListener(callback: NodeRemovedCallback): void;
+    addNodeHoverListener(callback: NodeHoverCallback): void;
     clickStart(mousePosition: Vector2, camera: Camera, ctrlKey: boolean): boolean;
     mouseDragEvent(delta: Vector2, scale: number): boolean;
     clearNodeInputConnection(node: FlowNode, index: number): void;
@@ -786,6 +808,7 @@ interface NodeMenuFilter {
     needs: PortType;
     /** Types that side has to accept. An empty list takes anything. */
     types: Array<string>;
+    casts?: Array<Cast>;
     onCreated?: (node: FlowNode) => void;
 }
 interface PublisherNodes {
@@ -914,6 +937,7 @@ interface FlowNodeGraphConfiguration {
     idleConnection?: ConnectionRendererConfiguration;
     contextMenu?: ContextMenuConfig;
     nodes?: NodeFactoryConfig;
+    casts?: Array<Cast>;
     board?: NoteSubsystemConfig;
     minimap?: MinimapConfig;
 }
@@ -942,6 +966,7 @@ declare class NodeFlowGraph {
     currentView(): GraphView;
     organize(): void;
     addPublisher(identifier: string, publisher: Publisher): void;
+    setCasts(casts: Array<Cast>): void;
     getNodes(): Array<FlowNode>;
     /**
      * Returns currently selected nodes in stable graph order (same selection
@@ -980,6 +1005,7 @@ declare class NodeFlowGraph {
     addOnNodeCreatedListener(callback: NodeCreatedCallback): void;
     addOnNodeAddedListener(callback: NodeAddedCallback): void;
     addOnNodeRemovedListener(callback: NodeRemovedCallback): void;
+    addNodeHoverListener(callback: NodeHoverCallback): void;
     requestRender(): void;
     renderContinuously(): () => void;
     dispose(): void;
@@ -1009,6 +1035,7 @@ declare const defaults: {
             MouseOver: string;
             Grabbed: string;
             Selected: string;
+            Highlighted: string;
         };
         Bevel: BevelColors | null;
         Port: {
@@ -1095,6 +1122,7 @@ declare const defaults: {
         H3: {
             FontSize: number;
         };
+        CodeFontFamily: string | null;
         CodeBlock: {
             BackgroundColor: string;
             FontColor: string;
@@ -1166,4 +1194,4 @@ interface InPlaceEdit {
  */
 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 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 };
+export { type BevelColors, type Box, ButtonWidget, type ButtonWidgetConfig, type CameraOrientation, type Cast, 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 NodeHoverCallback, 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, portTypeColor, portsCompatible, portsConnect, renderContinuously, requestRender, setTheme, themeVersion, typeSetsCompatible, typeSetsConnect, widgetFont };

package/dist/index.d.ts

@@ -488,7 +488,22 @@ interface PortConfig {
  */
 declare function portsCompatible(a: Port | undefined | null, b: Port | undefined | null): boolean;
 declare function typeSetsCompatible(a: Array<string>, b: Array<string>): boolean;
+/**
+ * Lets an output of type `from` feed an input of type `to`, and only that
+ * way round.
+ */
+interface Cast {
+    from: string;
+    to: string;
+}
+/**
+ * Whether an output may feed an input: their types overlap, or a cast takes
+ * one of the output's types to one of the input's.
+ */
+declare function portsConnect(output: Port | undefined | null, input: Port | undefined | null, casts?: Array<Cast>): boolean;
+declare function typeSetsConnect(output: Array<string>, input: Array<string>, casts?: Array<Cast>): boolean;
 declare function portConfigTypes(config: PortConfig): Array<string>;
+declare function portTypeColor(type: string): string;
 declare class Port {
     #private;
     constructor(node: FlowNode, portType: PortType, config?: PortConfig);
@@ -625,6 +640,8 @@ declare class FlowNode {
     metadata(): any;
     selected(): boolean;
     select(): void;
+    highlighted(): boolean;
+    setHighlighted(highlighted: boolean): void;
     raiseDragStoppedEvent(): void;
     addTitleChangeListener(callback: TitleChangeCallback): void;
     addInfoChangeListener(callback: InfoChangeCallback): void;
@@ -699,6 +716,7 @@ declare class FlowNode {
 
 type NodeAddedCallback = (node: FlowNode) => void;
 type NodeRemovedCallback = (node: FlowNode) => void;
+type NodeHoverCallback = (node: FlowNode | null) => void;
 /**
  * A connection between two nodes of a copied set, by their position in that
  * set rather than by node, so it can be rebuilt against the copies.
@@ -732,15 +750,19 @@ interface ConnectionRendererConfiguration {
 interface NodeSubsystemConfig {
     idleConnection?: ConnectionRendererConfiguration;
     nodes?: NodeFactoryConfig;
+    casts?: Array<Cast>;
 }
 declare class NodeSubsystem {
     #private;
     constructor(postProcessPass: PassSubsystem, config?: NodeSubsystemConfig);
+    setCasts(casts: Array<Cast>): void;
+    casts(): Array<Cast>;
     addPublisher(identifier: string, publisher: Publisher): void;
     addOnNodeCreatedListener(callback: NodeCreatedCallback): void;
     nodeFactory(): NodeFactory;
     addOnNodeAddedListener(callback: NodeAddedCallback): void;
     addOnNodeRemovedListener(callback: NodeRemovedCallback): void;
+    addNodeHoverListener(callback: NodeHoverCallback): void;
     clickStart(mousePosition: Vector2, camera: Camera, ctrlKey: boolean): boolean;
     mouseDragEvent(delta: Vector2, scale: number): boolean;
     clearNodeInputConnection(node: FlowNode, index: number): void;
@@ -786,6 +808,7 @@ interface NodeMenuFilter {
     needs: PortType;
     /** Types that side has to accept. An empty list takes anything. */
     types: Array<string>;
+    casts?: Array<Cast>;
     onCreated?: (node: FlowNode) => void;
 }
 interface PublisherNodes {
@@ -914,6 +937,7 @@ interface FlowNodeGraphConfiguration {
     idleConnection?: ConnectionRendererConfiguration;
     contextMenu?: ContextMenuConfig;
     nodes?: NodeFactoryConfig;
+    casts?: Array<Cast>;
     board?: NoteSubsystemConfig;
     minimap?: MinimapConfig;
 }
@@ -942,6 +966,7 @@ declare class NodeFlowGraph {
     currentView(): GraphView;
     organize(): void;
     addPublisher(identifier: string, publisher: Publisher): void;
+    setCasts(casts: Array<Cast>): void;
     getNodes(): Array<FlowNode>;
     /**
      * Returns currently selected nodes in stable graph order (same selection
@@ -980,6 +1005,7 @@ declare class NodeFlowGraph {
     addOnNodeCreatedListener(callback: NodeCreatedCallback): void;
     addOnNodeAddedListener(callback: NodeAddedCallback): void;
     addOnNodeRemovedListener(callback: NodeRemovedCallback): void;
+    addNodeHoverListener(callback: NodeHoverCallback): void;
     requestRender(): void;
     renderContinuously(): () => void;
     dispose(): void;
@@ -1009,6 +1035,7 @@ declare const defaults: {
             MouseOver: string;
             Grabbed: string;
             Selected: string;
+            Highlighted: string;
         };
         Bevel: BevelColors | null;
         Port: {
@@ -1095,6 +1122,7 @@ declare const defaults: {
         H3: {
             FontSize: number;
         };
+        CodeFontFamily: string | null;
         CodeBlock: {
             BackgroundColor: string;
             FontColor: string;
@@ -1166,4 +1194,4 @@ interface InPlaceEdit {
  */
 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 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 };
+export { type BevelColors, type Box, ButtonWidget, type ButtonWidgetConfig, type CameraOrientation, type Cast, 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 NodeHoverCallback, 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, portTypeColor, portsCompatible, portsConnect, renderContinuously, requestRender, setTheme, themeVersion, typeSetsCompatible, typeSetsConnect, widgetFont };