@comfyorg/comfyui-frontend-types 1.24.0 → 1.24.2

package/index.d.ts

@@ -29,6 +29,7 @@ import { ExecutionInterruptedWsMessage } from '../schemas/apiSchema';
 import { ExecutionStartWsMessage } from '../schemas/apiSchema';
 import { ExecutionSuccessWsMessage } from '../schemas/apiSchema';
 import { ExtensionsResponse } from '../schemas/apiSchema';
+import { FeatureFlagsWsMessage } from '../schemas/apiSchema';
 import { FirebaseOption } from 'vuefire';
 import { FirestoreOption } from 'vuefire';
 import { FunctionalComponent } from 'vue';
@@ -58,6 +59,7 @@ import { PendingTaskItem } from '../schemas/apiSchema';
 import { PluralizationRules } from '@intlify/core-base';
 import { Positionable } from '@comfyorg/litegraph/dist/interfaces';
 import { PostTranslationHandler } from 'vue-i18n';
+import { ProgressStateWsMessage } from '../schemas/apiSchema';
 import { ProgressTextWsMessage } from '../schemas/apiSchema';
 import { ProgressWsMessage } from '../schemas/apiSchema';
 import { PromptResponse } from '../schemas/apiSchema';
@@ -124,8 +126,19 @@ declare interface BackendApiCalls {
     logs: LogsWsMessage;
     /** Binary preview/progress data */
     b_preview: Blob;
+    /** Binary preview with metadata (node_id, prompt_id) */
+    b_preview_with_metadata: {
+        blob: Blob;
+        nodeId: string;
+        parentNodeId: string;
+        displayNodeId: string;
+        realNodeId: string;
+        promptId: string;
+    };
     progress_text: ProgressTextWsMessage;
+    progress_state: ProgressStateWsMessage;
     display_component: DisplayComponentWsMessage;
+    feature_flags: FeatureFlagsWsMessage;
 }
 
 declare interface BaseBottomPanelExtension {
@@ -234,6 +247,15 @@ export declare class ComfyApi extends EventTarget {
     user: string;
     socket: WebSocket | null;
     reportedUnknownMessageTypes: Set<string>;
+    /**
+     * Get feature flags supported by this frontend client.
+     * Returns a copy to prevent external modification.
+     */
+    getClientFeatureFlags(): Record<string, unknown>;
+    /**
+     * Feature flags received from the backend server.
+     */
+    serverFeatureFlags: Record<string, unknown>;
     /**
      * The auth token for the comfy org account if the user is logged in.
      * This is only used for {@link queuePrompt} now. It is not directly
@@ -373,9 +395,11 @@ export declare class ComfyApi extends EventTarget {
      */
     clearItems(type: string): Promise<void>;
     /**
-     * Interrupts the execution of the running prompt
+     * Interrupts the execution of the running prompt. If runningPromptId is provided,
+     * it is included in the payload as a helpful hint to the backend.
+     * @param {string | null} [runningPromptId] Optional Running Prompt ID to interrupt
      */
-    interrupt(): Promise<void>;
+    interrupt(runningPromptId: string | null): Promise<void>;
     /**
      * Gets user configuration data and where data should be stored
      */
@@ -446,6 +470,24 @@ export declare class ComfyApi extends EventTarget {
      * @returns The custom nodes i18n data
      */
     getCustomNodesI18n(): Promise<Record<string, any>>;
+    /**
+     * Checks if the server supports a specific feature.
+     * @param featureName The name of the feature to check
+     * @returns true if the feature is supported, false otherwise
+     */
+    serverSupportsFeature(featureName: string): boolean;
+    /**
+     * Gets a server feature flag value.
+     * @param featureName The name of the feature to get
+     * @param defaultValue The default value if the feature is not found
+     * @returns The feature value or default
+     */
+    getServerFeature<T = unknown>(featureName: string, defaultValue?: T): T;
+    /**
+     * Gets all server feature flags.
+     * @returns Copy of all server feature flags
+     */
+    getServerFeatures(): Record<string, unknown>;
 }
 
 export declare class ComfyApp {
@@ -491,6 +533,8 @@ export declare class ComfyApp {
      get lastExecutionError(): ExecutionErrorWsMessage | null;
      /**
       * @deprecated Use useExecutionStore().executingNodeId instead
+      * TODO: Update to support multiple executing nodes. This getter returns only the first executing node.
+      * Consider updating consumers to handle multiple nodes or use executingNodeIds array.
       */
      get runningNodeId(): NodeId | null;
      /**
@@ -592,11 +636,6 @@ export declare class ComfyApp {
       * Refresh combo list on whole nodes
       */
      refreshComboInNodes(): Promise<void>;
-     /**
-      * Frees memory allocated to image preview blobs for a specific node, by revoking the URLs associated with them.
-      * @param nodeId ID of the node to revoke all preview images of
-      */
-     revokePreviews(nodeId: NodeId): void;
      /**
       * Clean current state
       */
@@ -972,6 +1011,21 @@ export declare class ComfyApp {
 
     declare type ConfirmationDialogType = 'default' | 'overwrite' | 'delete' | 'dirtyClose' | 'reinstall';
 
+    /**
+     * Create a NodeExecutionId from an array of node IDs
+     * @param nodeIds Array of node IDs from root to target
+     * @returns A properly formatted NodeExecutionId
+     */
+    export declare function createNodeExecutionId(nodeIds: NodeId[]): NodeExecutionId;
+
+    /**
+     * Create a NodeLocatorId from components
+     * @param subgraphUuid The UUID of the immediate containing subgraph
+     * @param localNodeId The local node ID within that subgraph
+     * @returns A properly formatted NodeLocatorId
+     */
+    export declare function createNodeLocatorId(subgraphUuid: string, localNodeId: NodeId): NodeLocatorId;
+
     declare type CustomBottomPanelExtension = BaseBottomPanelExtension & CustomExtension;
 
     declare interface CustomDialogComponentProps {
@@ -1041,6 +1095,16 @@ export declare class ComfyApp {
 
     export declare type InputSpec = z.infer<typeof zInputSpec>;
 
+    /**
+     * Type guard to check if a value is a NodeExecutionId
+     */
+    export declare function isNodeExecutionId(value: unknown): value is NodeExecutionId;
+
+    /**
+     * Type guard to check if a value is a NodeLocatorId
+     */
+    export declare function isNodeLocatorId(value: unknown): value is NodeLocatorId;
+
     declare type Keybinding = z.infer<typeof zKeybinding>;
 
     declare interface LoadedComfyWorkflow extends ComfyWorkflow {
@@ -1090,6 +1154,49 @@ export declare class ComfyApp {
 
     export { NodeError }
 
+    /**
+     * An execution identifier representing a node's position in nested subgraphs.
+     * Also known as ExecutionId in some contexts.
+     *
+     * Format: Colon-separated path of node IDs
+     * Example: "123:456:789" (node 789 in subgraph 456 in subgraph 123)
+     */
+    export declare type NodeExecutionId = string;
+
+    /**
+     * A globally unique identifier for nodes that maintains consistency across
+     * multiple instances of the same subgraph.
+     *
+     * Format:
+     * - For subgraph nodes: `<immediate-contained-subgraph-uuid>:<local-node-id>`
+     * - For root graph nodes: `<local-node-id>`
+     *
+     * Examples:
+     * - "a1b2c3d4-e5f6-7890-abcd-ef1234567890:123" (node in subgraph)
+     * - "456" (node in root graph)
+     *
+     * Unlike execution IDs which change based on the instance path,
+     * NodeLocatorId remains the same for all instances of a particular node.
+     */
+    export declare type NodeLocatorId = string;
+
+    /**
+     * Parse a NodeExecutionId into its component node IDs
+     * @param id The NodeExecutionId to parse
+     * @returns Array of node IDs from root to target, or null if not an execution ID
+     */
+    export declare function parseNodeExecutionId(id: string): NodeId[] | null;
+
+    /**
+     * Parse a NodeLocatorId into its components
+     * @param id The NodeLocatorId to parse
+     * @returns The subgraph UUID and local node ID, or null if invalid
+     */
+    export declare function parseNodeLocatorId(id: string): {
+        subgraphUuid: string | null;
+        localNodeId: NodeId;
+    } | null;
+
     /** {@link Pick} only properties that evaluate to `never`. */
     declare type PickNevers<T> = {
         [K in keyof T as T[K] extends never ? K : never]: T[K];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@comfyorg/comfyui-frontend-types",
-  "version": "1.24.0",
+  "version": "1.24.2",
   "types": "./index.d.ts",
   "files": [
     "index.d.ts"
@@ -13,7 +13,7 @@
   "description": "TypeScript definitions for @comfyorg/comfyui-frontend",
   "license": "GPL-3.0-only",
   "dependencies": {
-    "@comfyorg/litegraph": "^0.16.6"
+    "@comfyorg/litegraph": "^0.16.16"
   },
   "peerDependencies": {
     "vue": "^3.5.13",