@mastra/opensearch 0.0.0-vector-sources-20250516175436 → 0.0.0-vector-extension-schema-20250922130418

package/dist/vector/index.d.ts

@@ -0,0 +1,101 @@
+import type { CreateIndexParams, DeleteIndexParams, DeleteVectorParams, DescribeIndexParams, IndexStats, QueryResult, QueryVectorParams, UpdateVectorParams, UpsertVectorParams } from '@mastra/core/vector';
+import { MastraVector } from '@mastra/core/vector';
+import type { OpenSearchVectorFilter } from './filter.js';
+type OpenSearchVectorParams = QueryVectorParams<OpenSearchVectorFilter>;
+export declare class OpenSearchVector extends MastraVector<OpenSearchVectorFilter> {
+    private client;
+    /**
+     * Creates a new OpenSearchVector client.
+     *
+     * @param {string} url - The url of the OpenSearch node.
+     */
+    constructor({ url }: {
+        url: string;
+    });
+    /**
+     * Creates a new collection with the specified configuration.
+     *
+     * @param {string} indexName - The name of the collection to create.
+     * @param {number} dimension - The dimension of the vectors to be stored in the collection.
+     * @param {'cosine' | 'euclidean' | 'dotproduct'} [metric=cosine] - The metric to use to sort vectors in the collection.
+     * @returns {Promise<void>} A promise that resolves when the collection is created.
+     */
+    createIndex({ indexName, dimension, metric }: CreateIndexParams): Promise<void>;
+    /**
+     * Lists all indexes.
+     *
+     * @returns {Promise<string[]>} A promise that resolves to an array of indexes.
+     */
+    listIndexes(): Promise<string[]>;
+    /**
+     * Retrieves statistics about a vector index.
+     *
+     * @param {string} indexName - The name of the index to describe
+     * @returns A promise that resolves to the index statistics including dimension, count and metric
+     */
+    describeIndex({ indexName }: DescribeIndexParams): Promise<IndexStats>;
+    /**
+     * Deletes the specified index.
+     *
+     * @param {string} indexName - The name of the index to delete.
+     * @returns {Promise<void>} A promise that resolves when the index is deleted.
+     */
+    deleteIndex({ indexName }: DeleteIndexParams): Promise<void>;
+    /**
+     * Inserts or updates vectors in the specified collection.
+     *
+     * @param {string} indexName - The name of the collection to upsert into.
+     * @param {number[][]} vectors - An array of vectors to upsert.
+     * @param {Record<string, any>[]} [metadata] - An optional array of metadata objects corresponding to each vector.
+     * @param {string[]} [ids] - An optional array of IDs corresponding to each vector. If not provided, new IDs will be generated.
+     * @returns {Promise<string[]>} A promise that resolves to an array of IDs of the upserted vectors.
+     */
+    upsert({ indexName, vectors, metadata, ids }: UpsertVectorParams): Promise<string[]>;
+    /**
+     * Queries the specified collection using a vector and optional filter.
+     *
+     * @param {string} indexName - The name of the collection to query.
+     * @param {number[]} queryVector - The vector to query with.
+     * @param {number} [topK] - The maximum number of results to return.
+     * @param {Record<string, any>} [filter] - An optional filter to apply to the query. For more on filters in OpenSearch, see the filtering reference: https://opensearch.org/docs/latest/query-dsl/
+     * @param {boolean} [includeVectors=false] - Whether to include the vectors in the response.
+     * @returns {Promise<QueryResult[]>} A promise that resolves to an array of query results.
+     */
+    query({ indexName, queryVector, filter, topK, includeVector, }: OpenSearchVectorParams): Promise<QueryResult[]>;
+    /**
+     * Validates the dimensions of the vectors.
+     *
+     * @param {number[][]} vectors - The vectors to validate.
+     * @param {number} dimension - The dimension of the vectors.
+     * @returns {void}
+     */
+    private validateVectorDimensions;
+    /**
+     * Transforms the filter to the OpenSearch DSL.
+     *
+     * @param {OpenSearchVectorFilter} filter - The filter to transform.
+     * @returns {Record<string, any>} The transformed filter.
+     */
+    private transformFilter;
+    /**
+     * Updates a vector by its ID with the provided vector and/or metadata.
+     * @param indexName - The name of the index containing the vector.
+     * @param id - The ID of the vector to update.
+     * @param update - An object containing the vector and/or metadata to update.
+     * @param update.vector - An optional array of numbers representing the new vector.
+     * @param update.metadata - An optional record containing the new metadata.
+     * @returns A promise that resolves when the update is complete.
+     * @throws Will throw an error if no updates are provided or if the update operation fails.
+     */
+    updateVector({ indexName, id, update }: UpdateVectorParams): Promise<void>;
+    /**
+     * Deletes a vector by its ID.
+     * @param indexName - The name of the index containing the vector.
+     * @param id - The ID of the vector to delete.
+     * @returns A promise that resolves when the deletion is complete.
+     * @throws Will throw an error if the deletion operation fails.
+     */
+    deleteVector({ indexName, id }: DeleteVectorParams): Promise<void>;
+}
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/vector/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/vector/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,UAAU,EACV,WAAW,EACX,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EACnB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAGnD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAC;AAcvD,KAAK,sBAAsB,GAAG,iBAAiB,CAAC,sBAAsB,CAAC,CAAC;AAExE,qBAAa,gBAAiB,SAAQ,YAAY,CAAC,sBAAsB,CAAC;IACxE,OAAO,CAAC,MAAM,CAAmB;IAEjC;;;;OAIG;gBACS,EAAE,GAAG,EAAE,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE;IAKpC;;;;;;;OAOG;IACG,WAAW,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,MAAiB,EAAE,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAqDhG;;;;OAIG;IACG,WAAW,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAoBtC;;;;;OAKG;IACG,aAAa,CAAC,EAAE,SAAS,EAAE,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC;IAe5E;;;;;OAKG;IACG,WAAW,CAAC,EAAE,SAAS,EAAE,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAkBlE;;;;;;;;OAQG;IACG,MAAM,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,QAAa,EAAE,GAAG,EAAE,EAAE,kBAAkB,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IA+C/F;;;;;;;;;OASG;IACG,KAAK,CAAC,EACV,SAAS,EACT,WAAW,EACX,MAAM,EACN,IAAS,EACT,aAAqB,GACtB,EAAE,sBAAsB,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAyClD;;;;;;OAMG;IACH,OAAO,CAAC,wBAAwB;IAMhC;;;;;OAKG;IACH,OAAO,CAAC,eAAe;IAKvB;;;;;;;;;OASG;IACG,YAAY,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAgFhF;;;;;;OAMG;IACG,YAAY,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;CAuBzE"}

