@mastra/pg 0.3.4 → 0.4.0-alpha.1

package/src/vector/index.test.ts

@@ -12,29 +12,23 @@ describe('PgVector', () => {
 
   beforeAll(async () => {
     // Initialize PgVector
-    vectorDB = new PgVector(connectionString);
+    vectorDB = new PgVector({ connectionString });
   });
 
   afterAll(async () => {
     // Clean up test tables
-    await vectorDB.deleteIndex(testIndexName);
+    await vectorDB.deleteIndex({ indexName: testIndexName });
     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)', () => {
+    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();
     });
   });
@@ -43,19 +37,19 @@ describe('PgVector', () => {
   describe('Index Management', () => {
     describe('createIndex', () => {
       afterAll(async () => {
-        await vectorDB.deleteIndex(testIndexName2);
+        await vectorDB.deleteIndex({ indexName: testIndexName2 });
       });
 
       it('should create a new vector table with specified dimensions', async () => {
         await vectorDB.createIndex({ indexName: testIndexName, dimension: 3 });
-        const stats = await vectorDB.describeIndex(testIndexName);
+        const stats = await vectorDB.describeIndex({ indexName: testIndexName });
         expect(stats?.dimension).toBe(3);
         expect(stats?.count).toBe(0);
       });
 
       it('should create index with specified metric', async () => {
         await vectorDB.createIndex({ indexName: testIndexName2, dimension: 3, metric: 'euclidean' });
-        const stats = await vectorDB.describeIndex(testIndexName2);
+        const stats = await vectorDB.describeIndex({ indexName: testIndexName2 });
         expect(stats.metric).toBe('euclidean');
       });
 
@@ -70,7 +64,7 @@ describe('PgVector', () => {
           metric: 'cosine',
           indexConfig: { type: 'flat' },
         });
-        const stats = await vectorDB.describeIndex(testIndexName2);
+        const stats = await vectorDB.describeIndex({ indexName: testIndexName2 });
         expect(stats.type).toBe('flat');
       });
 
@@ -81,7 +75,7 @@ describe('PgVector', () => {
           metric: 'cosine',
           indexConfig: { type: 'hnsw', hnsw: { m: 16, efConstruction: 64 } }, // Any reasonable values work
         });
-        const stats = await vectorDB.describeIndex(testIndexName2);
+        const stats = await vectorDB.describeIndex({ indexName: testIndexName2 });
         expect(stats.type).toBe('hnsw');
         expect(stats.config.m).toBe(16);
       });
@@ -93,7 +87,7 @@ describe('PgVector', () => {
           metric: 'cosine',
           indexConfig: { type: 'ivfflat', ivf: { lists: 100 } },
         });
-        const stats = await vectorDB.describeIndex(testIndexName2);
+        const stats = await vectorDB.describeIndex({ indexName: testIndexName2 });
         expect(stats.type).toBe('ivfflat');
         expect(stats.config.lists).toBe(100);
       });
