@openapi-typescript-infra/service 4.27.2 → 5.0.0

package/build/types.d.ts

@@ -1,12 +1,12 @@
 import type { Server } from 'http';
 import type { REPLServer } from 'repl';
-import type pino from 'pino';
+import type { pino } from 'pino';
 import type { Request, Response } from 'express';
 import type { Application } from 'express-serve-static-core';
 import type { middleware } from 'express-openapi-validator';
 import type { Meter } from '@opentelemetry/api';
 import { ShortstopHandler } from '@sesamecare-oss/confit';
-import { ConfigurationSchema } from './config/schema';
+import { ConfigurationSchema } from './config/schema.js';
 export interface InternalLocals<SLocals extends AnyServiceLocals = ServiceLocals<ConfigurationSchema>> extends Record<string, unknown> {
     server?: Server;
     mainApp: ServiceExpress<SLocals>;

package/build/types.js

@@ -1,3 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};
 //# sourceMappingURL=types.js.map

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@openapi-typescript-infra/service",
-  "version": "4.27.2",
+  "version": "5.0.0",
   "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"

package/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

package/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,

package/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';

package/src/config/validation.ts

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

package/src/development/port-finder.ts

@@ -1,6 +1,6 @@
 import net from 'net';
 
-import { isTest } from '../env';
+import { isTest } from '../env.js';
 
 // Inspired by https://github.com/kessler/find-port/blob/master/lib/findPort.js
 async function isAvailable(port: number) {

package/src/development/repl.ts

@@ -5,8 +5,8 @@ import path from 'path';
 import { glob } from 'glob';
 import { set } from 'lodash';
 
-import { AnyServiceLocals, ServiceExpress, ServiceLocals } from '../types';
-import { ConfigurationSchema } from '../config/schema';
+import { AnyServiceLocals, ServiceExpress, ServiceLocals } from '../types.js';
+import { ConfigurationSchema } from '../config/schema.js';
 
 const REPL_PROP = '$$repl$$';
 
@@ -42,7 +42,7 @@ export function serviceRepl<SLocals extends AnyServiceLocals = ServiceLocals<Con
   rl.on('exit', onExit);
 }
 
