Move to ESM and dynamic imports

BREAKING CHANGE: ESM breaks everything, this is no exception

Author: djMax

.gitignore

@@ -26,7 +26,7 @@ coverage
 tsconfig.json
 tsconfig.build.json
 jest.config.js
-.prettierrc.js
-.eslintrc.js
 .commitlintrc.json
 vitest.config.ts
+.eslintrc.cjs
+.prettierrc.cjs

Makefile

@@ -20,7 +20,7 @@
 # all: service dbi ts
 #
 
-build_dir := $(shell node -e "console.log(require('./package.json').main.replace(/^.\//, '').split('/')[0])")
+build_dir := $(shell node -e "console.log(require('./package.json').exports.replace(/^.\//, '').split('/')[0])")
 src_files := $(shell find src -name '*.ts')
 build_files := $(patsubst src/%.ts,$(build_dir)/%.js,$(src_files))
 camel_case_name := $(shell echo $(SERVICE_NAME) | awk -F- '{result=""; for(i=1; i<=NF; i++) result = result toupper(substr($$i,1,1)) substr($$i,2); print result}' | tr -d '\n')

__tests__/config.test.ts

@@ -3,8 +3,8 @@ import path from 'path';
 
 import { describe, expect, test } from 'vitest';
 
-import { ConfigurationSchema, insertConfigurationBefore, loadConfiguration } from '../src/config';
-import { shortstops } from '../src/config/shortstops';
+import { ConfigurationSchema, insertConfigurationBefore, loadConfiguration } from '../src/config/index.js';
+import { shortstops } from '../src/config/shortstops.js';
 
 interface CustomConfig extends ConfigurationSchema {
   google: string;

__tests__/fake-serv.test.ts

@@ -8,9 +8,9 @@ import {
   listen,
   ServiceStartOptions,
   startApp,
-} from '../src/index';
+} from '../src/index.js';
 