package/dist/vector/prompt.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Vector store prompt for OpenSearch. This prompt details supported filter operators, syntax, and usage examples.
+ * Use this as a guide for constructing valid filters for OpenSearch vector queries in Mastra.
+ */
+export declare const OPENSEARCH_PROMPT = "When querying OpenSearch, you can ONLY use the operators listed below. Any other operators will be rejected.\nImportant: Do not explain how to construct the filter\u2014use the specified operators and fields to search the content and return relevant results.\nIf a user tries to use an unsupported operator, reject the filter entirely and let them know that the operator is not supported.\n\nBasic Comparison Operators:\n- $eq: Exact match (default for field: value)\n  Example: { \"category\": \"electronics\" }\n- $ne: Not equal\n  Example: { \"category\": { \"$ne\": \"electronics\" } }\n- $gt: Greater than\n  Example: { \"price\": { \"$gt\": 100 } }\n- $gte: Greater than or equal\n  Example: { \"price\": { \"$gte\": 100 } }\n- $lt: Less than\n  Example: { \"price\": { \"$lt\": 100 } }\n- $lte: Less than or equal\n  Example: { \"price\": { \"$lte\": 100 } }\n\nArray Operators:\n- $in: Match any value in array\n  Example: { \"category\": { \"$in\": [\"electronics\", \"books\"] } }\n- $nin: Does not match any value in array\n  Example: { \"category\": { \"$nin\": [\"electronics\", \"books\"] } }\n- $all: Match all values in array\n  Example: { \"tags\": { \"$all\": [\"premium\", \"sale\"] } }\n\nLogical Operators:\n- $and: Logical AND (implicit when using multiple conditions)\n  Example: { \"$and\": [{ \"price\": { \"$gt\": 100 } }, { \"category\": \"electronics\" }] }\n- $or: Logical OR\n  Example: { \"$or\": [{ \"price\": { \"$lt\": 50 } }, { \"category\": \"books\" }] }\n- $not: Logical NOT\n  Example: { \"$not\": { \"category\": \"electronics\" } }\n\nElement Operators:\n- $exists: Check if field exists\n  Example: { \"rating\": { \"$exists\": true } }\n\nRegex Operator:\n- $regex: Match using a regular expression (ECMAScript syntax)\n  Example: { \"name\": { \"$regex\": \"^Sam.*son$\" } }\n  Note: Regex queries are supported for string fields only. Use valid ECMAScript patterns; invalid patterns will throw an error.\n\nRestrictions:\n- Nested fields are supported using dot notation (e.g., \"address.city\").\n- Multiple conditions on the same field are supported (e.g., { \"price\": { \"$gte\": 100, \"$lte\": 1000 } }).\n- Only logical operators ($and, $or, $not) can be used at the top level.\n- All other operators must be used within a field condition.\n  Valid: { \"field\": { \"$gt\": 100 } }\n  Valid: { \"$and\": [...] }\n  Invalid: { \"$gt\": 100 }\n- Logical operators must contain field conditions, not direct operators.\n  Valid: { \"$and\": [{ \"field\": { \"$gt\": 100 } }] }\n  Invalid: { \"$and\": [{ \"$gt\": 100 }] }\n- $not operator:\n  - Must be an object\n  - Cannot be empty\n  - Can be used at field level or top level\n  - Valid: { \"$not\": { \"field\": \"value\" } }\n  - Valid: { \"field\": { \"$not\": { \"$eq\": \"value\" } } }\n- Array operators work on array fields only.\n- Empty arrays in conditions are handled gracefully.\n- Regex queries are case-sensitive by default; use patterns accordingly.\n\nExample Complex Query:\n{\n  \"$and\": [\n    { \"category\": { \"$in\": [\"electronics\", \"computers\"] } },\n    { \"price\": { \"$gte\": 100, \"$lte\": 1000 } },\n    { \"tags\": { \"$all\": [\"premium\"] } },\n    { \"rating\": { \"$exists\": true, \"$gt\": 4 } },\n    { \"$or\": [\n      { \"stock\": { \"$gt\": 0 } },\n      { \"preorder\": true }\n    ]},\n    { \"name\": { \"$regex\": \"^Sam.*son$\" } }\n  ]\n}";
+//# sourceMappingURL=prompt.d.ts.map

