dsh-comfyui 0.5.2 → 0.5.3

package/README.en.md

@@ -20,10 +20,10 @@
 >
 > | dsh-comfyui | Paired DeepSeek Harness | Notes |
 > | --- | --- | --- |
-> | **0.4.0 (latest, `latest` tag)** | **>= 0.1.2** | From 0.4.0 this plugin uses the new settings service API |
+> | **0.5.x (latest, `latest` tag)** | **>= 0.1.2** (incl. 0.1.5 / 0.1.6 / 0.1.7 prereleases) | From 0.5.3 the settings page works with dsh 0.1.7's settings model (saves apply live, no restart) |
 > | **0.3.x (beta line, `beta` tag)** | **0.1.1** | On older dsh versions stay on the 0.3.x line |
 >
-> Install: `dsh plugin --profile web add dsh-comfyui` (latest 0.4.0) / `dsh plugin --profile web add dsh-comfyui@beta` (0.3.x for older hosts).
+> Install: `dsh plugin --profile web add dsh-comfyui` (latest 0.5.x) / `dsh plugin --profile web add dsh-comfyui@beta` (0.3.x for older hosts).
 
 ## Features
 

package/README.md

@@ -20,10 +20,10 @@
 >
 > | dsh-comfyui | 配对的 DeepSeek Harness | 说明 |
 > | --- | --- | --- |
-> | **0.4.0（最新，`latest` tag）** | **≥ 0.1.2** | 0.4.0 起使用新版 settings 服务 API |
+> | **0.5.x（最新，`latest` tag）** | **≥ 0.1.2**（含 0.1.5 / 0.1.6 / 0.1.7 预发布版） | 0.5.3 起兼容 dsh 0.1.7 的设置机制（设置页保存直接生效，无需重启） |
 > | **0.3.x（beta 线，`beta` tag）** | **0.1.1** | 老版本 dsh 请留在 0.3.x 线 |
 >
-> 安装：`dsh plugin --profile web add dsh-comfyui`（装最新 0.4.0）/ `dsh plugin --profile web add dsh-comfyui@beta`（老宿主装 0.3.x）。
+> 安装：`dsh plugin --profile web add dsh-comfyui`（装最新 0.5.x）/ `dsh plugin --profile web add dsh-comfyui@beta`（老宿主装 0.3.x）。
 
 ## 功能
 

package/lib/config.d.ts

@@ -1,86 +1,93 @@
 /**
  * dsh-comfyui host configuration. The same schema drives the Loader entry
- * config (cordis.yml patch) and the `comfyui:` settings section the browser
- * settings page writes, so one shape covers both doors into the same values.
+ * config (cordis.yml patch) and the settings page, so one shape covers both
+ * doors into the same values.
+ *
+ * Fields the plugin reads at use time are `.volatile()`: since dsh 0.1.7 the
+ * settings service only edits volatile fields (anything else fails with
+ * "Plugin entry has no volatile fields", Issue #11), and the Loader commits a
+ * volatile-only change into the running references without restarting the
+ * plugin. `dataDir` / `maxAssets` / `outputDir` stay ordinary: the store is
+ * built from them at startup, so a change there restarts the plugin.
  */
 import z from '@deepseek-ai/schemastery';
