@memtensor/memos-local-openclaw-plugin 0.1.0

package/src/types.ts

@@ -0,0 +1,214 @@
+// ─── Role & Message ───
+
+export type Role = "user" | "assistant" | "system" | "tool";
+
+export interface ConversationMessage {
+  role: Role;
+  content: string;
+  timestamp: number;
+  turnId: string;
+  sessionKey: string;
+  toolName?: string;
+}
+
+// ─── Chunk & Storage ───
+
+export interface Chunk {
+  id: string;
+  sessionKey: string;
+  turnId: string;
+  seq: number;
+  role: Role;
+  content: string;
+  kind: ChunkKind;
+  summary: string;
+  embedding: number[] | null;
+  createdAt: number;
+  updatedAt: number;
+}
+
+export type ChunkKind =
+  | "paragraph"
+  | "code_block"
+  | "error_stack"
+  | "command"
+  | "list"
+  | "mixed"
+  | "tool_result";
+
+export interface ChunkRef {
+  sessionKey: string;
+  chunkId: string;
+  turnId: string;
+  seq: number;
+}
+
+// ─── Search / Recall ───
+
+export interface SearchHit {
+  summary: string;
+  original_excerpt: string;
+  ref: ChunkRef;
+  score: number;
+  source: {
+    ts: number;
+    role: Role;
+    sessionKey: string;
+  };
+}
+
+export interface SearchResult {
+  hits: SearchHit[];
+  meta: {
+    usedMinScore: number;
+    usedMaxResults: number;
+    totalCandidates: number;
+    note?: string;
+  };
+}
+
+export interface TimelineEntry {
+  excerpt: string;
+  ref: ChunkRef;
+  role: Role;
+  ts: number;
+  relation: "before" | "current" | "after";
+}
+
+export interface TimelineResult {
+  entries: TimelineEntry[];
+  anchorRef: ChunkRef;
+}
+
+export interface GetResult {
+  content: string;
+  ref: ChunkRef;
+  source: {
+    ts: number;
+    role: Role;
+    sessionKey: string;
+  };
+}
+
+// ─── Candidate (internal) ───
+
+export interface RankedCandidate {
+  chunkId: string;
+  ftsScore: number | null;
+  vecScore: number | null;
+  rrfScore: number;
+  mmrScore: number;
+  recencyScore: number;
+  finalScore: number;
+}
+
+// ─── Provider ───
+
+export type SummaryProvider =
+  | "openai"
+  | "openai_compatible"
+  | "anthropic"
+  | "gemini"
+  | "azure_openai"
+  | "bedrock";
+
+export type EmbeddingProvider =
+  | "openai"
+  | "openai_compatible"
+  | "gemini"
+  | "azure_openai"
+  | "cohere"
+  | "mistral"
+  | "voyage"
+  | "local";
+
+export interface ProviderConfig {
+  provider: string;
+  endpoint?: string;
+  apiKey?: string;
+  model?: string;
+  headers?: Record<string, string>;
+  timeoutMs?: number;
+  temperature?: number;
+}
+
+export interface SummarizerConfig extends ProviderConfig {
+  provider: SummaryProvider;
+}
+
+export interface EmbeddingConfig extends ProviderConfig {
+  provider: EmbeddingProvider;
+  batchSize?: number;
+  dimensions?: number;
+  retry?: number;
+}
+
+// ─── Plugin Config ───
+
+export interface MemosLocalConfig {
+  summarizer?: SummarizerConfig;
+  embedding?: EmbeddingConfig;
+  storage?: {
+    dbPath?: string;
+  };
+  recall?: {
+    maxResultsDefault?: number;
+    maxResultsMax?: number;
+    minScoreDefault?: number;
+    minScoreFloor?: number;
+    rrfK?: number;
+    mmrLambda?: number;
+    recencyHalfLifeDays?: number;
+  };
+  dedup?: {
+    similarityThreshold?: number;
+  };
+  capture?: {
+    evidenceWrapperTag?: string;
+  };
+}
+
+// ─── Defaults ───
+
+export const DEFAULTS = {
+  maxResultsDefault: 6,
+  maxResultsMax: 20,
+  minScoreDefault: 0.45,
+  minScoreFloor: 0.35,
+  rrfK: 60,
+  mmrLambda: 0.7,
+  recencyHalfLifeDays: 14,
+  dedupSimilarityThreshold: 0.93,
+  evidenceWrapperTag: "STORED_MEMORY",
+  excerptMinChars: 200,
+  excerptMaxChars: 500,
+  getMaxCharsDefault: 2000,
+  getMaxCharsMax: 8000,
+  timelineWindowDefault: 2,
+  localEmbeddingModel: "Xenova/all-MiniLM-L6-v2",
+  localEmbeddingDimensions: 384,
+  toolResultMaxChars: 2000,
+} as const;
+
+// ─── Plugin Hooks (OpenClaw integration) ───
+
+export interface PluginContext {
+  stateDir: string;
+  workspaceDir: string;
+  config: MemosLocalConfig;
+  log: Logger;
+}
+
+export interface Logger {
+  debug(msg: string, ...args: unknown[]): void;
+  info(msg: string, ...args: unknown[]): void;
+  warn(msg: string, ...args: unknown[]): void;
+  error(msg: string, ...args: unknown[]): void;
+}
+
+export interface ToolDefinition {
+  name: string;
+  description: string;
+  inputSchema: Record<string, unknown>;
+  handler: (input: Record<string, unknown>) => Promise<unknown>;
+}