@comfyorg/comfyui-frontend-types 1.27.1 → 1.27.7

package/index.d.ts

@@ -1,5 +1,6 @@
-import { ComfyApiWorkflow } from '../schemas/comfyWorkflowSchema';
-import { ComfyWorkflowJSON } from '../schemas/comfyWorkflowSchema';
+import { ComfyApiWorkflow } from '../platform/workflow/validation/schemas/workflowSchema';
+import { ComfyWorkflowJSON } from '../platform/workflow/validation/schemas/workflowSchema';
+import { ComfyWorkflowJSON as ComfyWorkflowJSON_2 } from '../../validation/schemas/workflowSchema';
 import { Component } from 'vue';
 import { DeviceStats } from '../schemas/apiSchema';
 import { DisplayComponentWsMessage } from '../schemas/apiSchema';
@@ -18,7 +19,7 @@ import { LogEntry } from '../schemas/apiSchema';
 import { LogsRawResponse } from '../schemas/apiSchema';
 import { LogsWsMessage } from '../schemas/apiSchema';
 import { NodeError } from '../schemas/apiSchema';
-import { NodeId as NodeId_2 } from '../schemas/comfyWorkflowSchema';
+import { NodeId as NodeId_2 } from '../platform/workflow/validation/schemas/workflowSchema';
 import { PendingTaskItem } from '../schemas/apiSchema';
 import { ProgressStateWsMessage } from '../schemas/apiSchema';
 import { ProgressTextWsMessage } from '../schemas/apiSchema';
@@ -76,6 +77,17 @@ declare type AsCustomEvents<T> = {
     readonly [K in keyof T]: CustomEvent<T[K]>;
 };
 
+declare class AssetWidget extends BaseWidget<IAssetWidget> implements IAssetWidget {
+    constructor(widget: IAssetWidget, node: LGraphNode);
+    get _displayValue(): string;
+    drawWidget(ctx: CanvasRenderingContext2D, { width, showText }: DrawWidgetOptions): void;
+    onClick(): void;
+}
+
+declare interface AuthUserInfo {
+    id: string;
+}
+
 /** Dictionary of calls originating from ComfyUI core */
 declare interface BackendApiCalls {
     progress: ProgressWsMessage;
@@ -611,6 +623,15 @@ declare class ChartWidget extends BaseWidget<IChartWidget> implements IChartWidg
 
 declare type ClassList = string | string[] | Record<string, boolean>;
 
+/** Items copied from the canvas */
+declare interface ClipboardItems_2 {
+    nodes?: ISerialisedNode[];
+    groups?: ISerialisedGroup[];
+    reroutes?: SerialisableReroute[];
+    links?: SerialisableLLink[];
+    subgraphs?: ExportedSubgraph[];
+}
+
 /**
  * The items created by a clipboard paste operation.
  * Includes maps of original copied IDs to newly created items.
@@ -660,9 +681,15 @@ declare class ColorWidget extends BaseWidget<IColorWidget> implements IColorWidg
 }
 
 declare class ComboWidget extends BaseSteppedWidget<IStringComboWidget | IComboWidget> implements IComboWidget {
-    #private;
     type: "combo";
     get _displayValue(): string;
+    private getValues;
+    /**
+     * Checks if the value is {@link Array.at at} the given index in the combo list.
+     * @param increment `true` if checking the use of the increment button, `false` for decrement
+     * @returns `true` if the value is at the given index, otherwise `false`.
+     */
+    private canUseButton;
     /**
      * Returns `true` if the current value is not the last value in the list.
      * Handles edge case where the value is both the first and last item in the list.
@@ -671,6 +698,7 @@ declare class ComboWidget extends BaseSteppedWidget<IStringComboWidget | IComboW
     canDecrement(): boolean;
     incrementValue(options: WidgetEventOptions): void;
     decrementValue(options: WidgetEventOptions): void;
+    private tryChangeValue;
     onClick({ e, node, canvas }: WidgetEventOptions): void;
 }
 
@@ -784,19 +812,13 @@ export declare class ComfyApi extends EventTarget {
      * Gets a list of model folder keys (eg ['checkpoints', 'loras', ...])
      * @returns The list of model folder keys
      */
-    getModelFolders(): Promise<{
-        name: string;
-        folders: string[];
-    }[]>;
+    getModelFolders(): Promise<ModelFolderInfo[]>;
     /**
      * Gets a list of models in the specified folder
      * @param {string} folder The folder to list models from, such as 'checkpoints'
      * @returns The list of model filenames within the specified folder
      */
-    getModels(folder: string): Promise<{
-        name: string;
-        pathIndex: number;
-    }[]>;
+    getModels(folder: string): Promise<ModelFile[]>;
     /**
      * Gets the metadata for a model
      * @param {string} folder The folder containing the model
@@ -1286,6 +1308,12 @@ export declare class ComfyApp {
          * @param missingNodeTypes The missing node types
          */
         afterConfigureGraph?(missingNodeTypes: MissingNodeType[]): Promise<void> | void;
+        /**
+         * Fired whenever authentication resolves, providing the anonymized user id..
+         * Extensions can register at any time and will receive the latest value immediately.
+         * This is an experimental API and may be changed or removed in the future.
+         */
+        onAuthUserResolved?(user: AuthUserInfo, app: ComfyApp): Promise<void> | void;
         [key: string]: any;
     }
 
