comfyui-node 1.1.0 → 1.1.1

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/README.md +26 -1
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -143,7 +143,7 @@ wf.output('NodeId'); // key = id
143
143
  ### Events (WorkflowJob)
144
144
 
145
145
  ```txt
146
- pending -> start -> progress/progress_pct/preview -> output* -> finished (or failed)
146
+ pending -> start -> progress / progress_pct / preview -> output* -> finished (or failed)
147
147
  ```
148
148
 
149
149
  | Event | Notes |
@@ -1055,6 +1055,31 @@ bun test && bun run coverage
1055
1055
 
1056
1056
  before opening a PR, and prefer adding tests alongside new feature code.
1057
1057
 
1058
+ ## Troubleshooting
1059
+
1060
+ | Symptom | Likely Cause | Fix |
1061
+ | ------- | ------------ | ---- |
1062
+ | `progress_pct` never fires | Only listening to raw `progress` (or run finished instantly) | Subscribe to `progress_pct`; ensure workflow isn't trivially cached / instant |
1063
+ | Empty `images` array | Wrong node id in `.output()` or no `SaveImage` nodes detected | Verify node id in base JSON; omit outputs to let auto-detect run |
1064
+ | `_autoSeeds` missing | No `seed: -1` inputs present | Set seed field explicitly to `-1` on nodes requiring randomization |
1065
+ | Autocomplete missing for sampler | Used `Workflow.from(...)` not `fromAugmented` | Switch to `Workflow.fromAugmented(json)` |
1066
+ | Type not updating after new `.output()` | Captured type alias before adding the call | Recompute `type R = ReturnType<typeof wf.typedResult>` after the last output declaration |
1067
+ | Execution error but no missing outputs | Underlying node error surfaced via `execution_error` event | Listen to `failed` + inspect error / server logs |
1068
+ | Job hangs waiting for output | Declared non-existent node id | Run with fewer outputs or validate JSON; inspect `_nodes` metadata |
1069
+ | Random seed not changing between runs | Provided explicit numeric seed | Use `-1` sentinel or generate a random seed before `.set()` |
1070
+ | Preview frames never appear | Workflow lacks preview-capable nodes (e.g. KSampler) | Confirm server emits `b_preview` events for your graph |
1071
+ | Pool never selects idle client | Mode set to `PICK_LOWEST` with constant queue depth | Switch to `PICK_ZERO` for latency focus |
1072
+ | High-level run returns immediately | Accessed `await api.run(wf)` only (acceptance barrier) | Await `job.done()` or events to completion |
1073
+
1074
+ Diagnostic tips:
1075
+
1076
+ - Enable verbose progress: set `COMFY_PROGRESS_VERBOSE=1` before running the smoke script.
1077
+ - For enqueue failures inspect `EnqueueFailedError` fields (`status`, `reason`, `bodyTextSnippet`).
1078
+ - Use `_aliases` metadata to confirm alias -> node id mapping at runtime.
1079
+ - Log `_autoSeeds` to verify sentinel replacement behavior in batch runs.
1080
+ - If types feel stale, close & reopen the file – TypeScript sometimes caches deep conditional expansions.
1081
+
1082
+
1058
1083
  ## Published Smoke Test
1059
1084
 
1060
1085
  The script `scripts/published-e2e.ts` offers a zero‑config verification of the published npm artifact with **Bun auto‑install**. It dynamically imports `comfyui-node`, builds a small txt2img workflow (optionally an upscale branch), waits for completion and prints output image URLs.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "comfyui-node",
3
- "version": "1.1.0",
3
+ "version": "1.1.1",
4
4
  "description": "ComfyUI Node.js Client",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",