@seemem/see-mem-openclaw-plugin 0.1.4

package/README.md

@@ -0,0 +1,5 @@
+# See-Mem OpenClaw
+
+## 概述
+
+本文档指导你如何为 OpenClaw 接入 See-Mem 记忆系统插件。

package/index.js

@@ -0,0 +1,261 @@
+import { addMessage, searchMemory, formatPromptBlock, buildConfig } from "./lib/see-mem-api.js";
+import fs from "fs";
+import path from "path";
+import { fileURLToPath } from "url";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const logsDir = path.join(__dirname, "logs");
+
+/**
+ * 从 content 中提取附件信息
+ * 支持格式: [media attached: /path/to/file.jpg (image/jpeg) | /path/to/file.jpg]
+ */
+function extractAttachments(content) {
+  if (!content) return [];
+
+  const textContent = typeof content === "string" ? content : "";
+  const attachments = [];
+
+  // 匹配 [media attached: 文件路径 (MIME类型) | 文件路径]
+  const regex = /\[media attached: ([^\s]+) \(([^)]+)\)/g;
+  let match;
+  
+
+  while ((match = regex.exec(textContent)) !== null) {
+    attachments.push({
+      filePath: match[1],
+      mimeType: match[2],
+    });
+  }
+
+  return attachments;
+}
+
+/**
+ * 从 content 数组中提取 base64 图片数据
+ */
+function extractBase64Images(content) {
+  if (!Array.isArray(content)) return [];
+
+  const images = [];
+  for (const part of content) {
+    console.log("extractBase64Images part", part)
+    if (part?.type === "image" && part?.data) {
+      images.push({
+        data: part.data,
+        mimeType: part.mimeType || "image/jpeg",
+      });
+    }
+  }
+
+  return images;
+}
+
+/**
+ * 将本地文件路径转换为 file:// URL
+ * 注意: 这只是本地文件路径的 URL 形式，能否访问取决于服务端是否允许
+ */
+function filePathToUrl(filePath) {
+  // 替换空格等特殊字符
+  const encodedPath = encodeURIComponent(filePath);
+  return `file://${encodedPath}`;
+}
+
+function resolveSessionId(cfg, ctx) {
+  if (cfg.sessionId) return cfg.sessionId;
+  return ctx?.sessionKey || ctx?.sessionId || `openclaw-${Date.now()}`;
+}
+
+function buildSearchPayload(cfg, prompt, ctx) {
+  return {
+    user_id: cfg.userId,
+    query: prompt,
+    session_id: resolveSessionId(cfg, ctx),
+  };
+}
+
+function buildAddMessagePayload(cfg, messages, ctx, startTime) {
+  return {
+    user_id: cfg.userId,
+    messages,
+    start_time: startTime,
+    session_id: resolveSessionId(cfg, ctx),
+  };
+}
+
+function extractText(content) {
+  if (!content) return "";
+  if (typeof content === "string") return content;
+  if (Array.isArray(content)) {
+    return content
+      .filter((part) => part?.type === "text")
+      .map((part) => part.text)
+      .join("");
+  }
+  return "";
+}
+
+function pickLastTurnMessages(messages, cfg) {
+  const lastUserIndex = messages
+    .map((m, idx) => ({ m, idx }))
+    .filter(({ m }) => m?.role === "user")
+    .map(({ idx }) => idx)
+    .pop();
+
+  if (lastUserIndex === undefined) return [];
+
+  const slice = messages.slice(lastUserIndex);
+  const results = [];
+
+    for (const msg of slice) {
+    if (!msg || !msg.role) continue;
+
+    // 提取文本内容
+    const content = extractText(msg.content);
+    if (!content) continue;
+
+    const truncated = content.length > cfg.maxMessageChars
+      ? content.slice(0, cfg.maxMessageChars) + "..."
+      : content;
+
+    // 构建消息对象
+    const messageObj = {
+      role: msg.role,
+      content: truncated,
+    };
+
+    // 如果是用户消息，提取附件信息并添加到消息中
+    if (msg.role === "user") {
+      console.log("pickLastTurnMessages msg.content", msg.content)
+      console.log("pickLastTurnMessages msg.images", msg.images)
+      // 1. 从文本中提取本地文件路径
+      const attachments = extractAttachments(msg.content);
+      if (attachments.length > 0) {
+        messageObj.attachments = attachments.map((att) => ({
+          type: "local_file",
+          url: filePathToUrl(att.filePath),
+          mimeType: att.mimeType,
+          filePath: att.filePath,
+        }));
+      }
+
+      // 2. 从 content 数组中提取 base64 图片
+      const base64Images = extractBase64Images(msg.content);
+      if (base64Images.length > 0) {
+        messageObj.medias = base64Images.map((img) => ({
+          data: img.data,
+          mime_type: img.mimeType,
+        }));
+      }
+    }
+
+    results.push(messageObj);
+  }
+
+  return results;
+}
+
+function warnMissingApiKey(log, context) {
+  const heading = "[see-mem] Missing SEE_MEM_API_KEY (Token auth)";
+  const msg = `${heading}${context ? `; ${context} skipped` : ""}. Configure it with:`;
+  log.warn?.(
+    [
+      msg,
+      "echo 'export SEE_MEM_API_KEY=\"your-token\"' >> ~/.zshrc",
+      "source ~/.zshrc",
+      "or",
+      "[System.Environment]::SetEnvironmentVariable(\"SEE_MEM_API_KEY\", \"your-token\", \"User\")",
+      "Get API key from See-Mem developer platform",
+    ].join("\n"),
+  );
+}
+
+/**
+ * 将 searchMemory 的结果输出到 logs 目录
+ */
+function saveSearchResult(result) {
+  try {
+    if (!fs.existsSync(logsDir)) {
+      fs.mkdirSync(logsDir, { recursive: true });
+    }
+    const timestamp = Date.now();
+    const filename = `${timestamp}.json`;
+    const filepath = path.join(logsDir, filename);
+    fs.writeFileSync(filepath, JSON.stringify(result, null, 2), "utf-8");
+    console.log(`[see-mem] search result saved to ${filepath}`);
+  } catch (err) {
+    console.warn(`[see-mem] failed to save search result: ${String(err)}`);
+  }
+}
+
+export default {
+  id: "see-mem-openclaw-plugin",
+  name: "See-Mem OpenClaw Plugin",
+  description: "See-Mem long-term memory recall + add via lifecycle hooks",
+  kind: "lifecycle",
+
+  register(api) {
+    const cfg = buildConfig(api.pluginConfig);
+    const log = api.logger ?? console;
+
+    api.on("before_prompt_build", async (event, ctx) => {
+      console.log("before_prompt_build params", event, ctx, cfg);
+      if (!cfg.recallEnabled) return;
+      if (!event?.prompt || event.prompt.length < 3) return;
+      if (!cfg.apiKey) {
+        warnMissingApiKey(log, "recall");
+        return;
+      }
+
+      try {
+        const payload = buildSearchPayload(cfg, event.prompt, ctx);
+        // console.log("before_agent_start searchMemory", cfg, payload)
+        log.info(`before_agent_start searchMemory payload: ${JSON.stringify(payload)}, cfg: ${JSON.stringify(cfg)}`)
+        const result = await searchMemory(cfg, payload);
+        log.info(`before_agent_start searchMemory result: ${JSON.stringify(result)}`)
+        // saveSearchResult(result);
+        // console.log("before_agent_start searchMemory result", result)
+        if (!result || result.code !== 0 || !result.data?.response) {
+          return;
+        }
+
+        const promptBlock = formatPromptBlock(result.data.response);
+        log.info(`before_agent_start promptBlock: ${JSON.stringify(promptBlock)}`)
+
+        if (!promptBlock) return;
+
+        return {
+          prependSystemContext: promptBlock,
+        };
+      } catch (err) {
+        log.warn?.(`[see-mem] recall failed: ${String(err)}`);
+      }
+    });
+
+    api.on("agent_end", async (event, ctx) => {
+      console.log("agent_end", event, ctx);
+      // cfg.sessionId = `openclaw_${Date.now()}_${Math.random().toString(36).substring(2, 15)}`;
+      if (!cfg.addEnabled) return;
+      if (!event?.success || !event?.messages?.length) return;
+      if (!cfg.apiKey) {
+        warnMissingApiKey(log, "add");
+        return;
+      }
+
+      try {
+        const messages = pickLastTurnMessages(event.messages, cfg);
+        if (!messages.length) return;
+
+        const startTime = ctx?.sessionStartTime || new Date().toISOString().slice(0, 19);
+        const payload = buildAddMessagePayload(cfg, messages, ctx, startTime);
+        console.log("agent_end addMessage", cfg, payload);
+
+
+        await addMessage(cfg, payload);
+      } catch (err) {
+        log.warn?.(`[see-mem] add failed: ${String(err)}`);
+      }
+    });
+  },
+};

