dsh-dock 0.11.5 → 0.12.0

package/src/host-core.js

@@ -1,27 +1,36 @@
 // dsh-dock · 宿主共享内核：各功能模块（features/*/host.js）共用的常量与工具。
 // 放在 src/ 而非 features/：不属于任何单个功能；提取功能模块独立成包时按需随包复制。
+import { readFileSync, existsSync } from 'node:fs'
+import { join } from 'node:path'
+import { homedir } from 'node:os'
 import z from '@deepseek-ai/schemastery'
 
-/** dsh-dock 自有 settings 命名空间（插件级配置，如图片理解代理）。 */
+/** dsh-dock 自有 settings 命名空间 = profile 条目 id（cordis.patch.yml 的 id）。 */
 export const DOCK_NS = 'dsh-dock'
 
 /** 自有命名空间的 schema（功能开关 + 图片理解代理 + 任务动画/任务通知配置 + 远程访问账号）。
- *  运行状态模块只读共享追踪、不写配置，因此没有自己的段。 */
+ *  运行状态模块只读共享追踪、不写配置，因此没有自己的段。
+ *
+ *  dsh ≥ 0.1.7-alpha.1：settings 服务改为 SettingsForms——
+ *  ① 插件必须导出同名 Config（否则 mutate 报 No configurable plugin entry）；
+ *  ② ns 是 profile 条目 id（此处 DOCK_NS=cordis.patch.yml 的 id）；
+ *  ③ 活编辑路径必须落在 .volatile() 字段上，否则 write 抛 not volatile。
+ *  每个顶层段整体 volatile：段内任意 path 可被面板 mutate，无需逐字段标记。 */
 export const DockConfig = z.object({
   // 宿主侧功能开关（id -> boolean）：客户端面板 toggle 即时同步过来，
   // 重启 dsh 后按此表决定宿主半部 setup 哪些功能（路由注册、事件订阅等）。
-  features: z.dict(z.boolean()).default({}),
+  features: z.dict(z.boolean()).default({}).volatile(),
   remoteAuth: z.object({
     /** 远程访问登录账号（明文用户名；密码只存加盐哈希）。 */
     username: z.string().default(''),
     passwordHash: z.string().default(''),
     salt: z.string().default(''),
-  }).default({}),
+  }).default({}).volatile(),
   visionProxy: z.object({
     enabled: z.boolean().default(false),
     provider: z.string().default(''),
     model: z.string().default(''),
-  }).default({}),
+  }).default({}).volatile(),
   // 【用量记录】模块的单价配置：官网抓取的刊例价常与实际计费不符（第三方/中转、
   // 折扣、自建端点等），这里保存用户自填单价并优先用于费用估算。
   // 详见 features/tokenlog/host.js 的 resolvePricing（优先级：自定义 > 官网 > 内置 > 兜底）。
@@ -42,7 +51,9 @@ export const DockConfig = z.object({
       cacheRead: z.number().default(0),
       cacheWrite: z.number().default(0),
       /** 分时段价（可多段，如 DeepSeek 的高峰/优惠时段）：命中某段用该段价，否则用上面的基准价。
-       *  start/end 为本地小时数 0~24；start>end 表示跨零点；单段等价旧的 peak。 */
+       *  start/end 为本地小时数 0~24；start>end 表示跨零点；单段等价旧的 peak。
+       *  days：日期类型——all=每天（默认）；workday=仅工作日（非周末且非下方 holidays）；
+       *  nonworkday=仅周末或节假日。用于「周末/节假日谷价、仅工作日高峰」这类计价。 */
       peaks: z.array(z.object({
         start: z.number().default(0),
         end: z.number().default(0),
@@ -50,8 +61,12 @@ export const DockConfig = z.object({
         output: z.number().default(0),
         cacheRead: z.number().default(0),
         cacheWrite: z.number().default(0),
+        days: z.string().default('all'),
       })).default([]),
     })).default([]),
+    /** 法定节假日：单日 YYYY-MM-DD 或区间 YYYY-MM-DD~YYYY-MM-DD（含两端）。
+     *  供 peaks.days=workday/nonworkday 判断；周末（周六/周日）始终视为非工作日。 */
+    holidays: z.array(z.string()).default([]),
     /** 未匹配任何条目的模型所用兜底单价。 */
     fallback: z.object({
       input: z.number().default(2.16),
@@ -59,7 +74,7 @@ export const DockConfig = z.object({
       cacheRead: z.number().default(0.43),
       cacheWrite: z.number().default(4.32),
     }).default({}),
-  }).default({}),
+  }).default({}).volatile(),
   // 【任务动画】模块：只放动画本身（动效开关/模式/桌面伙伴大小）。
   // 通知相关的字段已全部迁往下面的 notify 段（见 migrateNotifyConfig）；
   // 旧值不在 schema 里也会被 schemastery 原样保留，迁移读得到。
