@agentskit/memory 0.5.0 → 0.5.2

package/README.md

@@ -1,14 +1,22 @@
 # @agentskit/memory
 
-![stability: stable](https://img.shields.io/badge/stability-stable-brightgreen)
-
 Persist conversations and add vector search to your agents — swap backends without changing agent code.
 
-## Why
+[![npm version](https://img.shields.io/npm/v/@agentskit/memory?color=blue)](https://www.npmjs.com/package/@agentskit/memory)
+[![npm downloads](https://img.shields.io/npm/dm/@agentskit/memory)](https://www.npmjs.com/package/@agentskit/memory)
+[![bundle size](https://img.shields.io/bundlephobia/minzip/@agentskit/memory)](https://bundlephobia.com/package/@agentskit/memory)
+[![license](https://img.shields.io/npm/l/@agentskit/memory)](../../LICENSE)
+[![stability](https://img.shields.io/badge/stability-stable-brightgreen)](../../docs/STABILITY.md)
+[![GitHub stars](https://img.shields.io/github/stars/AgentsKit-io/agentskit?style=social)](https://github.com/AgentsKit-io/agentskit)
+
+**Tags:** `ai` · `agents` · `llm` · `agentskit` · `ai-agents` · `memory` · `vector-db` · `embeddings` · `rag` · `sqlite` · `redis` · `vector-search`
+
+## Why memory
 
 - **Conversations that survive restarts** — SQLite for local development, Redis for production; your agent remembers context across sessions with zero code changes
 - **RAG-ready vector search** — store and retrieve embeddings with `fileVectorMemory` (pure JS, no native deps) or Redis vector search for scale
 - **Plug any backend** — the `VectorStore` interface is 3 methods; bring LanceDB, Pinecone, or any custom store in minutes
+- **One interface, every deployment target** — swap from `inMemory` to `sqlite` to `redis` without touching agent code
 
 ## Install
 
@@ -39,10 +47,12 @@ console.log(result.content)
 
 Use a **vector** backend with [`@agentskit/rag`](https://www.npmjs.com/package/@agentskit/rag) `createRAG({ embed, store })` — `fileVectorMemory` and `redisVectorMemory` implement `VectorMemory` for chunk storage and search.
 
-## Next steps
+## Features
 
-- Swap `sqliteChatMemory` for **Redis** or **in-memory** variants from the same package for different deployment targets
-- Pair **embedders** from [`@agentskit/adapters`](https://www.npmjs.com/package/@agentskit/adapters) with RAG — see [`@agentskit/rag`](https://www.npmjs.com/package/@agentskit/rag)
+- Chat memory: `inMemoryChatMemory`, `sqliteChatMemory`, `redisChatMemory`, `fileChatMemory`
+- Vector memory: `fileVectorMemory` (pure JS), `redisVectorMemory`
+- `VectorMemory` interface — 3 methods, bring any custom store
+- Memory contract v1 (ADR 0003) — substitutable across `runtime`, `useChat`, and `@agentskit/ink`
 
 ## Ecosystem
 
@@ -53,6 +63,16 @@ Use a **vector** backend with [`@agentskit/rag`](https://www.npmjs.com/package/@
 | [@agentskit/runtime](https://www.npmjs.com/package/@agentskit/runtime) | `memory` / `retriever` options |
 | [@agentskit/adapters](https://www.npmjs.com/package/@agentskit/adapters) | Embeddings for RAG |
 
+## Contributors
+
+<a href="https://github.com/AgentsKit-io/agentskit/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=AgentsKit-io/agentskit" alt="AgentsKit contributors" />
+</a>
+
+## License
+
+MIT — see [LICENSE](../../LICENSE).
+
 ## Docs
 
-[Full documentation](https://emersonbraun.github.io/agentskit/)
+[Full documentation](https://www.agentskit.io) · [GitHub](https://github.com/AgentsKit-io/agentskit)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agentskit/memory",
-  "version": "0.5.0",
+  "version": "0.5.2",
   "description": "Persistent and vector memory backends for AgentsKit.",
   "keywords": [
     "agentskit",
@@ -11,7 +11,16 @@
     "typescript",
     "memory",
     "vector",
-    "embeddings"
+    "embeddings",
+    "openai",
+    "anthropic",
+    "ai-agents",
+    "vector-db",
+    "sqlite",
+    "redis",
+    "rag",
+    "vector-search",
+    "persistence"
   ],
   "type": "module",
   "main": "./dist/index.cjs",
@@ -31,7 +40,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@agentskit/core": "1.0.0"
+    "@agentskit/core": "1.1.0"
   },
   "devDependencies": {
     "@types/better-sqlite3": "^7.6.12",

package/dist/file-vector.d.ts

@@ -1,8 +0,0 @@
-import type { VectorMemory } from '@agentskit/core';
-import type { VectorStore } from './vector-store';
-export interface FileVectorMemoryConfig {
-    path: string;
-    store?: VectorStore;
-}
-export declare function fileVectorMemory(config: FileVectorMemoryConfig): VectorMemory;
-//# sourceMappingURL=file-vector.d.ts.map

package/dist/file-vector.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"file-vector.d.ts","sourceRoot":"","sources":["../src/file-vector.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAqC,MAAM,iBAAiB,CAAA;AACtF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAEjD,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,WAAW,CAAA;CACpB;AAkED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,sBAAsB,GAAG,YAAY,CAkC7E"}

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAA;AAC3C,YAAY,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAA;AAEtD,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AAC9C,YAAY,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAA;AAEzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAA;AAClD,YAAY,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAA;AAE7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAA;AAChD,YAAY,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAA;AAE3D,YAAY,EAAE,WAAW,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAA;AACzF,YAAY,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAA"}

package/dist/redis-chat.d.ts

@@ -1,8 +0,0 @@
-import type { ChatMemory } from '@agentskit/core';
-import type { RedisConnectionConfig } from './redis-client';
-export interface RedisChatMemoryConfig extends RedisConnectionConfig {
-    keyPrefix?: string;
-    conversationId?: string;
-}
-export declare function redisChatMemory(config: RedisChatMemoryConfig): ChatMemory;
-//# sourceMappingURL=redis-chat.d.ts.map

package/dist/redis-chat.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"redis-chat.d.ts","sourceRoot":"","sources":["../src/redis-chat.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAyB,MAAM,iBAAiB,CAAA;AACxE,OAAO,KAAK,EAAsB,qBAAqB,EAAE,MAAM,gBAAgB,CAAA;AAG/E,MAAM,WAAW,qBAAsB,SAAQ,qBAAqB;IAClE,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB;AA2BD,wBAAgB,eAAe,CAAC,MAAM,EAAE,qBAAqB,GAAG,UAAU,CA2BzE"}

package/dist/redis-client.d.ts

@@ -1,19 +0,0 @@
-/**
- * Internal Redis client adapter interface.
- * Abstracts the underlying Redis library so it can be swapped
- * (e.g., from `redis` to `ioredis`) without changing consumers.
- */
-export interface RedisClientAdapter {
-    get(key: string): Promise<string | null>;
-    set(key: string, value: string): Promise<void>;
-    del(key: string | string[]): Promise<void>;
-    keys(pattern: string): Promise<string[]>;
-    disconnect(): Promise<void>;
-    call(command: string, ...args: (string | number | Buffer)[]): Promise<unknown>;
-}
-export interface RedisConnectionConfig {
-    url: string;
-    client?: RedisClientAdapter;
-}
-export declare function createRedisClientAdapter(url: string): Promise<RedisClientAdapter>;
-//# sourceMappingURL=redis-client.d.ts.map

package/dist/redis-client.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"redis-client.d.ts","sourceRoot":"","sources":["../src/redis-client.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAA;IACxC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC9C,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC1C,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAA;IACxC,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAC3B,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;CAC/E;AAED,MAAM,WAAW,qBAAqB;IACpC,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,CAAC,EAAE,kBAAkB,CAAA;CAC5B;AAED,wBAAsB,wBAAwB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAgCvF"}

package/dist/redis-vector.d.ts

@@ -1,9 +0,0 @@
-import type { VectorMemory } from '@agentskit/core';
-import type { RedisConnectionConfig } from './redis-client';
-export interface RedisVectorMemoryConfig extends RedisConnectionConfig {
-    indexName?: string;
-    keyPrefix?: string;
-    dimensions?: number;
-}
-export declare function redisVectorMemory(config: RedisVectorMemoryConfig): VectorMemory;
-//# sourceMappingURL=redis-vector.d.ts.map

package/dist/redis-vector.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"redis-vector.d.ts","sourceRoot":"","sources":["../src/redis-vector.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAqC,MAAM,iBAAiB,CAAA;AACtF,OAAO,KAAK,EAAsB,qBAAqB,EAAE,MAAM,gBAAgB,CAAA;AAG/E,MAAM,WAAW,uBAAwB,SAAQ,qBAAqB;IACpE,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAUD,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,uBAAuB,GAAG,YAAY,CAiG/E"}

package/dist/sqlite.d.ts

@@ -1,7 +0,0 @@
-import type { ChatMemory } from '@agentskit/core';
-export interface SqliteChatMemoryConfig {
-    path: string;
-    conversationId?: string;
-}
-export declare function sqliteChatMemory(config: SqliteChatMemoryConfig): ChatMemory;
-//# sourceMappingURL=sqlite.d.ts.map

package/dist/sqlite.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"sqlite.d.ts","sourceRoot":"","sources":["../src/sqlite.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAyB,MAAM,iBAAiB,CAAA;AAExE,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,MAAM,CAAA;IACZ,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB;AA4CD,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,sBAAsB,GAAG,UAAU,CAsC3E"}

package/dist/vector-store.d.ts

@@ -1,16 +0,0 @@
-export interface VectorStoreDocument {
-    id: string;
-    vector: number[];
-    metadata: Record<string, unknown>;
-}
-export interface VectorStoreResult {
-    id: string;
-    score: number;
-    metadata: Record<string, unknown>;
-}
-export interface VectorStore {
-    upsert(docs: VectorStoreDocument[]): Promise<void>;
-    query(vector: number[], topK: number): Promise<VectorStoreResult[]>;
-    delete(ids: string[]): Promise<void>;
-}
-//# sourceMappingURL=vector-store.d.ts.map

package/dist/vector-store.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"vector-store.d.ts","sourceRoot":"","sources":["../src/vector-store.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,MAAM,EAAE,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAClC;AAED,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAClC;AAED,MAAM,WAAW,WAAW;IAC1B,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAClD,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAA;IACnE,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACrC"}