@langchain/langgraph-checkpoint-redis 0.0.1

package/dist/store.d.ts

@@ -0,0 +1,132 @@
+import { createClient, createCluster } from "redis";
+/** A conventional Redis connection. */
+export type RedisClientConnection = ReturnType<typeof createClient>;
+/** A clustered Redis connection. */
+export type RedisClusterConnection = ReturnType<typeof createCluster>;
+/** A Redis connection, clustered or conventional. */
+export type RedisConnection = RedisClientConnection | RedisClusterConnection;
+import { type GetOperation, type ListNamespacesOperation, type Operation, type PutOperation, type SearchOperation } from "@langchain/langgraph-checkpoint";
+export declare function isPutOperation(op: Operation): op is PutOperation;
+export declare function isGetOperation(op: Operation): op is GetOperation;
+export declare function isSearchOperation(op: Operation): op is SearchOperation;
+export declare function isListNamespacesOperation(op: Operation): op is ListNamespacesOperation;
+export interface FilterOperators {
+    $eq?: any;
+    $ne?: any;
+    $gt?: number;
+    $gte?: number;
+    $lt?: number;
+    $lte?: number;
+    $in?: any[];
+    $nin?: any[];
+    $exists?: boolean;
+}
+export type FilterValue = any | FilterOperators;
+export type Filter = Record<string, FilterValue>;
+/**
+ * Internal class for evaluating filters against documents.
+ * Supports MongoDB-style query operators.
+ */
+declare class FilterBuilder {
+    /**
+     * Evaluates if a document matches the given filter criteria.
+     * Supports advanced operators like $gt, $lt, $in, etc.
+     */
+    static matchesFilter(doc: Record<string, any>, filter: Filter): boolean;
+    /**
+     * Builds a Redis Search query string from filter criteria.
+     * Note: This is limited by RediSearch capabilities and may not support all operators.
+     */
+    static buildRedisSearchQuery(filter: Filter, prefix?: string): {
+        query: string;
+        useClientFilter: boolean;
+    };
+    private static matchesFieldFilter;
+    private static matchesOperators;
+    private static matchesOperator;
+    private static isEqual;
+    private static getNestedValue;
+}
+export interface Item {
+    value: any;
+    key: string;
+    namespace: string[];
+    created_at: Date;
+    updated_at: Date;
+}
+export interface SearchItem extends Item {
+    score?: number;
+}
+export interface IndexConfig {
+    dims: number;
+    embed?: any;
+    distanceType?: "cosine" | "l2" | "ip";
+    fields?: string[];
+    vectorStorageType?: string;
+    similarityThreshold?: number;
+}
+export interface TTLConfig {
+    defaultTTL?: number;
+    refreshOnRead?: boolean;
+}
+export interface StoreConfig {
+    index?: IndexConfig;
+    ttl?: TTLConfig;
+}
+export declare class RedisStore {
+    private readonly client;
+    private readonly indexConfig?;
+    private readonly ttlConfig?;
+    private readonly embeddings?;
+    constructor(client: RedisConnection, config?: StoreConfig);
+    static fromConnString(connString: string, config?: StoreConfig): Promise<RedisStore>;
+    static fromCluster(rootNodes: Array<{
+        url: string;
+    }>, config?: StoreConfig): Promise<RedisStore>;
+    setup(): Promise<void>;
+    get(namespace: string[], key: string, options?: {
+        refreshTTL?: boolean;
+    }): Promise<Item | null>;
+    put(namespace: string[], key: string, value: any, options?: {
+        ttl?: number;
+        index?: boolean | string[];
+    }): Promise<void>;
+    delete(namespace: string[], key: string): Promise<void>;
+    search(namespacePrefix: string[], options?: {
+        filter?: Filter;
+        query?: string;
+        limit?: number;
+        offset?: number;
+        refreshTTL?: boolean;
+        similarityThreshold?: number;
+    }): Promise<SearchItem[]>;
+    listNamespaces(options?: {
+        prefix?: string[];
+        suffix?: string[];
+        maxDepth?: number;
+        limit?: number;
+        offset?: number;
+    }): Promise<string[][]>;
+    batch(ops: Operation[]): Promise<any[]>;
+    close(): Promise<void>;
+    /**
+     * Get statistics about the store.
+     * Returns document counts and other metrics.
+     */
+    getStatistics(): Promise<{
+        totalDocuments: number;
+        namespaceCount: number;
+        vectorDocuments?: number;
+        indexInfo?: Record<string, any>;
+    }>;
+    private validateNamespace;
+    private refreshItemTTL;
+    private escapeTagValue;
+    /**
+     * Calculate similarity score based on the distance metric.
+     * Converts raw distance to a normalized similarity score [0,1].
+     */
+    private calculateSimilarityScore;
+}
+export { FilterBuilder };
+//# sourceMappingURL=store.d.ts.map