@@ -68,7 +83,7 @@ export const DockConfig = z.object({
     effectMode: z.string().default('flow'),
     // 桌面伙伴场景缩放（0.85~2.2；浮层右下角也可直接拖动缩放）
     robotScale: z.number().default(1.35),
-  }).default({}),
+  }).default({}).volatile(),
   // 【任务通知】模块：页内卡片 / 提示音 / 浏览器系统通知 / 群机器人推送。
   // 模块自身的启停由 features.notify 开关负责（独立菜单项），这里只放通知行为配置。
   notify: z.object({
@@ -92,9 +107,99 @@ export const DockConfig = z.object({
     feishuWebhook: z.string().default(''),
     // 一次性迁移标记：animation 段的旧通知配置已搬到本段（搬完置 true，避免每次启动重复写）
     migratedFromAnimation: z.boolean().default(false),
-  }).default({}),
+  }).default({}).volatile(),
 })
 
+// ── 本地配置镜像（替代已移除的 settings.get） ─────────────────────────────
+// apply(ctx, config) 绑定带 volatile 引用的 Config；每次操作前 plainify 一次取快照。
+// settings.mutate 成功后由调用方/ volatile-update 刷新。测试桩可用 seedDockConfig 注入。
+
+/** @type {null | Record<string, unknown>} */
+let dockConfigBound = null
+
+/** 是否为 cosmokit Volatile 引用（跨副本用 Symbol 协议识别，不依赖包导入）。 */
+function isVolatileRef(value) {
+  return typeof value === 'object' && value !== null && Symbol.for('cosmokit.volatile.write') in value
+}
+
+/** 递归解开 volatile 引用 → 可 JSON 化的普通对象。 */
+export function plainifyDockConfig(value) {
+  if (isVolatileRef(value)) return plainifyDockConfig(value.get())
+  if (Array.isArray(value)) return value.map(plainifyDockConfig)
+  if (value !== null && typeof value === 'object') {
+    const out = {}
+    for (const [k, v] of Object.entries(value)) out[k] = plainifyDockConfig(v)
+    return out
+  }
+  return value
+}
+
+/** 由 index.js apply 挂载/刷新：持有 Config 引用并在 loader/volatile-update 后重读。 */
+export function bindDockConfig(config) {
+  dockConfigBound = config === undefined || config === null ? null : plainifyDockConfig(config)
+  return dockConfigBound
+}
+
+/** 测试/本地桩：直接写入镜像（绕过宿主 settings）。 */
+export function seedDockConfig(value) {
+  dockConfigBound = value === undefined || value === null ? null : plainifyDockConfig(value)
+}
+
+/**
+ * 读自有命名空间根对象。优先级：
+ * 1) apply 绑定的 Config 镜像（新宿主活值）
+ * 2) 测试/旧宿主的 settings.get（若仍存在）
+ * 3) settings.describe 里 ns=DOCK_NS 的 value（SettingsForms 读路径）
+ * 4) null（调用方回退默认）
+ */
+export function readDockRoot(ctx) {
+  if (dockConfigBound) return dockConfigBound
+  try {
+    const settings = ctx && typeof ctx.get === 'function' ? ctx.get('settings') : null
+    if (settings) {
+      if (typeof settings.get === 'function') {
+        const v = settings.get(DOCK_NS)
+        if (v && typeof v === 'object') return v
+      }
+      if (typeof settings.describe === 'function') {
+        const views = settings.describe({ redactSecrets: false }) || []
+        const hit = views.find((d) => d && d.ns === DOCK_NS && d.value && typeof d.value === 'object')
+        if (hit) return hit.value
+      }
+    }
+  } catch { /* settings 未挂载 */ }
+  return null
+}
+
+/**
+ * 写自有命名空间一段（走 SettingsForms.mutate；成功后同步本地镜像）。
+ * @param {object} ctx Cordis context
+ * @param {string[]} path 段路径（如 ['animation']）
+ * @param {unknown} value 整段值
+ * @param {number} [expectedRevision] describe 的 revision（乐观锁，可选）
+ */
+export async function mutateDockSection(ctx, path, value, expectedRevision) {
+  const settings = ctx && typeof ctx.get === 'function' ? ctx.get('settings') : null
+  if (!settings || typeof settings.mutate !== 'function') {
+    throw new Error('settings 服务不可用，配置无法持久化')
+  }
+  await settings.mutate(DOCK_NS, [{ op: 'set', path, value }], expectedRevision)
+  if (dockConfigBound) {
+    const next = { ...dockConfigBound }
+    let node = next
+    for (let i = 0; i < path.length - 1; i++) {
+      const key = path[i]
+      const child = node[key] && typeof node[key] === 'object' && !Array.isArray(node[key]) ? { ...node[key] } : {}
+      node[key] = child
+      node = child
+    }
+    if (path.length > 0) next[path[path.length - 1]] = value
+    else Object.assign(next, value)
+    dockConfigBound = next
+  }
+  return value
+}
+
 /** 通知配置字段清单（schema、迁移、客户端默认值三处共用同一份键名）。 */
 export const NOTIFY_FIELDS = [
   'notifyOnComplete', 'notifyOnError', 'notifyOnConfirm', 'notifyStayMs',
@@ -112,9 +217,7 @@ export const NOTIFY_FIELDS = [
  */
 export async function migrateNotifyConfig(ctx) {
   try {
-    const settings = ctx.get('settings')
-    if (!settings || typeof settings.get !== 'function' || typeof settings.mutate !== 'function') return
-    const root = settings.get(DOCK_NS)
+    const root = readDockRoot(ctx)
     const notify = root && typeof root === 'object' && root.notify && typeof root.notify === 'object' ? root.notify : null
     if (notify && notify.migratedFromAnimation === true) return
     const animation = root && typeof root === 'object' && root.animation && typeof root.animation === 'object' ? root.animation : null
@@ -127,7 +230,7 @@ export async function migrateNotifyConfig(ctx) {
     // 避免 settings 命名空间尚未生效时误把「空迁移」当完成（那会丢掉旧配置）。
     if (copied === 0) return
     const next = Object.assign({}, notify || {}, legacy, { migratedFromAnimation: true })
-    await settings.mutate(DOCK_NS, [{ op: 'set', path: ['notify'], value: next }])
+    await mutateDockSection(ctx, ['notify'], next)
     console.log('[dsh-dock] notify config migrated from animation section; fields copied:', copied)
   } catch (e) {
     console.warn('[dsh-dock] notify config migration skipped:', (e && e.message) || String(e))
@@ -144,20 +247,55 @@ export async function migrateNotifyConfig(ctx) {
  */
 export async function migrateModelsFeatureId(ctx) {
   try {
-    const settings = ctx.get('settings')
-    if (!settings || typeof settings.get !== 'function' || typeof settings.mutate !== 'function') return
-    const root = settings.get(DOCK_NS)
+    const root = readDockRoot(ctx)
     const features = root && typeof root === 'object' && root.features && typeof root.features === 'object' ? root.features : null
     if (!features || typeof features.models !== 'boolean' || typeof features.modelconfig === 'boolean') return
     const next = Object.assign({}, features, { modelconfig: features.models })
     delete next.models
-    await settings.mutate(DOCK_NS, [{ op: 'set', path: ['features'], value: next }])
+    await mutateDockSection(ctx, ['features'], next)
     console.log('[dsh-dock] feature id migrated: features.models -> features.modelconfig =', features.models)
   } catch (e) {
     console.warn('[dsh-dock] models feature id migration skipped:', (e && e.message) || String(e))
   }
 }
 
+/**
+ * 一次性迁移：旧 settings.yaml 已被宿主改名为 settings.yaml.imported；
+ * 当时 dsh-dock 尚未导出 Config，importLegacyDocument 对本段 update 会失败，
+ * 功能开关表停在 imported 文件里。配置可写后把 features 补写进 profile。
+ */
+export async function migrateImportedFeatures(ctx) {
+  try {
+    const root = readDockRoot(ctx)
+    const features = root && typeof root === 'object' && root.features && typeof root.features === 'object' ? root.features : null
+    if (features && Object.keys(features).length > 0) return
+    const home = process.env.DSH_HOME || join(homedir(), '.dsh')
+    const file = join(home, 'settings.yaml.imported')
+    if (!existsSync(file)) return
+    const text = readFileSync(file, 'utf8')
+    // 极简 YAML：仅取 dsh-dock.features 下的 `key: true|false` 行（避免引入完整解析器）
+    const lines = text.split(/\r?\n/)
+    let inDock = false
+    let inFeatures = false
+    const imported = {}
+    for (const line of lines) {
+      if (/^dsh-dock:\s*$/.test(line)) { inDock = true; inFeatures = false; continue }
+      if (inDock && /^\S/.test(line) && !/^dsh-dock:/.test(line)) { inDock = false; inFeatures = false }
+      if (inDock && /^\s{2}features:\s*$/.test(line)) { inFeatures = true; continue }
+      if (inDock && inFeatures && /^\s{2}\S/.test(line)) { inFeatures = false }
+      if (inDock && inFeatures) {
+        const m = /^\s{4}([A-Za-z0-9_-]+):\s*(true|false)\s*$/.exec(line)
+        if (m) imported[m[1]] = m[2] === 'true'
+      }
+    }
+    if (Object.keys(imported).length === 0) return
+    await mutateDockSection(ctx, ['features'], imported)
+    console.log('[dsh-dock] features imported from settings.yaml.imported:', imported)
+  } catch (e) {
+    console.warn('[dsh-dock] imported features migration skipped:', (e && e.message) || String(e))
+  }
+}
+
 /** 任务动画 effectMode 合法值（客户端动画模式）。 */
 export const ANIMATION_MODES = [
   'flow', 'breathe', 'ring', 'orbit', 'robot', 'matrix', 'stars', 'aurora', 'space',