@langchain/google-cloud-sql-pg 0.0.2 → 1.0.1

package/dist/engine.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"engine.js","names":["name: string","dataType: string","nullable: boolean","key: symbol","pool: knex.Knex","projectId: string","region: string","instance: string","database: string","dbUser: string","enableIAMAuth: boolean","dbConfig: knex.Knex.Config","engine: knex.Knex","url: string | knex.Knex.StaticConnectionConfig","poolConfig?: knex.Knex.PoolConfig","tableName: string","vectorSize: number","schemaName: string"],"sources":["../src/engine.ts"],"sourcesContent":["import {\n  AuthTypes,\n  Connector,\n  IpAddressTypes,\n} from \"@google-cloud/cloud-sql-connector\";\nimport { GoogleAuth } from \"google-auth-library\";\nimport knex from \"knex\";\nimport { getIAMPrincipalEmail } from \"./utils/utils.js\";\n\nexport interface PostgresEngineArgs {\n  ipType?: IpAddressTypes;\n  user?: string;\n  password?: string;\n  iamAccountEmail?: string;\n}\n\nexport interface VectorStoreTableArgs {\n  schemaName?: string;\n  contentColumn?: string;\n  embeddingColumn?: string;\n  embeddingColumnType?: \"vector\" | \"halfvec\" | \"bit\" | \"sparsevec\";\n  metadataColumns?: Column[];\n  metadataJsonColumn?: string;\n  idColumn?: string | Column;\n  overwriteExisting?: boolean;\n  storeMetadata?: boolean;\n}\n\nexport class Column {\n  name: string;\n\n  dataType: string;\n\n  nullable: boolean;\n\n  constructor(name: string, dataType: string, nullable: boolean = true) {\n    this.name = name;\n    this.dataType = dataType;\n    this.nullable = nullable;\n\n    this.postInitilization();\n  }\n\n  private postInitilization() {\n    if (typeof this.name !== \"string\") {\n      throw Error(\"Column name must be type string\");\n    }\n\n    if (typeof this.dataType !== \"string\") {\n      throw Error(\"Column data_type must be type string\");\n    }\n  }\n}\n\nconst USER_AGENT = \"langchain-google-cloud-sql-pg-js\";\n\n/**\n * Cloud SQL shared connection pool\n *\n * Setup:\n * Install `@langchain/google-cloud-sql-pg`\n *\n * <details open>\n * <summary><strong>Instantiate</strong></summary>\n *\n * ```typescript\n * import { Column, PostgresEngine, PostgresEngineArgs } from \"@langchain/google-cloud-sql-pg\";\n *\n * const pgArgs: PostgresEngineArgs = {\n *    user: \"db-user\",\n *    password: \"password\"\n *}\n *\n * const engine: PostgresEngine = await PostgresEngine.fromInstance(\n *  \"project-id\",\n *  \"region\",\n *  \"instance-name\",\n *  \"database-name\",\n *  pgArgs\n * );\n * ```\n * </details>\n *\n * <br />\n *\n */\nexport class PostgresEngine {\n  private static _createKey = Symbol(\"key\");\n\n  pool: knex.Knex;\n\n  static connector: Connector;\n\n  constructor(key: symbol, pool: knex.Knex) {\n    if (key !== PostgresEngine._createKey) {\n      throw Error(\"Only create class through 'create' method!\");\n    }\n    this.pool = pool;\n  }\n\n  /**\n   * @param projectId Required - GCP Project ID\n   * @param region Required - Postgres Instance Region\n   * @param instance Required - Postgres Instance name\n   * @param database Required - Database name\n   * @param ipType Optional - IP address type. Defaults to IPAddressType.PUBLIC\n   * @param user Optional - Postgres user name. Defaults to undefined\n   * @param password Optional - Postgres user password. Defaults to undefined\n   * @param iamAccountEmail Optional - IAM service account email. Defaults to undefined\n   * @returns PostgresEngine instance\n   */\n\n  static async fromInstance(\n    projectId: string,\n    region: string,\n    instance: string,\n    database: string,\n    {\n      ipType = IpAddressTypes.PUBLIC,\n      user,\n      password,\n      iamAccountEmail,\n    }: PostgresEngineArgs = {}\n  ): Promise<PostgresEngine> {\n    let dbUser: string;\n    let enableIAMAuth: boolean;\n\n    if ((!user && password) || (user && !password)) {\n      // XOR for strings\n      throw Error(\n        \"Only one of 'user' or 'password' were specified. Either \" +\n          \"both should be specified to use basic user/password \" +\n          \"authentication or neither for IAM DB authentication.\"\n      );\n    }\n\n    // User and password are given so we use the basic auth\n    if (user !== undefined && password !== undefined) {\n      enableIAMAuth = false;\n      dbUser = user!;\n    } else {\n      enableIAMAuth = true;\n      if (iamAccountEmail !== undefined) {\n        dbUser = iamAccountEmail;\n      } else {\n        // Get application default credentials\n        const auth = new GoogleAuth({\n          scopes: \"https://www.googleapis.com/auth/cloud-platform\",\n        });\n        // dbUser should be the iam principal email by passing the credentials obtained\n        dbUser = await getIAMPrincipalEmail(auth);\n      }\n    }\n\n    PostgresEngine.connector = new Connector({ userAgent: USER_AGENT });\n    const clientOpts = await PostgresEngine.connector.getOptions({\n      instanceConnectionName: `${projectId}:${region}:${instance}`,\n      ipType,\n      authType: enableIAMAuth ? AuthTypes.IAM : AuthTypes.PASSWORD,\n    });\n\n    const dbConfig: knex.Knex.Config = {\n      client: \"pg\",\n      connection: {\n        ...clientOpts,\n        ...(password ? { password } : {}),\n        user: dbUser,\n        database,\n      },\n    };\n\n    const engine = knex(dbConfig);\n\n    return new PostgresEngine(PostgresEngine._createKey, engine);\n  }\n\n  /**\n   * Create a PostgresEngine instance from an Knex instance.\n   *\n   * @param engine knex instance\n   * @returns PostgresEngine instance from a knex instance\n   */\n  static async fromPool(engine: knex.Knex) {\n    return new PostgresEngine(PostgresEngine._createKey, engine);\n  }\n\n  /**\n   * Create a PostgresEngine instance from arguments.\n   *\n   * @param url URL use to connect to a database\n   * @param poolConfig Optional - Configuration pool to use in the Knex configuration\n   * @returns PostgresEngine instance\n   */\n  static async fromConnectionString(\n    url: string | knex.Knex.StaticConnectionConfig,\n    poolConfig?: knex.Knex.PoolConfig\n  ) {\n    const driver = \"postgresql+asyncpg\";\n\n    if (typeof url === \"string\" && !url.startsWith(driver)) {\n      throw Error(\"Driver must be type 'postgresql+asyncpg'\");\n    }\n\n    const dbConfig: knex.Knex.Config = {\n      client: \"pg\",\n      connection: url,\n      acquireConnectionTimeout: 1000000,\n      pool: {\n        ...poolConfig,\n        acquireTimeoutMillis: 600000,\n      },\n    };\n\n    const engine = knex(dbConfig);\n\n    return new PostgresEngine(PostgresEngine._createKey, engine);\n  }\n\n  /**\n   * Create a table for saving of vectors to be used with PostgresVectorStore.\n   *\n   * @param tableName Postgres database table name. Parameter is not escaped. Do not use with end user input.\n   * @param vectorSize Vector size for the embedding model to be used.\n   * @param schemaName The schema name to store Postgres database table. Default: \"public\". Parameter is not escaped. Do not use with end user input.\n   * @param contentColumn Name of the column to store document content. Default: \"content\".\n   * @param embeddingColumn Name of the column to store vector embeddings. Default: \"embedding\".\n   * @param embeddingColumnType Type of the embedding column (\"vector\" | \"halfvec\" | \"bit\" | \"sparsevec\"). Default: \"vector\". More info on HNSW-supported types: https://github.com/pgvector/pgvector#hnsw\n   * @param metadataColumns Optional - A list of Columns to create for custom metadata. Default: [].\n   * @param metadataJsonColumn Optional - The column to store extra metadata in JSON format. Default: \"langchain_metadata\".\n   * @param idColumn Optional - Column to store ids. Default: \"langchain_id\" column name with data type UUID.\n   * @param overwriteExisting Whether to drop existing table. Default: False.\n   * @param storeMetadata Whether to store metadata in the table. Default: True.\n   */\n  async initVectorstoreTable(\n    tableName: string,\n    vectorSize: number,\n    {\n      schemaName = \"public\",\n      contentColumn = \"content\",\n      embeddingColumn = \"embedding\",\n      embeddingColumnType = \"vector\",\n      metadataColumns = [],\n      metadataJsonColumn = \"langchain_metadata\",\n      idColumn = \"langchain_id\",\n      overwriteExisting = false,\n      storeMetadata = true,\n    }: VectorStoreTableArgs = {}\n  ): Promise<void> {\n    await this.pool.raw(\"CREATE EXTENSION IF NOT EXISTS vector\");\n\n    if (overwriteExisting) {\n      await this.pool.schema\n        .withSchema(schemaName)\n        .dropTableIfExists(tableName);\n    }\n\n    const idDataType =\n      typeof idColumn === \"string\" ? \"UUID\" : idColumn.dataType;\n    const idColumnName =\n      typeof idColumn === \"string\" ? idColumn : idColumn.name;\n\n    let query = `CREATE TABLE ${schemaName}.${tableName}(\n      ${idColumnName} ${idDataType} PRIMARY KEY,\n      ${contentColumn} TEXT NOT NULL,\n      ${embeddingColumn} ${embeddingColumnType}(${vectorSize}) NOT NULL`;\n\n    for (const column of metadataColumns) {\n      const nullable = !column.nullable ? \"NOT NULL\" : \"\";\n      query += `,\\n ${column.name} ${column.dataType} ${nullable}`;\n    }\n\n    if (storeMetadata) {\n      query += `,\\n${metadataJsonColumn} JSON`;\n    }\n\n    query += `\\n);`;\n\n    await this.pool.raw(query);\n  }\n\n  /**\n   * Create a Cloud SQL table to store chat history.\n   *\n   * @param tableName Table name to store chat history\n   * @param schemaName Schema name to store chat history table\n   */\n\n  async initChatHistoryTable(\n    tableName: string,\n    schemaName: string = \"public\"\n  ): Promise<void> {\n    await this.pool.raw(\n      `CREATE TABLE IF NOT EXISTS ${schemaName}.${tableName}(\n      id SERIAL PRIMARY KEY,\n      session_id TEXT NOT NULL,\n      data JSONB NOT NULL,\n      type TEXT NOT NULL);`\n    );\n  }\n\n  /**\n   *  Dispose of connection pool\n   */\n  async closeConnection(): Promise<void> {\n    await this.pool.destroy();\n    if (PostgresEngine.connector !== undefined) {\n      PostgresEngine.connector.close();\n    }\n  }\n\n  // Just to test the connection to the database\n  testConnection() {\n    const now = this.pool.raw(\"SELECT NOW() as currentTimestamp\");\n    return now;\n  }\n}\n\nexport default PostgresEngine;\n"],"mappings":";;;;;;AA4BA,IAAa,SAAb,MAAoB;CAClB;CAEA;CAEA;CAEA,YAAYA,MAAcC,UAAkBC,WAAoB,MAAM;EACpE,KAAK,OAAO;EACZ,KAAK,WAAW;EAChB,KAAK,WAAW;EAEhB,KAAK,mBAAmB;CACzB;CAED,AAAQ,oBAAoB;AAC1B,MAAI,OAAO,KAAK,SAAS,SACvB,OAAM,MAAM,kCAAkC;AAGhD,MAAI,OAAO,KAAK,aAAa,SAC3B,OAAM,MAAM,uCAAuC;CAEtD;AACF;AAED,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgCnB,IAAa,iBAAb,MAAa,eAAe;CAC1B,OAAe,aAAa,OAAO,MAAM;CAEzC;CAEA,OAAO;CAEP,YAAYC,KAAaC,MAAiB;AACxC,MAAI,QAAQ,eAAe,WACzB,OAAM,MAAM,6CAA6C;EAE3D,KAAK,OAAO;CACb;;;;;;;;;;;;CAcD,aAAa,aACXC,WACAC,QACAC,UACAC,UACA,EACE,SAAS,eAAe,QACxB,MACA,UACA,iBACmB,GAAG,CAAE,GACD;EACzB,IAAIC;EACJ,IAAIC;AAEJ,MAAK,CAAC,QAAQ,YAAc,QAAQ,CAAC,SAEnC,OAAM,MACJ,mKAGD;AAIH,MAAI,SAAS,UAAa,aAAa,QAAW;GAChD,gBAAgB;GAChB,SAAS;EACV,OAAM;GACL,gBAAgB;AAChB,OAAI,oBAAoB,QACtB,SAAS;QACJ;IAEL,MAAM,OAAO,IAAI,WAAW,EAC1B,QAAQ,iDACT;IAED,SAAS,MAAM,qBAAqB,KAAK;GAC1C;EACF;EAED,eAAe,YAAY,IAAI,UAAU,EAAE,WAAW,WAAY;EAClE,MAAM,aAAa,MAAM,eAAe,UAAU,WAAW;GAC3D,wBAAwB,GAAG,UAAU,CAAC,EAAE,OAAO,CAAC,EAAE,UAAU;GAC5D;GACA,UAAU,gBAAgB,UAAU,MAAM,UAAU;EACrD,EAAC;EAEF,MAAMC,WAA6B;GACjC,QAAQ;GACR,YAAY;IACV,GAAG;IACH,GAAI,WAAW,EAAE,SAAU,IAAG,CAAE;IAChC,MAAM;IACN;GACD;EACF;EAED,MAAM,SAAS,KAAK,SAAS;AAE7B,SAAO,IAAI,eAAe,eAAe,YAAY;CACtD;;;;;;;CAQD,aAAa,SAASC,QAAmB;AACvC,SAAO,IAAI,eAAe,eAAe,YAAY;CACtD;;;;;;;;CASD,aAAa,qBACXC,KACAC,YACA;EACA,MAAM,SAAS;AAEf,MAAI,OAAO,QAAQ,YAAY,CAAC,IAAI,WAAW,OAAO,CACpD,OAAM,MAAM,2CAA2C;EAGzD,MAAMH,WAA6B;GACjC,QAAQ;GACR,YAAY;GACZ,0BAA0B;GAC1B,MAAM;IACJ,GAAG;IACH,sBAAsB;GACvB;EACF;EAED,MAAM,SAAS,KAAK,SAAS;AAE7B,SAAO,IAAI,eAAe,eAAe,YAAY;CACtD;;;;;;;;;;;;;;;;CAiBD,MAAM,qBACJI,WACAC,YACA,EACE,aAAa,UACb,gBAAgB,WAChB,kBAAkB,aAClB,sBAAsB,UACtB,kBAAkB,CAAE,GACpB,qBAAqB,sBACrB,WAAW,gBACX,oBAAoB,OACpB,gBAAgB,MACK,GAAG,CAAE,GACb;EACf,MAAM,KAAK,KAAK,IAAI,wCAAwC;AAE5D,MAAI,mBACF,MAAM,KAAK,KAAK,OACb,WAAW,WAAW,CACtB,kBAAkB,UAAU;EAGjC,MAAM,aACJ,OAAO,aAAa,WAAW,SAAS,SAAS;EACnD,MAAM,eACJ,OAAO,aAAa,WAAW,WAAW,SAAS;EAErD,IAAI,QAAQ,CAAC,aAAa,EAAE,WAAW,CAAC,EAAE,UAAU;MAClD,EAAE,aAAa,CAAC,EAAE,WAAW;MAC7B,EAAE,cAAc;MAChB,EAAE,gBAAgB,CAAC,EAAE,oBAAoB,CAAC,EAAE,WAAW,UAAU,CAAC;AAEpE,OAAK,MAAM,UAAU,iBAAiB;GACpC,MAAM,WAAW,CAAC,OAAO,WAAW,aAAa;GACjD,SAAS,CAAC,IAAI,EAAE,OAAO,KAAK,CAAC,EAAE,OAAO,SAAS,CAAC,EAAE,UAAU;EAC7D;AAED,MAAI,eACF,SAAS,CAAC,GAAG,EAAE,mBAAmB,KAAK,CAAC;EAG1C,SAAS,CAAC,IAAI,CAAC;EAEf,MAAM,KAAK,KAAK,IAAI,MAAM;CAC3B;;;;;;;CASD,MAAM,qBACJD,WACAE,aAAqB,UACN;EACf,MAAM,KAAK,KAAK,IACd,CAAC,2BAA2B,EAAE,WAAW,CAAC,EAAE,UAAU;;;;0BAIlC,CAAC,CACtB;CACF;;;;CAKD,MAAM,kBAAiC;EACrC,MAAM,KAAK,KAAK,SAAS;AACzB,MAAI,eAAe,cAAc,QAC/B,eAAe,UAAU,OAAO;CAEnC;CAGD,iBAAiB;EACf,MAAM,MAAM,KAAK,KAAK,IAAI,mCAAmC;AAC7D,SAAO;CACR;AACF"}

