api.js 10.9 KB
Newer Older
pythongosssss's avatar
pythongosssss committed
1
class ComfyApi extends EventTarget {
2
3
	#registered = new Set();

pythongosssss's avatar
pythongosssss committed
4
	constructor() {
pythongosssss's avatar
pythongosssss committed
5
		super();
6
7
8
9
10
11
12
13
14
		this.api_host = location.host;
		this.api_base = location.pathname.split('/').slice(0, -1).join('/');
	}

	apiURL(route) {
		return this.api_base + route;
	}

	fetchApi(route, options) {
15
16
17
18
19
20
21
		if (!options) {
			options = {};
		}
		if (!options.headers) {
			options.headers = {};
		}
		options.headers["Comfy-User"] = this.user;
22
		return fetch(this.apiURL(route), options);
pythongosssss's avatar
pythongosssss committed
23
24
	}

25
26
27
28
29
	addEventListener(type, callback, options) {
		super.addEventListener(type, callback, options);
		this.#registered.add(type);
	}

pythongosssss's avatar
pythongosssss committed
30
31
32
	/**
	 * Poll status  for colab and other things that don't support websockets.
	 */
pythongosssss's avatar
pythongosssss committed
33
34
35
	#pollQueue() {
		setInterval(async () => {
			try {
36
				const resp = await this.fetchApi("/prompt");
pythongosssss's avatar
pythongosssss committed
37
38
39
40
41
42
43
44
				const status = await resp.json();
				this.dispatchEvent(new CustomEvent("status", { detail: status }));
			} catch (error) {
				this.dispatchEvent(new CustomEvent("status", { detail: null }));
			}
		}, 1000);
	}

pythongosssss's avatar
pythongosssss committed
45
46
47
48
	/**
	 * Creates and connects a WebSocket for realtime updates
	 * @param {boolean} isReconnect If the socket is connection is a reconnect attempt
	 */
pythongosssss's avatar
pythongosssss committed
49
50
51
52
53
54
	#createSocket(isReconnect) {
		if (this.socket) {
			return;
		}

		let opened = false;
55
		let existingSession = window.name;
56
57
58
59
		if (existingSession) {
			existingSession = "?clientId=" + existingSession;
		}
		this.socket = new WebSocket(
60
			`ws${window.location.protocol === "https:" ? "s" : ""}://${this.api_host}${this.api_base}/ws${existingSession}`
61
		);
space-nuko's avatar
space-nuko committed
62
		this.socket.binaryType = "arraybuffer";