package/lib/see-mem-api.js

@@ -0,0 +1,158 @@
+import { readFileSync } from "node:fs";
+import { join } from "node:path";
+import { homedir } from "node:os";
+
+const DEFAULT_BASE_URL = "https://seemem.com/api/v1/memory";
+
+function stripQuotes(value) {
+  if (!value) return value;
+  const trimmed = value.trim();
+  if (
+    (trimmed.startsWith('"') && trimmed.endsWith('"')) ||
+    (trimmed.startsWith("'") && trimmed.endsWith("'"))
+  ) {
+    return trimmed.slice(1, -1);
+  }
+  return trimmed;
+}
+
+function parseEnvFile(content) {
+  const values = new Map();
+  for (const line of content.split(/\r?\n/)) {
+    const trimmed = line.trim();
+    if (!trimmed || trimmed.startsWith("#")) continue;
+    const idx = trimmed.indexOf("=");
+    if (idx <= 0) continue;
+    const key = trimmed.slice(0, idx).trim();
+    const rawValue = trimmed.slice(idx + 1);
+    if (!key) continue;
+    values.set(key, stripQuotes(rawValue));
+  }
+  return values;
+}
+
+function loadEnvVar(name) {
+  try {
+    const envFilePath = join(homedir(), ".openclaw", ".env");
+    console.log("loadEnvVar envFilePath", envFilePath)
+    // const envFilePath = join("~/.openclaw", ".env");
+    const content = readFileSync(envFilePath, "utf-8");
+    const values = parseEnvFile(content);
+    if (values.has(name)) return values.get(name);
+  } catch {
+    // ignore missing file
+  }
+  return process.env[name];
+}
+
+export function buildConfig(pluginConfig = {}) {
+  const cfg = pluginConfig ?? {};
+
+  const baseUrl = cfg.baseUrl || loadEnvVar("SEE_MEM_BASE_URL") || DEFAULT_BASE_URL;
+  const apiKey = cfg.apiKey || loadEnvVar("SEE_MEM_API_KEY") || "";
+  const userId = cfg.userId || loadEnvVar("SEE_MEM_USER_ID") || "openclaw-user";
+  const sessionId = cfg.sessionId || loadEnvVar("SEE_MEM_SESSION_ID") || "";
+  // const sessionId = `openclaw_${Date.now()}_${Math.random().toString(36).substring(2, 15)}`;
+
+  const recallEnabled = cfg.recallEnabled !== false;
+  const addEnabled = cfg.addEnabled !== false;
+  const maxMessageChars = cfg.maxMessageChars || 20000;
+  const timeoutMs = cfg.timeoutMs || 5000;
+
+  return {
+    baseUrl: baseUrl.replace(/\/+$/, ""),
+    apiKey,
+    userId,
+    sessionId,
+    recallEnabled,
+    addEnabled,
+    maxMessageChars,
+    timeoutMs,
+  };
+}
+
+export async function callApi({ baseUrl, apiKey, timeoutMs = 5000 }, path, body) {
+  if (!apiKey) {
+    throw new Error("Missing SEE_MEM API key (Token auth)");
+  }
+
+  const headers = {
+    "Content-Type": "application/json",
+    Authorization: apiKey,
+  };
+
+  const controller = new AbortController();
+  const timeoutId = setTimeout(() => controller.abort(), timeoutMs);
+
+  try {
+    const res = await fetch(`${baseUrl}${path}`, {
+      method: "POST",
+      headers,
+      body: JSON.stringify(body),
+      signal: controller.signal,
+    });
+
+    clearTimeout(timeoutId);
+
+    if (!res.ok) {
+      throw new Error(`HTTP ${res.status}`);
+    }
+
+    return await res.json();
+  } catch (err) {
+    clearTimeout(timeoutId);
+    throw err;
+  }
+}
+
+export async function searchMemory(cfg, payload) {
+  return callApi(cfg, "/search", payload);
+}
+
+export async function addMessage(cfg, payload) {
+  return callApi(cfg, "/add", payload);
+}
+
+/**
+ * 替换文本中的图片域名
+ * @param memoryText 原始文本内容
+ * @returns 替换域名后的文本内容
+ */
+function replaceImageDomain(memoryText) {
+  // 定义需要替换的原始域名和新域名
+  const oldDomain = 'seemem-prod-1310684398.cos.ap-guangzhou.myqcloud.com';
+  const newDomain = 'res.seemem.seemem.com';
+  
+  // 使用正则表达式全局替换域名（忽略大小写，增强兼容性）
+  // 正则中的 \. 需要转义，\b 用于匹配单词边界，避免部分匹配
+  const regex = new RegExp(`\\b${oldDomain.replace(/\./g, '\\.')}\\b`, 'gi');
+  
+  // 执行替换并返回结果
+  return memoryText.replace(regex, newDomain);
+}
+
+export function formatPromptBlock(memoryText) {
+  
+  if (!memoryText) return "";
+
+  return `# Relevant Memory
+
+<memory>
+
+${replaceImageDomain(memoryText)}
+
+</memory>
+
+---
+
+## SYSTEM PROMPT
+1. Above is the user's historical memory data (from past conversations), which you can reference when answering.
+2. When answering, combine the user's current question with the memory context to provide personalized responses.
+3. Image URLs in the memory are in format: (URL: https://...) - search for patterns like "(URL: https://..." to find images.
+4. Images are stored on OSS and URLs are publicly accessible over the Internet - you can directly send them to the user.
+5. Determine whether to send the image based on the user's question:
+   - If the user explicitly asks about the image, mentions related content, or the image is directly relevant to their question → send it
+   - If you're unsure whether to send → ask the user if they want to see the related images
+6. When sending images, you can say something like "我找到了一些相关图片，发给你看看" or "这张图片和你提到的xxx有关" to let the user know you found relevant images.
+7. Do NOT download or save the image yourself - just send the URL as a media message.`;
+}

