Switched to ESM and dropped support for Node < 22

Author: ankane

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.3.0 (unreleased)
+
+- Switched to ESM
+- Dropped support for Node < 22
+
 ## 0.2.1 (2025-05-20)
 
 - Improved support for migrations with Sequelize

package.json

@@ -11,6 +11,7 @@
     "type": "git",
     "url": "https://github.com/pgvector/pgvector-node"
   },
+  "type": "module",
   "exports": {
     ".": {
       "types": "./types/index.d.ts",
@@ -86,7 +87,7 @@
     "types"
   ],
   "engines": {
-    "node": ">=18"
+    "node": ">=22"
   },
   "scripts": {
     "build": "tsc",

src/index.js

@@ -1,3 +1,5 @@
-const { fromSql, toSql, SparseVector } = require('./utils');
+import { fromSql, toSql, SparseVector } from './utils/index.js';
 
-module.exports = {fromSql, toSql, SparseVector};
+export { fromSql, toSql, SparseVector };
+
+export default { fromSql, toSql };

src/knex/index.js

@@ -1,5 +1,5 @@
-const knex = require('knex');
-const { fromSql, toSql, vectorType, halfvecType, sparsevecType } = require('../utils');
+import knex from 'knex';
+import { fromSql, toSql, vectorType, halfvecType, sparsevecType } from '../utils/index.js';
 
 knex.SchemaBuilder.extend('enableExtension', function (name) {
   return this.raw('CREATE EXTENSION IF NOT EXISTS ??', [name]);
@@ -44,4 +44,6 @@ knex.QueryBuilder.extend('jaccardDistance', function (column, value) {
   return this.client.raw('?? <%> ?', [column, value]);
 });
 
-module.exports = {fromSql, toSql};
+export { fromSql, toSql };
+
+export default { fromSql, toSql };

src/kysely/index.js

@@ -1,37 +1,30 @@
-const { sql } = require('kysely');
-const { fromSql, toSql } = require('..');
+import { sql } from 'kysely';
+import { fromSql, toSql } from '../utils/index.js';
 
-function l2Distance(column, value) {
+export function l2Distance(column, value) {
   return sql`${sql.ref(column)} <-> ${toSql(value)}`;
 }
 
-function maxInnerProduct(column, value) {
+export function maxInnerProduct(column, value) {
   return sql`${sql.ref(column)} <#> ${toSql(value)}`;
 }
 
-function cosineDistance(column, value) {
+export function cosineDistance(column, value) {
   return sql`${sql.ref(column)} <=> ${toSql(value)}`;
 }
 
-function l1Distance(column, value) {
+export function l1Distance(column, value) {
   return sql`${sql.ref(column)} <+> ${toSql(value)}`;
 }
 
-function hammingDistance(column, value) {
+export function hammingDistance(column, value) {
   return sql`${sql.ref(column)} <~> ${value}`;
 }
 
-function jaccardDistance(column, value) {
+export function jaccardDistance(column, value) {
   return sql`${sql.ref(column)} <%> ${value}`;
 }
 
-module.exports = {
-  fromSql,
-  toSql,
-  l2Distance,
-  maxInnerProduct,
-  cosineDistance,
-  l1Distance,
-  hammingDistance,
-  jaccardDistance
-};
+export { fromSql, toSql };
+
+export default { fromSql, toSql };

src/mikro-orm/bit.js

@@ -1,10 +1,8 @@
-const { Type } = require('@mikro-orm/core');
-const utils = require('../utils');
+import { Type } from '@mikro-orm/core';
+import { bitType } from '../utils/index.js';
 
-class BitType extends Type {
+export class BitType extends Type {
   getColumnType(prop, platform) {
-    return utils.bitType(prop.length);
+    return bitType(prop.length);
   }
 }
-
-module.exports = {BitType};

src/mikro-orm/halfvec.js

@@ -1,24 +1,22 @@
-const { Type } = require('@mikro-orm/core');
-const utils = require('../utils');
+import { Type } from '@mikro-orm/core';
+import { halfvecFromSql, halfvecToSql, halfvecType } from '../utils/index.js';
 
-class HalfvecType extends Type {
+export class HalfvecType extends Type {
   convertToDatabaseValue(value, platform) {
     if (value === null) {
       return null;
     }
-    return utils.halfvecToSql(value);
+    return halfvecToSql(value);
   }
 
   convertToJSValue(value, platform) {
     if (value === null) {
       return null;
     }
-    return utils.halfvecFromSql(value);
+    return halfvecFromSql(value);
   }
 
   getColumnType(prop, platform) {
-    return utils.halfvecType(prop.dimensions);
+    return halfvecType(prop.dimensions);
   }
 }
-
-module.exports = {HalfvecType};

src/mikro-orm/index.js

@@ -1,9 +1,10 @@
-const { raw } = require('@mikro-orm/core');
-const { BitType } = require('./bit');
-const { HalfvecType } = require('./halfvec');
-const { SparsevecType } = require('./sparsevec');
-const { VectorType } = require('./vector');
-const { toSql } = require('../utils');
+import { raw } from '@mikro-orm/core';
+import { toSql } from '../utils/index.js';
+
+export { BitType } from './bit.js';
+export { HalfvecType } from './halfvec.js';
+export { SparsevecType } from './sparsevec.js';
+export { VectorType } from './vector.js';
 
 function distance(op, column, value, em, binary) {
   if (raw) {
@@ -13,39 +14,26 @@ function distance(op, column, value, em, binary) {
   }
 }
 
-function l2Distance(column, value, em) {
+export function l2Distance(column, value, em) {
   return distance('<->', column, value, em);
 }
 
-function maxInnerProduct(column, value, em) {
+export function maxInnerProduct(column, value, em) {
   return distance('<#>', column, value, em);
 }
 
-function cosineDistance(column, value, em) {
+export function cosineDistance(column, value, em) {
   return distance('<=>', column, value, em);
 }
 
-function l1Distance(column, value, em) {
+export function l1Distance(column, value, em) {
   return distance('<+>', column, value, em);
 }
 
-function hammingDistance(column, value, em) {
+export function hammingDistance(column, value, em) {
   return distance('<~>', column, value, em, true);
 }
 
-function jaccardDistance(column, value, em) {
+export function jaccardDistance(column, value, em) {
   return distance('<%>', column, value, em, true);
 }
-
-module.exports = {
-  VectorType,
-  HalfvecType,
-  BitType,
-  SparsevecType,
-  l2Distance,
-  maxInnerProduct,
-  cosineDistance,
-  l1Distance,
-  hammingDistance,
-  jaccardDistance
-};

src/mikro-orm/sparsevec.js

@@ -1,24 +1,22 @@
-const { Type } = require('@mikro-orm/core');
-const utils = require('../utils');
+import { Type } from '@mikro-orm/core';
+import { sparsevecFromSql, sparsevecToSql, sparsevecType } from '../utils/index.js';
 
-class SparsevecType extends Type {
+export class SparsevecType extends Type {
   convertToDatabaseValue(value, platform) {
     if (value === null) {
       return null;
     }
-    return utils.sparsevecToSql(value);
+    return sparsevecToSql(value);
   }
 
   convertToJSValue(value, platform) {
     if (value === null) {
       return null;
     }
-    return utils.sparsevecFromSql(value);
+    return sparsevecFromSql(value);
   }
 
   getColumnType(prop, platform) {
-    return utils.sparsevecType(prop.dimensions);
+    return sparsevecType(prop.dimensions);
   }
 }
-
-module.exports = {SparsevecType};

src/mikro-orm/vector.js

@@ -1,24 +1,22 @@
-const { Type } = require('@mikro-orm/core');
-const utils = require('../utils');
+import { Type } from '@mikro-orm/core';
+import { vectorFromSql, vectorToSql, vectorType } from '../utils/index.js';
 
-class VectorType extends Type {
+export class VectorType extends Type {
   convertToDatabaseValue(value, platform) {
     if (value === null) {
       return null;
     }
-    return utils.vectorToSql(value);
+    return vectorToSql(value);
   }
 
   convertToJSValue(value, platform) {
     if (value === null) {
       return null;
     }
-    return utils.vectorFromSql(value);
+    return vectorFromSql(value);
   }
 
   getColumnType(prop, platform) {
-    return utils.vectorType(prop.dimensions);
+    return vectorType(prop.dimensions);
   }
 }
-
-module.exports = {VectorType};