dsh-free-search 0.5.0 → 0.5.6

package/README.md

@@ -186,7 +186,9 @@ dsh web
 
 #### 配置文件
 
-DSH 0.1.7-rc.1 起，配置跟随 profile 的插件条目保存：设置页与 `/free-search-engine` 都会写入当前 profile 的 `cordis.patch.yml` 中 `web-search-free`（`dsh-free-search`）条目的 `config`。旧版 `~/.dsh/settings.yaml` 的 `free-search:` 段只会在启动时自动导入一次，随后原文件被重命名为 `settings.yaml.imported`。
+DSH 0.1.7-rc.1 起，配置跟随 profile 的插件条目保存：设置页与 `/free-search-engine` 都会写入当前 profile 的 `cordis.patch.yml` 中 `web-search-free`（`dsh-free-search`）条目的 `config`。
+
+旧版 `~/.dsh/settings.yaml` 的 `free-search:` 段**不会被 DSH 核心自动导入**（核心的 `importLegacyDocument` 只为 `ui-developer-tools` / `ui-onboarding` / `shell` 三个段提供了映射），原文件在导入其它段后会被改名为 `settings.yaml.imported`，该段的值只留在那里。插件会在启动时检测 `settings.yaml.imported`（或仍存在的 `settings.yaml`）中的 `free-search:` 段，把可识别的字段**一次性补种**进当前 profile 的条目 `config`（写一次后不再重复，可在启动日志看到 `free-search: migrated N field(s)…`）。如果你想手动处理，也可以照着 `settings.yaml.imported` 里的值在插件页行配置中填一遍。
 
 ```yaml
 # profiles/<profile>/cordis.patch.yml 中该条目的 config：
@@ -495,7 +497,9 @@ The command only changes the preferred engine; search still goes through `web_se
 
 #### Configuration File
 
