memorylake-openclaw 1.1.2 → 1.1.4

package/lib/types.ts

@@ -1,273 +0,0 @@
-export const DEFAULT_USER_ID = "default";
-
-export type MemoryLakeConfig = {
-  host: string;
-  apiKey: string;
-  projectId: string;
-  userId: string;
-  autoCapture: boolean;
-  autoRecall: boolean;
-  autoUpload: boolean;
-  searchThreshold: number;
-  topK: number;
-  rerank: boolean;
-  webSearchIncludeDomains?: string[];
-  webSearchExcludeDomains?: string[];
-  webSearchCountry?: string;
-  webSearchTimezone?: string;
-};
-
-// V2 API option types
-export interface AddOptions {
-  user_id: string;
-  chat_session_id?: string;
-  metadata?: Record<string, unknown>;
-  infer?: boolean;
-}
-
-export interface SearchOptions {
-  user_id: string;
-  top_k?: number;
-  threshold?: number;
-  rerank?: boolean;
-}
-
-export interface ListOptions {
-  user_id?: string;
-  page?: number;
-  size?: number;
-}
-
-export interface MemoryItem {
-  id: string;
-  content: string;
-  user_id?: string;
-  created_at?: string;
-  updated_at?: string;
-  has_unresolved_conflict?: boolean;
-}
-
-export interface ConflictMemorySnapshot {
-  memory_id: string;
-  memory_history_id?: string;
-  memory_text: string;
-}
-
-export interface ConflictFileChunk {
-  chunk: { type?: string; text: string; range?: string };
-  document_id?: string;
-  document_name?: string;
-}
-
-export interface ConflictResolve {
-  id: string;
-  strategy: string;
-  keep_memory_id?: string;
-  forgotten_memory_ids?: string[];
-  resolved_by?: string;
-  created_at?: string;
-}
-
-export interface ConflictItem {
-  id: string;
-  name: string;
-  description: string;
-  category: "m2m" | "m2d";
-  conflict_type: "logical" | "knowledge";
-  memory_ids: string[];
-  memory_snapshots: ConflictMemorySnapshot[];
-  file_chunks: ConflictFileChunk[];
-  resolved: boolean;
-  resolve?: ConflictResolve;
-  stale?: boolean;
-  event_id?: string;
-  created_at?: string;
-  updated_at?: string;
-}
-
-export interface ConflictListResponse {
-  items: ConflictItem[];
-  page: number;
-  total: number;
-  page_size: number;
-}
-
-export interface AddResultItem {
-  event_id: string;
-  status: string;
-  message: string;
-}
-
-export interface AddResult {
-  results: AddResultItem[];
-}
-
-export interface DocumentSearchResult {
-  type: "table" | "paragraph" | "figure";
-  document_id?: string;
-  document_name?: string;
-  source_document?: { file_name?: string };
-  highlight?: {
-    chunks?: Array<{ text?: string; range?: string }>;
-    inner_tables?: Array<{
-      id?: string;
-      columns?: Array<{ name?: string; data_type?: string }>;
-      num_rows?: number;
-    }>;
-    figure?: {
-      text?: string;
-      caption?: string;
-      summary_text?: string;
-    };
-  };
-  title?: string;
-  footnote?: string;
-  sheet_name?: string;
-  semantic_sheet_name?: string;
-  figure_id?: number;
-}
-
-export interface DocumentSearchResponse {
-  count: number;
-  results: DocumentSearchResult[];
-}
-
-/**
- * Allowed values for web search domain (aligned with zootopia unified_search Domain).
- * Declared as enum in schema; at runtime accept string and fall back to "auto" if invalid.
- */
-export const WebSearchDomainValues = [
-  "web",
-  "academic",
-  "news",
-  "people",
-  "company",
-  "financial",
-  "markets",
-  "code",
-  "legal",
-  "government",
-  "poi",
-  "auto",
-] as const;
-export type WebSearchDomain = (typeof WebSearchDomainValues)[number];
-
-export const WEB_SEARCH_DOMAIN_SET = new Set<string>(WebSearchDomainValues);
-
-export interface WebSearchUserLocation {
-  country?: string;
-  timezone?: string;
-}
-
-export interface WebSearchOptions {
-  /** Declared as enum in schema; at runtime accept string, normalized with fallback to "auto". */
-  domain?: WebSearchDomain | string;
-  max_results?: number;
-  start_date?: string;
-  end_date?: string;
-  include_domains?: string[];
-  exclude_domains?: string[];
-  user_location?: WebSearchUserLocation;
-}
-
-export interface WebSearchResult {
-  url?: string;
-  title?: string;
-  summary?: string;
-  content?: string;
-  source?: string;
-  published_date?: string;
-  author?: string;
-  score?: number;
-  highlights?: string[];
-}
-
-export interface WebSearchResponse {
-  results: WebSearchResult[];
-  total_results: number;
-}
-
-/**
- * Allowed values for open data search category (aligned with opendata endpoint).
- * Maps to proprietary data sources per category.
- */
-export const OpenDataCategoryValues = [
-  "research/academic",
-  "clinical/trials",
-  "drug/database",
-  "financial/markets",
-  "company/fundamentals",
-  "economic/data",
-  "patents/ip",
-] as const;
-export type OpenDataCategory = (typeof OpenDataCategoryValues)[number];
-
-export const OPEN_DATA_CATEGORY_SET = new Set<string>(OpenDataCategoryValues);
-
-export interface OpenDataIndustry {
-  id: string;
-  name: string;
-  description?: string;
-}
-
-export interface ProjectInfo {
-  id: string;
-  name: string;
-  description?: string;
-  industries: OpenDataIndustry[];
-}
-
-export interface OpenDataSearchOptions {
-  dataset?: OpenDataCategory | string;
-  max_results?: number;
-  start_date?: string;
-  end_date?: string;
-}
-
-export interface OpenDataSearchResult {
-  title?: string;
-  url?: string;
-  summary?: string;
-  content?: string;
-  source?: string;
-  category?: string;
-  published_date?: string;
-  author?: string;
-  score?: number;
-  metadata?: Record<string, unknown>;
-}
-
-export interface OpenDataSearchResponse {
-  results: OpenDataSearchResult[];
-  total_results: number;
-}
-
-// ============================================================================
-// Unified Provider Interface
-// ============================================================================
-
-export interface MemoryLakeProvider {
-  add(
-    messages: Array<{ role: string; content: string }>,
-    options: AddOptions,
-  ): Promise<AddResult>;
-  search(query: string, options: SearchOptions): Promise<MemoryItem[]>;
-  get(memoryId: string): Promise<MemoryItem>;
-  getAll(options: ListOptions): Promise<MemoryItem[]>;
-  delete(memoryId: string): Promise<void>;
-  searchDocuments(query: string, topN: number): Promise<DocumentSearchResponse>;
-  getDocumentDownloadUrl(documentId: string): Promise<string>;
-  searchWeb(query: string, options: WebSearchOptions): Promise<WebSearchResponse>;
-  searchOpenData(query: string, options: OpenDataSearchOptions): Promise<OpenDataSearchResponse>;
-  getProject(): Promise<ProjectInfo>;
-  listConflicts(memoryIds: string[], userId: string): Promise<ConflictItem[]>;
-}
-
-/** Shared type for the upload / uploadAuto function signature */
-export type UploadFn = (opts: {
-  host: string;
-  apiKey: string;
-  projectId: string;
-  filePath: string;
-  fileName: string;
-}) => Promise<unknown>;

