@mastra/pg 0.3.5-alpha.0 → 0.10.0

package/dist/index.js

@@ -362,27 +362,11 @@ var PgVector = class extends MastraVector {
   installVectorExtensionPromise = null;
   vectorExtensionInstalled = void 0;
   schemaSetupComplete = void 0;
-  constructor(config) {
-    let connectionString;
-    let pgPoolOptions;
-    let schemaName;
-    if (typeof config === "string") {
-      console.warn(
-        `DEPRECATION WARNING: Passing connectionString as a string to PgVector constructor is deprecated.
-
-        Please use an object parameter instead:
-        new PgVector({ connectionString })
-
-        The string signature will be removed on May 20th, 2025.`
-      );
-      connectionString = config;
-      schemaName = void 0;
-      pgPoolOptions = void 0;
-    } else {
-      connectionString = config.connectionString;
-      schemaName = config.schemaName;
-      pgPoolOptions = config.pgPoolOptions;
-    }
+  constructor({
+    connectionString,
+    schemaName,
+    pgPoolOptions
+  }) {
     if (!connectionString || connectionString.trim() === "") {
       throw new Error(
         "PgVector: connectionString must be provided and cannot be empty. Passing an empty string may cause fallback to local Postgres defaults."
@@ -434,21 +418,22 @@ var PgVector = class extends MastraVector {
     const translator = new PGFilterTranslator();
     return translator.translate(filter);
   }
-  async getIndexInfo(...args) {
-    const params = this.normalizeArgs("getIndexInfo", args);
-    const { indexName } = params;
+  async getIndexInfo({ indexName }) {
     if (!this.describeIndexCache.has(indexName)) {
       this.describeIndexCache.set(indexName, await this.describeIndex({ indexName }));
     }
     return this.describeIndexCache.get(indexName);
   }
-  async query(...args) {
-    const params = this.normalizeArgs("query", args, [
-      "minScore",
-      "ef",
-      "probes"
-    ]);
-    const { indexName, queryVector, topK = 10, filter, includeVector = false, minScore = 0, ef, probes } = params;
+  async query({
+    indexName,
+    queryVector,
+    topK = 10,
+    filter,
+    includeVector = false,
+    minScore = 0,
+    ef,
+    probes
+  }) {
     if (!Number.isInteger(topK) || topK <= 0) {
       throw new Error("topK must be a positive integer");
     }
@@ -496,9 +481,7 @@ var PgVector = class extends MastraVector {
       client.release();
     }
   }
-  async upsert(...args) {
-    const params = this.normalizeArgs("upsert", args);
-    const { indexName, vectors, metadata, ids } = params;
+  async upsert({ indexName, vectors, metadata, ids }) {
     const tableName = this.getTableName(indexName);
     const client = await this.pool.connect();
     try {
@@ -525,7 +508,7 @@ var PgVector = class extends MastraVector {
         if (match) {
           const [, expected, actual] = match;
           throw new Error(
-            `Vector dimension mismatch: Index "${params.indexName}" expects ${expected} dimensions but got ${actual} dimensions. Either use a matching embedding model or delete and recreate the index with the new dimension.`
+            `Vector dimension mismatch: Index "${indexName}" expects ${expected} dimensions but got ${actual} dimensions. Either use a matching embedding model or delete and recreate the index with the new dimension.`
           );
         }
       }
@@ -535,8 +518,13 @@ var PgVector = class extends MastraVector {
     }
   }
   hasher = xxhash();
-  async getIndexCacheKey(params) {
-    const input = params.indexName + params.dimension + params.metric + (params.type || "ivfflat");
+  async getIndexCacheKey({
+    indexName,
+    dimension,
+    metric,
+    type
+  }) {
+    const input = indexName + dimension + metric + (type || "ivfflat");
     return (await this.hasher).h32(input);
   }
   cachedIndexExists(indexName, newKey) {
@@ -584,12 +572,13 @@ var PgVector = class extends MastraVector {
     }
     await this.setupSchemaPromise;
   }
-  async createIndex(...args) {
-    const params = this.normalizeArgs("createIndex", args, [
-      "indexConfig",
-      "buildIndex"
-    ]);
-    const { indexName, dimension, metric = "cosine", indexConfig = {}, buildIndex = true } = params;
+  async createIndex({
+    indexName,
+    dimension,
+    metric = "cosine",
+    indexConfig = {},
+    buildIndex = true
+  }) {
     const tableName = this.getTableName(indexName);
     if (!indexName.match(/^[a-zA-Z_][a-zA-Z0-9_]*$/)) {
       throw new Error("Invalid index name format");
@@ -630,20 +619,7 @@ var PgVector = class extends MastraVector {
       }
     });
   }
-  /**
-   * @deprecated This function is deprecated. Use buildIndex instead
-   * This function will be removed on May 20th, 2025
-   */
-  async defineIndex(indexName, metric = "cosine", indexConfig) {
-    console.warn("defineIndex is deprecated. Use buildIndex instead. This function will be removed on May 20th, 2025");
-    return this.buildIndex({ indexName, metric, indexConfig });
-  }
-  async buildIndex(...args) {
-    const params = this.normalizeArgs("buildIndex", args, [
-      "metric",
-      "indexConfig"
-    ]);
-    const { indexName, metric = "cosine", indexConfig } = params;
+  async buildIndex({ indexName, metric = "cosine", indexConfig }) {
     const client = await this.pool.connect();
     try {
       await this.setupIndex({ indexName, metric, indexConfig }, client);
@@ -750,13 +726,10 @@ var PgVector = class extends MastraVector {
   /**
    * Retrieves statistics about a vector index.
    *
-   * @param params - The parameters for describing an index
-   * @param params.indexName - The name of the index to describe
+   * @param {string} indexName - The name of the index to describe
    * @returns A promise that resolves to the index statistics including dimension, count and metric
    */
-  async describeIndex(...args) {
-    const params = this.normalizeArgs("describeIndex", args);
-    const { indexName } = params;
+  async describeIndex({ indexName }) {
     const client = await this.pool.connect();
     try {
       const tableName = this.getTableName(indexName);
@@ -830,9 +803,7 @@ var PgVector = class extends MastraVector {
       client.release();
     }
   }
-  async deleteIndex(...args) {
-    const params = this.normalizeArgs("deleteIndex", args);
-    const { indexName } = params;
+  async deleteIndex({ indexName }) {
     const client = await this.pool.connect();
     try {
       const tableName = this.getTableName(indexName);
@@ -845,9 +816,7 @@ var PgVector = class extends MastraVector {
       client.release();
     }
   }
-  async truncateIndex(...args) {
-    const params = this.normalizeArgs("truncateIndex", args);
-    const { indexName } = params;
+  async truncateIndex({ indexName }) {
     const client = await this.pool.connect();
     try {
       const tableName = this.getTableName(indexName);
@@ -862,26 +831,6 @@ var PgVector = class extends MastraVector {
   async disconnect() {
     await this.pool.end();
   }
-  /**
-   * @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.
-   */
-  async updateIndexById(indexName, id, update) {
-    this.logger.warn(
-      `Deprecation Warning: updateIndexById() is deprecated. 
-      Please use updateVector() instead. 
-      updateIndexById() will be removed on May 20th, 2025.`
-    );
-    await this.updateVector({ indexName, id, update });
-  }
   /**
    * Updates a vector by its ID with the provided vector and/or metadata.
    * @param indexName - The name of the index containing the vector.
@@ -892,9 +841,7 @@ var PgVector = class 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.
    */
-  async updateVector(...args) {
-    const params = this.normalizeArgs("updateVector", args);
-    const { indexName, id, update } = params;
+  async updateVector({ indexName, id, update }) {
     if (!update.vector && !update.metadata) {
       throw new Error("No updates provided");
     }
@@ -929,32 +876,13 @@ var PgVector = class extends MastraVector {
     }
   }
   /**
-   * @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.
    */
-  async deleteIndexById(indexName, id) {
-    this.logger.warn(
-      `Deprecation Warning: deleteIndexById() is deprecated. 
-      Please use deleteVector() instead. 
-      deleteIndexById() will be removed on May 20th, 2025.`
-    );
-    await this.deleteVector({ indexName, id });
-  }
-  /**
-   * 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.
-   */
-  async deleteVector(...args) {
-    const params = this.normalizeArgs("deleteVector", args);
-    const { indexName, id } = params;
+  async deleteVector({ indexName, id }) {
     const client = await this.pool.connect();
     try {
       const tableName = this.getTableName(indexName);
@@ -995,12 +923,7 @@ var PostgresStore = class extends MastraStorage {
     }
     super({ name: "PostgresStore" });
     this.pgp = pgPromise();
-    if ("schema" in config && config.schema) {
-      console.warn(
-        '[DEPRECATION NOTICE] The "schema" option in PostgresStore is deprecated. Please use "schemaName" instead. Support for "schema" will be removed on May 20th, 2025.'
-      );
-    }
-    this.schema = config.schemaName ?? config.schema;
+    this.schema = config.schemaName;
     this.db = this.pgp(
       `connectionString` in config ? { connectionString: config.connectionString } : {
         host: config.host,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/pg",
-  "version": "0.3.5-alpha.0",
+  "version": "0.10.0",
   "description": "Postgres provider for Mastra - includes both vector and db storage capabilities",
   "type": "module",
   "main": "dist/index.js",
@@ -23,8 +23,7 @@
     "async-mutex": "^0.5.0",
     "pg": "^8.13.3",
     "pg-promise": "^11.11.0",
-    "xxhash-wasm": "^1.1.0",
-    "@mastra/core": "^0.9.5-alpha.0"
+    "xxhash-wasm": "^1.1.0"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.52.5",
@@ -34,7 +33,11 @@
     "tsup": "^8.4.0",
     "typescript": "^5.8.2",
     "vitest": "^3.1.2",
-    "@internal/lint": "0.0.5"
+    "@internal/lint": "0.0.6",
+    "@mastra/core": "0.10.0"
+  },
+  "peerDependencies": {
+    "@mastra/core": "^0.10.0"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --experimental-dts --clean --treeshake=smallest --splitting",

package/src/storage/index.test.ts

@@ -41,10 +41,7 @@ const createSampleMessage = (threadId: string): MessageType => ({
   createdAt: new Date(),
 });
 
-const createSampleWorkflowSnapshot = (
-  status: WorkflowRunState['context']['steps'][string]['status'],
-  createdAt?: Date,
-) => {
+const createSampleWorkflowSnapshot = (status: WorkflowRunState['context'][string]['status'], createdAt?: Date) => {
   const runId = `run-${randomUUID()}`;
   const stepId = `step-${randomUUID()}`;
   const timestamp = createdAt || new Date();
@@ -52,21 +49,18 @@ const createSampleWorkflowSnapshot = (
     result: { success: true },
     value: {},
     context: {
-      steps: {
-        [stepId]: {
-          status,
-          payload: {},
-          error: undefined,
-        },
+      [stepId]: {
+        status,
+        payload: {},
+        error: undefined,
       },
-      triggerData: {},
-      attempts: {},
+      input: {},
     },
     activePaths: [],
     suspendedPaths: {},
     runId,
     timestamp: timestamp.getTime(),
-  };
+  } as unknown as WorkflowRunState;
   return { snapshot, runId, stepId };
 };
 
@@ -92,7 +86,7 @@ const checkWorkflowSnapshot = (snapshot: WorkflowRunState | string, stepId: stri
   if (typeof snapshot === 'string') {
     throw new Error('Expected WorkflowRunState, got string');
   }
-  expect(snapshot.context?.steps[stepId]?.status).toBe(status);
+  expect(snapshot.context?.[stepId]?.status).toBe(status);
 };
 
 describe('PostgresStore', () => {
@@ -356,17 +350,15 @@ describe('PostgresStore', () => {
       const snapshot = {
         status: 'running',
         context: {
-          steps: {},
-          stepResults: {},
-          attempts: {},
-          triggerData: { type: 'manual' },
+          input: { type: 'manual' },
+          step1: { status: 'success', output: { data: 'test' } },
         },
         value: {},
         activePaths: [],
         suspendedPaths: {},
         runId,
         timestamp: new Date().getTime(),
-      };
+      } as unknown as WorkflowRunState;
 
       await store.persistWorkflowSnapshot({
         workflowName,
@@ -397,10 +389,7 @@ describe('PostgresStore', () => {
       const initialSnapshot = {
         status: 'running',
         context: {
-          steps: {},
-          stepResults: {},
-          attempts: {},
-          triggerData: { type: 'manual' },
+          input: { type: 'manual' },
         },
         value: {},
         activePaths: [],
@@ -412,18 +401,14 @@ describe('PostgresStore', () => {
       await store.persistWorkflowSnapshot({
         workflowName,
         runId,
-        snapshot: initialSnapshot,
+        snapshot: initialSnapshot as unknown as WorkflowRunState,
       });
 
       const updatedSnapshot = {
-        status: 'completed',
+        status: 'success',
         context: {
-          steps: {},
-          stepResults: {
-            'step-1': { status: 'success', result: { data: 'test' } },
-          },
-          attempts: { 'step-1': 1 },
-          triggerData: { type: 'manual' },
+          input: { type: 'manual' },
+          'step-1': { status: 'success', result: { data: 'test' } },
         },
         value: {},
         activePaths: [],
@@ -435,7 +420,7 @@ describe('PostgresStore', () => {
       await store.persistWorkflowSnapshot({
         workflowName,
         runId,
-        snapshot: updatedSnapshot,
+        snapshot: updatedSnapshot as unknown as WorkflowRunState,
       });
 
       const loadedSnapshot = await store.loadWorkflowSnapshot({
@@ -452,25 +437,21 @@ describe('PostgresStore', () => {
       const complexSnapshot = {
         value: { currentState: 'running' },
         context: {
-          stepResults: {
-            'step-1': {
-              status: 'success',
-              result: {
-                nestedData: {
-                  array: [1, 2, 3],
-                  object: { key: 'value' },
-                  date: new Date().toISOString(),
-                },
+          'step-1': {
+            status: 'success',
+            output: {
+              nestedData: {
+                array: [1, 2, 3],
+                object: { key: 'value' },
+                date: new Date().toISOString(),
               },
             },
-            'step-2': {
-              status: 'waiting',
-              dependencies: ['step-3', 'step-4'],
-            },
           },
-          steps: {},
-          attempts: { 'step-1': 1, 'step-2': 0 },
-          triggerData: {
+          'step-2': {
+            status: 'waiting',
+            dependencies: ['step-3', 'step-4'],
+          },
+          input: {
             type: 'scheduled',
             metadata: {
               schedule: '0 0 * * *',
@@ -498,7 +479,7 @@ describe('PostgresStore', () => {
       await store.persistWorkflowSnapshot({
         workflowName,
         runId,
-        snapshot: complexSnapshot,
+        snapshot: complexSnapshot as unknown as WorkflowRunState,
       });
 
       const loadedSnapshot = await store.loadWorkflowSnapshot({
@@ -704,7 +685,7 @@ describe('PostgresStore', () => {
       // Insert multiple workflow runs for the same resourceId
       resourceId = 'resource-shared';
       for (const status of ['success', 'failed']) {
-        const sample = createSampleWorkflowSnapshot(status as WorkflowRunState['context']['steps'][string]['status']);
+        const sample = createSampleWorkflowSnapshot(status as WorkflowRunState['context'][string]['status']);
         runIds.push(sample.runId);
         await store.insert({
           tableName: TABLE_WORKFLOW_SNAPSHOT,
@@ -719,7 +700,7 @@ describe('PostgresStore', () => {
         });
       }
       // Insert a run with a different resourceId
-      const other = createSampleWorkflowSnapshot('waiting');
+      const other = createSampleWorkflowSnapshot('suspended');
       await store.insert({
         tableName: TABLE_WORKFLOW_SNAPSHOT,
         record: {

package/src/storage/index.ts

@@ -23,10 +23,6 @@ import type { ISSLConfig } from 'pg-promise/typescript/pg-subset';
 
 export type PostgresConfig = {
   schemaName?: string;
-  /**
-   * @deprecated Use `schemaName` instead. Support for `schema` will be removed on May 20th, 2025.
-   */
-  schema?: string;
 } & (
   | {
       host: string;
@@ -72,13 +68,7 @@ export class PostgresStore extends MastraStorage {
     }
     super({ name: 'PostgresStore' });
     this.pgp = pgPromise();
-    // Deprecation notice for schema (old option)
-    if ('schema' in config && config.schema) {
-      console.warn(
-        '[DEPRECATION NOTICE] The "schema" option in PostgresStore is deprecated. Please use "schemaName" instead. Support for "schema" will be removed on May 20th, 2025.',
-      );
-    }
-    this.schema = config.schemaName ?? config.schema;
+    this.schema = config.schemaName;
     this.db = this.pgp(
       `connectionString` in config
         ? { connectionString: config.connectionString }

package/src/vector/index.test.ts

@@ -23,18 +23,12 @@ describe('PgVector', () => {
 
   // --- Validation tests ---
   describe('Validation', () => {
-    it('throws if connectionString is empty (string)', () => {
-      expect(() => new PgVector('')).toThrow(/connectionString must be provided and cannot be empty/);
-    });
-    it('throws if connectionString is empty (object)', () => {
+    it('throws if connectionString is empty', () => {
       expect(() => new PgVector({ connectionString: '' })).toThrow(
         /connectionString must be provided and cannot be empty/,
       );
     });
-    it('does not throw on non-empty connection string (string)', () => {
-      expect(() => new PgVector(connectionString)).not.toThrow();
-    });
-    it('does not throw on non-empty connection string (object)', () => {
+    it('does not throw on non-empty connection string', () => {
       expect(() => new PgVector({ connectionString })).not.toThrow();
     });
   });
@@ -152,7 +146,7 @@ describe('PgVector', () => {
       });
 
       it('should throw error for non-existent index', async () => {
-        await expect(vectorDB.describeIndex('non_existent')).rejects.toThrow();
+        await expect(vectorDB.describeIndex({ indexName: 'non_existent' })).rejects.toThrow();
       });
     });
 
@@ -1839,124 +1833,6 @@ describe('PgVector', () => {
       });
     });
   });
-  describe('Deprecation Warnings', () => {
-    const indexName = 'testdeprecationwarnings';
-
-    const indexName2 = 'testdeprecationwarnings2';
-
-    let warnSpy;
-
-    beforeAll(async () => {
-      await vectorDB.createIndex({ indexName, dimension: 3 });
-    });
-
-    afterAll(async () => {
-      await vectorDB.deleteIndex({ indexName });
-      await vectorDB.deleteIndex({ indexName: indexName2 });
-    });
-
-    beforeEach(async () => {
-      warnSpy = vi.spyOn(vectorDB['logger'], 'warn');
-    });
-
-    afterEach(async () => {
-      warnSpy.mockRestore();
-      await vectorDB.deleteIndex({ indexName: indexName2 });
-    });
-
-    it('should show deprecation warning when using individual args for createIndex', async () => {
-      await vectorDB.createIndex(indexName2, 3, 'cosine');
-
-      expect(warnSpy).toHaveBeenCalledWith(
-        expect.stringContaining('Deprecation Warning: Passing individual arguments to createIndex() is deprecated'),
-      );
-    });
-
-    it('should show deprecation warning when using individual args for upsert', async () => {
-      await vectorDB.upsert(indexName, [[1, 2, 3]], [{ test: 'data' }]);
-
-      expect(warnSpy).toHaveBeenCalledWith(
-        expect.stringContaining('Deprecation Warning: Passing individual arguments to upsert() is deprecated'),
-      );
-    });
-
-    it('should show deprecation warning when using individual args for query', async () => {
-      await vectorDB.query(indexName, [1, 2, 3], 5);
-
-      expect(warnSpy).toHaveBeenCalledWith(
-        expect.stringContaining('Deprecation Warning: Passing individual arguments to query() is deprecated'),
-      );
-    });
-
-    it('should show deprecation warning when using individual args for buildIndex', async () => {
-      await vectorDB.buildIndex(indexName, 'cosine', { type: 'flat' });
-
-      expect(warnSpy).toHaveBeenCalledWith(
-        expect.stringContaining('Deprecation Warning: Passing individual arguments to buildIndex() is deprecated'),
-      );
-    });
-
-    it('should not show deprecation warning when using object param for buildIndex', async () => {
-      await vectorDB.buildIndex({
-        indexName: indexName,
-        metric: 'cosine',
-        indexConfig: { type: 'flat' },
-      });
-
-      expect(warnSpy).not.toHaveBeenCalled();
-    });
-
-    it('should not show deprecation warning when using object param for query', async () => {
-      await vectorDB.query({
-        indexName,
-        queryVector: [1, 2, 3],
-        topK: 5,
-      });
-
-      expect(warnSpy).not.toHaveBeenCalled();
-    });
-
-    it('should not show deprecation warning when using object param for createIndex', async () => {
-      await vectorDB.createIndex({
-        indexName: indexName2,
-        dimension: 3,
-        metric: 'cosine',
-      });
-
-      expect(warnSpy).not.toHaveBeenCalled();
-    });
-
-    it('should not show deprecation warning when using object param for upsert', async () => {
-      await vectorDB.upsert({
-        indexName,
-        vectors: [[1, 2, 3]],
-        metadata: [{ test: 'data' }],
-      });
-
-      expect(warnSpy).not.toHaveBeenCalled();
-    });
-
-    it('should maintain backward compatibility with individual args', async () => {
-      // Query
-      const queryResults = await vectorDB.query(indexName, [1, 2, 3], 5);
-      expect(Array.isArray(queryResults)).toBe(true);
-
-      // CreateIndex
-      await expect(vectorDB.createIndex(indexName2, 3, 'cosine')).resolves.not.toThrow();
-
-      // Upsert
-      const upsertResults = await vectorDB.upsert({
-        indexName,
-        vectors: [[1, 2, 3]],
-        metadata: [{ test: 'data' }],
-      });
-      expect(Array.isArray(upsertResults)).toBe(true);
-      expect(upsertResults).toHaveLength(1);
-
-      // BuildIndex
-      await expect(vectorDB.buildIndex(indexName, 'cosine', { type: 'flat' })).resolves.not.toThrow();
-    });
-  });
 
   describe('Concurrent Operations', () => {
     it('should handle concurrent index creation attempts', async () => {
@@ -2055,11 +1931,6 @@ describe('PgVector', () => {
     });
 
     describe('Constructor', () => {
-      it('should accept connectionString directly', () => {
-        const db = new PgVector(connectionString);
-        expect(db).toBeInstanceOf(PgVector);
-      });
-
       it('should accept config object with connectionString', () => {
         const db = new PgVector({ connectionString });
         expect(db).toBeInstanceOf(PgVector);