counterfact 0.28.0 → 0.30.0

package/bin/counterfact.js

@@ -6,10 +6,8 @@ import { program } from "commander";
 import createDebug from "debug";
 import open from "open";
 
-import { migrate } from "../dist/src/migrations/0.27.js";
-import { startRepl } from "../dist/src/server/repl.js";
-import { start } from "../dist/src/server/start.js";
-import { generate } from "../dist/src/typescript-generator/generate.js";
+import { migrate } from "../dist/migrations/0.27.js";
+import { counterfact } from "../dist/server/app.js";
 
 const DEFAULT_PORT = 3100;
 
@@ -23,10 +21,6 @@ async function main(source, destination) {
 
   const options = program.opts();
 
-  debug("options: %o", options);
-  debug("source: %s", source);
-  debug("destination: %s", destination);
-
   const destinationPath = nodePath
     .join(process.cwd(), destination)
     .replaceAll("\\", "/");
@@ -35,14 +29,12 @@ async function main(source, destination) {
   migrate(destinationPath);
   debug("done with migration");
 
-  debug('generating code at "%s"', destinationPath);
-
-  await generate(source, destinationPath);
-
-  debug("generated code", destinationPath);
-
   const basePath = nodePath.resolve(destinationPath).replaceAll("\\", "/");
 
+  debug("options: %o", options);
+  debug("source: %s", source);
+  debug("destination: %s", destination);
+
   const openBrowser = options.open;
 
   const url = `http://localhost:${options.port}`;
@@ -56,13 +48,14 @@ async function main(source, destination) {
     port: options.port,
     proxyEnabled: Boolean(options.proxyUrl),
     proxyUrl: options.proxyUrl,
+    routePrefix: options.prefix,
   };
 
-  debug("starting server (%o)", config);
+  debug("loading counterfact (%o)", config);
 
-  const { contextRegistry } = await start(config);
+  const { start } = await counterfact(config);
 
-  debug("started server");
+  debug("loaded counterfact", config);
 
   const waysToInteract = [
     `Call the REST APIs at ${url} (with your front end app, curl, Postman, etc.)`,
@@ -90,13 +83,11 @@ async function main(source, destination) {
 
   process.stdout.write("\n\n");
 
-  process.stdout.write("Starting REPL...\n");
+  debug("starting server");
 
-  debug("starting repl");
+  await start();
 
-  startRepl(contextRegistry, config);
-
-  debug("started repl");
+  debug("started server");
 
   if (openBrowser) {
     debug("opening browser");
@@ -116,6 +107,10 @@ program
   .option("--swagger", "include swagger-ui")
   .option("--open", "open a browser")
   .option("--proxy-url <string>", "proxy URL")
+  .option(
+    "--prefix <string>",
+    "base path from which routes will be served (e.g. /api/v1)",
+  )
   .action(main)
   // eslint-disable-next-line sonar/process-argv
   .parse(process.argv);

package/dist/server/app.js

@@ -0,0 +1,76 @@
+import nodePath from "node:path";
+import { createHttpTerminator } from "http-terminator";
+import yaml from "js-yaml";
+import $RefParser from "json-schema-ref-parser";
+import { readFile } from "../util/read-file.js";
+import { CodeGenerator } from "./code-generator.js";
+import { ContextRegistry } from "./context-registry.js";
+import { createKoaApp } from "./create-koa-app.js";
+import { Dispatcher } from "./dispatcher.js";
+import { koaMiddleware } from "./koa-middleware.js";
+import { ModuleLoader } from "./module-loader.js";
+import { Registry } from "./registry.js";
+import { startRepl } from "./repl.js";
+import { Transpiler } from "./transpiler.js";
+async function loadOpenApiDocument(source) {
+    try {
+        const text = await readFile(source);
+        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+        const openApiDocument = (await yaml.load(text));
+        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+        return (await $RefParser.dereference(openApiDocument));
+    }
+    catch {
+        return undefined;
+    }
+}
+// eslint-disable-next-line max-statements
+export async function counterfact(config) {
+    const modulesPath = config.basePath;
+    const compiledPathsDirectory = nodePath
+        .join(modulesPath, ".cache")
+        .replaceAll("\\", "/");
+    const registry = new Registry();
+    const contextRegistry = new ContextRegistry();
+    const codeGenerator = new CodeGenerator(config.openApiPath, config.basePath);
+    const dispatcher = new Dispatcher(registry, contextRegistry, await loadOpenApiDocument(config.openApiPath));
+    const transpiler = new Transpiler(nodePath.join(modulesPath, "paths").replaceAll("\\", "/"), compiledPathsDirectory);
+    const moduleLoader = new ModuleLoader(compiledPathsDirectory, registry, contextRegistry);
+    const middleware = koaMiddleware(dispatcher, config);
+    const koaApp = createKoaApp(registry, middleware, config);
+    // eslint-disable-next-line max-statements
+    async function start(options = {}) {
+        const http = options.http ?? true;
+        await codeGenerator.watch();
+        await transpiler.watch();
+        await moduleLoader.load();
+        await moduleLoader.watch();
+        // eslint-disable-next-line @typescript-eslint/init-declarations
+        let httpTerminator;
+        if (http) {
+            const server = koaApp.listen({
+                port: config.port,
+            });
+            httpTerminator = createHttpTerminator({
+                server,
+            });
+        }
+        const replServer = startRepl(contextRegistry, config);
+        return {
+            replServer,
+            async stop() {
+                await codeGenerator.stopWatching();
+                await transpiler.stopWatching();
+                await moduleLoader.stopWatching();
+                await httpTerminator?.terminate();
+            },
+        };
+    }
+    return {
+        contextRegistry,
+        koaApp,
+        koaMiddleware: middleware,
+        registry,
+        start,
+    };
+}

package/dist/server/code-generator.js

@@ -0,0 +1,23 @@
+import { watch } from "chokidar";
+import { generate } from "../typescript-generator/generate.js";
+export class CodeGenerator {
+    openapiPath;
+    destination;
+    watcher;
+    constructor(openApiPath, destination) {
+        this.openapiPath = openApiPath;
+        this.destination = destination;
+    }
+    async watch() {
+        await generate(this.openapiPath, this.destination);
+        if (this.openapiPath.startsWith("http")) {
+            return;
+        }
+        this.watcher = watch(this.openapiPath).on("change", () => {
+            void generate(this.openapiPath, this.destination);
+        });
+    }
+    async stopWatching() {
+        await this.watcher?.close();
+    }
+}

package/dist/server/create-koa-app.js

@@ -0,0 +1,49 @@
+import { pathToFileURL } from "node:url";
+import createDebug from "debug";
+import Koa from "koa";
+import bodyParser from "koa-bodyparser";
+import { koaSwagger } from "koa2-swagger-ui";
+import { openapiMiddleware } from "./openapi-middleware.js";
+import { pageMiddleware } from "./page-middleware.js";
+const debug = createDebug("counterfact:server:create-koa-app");
+// eslint-disable-next-line max-statements
+export function createKoaApp(registry, koaMiddleware, config) {
+    const app = new Koa();
+    app.use(openapiMiddleware(config.openApiPath, `//localhost:${config.port}`));
+    app.use(koaSwagger({
+        routePrefix: "/counterfact/swagger",
+        swaggerOptions: {
+            url: "/counterfact/openapi",
+        },
+    }));
+    debug("basePath: %s", config.basePath);
+    debug("routes", registry.routes);
+    app.use(pageMiddleware("/counterfact/", "index", {
+        basePath: config.basePath,
+        methods: ["get", "post", "put", "delete", "patch"],
+        openApiHref: config.openApiPath.includes("://")
+            ? config.openApiPath
+            : pathToFileURL(config.openApiPath).href,
+        openApiPath: config.openApiPath,
+        get routes() {
+            return registry.routes;
+        },
+    }));
+    app.use(async (ctx, next) => {
+        if (ctx.URL.pathname === "/counterfact") {
+            ctx.redirect("/counterfact/");
+            return;
+        }
+        // eslint-disable-next-line  n/callback-return
+        await next();
+    });
+    app.use(pageMiddleware("/counterfact/rapidoc", "rapi-doc", {
+        basePath: config.basePath,
+        get routes() {
+            return registry.routes;
+        },
+    }));
+    app.use(bodyParser());
+    app.use(koaMiddleware);
+    return app;
+}

package/dist/{src/server → server}/dispatcher.js

@@ -1,10 +1,9 @@
 /* eslint-disable import/newline-after-import */
-/* eslint-disable max-lines */
 import { mediaTypes } from "@hapi/accept";
 import createDebugger from "debug";
 // eslint-disable-next-line @typescript-eslint/no-shadow
 import fetch, { Headers } from "node-fetch";
-import { createResponseBuilder, } from "./response-builder.js";
+import { createResponseBuilder } from "./response-builder.js";
 import { Tools } from "./tools.js";
 const debug = createDebugger("counterfact:server:dispatcher");
 export class Dispatcher {

package/dist/{src/server → server}/koa-middleware.js

@@ -8,13 +8,20 @@ function addCors(ctx, headers) {
     ctx.set("Access-Control-Expose-Headers", headers?.["access-control-request-headers"] ?? []);
     ctx.set("Access-Control-Allow-Credentials", "true");
 }
-export function koaMiddleware(dispatcher, { proxyEnabled = false, proxyUrl = "" } = {}, proxy = koaProxy) {
+export function koaMiddleware(dispatcher, { proxyEnabled = false, proxyUrl = "", routePrefix = "" } = {}, proxy = koaProxy) {
     // eslint-disable-next-line max-statements
     return async function middleware(ctx, next) {
-        const { body, headers, path, query } = ctx.request;
+        if (!ctx.request.path.startsWith(routePrefix)) {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+            return await next();
+        }
+        /* @ts-expect-error the body comes from koa-bodyparser, not sure how to fix this */
+        const { body, headers, query } = ctx.request;
+        const path = ctx.request.path.slice(routePrefix.length);
         // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
         const method = ctx.request.method;
         if (proxyEnabled && proxyUrl) {
+            /* @ts-expect-error the body comes from koa-bodyparser, not sure how to fix this */
             // eslint-disable-next-line @typescript-eslint/no-unsafe-return
             return proxy({ host: proxyUrl })(ctx, next);
         }
@@ -24,6 +31,7 @@ export function koaMiddleware(dispatcher, { proxyEnabled = false, proxyUrl = ""
             return undefined;
         }
         const response = await dispatcher.request({
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
             body,
             /* @ts-expect-error the value of a header can be an array and we don't have a solution for that yet */
             headers,

package/dist/server/openapi-middleware.js

@@ -0,0 +1,22 @@
+import yaml from "js-yaml";
+import { readFile } from "../util/read-file.js";
+export function openapiMiddleware(openApiPath, url) {
+    return async (ctx, next) => {
+        if (ctx.URL.pathname === "/counterfact/openapi") {
+            // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+            const openApiDocument = (await yaml.load(await readFile(openApiPath)));
+            openApiDocument.servers ??= [];
+            openApiDocument.servers.unshift({
+                description: "Counterfact",
+                url,
+            });
+            // OpenApi 2 support:
+            openApiDocument.host = url;
+            // eslint-disable-next-line require-atomic-updates
+            ctx.body = yaml.dump(openApiDocument);
+            return;
+        }
+        // eslint-disable-next-line  n/callback-return
+        await next();
+    };
+}

package/dist/server/page-middleware.js

@@ -0,0 +1,24 @@
+import nodePath from "node:path";
+import { fileURLToPath } from "node:url";
+import createDebug from "debug";
+import Handlebars from "handlebars";
+import { readFile } from "../util/read-file.js";
+// eslint-disable-next-line no-underscore-dangle
+const __dirname = nodePath.dirname(fileURLToPath(import.meta.url));
+const debug = createDebug("counterfact:server:page-middleware");
+Handlebars.registerHelper("escape_route", (route) => route.replaceAll(/[^\w/]/gu, "-"));
+export function pageMiddleware(pathname, templateName, locals) {
+    return async (ctx, next) => {
+        const pathToHandlebarsTemplate = nodePath
+            .join(__dirname, `../client/${templateName}.html.hbs`)
+            .replaceAll("\\", "/");
+        debug("pathToHandlebarsTemplate: %s", pathToHandlebarsTemplate);
+        const render = Handlebars.compile(await readFile(pathToHandlebarsTemplate));
+        if (ctx.URL.pathname === pathname) {
+            ctx.body = render(locals);
+            return;
+        }
+        // eslint-disable-next-line  n/callback-return
+        await next();
+    };
+}

package/dist/{src/server → server}/repl.js

@@ -30,4 +30,5 @@ export function startRepl(contextRegistry, config) {
     replServer.context.loadContext = (path) => contextRegistry.find(path);
     // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-call
     replServer.context.context = replServer.context.loadContext("/");
+    return replServer;
 }

package/dist/{src/server → server}/response-builder.js

@@ -81,7 +81,8 @@ export function createResponseBuilder(operation) {
                 }
                 const body = response.examples
                     ? oneOf(response.examples)
-                    : JSONSchemaFaker.generate(response.schema ?? { type: "object" });
+                    : // eslint-disable-next-line total-functions/no-unsafe-readonly-mutable-assignment
+                        JSONSchemaFaker.generate(response.schema ?? { type: "object" });
                 return {
                     ...this,
                     content: operation.produces?.map((type) => ({

package/dist/{src/server → server}/transpiler.js

@@ -71,7 +71,6 @@ export class Transpiler extends EventTarget {
             .replace(".ts", ".mjs"))
             .replaceAll("\\", "/");
         try {
-            // eslint-disable-next-line total-functions/no-unsafe-readonly-mutable-assignment
             await fs.writeFile(fullDestination, result);
         }
         catch {

package/dist/{src/typescript-generator → typescript-generator}/generate.js

@@ -22,6 +22,15 @@ async function buildCacheDirectory(destination) {
         await fs.writeFile(cacheReadmePath, "This directory contains compiled JS files from the paths directory. Do not edit these files directly.\n", "utf8");
     }
 }
+async function getPathsFromSpecification(specification) {
+    try {
+        return await specification.requirementAt("#/paths");
+    }
+    catch (error) {
+        process.stderr.write(`Could not find #/paths in the specification.\n${error}\n`);
+        return [];
+    }
+}
 // eslint-disable-next-line max-statements
 export async function generate(source, destination, repository = new Repository()) {
     debug("generating code from %s to %s", source, destination);
@@ -31,8 +40,8 @@ export async function generate(source, destination, repository = new Repository(
     debug("creating specification from %s", source);
     const specification = new Specification(source);
     debug("created specification: $o", specification);
-    debug("getting reading the #/paths from the specification");
-    const paths = await specification.requirementAt("#/paths");
+    debug("reading the #/paths from the specification");
+    const paths = await getPathsFromSpecification(specification);
     debug("got %i paths", paths.size);
     paths.forEach((pathDefinition, key) => {
         debug("processing path %s", key);

package/dist/{src/typescript-generator → typescript-generator}/repository.js

@@ -31,14 +31,9 @@ export class Repository {
         }
     }
     copyCoreFiles(destination) {
-        const files = ["response-builder-factory.ts"];
-        return files.map((file) => {
-            const path = nodePath.join(destination, file).replaceAll("\\", "/");
-            process.stdout.write(`writing ${path}\n`);
-            return fs.copyFile(nodePath
-                .join(__dirname, `../../templates/${file}`)
-                .replaceAll("\\", "/"), path);
-        });
+        return fs.copyFile(nodePath
+            .join(__dirname, "../../src/server/types.d.ts")
+            .replaceAll("\\", "/"), nodePath.join(destination, "types.d.ts").replaceAll("\\", "/"));
     }
     async writeFiles(destination) {
         debug("waiting for %i or more scripts to finish before writing files", this.scripts.size);

package/dist/{src/typescript-generator → typescript-generator}/response-type-coder.js

@@ -8,7 +8,6 @@ export class ResponseTypeCoder extends Coder {
         this.openApi2MediaTypes = openApi2MediaTypes;
     }
     typeForDefaultStatusCode(listedStatusCodes) {
-        this.needsHttpStatusCodeImport = true;
         const definedStatusCodes = listedStatusCodes.filter((key) => key !== "default");
         if (definedStatusCodes.length === 0) {
             return "[statusCode in HttpStatusCode]";
@@ -72,14 +71,11 @@ export class ResponseTypeCoder extends Coder {
             .slice(0, -1)
             .map(() => "..")
             .join("/");
-        script.importExternalType("ResponseBuilderFactory", nodePath
-            .join(basePath, "response-builder-factory.js")
-            .replaceAll("\\", "/"));
-        if (this.needsHttpStatusCodeImport) {
-            script.importExternalType("HttpStatusCode", nodePath
-                .join(basePath, "response-builder-factory.js")
-                .replaceAll("\\", "/"));
+        script.importExternalType("ResponseBuilderFactory", nodePath.join(basePath, "types.d.ts").replaceAll("\\", "/"));
+        const text = `ResponseBuilderFactory<${this.buildResponseObjectType(script)}>`;
+        if (text.includes("HttpStatusCode")) {
+            script.importExternalType("HttpStatusCode", nodePath.join(basePath, "types.d.ts").replaceAll("\\", "/"));
         }
-        return `ResponseBuilderFactory<${this.buildResponseObjectType(script)}>`;
+        return text;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "counterfact",
-  "version": "0.28.0",
+  "version": "0.30.0",
   "description": "a library for building a fake REST API for testing",
   "type": "module",
   "main": "./src/server/counterfact.js",
@@ -31,7 +31,7 @@
     "test": "yarn node --experimental-vm-modules ./node_modules/jest-cli/bin/jest --testPathIgnorePatterns=black-box --forceExit",
     "test:black-box": "rimraf dist && rimraf out && yarn build && yarn node --experimental-vm-modules ./node_modules/jest-cli/bin/jest black-box --forceExit --coverage=false",
     "test:mutants": "stryker run stryker.config.json",
-    "build": "tsc && copyfiles src/client/** dist && copyfiles templates/** dist",
+    "build": "tsc && copyfiles -f \"src/client/**\" dist/client",
     "prepack": "yarn build",
     "release": "npx changeset publish",
     "prepare": "husky install",
@@ -44,32 +44,32 @@
   },
   "devDependencies": {
     "@changesets/cli": "2.26.2",
-    "@stryker-mutator/core": "7.2.0",
-    "@stryker-mutator/jest-runner": "7.2.0",
-    "@stryker-mutator/typescript-checker": "7.2.0",
-    "@swc/core": "1.3.93",
+    "@stryker-mutator/core": "7.3.0",
+    "@stryker-mutator/jest-runner": "7.3.0",
+    "@stryker-mutator/typescript-checker": "7.3.0",
+    "@swc/core": "1.3.96",
     "@swc/jest": "0.2.29",
     "@testing-library/dom": "9.3.3",
-    "@types/jest": "29.5.5",
-    "@types/js-yaml": "4.0.7",
-    "@types/koa": "2.13.8",
-    "@types/koa-bodyparser": "4.3.10",
-    "@types/koa-proxy": "1.0.5",
-    "@types/koa-static": "4.0.2",
+    "@types/jest": "29.5.8",
+    "@types/js-yaml": "4.0.9",
+    "@types/koa": "2.13.11",
+    "@types/koa-bodyparser": "4.3.12",
+    "@types/koa-proxy": "1.0.7",
+    "@types/koa-static": "4.0.4",
     "copyfiles": "2.4.1",
-    "eslint": "8.51.0",
+    "eslint": "8.53.0",
     "eslint-config-hardcore": "41.3.0",
     "eslint-formatter-github-annotations": "0.1.0",
     "eslint-import-resolver-typescript": "3.6.1",
     "eslint-plugin-etc": "2.0.3",
     "eslint-plugin-file-progress": "1.3.0",
-    "eslint-plugin-import": "2.28.1",
-    "eslint-plugin-jest": "27.4.2",
+    "eslint-plugin-import": "2.29.0",
+    "eslint-plugin-jest": "27.6.0",
     "eslint-plugin-jest-dom": "5.1.0",
     "eslint-plugin-no-explicit-type-exports": "0.12.1",
     "eslint-plugin-unused-imports": "3.0.0",
     "husky": "8.0.3",
-    "jest": "28.1.3",
+    "jest": "29.7.0",
     "node-mocks-http": "1.13.0",
     "nodemon": "3.0.1",
     "patch-package": "8.0.0",
@@ -79,7 +79,7 @@
   },
   "dependencies": {
     "@hapi/accept": "6.0.3",
-    "@types/json-schema": "7.0.13",
+    "@types/json-schema": "7.0.15",
     "chokidar": "3.5.3",
     "commander": "11.1.0",
     "debug": "4.3.4",

package/dist/src/server/counterfact.js

@@ -1,47 +0,0 @@
-import nodePath from "node:path";
-import yaml from "js-yaml";
-import $RefParser from "json-schema-ref-parser";
-import { readFile } from "../util/read-file.js";
-import { ContextRegistry } from "./context-registry.js";
-import { Dispatcher } from "./dispatcher.js";
-import { koaMiddleware } from "./koa-middleware.js";
-import { ModuleLoader } from "./module-loader.js";
-import { Registry } from "./registry.js";
-import { Transpiler } from "./transpiler.js";
-async function loadOpenApiDocument(source) {
-    try {
-        const text = await readFile(source);
-        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-        const openApiDocument = (await yaml.load(text));
-        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-        return (await $RefParser.dereference(openApiDocument));
-    }
-    catch {
-        return undefined;
-    }
-}
-// eslint-disable-next-line max-statements
-export async function counterfact(basePath, openApiPath = nodePath
-    .join(basePath, "../openapi.yaml")
-    .replaceAll("\\", "/"), options = {}) {
-    const openApiDocument = await loadOpenApiDocument(openApiPath);
-    const registry = new Registry();
-    const modulesPath = basePath;
-    const contextRegistry = new ContextRegistry();
-    const dispatcher = new Dispatcher(registry, contextRegistry, openApiDocument);
-    const compiledPathsDirectory = nodePath
-        .join(modulesPath, ".cache")
-        .replaceAll("\\", "/");
-    const transpiler = new Transpiler(nodePath.join(modulesPath, "paths").replaceAll("\\", "/"), compiledPathsDirectory);
-    await transpiler.watch();
-    const moduleLoader = new ModuleLoader(compiledPathsDirectory, registry, contextRegistry);
-    await moduleLoader.load();
-    await moduleLoader.watch();
-    return {
-        contextRegistry,
-        // eslint-disable-next-line total-functions/no-unsafe-readonly-mutable-assignment
-        koaMiddleware: koaMiddleware(dispatcher, options),
-        moduleLoader,
-        registry,
-    };
-}

package/dist/src/server/start.js

@@ -1,106 +0,0 @@
-/* eslint-disable max-statements */
-import nodePath, { dirname } from "node:path";
-import { fileURLToPath, pathToFileURL } from "node:url";
-import createDebug from "debug";
-import Handlebars from "handlebars";
-import { createHttpTerminator } from "http-terminator";
-import yaml from "js-yaml";
-import Koa from "koa";
-import bodyParser from "koa-bodyparser";
-import { koaSwagger } from "koa2-swagger-ui";
-import { readFile } from "../util/read-file.js";
-import { counterfact } from "./counterfact.js";
-const debug = createDebug("counterfact:server:start");
-// eslint-disable-next-line @typescript-eslint/init-declarations
-let httpTerminator;
-// eslint-disable-next-line no-underscore-dangle
-const __dirname = dirname(fileURLToPath(import.meta.url));
-const DEFAULT_PORT = 3100;
-Handlebars.registerHelper("escape_route", (route) => route.replaceAll(/[^\w/]/gu, "-"));
-function openapi(openApiPath, url) {
-    return async (ctx, next) => {
-        if (ctx.URL.pathname === "/counterfact/openapi") {
-            // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-            const openApiDocument = (await yaml.load(await readFile(openApiPath)));
-            openApiDocument.servers ??= [];
-            openApiDocument.servers.unshift({
-                description: "Counterfact",
-                url,
-            });
-            // OpenApi 2 support:
-            openApiDocument.host = url;
-            // eslint-disable-next-line require-atomic-updates
-            ctx.body = yaml.dump(openApiDocument);
-            return;
-        }
-        // eslint-disable-next-line  n/callback-return
-        await next();
-    };
-}
-function page(pathname, templateName, locals) {
-    return async (ctx, next) => {
-        const pathToHandlebarsTemplate = nodePath
-            .join(__dirname, `../client/${templateName}.html.hbs`)
-            .replaceAll("\\", "/");
-        debug("pathToHandlebarsTemplate: %s", pathToHandlebarsTemplate);
-        const render = Handlebars.compile(await readFile(pathToHandlebarsTemplate));
-        if (ctx.URL.pathname === pathname) {
-            ctx.body = render(locals);
-            return;
-        }
-        // eslint-disable-next-line  n/callback-return
-        await next();
-    };
-}
-export async function start(config) {
-    const { basePath = process.cwd().replaceAll("\\", "/"), openApiPath = nodePath
-        .join(basePath, "../openapi.yaml")
-        .replaceAll("\\", "/"), port = DEFAULT_PORT, } = config;
-    const app = new Koa();
-    const { contextRegistry, koaMiddleware, registry } = await counterfact(basePath, openApiPath, config);
-    app.use(openapi(openApiPath, `//localhost:${port}`));
-    app.use(koaSwagger({
-        routePrefix: "/counterfact/swagger",
-        swaggerOptions: {
-            url: "/counterfact/openapi",
-        },
-    }));
-    debug("basePath: %s", basePath);
-    debug("routes", registry.routes);
-    app.use(page("/counterfact/", "index", {
-        basePath,
-        methods: ["get", "post", "put", "delete", "patch"],
-        openApiHref: openApiPath.includes("://")
-            ? openApiPath
-            : pathToFileURL(openApiPath).href,
-        openApiPath,
-        routes: registry.routes,
-    }));
-    app.use(async (ctx, next) => {
-        if (ctx.URL.pathname === "/counterfact") {
-            ctx.redirect("/counterfact/");
-            return;
-        }
-        if (ctx.URL.pathname === "/counterfact/stop") {
-            debug("Stopping server...");
-            await httpTerminator?.terminate();
-            debug("Server stopped.");
-            return;
-        }
-        // eslint-disable-next-line  n/callback-return
-        await next();
-    });
-    app.use(page("/counterfact/rapidoc", "rapi-doc", {
-        basePath,
-        routes: registry.routes,
-    }));
-    app.use(bodyParser());
-    app.use(koaMiddleware);
-    const server = app.listen({
-        port,
-    });
-    httpTerminator = createHttpTerminator({
-        server,
-    });
-    return { contextRegistry };
-}

package/dist/templates/response-builder-factory.ts

@@ -1,133 +0,0 @@
-import type { OpenApiResponse } from "../src/server/response-builder.js";
-
-type OmitValueWhenNever<Base> = Pick<
-  Base,
-  {
-    [Key in keyof Base]: [Base[Key]] extends [never] ? never : Key;
-  }[keyof Base]
->;
-
-type MediaType = `${string}/${string}`;
-
-interface OpenApiResponses {
-  [key: string]: OpenApiResponse;
-}
-
-type IfHasKey<SomeObject, Key, Yes, No> = Key extends keyof SomeObject
-  ? Yes
-  : No;
-
-type MaybeShortcut<
-  ContentType extends MediaType,
-  Response extends OpenApiResponse,
-> = IfHasKey<
-  Response["content"],
-  ContentType,
-  (body: Response["content"][ContentType]["schema"]) => ResponseBuilder<{
-    content: Omit<Response["content"], ContentType>;
-    headers: Response["headers"];
-  }>,
-  never
->;
-
-type MatchFunction<Response extends OpenApiResponse> = <
-  ContentType extends MediaType & keyof Response["content"],
->(
-  contentType: ContentType,
-  body: Response["content"][ContentType]["schema"],
-) => ResponseBuilder<{
-  content: Omit<Response["content"], ContentType>;
-  headers: Response["headers"];
-}>;
-
-type HeaderFunction<Response extends OpenApiResponse> = <
-  Header extends string & keyof Response["headers"],
->(
-  header: Header,
-  value: Response["headers"][Header]["schema"],
-) => ResponseBuilder<{
-  content: Response["content"];
-  headers: Omit<Response["headers"], Header>;
-}>;
-
-export type ResponseBuilder<
-  Response extends OpenApiResponse = OpenApiResponse,
-> = [keyof Response["content"]] extends [never]
-  ? // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
-    void
-  : OmitValueWhenNever<{
-      header: [keyof Response["headers"]] extends [never]
-        ? never
-        : HeaderFunction<Response>;
-      html: MaybeShortcut<"text/html", Response>;
-      json: MaybeShortcut<"application/json", Response>;
-      match: [keyof Response["content"]] extends [never]
-        ? never
-        : MatchFunction<Response>;
-      random: [keyof Response["content"]] extends [never] ? never : () => void;
-      text: MaybeShortcut<"text/plain", Response>;
-    }>;
-
-export type ResponseBuilderFactory<
-  Responses extends OpenApiResponses = OpenApiResponses,
-> = {
-  [StatusCode in keyof Responses]: ResponseBuilder<Responses[StatusCode]>;
-} & { [key: string]: ResponseBuilder<Responses["default"]> };
-
-export type HttpStatusCode =
-  | 100
-  | 101
-  | 102
-  | 200
-  | 201
-  | 202
-  | 203
-  | 204
-  | 205
-  | 206
-  | 207
-  | 226
-  | 300
-  | 301
-  | 302
-  | 303
-  | 304
-  | 305
-  | 307
-  | 308
-  | 400
-  | 401
-  | 402
-  | 403
-  | 404
-  | 405
-  | 406
-  | 407
-  | 408
-  | 409
-  | 410
-  | 411
-  | 412
-  | 413
-  | 414
-  | 415
-  | 416
-  | 417
-  | 418
-  | 422
-  | 423
-  | 424
-  | 426
-  | 428
-  | 429
-  | 431
-  | 451
-  | 500
-  | 501
-  | 502
-  | 503
-  | 504
-  | 505
-  | 506
-  | 507
-  | 511;