package/dist/vector/prompt.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prompt.d.ts","sourceRoot":"","sources":["../../src/vector/prompt.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,iBAAiB,m0GA6E5B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/opensearch",
-  "version": "0.0.0-vector-sources-20250516175436",
+  "version": "0.0.0-vector-extension-schema-20250922130418",
   "description": "OpenSearch vector store provider for Mastra",
   "type": "module",
   "main": "dist/index.js",
@@ -12,28 +12,45 @@
         "default": "./dist/index.js"
       },
       "require": {
-        "types": "./dist/index.d.cts",
+        "types": "./dist/index.d.ts",
         "default": "./dist/index.cjs"
       }
     },
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@opensearch-project/opensearch": "^3.4.0",
-    "@mastra/core": "0.0.0-vector-sources-20250516175436"
+    "@opensearch-project/opensearch": "^3.5.1"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.52.1",
-    "@types/node": "^22.13.10",
-    "eslint": "^9.22.0",
-    "tsup": "^8.4.0",
-    "typescript": "^5.8.2",
-    "vitest": "^3.0.8",
-    "@internal/lint": "0.0.0-vector-sources-20250516175436"
+    "@microsoft/api-extractor": "^7.52.8",
+    "@types/node": "^20.19.0",
+    "eslint": "^9.35.0",
+    "tsup": "^8.5.0",
+    "typescript": "^5.8.3",
+    "vitest": "^3.2.4",
+    "@internal/lint": "0.0.0-vector-extension-schema-20250922130418",
+    "@internal/types-builder": "0.0.0-vector-extension-schema-20250922130418",
+    "@mastra/core": "0.0.0-vector-extension-schema-20250922130418"
+  },
+  "peerDependencies": {
+    "@mastra/core": "0.0.0-vector-extension-schema-20250922130418"
+  },
+  "files": [
+    "dist",
+    "CHANGELOG.md"
+  ],
+  "homepage": "https://mastra.ai",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mastra-ai/mastra.git",
+    "directory": "stores/opensearch"
+  },
+  "bugs": {
+    "url": "https://github.com/mastra-ai/mastra/issues"
   },
   "scripts": {
-    "build": "tsup src/index.ts --format esm,cjs --experimental-dts --clean --treeshake=smallest --splitting",
-    "build:watch": "pnpm build --watch",
+    "build": "tsup --silent --config tsup.config.ts",
+    "build:watch": "tsup --watch --silent --config tsup.config.ts",
     "pretest": "docker compose up -d && (for i in $(seq 1 30); do curl -s http://localhost:9200/_cluster/health | grep -q '\"status\"' && break || (sleep 1; [ $i -eq 30 ] && exit 1); done)",
     "test": "vitest run",
     "posttest": "docker compose down -v",

package/dist/_tsup-dts-rollup.d.cts

@@ -1,186 +0,0 @@
-import { BaseFilterTranslator } from '@mastra/core/vector/filter';
-import type { CreateIndexParams } from '@mastra/core';
-import type { DeleteIndexParams } from '@mastra/core';
-import type { DeleteVectorParams } from '@mastra/core';
-import type { DescribeIndexParams } from '@mastra/core';
-import type { IndexStats } from '@mastra/core';
-import { MastraVector } from '@mastra/core/vector';
-import type { OperatorSupport } from '@mastra/core/vector/filter';
-import type { ParamsToArgs } from '@mastra/core';
-import type { QueryResult } from '@mastra/core';
-import type { QueryVectorParams } from '@mastra/core';
-import type { UpdateVectorParams } from '@mastra/core';
-import type { UpsertVectorParams } from '@mastra/core';
-import type { VectorFilter } from '@mastra/core/vector/filter';
-
-/**
- * Translator for OpenSearch filter queries.
- * Maintains OpenSearch-compatible syntax while ensuring proper validation
- * and normalization of values.
- */
-export declare class OpenSearchFilterTranslator extends BaseFilterTranslator {
-    protected getSupportedOperators(): OperatorSupport;
-    translate(filter?: VectorFilter): VectorFilter;
-    private translateNode;
-    /**
-     * Handles translation of nested objects with dot notation fields
-     */
-    private translateNestedObject;
-    private translateLogicalOperator;
-    private translateFieldOperator;
-    /**
-     * Translates regex patterns to OpenSearch query syntax
-     */
-    private translateRegexOperator;
-    private addKeywordIfNeeded;
-    /**
-     * Helper method to handle special cases for the $not operator
-     */
-    private handleNotOperatorSpecialCases;
-    private translateOperator;
-    /**
-     * Translates field conditions to OpenSearch query syntax
-     * Handles special cases like range queries and multiple operators
-     */
-    private translateFieldConditions;
-    /**
-     * Checks if conditions can be optimized to a range query
-     */
-    private canOptimizeToRangeQuery;
-    /**
-     * Creates a range query from numeric operators
-     */
-    private createRangeQuery;
-}
-
-declare class OpenSearchVector extends MastraVector {
-    private client;
-    /**
-     * @deprecated Passing a string URL is deprecated. Use an object parameter: { url }.
-     * @param url - The OpenSearch node URL (deprecated)
-     */
-    constructor(url: string);
-    /**
-     * Creates a new OpenSearchVector client.
-     *
-     * @param params - An object with a url property specifying the OpenSearch node.
-     */
-    constructor(params: {
-        url: string;
-    });
-    /**
-     * Creates a new collection with the specified configuration.
-     *
-     * @param {string} indexName - The name of the collection to create.
-     * @param {number} dimension - The dimension of the vectors to be stored in the collection.
-     * @param {'cosine' | 'euclidean' | 'dotproduct'} [metric=cosine] - The metric to use to sort vectors in the collection.
-     * @returns {Promise<void>} A promise that resolves when the collection is created.
-     */
-    createIndex(params: CreateIndexParams): Promise<void>;
-    /**
-     * Lists all indexes.
-     *
-     * @returns {Promise<string[]>} A promise that resolves to an array of indexes.
-     */
-    listIndexes(): Promise<string[]>;
-    /**
-     * Retrieves statistics about a vector index.
-     *
-     * @param params - The parameters for describing an index
-     * @param params.indexName - The name of the index to describe
-     * @returns A promise that resolves to the index statistics including dimension, count and metric
-     */
-    describeIndex(...args: ParamsToArgs<DescribeIndexParams>): Promise<IndexStats>;
-    /**
-     * Deletes the specified index.
-     *
-     * @param {string} indexName - The name of the index to delete.
-     * @returns {Promise<void>} A promise that resolves when the index is deleted.
-     */
-    deleteIndex(...args: ParamsToArgs<DeleteIndexParams>): Promise<void>;
-    /**
-     * Inserts or updates vectors in the specified collection.
-     *
-     * @param {string} indexName - The name of the collection to upsert into.
-     * @param {number[][]} vectors - An array of vectors to upsert.
-     * @param {Record<string, any>[]} [metadata] - An optional array of metadata objects corresponding to each vector.
-     * @param {string[]} [ids] - An optional array of IDs corresponding to each vector. If not provided, new IDs will be generated.
-     * @returns {Promise<string[]>} A promise that resolves to an array of IDs of the upserted vectors.
-     */
-    upsert(params: UpsertVectorParams): Promise<string[]>;
-    /**
-     * Queries the specified collection using a vector and optional filter.
-     *
-     * @param {string} indexName - The name of the collection to query.
-     * @param {number[]} queryVector - The vector to query with.
-     * @param {number} [topK] - The maximum number of results to return.
-     * @param {Record<string, any>} [filter] - An optional filter to apply to the query. For more on filters in OpenSearch, see the filtering reference: https://opensearch.org/docs/latest/query-dsl/
-     * @param {boolean} [includeVectors=false] - Whether to include the vectors in the response.
-     * @returns {Promise<QueryResult[]>} A promise that resolves to an array of query results.
-     */
-    query(params: QueryVectorParams): Promise<QueryResult[]>;
-    /**
-     * Validates the dimensions of the vectors.
-     *
-     * @param {number[][]} vectors - The vectors to validate.
-     * @param {number} dimension - The dimension of the vectors.
-     * @returns {void}
-     */
-    private validateVectorDimensions;
-    /**
-     * Transforms the filter to the OpenSearch DSL.
-     *
-     * @param {VectorFilter} filter - The filter to transform.
-     * @returns {Record<string, any>} The transformed filter.
-     */
-    private transformFilter;
-    /**
-     * @deprecated Use {@link updateVector} instead. This method will be removed on May 20th, 2025.
-     *
-     * Updates a vector by its ID with the provided vector and/or metadata.
-     * @param indexName - The name of the index containing the vector.
-     * @param id - The ID of the vector to update.
-     * @param update - An object containing the vector and/or metadata to update.
-     * @param update.vector - An optional array of numbers representing the new vector.
-     * @param update.metadata - An optional record containing the new metadata.
-     * @returns A promise that resolves when the update is complete.
-     * @throws Will throw an error if no updates are provided or if the update operation fails.
-     */
-    updateIndexById(indexName: string, id: string, update: {
-        vector?: number[];
-        metadata?: Record<string, any>;
-    }): Promise<void>;
-    /**
-     * Updates a vector by its ID with the provided vector and/or metadata.
-     * @param indexName - The name of the index containing the vector.
-     * @param id - The ID of the vector to update.
-     * @param update - An object containing the vector and/or metadata to update.
-     * @param update.vector - An optional array of numbers representing the new vector.
-     * @param update.metadata - An optional record containing the new metadata.
-     * @returns A promise that resolves when the update is complete.
-     * @throws Will throw an error if no updates are provided or if the update operation fails.
-     */
-    updateVector(...args: ParamsToArgs<UpdateVectorParams>): Promise<void>;
-    /**
-     * @deprecated Use {@link deleteVector} instead. This method will be removed on May 20th, 2025.
-     *
-     * Deletes a vector by its ID.
-     * @param indexName - The name of the index containing the vector.
-     * @param id - The ID of the vector to delete.
-     * @returns A promise that resolves when the deletion is complete.
-     * @throws Will throw an error if the deletion operation fails.
-     */
-    deleteIndexById(indexName: string, id: string): Promise<void>;
-    /**
-     * Deletes a vector by its ID.
-     * @param indexName - The name of the index containing the vector.
-     * @param id - The ID of the vector to delete.
-     * @returns A promise that resolves when the deletion is complete.
-     * @throws Will throw an error if the deletion operation fails.
-     */
-    deleteVector(...args: ParamsToArgs<DeleteVectorParams>): Promise<void>;
-}
-export { OpenSearchVector }
-export { OpenSearchVector as OpenSearchVector_alias_1 }
-
-export { }

package/dist/_tsup-dts-rollup.d.ts

@@ -1,186 +0,0 @@
-import { BaseFilterTranslator } from '@mastra/core/vector/filter';
-import type { CreateIndexParams } from '@mastra/core';
-import type { DeleteIndexParams } from '@mastra/core';
-import type { DeleteVectorParams } from '@mastra/core';
-import type { DescribeIndexParams } from '@mastra/core';
-import type { IndexStats } from '@mastra/core';
-import { MastraVector } from '@mastra/core/vector';
-import type { OperatorSupport } from '@mastra/core/vector/filter';
-import type { ParamsToArgs } from '@mastra/core';
-import type { QueryResult } from '@mastra/core';
-import type { QueryVectorParams } from '@mastra/core';
-import type { UpdateVectorParams } from '@mastra/core';
-import type { UpsertVectorParams } from '@mastra/core';
-import type { VectorFilter } from '@mastra/core/vector/filter';
-
-/**
- * Translator for OpenSearch filter queries.
- * Maintains OpenSearch-compatible syntax while ensuring proper validation
- * and normalization of values.
- */
-export declare class OpenSearchFilterTranslator extends BaseFilterTranslator {
-    protected getSupportedOperators(): OperatorSupport;
-    translate(filter?: VectorFilter): VectorFilter;
-    private translateNode;
-    /**
-     * Handles translation of nested objects with dot notation fields
-     */
-    private translateNestedObject;
-    private translateLogicalOperator;
-    private translateFieldOperator;
-    /**
-     * Translates regex patterns to OpenSearch query syntax
-     */
-    private translateRegexOperator;
-    private addKeywordIfNeeded;
-    /**
-     * Helper method to handle special cases for the $not operator
-     */
-    private handleNotOperatorSpecialCases;
-    private translateOperator;
-    /**
-     * Translates field conditions to OpenSearch query syntax
-     * Handles special cases like range queries and multiple operators
-     */
-    private translateFieldConditions;
-    /**
-     * Checks if conditions can be optimized to a range query
-     */
-    private canOptimizeToRangeQuery;
-    /**
-     * Creates a range query from numeric operators
-     */
-    private createRangeQuery;
-}
-
-declare class OpenSearchVector extends MastraVector {
-    private client;
-    /**
-     * @deprecated Passing a string URL is deprecated. Use an object parameter: { url }.
-     * @param url - The OpenSearch node URL (deprecated)
-     */
-    constructor(url: string);
-    /**
-     * Creates a new OpenSearchVector client.
-     *
-     * @param params - An object with a url property specifying the OpenSearch node.
-     */
-    constructor(params: {
-        url: string;
-    });
-    /**
-     * Creates a new collection with the specified configuration.
-     *
-     * @param {string} indexName - The name of the collection to create.
-     * @param {number} dimension - The dimension of the vectors to be stored in the collection.
-     * @param {'cosine' | 'euclidean' | 'dotproduct'} [metric=cosine] - The metric to use to sort vectors in the collection.
-     * @returns {Promise<void>} A promise that resolves when the collection is created.
-     */
-    createIndex(params: CreateIndexParams): Promise<void>;
-    /**
-     * Lists all indexes.
-     *
-     * @returns {Promise<string[]>} A promise that resolves to an array of indexes.
-     */
-    listIndexes(): Promise<string[]>;
-    /**
-     * Retrieves statistics about a vector index.
-     *
-     * @param params - The parameters for describing an index
-     * @param params.indexName - The name of the index to describe
-     * @returns A promise that resolves to the index statistics including dimension, count and metric
-     */
-    describeIndex(...args: ParamsToArgs<DescribeIndexParams>): Promise<IndexStats>;
-    /**
-     * Deletes the specified index.
-     *
-     * @param {string} indexName - The name of the index to delete.
-     * @returns {Promise<void>} A promise that resolves when the index is deleted.
-     */
-    deleteIndex(...args: ParamsToArgs<DeleteIndexParams>): Promise<void>;
-    /**
-     * Inserts or updates vectors in the specified collection.
-     *
-     * @param {string} indexName - The name of the collection to upsert into.
-     * @param {number[][]} vectors - An array of vectors to upsert.
-     * @param {Record<string, any>[]} [metadata] - An optional array of metadata objects corresponding to each vector.
-     * @param {string[]} [ids] - An optional array of IDs corresponding to each vector. If not provided, new IDs will be generated.
-     * @returns {Promise<string[]>} A promise that resolves to an array of IDs of the upserted vectors.
-     */
-    upsert(params: UpsertVectorParams): Promise<string[]>;
-    /**
-     * Queries the specified collection using a vector and optional filter.
-     *
-     * @param {string} indexName - The name of the collection to query.
-     * @param {number[]} queryVector - The vector to query with.
-     * @param {number} [topK] - The maximum number of results to return.
-     * @param {Record<string, any>} [filter] - An optional filter to apply to the query. For more on filters in OpenSearch, see the filtering reference: https://opensearch.org/docs/latest/query-dsl/
-     * @param {boolean} [includeVectors=false] - Whether to include the vectors in the response.
-     * @returns {Promise<QueryResult[]>} A promise that resolves to an array of query results.
-     */
-    query(params: QueryVectorParams): Promise<QueryResult[]>;
-    /**
-     * Validates the dimensions of the vectors.
-     *
-     * @param {number[][]} vectors - The vectors to validate.
-     * @param {number} dimension - The dimension of the vectors.
-     * @returns {void}
-     */
-    private validateVectorDimensions;
-    /**
-     * Transforms the filter to the OpenSearch DSL.
-     *
-     * @param {VectorFilter} filter - The filter to transform.
-     * @returns {Record<string, any>} The transformed filter.
-     */
-    private transformFilter;
-    /**
-     * @deprecated Use {@link updateVector} instead. This method will be removed on May 20th, 2025.
-     *
-     * Updates a vector by its ID with the provided vector and/or metadata.
-     * @param indexName - The name of the index containing the vector.
-     * @param id - The ID of the vector to update.
-     * @param update - An object containing the vector and/or metadata to update.
-     * @param update.vector - An optional array of numbers representing the new vector.
-     * @param update.metadata - An optional record containing the new metadata.
-     * @returns A promise that resolves when the update is complete.
-     * @throws Will throw an error if no updates are provided or if the update operation fails.
-     */
-    updateIndexById(indexName: string, id: string, update: {
-        vector?: number[];
-        metadata?: Record<string, any>;
-    }): Promise<void>;
-    /**
-     * Updates a vector by its ID with the provided vector and/or metadata.
-     * @param indexName - The name of the index containing the vector.
-     * @param id - The ID of the vector to update.
-     * @param update - An object containing the vector and/or metadata to update.
-     * @param update.vector - An optional array of numbers representing the new vector.
-     * @param update.metadata - An optional record containing the new metadata.
-     * @returns A promise that resolves when the update is complete.
-     * @throws Will throw an error if no updates are provided or if the update operation fails.
-     */
-    updateVector(...args: ParamsToArgs<UpdateVectorParams>): Promise<void>;
-    /**
-     * @deprecated Use {@link deleteVector} instead. This method will be removed on May 20th, 2025.
-     *
-     * Deletes a vector by its ID.
-     * @param indexName - The name of the index containing the vector.
-     * @param id - The ID of the vector to delete.
-     * @returns A promise that resolves when the deletion is complete.
-     * @throws Will throw an error if the deletion operation fails.
-     */
-    deleteIndexById(indexName: string, id: string): Promise<void>;
-    /**
-     * Deletes a vector by its ID.
-     * @param indexName - The name of the index containing the vector.
-     * @param id - The ID of the vector to delete.
-     * @returns A promise that resolves when the deletion is complete.
-     * @throws Will throw an error if the deletion operation fails.
-     */
-    deleteVector(...args: ParamsToArgs<DeleteVectorParams>): Promise<void>;
-}
-export { OpenSearchVector }
-export { OpenSearchVector as OpenSearchVector_alias_1 }
-
-export { }

package/dist/index.d.cts

@@ -1 +0,0 @@
-export { OpenSearchVector } from './_tsup-dts-rollup.cjs';

package/docker-compose.yaml

@@ -1,23 +0,0 @@
-version: '3.8'
-
-services:
-  opensearch:
-    image: opensearchproject/opensearch:latest
-    ports:
-      - '9200:9200'
-    volumes:
-      - opensearch_data:/usr/share/opensearch/data
-    environment:
-      - discovery.type=single-node
-      - OPENSEARCH_JAVA_OPTS=-Xms512m -Xmx512m
-      - bootstrap.memory_lock=true
-      - DISABLE_SECURITY_PLUGIN=true
-    ulimits:
-      memlock:
-        soft: -1
-        hard: -1
-    restart: always
-
-volumes:
-  opensearch_data:
-    driver: local

package/eslint.config.js

@@ -1,6 +0,0 @@
-import { createConfig } from '@internal/lint/eslint';
-
-const config = await createConfig();
-
-/** @type {import("eslint").Linter.Config[]} */
-export default [...config];

package/src/index.ts

@@ -1 +0,0 @@
-export * from './vector';