-Since DSH 0.1.7-rc.1 the configuration is stored with the profile's plugin entry: the settings page and `/free-search-engine` both write the `config` of the `web-search-free` (`dsh-free-search`) entry in the active profile's `cordis.patch.yml`. The old `free-search:` section of `~/.dsh/settings.yaml` is imported once at startup; the file is then renamed to `settings.yaml.imported`.
+Since DSH 0.1.7-rc.1 the configuration is stored with the profile's plugin entry: the settings page and `/free-search-engine` both write the `config` of the `web-search-free` (`dsh-free-search`) entry in the active profile's `cordis.patch.yml`.
+
+The old `free-search:` section of `~/.dsh/settings.yaml` is **not** imported by the DSH core (`importLegacyDocument` only maps `ui-developer-tools` / `ui-onboarding` / `shell`); the file is renamed to `settings.yaml.imported` after the other sections are imported, and the section's values stay there. The plugin detects that section in `settings.yaml.imported` (or in a still-present `settings.yaml`) at startup and seeds the recognized fields into this entry's `config` **once** (watch for `free-search: migrated N field(s)…` in the startup log). You can also migrate manually by copying the values from `settings.yaml.imported` into the plugin row config.
 
 ```yaml
 # config of that entry in profiles/<profile>/cordis.patch.yml:

package/cordis.patch.yml

@@ -1,16 +1,19 @@
 # dsh-free-search — free web search providers (no API key needed)
-# Registers the free-search plugin into ctx.web + a settings bridge
-# (/api/dsh-free-search-settings) that serves the "free-search" namespace.
-# The engine (ddg / ddg-lite / bing) is chosen from the web Settings page:
-#   DSH 0.1.6-alpha.2+: sidebar Plugins page -> Installed -> free-search -> row config
-#   DSH 0.1.5 and earlier: Settings > Plugins > Configurable > Free Search
-# or from settings.yaml:
-#   free-search:
-#     provider: bing
-#     region: cn-zh        # DuckDuckGo region
-#     bingMarket: zh-CN    # Bing market
+# Registers the plugin into ctx.web + a settings bridge served at
+# /api/dsh-free-search-settings.
+# The engine is chosen from the sidebar Plugins page -> Free Search row config
+# (plugins.row.config, DSH 0.1.7-rc.1+), from the /free-search-engine command,
+# or directly via this entry's config, e.g.:
+#   provider: bing        # engine id: ddg / bing / baidu / kimi / aliyun / auto / ...
+#   region: cn-zh         # DuckDuckGo region
+#   bingMarket: zh-CN     # Bing market
+# A legacy ~/.dsh/settings.yaml "free-search:" section is migrated into this
+# entry's config once at startup (see README).
 # Failed/empty engines automatically fall back to the next free engine.
-# web.searchProvider must point at this plugin's provider id (ddg).
+# web.searchProvider must point at this plugin's provider id (ddg); the runtime
+# also takes over when it is unset or still the shipped default
+# (deepseek-official), and only warns when another provider was chosen
+# explicitly.
 - insert:
     - id: web-search-free
       name: dsh-free-search

package/lib/client.js

@@ -265,7 +265,7 @@ window.__ModuleLoader__.load({
     };
     const tt = (lang) => I18N[lang === "en" ? "en" : "zh"];
     // 当前插件版本（与 lib/index.js 的 PLUGIN_VERSION 保持一致）
-    const PLUGIN_VERSION = "0.5.0";
+    const PLUGIN_VERSION = "0.5.6";
     const ENGINES = [
       { id: "auto", label: "Auto · 智能路由", badge: "AUTO", link: null },
       { id: "ddg", label: "DuckDuckGo · HTML", badge: "FREE", link: "https://duckduckgo.com" },

package/lib/index.js

@@ -2,6 +2,7 @@ import { SettingsConflictError } from "@deepseek-ai/dsh-settings";
 import { defineTool } from "@deepseek-ai/dsh-tools";
 import z from "@deepseek-ai/schemastery";
 import fs from "node:fs";
+import os from "node:os";
 import path from "node:path";
 import { exec } from "node:child_process";
 
@@ -81,7 +82,7 @@ function routeEngines(query, { timeRange } = {}) {
 }
 
 // 当前插件版本（发布时与 package.json 同步）
-const PLUGIN_VERSION = "0.5.0";
+const PLUGIN_VERSION = "0.5.6";
 // 检查更新的 npm registry 元数据地址（dsh-free-search 是 npmjs 上的公开包）
 const NPM_REGISTRY_URL = "https://registry.npmjs.org/dsh-free-search/latest";
 const PLUGIN_NPM_URL = "https://www.npmjs.com/package/dsh-free-search";
@@ -2181,8 +2182,104 @@ const Config = z.object({
   baiduApiKey: z.string().role("secret").volatile(),
   kimiApiKey: z.string().role("secret").volatile(),
   aliyunApiKey: z.string().role("secret").volatile(),
+  // 旧版 settings.yaml `free-search:` 段的一次性迁移标记（见 readLegacyFreeSearchSection）
+  legacyYamlMigrated: z.boolean().default(false).volatile(),
 });
 
+// ── 旧版 settings.yaml `free-search:` 段的迁移 ─────────────────────────────────
+// DSH 核心的 importLegacyDocument 只为 ui-developer-tools / ui-onboarding / shell
+// 三个段提供了映射；`free-search:` 段无法自动导入，值只会留在启动时被改名的
+// settings.yaml.imported 里。这里解析该段，并在首次启动时补种进本条目 config，
+// 用 Config.legacyYamlMigrated 去重（只写一次）。
+const LEGACY_MIGRATABLE_KEYS = [
+  "provider",
+  "cache",
+  "cacheTtl",
+  "keyStorage",
+  "lang",
+  "region",
+  "bingMarket",
+  "safeSearch",
+  "searxngInstances",
+  "platforms",
+  "anysearchApiKey",
+  "exaApiKey",
+  "tavilyApiKey",
+  "keenableApiKey",
+  "firecrawlApiKey",
+  "parallelApiKey",
+  "perplexityApiKey",
+  "serpbaseApiKey",
+  "deepseekApiKey",
+  "youcomApiKey",
+  "baiduApiKey",
+  "kimiApiKey",
+  "aliyunApiKey",
+];
+
+function dshHomeDir() {
+  return process.env.DSH_HOME ?? path.join(os.homedir(), ".dsh");
+}
+
+/** 解析 YAML 标量：引号字符串、布尔、null、数字、内联数组；其余按原样字符串。 */
+function parseLegacyScalar(raw) {
+  if (raw === "true") return true;
+  if (raw === "false") return false;
+  if (raw === "null" || raw === "~") return null;
+  const quoted = raw.match(/^(['"])([\s\S]*)\1$/);
+  if (quoted) return quoted[2];
+  if (/^-?\d+$/.test(raw)) return Number(raw);
+  if (/^-?\d+\.\d+$/.test(raw)) return Number(raw);
+  if (raw.startsWith("[") && raw.endsWith("]")) {
+    return raw
+      .slice(1, -1)
+      .split(",")
+      .map((part) => part.trim())
+      .filter(Boolean)
+      .map((part) => parseLegacyScalar(part))
+      .filter((value) => value !== null);
+  }
+  return raw;
+}
+
+/** 从 settings.yaml 文本里抽出顶层 `free-search:` 段的扁平键值（忽略嵌套块/块状列表）。 */
+function parseLegacyFreeSearchSection(text) {
+  const lines = String(text).split(/\r?\n/);
+  let start = -1;
+  for (let i = 0; i < lines.length; i++) {
+    if (/^free-search:\s*(#.*)?$/.test(lines[i])) {
+      start = i;
+      break;
+    }
+  }
+  if (start === -1) return null;
+  const section = {};
+  for (let i = start + 1; i < lines.length; i++) {
+    const line = lines[i];
+    if (line.trim() === "" || line.trimStart().startsWith("#")) continue;
+    if (/^\S/.test(line)) break; // 下一个顶层键
+    const kv = line.match(/^\s+([A-Za-z0-9_-]+):\s*(.*)$/);
+    if (!kv) continue;
+    const value = kv[2].replace(/\s+#.*$/, "").trim();
+    if (value === "") continue; // 嵌套块（map / 块状列表）：跳过，保留人工处理
+    section[kv[1]] = parseLegacyScalar(value);
+  }
+  return section;
+}
+
+/** 依次尝试 settings.yaml.imported（导入后的遗留段）与 settings.yaml。 */
+function readLegacyFreeSearchSection() {
+  const home = dshHomeDir();
+  for (const name of ["settings.yaml.imported", "settings.yaml"]) {
+    try {
+      const text = fs.readFileSync(path.join(home, name), "utf8");
+      const section = parseLegacyFreeSearchSection(text);
+      if (section !== null && Object.keys(section).length > 0) return { file: name, section };
+    } catch {}
+  }
+  return null;
+}
+
 // Unwrap the live `Volatile<T>` references the Loader passes for `.volatile()`
 // fields into a plain object, once per read.
 function resolveConfig(config) {
@@ -2206,6 +2303,27 @@ function apply(ctx, config) {
   // 单 query 结果缓存（provider.search 内闭包持有）：LRU 50 条 / TTL 可配置
   const searchCache = new Map(); // key -> { value, expiresAt }
 
+  // 旧版 settings.yaml `free-search:` 段的一次性补种：核心不会导入它（只映射 3 个特例），
+  // 这里在首次启动时把可识别的字段写进本条目 config，之后靠 legacyYamlMigrated 去重。
+  const migrateLegacySettingsFile = async (settings) => {
+    if (current().legacyYamlMigrated) return;
+    const legacy = readLegacyFreeSearchSection();
+    if (legacy === null) return;
+    const cfg = current();
+    const ops = [];
+    for (const [key, value] of Object.entries(legacy.section)) {
+      if (!LEGACY_MIGRATABLE_KEYS.includes(key)) continue;
+      if (JSON.stringify(cfg[key]) === JSON.stringify(value)) continue;
+      ops.push({ op: "set", path: [key], value });
+    }
+    if (ops.length === 0) return;
+    ops.push({ op: "set", path: ["legacyYamlMigrated"], value: true });
+    await settings.mutate(FREE_SEARCH_NS, ops);
+    logger.info(
+      `free-search: migrated ${ops.length - 1} field(s) from legacy ${legacy.file} "free-search:" section into this entry's config`
+    );
+  };
+
   // key 优先级：credentials（.credentials.yaml 凭据中心，官方推荐）> settings 的 free-search.<x>ApiKey（遗留兼容）> 环境变量
   const resolveApiKey = async (envName, settingsKey) => {
     const credentials = getCredentials();
@@ -2472,6 +2590,13 @@ function apply(ctx, config) {
     // page (`auto: false`) so the host does not also generate a schema form. Values
     // persist per profile in `cordis.patch.yml` under this entry (`FREE_SEARCH_NS`).
     sctx.effect(() => sctx.settings.configure({ auto: false }, ctx.fiber));
+    // 旧版 settings.yaml 的 `free-search:` 段不会被核心自动导入（只映射 3 个特例），
+    // 这里一次性补种进本条目 config；失败只警告，不影响插件启动。
+    void migrateLegacySettingsFile(sctx.settings).catch((error) => {
+      logger.warn(
+        `free-search: legacy settings.yaml migration skipped (${error instanceof Error ? error.message : String(error)})`
+      );
+    });
     // Re-render the dynamic system-prompt engine list whenever this entry's config changes.
     sctx.on("settings/document-updated", (ns) => {
       if (String(ns) === FREE_SEARCH_NS && typeof refreshPrompt === "function") refreshPrompt();
@@ -2508,7 +2633,7 @@ function apply(ctx, config) {
     const previous = ctx.web.searchProviderId;
     ctx.web.searchProviderId = provider.id;
     logger.info(
-      previous === undefined
+      previous === undefined || previous === null
         ? `free-search: web.searchProvider was unset, taking over as "${provider.id}"`
         : `free-search: taking over from the default provider "${previous}" as "${provider.id}"`
     );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dsh-free-search",
-  "version": "0.5.0",
+  "version": "0.5.6",
   "description": "Free web search for DeepSeek Harness: 17 engines (Bing/DuckDuckGo/AnySearch/SearXNG/Exa/Tavily/Keenable/Firecrawl/Parallel keyless; Perplexity/SerpBase/DeepSeek/You.com/Baidu/Kimi/Aliyun with key) + auto smart routing + multi_search cross-source tool + time filtering + platform search + web_fetch, with web settings UI.",
   "type": "module",
   "main": "lib/index.js",
@@ -54,11 +54,11 @@
   },
   "peerDependencies": {
     "@deepseek-ai/cordis": "^4.0.1",
-    "@deepseek-ai/dsh-client-ui-commands": "^0.1.7-rc.1",
-    "@deepseek-ai/dsh-client-ui-plugin-manager": "^0.1.7-rc.1",
-    "@deepseek-ai/dsh-client-ui-renderer": "^0.1.7-rc.1",
-    "@deepseek-ai/dsh-settings": "^0.1.7-rc.1",
-    "@deepseek-ai/dsh-tools": "^0.1.7-rc.1",
+    "@deepseek-ai/dsh-client-ui-commands": "^0.1.7-rc.1 || ^0.2.0-rc.1",
+    "@deepseek-ai/dsh-client-ui-plugin-manager": "^0.1.7-rc.1 || ^0.2.0-rc.1",
+    "@deepseek-ai/dsh-client-ui-renderer": "^0.1.7-rc.1 || ^0.2.0-rc.1",
+    "@deepseek-ai/dsh-settings": "^0.1.7-rc.1 || ^0.2.0-rc.1",
+    "@deepseek-ai/dsh-tools": "^0.1.7-rc.1 || ^0.2.0-rc.1",
     "@deepseek-ai/schemastery": "^3.18.4",
     "react": "^18.2.0"
   },