Updated docs and tests for TypeORM 0.3.27

Author: ankane

README.md

@@ -537,11 +537,7 @@ See a [full example](tests/slonik.test.mjs)
 
 ## TypeORM
 
-Import the library
-
-```javascript
-import pgvector from 'pgvector';
-```
+TypeORM 0.3.27+ has [built-in support](https://typeorm.io/docs/entity/entities#vector-columns) for pgvector :tada:
 
 Enable the extension
 
@@ -563,21 +559,23 @@ class Item {
   @PrimaryGeneratedColumn()
   id: number
 
-  @Column()
-  embedding: string
+  @Column('vector', {length: 3})
+  embedding: number[]
 }
 ```
 
 Insert a vector
 
 ```javascript
 const itemRepository = AppDataSource.getRepository(Item);
-await itemRepository.save({embedding: pgvector.toSql([1, 2, 3])});
+await itemRepository.save({embedding: [1, 2, 3]});
 ```
 
 Get the nearest neighbors to a vector
 
 ```javascript
+import pgvector from 'pgvector';
+
 const items = await itemRepository
   .createQueryBuilder('item')
   .orderBy('embedding <-> :embedding')

tests/typeorm.test.mjs

@@ -16,14 +16,16 @@ test('typeorm example', async () => {
         primary: true,
         generated: true
       },
-      // custom types not supported
-      // https://github.com/typeorm/typeorm/issues/10056
       embedding: {
-        type: String
+        type: 'vector',
+        length: 3
       },
       half_embedding: {
-        type: String
+        type: 'halfvec',
+        length: 3
       },
+      // custom types not supported
+      // https://github.com/typeorm/typeorm/issues/10056
       binary_embedding: {
         type: String
       },
@@ -46,9 +48,9 @@ test('typeorm example', async () => {
   await AppDataSource.query('CREATE TABLE typeorm_items (id bigserial PRIMARY KEY, embedding vector(3), half_embedding halfvec(3), binary_embedding bit(3), sparse_embedding sparsevec(3))');
 
   const itemRepository = AppDataSource.getRepository(Item);
-  await itemRepository.save({embedding: pgvector.toSql([1, 1, 1]), half_embedding: pgvector.toSql([1, 1, 1]), binary_embedding: '000', sparse_embedding: new SparseVector([1, 1, 1])});
-  await itemRepository.save({embedding: pgvector.toSql([2, 2, 2]), half_embedding: pgvector.toSql([2, 2, 2]), binary_embedding: '101', sparse_embedding: new SparseVector([2, 2, 2])});
-  await itemRepository.save({embedding: pgvector.toSql([1, 1, 2]), half_embedding: pgvector.toSql([1, 1, 2]), binary_embedding: '111', sparse_embedding: new SparseVector([1, 1, 2])});
+  await itemRepository.save({embedding: [1, 1, 1], half_embedding: [1, 1, 1], binary_embedding: '000', sparse_embedding: new SparseVector([1, 1, 1])});
+  await itemRepository.save({embedding: [2, 2, 2], half_embedding: [2, 2, 2], binary_embedding: '101', sparse_embedding: new SparseVector([2, 2, 2])});
+  await itemRepository.save({embedding: [1, 1, 2], half_embedding: [1, 1, 2], binary_embedding: '111', sparse_embedding: new SparseVector([1, 1, 2])});
 
   const items = await itemRepository
     .createQueryBuilder('item')
@@ -57,8 +59,8 @@ test('typeorm example', async () => {
     .limit(5)
     .getMany();
   assert.deepEqual(items.map(v => v.id), [1, 3, 2]);
-  assert.deepEqual(pgvector.fromSql(items[0].embedding), [1, 1, 1]);
-  assert.deepEqual(pgvector.fromSql(items[0].half_embedding), [1, 1, 1]);
+  assert.deepEqual(items[0].embedding, [1, 1, 1]);
+  assert.deepEqual(items[0].half_embedding, [1, 1, 1]);
   assert.equal(items[0].binary_embedding, '000');
   assert.deepEqual((new SparseVector(items[0].sparse_embedding).toArray()), [1, 1, 1]);