package/openclaw.plugin.json

@@ -0,0 +1,50 @@
+{
+  "id": "see-mem-openclaw-plugin",
+  "name": "See-Mem OpenClaw Plugin",
+  "description": "See-Mem long-term memory recall + add via lifecycle hooks",
+  "version": "0.1.4",
+  "kind": "lifecycle",
+  "main": "./index.js",
+  "configSchema": {
+    "type": "object",
+    "properties": {
+      "baseUrl": {
+        "type": "string",
+        "description": "See-Mem API base URL",
+        "default": "https://seemem.com/api/v1/memory"
+      },
+      "apiKey": {
+        "type": "string",
+        "description": "See-Mem API Key (Token auth; also supports via ~/.openclaw/.env or process env SEE_MEM_API_KEY)"
+      },
+      "userId": {
+        "type": "string",
+        "description": "See-Mem user_id (default: openclaw-user)",
+        "default": "openclaw-user"
+      },
+      "sessionId": {
+        "type": "string",
+        "description": "Override session_id"
+      },
+      "recallEnabled": {
+        "type": "boolean",
+        "default": true
+      },
+      "addEnabled": {
+        "type": "boolean",
+        "default": true
+      },
+      "maxMessageChars": {
+        "type": "integer",
+        "description": "Max chars per message when adding",
+        "default": 20000
+      },
+      "timeoutMs": {
+        "type": "integer",
+        "default": 5000
+      }
+    },
+    "required": [],
+    "additionalProperties": true
+  }
+}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@seemem/see-mem-openclaw-plugin",
+  "version": "0.1.4",
+  "description": "OpenClaw lifecycle plugin for SeeMemory - long-term memory recall and persistence",
+  "main": "./index.js",
+  "type": "module",
+  "scripts": {
+    "sync-version": "node scripts/sync-version.js",
+    "version": "npm run sync-version && git add openclaw.plugin.json moltbot.plugin.json clawdbot.plugin.json",
+    "publish-beta": "npm publish --access public --tag beta",
+    "publish-beta-patch": "npm version prepatch --preid=beta && npm publish --access public --tag beta",
+    "publish-latest": "npm version $(node -p \"require('./package.json').version.split('-')[0]\") && npm publish --access public",
+    "publish-latest-patch": "npm version patch && npm publish --access public"
+  },
+  "keywords": [
+    "seemem",
+    "see-mem",
+    "openclaw",
+    "plugin",
+    "memory",
+    "long-term-memory",
+    "ai-memory"
+  ],
+  "author": "SeeMemory",
+  "license": "MIT",
+  "files": [
+    "index.js",
+    "lib/",
+    "openclaw.plugin.json"
+  ],
+  "openclaw": {
+    "extensions": [
+      "./index.js"
+    ]
+  },
+  "clawdbot": {
+    "extensions": [
+      "./index.js"
+    ]
+  },
+  "moltbot": {
+    "extensions": [
+      "./index.js"
+    ]
+  }
+}