comfyui-node 1.4.1 → 1.4.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. package/dist/.tsbuildinfo +1 -1
  2. package/dist/call-wrapper.d.ts +124 -123
  3. package/dist/call-wrapper.d.ts.map +1 -1
  4. package/dist/call-wrapper.js +567 -555
  5. package/dist/call-wrapper.js.map +1 -1
  6. package/dist/pool/WorkflowPool.d.ts.map +1 -1
  7. package/dist/pool/WorkflowPool.js +455 -437
  8. package/dist/pool/WorkflowPool.js.map +1 -1
  9. package/package.json +1 -1
package/dist/call-wrapper.d.ts CHANGED
@@ -1,124 +1,125 @@
1
- import { NodeData, NodeProgress } from "./types/api.js";
2
- import { ComfyApi } from "./client.js";
3
- import { PromptBuilder } from "./prompt-builder.js";
4
- /**
5
- * Represents a wrapper class for making API calls using the ComfyApi client.
6
- * Provides methods for setting callback functions and executing the job.
7
- */
8
- export declare class CallWrapper<I extends string, O extends string, T extends NodeData> {
9
- private client;
10
- private prompt;
11
- private started;
12
- private promptId?;
13
- private output;
14
- private onPreviewFn?;
15
- private onPreviewMetaFn?;
16
- private onPendingFn?;
17
- private onStartFn?;
18
- private onOutputFn?;
19
- private onFinishedFn?;
20
- private onFailedFn?;
21
- private onProgressFn?;
22
- private onDisconnectedHandlerOffFn;
23
- private checkExecutingOffFn;
24
- private checkExecutedOffFn;
25
- private progressHandlerOffFn;
26
- private previewHandlerOffFn;
27
- private executionHandlerOffFn;
28
- private errorHandlerOffFn;
29
- private executionEndSuccessOffFn;
30
- private statusHandlerOffFn;
31
- private interruptionHandlerOffFn;
32
- /**
33
- * Constructs a new CallWrapper instance.
34
- * @param client The ComfyApi client.
35
- * @param workflow The workflow object.
36
- */
37
- constructor(client: ComfyApi, workflow: PromptBuilder<I, O, T>);
38
- /**
39
- * Set the callback function to be called when a preview event occurs.
40
- *
41
- * @param fn - The callback function to be called. It receives a Blob object representing the event and an optional promptId string.
42
- * @returns The current instance of the CallWrapper.
43
- */
44
- onPreview(fn: (ev: Blob, promptId?: string) => void): this;
45
- /**
46
- * Set the callback function to be called when a preview-with-metadata event occurs.
47
- */
48
- onPreviewMeta(fn: (payload: {
49
- blob: Blob;
50
- metadata: any;
51
- }, promptId?: string) => void): this;
52
- /**
53
- * Set a callback function to be executed when the job is queued.
54
- * @param {Function} fn - The callback function to be executed.
55
- * @returns The current instance of the CallWrapper.
56
- */
57
- onPending(fn: (promptId?: string) => void): this;
58
- /**
59
- * Set the callback function to be executed when the job start.
60
- *
61
- * @param fn - The callback function to be executed. It can optionally receive a `promptId` parameter.
62
- * @returns The current instance of the CallWrapper.
63
- */
64
- onStart(fn: (promptId?: string) => void): this;
65
- /**
66
- * Sets the callback function to handle the output node when the workflow is executing. This is
67
- * useful when you want to handle the output of each nodes as they are being processed.
68
- *
69
- * All the nodes defined in the `mapOutputKeys` will be passed to this function when node is executed.
70
- *
71
- * @param fn - The callback function to handle the output.
72
- * @returns The current instance of the class.
73
- */
74
- onOutput(fn: (key: keyof PromptBuilder<I, O, T>["mapOutputKeys"] | string | "_raw", data: any, promptId?: string) => void): this;
75
- /**
76
- * Set the callback function to be executed when the asynchronous operation is finished.
77
- *
78
- * @param fn - The callback function to be executed. It receives the data returned by the operation
79
- * and an optional promptId parameter.
80
- * @returns The current instance of the CallWrapper.
81
- */
82
- onFinished(fn: (data: Record<keyof PromptBuilder<I, O, T>["mapOutputKeys"], any> & {
83
- /**
84
- * The raw output data from the workflow execution.
85
- * Key is node_id, value is node output.
86
- */
87
- _raw?: Record<string, any>;
88
- }, promptId?: string) => void): this;
89
- /**
90
- * Set the callback function to be executed when the API call fails.
91
- *
92
- * @param fn - The callback function to be executed when the API call fails.
93
- * It receives an `Error` object as the first parameter and an optional `promptId` as the second parameter.
94
- * @returns The current instance of the CallWrapper.
95
- */
96
- onFailed(fn: (err: Error, promptId?: string) => void): this;
97
- /**
98
- * Set a callback function to be called when progress information is available.
99
- * @param fn - The callback function to be called with the progress information.
100
- * @returns The current instance of the CallWrapper.
101
- */
102
- onProgress(fn: (info: NodeProgress, promptId?: string) => void): this;
103
- /**
104
- * Run the call wrapper and returns the output of the executed job.
105
- * If the job is already cached, it returns the cached output.
106
- * If the job is not cached, it executes the job and returns the output.
107
- *
108
- * @returns A promise that resolves to the output of the executed job,
109
- * or `undefined` if the job is not found,
110
- * or `false` if the job execution fails.
111
- */
112
- run(): Promise<Record<keyof PromptBuilder<I, O, T>["mapOutputKeys"] | "_raw", any> | undefined | false>;
113
- private bypassWorkflowNodes;
114
- private enqueueJob;
115
- private handleCachedOutput;
116
- private mapOutput;
117
- private handleJobExecution;
118
- private reverseMapOutputKeys;
119
- private handleProgress;
120
- private handleError;
121
- private emitLog;
122
- private cleanupListeners;
123
- }
1
+ import { NodeData, NodeProgress } from "./types/api.js";
2
+ import { ComfyApi } from "./client.js";
3
+ import { PromptBuilder } from "./prompt-builder.js";
4
+ /**
5
+ * Represents a wrapper class for making API calls using the ComfyApi client.
6
+ * Provides methods for setting callback functions and executing the job.
7
+ */
8
+ export declare class CallWrapper<I extends string, O extends string, T extends NodeData> {
9
+ private client;
10
+ private prompt;
11
+ private started;
12
+ private isCompletingSuccessfully;
13
+ private promptId?;
14
+ private output;
15
+ private onPreviewFn?;
16
+ private onPreviewMetaFn?;
17
+ private onPendingFn?;
18
+ private onStartFn?;
19
+ private onOutputFn?;
20
+ private onFinishedFn?;
21
+ private onFailedFn?;
22
+ private onProgressFn?;
23
+ private onDisconnectedHandlerOffFn;
24
+ private checkExecutingOffFn;
25
+ private checkExecutedOffFn;
26
+ private progressHandlerOffFn;
27
+ private previewHandlerOffFn;
28
+ private executionHandlerOffFn;
29
+ private errorHandlerOffFn;
30
+ private executionEndSuccessOffFn;
31
+ private statusHandlerOffFn;
32
+ private interruptionHandlerOffFn;
33
+ /**
34
+ * Constructs a new CallWrapper instance.
35
+ * @param client The ComfyApi client.
36
+ * @param workflow The workflow object.
37
+ */
38
+ constructor(client: ComfyApi, workflow: PromptBuilder<I, O, T>);
39
+ /**
40
+ * Set the callback function to be called when a preview event occurs.
41
+ *
42
+ * @param fn - The callback function to be called. It receives a Blob object representing the event and an optional promptId string.
43
+ * @returns The current instance of the CallWrapper.
44
+ */
45
+ onPreview(fn: (ev: Blob, promptId?: string) => void): this;
46
+ /**
47
+ * Set the callback function to be called when a preview-with-metadata event occurs.
48
+ */
49
+ onPreviewMeta(fn: (payload: {
50
+ blob: Blob;
51
+ metadata: any;
52
+ }, promptId?: string) => void): this;
53
+ /**
54
+ * Set a callback function to be executed when the job is queued.
55
+ * @param {Function} fn - The callback function to be executed.
56
+ * @returns The current instance of the CallWrapper.
57
+ */
58
+ onPending(fn: (promptId?: string) => void): this;
59
+ /**
60
+ * Set the callback function to be executed when the job start.
61
+ *
62
+ * @param fn - The callback function to be executed. It can optionally receive a `promptId` parameter.
63
+ * @returns The current instance of the CallWrapper.
64
+ */
65
+ onStart(fn: (promptId?: string) => void): this;
66
+ /**
67
+ * Sets the callback function to handle the output node when the workflow is executing. This is
68
+ * useful when you want to handle the output of each nodes as they are being processed.
69
+ *
70
+ * All the nodes defined in the `mapOutputKeys` will be passed to this function when node is executed.
71
+ *
72
+ * @param fn - The callback function to handle the output.
73
+ * @returns The current instance of the class.
74
+ */
75
+ onOutput(fn: (key: keyof PromptBuilder<I, O, T>["mapOutputKeys"] | string | "_raw", data: any, promptId?: string) => void): this;
76
+ /**
77
+ * Set the callback function to be executed when the asynchronous operation is finished.
78
+ *
79
+ * @param fn - The callback function to be executed. It receives the data returned by the operation
80
+ * and an optional promptId parameter.
81
+ * @returns The current instance of the CallWrapper.
82
+ */
83
+ onFinished(fn: (data: Record<keyof PromptBuilder<I, O, T>["mapOutputKeys"], any> & {
84
+ /**
85
+ * The raw output data from the workflow execution.
86
+ * Key is node_id, value is node output.
87
+ */
88
+ _raw?: Record<string, any>;
89
+ }, promptId?: string) => void): this;
90
+ /**
91
+ * Set the callback function to be executed when the API call fails.
92
+ *
93
+ * @param fn - The callback function to be executed when the API call fails.
94
+ * It receives an `Error` object as the first parameter and an optional `promptId` as the second parameter.
95
+ * @returns The current instance of the CallWrapper.
96
+ */
97
+ onFailed(fn: (err: Error, promptId?: string) => void): this;
98
+ /**
99
+ * Set a callback function to be called when progress information is available.
100
+ * @param fn - The callback function to be called with the progress information.
101
+ * @returns The current instance of the CallWrapper.
102
+ */
103
+ onProgress(fn: (info: NodeProgress, promptId?: string) => void): this;
104
+ /**
105
+ * Run the call wrapper and returns the output of the executed job.
106
+ * If the job is already cached, it returns the cached output.
107
+ * If the job is not cached, it executes the job and returns the output.
108
+ *
109
+ * @returns A promise that resolves to the output of the executed job,
110
+ * or `undefined` if the job is not found,
111
+ * or `false` if the job execution fails.
112
+ */
113
+ run(): Promise<Record<keyof PromptBuilder<I, O, T>["mapOutputKeys"] | "_raw", any> | undefined | false>;
114
+ private bypassWorkflowNodes;
115
+ private enqueueJob;
116
+ private handleCachedOutput;
117
+ private mapOutput;
118
+ private handleJobExecution;
119
+ private reverseMapOutputKeys;
120
+ private handleProgress;
121
+ private handleError;
122
+ private emitLog;
123
+ private cleanupListeners;
124
+ }
124
125
  //# sourceMappingURL=call-wrapper.d.ts.map
