dsh-instruction-memory 1.0.5 → 1.0.6

package/README.md

@@ -2,6 +2,10 @@
 
 在 DSH 设置界面中维护**长期指令记忆**：保存后自动注入此后每一轮对话的系统提示词。
 
+![设置页截图](docs/screenshot.png)
+
+> 想先看看界面？`docs/demo.html` 无需安装 DSH，浏览器直接打开即可体验真实设置页（内置演示数据）。
+
 ## 安装
 
 ```sh
@@ -32,6 +36,7 @@ dsh plugin --profile web remove dsh-instruction-memory
 | `contract-test.mjs` | 契约测试：驱动真实路由，验证两半之间的响应格式 |
 | `verify.mjs` | 装载验证：按 DSH 的方式加载两半 |
 | `smoke-test.mjs` | 注入渲染逻辑的单元测试 |
+| `docs/demo.html` | 离线演示页：桩掉 DSH 外壳、加载真实 Client 半渲染设置页（不随 npm 包发布） |
 
 ## 生效方式
 
@@ -58,8 +63,13 @@ DSH 就会得到第二份空记忆，看起来像"记忆消失"。
 > 首次启动新版本时会自动迁移到上述位置，并把原文件改名为 `*.migrated` 保留。
 
 该文件可手工编辑，改完点设置页的「重新载入」即可读回。每次保存先写临时文件再原子替换，
-进程崩溃不会留下损坏的半截 `memory.json`。若手工编辑后的文件有条目为空或超过 200 条上限，
-设置页会明确提示哪些条目未能载入（它们将在下次保存时从文件中移除），不会静默丢弃。
+进程崩溃不会留下损坏的半截 `memory.json`；保存时上一版会保留为 `memory.json.bak`，
+若 `memory.json` 解析失败会自动临时回退到该备份并明确提示。若手工编辑后的文件有条目为空
+或超过 200 条上限，设置页会明确提示哪些条目未能载入（它们将在下次保存时从文件中移除），
+不会静默丢弃。
+
+设置页支持**导出 / 导入**：导出为自带说明的 JSON 文件；导入采用**合并语义**——按 id 与
+「标题+内容」去重，只新增、绝不覆盖或清空现有条目。
 
 ## 兼容性
 

package/lib/client.js

@@ -71,6 +71,9 @@ window.__ModuleLoader__.load({
 .im-dot-on { background:var(--dsw-alias-state-success-primary,#18a058); }
 .im-dot-off { background:var(--dsw-alias-state-warn-primary,#d97706); }
 .im-dot-err { background:var(--dsw-alias-state-error-primary,#d94838); }
+.im-body-open { max-height:none; }
+.im-more { margin-top:4px; font-size:11.5px; color:var(--dsw-alias-brand-primary,#3b6cff); cursor:pointer; user-select:none; }
+.im-search-meta { margin-top:5px; }
 @media (max-width:640px) { .im-grid2 { grid-template-columns:1fr; } }
 `
 
