From 79157f4289676fd94e89391bcaf27cd3ad180e2c Mon Sep 17 00:00:00 2001 From: Ethanfel Date: Mon, 23 Feb 2026 19:32:57 +0100 Subject: [PATCH] Initial commit: JSON Loader (Dynamic) ComfyUI node Auto-discovers JSON keys and exposes them as typed output slots. Includes JS frontend for refresh, connection-safe updates, and workflow persistence of keys and types. Co-Authored-By: Claude Opus 4.6 --- LICENSE | 201 +++++++++++++++++++++++++++++++++++++++++ README.md | 121 +++++++++++++++++++++++++ __init__.py | 5 + json_loader_dynamic.py | 132 +++++++++++++++++++++++++++ web/json_dynamic.js | 139 ++++++++++++++++++++++++++++ 5 files changed, 598 insertions(+) create mode 100644 LICENSE create mode 100644 README.md create mode 100644 __init__.py create mode 100644 json_loader_dynamic.py create mode 100644 web/json_dynamic.js diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..887ae67 --- /dev/null +++ b/README.md @@ -0,0 +1,121 @@ +

+ + + + + + + + + + + + + + { Dynamic } + ComfyUI JSON Dynamic Loader + Auto-discover JSON keys as typed output slots + +

+ +

+ License + ComfyUI +

+ +A single ComfyUI node that reads any JSON file and **automatically creates output slots** for every key it finds. No hardcoded outputs — when your JSON structure changes, just click Refresh. + +## Features + +- **Auto-discovery** — reads JSON keys and exposes them as named outputs +- **Type detection** — `INT`, `FLOAT`, `STRING` types with colored connectors +- **Batch support** — `sequence_number` input for `batch_data` arrays +- **Connection-safe refresh** — adding new keys preserves existing links +- **Workflow persistence** — keys, types, and connections survive save/reload + +## Installation + +```bash +cd ComfyUI/custom_nodes/ +git clone ComfyUI-JSON-Dynamic +# Restart ComfyUI +``` + +## Usage + +1. Add **JSON Loader (Dynamic)** node to your workflow +2. Enter a `json_path` and `sequence_number` +3. Click **Refresh Outputs** +4. Outputs appear named after your JSON keys with correct types +5. Connect to downstream nodes + +

+ + + + + + + + + + + JSON Loader (Dynamic) + json_path: /data/prompt.json + sequence_number: 1 + + Refresh Outputs + + general_prompt + + negative + + seed + + flf + + camera + + + + KSampler + + positive + + seed + +

