@comfyorg/comfyui-frontend-types 1.29.0 → 1.29.2

package/index.d.ts

@@ -1139,6 +1139,18 @@ export declare class ComfyApp {
       * @param {ComfyExtension} extension
       */
      registerExtension(extension: ComfyExtension): void;
+     /**
+      * Collects context menu items from all extensions for canvas menus
+      * @param canvas The canvas instance
+      * @returns Array of context menu items from all extensions
+      */
+     collectCanvasMenuItems(canvas: LGraphCanvas): IContextMenuValue[];
+     /**
+      * Collects context menu items from all extensions for node menus
+      * @param node The node being right-clicked
+      * @returns Array of context menu items from all extensions
+      */
+     collectNodeMenuItems(node: LGraphNode): IContextMenuValue[];
      /**
       * Refresh combo list on whole nodes
       */
@@ -1293,6 +1305,18 @@ export declare class ComfyApp {
          * @returns An array of command ids to add to the selection toolbox
          */
         getSelectionToolboxCommands?(selectedItem: Positionable): string[];
+        /**
+         * Allows the extension to add context menu items to canvas right-click menus
+         * @param canvas The canvas instance
+         * @returns An array of context menu items to add
+         */
+        getCanvasMenuItems?(canvas: LGraphCanvas): IContextMenuValue[];
+        /**
+         * Allows the extension to add context menu items to node right-click menus
+         * @param node The node being right-clicked
+         * @returns An array of context menu items to add
+         */
+        getNodeMenuItems?(node: LGraphNode): IContextMenuValue[];
         /**
          * Allows the extension to add additional handling to the node before it is registered with **LGraph**
          * @param nodeType The node class (not an instance)
@@ -2201,6 +2225,11 @@ export declare class ComfyApp {
         value: string;
     }
 
+    declare interface IAudioRecordWidget extends IBaseWidget<string, 'audiorecord'> {
+        type: 'audiorecord';
+        value: string;
+    }
+
     /**
      * The base type for all widgets.  Should not be implemented directly.
      * @template TValue The type of value this widget holds.
@@ -2904,7 +2933,7 @@ export declare class ComfyApp {
      * Recommend declaration merging any properties that use IWidget (e.g. {@link LGraphNode.widgets}) with a new type alias.
      * @see ICustomWidget
      */
-    declare type IWidget = IBooleanWidget | INumericWidget | IStringWidget | IComboWidget | IStringComboWidget | ICustomWidget | ISliderWidget | IButtonWidget | IKnobWidget | IFileUploadWidget | IColorWidget | IMarkdownWidget | IImageWidget | ITreeSelectWidget | IMultiSelectWidget | IChartWidget | IGalleriaWidget | IImageCompareWidget | ISelectButtonWidget | ITextareaWidget | IAssetWidget;
+    declare type IWidget = IBooleanWidget | INumericWidget | IStringWidget | IComboWidget | IStringComboWidget | ICustomWidget | ISliderWidget | IButtonWidget | IKnobWidget | IFileUploadWidget | IColorWidget | IMarkdownWidget | IImageWidget | ITreeSelectWidget | IMultiSelectWidget | IChartWidget | IGalleriaWidget | IImageCompareWidget | ISelectButtonWidget | ITextareaWidget | IAssetWidget | IAudioRecordWidget;
 
     declare interface IWidgetKnobOptions extends IWidgetOptions<number[]> {
         min: number;
@@ -3097,7 +3126,7 @@ export declare class ComfyApp {
         onExecuteStep?(): void;
         onNodeAdded?(node: LGraphNode): void;
         onNodeRemoved?(node: LGraphNode): void;
-        onTrigger?(action: string, param: unknown): void;
+        onTrigger?: LGraphTriggerHandler;
         onBeforeChange?(graph: LGraph, info?: LGraphNode): void;
         onAfterChange?(graph: LGraph, info?: LGraphNode | null): void;
         onConnectionChange?(node: LGraphNode): void;
@@ -3276,6 +3305,7 @@ export declare class ComfyApp {
          * this replaces the ones using the old version with the new version
          */
         checkNodeTypes(): void;
+        trigger<A extends LGraphTriggerAction>(action: A, param: LGraphTriggerParam<A>): void;
         trigger(action: string, param: unknown): void;
         /** @todo Clean up - never implemented. */
         triggerInput(name: string, value: any): void;
@@ -5021,10 +5051,10 @@ export declare class ComfyApp {
          * Gets the position of an output slot, in graph co-ordinates.
          *
          * This method is preferred over the legacy {@link getConnectionPos} method.
-         * @param slot Output slot index
+         * @param outputSlotIndex Output slot index
          * @returns Position of the output slot
          */
-        getOutputPos(slot: number): Point;
+        getOutputPos(outputSlotIndex: number): Point;
         /** @inheritdoc */
         snapToGrid(snapTo: number): boolean;
         /** @see {@link snapToGrid} */
@@ -5182,6 +5212,16 @@ export declare class ComfyApp {
         lastRerouteId: number;
     }
 
+    declare type LGraphTriggerAction = LGraphTriggerEvent['type'];
+
+    declare type LGraphTriggerEvent = NodePropertyChangedEvent | NodeSlotErrorsChangedEvent | NodeSlotLinksChangedEvent;
+
+    declare type LGraphTriggerHandler = (event: LGraphTriggerEvent) => void;
+
+    declare type LGraphTriggerParam<A extends LGraphTriggerAction> = Extract<LGraphTriggerEvent, {
+        type: A;
+    }>;
+
     /**
      * Component of {@link LGraphCanvas} that handles connecting and moving links.
      * @see {@link LLink}
@@ -6211,6 +6251,28 @@ export declare class ComfyApp {
 
     declare type NodeProperty = string | number | boolean | object;
 
+    declare interface NodePropertyChangedEvent {
+        type: 'node:property:changed';
+        nodeId: NodeId;
+        property: string;
+        oldValue: unknown;
+        newValue: unknown;
+    }
+
+    declare interface NodeSlotErrorsChangedEvent {
+        type: 'node:slot-errors:changed';
+        nodeId: NodeId;
+    }
+
+    declare interface NodeSlotLinksChangedEvent {
+        type: 'node:slot-links:changed';
+        nodeId: NodeId;
+        slotType: NodeSlotType;
+        slotIndex: number;
+        connected: boolean;
+        linkId: number;
+    }
+
     /** Node slot type - input or output */
     declare enum NodeSlotType {
         INPUT = 1,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@comfyorg/comfyui-frontend-types",
-  "version": "1.29.0",
+  "version": "1.29.2",
   "types": "./index.d.ts",
   "files": [
     "index.d.ts"