@agent-relay/memory 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,195 @@
+/**
+ * Agent Relay Memory Types
+ *
+ * Core types for the memory adapter system. Memory adapters provide
+ * semantic storage and retrieval of agent learnings and context.
+ */
+/**
+ * A memory entry stored in the system
+ */
+export interface MemoryEntry {
+    /** Unique identifier for the memory */
+    id: string;
+    /** The actual content of the memory */
+    content: string;
+    /** Timestamp when memory was created */
+    createdAt: number;
+    /** Timestamp when memory was last accessed */
+    lastAccessedAt?: number;
+    /** Optional metadata tags */
+    tags?: string[];
+    /** Source of the memory (e.g., 'agent', 'user', 'session') */
+    source?: string;
+    /** Agent that created the memory */
+    agentId?: string;
+    /** Project associated with this memory */
+    projectId?: string;
+    /** Session ID where memory was created */
+    sessionId?: string;
+    /** Relevance score (when returned from search) */
+    score?: number;
+    /** Additional structured metadata */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Query options for searching memories
+ */
+export interface MemorySearchQuery {
+    /** Semantic search query text */
+    query: string;
+    /** Maximum number of results to return */
+    limit?: number;
+    /** Minimum relevance score threshold (0-1) */
+    minScore?: number;
+    /** Filter by tags */
+    tags?: string[];
+    /** Filter by agent ID */
+    agentId?: string;
+    /** Filter by project ID */
+    projectId?: string;
+    /** Filter by memories created after this timestamp */
+    since?: number;
+    /** Filter by memories created before this timestamp */
+    before?: number;
+}
+/**
+ * Options for adding a memory
+ */
+export interface AddMemoryOptions {
+    /** Optional tags for the memory */
+    tags?: string[];
+    /** Source of the memory */
+    source?: string;
+    /** Agent creating the memory */
+    agentId?: string;
+    /** Project context */
+    projectId?: string;
+    /** Session context */
+    sessionId?: string;
+    /** Additional metadata */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Result of a memory operation
+ */
+export interface MemoryResult {
+    /** Whether the operation succeeded */
+    success: boolean;
+    /** ID of the affected memory (if applicable) */
+    id?: string;
+    /** Error message if operation failed */
+    error?: string;
+}
+/**
+ * Memory adapter interface
+ *
+ * All memory backends must implement this interface to be used
+ * with the agent-relay memory system.
+ */
+export interface MemoryAdapter {
+    /** Unique identifier for this adapter type */
+    readonly type: string;
+    /**
+     * Initialize the adapter (connect to backend, etc.)
+     */
+    init(): Promise<void>;
+    /**
+     * Add a new memory to the system
+     * @param content - The content to remember
+     * @param options - Optional metadata and context
+     * @returns Result with the new memory's ID
+     */
+    add(content: string, options?: AddMemoryOptions): Promise<MemoryResult>;
+    /**
+     * Search for relevant memories
+     * @param query - Search parameters
+     * @returns Array of matching memories, ordered by relevance
+     */
+    search(query: MemorySearchQuery): Promise<MemoryEntry[]>;
+    /**
+     * Get a specific memory by ID
+     * @param id - The memory ID
+     * @returns The memory entry or null if not found
+     */
+    get(id: string): Promise<MemoryEntry | null>;
+    /**
+     * Delete a memory
+     * @param id - The memory ID to delete
+     * @returns Result indicating success/failure
+     */
+    delete(id: string): Promise<MemoryResult>;
+    /**
+     * Update an existing memory
+     * @param id - The memory ID
+     * @param content - New content
+     * @param options - Optional updated metadata
+     * @returns Result indicating success/failure
+     */
+    update?(id: string, content: string, options?: Partial<AddMemoryOptions>): Promise<MemoryResult>;
+    /**
+     * List recent memories
+     * @param options - Filter options
+     * @returns Array of recent memories
+     */
+    list?(options?: {
+        limit?: number;
+        agentId?: string;
+        projectId?: string;
+    }): Promise<MemoryEntry[]>;
+    /**
+     * Clear all memories matching criteria
+     * @param options - Filter for what to clear
+     */
+    clear?(options?: {
+        agentId?: string;
+        projectId?: string;
+        before?: number;
+    }): Promise<MemoryResult>;
+    /**
+     * Get statistics about stored memories
+     */
+    stats?(): Promise<{
+        totalCount: number;
+        byAgent?: Record<string, number>;
+        byProject?: Record<string, number>;
+    }>;
+    /**
+     * Close the adapter and release resources
+     */
+    close?(): Promise<void>;
+}
+/**
+ * Configuration for memory adapters
+ */
+export interface MemoryConfig {
+    /** Adapter type: 'inmemory', 'supermemory', 'claude', etc. */
+    type: string;
+    /** API key for external services */
+    apiKey?: string;
+    /** API endpoint URL (for supermemory, etc.) */
+    endpoint?: string;
+    /** Default agent ID to use */
+    defaultAgentId?: string;
+    /** Default project ID to use */
+    defaultProjectId?: string;
+    /** Additional adapter-specific options */
+    options?: Record<string, unknown>;
+}
+/**
+ * Memory service interface for hooks
+ *
+ * This is a simplified interface exposed to hooks for memory operations.
+ */
+export interface MemoryService {
+    /** Add a memory */
+    add(content: string, options?: AddMemoryOptions): Promise<MemoryResult>;
+    /** Search for memories */
+    search(query: string | MemorySearchQuery): Promise<MemoryEntry[]>;
+    /** Delete a memory */
+    delete(id: string): Promise<MemoryResult>;
+    /** List recent memories */
+    list(limit?: number): Promise<MemoryEntry[]>;
+    /** Check if memory service is available */
+    isAvailable(): boolean;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,uCAAuC;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,uCAAuC;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,wCAAwC;IACxC,SAAS,EAAE,MAAM,CAAC;IAClB,8CAA8C;IAC9C,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,6BAA6B;IAC7B,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,8DAA8D;IAC9D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oCAAoC;IACpC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,0CAA0C;IAC1C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,0CAA0C;IAC1C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kDAAkD;IAClD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,qCAAqC;IACrC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,iCAAiC;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,0CAA0C;IAC1C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,8CAA8C;IAC9C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qBAAqB;IACrB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,yBAAyB;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,2BAA2B;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,sDAAsD;IACtD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,uDAAuD;IACvD,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,mCAAmC;IACnC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,2BAA2B;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gCAAgC;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,sBAAsB;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,sBAAsB;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,sCAAsC;IACtC,OAAO,EAAE,OAAO,CAAC;IACjB,gDAAgD;IAChD,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,wCAAwC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B,8CAA8C;IAC9C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtB;;;;;OAKG;IACH,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAExE;;;;OAIG;IACH,MAAM,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IAEzD;;;;OAIG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC,CAAC;IAE7C;;;;OAIG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAE1C;;;;;;OAMG;IACH,MAAM,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAEjG;;;;OAIG;IACH,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IAE3B;;;OAGG;IACH,KAAK,CAAC,CAAC,OAAO,CAAC,EAAE;QACf,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAE1B;;OAEG;IACH,KAAK,CAAC,IAAI,OAAO,CAAC;QAChB,UAAU,EAAE,MAAM,CAAC;QACnB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACjC,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KACpC,CAAC,CAAC;IAEH;;OAEG;IACH,KAAK,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,8DAA8D;IAC9D,IAAI,EAAE,MAAM,CAAC;IACb,oCAAoC;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,8BAA8B;IAC9B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,gCAAgC;IAChC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,0CAA0C;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,mBAAmB;IACnB,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IACxE,0BAA0B;IAC1B,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,iBAAiB,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IAClE,sBAAsB;IACtB,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAC1C,2BAA2B;IAC3B,IAAI,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IAC7C,2CAA2C;IAC3C,WAAW,IAAI,OAAO,CAAC;CACxB"}

package/dist/types.js

@@ -0,0 +1,8 @@
+/**
+ * Agent Relay Memory Types
+ *
+ * Core types for the memory adapter system. Memory adapters provide
+ * semantic storage and retrieval of agent learnings and context.
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG"}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@agent-relay/memory",
+  "version": "0.1.0",
+  "description": "Semantic memory storage and retrieval system for agent-relay with multiple backend support",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf dist",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "dependencies": {
+    "@agent-relay/hooks": "^0.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.19.3",
+    "typescript": "^5.9.3",
+    "vitest": "^3.2.4"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}