+ +## Type Handling + +| JSON type | Output type | Connector | +|:---|:---|:---| +| `42` (integer) | `INT` | Blue | +| `3.14` (float) | `FLOAT` | Teal | +| `"hello"` (string) | `STRING` | Pink | +| `true` / `false` | `STRING` (`"true"` / `"false"`) | Pink | + +## JSON Format + +Works with flat JSON or `batch_data` arrays: + +```json +{ + "batch_data": [ + { + "sequence_number": 1, + "general_prompt": "A cinematic scene...", + "seed": 42, + "flf": 0.5, + "camera": "pan_left", + "my_custom_key": "any value" + } + ] +} +``` + +Without `batch_data`, reads keys directly from the root object. + +## License + +[Apache 2.0](LICENSE) diff --git a/__init__.py b/__init__.py new file mode 100644 index 0000000..9756331 --- /dev/null +++ b/__init__.py @@ -0,0 +1,5 @@ +from .json_loader_dynamic import NODE_CLASS_MAPPINGS, NODE_DISPLAY_NAME_MAPPINGS + +WEB_DIRECTORY = "./web" + +__all__ = ['NODE_CLASS_MAPPINGS', 'NODE_DISPLAY_NAME_MAPPINGS', 'WEB_DIRECTORY'] diff --git a/json_loader_dynamic.py b/json_loader_dynamic.py new file mode 100644 index 0000000..b069f64 --- /dev/null +++ b/json_loader_dynamic.py @@ -0,0 +1,132 @@ +import json +import os +import logging +from typing import Any + +logger = logging.getLogger(__name__) + +KEY_BATCH_DATA = "batch_data" +MAX_DYNAMIC_OUTPUTS = 32 + + +class AnyType(str): + """Universal connector type that matches any ComfyUI type.""" + def __ne__(self, __value: object) -> bool: + return False + +any_type = AnyType("*") + + +try: + from server import PromptServer + from aiohttp import web +except ImportError: + PromptServer = None + + +def read_json_data(json_path: str) -> dict[str, Any]: + if not os.path.exists(json_path): + logger.warning(f"File not found at {json_path}") + return {} + try: + with open(json_path, 'r') as f: + data = json.load(f) + except (json.JSONDecodeError, IOError) as e: + logger.warning(f"Error reading {json_path}: {e}") + return {} + if not isinstance(data, dict): + logger.warning(f"Expected dict from {json_path}, got {type(data).__name__}") + return {} + return data + + +def get_batch_item(data: dict[str, Any], sequence_number: int) -> dict[str, Any]: + """Resolve batch item by sequence_number field, falling back to array index.""" + if KEY_BATCH_DATA in data and isinstance(data[KEY_BATCH_DATA], list) and len(data[KEY_BATCH_DATA]) > 0: + for item in data[KEY_BATCH_DATA]: + if int(item.get("sequence_number", 0)) == sequence_number: + return item + idx = max(0, min(sequence_number - 1, len(data[KEY_BATCH_DATA]) - 1)) + logger.warning(f"No item with sequence_number={sequence_number}, falling back to index {idx}") + return data[KEY_BATCH_DATA][idx] + return data + + +# --- API Route --- +if PromptServer is not None: + @PromptServer.instance.routes.get("/json_dynamic/get_keys") + async def get_keys_route(request): + json_path = request.query.get("path", "") + try: + seq = int(request.query.get("sequence_number", "1")) + except (ValueError, TypeError): + seq = 1 + data = read_json_data(json_path) + target = get_batch_item(data, seq) + keys = [] + types = [] + if isinstance(target, dict): + for k, v in target.items(): + keys.append(k) + if isinstance(v, bool): + types.append("STRING") + elif isinstance(v, int): + types.append("INT") + elif isinstance(v, float): + types.append("FLOAT") + else: + types.append("STRING") + return web.json_response({"keys": keys, "types": types}) + + +class JSONLoaderDynamic: + @classmethod + def INPUT_TYPES(s): + return { + "required": { + "json_path": ("STRING", {"default": "", "multiline": False}), + "sequence_number": ("INT", {"default": 1, "min": 1, "max": 9999}), + }, + "optional": { + "output_keys": ("STRING", {"default": ""}), + "output_types": ("STRING", {"default": ""}), + }, + } + + RETURN_TYPES = tuple(any_type for _ in range(MAX_DYNAMIC_OUTPUTS)) + RETURN_NAMES = tuple(f"output_{i}" for i in range(MAX_DYNAMIC_OUTPUTS)) + FUNCTION = "load_dynamic" + CATEGORY = "utils/json" + OUTPUT_NODE = False + + def load_dynamic(self, json_path, sequence_number, output_keys="", output_types=""): + data = read_json_data(json_path) + target = get_batch_item(data, sequence_number) + + keys = [k.strip() for k in output_keys.split(",") if k.strip()] if output_keys else [] + + results = [] + for key in keys: + val = target.get(key, "") + if isinstance(val, bool): + results.append(str(val).lower()) + elif isinstance(val, int): + results.append(val) + elif isinstance(val, float): + results.append(val) + else: + results.append(str(val)) + + while len(results) < MAX_DYNAMIC_OUTPUTS: + results.append("") + + return tuple(results) + + +NODE_CLASS_MAPPINGS = { + "JSONLoaderDynamic": JSONLoaderDynamic, +} + +NODE_DISPLAY_NAME_MAPPINGS = { + "JSONLoaderDynamic": "JSON Loader (Dynamic)", +} diff --git a/web/json_dynamic.js b/web/json_dynamic.js new file mode 100644 index 0000000..35d875c --- /dev/null +++ b/web/json_dynamic.js @@ -0,0 +1,139 @@ +import { app } from "../../scripts/app.js"; +import { api } from "../../scripts/api.js"; + +app.registerExtension({ + name: "json.dynamic.loader", + + async beforeRegisterNodeDef(nodeType, nodeData, app) { + if (nodeData.name !== "JSONLoaderDynamic") return; + + const origOnNodeCreated = nodeType.prototype.onNodeCreated; + nodeType.prototype.onNodeCreated = function () { + origOnNodeCreated?.apply(this, arguments); + + // Hide internal widgets (managed by JS) + for (const name of ["output_keys", "output_types"]) { + const w = this.widgets?.find(w => w.name === name); + if (w) { w.type = "hidden"; w.computeSize = () => [0, -4]; } + } + + // Remove all 32 default outputs from Python RETURN_TYPES + while (this.outputs.length > 0) { + this.removeOutput(0); + } + + // Add Refresh button + this.addWidget("button", "Refresh Outputs", null, () => { + this.refreshDynamicOutputs(); + }); + + this.setSize(this.computeSize()); + }; + + nodeType.prototype.refreshDynamicOutputs = async function () { + const pathWidget = this.widgets?.find(w => w.name === "json_path"); + const seqWidget = this.widgets?.find(w => w.name === "sequence_number"); + if (!pathWidget?.value) return; + + try { + const resp = await api.fetchApi( + `/json_dynamic/get_keys?path=${encodeURIComponent(pathWidget.value)}&sequence_number=${seqWidget?.value || 1}` + ); + const { keys, types } = await resp.json(); + + // Store keys and types in hidden widgets for persistence + const okWidget = this.widgets?.find(w => w.name === "output_keys"); + if (okWidget) okWidget.value = keys.join(","); + const otWidget = this.widgets?.find(w => w.name === "output_types"); + if (otWidget) otWidget.value = types.join(","); + + // Build a map of current output names to slot indices + const oldSlots = {}; + for (let i = 0; i < this.outputs.length; i++) { + oldSlots[this.outputs[i].name] = i; + } + + // Build new outputs, reusing existing slots to preserve links + const newOutputs = []; + for (let k = 0; k < keys.length; k++) { + const key = keys[k]; + const type = types[k] || "*"; + if (key in oldSlots) { + // Reuse existing slot object (keeps links intact) + const slot = this.outputs[oldSlots[key]]; + slot.type = type; + newOutputs.push(slot); + delete oldSlots[key]; + } else { + // New key — create a fresh slot + newOutputs.push({ name: key, type: type, links: null }); + } + } + + // Disconnect links on slots that are being removed + for (const name in oldSlots) { + const idx = oldSlots[name]; + if (this.outputs[idx]?.links?.length) { + for (const linkId of [...this.outputs[idx].links]) { + this.graph?.removeLink(linkId); + } + } + } + + // Reassign the outputs array and fix link slot indices + this.outputs = newOutputs; + if (this.graph) { + for (let i = 0; i < this.outputs.length; i++) { + const links = this.outputs[i].links; + if (!links) continue; + for (const linkId of links) { + const link = this.graph.links[linkId]; + if (link) link.origin_slot = i; + } + } + } + + this.setSize(this.computeSize()); + app.graph.setDirtyCanvas(true, true); + } catch (e) { + console.error("[JSONLoaderDynamic] Refresh failed:", e); + } + }; + + // Restore state on workflow load + const origOnConfigure = nodeType.prototype.onConfigure; + nodeType.prototype.onConfigure = function (info) { + origOnConfigure?.apply(this, arguments); + + // Hide internal widgets + for (const name of ["output_keys", "output_types"]) { + const w = this.widgets?.find(w => w.name === name); + if (w) { w.type = "hidden"; w.computeSize = () => [0, -4]; } + } + + const okWidget = this.widgets?.find(w => w.name === "output_keys"); + const otWidget = this.widgets?.find(w => w.name === "output_types"); + + const keys = okWidget?.value + ? okWidget.value.split(",").filter(k => k.trim()) + : []; + const types = otWidget?.value + ? otWidget.value.split(",") + : []; + + // On load, LiteGraph already restored serialized outputs with links. + // Rename and set types to match stored state (preserves links). + for (let i = 0; i < this.outputs.length && i < keys.length; i++) { + this.outputs[i].name = keys[i].trim(); + if (types[i]) this.outputs[i].type = types[i]; + } + + // Remove any extra outputs beyond the key count + while (this.outputs.length > keys.length) { + this.removeOutput(this.outputs.length - 1); + } + + this.setSize(this.computeSize()); + }; + }, +});