counterfact 0.40.1 → 0.41.0

package/bin/counterfact.js

@@ -89,7 +89,7 @@ async function main(source, destination) {
     padTagLine(taglines[Math.floor(Math.random() * taglines.length)]),
     "",
     `| API Base URL  ==> ${url}`,
-    `| Swagger UI    ==> ${swaggerUrl}`,
+    source === "_" ? undefined : `| Swagger UI    ==> ${swaggerUrl}`,
     "",
     "| Instructions  ==> https://counterfact.dev/docs/usage.html",
     "| Help/feedback ==> https://github.com/pmcelhaney/counterfact/issues",
@@ -100,7 +100,9 @@ async function main(source, destination) {
     "Starting REPL, type .help for more info",
   ];
 
-  process.stdout.write(introduction.join("\n"));
+  process.stdout.write(
+    introduction.filter((line) => line !== undefined).join("\n"),
+  );
 
   process.stdout.write("\n\n");
 
@@ -120,9 +122,13 @@ async function main(source, destination) {
 program
   .name("counterfact")
   .description(
-    "Counterfact is a tool for generating a REST API from an OpenAPI document.",
+    "Counterfact is a tool for mocking REST APIs in development. See https://counterfact.dev for more info.",
+  )
+  .argument(
+    "[openapi.yaml]",
+    'path or URL to OpenAPI document or "_" to run without OpenAPI',
+    "_",
   )
-  .argument("<openapi.yaml>", "path or URL to OpenAPI document")
   .argument("[destination]", "path to generated code", ".")
   .option("--port <number>", "server port number", DEFAULT_PORT)
   .option("--swagger", "include swagger-ui")
@@ -131,6 +137,7 @@ program
   .option(
     "--prefix <string>",
     "base path from which routes will be served (e.g. /api/v1)",
+    "",
   )
   .action(main)
   // eslint-disable-next-line sonar/process-argv

package/dist/server/koa-middleware.js

@@ -1,4 +1,6 @@
+import createDebug from "debug";
 import koaProxy from "koa-proxy";
+const debug = createDebug("counterfact:server:create-koa-app");
 const HTTP_STATUS_CODE_OK = 200;
 function addCors(ctx, headers) {
     // Always append CORS headers, reflecting back the headers requested if any
@@ -21,9 +23,12 @@ function getAuthObject(ctx) {
     const [username, password] = user.split(":");
     return { password, username };
 }
-export function koaMiddleware(dispatcher, { proxyEnabled = false, proxyUrl = "", routePrefix = "" } = {}, proxy = koaProxy) {
+export function koaMiddleware(dispatcher, config, proxy = koaProxy) {
     // eslint-disable-next-line max-statements
     return async function middleware(ctx, next) {
+        const { proxyEnabled, proxyUrl, routePrefix } = config;
+        debug("middleware running for path: %s", ctx.request.path);
+        debug("routePrefix: %s", routePrefix);
         if (!ctx.request.path.startsWith(routePrefix)) {
             // eslint-disable-next-line @typescript-eslint/no-unsafe-return
             return await next();

package/dist/server/page-middleware.js

@@ -12,9 +12,10 @@ export function pageMiddleware(pathname, templateName, locals) {
         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) {
+            debug("rendering page: %s", pathname);
+            debug("locals: %o", locals);
             ctx.body = render(locals);
             return;
         }

package/dist/server/transpiler.js

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

package/dist/typescript-generator/script.js

@@ -22,16 +22,14 @@ export class Script {
     }
     firstUniqueName(coder) {
         for (const name of coder.names()) {
-            if (!this.imports.has(name) && !this.exports.has(name)) {
+            if (!this.imports.has(name)) {
                 return name;
             }
         }
         throw new Error(`could not find a unique name for ${coder.id}`);
     }
     export(coder, isType = false, isDefault = false) {
-        const cacheKey = isDefault
-            ? "default"
-            : `${coder.id}@${nodePath}:${isType}`;
+        const cacheKey = isDefault ? "default" : `${coder.id}:${isType}`;
         if (this.cache.has(cacheKey)) {
             return this.cache.get(cacheKey);
         }

package/dist/typescript-generator/specification.js

@@ -6,6 +6,14 @@ import yaml from "js-yaml";
 import { readFile } from "../util/read-file.js";
 import { Requirement } from "./requirement.js";
 const debug = createDebug("counterfact:typescript-generator:specification");
+const EMPTY_OPENAPI = `{
+    "openapi": "3.0.0",
+    "info": {
+      "title": "Sample API",
+      "version": "1.0.0"
+    },
+    "paths": {}
+  }`;
 export class Specification {
     constructor(rootUrl) {
         this.cache = new Map();
@@ -34,7 +42,7 @@ export class Specification {
             return this.cache.get(urlOrPath);
         }
         debug("cache miss, reading file at %s", urlOrPath);
-        const source = await readFile(urlOrPath, "utf8");
+        const source = urlOrPath === "_" ? EMPTY_OPENAPI : await readFile(urlOrPath, "utf8");
         debug("read file");
         debug("parsing YAML");
         const data = await yaml.load(source);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "counterfact",
-  "version": "0.40.1",
+  "version": "0.41.0",
   "description": "a library for building a fake REST API for testing",
   "type": "module",
   "main": "./src/server/counterfact.js",
@@ -50,7 +50,7 @@
     "@stryker-mutator/typescript-checker": "8.2.6",
     "@swc/core": "1.5.0",
     "@swc/jest": "0.2.36",
-    "@testing-library/dom": "10.0.0",
+    "@testing-library/dom": "10.1.0",
     "@types/jest": "29.5.12",
     "@types/js-yaml": "4.0.9",
     "@types/koa": "2.15.0",
@@ -65,10 +65,10 @@
     "eslint-plugin-etc": "2.0.3",
     "eslint-plugin-file-progress": "1.3.0",
     "eslint-plugin-import": "2.29.1",
-    "eslint-plugin-jest": "28.3.0",
+    "eslint-plugin-jest": "28.5.0",
     "eslint-plugin-jest-dom": "5.4.0",
     "eslint-plugin-no-explicit-type-exports": "0.12.1",
-    "eslint-plugin-unused-imports": "3.1.0",
+    "eslint-plugin-unused-imports": "3.2.0",
     "husky": "9.0.11",
     "jest": "29.7.0",
     "node-mocks-http": "1.14.1",