dsh-apis-plugin 0.1.1 → 0.1.3

package/api-tools.js

@@ -6,16 +6,31 @@ import { readFileSync, writeFileSync } from 'node:fs'
 import { join } from 'node:path'
 import Schema from '@deepseek-ai/schemastery'
 
-// 读取目录下 apis.txt 作为默认接口列表；支持空行与 # 注释
-function loadApisTxt(dir) {
-  if (!dir) return []
+// 读取目录下 api.cfg（key=value 行，# 注释）：baseUrl 为服务前缀；apis 为接口列表，
+// 支持逗号分隔同行书写，或 apis= 下面逐行一个接口
+function loadApiCfg(dir) {
+  const empty = { apis: [] }
+  if (!dir) return empty
   try {
-    return readFileSync(join(dir, 'apis.txt'), 'utf8')
-      .split(/\r?\n/)
-      .map((line) => line.trim())
-      .filter((line) => line && !line.startsWith('#'))
+    const cfg = { apis: [] }
+    let current = null
+    // 去掉 UTF-8 BOM（Windows 记事本默认会加），否则首个 key 解析失败
+    const text = readFileSync(join(dir, 'api.cfg'), 'utf8').replace(/^\uFEFF/, '')
+    for (const raw of text.split(/\r?\n/)) {
+      const line = raw.trim()
+      if (!line || line.startsWith('#')) continue
+      const m = line.match(/^([\w-]+)\s*=\s*(.*)$/)
+      if (m) {
+        current = m[1]
+        if (m[2]) cfg[current] = current === 'apis' ? m[2].split(',').map((s) => s.trim()).filter(Boolean) : m[2]
+        continue
+      }
+      // 无 = 的行归属上一个 key（apis 的逐行列举形式）
+      if (current === 'apis') cfg.apis.push(line)
+    }
+    return cfg
   } catch {
-    return []
+    return empty
   }
 }
 
@@ -23,7 +38,7 @@ function loadApisTxt(dir) {
 function loadApiDoc(dir) {
   if (!dir) return ''
   try {
-    return readFileSync(join(dir, 'api_doc.md'), 'utf8')
+    return readFileSync(join(dir, 'api_doc.md'), 'utf8').replace(/^\uFEFF/, '')
   } catch {
     return ''
   }
@@ -62,7 +77,7 @@ export function syncClientNs(dir, ns) {
  * @param {string} options.ns               settings 命名空间，须与前端卡片的 NS 一致
  * @param {string} [options.toolPrefix]     工具名前缀默认值，生成 {prefix}_api_doc / {prefix}_api_request，可被 config 覆盖
  * @param {string} [options.domain]         领域名默认值，用于拼接工具描述 prompt，可被 config 覆盖
- * @param {string} [options.apiDir]         apis.txt 与 api_doc.md 所在目录默认值，可被 config 覆盖
+ * @param {string} [options.apiDir]         api.cfg 与 api_doc.md 所在目录默认值，可被 config 覆盖
  * @param {string} [options.defaultBaseUrl] 接口服务前缀默认值（域名 + nginx 前缀 + 网关路由段）
  * @param {string[]} [options.defaultEndpoints] yml 之外的额外默认接口
  */
@@ -74,12 +89,14 @@ export function defineApiPlugin(options) {
     domain: Schema.string().default(domain),
     // 工具名前缀：生成 {prefix}_api_doc / {prefix}_api_request
     toolPrefix: Schema.string().default(toolPrefix),
-    // apis.txt 与 api_doc.md 所在目录（留空则只用 endpoints）
+    // api.cfg 与 api_doc.md 所在目录（留空则只用 endpoints）
     apiDir: Schema.string().default(apiDir),
     endpoints: Schema.array(Schema.string()).default([]),
     // 接口服务前缀：域名 + nginx 前缀 + 网关路由段
     // （接口路径本身已含服务前缀，最终形如 /prod-api/xxx/users/detail）
     baseUrl: Schema.string().default(defaultBaseUrl),
+    // 内部字段：客户端「加载API」按钮改写它触发服务端重扫目录
+    scanToken: Schema.string().default(''),
   })
 
   // 依赖部署挂载的设置服务与工具服务
@@ -89,24 +106,54 @@ export function defineApiPlugin(options) {
     // config 覆盖优先，回退工厂默认值（兼容旧用户层保存值缺字段的情况）
     const prefix = config.toolPrefix || toolPrefix
     const domainName = config.domain || domain
-    const docDir = config.apiDir || apiDir
-
-    // 合并 apis.txt 与 yml 配置作为 base 层默认值（去重）
-    const endpoints = [...new Set([...loadApisTxt(docDir), ...defaultEndpoints, ...(config.endpoints ?? [])])]
+    // 部署侧静态接口（yml config.endpoints + 工厂默认），与 api.cfg 动态读取分离，
+    // 避免「加载API」重扫时把启动时的旧 api.cfg 列表拼回去（导致删掉的接口仍可请求）
+    const ymlApiDir = config.apiDir || apiDir
+    const staticEndpoints = [...new Set([...defaultEndpoints, ...(config.endpoints ?? [])])]
+    // 启动时以当前目录 api.cfg 为权威范围，∪ 静态接口作为 base
+    const bootEndpoints = [...new Set([...loadApiCfg(ymlApiDir).apis, ...staticEndpoints])]
 
     // 以组合配置为 base 层注册 settings 命名空间，卸载插件时注册随 fiber 一并清理
-    const scope = ctx.settings.register(ns, Config, { base: { ...config, endpoints } })
+    const scope = ctx.settings.register(ns, Config, { base: { ...config, endpoints: bootEndpoints } })
+
+    // 当前生效目录：用户层保存值优先（重启后仍生效），回退部署侧配置
+    let docDir = scope.get()?.apiDir || ymlApiDir
 
-    // 每次已提交变更后收到通知
+    // 文档按当前生效目录读取；用户层改写 apiDir 后随 watch 刷新
+    let docSections = splitDocSections(loadApiDoc(docDir))
+
+    // 每次已提交变更后收到通知；「加载API」以 scanToken 变化标记，触发目录重扫
+    let lastScanToken = scope.get()?.scanToken ?? ''
     ctx.effect(
-      () => scope.watch(() => {
+      () => {
+        console.log(`[${ns}] watch registering`)
+        return scope.watch((next) => {
+          try {
+            console.log(`[${ns}] watch fired; apiDir=${next.apiDir}, scanToken=${next.scanToken}`)
+            const dir = next.apiDir || apiDir
+        // 目录变化或显式重扫时重读文档
+        if (dir !== docDir || next.scanToken !== lastScanToken) {
+          docDir = dir
+          docSections = splitDocSections(loadApiDoc(dir))
+        }
+        if (next.scanToken !== lastScanToken) {
+          lastScanToken = next.scanToken
+          // 以最新 api.cfg 为权威范围 ∪ 静态接口，整体接管用户层 endpoints（去重；值未变时不提交，避免循环）
+          // 用最新读取结果而非启动时的快照，这样从 api.cfg 删掉的接口重扫后即失效
+          const merged = [...new Set([...loadApiCfg(dir).apis, ...staticEndpoints])]
+          const cur = Array.isArray(next.endpoints) ? next.endpoints : []
+          if (merged.join('\n') !== cur.join('\n')) scope.update({ endpoints: merged })
+        }
         console.log(`${ns}: settings updated`)
-      }),
+          } catch (err) {
+            console.error(`[${ns}] watch handler error:`, err)
+          }
+        })
+      },
       `${ns}: settings watch`,
-    )
+  )
 
     // ---------- agent 工具 ----------
-    const docSections = splitDocSections(loadApiDoc(docDir))
 
     // 当前生效的接口列表（用户层保存值优先，回退默认值）
     function currentEndpoints() {
@@ -114,7 +161,7 @@ export function defineApiPlugin(options) {
         const value = scope.get()
         if (Array.isArray(value?.endpoints) && value.endpoints.length) return value.endpoints
       } catch { /* scope.get 不可用时回退 */ }
-      return endpoints
+      return bootEndpoints
     }
 
     // 工具 1：查接口文档，让模型了解每个接口的参数与响应（prompt 按领域名拼接）
@@ -158,7 +205,12 @@ export function defineApiPlugin(options) {
           return `接口 ${norm} 不在已配置列表中。可用接口：\n` + list.join('\n')
         }
 
-        const url = new URL(config.baseUrl.replace(/\/+$/, '') + matched)
+        // 服务前缀：api.cfg 优先（改文件即生效，无需重启），回退部署配置
+        const base = loadApiCfg(docDir).baseUrl || scope.get()?.baseUrl || ''
+        if (!base) {
+          return `未配置接口服务前缀 baseUrl。请在文档目录 ${docDir || '(未配置)'} 下新建 api.cfg 写入 baseUrl=http://... ，或在部署配置中设置。`
+        }
+        const url = new URL(base.replace(/\/+$/, '') + matched)
         for (const [k, v] of Object.entries(args.query ?? {})) {
           url.searchParams.set(k, String(v))
         }
@@ -178,7 +230,7 @@ export function defineApiPlugin(options) {
       },
     })
 
-    console.log(`[${ns}] loaded; endpoints=${endpoints.length}, doc sections=${docSections.length}`)
+    console.log(`[${ns}] loaded; endpoints=${bootEndpoints.length}, doc sections=${docSections.length}`)
   }
 
   return { Config, inject, apply }