-export declare const Config: z<Schemastery.ObjectS<{
+export declare const Config: z<Schemastery.ObjectS<NoInfer<{
     /** ComfyUI HTTP server base URL. */
-    baseUrl: z<string, string>;
+    baseUrl: z<string, string, "volatile-defined">;
     /** Environment-variable name of the optional API key (credentials ref). */
-    apiKeyEnv: z<string, string>;
+    apiKeyEnv: z<string, string, "volatile-defined">;
     /** Per-request connect/read timeout for the ComfyUI HTTP client. */
-    connectTimeoutMs: z<number, number>;
+    connectTimeoutMs: z<number, number, "volatile-defined">;
     /** How long a synchronous generation (or background job) waits for workflow completion. */
-    timeoutMs: z<number, number>;
+    timeoutMs: z<number, number, "volatile-defined">;
     /** History polling interval while waiting for completion. */
-    pollIntervalMs: z<number, number>;
+    pollIntervalMs: z<number, number, "volatile-defined">;
     /** Max media items returned per completed workflow. */
-    maxMediaItems: z<number, number>;
+    maxMediaItems: z<number, number, "volatile-defined">;
     /** Max bytes the media proxy streams for one file. */
-    maxMediaBytes: z<number, number>;
+    maxMediaBytes: z<number, number, "volatile-defined">;
     /** Directory for plugin data (workflow library, asset index); empty means DSH_HOME/data/dsh-comfyui. */
-    dataDir: z<string, string>;
+    dataDir: z<string, string, "defined">;
     /** Max asset records kept in the asset index. */
-    maxAssets: z<number, number>;
+    maxAssets: z<number, number, "defined">;
     /** Directory holding the per-workflow skill packs. Empty = `<dataDir>/skills`.
      * Separate from `dataDir` on purpose: packs are documents a user may want on
      * another drive, in a synced folder, or under version control, while the
      * JSON state files belong with the rest of the plugin data. Must be absolute;
      * a relative value is ignored. */
-    skillsDir: z<string, string>;
+    skillsDir: z<string, string, "volatile-defined">;
     /** External base URL for generated media (e.g. http://192.168.1.5:3080). Empty = auto-detect the browser's request host, then http://127.0.0.1:<webServerPort>. */
-    mediaHost: z<string, string>;
+    mediaHost: z<string, string, "volatile-defined">;
     /** ComfyUI's output directory on this machine, used to delete asset files
      * from the panel. Empty = infer it from the file paths ComfyUI reports;
      * deletion falls back to removing the index record when neither works
      * (e.g. a ComfyUI running on another host). */
-    outputDir: z<string, string>;
+    outputDir: z<string, string, "defined">;
     /** ComfyUI install root(s) on this machine (absolute paths). Multiple
      * entries are allowed because ComfyUI folders can be mapped/mounted (extra
      * models dirs, several installs, portable copies). The agent reads them to
      * locate ComfyUI files directly (workflows, models, the TTS-Audio-Suite
      * voice library) without guessing or asking the user. */
-    comfyuiDirs: z<string[], string[]>;
-}>, Schemastery.ObjectT<{
+    comfyuiDirs: z<NoInfer<string[]>, NoInfer<string[]>, "volatile-defined">;
+}>>, Schemastery.ObjectT<NoInfer<{
     /** ComfyUI HTTP server base URL. */
-    baseUrl: z<string, string>;
+    baseUrl: z<string, string, "volatile-defined">;
     /** Environment-variable name of the optional API key (credentials ref). */
-    apiKeyEnv: z<string, string>;
+    apiKeyEnv: z<string, string, "volatile-defined">;
     /** Per-request connect/read timeout for the ComfyUI HTTP client. */
-    connectTimeoutMs: z<number, number>;
+    connectTimeoutMs: z<number, number, "volatile-defined">;
     /** How long a synchronous generation (or background job) waits for workflow completion. */
-    timeoutMs: z<number, number>;
+    timeoutMs: z<number, number, "volatile-defined">;
     /** History polling interval while waiting for completion. */
-    pollIntervalMs: z<number, number>;
+    pollIntervalMs: z<number, number, "volatile-defined">;
     /** Max media items returned per completed workflow. */
-    maxMediaItems: z<number, number>;
+    maxMediaItems: z<number, number, "volatile-defined">;
     /** Max bytes the media proxy streams for one file. */
-    maxMediaBytes: z<number, number>;
+    maxMediaBytes: z<number, number, "volatile-defined">;
     /** Directory for plugin data (workflow library, asset index); empty means DSH_HOME/data/dsh-comfyui. */
-    dataDir: z<string, string>;
+    dataDir: z<string, string, "defined">;
     /** Max asset records kept in the asset index. */
-    maxAssets: z<number, number>;
+    maxAssets: z<number, number, "defined">;
     /** Directory holding the per-workflow skill packs. Empty = `<dataDir>/skills`.
      * Separate from `dataDir` on purpose: packs are documents a user may want on
      * another drive, in a synced folder, or under version control, while the
      * JSON state files belong with the rest of the plugin data. Must be absolute;
      * a relative value is ignored. */
-    skillsDir: z<string, string>;
+    skillsDir: z<string, string, "volatile-defined">;
     /** External base URL for generated media (e.g. http://192.168.1.5:3080). Empty = auto-detect the browser's request host, then http://127.0.0.1:<webServerPort>. */
-    mediaHost: z<string, string>;
+    mediaHost: z<string, string, "volatile-defined">;
     /** ComfyUI's output directory on this machine, used to delete asset files
      * from the panel. Empty = infer it from the file paths ComfyUI reports;
      * deletion falls back to removing the index record when neither works
      * (e.g. a ComfyUI running on another host). */
-    outputDir: z<string, string>;
+    outputDir: z<string, string, "defined">;
     /** ComfyUI install root(s) on this machine (absolute paths). Multiple
      * entries are allowed because ComfyUI folders can be mapped/mounted (extra
      * models dirs, several installs, portable copies). The agent reads them to
      * locate ComfyUI files directly (workflows, models, the TTS-Audio-Suite
      * voice library) without guessing or asking the user. */
-    comfyuiDirs: z<string[], string[]>;
-}>>;
+    comfyuiDirs: z<NoInfer<string[]>, NoInfer<string[]>, "volatile-defined">;
+}>>, "plain">;
 export type Config = {
     /** ComfyUI HTTP server base URL. */
     baseUrl: string;
@@ -109,3 +116,12 @@ export type Config = {
     /** ComfyUI install root(s) on this machine; the agent uses them to locate files directly. */
     comfyuiDirs: string[];
 };
+/**
+ * Resolve the Loader's parsed entry config into the plain object the plugin
+ * reads. Call again after `loader/volatile-update`: the references are the
+ * same objects, now holding the new values.
+ * @param raw - parsed entry config; fields may be volatile references.
+ * @param defaultDataDir - data directory used when `dataDir` is empty.
+ * @returns a fully populated plain config.
+ */
+export declare function resolveConfig(raw: Partial<Record<keyof Config, unknown>>, defaultDataDir: string): Config;

package/lib/config.js

@@ -1,24 +1,31 @@
 /**
  * dsh-comfyui host configuration. The same schema drives the Loader entry
- * config (cordis.yml patch) and the `comfyui:` settings section the browser
- * settings page writes, so one shape covers both doors into the same values.
+ * config (cordis.yml patch) and the settings page, so one shape covers both
+ * doors into the same values.
+ *
+ * Fields the plugin reads at use time are `.volatile()`: since dsh 0.1.7 the
+ * settings service only edits volatile fields (anything else fails with
+ * "Plugin entry has no volatile fields", Issue #11), and the Loader commits a
+ * volatile-only change into the running references without restarting the
+ * plugin. `dataDir` / `maxAssets` / `outputDir` stay ordinary: the store is
+ * built from them at startup, so a change there restarts the plugin.
  */
 import z from '@deepseek-ai/schemastery';
 export const Config = z.object({
     /** ComfyUI HTTP server base URL. */
-    baseUrl: z.string().default('http://127.0.0.1:8188'),
+    baseUrl: z.string().default('http://127.0.0.1:8188').volatile(),
     /** Environment-variable name of the optional API key (credentials ref). */
-    apiKeyEnv: z.string().default('COMFYUI_API_KEY'),
+    apiKeyEnv: z.string().default('COMFYUI_API_KEY').volatile(),
     /** Per-request connect/read timeout for the ComfyUI HTTP client. */
-    connectTimeoutMs: z.number().min(1_000).max(60_000).default(10_000),
+    connectTimeoutMs: z.number().min(1_000).max(60_000).default(10_000).volatile(),
     /** How long a synchronous generation (or background job) waits for workflow completion. */
-    timeoutMs: z.number().min(5_000).max(3_600_000).default(900_000),
+    timeoutMs: z.number().min(5_000).max(3_600_000).default(900_000).volatile(),
     /** History polling interval while waiting for completion. */
-    pollIntervalMs: z.number().min(200).max(10_000).default(1_000),
+    pollIntervalMs: z.number().min(200).max(10_000).default(1_000).volatile(),
     /** Max media items returned per completed workflow. */
-    maxMediaItems: z.number().min(1).max(50).default(12),
+    maxMediaItems: z.number().min(1).max(50).default(12).volatile(),
     /** Max bytes the media proxy streams for one file. */
-    maxMediaBytes: z.number().min(64 * 1024).max(512 * 1024 * 1024).default(64 * 1024 * 1024),
+    maxMediaBytes: z.number().min(64 * 1024).max(512 * 1024 * 1024).default(64 * 1024 * 1024).volatile(),
     /** Directory for plugin data (workflow library, asset index); empty means DSH_HOME/data/dsh-comfyui. */
     dataDir: z.string().default(''),
     /** Max asset records kept in the asset index. */
@@ -28,9 +35,9 @@ export const Config = z.object({
      * another drive, in a synced folder, or under version control, while the
      * JSON state files belong with the rest of the plugin data. Must be absolute;
      * a relative value is ignored. */
-    skillsDir: z.string().default(''),
+    skillsDir: z.string().default('').volatile(),
     /** External base URL for generated media (e.g. http://192.168.1.5:3080). Empty = auto-detect the browser's request host, then http://127.0.0.1:<webServerPort>. */
-    mediaHost: z.string().default(''),
+    mediaHost: z.string().default('').volatile(),
     /** ComfyUI's output directory on this machine, used to delete asset files
      * from the panel. Empty = infer it from the file paths ComfyUI reports;
      * deletion falls back to removing the index record when neither works
@@ -41,5 +48,45 @@ export const Config = z.object({
      * models dirs, several installs, portable copies). The agent reads them to
      * locate ComfyUI files directly (workflows, models, the TTS-Audio-Suite
      * voice library) without guessing or asking the user. */
-    comfyuiDirs: z.array(z.string()).default([]),
+    comfyuiDirs: z.array(z.string()).default([]).volatile(),
 });
+/** The volatile-reference protocol shared across cosmokit copies (Symbol.for). */
+const VOLATILE_WRITE = Symbol.for('cosmokit.volatile.write');
+/** Read a config value that may be a volatile reference (dsh 0.1.7+) or a plain value (older hosts). */
+function current(value) {
+    if (typeof value === 'object' && value !== null && VOLATILE_WRITE in value) {
+        return value.get();
+    }
+    return value;
+}
+/**
+ * Resolve the Loader's parsed entry config into the plain object the plugin
+ * reads. Call again after `loader/volatile-update`: the references are the
+ * same objects, now holding the new values.
+ * @param raw - parsed entry config; fields may be volatile references.
+ * @param defaultDataDir - data directory used when `dataDir` is empty.
+ * @returns a fully populated plain config.
+ */
+export function resolveConfig(raw, defaultDataDir) {
+    const str = (value, fallback) => (typeof value === 'string' ? value : fallback);
+    const num = (value, fallback) => (typeof value === 'number' ? value : fallback);
+    const dataDir = str(current(raw.dataDir), '');
+    const dirs = current(raw.comfyuiDirs);
+    return {
+        baseUrl: str(current(raw.baseUrl), 'http://127.0.0.1:8188'),
+        apiKeyEnv: str(current(raw.apiKeyEnv), 'COMFYUI_API_KEY'),
+        connectTimeoutMs: num(current(raw.connectTimeoutMs), 10_000),
+        timeoutMs: num(current(raw.timeoutMs), 900_000),
+        pollIntervalMs: num(current(raw.pollIntervalMs), 1_000),
+        maxMediaItems: num(current(raw.maxMediaItems), 12),
+        maxMediaBytes: num(current(raw.maxMediaBytes), 64 * 1024 * 1024),
+        dataDir: dataDir !== '' ? dataDir : defaultDataDir,
+        maxAssets: num(current(raw.maxAssets), 200),
+        skillsDir: str(current(raw.skillsDir), ''),
+        mediaHost: str(current(raw.mediaHost), ''),
+        outputDir: str(current(raw.outputDir), ''),
+        comfyuiDirs: Array.isArray(dirs)
+            ? dirs.filter((dir) => typeof dir === 'string' && dir.trim() !== '')
+            : [],
+    };
+}

package/lib/index.d.ts

@@ -21,4 +21,4 @@ export declare const inject: string[];
  * The plugin body. The loader validates the entry config against `Config`
  * (defaults applied), then hands the resolved object to apply.
  */
-export declare function apply(ctx: Context, entryConfig: Partial<ConfigType>): Promise<void>;
+export declare function apply(ctx: Context, entryConfig: Partial<Record<keyof ConfigType, unknown>>): Promise<void>;

package/lib/index.js

@@ -1,6 +1,6 @@
 import { homedir } from 'node:os';
 import { isAbsolute, join } from 'node:path';
-import { Config } from './config.js';
+import { Config, resolveConfig } from './config.js';
 import { ComfyUIClient, CLIENT_ID } from './comfyui.js';
 import { ComfyUIStore } from './store.js';
 import { QueueTracker } from './queue.js';
@@ -66,23 +66,10 @@ function defaultDataDir() {
  * (defaults applied), then hands the resolved object to apply.
  */
 export async function apply(ctx, entryConfig) {
-    const resolved = {
-        baseUrl: entryConfig.baseUrl ?? 'http://127.0.0.1:8188',
-        apiKeyEnv: entryConfig.apiKeyEnv ?? 'COMFYUI_API_KEY',
-        connectTimeoutMs: entryConfig.connectTimeoutMs ?? 10_000,
-        timeoutMs: entryConfig.timeoutMs ?? 900_000,
-        pollIntervalMs: entryConfig.pollIntervalMs ?? 1_000,
-        maxMediaItems: entryConfig.maxMediaItems ?? 12,
-        maxMediaBytes: entryConfig.maxMediaBytes ?? 64 * 1024 * 1024,
-        dataDir: entryConfig.dataDir !== undefined && entryConfig.dataDir !== '' ? entryConfig.dataDir : defaultDataDir(),
-        maxAssets: entryConfig.maxAssets ?? 200,
-        skillsDir: entryConfig.skillsDir ?? '',
-        mediaHost: entryConfig.mediaHost ?? '',
-        outputDir: entryConfig.outputDir ?? '',
-        comfyuiDirs: Array.isArray(entryConfig.comfyuiDirs)
-            ? entryConfig.comfyuiDirs.filter((dir) => typeof dir === 'string' && dir.trim() !== '')
-            : [],
-    };
+    // Volatile fields arrive as references on dsh 0.1.7+ (plain values on older
+    // hosts); `resolved` is the one plain object every consumer reads, refreshed
+    // in place when the Loader commits a settings-page change.
+    const resolved = resolveConfig(entryConfig, defaultDataDir());
     const store = new ComfyUIStore(resolved.dataDir, resolved.maxAssets);
     await store.init();
     // Per-workflow skill packs default to `<dataDir>/skills`; `skillsDir` moves
@@ -113,11 +100,27 @@ export async function apply(ctx, entryConfig) {
     // only broadcasts them to the submitting client. Node's global WebSocket
     // (undici) cannot set auth headers, so a remote server behind an
     // authenticating proxy simply shows no progress.
+    const progressUrl = () => resolved.baseUrl.replace(/^http:/, 'ws:').replace(/^https:/, 'wss:').replace(/\/$/, '') + `/ws?clientId=${CLIENT_ID}`;
+    let attachedUrl = progressUrl();
     ctx.effect(() => {
-        const wsUrl = resolved.baseUrl.replace(/^http:/, 'ws:').replace(/^https:/, 'wss:').replace(/\/$/, '') + `/ws?clientId=${CLIENT_ID}`;
-        progress.attach(wsUrl);
+        progress.attach(attachedUrl);
         return () => progress.dispose();
     }, 'dsh-comfyui: progress');
+    /** Pick up a new config in place; a new baseUrl re-points the progress socket. */
+    const refreshConfig = (next) => {
+        Object.assign(resolved, next);
+        const url = progressUrl();
+        if (url !== attachedUrl) {
+            attachedUrl = url;
+            progress.dispose();
+            progress.attach(url);
+        }
+    };
+    // dsh 0.1.7+: a settings-page save commits volatile values into the same
+    // references without restarting the plugin, then notifies this fiber.
+    ctx.on('loader/volatile-update', (() => {
+        refreshConfig(resolveConfig(entryConfig, defaultDataDir()));
+    }));
     const hostHint = createHostHint();
     const runtime = {
         getConfig: () => resolved,
@@ -323,18 +326,25 @@ export async function apply(ctx, entryConfig) {
     let source = () => resolved;
     ctx.inject(['settings'], (settingsCtx) => {
         const settings = settingsCtx.settings;
-        if (typeof settings.installSection !== 'function') {
-            ctx.logger.warn('comfyui: settings service lacks installSection — settings page stays read-only, entry config stands');
+        if (typeof settings.installSection === 'function') {
+            // dsh 0.1.2–0.1.5: the section registry keeps its own copy of the values.
+            settings.installSection(ctx, COMFYUI_NS, Config, resolved, {
+                setSource: (current) => {
+                    source = current;
+                },
+                onChange: () => {
+                    refreshConfig(resolveConfig(source(), defaultDataDir()));
+                },
+            });
             return;
         }
-        settings.installSection(ctx, COMFYUI_NS, Config, resolved, {
-            setSource: (current) => {
-                source = current;
-            },
-            onChange: () => {
-                Object.assign(resolved, source());
-            },
-        });
+        // dsh 0.1.7+: forms are projected from the volatile Config fields and a
+        // save arrives through loader/volatile-update above. This plugin ships its
+        // own settings page, so opt out of any auto-generated one.
+        if (typeof settings.configure === 'function') {
+            const configure = settings.configure.bind(settings);
+            settingsCtx.effect(() => configure({ auto: false }, ctx.fiber), 'dsh-comfyui: settings page policy');
+        }
     });
     ctx.effect(() => {
         const disposers = registerComfyUITools(ctx, runtime);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dsh-comfyui",
-  "version": "0.5.2",
+  "version": "0.5.3",
   "description": "Let the DeepSeek Harness agent smartly drive a local or remote ComfyUI to generate anything, with workflow and asset management panels, per-workflow skill packs, a companion skill and a same-origin media proxy. / 让 DeepSeek Harness 的 Agent 智能驱动本地或远程 ComfyUI 生成任何内容。附带工作流、资产管理面板与技能包管理挂载。配套 skill 与同源媒体代理。",
   "repository": {
     "type": "git",
@@ -49,12 +49,12 @@
     "node": ">=22.19"
   },
   "dependencies": {
-    "@deepseek-ai/schemastery": "^3.18.0",
+    "@deepseek-ai/schemastery": "^3.18.4",
     "fflate": "^0.8.3"
   },
   "peerDependencies": {
     "@deepseek-ai/cordis": "^4.0.1",
-    "@deepseek-ai/dsh-settings": "^0.1.2-alpha.4"
+    "@deepseek-ai/dsh-settings": "^0.1.2-alpha.4 || ^0.1.5-alpha.1 || ^0.1.6-alpha.1 || ^0.1.7-alpha.1"
   },
   "devDependencies": {
     "@deepseek-ai/cordis": "^4.0.1",