@openapi-typescript-infra/service 4.3.4 → 4.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openapi-typescript-infra/service",
-  "version": "4.3.4",
+  "version": "4.5.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": {
@@ -17,7 +17,6 @@
     "url": "git+https://github.com/openapi-typescript-infra/service.git"
   },
   "bin": {
-    "generate-config-schema": "./build/bin/generate-config-schema.js",
     "start-service": "./build/bin/start-service.js"
   },
   "config": {
@@ -81,7 +80,7 @@
     "@opentelemetry/sdk-node": "^0.43.0",
     "@opentelemetry/sdk-trace-base": "^1.17.1",
     "@opentelemetry/semantic-conventions": "^1.17.1",
-    "@sesamecare-oss/confit": "^2.0.1",
+    "@sesamecare-oss/confit": "^2.0.2",
     "@sesamecare-oss/opentelemetry-node-metrics": "^1.0.1",
     "ajv": "^8.12.0",
     "cookie-parser": "^1.4.6",

package/src/config/index.ts

@@ -121,3 +121,4 @@ export function insertConfigurationBefore(
 }
 
 export * from './schema';
+export * from './validation';

package/src/config/schema.ts

@@ -65,8 +65,8 @@ export interface ConfigurationSchema extends BaseConfitSchema {
     // actual key material (not the path). Use shortstop file: handler.
     // Note that generally it's better to offload tls termination,
     // but this is useful for dev.
-    key?: string;
-    certificate?: string;
+    key?: string | Uint8Array;
+    certificate?: string | Uint8Array;
     // If you have an alternate host name (other than localhost) that
     // should be used when referring to this service, set it here.
     hostname?: string;

package/src/config/validation.ts

@@ -0,0 +1,22 @@
+import { ConfigurationSchema } from './schema';
+
+export interface ConfigValidationError {
+  path: string;
+  message: string;
+}
+
+export type ConfigurationValidator<Config extends ConfigurationSchema> = (config: Config) => {
+  success: boolean;
+  errors: ConfigValidationError[];
+};
+
+export function validateConfiguration<Config extends ConfigurationSchema>(
+  config: Config,
+  validator: ConfigurationValidator<Config>,
+) {
+  const result = validator(config);
+  if (!result.success) {
+    throw new Error(`Configuration validation failed:
+${result.errors.map((e) => `  - ${e.path}: ${e.message}`).join('\n')}`);
+  }
+}

package/src/express-app/app.ts

@@ -270,8 +270,8 @@ function httpServer<
 
   return https.createServer(
     {
-      key: config.key,
-      cert: config.certificate,
+      key: config.key ? Buffer.from(config.key) : undefined,
+      cert: config.certificate ? Buffer.from(config.certificate) : undefined,
     },
     app,
   );

package/build/bin/generate-config-schema.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};

package/build/bin/generate-config-schema.js

@@ -1,53 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs_1 = __importDefault(require("fs"));
-const child_process_1 = require("child_process");
-const ajv_1 = __importDefault(require("ajv"));
-const standalone_1 = __importDefault(require("ajv/dist/standalone"));
-const minimist_1 = __importDefault(require("minimist"));
-// Generate an AJV validator from a Typescript type
-// This is mostly included since we already have AJV,
-// and we want you to use it to validate configurations.
-const argv = (0, minimist_1.default)(process.argv.slice(2));
-async function run() {
-    // First we need to run typescript-json-schema to
-    // generate the JSON schema. We use npx to avoid the
-    // runtime dependency.
-    const tsJsonSchema = (0, child_process_1.spawnSync)('npx', [
-        '-y',
-        'typescript-json-schema',
-        argv.tsconfig || 'tsconfig.build.json',
-        argv.type,
-        '--required',
-        '--noExtraProps',
-        '--strictNullChecks',
-        '--include',
-        argv.source || 'src/types/config.ts',
-    ], {
-        stdio: 'pipe',
-        encoding: 'utf-8',
-    });
-    if (tsJsonSchema.status !== 0) {
-        console.error(tsJsonSchema.stderr);
-        process.exit(1);
-    }
-    const schema = JSON.parse(tsJsonSchema.stdout);
-    const ajv = new ajv_1.default({ code: { source: true, esm: true } });
-    const validate = ajv.compile(schema);
-    const moduleCode = (0, standalone_1.default)(ajv, validate);
-    if (argv.output) {
-        fs_1.default.writeFileSync(argv.output, `// @ts-nocheck\n${moduleCode}\n`);
-    }
-    else {
-        console.log(moduleCode);
-    }
-}
-run().catch((err) => {
-    console.error(err);
-    process.exit(1);
-});
-//# sourceMappingURL=generate-config-schema.js.map

package/build/bin/generate-config-schema.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"generate-config-schema.js","sourceRoot":"","sources":["../../src/bin/generate-config-schema.ts"],"names":[],"mappings":";;;;;;AACA,4CAAoB;AACpB,iDAA0C;AAE1C,8CAAsB;AACtB,qEAAiD;AACjD,wDAAgC;AAEhC,mDAAmD;AACnD,qDAAqD;AACrD,wDAAwD;AACxD,MAAM,IAAI,GAAG,IAAA,kBAAQ,EAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AAE7C,KAAK,UAAU,GAAG;IAChB,iDAAiD;IACjD,oDAAoD;IACpD,sBAAsB;IACtB,MAAM,YAAY,GAAG,IAAA,yBAAS,EAC5B,KAAK,EACL;QACE,IAAI;QACJ,wBAAwB;QACxB,IAAI,CAAC,QAAQ,IAAI,qBAAqB;QACtC,IAAI,CAAC,IAAI;QACT,YAAY;QACZ,gBAAgB;QAChB,oBAAoB;QACpB,WAAW;QACX,IAAI,CAAC,MAAM,IAAI,qBAAqB;KACrC,EACD;QACE,KAAK,EAAE,MAAM;QACb,QAAQ,EAAE,OAAO;KAClB,CACF,CAAC;IACF,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE;QAC7B,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QACnC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IACD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IAE/C,MAAM,GAAG,GAAG,IAAI,aAAG,CAAC,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;IAC3D,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACrC,MAAM,UAAU,GAAG,IAAA,oBAAc,EAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IACjD,IAAI,IAAI,CAAC,MAAM,EAAE;QACf,YAAE,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,EAAE,mBAAmB,UAAU,IAAI,CAAC,CAAC;KAClE;SAAM;QACL,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;KACzB;AACH,CAAC;AAED,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;IAClB,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}

package/src/bin/generate-config-schema.ts

@@ -1,55 +0,0 @@
-#!/usr/bin/env node
-import fs from 'fs';
-import { spawnSync } from 'child_process';
-
-import Ajv from 'ajv';
-import standaloneCode from 'ajv/dist/standalone';
-import minimist from 'minimist';
-
-// Generate an AJV validator from a Typescript type
-// This is mostly included since we already have AJV,
-// and we want you to use it to validate configurations.
-const argv = minimist(process.argv.slice(2));
-
-async function run() {
-  // First we need to run typescript-json-schema to
-  // generate the JSON schema. We use npx to avoid the
-  // runtime dependency.
-  const tsJsonSchema = spawnSync(
-    'npx',
-    [
-      '-y',
-      'typescript-json-schema',
-      argv.tsconfig || 'tsconfig.build.json',
-      argv.type,
-      '--required',
-      '--noExtraProps',
-      '--strictNullChecks',
-      '--include',
-      argv.source || 'src/types/config.ts',
-    ],
-    {
-      stdio: 'pipe',
-      encoding: 'utf-8',
-    },
-  );
-  if (tsJsonSchema.status !== 0) {
-    console.error(tsJsonSchema.stderr);
-    process.exit(1);
-  }
-  const schema = JSON.parse(tsJsonSchema.stdout);
-
-  const ajv = new Ajv({ code: { source: true, esm: true } });
-  const validate = ajv.compile(schema);
-  const moduleCode = standaloneCode(ajv, validate);
-  if (argv.output) {
-    fs.writeFileSync(argv.output, `// @ts-nocheck\n${moduleCode}\n`);
-  } else {
-    console.log(moduleCode);
-  }
-}
-
-run().catch((err) => {
-  console.error(err);
-  process.exit(1);
-});