@mastra/pg 0.3.4 → 0.3.5-alpha.0

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.3.5-alpha.0 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 9464ms
 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 12331ms
 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
+CJS dist/index.cjs 61.67 KB
+CJS ⚡️ Build success in 1494ms
+ESM dist/index.js 61.16 KB
+ESM ⚡️ Build success in 1495ms

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @mastra/pg
 
+## 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,26 @@
-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 +60,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 +68,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 +106,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,10 +125,6 @@ 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 {
@@ -224,7 +208,7 @@ declare class PgVector extends MastraVector {
     private getMutexByName;
     private getTableName;
     transformFilter(filter?: VectorFilter): VectorFilter;
-    getIndexInfo(indexName: string): Promise<PGIndexStats>;
+    getIndexInfo(...args: ParamsToArgs<DescribeIndexParams>): Promise<PGIndexStats>;
     query(...args: ParamsToArgs<PgQueryVectorParams> | PgQueryVectorArgs): Promise<QueryResult[]>;
     upsert(...args: ParamsToArgs<UpsertVectorParams>): Promise<string[]>;
     private hasher;
@@ -241,9 +225,16 @@ declare class PgVector extends MastraVector {
     private setupIndex;
     private installVectorExtension;
     listIndexes(): Promise<string[]>;
-    describeIndex(indexName: string): Promise<PGIndexStats>;
-    deleteIndex(indexName: string): Promise<void>;
-    truncateIndex(indexName: string): Promise<void>;
+    /**
+     * 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<PGIndexStats>;
+    deleteIndex(...args: ParamsToArgs<DeleteIndexParams>): Promise<void>;
+    truncateIndex(...args: ParamsToArgs<DeleteIndexParams>): Promise<void>;
     disconnect(): Promise<void>;
     /**
      * @deprecated Use {@link updateVector} instead. This method will be removed on May 20th, 2025.
@@ -271,10 +262,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>;
+    updateVector(...args: ParamsToArgs<UpdateVectorParams>): Promise<void>;
     /**
      * @deprecated Use {@link deleteVector} instead. This method will be removed on May 20th, 2025.
      *
@@ -292,7 +280,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(...args: ParamsToArgs<DeleteVectorParams>): Promise<void>;
 }
 export { PgVector }
 export { PgVector as PgVector_alias_1 }

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

@@ -1,28 +1,26 @@
-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 +60,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 +68,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 +106,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,10 +125,6 @@ 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 {
@@ -224,7 +208,7 @@ declare class PgVector extends MastraVector {
     private getMutexByName;
     private getTableName;
     transformFilter(filter?: VectorFilter): VectorFilter;
-    getIndexInfo(indexName: string): Promise<PGIndexStats>;
+    getIndexInfo(...args: ParamsToArgs<DescribeIndexParams>): Promise<PGIndexStats>;
     query(...args: ParamsToArgs<PgQueryVectorParams> | PgQueryVectorArgs): Promise<QueryResult[]>;
     upsert(...args: ParamsToArgs<UpsertVectorParams>): Promise<string[]>;
     private hasher;
@@ -241,9 +225,16 @@ declare class PgVector extends MastraVector {
     private setupIndex;
     private installVectorExtension;
     listIndexes(): Promise<string[]>;
-    describeIndex(indexName: string): Promise<PGIndexStats>;
-    deleteIndex(indexName: string): Promise<void>;
-    truncateIndex(indexName: string): Promise<void>;
+    /**
+     * 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<PGIndexStats>;
+    deleteIndex(...args: ParamsToArgs<DeleteIndexParams>): Promise<void>;
+    truncateIndex(...args: ParamsToArgs<DeleteIndexParams>): Promise<void>;
     disconnect(): Promise<void>;
     /**
      * @deprecated Use {@link updateVector} instead. This method will be removed on May 20th, 2025.
@@ -271,10 +262,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>;
+    updateVector(...args: ParamsToArgs<UpdateVectorParams>): Promise<void>;
     /**
      * @deprecated Use {@link deleteVector} instead. This method will be removed on May 20th, 2025.
      *
@@ -292,7 +280,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(...args: ParamsToArgs<DeleteVectorParams>): Promise<void>;
 }
 export { PgVector }
 export { PgVector as PgVector_alias_1 }