@bamdra/bamdra-memory-vector 0.1.0 → 0.1.1

package/README.md

@@ -1,6 +1,6 @@
 # bamdra-memory-vector
 
-`bamdra-memory-vector` is the optional semantic retrieval plugin for the Bamdra OpenClaw memory suite.
+`bamdra-memory-vector` is the semantic retrieval plugin for the Bamdra OpenClaw suite.
 
 It adds lightweight vector-style recall on top of `bamdra-openclaw-memory` without turning the whole stack into a heavy external vector-database deployment.
 
@@ -27,11 +27,38 @@ The repository currently looks small because the first public version is intenti
 
 ## Current Runtime Model
 
-- Markdown root:
-  `~/.openclaw/memory/vector/markdown/`
+- private Markdown root:
+  `~/.openclaw/memory/vector/markdown/private/`
+- shared Markdown root:
+  `~/.openclaw/memory/vector/markdown/shared/`
 - local index:
   `~/.openclaw/memory/vector/index.json`
 
+`markdownRoot` is still supported as a legacy base path, but the recommended production setup is to set `privateMarkdownRoot` and `sharedMarkdownRoot` explicitly.
+
+## Best Practice: Obsidian-Friendly Layout
+
+The plugin now supports separate roots for private memory and shared knowledge. That makes it practical to point Markdown storage at an Obsidian vault, iCloud Drive folder, Git-synced repo, or Syncthing workspace while keeping the local vector index in `~/.openclaw`.
+
+Recommended example:
+
+```json
+{
+  "enabled": true,
+  "privateMarkdownRoot": "~/Documents/Obsidian/MyVault/openclaw/private",
+  "sharedMarkdownRoot": "~/Documents/Obsidian/MyVault/openclaw/shared",
+  "indexPath": "~/.openclaw/memory/vector/index.json",
+  "dimensions": 64
+}
+```
+
+This gives you:
+
+- a private vault area for user-specific memory
+- a shared vault area for team or household knowledge
+- Markdown files that can be edited on any synced device
+- a local index that OpenClaw can rebuild without exposing other users' data
+
 This first version exposes a lightweight local vector-style index interface and keeps the integration surface ready for later LanceDB-backed evolution.
 
 ## Product Positioning

package/README.zh-CN.md

@@ -0,0 +1,79 @@
+# bamdra-memory-vector
+
+`bamdra-memory-vector` 是 Bamdra OpenClaw 套件中的语义召回插件，而且它也可以独立运行。
+
+## 它做什么
+
+- 把记忆内容以 Markdown 可读形式写入本地
+- 建立轻量的本地语义索引
+- 按当前用户边界限制检索范围
+- 为长程记忆回捞提供 Top-K 语义召回
+- 保持私有记忆与共享知识分离
+
+## 开源内容说明
+
+当前开源版的实际源码已经包含在这个仓库里。
+
+- 源码入口：
+  [src/index.ts](/Users/wood/workspace/macmini-openclaw/openclaw-enhanced/bamdra-memory-vector/src/index.ts)
+- 插件清单：
+  [openclaw.plugin.json](/Users/wood/workspace/macmini-openclaw/openclaw-enhanced/bamdra-memory-vector/openclaw.plugin.json)
+- 包元数据：
+  [package.json](/Users/wood/workspace/macmini-openclaw/openclaw-enhanced/bamdra-memory-vector/package.json)
+
+仓库目前看起来比较轻，是因为首个公开版本刻意保持为紧凑、单入口插件。
+
+## 当前运行模型
+
+- 私有 Markdown 根目录：
+  `~/.openclaw/memory/vector/markdown/private/`
+- 共享 Markdown 根目录：
+  `~/.openclaw/memory/vector/markdown/shared/`
+- 本地索引：
+  `~/.openclaw/memory/vector/index.json`
+
+这一版提供的是轻量本地向量式索引接口，同时为后续 LanceDB 演进保留接入面。
+
+`markdownRoot` 仍然保留兼容，但更推荐在正式环境里显式设置 `privateMarkdownRoot` 和 `sharedMarkdownRoot`。
+
+## 最佳实践：兼容 Obsidian 的双库布局
+
+插件现在支持把私有记忆和共享知识分别落到两个 Markdown 根目录。这意味着你可以把 Markdown 指向 Obsidian 仓库、iCloud Drive、Git 同步目录或者 Syncthing 目录，而把本地索引仍然保留在 `~/.openclaw` 下面。
+
+推荐配置示例：
+
+```json
+{
+  "enabled": true,
+  "privateMarkdownRoot": "~/Documents/Obsidian/MyVault/openclaw/private",
+  "sharedMarkdownRoot": "~/Documents/Obsidian/MyVault/openclaw/shared",
+  "indexPath": "~/.openclaw/memory/vector/index.json",
+  "dimensions": 64
+}
+```
+
+这样做的好处是：
+
+- 私有记忆和共享知识库天然分开
+- Markdown 文件可以在任何同步设备上直接编辑
+- OpenClaw 继续使用本地索引，不依赖远端向量服务
+- 更适合把 Obsidian 作为长期知识库编辑入口
+
+## 产品定位
+
+`bamdra-memory-vector` 不是用来替代 `bamdra-openclaw-memory` 的。
+
+- `bamdra-openclaw-memory` 更强调连续性
+- `bamdra-memory-vector` 更强调召回增强
+
+两者组合后的价值是：
+
+- 更强的长会话连续性
+- Markdown 可读、可维护的记忆载体
+- 不依赖重型基础设施的轻量语义召回
+
+## 构建
+
+```bash
+pnpm run bundle
+```