package/dist/call-wrapper.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"call-wrapper.d.ts","sourceRoot":"","sources":["../src/call-wrapper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAW,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACjE,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAOpD;;;GAGG;AACH,qBAAa,WAAW,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,QAAQ;IAC7E,OAAO,CAAC,MAAM,CAAW;IACzB,OAAO,CAAC,MAAM,CAAyB;IACvC,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,QAAQ,CAAC,CAAS;IAC1B,OAAO,CAAC,MAAM,CAAkF;IAEhG,OAAO,CAAC,WAAW,CAAC,CAAwC;IAC5D,OAAO,CAAC,eAAe,CAAC,CAAsE;IAC9F,OAAO,CAAC,WAAW,CAAC,CAA8B;IAClD,OAAO,CAAC,SAAS,CAAC,CAA8B;IAChD,OAAO,CAAC,UAAU,CAAC,CAIT;IACV,OAAO,CAAC,YAAY,CAAC,CASX;IACV,OAAO,CAAC,UAAU,CAAC,CAA0C;IAC7D,OAAO,CAAC,YAAY,CAAC,CAAkD;IAEvE,OAAO,CAAC,0BAA0B,CAAM;IACxC,OAAO,CAAC,mBAAmB,CAAM;IACjC,OAAO,CAAC,kBAAkB,CAAM;IAChC,OAAO,CAAC,oBAAoB,CAAM;IAClC,OAAO,CAAC,mBAAmB,CAAM;IACjC,OAAO,CAAC,qBAAqB,CAAM;IACnC,OAAO,CAAC,iBAAiB,CAAM;IAC/B,OAAO,CAAC,wBAAwB,CAAM;IACtC,OAAO,CAAC,kBAAkB,CAAM;IAChC,OAAO,CAAC,wBAAwB,CAAM;IAEtC;;;;OAIG;gBACS,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAM9D;;;;;OAKG;IACH,SAAS,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,IAAI;IAKnD;;OAEG;IACH,aAAa,CAAC,EAAE,EAAE,CAAC,OAAO,EAAE;QAAE,IAAI,EAAE,IAAI,CAAC;QAAC,QAAQ,EAAE,GAAG,CAAA;KAAE,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,IAAI;IAKrF;;;;OAIG;IACH,SAAS,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,KAAK,IAAI;IAKzC;;;;;OAKG;IACH,OAAO,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,KAAK,IAAI;IAKvC;;;;;;;;OAQG;IACH,QAAQ,CACN,EAAE,EAAE,CACF,GAAG,EAAE,MAAM,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,eAAe,CAAC,GAAG,MAAM,GAAG,MAAM,EACpE,IAAI,EAAE,GAAG,EACT,QAAQ,CAAC,EAAE,MAAM,KACd,IAAI;IAMX;;;;;;OAMG;IACH,UAAU,CACR,EAAE,EAAE,CACF,IAAI,EAAE,MAAM,CAAC,MAAM,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,eAAe,CAAC,EAAE,GAAG,CAAC,GAAG;QACjE;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KAC5B,EACD,QAAQ,CAAC,EAAE,MAAM,KACd,IAAI;IAMX;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,IAAI;IAKpD;;;;OAIG;IACH,UAAU,CAAC,EAAE,EAAE,CAAC,IAAI,EAAE,YAAY,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,IAAI;IAK9D;;;;;;;;OAQG;IACG,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,eAAe,CAAC,GAAG,MAAM,EAAE,GAAG,CAAC,GAAG,SAAS,GAAG,KAAK,CAAC;YA2I/F,mBAAmB;YA+DnB,UAAU;YAkDV,kBAAkB;IAmDhC,OAAO,CAAC,SAAS;IAmBjB,OAAO,CAAC,kBAAkB;IAwG1B,OAAO,CAAC,oBAAoB;IAW5B,OAAO,CAAC,cAAc;IAQtB,OAAO,CAAC,WAAW;IAenB,OAAO,CAAC,OAAO;IAiBf,OAAO,CAAC,gBAAgB;CAwBzB"}
1
+ {"version":3,"file":"call-wrapper.d.ts","sourceRoot":"","sources":["../src/call-wrapper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAW,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACjE,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAOpD;;;GAGG;AACH,qBAAa,WAAW,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,QAAQ;IAC7E,OAAO,CAAC,MAAM,CAAW;IACzB,OAAO,CAAC,MAAM,CAAyB;IACvC,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,wBAAwB,CAAS;IACzC,OAAO,CAAC,QAAQ,CAAC,CAAS;IAC1B,OAAO,CAAC,MAAM,CAAkF;IAEhG,OAAO,CAAC,WAAW,CAAC,CAAwC;IAC5D,OAAO,CAAC,eAAe,CAAC,CAAsE;IAC9F,OAAO,CAAC,WAAW,CAAC,CAA8B;IAClD,OAAO,CAAC,SAAS,CAAC,CAA8B;IAChD,OAAO,CAAC,UAAU,CAAC,CAIT;IACV,OAAO,CAAC,YAAY,CAAC,CASX;IACV,OAAO,CAAC,UAAU,CAAC,CAA0C;IAC7D,OAAO,CAAC,YAAY,CAAC,CAAkD;IAEvE,OAAO,CAAC,0BAA0B,CAAM;IACxC,OAAO,CAAC,mBAAmB,CAAM;IACjC,OAAO,CAAC,kBAAkB,CAAM;IAChC,OAAO,CAAC,oBAAoB,CAAM;IAClC,OAAO,CAAC,mBAAmB,CAAM;IACjC,OAAO,CAAC,qBAAqB,CAAM;IACnC,OAAO,CAAC,iBAAiB,CAAM;IAC/B,OAAO,CAAC,wBAAwB,CAAM;IACtC,OAAO,CAAC,kBAAkB,CAAM;IAChC,OAAO,CAAC,wBAAwB,CAAM;IAEtC;;;;OAIG;gBACS,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAM9D;;;;;OAKG;IACH,SAAS,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,IAAI;IAKnD;;OAEG;IACH,aAAa,CAAC,EAAE,EAAE,CAAC,OAAO,EAAE;QAAE,IAAI,EAAE,IAAI,CAAC;QAAC,QAAQ,EAAE,GAAG,CAAA;KAAE,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,IAAI;IAKrF;;;;OAIG;IACH,SAAS,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,KAAK,IAAI;IAKzC;;;;;OAKG;IACH,OAAO,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,KAAK,IAAI;IAKvC;;;;;;;;OAQG;IACH,QAAQ,CACN,EAAE,EAAE,CACF,GAAG,EAAE,MAAM,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,eAAe,CAAC,GAAG,MAAM,GAAG,MAAM,EACpE,IAAI,EAAE,GAAG,EACT,QAAQ,CAAC,EAAE,MAAM,KACd,IAAI;IAMX;;;;;;OAMG;IACH,UAAU,CACR,EAAE,EAAE,CACF,IAAI,EAAE,MAAM,CAAC,MAAM,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,eAAe,CAAC,EAAE,GAAG,CAAC,GAAG;QACjE;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KAC5B,EACD,QAAQ,CAAC,EAAE,MAAM,KACd,IAAI;IAMX;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,IAAI;IAKpD;;;;OAIG;IACH,UAAU,CAAC,EAAE,EAAE,CAAC,IAAI,EAAE,YAAY,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,IAAI;IAK9D;;;;;;;;OAQG;IACG,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,eAAe,CAAC,GAAG,MAAM,EAAE,GAAG,CAAC,GAAG,SAAS,GAAG,KAAK,CAAC;YA2I/F,mBAAmB;YA+DnB,UAAU;YAyDV,kBAAkB;IAmDhC,OAAO,CAAC,SAAS;IAmBjB,OAAO,CAAC,kBAAkB;IA0G1B,OAAO,CAAC,oBAAoB;IAW5B,OAAO,CAAC,cAAc;IAQtB,OAAO,CAAC,WAAW;IAenB,OAAO,CAAC,OAAO;IAiBf,OAAO,CAAC,gBAAgB;CAwBzB"}