@mastra/pg 0.3.4 → 0.4.0-alpha.1

package/.turbo/turbo-build.log

@@ -1,23 +1,23 @@
 
-> @mastra/pg@0.3.4-alpha.5 build /home/runner/work/mastra/mastra/stores/pg
+> @mastra/pg@0.4.0-alpha.1 build /home/runner/work/mastra/mastra/stores/pg
 > tsup src/index.ts --format esm,cjs --experimental-dts --clean --treeshake=smallest --splitting
 
 CLI Building entry: src/index.ts
 CLI Using tsconfig: tsconfig.json
 CLI tsup v8.4.0
 TSC Build start
-TSC ⚡️ Build success in 11030ms
+TSC ⚡️ Build success in 9665ms
 DTS Build start
 CLI Target: es2022
 Analysis will use the bundled TypeScript version 5.8.3
 Writing package typings: /home/runner/work/mastra/mastra/stores/pg/dist/_tsup-dts-rollup.d.ts
 Analysis will use the bundled TypeScript version 5.8.3
 Writing package typings: /home/runner/work/mastra/mastra/stores/pg/dist/_tsup-dts-rollup.d.cts
-DTS ⚡️ Build success in 11568ms
+DTS ⚡️ Build success in 11950ms
 CLI Cleaning output folder
 ESM Build start
 CJS Build start
-ESM dist/index.js 58.39 KB
-ESM ⚡️ Build success in 1536ms
-CJS dist/index.cjs 58.86 KB
-CJS ⚡️ Build success in 1537ms
+ESM dist/index.js 57.30 KB
+ESM ⚡️ Build success in 1505ms
+CJS dist/index.cjs 57.80 KB
+CJS ⚡️ Build success in 1505ms

package/CHANGELOG.md

@@ -1,5 +1,42 @@
 # @mastra/pg
 
+## 0.4.0-alpha.1
+
+### Minor Changes
+
+- 83da932: Move @mastra/core to peerdeps
+
+### Patch Changes
+
+- b3a3d63: BREAKING: Make vnext workflow the default worklow, and old workflow legacy_workflow
+- a7292b0: BREAKING(@mastra/core, all vector stores): Vector store breaking changes (remove deprecated functions and positional arguments)
+- Updated dependencies [b3a3d63]
+- Updated dependencies [344f453]
+- Updated dependencies [0a3ae6d]
+- Updated dependencies [95911be]
+- Updated dependencies [5eb5a99]
+- Updated dependencies [7e632c5]
+- Updated dependencies [1e9fbfa]
+- Updated dependencies [b2ae5aa]
+- Updated dependencies [a7292b0]
+- Updated dependencies [0dcb9f0]
+  - @mastra/core@0.10.0-alpha.1
+
+## 0.3.5-alpha.0
+
+### Patch Changes
+
+- eabdcd9: [MASTRA-3451] SQL Injection Protection
+- d0ee3c6: Change all public functions and constructors in vector stores to use named args and prepare to phase out positional args
+- Updated dependencies [f53a6ac]
+- Updated dependencies [eabdcd9]
+- Updated dependencies [90be034]
+- Updated dependencies [99f050a]
+- Updated dependencies [d0ee3c6]
+- Updated dependencies [23f258c]
+- Updated dependencies [2672a05]
+  - @mastra/core@0.9.5-alpha.0
+
 ## 0.3.4
 
 ### Patch Changes

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

@@ -1,28 +1,23 @@
-import type { ArrayOperator } from '@mastra/core/vector/filter';
 import { BaseFilterTranslator } from '@mastra/core/vector/filter';
-import type { BasicOperator } from '@mastra/core/vector/filter';
-import type { CreateIndexArgs } from '@mastra/core/vector';
 import type { CreateIndexParams } from '@mastra/core/vector';
-import type { ElementOperator } from '@mastra/core/vector/filter';
+import type { DeleteIndexParams } from '@mastra/core/vector';
+import type { DeleteVectorParams } from '@mastra/core/vector';
+import type { DescribeIndexParams } from '@mastra/core/vector';
 import type { EvalRow } from '@mastra/core/storage';
 import type { IndexStats } from '@mastra/core/vector';
 import type { ISSLConfig } from 'pg-promise/typescript/pg-subset';
-import type { LogicalOperator } from '@mastra/core/vector/filter';
 import { MastraStorage } from '@mastra/core/storage';
 import { MastraVector } from '@mastra/core/vector';
 import type { MessageType } from '@mastra/core/memory';
