@langchain/langgraph-checkpoint-mongodb 0.0.1 → 0.0.2

package/dist/index.cjs

@@ -0,0 +1,236 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MongoDBSaver = void 0;
+const langgraph_checkpoint_1 = require("@langchain/langgraph-checkpoint");
+/**
+ * A LangGraph checkpoint saver backed by a MongoDB database.
+ */
+class MongoDBSaver extends langgraph_checkpoint_1.BaseCheckpointSaver {
+    constructor({ client, dbName, checkpointCollectionName, checkpointWritesCollectionName, }, serde) {
+        super(serde);
+        Object.defineProperty(this, "client", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "db", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "checkpointCollectionName", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: "checkpoints"
+        });
+        Object.defineProperty(this, "checkpointWritesCollectionName", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: "checkpoint_writes"
+        });
+        this.client = client;
+        this.db = this.client.db(dbName);
+        this.checkpointCollectionName =
+            checkpointCollectionName ?? this.checkpointCollectionName;
+        this.checkpointWritesCollectionName =
+            checkpointWritesCollectionName ?? this.checkpointWritesCollectionName;
+    }
+    /**
+     * Retrieves a checkpoint from the MongoDB database based on the
+     * provided config. If the config contains a "checkpoint_id" key, the checkpoint with
+     * the matching thread ID and checkpoint ID is retrieved. Otherwise, the latest checkpoint
+     * for the given thread ID is retrieved.
+     */
+    async getTuple(config) {
+        const { thread_id, checkpoint_ns = "", checkpoint_id, } = config.configurable ?? {};
+        let query;
+        if (checkpoint_id) {
+            query = {
+                thread_id,
+                checkpoint_ns,
+                checkpoint_id,
+            };
+        }
+        else {
+            query = { thread_id, checkpoint_ns };
+        }
+        const result = await this.db
+            .collection(this.checkpointCollectionName)
+            .find(query)
+            .sort("checkpoint_id", -1)
+            .limit(1)
+            .toArray();
+        if (result.length === 0) {
+            return undefined;
+        }
+        const doc = result[0];
+        const configurableValues = {
+            thread_id,
+            checkpoint_ns,
+            checkpoint_id: doc.checkpoint_id,
+        };
+        const checkpoint = (await this.serde.loadsTyped(doc.type, doc.checkpoint.value()));
+        const serializedWrites = await this.db
+            .collection(this.checkpointWritesCollectionName)
+            .find(configurableValues)
+            .toArray();
+        const pendingWrites = await Promise.all(serializedWrites.map(async (serializedWrite) => {
+            return [
+                serializedWrite.task_id,
+                serializedWrite.channel,
+                await this.serde.loadsTyped(serializedWrite.type, serializedWrite.value.value()),
+            ];
+        }));
+        return {
+            config: { configurable: configurableValues },
+            checkpoint,
+            pendingWrites,
+            metadata: (await this.serde.loadsTyped(doc.type, doc.metadata.value())),
+            parentConfig: doc.parent_checkpoint_id != null
+                ? {
+                    configurable: {
+                        thread_id,
+                        checkpoint_ns,
+                        checkpoint_id: doc.parent_checkpoint_id,
+                    },
+                }
+                : undefined,
+        };
+    }
+    /**
+     * Retrieve a list of checkpoint tuples from the MongoDB database based
+     * on the provided config. The checkpoints are ordered by checkpoint ID
+     * in descending order (newest first).
+     */
+    async *list(config, options) {
+        const { limit, before, filter } = options ?? {};
+        let query = {};
+        if (config?.configurable) {
+            query = {
+                thread_id: config.configurable.thread_id,
+                checkpoint_ns: config.configurable.checkpoint_ns ?? "",
+            };
+        }
+        if (filter) {
+            Object.entries(filter).forEach(([key, value]) => {
+                query[`metadata.${key}`] = value;
+            });
+        }
+        if (before) {
+            query.checkpoint_id = { $lt: before.configurable?.checkpoint_id };
+        }
+        let result = this.db
+            .collection(this.checkpointCollectionName)
+            .find(query)
+            .sort("checkpoint_id", -1);
+        if (limit !== undefined) {
+            result = result.limit(limit);
+        }
+        for await (const doc of result) {
+            const checkpoint = (await this.serde.loadsTyped(doc.type, doc.checkpoint.value()));
+            const metadata = (await this.serde.loadsTyped(doc.type, doc.metadata.value()));
+            yield {
+                config: {
+                    configurable: {
+                        thread_id: doc.thread_id,
+                        checkpoint_ns: doc.checkpoint_ns,
+                        checkpoint_id: doc.checkpoint_id,
+                    },
+                },
+                checkpoint,
+                metadata,
+                parentConfig: doc.parent_checkpoint_id
+                    ? {
+                        configurable: {
+                            thread_id: doc.thread_id,
+                            checkpoint_ns: doc.checkpoint_ns,
+                            checkpoint_id: doc.parent_checkpoint_id,
+                        },
+                    }
+                    : undefined,
+            };
+        }
+    }
+    /**
+     * Saves a checkpoint to the MongoDB database. The checkpoint is associated
+     * with the provided config and its parent config (if any).
+     */
+    async put(config, checkpoint, metadata) {
+        const thread_id = config.configurable?.thread_id;
+        const checkpoint_ns = config.configurable?.checkpoint_ns ?? "";
+        const checkpoint_id = checkpoint.id;
+        if (thread_id === undefined) {
+            throw new Error(`The provided config must contain a configurable field with a "thread_id" field.`);
+        }
+        const [checkpointType, serializedCheckpoint] = this.serde.dumpsTyped(checkpoint);
+        const [metadataType, serializedMetadata] = this.serde.dumpsTyped(metadata);
+        if (checkpointType !== metadataType) {
+            throw new Error("Mismatched checkpoint and metadata types.");
+        }
+        const doc = {
+            parent_checkpoint_id: config.configurable?.checkpoint_id,
+            type: checkpointType,
+            checkpoint: serializedCheckpoint,
+            metadata: serializedMetadata,
+        };
+        const upsertQuery = {
+            thread_id,
+            checkpoint_ns,
+            checkpoint_id,
+        };
+        await this.db.collection(this.checkpointCollectionName).updateOne(upsertQuery, {
+            $set: doc,
+        }, { upsert: true });
+        return {
+            configurable: {
+                thread_id,
+                checkpoint_ns,
+                checkpoint_id,
+            },
+        };
+    }
+    /**
+     * Saves intermediate writes associated with a checkpoint to the MongoDB database.
+     */
+    async putWrites(config, writes, taskId) {
+        const thread_id = config.configurable?.thread_id;
+        const checkpoint_ns = config.configurable?.checkpoint_ns;
+        const checkpoint_id = config.configurable?.checkpoint_id;
+        if (thread_id === undefined ||
+            checkpoint_ns === undefined ||
+            checkpoint_id === undefined) {
+            throw new Error(`The provided config must contain a configurable field with "thread_id", "checkpoint_ns" and "checkpoint_id" fields.`);
+        }
+        const operations = writes.map(([channel, value], idx) => {
+            const upsertQuery = {
+                thread_id,
+                checkpoint_ns,
+                checkpoint_id,
+                task_id: taskId,
+                idx,
+            };
+            const [type, serializedValue] = this.serde.dumpsTyped(value);
+            return {
+                updateOne: {
+                    filter: upsertQuery,
+                    update: {
+                        $set: {
+                            channel,
+                            type,
+                            value: serializedValue,
+                        },
+                    },
+                    upsert: true,
+                },
+            };
+        });
+        await this.db
+            .collection(this.checkpointWritesCollectionName)
+            .bulkWrite(operations);
+    }
+}
+exports.MongoDBSaver = MongoDBSaver;