package/dist/index.cjs

@@ -1,20 +1,21 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./engine.cjs"), exports);
-__exportStar(require("./chat_message_history.cjs"), exports);
-__exportStar(require("./vectorstore.cjs"), exports);
-__exportStar(require("./loader.cjs"), exports);
+const require_engine = require('./engine.cjs');
+const require_chat_message_history = require('./chat_message_history.cjs');
+const require_indexes = require('./indexes.cjs');
+const require_vectorstore = require('./vectorstore.cjs');
+const require_loader = require('./loader.cjs');
+
+exports.BaseIndex = require_indexes.BaseIndex;
+exports.Column = require_engine.Column;
+exports.DEFAULT_DISTANCE_STRATEGY = require_indexes.DEFAULT_DISTANCE_STRATEGY;
+exports.DEFAULT_INDEX_NAME_SUFFIX = require_indexes.DEFAULT_INDEX_NAME_SUFFIX;
+exports.DistanceStrategy = require_indexes.DistanceStrategy;
+exports.ExactNearestNeighbor = require_indexes.ExactNearestNeighbor;
+exports.HNSWIndex = require_indexes.HNSWIndex;
+exports.HNSWQueryOptions = require_indexes.HNSWQueryOptions;
+exports.IVFFlatIndex = require_indexes.IVFFlatIndex;
+exports.IVFFlatQueryOptions = require_indexes.IVFFlatQueryOptions;
+exports.PostgresChatMessageHistory = require_chat_message_history.PostgresChatMessageHistory;
+exports.PostgresEngine = require_engine.PostgresEngine;
+exports.PostgresLoader = require_loader.PostgresLoader;
+exports.PostgresVectorStore = require_vectorstore.PostgresVectorStore;
+exports.QueryOptions = require_indexes.QueryOptions;