pythongosssss's avatar
pythongosssss committed
63
64
65
66
67
68
69
70
71
72

		this.socket.addEventListener("open", () => {
			opened = true;
			if (isReconnect) {
				this.dispatchEvent(new CustomEvent("reconnected"));
			}
		});

		this.socket.addEventListener("error", () => {
			if (this.socket) this.socket.close();
pythongosssss's avatar
pythongosssss committed
73
			if (!isReconnect && !opened) {
74
75
				this.#pollQueue();
			}
pythongosssss's avatar
pythongosssss committed
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
		});

		this.socket.addEventListener("close", () => {
			setTimeout(() => {
				this.socket = null;
				this.#createSocket(true);
			}, 300);
			if (opened) {
				this.dispatchEvent(new CustomEvent("status", { detail: null }));
				this.dispatchEvent(new CustomEvent("reconnecting"));
			}
		});

		this.socket.addEventListener("message", (event) => {
			try {
space-nuko's avatar
space-nuko committed
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
				if (event.data instanceof ArrayBuffer) {
					const view = new DataView(event.data);
					const eventType = view.getUint32(0);
					const buffer = event.data.slice(4);
					switch (eventType) {
					case 1:
						const view2 = new DataView(event.data);
						const imageType = view2.getUint32(0)
						let imageMime
						switch (imageType) {
							case 1:
							default:
								imageMime = "image/jpeg";
								break;
							case 2:
								imageMime = "image/png"
pythongosssss's avatar
pythongosssss committed
107
						}
space-nuko's avatar
Fix  
space-nuko committed
108
109
						const imageBlob = new Blob([buffer.slice(4)], { type: imageMime });
						this.dispatchEvent(new CustomEvent("b_preview", { detail: imageBlob }));
110
						break;
pythongosssss's avatar
pythongosssss committed
111
					default:
space-nuko's avatar
space-nuko committed
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
						throw new Error(`Unknown binary websocket message of type ${eventType}`);
					}
				}
				else {
				    const msg = JSON.parse(event.data);
				    switch (msg.type) {
					    case "status":
						    if (msg.data.sid) {
							    this.clientId = msg.data.sid;
							    window.name = this.clientId;
						    }
						    this.dispatchEvent(new CustomEvent("status", { detail: msg.data.status }));
						    break;
					    case "progress":
						    this.dispatchEvent(new CustomEvent("progress", { detail: msg.data }));
						    break;
					    case "executing":
						    this.dispatchEvent(new CustomEvent("executing", { detail: msg.data.node }));
						    break;
					    case "executed":
						    this.dispatchEvent(new CustomEvent("executed", { detail: msg.data }));
						    break;
					    case "execution_start":
						    this.dispatchEvent(new CustomEvent("execution_start", { detail: msg.data }));
						    break;
					    case "execution_error":
						    this.dispatchEvent(new CustomEvent("execution_error", { detail: msg.data }));
						    break;
140
141
142
					    case "execution_cached":
						    this.dispatchEvent(new CustomEvent("execution_cached", { detail: msg.data }));
						    break;
space-nuko's avatar
space-nuko committed
143
144
145
146
147
148
149
					    default:
						    if (this.#registered.has(msg.type)) {
							    this.dispatchEvent(new CustomEvent(msg.type, { detail: msg.data }));
						    } else {
							    throw new Error(`Unknown message type ${msg.type}`);
						    }
				    }
pythongosssss's avatar
pythongosssss committed
150
151
				}
			} catch (error) {
space-nuko's avatar
space-nuko committed
152
				console.warn("Unhandled message:", event.data, error);
pythongosssss's avatar
pythongosssss committed
153
154
155
156
			}
		});
	}

pythongosssss's avatar
pythongosssss committed
157
158
159
	/**
	 * Initialises sockets and realtime updates
	 */
pythongosssss's avatar
pythongosssss committed
160
161
162
	init() {
		this.#createSocket();
	}
pythongosssss's avatar
pythongosssss committed
163

164
165
166
167
168
	/**
	 * Gets a list of extension urls
	 * @returns An array of script urls to import
	 */
	async getExtensions() {
169
		const resp = await this.fetchApi("/extensions", { cache: "no-store" });
170
171
172
		return await resp.json();
	}

173
174
175
176
177
	/**
	 * Gets a list of embedding names
	 * @returns An array of script urls to import
	 */
	async getEmbeddings() {
178
		const resp = await this.fetchApi("/embeddings", { cache: "no-store" });
179
180
181
		return await resp.json();
	}

pythongosssss's avatar
pythongosssss committed
182
183
184
185
	/**
	 * Loads node object definitions for the graph
	 * @returns The node definitions
	 */
pythongosssss's avatar
pythongosssss committed
186
	async getNodeDefs() {
187
		const resp = await this.fetchApi("/object_info", { cache: "no-store" });
pythongosssss's avatar
pythongosssss committed
188
189
190
		return await resp.json();
	}

pythongosssss's avatar
pythongosssss committed
191
192
193
194
195
	/**
	 *
	 * @param {number} number The index at which to queue the prompt, passing -1 will insert the prompt at the front of the queue
	 * @param {object} prompt The prompt data to queue
	 */
