counterfact 0.25.3 → 0.25.4

package/.eslintrc.cjs

@@ -1,20 +1,35 @@
 "use strict";
 
 const rules = {
-  "n/shebang": "off",
-  "putout/putout": "off",
-  "import/prefer-default-export": "off",
+  "@microsoft/sdl/no-html-method": "off",
+  "@typescript-eslint/lines-around-comment": "off",
   "@typescript-eslint/naming-convention": "off",
+  "import/default": "off",
+
+  "import/namespace": "off",
+
+  // too slow
+  "import/no-cycle": "off",
+
+  "import/no-deprecated": "off",
+  "import/no-named-as-default": "off",
+  "import/no-named-as-default-member": "off",
+
+  "import/no-unused-modules": "off",
+
+  "import/prefer-default-export": "off",
 
   "max-len": [
     "warn",
     {
+      code: 120,
       ignorePattern: "eslint|it\\(|describe\\(",
       ignoreTemplateLiterals: true,
-      code: 120,
     },
   ],
 
+  "n/shebang": "off",
+
   "no-magic-numbers": [
     "error",
     {
@@ -22,8 +37,8 @@ const rules = {
     },
   ],
 
-  "node/no-callback-literal": "off",
   "node/file-extension-in-import": "off",
+  "node/no-callback-literal": "off",
   "node/no-missing-import": "off",
 
   "prettier/prettier": [
@@ -33,19 +48,17 @@ const rules = {
     },
   ],
 
-  // too slow
-  "import/no-cycle": "off",
-  "import/no-unused-modules": "off",
-  "import/namespace": "off",
-  "import/no-named-as-default": "off",
-  "import/no-deprecated": "off",
-  "import/default": "off",
-  "import/no-named-as-default-member": "off",
-  "@microsoft/sdl/no-html-method": "off",
-  "@typescript-eslint/lines-around-comment": "off",
+  "putout/putout": "off",
 };
 
 module.exports = {
+  env: {
+    es2021: true,
+    node: true,
+  },
+
+  extends: ["hardcore", "hardcore/ts", "hardcore/node"],
+
   ignorePatterns: [
     "/node_modules/",
     "/coverage/",
@@ -55,112 +68,101 @@ module.exports = {
     ".stryker-tmp",
   ],
 
-  extends: ["hardcore", "hardcore/ts", "hardcore/node"],
-
-  parserOptions: {
-    sourceType: "module",
-  },
-
-  env: {
-    es2021: true,
-    node: true,
-  },
-
-  rules,
-
   overrides: [
     {
-      files: ["*.cjs"],
       extends: ["hardcore", "hardcore/node"],
-
-      rules: {
-        "import/no-commonjs": "off",
-      },
+      files: ["*.cjs"],
 
       parserOptions: {
         sourceType: "script",
       },
+
+      rules: {
+        "import/no-commonjs": "off",
+      },
     },
 
     {
-      files: ["*.test.js"],
-
       extends: ["hardcore", "hardcore/ts", "hardcore/node", "hardcore/jest"],
 
+      files: ["*.test.js"],
+
       rules: {
         ...rules,
+        "@typescript-eslint/naming-convention": "off",
+        "id-length": ["off"],
+
         "import/unambiguous": "off",
+
         "jest/prefer-expect-assertions": "off",
 
+        "jest/unbound-method": "off",
+
+        "max-lines": "off",
+
         "new-cap": [
           "error",
           { capIsNewExceptionPattern: "GET|PUT|POST|DELETE" },
         ],
 
-        "@typescript-eslint/naming-convention": "off",
-
-        "node/no-unpublished-import": "off",
-
         "no-magic-numbers": ["off"],
-        "id-length": ["off"],
-        "max-lines": "off",
-        "jest/unbound-method": "off",
+        "node/no-unpublished-import": "off",
       },
     },
 
     {
-      files: ["demo/**/*.js"],
       extends: ["hardcore", "hardcore/node"],
+      files: ["demo/**/*.js"],
 
       rules: {
         ...rules,
         "import/no-extraneous-dependencies": "off",
         "import/no-unused-modules": "off",
         "import/prefer-default-export": "off",
-        "no-param-reassign": "off",
         "no-console": "off",
+        "no-param-reassign": "off",
         "node/no-unpublished-import": "off",
       },
     },
 
     {
-      files: ["*.cjs"],
       extends: ["hardcore", "hardcore/node"],
+      files: ["*.cjs"],
+
+      parserOptions: {
+        sourceType: "script",
+      },
 
       rules: {
         ...rules,
         "import/no-commonjs": "off",
       },
-
-      parserOptions: {
-        sourceType: "script",
-      },
     },
 
     {
-      files: ["**/*.ts"],
       extends: ["hardcore", "hardcore/node", "hardcore/ts"],
+      files: ["**/*.ts"],
 
       parserOptions: {
-        sourceType: "module",
         project: "./tsconfig.json",
+        sourceType: "module",
       },
 
       rules: {
         ...rules,
-        "import/prefer-default-export": "off",
-        "import/no-unused-modules": "off",
-        "func-style": "off",
-        camelcase: "off",
         "@typescript-eslint/naming-convention": "off",
-        "no-magic-numbers": "off",
-        "no-param-reassign": "off",
-        "import/group-exports": "off",
-        "max-len": "off",
-        "etc/prefer-interface": "off",
+        "@typescript-eslint/no-magic-numbers": "off",
         "@typescript-eslint/prefer-readonly-parameter-types": "off",
+        camelcase: "off",
         "eslint-comments/no-unused-disable": "off",
-        "@typescript-eslint/no-magic-numbers": "off",
+        "etc/prefer-interface": "off",
+        "func-style": "off",
+        "import/group-exports": "off",
+        "import/no-unused-modules": "off",
+        "import/prefer-default-export": "off",
+        "max-len": "off",
+        "no-magic-numbers": "off",
+        "no-param-reassign": "off",
       },
 
       settings: {
@@ -178,8 +180,6 @@ module.exports = {
     },
 
     {
-      files: ["templates/**/*.ts"],
-
       env: {
         es2021: true,
         node: true,
@@ -187,6 +187,8 @@ module.exports = {
 
       extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
 
+      files: ["templates/**/*.ts"],
+
       parserOptions: {
         ecmaVersion: "latest",
         sourceType: "module",
@@ -195,4 +197,10 @@ module.exports = {
       rules: {},
     },
   ],
+
+  parserOptions: {
+    sourceType: "module",
+  },
+
+  rules,
 };

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # counterfact
 
+## 0.25.4
+
+### Patch Changes
+
+- 7f2e19e: fixed an issue in which routes on the start page weren't rendered correctly in Windows
+
 ## 0.25.3
 
 ### Patch Changes

package/bin/counterfact.js

@@ -2,13 +2,13 @@
 
 import nodePath from "node:path";
 
-import createDebug from "debug";
 import { program } from "commander";
+import createDebug from "debug";
 import open from "open";
 
-import { generate } from "../src/typescript-generator/generate.js";
-import { start } from "../src/server/start.js";
 import { startRepl } from "../src/server/repl.js";
+import { start } from "../src/server/start.js";
+import { generate } from "../src/typescript-generator/generate.js";
 
 const DEFAULT_PORT = 3100;
 
@@ -36,7 +36,7 @@ async function main(source, destination) {
 
   debug("generated code", destinationPath);
 
-  const basePath = nodePath.resolve(destinationPath);
+  const basePath = nodePath.resolve(destinationPath).replaceAll("\\", "/");
 
   const openBrowser = options.open;
 
@@ -46,11 +46,11 @@ async function main(source, destination) {
 
   const config = {
     basePath,
-    port: options.port,
-    openApiPath: source,
     includeSwaggerUi: true,
-    proxyUrl: options.proxyUrl,
+    openApiPath: source,
+    port: options.port,
     proxyEnabled: Boolean(options.proxyUrl),
+    proxyUrl: options.proxyUrl,
   };
 
   debug("starting server (%o)", config);
@@ -80,7 +80,7 @@ async function main(source, destination) {
   process.stdout.write(`${introduction.join("\n")}\n`);
 
   process.stdout.write(
-    waysToInteract.map((text, index) => `${index + 1}. ${text}`).join("\n")
+    waysToInteract.map((text, index) => `${index + 1}. ${text}`).join("\n"),
   );
 
   process.stdout.write("\n\n");
@@ -103,7 +103,7 @@ 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 generating a REST API from an OpenAPI document.",
   )
   .argument("<openapi.yaml>", "path or URL to OpenAPI document")
   .argument("[destination]", "path to generated code", ".")
@@ -112,4 +112,5 @@ program
   .option("--open", "open a browser")
   .option("--proxy-url <string>", "proxy URL")
   .action(main)
+  // eslint-disable-next-line sonar/process-argv
   .parse(process.argv);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "counterfact",
-  "version": "0.25.3",
+  "version": "0.25.4",
   "description": "a library for building a fake REST API for testing",
   "type": "module",
   "main": "./src/server/counterfact.js",
@@ -42,8 +42,8 @@
     "@testing-library/dom": "^9.3.0",
     "@types/koa": "2.13.8",
     "@types/koa-static": "^4.0.2",
-    "eslint": "8.47.0",
-    "eslint-config-hardcore": "36.4.0",
+    "eslint": "8.48.0",
+    "eslint-config-hardcore": "41.2.0",
     "eslint-formatter-github-annotations": "0.1.0",
     "eslint-import-resolver-typescript": "^3.2.5",
     "eslint-plugin-etc": "^2.0.2",
@@ -79,7 +79,7 @@
     "koa2-swagger-ui": "^5.6.0",
     "node-fetch": "^3.2.10",
     "open": "^9.0.0",
-    "prettier": "^2.7.1",
+    "prettier": "^3.0.0",
     "typescript": "^5.0.0"
   }
 }

package/src/server/counterfact.js

@@ -1,15 +1,14 @@
 import nodePath from "node:path";
 
-import $RefParser from "json-schema-ref-parser";
 import yaml from "js-yaml";
+import $RefParser from "json-schema-ref-parser";
 
 import { readFile } from "../util/read-file.js";
-
-import { Registry } from "./registry.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 { ContextRegistry } from "./context-registry.js";
+import { Registry } from "./registry.js";
 import { Transpiler } from "./transpiler.js";
 
 async function loadOpenApiDocument(source) {
@@ -26,7 +25,7 @@ export async function counterfact(
   openApiPath = nodePath
     .join(basePath, "../openapi.yaml")
     .replaceAll("\\", "/"),
-  options = {}
+  options = {},
 ) {
   const openApiDocument = await loadOpenApiDocument(openApiPath);
 
@@ -44,7 +43,7 @@ export async function counterfact(
 
   const transpiler = new Transpiler(
     nodePath.join(modulesPath, "paths").replaceAll("\\", "/"),
-    compiledPathsDirectory
+    compiledPathsDirectory,
   );
 
   await transpiler.watch();
@@ -52,7 +51,7 @@ export async function counterfact(
   const moduleLoader = new ModuleLoader(
     compiledPathsDirectory,
     registry,
-    contextRegistry
+    contextRegistry,
   );
 
   await moduleLoader.load();
@@ -60,9 +59,9 @@ export async function counterfact(
   await moduleLoader.watch();
 
   return {
+    contextRegistry,
     koaMiddleware: koaMiddleware(dispatcher, options),
-    registry,
     moduleLoader,
-    contextRegistry,
+    registry,
   };
 }

package/src/server/dispatcher.js

@@ -1,6 +1,5 @@
-// eslint-disable-next-line import/order
+// eslint-disable-next-line import/newline-after-import
 import Accept from "@hapi/accept";
-
 // eslint-disable-next-line no-shadow
 import fetch, { Headers } from "node-fetch";
 
@@ -13,12 +12,12 @@ function parameterTypes(parameters) {
   }
 
   const types = {
-    path: {},
-    query: {},
-    header: {},
+    body: {},
     cookie: {},
     formData: {},
-    body: {},
+    header: {},
+    path: {},
+    query: {},
   };
 
   for (const parameter of parameters) {
@@ -57,27 +56,18 @@ export class Dispatcher {
     return operation;
   }
 
-  async request({ method, path, headers, body, query, req }) {
+  async request({ body, headers, method, path, query, req }) {
     const { matchedPath } = this.registry.handler(path);
     const operation = this.operationForPathAndMethod(matchedPath, method);
 
     const response = await this.registry.endpoint(
       method,
       path,
-      parameterTypes(operation?.parameters)
+      parameterTypes(operation?.parameters),
     )({
-      tools: new Tools({ headers }),
       body,
-      query,
-      headers,
       context: this.contextRegistry.find(path),
-
-      response: createResponseBuilder(
-        this.operationForPathAndMethod(
-          this.registry.handler(path).matchedPath,
-          method
-        )
-      ),
+      headers,
 
       proxy: async (url) => {
         if (
@@ -86,40 +76,51 @@ export class Dispatcher {
           headers.contentType !== "application/json"
         ) {
           throw new Error(
-            `$.proxy() is currently limited to application/json requests. You tried to proxy to ${url} with a Content-Type of ${headers.contentType}. Please open an issue at https://github.com/pmcelhaney/counterfact/issues and prod me to fix this limitation.`
+            `$.proxy() is currently limited to application/json requests. You tried to proxy to ${url} with a Content-Type of ${headers.contentType}. Please open an issue at https://github.com/pmcelhaney/counterfact/issues and prod me to fix this limitation.`,
           );
         }
 
         const fetchResponse = await this.fetch(url + req.path, {
-          method,
-          headers: new Headers(headers),
           body: body ? JSON.stringify(body) : undefined,
+          headers: new Headers(headers),
+          method,
         });
 
         const responseHeaders = Object.fromEntries(
-          fetchResponse.headers.entries()
+          fetchResponse.headers.entries(),
         );
 
         return {
-          status: fetchResponse.status,
+          body: await fetchResponse.text(),
           contentType: responseHeaders["content-type"] ?? "unknown/unknown",
           headers: responseHeaders,
-          body: await fetchResponse.text(),
+          status: fetchResponse.status,
         };
       },
+
+      query,
+
+      response: createResponseBuilder(
+        this.operationForPathAndMethod(
+          this.registry.handler(path).matchedPath,
+          method,
+        ),
+      ),
+
+      tools: new Tools({ headers }),
     });
 
     const normalizedResponse = this.normalizeResponse(
       response,
-      headers?.accept ?? "*/*"
+      headers?.accept ?? "*/*",
     );
 
     if (
       !Accept.mediaTypes(headers?.accept ?? "*/*").some((type) =>
-        this.isMediaType(normalizedResponse.contentType, type)
+        this.isMediaType(normalizedResponse.contentType, type),
       )
     ) {
-      return { status: 406, body: Accept.mediaTypes(headers?.accept ?? "*/*") };
+      return { body: Accept.mediaTypes(headers?.accept ?? "*/*"), status: 406 };
     }
 
     return normalizedResponse;
@@ -128,10 +129,10 @@ export class Dispatcher {
   normalizeResponse(response, acceptHeader) {
     if (typeof response === "string") {
       return {
-        status: 200,
-        headers: {},
-        contentType: "text/plain",
         body: response,
+        contentType: "text/plain",
+        headers: {},
+        status: 200,
       };
     }
 
@@ -146,8 +147,8 @@ export class Dispatcher {
 
       const normalizedResponse = {
         ...response,
-        contentType: content.type,
         body: content.body,
+        contentType: content.type,
       };
 
       delete normalizedResponse.content;
@@ -163,7 +164,7 @@ export class Dispatcher {
 
     for (const mediaType of preferredMediaTypes) {
       const contentItem = content.find((item) =>
-        this.isMediaType(item.type, mediaType)
+        this.isMediaType(item.type, mediaType),
       );
 
       if (contentItem) {
@@ -172,8 +173,8 @@ export class Dispatcher {
     }
 
     return {
-      type: preferredMediaTypes,
       body: "no match",
+      type: preferredMediaTypes,
     };
   }
 

package/src/server/koa-middleware.js

@@ -8,18 +8,18 @@ function addCors(ctx, headers) {
   ctx.set("Access-Control-Allow-Methods", "GET,HEAD,PUT,POST,DELETE,PATCH");
   ctx.set(
     "Access-Control-Allow-Headers",
-    headers?.["access-control-request-headers"]
+    headers?.["access-control-request-headers"],
   );
   ctx.set(
     "Access-Control-Expose-Headers",
-    headers?.["access-control-request-headers"]
+    headers?.["access-control-request-headers"],
   );
   ctx.set("Access-Control-Allow-Credentials", "true");
 }
 
 export function koaMiddleware(dispatcher, options = {}, proxy = koaProxy) {
   return async function middleware(ctx, next) {
-    const { method, path, headers, body, query } = ctx.request;
+    const { body, headers, method, path, query } = ctx.request;
 
     if (options.proxyEnabled && options.proxyUrl) {
       return proxy({ host: options.proxyUrl })(ctx, next);
@@ -32,10 +32,10 @@ export function koaMiddleware(dispatcher, options = {}, proxy = koaProxy) {
       ctx.status = HTTP_STATUS_CODE_OK;
     } else {
       const response = await dispatcher.request({
+        body,
+        headers,
         method,
         path,
-        headers,
-        body,
         query,
         req: ctx.req,
       });

package/src/server/module-loader.js

@@ -1,14 +1,14 @@
-import fs from "node:fs/promises";
+import { once } from "node:events";
 import { existsSync } from "node:fs";
+import fs from "node:fs/promises";
 import nodePath from "node:path";
-import { once } from "node:events";
 import { pathToFileURL } from "node:url";
 
 import chokidar from "chokidar";
 import createDebug from "debug";
 
-import { ContextRegistry } from "./context-registry.js";
 import { CHOKIDAR_OPTIONS } from "./constants.js";
+import { ContextRegistry } from "./context-registry.js";
 
 const debug = createDebug("counterfact:typescript-generator:module-loader");
 
@@ -41,9 +41,9 @@ export class ModuleLoader extends EventTarget {
         }
 
         const parts = nodePath.parse(pathName.replace(this.basePath, ""));
-        const url = nodePath
-          .normalize(`/${nodePath.join(parts.dir, parts.name)}`)
-          .replaceAll("\\", "/");
+        const url = `/${parts.dir}/${parts.name}`
+          .replaceAll("\\", "/")
+          .replaceAll(/\/+/gu, "/");
 
         if (eventName === "unlink") {
           this.registry.remove(url);
@@ -97,7 +97,7 @@ export class ModuleLoader extends EventTarget {
       nodePath.join(this.basePath, directory).replaceAll("\\", "/"),
       {
         withFileTypes: true,
-      }
+      },
     );
 
     // eslint-disable-next-line max-statements
@@ -106,13 +106,13 @@ export class ModuleLoader extends EventTarget {
 
       if (file.isDirectory()) {
         await this.load(
-          nodePath.join(directory, file.name).replaceAll("\\", "/")
+          nodePath.join(directory, file.name).replaceAll("\\", "/"),
         );
 
         return;
       }
 
-      if (!["js", "mjs", "ts", "mts"].includes(extension)) {
+      if (!["js", "mjs", "mts", "ts"].includes(extension)) {
         return;
       }
 
@@ -131,14 +131,19 @@ export class ModuleLoader extends EventTarget {
         debug("* imported module: %s", fileUrl);
 
         if (file.name.includes("$.context")) {
-          this.contextRegistry.add(`/${directory}`, endpoint.default);
-        } else {
-          this.registry.add(
-            `/${nodePath
-              .join(directory, nodePath.parse(file.name).name)
-              .replaceAll("\\", "/")}`,
-            endpoint
+          this.contextRegistry.add(
+            `/${directory.replaceAll("\\", "/")}`.replaceAll(/\/+/gu, "/"),
+            endpoint.default,
           );
+        } else {
+          const url = `/${nodePath.join(
+            directory,
+            nodePath.parse(file.name).name,
+          )}`
+            .replaceAll("\\", "/")
+            .replaceAll(/\/+/gu, "/");
+
+          this.registry.add(url, endpoint);
         }
       } catch (error) {
         process.stdout.write(["Error loading", fullPath, error].join("\n"));