@comfyorg/sdk 0.1.2 → 0.1.4

package/README.md

@@ -14,7 +14,7 @@ JavaScript is async-native).
 import { Comfy } from "@comfyorg/sdk";
 
 const client = new Comfy("http://127.0.0.1:8189"); // local proxy, no key needed
-// const client = new Comfy("https://api.comfy.org", { apiKey: "..." }); // Comfy Cloud
+// const client = new Comfy({ apiKey: "..." }); // Comfy Cloud (default base URL)
 
 const wf = await client.workflows.fromFile("workflow_api.json");
 const asset = client.assets.fromFile("photo.png"); // lazy; hashed + uploaded on first use

package/dist/index.d.ts

@@ -14,7 +14,7 @@
  * import { Comfy } from "@comfyorg/sdk";
  *
  * const client = new Comfy("http://127.0.0.1:8189"); // local proxy
- * // const client = new Comfy("https://api.comfy.org", { apiKey: "..." }) // Comfy Cloud
+ * // const client = new Comfy({ apiKey: "..." }) // Comfy Cloud (default base URL)
  *
  * const wf = await client.workflows.fromFile("workflow_api.json");
  * const asset = client.assets.fromFile("photo.png"); // lazy; uploaded on use

package/dist/index.js

@@ -14,7 +14,7 @@
  * import { Comfy } from "@comfyorg/sdk";
  *
  * const client = new Comfy("http://127.0.0.1:8189"); // local proxy
- * // const client = new Comfy("https://api.comfy.org", { apiKey: "..." }) // Comfy Cloud
+ * // const client = new Comfy({ apiKey: "..." }) // Comfy Cloud (default base URL)
  *
  * const wf = await client.workflows.fromFile("workflow_api.json");
  * const asset = client.assets.fromFile("photo.png"); // lazy; uploaded on use

package/dist/low/generated/types.gen.d.ts

@@ -1,5 +1,5 @@
 export type ClientOptions = {
-    baseUrl: 'http://127.0.0.1:8189' | 'https://api.comfy.org' | 'https://{deployment}.comfy.org' | (string & {});
+    baseUrl: 'http://127.0.0.1:8189' | 'https://cloud.comfy.org' | 'https://{deployment}.comfy.org' | (string & {});
 };
 /**
  * A user-owned record identified by a server-assigned UUID, backing an immutable blob whose content carries a server-computed blake3 hash. `hash` may be computed lazily: an asset record (and its retrievable bytes) can exist before its hash is filled in.

package/dist/low/transport.js

@@ -27,13 +27,9 @@
  */
 import { errorFromEnvelope } from "./errors.js";
 import { iterateSse } from "./sse.js";
+import { SDK_VERSION } from "./version.js";
 const API_PREFIX = "/api/v2";
 const DEFAULT_TIMEOUT_MS = 30_000;
-// Mirrors `version` in package.json. Hand-kept in sync: this package builds
-// with plain `tsc` (no bundler/codegen step to inline it), and importing
-// `../../package.json` directly would step outside `tsc`'s configured
-// `rootDir`.
-const SDK_VERSION = "0.1.0";
 function looksLikePath(value) {
     return value.startsWith("http") || value.startsWith("/");
 }