package/dist/index.d.ts

@@ -0,0 +1,41 @@
+import { type MongoClient, type Db as MongoDatabase } from "mongodb";
+import type { RunnableConfig } from "@langchain/core/runnables";
+import { BaseCheckpointSaver, type Checkpoint, type CheckpointListOptions, type CheckpointTuple, type SerializerProtocol, type PendingWrite, type CheckpointMetadata } from "@langchain/langgraph-checkpoint";
+export type MongoDBSaverParams = {
+    client: MongoClient;
+    dbName?: string;
+    checkpointCollectionName?: string;
+    checkpointWritesCollectionName?: string;
+};
+/**
+ * A LangGraph checkpoint saver backed by a MongoDB database.
+ */
+export declare class MongoDBSaver extends BaseCheckpointSaver {
+    protected client: MongoClient;
+    protected db: MongoDatabase;
+    checkpointCollectionName: string;
+    checkpointWritesCollectionName: string;
+    constructor({ client, dbName, checkpointCollectionName, checkpointWritesCollectionName, }: MongoDBSaverParams, serde?: SerializerProtocol);
+    /**
+     * Retrieves a checkpoint from the MongoDB database based on the
+     * provided config. If the config contains a "checkpoint_id" key, the checkpoint with
+     * the matching thread ID and checkpoint ID is retrieved. Otherwise, the latest checkpoint
+     * for the given thread ID is retrieved.
+     */
+    getTuple(config: RunnableConfig): Promise<CheckpointTuple | undefined>;
+    /**
+     * Retrieve a list of checkpoint tuples from the MongoDB database based
+     * on the provided config. The checkpoints are ordered by checkpoint ID
+     * in descending order (newest first).
+     */
+    list(config: RunnableConfig, options?: CheckpointListOptions): AsyncGenerator<CheckpointTuple>;
+    /**
+     * Saves a checkpoint to the MongoDB database. The checkpoint is associated
+     * with the provided config and its parent config (if any).
+     */
+    put(config: RunnableConfig, checkpoint: Checkpoint, metadata: CheckpointMetadata): Promise<RunnableConfig>;
+    /**
+     * Saves intermediate writes associated with a checkpoint to the MongoDB database.
+     */
+    putWrites(config: RunnableConfig, writes: PendingWrite[], taskId: string): Promise<void>;
+}

