chore: upgrade dependencies and make package ESM only

.github/workflows/nodejs.yml

@@ -13,16 +13,18 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+      - uses: actions/checkout@v6
+      - uses: actions/setup-node@v6
         with:
-          node-version: 20.x
+          node-version: 22.x
       - name: Install dependencies
         run: npm install
       - name: Run ESLint
         run: npm run eslint
       - name: Check types
         run: npm run check-types
+      - name: Test package
+        uses: zakodium/test-package-action@v1
   test:
     services:
       couchdb:
@@ -50,16 +52,17 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [20.x, 22.x, 24.x]
+        node-version: [22.x, 24.x]
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@v6
         with:
           node-version: ${{ matrix.node-version }}
       - name: Install dependencies
         run: npm install
       - name: Run tests
         run: npm run test-coverage
       - name: Send coverage report to Codecov
+        if: ${{ matrix.node-version == '22.x' }}
         uses: codecov/codecov-action@v5

.gitignore

@@ -33,11 +33,11 @@ build/Release
 node_modules
 jspm_packages
 
-# Optional npm cache directory
+# Cache
 .npm
+.eslintcache
 
 # Optional REPL history
 .node_repl_history
 
 lib
-lib-es6

.prettierignore

@@ -0,0 +1 @@
+CHANGELOG.md

docker-compose.yml → compose.yml

@@ -5,10 +5,12 @@ services:
       COUCHDB_USER: admin
       COUCHDB_PASSWORD: admin
     ports:
-      - 5984:5984
+      - 127.0.0.1:5984:5984
   rest-on-couch:
     build: ./rest-on-couch
     ports:
-      - 4000:4000
+      - 127.0.0.1:4000:4000
     env_file:
       - .env.test
+    depends_on:
+      - couchdb

eslint.config.mjs

@@ -0,0 +1,43 @@
+import { defineConfig, globalIgnores } from 'eslint/config';
+import ts from 'eslint-config-zakodium/ts';
+import vitest from 'eslint-config-zakodium/vitest-ts';
+
+export default defineConfig(
+  globalIgnores(['rest-on-couch/**', 'lib/**']),
+  ts,
+  vitest,
+  {
+    files: ['**/*.ts'],
+    rules: {
+      camelcase: 'off',
+      '@typescript-eslint/no-dynamic-delete': 'off',
+      '@typescript-eslint/naming-convention': [
+        'error',
+        { selector: ['typeLike'], format: ['PascalCase'] },
+        { selector: ['variable'], format: ['camelCase', 'UPPER_CASE'] },
+        { selector: ['function'], format: ['camelCase', 'PascalCase'] },
+        {
+          selector: [
+            'method',
+            'classProperty',
+            'classMethod',
+            'parameterProperty',
+            'accessor',
+            'typeProperty',
+            'typeMethod',
+          ],
+          format: ['camelCase', 'snake_case'],
+          leadingUnderscore: 'allow',
+        },
+        {
+          selector: [
+            'objectLiteralProperty',
+            'objectLiteralMethod',
+            'enumMember',
+          ],
+          format: null,
+        },
+      ],
+    },
+  },
+);

package.json

@@ -2,26 +2,27 @@
   "name": "rest-on-couch-client",
   "version": "6.0.0",
   "description": "A nodejs / browser client for rest-on-couch backend",
