@mastra/pg 0.3.0-alpha.3 → 0.3.0-alpha.5

package/.turbo/turbo-build.log

@@ -1,23 +1,23 @@
 
-> @mastra/pg@0.3.0-alpha.3 build /home/runner/work/mastra/mastra/stores/pg
+> @mastra/pg@0.3.0-alpha.5 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 10982ms
+TSC ⚡️ Build success in 10144ms
 DTS Build start
 CLI Target: es2022
 Analysis will use the bundled TypeScript version 5.8.2
 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.2
 Writing package typings: /home/runner/work/mastra/mastra/stores/pg/dist/_tsup-dts-rollup.d.cts
-DTS ⚡️ Build success in 12779ms
+DTS ⚡️ Build success in 12459ms
 CLI Cleaning output folder
 ESM Build start
 CJS Build start
-ESM dist/index.js 45.68 KB
-ESM ⚡️ Build success in 1276ms
-CJS dist/index.cjs 46.10 KB
-CJS ⚡️ Build success in 1276ms
+CJS dist/index.cjs 47.42 KB
+CJS ⚡️ Build success in 1401ms
+ESM dist/index.js 46.99 KB
+ESM ⚡️ Build success in 1404ms

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @mastra/pg
 
+## 0.3.0-alpha.5
+
+### Patch Changes
+
+- Updated dependencies [08bb78e]
+  - @mastra/core@0.9.0-alpha.5
+
+## 0.3.0-alpha.4
+
+### Patch Changes
+
+- 373458f: updated schema for storage config to align with pgvector and added validation for pg connections
+- Updated dependencies [7e92011]
+  - @mastra/core@0.9.0-alpha.4
+
 ## 0.3.0-alpha.3
 
 ### Minor Changes

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