package/dist/index.js

@@ -0,0 +1,232 @@
+import { BaseCheckpointSaver, } from "@langchain/langgraph-checkpoint";
+/**
+ * A LangGraph checkpoint saver backed by a MongoDB database.
+ */
+export class MongoDBSaver extends BaseCheckpointSaver {
+    constructor({ client, dbName, checkpointCollectionName, checkpointWritesCollectionName, }, serde) {
+        super(serde);
+        Object.defineProperty(this, "client", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "db", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "checkpointCollectionName", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: "checkpoints"
+        });
+        Object.defineProperty(this, "checkpointWritesCollectionName", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: "checkpoint_writes"
+        });
+        this.client = client;
+        this.db = this.client.db(dbName);
+        this.checkpointCollectionName =
+            checkpointCollectionName ?? this.checkpointCollectionName;
+        this.checkpointWritesCollectionName =
+            checkpointWritesCollectionName ?? this.checkpointWritesCollectionName;
+    }
+    /**
+     * Retrieves a checkpoint from the MongoDB database based on the
+     * provided config. If the config contains a "checkpoint_id" key, the checkpoint with
+     * the matching thread ID and checkpoint ID is retrieved. Otherwise, the latest checkpoint
+     * for the given thread ID is retrieved.
+     */
+    async getTuple(config) {
+        const { thread_id, checkpoint_ns = "", checkpoint_id, } = config.configurable ?? {};
+        let query;
+        if (checkpoint_id) {
+            query = {
+                thread_id,
+                checkpoint_ns,
+                checkpoint_id,
+            };
+        }
+        else {
+            query = { thread_id, checkpoint_ns };
+        }
+        const result = await this.db
+            .collection(this.checkpointCollectionName)
+            .find(query)
+            .sort("checkpoint_id", -1)
+            .limit(1)
+            .toArray();
+        if (result.length === 0) {
+            return undefined;
+        }
+        const doc = result[0];
+        const configurableValues = {
+            thread_id,
+            checkpoint_ns,
+            checkpoint_id: doc.checkpoint_id,
+        };
+        const checkpoint = (await this.serde.loadsTyped(doc.type, doc.checkpoint.value()));
+        const serializedWrites = await this.db
+            .collection(this.checkpointWritesCollectionName)
+            .find(configurableValues)
+            .toArray();
+        const pendingWrites = await Promise.all(serializedWrites.map(async (serializedWrite) => {
+            return [
+                serializedWrite.task_id,
+                serializedWrite.channel,
+                await this.serde.loadsTyped(serializedWrite.type, serializedWrite.value.value()),
+            ];
+        }));
+        return {
+            config: { configurable: configurableValues },
+            checkpoint,
+            pendingWrites,
+            metadata: (await this.serde.loadsTyped(doc.type, doc.metadata.value())),
+            parentConfig: doc.parent_checkpoint_id != null
+                ? {
+                    configurable: {
+                        thread_id,
+                        checkpoint_ns,
+                        checkpoint_id: doc.parent_checkpoint_id,
+                    },
+                }
+                : undefined,
+        };
+    }
+    /**
+     * Retrieve a list of checkpoint tuples from the MongoDB database based
+     * on the provided config. The checkpoints are ordered by checkpoint ID
+     * in descending order (newest first).
+     */
+    async *list(config, options) {
+        const { limit, before, filter } = options ?? {};
+        let query = {};
+        if (config?.configurable) {
+            query = {
+                thread_id: config.configurable.thread_id,
+                checkpoint_ns: config.configurable.checkpoint_ns ?? "",
+            };
+        }
+        if (filter) {
+            Object.entries(filter).forEach(([key, value]) => {
+                query[`metadata.${key}`] = value;
+            });
+        }
+        if (before) {
+            query.checkpoint_id = { $lt: before.configurable?.checkpoint_id };
+        }
+        let result = this.db
+            .collection(this.checkpointCollectionName)
+            .find(query)
+            .sort("checkpoint_id", -1);
+        if (limit !== undefined) {
+            result = result.limit(limit);
+        }
+        for await (const doc of result) {
+            const checkpoint = (await this.serde.loadsTyped(doc.type, doc.checkpoint.value()));
+            const metadata = (await this.serde.loadsTyped(doc.type, doc.metadata.value()));
+            yield {
+                config: {
+                    configurable: {
+                        thread_id: doc.thread_id,
+                        checkpoint_ns: doc.checkpoint_ns,
+                        checkpoint_id: doc.checkpoint_id,
+                    },
+                },
+                checkpoint,
+                metadata,
+                parentConfig: doc.parent_checkpoint_id
+                    ? {
+                        configurable: {
+                            thread_id: doc.thread_id,
+                            checkpoint_ns: doc.checkpoint_ns,
+                            checkpoint_id: doc.parent_checkpoint_id,
+                        },
+                    }
+                    : undefined,
+            };
+        }
+    }
+    /**
+     * Saves a checkpoint to the MongoDB database. The checkpoint is associated
+     * with the provided config and its parent config (if any).
+     */
+    async put(config, checkpoint, metadata) {
+        const thread_id = config.configurable?.thread_id;
+        const checkpoint_ns = config.configurable?.checkpoint_ns ?? "";
+        const checkpoint_id = checkpoint.id;
+        if (thread_id === undefined) {
+            throw new Error(`The provided config must contain a configurable field with a "thread_id" field.`);
+        }
+        const [checkpointType, serializedCheckpoint] = this.serde.dumpsTyped(checkpoint);
+        const [metadataType, serializedMetadata] = this.serde.dumpsTyped(metadata);
+        if (checkpointType !== metadataType) {
+            throw new Error("Mismatched checkpoint and metadata types.");
+        }
+        const doc = {
+            parent_checkpoint_id: config.configurable?.checkpoint_id,
+            type: checkpointType,
+            checkpoint: serializedCheckpoint,
+            metadata: serializedMetadata,
+        };
+        const upsertQuery = {
+            thread_id,
+            checkpoint_ns,
+            checkpoint_id,
+        };
+        await this.db.collection(this.checkpointCollectionName).updateOne(upsertQuery, {
+            $set: doc,
+        }, { upsert: true });
+        return {
+            configurable: {
+                thread_id,
+                checkpoint_ns,
+                checkpoint_id,
+            },
+        };
+    }
+    /**
+     * Saves intermediate writes associated with a checkpoint to the MongoDB database.
+     */
+    async putWrites(config, writes, taskId) {
+        const thread_id = config.configurable?.thread_id;
+        const checkpoint_ns = config.configurable?.checkpoint_ns;
+        const checkpoint_id = config.configurable?.checkpoint_id;
+        if (thread_id === undefined ||
+            checkpoint_ns === undefined ||
+            checkpoint_id === undefined) {
+            throw new Error(`The provided config must contain a configurable field with "thread_id", "checkpoint_ns" and "checkpoint_id" fields.`);
+        }
+        const operations = writes.map(([channel, value], idx) => {
+            const upsertQuery = {
+                thread_id,
+                checkpoint_ns,
+                checkpoint_id,
+                task_id: taskId,
+                idx,
+            };
+            const [type, serializedValue] = this.serde.dumpsTyped(value);
+            return {
+                updateOne: {
+                    filter: upsertQuery,
+                    update: {
+                        $set: {
+                            channel,
+                            type,
+                            value: serializedValue,
+                        },
+                    },
+                    upsert: true,
+                },
+            };
+        });
+        await this.db
+            .collection(this.checkpointWritesCollectionName)
+            .bulkWrite(operations);
+    }
+}