package/lib/utils/builders.ts

@@ -1,127 +0,0 @@
-import { createRequire } from "node:module";
-import type { MemoryLakeConfig, AddOptions, SearchOptions, DocumentSearchResult, WebSearchResult, ConflictItem, OpenDataSearchResult } from "../types";
-
-const require = createRequire(import.meta.url);
-const { version: PLUGIN_VERSION } = require("../../package.json") as { version: string };
-
-// ============================================================================
-// Context Builders
-// ============================================================================
-
-export function buildDocumentContext(
-  results: DocumentSearchResult[],
-  maxChunkLength = 10000,
-): string {
-  const parts: string[] = [];
-
-  for (const result of results) {
-    const source = result.document_name ?? result.source_document?.file_name ?? "unknown";
-    const docId = result.document_id ?? "unknown";
-    const highlight = result.highlight;
-
-    if (result.type === "table") {
-      const title = result.title || "Untitled Table";
-      const sheetLabel = result.semantic_sheet_name || result.sheet_name;
-      const sheetPart = sheetLabel ? `, sheet: ${sheetLabel}` : "";
-      parts.push(`### Table: ${title} (from ${source}${sheetPart}, doc_id: ${docId})`);
-      if (result.footnote) parts.push(`Note: ${result.footnote}`);
-
-      for (const innerTable of highlight?.inner_tables ?? []) {
-        const colDesc = (innerTable.columns ?? [])
-          .map((c) => `${c.name}(${c.data_type})`)
-          .join(", ");
-        if (colDesc) parts.push(`Columns: ${colDesc}`);
-        if (innerTable.num_rows != null) parts.push(`Rows: ${innerTable.num_rows}`);
-      }
-      for (const chunk of highlight?.chunks ?? []) {
-        if (chunk.text) parts.push(chunk.text.slice(0, maxChunkLength));
-      }
-    } else if (result.type === "paragraph") {
-      parts.push(`### Paragraph (from ${source}, doc_id: ${docId}):`);
-      for (const chunk of highlight?.chunks ?? []) {
-        if (chunk.text) parts.push(chunk.text.slice(0, maxChunkLength));
-      }
-    } else if (result.type === "figure") {
-      const figure = highlight?.figure;
-      if (figure) {
-        parts.push(`### Figure (from ${source}, doc_id: ${docId}):`);
-        if (figure.caption) parts.push(`Caption: ${figure.caption}`);
-        const text = figure.text || figure.summary_text || "";
-        if (text) parts.push(text);
-      }
-    }
-  }
-
-  return parts.join("\n\n");
-}
-
-export function buildWebSearchContext(results: WebSearchResult[]): string {
-  return results
-    .map((result, index) => {
-      const parts = [`${index + 1}. ${result.title ?? result.url ?? "Untitled result"}`];
-      if (result.url) parts.push(`URL: ${result.url}`);
-      if (result.summary) parts.push(`Summary: ${result.summary}`);
-      if (result.source) parts.push(`Source: ${result.source}`);
-      if (result.published_date) parts.push(`Published: ${result.published_date}`);
-      return parts.join("\n");
-    })
-    .join("\n\n");
-}
-
-export function buildConflictContext(conflicts: ConflictItem[], maxChunkLength = 200): string {
-  return conflicts
-    .map((c) => {
-      const parts: string[] = [
-        `- [${c.conflict_type}] ${c.description}`,
-      ];
-      for (const snap of c.memory_snapshots ?? []) {
-        parts.push(`  Memory(${snap.memory_id}): ${snap.memory_text.slice(0, maxChunkLength)}`);
-      }
-      for (const fc of c.file_chunks ?? []) {
-        const docLabel = fc.document_name ?? fc.document_id ?? "unknown";
-        parts.push(`  Document(${docLabel}): ${fc.chunk.text.slice(0, maxChunkLength)}`);
-      }
-      return parts.join("\n");
-    })
-    .join("\n");
-}
-
-export function buildOpenDataContext(results: OpenDataSearchResult[]): string {
-  const filtered = results.map((r) => {
-    const item: Record<string, unknown> = {};
-    if (r.title != null) item.title = r.title;
-    if (r.url != null) item.url = r.url;
-    if (r.content != null) item.content = r.content;
-    if (r.published_date != null) item.published_date = r.published_date;
-    if (r.category != null) item.category = r.category;
-    return item;
-  });
-  return JSON.stringify(filtered, null, 2);
-}
-
-// ============================================================================
-// Option Builders
-// ============================================================================
-
-export function buildAddOptions(effectiveCfg: MemoryLakeConfig, userIdOverride?: string, sessionId?: string): AddOptions {
-  const opts: AddOptions = {
-    user_id: userIdOverride || effectiveCfg.userId,
-    infer: true,
-    metadata: { source: "OPENCLAW", plugin_version: PLUGIN_VERSION },
-  };
-  if (sessionId) opts.chat_session_id = sessionId;
-  return opts;
-}
-
-export function buildSearchOptions(
-  effectiveCfg: MemoryLakeConfig,
-  userIdOverride?: string,
-  limit?: number,
-): SearchOptions {
-  return {
-    user_id: userIdOverride || effectiveCfg.userId,
-    top_k: limit ?? effectiveCfg.topK,
-    threshold: effectiveCfg.searchThreshold,
-    rerank: effectiveCfg.rerank,
-  };
-}