pythongosssss's avatar
pythongosssss committed
196
197
198
199
200
201
202
203
204
205
206
207
208
	async queuePrompt(number, { output, workflow }) {
		const body = {
			client_id: this.clientId,
			prompt: output,
			extra_data: { extra_pnginfo: { workflow } },
		};

		if (number === -1) {
			body.front = true;
		} else if (number != 0) {
			body.number = number;
		}

209
		const res = await this.fetchApi("/prompt", {
pythongosssss's avatar
pythongosssss committed
210
211
212
213
214
215
216
217
218
			method: "POST",
			headers: {
				"Content-Type": "application/json",
			},
			body: JSON.stringify(body),
		});

		if (res.status !== 200) {
			throw {
219
				response: await res.json(),
pythongosssss's avatar
pythongosssss committed
220
221
			};
		}
222
223

		return await res.json();
pythongosssss's avatar
pythongosssss committed
224
	}
pythongosssss's avatar
pythongosssss committed
225

pythongosssss's avatar
pythongosssss committed
226
227
228
229
230
	/**
	 * Loads a list of items (queue or history)
	 * @param {string} type The type of items to load, queue or history
	 * @returns The items of the specified type grouped by their status
	 */
pythongosssss's avatar
pythongosssss committed
231
232
233
234
235
236
237
	async getItems(type) {
		if (type === "queue") {
			return this.getQueue();
		}
		return this.getHistory();
	}

pythongosssss's avatar
pythongosssss committed
238
239
240
241
	/**
	 * Gets the current state of the queue
	 * @returns The currently running and queued items
	 */
pythongosssss's avatar
pythongosssss committed
242
243
	async getQueue() {
		try {
244
			const res = await this.fetchApi("/queue");
pythongosssss's avatar
pythongosssss committed
245
246
247
			const data = await res.json();
			return {
				// Running action uses a different endpoint for cancelling
pythongosssss's avatar
pythongosssss committed
248
249
250
251
				Running: data.queue_running.map((prompt) => ({
					prompt,
					remove: { name: "Cancel", cb: () => api.interrupt() },
				})),
pythongosssss's avatar
pythongosssss committed
252
253
254
255
256
257
258
259
				Pending: data.queue_pending.map((prompt) => ({ prompt })),
			};
		} catch (error) {
			console.error(error);
			return { Running: [], Pending: [] };
		}
	}

pythongosssss's avatar
pythongosssss committed
260
261
262
263
	/**
	 * Gets the prompt execution history
	 * @returns Prompt history including node outputs
	 */
264
	async getHistory(max_items=200) {
pythongosssss's avatar
pythongosssss committed
265
		try {
266
			const res = await this.fetchApi(`/history?max_items=${max_items}`);
pythongosssss's avatar
pythongosssss committed
267
268
269
270
271
272
273
			return { History: Object.values(await res.json()) };
		} catch (error) {
			console.error(error);
			return { History: [] };
		}
	}

pythongosssss's avatar
pythongosssss committed
274
275
276
277
278
279
280
281
282
	/**
	 * Gets system & device stats
	 * @returns System stats such as python version, OS, per device info
	 */
	async getSystemStats() {
		const res = await this.fetchApi("/system_stats");
		return await res.json();
	}

pythongosssss's avatar
pythongosssss committed
283
284
285
286
287
	/**
	 * Sends a POST request to the API
	 * @param {*} type The endpoint to post to
	 * @param {*} body Optional POST data
	 */
pythongosssss's avatar
pythongosssss committed
288
289
	async #postItem(type, body) {
		try {
290
			await this.fetchApi("/" + type, {
pythongosssss's avatar
pythongosssss committed
291
292
293
294
295
296
297
298
299
300
301
				method: "POST",
				headers: {
					"Content-Type": "application/json",
				},
				body: body ? JSON.stringify(body) : undefined,
			});
		} catch (error) {
			console.error(error);
		}
	}