-import type { NumericOperator } from '@mastra/core/vector/filter';
 import type { OperatorSupport } from '@mastra/core/vector/filter';
-import type { ParamsToArgs } from '@mastra/core/vector';
 import pg from 'pg';
 import type { QueryResult } from '@mastra/core/vector';
-import type { QueryVectorArgs } from '@mastra/core/vector';
 import type { QueryVectorParams } from '@mastra/core/vector';
-import type { RegexOperator } from '@mastra/core/vector/filter';
 import type { StorageColumn } from '@mastra/core/storage';
 import type { StorageGetMessagesArg } from '@mastra/core/storage';
 import type { StorageThreadType } from '@mastra/core/memory';
 import type { TABLE_NAMES } from '@mastra/core/storage';
+import type { UpdateVectorParams } from '@mastra/core/vector';
 import type { UpsertVectorParams } from '@mastra/core/vector';
 import type { VectorFilter } from '@mastra/core/vector/filter';
 import type { WorkflowRun } from '@mastra/core/storage';
@@ -62,7 +57,7 @@ export declare const baseTestConfigs: {
     }[];
 };
 
-export declare function buildFilterQuery(filter: VectorFilter, minScore: number): FilterResult;
+export declare function buildFilterQuery(filter: VectorFilter, minScore: number, topK: number): FilterResult;
 
 export declare const calculateRecall: (actual: number[], expected: number[], k: number) => number;
 
