@comfyorg/comfyui-frontend-types 1.17.9 → 1.17.10

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 (2) hide show
  1. package/index.d.ts +14 -2
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -226,6 +226,19 @@ export declare class ComfyApi extends EventTarget {
226
226
  user: string;
227
227
  socket: WebSocket | null;
228
228
  reportedUnknownMessageTypes: Set<string>;
229
+ /**
230
+ * The auth token for the comfy org account if the user is logged in.
231
+ * This is only used for {@link queuePrompt} now. It is not directly
232
+ * passed as parameter to the function because some custom nodes are hijacking
233
+ * {@link queuePrompt} improperly, which causes extra parameters to be lost
234
+ * in the function call chain.
235
+ *
236
+ * Ref: https://cs.comfy.org/search?q=context:global+%22api.queuePrompt+%3D%22&patternType=keyword&sm=0
237
+ *
238
+ * TODO: Move this field to parameter of {@link queuePrompt} once all
239
+ * custom nodes are patched.
240
+ */
241
+ authToken?: string;
229
242
  constructor();
230
243
  internalURL(route: string): string;
231
244
  apiURL(route: string): string;
@@ -275,13 +288,12 @@ export declare class ComfyApi extends EventTarget {
275
288
  * Queues a prompt to be executed
276
289
  * @param {number} number The index at which to queue the prompt, passing -1 will insert the prompt at the front of the queue
277
290
  * @param {object} prompt The prompt data to queue
278
- * @param {string} authToken The auth token for the comfy org account if the user is logged in
279
291
  * @throws {PromptExecutionError} If the prompt fails to execute
280
292
  */
281
293
  queuePrompt(number: number, data: {
282
294
  output: ComfyApiWorkflow;
283
295
  workflow: ComfyWorkflowJSON;
284
- }, authToken?: string): Promise<PromptResponse>;
296
+ }): Promise<PromptResponse>;
285
297
  /**
286
298
  * Gets a list of model folder keys (eg ['checkpoints', 'loras', ...])
287
299
  * @returns The list of model folder keys
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@comfyorg/comfyui-frontend-types",
3
- "version": "1.17.9",
3
+ "version": "1.17.10",
4
4
  "types": "./index.d.ts",
5
5
  "files": [
6
6
  "index.d.ts"