package/dist/index.js

@@ -35,7 +35,8 @@ var LocalVectorIndex = class {
   constructor(inputConfig) {
     this.config = normalizeConfig(inputConfig);
     (0, import_node_fs.mkdirSync)((0, import_node_path.dirname)(this.config.indexPath), { recursive: true });
-    (0, import_node_fs.mkdirSync)(this.config.markdownRoot, { recursive: true });
+    (0, import_node_fs.mkdirSync)(this.config.privateMarkdownRoot, { recursive: true });
+    (0, import_node_fs.mkdirSync)(this.config.sharedMarkdownRoot, { recursive: true });
     this.load();
   }
   upsert(args) {
@@ -54,7 +55,8 @@ ${args.text}`, this.config.dimensions),
       updatedAt: (/* @__PURE__ */ new Date()).toISOString()
     };
     this.records.set(id, record);
-    const markdownPath = (0, import_node_path.join)(this.config.markdownRoot, args.sourcePath);
+    const markdownRoot = args.userId == null ? this.config.sharedMarkdownRoot : this.config.privateMarkdownRoot;
+    const markdownPath = (0, import_node_path.join)(markdownRoot, args.sourcePath);
     (0, import_node_fs.mkdirSync)((0, import_node_path.dirname)(markdownPath), { recursive: true });
     (0, import_node_fs.writeFileSync)(markdownPath, `# ${args.title}
 
@@ -69,7 +71,7 @@ ${args.text}
       if (args.userId == null) {
         return record.userId == null;
       }
-      return record.userId === args.userId;
+      return record.userId === args.userId || record.userId == null;
     }).map((record) => ({
       id: record.id,
       userId: record.userId,
@@ -148,9 +150,12 @@ function exposeVectorApi(runtime) {
 }
 function normalizeConfig(input) {
   const root = (0, import_node_path.join)((0, import_node_os.homedir)(), ".openclaw", "memory", "vector");
+  const markdownRoot = input?.markdownRoot ?? (0, import_node_path.join)(root, "markdown");
   return {
     enabled: input?.enabled ?? true,
-    markdownRoot: input?.markdownRoot ?? (0, import_node_path.join)(root, "markdown"),
+    markdownRoot,
+    privateMarkdownRoot: input?.privateMarkdownRoot ?? (0, import_node_path.join)(markdownRoot, "private"),
+    sharedMarkdownRoot: input?.sharedMarkdownRoot ?? (0, import_node_path.join)(markdownRoot, "shared"),
     indexPath: input?.indexPath ?? (0, import_node_path.join)(root, "index.json"),
     dimensions: input?.dimensions ?? 64
   };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bamdra/bamdra-memory-vector",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Lightweight local semantic retrieval enhancement for the Bamdra OpenClaw memory suite.",
   "license": "MIT",
   "homepage": "https://www.bamdra.com",
@@ -31,10 +31,6 @@
   "engines": {
     "node": ">=22"
   },
-  "scripts": {
-    "bundle": "node ../bamdra-openclaw-memory/scripts/run-local-bin.mjs tsup",
-    "prepublishOnly": "pnpm run bundle"
-  },
   "openclaw": {
     "id": "bamdra-memory-vector",
     "type": "tool",
@@ -55,5 +51,8 @@
   "dependencies": {},
   "devDependencies": {
     "@types/node": "^24.5.2"
+  },
+  "scripts": {
+    "bundle": "node ../bamdra-openclaw-memory/scripts/run-local-bin.mjs tsup"
   }
-}
+}