-function loadReplFunctions<SLocals extends AnyServiceLocals = ServiceLocals<ConfigurationSchema>>(
+async function loadReplFunctions<SLocals extends AnyServiceLocals = ServiceLocals<ConfigurationSchema>>(
   app: ServiceExpress<SLocals>,
   codepath: string | undefined,
   rl: REPLServer,
@@ -53,15 +53,14 @@ function loadReplFunctions<SLocals extends AnyServiceLocals = ServiceLocals<Conf
 
   const files = glob.sync(path.join(codepath, '**/*.{js,ts}'));
 
-  files.forEach((file) => {
+  for (const file of files) {
     try {
       // Read the file content as text
       const fileContent = fs.readFileSync(file, 'utf-8');
 
       // Check if repl$ is present, in a very rudimentary way (note built JS has close paren not open)
       if (/repl\$[()]/.test(fileContent)) {
-        // eslint-disable-next-line global-require, import/no-dynamic-require, @typescript-eslint/no-var-requires
-        const module = require(path.resolve(file));
+        const module = await import(path.resolve(file));
 
         // Look for functions with the REPL_PROP marker
         Object.values(module).forEach((exported) => {
@@ -79,7 +78,7 @@ function loadReplFunctions<SLocals extends AnyServiceLocals = ServiceLocals<Conf
     } catch (err) {
       console.error(`Failed to load REPL functions from ${file}:`, err);
     }
-  });
+  }
 }
 
 // Can't seem to sort out proper generics here, so we'll just use any since it's dev only

package/src/error.ts

@@ -1,5 +1,5 @@
-import { ConfigurationSchema } from './config/schema';
-import type { AnyServiceLocals, ServiceLike, ServiceLocals } from './types';
+import { ConfigurationSchema } from './config/schema.js';
+import type { AnyServiceLocals, ServiceLike, ServiceLocals } from './types.js';
 
 export interface ServiceErrorSpec {
   status?: number;

package/src/express-app/app.ts

@@ -10,13 +10,13 @@ import { setupNodeMetrics } from '@sesamecare-oss/opentelemetry-node-metrics';
 import { createTerminus } from '@godaddy/terminus';
 import type { RequestHandler, Response } from 'express';
 
-import { loadConfiguration } from '../config/index';
-import { openApi } from '../openapi';
+import { loadConfiguration } from '../config/index.js';
+import { openApi } from '../openapi.js';
 import {
   errorHandlerMiddleware,
   loggerMiddleware,
   notFoundMiddleware,
-} from '../telemetry/requestLogger';
+} from '../telemetry/requestLogger.js';
 import type {
   AnyServiceLocals,
   RequestLocals,
@@ -25,14 +25,14 @@ import type {
   ServiceLocals,
   ServiceOptions,
   ServiceStartOptions,
-} from '../types';
-import { ConfigurationSchema } from '../config/schema';
-import { shortstops } from '../config/shortstops';
-import { getNodeEnv, isDev } from '../env';
-import { getGlobalPrometheusExporter } from '../telemetry/index';
-
-import { loadRoutes } from './route-loader';
-import { startInternalApp } from './internal-server';
+} from '../types.js';
+import { ConfigurationSchema } from '../config/schema.js';
+import { shortstops } from '../config/shortstops.js';
+import { getNodeEnv, isDev } from '../env.js';
+import { getGlobalPrometheusExporter } from '../telemetry/index.js';
+
+import { loadRoutes } from './route-loader.js';
+import { startInternalApp } from './internal-server.js';
 
 function isSyncLogging() {
   if (process.env.LOG_SYNC) {

package/src/express-app/index.ts

@@ -1,3 +1,3 @@
-export * from './app';
-export * from './types';
-export * from './modules';
+export * from './app.js';
+export * from './types.js';
+export * from './modules.js';

package/src/express-app/internal-server.ts

@@ -1,9 +1,9 @@
 import express from 'express';
 import type { Application } from 'express-serve-static-core';
 
-import { AnyServiceLocals, InternalLocals, ServiceExpress, ServiceLocals } from '../types';
-import { getAvailablePort } from '../development/port-finder';
-import { ConfigurationSchema } from '../config/schema';
+import { AnyServiceLocals, InternalLocals, ServiceExpress, ServiceLocals } from '../types.js';
+import { getAvailablePort } from '../development/port-finder.js';
+import { ConfigurationSchema } from '../config/schema.js';
 
 export async function startInternalApp<
   SLocals extends AnyServiceLocals = ServiceLocals<ConfigurationSchema>,

package/src/express-app/modules.ts

@@ -1,28 +1,10 @@
 import { glob } from 'glob';
 
-export async function loadModule(path: string): Promise<Record<string, unknown>> {
-  try {
-    return require(path);
-  } catch (error) {
-    if ((error as Error).message.includes('Cannot use import statement outside a module')) {
-      return import(path);
-    }
-    throw error;
-  }
-}
-
 export async function getFilesInDir(pattern: string, dir: string) {
-  const files: string[] = await new Promise((accept, reject) => {
-    glob(
-      pattern,
-      {
-        nodir: true,
-        strict: true,
-        cwd: dir,
-        ignore: ['**/*.spec.@(js|ts)', '**/*.test.@(js|ts)', '**/*.fixtures.@(js|ts)'],
-      },
-      (error, matches) => (error ? reject(error) : accept(matches)),
-    );
+  const files = await glob(pattern, {
+    nodir: true,
+    cwd: dir,
+    ignore: ['**/*.spec.@(js|ts)', '**/*.test.@(js|ts)', '**/*.fixtures.@(js|ts)'],
   });
   return files;
 }

package/src/express-app/route-loader.ts

@@ -1,11 +1,11 @@
 import path from 'path';
 
-import express from 'express';
+import { Router } from 'express';
 
-import type { AnyServiceLocals, ServiceExpress, ServiceLocals } from '../types';
-import { ConfigurationSchema } from '../config/schema';
+import type { AnyServiceLocals, ServiceExpress, ServiceLocals } from '../types.js';
+import { ConfigurationSchema } from '../config/schema.js';
 
-import { getFilesInDir, loadModule } from './modules';
+import { getFilesInDir } from './modules.js';
 
 export async function loadRoutes<
   SLocals extends AnyServiceLocals = ServiceLocals<ConfigurationSchema>,
@@ -16,10 +16,10 @@ export async function loadRoutes<
     files.map(async (filename) => {
       const routeBase = path.dirname(filename);
       const modulePath = path.resolve(routingDir, filename);
-      const module = await loadModule(modulePath);
+      const module = await import(modulePath);
       const mounter = module.default || module.route;
       if (typeof mounter === 'function') {
-        const childRouter = express.Router();
+        const childRouter = Router();
         mounter(childRouter, app);
         const pathParts = [''];
         if (routeBase !== '.') {

package/src/express-app/types.ts

@@ -1,7 +1,7 @@
 import type { NextFunction, Response } from 'express';
 
-import type { AnyServiceLocals, RequestLocals, RequestWithApp, ServiceLocals } from '../types';
-import { ConfigurationSchema } from '../config/schema';
+import type { AnyServiceLocals, RequestLocals, RequestWithApp, ServiceLocals } from '../types.js';
+import { ConfigurationSchema } from '../config/schema.js';
 
 export type ServiceHandler<
   SLocals extends AnyServiceLocals = ServiceLocals<ConfigurationSchema>,

package/src/hook.ts

@@ -1,5 +1,5 @@
-import { ConfigurationSchema } from './config/schema';
-import type { AnyServiceLocals, RequestLocals, Service, ServiceLocals } from './types';
+import { ConfigurationSchema } from './config/schema.js';
+import type { AnyServiceLocals, RequestLocals, Service, ServiceLocals } from './types.js';
 
 /**
  * Your service should call this function and then "inherit"

package/src/index.ts

@@ -1,9 +1,9 @@
-export * from './telemetry';
-export * from './express-app';
-export * from './types';
-export * from './env';
-export * from './config';
-export * from './error';
-export * from './bootstrap';
-export * from './hook';
-export { repl$ } from './development/repl';
+export * from './telemetry/index.js';
+export * from './express-app/index.js';
+export * from './types.js';
+export * from './env.js';
+export * from './config/index.js';
+export * from './error.js';
+export * from './bootstrap.js';
+export * from './hook.js';
+export { repl$ } from './development/repl.js';

package/src/openapi.ts

@@ -2,13 +2,13 @@ import path from 'path';
 
 import _ from 'lodash';
 import * as OpenApiValidator from 'express-openapi-validator';
-import { OpenAPIFramework } from 'express-openapi-validator/dist/framework/index';
+import { OpenAPIFramework } from 'express-openapi-validator/dist/framework/index.js';
 import type { Handler, Request, RequestHandler } from 'express';
 
-import type { AnyServiceLocals, ServiceExpress, ServiceLocals } from './types';
-import { getNodeEnv } from './env';
-import { getFilesInDir, loadModule } from './express-app/modules';
-import { ConfigurationSchema } from './config/schema';
+import type { AnyServiceLocals, ServiceExpress, ServiceLocals } from './types.js';
+import { getNodeEnv } from './env.js';
+import { getFilesInDir } from './express-app/modules.js';
+import { ConfigurationSchema } from './config/schema.js';
 
 const notImplementedHandler: Handler = (req, res) => {
   res.status(501).json({
@@ -46,7 +46,7 @@ export async function openApi<
   const preloadedModules = await Promise.all(
     moduleFiles.map((file) => {
       const fullPath = path.join(basePath, file);
-      return loadModule(fullPath).catch((error) => {
+      return import(fullPath).catch((error) => {
         app.locals.logger.warn(
           { file: fullPath, message: error.message },
           'Could not load potential API handler',

package/src/telemetry/index.ts

@@ -16,12 +16,12 @@ import type {
   RequestLocals,
   ServiceLocals,
   ServiceStartOptions,
-} from '../types';
-import type { ListenFn, StartAppFn } from '../express-app/index';
-import type { ConfigurationSchema } from '../config/schema';
+} from '../types.js';
+import type { ListenFn, StartAppFn } from '../express-app/index.js';
+import type { ConfigurationSchema } from '../config/schema.js';
 
-import { getAutoInstrumentations } from './instrumentations';
-import { DummySpanExporter } from './DummyExporter';
+import { getAutoInstrumentations } from './instrumentations.js';
+import { DummySpanExporter } from './DummyExporter.js';
 
 // For troubleshooting, set the log level to DiagLogLevel.DEBUG
 opentelemetry.api.diag.setLogger(new (opentelemetry.api.DiagConsoleLogger)(), opentelemetry.api.DiagLogLevel.INFO);

package/src/telemetry/requestLogger.ts

@@ -1,12 +1,12 @@
 import type { RequestHandler, Request, Response, ErrorRequestHandler } from 'express';
-import requestip from 'request-ip';
+import { getClientIp } from 'request-ip';
 import { Histogram } from '@opentelemetry/api';
 
-import { ServiceError } from '../error';
-import type { AnyServiceLocals, RequestWithApp, ServiceExpress, ServiceLocals } from '../types';
-import type { ServiceHandler } from '../express-app/types';
-import { ConfigurationSchema } from '../config/schema';
-import { getNodeEnv } from '../env';
+import { ServiceError } from '../error.js';
+import type { AnyServiceLocals, RequestWithApp, ServiceExpress, ServiceLocals } from '../types.js';
+import type { ServiceHandler } from '../express-app/types.js';
+import { ConfigurationSchema } from '../config/schema.js';
+import { getNodeEnv } from '../env.js';
 
 const LOG_PREFS = Symbol('Logging information');
 
@@ -36,7 +36,7 @@ function getBasicInfo(req: Request): [string, Record<string, string | number>] {
   const url = req.originalUrl || req.url;
 
   const preInfo: Record<string, string> = {
-    ip: requestip.getClientIp(req) || '',
+    ip: getClientIp(req) || '',
     m: req.method,
   };
 

package/src/types.ts

@@ -1,14 +1,14 @@
 import type { Server } from 'http';
 import type { REPLServer } from 'repl';
 
-import type pino from 'pino';
+import type { pino } from 'pino';
 import type { Request, Response } from 'express';
 import type { Application } from 'express-serve-static-core';
 import type { middleware } from 'express-openapi-validator';
 import type { Meter } from '@opentelemetry/api';
 import { ShortstopHandler } from '@sesamecare-oss/confit';
 
-import { ConfigurationSchema } from './config/schema';
+import { ConfigurationSchema } from './config/schema.js';
 
 export interface InternalLocals<
   SLocals extends AnyServiceLocals = ServiceLocals<ConfigurationSchema>,

package/tsconfig.json

@@ -14,15 +14,16 @@
   ],
   "ts-node": {
     "transpileOnly": true,
-    "files": true
+    "files": true,
+    "esm": true
   },
   "compilerOptions": {
     "lib": [
       "ES2022",
       "DOM"
     ],
-    "module": "NodeNext",
-    "moduleResolution": "NodeNext",
+    "module": "Node16",
+    "moduleResolution": "node16",
     "target": "ES2022",
     "declaration": true,
     "sourceMap": true,