package/dist/index.d.cts

@@ -0,0 +1,6 @@
+import { Column, PostgresEngine, PostgresEngineArgs, VectorStoreTableArgs } from "./engine.cjs";
+import { PostgresChatMessageHistory, PostgresChatMessageHistoryInput } from "./chat_message_history.cjs";
+import { BaseIndex, BaseIndexArgs, DEFAULT_DISTANCE_STRATEGY, DEFAULT_INDEX_NAME_SUFFIX, DistanceStrategy, ExactNearestNeighbor, HNSWIndex, HNSWQueryOptions, IVFFlatIndex, IVFFlatQueryOptions, QueryOptions } from "./indexes.cjs";
+import { PostgresVectorStore, PostgresVectorStoreArgs, dbConfigArgs } from "./vectorstore.cjs";
+import { PostgresLoader, PostgresLoaderOptions } from "./loader.cjs";
+export { BaseIndex, BaseIndexArgs, Column, DEFAULT_DISTANCE_STRATEGY, DEFAULT_INDEX_NAME_SUFFIX, DistanceStrategy, ExactNearestNeighbor, HNSWIndex, HNSWQueryOptions, IVFFlatIndex, IVFFlatQueryOptions, PostgresChatMessageHistory, PostgresChatMessageHistoryInput, PostgresEngine, PostgresEngineArgs, PostgresLoader, PostgresLoaderOptions, PostgresVectorStore, PostgresVectorStoreArgs, QueryOptions, VectorStoreTableArgs, dbConfigArgs };