package/dist/store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../src/store.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAEpD,uCAAuC;AACvC,MAAM,MAAM,qBAAqB,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC;AAEpE,oCAAoC;AACpC,MAAM,MAAM,sBAAsB,GAAG,UAAU,CAAC,OAAO,aAAa,CAAC,CAAC;AAEtE,qDAAqD;AACrD,MAAM,MAAM,eAAe,GAAG,qBAAqB,GAAG,sBAAsB,CAAC;AAE7E,OAAO,EACL,KAAK,YAAY,EAEjB,KAAK,uBAAuB,EAC5B,KAAK,SAAS,EACd,KAAK,YAAY,EACjB,KAAK,eAAe,EACrB,MAAM,iCAAiC,CAAC;AAGzC,wBAAgB,cAAc,CAAC,EAAE,EAAE,SAAS,GAAG,EAAE,IAAI,YAAY,CAEhE;AAED,wBAAgB,cAAc,CAAC,EAAE,EAAE,SAAS,GAAG,EAAE,IAAI,YAAY,CAQhE;AAED,wBAAgB,iBAAiB,CAAC,EAAE,EAAE,SAAS,GAAG,EAAE,IAAI,eAAe,CAEtE;AAED,wBAAgB,yBAAyB,CACvC,EAAE,EAAE,SAAS,GACZ,EAAE,IAAI,uBAAuB,CAE/B;AAGD,MAAM,WAAW,eAAe;IAC9B,GAAG,CAAC,EAAE,GAAG,CAAC;IACV,GAAG,CAAC,EAAE,GAAG,CAAC;IACV,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC;IACZ,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;IACb,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,MAAM,WAAW,GAAG,GAAG,GAAG,eAAe,CAAC;AAChD,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;AAEjD;;;GAGG;AACH,cAAM,aAAa;IACjB;;;OAGG;IACH,MAAM,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO;IASvE;;;OAGG;IACH,MAAM,CAAC,qBAAqB,CAC1B,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,MAAM,GACd;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,eAAe,EAAE,OAAO,CAAA;KAAE;IAqC9C,OAAO,CAAC,MAAM,CAAC,kBAAkB;IAuBjC,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAY/B,OAAO,CAAC,MAAM,CAAC,eAAe;IA2D9B,OAAO,CAAC,MAAM,CAAC,OAAO;IA8BtB,OAAO,CAAC,MAAM,CAAC,cAAc;CAa9B;AAED,MAAM,WAAW,IAAI;IACnB,KAAK,EAAE,GAAG,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,UAAU,EAAE,IAAI,CAAC;IACjB,UAAU,EAAE,IAAI,CAAC;CAClB;AAED,MAAM,WAAW,UAAW,SAAQ,IAAI;IACtC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAmBD,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,YAAY,CAAC,EAAE,QAAQ,GAAG,IAAI,GAAG,IAAI,CAAC;IACtC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,SAAS;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,GAAG,CAAC,EAAE,SAAS,CAAC;CACjB;AA+BD,qBAAa,UAAU;IACrB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAkB;IACzC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAc;IAC3C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAY;IACvC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAM;gBAEtB,MAAM,EAAE,eAAe,EAAE,MAAM,CAAC,EAAE,WAAW;WAU5C,cAAc,CACzB,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,UAAU,CAAC;WAQT,WAAW,CACtB,SAAS,EAAE,KAAK,CAAC;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC,EACjC,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,UAAU,CAAC;IAQhB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAyDtB,GAAG,CACP,SAAS,EAAE,MAAM,EAAE,EACnB,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,OAAO,CAAA;KAAE,GACjC,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;IA2EjB,GAAG,CACP,SAAS,EAAE,MAAM,EAAE,EACnB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,GAAG,EACV,OAAO,CAAC,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,GAAG,MAAM,EAAE,CAAA;KAAE,GACrD,OAAO,CAAC,IAAI,CAAC;IAsHV,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvD,MAAM,CACV,eAAe,EAAE,MAAM,EAAE,EACzB,OAAO,CAAC,EAAE;QACR,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,mBAAmB,CAAC,EAAE,MAAM,CAAC;KAC9B,GACA,OAAO,CAAC,UAAU,EAAE,CAAC;IAgJlB,cAAc,CAAC,OAAO,CAAC,EAAE;QAC7B,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;QAClB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,GAAG,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;IA4EjB,KAAK,CAAC,GAAG,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAsDvC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAI5B;;;OAGG;IACG,aAAa,IAAI,OAAO,CAAC;QAC7B,cAAc,EAAE,MAAM,CAAC;QACvB,cAAc,EAAE,MAAM,CAAC;QACvB,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KACjC,CAAC;IAsDF,OAAO,CAAC,iBAAiB;YAiCX,cAAc;IAgB5B,OAAO,CAAC,cAAc;IAetB;;;OAGG;IACH,OAAO,CAAC,wBAAwB;CAuBjC;AAGD,OAAO,EAAE,aAAa,EAAE,CAAC"}