@openapi-typescript-infra/service 4.7.0 → 4.8.1

package/build/types.d.ts

@@ -8,6 +8,7 @@ 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';
 export interface InternalLocals<SLocals extends AnyServiceLocals = ServiceLocals<ConfigurationSchema>> extends Record<string, unknown> {
     server?: Server;
@@ -66,6 +67,7 @@ export interface DelayLoadServiceStartOptions extends Omit<ServiceStartOptions,
 export interface ServiceOptions {
     configurationDirectories: string[];
     openApiOptions?: Parameters<typeof middleware>[0];
+    shortstopHandlers: Record<string, ShortstopHandler<string, unknown>>;
 }
 export interface ServiceLike<SLocals extends AnyServiceLocals = ServiceLocals<ConfigurationSchema>> {
     locals: SLocals;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openapi-typescript-infra/service",
-  "version": "4.7.0",
+  "version": "4.8.1",
   "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": {

package/src/config/index.ts

@@ -1,11 +1,16 @@
 import fs from 'fs';
 import path from 'path';
 
-import { BaseConfitSchema, Confit, Factory, confit } from '@sesamecare-oss/confit';
+import {
+  BaseConfitSchema,
+  Confit,
+  Factory,
+  ShortstopHandler,
+  confit,
+} from '@sesamecare-oss/confit';
 
 import { findPort } from '../development/port-finder';
 
-import { shortstops } from './shortstops';
 import type { ConfigurationSchema } from './schema';
 
 // Order matters here.
@@ -51,27 +56,23 @@ async function addDefaultConfiguration<Config extends ConfigurationSchema = Conf
 }
 
 export interface ServiceConfigurationSpec {
-  // Used for "sourcerequire" and other source-relative paths and for the package name
-  sourceDirectory: string;
   // The LAST configuration is the most "specific" - if a configuration value
   // exists in all directories, the last one wins
   configurationDirectories: string[];
-  name: string;
+  shortstopHandlers: Record<string, ShortstopHandler<string, unknown>>;
 }
 
 export async function loadConfiguration<Config extends ConfigurationSchema>({
-  name,
   configurationDirectories: dirs,
-  sourceDirectory,
+  shortstopHandlers,
 }: 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<Config>({
     basedir: specificConfig,
-    protocols: defaultProtocols,
+    protocols: shortstopHandlers,
   });
 
   /**

package/src/config/shortstops.ts

@@ -122,7 +122,10 @@ export function shortstops(service: { name: string }, sourcedir: string) {
     },
     base64: base64Handler(),
     regex(v: string) {
-      const [, pattern, flags] = v.match(/^\/(.*)\/([a-z]*)/) || [];
+      const [, pattern, flags] = v.match(/^\/(.*)\/([a-z]*)$/) || [];
+      if (pattern === undefined) {
+        throw new Error(`Invalid regular expression in configuration ${v}`);
+      }
       return new RegExp(pattern, flags);
     },
 

package/src/express-app/app.ts

@@ -28,6 +28,7 @@ import type {
   ServiceStartOptions,
 } from '../types';
 import { ConfigurationSchema } from '../config/schema';
+import { shortstops } from '../config/shortstops';
 import { getNodeEnv, isDev } from '../env';
 import { getGlobalPrometheusExporter } from '../telemetry/index';
 
@@ -76,15 +77,16 @@ export async function startApp<
   const serviceImpl = service();
   assert(serviceImpl?.start, 'Service function did not return a conforming object');
 
+  const sourceDirectory = path.join(rootDirectory, codepath);
   const baseOptions: ServiceOptions = {
     configurationDirectories: [path.resolve(rootDirectory, './config')],
+    shortstopHandlers: shortstops({ name }, sourceDirectory),
   };
   const options = serviceImpl.configure?.(startOptions, baseOptions) || baseOptions;
 
   const config = await loadConfiguration({
-    name,
     configurationDirectories: options.configurationDirectories,
-    sourceDirectory: path.join(rootDirectory, codepath),
+    shortstopHandlers: options.shortstopHandlers,
   });
 
   const logging = config.logging;

package/src/types.ts

@@ -6,6 +6,7 @@ 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';
 
@@ -143,6 +144,8 @@ export interface ServiceOptions {
 
   // Add or control OpenAPI options such as security handlers
   openApiOptions?: Parameters<typeof middleware>[0];
+
+  shortstopHandlers: Record<string, ShortstopHandler<string, unknown>>;
 }
 
 export interface ServiceLike<