@@ -1412,7 +1440,8 @@ export declare class ComfyApp {
     };
 
     declare class ComfyWorkflow extends UserFile {
-        static readonly basePath = "workflows/";
+        static readonly basePath: string;
+        readonly tintCanvasBg?: string;
         /**
          * The change tracker for the workflow. Non-reactive raw object.
          */
@@ -1431,8 +1460,8 @@ export declare class ComfyApp {
             size: number;
         });
         get key(): string;
-        get activeState(): ComfyWorkflowJSON | null;
-        get initialState(): ComfyWorkflowJSON | null;
+        get activeState(): ComfyWorkflowJSON_2 | null;
+        get initialState(): ComfyWorkflowJSON_2 | null;
         get isLoaded(): boolean;
         get isModified(): boolean;
         set isModified(value: boolean);
@@ -1454,6 +1483,7 @@ export declare class ComfyApp {
          * @returns this
          */
         saveAs(path: string): Promise<UserFile>;
+        promptSave(): Promise<string | null>;
     }
 
     export declare interface CommandManager {
@@ -2134,6 +2164,11 @@ export declare class ComfyApp {
         onPointerLeave?(e?: CanvasPointerEvent): void;
     }
 
+    declare interface IAssetWidget extends IBaseWidget<string, 'asset', IWidgetOptions<string[]>> {
+        type: 'asset';
+        value: string;
+    }
+
     /**
      * The base type for all widgets.  Should not be implemented directly.
      * @template TValue The type of value this widget holds.
@@ -2829,7 +2864,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;
+    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 interface IWidgetKnobOptions extends IWidgetOptions<number[]> {
         min: number;
@@ -3574,6 +3609,7 @@ export declare class ComfyApp {
         _bg_img?: HTMLImageElement;
         _pattern?: CanvasPattern;
         _pattern_img?: HTMLImageElement;
+        bg_tint?: string | CanvasGradient | CanvasPattern;
         prompt_box?: PromptDialog | null;
         search_box?: HTMLDivElement;
         /** @deprecated Panels */
@@ -3755,6 +3791,7 @@ export declare class ComfyApp {
          * process a key event
          */
         processKey(e: KeyboardEvent): void;
+        _serializeItems(items?: Iterable<Positionable>): ClipboardItems_2;
         /**
          * Copies canvas items to an internal, app-specific clipboard backed by local storage.
          * When called without parameters, it copies {@link selectedItems}.
@@ -3770,6 +3807,7 @@ export declare class ComfyApp {
          * Pastes the items from the canvas "clipbaord" - a local storage variable.
          */
         _pasteFromClipboard(options?: IPasteFromClipboardOptions): ClipboardPasteResult | undefined;
+        _deserializeItems(parsed: ClipboardItems_2, options: IPasteFromClipboardOptions): ClipboardPasteResult | undefined;
         pasteFromClipboard(options?: IPasteFromClipboardOptions): void;
         processNodeDblClicked(n: LGraphNode): void;
         /**
@@ -5387,22 +5425,6 @@ export declare class ComfyApp {
         WIDGET_TEXT_COLOR: string;
         WIDGET_SECONDARY_TEXT_COLOR: string;
         WIDGET_DISABLED_TEXT_COLOR: string;
-        /**
-         * Vue node dimensions configuration for the contract between LiteGraph and Vue components.
-         * These values ensure both systems can independently calculate node, slot, and widget positions
-         * to place them in identical locations.
-         */
-        COMFY_VUE_NODE_DIMENSIONS: {
-            readonly spacing: {
-                readonly BETWEEN_SLOTS_AND_BODY: 8;
-                readonly BETWEEN_WIDGETS: 8;
-            };
-            readonly components: {
-                readonly HEADER_HEIGHT: 34;
-                readonly SLOT_HEIGHT: 24;
-                readonly STANDARD_WIDGET_HEIGHT: 30;
-            };
-        };
         LINK_COLOR: string;
         EVENT_LINK_COLOR: string;
         CONNECTING_LINK_COLOR: string;
@@ -5591,9 +5613,12 @@ export declare class ComfyApp {
         /**
          * "standard": change the dragging on left mouse button click to select, enable middle-click or spacebar+left-click dragging
          * "legacy": Enable dragging on left-click (original behavior)
+         * "custom": Use leftMouseClickBehavior and mouseWheelScroll settings
          * @default "legacy"
          */
-        canvasNavigationMode: 'standard' | 'legacy';
+        canvasNavigationMode: 'standard' | 'legacy' | 'custom';
+        leftMouseClickBehavior: 'panning' | 'select';
+        mouseWheelScroll: 'panning' | 'zoom';
         /**
          * If `true`, widget labels and values will both be truncated (proportionally to size),
          * until they fit within the widget.
@@ -5930,8 +5955,8 @@ export declare class ComfyApp {
         originalContent: string;
         content: string;
         changeTracker: ChangeTracker;
-        initialState: ComfyWorkflowJSON;
-        activeState: ComfyWorkflowJSON;
+        initialState: ComfyWorkflowJSON_2;
+        activeState: ComfyWorkflowJSON_2;
     }
 
     declare interface LoadedUserFile extends UserFile {
@@ -5978,6 +6003,16 @@ export declare class ComfyApp {
         };
     };
 
+    declare interface ModelFile {
+        name: string;
+        pathIndex: number;
+    }
+
+    declare interface ModelFolderInfo {
+        name: string;
+        folders: string[];
+    }
+
     declare class MovingInputLink extends MovingLinkBase {
         readonly toType = "input";
         readonly node: LGraphNode;
@@ -6805,7 +6840,7 @@ export declare class ComfyApp {
 
     declare type SettingCustomRenderer = (name: string, setter: (v: any) => void, value: any, attrs: any) => HTMLElement;
 
-    declare type SettingInputType = 'boolean' | 'number' | 'slider' | 'knob' | 'combo' | 'text' | 'image' | 'color' | 'url' | 'hidden' | 'backgroundImage';
+    declare type SettingInputType = 'boolean' | 'number' | 'slider' | 'knob' | 'combo' | 'radio' | 'text' | 'image' | 'color' | 'url' | 'hidden' | 'backgroundImage';
 
     declare interface SettingOption {
         text: string;
@@ -6813,7 +6848,7 @@ export declare class ComfyApp {
     }
 
     declare interface SettingParams<TValue = unknown> extends FormItem {
-        id: keyof Settings;
+        id: keyof Settings_2;
         defaultValue: any | (() => any);
         defaultsByInstallVersion?: Record<`${number}.${number}.${number}`, TValue>;
         onChange?: (newValue: any, oldValue?: any) => void;
@@ -6823,6 +6858,7 @@ export declare class ComfyApp {
         migrateDeprecatedValue?: (value: any) => any;
         versionAdded?: string;
         versionModified?: string;
+        sortOrder?: number;
     }
 
     export { Settings }
@@ -7649,6 +7685,7 @@ export declare class ComfyApp {
         imagecompare: ImageCompareWidget;
         selectbutton: SelectButtonWidget;
         textarea: TextareaWidget;
+        asset: AssetWidget;
         [key: string]: BaseWidget;
     };
 
@@ -9730,8 +9767,8 @@ export declare class ComfyApp {
     }, "strip", z.ZodTypeAny, {
         name: string;
         description: string;
-        category: string;
         display_name: string;
+        category: string;
         output_node: boolean;
         python_module: string;
         input?: {
@@ -10146,19 +10183,19 @@ export declare class ComfyApp {
             }, z.ZodTypeAny, "passthrough"> | undefined]> | undefined;
         } | undefined;
         output?: (string | (string | number)[])[] | undefined;
-        deprecated?: boolean | undefined;
-        help?: string | undefined;
-        experimental?: boolean | undefined;
         output_is_list?: boolean[] | undefined;
         output_name?: string[] | undefined;
         output_tooltips?: string[] | undefined;
+        help?: string | undefined;
+        deprecated?: boolean | undefined;
+        experimental?: boolean | undefined;
         api_node?: boolean | undefined;
         input_order?: Record<string, string[]> | undefined;
     }, {
         name: string;
         description: string;
-        category: string;
         display_name: string;
+        category: string;
         output_node: boolean;
         python_module: string;
         input?: {
@@ -10573,12 +10610,12 @@ export declare class ComfyApp {
             }, z.ZodTypeAny, "passthrough"> | undefined]> | undefined;
         } | undefined;
         output?: (string | (string | number)[])[] | undefined;
-        deprecated?: boolean | undefined;
-        help?: string | undefined;
-        experimental?: boolean | undefined;
         output_is_list?: boolean[] | undefined;
         output_name?: string[] | undefined;
         output_tooltips?: string[] | undefined;
+        help?: string | undefined;
+        deprecated?: boolean | undefined;
+        experimental?: boolean | undefined;
         api_node?: boolean | undefined;
         input_order?: Record<string, string[]> | undefined;
     }>;
@@ -11239,226 +11276,3 @@ export declare class ComfyApp {
     }>;
 
     export { }
-
-
-declare global {
-    interface Window {
-        /** For use by extensions and in the browser console. Where possible, import `app` from '@/scripts/app' instead. */
-        app?: ComfyApp;
-        /** For use by extensions and in the browser console. Where possible, import `app` and access via `app.graph` instead. */
-        graph?: LGraph;
-    }
-}
-
-
-
-declare global {
-  interface Window {
-    __COMFYUI_FRONTEND_VERSION__: string
-  }
-}
-
-
-
-/** ComfyUI extensions of litegraph */
-declare module '@/lib/litegraph/src/types/widgets' {
-  interface IWidgetOptions {
-    /** Currently used by DOM widgets only.  Declaring here reduces complexity. */
-    onHide?: (widget: DOMWidget) => void
-    /**
-     * Controls whether the widget's value is included in the API workflow/prompt.
-     * - If false, the value will be excluded from the API workflow but still serialized as part of the graph state
-     * - If true or undefined, the value will be included in both the API workflow and graph state
-     * @default true
-     * @use {@link IBaseWidget.serialize} if you don't want the widget value to be included in both
-     * the API workflow and graph state.
-     */
-    serialize?: boolean
-    /**
-     * Rounding value for numeric float widgets.
-     */
-    round?: number
-    /**
-     * The minimum size of the node if the widget is present.
-     */
-    minNodeSize?: Size
-
-    /** If the widget is advanced, this will be set to true. */
-    advanced?: boolean
-
-    /** If the widget is hidden, this will be set to true. */
-    hidden?: boolean
-  }
-
-  interface IBaseWidget {
-    onRemove?(): void
-    beforeQueued?(): unknown
-    afterQueued?(): unknown
-    serializeValue?(node: LGraphNode, index: number): Promise<unknown> | unknown
-
-    /**
-     * Refreshes the widget's value or options from its remote source.
-     */
-    refresh?(): unknown
-
-    /**
-     * If the widget supports dynamic prompts, this will be set to true.
-     * See extensions/core/dynamicPrompts.ts
-     */
-    dynamicPrompts?: boolean
-  }
-}
-
-
-
-/**
- * ComfyUI extensions of litegraph interfaces
- */
-declare module '@/lib/litegraph/src/interfaces' {
-  interface IWidgetLocator {
-    [key: symbol]: unknown
-  }
-}
-
-
-
-/**
- *  ComfyUI extensions of litegraph
- */
-declare module '@/lib/litegraph/src/litegraph' {
-  interface LGraphNodeConstructor<T extends LGraphNode = LGraphNode> {
-    type?: string
-    comfyClass: string
-    title: string
-    nodeData?: ComfyNodeDefV1 & ComfyNodeDefV2 & { [key: symbol]: unknown }
-    category?: string
-    new (): T
-  }
-
-  // Add interface augmentations into the class itself
-  // eslint-disable-next-line @typescript-eslint/no-empty-object-type
-  interface BaseWidget extends IBaseWidget {}
-
-  interface LGraphNode {
-    constructor: LGraphNodeConstructor
-
-    /**
-     * Callback fired on each node after the graph is configured
-     */
-    onAfterGraphConfigured?(): void
-    onGraphConfigured?(): void
-    onExecuted?(output: any): void
-    onNodeCreated?(this: LGraphNode): void
-    /** @deprecated groupNode */
-    setInnerNodes?(nodes: LGraphNode[]): void
-    /** Originally a group node API. */
-    getInnerNodes?(
-      nodesByExecutionId: Map<ExecutionId, ExecutableLGraphNode>,
-      subgraphNodePath?: readonly NodeId[],
-      nodes?: ExecutableLGraphNode[],
-      subgraphs?: Set<LGraphNode>
-    ): ExecutableLGraphNode[]
-    /** @deprecated groupNode */
-    convertToNodes?(): LGraphNode[]
-    recreate?(): Promise<LGraphNode>
-    refreshComboInNode?(defs: Record<string, ComfyNodeDef>)
-    /** @deprecated groupNode */
-    updateLink?(link: LLink): LLink | null
-    /**
-     * @deprecated primitive node.
-     * Used by virtual nodes (primitives) to insert their values into the graph prior to queueing.
-     * Externally used by
-     * - https://github.com/pythongosssss/ComfyUI-Custom-Scripts/blob/bbda5e52ad580c13ceaa53136d9c2bed9137bd2e/web/js/presetText.js#L160-L182
-     * - https://github.com/Kosinkadink/ComfyUI-VideoHelperSuite/blob/4c7858ddd5126f7293dc3c9f6e0fc4c263cde079/web/js/VHS.core.js#L1889-L1889
-     */
-    applyToGraph?(extraLinks?: LLink[]): void
-    onExecutionStart?(): unknown
-    /**
-     * Callback invoked when the node is dragged over from an external source, i.e.
-     * a file or another HTML element.
-     * @param e The drag event
-     * @returns {boolean} True if the drag event should be handled by this node, false otherwise
-     */
-    onDragOver?(e: DragEvent): boolean
-    /**
-     * Callback invoked when the node is dropped from an external source, i.e.
-     * a file or another HTML element.
-     * @param e The drag event
-     * @returns {boolean} True if the drag event should be handled by this node, false otherwise
-     */
-    onDragDrop?(e: DragEvent): Promise<boolean> | boolean
-
-    index?: number
-    runningInternalNodeId?: NodeId
-
-    comfyClass?: string
-
-    /**
-     * If the node is a frontend only node and should not be serialized into the prompt.
-     */
-    isVirtualNode?: boolean
-
-    addDOMWidget<
-      T extends HTMLElement = HTMLElement,
-      V extends object | string = string
-    >(
-      name: string,
-      type: string,
-      element: T,
-      options?: DOMWidgetOptions<V>
-    ): DOMWidget<T, V>
-
-    animatedImages?: boolean
-    imgs?: HTMLImageElement[]
-    images?: ExecutedWsMessage['output']
-    /** Container for the node's video preview */
-    videoContainer?: HTMLElement
-    /** Whether the node's preview media is loading */
-    isLoading?: boolean
-    /** The content type of the node's preview media */
-    previewMediaType?: 'image' | 'video' | 'audio' | 'model'
-
-    preview: string[]
-    /** Index of the currently selected image on a multi-image node such as Preview Image */
-    imageIndex?: number | null
-    imageRects: Rect[]
-    overIndex?: number | null
-    pointerDown?: { index: number | null; pos: Point } | null
-    /**
-     * @deprecated No longer needed as we use {@link useImagePreviewWidget}
-     */
-    setSizeForImage?(force?: boolean): void
-    /** @deprecated Unused */
-    inputHeight?: unknown
-
-    /** The y offset of the image preview to the top of the node body. */
-    imageOffset?: number
-    /** Callback for pasting an image file into the node */
-    pasteFile?(file: File): void
-    /** Callback for pasting multiple files into the node */
-    pasteFiles?(files: File[]): void
-  }
-  /**
-   * Only used by the Primitive node. Primitive node is using the widget property
-   * to store/access the widget config.
-   * We should remove this hacky solution once we have a proper solution.
-   */
-  interface INodeOutputSlot {
-    widget?: { name: string; [key: symbol]: unknown }
-  }
-}
-
-
-
-/**
- * Extended types for litegraph, to be merged upstream once it has stabilized.
- */
-declare module '@/lib/litegraph/src/litegraph' {
-  /**
-   * widgets_values is set to LGraphNode by `LGraphNode.configure`, but it is not
-   * used by litegraph internally. We should remove the dependency on it later.
-   */
-  interface LGraphNode {
-    widgets_values?: unknown[]
-  }
-}

package/package.json

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