@@ -193,6 +196,24 @@ window.__ModuleLoader__.load({
       return h('div', { className: 'im-card' }, children)
     }
 
+    /**
+     * Entry body with an explicit 展开/收起 toggle. The collapsed cap lives in
+     * CSS (max-height + overflow:hidden), so whether overflow actually happens
+     * is measured from the DOM — a short body renders no toggle at all.
+     */
+    function EntryBody(props) {
+      const bodyRef = React.useRef(null)
+      const [overflowing, setOverflowing] = React.useState(false)
+      const [open, setOpen] = React.useState(false)
+      React.useEffect(() => {
+        const el = bodyRef.current
+        if (el !== null && el !== undefined) setOverflowing(el.scrollHeight > el.clientHeight + 1)
+      }, [props.text])
+      return h('div', null,
+        h('div', { className: 'im-body' + (open ? ' im-body-open' : ''), ref: bodyRef }, props.text),
+        overflowing ? h('div', { className: 'im-more', onClick: () => setOpen(!open) }, open ? '收起' : '展开全部') : null)
+    }
+
     function InstructionPanel() {
       const [view, setView] = React.useState(null)
       const [error, setError] = React.useState('')
@@ -201,6 +222,8 @@ window.__ModuleLoader__.load({
       const [draft, setDraft] = React.useState(null)
       const [budgetText, setBudgetText] = React.useState('')
       const [showPreview, setShowPreview] = React.useState(false)
+      const [query, setQuery] = React.useState('')
+      const importInputRef = React.useRef(null)
 
       function absorb(result) {
         const normalized = normalizeResult(result)
@@ -235,6 +258,50 @@ window.__ModuleLoader__.load({
         }
       }
 
+      async function doExport() {
+        try {
+          const result = await callHost('export-data', null)
+          if (result === null || typeof result !== 'object' || result.export === undefined || result.export === null) {
+            setError('导出失败：宿主返回了无法识别的数据')
+            return
+          }
+          const blob = new Blob([JSON.stringify(result.export, null, 2) + '\n'], { type: 'application/json' })
+          const url = URL.createObjectURL(blob)
+          const link = document.createElement('a')
+          link.href = url
+          link.download = 'dsh-instruction-memory-' + new Date().toISOString().slice(0, 10) + '.json'
+          document.body.appendChild(link)
+          link.click()
+          if (link.parentNode !== null) link.parentNode.removeChild(link)
+          setTimeout(() => { URL.revokeObjectURL(url) }, 1000)
+        } catch (err) {
+          setError(String(err && err.message ? err.message : err))
+        }
+      }
+
+      async function handleImportFile(file) {
+        try {
+          const text = typeof file.text === 'function'
+            ? await file.text()
+            : await new Promise((resolve, reject) => {
+              const reader = new FileReader()
+              reader.onload = () => resolve(String(reader.result))
+              reader.onerror = () => reject(reader.error)
+              reader.readAsText(file)
+            })
+          let payload
+          try {
+            payload = JSON.parse(text)
+          } catch (err) {
+            setError('导入文件不是有效的 JSON（' + String(err && err.message ? err.message : err) + '）')
+            return
+          }
+          await send('import-data', { payload })
+        } catch (err) {
+          setError(String(err && err.message ? err.message : err))
+        }
+      }
+
       React.useEffect(() => {
         let alive = true
         callHost('state', null).then(
@@ -276,6 +343,13 @@ window.__ModuleLoader__.load({
       const injection = view.injection || { registered: false, chars: 0, error: null }
       const entries = data.entries.slice().sort((a, b) => (b.priority - a.priority) || (b.updatedAt - a.updatedAt))
       const activeCount = entries.filter((e) => e.enabled && e.content !== '').length
+      const keyword = query.trim().toLowerCase()
+      const visible = keyword === ''
+        ? entries
+        : entries.filter((entry) =>
+          entry.title.toLowerCase().indexOf(keyword) !== -1
+          || entry.content.toLowerCase().indexOf(keyword) !== -1
+          || entry.when.toLowerCase().indexOf(keyword) !== -1)
 
       const dotClass = injection.error
         ? 'im-dot im-dot-err'
@@ -328,6 +402,14 @@ window.__ModuleLoader__.load({
             h('label', { className: 'im-label' }, '生效规则'),
             h('div', { className: 'im-meta' },
               '「始终」无条件生效；「按需」由模型按相关性自动判断。超出上限时按优先级保留，其余暂不注入。'))),
+        entries.length > 0 ? h('div', { key: 'search' },
+          h('input', {
+            className: 'im-input',
+            value: query,
+            placeholder: '搜索指令：标题 / 内容 / 适用场景（共 ' + entries.length + ' 条）',
+            onChange: (ev) => setQuery(ev.target.value),
+          }),
+          query.trim() !== '' ? h('div', { className: 'im-meta im-search-meta' }, '匹配 ' + visible.length + ' / ' + entries.length + ' 条') : null) : null,
         h('div', { className: 'im-row-wrap' },
           h('button', {
             className: 'im-btn im-btn-primary',
@@ -335,6 +417,15 @@ window.__ModuleLoader__.load({
             onClick: () => { setDraft(blankDraft()); setError('') },
           }, '＋ 新增指令'),
           h('button', { className: 'im-btn', disabled: busy, onClick: () => send('reload', null) }, '重新载入'),
+          h('button', { className: 'im-btn', disabled: busy, onClick: doExport }, '导出'),
+          h('button', {
+            className: 'im-btn',
+            disabled: busy,
+            onClick: () => {
+              const el = importInputRef.current
+              if (el !== null && el !== undefined) el.click()
+            },
+          }, '导入'),
           h('button', {
             className: 'im-btn',
             disabled: busy,
@@ -355,9 +446,21 @@ window.__ModuleLoader__.load({
         error === '' && notice === '' && storage.error ? h('div', { className: 'im-err' }, storage.error) : null,
         showPreview ? h('div', null,
           h('label', { className: 'im-label' }, '当前注入到每轮系统提示词的内容'),
-          h('pre', { className: 'im-pre' }, view.preview === '' ? '（当前没有生效中的指令）' : view.preview)) : null)
+          h('pre', { className: 'im-pre' }, view.preview === '' ? '（当前没有生效中的指令）' : view.preview)) : null,
+        h('input', {
+          key: 'import-input',
+          type: 'file',
+          accept: '.json,application/json',
+          style: { display: 'none' },
+          ref: importInputRef,
+          onChange: (ev) => {
+            const file = ev.target.files && ev.target.files.length > 0 ? ev.target.files[0] : null
+            ev.target.value = ''
+            if (file !== null) void handleImportFile(file)
+          },
+        }))
 
-      const items = entries.map((entry) => {
+      const items = visible.map((entry) => {
         const tags = [
           h('span', {
             className: 'im-tag ' + (entry.mode === 'always' ? 'im-tag-always' : 'im-tag-auto'),
@@ -402,7 +505,7 @@ window.__ModuleLoader__.load({
                 send('delete-entry', { id: entry.id })
               },
             }, '删除')),
-          h('div', { className: 'im-body' }, entry.content),
+          h(EntryBody, { text: entry.content, key: 'body' }),
           entry.mode === 'auto' && entry.when !== ''
             ? h('div', { className: 'im-meta' }, '适用场景：' + entry.when)
             : null)
@@ -411,7 +514,9 @@ window.__ModuleLoader__.load({
       const list = entries.length === 0
         ? h('div', { className: 'im-empty', key: 'empty' },
           '还没有指令记忆。点击「＋ 新增指令」添加第一条，例如“所有回答使用简体中文”。')
-        : h('div', { className: 'im-list', key: 'list' }, items)
+        : visible.length === 0
+          ? h('div', { className: 'im-empty', key: 'no-match' }, '没有匹配“' + query.trim() + '”的指令。')
+          : h('div', { className: 'im-list', key: 'list' }, items)
 
       return h('div', { className: 'im-root' }, header, list)
     }

package/lib/index.js

@@ -346,14 +346,21 @@ export function apply(ctx) {
   const serialize = () => JSON.stringify(state.data, null, 2) + '\n'
 
   const writeToDisk = async () => {
-    // Atomic replace (write a sibling temp file, then rename): a crash
-    // mid-write must never leave a truncated memory.json behind, because the
-    // reader refuses to touch a file it cannot parse — half-written JSON
-    // would wedge every future boot until hand-repaired.
+    // Atomic replace (write a sibling temp file, then rename) with a rolling
+    // one-version backup: a crash mid-write must never leave a truncated
+    // memory.json, and an edit the user regrets must still be recoverable
+    // from memory.json.bak. The .bak holds the previous good version.
     const tmpPath = storePath + '.tmp'
+    const bakPath = storePath + '.bak'
     try {
       await mkdir(dirname(storePath), { recursive: true })
       await writeFile(tmpPath, serialize(), 'utf8')
+      try {
+        await rename(storePath, bakPath)
+      } catch (err) {
+        // No previous version on the very first save; anything else is real.
+        if (err.code !== 'ENOENT') throw err
+      }
       try {
         await rename(tmpPath, storePath)
       } catch (err) {
@@ -393,6 +400,26 @@ export function apply(ctx) {
       return
     } catch (err) {
       if (err === null || err === undefined || err.code !== 'ENOENT') {
+        // The main file is unreadable or corrupt. A previous good version
+        // may survive in the rolling backup — recover from it rather than
+        // presenting an empty memory, but say so loudly. The corrupt file
+        // itself stays untouched for hand repair; it gets overwritten on the
+        // next save (the pre-existing and disclosed behaviour).
+        if (err instanceof SyntaxError) {
+          try {
+            const backup = await readStoreFile(storePath + '.bak')
+            if (backup !== null) {
+              const loaded = normalizeData(backup)
+              state.data = loaded.data
+              state.storageWarning = (droppedEntriesMessage(loaded.dropped) || '')
+                + (loaded.dropped > 0 ? '；' : '')
+                + 'memory.json 解析失败（' + describeError(err) + '），已临时回退到最近备份 memory.json.bak；损坏文件已保留，下次保存时会覆盖它'
+              return
+            }
+          } catch {
+            // No usable backup either; fall through to the error below.
+          }
+        }
         // A file we cannot understand must never be silently overwritten.
         state.storageError = err instanceof SyntaxError
           ? '配置文件解析失败（' + describeError(err) + '），原文件已保留；你下次保存时会覆盖它'
@@ -542,6 +569,63 @@ export function apply(ctx) {
     return { ok: state.storageError === null, saved: true, message: state.storageError, snapshot: snapshot() }
   })
 
+  const exportData = () => enqueue(async () => ({
+    ok: true,
+    saved: true,
+    message: null,
+    // A self-describing envelope: re-importable by this plugin, and readable
+    // as plain JSON by anything else.
+    export: { app: 'dsh-instruction-memory', version: 1, exportedAt: new Date().toISOString(), data: snapshot().data },
+    snapshot: snapshot(),
+  }))
+
+  const importData = (payload) => enqueue(async () => {
+    if (payload === null || typeof payload !== 'object') {
+      return { ok: false, saved: false, message: '导入内容不是有效的 JSON 对象', snapshot: snapshot() }
+    }
+    // Accept both the plugin's own export envelope ({app, data:{entries}}) and
+    // a bare {entries} array (e.g. a hand-assembled file).
+    const rawEntries = Array.isArray(payload.entries)
+      ? payload.entries
+      : (payload.data !== null && typeof payload.data === 'object' && Array.isArray(payload.data.entries)
+        ? payload.data.entries
+        : null)
+    if (rawEntries === null || rawEntries.length === 0) {
+      return { ok: false, saved: false, message: '导入文件中没有找到条目', snapshot: snapshot() }
+    }
+    // Merge, never replace: importing must not be able to wipe what is here.
+    // Duplicates (same id, or same title+content) and invalid items are
+    // skipped and counted, not silently dropped.
+    const existing = state.data.entries
+    const seenIds = new Set(existing.map((entry) => entry.id))
+    const seenBodies = new Set(existing.map((entry) => entry.title + '\u0000' + entry.content))
+    let imported = 0
+    let skipped = 0
+    for (const candidate of rawEntries) {
+      const entry = sanitizeEntry(candidate)
+      if (entry === null || seenIds.has(entry.id) || seenBodies.has(entry.title + '\u0000' + entry.content)) {
+        skipped += 1
+        continue
+      }
+      if (existing.length >= MAX_ENTRIES) {
+        skipped += 1
+        continue
+      }
+      entry.updatedAt = Date.now()
+      existing.push(entry)
+      seenIds.add(entry.id)
+      seenBodies.add(entry.title + '\u0000' + entry.content)
+      imported += 1
+    }
+    if (imported === 0) {
+      return { ok: true, saved: true, message: '没有新增条目：' + skipped + ' 条已存在或无效', snapshot: snapshot() }
+    }
+    syncSection()
+    const saved = await writeToDisk()
+    if (saved) state.storageWarning = null
+    return settle('导入完成：新增 ' + imported + ' 条，跳过 ' + skipped + ' 条（已存在或无效）', saved)
+  })
+
   const dispatch = async (method, args) => {
     await boot
     switch (method) {
@@ -557,6 +641,10 @@ export function apply(ctx) {
         return setOptions(args)
       case 'reload':
         return reload()
+      case 'export-data':
+        return exportData()
+      case 'import-data':
+        return importData(args !== null && typeof args === 'object' ? args.payload : null)
       default:
         return { ok: false, saved: false, message: '未知方法：' + String(method), snapshot: snapshot() }
     }
@@ -572,6 +660,18 @@ export function apply(ctx) {
         res.end(JSON.stringify({ ok: false, message: 'only POST is supported' }))
         return
       }
+      // The settings page always posts application/json. Enforcing it turns
+      // the anti-CSRF coincidence (a plain HTML form cannot fabricate a JSON
+      // body) into a hard rule: a cross-site or malformed post now gets a
+      // readable 415 instead of a confusing parse failure.
+      const contentType = String(
+        (req.headers !== null && typeof req.headers === 'object') ? (req.headers['content-type'] || '') : '',
+      )
+      if (contentType.indexOf('application/json') === -1) {
+        res.writeHead(415, { 'content-type': 'application/json; charset=utf-8' })
+        res.end(JSON.stringify({ ok: false, message: 'content-type 必须是 application/json' }))
+        return
+      }
       // A call aborted mid-flight (settings page closed, tab navigated away)
       // makes these streams emit 'error'. A server stream with no error
       // listener turns that into an uncaught exception — i.e. it would take

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "dsh-instruction-memory",
-  "version": "1.0.5",
-  "description": "DSH 指令记忆：在设置界面中维护可增删改的长期指令，并自动注入此后每一轮对话的系统提示词。",
+  "version": "1.0.6",
+  "description": "User-only instruction memory for DSH: long-term instructions maintained in the settings UI and auto-injected into every conversation — the model has no write access. 指令记忆：只由用户在设置页维护的长期指令，自动注入此后每轮对话；模型没有任何写入口。",
   "license": "MIT",
   "type": "module",
   "repository": {
@@ -33,10 +33,15 @@
     "dsh",
     "dsh-plugin",
     "deepseek-harness",
-    "cordis",
     "instruction-memory",
+    "memory",
+    "记忆",
+    "instructions",
+    "custom-instructions",
+    "persistent-instructions",
     "system-prompt",
-    "settings"
+    "settings",
+    "cordis"
   ],
   "engines": {
     "node": ">=20"