package/dist/index.d.ts

@@ -1,4 +1,6 @@
-export * from "./engine.js";
-export * from "./chat_message_history.js";
-export * from "./vectorstore.js";
-export * from "./loader.js";
+import { Column, PostgresEngine, PostgresEngineArgs, VectorStoreTableArgs } from "./engine.js";
+import { PostgresChatMessageHistory, PostgresChatMessageHistoryInput } from "./chat_message_history.js";
+import { BaseIndex, BaseIndexArgs, DEFAULT_DISTANCE_STRATEGY, DEFAULT_INDEX_NAME_SUFFIX, DistanceStrategy, ExactNearestNeighbor, HNSWIndex, HNSWQueryOptions, IVFFlatIndex, IVFFlatQueryOptions, QueryOptions } from "./indexes.js";
+import { PostgresVectorStore, PostgresVectorStoreArgs, dbConfigArgs } from "./vectorstore.js";
+import { PostgresLoader, PostgresLoaderOptions } from "./loader.js";
+export { BaseIndex, BaseIndexArgs, Column, DEFAULT_DISTANCE_STRATEGY, DEFAULT_INDEX_NAME_SUFFIX, DistanceStrategy, ExactNearestNeighbor, HNSWIndex, HNSWQueryOptions, IVFFlatIndex, IVFFlatQueryOptions, PostgresChatMessageHistory, PostgresChatMessageHistoryInput, PostgresEngine, PostgresEngineArgs, PostgresLoader, PostgresLoaderOptions, PostgresVectorStore, PostgresVectorStoreArgs, QueryOptions, VectorStoreTableArgs, dbConfigArgs };

package/dist/index.js

@@ -1,4 +1,7 @@
-export * from "./engine.js";
-export * from "./chat_message_history.js";
-export * from "./vectorstore.js";
-export * from "./loader.js";
+import { Column, PostgresEngine } from "./engine.js";
+import { PostgresChatMessageHistory } from "./chat_message_history.js";
+import { BaseIndex, DEFAULT_DISTANCE_STRATEGY, DEFAULT_INDEX_NAME_SUFFIX, DistanceStrategy, ExactNearestNeighbor, HNSWIndex, HNSWQueryOptions, IVFFlatIndex, IVFFlatQueryOptions, QueryOptions } from "./indexes.js";
+import { PostgresVectorStore } from "./vectorstore.js";
+import { PostgresLoader } from "./loader.js";
+
+export { BaseIndex, Column, DEFAULT_DISTANCE_STRATEGY, DEFAULT_INDEX_NAME_SUFFIX, DistanceStrategy, ExactNearestNeighbor, HNSWIndex, HNSWQueryOptions, IVFFlatIndex, IVFFlatQueryOptions, PostgresChatMessageHistory, PostgresEngine, PostgresLoader, PostgresVectorStore, QueryOptions };

package/dist/indexes.cjs

