counterfact 0.42.0 → 0.43.0

package/bin/counterfact.js

@@ -9,7 +9,7 @@ import { program } from "commander";
 import createDebug from "debug";
 import open from "open";
 
-import { counterfact } from "../dist/server/app.js";
+import { counterfact } from "../dist/app.js";
 
 const MIN_NODE_VERSION = 17;
 
@@ -151,8 +151,8 @@ async function main(source, destination) {
     includeSwaggerUi: true,
     openApiPath: source,
     port: options.port,
-    proxyEnabled: Boolean(options.proxyUrl),
-    proxyUrl: options.proxyUrl,
+    proxyPaths: new Map([["", Boolean(options.proxyUrl)]]),
+    proxyUrl: options.proxyUrl ?? "",
     routePrefix: options.prefix,
     startRepl: options.repl,
     startServer: options.serve,

package/dist/{server/app.js → app.js}

@@ -3,16 +3,16 @@ import nodePath from "node:path";
 import { createHttpTerminator } from "http-terminator";
 import yaml from "js-yaml";
 import $RefParser from "json-schema-ref-parser";
-import { CodeGenerator } from "../typescript-generator/code-generator.js";
-import { readFile } from "../util/read-file.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";
+import { startRepl } from "./repl/repl.js";
+import { ContextRegistry } from "./server/context-registry.js";
+import { createKoaApp } from "./server/create-koa-app.js";
+import { Dispatcher } from "./server/dispatcher.js";
+import { koaMiddleware } from "./server/koa-middleware.js";
+import { ModuleLoader } from "./server/module-loader.js";
+import { Registry } from "./server/registry.js";
+import { Transpiler } from "./server/transpiler.js";
+import { CodeGenerator } from "./typescript-generator/code-generator.js";
+import { readFile } from "./util/read-file.js";
 async function loadOpenApiDocument(source) {
     try {
         const text = await readFile(source);

package/dist/repl/repl.js

@@ -0,0 +1,87 @@
+import repl from "node:repl";
+function printToStdout(line) {
+    process.stdout.write(`${line}\n`);
+}
+export function startRepl(contextRegistry, config, print = printToStdout) {
+    // eslint-disable-next-line max-statements
+    function printProxyStatus() {
+        if (config.proxyUrl === "") {
+            print("The proxy URL is not set.");
+            print('To set it, type ".proxy url <url>');
+            return;
+        }
+        print("Proxy Configuration:");
+        print("");
+        print(`The proxy URL is ${config.proxyUrl}`);
+        print("");
+        print("Paths prefixed with [+] will be proxied.");
+        print("Paths prefixed with [-] will not be proxied.");
+        print("");
+        // eslint-disable-next-line array-func/prefer-array-from
+        const entries = [...config.proxyPaths.entries()].sort(([path1], [path2]) => path1 < path2 ? -1 : 1);
+        for (const [path, state] of entries) {
+            print(`${state ? "[+]" : "[-]"} ${path}/`);
+        }
+    }
+    function setProxyUrl(url) {
+        if (url === undefined) {
+            print("usage: .proxy url <url>");
+            return;
+        }
+        config.proxyUrl = url;
+        print(`proxy URL is set to ${url}`);
+    }
+    function turnProxyOnOrOff(text) {
+        const [command, endpoint] = text.split(" ");
+        const printEndpoint = endpoint === undefined || endpoint === "" ? "/" : endpoint;
+        config.proxyPaths.set((endpoint ?? "").replace(/\/$/u, ""), command === "on");
+        if (command === "on") {
+            print(`Requests to ${printEndpoint} will be proxied to ${config.proxyUrl || "<proxy URL>"}${printEndpoint}`);
+        }
+        if (command === "off") {
+            print(`Requests to ${printEndpoint} will be handled by local code`);
+        }
+    }
+    const replServer = repl.start({ prompt: "🤖> " });
+    replServer.defineCommand("counterfact", {
+        action() {
+            print("This is a read-eval-print loop (REPL), the same as the one you get when you run node with no arguments.");
+            print("Except that it's connected to the running server, which you can access with the following globals:");
+            print("");
+            print("- loadContext('/some/path'): to access the context object for a given path");
+            print("- context: the root context ( same as loadContext('/') )");
+            print("");
+            print("For more information, see https://counterfact.dev/docs/usage.html");
+            print("");
+            this.clearBufferedCommand();
+            this.displayPrompt();
+        },
+        help: "Get help with Counterfact",
+    });
+    replServer.defineCommand("proxy", {
+        action(text) {
+            if (text === "help" || text === "") {
+                print(".proxy [on|off] - turn the proxy on/off at the root level");
+                print(".proxy [on|off] <path-prefix> - turn the proxy on for a path");
+                print(".proxy status - show the proxy status");
+                print(".proxy help - show this message");
+            }
+            else if (text.startsWith("url")) {
+                setProxyUrl(text.split(" ")[1]);
+            }
+            else if (text === "status") {
+                printProxyStatus();
+            }
+            else {
+                turnProxyOnOrOff(text);
+            }
+            this.clearBufferedCommand();
+            this.displayPrompt();
+        },
+        help: 'proxy configuration (".proxy help" for details)',
+    });
+    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/server/convert-js-extensions-to-cjs.js

@@ -17,7 +17,9 @@ export function convertFileExtensionsToCjs(code) {
                 typeof node.arguments[0].value === "string" &&
                 node.arguments[0].value.startsWith(".")) {
                 // Change the module string from "foo.js" to "foo.cjs"
-                node.arguments[0].value = node.arguments[0].value.replace(/\.js$/u, ".cjs");
+                node.arguments[0].value = node.arguments[0].value.replace(
+                // eslint-disable-next-line prefer-named-capture-group, regexp/no-unused-capturing-group, regexp/prefer-named-capture-group
+                /(\.js|\.ts)?$/u, ".cjs");
             }
             // Continue traversing the AST
             this.traverse(path);

package/dist/server/is-proxy-enabled-for-path.js

@@ -0,0 +1,10 @@
+export function isProxyEnabledForPath(path, config) {
+    if (config.proxyPaths.has(path)) {
+        return config.proxyPaths.get(path) ?? false;
+    }
+    if (path === "") {
+        return false;
+    }
+    const parentPath = path.slice(0, Math.max(0, path.lastIndexOf("/")));
+    return isProxyEnabledForPath(parentPath, config);
+}

package/dist/server/koa-middleware.js

@@ -1,5 +1,6 @@
 import createDebug from "debug";
 import koaProxy from "koa-proxy";
+import { isProxyEnabledForPath } from "./is-proxy-enabled-for-path.js";
 const debug = createDebug("counterfact:server:create-koa-app");
 const HTTP_STATUS_CODE_OK = 200;
 function addCors(ctx, headers) {
@@ -26,7 +27,7 @@ function getAuthObject(ctx) {
 export function koaMiddleware(dispatcher, config, proxy = koaProxy) {
     // eslint-disable-next-line max-statements
     return async function middleware(ctx, next) {
-        const { proxyEnabled, proxyUrl, routePrefix } = config;
+        const { proxyUrl, routePrefix } = config;
         debug("middleware running for path: %s", ctx.request.path);
         debug("routePrefix: %s", routePrefix);
         if (!ctx.request.path.startsWith(routePrefix)) {
@@ -39,7 +40,7 @@ export function koaMiddleware(dispatcher, config, proxy = koaProxy) {
         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) {
+        if (isProxyEnabledForPath(path, config) && 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);

package/dist/server/response-builder.js

@@ -46,7 +46,11 @@ export function createResponseBuilder(operation) {
                 return this.match("text/html", body);
             },
             json(body) {
-                return this.match("application/json", body);
+                return this.match("application/json", body)
+                    .match("text/json", body)
+                    .match("text/x-json", body)
+                    .match("application/xml", body)
+                    .match("text/xml", body);
             },
             match(contentType, body) {
                 return {

package/dist/server/types.d.ts

@@ -99,7 +99,7 @@ type GenericResponseBuilderInner<
     ? never
     : HeaderFunction<Response>;
   html: MaybeShortcut<"text/html", Response>;
-  json: MaybeShortcut<"application/json", Response>;
+  json: MaybeShortcut<"application/json" | "text/json" | "text/x-json" | "application/xml" | "text/xml", Response>;
   match: [keyof Response["content"]] extends [never]
     ? never
     : MatchFunction<Response>;

package/dist/util/wait-for-event.js

@@ -1,3 +1,4 @@
+import { EventEmitter } from "node:events";
 /**
  * Creates a promise that resolves when a specified event is fired on the given EventTarget.
  * @param {EventTarget | EventEmitter} target - The target to listen for the event on.
@@ -13,11 +14,11 @@ export async function waitForEvent(target, eventName) {
             }
             resolve(event);
         };
-        if (target instanceof EventTarget) {
-            target.addEventListener(eventName, handler);
+        if (target instanceof EventEmitter) {
+            target.once(eventName, handler);
         }
         else {
-            target.once(eventName, handler);
+            target.addEventListener(eventName, handler);
         }
     });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "counterfact",
-  "version": "0.42.0",
+  "version": "0.43.0",
   "description": "a library for building a fake REST API for testing",
   "type": "module",
   "main": "./src/server/counterfact.js",
@@ -44,11 +44,11 @@
     "postinstall": "patch-package"
   },
   "devDependencies": {
-    "@changesets/cli": "2.27.1",
+    "@changesets/cli": "2.27.3",
     "@stryker-mutator/core": "8.2.6",
     "@stryker-mutator/jest-runner": "8.2.6",
     "@stryker-mutator/typescript-checker": "8.2.6",
-    "@swc/core": "1.5.3",
+    "@swc/core": "1.5.7",
     "@swc/jest": "0.2.36",
     "@testing-library/dom": "10.1.0",
     "@types/jest": "29.5.12",
@@ -63,17 +63,17 @@
     "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-file-progress": "1.4.0",
     "eslint-plugin-import": "2.29.1",
     "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.2.0",
+    "eslint-plugin-unused-imports": "4.0.0",
     "husky": "9.0.11",
     "jest": "29.7.0",
     "node-mocks-http": "1.14.1",
-    "nodemon": "3.1.0",
-    "rimraf": "5.0.5",
+    "nodemon": "3.1.1",
+    "rimraf": "5.0.7",
     "stryker-cli": "1.0.2",
     "supertest": "7.0.0",
     "using-temporary-files": "2.2.1"
@@ -83,7 +83,7 @@
     "@types/json-schema": "7.0.15",
     "ast-types": "0.14.2",
     "chokidar": "3.6.0",
-    "commander": "12.0.0",
+    "commander": "12.1.0",
     "debug": "4.3.4",
     "fetch": "1.1.0",
     "fs-extra": "11.2.0",
@@ -102,7 +102,7 @@
     "patch-package": "8.0.0",
     "precinct": "12.1.1",
     "prettier": "3.2.5",
-    "recast": "0.23.6",
+    "recast": "0.23.7",
     "typescript": "5.4.5"
   }
 }

package/dist/server/repl.js

@@ -1,34 +0,0 @@
-import repl from "node:repl";
-export function startRepl(contextRegistry, config) {
-    const replServer = repl.start("🤖> ");
-    replServer.defineCommand("counterfact", {
-        action() {
-            process.stdout.write("This is a read-eval-print loop (REPL), the same as the one you get when you run node with no arguments.\n");
-            process.stdout.write("Except that it's connected to the running server, which you can access with the following globals:\n\n");
-            process.stdout.write("- loadContext('/some/path'): to access the context object for a given path\n");
-            process.stdout.write("- context: the root context ( same as loadContext('/') )\n");
-            process.stdout.write("\nFor more information, see https://counterfact.dev/docs/usage.html\n\n");
-            this.clearBufferedCommand();
-            this.displayPrompt();
-        },
-        help: "Get help with Counterfact",
-    });
-    replServer.defineCommand("proxy", {
-        action(state) {
-            if (state === "on") {
-                config.proxyEnabled = true;
-            }
-            if (state === "off") {
-                config.proxyEnabled = false;
-            }
-            process.stdout.write(`Proxy is ${config.proxyEnabled ? "on" : "off"}: ${config.proxyUrl}\n`);
-            this.clearBufferedCommand();
-            this.displayPrompt();
-        },
-        help: "proxy [on|off] - turn the proxy on or off; proxy - print proxy info",
-    });
-    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;
-}