api.js 8.08 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
15
		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) {
		return fetch(this.apiURL(route), options);
pythongosssss's avatar
pythongosssss committed
16
17
	}

18
19
20
21
22
	addEventListener(type, callback, options) {
		super.addEventListener(type, callback, options);
		this.#registered.add(type);
	}

pythongosssss's avatar
pythongosssss committed
23
24
25
	/**
	 * Poll status  for colab and other things that don't support websockets.
	 */
pythongosssss's avatar
pythongosssss committed
26
27
28
	#pollQueue() {
		setInterval(async () => {
			try {
29
				const resp = await this.fetchApi("/prompt");
pythongosssss's avatar
pythongosssss committed
30
31
32
33
34
35
36
37
				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
38
39
40
41
	/**
	 * 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
42
43
44
45
46
47
	#createSocket(isReconnect) {
		if (this.socket) {
			return;
		}

		let opened = false;
48
		let existingSession = window.name;
49
50
51
52
		if (existingSession) {
			existingSession = "?clientId=" + existingSession;
		}
		this.socket = new WebSocket(
53
			`ws${window.location.protocol === "https:" ? "s" : ""}://${this.api_host}${this.api_base}/ws${existingSession}`
54
		);
space-nuko's avatar
space-nuko committed
55
		this.socket.binaryType = "arraybuffer";
pythongosssss's avatar
pythongosssss committed
56
57
58
59
60
61
62
63
64
65

		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
66
			if (!isReconnect && !opened) {
67
68
				this.#pollQueue();
			}
pythongosssss's avatar
pythongosssss committed
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
		});

		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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
				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
100
						}
space-nuko's avatar
Fix  
space-nuko committed
101
102
						const imageBlob = new Blob([buffer.slice(4)], { type: imageMime });
						this.dispatchEvent(new CustomEvent("b_preview", { detail: imageBlob }));
103
						break;
pythongosssss's avatar
pythongosssss committed
104
					default:
space-nuko's avatar
space-nuko committed
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
						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;
133
134
135
					    case "execution_cached":
						    this.dispatchEvent(new CustomEvent("execution_cached", { detail: msg.data }));
						    break;
space-nuko's avatar
space-nuko committed
136
137
138
139
140
141
142
					    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
143
144
				}
			} catch (error) {
space-nuko's avatar
space-nuko committed
145
				console.warn("Unhandled message:", event.data, error);
pythongosssss's avatar
pythongosssss committed
146
147
148
149
			}
		});
	}

pythongosssss's avatar
pythongosssss committed
150
151
152
	/**
	 * Initialises sockets and realtime updates
	 */
pythongosssss's avatar
pythongosssss committed
153
154
155
	init() {
		this.#createSocket();
	}
pythongosssss's avatar
pythongosssss committed
156

157
158
159
160
161
	/**
	 * Gets a list of extension urls
	 * @returns An array of script urls to import
	 */
	async getExtensions() {
162
		const resp = await this.fetchApi("/extensions", { cache: "no-store" });
163
164
165
		return await resp.json();
	}

166
167
168
169
170
	/**
	 * Gets a list of embedding names
	 * @returns An array of script urls to import
	 */
	async getEmbeddings() {
171
		const resp = await this.fetchApi("/embeddings", { cache: "no-store" });
172
173
174
		return await resp.json();
	}

pythongosssss's avatar
pythongosssss committed
175
176
177
178
	/**
	 * Loads node object definitions for the graph
	 * @returns The node definitions
	 */
pythongosssss's avatar
pythongosssss committed
179
	async getNodeDefs() {
180
		const resp = await this.fetchApi("/object_info", { cache: "no-store" });
pythongosssss's avatar
pythongosssss committed
181
182
183
		return await resp.json();
	}

pythongosssss's avatar
pythongosssss committed
184
185
186
187
188
	/**
	 *
	 * @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
189
190
191
192
193
194
195
196
197
198
199
200
201
	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;
		}

202
		const res = await this.fetchApi("/prompt", {
pythongosssss's avatar
pythongosssss committed
203
204
205
206
207
208
209
210
211
			method: "POST",
			headers: {
				"Content-Type": "application/json",
			},
			body: JSON.stringify(body),
		});

		if (res.status !== 200) {
			throw {
212
				response: await res.json(),
pythongosssss's avatar
pythongosssss committed
213
214
			};
		}
215
216

		return await res.json();
pythongosssss's avatar
pythongosssss committed
217
	}
pythongosssss's avatar
pythongosssss committed
218

pythongosssss's avatar
pythongosssss committed
219
220
221
222
223
	/**
	 * 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
224
225
226
227
228
229
230
	async getItems(type) {
		if (type === "queue") {
			return this.getQueue();
		}
		return this.getHistory();
	}

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

pythongosssss's avatar
pythongosssss committed
253
254
255
256
	/**
	 * Gets the prompt execution history
	 * @returns Prompt history including node outputs
	 */
pythongosssss's avatar
pythongosssss committed
257
258
	async getHistory() {
		try {
259
			const res = await this.fetchApi("/history?max_items=200");
pythongosssss's avatar
pythongosssss committed
260
261
262
263
264
265
266
			return { History: Object.values(await res.json()) };
		} catch (error) {
			console.error(error);
			return { History: [] };
		}
	}

pythongosssss's avatar
pythongosssss committed
267
268
269
270
271
272
273
274
275
	/**
	 * 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
276
277
278
279
280
	/**
	 * Sends a POST request to the API
	 * @param {*} type The endpoint to post to
	 * @param {*} body Optional POST data
	 */
pythongosssss's avatar
pythongosssss committed
281
282
	async #postItem(type, body) {
		try {
283
			await this.fetchApi("/" + type, {
pythongosssss's avatar
pythongosssss committed
284
285
286
287
288
289
290
291
292
293
294
				method: "POST",
				headers: {
					"Content-Type": "application/json",
				},
				body: body ? JSON.stringify(body) : undefined,
			});
		} catch (error) {
			console.error(error);
		}
	}

pythongosssss's avatar
pythongosssss committed
295
296
297
298
299
	/**
	 * 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
300
301
302
303
	async deleteItem(type, id) {
		await this.#postItem(type, { delete: [id] });
	}

pythongosssss's avatar
pythongosssss committed
304
305
306
307
	/**
	 * Clears the specified list
	 * @param {string} type The type of list to clear, queue or history
	 */
pythongosssss's avatar
pythongosssss committed
308
309
310
311
	async clearItems(type) {
		await this.#postItem(type, { clear: true });
	}

pythongosssss's avatar
pythongosssss committed
312
313
314
	/**
	 * Interrupts the execution of the running prompt
	 */
pythongosssss's avatar
pythongosssss committed
315
316
317
	async interrupt() {
		await this.#postItem("interrupt", null);
	}
pythongosssss's avatar
pythongosssss committed
318
319
320
}

export const api = new ComfyApi();