@@ -102,8 +98,17 @@ export class ComfyLow {
     urlFor(path) {
         if (path.startsWith("http"))
             return path;
-        if (path.startsWith("/api/"))
-            return this.baseUrl + path;
+        // A server link (job.urls.*, marked by containing /api/) already carries
+        // the server's mount prefix, so it resolves against the origin — joining
+        // it to baseUrl would double the prefix on a prefix-mounted surface.
+        if (path.startsWith("/") && path.includes("/api/")) {
+            try {
+                return new URL(this.baseUrl).origin + path;
+            }
+            catch {
+                return this.baseUrl + path;
+            }
+        }
         return this.baseUrl + API_PREFIX + path;
     }
     /**

package/dist/low/version.d.ts

@@ -0,0 +1 @@
+export declare const SDK_VERSION = "0.1.4";

package/dist/low/version.js

@@ -0,0 +1,2 @@
+// GENERATED by scripts/gen-version.mjs from package.json — do not edit.
+export const SDK_VERSION = "0.1.4";

package/dist/sdk/client.d.ts

@@ -18,7 +18,7 @@
  * import { Comfy } from "@comfyorg/sdk";
  *
  * const client = new Comfy("http://127.0.0.1:8189"); // self-hosted, no key
- * // const client = new Comfy("https://api.comfy.org", { apiKey: "ck_..." });
+ * // const client = new Comfy({ apiKey: "ck_..." });   // Comfy Cloud (default base URL)
  *
  * const wf = await client.workflows.fromFile("workflow_api.json");
  * const asset = client.assets.fromFile("photo.png"); // lazy; uploaded on use
@@ -33,6 +33,9 @@ import { AssetFactory } from "./assets.js";
 import { Job, JobFactory } from "./jobs.js";
 import type { Workflow } from "./workflows.js";
 import { WorkflowFactory } from "./workflows.js";
+/** Base URL of the hosted Comfy Cloud deployment, used when none is given.
+ * Self-hosted ComfyUI and serverless deployments must pass their own baseUrl. */
+export declare const COMFY_CLOUD_BASE_URL = "https://cloud.comfy.org";
 export interface ComfyOptions {
     apiKey?: string;
     timeoutMs?: number;
@@ -46,6 +49,9 @@ export declare class Comfy {
     readonly assets: AssetFactory;
     readonly workflows: WorkflowFactory;
     readonly jobs: JobFactory;
+    /** Connect to the hosted Comfy Cloud deployment. */
+    constructor(options?: ComfyOptions);
+    /** Connect to a specific deployment — self-hosted ComfyUI, or a serverless one. */
     constructor(baseUrl: string, options?: ComfyOptions);
     private materialize;
     /**

package/dist/sdk/client.js

@@ -18,7 +18,7 @@
  * import { Comfy } from "@comfyorg/sdk";
  *
  * const client = new Comfy("http://127.0.0.1:8189"); // self-hosted, no key
- * // const client = new Comfy("https://api.comfy.org", { apiKey: "ck_..." });
+ * // const client = new Comfy({ apiKey: "ck_..." });   // Comfy Cloud (default base URL)
  *
  * const wf = await client.workflows.fromFile("workflow_api.json");
  * const asset = client.assets.fromFile("photo.png"); // lazy; uploaded on use
@@ -37,6 +37,9 @@ import { Job, JobFactory } from "./jobs.js";
 import { WorkflowFactory } from "./workflows.js";
 // How long to keep retrying a full queue before giving up (ms).
 const QUEUE_RETRY_BUDGET_MS = 60_000;
+/** Base URL of the hosted Comfy Cloud deployment, used when none is given.
+ * Self-hosted ComfyUI and serverless deployments must pass their own baseUrl. */
+export const COMFY_CLOUD_BASE_URL = "https://cloud.comfy.org";
 const DEFAULT_RETRY_AFTER_S = 2;
 function guardUiFormat(workflow) {
     if (looksLikeUiFormat(workflow.json)) {
@@ -48,7 +51,10 @@ export class Comfy {
     assets;
     workflows;
     jobs;
-    constructor(baseUrl, options = {}) {
+    constructor(baseUrlOrOptions, maybeOptions = {}) {
+        const isUrl = typeof baseUrlOrOptions === "string";
+        const baseUrl = isUrl ? baseUrlOrOptions : COMFY_CLOUD_BASE_URL;
+        const options = isUrl ? maybeOptions : (baseUrlOrOptions ?? {});
         this.low = new ComfyLow(baseUrl, options.apiKey, {
             timeoutMs: options.timeoutMs,
             fetch: options.fetch,

package/dist/sdk/index.d.ts

@@ -4,7 +4,7 @@
  * Mirrors `comfy_sdk`'s `__init__.py` in the Python SDK, minus the
  * sync/async duplication (JS is async-native).
  */
-export { Comfy, type ComfyOptions } from "./client.js";
+export { Comfy, COMFY_CLOUD_BASE_URL, type ComfyOptions } from "./client.js";
 export { Asset, AssetFactory } from "./assets.js";
 export { Workflow, WorkflowFactory, type WorkflowGraph } from "./workflows.js";
 export { Job, JobFactory } from "./jobs.js";

package/dist/sdk/index.js

@@ -4,7 +4,7 @@
  * Mirrors `comfy_sdk`'s `__init__.py` in the Python SDK, minus the
  * sync/async duplication (JS is async-native).
  */
-export { Comfy } from "./client.js";
+export { Comfy, COMFY_CLOUD_BASE_URL } from "./client.js";
 export { Asset, AssetFactory } from "./assets.js";
 export { Workflow, WorkflowFactory } from "./workflows.js";
 export { Job, JobFactory } from "./jobs.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@comfyorg/sdk",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "private": false,
   "description": "TypeScript SDK for running ComfyUI workflows via the Comfy API v2 (self-hosted, Comfy Cloud, serverless).",
   "homepage": "https://github.com/Comfy-Org/ComfyTypeScriptSDK#readme",
@@ -46,7 +46,7 @@
     "node": ">=22"
   },
   "scripts": {
-    "build": "tsc",
+    "build": "node scripts/gen-version.mjs && tsc",
     "generate": "openapi-ts",
     "lint": "oxlint .",
     "format": "oxfmt --write .",