-  "main": "./lib/index.js",
-  "module": "./lib-es6/index.js",
+  "type": "module",
+  "exports": {
+    ".": "./lib/index.js"
+  },
   "types": "./lib/index.d.ts",
   "files": [
-    "lib",
-    "lib-es6"
+    "lib"
   ],
   "scripts": {
     "check-types": "tsc --noEmit",
-    "clean": "rimraf lib lib-es6",
-    "eslint": "eslint src --ext ts",
+    "clean": "rimraf lib",
+    "eslint": "eslint . --cache",
     "eslint-fix": "npm run eslint -- --fix",
     "prepare": "npm run tsc",
+    "prettier": "prettier --check .",
+    "prettier-write": "prettier --write .",
     "test": "npm run test-coverage && npm run eslint && npm run check-types",
-    "test-only": "jest --runInBand",
-    "test-coverage": "jest --coverage --runInBand",
-    "test-watch": "jest --runInBand --watch",
-    "tsc": "npm run clean && npm run tsc-es5 && npm run tsc-es6",
-    "tsc-es5": "tsc",
-    "tsc-es6": "tsc --project tsconfig.es6.json"
+    "test-only": "vitest run",
+    "test-coverage": "vitest run --coverage",
+    "test-watch": "vitest",
+    "tsc": "npm run clean && tsc --project tsconfig.build.json"
   },
   "repository": {
     "type": "git",
@@ -34,24 +35,20 @@
     "url": "https://github.com/cheminfo/rest-on-couch-client/issues"
   },
   "homepage": "https://github.com/cheminfo/rest-on-couch-client#readme",
-  "jest": {
-    "preset": "ts-jest",
-    "testEnvironment": "node"
-  },
   "devDependencies": {
-    "@types/jest": "^27.4.1",
-    "@types/node": "^18.17.1",
-    "eslint": "^8.13.0",
-    "eslint-config-zakodium": "^10.0.0",
-    "jest": "^30.0.4",
-    "prettier": "^3.6.2",
-    "rimraf": "^6.0.1",
-    "ts-jest": "^29.4.0",
-    "typescript": "^5.8.3"
+    "@types/node": "^22.19.7",
+    "@vitest/coverage-v8": "^4.0.18",
+    "@zakodium/tsconfig": "^1.0.2",
+    "eslint": "^9.39.2",
+    "eslint-config-zakodium": "^19.1.0",
+    "prettier": "^3.8.1",
+    "rimraf": "^6.1.2",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.18"
   },
   "dependencies": {
-    "axios": "^1.10.0",
-    "immer": "^10.1.1"
+    "axios": "^1.13.3",
+    "immer": "^11.1.3"
   },
   "prettier": {
     "arrowParens": "always",
@@ -61,6 +58,6 @@
     "trailingComma": "all"
   },
   "volta": {
-    "node": "20.19.3"
+    "node": "22.22.0"
   }
 }

rest-on-couch/Dockerfile

@@ -1,7 +1,4 @@
-FROM ghcr.io/cheminfo/rest-on-couch:15
-
-# Install system packages
-RUN apt-get update && apt-get install -y vim
+FROM ghcr.io/cheminfo/rest-on-couch:19
 
 # Copy ROC scripts
 COPY wait.sh start.sh create_db.sh /
@@ -11,4 +8,4 @@ RUN chmod +x /wait.sh /start.sh /create_db.sh
 COPY home /rest-on-couch/
 
 
-CMD ["/start.sh"]
+CMD ["/start.sh"]

rest-on-couch/home/config.js