package/client.js

@@ -34,6 +34,8 @@ window.__ModuleLoader__.load({
 			.apis-save{background:var(--dsw-alias-label-primary);color:var(--dsw-alias-bg-layer-3)}
 			.apis-row{display:flex;align-items:center;gap:8px}
 			.apis-rowLabel{width:44px;flex-shrink:0;font-size:13px;color:var(--dsw-alias-label-primary)}
+			.apis-rowLabelWide{width:auto;white-space:nowrap}
+			.apis-hr{width:100%;height:0;border:0;border-top:.5px solid var(--dsw-alias-border-l2);margin:0}
 			.apis-input{box-sizing:border-box;flex:1;min-width:0;font:inherit;color:var(--dsw-alias-label-primary);background:transparent;border:.5px solid var(--dsw-alias-border-l4);border-radius:8px;padding:6px 10px}
 			.apis-remove{appearance:none;font:inherit;font-size:13px;cursor:pointer;background:none;border:none;border-radius:8px;padding:5px 10px;color:var(--dsw-alias-label-tertiary)}
 			.apis-remove:hover:not(:disabled){color:var(--dsw-alias-label-primary)}
@@ -80,25 +82,49 @@ window.__ModuleLoader__.load({
 		function ApisCard(props) {
 			const state = props.useApisCard((s) => s);
 			const [draft, setDraft] = react.useState(null); // string[]，null 表示未编辑
+			const [dirDraft, setDirDraft] = react.useState(null); // 文档目录，null 表示未编辑
 			const [saving, setSaving] = react.useState(false);
+			const [loading, setLoading] = react.useState(false); // 加载API 扫描中
 			const [saved, setSaved] = react.useState(false); // 保存成功后短暂提示
+			const [loaded, setLoaded] = react.useState(false); // 加载API 完成后短暂提示
 			const [open, setOpen] = react.useState(false); // 折叠态只显示标题行
 			const ready = state.status === "ready" && state.writable;
 
 			/** 当前展示的接口列表：编辑中取 draft，否则取已保存值 */
 			const list = draft ?? (state.value?.endpoints ?? []).map(String);
 			const dirty = draft !== null;
+			/** 当前展示的文档目录：编辑中取 dirDraft，否则取已保存值 */
+			const savedDir = state.value?.apiDir ?? "";
+			const shownDir = dirDraft ?? savedDir;
+			const dirDirty = dirDraft !== null && dirDraft !== savedDir;
 
 			async function save() {
-				if (saving || !ready || !dirty) return;
+				if (saving || !ready || (!dirty && !dirDirty)) return;
 				setSaving(true);
-				await scope.set("endpoints", draft);
+				if (dirDirty) await scope.set("apiDir", dirDraft); // 只存配置，扫描交给「加载API」
+				if (dirty) await scope.set("endpoints", draft);
 				setSaving(false);
 				setDraft(null);
+				setDirDraft(null);
 				setSaved(true); // 显示「已保存」提示，2 秒后消失
 				setTimeout(() => setSaved(false), 2000);
 			}
 
+			/** 加载API：把目录写入配置并翻转 scanToken，服务端 watch 重扫 apis.txt 后回写接口列表 */
+			async function loadApis() {
+				if (loading || !ready || !shownDir.trim()) return;
+				setLoading(true);
+				try {
+					if (dirDirty) await scope.set("apiDir", shownDir.trim());
+					await scope.set("scanToken", String(Date.now()));
+					setDirDraft(null);
+					setLoaded(true);
+					setTimeout(() => setLoaded(false), 2000);
+				} finally {
+					setLoading(false);
+				}
+			}
+
 			// 单行：接口N 标签 + 输入框 + 删除按钮
 			const row = (v, i) => react_jsx_runtime.jsxs("div", {
 				className: "apis-row",
@@ -135,8 +161,25 @@ window.__ModuleLoader__.load({
 							react_jsx_runtime.jsx(Chevron, { open }),
 						],
 					}),
-					// 展开体：接口行列表 + 底部操作条（与原生一致：分隔线 + 右对齐按钮）
+					// 展开体：API配置目录行 + 分隔线 + 接口行列表 + 底部操作条
 					open && react_jsx_runtime.jsxs("div", { className: "apis-body", children: [
+						// API配置：文档目录（apis.txt / api_doc.md 所在目录）+ 加载API 重扫按钮
+						react_jsx_runtime.jsxs("div", { className: "apis-row", children: [
+							react_jsx_runtime.jsx("div", { className: "apis-rowLabel apis-rowLabelWide", children: "API配置" }),
+							react_jsx_runtime.jsx("input", {
+								value: shownDir, disabled: !ready || saving || loading,
+								onChange: (e) => setDirDraft(e.target.value),
+								placeholder: "api.cfg / api_doc.md 所在目录",
+								className: "apis-input",
+							}),
+							react_jsx_runtime.jsx("button", {
+								type: "button", disabled: !ready || saving || loading || !shownDir.trim(),
+								onClick: loadApis,
+								className: "apis-btn apis-discard", children: loading ? "扫描中…" : "加载API",
+							}),
+							loaded && react_jsx_runtime.jsx("span", { className: "apis-saved", children: "已加载" }),
+						] }),
+						react_jsx_runtime.jsx("hr", { className: "apis-hr" }),
 						!state.writable && react_jsx_runtime.jsx("span", { className: "apis-description", children: "只读" }),
 						list.map(row),
 						react_jsx_runtime.jsx("button", {
@@ -148,12 +191,12 @@ window.__ModuleLoader__.load({
 							// 保存成功后的短暂提示（占按钮行左侧）
 							react_jsx_runtime.jsx("span", { className: "apis-saved", children: saved ? "已保存" : "" }),
 							react_jsx_runtime.jsx("button", {
-								type: "button", disabled: !dirty || saving,
-								onClick: () => setDraft(null),
-								className: "apis-btn apis-discard", children: "放弃修改",
+								type: "button", disabled: (!dirty && !dirDirty) || saving,
+								onClick: () => { setDraft(null); setDirDraft(null); },
+							className: "apis-btn apis-discard", children: "放弃修改",
 							}),
 							react_jsx_runtime.jsx("button", {
-								type: "button", disabled: !ready || !dirty || saving,
+								type: "button", disabled: !ready || (!dirty && !dirDirty) || saving,
 								onClick: save, children: saving ? "保存中…" : "保存",
 								className: "apis-btn apis-save",
 							}),

package/cordis.patch.yml

@@ -7,9 +7,10 @@
         domain: ""
         # 工具名前缀：生成 {prefix}_api_doc / {prefix}_api_request
         toolPrefix: api
-        # apis.txt 与 api_doc.md 所在目录（可选，留空则只用 endpoints）
+        # api.cfg 与 api_doc.md 所在目录（可选，留空则只用 endpoints）
         apiDir: ""
         # 默认接口列表
         endpoints: []
         # 接口服务前缀：域名 + nginx 前缀 + 网关路由段
+        # （也可在 apiDir 下 api.cfg 写 baseUrl=... 覆盖，改文件即生效无需重启）
         baseUrl: ""

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dsh-apis-plugin",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "通用接口管理插件：把任意一套 HTTP 接口注册成 agent 可用的文档查询与请求双工具",
   "type": "module",
   "license": "MIT",