@@ -246,6 +246,10 @@ export { PgVector }
 export { PgVector as PgVector_alias_1 }
 
 declare type PostgresConfig = {
+    schemaName?: string;
+    /**
+     * @deprecated Use `schemaName` instead. Support for `schema` will be removed in a future release.
+     */
     schema?: string;
 } & ({
     host: string;

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

@@ -246,6 +246,10 @@ export { PgVector }
 export { PgVector as PgVector_alias_1 }
 
 declare type PostgresConfig = {
+    schemaName?: string;
+    /**
+     * @deprecated Use `schemaName` instead. Support for `schema` will be removed in a future release.
+     */
     schema?: string;
 } & ({
     host: string;

package/dist/index.cjs

@@ -305,8 +305,13 @@ var PgVector = class extends vector.MastraVector {
   vectorExtensionInstalled = void 0;
   schemaSetupComplete = void 0;
   constructor(config) {
-    super();
     const connectionString = typeof config === "string" ? config : config.connectionString;
+    if (!connectionString || typeof connectionString !== "string" || 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."
+      );
+    }
+    super();
     this.schema = typeof config === "string" ? void 0 : config.schemaName;
     const basePool = new pg__default.default.Pool({
       connectionString,
@@ -793,9 +798,30 @@ var PostgresStore = class extends storage.MastraStorage {
   setupSchemaPromise = null;
   schemaSetupComplete = void 0;
   constructor(config) {
+    if ("connectionString" in config) {
+      if (!config.connectionString || typeof config.connectionString !== "string" || config.connectionString.trim() === "") {
+        throw new Error(
+          "PostgresStore: connectionString must be provided and cannot be empty. Passing an empty string may cause fallback to local Postgres defaults."
+        );
+      }
+    } else {
+      const required = ["host", "database", "user", "password"];
+      for (const key of required) {
+        if (!(key in config) || typeof config[key] !== "string" || config[key].trim() === "") {
+          throw new Error(
+            `PostgresStore: ${key} must be provided and cannot be empty. Passing an empty string may cause fallback to local Postgres defaults.`
+          );
+        }
+      }
+    }
     super({ name: "PostgresStore" });
     this.pgp = pgPromise__default.default();
-    this.schema = config.schema;
+    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 in a future release.'
+      );
+    }
+    this.schema = config.schemaName ?? config.schema;
     this.db = this.pgp(
       `connectionString` in config ? { connectionString: config.connectionString } : {
         host: config.host,

package/dist/index.js

@@ -297,8 +297,13 @@ var PgVector = class extends MastraVector {
   vectorExtensionInstalled = void 0;
   schemaSetupComplete = void 0;
   constructor(config) {
-    super();
     const connectionString = typeof config === "string" ? config : config.connectionString;
+    if (!connectionString || typeof connectionString !== "string" || 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."
+      );
+    }
+    super();
     this.schema = typeof config === "string" ? void 0 : config.schemaName;
     const basePool = new pg.Pool({
       connectionString,
@@ -785,9 +790,30 @@ var PostgresStore = class extends MastraStorage {
   setupSchemaPromise = null;
   schemaSetupComplete = void 0;
   constructor(config) {
+    if ("connectionString" in config) {
+      if (!config.connectionString || typeof config.connectionString !== "string" || config.connectionString.trim() === "") {
+        throw new Error(
+          "PostgresStore: connectionString must be provided and cannot be empty. Passing an empty string may cause fallback to local Postgres defaults."
+        );
+      }
+    } else {
+      const required = ["host", "database", "user", "password"];
+      for (const key of required) {
+        if (!(key in config) || typeof config[key] !== "string" || config[key].trim() === "") {
+          throw new Error(
+            `PostgresStore: ${key} must be provided and cannot be empty. Passing an empty string may cause fallback to local Postgres defaults.`
+          );
+        }
+      }
+    }
     super({ name: "PostgresStore" });
     this.pgp = pgPromise();
-    this.schema = config.schema;
+    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 in a future release.'
+      );
+    }
+    this.schema = config.schemaName ?? config.schema;
     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.0-alpha.3",
+  "version": "0.3.0-alpha.5",
   "description": "Postgres provider for Mastra - includes both vector and db storage capabilities",
   "type": "module",
   "main": "dist/index.js",
@@ -24,7 +24,7 @@
     "pg": "^8.13.3",
     "pg-promise": "^11.11.0",
     "xxhash-wasm": "^1.1.0",
-    "@mastra/core": "^0.9.0-alpha.3"
+    "@mastra/core": "^0.9.0-alpha.5"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.52.1",

package/src/storage/index.test.ts

@@ -104,6 +104,50 @@ describe('PostgresStore', () => {
     }
   });
 
+  // --- Validation tests ---
+  describe('Validation', () => {
+    const validConfig = TEST_CONFIG;
+    it('throws if connectionString is empty', () => {
+      expect(() => new PostgresStore({ connectionString: '' })).toThrow(
+        /connectionString must be provided and cannot be empty/,
+      );
+    });
+    it('throws if host is missing or empty', () => {
+      expect(() => new PostgresStore({ ...validConfig, host: '' })).toThrow(
+        /host must be provided and cannot be empty/,
+      );
+      const { host, ...rest } = validConfig;
+      expect(() => new PostgresStore(rest as any)).toThrow(/host must be provided and cannot be empty/);
+    });
+    it('throws if user is missing or empty', () => {
+      expect(() => new PostgresStore({ ...validConfig, user: '' })).toThrow(
+        /user must be provided and cannot be empty/,
+      );
+      const { user, ...rest } = validConfig;
+      expect(() => new PostgresStore(rest as any)).toThrow(/user must be provided and cannot be empty/);
+    });
+    it('throws if database is missing or empty', () => {
+      expect(() => new PostgresStore({ ...validConfig, database: '' })).toThrow(
+        /database must be provided and cannot be empty/,
+      );
+      const { database, ...rest } = validConfig;
+      expect(() => new PostgresStore(rest as any)).toThrow(/database must be provided and cannot be empty/);
+    });
+    it('throws if password is missing or empty', () => {
+      expect(() => new PostgresStore({ ...validConfig, password: '' })).toThrow(
+        /password must be provided and cannot be empty/,
+      );
+      const { password, ...rest } = validConfig;
+      expect(() => new PostgresStore(rest as any)).toThrow(/password must be provided and cannot be empty/);
+    });
+    it('does not throw on valid config (host-based)', () => {
+      expect(() => new PostgresStore(validConfig)).not.toThrow();
+    });
+    it('does not throw on non-empty connection string', () => {
+      expect(() => new PostgresStore({ connectionString })).not.toThrow();
+    });
+  });
+
   describe('Thread Operations', () => {
     it('should create and retrieve a thread', async () => {
       const thread = createSampleThread();
@@ -662,7 +706,7 @@ describe('PostgresStore', () => {
     beforeAll(async () => {
       customSchemaStore = new PostgresStore({
         ...TEST_CONFIG,
-        schema: customSchema,
+        schemaName: customSchema,
       });
 
       await customSchemaStore.init();
@@ -844,7 +888,7 @@ describe('PostgresStore', () => {
           ...TEST_CONFIG,
           user: schemaRestrictedUser,
           password: restrictedPassword,
-          schema: testSchema,
+          schemaName: testSchema,
         });
 
         // Create a fresh connection for verification
@@ -876,7 +920,7 @@ describe('PostgresStore', () => {
           ...TEST_CONFIG,
           user: schemaRestrictedUser,
           password: restrictedPassword,
-          schema: testSchema,
+          schemaName: testSchema,
         });
 
         // Create a fresh connection for verification

package/src/storage/index.ts

@@ -13,7 +13,13 @@ import type { WorkflowRunState } from '@mastra/core/workflows';
 import pgPromise from 'pg-promise';
 import type { ISSLConfig } from 'pg-promise/typescript/pg-subset';
 
-export type PostgresConfig = { schema?: string } & (
+export type PostgresConfig = {
+  schemaName?: string;
+  /**
+   * @deprecated Use `schemaName` instead. Support for `schema` will be removed in a future release.
+   */
+  schema?: string;
+} & (
   | {
       host: string;
       port: number;
@@ -35,9 +41,36 @@ export class PostgresStore extends MastraStorage {
   private schemaSetupComplete: boolean | undefined = undefined;
 
   constructor(config: PostgresConfig) {
+    // Validation: connectionString or host/database/user/password must not be empty
+    if ('connectionString' in config) {
+      if (
+        !config.connectionString ||
+        typeof config.connectionString !== 'string' ||
+        config.connectionString.trim() === ''
+      ) {
+        throw new Error(
+          'PostgresStore: connectionString must be provided and cannot be empty. Passing an empty string may cause fallback to local Postgres defaults.',
+        );
+      }
+    } else {
+      const required = ['host', 'database', 'user', 'password'];
+      for (const key of required) {
+        if (!(key in config) || typeof (config as any)[key] !== 'string' || (config as any)[key].trim() === '') {
+          throw new Error(
+            `PostgresStore: ${key} must be provided and cannot be empty. Passing an empty string may cause fallback to local Postgres defaults.`,
+          );
+        }
+      }
+    }
     super({ name: 'PostgresStore' });
     this.pgp = pgPromise();
-    this.schema = config.schema;
+    // 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 in a future release.',
+      );
+    }
+    this.schema = config.schemaName ?? config.schema;
     this.db = this.pgp(
       `connectionString` in config
         ? { connectionString: config.connectionString }

package/src/vector/index.test.ts

@@ -21,6 +21,24 @@ describe('PgVector', () => {
     await vectorDB.disconnect();
   });
 
+  // --- 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)', () => {
+      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)', () => {
+      expect(() => new PgVector({ connectionString })).not.toThrow();
+    });
+  });
+
   // Index Management Tests
   describe('Index Management', () => {
     describe('createIndex', () => {
@@ -329,8 +347,8 @@ describe('PgVector', () => {
         expect(results[0]?.vector).toEqual(newVector);
       });
 
-      it('should throw exception when no updates are given', () => {
-        expect(vectorDB.updateIndexById(testIndexName, 'id', {})).rejects.toThrow('No updates provided');
+      it('should throw exception when no updates are given', async () => {
+        await expect(vectorDB.updateIndexById(testIndexName, 'id', {})).rejects.toThrow('No updates provided');
       });
     });
 

package/src/vector/index.ts

@@ -73,9 +73,14 @@ export class PgVector extends MastraVector {
   constructor(connectionString: string);
   constructor(config: { connectionString: string; schemaName?: string });
   constructor(config: string | { connectionString: string; schemaName?: string }) {
+    const connectionString = typeof config === 'string' ? config : config.connectionString;
+    if (!connectionString || typeof connectionString !== 'string' || 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.',
+      );
+    }
     super();
 
-    const connectionString = typeof config === 'string' ? config : config.connectionString;
     this.schema = typeof config === 'string' ? undefined : config.schemaName;
 
     const basePool = new pg.Pool({