@@ -33,6 +33,7 @@ module.exports = {
   username: 'rest-on-couch',
   superAdministrators: ['admin@goodyear.com'],
   password: process.env.COUCHDB_ROC_SERVER_PASSWORD,
+  adminPassword: process.env.COUCHDB_ROC_ADMIN_PASSWORD,
   logLevel: 'TRACE',
   // Make sure logged audit actions get the ip address from 'X-Forwarded-For' header
   proxy: true,

src/index.ts

@@ -1,3 +1,3 @@
-export * from './roc';
-export * from './types';
-export * from './helpers';
+export * from './roc/index.ts';
+export * from './types.ts';
+export * from './helpers.ts';

src/roc/Find.ts

@@ -1,14 +1,13 @@
-import { AxiosInstance } from 'axios';
+import type { AxiosInstance } from 'axios';
 
-import {
+import type {
   IFindOptions,
   IFindQueryResult,
   PromisedFindQueryResult,
   RocAxiosRequestOptions,
-} from '../types';
+} from '../types.ts';
 
 export default class Find<ResultType> {
-  public readonly viewName: string;
   protected baseOptions: IFindOptions;
   private request: AxiosInstance;
   public constructor(options: IFindOptions, request: AxiosInstance) {

src/roc/Query.ts

@@ -1,11 +1,11 @@
-import { AxiosInstance } from 'axios';
+import type { AxiosInstance } from 'axios';
 
-import { IQueryResult } from '..';
-import {
+import type { IQueryResult } from '../index.ts';
+import type {
   IQueryOptions,
   PromisedQueryResult,
   RocAxiosRequestOptions,
-} from '../types';
+} from '../types.ts';
 
 export default class Query<KeyType, ValueType, ContentType> {
   public readonly viewName: string;

src/roc/ReduceQuery.ts

@@ -1,12 +1,12 @@
-import { AxiosInstance } from 'axios';
+import type { AxiosInstance } from 'axios';
 
-import { IReduceQueryResult } from '..';
-import {
+import type { IReduceQueryResult } from '../index.ts';
+import type {
   IReduceQueryOptions,
   IRocReduceQueryParams,
   PromisedReduceQueryResult,
   RocAxiosRequestOptions,
-} from '../types';
+} from '../types.ts';
 
 export default class ReduceQuery<KeyType = unknown, ValueType = unknown> {
   public readonly viewName: string;

src/roc/Roc.ts

@@ -1,7 +1,8 @@
-import axios, { AxiosInstance } from 'axios';
+import type { AxiosInstance } from 'axios';
+import axios from 'axios';
 
-import { ICouchGroupInfo, IEntryDocument } from '..';
-import {
+import type { ICouchGroupInfo, IEntryDocument } from '../index.ts';
+import type {
   ICouchUser,
   ICouchUserGroup,
   IFindOptions,
@@ -12,13 +13,14 @@ import {
   IViewOptions,
   Ok,
   RocAxiosRequestOptions,
-} from '../types';
-
-import Find from './Find';
-import Query from './Query';
-import ReduceQuery from './ReduceQuery';
-import RocDocument, { RocDocumentOptions } from './RocDocument';
-import View from './View';
+} from '../types.ts';
+
+import Find from './Find.ts';
+import Query from './Query.ts';
+import ReduceQuery from './ReduceQuery.ts';
+import type { RocDocumentOptions } from './RocDocument.ts';
+import RocDocument from './RocDocument.ts';
+import View from './View.ts';
 
 export interface IRocConfig {
   url: string;

src/roc/RocDocument.ts

@@ -1,15 +1,16 @@
-import { AxiosInstance } from 'axios';
+import type { AxiosInstance } from 'axios';
 
-import { FetchAttachmentType, IAttachment } from '..';
-import { RocClientError } from '../Error';
-import {
+import { RocClientError } from '../Error.ts';
+import type { FetchAttachmentType, IAttachment } from '../index.ts';
+import type {
   IEntryDocument,
   IEntryDocumentDraft,
   INewAttachment,
   RocAxiosRequestOptions,
-} from '../types';
+} from '../types.ts';
+import { assert } from '../util/assert.ts';
 
-import { addInlineUploads, deleteInlineUploads } from './utils';
+import { addInlineUploads, deleteInlineUploads } from './utils.ts';
 
 export interface RocDocumentOptions {
   allowAttachmentOverwrite: boolean;
@@ -78,13 +79,14 @@ export default class RocDocument<
     deleteAttachments?: string[],
     axiosOptions?: RocAxiosRequestOptions,
   ): Promise<IEntryDocument<ContentType, IdType>> {
-    if (typeof content === 'object' && '_id' in content) {
+    if (content && typeof content === 'object' && '_id' in content) {
       throw new Error(
         'Your content contains an _id proprerty. This is probably an error since you should not pass the entire document, only $content',
       );
     }
 
     await this._fetchIfUnfetched();
+    assert(this.value, 'Unreachable: fetched value is undefined');
     let newDoc: IEntryDocumentDraft<ContentType, IdType> = {
       ...this.value,
       $content: content,