package/index.cjs

@@ -0,0 +1 @@
+module.exports = require('./dist/index.cjs');

package/index.d.cts

@@ -0,0 +1 @@
+export * from './dist/index.js'

package/index.d.ts

@@ -0,0 +1 @@
+export * from './dist/index.js'

package/index.js

@@ -0,0 +1 @@
+export * from './dist/index.js'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@langchain/langgraph-checkpoint-mongodb",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "LangGraph",
   "type": "module",
   "engines": {
@@ -13,8 +13,9 @@
     "url": "git@github.com:langchain-ai/langgraphjs.git"
   },
   "scripts": {
-    "build": "yarn turbo:command build:internal --filter=@langchain/langgraph-checkpoint-sqlite",
-    "build:internal": "yarn lc_build_v2 --create-entrypoints --pre --tree-shaking",
+    "build": "yarn turbo:command build:internal --filter=@langchain/langgraph-checkpoint-mongodb",
+    "build:internal": "yarn clean && yarn lc_build --create-entrypoints --pre --tree-shaking",
+    "clean": "rm -rf dist/ dist-cjs/ .turbo/",
     "lint:eslint": "NODE_OPTIONS=--max-old-space-size=4096 eslint --cache --ext .ts,.js src/",
     "lint:dpdm": "dpdm --exit-code circular:1 --no-warning --no-tree src/*.ts src/**/*.ts",
     "lint": "yarn lint:eslint && yarn lint:dpdm",
@@ -38,7 +39,8 @@
   },
   "devDependencies": {
     "@jest/globals": "^29.5.0",
-    "@langchain/scripts": "^0.0.22",
+    "@langchain/langgraph-checkpoint": "workspace:*",
+    "@langchain/scripts": ">=0.1.2 <0.2.0",
     "@swc/core": "^1.3.90",
     "@swc/jest": "^0.2.29",
     "@tsconfig/recommended": "^1.0.3",