@openapi-typescript-infra/service 4.2.0 → 4.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openapi-typescript-infra/service",
-  "version": "4.2.0",
+  "version": "4.3.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,6 +17,7 @@
     "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": {
@@ -82,6 +83,7 @@
     "@opentelemetry/semantic-conventions": "^1.17.1",
     "@sesamecare-oss/confit": "^2.0.1",
     "@sesamecare-oss/opentelemetry-node-metrics": "^1.0.1",
+    "ajv": "^8.12.0",
     "cookie-parser": "^1.4.6",
     "dotenv": "^16.3.1",
     "express": "next",

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

@@ -0,0 +1,55 @@
+#!/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);
+});