counterfact 0.37.1 → 0.37.2

package/dist/server/dispatcher.js

@@ -110,9 +110,15 @@ export class Dispatcher {
         }
         return false;
     }
-    // eslint-disable-next-line sonarjs/cognitive-complexity
+    // eslint-disable-next-line sonarjs/cognitive-complexity, max-statements
     async request({ body, headers = {}, method, path, query, req, }) {
         debug(`request: ${method} ${path}`);
+        // If the incoming path includes the base path, remove it
+        if (this.openApiDocument?.basePath !== undefined &&
+            path.toLowerCase().startsWith(this.openApiDocument.basePath.toLowerCase())) {
+            // eslint-disable-next-line security/detect-non-literal-regexp
+            path = path.replace(new RegExp(this.openApiDocument.basePath, "iu"), "");
+        }
         const { matchedPath } = this.registry.handler(path);
         const operation = this.operationForPathAndMethod(matchedPath, method);
         const response = await this.registry.endpoint(method, path, this.parameterTypes(operation?.parameters))({

package/dist/typescript-generator/operation-type-coder.js

@@ -2,6 +2,7 @@ import nodePath from "node:path";
 import { Coder } from "./coder.js";
 import { CONTEXT_FILE_TOKEN } from "./context-file-token.js";
 import { ParametersTypeCoder } from "./parameters-type-coder.js";
+import { READ_ONLY_COMMENTS } from "./read-only-comments.js";
 import { ResponseTypeCoder } from "./response-type-coder.js";
 import { SchemaTypeCoder } from "./schema-type-coder.js";
 export class OperationTypeCoder extends Coder {
@@ -48,7 +49,10 @@ export class OperationTypeCoder extends Coder {
             .join("path-types", pathString)
             .replaceAll("\\", "/")}.types.ts`;
     }
+    // eslint-disable-next-line max-statements
     write(script) {
+        // eslint-disable-next-line no-param-reassign
+        script.comments = READ_ONLY_COMMENTS;
         const contextTypeImportName = script.importExternalType("Context", CONTEXT_FILE_TOKEN);
         const parameters = this.requirement.get("parameters");
         const queryType = parameters === undefined

package/dist/typescript-generator/read-only-comments.js

@@ -0,0 +1,5 @@
+export const READ_ONLY_COMMENTS = [
+    "This code was automatically generated from an OpenAPI description.",
+    "Do not edit this file. Edit the OpenAPI file instead.",
+    "For more information, see https://github.com/pmcelhaney/counterfact/blob/main/docs/faq-generated-code.md",
+];

package/dist/typescript-generator/repository.js

@@ -93,7 +93,9 @@ export class Context {
 `);
     }
     findContextPath(destination, path) {
-        return nodePath.relative(nodePath.join(destination, nodePath.dirname(path)), this.nearestContextFile(destination, path));
+        return nodePath
+            .relative(nodePath.join(destination, nodePath.dirname(path)), this.nearestContextFile(destination, path))
+            .replaceAll("\\", "/");
     }
     nearestContextFile(destination, path) {
         const directory = nodePath.dirname(path).replace("path-types", "paths");

package/dist/typescript-generator/schema-type-coder.js

@@ -73,6 +73,7 @@ export class SchemaTypeCoder extends Coder {
         return `components/${this.requirement.data.$ref.split("/").at(-1)}.ts`;
     }
     write(script) {
+        // script.comments = READ_ONLY_COMMENTS;
         if (this.requirement.isReference) {
             return script.importType(this);
         }

package/dist/typescript-generator/script.js

@@ -5,6 +5,7 @@ const debug = createDebugger("counterfact:typescript-generator:script");
 export class Script {
     constructor(repository, path) {
         this.repository = repository;
+        this.comments = [];
         this.exports = new Map();
         this.imports = new Map();
         this.externalImport = new Map();
@@ -131,6 +132,8 @@ export class Script {
     }
     contents() {
         return prettier.format([
+            this.comments.map((comment) => `// ${comment}`).join("\n"),
+            this.comments.length > 0 ? "\n\n" : "",
             this.externalImportStatements().join("\n"),
             this.importStatements().join("\n"),
             "\n\n",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "counterfact",
-  "version": "0.37.1",
+  "version": "0.37.2",
   "description": "a library for building a fake REST API for testing",
   "type": "module",
   "main": "./src/server/counterfact.js",
@@ -47,7 +47,7 @@
     "@stryker-mutator/core": "8.2.6",
     "@stryker-mutator/jest-runner": "8.2.6",
     "@stryker-mutator/typescript-checker": "8.2.6",
-    "@swc/core": "1.4.4",
+    "@swc/core": "1.4.6",
     "@swc/jest": "0.2.36",
     "@testing-library/dom": "9.3.4",
     "@types/jest": "29.5.12",
@@ -97,8 +97,8 @@
     "koa-proxy": "1.0.0-alpha.3",
     "koa2-swagger-ui": "5.10.0",
     "node-fetch": "3.3.2",
-    "open": "10.0.4",
+    "open": "10.1.0",
     "prettier": "3.2.5",
-    "typescript": "5.3.3"
+    "typescript": "5.4.2"
   }
 }