feat!: migrate to type:module and do not expose default

Author: lpatiny

.eslintrc.yml

@@ -0,0 +1,7 @@
+{
+  "arrowParens": "always",
+  "semi": true,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "trailingComma": "all"
+}

workflows/nodejs.yml .github/workflows/nodejs.ymlworkflows/nodejs.yml renamed to .github/workflows/nodejs.yml

@@ -0,0 +1,4 @@
+import { defineConfig, globalIgnores } from 'eslint/config';
+import cheminfo from 'eslint-config-cheminfo-typescript';
+
+export default defineConfig(globalIgnores(['coverage', 'lib']), cheminfo);

workflows/release.yml .github/workflows/release.ymlworkflows/release.yml renamed to .github/workflows/release.yml

@@ -2,39 +2,25 @@
   "name": "ml-nearest-vector",
   "version": "2.0.1",
   "description": "Find the nearest point to a sample point",
-  "main": "./lib/index.js",
-  "module": "./lib-es6/index.js",
-  "types": "./lib/index.d.ts",
+  "type": "module",
+  "exports": "./lib/index.js",
   "files": [
-    "lib",
-    "lib-es6"
+    "src",
+    "lib"
   ],
   "scripts": {
-    "clean": "rimraf lib lib-es6",
-    "prepublishOnly": "npm run tsc",
-    "test": "npm run test-only && npm run tslint",
-    "test-only": "jest",
-    "tsc": "npm run clean && npm run tsc-es5 && npm run tsc-es6",
-    "tsc-es5": "tsc",
-    "tsc-es6": "tsc --project tsconfig.es6.json",
-    "tslint": "tslint --project tsconfig.base.json",
-    "tslint-fix": "npm run tslint -- --fix"
-  },
-  "jest": {
-    "testEnvironment": "node",
-    "transform": {
-      "^.+\\.tsx?$": "ts-jest"
-    },
-    "testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$",
-    "moduleFileExtensions": [
-      "ts",
-      "tsx",
-      "js",
-      "jsx",
-      "json",
-      "node"
-    ],
-    "collectCoverage": true
+    "check-types": "tsc --noEmit",
+    "clean": "rimraf lib",
+    "eslint": "eslint src",
+    "eslint-fix": "npm run eslint -- --fix",
+    "prepack": "npm run tsc",
+    "prettier": "prettier --check src",
+    "prettier-write": "prettier --write src",
+    "test": "npm run test-only && npm run eslint && npm run prettier && npm run check-types && npm run verify-build",
+    "test-only": "vitest run --coverage",
+    "tsc": "npm run clean && npm run tsc-build",
+    "tsc-build": "tsc --project tsconfig.build.json",
+    "verify-build": "npm run tsc && node lib/index.js"
   },
   "repository": {
     "type": "git",
@@ -57,13 +43,14 @@
   },
   "homepage": "https://github.com/mljs/nearest-vector#readme",
   "devDependencies": {
-    "@types/jest": "^23.3.1",
-    "jest": "^23.5.0",
-    "rimraf": "^2.6.2",
-    "ts-jest": "^23.1.3",
-    "tslint": "^5.11.0",
-    "tslint-config-prettier": "^1.14.0",
-    "typescript": "^3.0.1"
+    "@types/node": "^24.10.1",
+    "@vitest/coverage-v8": "^4.0.8",
+    "@zakodium/tsconfig": "^1.0.2",
+    "eslint-config-cheminfo-typescript": "^21.0.1",
+    "prettier": "^3.6.2",
+    "rimraf": "^6.1.0",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.8"
   },
   "dependencies": {
     "ml-distance-euclidean": "^2.0.0"

workflows/typedoc.yml .github/workflows/typedoc.ymlworkflows/typedoc.yml renamed to .github/workflows/typedoc.yml

@@ -0,0 +1,87 @@
+import { describe, expect, it, test } from 'vitest';
+
+import { findNearestVector, nearestVector } from '../index.js';
+
+function cosineSimilarity(a: number[], b: number[]) {
+  const ii = a.length;
+
+  let p = 0;
+
+  let p2 = 0;
+
+  let q2 = 0;
+  for (let i = 0; i < ii; i++) {
+    p += a[i] * b[i];
+    p2 += a[i] * a[i];
+    q2 += b[i] * b[i];
+  }
+  return p / (Math.sqrt(p2) * Math.sqrt(q2));
+}
+
+test('Distance tests', () => {
+  const centers = [
+    [1, 2, 1],
+    [-1, -1, -1],
+  ];
+  const data = [
+    [1, 1, 1],
+    [1, 2, 1],
+    [-1, -1, -1],
+    [-1, -1, -1.5],
+  ];
+  const clusterID = [0, 0, 1, 1];
+
+  for (let i = 0; i < clusterID.length; i++) {
+    expect(nearestVector(centers, data[i])).toBe(clusterID[i]);
+  }
+});
+
+describe('Similarity tests', () => {
+  const centers = [
+    [1, 2, 1],
+    [-1, -1, -1],
+  ];
+  const data = [
+    [1, 1, 1],
+    [1, 2, 1],
+    [-1, -1, -1],
+    [-1, -1, -1.5],
+  ];
+  const clusterID = [0, 0, 1, 1];
+
+  // cosine similarity
+  const options = { similarityFunction: cosineSimilarity };
+
+  it('Find nearest vector with cosine similarity', () => {
+    for (let i = 0; i < clusterID.length; i++) {
+      expect(nearestVector(centers, data[i], options)).toBe(clusterID[i]);
+    }
+  });
+
+  it('Throws for non-function', () => {
+    //@ts-expect-error testing invalid input
+    expect(nearestVector.bind(null, [], [], { distanceFunction: 1 })).toThrow(
+      "A similarity or distance function it's required",
+    );
+  });
+
+  it('find nearest vector', () => {
+    const centers = [
+      [1, 2, 1],
+      [-1, -1, -1],
+    ];
+    const data = [
+      [1, 1, 1],
+      [1, 2, 1],
+      [-1, -1, -1],
+      [-1, -1, -1.5],
+    ];
+    const clusterID = [0, 0, 1, 1];
+
+    for (let i = 0; i < clusterID.length; i++) {
+      expect(findNearestVector(centers, data[i])).toStrictEqual(
+        centers[clusterID[i]],
+      );
+    }
+  });
+});

.prettierrc.json

@@ -1,9 +1,7 @@
-'use strict';
-
 import { squaredEuclidean } from 'ml-distance-euclidean';
 
 const defaultOptions: IOptions = {
-  distanceFunction: squaredEuclidean
+  distanceFunction: squaredEuclidean,
 };
 
 type Vector = number[];
@@ -14,10 +12,10 @@ interface IOptions {
   similarityFunction?: (vector1: Vector, vector2: Vector) => number;
 }
 
-export default function nearestVector(
+export function nearestVector(
   listVectors: Matrix,
   vector: number[],
-  options: IOptions = defaultOptions
+  options: IOptions = defaultOptions,
 ) {
   const distanceFunction =
     options.distanceFunction || defaultOptions.distanceFunction;
@@ -55,7 +53,7 @@ export default function nearestVector(
 export function findNearestVector(
   vectorList: Matrix,
   vector: Vector,
-  options: IOptions = defaultOptions
+  options: IOptions = defaultOptions,
 ) {
   const index = nearestVector(vectorList, vector, options);
   return vectorList[index];