pythongosssss's avatar
pythongosssss committed
302
303
304
305
306
	/**
	 * Deletes an item from the specified list
	 * @param {string} type The type of item to delete, queue or history
	 * @param {number} id The id of the item to delete
	 */
pythongosssss's avatar
pythongosssss committed
307
308
309
310
	async deleteItem(type, id) {
		await this.#postItem(type, { delete: [id] });
	}

pythongosssss's avatar
pythongosssss committed
311
312
313
314
	/**
	 * Clears the specified list
	 * @param {string} type The type of list to clear, queue or history
	 */
pythongosssss's avatar
pythongosssss committed
315
316
317
318
	async clearItems(type) {
		await this.#postItem(type, { clear: true });
	}

pythongosssss's avatar
pythongosssss committed
319
320
321
	/**
	 * Interrupts the execution of the running prompt
	 */
pythongosssss's avatar
pythongosssss committed
322
323
324
	async interrupt() {
		await this.#postItem("interrupt", null);
	}
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417

	/**
	 * Gets user configuration data and where data should be stored
	 * @returns { Promise<{ storage: "server" | "browser", users?: Promise<string, unknown>, migrated?: boolean }> } 
	 */
	async getUserConfig() {
		return (await this.fetchApi("/users")).json();
	}

	/**
	 * Creates a new user
	 * @param { string } username 
	 * @returns The fetch response
	 */
	createUser(username) {
		return this.fetchApi("/users", {
			method: "POST",
			headers: {
				"Content-Type": "application/json",
			},
			body: JSON.stringify({ username }),
		});
	}

	/**
	 * Gets all setting values for the current user
	 * @returns { Promise<string, unknown> } A dictionary of id -> value
	 */
	async getSettings() {
		return (await this.fetchApi("/settings")).json();
	}

	/**
	 * Gets a setting for the current user
	 * @param { string } id The id of the setting to fetch
	 * @returns { Promise<unknown> } The setting value
	 */
	async getSetting(id) {
		return (await this.fetchApi(`/settings/${encodeURIComponent(id)}`)).json();
	}

	/**
	 * Stores a dictionary of settings for the current user
	 * @param { Record<string, unknown> } settings Dictionary of setting id -> value to save
	 * @returns { Promise<void> }
	 */
	async storeSettings(settings) {
		return this.fetchApi(`/settings`, {
			method: "POST",
			body: JSON.stringify(settings)
		});
	}

	/**
	 * Stores a setting for the current user
	 * @param { string } id The id of the setting to update
	 * @param { unknown } value The value of the setting
	 * @returns { Promise<void> }
	 */
	async storeSetting(id, value) {
		return this.fetchApi(`/settings/${encodeURIComponent(id)}`, {
			method: "POST",
			body: JSON.stringify(value)
		});
	}

	/**
	 * Gets a user data file for the current user
	 * @param { string } file The name of the userdata file to load
	 * @param { RequestInit } [options]
	 * @returns { Promise<unknown> } The fetch response object
	 */
	async getUserData(file, options) {
		return this.fetchApi(`/userdata/${encodeURIComponent(file)}`, options);
	}

	/**
	 * Stores a user data file for the current user
	 * @param { string } file The name of the userdata file to save
	 * @param { unknown } data The data to save to the file
	 * @param { RequestInit & { stringify?: boolean, throwOnError?: boolean } } [options]
	 * @returns { Promise<void> }
	 */
	async storeUserData(file, data, options = { stringify: true, throwOnError: true }) {
		const resp = await this.fetchApi(`/userdata/${encodeURIComponent(file)}`, {
			method: "POST",
			body: options?.stringify ? JSON.stringify(data) : data,
			...options,
		});	
		if (resp.status !== 200) {
			throw new Error(`Error storing user data file '${file}': ${resp.status} ${(await resp).statusText}`);
		}
	}
pythongosssss's avatar
pythongosssss committed
418
419
420
}

export const api = new ComfyApi();