langchain 0.0.131 → 0.0.132

package/dist/stores/message/firestore.cjs

@@ -5,6 +5,10 @@ const app_1 = require("firebase-admin/app");
 const firestore_1 = require("firebase-admin/firestore");
 const index_js_1 = require("../../schema/index.cjs");
 const utils_js_1 = require("./utils.cjs");
+/**
+ * Class for managing chat message history using Google's Firestore as a
+ * storage backend. Extends the BaseListChatMessageHistory class.
+ */
 class FirestoreChatMessageHistory extends index_js_1.BaseListChatMessageHistory {
     constructor({ collectionName, sessionId, userId, appIdx = 0, config, }) {
         super();
@@ -82,6 +86,12 @@ class FirestoreChatMessageHistory extends index_js_1.BaseListChatMessageHistory
             .collection(this.collectionName)
             .doc(this.sessionId);
     }
+    /**
+     * Method to retrieve all messages from the Firestore collection
+     * associated with the current session. Returns an array of BaseMessage
+     * objects.
+     * @returns Array of stored messages
+     */
     async getMessages() {
         if (!this.document) {
             throw new Error("Document not initialized");
@@ -100,6 +110,11 @@ class FirestoreChatMessageHistory extends index_js_1.BaseListChatMessageHistory
         });
         return (0, utils_js_1.mapStoredMessagesToChatMessages)(response);
     }
+    /**
+     * Method to add a new message to the Firestore collection. The message is
+     * passed as a BaseMessage object.
+     * @param message The message to be added as a BaseMessage object.
+     */
     async addMessage(message) {
         const messages = (0, utils_js_1.mapChatMessagesToStoredMessages)([message]);
         await this.upsertMessage(messages[0]);
@@ -124,6 +139,10 @@ class FirestoreChatMessageHistory extends index_js_1.BaseListChatMessageHistory
             throw new Error(`Unknown response type: ${err.toString()}`);
         });
     }