@@ -106,7 +100,7 @@ describe('PgVector', () => {
       });
 
       afterAll(async () => {
-        await vectorDB.deleteIndex(indexName);
+        await vectorDB.deleteIndex({ indexName });
       });
 
       it('should list all vector tables', async () => {
@@ -115,7 +109,7 @@ describe('PgVector', () => {
       });
 
       it('should not return created index in list if it is deleted', async () => {
-        await vectorDB.deleteIndex(indexName);
+        await vectorDB.deleteIndex({ indexName });
         const indexes = await vectorDB.listIndexes();
         expect(indexes).not.toContain(indexName);
       });
@@ -128,7 +122,7 @@ describe('PgVector', () => {
       });
 
       afterAll(async () => {
-        await vectorDB.deleteIndex(indexName);
+        await vectorDB.deleteIndex({ indexName });
       });
 
       it('should return correct index stats', async () => {
@@ -139,7 +133,7 @@ describe('PgVector', () => {
         ];
         await vectorDB.upsert({ indexName, vectors });
 
-        const stats = await vectorDB.describeIndex(indexName);
+        const stats = await vectorDB.describeIndex({ indexName });
         expect(stats).toEqual({
           type: 'ivfflat',
           config: {
@@ -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();
       });
     });
 
@@ -163,7 +157,7 @@ describe('PgVector', () => {
       });
 
       afterAll(async () => {
-        await vectorDB.deleteIndex(indexName);
+        await vectorDB.deleteIndex({ indexName });
       });
 
       it('should build index with specified metric and config', async () => {
@@ -173,7 +167,7 @@ describe('PgVector', () => {
           indexConfig: { type: 'hnsw', hnsw: { m: 16, efConstruction: 64 } },
         });
 
-        const stats = await vectorDB.describeIndex(indexName);
+        const stats = await vectorDB.describeIndex({ indexName });
         expect(stats.type).toBe('hnsw');
         expect(stats.metric).toBe('cosine');
         expect(stats.config.m).toBe(16);
@@ -186,7 +180,7 @@ describe('PgVector', () => {
           indexConfig: { type: 'ivfflat', ivf: { lists: 100 } },
         });
 
-        const stats = await vectorDB.describeIndex(indexName);
+        const stats = await vectorDB.describeIndex({ indexName });
         expect(stats.type).toBe('ivfflat');
         expect(stats.metric).toBe('euclidean');
         expect(stats.config.lists).toBe(100);
@@ -202,7 +196,7 @@ describe('PgVector', () => {
       });
 
       afterEach(async () => {
-        await vectorDB.deleteIndex(testIndexName);
+        await vectorDB.deleteIndex({ indexName: testIndexName });
       });
 
       it('should insert new vectors', async () => {
@@ -213,7 +207,7 @@ describe('PgVector', () => {
         const ids = await vectorDB.upsert({ indexName: testIndexName, vectors });
 
         expect(ids).toHaveLength(2);
-        const stats = await vectorDB.describeIndex(testIndexName);
+        const stats = await vectorDB.describeIndex({ indexName: testIndexName });
         expect(stats.count).toBe(2);
       });
 
@@ -267,7 +261,7 @@ describe('PgVector', () => {
       });
 
       afterEach(async () => {
-        await vectorDB.deleteIndex(testIndexName);
+        await vectorDB.deleteIndex({ indexName: testIndexName });
       });
 
       it('should update the vector by id', async () => {
@@ -285,7 +279,7 @@ describe('PgVector', () => {
           metadata: newMetaData,
         };
 
-        await vectorDB.updateVector(testIndexName, idToBeUpdated, update);
+        await vectorDB.updateVector({ indexName: testIndexName, id: idToBeUpdated, update });
 
         const results: QueryResult[] = await vectorDB.query({
           indexName: testIndexName,
@@ -311,7 +305,7 @@ describe('PgVector', () => {
           metadata: newMetaData,
         };
 
-        await vectorDB.updateVector(testIndexName, idToBeUpdated, update);
+        await vectorDB.updateVector({ indexName: testIndexName, id: idToBeUpdated, update });
 
         const results: QueryResult[] = await vectorDB.query({
           indexName: testIndexName,
@@ -335,7 +329,7 @@ describe('PgVector', () => {
           vector: newVector,
         };
 
-        await vectorDB.updateVector(testIndexName, idToBeUpdated, update);
+        await vectorDB.updateVector({ indexName: testIndexName, id: idToBeUpdated, update });
 
         const results: QueryResult[] = await vectorDB.query({
           indexName: testIndexName,
@@ -348,7 +342,9 @@ describe('PgVector', () => {
       });
 
       it('should throw exception when no updates are given', async () => {
-        await expect(vectorDB.updateVector(testIndexName, 'id', {})).rejects.toThrow('No updates provided');
+        await expect(vectorDB.updateVector({ indexName: testIndexName, id: 'id', update: {} })).rejects.toThrow(
+          'No updates provided',
+        );
       });
     });
 
@@ -364,7 +360,7 @@ describe('PgVector', () => {
       });
 
       afterEach(async () => {
-        await vectorDB.deleteIndex(testIndexName);
+        await vectorDB.deleteIndex({ indexName: testIndexName });
       });
 
       it('should delete the vector by id', async () => {
@@ -372,7 +368,7 @@ describe('PgVector', () => {
         expect(ids).toHaveLength(3);
         const idToBeDeleted = ids[0];
 
-        await vectorDB.deleteVector(testIndexName, idToBeDeleted);
+        await vectorDB.deleteVector({ indexName: testIndexName, id: idToBeDeleted });
 
         const results: QueryResult[] = await vectorDB.query({
           indexName: testIndexName,
@@ -390,7 +386,7 @@ describe('PgVector', () => {
         const indexName = `test_query_2_${indexType}`;
         beforeAll(async () => {
           try {
-            await vectorDB.deleteIndex(indexName);
+            await vectorDB.deleteIndex({ indexName });
           } catch {
             // Ignore if doesn't exist
           }
@@ -398,7 +394,7 @@ describe('PgVector', () => {
         });
 
         beforeEach(async () => {
-          await vectorDB.truncateIndex(indexName);
+          await vectorDB.truncateIndex({ indexName });
           const vectors = [
             [1, 0, 0],
             [0.8, 0.2, 0],
@@ -413,7 +409,7 @@ describe('PgVector', () => {
         });
 
         afterAll(async () => {
-          await vectorDB.deleteIndex(indexName);
+          await vectorDB.deleteIndex({ indexName });
         });
 
         it('should return closest vectors', async () => {
@@ -451,7 +447,7 @@ describe('PgVector', () => {
     const indexName = 'test_query_filters';
     beforeAll(async () => {
       try {
-        await vectorDB.deleteIndex(indexName);
+        await vectorDB.deleteIndex({ indexName });
       } catch {
         // Ignore if doesn't exist
       }
@@ -459,7 +455,7 @@ describe('PgVector', () => {
     });
 
     beforeEach(async () => {
-      await vectorDB.truncateIndex(indexName);
+      await vectorDB.truncateIndex({ indexName });
       const vectors = [
         [1, 0.1, 0],
         [0.9, 0.2, 0],
@@ -509,7 +505,7 @@ describe('PgVector', () => {
     });
 
     afterAll(async () => {
-      await vectorDB.deleteIndex(indexName);
+      await vectorDB.deleteIndex({ indexName });
     });
 
     // Numeric Comparison Tests
@@ -1346,7 +1342,7 @@ describe('PgVector', () => {
       });
 
       afterAll(async () => {
-        await vectorDB.deleteIndex(testIndexName);
+        await vectorDB.deleteIndex({ indexName: testIndexName });
       });
 
       it('should handle non-existent index queries', async () => {
@@ -1379,7 +1375,7 @@ describe('PgVector', () => {
         ).resolves.not.toThrow();
 
         // Cleanup
-        await vectorDB.deleteIndex(duplicateIndexName);
+        await vectorDB.deleteIndex({ indexName: duplicateIndexName });
       });
     });
 
@@ -1765,7 +1761,7 @@ describe('PgVector', () => {
       });
 
       afterAll(async () => {
-        await vectorDB.deleteIndex(indexName);
+        await vectorDB.deleteIndex({ indexName });
       });
 
       it('should use default ef value', async () => {
@@ -1810,7 +1806,7 @@ describe('PgVector', () => {
       });
 
       afterAll(async () => {
-        await vectorDB.deleteIndex(indexName);
+        await vectorDB.deleteIndex({ indexName });
       });
 
       it('should use default probe value', async () => {
@@ -1837,124 +1833,6 @@ describe('PgVector', () => {
       });
     });
   });
-  describe('Deprecation Warnings', () => {
-    const indexName = 'testdeprecationwarnings';
-
-    const indexName2 = 'testdeprecationwarnings2';
-
-    let warnSpy;
-
-    beforeAll(async () => {
-      await vectorDB.createIndex({ indexName: indexName, dimension: 3 });
-    });
-
-    afterAll(async () => {
-      await vectorDB.deleteIndex(indexName);
-      await vectorDB.deleteIndex(indexName2);
-    });
-
-    beforeEach(async () => {
-      warnSpy = vi.spyOn(vectorDB['logger'], 'warn');
-    });
-
-    afterEach(async () => {
-      warnSpy.mockRestore();
-      await vectorDB.deleteIndex(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 () => {
@@ -1970,10 +1848,10 @@ describe('PgVector', () => {
       await expect(Promise.all(promises)).resolves.not.toThrow();
 
       // Verify only one index was actually created
-      const stats = await vectorDB.describeIndex(indexName);
+      const stats = await vectorDB.describeIndex({ indexName });
       expect(stats.dimension).toBe(dimension);
 
-      await vectorDB.deleteIndex(indexName);
+      await vectorDB.deleteIndex({ indexName });
     });
 
     it('should handle concurrent buildIndex attempts', async () => {
@@ -1992,10 +1870,10 @@ describe('PgVector', () => {
 
       await expect(Promise.all(promises)).resolves.not.toThrow();
 
-      const stats = await vectorDB.describeIndex(indexName);
+      const stats = await vectorDB.describeIndex({ indexName });
       expect(stats.type).toBe('ivfflat');
 
-      await vectorDB.deleteIndex(indexName);
+      await vectorDB.deleteIndex({ indexName });
     });
   });
 
@@ -2006,7 +1884,7 @@ describe('PgVector', () => {
 
     beforeAll(async () => {
       // Initialize default vectorDB first
-      vectorDB = new PgVector(connectionString);
+      vectorDB = new PgVector({ connectionString });
 
       // Create schema using the default vectorDB connection
       const client = await vectorDB['pool'].connect();
@@ -2030,7 +1908,7 @@ describe('PgVector', () => {
     afterAll(async () => {
       // Clean up test tables and schema
       try {
-        await customSchemaVectorDB.deleteIndex('schema_test_vectors');
+        await customSchemaVectorDB.deleteIndex({ indexName: 'schema_test_vectors' });
       } catch {
         // Ignore errors if index doesn't exist
       }
@@ -2053,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);
@@ -2075,12 +1948,12 @@ describe('PgVector', () => {
       beforeEach(async () => {
         // Clean up any existing indexes
         try {
-          await customSchemaVectorDB.deleteIndex(testIndexName);
+          await customSchemaVectorDB.deleteIndex({ indexName: testIndexName });
         } catch {
           // Ignore if doesn't exist
         }
         try {
-          await vectorDB.deleteIndex(testIndexName);
+          await vectorDB.deleteIndex({ indexName: testIndexName });
         } catch {
           // Ignore if doesn't exist
         }
@@ -2089,12 +1962,12 @@ describe('PgVector', () => {
       afterEach(async () => {
         // Clean up indexes after each test
         try {
-          await customSchemaVectorDB.deleteIndex(testIndexName);
+          await customSchemaVectorDB.deleteIndex({ indexName: testIndexName });
         } catch {
           // Ignore if doesn't exist
         }
         try {
-          await vectorDB.deleteIndex(testIndexName);
+          await vectorDB.deleteIndex({ indexName: testIndexName });
         } catch {
           // Ignore if doesn't exist
         }
@@ -2150,7 +2023,7 @@ describe('PgVector', () => {
         // Insert a vector
         await customSchemaVectorDB.upsert({ indexName: testIndexName, vectors: [[1, 2, 3]] });
         // Describe the index
-        const stats = await customSchemaVectorDB.describeIndex(testIndexName);
+        const stats = await customSchemaVectorDB.describeIndex({ indexName: testIndexName });
         expect(stats).toMatchObject({
           dimension: 3,
           metric: 'dotproduct',
@@ -2198,7 +2071,7 @@ describe('PgVector', () => {
         await customSchemaVectorDB.createIndex({ indexName: testIndexName, dimension: 3 });
 
         // Test index operations
-        const stats = await customSchemaVectorDB.describeIndex(testIndexName);
+        const stats = await customSchemaVectorDB.describeIndex({ indexName: testIndexName });
         expect(stats.dimension).toBe(3);
 
         // Test list operation
@@ -2215,7 +2088,7 @@ describe('PgVector', () => {
         });
 
         // Test delete operation
-        await customSchemaVectorDB.deleteVector(testIndexName, id!);
+        await customSchemaVectorDB.deleteVector({ indexName: testIndexName, id: id! });
 
         // Verify deletion
         const results = await customSchemaVectorDB.query({