@agentskit/memory 0.9.0 → 0.10.0

package/dist/index.d.cts

@@ -485,4 +485,145 @@ declare function wrapChatMemoryWithRedaction(inner: ChatMemory, options: ChatMem
  */
 declare function wrapVectorMemoryWithRedaction(inner: VectorMemory, options: VectorMemoryRedactionOptions): VectorMemory;
 
-export { type ChatMemoryRedactionOptions, type ChromaConfig, type EncryptedEnvelope, type EncryptedMemoryOptions, type FileVectorMemoryConfig, type ForgetReport, type ForgetSubjectResult, type ForgettableMemory, type GraphEdge, type GraphMemory, type GraphNode, type GraphQuery, type HierarchicalMemory, type HierarchicalMemoryOptions, type HierarchicalRecall, type MilvusConfig, type MongoAtlasVectorConfig, type MongoCollectionLike, type PgVectorConfig, type PgVectorRunner, type PineconeConfig, type QdrantConfig, type RedactionMode, type RedisChatMemoryConfig, type RedisClientAdapter, type RedisConnectionConfig, type RedisVectorMemoryConfig, type SqliteChatMemoryConfig, type SupabaseVectorStoreConfig, type TursoChatMemoryConfig, type UpstashVectorConfig, type VectorMemoryRedactionOptions, type VectorStore, type VectorStoreDocument, type VectorStoreResult, type WeaviateConfig, chroma, createEncryptedMemory, createHierarchicalMemory, createInMemoryGraph, fileChatMemory, fileVectorMemory, forgetSubject, makeForgettable, matchesFilter, milvusVectorStore, mongoAtlasVectorStore, pgvector, pinecone, qdrant, redisChatMemory, redisVectorMemory, sqliteChatMemory, supabaseVectorStore, tursoChatMemory, upstashVector, weaviateVectorStore, wrapChatMemoryWithRedaction, wrapVectorMemoryWithRedaction };
+/** Minimal KV store contract. */
+interface AgentskitMemoryStore {
+    readonly id: string | undefined;
+    get(key: string): Promise<unknown>;
+    set(key: string, value: unknown): Promise<void>;
+}
+interface KvEntry {
+    readonly value: unknown;
+    readonly insertedAt: number;
+}
+interface CommonKvConfig {
+    readonly maxMessages?: number;
+    readonly ttlSeconds?: number;
+}
+interface InMemoryKvConfig extends CommonKvConfig {
+    readonly backend: 'in-memory';
+}
+interface FileKvConfig extends CommonKvConfig {
+    readonly backend: 'file';
+    readonly path: string;
+}
+interface SqliteKvConfig extends CommonKvConfig {
+    readonly backend: 'sqlite';
+    readonly path: string;
+}
+interface RedisKvConfig extends CommonKvConfig {
+    readonly backend: 'redis';
+    readonly url: string;
+    readonly prefix: string;
+}
+interface VectorKvConfig extends CommonKvConfig {
+    readonly backend: 'vector';
+    readonly provider: string;
+    readonly collection: string;
+}
+interface LocalStorageKvConfig extends CommonKvConfig {
+    readonly backend: 'localstorage';
+    readonly key: string;
+}
+type KvMemoryConfig = InMemoryKvConfig | FileKvConfig | SqliteKvConfig | RedisKvConfig | VectorKvConfig | LocalStorageKvConfig;
+interface RedisLike {
+    get(key: string): Promise<string | null>;
+    set(key: string, value: string, options?: {
+        readonly EX?: number;
+    }): Promise<unknown>;
+    del(key: string): Promise<unknown>;
+    keys(pattern: string): Promise<readonly string[]>;
+}
+interface SqliteStmt {
+    run(...params: unknown[]): void;
+    get(...params: unknown[]): unknown;
+    all(...params: unknown[]): unknown[];
+}
+interface SqliteLike {
+    exec(sql: string): void;
+    prepare(sql: string): SqliteStmt;
+}
+type SqliteOpener = (path: string) => SqliteLike;
+interface MemoryVectorStoreLike {
+    upsert(rows: readonly {
+        readonly chunkId: string;
+        readonly vec: readonly number[];
+        readonly metadata: Record<string, unknown>;
+    }[]): Promise<void>;
+    query(vec: readonly number[], k: number, filter?: Record<string, unknown>): Promise<readonly {
+        readonly chunkId: string;
+        readonly score: number;
+        readonly metadata: Record<string, unknown>;
+    }[]>;
+}
+interface MemoryEmbedderLike {
+    embed(texts: readonly string[]): Promise<number[][]>;
+}
+interface LocalStorageLike {
+    getItem(key: string): string | null;
+    setItem(key: string, value: string): void;
+}
+
+declare const createInMemoryStore: (config: InMemoryKvConfig) => AgentskitMemoryStore;
+declare const createFileStore: (config: FileKvConfig) => AgentskitMemoryStore;
+interface CreateLocalStorageStoreOpts {
+    readonly config: LocalStorageKvConfig;
+    readonly storage?: LocalStorageLike;
+    readonly filePath?: string;
+}
+declare const createLocalStorageStore: ({ config, storage, filePath, }: CreateLocalStorageStoreOpts) => AgentskitMemoryStore;
+
+interface CreateSqliteStoreOpts {
+    readonly config: SqliteKvConfig;
+    readonly open: SqliteOpener;
+}
+declare const createSqliteStore: ({ config, open }: CreateSqliteStoreOpts) => AgentskitMemoryStore;
+/**
+ * Lazy-import `better-sqlite3` and return an opener, or `undefined` when the
+ * optional peer dep is absent (caller surfaces AK_MEMORY_PEER_MISSING).
+ */
+declare const tryDefaultSqliteOpener: () => Promise<SqliteOpener | undefined>;
+
+interface CreateRedisStoreOpts {
+    readonly config: RedisKvConfig;
+    readonly client: RedisLike;
+}
+declare const createRedisStore: ({ config, client }: CreateRedisStoreOpts) => AgentskitMemoryStore;
+/** Bridge an `ioredis`-style client to the {@link RedisLike} options-object shape. */
+declare const adaptIoredis: (io: {
+    get(key: string): Promise<string | null>;
+    set(key: string, value: string, mode?: string, ttl?: number): Promise<unknown>;
+    del(key: string): Promise<unknown>;
+    keys(pattern: string): Promise<string[]>;
+}) => RedisLike;
+/** Lazy-import `redis` (node-redis v4), connect, and return a client; `undefined` if absent. */
+declare const tryDefaultRedisClient: (url: string) => Promise<RedisLike | undefined>;
+
+interface CreateVectorStoreOpts {
+    readonly config: VectorKvConfig;
+    readonly vectorStore: MemoryVectorStoreLike;
+    readonly embedder: MemoryEmbedderLike;
+}
+declare const createVectorStore: ({ config, vectorStore, embedder, }: CreateVectorStoreOpts) => AgentskitMemoryStore & {
+    recall(query: string, k?: number): Promise<readonly unknown[]>;
+};
+
+declare class MemoryBackendNotImplementedError extends Error {
+    readonly code = "MEMORY_BACKEND_NOT_IMPLEMENTED";
+    readonly backend: KvMemoryConfig['backend'];
+    constructor(backend: KvMemoryConfig['backend']);
+}
+type MemoryBackendStatus = 'supported' | 'planned';
+declare const MEMORY_BACKEND_SUPPORT: Readonly<Record<KvMemoryConfig['backend'], MemoryBackendStatus>>;
+declare const isMemoryBackendSupported: (backend: KvMemoryConfig["backend"]) => boolean;
+interface CreateKvMemoryFromConfigOpts {
+    readonly config: KvMemoryConfig;
+    readonly sqlite?: SqliteOpener;
+    readonly localStorageFilePath?: string;
+    readonly redis?: RedisLike;
+    readonly vectorStore?: MemoryVectorStoreLike;
+    readonly embedder?: MemoryEmbedderLike;
+}
+declare const createKvMemoryFromConfig: ({ config, sqlite, localStorageFilePath, redis, vectorStore, embedder, }: CreateKvMemoryFromConfigOpts) => AgentskitMemoryStore;
+declare const createKvMemoryFromConfigAuto: (config: KvMemoryConfig) => Promise<AgentskitMemoryStore>;
+
+export { type AgentskitMemoryStore, type ChatMemoryRedactionOptions, type ChromaConfig, type CreateKvMemoryFromConfigOpts, type CreateLocalStorageStoreOpts, type CreateRedisStoreOpts, type CreateSqliteStoreOpts, type CreateVectorStoreOpts, type EncryptedEnvelope, type EncryptedMemoryOptions, type FileKvConfig, type FileVectorMemoryConfig, type ForgetReport, type ForgetSubjectResult, type ForgettableMemory, type GraphEdge, type GraphMemory, type GraphNode, type GraphQuery, type HierarchicalMemory, type HierarchicalMemoryOptions, type HierarchicalRecall, type InMemoryKvConfig, type KvEntry, type KvMemoryConfig, type LocalStorageKvConfig, type LocalStorageLike, MEMORY_BACKEND_SUPPORT, MemoryBackendNotImplementedError, type MemoryBackendStatus, type MemoryEmbedderLike, type MemoryVectorStoreLike, type MilvusConfig, type MongoAtlasVectorConfig, type MongoCollectionLike, type PgVectorConfig, type PgVectorRunner, type PineconeConfig, type QdrantConfig, type RedactionMode, type RedisChatMemoryConfig, type RedisClientAdapter, type RedisConnectionConfig, type RedisKvConfig, type RedisLike, type RedisVectorMemoryConfig, type SqliteChatMemoryConfig, type SqliteKvConfig, type SqliteLike, type SqliteOpener, type SqliteStmt, type SupabaseVectorStoreConfig, type TursoChatMemoryConfig, type UpstashVectorConfig, type VectorKvConfig, type VectorMemoryRedactionOptions, type VectorStore, type VectorStoreDocument, type VectorStoreResult, type WeaviateConfig, adaptIoredis, chroma, createEncryptedMemory, createFileStore, createHierarchicalMemory, createInMemoryGraph, createInMemoryStore, createKvMemoryFromConfig, createKvMemoryFromConfigAuto, createLocalStorageStore, createRedisStore, createSqliteStore, createVectorStore, fileChatMemory, fileVectorMemory, forgetSubject, isMemoryBackendSupported, makeForgettable, matchesFilter, milvusVectorStore, mongoAtlasVectorStore, pgvector, pinecone, qdrant, redisChatMemory, redisVectorMemory, sqliteChatMemory, supabaseVectorStore, tryDefaultRedisClient, tryDefaultSqliteOpener, tursoChatMemory, upstashVector, weaviateVectorStore, wrapChatMemoryWithRedaction, wrapVectorMemoryWithRedaction };

package/dist/index.d.ts

@@ -485,4 +485,145 @@ declare function wrapChatMemoryWithRedaction(inner: ChatMemory, options: ChatMem
  */
 declare function wrapVectorMemoryWithRedaction(inner: VectorMemory, options: VectorMemoryRedactionOptions): VectorMemory;
 
-export { type ChatMemoryRedactionOptions, type ChromaConfig, type EncryptedEnvelope, type EncryptedMemoryOptions, type FileVectorMemoryConfig, type ForgetReport, type ForgetSubjectResult, type ForgettableMemory, type GraphEdge, type GraphMemory, type GraphNode, type GraphQuery, type HierarchicalMemory, type HierarchicalMemoryOptions, type HierarchicalRecall, type MilvusConfig, type MongoAtlasVectorConfig, type MongoCollectionLike, type PgVectorConfig, type PgVectorRunner, type PineconeConfig, type QdrantConfig, type RedactionMode, type RedisChatMemoryConfig, type RedisClientAdapter, type RedisConnectionConfig, type RedisVectorMemoryConfig, type SqliteChatMemoryConfig, type SupabaseVectorStoreConfig, type TursoChatMemoryConfig, type UpstashVectorConfig, type VectorMemoryRedactionOptions, type VectorStore, type VectorStoreDocument, type VectorStoreResult, type WeaviateConfig, chroma, createEncryptedMemory, createHierarchicalMemory, createInMemoryGraph, fileChatMemory, fileVectorMemory, forgetSubject, makeForgettable, matchesFilter, milvusVectorStore, mongoAtlasVectorStore, pgvector, pinecone, qdrant, redisChatMemory, redisVectorMemory, sqliteChatMemory, supabaseVectorStore, tursoChatMemory, upstashVector, weaviateVectorStore, wrapChatMemoryWithRedaction, wrapVectorMemoryWithRedaction };
+/** Minimal KV store contract. */
+interface AgentskitMemoryStore {
+    readonly id: string | undefined;
+    get(key: string): Promise<unknown>;
+    set(key: string, value: unknown): Promise<void>;
+}
+interface KvEntry {
+    readonly value: unknown;
+    readonly insertedAt: number;
+}
+interface CommonKvConfig {
+    readonly maxMessages?: number;
+    readonly ttlSeconds?: number;
+}
+interface InMemoryKvConfig extends CommonKvConfig {
+    readonly backend: 'in-memory';
+}
+interface FileKvConfig extends CommonKvConfig {
+    readonly backend: 'file';
+    readonly path: string;
+}
+interface SqliteKvConfig extends CommonKvConfig {
+    readonly backend: 'sqlite';
+    readonly path: string;
+}
+interface RedisKvConfig extends CommonKvConfig {
+    readonly backend: 'redis';
+    readonly url: string;
+    readonly prefix: string;
+}
+interface VectorKvConfig extends CommonKvConfig {
+    readonly backend: 'vector';
+    readonly provider: string;
+    readonly collection: string;
+}
+interface LocalStorageKvConfig extends CommonKvConfig {
+    readonly backend: 'localstorage';
+    readonly key: string;
+}
+type KvMemoryConfig = InMemoryKvConfig | FileKvConfig | SqliteKvConfig | RedisKvConfig | VectorKvConfig | LocalStorageKvConfig;
+interface RedisLike {
+    get(key: string): Promise<string | null>;
+    set(key: string, value: string, options?: {
+        readonly EX?: number;
+    }): Promise<unknown>;
+    del(key: string): Promise<unknown>;
+    keys(pattern: string): Promise<readonly string[]>;
+}
+interface SqliteStmt {
+    run(...params: unknown[]): void;
+    get(...params: unknown[]): unknown;
+    all(...params: unknown[]): unknown[];
+}
+interface SqliteLike {
+    exec(sql: string): void;
+    prepare(sql: string): SqliteStmt;
+}
+type SqliteOpener = (path: string) => SqliteLike;
+interface MemoryVectorStoreLike {
+    upsert(rows: readonly {
+        readonly chunkId: string;
+        readonly vec: readonly number[];
+        readonly metadata: Record<string, unknown>;
+    }[]): Promise<void>;
+    query(vec: readonly number[], k: number, filter?: Record<string, unknown>): Promise<readonly {
+        readonly chunkId: string;
+        readonly score: number;
+        readonly metadata: Record<string, unknown>;
+    }[]>;
+}
+interface MemoryEmbedderLike {
+    embed(texts: readonly string[]): Promise<number[][]>;
+}
+interface LocalStorageLike {
+    getItem(key: string): string | null;
+    setItem(key: string, value: string): void;
+}
+
+declare const createInMemoryStore: (config: InMemoryKvConfig) => AgentskitMemoryStore;
+declare const createFileStore: (config: FileKvConfig) => AgentskitMemoryStore;
+interface CreateLocalStorageStoreOpts {
+    readonly config: LocalStorageKvConfig;
+    readonly storage?: LocalStorageLike;
+    readonly filePath?: string;
+}
+declare const createLocalStorageStore: ({ config, storage, filePath, }: CreateLocalStorageStoreOpts) => AgentskitMemoryStore;
+
+interface CreateSqliteStoreOpts {
+    readonly config: SqliteKvConfig;
+    readonly open: SqliteOpener;
+}
+declare const createSqliteStore: ({ config, open }: CreateSqliteStoreOpts) => AgentskitMemoryStore;
+/**
+ * Lazy-import `better-sqlite3` and return an opener, or `undefined` when the
+ * optional peer dep is absent (caller surfaces AK_MEMORY_PEER_MISSING).
+ */
+declare const tryDefaultSqliteOpener: () => Promise<SqliteOpener | undefined>;
+
+interface CreateRedisStoreOpts {
+    readonly config: RedisKvConfig;
+    readonly client: RedisLike;
+}
+declare const createRedisStore: ({ config, client }: CreateRedisStoreOpts) => AgentskitMemoryStore;
+/** Bridge an `ioredis`-style client to the {@link RedisLike} options-object shape. */
+declare const adaptIoredis: (io: {
+    get(key: string): Promise<string | null>;
+    set(key: string, value: string, mode?: string, ttl?: number): Promise<unknown>;
+    del(key: string): Promise<unknown>;
+    keys(pattern: string): Promise<string[]>;
+}) => RedisLike;
+/** Lazy-import `redis` (node-redis v4), connect, and return a client; `undefined` if absent. */
+declare const tryDefaultRedisClient: (url: string) => Promise<RedisLike | undefined>;
+
+interface CreateVectorStoreOpts {
+    readonly config: VectorKvConfig;
+    readonly vectorStore: MemoryVectorStoreLike;
+    readonly embedder: MemoryEmbedderLike;
+}
+declare const createVectorStore: ({ config, vectorStore, embedder, }: CreateVectorStoreOpts) => AgentskitMemoryStore & {
+    recall(query: string, k?: number): Promise<readonly unknown[]>;
+};
+
+declare class MemoryBackendNotImplementedError extends Error {
+    readonly code = "MEMORY_BACKEND_NOT_IMPLEMENTED";
+    readonly backend: KvMemoryConfig['backend'];
+    constructor(backend: KvMemoryConfig['backend']);
+}
+type MemoryBackendStatus = 'supported' | 'planned';
+declare const MEMORY_BACKEND_SUPPORT: Readonly<Record<KvMemoryConfig['backend'], MemoryBackendStatus>>;
+declare const isMemoryBackendSupported: (backend: KvMemoryConfig["backend"]) => boolean;
+interface CreateKvMemoryFromConfigOpts {
+    readonly config: KvMemoryConfig;
+    readonly sqlite?: SqliteOpener;
+    readonly localStorageFilePath?: string;
+    readonly redis?: RedisLike;
+    readonly vectorStore?: MemoryVectorStoreLike;
+    readonly embedder?: MemoryEmbedderLike;
+}
+declare const createKvMemoryFromConfig: ({ config, sqlite, localStorageFilePath, redis, vectorStore, embedder, }: CreateKvMemoryFromConfigOpts) => AgentskitMemoryStore;
+declare const createKvMemoryFromConfigAuto: (config: KvMemoryConfig) => Promise<AgentskitMemoryStore>;
+
+export { type AgentskitMemoryStore, type ChatMemoryRedactionOptions, type ChromaConfig, type CreateKvMemoryFromConfigOpts, type CreateLocalStorageStoreOpts, type CreateRedisStoreOpts, type CreateSqliteStoreOpts, type CreateVectorStoreOpts, type EncryptedEnvelope, type EncryptedMemoryOptions, type FileKvConfig, type FileVectorMemoryConfig, type ForgetReport, type ForgetSubjectResult, type ForgettableMemory, type GraphEdge, type GraphMemory, type GraphNode, type GraphQuery, type HierarchicalMemory, type HierarchicalMemoryOptions, type HierarchicalRecall, type InMemoryKvConfig, type KvEntry, type KvMemoryConfig, type LocalStorageKvConfig, type LocalStorageLike, MEMORY_BACKEND_SUPPORT, MemoryBackendNotImplementedError, type MemoryBackendStatus, type MemoryEmbedderLike, type MemoryVectorStoreLike, type MilvusConfig, type MongoAtlasVectorConfig, type MongoCollectionLike, type PgVectorConfig, type PgVectorRunner, type PineconeConfig, type QdrantConfig, type RedactionMode, type RedisChatMemoryConfig, type RedisClientAdapter, type RedisConnectionConfig, type RedisKvConfig, type RedisLike, type RedisVectorMemoryConfig, type SqliteChatMemoryConfig, type SqliteKvConfig, type SqliteLike, type SqliteOpener, type SqliteStmt, type SupabaseVectorStoreConfig, type TursoChatMemoryConfig, type UpstashVectorConfig, type VectorKvConfig, type VectorMemoryRedactionOptions, type VectorStore, type VectorStoreDocument, type VectorStoreResult, type WeaviateConfig, adaptIoredis, chroma, createEncryptedMemory, createFileStore, createHierarchicalMemory, createInMemoryGraph, createInMemoryStore, createKvMemoryFromConfig, createKvMemoryFromConfigAuto, createLocalStorageStore, createRedisStore, createSqliteStore, createVectorStore, fileChatMemory, fileVectorMemory, forgetSubject, isMemoryBackendSupported, makeForgettable, matchesFilter, milvusVectorStore, mongoAtlasVectorStore, pgvector, pinecone, qdrant, redisChatMemory, redisVectorMemory, sqliteChatMemory, supabaseVectorStore, tryDefaultRedisClient, tryDefaultSqliteOpener, tursoChatMemory, upstashVector, weaviateVectorStore, wrapChatMemoryWithRedaction, wrapVectorMemoryWithRedaction };