package/lib/utils/config-parser.ts

@@ -1,14 +0,0 @@
-import fs from "node:fs";
-import JSON5 from "json5";
-
-/**
- * Read and parse a JSON5-compatible config file.
- */
-export function readJson5ConfigFile(filePath: string): unknown {
-  const source = fs.readFileSync(filePath, "utf-8");
-  try {
-    return JSON5.parse(source);
-  } catch (err) {
-    throw new Error(`Failed to parse JSON5 config file "${filePath}": ${String(err)}`);
-  }
-}

package/lib/utils/normalizers.ts

@@ -1,76 +0,0 @@
-import type { MemoryItem, AddResult, WebSearchResponse, OpenDataSearchResult, OpenDataSearchResponse, WebSearchDomain, OpenDataCategory } from "../types";
-import { WEB_SEARCH_DOMAIN_SET, OPEN_DATA_CATEGORY_SET } from "../types";
-
-/** Normalize domain: accept string at runtime; if not a valid enum value, return "auto". */
-export function normalizeWebSearchDomain(value: unknown): WebSearchDomain {
-  if (value == null) return "auto";
-  const s = typeof value === "string" ? value.toLowerCase().trim() : "";
-  return (WEB_SEARCH_DOMAIN_SET.has(s) ? s : "auto") as WebSearchDomain;
-}
-
-/** Normalize category: accept string at runtime; return undefined if not a valid enum value. */
-export function normalizeOpenDataCategory(value: unknown): OpenDataCategory | undefined {
-  if (value == null) return undefined;
-  const s = typeof value === "string" ? value.toLowerCase().trim() : "";
-  return OPEN_DATA_CATEGORY_SET.has(s) ? (s as OpenDataCategory) : undefined;
-}
-
-export function normalizeMemoryItem(raw: any): MemoryItem {
-  return {
-    id: raw.id ?? "",
-    content: raw.content ?? "",
-    user_id: raw.user_id,
-    created_at: raw.created_at,
-    updated_at: raw.updated_at,
-    has_unresolved_conflict: raw.has_unresolved_conflict ?? false,
-  };
-}
-
-export function normalizeSearchResults(raw: any): MemoryItem[] {
-  if (raw?.results && Array.isArray(raw.results))
-    return raw.results.map(normalizeMemoryItem);
-  if (Array.isArray(raw)) return raw.map(normalizeMemoryItem);
-  return [];
-}
-
-export function normalizeAddResult(raw: any): AddResult {
-  const items = raw?.results ?? (Array.isArray(raw) ? raw : []);
-  return {
-    results: items.map((r: any) => ({
-      event_id: r.event_id ?? "",
-      status: r.status ?? "",
-      message: r.message ?? "",
-    })),
-  };
-}
-
-export function normalizeWebSearchResponse(raw: any): WebSearchResponse {
-  return {
-    results: Array.isArray(raw?.results) ? raw.results : [],
-    total_results: typeof raw?.total_results === "number" ? raw.total_results : 0,
-  };
-}
-
-export function normalizeOpenDataResult(raw: any): OpenDataSearchResult {
-  return {
-    title: typeof raw?.title === "string" ? raw.title : undefined,
-    url: typeof raw?.url === "string" ? raw.url : undefined,
-    summary: typeof raw?.summary === "string" ? raw.summary : undefined,
-    content: typeof raw?.content === "string" ? raw.content : undefined,
-    source: typeof raw?.source === "string" ? raw.source : undefined,
-    category: typeof raw?.category === "string" ? raw.category : undefined,
-    published_date: typeof raw?.published_date === "string" ? raw.published_date : undefined,
-    author: typeof raw?.author === "string" ? raw.author : undefined,
-    score: typeof raw?.score === "number" ? raw.score : undefined,
-    metadata: raw?.metadata && typeof raw.metadata === "object" && !Array.isArray(raw.metadata)
-      ? raw.metadata as Record<string, unknown>
-      : undefined,
-  };
-}
-
-export function normalizeOpenDataSearchResponse(raw: any): OpenDataSearchResponse {
-  return {
-    results: Array.isArray(raw?.results) ? raw.results.map(normalizeOpenDataResult) : [],
-    total_results: typeof raw?.total_results === "number" ? raw.total_results : 0,
-  };
-}

