@openapi-typescript-infra/service 3.0.3 → 4.0.0

package/build/types.d.ts

@@ -8,7 +8,6 @@ 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 { Confit } from '@sesamecare-oss/confit';
 import { ConfigurationSchema } from './config/schema';
 export interface InternalLocals<SLocals extends AnyServiceLocals = ServiceLocals<ConfigurationSchema>> extends Record<string, unknown> {
     server?: Server;
@@ -19,7 +18,7 @@ export interface ServiceLocals<Config extends ConfigurationSchema = Configuratio
     service: Service;
     name: string;
     logger: ServiceLogger;
-    config: Confit<Config>;
+    config: Config;
     meter: Meter;
     internalApp: Application<InternalLocals<this>>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openapi-typescript-infra/service",
-  "version": "3.0.3",
+  "version": "4.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",
   "scripts": {
@@ -80,11 +80,10 @@
     "@opentelemetry/sdk-node": "^0.43.0",
     "@opentelemetry/sdk-trace-base": "^1.17.1",
     "@opentelemetry/semantic-conventions": "^1.17.1",
-    "@sesamecare-oss/confit": "^1.1.0",
+    "@sesamecare-oss/confit": "^2.0.0",
     "@sesamecare-oss/opentelemetry-node-metrics": "^1.0.1",
     "cookie-parser": "^1.4.6",
     "dotenv": "^16.3.1",
-    "eventsource": "^1.1.2",
     "express": "next",
     "express-openapi-validator": "^5.0.6",
     "glob": "^8.1.0",
@@ -104,12 +103,11 @@
     "@semantic-release/git": "^10.0.1",
     "@semantic-release/release-notes-generator": "^12.0.0",
     "@types/cookie-parser": "^1.4.5",
-    "@types/eventsource": "1.1.12",
-    "@types/express": "^4.17.19",
+    "@types/express": "^4.17.20",
     "@types/glob": "^8.1.0",
-    "@types/lodash": "^4.14.199",
-    "@types/minimist": "^1.2.3",
-    "@types/node": "^20.8.6",
+    "@types/lodash": "^4.14.200",
+    "@types/minimist": "^1.2.4",
+    "@types/node": "^20.8.7",
     "@types/supertest": "^2.0.14",
     "@typescript-eslint/eslint-plugin": "^6.8.0",
     "@typescript-eslint/parser": "^6.8.0",

package/src/config/index.ts

@@ -1,7 +1,7 @@
 import fs from 'fs';
 import path from 'path';
 
-import { BaseConfitType, Confit, Factory, confit } from '@sesamecare-oss/confit';
+import { BaseConfitSchema, Confit, Factory, confit } from '@sesamecare-oss/confit';
 
 import { findPort } from '../development/port-finder';
 
@@ -28,11 +28,11 @@ async function pathExists(f: string) {
 async function addDefaultConfiguration<Config extends ConfigurationSchema = ConfigurationSchema>(
   configFactory: Factory<Config>,
   directory: string,
-  envConfit: Confit<BaseConfitType>,
+  envConfit: Confit<BaseConfitSchema>,
 ) {
   const addIfEnv = async (e: (typeof ENVIRONMENTS)[number]) => {
     const c = path.join(directory, `${e}.json`);
-    if (envConfit.get(`env:${e}`) && (await pathExists(c))) {
+    if (envConfit.get().env[e] && (await pathExists(c))) {
       configFactory.addDefault(c);
       return true;
     }
@@ -63,13 +63,13 @@ export async function loadConfiguration<Config extends ConfigurationSchema>({
   name,
   configurationDirectories: dirs,
   sourceDirectory,
-}: ServiceConfigurationSpec): Promise<Confit<Config>> {
+}: ServiceConfigurationSpec): Promise<Config> {
   const defaultProtocols = shortstops({ name }, sourceDirectory);
   const specificConfig = dirs[dirs.length - 1];
 
   // This confit version just gets us environment info
   const envConfit = await confit({ basedir: specificConfig }).create();
-  const configFactory = confit<ConfigurationSchema>({
+  const configFactory = confit<Config>({
     basedir: specificConfig,
     protocols: defaultProtocols,
   });
@@ -90,17 +90,19 @@ export async function loadConfiguration<Config extends ConfigurationSchema>({
 
   // Because other things need to know the port we choose, we pick it here if it's
   // configured to auto-select
-  const serverConfig = loaded.get('server');
+  const serverConfig = loaded.get().server;
   if (serverConfig.port === 0) {
     const port = (await findPort(8001)) as number;
-    loaded.set('server:port', port);
+    const store = loaded.get();
+    store.server = store.server || {};
+    store.server.port = port;
   }
 
   // TODO init other stuff based on config here, such as key management or
   // other cloud-aware shortstop handlers
 
   // Not sure why this is necessary, but it is
-  return loaded as unknown as Confit<Config>;
+  return loaded.get();
 }
 
 export function insertConfigurationBefore(

package/src/config/schema.ts

@@ -1,4 +1,4 @@
-import type { BaseConfitType } from '@sesamecare-oss/confit';
+import type { BaseConfitSchema } from '@sesamecare-oss/confit';
 import type { Level } from 'pino';
 
 export interface ServiceConfiguration {
@@ -13,7 +13,7 @@ export interface ConfigurationItemEnabled {
   enabled?: boolean;
 }
 
-export interface ConfigurationSchema extends BaseConfitType {
+export interface ConfigurationSchema extends BaseConfitSchema {
   trustProxy?: string[];
   logging?: {
     level?: Level;

package/src/express-app/app.ts

@@ -10,7 +10,6 @@ import { metrics } from '@opentelemetry/api';
 import { setupNodeMetrics } from '@sesamecare-oss/opentelemetry-node-metrics';
 import { createTerminus } from '@godaddy/terminus';
 import type { RequestHandler, Response } from 'express';
-import { Confit } from '@sesamecare-oss/confit';
 
 import { loadConfiguration } from '../config/index';
 import { openApi } from '../openapi';
@@ -88,12 +87,12 @@ export async function startApp<
     sourceDirectory: path.join(rootDirectory, codepath),
   });
 
-  const logging = config.get('logging');
+  const logging = config.logging;
   logger.level = logging?.level || 'info';
 
   // Concentrate the Typescript ugliness...
   const app = express() as unknown as ServiceExpress<SLocals>;
-  const routing = config.get('routing');
+  const routing = config.routing;
 
   app.disable('x-powered-by');
   if (routing?.etag !== true) {
@@ -114,8 +113,8 @@ export async function startApp<
   app.locals.meter = metrics.getMeterProvider().getMeter(name);
   setupNodeMetrics(app.locals.meter, {});
 
-  if (config.get('trustProxy')) {
-    app.set('trust proxy', config.get('trustProxy'));
+  if (config.trustProxy) {
+    app.set('trust proxy', config.trustProxy);
   }
 
   app.use(loggerMiddleware(app, logging?.logRequestBody, logging?.logResponseBody));
@@ -220,7 +219,7 @@ export async function startApp<
   if (routing?.routes) {
     await loadRoutes(
       app,
-      path.resolve(rootDirectory, codepath, config.get<string>('routing:routes') || 'routes'),
+      path.resolve(rootDirectory, codepath, config.routing?.routes || 'routes'),
       codePattern,
     );
   }
@@ -288,10 +287,7 @@ export async function listen<SLocals extends AnyServiceLocals = ServiceLocals<Co
   app: ServiceExpress<SLocals>,
   shutdownHandler?: () => Promise<void>,
 ) {
-  // TODO I don't know why this is necessary, but TS can't quite figure this out
-  // otherwise.
-  const typedConfig = app.locals.config as unknown as Confit<ConfigurationSchema>;
-  const config = typedConfig.get('server') as Required<ConfigurationSchema['server']>;
+  const config = app.locals.config.server || {};
   const { port } = config;
 
   const { service, logger } = app.locals;
@@ -348,7 +344,7 @@ export async function listen<SLocals extends AnyServiceLocals = ServiceLocals<Co
       const { locals } = app;
       locals.logger.info({ url: url(config, port), service: locals.name }, 'express listening');
 
-      const serverConfig = typedConfig.get('server');
+      const serverConfig = app.locals.config.server;
       // Ok now start the internal port if we have one.
       if (serverConfig?.internalPort || serverConfig?.internalPort === 0) {
         startInternalApp(app, serverConfig.internalPort)

package/src/types.ts

@@ -6,7 +6,6 @@ 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 { Confit } from '@sesamecare-oss/confit';
 
 import { ConfigurationSchema } from './config/schema';
 
@@ -26,7 +25,7 @@ export interface ServiceLocals<Config extends ConfigurationSchema = Configuratio
   service: Service;
   name: string;
   logger: ServiceLogger;
-  config: Confit<Config>;
+  config: Config;
   meter: Meter;
   internalApp: Application<InternalLocals<this>>;
 }