@@ -70,15 +65,7 @@ export declare const calculateTimeout: (dimension: number, size: number, k: numb
 
 export declare function cosineSimilarity(a: number[], b: number[]): number;
 
-export declare const FILTER_OPERATORS: Record<string, OperatorFn>;
-
-declare type FilterOperator = {
-    sql: string;
-    needsValue: boolean;
-    transformValue?: () => any;
-};
-
-export declare interface FilterResult {
+declare interface FilterResult {
     sql: string;
     values: any[];
 }
@@ -116,8 +103,6 @@ export declare function getSearchEf(k: number, m: number): {
 
 export declare const groupBy: <T, K extends keyof T>(array: T[], key: K | ((item: T) => string), reducer?: (group: T[]) => any) => Record<string, any>;
 
-export declare const handleKey: (key: string) => string;
-
 declare interface HNSWConfig {
     m?: number;
     efConstruction?: number;
@@ -137,19 +122,11 @@ declare interface IVFConfig {
 
 export declare function measureLatency<T>(fn: () => Promise<T>): Promise<[number, T]>;
 
-declare type OperatorFn = (key: string, paramIndex: number, value?: any) => FilterOperator;
-
-export declare type OperatorType = BasicOperator | NumericOperator | ArrayOperator | ElementOperator | LogicalOperator | '$contains' | Exclude<RegexOperator, '$options'>;
-
-declare type PgCreateIndexArgs = [...CreateIndexArgs, IndexConfig?, boolean?];
-
 declare interface PgCreateIndexParams extends CreateIndexParams {
     indexConfig?: IndexConfig;
     buildIndex?: boolean;
 }
 
-declare type PgDefineIndexArgs = [string, 'cosine' | 'euclidean' | 'dotproduct', IndexConfig];
-
 declare interface PgDefineIndexParams {
     indexName: string;
     metric: 'cosine' | 'euclidean' | 'dotproduct';
@@ -185,8 +162,6 @@ declare interface PGIndexStats extends IndexStats {
 export { PGIndexStats }
 export { PGIndexStats as PGIndexStats_alias_1 }
 
-declare type PgQueryVectorArgs = [...QueryVectorArgs, number?, number?, number?];
-
 declare interface PgQueryVectorParams extends QueryVectorParams {
     minScore?: number;
     /**
@@ -211,12 +186,7 @@ declare class PgVector extends MastraVector {
     private installVectorExtensionPromise;
     private vectorExtensionInstalled;
     private schemaSetupComplete;
-    /**
-     * @deprecated Passing connectionString as a string is deprecated.
-     * Use the object parameter instead. This signature will be removed on May 20th, 2025.
-     */
-    constructor(connectionString: string);
-    constructor(config: {
+    constructor({ connectionString, schemaName, pgPoolOptions, }: {
         connectionString: string;
         schemaName?: string;
         pgPoolOptions?: Omit<pg.PoolConfig, 'connectionString'>;
@@ -224,43 +194,28 @@ declare class PgVector extends MastraVector {
     private getMutexByName;
     private getTableName;
     transformFilter(filter?: VectorFilter): VectorFilter;
-    getIndexInfo(indexName: string): Promise<PGIndexStats>;
-    query(...args: ParamsToArgs<PgQueryVectorParams> | PgQueryVectorArgs): Promise<QueryResult[]>;
-    upsert(...args: ParamsToArgs<UpsertVectorParams>): Promise<string[]>;
+    getIndexInfo({ indexName }: DescribeIndexParams): Promise<PGIndexStats>;
+    query({ indexName, queryVector, topK, filter, includeVector, minScore, ef, probes, }: PgQueryVectorParams): Promise<QueryResult[]>;
+    upsert({ indexName, vectors, metadata, ids }: UpsertVectorParams): Promise<string[]>;
     private hasher;
     private getIndexCacheKey;
     private cachedIndexExists;
     private setupSchema;
-    createIndex(...args: ParamsToArgs<PgCreateIndexParams> | PgCreateIndexArgs): Promise<void>;
-    /**
-     * @deprecated This function is deprecated. Use buildIndex instead
-     * This function will be removed on May 20th, 2025
-     */
-    defineIndex(indexName: string, metric: "cosine" | "euclidean" | "dotproduct" | undefined, indexConfig: IndexConfig): Promise<void>;
-    buildIndex(...args: ParamsToArgs<PgDefineIndexParams> | PgDefineIndexArgs): Promise<void>;
+    createIndex({ indexName, dimension, metric, indexConfig, buildIndex, }: PgCreateIndexParams): Promise<void>;
+    buildIndex({ indexName, metric, indexConfig }: PgDefineIndexParams): Promise<void>;
     private setupIndex;
     private installVectorExtension;
     listIndexes(): Promise<string[]>;
-    describeIndex(indexName: string): Promise<PGIndexStats>;
-    deleteIndex(indexName: string): Promise<void>;
-    truncateIndex(indexName: string): Promise<void>;
-    disconnect(): Promise<void>;
     /**
-     * @deprecated Use {@link updateVector} instead. This method will be removed on May 20th, 2025.
+     * Retrieves statistics about a vector index.
      *
-     * 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.
+     * @param {string} indexName - The name of the index to describe
+     * @returns A promise that resolves to the index statistics including dimension, count and metric
      */
-    updateIndexById(indexName: string, id: string, update: {
-        vector?: number[];
-        metadata?: Record<string, any>;
-    }): Promise<void>;
+    describeIndex({ indexName }: DescribeIndexParams): Promise<PGIndexStats>;
+    deleteIndex({ indexName }: DeleteIndexParams): Promise<void>;
+    truncateIndex({ indexName }: DeleteIndexParams): Promise<void>;
+    disconnect(): 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.
@@ -271,20 +226,7 @@ declare class PgVector extends MastraVector {
      * @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: string, id: string, update: {
-        vector?: number[];
-        metadata?: Record<string, any>;
-    }): 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>;
+    updateVector({ indexName, id, update }: UpdateVectorParams): Promise<void>;
     /**
      * Deletes a vector by its ID.
      * @param indexName - The name of the index containing the vector.
@@ -292,7 +234,7 @@ declare class PgVector extends MastraVector {
      * @returns A promise that resolves when the deletion is complete.
      * @throws Will throw an error if the deletion operation fails.
      */
-    deleteVector(indexName: string, id: string): Promise<void>;
+    deleteVector({ indexName, id }: DeleteVectorParams): Promise<void>;
 }
 export { PgVector }
 export { PgVector as PgVector_alias_1 }
@@ -307,10 +249,6 @@ export { PGVECTOR_PROMPT as PGVECTOR_PROMPT_alias_1 }
 
 declare type PostgresConfig = {
     schemaName?: string;
-    /**
-     * @deprecated Use `schemaName` instead. Support for `schema` will be removed on May 20th, 2025.
-     */
-    schema?: string;
 } & ({
     host: string;
     port: number;

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

@@ -1,28 +1,23 @@
-import type { ArrayOperator } from '@mastra/core/vector/filter';
 import { BaseFilterTranslator } from '@mastra/core/vector/filter';
-import type { BasicOperator } from '@mastra/core/vector/filter';
-import type { CreateIndexArgs } from '@mastra/core/vector';
 import type { CreateIndexParams } from '@mastra/core/vector';
-import type { ElementOperator } from '@mastra/core/vector/filter';
+import type { DeleteIndexParams } from '@mastra/core/vector';
+import type { DeleteVectorParams } from '@mastra/core/vector';
+import type { DescribeIndexParams } from '@mastra/core/vector';
 import type { EvalRow } from '@mastra/core/storage';
 import type { IndexStats } from '@mastra/core/vector';
 import type { ISSLConfig } from 'pg-promise/typescript/pg-subset';
-import type { LogicalOperator } from '@mastra/core/vector/filter';
 import { MastraStorage } from '@mastra/core/storage';
 import { MastraVector } from '@mastra/core/vector';
 import type { MessageType } from '@mastra/core/memory';
-import type { NumericOperator } from '@mastra/core/vector/filter';
 import type { OperatorSupport } from '@mastra/core/vector/filter';
-import type { ParamsToArgs } from '@mastra/core/vector';
 import pg from 'pg';
 import type { QueryResult } from '@mastra/core/vector';
-import type { QueryVectorArgs } from '@mastra/core/vector';
 import type { QueryVectorParams } from '@mastra/core/vector';
-import type { RegexOperator } from '@mastra/core/vector/filter';
 import type { StorageColumn } from '@mastra/core/storage';
 import type { StorageGetMessagesArg } from '@mastra/core/storage';
 import type { StorageThreadType } from '@mastra/core/memory';
 import type { TABLE_NAMES } from '@mastra/core/storage';
+import type { UpdateVectorParams } from '@mastra/core/vector';
 import type { UpsertVectorParams } from '@mastra/core/vector';
 import type { VectorFilter } from '@mastra/core/vector/filter';
 import type { WorkflowRun } from '@mastra/core/storage';
@@ -62,7 +57,7 @@ export declare const baseTestConfigs: {
     }[];
 };
 
-export declare function buildFilterQuery(filter: VectorFilter, minScore: number): FilterResult;
+export declare function buildFilterQuery(filter: VectorFilter, minScore: number, topK: number): FilterResult;
 
 export declare const calculateRecall: (actual: number[], expected: number[], k: number) => number;
 
@@ -70,15 +65,7 @@ export declare const calculateTimeout: (dimension: number, size: number, k: numb
 
 export declare function cosineSimilarity(a: number[], b: number[]): number;
 
-export declare const FILTER_OPERATORS: Record<string, OperatorFn>;
-
-declare type FilterOperator = {
-    sql: string;
-    needsValue: boolean;
-    transformValue?: () => any;
-};
-
-export declare interface FilterResult {
+declare interface FilterResult {
     sql: string;
     values: any[];
 }
@@ -116,8 +103,6 @@ export declare function getSearchEf(k: number, m: number): {
 
 export declare const groupBy: <T, K extends keyof T>(array: T[], key: K | ((item: T) => string), reducer?: (group: T[]) => any) => Record<string, any>;
 
-export declare const handleKey: (key: string) => string;
-
 declare interface HNSWConfig {
     m?: number;
     efConstruction?: number;
@@ -137,19 +122,11 @@ declare interface IVFConfig {
 
 export declare function measureLatency<T>(fn: () => Promise<T>): Promise<[number, T]>;
 
-declare type OperatorFn = (key: string, paramIndex: number, value?: any) => FilterOperator;
-
-export declare type OperatorType = BasicOperator | NumericOperator | ArrayOperator | ElementOperator | LogicalOperator | '$contains' | Exclude<RegexOperator, '$options'>;
-
-declare type PgCreateIndexArgs = [...CreateIndexArgs, IndexConfig?, boolean?];
-
 declare interface PgCreateIndexParams extends CreateIndexParams {
     indexConfig?: IndexConfig;
     buildIndex?: boolean;
 }
 
-declare type PgDefineIndexArgs = [string, 'cosine' | 'euclidean' | 'dotproduct', IndexConfig];
-
 declare interface PgDefineIndexParams {
     indexName: string;
     metric: 'cosine' | 'euclidean' | 'dotproduct';
@@ -185,8 +162,6 @@ declare interface PGIndexStats extends IndexStats {
 export { PGIndexStats }
 export { PGIndexStats as PGIndexStats_alias_1 }
 
-declare type PgQueryVectorArgs = [...QueryVectorArgs, number?, number?, number?];
-
 declare interface PgQueryVectorParams extends QueryVectorParams {
     minScore?: number;
     /**
@@ -211,12 +186,7 @@ declare class PgVector extends MastraVector {
     private installVectorExtensionPromise;
     private vectorExtensionInstalled;
     private schemaSetupComplete;
-    /**
-     * @deprecated Passing connectionString as a string is deprecated.
-     * Use the object parameter instead. This signature will be removed on May 20th, 2025.
-     */
-    constructor(connectionString: string);
-    constructor(config: {
+    constructor({ connectionString, schemaName, pgPoolOptions, }: {
         connectionString: string;
         schemaName?: string;
         pgPoolOptions?: Omit<pg.PoolConfig, 'connectionString'>;
@@ -224,43 +194,28 @@ declare class PgVector extends MastraVector {
     private getMutexByName;
     private getTableName;
     transformFilter(filter?: VectorFilter): VectorFilter;
-    getIndexInfo(indexName: string): Promise<PGIndexStats>;
-    query(...args: ParamsToArgs<PgQueryVectorParams> | PgQueryVectorArgs): Promise<QueryResult[]>;
-    upsert(...args: ParamsToArgs<UpsertVectorParams>): Promise<string[]>;
+    getIndexInfo({ indexName }: DescribeIndexParams): Promise<PGIndexStats>;
+    query({ indexName, queryVector, topK, filter, includeVector, minScore, ef, probes, }: PgQueryVectorParams): Promise<QueryResult[]>;
+    upsert({ indexName, vectors, metadata, ids }: UpsertVectorParams): Promise<string[]>;
     private hasher;
     private getIndexCacheKey;
     private cachedIndexExists;
     private setupSchema;
-    createIndex(...args: ParamsToArgs<PgCreateIndexParams> | PgCreateIndexArgs): Promise<void>;
-    /**
-     * @deprecated This function is deprecated. Use buildIndex instead
-     * This function will be removed on May 20th, 2025
-     */
-    defineIndex(indexName: string, metric: "cosine" | "euclidean" | "dotproduct" | undefined, indexConfig: IndexConfig): Promise<void>;
-    buildIndex(...args: ParamsToArgs<PgDefineIndexParams> | PgDefineIndexArgs): Promise<void>;
+    createIndex({ indexName, dimension, metric, indexConfig, buildIndex, }: PgCreateIndexParams): Promise<void>;
+    buildIndex({ indexName, metric, indexConfig }: PgDefineIndexParams): Promise<void>;
     private setupIndex;
     private installVectorExtension;
     listIndexes(): Promise<string[]>;
-    describeIndex(indexName: string): Promise<PGIndexStats>;
-    deleteIndex(indexName: string): Promise<void>;
-    truncateIndex(indexName: string): Promise<void>;
-    disconnect(): Promise<void>;
     /**
-     * @deprecated Use {@link updateVector} instead. This method will be removed on May 20th, 2025.
+     * Retrieves statistics about a vector index.
      *
-     * 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.
+     * @param {string} indexName - The name of the index to describe
+     * @returns A promise that resolves to the index statistics including dimension, count and metric
      */
-    updateIndexById(indexName: string, id: string, update: {
-        vector?: number[];
-        metadata?: Record<string, any>;
-    }): Promise<void>;
+    describeIndex({ indexName }: DescribeIndexParams): Promise<PGIndexStats>;
+    deleteIndex({ indexName }: DeleteIndexParams): Promise<void>;
+    truncateIndex({ indexName }: DeleteIndexParams): Promise<void>;
+    disconnect(): 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.
@@ -271,20 +226,7 @@ declare class PgVector extends MastraVector {
      * @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: string, id: string, update: {
-        vector?: number[];
-        metadata?: Record<string, any>;
-    }): 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>;
+    updateVector({ indexName, id, update }: UpdateVectorParams): Promise<void>;
     /**
      * Deletes a vector by its ID.
      * @param indexName - The name of the index containing the vector.
@@ -292,7 +234,7 @@ declare class PgVector extends MastraVector {
      * @returns A promise that resolves when the deletion is complete.
      * @throws Will throw an error if the deletion operation fails.
      */
-    deleteVector(indexName: string, id: string): Promise<void>;
+    deleteVector({ indexName, id }: DeleteVectorParams): Promise<void>;
 }
 export { PgVector }
 export { PgVector as PgVector_alias_1 }
@@ -307,10 +249,6 @@ export { PGVECTOR_PROMPT as PGVECTOR_PROMPT_alias_1 }
 
 declare type PostgresConfig = {
     schemaName?: string;
-    /**
-     * @deprecated Use `schemaName` instead. Support for `schema` will be removed on May 20th, 2025.
-     */
-    schema?: string;
 } & ({
     host: string;
     port: number;