package/test/json5_config_smoke.test.mjs

@@ -1,104 +0,0 @@
-import { describe, it } from "node:test";
-import assert from "node:assert/strict";
-import { mkdtempSync, mkdirSync, writeFileSync, readFileSync } from "node:fs";
-import { tmpdir } from "node:os";
-import { join, resolve } from "node:path";
-import { spawnSync } from "node:child_process";
-
-const repoRoot = resolve(process.cwd());
-const getConfigScript = join(repoRoot, "skills/common/get-config.mjs");
-const pluginContextSource = join(repoRoot, "lib/plugin-context.ts");
-const registerCliSource = join(repoRoot, "lib/cli/register-cli.ts");
-
-function runGetConfig(homeDir, agentId = "a1") {
-  return spawnSync("node", [getConfigScript, "--agent", agentId], {
-    env: { ...process.env, HOME: homeDir },
-    encoding: "utf8",
-  });
-}
-
-describe("json5 config smoke", () => {
-  it("accepts JSON5 openclaw.json in get-config.mjs", () => {
-    const root = mkdtempSync(join(tmpdir(), "ml-json5-ok-"));
-    const home = root;
-    const workspace = join(root, "workspace");
-    mkdirSync(join(home, ".openclaw"), { recursive: true });
-    mkdirSync(join(workspace, ".memorylake"), { recursive: true });
-
-    writeFileSync(
-      join(home, ".openclaw", "openclaw.json"),
-      `{
-  // allow comments
-  plugins: {
-    entries: {
-      "memorylake-openclaw": {
-        config: {
-          apiKey: "k",
-          projectId: "p",
-          host: "https://app.memorylake.ai",
-        },
-      },
-    },
-  },
-  agents: {
-    list: [{ id: "a1", workspace: "${workspace.replaceAll("\\", "\\\\")}" }],
-  },
-}
-`,
-    );
-    writeFileSync(join(workspace, ".memorylake", "config.json"), JSON.stringify({ topK: 5 }));
-
-    const result = runGetConfig(home);
-    assert.equal(result.status, 0, result.stderr);
-    const parsed = JSON.parse(result.stdout);
-    assert.equal(parsed.projectId, "p");
-    assert.equal(parsed.workspace, workspace);
-    assert.equal(parsed.topK, 5);
-  });
-
-  it("returns clear non-zero error for malformed JSON5 global config", () => {
-    const root = mkdtempSync(join(tmpdir(), "ml-json5-bad-global-"));
-    const home = root;
-    mkdirSync(join(home, ".openclaw"), { recursive: true });
-    writeFileSync(join(home, ".openclaw", "openclaw.json"), "{ invalid json5 }");
-
-    const result = runGetConfig(home);
-    assert.notEqual(result.status, 0);
-    assert.match(result.stderr, /failed to parse JSON5 config file/);
-  });
-
-  it("keeps workspace override as strict JSON", () => {
-    const root = mkdtempSync(join(tmpdir(), "ml-json5-bad-local-"));
-    const home = root;
-    const workspace = join(root, "workspace");
-    mkdirSync(join(home, ".openclaw"), { recursive: true });
-    mkdirSync(join(workspace, ".memorylake"), { recursive: true });
-
-    writeFileSync(
-      join(home, ".openclaw", "openclaw.json"),
-      JSON.stringify({
-        plugins: {
-          entries: {
-            "memorylake-openclaw": {
-              config: { apiKey: "k", projectId: "p", host: "https://app.memorylake.ai" },
-            },
-          },
-        },
-        agents: { list: [{ id: "a1", workspace }] },
-      }),
-    );
-    writeFileSync(join(workspace, ".memorylake", "config.json"), "{ trailing: 1, }");
-
-    const result = runGetConfig(home);
-    assert.notEqual(result.status, 0);
-    assert.match(result.stderr, /failed to parse workspace config/);
-  });
-
-  it("ensures plugin and CLI global config paths use shared JSON5 parser", () => {
-    const pluginContext = readFileSync(pluginContextSource, "utf8");
-    const registerCli = readFileSync(registerCliSource, "utf8");
-
-    assert.match(pluginContext, /readJson5ConfigFile\(GLOBAL_CONFIG_PATH\)/);
-    assert.match(registerCli, /readJson5ConfigFile\(openclawPath\)/);
-  });
-});