@klarkxy/dsh-memory 0.1.0

package/LICENSE

@@ -0,0 +1,41 @@
+            The Star And Thank Author License (SATA)
+                  Version 2.1, September 2026
+
+Copyright © 2026 Klarkxy(278370456@qq.com)
+
+Project Url: https://github.com/klarkxy/dsh-editor
+             https://github.com/klarkxy/sata-license
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+And wait, one more thing — an invitation, not a condition: it would be best if
+you star/+1/like the project(s) in the project url section above, and thank the
+author(s) in the Copyright section. You may, and arguably you should — but the
+permissions above hold either way, star or no star.
+
+Here are some suggested ways:
+
+ - Email the authors a thank-you letter, and make friends with him/her/them.
+ - Report bugs or issues.
+ - Tell friends what a wonderful project this is.
+ - And, sure, you can just express thanks in your mind without telling the world.
+
+Contributors of this project by forking have the option to add his/her name and
+forked project url at copyright and project url sections, but shall not delete
+or modify anything else in these two sections.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,40 @@
+# @klarkxy/dsh-memory
+
+Default-enabled Memory with idle Dream consolidation. Stores long-term preferences, project facts, decisions, and lessons. Novel canon stays in author-confirmed worldbook files, not here.
+
+[简体中文](https://github.com/klarkxy/dsh-editor/blob/main/packages/dsh-memory/docs/README.zh-CN.md)
+
+## Install
+
+Requires Node.js ≥22 and DSH `0.1.7-alpha.1`. The bundle entry starts enabled, but loading it does not start inference or load `@klarkxy/dsh-ai-services`.
+
+Standalone DSH must load the shared service explicitly before this feature can start:
+
+```sh
+dsh plugin --profile web add @klarkxy/dsh-ai-services
+dsh plugin --profile web add @klarkxy/dsh-memory
+```
+
+Idle Dream is on by default and needs no confirmation: once a session has been idle for 15 minutes, at least 24 hours have passed since the last attempt, and at least 3 records were added or changed since then (deletions count), it runs once and applies automatically — at most once a day. Apply writes candidates only and never overwrites active records; failures back off for the same 24 hours. Turn it off under **Settings → 记忆**, or run the full flow manually via **Organize now**. Memory itself remains independently switchable in plugin settings.
+
+## Behaviour
+
+`ctx.aiMemory` implements the frozen `MemoryService`. Project identity is the shared untruncated `projectIdFromCwd(session.meta.cwd)` (DSH also exposes it as `session.header.cwd`). RPC derives that path from the live session id; clients cannot submit an arbitrary directory. Record ids are UUID-backed and cannot reuse a tombstone after restart. Durable writes are one typed aggregate snapshot.
+
+Recall injects at most 3–5 active records (~800 tokens) at Host `agent/pre-step`, exact project scope plus explicit global records. Lessons are not injected here (self-improvement owns them). Candidates, rejected, revoked, deleted, expired, and superseded records stay out of prompts.
+
+Human preference and project-fact candidates need evidence or an explicit manual add. Global writes require the global checkbox. Dream produces merge/dedup candidates and applies them automatically under the idle gates above; apply writes candidates only, never overwrites active records or expands project scope to global. Corrections and deletions win over in-flight runs. Deleted ids cannot be resurrected.
+
+Disabling the plugin or injection/Dream switches cancels pending results and injection. Stored records remain.
+
+From the repository root:
+
+```sh
+pnpm --filter @klarkxy/dsh-memory typecheck
+pnpm exec vitest run packages/dsh-memory/src
+pnpm --filter @klarkxy/dsh-memory build
+```
+
+[Publishing](https://github.com/klarkxy/dsh-editor/blob/main/packages/PUBLISHING.md) · [License](https://github.com/klarkxy/dsh-editor/blob/main/packages/dsh-memory/LICENSE)
+
+The Editor preinstalls this feature enabled. In the Editor, use Settings → Plugins to switch it without restarting. Standalone DSH must load `@klarkxy/dsh-ai-services` before this package; installation or removal may require a restart when the host asks for one.

package/cordis.patch.yml

@@ -0,0 +1,5 @@
+# Enabled when installed. Memory still does not enable Dream idle processing or load ai-services.
+- insert:
+    - id: memory
+      name: '@klarkxy/dsh-memory'
+      disabled: false

package/docs/README.zh-CN.md

@@ -0,0 +1,9 @@
+# @klarkxy/dsh-memory
+
+默认启用的记忆与闲时梦境整理。保存长期偏好、项目事实、决策和教训。小说设定仍只存在于作者确认的世界书，不写入本插件。
+
+[English](https://github.com/klarkxy/dsh-editor/blob/main/packages/dsh-memory/README.md)
+
+需要 Node.js ≥22、DSH `0.1.7-alpha.1`。安装条目默认启用，但不会自行推理，也不会自动加载共享服务 bundle `@klarkxy/dsh-ai-services`。独立部署须先显式加载该共享服务。
+
+闲时梦境默认开启，无需确认：会话闲置 15 分钟、距上次整理尝试满 24 小时、且自上次以来新增或变更不少于 3 条记录（含删除）时，自动做一次整理并直接生效，每天至多一次；应用只写入候选条目，不覆盖已生效记录，失败同样计入 24 小时退避。可在「设置 → 记忆」关闭自动整理，或点击「立即整理」手动运行完整流程。关闭插件会取消进行中的整理和注入，已存数据保留。