@tscomfy/client 0.0.0-stage → 0.1.2

package/dist/event-queue.js

@@ -0,0 +1,66 @@
+/**
+ * Events of these types are snapshots: a newer one of a node replaces its unread one. Progress
+ * text isn't: each says something different ("Downloading…", "Generating…").
+ */
+const COALESCED = new Set(["progress", "preview"]);
+/**
+ * A job's events, for one consumer. Buffered from the start, so none is missed before the
+ * consumer starts reading; while it lags, a newer progress or preview of a node replaces the
+ * unread one where it stands, so the buffer stays bounded by the number of nodes and keeps its
+ * order.
+ */
+export class EventQueue {
+    #buffer = [];
+    /** `next()` calls waiting for an event, in the order they were made. */
+    #waiting = [];
+    #ended = false;
+    #taken = false;
+    /** Adds an event, unless the queue has ended or its consumer stopped. */
+    push(event) {
+        if (this.#ended)
+            return;
+        const waiting = this.#waiting.shift();
+        if (waiting !== undefined) {
+            waiting({ done: false, value: event });
+            return;
+        }
+        if (COALESCED.has(event.type) && "node" in event) {
+            const stale = this.#buffer.findIndex((queued) => queued.type === event.type && "node" in queued && queued.node === event.node);
+            if (stale !== -1) {
+                this.#buffer[stale] = event;
+                return;
+            }
+        }
+        this.#buffer.push(event);
+    }
+    /** Ends the queue: the consumer reads what is buffered, then stops. */
+    end() {
+        this.#ended = true;
+        for (const waiting of this.#waiting.splice(0))
+            waiting({ done: true, value: undefined });
+    }
+    [Symbol.asyncIterator]() {
+        if (this.#taken)
+            throw new TypeError("job.events can be iterated only once");
+        this.#taken = true;
+        return {
+            next: () => {
+                const event = this.#buffer.shift();
+                if (event !== undefined)
+                    return Promise.resolve({ done: false, value: event });
+                if (this.#ended)
+                    return Promise.resolve({ done: true, value: undefined });
+                return new Promise((resolve) => {
+                    this.#waiting.push(resolve);
+                });
+            },
+            return: () => {
+                // The consumer stopped (`break`): drop the buffer and what comes later.
+                this.#buffer.length = 0;
+                this.end();
+                return Promise.resolve({ done: true, value: undefined });
+            },
+        };
+    }
+}
+//# sourceMappingURL=event-queue.js.map

package/dist/event-queue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-queue.js","sourceRoot":"","sources":["../src/event-queue.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,MAAM,SAAS,GAAkC,IAAI,GAAG,CAAC,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC;AAIlF;;;;;GAKG;AACH,MAAM,OAAO,UAAU;IACZ,OAAO,GAAe,EAAE,CAAC;IAClC,wEAAwE;IAC/D,QAAQ,GAAa,EAAE,CAAC;IACjC,MAAM,GAAG,KAAK,CAAC;IACf,MAAM,GAAG,KAAK,CAAC;IAEf,yEAAyE;IACzE,IAAI,CAAC,KAAe;QAClB,IAAI,IAAI,CAAC,MAAM;YAAE,OAAO;QACxB,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QACtC,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,OAAO,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;YACvC,OAAO;QACT,CAAC;QACD,IAAI,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,MAAM,IAAI,KAAK,EAAE,CAAC;YACjD,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAClC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CACzF,CAAC;YACF,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;gBACjB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC;gBAC5B,OAAO;YACT,CAAC;QACH,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAED,uEAAuE;IACvE,GAAG;QACD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACnB,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;YAAE,OAAO,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED,CAAC,MAAM,CAAC,aAAa,CAAC;QACpB,IAAI,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,SAAS,CAAC,sCAAsC,CAAC,CAAC;QAC7E,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACnB,OAAO;YACL,IAAI,EAAE,GAAG,EAAE;gBACT,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;gBACnC,IAAI,KAAK,KAAK,SAAS;oBAAE,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;gBAC/E,IAAI,IAAI,CAAC,MAAM;oBAAE,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;gBAC1E,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;oBAC7B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAC9B,CAAC,CAAC,CAAC;YACL,CAAC;YACD,MAAM,EAAE,GAAG,EAAE;gBACX,wEAAwE;gBACxE,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;gBACxB,IAAI,CAAC,GAAG,EAAE,CAAC;gBACX,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;YAC3D,CAAC;SACF,CAAC;IACJ,CAAC;CACF"}

package/dist/events.d.ts

@@ -0,0 +1,60 @@
+import type { NodeId } from "@tscomfy/core";
+import type { NodeOutput } from "./outputs.ts";
+/** The server started running the job. */
+export interface StartedEvent {
+    readonly type: "started";
+}
+/** Nodes whose cached results the run reuses instead of running them. */
+export interface CachedEvent {
+    readonly type: "cached";
+    readonly nodes: readonly NodeId[];
+}
+/** A node started running. */
+export interface ExecutingEvent {
+    readonly type: "executing";
+    readonly node: NodeId;
+}
+/** A running node's progress: `value` of `max` (sampler steps, say). */
+export interface ProgressEvent {
+    readonly type: "progress";
+    readonly node: NodeId;
+    readonly value: number;
+    readonly max: number;
+}
+/**
+ * A live preview from a running node: a sampler's latent preview (a JPEG at most 512 pixels on a
+ * side, sent when the job asks for previews with `previews` in {@link SubmitOptions}, or the
+ * server was started with `--preview-method`), or a `SaveImageWebsocket` image (a full-size PNG,
+ * always sent).
+ */
+export interface PreviewEvent {
+    readonly type: "preview";
+    readonly node: NodeId;
+    /** `image/jpeg` or `image/png`. */
+    readonly mime: string;
+    readonly bytes: Uint8Array<ArrayBuffer>;
+}
+/** A node finished and reported output (files, text). */
+export interface OutputEvent {
+    readonly type: "output";
+    readonly node: NodeId;
+    readonly output: NodeOutput;
+}
+/** Progress text from a running node (partner nodes report their status this way). */
+export interface TextEvent {
+    readonly type: "text";
+    readonly node: NodeId;
+    readonly text: string;
+}
+/**
+ * A node blocked execution with a message. The run continues without what depends on it; the
+ * outcome also lists it, as a `W_NODE_BLOCKED` diagnostic.
+ */
+export interface BlockedEvent {
+    readonly type: "blocked";
+    readonly node: NodeId;
+    readonly message: string;
+}
+/** What a job reports while it runs. Node ids are the prompt's (the builder's) ids. */
+export type JobEvent = StartedEvent | CachedEvent | ExecutingEvent | ProgressEvent | PreviewEvent | OutputEvent | TextEvent | BlockedEvent;
+//# sourceMappingURL=events.d.ts.map

package/dist/events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,0CAA0C;AAC1C,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;CAC1B;AAED,yEAAyE;AACzE,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;CACnC;AAED,8BAA8B;AAC9B,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED,wEAAwE;AACxE,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;CACtB;AAED;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,mCAAmC;IACnC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;CACzC;AAED,yDAAyD;AACzD,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;CAC7B;AAED,sFAAsF;AACtF,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED,uFAAuF;AACvF,MAAM,MAAM,QAAQ,GAChB,YAAY,GACZ,WAAW,GACX,cAAc,GACd,aAAa,GACb,YAAY,GACZ,WAAW,GACX,SAAS,GACT,YAAY,CAAC"}

package/dist/events.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=events.js.map

package/dist/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":""}

package/dist/files.d.ts

@@ -0,0 +1,55 @@
+import type { FileRef, FolderType } from "./outputs.ts";
+import type { Server } from "./server.ts";
+/** A file to upload. */
+export interface UploadSource {
+    /** The file name to store it under. */
+    readonly name: string;
+    readonly bytes: Uint8Array;
+    /** Its media type, such as `image/png`. */
+    readonly mime?: string;
+}
+/** Options for {@link uploadFile}. */
+export interface UploadOptions {
+    /** A folder under the target directory. */
+    readonly subfolder?: string;
+    /** The directory: `input` (default), `temp` or `output`. */
+    readonly type?: FolderType;
+    /** Replace a file of the same name. Otherwise the server keeps both, renaming the new one. */
+    readonly overwrite?: boolean;
+    readonly signal?: AbortSignal;
+}
+/** An uploaded file, as the server stored it. */
+export interface UploadedFile extends FileRef {
+    /**
+     * The value a loader node's file input takes (`LoadImage`'s `image`): `subfolder/name`, with
+     * ` [temp]` or ` [output]` after it outside the input directory.
+     */
+    readonly value: string;
+}
+/**
+ * Uploads a file (an image, video or audio for a loader node) through `/upload/image`. The
+ * stored name can differ from `source.name`: without `overwrite`, the server renames a file whose
+ * name is taken by different content. Rejects with a {@link ClientError} if the server refuses.
+ */
+export declare function uploadFile(server: Server, source: UploadSource, options?: UploadOptions): Promise<UploadedFile>;
+/** A downloaded file. */
+export interface FileData {
+    readonly bytes: Uint8Array<ArrayBuffer>;
+    /** The server's `Content-Type`; `application/octet-stream` when it sent none. */
+    readonly mime: string;
+}
+/** Options for {@link fetchFile}. */
+export interface FetchFileOptions {
+    readonly signal?: AbortSignal;
+}
+/**
+ * Downloads a file the server has, such as an output, through `/view`. Rejects with a
+ * {@link ClientError} if the server doesn't have it.
+ */
+export declare function fetchFile(server: Server, file: FileRef, options?: FetchFileOptions): Promise<FileData>;
+/**
+ * The URL `/view` serves a file at, for `<img src>` on a page the server allows (same origin, or
+ * `--enable-cors-header`). It carries the server URL's query, so a token in it is in the result.
+ */
+export declare function fileUrl(server: Server, file: FileRef): string;
+//# sourceMappingURL=files.d.ts.map

package/dist/files.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"files.d.ts","sourceRoot":"","sources":["../src/files.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAExD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAG1C,wBAAwB;AACxB,MAAM,WAAW,YAAY;IAC3B,uCAAuC;IACvC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC;IAC3B,2CAA2C;IAC3C,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,sCAAsC;AACtC,MAAM,WAAW,aAAa;IAC5B,2CAA2C;IAC3C,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,4DAA4D;IAC5D,QAAQ,CAAC,IAAI,CAAC,EAAE,UAAU,CAAC;IAC3B,8FAA8F;IAC9F,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC;CAC/B;AAED,iDAAiD;AACjD,MAAM,WAAW,YAAa,SAAQ,OAAO;IAC3C;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAED;;;;GAIG;AACH,wBAAsB,UAAU,CAC9B,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,YAAY,EACpB,OAAO,GAAE,aAAkB,GAC1B,OAAO,CAAC,YAAY,CAAC,CA2BvB;AAED,yBAAyB;AACzB,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;IACxC,iFAAiF;IACjF,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED,qCAAqC;AACrC,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC;CAC/B;AAED;;;GAGG;AACH,wBAAsB,SAAS,CAC7B,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,OAAO,EACb,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,QAAQ,CAAC,CAYnB;AAED;;;GAGG;AACH,wBAAgB,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,MAAM,CAE7D"}

package/dist/files.js

@@ -0,0 +1,69 @@
+import { ClientError } from "./client-error.js";
+import { readObject, send, unexpected } from "./http.js";
+import { isFolderType } from "./read-outputs.js";
+import { baseUrl, endpoint } from "./url.js";
+/**
+ * Uploads a file (an image, video or audio for a loader node) through `/upload/image`. The
+ * stored name can differ from `source.name`: without `overwrite`, the server renames a file whose
+ * name is taken by different content. Rejects with a {@link ClientError} if the server refuses.
+ */
+export async function uploadFile(server, source, options = {}) {
+    const form = new FormData();
+    const blob = new Blob([new Uint8Array(source.bytes)], { type: source.mime ?? "" });
+    form.append("image", blob, source.name);
+    form.append("type", options.type ?? "input");
+    if (options.subfolder !== undefined)
+        form.append("subfolder", options.subfolder);
+    if (options.overwrite === true)
+        form.append("overwrite", "true");
+    const response = await send(server, {
+        method: "POST",
+        path: "upload/image",
+        body: form,
+        signal: options.signal,
+    });
+    if (!response.ok)
+        throw await unexpected(response);
+    const answer = await readObject(response);
+    const { name, subfolder, type } = answer;
+    if (typeof name !== "string" || !isFolderType(type)) {
+        throw new ClientError("The server's answer to an upload has no file name or folder");
+    }
+    const folder = typeof subfolder === "string" ? subfolder : "";
+    const path = folder === "" ? name : `${folder}/${name}`;
+    return Object.freeze({
+        filename: name,
+        subfolder: folder,
+        type,
+        value: type === "input" ? path : `${path} [${type}]`,
+    });
+}
+/**
+ * Downloads a file the server has, such as an output, through `/view`. Rejects with a
+ * {@link ClientError} if the server doesn't have it.
+ */
+export async function fetchFile(server, file, options = {}) {
+    const response = await send(server, {
+        method: "GET",
+        path: "view",
+        query: viewQuery(file),
+        signal: options.signal,
+    });
+    if (!response.ok)
+        throw await unexpected(response);
+    return Object.freeze({
+        bytes: new Uint8Array(await response.arrayBuffer()),
+        mime: response.headers.get("content-type") ?? "application/octet-stream",
+    });
+}
+/**
+ * The URL `/view` serves a file at, for `<img src>` on a page the server allows (same origin, or
+ * `--enable-cors-header`). It carries the server URL's query, so a token in it is in the result.
+ */
+export function fileUrl(server, file) {
+    return endpoint(baseUrl(server), "view", viewQuery(file)).href;
+}
+function viewQuery(file) {
+    return { filename: file.filename, subfolder: file.subfolder, type: file.type };
+}
+//# sourceMappingURL=files.js.map

package/dist/files.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"files.js","sourceRoot":"","sources":["../src/files.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAEzD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AA+B7C;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,MAAc,EACd,MAAoB,EACpB,OAAO,GAAkB,EAAE;IAE3B,MAAM,IAAI,GAAG,IAAI,QAAQ,EAAE,CAAC;IAC5B,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,IAAI,EAAE,EAAE,CAAC,CAAC;IACnF,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;IACxC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,CAAC;IAC7C,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS;QAAE,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;IACjF,IAAI,OAAO,CAAC,SAAS,KAAK,IAAI;QAAE,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IACjE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,EAAE;QAClC,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,cAAc;QACpB,IAAI,EAAE,IAAI;QACV,MAAM,EAAE,OAAO,CAAC,MAAM;KACvB,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE;QAAE,MAAM,MAAM,UAAU,CAAC,QAAQ,CAAC,CAAC;IACnD,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC1C,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC;IACzC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;QACpD,MAAM,IAAI,WAAW,CAAC,6DAA6D,CAAC,CAAC;IACvF,CAAC;IACD,MAAM,MAAM,GAAG,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9D,MAAM,IAAI,GAAG,MAAM,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,IAAI,EAAE,CAAC;IACxD,OAAO,MAAM,CAAC,MAAM,CAAC;QACnB,QAAQ,EAAE,IAAI;QACd,SAAS,EAAE,MAAM;QACjB,IAAI;QACJ,KAAK,EAAE,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,KAAK,IAAI,GAAG;KACrD,CAAC,CAAC;AACL,CAAC;AAcD;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,MAAc,EACd,IAAa,EACb,OAAO,GAAqB,EAAE;IAE9B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,EAAE;QAClC,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,MAAM;QACZ,KAAK,EAAE,SAAS,CAAC,IAAI,CAAC;QACtB,MAAM,EAAE,OAAO,CAAC,MAAM;KACvB,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE;QAAE,MAAM,MAAM,UAAU,CAAC,QAAQ,CAAC,CAAC;IACnD,OAAO,MAAM,CAAC,MAAM,CAAC;QACnB,KAAK,EAAE,IAAI,UAAU,CAAC,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAC;QACnD,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,0BAA0B;KACzE,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,OAAO,CAAC,MAAc,EAAE,IAAa;IACnD,OAAO,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;AACjE,CAAC;AAED,SAAS,SAAS,CAAC,IAAa;IAC9B,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC;AACjF,CAAC"}

package/dist/frames.d.ts

@@ -0,0 +1,24 @@
+import { type NodeId } from "@tscomfy/core";
+/** A preview image: binary type 4, which carries the node and prompt it belongs to. */
+export interface PreviewFrame {
+    readonly kind: "preview";
+    readonly promptId: string;
+    readonly node: NodeId;
+    readonly mime: string;
+    readonly bytes: Uint8Array<ArrayBuffer>;
+}
+/** Progress text: binary type 3. Only newer servers say which prompt it belongs to. */
+export interface TextFrame {
+    readonly kind: "text";
+    readonly promptId: string | undefined;
+    readonly node: NodeId;
+    readonly text: string;
+}
+/**
+ * Decodes a binary websocket frame: a big-endian `uint32` type, then the payload. Type 1 (a
+ * preview without ids) isn't decoded: the client asks for type 4 instead, and an unattributed
+ * image can't be given to a job. Unknown types and malformed frames give `undefined`.
+ * `textHasPromptId` is the server's `supports_progress_text_metadata` flag.
+ */
+export declare function decodeFrame(data: ArrayBuffer, textHasPromptId: boolean): PreviewFrame | TextFrame | undefined;
+//# sourceMappingURL=frames.d.ts.map

package/dist/frames.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"frames.d.ts","sourceRoot":"","sources":["../src/frames.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAS,MAAM,eAAe,CAAC;AAGnD,uFAAuF;AACvF,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;CACzC;AAED,uFAAuF;AACvF,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAKD;;;;;GAKG;AACH,wBAAgB,WAAW,CACzB,IAAI,EAAE,WAAW,EACjB,eAAe,EAAE,OAAO,GACvB,YAAY,GAAG,SAAS,GAAG,SAAS,CAOtC"}

package/dist/frames.js

@@ -0,0 +1,71 @@
+import { parse } from "@tscomfy/core";
+import { isObject } from "./http.js";
+const TEXT = 3;
+const PREVIEW_WITH_METADATA = 4;
+/**
+ * Decodes a binary websocket frame: a big-endian `uint32` type, then the payload. Type 1 (a
+ * preview without ids) isn't decoded: the client asks for type 4 instead, and an unattributed
+ * image can't be given to a job. Unknown types and malformed frames give `undefined`.
+ * `textHasPromptId` is the server's `supports_progress_text_metadata` flag.
+ */
+export function decodeFrame(data, textHasPromptId) {
+    if (data.byteLength < 4)
+        return undefined;
+    const view = new DataView(data);
+    const type = view.getUint32(0);
+    if (type === PREVIEW_WITH_METADATA)
+        return preview(data, view);
+    if (type === TEXT)
+        return text(data, view, textHasPromptId);
+    return undefined;
+}
+function preview(data, view) {
+    const length = readLength(view, 4);
+    if (length === undefined)
+        return undefined;
+    const metadata = parse(decoder.decode(new Uint8Array(data, 8, length))).value;
+    if (!isObject(metadata))
+        return undefined;
+    const promptId = metadata["prompt_id"];
+    const node = metadata["display_node_id"] ?? metadata["node_id"];
+    const mime = metadata["image_type"];
+    if (typeof promptId !== "string" || typeof node !== "string")
+        return undefined;
+    return {
+        kind: "preview",
+        promptId,
+        node,
+        mime: typeof mime === "string" ? mime : "image/jpeg",
+        bytes: new Uint8Array(data.slice(8 + length)),
+    };
+}
+function text(data, view, hasPromptId) {
+    let offset = 4;
+    let promptId;
+    if (hasPromptId) {
+        const length = readLength(view, offset);
+        if (length === undefined)
+            return undefined;
+        promptId = decoder.decode(new Uint8Array(data, offset + 4, length));
+        offset += 4 + length;
+    }
+    const length = readLength(view, offset);
+    if (length === undefined)
+        return undefined;
+    const node = decoder.decode(new Uint8Array(data, offset + 4, length));
+    return {
+        kind: "text",
+        promptId,
+        node,
+        text: decoder.decode(new Uint8Array(data, offset + 4 + length)),
+    };
+}
+/** A `uint32` length at `offset` whose bytes fit in the frame after it. */
+function readLength(view, offset) {
+    if (view.byteLength < offset + 4)
+        return undefined;
+    const length = view.getUint32(offset);
+    return offset + 4 + length <= view.byteLength ? length : undefined;
+}
+const decoder = new TextDecoder();
+//# sourceMappingURL=frames.js.map

package/dist/frames.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"frames.js","sourceRoot":"","sources":["../src/frames.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,KAAK,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAmBrC,MAAM,IAAI,GAAG,CAAC,CAAC;AACf,MAAM,qBAAqB,GAAG,CAAC,CAAC;AAEhC;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CACzB,IAAiB,EACjB,eAAwB;IAExB,IAAI,IAAI,CAAC,UAAU,GAAG,CAAC;QAAE,OAAO,SAAS,CAAC;IAC1C,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC;IAChC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAC/B,IAAI,IAAI,KAAK,qBAAqB;QAAE,OAAO,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC/D,IAAI,IAAI,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,eAAe,CAAC,CAAC;IAC5D,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,OAAO,CAAC,IAAiB,EAAE,IAAc;IAChD,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IACnC,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC3C,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,UAAU,CAAC,IAAI,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAC9E,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;QAAE,OAAO,SAAS,CAAC;IAC1C,MAAM,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC;IACvC,MAAM,IAAI,GAAG,QAAQ,CAAC,iBAAiB,CAAC,IAAI,QAAQ,CAAC,SAAS,CAAC,CAAC;IAChE,MAAM,IAAI,GAAG,QAAQ,CAAC,YAAY,CAAC,CAAC;IACpC,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,OAAO,IAAI,KAAK,QAAQ;QAAE,OAAO,SAAS,CAAC;IAC/E,OAAO;QACL,IAAI,EAAE,SAAS;QACf,QAAQ;QACR,IAAI;QACJ,IAAI,EAAE,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY;QACpD,KAAK,EAAE,IAAI,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;KAC9C,CAAC;AACJ,CAAC;AAED,SAAS,IAAI,CAAC,IAAiB,EAAE,IAAc,EAAE,WAAoB;IACnE,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,IAAI,QAA4B,CAAC;IACjC,IAAI,WAAW,EAAE,CAAC;QAChB,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACxC,IAAI,MAAM,KAAK,SAAS;YAAE,OAAO,SAAS,CAAC;QAC3C,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;QACpE,MAAM,IAAI,CAAC,GAAG,MAAM,CAAC;IACvB,CAAC;IACD,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACxC,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC3C,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;IACtE,OAAO;QACL,IAAI,EAAE,MAAM;QACZ,QAAQ;QACR,IAAI;QACJ,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC;KAChE,CAAC;AACJ,CAAC;AAED,2EAA2E;AAC3E,SAAS,UAAU,CAAC,IAAc,EAAE,MAAc;IAChD,IAAI,IAAI,CAAC,UAAU,GAAG,MAAM,GAAG,CAAC;QAAE,OAAO,SAAS,CAAC;IACnD,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IACtC,OAAO,MAAM,GAAG,CAAC,GAAG,MAAM,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;AACrE,CAAC;AAED,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC"}

package/dist/http.d.ts

@@ -0,0 +1,28 @@
+import { type JsonObject, type JsonValue } from "@tscomfy/core";
+import { ClientError } from "./client-error.ts";
+import type { Server } from "./server.ts";
+/** One HTTP request to a server. */
+export interface Request {
+    readonly method: "GET" | "POST";
+    /** Under the server's path: `prompt`, `api/jobs/<id>`. */
+    readonly path: string;
+    readonly query?: Readonly<Record<string, string>>;
+    readonly body?: string | FormData;
+    readonly signal?: AbortSignal | undefined;
+}
+/**
+ * Sends a request and returns the response, whatever its status. A failure to reach the server
+ * is a {@link ClientError}; an aborted signal rejects with the signal's reason, as `fetch` does.
+ */
+export declare function send(server: Server, request: Request): Promise<Response>;
+/** The response's body as JSON, read losslessly (big integers stay exact). */
+export declare function readJson(response: Response): Promise<JsonValue>;
+/** The response's body as a JSON object; anything else is a {@link ClientError}. */
+export declare function readObject(response: Response): Promise<JsonObject>;
+/** A {@link ClientError} for an answer the protocol doesn't expect, with the body's message. */
+export declare function unexpected(response: Response): Promise<ClientError>;
+/** A JSON list. */
+export declare function isList(value: JsonValue | undefined): value is readonly JsonValue[];
+/** A JSON object, not an array or `null`. */
+export declare function isObject(value: JsonValue | undefined): value is JsonObject;
+//# sourceMappingURL=http.d.ts.map

package/dist/http.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http.d.ts","sourceRoot":"","sources":["../src/http.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,SAAS,EAAS,MAAM,eAAe,CAAC;AACvE,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAG1C,oCAAoC;AACpC,MAAM,WAAW,OAAO;IACtB,QAAQ,CAAC,MAAM,EAAE,KAAK,GAAG,MAAM,CAAC;IAChC,0DAA0D;IAC1D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAClD,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAC;IAClC,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;CAC3C;AAED;;;GAGG;AACH,wBAAsB,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,CAkB9E;AAED,8EAA8E;AAC9E,wBAAsB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CASrE;AAED,oFAAoF;AACpF,wBAAsB,UAAU,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,CAQxE;AAED,gGAAgG;AAChG,wBAAsB,UAAU,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,WAAW,CAAC,CASzE;AAED,mBAAmB;AACnB,wBAAgB,MAAM,CAAC,KAAK,EAAE,SAAS,GAAG,SAAS,GAAG,KAAK,IAAI,SAAS,SAAS,EAAE,CAElF;AAED,6CAA6C;AAC7C,wBAAgB,QAAQ,CAAC,KAAK,EAAE,SAAS,GAAG,SAAS,GAAG,KAAK,IAAI,UAAU,CAE1E"}

package/dist/http.js

@@ -0,0 +1,96 @@
+import { parse } from "@tscomfy/core";
+import { ClientError } from "./client-error.js";
+import { baseUrl, endpoint, shownUrl } from "./url.js";
+/**
+ * Sends a request and returns the response, whatever its status. A failure to reach the server
+ * is a {@link ClientError}; an aborted signal rejects with the signal's reason, as `fetch` does.
+ */
+export async function send(server, request) {
+    const url = endpoint(baseUrl(server), request.path, request.query);
+    const headers = new Headers(server.headers);
+    if (typeof request.body === "string")
+        headers.set("content-type", "application/json");
+    const fetcher = server.fetch ?? globalThis.fetch;
+    try {
+        return await fetcher(url, {
+            method: request.method,
+            headers,
+            body: request.body ?? null,
+            signal: request.signal ?? null,
+        });
+    }
+    catch (error) {
+        if (request.signal?.aborted === true)
+            throw request.signal.reason;
+        // The runtime's message may quote the URL, query and all.
+        const why = describe(error).replaceAll(url.href, shownUrl(url));
+        throw new ClientError(`Could not reach ${shownUrl(url)}: ${why}`, { cause: error });
+    }
+}
+/** The response's body as JSON, read losslessly (big integers stay exact). */
+export async function readJson(response) {
+    const text = await response.text();
+    const { value } = parse(text);
+    if (value === undefined) {
+        throw new ClientError(`${where(response)} answered with a body that isn't JSON`, {
+            status: response.status,
+        });
+    }
+    return value;
+}
+/** The response's body as a JSON object; anything else is a {@link ClientError}. */
+export async function readObject(response) {
+    const value = await readJson(response);
+    if (!isObject(value)) {
+        throw new ClientError(`${where(response)} answered with JSON that isn't an object`, {
+            status: response.status,
+        });
+    }
+    return value;
+}
+/** A {@link ClientError} for an answer the protocol doesn't expect, with the body's message. */
+export async function unexpected(response) {
+    const answer = `${String(response.status)} ${response.statusText}`.trimEnd();
+    // Best effort: the status says what went wrong; the body may say why.
+    const body = await response.text().catch(() => "");
+    const detail = bodyMessage(body);
+    return new ClientError(`${where(response)} answered ${answer}${detail === undefined ? "" : `: ${detail}`}`, { status: response.status });
+}
+/** A JSON list. */
+export function isList(value) {
+    return Array.isArray(value);
+}
+/** A JSON object, not an array or `null`. */
+export function isObject(value) {
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+/** The response's URL without its query, or a fallback when the runtime gives none. */
+function where(response) {
+    return URL.canParse(response.url) ? shownUrl(new URL(response.url)) : "The server";
+}
+/** The message of an error body (`{"error": …}`, `{"detail": …}`), at most 200 characters. */
+function bodyMessage(text) {
+    const value = parse(text).value;
+    if (!isObject(value))
+        return undefined;
+    const message = value["error"] ?? value["detail"] ?? value["message"];
+    const shown = typeof message === "string"
+        ? message
+        : isObject(message) && typeof message["message"] === "string"
+            ? message["message"]
+            : undefined;
+    if (shown === undefined)
+        return undefined;
+    // oxlint-disable-next-line no-control-regex -- control characters are what it removes
+    const printable = shown.replaceAll(/[\u0000-\u001f\u007f]/g, " ");
+    return printable.length <= 200 ? printable : `${printable.slice(0, 200)}…`;
+}
+/** Why something failed. Node's `fetch` says only "fetch failed"; the reason is in its `cause`. */
+function describe(error) {
+    const message = error instanceof Error ? error.message : String(error);
+    const cause = error instanceof Error ? error.cause : undefined;
+    if (!(cause instanceof Error) || message.includes(cause.message))
+        return message;
+    return `${message} (${cause.message})`;
+}
+//# sourceMappingURL=http.js.map

package/dist/http.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"http.js","sourceRoot":"","sources":["../src/http.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmC,KAAK,EAAE,MAAM,eAAe,CAAC;AACvE,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAYvD;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,MAAc,EAAE,OAAgB;IACzD,MAAM,GAAG,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IACnE,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC5C,IAAI,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ;QAAE,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;IACtF,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,IAAI,UAAU,CAAC,KAAK,CAAC;IACjD,IAAI,CAAC;QACH,OAAO,MAAM,OAAO,CAAC,GAAG,EAAE;YACxB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,OAAO;YACP,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,IAAI;YAC1B,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,IAAI;SAC/B,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,OAAO,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI;YAAE,MAAM,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC;QAClE,0DAA0D;QAC1D,MAAM,GAAG,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;QAChE,MAAM,IAAI,WAAW,CAAC,mBAAmB,QAAQ,CAAC,GAAG,CAAC,KAAK,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;IACtF,CAAC;AACH,CAAC;AAED,8EAA8E;AAC9E,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,QAAkB;IAC/C,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;IACnC,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;IAC9B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,MAAM,IAAI,WAAW,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,uCAAuC,EAAE;YAC/E,MAAM,EAAE,QAAQ,CAAC,MAAM;SACxB,CAAC,CAAC;IACL,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,oFAAoF;AACpF,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,QAAkB;IACjD,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACvC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACrB,MAAM,IAAI,WAAW,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,0CAA0C,EAAE;YAClF,MAAM,EAAE,QAAQ,CAAC,MAAM;SACxB,CAAC,CAAC;IACL,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,gGAAgG;AAChG,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,QAAkB;IACjD,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC,OAAO,EAAE,CAAC;IAC7E,sEAAsE;IACtE,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;IACnD,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IACjC,OAAO,IAAI,WAAW,CACpB,GAAG,KAAK,CAAC,QAAQ,CAAC,aAAa,MAAM,GAAG,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,MAAM,EAAE,EAAE,EACnF,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,CAC5B,CAAC;AACJ,CAAC;AAED,mBAAmB;AACnB,MAAM,UAAU,MAAM,CAAC,KAA4B;IACjD,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9B,CAAC;AAED,6CAA6C;AAC7C,MAAM,UAAU,QAAQ,CAAC,KAA4B;IACnD,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAED,uFAAuF;AACvF,SAAS,KAAK,CAAC,QAAkB;IAC/B,OAAO,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC;AACrF,CAAC;AAED,8FAA8F;AAC9F,SAAS,WAAW,CAAC,IAAY;IAC/B,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC;IAChC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IACvC,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC;IACtE,MAAM,KAAK,GACT,OAAO,OAAO,KAAK,QAAQ;QACzB,CAAC,CAAC,OAAO;QACT,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,OAAO,OAAO,CAAC,SAAS,CAAC,KAAK,QAAQ;YAC3D,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC;YACpB,CAAC,CAAC,SAAS,CAAC;IAClB,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC1C,sFAAsF;IACtF,MAAM,SAAS,GAAG,KAAK,CAAC,UAAU,CAAC,wBAAwB,EAAE,GAAG,CAAC,CAAC;IAClE,OAAO,SAAS,CAAC,MAAM,IAAI,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC;AAC7E,CAAC;AAED,mGAAmG;AACnG,SAAS,QAAQ,CAAC,KAAc;IAC9B,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACvE,MAAM,KAAK,GAAY,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;IACxE,IAAI,CAAC,CAAC,KAAK,YAAY,KAAK,CAAC,IAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC;QAAE,OAAO,OAAO,CAAC;IACjF,OAAO,GAAG,OAAO,KAAK,KAAK,CAAC,OAAO,GAAG,CAAC;AACzC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @module @tscomfy/client
+ *
+ * Runs tscomfy workflows on a ComfyUI server: `connect` opens a websocket, `submit` queues a
+ * workflow and returns a job whose events stream progress, live previews and outputs, and whose
+ * outcome the server's record of the job decides. `uploadFile` and `fetchFile` move files.
+ * Runtime-agnostic: it uses only `fetch`, `WebSocket` and their companions.
+ */
+export { ClientError } from "./client-error.ts";
+export { type Connection, type ConnectOptions, connect } from "./connection.ts";
+export type { BlockedEvent, CachedEvent, ExecutingEvent, JobEvent, OutputEvent, PreviewEvent, ProgressEvent, StartedEvent, TextEvent, } from "./events.ts";
+export { type FetchFileOptions, fetchFile, type FileData, fileUrl, type UploadedFile, uploadFile, type UploadOptions, type UploadSource, } from "./files.ts";
+export { type Job, type PreviewMethod, submit, type SubmitOptions } from "./job.ts";
+export type { CancelledOutcome, ExecutionError, FailedOutcome, Outcome, RejectedOutcome, SuccessOutcome, } from "./outcome.ts";
+export { type FileKind, type FileRef, type FolderType, type NodeOutput, type NodeRef, type OutputFile, outputFiles, outputOf, type Outputs, } from "./outputs.ts";
+export type { Server } from "./server.ts";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,cAAc,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAChF,YAAY,EACV,YAAY,EACZ,WAAW,EACX,cAAc,EACd,QAAQ,EACR,WAAW,EACX,YAAY,EACZ,aAAa,EACb,YAAY,EACZ,SAAS,GACV,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,KAAK,gBAAgB,EACrB,SAAS,EACT,KAAK,QAAQ,EACb,OAAO,EACP,KAAK,YAAY,EACjB,UAAU,EACV,KAAK,aAAa,EAClB,KAAK,YAAY,GAClB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,KAAK,GAAG,EAAE,KAAK,aAAa,EAAE,MAAM,EAAE,KAAK,aAAa,EAAE,MAAM,UAAU,CAAC;AACpF,YAAY,EACV,gBAAgB,EAChB,cAAc,EACd,aAAa,EACb,OAAO,EACP,eAAe,EACf,cAAc,GACf,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,KAAK,QAAQ,EACb,KAAK,OAAO,EACZ,KAAK,UAAU,EACf,KAAK,UAAU,EACf,KAAK,OAAO,EACZ,KAAK,UAAU,EACf,WAAW,EACX,QAAQ,EACR,KAAK,OAAO,GACb,MAAM,cAAc,CAAC;AACtB,YAAY,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC"}

package/dist/index.js

@@ -0,0 +1,14 @@
+/**
+ * @module @tscomfy/client
+ *
+ * Runs tscomfy workflows on a ComfyUI server: `connect` opens a websocket, `submit` queues a
+ * workflow and returns a job whose events stream progress, live previews and outputs, and whose
+ * outcome the server's record of the job decides. `uploadFile` and `fetchFile` move files.
+ * Runtime-agnostic: it uses only `fetch`, `WebSocket` and their companions.
+ */
+export { ClientError } from "./client-error.js";
+export { connect } from "./connection.js";
+export { fetchFile, fileUrl, uploadFile, } from "./files.js";
+export { submit } from "./job.js";
+export { outputFiles, outputOf, } from "./outputs.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAwC,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAYhF,OAAO,EAEL,SAAS,EAET,OAAO,EAEP,UAAU,GAGX,MAAM,YAAY,CAAC;AACpB,OAAO,EAAgC,MAAM,EAAsB,MAAM,UAAU,CAAC;AASpF,OAAO,EAOL,WAAW,EACX,QAAQ,GAET,MAAM,cAAc,CAAC"}

package/dist/job.d.ts

@@ -0,0 +1,59 @@
+import { type ApiPrompt, type JsonObject, type Workflow } from "@tscomfy/core";
+import type { Connection } from "./connection.ts";
+import type { JobEvent } from "./events.ts";
+import type { Outcome } from "./outcome.ts";
+import type { NodeRef } from "./outputs.ts";
+/** How the server draws live previews: `auto` is latent2rgb; `taesd` needs its decoder model. */
+export type PreviewMethod = "auto" | "latent2rgb" | "taesd" | "none";
+/** Options for {@link submit}. */
+export interface SubmitOptions {
+    /**
+     * Live previews for this job (`extra_data.preview_method`). Without it the server's default
+     * applies, which is `none` unless it was started with `--preview-method`.
+     */
+    readonly previews?: PreviewMethod;
+    /** Run only these output nodes (`partial_execution_targets`). */
+    readonly targets?: readonly NodeRef[];
+    /** Queue ahead of the jobs already waiting. */
+    readonly front?: boolean;
+    /**
+     * More `extra_data` for the server, such as `api_key_comfy_org` for partner nodes. The keys the
+     * client sets (`client_id`, `preview_method`) are refused.
+     */
+    readonly extraData?: JsonObject;
+    /**
+     * Aborting it cancels the job on the server and rejects the outcome with the signal's reason:
+     * `AbortSignal.timeout(600_000)`. There is no default timeout.
+     */
+    readonly signal?: AbortSignal;
+}
+/** A submitted job. */
+export interface Job {
+    /** The prompt id, minted by the client. */
+    readonly id: string;
+    /**
+     * What the job reports while it runs, for one consumer, from the moment it was submitted. Ends
+     * when the outcome settles; never throws for the job's failure.
+     */
+    readonly events: AsyncIterable<JobEvent>;
+    /**
+     * How the job ended, as the server's record says. Rejects only with the signal's reason (see
+     * {@link SubmitOptions.signal}) or a {@link ClientError}: the server couldn't be reached, the
+     * connection was closed, or the server broke the protocol.
+     */
+    readonly outcome: Promise<Outcome>;
+    /**
+     * Asks the server to cancel the job, queued or running. The outcome then settles, normally as
+     * `cancelled` (a job that was finishing may still succeed). Rejects with a {@link ClientError}
+     * if the server can't be asked.
+     */
+    cancel(): Promise<void>;
+}
+/**
+ * Submits a workflow, or a prompt, to run on the server. A workflow is exported with `toApi`,
+ * which validates it and throws a `ValidationError` for errors (D21); a prompt is sent as given.
+ * The job is registered under a prompt id the client mints before anything is sent, so no event
+ * is missed. Throws a `TypeError` for invalid options or a closed connection.
+ */
+export declare function submit(connection: Connection, input: Workflow | ApiPrompt, options?: SubmitOptions): Job;
+//# sourceMappingURL=job.d.ts.map

package/dist/job.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"job.d.ts","sourceRoot":"","sources":["../src/job.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,SAAS,EAGd,KAAK,UAAU,EAKf,KAAK,QAAQ,EACd,MAAM,eAAe,CAAC;AAGvB,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAElD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAG5C,OAAO,KAAK,EAAkB,OAAO,EAAE,MAAM,cAAc,CAAC;AAC5D,OAAO,KAAK,EAAc,OAAO,EAAW,MAAM,cAAc,CAAC;AAOjE,iGAAiG;AACjG,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,YAAY,GAAG,OAAO,GAAG,MAAM,CAAC;AAErE,kCAAkC;AAClC,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC;IAClC,iEAAiE;IACjE,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,OAAO,EAAE,CAAC;IACtC,+CAA+C;IAC/C,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IACzB;;;OAGG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,UAAU,CAAC;IAChC;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC;CAC/B;AAED,uBAAuB;AACvB,MAAM,WAAW,GAAG;IAClB,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAC;IACzC;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IACnC;;;;OAIG;IACH,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACzB;AAED;;;;;GAKG;AACH,wBAAgB,MAAM,CACpB,UAAU,EAAE,UAAU,EACtB,KAAK,EAAE,QAAQ,GAAG,SAAS,EAC3B,OAAO,GAAE,aAAkB,GAC1B,GAAG,CAQL"}