-import { type FakeServLocals, service } from './fake-serv/src/index';
+import { type FakeServLocals, service } from './fake-serv/src/index.js';
 
 function httpRequest(options: http.RequestOptions) {
   return new Promise((resolve, reject) => {

__tests__/fake-serv/src/index.ts

@@ -1,5 +1,5 @@
-import type { Service, ServiceLocals } from '../../../src/types';
-import { useService } from '../../../src';
+import type { Service, ServiceLocals } from '../../../src/types.js';
+import { useService } from '../../../src/index.js';
 
 export interface FakeServLocals extends ServiceLocals {
   services: {

package.json

@@ -2,7 +2,8 @@
   "name": "@openapi-typescript-infra/service",
   "version": "4.10.2",
   "description": "An opinionated framework for building configuration driven services - web, api, or  ob. Uses OpenAPI, pino logging, express, confit, Typescript and vitest.",
-  "main": "build/index.js",
+  "exports": "./build/index.js",
+  "type": "module",
   "scripts": {
     "test": "vitest",
     "lint": "eslint .",
@@ -68,10 +69,10 @@
     "@opentelemetry/instrumentation-http": "^0.53.0",
     "@opentelemetry/instrumentation-ioredis": "^0.43.0",
     "@opentelemetry/instrumentation-net": "^0.39.0",
-    "@opentelemetry/instrumentation-pg": "^0.45.1",
+    "@opentelemetry/instrumentation-pg": "^0.46.0",
     "@opentelemetry/instrumentation-pino": "^0.42.0",
     "@opentelemetry/instrumentation-undici": "^0.6.0",
-    "@opentelemetry/resource-detector-container": "^0.4.3",
+    "@opentelemetry/resource-detector-container": "^0.4.4",
     "@opentelemetry/resource-detector-gcp": "^0.29.12",
     "@opentelemetry/sdk-node": "^0.53.0",
     "@opentelemetry/semantic-conventions": "^1.27.0",
@@ -82,11 +83,11 @@
     "dotenv": "^16.4.5",
     "express": "^5.0.1",
     "express-openapi-validator": "^5.3.7",
-    "glob": "^8.1.0",
+    "glob": "^11.0.0",
     "lodash": "^4.17.21",
     "minimist": "^1.2.8",
-    "pino": "^9.4.0",
-    "read-pkg-up": "^7.0.1",
+    "pino": "^9.5.0",
+    "read-package-up": "^11.0.0",
     "request-ip": "^3.3.0"
   },
   "devDependencies": {
@@ -99,25 +100,25 @@
     "@semantic-release/release-notes-generator": "^14.0.1",
     "@types/cookie-parser": "^1.4.7",
     "@types/express": "^5.0.0",
-    "@types/glob": "^8.1.0",
     "@types/lodash": "^4.17.10",
     "@types/minimist": "^1.2.5",
-    "@types/node": "^20.16.11",
+    "@types/node": "^22.7.6",
     "@types/request-ip": "^0.0.41",
     "@types/supertest": "^6.0.2",
-    "@typescript-eslint/eslint-plugin": "^6.21.0",
-    "@typescript-eslint/parser": "^6.21.0",
+    "@typescript-eslint/eslint-plugin": "^7.18.0",
+    "@typescript-eslint/parser": "^7.18.0",
     "coconfig": "^1.5.2",
     "eslint": "^8.57.1",
     "eslint-config-prettier": "^9.1.0",
+    "eslint-import-resolver-typescript": "^3.6.3",
     "eslint-plugin-import": "^2.31.0",
-    "pino-pretty": "^11.2.2",
+    "pino-pretty": "^11.3.0",
     "pinst": "^3.0.0",
     "supertest": "^7.0.0",
     "ts-node": "^10.9.2",
     "tsconfig-paths": "^4.2.0",
     "typescript": "^5.6.3",
-    "vitest": "^2.1.2"
+    "vitest": "^2.1.3"
   },
   "resolutions": {
     "qs": "^6.11.0"

src/bin/start-service.ts

@@ -1,9 +1,9 @@
 #!/usr/bin/env node
 import minimist from 'minimist';
 
-import { serviceRepl } from '../development/repl';
-import { isDev } from '../env';
-import { bootstrap } from '../bootstrap';
+import { serviceRepl } from '../development/repl.js';
+import { isDev } from '../env.js';
+import { bootstrap } from '../bootstrap.js';
 
 /**
  * built - forces the use of the build directory. Defaults to true in stage/prod, not in dev

src/bootstrap.ts

@@ -1,21 +1,21 @@
 import path from 'node:path';
 import assert from 'node:assert';
 
-import dotenv from 'dotenv';
-import readPackageUp from 'read-pkg-up';
-import type { NormalizedPackageJson } from 'read-pkg-up';
+import { config } from 'dotenv';
+import { readPackageUp } from 'read-package-up';
+import type { NormalizedPackageJson } from 'read-package-up';
 
-import type { AnyServiceLocals, RequestLocals, ServiceLocals, ServiceStartOptions } from './types';
-import { isDev } from './env';
-import { startWithTelemetry } from './telemetry/index';
-import { ConfigurationSchema } from './config/schema';
+import type { AnyServiceLocals, RequestLocals, ServiceLocals, ServiceStartOptions } from './types.js';
+import { isDev } from './env.js';
+import { startWithTelemetry } from './telemetry/index.js';
+import { ConfigurationSchema } from './config/schema.js';
 
 interface BootstrapArguments {
-  // The name of the service, else discovered via read-pkg-up
+  // The name of the service, else discovered via read-package-up
   name?: string;
   // The name of the file with the service function, relative to root
   main?: string;
-  // Root directory of the app, else discovered via read-pkg-up
+  // Root directory of the app, else discovered via read-package-up
   root?: string;
   // Use built directory. Omitting lets us determine a sensible default
   built?: boolean;
@@ -25,7 +25,7 @@ interface BootstrapArguments {
   telemetry?: boolean;
   // Don't bind to http port or expose metrics
   nobind?: boolean;
-  // The version of the app, else discovered via read-pkg-up
+  // The version of the app, else discovered via read-package-up
   version?: string;
 }
 
@@ -84,11 +84,6 @@ export async function bootstrap<
     // eslint-disable-next-line import/no-extraneous-dependencies
     const { register } = await import('ts-node');
     register();
-    try {
-      require('tsconfig-paths/register');
-    } catch (error) {
-      // No action needed
-    }
     if (main) {
       entrypoint = main.replace(/^(\.?\/?)(build|dist)\//, '$1src/').replace(/\.js$/, '.ts');
     } else {
@@ -102,7 +97,7 @@ export async function bootstrap<
     entrypoint = './build/index.js';
   }
 
-  dotenv.config();
+  config();
 
   const absoluteEntrypoint = path.resolve(rootDirectory, entrypoint);
   if (argv?.telemetry) {
@@ -117,7 +112,7 @@ export async function bootstrap<
 
   // This needs to be required for TS on-the-fly to work
   // eslint-disable-next-line global-require, import/no-dynamic-require, @typescript-eslint/no-var-requires
-  const impl = require(absoluteEntrypoint);
+  const impl = await import(absoluteEntrypoint);
   const opts: ServiceStartOptions<SLocals, RLocals> = {
     name,
     version,

src/config/index.ts

@@ -9,9 +9,9 @@ import {
   confit,
 } from '@sesamecare-oss/confit';
 
-import { getAvailablePort } from '../development/port-finder';
+import { getAvailablePort } from '../development/port-finder.js';
 
-import type { ConfigurationSchema } from './schema';
+import type { ConfigurationSchema } from './schema.js';
 
 // Order matters here.
 const ENVIRONMENTS = ['production', 'staging', 'test', 'development'] as const;
@@ -121,5 +121,5 @@ export function insertConfigurationBefore(
   return copy;
 }
 
-export * from './schema';
-export * from './validation';
+export * from './schema.js';
+export * from './validation.js';

src/config/validation.ts

@@ -1,4 +1,4 @@
-import { ConfigurationSchema } from './schema';
+import { ConfigurationSchema } from './schema.js';
 
 export interface ConfigValidationError {
   path: string;