@@ -1,174 +1,102 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.IVFFlatQueryOptions = exports.HNSWQueryOptions = exports.QueryOptions = exports.IVFFlatIndex = exports.HNSWIndex = exports.ExactNearestNeighbor = exports.BaseIndex = exports.DEFAULT_INDEX_NAME_SUFFIX = exports.DEFAULT_DISTANCE_STRATEGY = exports.DistanceStrategy = void 0;
-class StrategyMixin {
-    constructor(operator, searchFunction, indexFunction) {
-        Object.defineProperty(this, "operator", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "searchFunction", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "indexFunction", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.operator = operator;
-        this.searchFunction = searchFunction;
-        this.indexFunction = indexFunction;
-    }
-}
+
+//#region src/indexes.ts
+var StrategyMixin = class {
+	operator;
+	searchFunction;
+	indexFunction;
+	constructor(operator, searchFunction, indexFunction) {
+		this.operator = operator;
+		this.searchFunction = searchFunction;
+		this.indexFunction = indexFunction;
+	}
+};
 /**
- * Enumerator of the Distance strategies.
- */
-class DistanceStrategy extends StrategyMixin {
-}
-exports.DistanceStrategy = DistanceStrategy;
-Object.defineProperty(DistanceStrategy, "EUCLIDEAN", {
-    enumerable: true,
-    configurable: true,
-    writable: true,
-    value: new StrategyMixin("<->", "l2_distance", "vector_l2_ops")
-});
-Object.defineProperty(DistanceStrategy, "COSINE_DISTANCE", {
-    enumerable: true,
-    configurable: true,
-    writable: true,
-    value: new StrategyMixin("<=>", "cosine_distance", "vector_cosine_ops")
-});
-Object.defineProperty(DistanceStrategy, "INNER_PRODUCT", {
-    enumerable: true,
-    configurable: true,
-    writable: true,
-    value: new StrategyMixin("<#>", "inner_product", "vector_ip_ops")
-});
-exports.DEFAULT_DISTANCE_STRATEGY = DistanceStrategy.COSINE_DISTANCE;
-exports.DEFAULT_INDEX_NAME_SUFFIX = "langchainvectorindex";
-class BaseIndex {
-    constructor(name, indexType = "base", distanceStrategy = DistanceStrategy.COSINE_DISTANCE, partialIndexes = []) {
-        Object.defineProperty(this, "name", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "indexType", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "distanceStrategy", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "partialIndexes", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.name = name;
-        this.indexType = indexType;
-        this.distanceStrategy = distanceStrategy;
-        this.partialIndexes = partialIndexes;
-    }
-}
+* Enumerator of the Distance strategies.
+*/
+var DistanceStrategy = class extends StrategyMixin {
+	static EUCLIDEAN = new StrategyMixin("<->", "l2_distance", "vector_l2_ops");
+	static COSINE_DISTANCE = new StrategyMixin("<=>", "cosine_distance", "vector_cosine_ops");
+	static INNER_PRODUCT = new StrategyMixin("<#>", "inner_product", "vector_ip_ops");
+};
+const DEFAULT_DISTANCE_STRATEGY = DistanceStrategy.COSINE_DISTANCE;
+const DEFAULT_INDEX_NAME_SUFFIX = "langchainvectorindex";
+var BaseIndex = class {
+	name;
+	indexType;
+	distanceStrategy;
+	partialIndexes;
+	constructor(name, indexType = "base", distanceStrategy = DistanceStrategy.COSINE_DISTANCE, partialIndexes = []) {
+		this.name = name;
+		this.indexType = indexType;
+		this.distanceStrategy = distanceStrategy;
+		this.partialIndexes = partialIndexes;
+	}
+};
+var ExactNearestNeighbor = class extends BaseIndex {
+	constructor(baseArgs) {
+		super(baseArgs?.name, "exactnearestneighbor", baseArgs?.distanceStrategy, baseArgs?.partialIndexes);
+	}
+	indexOptions() {
+		throw new Error("indexOptions method must be implemented by subclass");
+	}
+};
+var HNSWIndex = class extends BaseIndex {
+	m;
+	efConstruction;
+	constructor(baseArgs, m, efConstruction) {
+		super(baseArgs?.name, "hnsw", baseArgs?.distanceStrategy, baseArgs?.partialIndexes);
+		this.m = m ?? 16;
+		this.efConstruction = efConstruction ?? 64;
+	}
+	indexOptions() {
+		return `(m = ${this.m}, ef_construction = ${this.efConstruction})`;
+	}
+};
+var IVFFlatIndex = class extends BaseIndex {
+	lists;
+	constructor(baseArgs, lists) {
+		super(baseArgs?.name, "ivfflat", baseArgs?.distanceStrategy, baseArgs?.partialIndexes);
+		this.lists = lists ?? 100;
+	}
+	indexOptions() {
+		return `(lists = ${this.lists})`;
+	}
+};
+/**
+* Convert index attributes to string.
+* Must be implemented by subclasses.
+*/
+var QueryOptions = class {};
+var HNSWQueryOptions = class extends QueryOptions {
+	efSearch;
+	constructor(efSearch) {
+		super();
+		this.efSearch = efSearch ?? 40;
+	}
+	to_string() {
+		return `hnsw.ef_search = ${this.efSearch}`;
+	}
+};
+var IVFFlatQueryOptions = class extends QueryOptions {
+	probes;
+	constructor(probes) {
+		super();
+		this.probes = probes ?? 1;
+	}
+	to_string() {
+		return `ivflfat.probes = ${this.probes}`;
+	}
+};
+
+//#endregion
 exports.BaseIndex = BaseIndex;
-class ExactNearestNeighbor extends BaseIndex {
-    constructor(baseArgs) {
-        super(baseArgs?.name, "exactnearestneighbor", baseArgs?.distanceStrategy, baseArgs?.partialIndexes);
-    }
-    indexOptions() {
-        throw new Error("indexOptions method must be implemented by subclass");
-    }
-}
+exports.DEFAULT_DISTANCE_STRATEGY = DEFAULT_DISTANCE_STRATEGY;
+exports.DEFAULT_INDEX_NAME_SUFFIX = DEFAULT_INDEX_NAME_SUFFIX;
+exports.DistanceStrategy = DistanceStrategy;
 exports.ExactNearestNeighbor = ExactNearestNeighbor;
-class HNSWIndex extends BaseIndex {
-    constructor(baseArgs, m, efConstruction) {
-        super(baseArgs?.name, "hnsw", baseArgs?.distanceStrategy, baseArgs?.partialIndexes);
-        Object.defineProperty(this, "m", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "efConstruction", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.m = m ?? 16;
-        this.efConstruction = efConstruction ?? 64;
-    }
-    indexOptions() {
-        return `(m = ${this.m}, ef_construction = ${this.efConstruction})`;
-    }
-}
 exports.HNSWIndex = HNSWIndex;
-class IVFFlatIndex extends BaseIndex {
-    constructor(baseArgs, lists) {
-        super(baseArgs?.name, "ivfflat", baseArgs?.distanceStrategy, baseArgs?.partialIndexes);
-        Object.defineProperty(this, "lists", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.lists = lists ?? 100;
-    }
-    indexOptions() {
-        return `(lists = ${this.lists})`;
-    }
-}
-exports.IVFFlatIndex = IVFFlatIndex;
-/**
- * Convert index attributes to string.
- * Must be implemented by subclasses.
- */
-class QueryOptions {
-}
-exports.QueryOptions = QueryOptions;
-class HNSWQueryOptions extends QueryOptions {
-    constructor(efSearch) {
-        super();
-        Object.defineProperty(this, "efSearch", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.efSearch = efSearch ?? 40;
-    }
-    to_string() {
-        return `hnsw.ef_search = ${this.efSearch}`;
-    }
-}
 exports.HNSWQueryOptions = HNSWQueryOptions;
-class IVFFlatQueryOptions extends QueryOptions {
-    constructor(probes) {
-        super();
-        Object.defineProperty(this, "probes", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.probes = probes ?? 1;
-    }
-    to_string() {
-        return `ivflfat.probes = ${this.probes}`;
-    }
-}
+exports.IVFFlatIndex = IVFFlatIndex;
 exports.IVFFlatQueryOptions = IVFFlatQueryOptions;
+exports.QueryOptions = QueryOptions;
+//# sourceMappingURL=indexes.cjs.map

package/dist/indexes.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexes.cjs","names":["operator: string","searchFunction: string","indexFunction: string","DEFAULT_INDEX_NAME_SUFFIX: string","name?: string","indexType: string","distanceStrategy: DistanceStrategy","partialIndexes: string[]","baseArgs?: BaseIndexArgs","m?: number","efConstruction?: number","baseArgs: BaseIndexArgs","lists?: number","efSearch?: number","probes?: number"],"sources":["../src/indexes.ts"],"sourcesContent":["class StrategyMixin {\n  operator: string;\n\n  searchFunction: string;\n\n  indexFunction: string;\n\n  constructor(operator: string, searchFunction: string, indexFunction: string) {\n    this.operator = operator;\n    this.searchFunction = searchFunction;\n    this.indexFunction = indexFunction;\n  }\n}\n\n/**\n * Enumerator of the Distance strategies.\n */\nexport class DistanceStrategy extends StrategyMixin {\n  public static EUCLIDEAN = new StrategyMixin(\n    \"<->\",\n    \"l2_distance\",\n    \"vector_l2_ops\"\n  );\n\n  public static COSINE_DISTANCE = new StrategyMixin(\n    \"<=>\",\n    \"cosine_distance\",\n    \"vector_cosine_ops\"\n  );\n\n  public static INNER_PRODUCT = new StrategyMixin(\n    \"<#>\",\n    \"inner_product\",\n    \"vector_ip_ops\"\n  );\n}\n\nexport const DEFAULT_DISTANCE_STRATEGY = DistanceStrategy.COSINE_DISTANCE;\nexport const DEFAULT_INDEX_NAME_SUFFIX: string = \"langchainvectorindex\";\n\nexport interface BaseIndexArgs {\n  name?: string;\n  distanceStrategy?: DistanceStrategy;\n  partialIndexes?: string[];\n}\n\nexport abstract class BaseIndex {\n  name?: string;\n\n  indexType: string;\n\n  distanceStrategy: DistanceStrategy;\n\n  partialIndexes?: string[];\n\n  constructor(\n    name?: string,\n    indexType: string = \"base\",\n    distanceStrategy: DistanceStrategy = DistanceStrategy.COSINE_DISTANCE,\n    partialIndexes: string[] = []\n  ) {\n    this.name = name;\n    this.indexType = indexType;\n    this.distanceStrategy = distanceStrategy;\n    this.partialIndexes = partialIndexes;\n  }\n\n  /**\n   * Set index query options for vector store initialization.\n   */\n  abstract indexOptions(): string;\n}\n\nexport class ExactNearestNeighbor extends BaseIndex {\n  constructor(baseArgs?: BaseIndexArgs) {\n    super(\n      baseArgs?.name,\n      \"exactnearestneighbor\",\n      baseArgs?.distanceStrategy,\n      baseArgs?.partialIndexes\n    );\n  }\n\n  indexOptions(): string {\n    throw new Error(\"indexOptions method must be implemented by subclass\");\n  }\n}\n\nexport class HNSWIndex extends BaseIndex {\n  m: number;\n\n  efConstruction: number;\n\n  constructor(baseArgs?: BaseIndexArgs, m?: number, efConstruction?: number) {\n    super(\n      baseArgs?.name,\n      \"hnsw\",\n      baseArgs?.distanceStrategy,\n      baseArgs?.partialIndexes\n    );\n    this.m = m ?? 16;\n    this.efConstruction = efConstruction ?? 64;\n  }\n\n  indexOptions(): string {\n    return `(m = ${this.m}, ef_construction = ${this.efConstruction})`;\n  }\n}\n\nexport class IVFFlatIndex extends BaseIndex {\n  lists: number;\n\n  constructor(baseArgs: BaseIndexArgs, lists?: number) {\n    super(\n      baseArgs?.name,\n      \"ivfflat\",\n      baseArgs?.distanceStrategy,\n      baseArgs?.partialIndexes\n    );\n    this.lists = lists ?? 100;\n  }\n\n  indexOptions(): string {\n    return `(lists = ${this.lists})`;\n  }\n}\n\n/**\n * Convert index attributes to string.\n * Must be implemented by subclasses.\n */\nexport abstract class QueryOptions {\n  abstract to_string(): string;\n}\n\nexport class HNSWQueryOptions extends QueryOptions {\n  efSearch: number;\n\n  constructor(efSearch?: number) {\n    super();\n    this.efSearch = efSearch ?? 40;\n  }\n\n  to_string(): string {\n    return `hnsw.ef_search = ${this.efSearch}`;\n  }\n}\n\nexport class IVFFlatQueryOptions extends QueryOptions {\n  readonly probes: number;\n\n  constructor(probes?: number) {\n    super();\n    this.probes = probes ?? 1;\n  }\n\n  to_string(): string {\n    return `ivflfat.probes = ${this.probes}`;\n  }\n}\n"],"mappings":";;AAAA,IAAM,gBAAN,MAAoB;CAClB;CAEA;CAEA;CAEA,YAAYA,UAAkBC,gBAAwBC,eAAuB;EAC3E,KAAK,WAAW;EAChB,KAAK,iBAAiB;EACtB,KAAK,gBAAgB;CACtB;AACF;;;;AAKD,IAAa,mBAAb,cAAsC,cAAc;CAClD,OAAc,YAAY,IAAI,cAC5B,OACA,eACA;CAGF,OAAc,kBAAkB,IAAI,cAClC,OACA,mBACA;CAGF,OAAc,gBAAgB,IAAI,cAChC,OACA,iBACA;AAEH;AAED,MAAa,4BAA4B,iBAAiB;AAC1D,MAAaC,4BAAoC;AAQjD,IAAsB,YAAtB,MAAgC;CAC9B;CAEA;CAEA;CAEA;CAEA,YACEC,MACAC,YAAoB,QACpBC,mBAAqC,iBAAiB,iBACtDC,iBAA2B,CAAE,GAC7B;EACA,KAAK,OAAO;EACZ,KAAK,YAAY;EACjB,KAAK,mBAAmB;EACxB,KAAK,iBAAiB;CACvB;AAMF;AAED,IAAa,uBAAb,cAA0C,UAAU;CAClD,YAAYC,UAA0B;EACpC,MACE,UAAU,MACV,wBACA,UAAU,kBACV,UAAU,eACX;CACF;CAED,eAAuB;AACrB,QAAM,IAAI,MAAM;CACjB;AACF;AAED,IAAa,YAAb,cAA+B,UAAU;CACvC;CAEA;CAEA,YAAYA,UAA0BC,GAAYC,gBAAyB;EACzE,MACE,UAAU,MACV,QACA,UAAU,kBACV,UAAU,eACX;EACD,KAAK,IAAI,KAAK;EACd,KAAK,iBAAiB,kBAAkB;CACzC;CAED,eAAuB;AACrB,SAAO,CAAC,KAAK,EAAE,KAAK,EAAE,oBAAoB,EAAE,KAAK,eAAe,CAAC,CAAC;CACnE;AACF;AAED,IAAa,eAAb,cAAkC,UAAU;CAC1C;CAEA,YAAYC,UAAyBC,OAAgB;EACnD,MACE,UAAU,MACV,WACA,UAAU,kBACV,UAAU,eACX;EACD,KAAK,QAAQ,SAAS;CACvB;CAED,eAAuB;AACrB,SAAO,CAAC,SAAS,EAAE,KAAK,MAAM,CAAC,CAAC;CACjC;AACF;;;;;AAMD,IAAsB,eAAtB,MAAmC,CAElC;AAED,IAAa,mBAAb,cAAsC,aAAa;CACjD;CAEA,YAAYC,UAAmB;EAC7B,OAAO;EACP,KAAK,WAAW,YAAY;CAC7B;CAED,YAAoB;AAClB,SAAO,CAAC,iBAAiB,EAAE,KAAK,UAAU;CAC3C;AACF;AAED,IAAa,sBAAb,cAAyC,aAAa;CACpD,AAAS;CAET,YAAYC,QAAiB;EAC3B,OAAO;EACP,KAAK,SAAS,UAAU;CACzB;CAED,YAAoB;AAClB,SAAO,CAAC,iBAAiB,EAAE,KAAK,QAAQ;CACzC;AACF"}

package/dist/indexes.d.cts

@@ -0,0 +1,68 @@
+//#region src/indexes.d.ts
+declare class StrategyMixin {
+  operator: string;
+  searchFunction: string;
+  indexFunction: string;
+  constructor(operator: string, searchFunction: string, indexFunction: string);
+}
+/**
+ * Enumerator of the Distance strategies.
+ */
+declare class DistanceStrategy extends StrategyMixin {
+  static EUCLIDEAN: StrategyMixin;
+  static COSINE_DISTANCE: StrategyMixin;
+  static INNER_PRODUCT: StrategyMixin;
+}
+declare const DEFAULT_DISTANCE_STRATEGY: StrategyMixin;
+declare const DEFAULT_INDEX_NAME_SUFFIX: string;
+interface BaseIndexArgs {
+  name?: string;
+  distanceStrategy?: DistanceStrategy;
+  partialIndexes?: string[];
+}
+declare abstract class BaseIndex {
+  name?: string;
+  indexType: string;
+  distanceStrategy: DistanceStrategy;
+  partialIndexes?: string[];
+  constructor(name?: string, indexType?: string, distanceStrategy?: DistanceStrategy, partialIndexes?: string[]);
+  /**
+   * Set index query options for vector store initialization.
+   */
+  abstract indexOptions(): string;
+}
+declare class ExactNearestNeighbor extends BaseIndex {
+  constructor(baseArgs?: BaseIndexArgs);
+  indexOptions(): string;
+}
+declare class HNSWIndex extends BaseIndex {
+  m: number;
+  efConstruction: number;
+  constructor(baseArgs?: BaseIndexArgs, m?: number, efConstruction?: number);
+  indexOptions(): string;
+}
+declare class IVFFlatIndex extends BaseIndex {
+  lists: number;
+  constructor(baseArgs: BaseIndexArgs, lists?: number);
+  indexOptions(): string;
+}
+/**
+ * Convert index attributes to string.
+ * Must be implemented by subclasses.
+ */
+declare abstract class QueryOptions {
+  abstract to_string(): string;
+}
+declare class HNSWQueryOptions extends QueryOptions {
+  efSearch: number;
+  constructor(efSearch?: number);
+  to_string(): string;
+}
+declare class IVFFlatQueryOptions extends QueryOptions {
+  readonly probes: number;
+  constructor(probes?: number);
+  to_string(): string;
+}
+//#endregion
+export { BaseIndex, BaseIndexArgs, DEFAULT_DISTANCE_STRATEGY, DEFAULT_INDEX_NAME_SUFFIX, DistanceStrategy, ExactNearestNeighbor, HNSWIndex, HNSWQueryOptions, IVFFlatIndex, IVFFlatQueryOptions, QueryOptions };
+//# sourceMappingURL=indexes.d.cts.map

package/dist/indexes.d.ts

@@ -1,65 +1,68 @@
+//#region src/indexes.d.ts
 declare class StrategyMixin {
-    operator: string;
-    searchFunction: string;
-    indexFunction: string;
-    constructor(operator: string, searchFunction: string, indexFunction: string);
+  operator: string;
+  searchFunction: string;
+  indexFunction: string;
+  constructor(operator: string, searchFunction: string, indexFunction: string);
 }
 /**
  * Enumerator of the Distance strategies.
  */
-export declare class DistanceStrategy extends StrategyMixin {
-    static EUCLIDEAN: StrategyMixin;
-    static COSINE_DISTANCE: StrategyMixin;
-    static INNER_PRODUCT: StrategyMixin;
+declare class DistanceStrategy extends StrategyMixin {
+  static EUCLIDEAN: StrategyMixin;
+  static COSINE_DISTANCE: StrategyMixin;
+  static INNER_PRODUCT: StrategyMixin;
 }
-export declare const DEFAULT_DISTANCE_STRATEGY: StrategyMixin;
-export declare const DEFAULT_INDEX_NAME_SUFFIX: string;
-export interface BaseIndexArgs {
-    name?: string;
-    distanceStrategy?: DistanceStrategy;
-    partialIndexes?: string[];
+declare const DEFAULT_DISTANCE_STRATEGY: StrategyMixin;
+declare const DEFAULT_INDEX_NAME_SUFFIX: string;
+interface BaseIndexArgs {
+  name?: string;
+  distanceStrategy?: DistanceStrategy;
+  partialIndexes?: string[];
 }
-export declare abstract class BaseIndex {
-    name?: string;
-    indexType: string;
-    distanceStrategy: DistanceStrategy;
-    partialIndexes?: string[];
-    constructor(name?: string, indexType?: string, distanceStrategy?: DistanceStrategy, partialIndexes?: string[]);
-    /**
-     * Set index query options for vector store initialization.
-     */
-    abstract indexOptions(): string;
+declare abstract class BaseIndex {
+  name?: string;
+  indexType: string;
+  distanceStrategy: DistanceStrategy;
+  partialIndexes?: string[];
+  constructor(name?: string, indexType?: string, distanceStrategy?: DistanceStrategy, partialIndexes?: string[]);
+  /**
+   * Set index query options for vector store initialization.
+   */
+  abstract indexOptions(): string;
 }
-export declare class ExactNearestNeighbor extends BaseIndex {
-    constructor(baseArgs?: BaseIndexArgs);
-    indexOptions(): string;
+declare class ExactNearestNeighbor extends BaseIndex {
+  constructor(baseArgs?: BaseIndexArgs);
+  indexOptions(): string;
 }
-export declare class HNSWIndex extends BaseIndex {
-    m: number;
-    efConstruction: number;
-    constructor(baseArgs?: BaseIndexArgs, m?: number, efConstruction?: number);
-    indexOptions(): string;
+declare class HNSWIndex extends BaseIndex {
+  m: number;
+  efConstruction: number;
+  constructor(baseArgs?: BaseIndexArgs, m?: number, efConstruction?: number);
+  indexOptions(): string;
 }
-export declare class IVFFlatIndex extends BaseIndex {
-    lists: number;
-    constructor(baseArgs: BaseIndexArgs, lists?: number);
-    indexOptions(): string;
+declare class IVFFlatIndex extends BaseIndex {
+  lists: number;
+  constructor(baseArgs: BaseIndexArgs, lists?: number);
+  indexOptions(): string;
 }
 /**
  * Convert index attributes to string.
  * Must be implemented by subclasses.
  */
-export declare abstract class QueryOptions {
-    abstract to_string(): string;
+declare abstract class QueryOptions {
+  abstract to_string(): string;
 }
-export declare class HNSWQueryOptions extends QueryOptions {
-    efSearch: number;
-    constructor(efSearch?: number);
-    to_string(): string;
+declare class HNSWQueryOptions extends QueryOptions {
+  efSearch: number;
+  constructor(efSearch?: number);
+  to_string(): string;
 }
-export declare class IVFFlatQueryOptions extends QueryOptions {
-    readonly probes: number;
-    constructor(probes?: number);
-    to_string(): string;
+declare class IVFFlatQueryOptions extends QueryOptions {
+  readonly probes: number;
+  constructor(probes?: number);
+  to_string(): string;
 }
-export {};
+//#endregion
+export { BaseIndex, BaseIndexArgs, DEFAULT_DISTANCE_STRATEGY, DEFAULT_INDEX_NAME_SUFFIX, DistanceStrategy, ExactNearestNeighbor, HNSWIndex, HNSWQueryOptions, IVFFlatIndex, IVFFlatQueryOptions, QueryOptions };
+//# sourceMappingURL=indexes.d.ts.map