+    /**
+     * Method to delete all messages from the Firestore collection associated
+     * with the current session.
+     */
     async clear() {
         if (!this.document) {
             throw new Error("Document not initialized");

package/dist/stores/message/firestore.d.ts

@@ -1,5 +1,10 @@
 import type { AppOptions } from "firebase-admin";
 import { BaseMessage, BaseListChatMessageHistory } from "../../schema/index.js";
+/**
+ * Interface for FirestoreDBChatMessageHistory. It includes the collection
+ * name, session ID, user ID, and optionally, the app index and
+ * configuration for the Firebase app.
+ */
 export interface FirestoreDBChatMessageHistory {
     collectionName: string;
     sessionId: string;
@@ -7,6 +12,10 @@ export interface FirestoreDBChatMessageHistory {
     appIdx?: number;
     config?: AppOptions;
 }
+/**
+ * Class for managing chat message history using Google's Firestore as a
+ * storage backend. Extends the BaseListChatMessageHistory class.
+ */
 export declare class FirestoreChatMessageHistory extends BaseListChatMessageHistory {
     lc_namespace: string[];
     private collectionName;
@@ -18,8 +27,23 @@ export declare class FirestoreChatMessageHistory extends BaseListChatMessageHist
     private document;
     constructor({ collectionName, sessionId, userId, appIdx, config, }: FirestoreDBChatMessageHistory);
     private ensureFirestore;
+    /**
+     * Method to retrieve all messages from the Firestore collection
+     * associated with the current session. Returns an array of BaseMessage
+     * objects.
+     * @returns Array of stored messages
+     */
     getMessages(): Promise<BaseMessage[]>;
+    /**
+     * Method to add a new message to the Firestore collection. The message is
+     * passed as a BaseMessage object.
+     * @param message The message to be added as a BaseMessage object.
+     */
     addMessage(message: BaseMessage): Promise<void>;
     private upsertMessage;
+    /**
+     * Method to delete all messages from the Firestore collection associated
+     * with the current session.
+     */
     clear(): Promise<void>;
 }

package/dist/stores/message/firestore.js

@@ -2,6 +2,10 @@ import { getApps, initializeApp } from "firebase-admin/app";
 import { getFirestore, FieldValue, } from "firebase-admin/firestore";
 import { BaseListChatMessageHistory, } from "../../schema/index.js";
 import { mapChatMessagesToStoredMessages, mapStoredMessagesToChatMessages, } from "./utils.js";
+/**
+ * Class for managing chat message history using Google's Firestore as a
+ * storage backend. Extends the BaseListChatMessageHistory class.
+ */
 export class FirestoreChatMessageHistory extends BaseListChatMessageHistory {
     constructor({ collectionName, sessionId, userId, appIdx = 0, config, }) {
         super();
@@ -79,6 +83,12 @@ export class FirestoreChatMessageHistory extends BaseListChatMessageHistory {
             .collection(this.collectionName)
             .doc(this.sessionId);
     }
+    /**
+     * Method to retrieve all messages from the Firestore collection
+     * associated with the current session. Returns an array of BaseMessage
+     * objects.
+     * @returns Array of stored messages
+     */
     async getMessages() {
         if (!this.document) {
             throw new Error("Document not initialized");
@@ -97,6 +107,11 @@ export class FirestoreChatMessageHistory extends BaseListChatMessageHistory {
         });
         return mapStoredMessagesToChatMessages(response);
     }
+    /**
+     * Method to add a new message to the Firestore collection. The message is
+     * passed as a BaseMessage object.
+     * @param message The message to be added as a BaseMessage object.
+     */
     async addMessage(message) {
         const messages = mapChatMessagesToStoredMessages([message]);
         await this.upsertMessage(messages[0]);
@@ -121,6 +136,10 @@ export class FirestoreChatMessageHistory extends BaseListChatMessageHistory {
             throw new Error(`Unknown response type: ${err.toString()}`);
         });
     }
+    /**
+     * Method to delete all messages from the Firestore collection associated
+     * with the current session.
+     */
     async clear() {
         if (!this.document) {
             throw new Error("Document not initialized");

package/dist/stores/message/in_memory.cjs

@@ -2,6 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ChatMessageHistory = void 0;
 const index_js_1 = require("../../schema/index.cjs");
+/**
+ * Class for storing chat message history in-memory. It extends the
+ * BaseListChatMessageHistory class and provides methods to get, add, and
+ * clear messages.
+ */
 class ChatMessageHistory extends index_js_1.BaseListChatMessageHistory {
     constructor(messages) {
         super(...arguments);
@@ -19,12 +24,26 @@ class ChatMessageHistory extends index_js_1.BaseListChatMessageHistory {
         });
         this.messages = messages ?? [];
     }
+    /**
+     * Method to get all the messages stored in the ChatMessageHistory
+     * instance.
+     * @returns Array of stored BaseMessage instances.
+     */
     async getMessages() {
         return this.messages;
     }
+    /**
+     * Method to add a new message to the ChatMessageHistory instance.
+     * @param message The BaseMessage instance to add.
+     * @returns A promise that resolves when the message has been added.
+     */
     async addMessage(message) {
         this.messages.push(message);
     }
+    /**
+     * Method to clear all the messages from the ChatMessageHistory instance.
+     * @returns A promise that resolves when all messages have been cleared.
+     */
     async clear() {
         this.messages = [];
     }

package/dist/stores/message/in_memory.d.ts

@@ -1,9 +1,28 @@
 import { BaseMessage, BaseListChatMessageHistory } from "../../schema/index.js";
+/**
+ * Class for storing chat message history in-memory. It extends the
+ * BaseListChatMessageHistory class and provides methods to get, add, and
+ * clear messages.
+ */
 export declare class ChatMessageHistory extends BaseListChatMessageHistory {
     lc_namespace: string[];
     private messages;
     constructor(messages?: BaseMessage[]);
+    /**
+     * Method to get all the messages stored in the ChatMessageHistory
+     * instance.
+     * @returns Array of stored BaseMessage instances.
+     */
     getMessages(): Promise<BaseMessage[]>;
+    /**
+     * Method to add a new message to the ChatMessageHistory instance.
+     * @param message The BaseMessage instance to add.
+     * @returns A promise that resolves when the message has been added.
+     */
     addMessage(message: BaseMessage): Promise<void>;
+    /**
+     * Method to clear all the messages from the ChatMessageHistory instance.
+     * @returns A promise that resolves when all messages have been cleared.
+     */
     clear(): Promise<void>;
 }

package/dist/stores/message/in_memory.js

@@ -1,4 +1,9 @@
 import { BaseListChatMessageHistory } from "../../schema/index.js";
+/**
+ * Class for storing chat message history in-memory. It extends the
+ * BaseListChatMessageHistory class and provides methods to get, add, and
+ * clear messages.
+ */
 export class ChatMessageHistory extends BaseListChatMessageHistory {
     constructor(messages) {
         super(...arguments);
@@ -16,12 +21,26 @@ export class ChatMessageHistory extends BaseListChatMessageHistory {
         });
         this.messages = messages ?? [];
     }
+    /**
+     * Method to get all the messages stored in the ChatMessageHistory
+     * instance.
+     * @returns Array of stored BaseMessage instances.
+     */
     async getMessages() {
         return this.messages;
     }
+    /**
+     * Method to add a new message to the ChatMessageHistory instance.
+     * @param message The BaseMessage instance to add.
+     * @returns A promise that resolves when the message has been added.
+     */
     async addMessage(message) {
         this.messages.push(message);
     }
+    /**
+     * Method to clear all the messages from the ChatMessageHistory instance.
+     * @returns A promise that resolves when all messages have been cleared.
+     */
     async clear() {
         this.messages = [];
     }

package/dist/stores/message/ioredis.cjs

@@ -4,6 +4,10 @@ exports.RedisChatMessageHistory = void 0;
 const ioredis_1 = require("ioredis");
 const index_js_1 = require("../../schema/index.cjs");
 const utils_js_1 = require("./utils.cjs");
+/**
+ * Class used to store chat message history in Redis. It provides methods
+ * to add, retrieve, and clear messages from the chat history.
+ */
 class RedisChatMessageHistory extends index_js_1.BaseListChatMessageHistory {
     get lc_secrets() {
         return {
@@ -44,6 +48,10 @@ class RedisChatMessageHistory extends index_js_1.BaseListChatMessageHistory {
         this.sessionId = sessionId;
         this.sessionTTL = sessionTTL;
     }
+    /**
+     * Retrieves all messages from the chat history.
+     * @returns Promise that resolves with an array of BaseMessage instances.
+     */
     async getMessages() {
         const rawStoredMessages = await this.client.lrange(this.sessionId, 0, -1);
         const orderedMessages = rawStoredMessages
@@ -51,6 +59,11 @@ class RedisChatMessageHistory extends index_js_1.BaseListChatMessageHistory {
             .map((message) => JSON.parse(message));
         return (0, utils_js_1.mapStoredMessagesToChatMessages)(orderedMessages);
     }
+    /**
+     * Adds a message to the chat history.
+     * @param message The message to add to the chat history.
+     * @returns Promise that resolves when the message has been added.
+     */
     async addMessage(message) {
         const messageToAdd = (0, utils_js_1.mapChatMessagesToStoredMessages)([message]);
         await this.client.lpush(this.sessionId, JSON.stringify(messageToAdd[0]));
@@ -58,6 +71,10 @@ class RedisChatMessageHistory extends index_js_1.BaseListChatMessageHistory {
             await this.client.expire(this.sessionId, this.sessionTTL);
         }
     }
+    /**
+     * Clears all messages from the chat history.
+     * @returns Promise that resolves when the chat history has been cleared.
+     */
     async clear() {
         await this.client.del(this.sessionId);
     }

package/dist/stores/message/ioredis.d.ts

@@ -1,5 +1,10 @@
 import { Redis, RedisOptions } from "ioredis";
 import { BaseMessage, BaseListChatMessageHistory } from "../../schema/index.js";
+/**
+ * Type for the input parameter of the RedisChatMessageHistory
+ * constructor. It includes fields for the session ID, session TTL, Redis
+ * URL, Redis configuration, and Redis client.
+ */
 export type RedisChatMessageHistoryInput = {
     sessionId: string;
     sessionTTL?: number;
@@ -7,6 +12,10 @@ export type RedisChatMessageHistoryInput = {
     config?: RedisOptions;
     client?: Redis;
 };
+/**
+ * Class used to store chat message history in Redis. It provides methods
+ * to add, retrieve, and clear messages from the chat history.
+ */
 export declare class RedisChatMessageHistory extends BaseListChatMessageHistory {
     lc_namespace: string[];
     get lc_secrets(): {
@@ -18,7 +27,20 @@ export declare class RedisChatMessageHistory extends BaseListChatMessageHistory
     private sessionId;
     private sessionTTL?;
     constructor(fields: RedisChatMessageHistoryInput);
+    /**
+     * Retrieves all messages from the chat history.
+     * @returns Promise that resolves with an array of BaseMessage instances.
+     */
     getMessages(): Promise<BaseMessage[]>;
+    /**
+     * Adds a message to the chat history.
+     * @param message The message to add to the chat history.
+     * @returns Promise that resolves when the message has been added.
+     */
     addMessage(message: BaseMessage): Promise<void>;
+    /**
+     * Clears all messages from the chat history.
+     * @returns Promise that resolves when the chat history has been cleared.
+     */
     clear(): Promise<void>;
 }

package/dist/stores/message/ioredis.js

@@ -1,6 +1,10 @@
 import { Redis } from "ioredis";
 import { BaseListChatMessageHistory } from "../../schema/index.js";
 import { mapChatMessagesToStoredMessages, mapStoredMessagesToChatMessages, } from "./utils.js";
+/**
+ * Class used to store chat message history in Redis. It provides methods
+ * to add, retrieve, and clear messages from the chat history.
+ */
 export class RedisChatMessageHistory extends BaseListChatMessageHistory {
     get lc_secrets() {
         return {
@@ -41,6 +45,10 @@ export class RedisChatMessageHistory extends BaseListChatMessageHistory {
         this.sessionId = sessionId;
         this.sessionTTL = sessionTTL;
     }
+    /**
+     * Retrieves all messages from the chat history.
+     * @returns Promise that resolves with an array of BaseMessage instances.
+     */
     async getMessages() {
         const rawStoredMessages = await this.client.lrange(this.sessionId, 0, -1);
         const orderedMessages = rawStoredMessages
@@ -48,6 +56,11 @@ export class RedisChatMessageHistory extends BaseListChatMessageHistory {
             .map((message) => JSON.parse(message));
         return mapStoredMessagesToChatMessages(orderedMessages);
     }
+    /**
+     * Adds a message to the chat history.
+     * @param message The message to add to the chat history.
+     * @returns Promise that resolves when the message has been added.
+     */
     async addMessage(message) {
         const messageToAdd = mapChatMessagesToStoredMessages([message]);
         await this.client.lpush(this.sessionId, JSON.stringify(messageToAdd[0]));
@@ -55,6 +68,10 @@ export class RedisChatMessageHistory extends BaseListChatMessageHistory {
             await this.client.expire(this.sessionId, this.sessionTTL);
         }
     }
+    /**
+     * Clears all messages from the chat history.
+     * @returns Promise that resolves when the chat history has been cleared.
+     */
     async clear() {
         await this.client.del(this.sessionId);
     }

package/dist/stores/message/momento.cjs

@@ -6,6 +6,11 @@ const sdk_1 = require("@gomomento/sdk");
 const index_js_1 = require("../../schema/index.cjs");
 const utils_js_1 = require("./utils.cjs");
 const momento_js_1 = require("../../util/momento.cjs");
+/**
+ * A class that stores chat message history using Momento Cache. It
+ * interacts with a Momento cache client to perform operations like
+ * fetching, adding, and deleting messages.
+ */
 class MomentoChatMessageHistory extends index_js_1.BaseListChatMessageHistory {
     constructor(props) {
         super();
@@ -78,6 +83,10 @@ class MomentoChatMessageHistory extends index_js_1.BaseListChatMessageHistory {
             throw new sdk_1.InvalidArgumentError("ttlSeconds must be positive.");
         }
     }
+    /**
+     * Fetches messages from the cache.
+     * @returns A Promise that resolves to an array of BaseMessage instances.
+     */
     async getMessages() {
         const fetchResponse = await this.client.listFetch(this.cacheName, this.sessionId);
         let messages = [];
@@ -97,6 +106,11 @@ class MomentoChatMessageHistory extends index_js_1.BaseListChatMessageHistory {
         }
         return (0, utils_js_1.mapStoredMessagesToChatMessages)(messages);
     }
+    /**
+     * Adds a message to the cache.
+     * @param message The BaseMessage instance to add to the cache.
+     * @returns A Promise that resolves when the message has been added.
+     */
     async addMessage(message) {
         const messageToAdd = JSON.stringify((0, utils_js_1.mapChatMessagesToStoredMessages)([message])[0]);
         const pushResponse = await this.client.listPushBack(this.cacheName, this.sessionId, messageToAdd, { ttl: this.sessionTtl });
@@ -110,6 +124,10 @@ class MomentoChatMessageHistory extends index_js_1.BaseListChatMessageHistory {
             throw new Error(`Unknown response type: ${pushResponse.toString()}`);
         }
     }
+    /**
+     * Deletes all messages from the cache.
+     * @returns A Promise that resolves when all messages have been deleted.
+     */
     async clear() {
         const deleteResponse = await this.client.delete(this.cacheName, this.sessionId);
         if (deleteResponse instanceof sdk_1.CacheDelete.Success) {

package/dist/stores/message/momento.d.ts

@@ -28,6 +28,11 @@ export interface MomentoChatMessageHistoryProps {
      */
     ensureCacheExists?: true;
 }
+/**
+ * A class that stores chat message history using Momento Cache. It
+ * interacts with a Momento cache client to perform operations like
+ * fetching, adding, and deleting messages.
+ */
 export declare class MomentoChatMessageHistory extends BaseListChatMessageHistory {
     lc_namespace: string[];
     private readonly sessionId;
@@ -55,7 +60,20 @@ export declare class MomentoChatMessageHistory extends BaseListChatMessageHistor
      * @param ttlSeconds The TTL to validate.
      */
     private validateTtlSeconds;
+    /**
+     * Fetches messages from the cache.
+     * @returns A Promise that resolves to an array of BaseMessage instances.
+     */
     getMessages(): Promise<BaseMessage[]>;
+    /**
+     * Adds a message to the cache.
+     * @param message The BaseMessage instance to add to the cache.
+     * @returns A Promise that resolves when the message has been added.
+     */
     addMessage(message: BaseMessage): Promise<void>;
+    /**
+     * Deletes all messages from the cache.
+     * @returns A Promise that resolves when all messages have been deleted.
+     */
     clear(): Promise<void>;
 }

package/dist/stores/message/momento.js

@@ -3,6 +3,11 @@ import { CacheDelete, CacheListFetch, CacheListPushBack, InvalidArgumentError, C
 import { BaseListChatMessageHistory, } from "../../schema/index.js";
 import { mapChatMessagesToStoredMessages, mapStoredMessagesToChatMessages, } from "./utils.js";
 import { ensureCacheExists } from "../../util/momento.js";
+/**
+ * A class that stores chat message history using Momento Cache. It
+ * interacts with a Momento cache client to perform operations like
+ * fetching, adding, and deleting messages.
+ */
 export class MomentoChatMessageHistory extends BaseListChatMessageHistory {
     constructor(props) {
         super();
@@ -75,6 +80,10 @@ export class MomentoChatMessageHistory extends BaseListChatMessageHistory {
             throw new InvalidArgumentError("ttlSeconds must be positive.");
         }
     }
+    /**
+     * Fetches messages from the cache.
+     * @returns A Promise that resolves to an array of BaseMessage instances.
+     */
     async getMessages() {
         const fetchResponse = await this.client.listFetch(this.cacheName, this.sessionId);
         let messages = [];
@@ -94,6 +103,11 @@ export class MomentoChatMessageHistory extends BaseListChatMessageHistory {
         }
         return mapStoredMessagesToChatMessages(messages);
     }
+    /**
+     * Adds a message to the cache.
+     * @param message The BaseMessage instance to add to the cache.
+     * @returns A Promise that resolves when the message has been added.
+     */
     async addMessage(message) {
         const messageToAdd = JSON.stringify(mapChatMessagesToStoredMessages([message])[0]);
         const pushResponse = await this.client.listPushBack(this.cacheName, this.sessionId, messageToAdd, { ttl: this.sessionTtl });
@@ -107,6 +121,10 @@ export class MomentoChatMessageHistory extends BaseListChatMessageHistory {
             throw new Error(`Unknown response type: ${pushResponse.toString()}`);
         }
     }
+    /**
+     * Deletes all messages from the cache.
+     * @returns A Promise that resolves when all messages have been deleted.
+     */
     async clear() {
         const deleteResponse = await this.client.delete(this.cacheName, this.sessionId);
         if (deleteResponse instanceof CacheDelete.Success) {

package/dist/stores/message/planetscale.cjs

@@ -4,6 +4,10 @@ exports.PlanetScaleChatMessageHistory = void 0;
 const database_1 = require("@planetscale/database");
 const index_js_1 = require("../../schema/index.cjs");
 const utils_js_1 = require("./utils.cjs");
+/**
+ * Class for storing and retrieving chat message history from a
+ * PlanetScale database. Extends the BaseListChatMessageHistory class.
+ */
 class PlanetScaleChatMessageHistory extends index_js_1.BaseListChatMessageHistory {
     get lc_secrets() {
         return {
@@ -66,6 +70,12 @@ class PlanetScaleChatMessageHistory extends index_js_1.BaseListChatMessageHistor
         this.tableInitialized = false;
         this.sessionId = sessionId;
     }
+    /**
+     * Private method to ensure that the necessary table exists in the
+     * PlanetScale database before performing any operations. If the table
+     * does not exist, it is created.
+     * @returns Promise that resolves to void.
+     */
     async ensureTable() {
         if (this.tableInitialized) {
             return;
@@ -76,6 +86,11 @@ class PlanetScaleChatMessageHistory extends index_js_1.BaseListChatMessageHistor
         await this.connection.execute(indexQuery);
         this.tableInitialized = true;
     }
+    /**
+     * Method to retrieve all messages from the PlanetScale database for the
+     * current session.
+     * @returns Promise that resolves to an array of BaseMessage objects.
+     */
     async getMessages() {
         await this.ensureTable();
         const query = `SELECT * FROM ${this.tableName} WHERE session_id = :session_id`;
@@ -102,6 +117,12 @@ class PlanetScaleChatMessageHistory extends index_js_1.BaseListChatMessageHistor
         });
         return (0, utils_js_1.mapStoredMessagesToChatMessages)(orderedMessages);
     }
+    /**
+     * Method to add a new message to the PlanetScale database for the current
+     * session.
+     * @param message The BaseMessage object to be added to the database.
+     * @returns Promise that resolves to void.
+     */
     async addMessage(message) {
         await this.ensureTable();
         const messageToAdd = (0, utils_js_1.mapChatMessagesToStoredMessages)([message]);
@@ -116,6 +137,11 @@ class PlanetScaleChatMessageHistory extends index_js_1.BaseListChatMessageHistor
         };
         await this.connection.execute(query, params);
     }
+    /**
+     * Method to delete all messages from the PlanetScale database for the
+     * current session.
+     * @returns Promise that resolves to void.
+     */
     async clear() {
         await this.ensureTable();
         const query = `DELETE FROM ${this.tableName} WHERE session_id = :session_id`;

package/dist/stores/message/planetscale.d.ts

@@ -1,11 +1,19 @@
 import { Client as PlanetScaleClient, Config as PlanetScaleConfig } from "@planetscale/database";
 import { BaseMessage, BaseListChatMessageHistory } from "../../schema/index.js";
+/**
+ * Type definition for the input parameters required when instantiating a
+ * PlanetScaleChatMessageHistory object.
+ */
 export type PlanetScaleChatMessageHistoryInput = {
     tableName?: string;
     sessionId: string;
     config?: PlanetScaleConfig;
     client?: PlanetScaleClient;
 };
+/**
+ * Class for storing and retrieving chat message history from a
+ * PlanetScale database. Extends the BaseListChatMessageHistory class.
+ */
 export declare class PlanetScaleChatMessageHistory extends BaseListChatMessageHistory {
     lc_namespace: string[];
     get lc_secrets(): {
@@ -20,8 +28,30 @@ export declare class PlanetScaleChatMessageHistory extends BaseListChatMessageHi
     private sessionId;
     private tableInitialized;
     constructor(fields: PlanetScaleChatMessageHistoryInput);
+    /**
+     * Private method to ensure that the necessary table exists in the
+     * PlanetScale database before performing any operations. If the table
+     * does not exist, it is created.
+     * @returns Promise that resolves to void.
+     */
     private ensureTable;
+    /**
+     * Method to retrieve all messages from the PlanetScale database for the
+     * current session.
+     * @returns Promise that resolves to an array of BaseMessage objects.
+     */
     getMessages(): Promise<BaseMessage[]>;
+    /**
+     * Method to add a new message to the PlanetScale database for the current
+     * session.
+     * @param message The BaseMessage object to be added to the database.
+     * @returns Promise that resolves to void.
+     */
     addMessage(message: BaseMessage): Promise<void>;
+    /**
+     * Method to delete all messages from the PlanetScale database for the
+     * current session.
+     * @returns Promise that resolves to void.
+     */
     clear(): Promise<void>;
 }

package/dist/stores/message/planetscale.js

@@ -1,6 +1,10 @@
 import { Client as PlanetScaleClient, } from "@planetscale/database";
 import { BaseListChatMessageHistory, } from "../../schema/index.js";
 import { mapChatMessagesToStoredMessages, mapStoredMessagesToChatMessages, } from "./utils.js";
+/**
+ * Class for storing and retrieving chat message history from a
+ * PlanetScale database. Extends the BaseListChatMessageHistory class.
+ */
 export class PlanetScaleChatMessageHistory extends BaseListChatMessageHistory {
     get lc_secrets() {
         return {
@@ -63,6 +67,12 @@ export class PlanetScaleChatMessageHistory extends BaseListChatMessageHistory {
         this.tableInitialized = false;
         this.sessionId = sessionId;
     }
+    /**
+     * Private method to ensure that the necessary table exists in the
+     * PlanetScale database before performing any operations. If the table
+     * does not exist, it is created.
+     * @returns Promise that resolves to void.
+     */
     async ensureTable() {
         if (this.tableInitialized) {
             return;
@@ -73,6 +83,11 @@ export class PlanetScaleChatMessageHistory extends BaseListChatMessageHistory {
         await this.connection.execute(indexQuery);
         this.tableInitialized = true;
     }
+    /**
+     * Method to retrieve all messages from the PlanetScale database for the
+     * current session.
+     * @returns Promise that resolves to an array of BaseMessage objects.
+     */
     async getMessages() {
         await this.ensureTable();
         const query = `SELECT * FROM ${this.tableName} WHERE session_id = :session_id`;
@@ -99,6 +114,12 @@ export class PlanetScaleChatMessageHistory extends BaseListChatMessageHistory {
         });
         return mapStoredMessagesToChatMessages(orderedMessages);
     }
+    /**
+     * Method to add a new message to the PlanetScale database for the current
+     * session.
+     * @param message The BaseMessage object to be added to the database.
+     * @returns Promise that resolves to void.
+     */
     async addMessage(message) {
         await this.ensureTable();
         const messageToAdd = mapChatMessagesToStoredMessages([message]);
@@ -113,6 +134,11 @@ export class PlanetScaleChatMessageHistory extends BaseListChatMessageHistory {
         };
         await this.connection.execute(query, params);
     }
+    /**
+     * Method to delete all messages from the PlanetScale database for the
+     * current session.
+     * @returns Promise that resolves to void.
+     */
     async clear() {
         await this.ensureTable();
         const query = `DELETE FROM ${this.tableName} WHERE session_id = :session_id`;