counterfact 0.10.0 → 0.10.2

package/.eslintrc.cjs

@@ -36,14 +36,7 @@ const rules = {
 };
 
 module.exports = {
-  ignorePatterns: [
-    "/node_modules/",
-    "/coverage/",
-    "/reports/",
-    "/demo-ts",
-    "/templates/",
-    "/out/",
-  ],
+  ignorePatterns: ["/node_modules/", "/coverage/", "/reports/", "/out/"],
 
   extends: ["hardcore", "hardcore/ts", "hardcore/node"],
 

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # counterfact
 
+## 0.10.2
+
+### Patch Changes
+
+- d8cbc41: fix swagger-ui when the openapi doc has a host property
+- d8cbc41: ensure a $context.ts file is created in every directory
+- 15270ed: remove dead code in operation-coder.js
+- c7a928f: encode non-alphanumeric name as valid variable names
+
+## 0.10.1
+
+### Patch Changes
+
+- 02efcd5: fix so that Counterfact no longer depends on itself
+
 ## 0.10.0
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "counterfact",
-  "version": "0.10.0",
+  "version": "0.10.2",
   "description": "a library for building a fake REST API for testing",
   "type": "module",
   "main": "./src/counterfact.js",
@@ -60,7 +60,6 @@
     "@types/json-schema": "^7.0.11",
     "chokidar": "^3.5.3",
     "commander": "^9.4.0",
-    "counterfact": "*",
     "fs-extra": "^10.1.0",
     "js-yaml": "^4.1.0",
     "json-schema-faker": "^0.5.0-rcv.44",

package/src/counterfact.js

@@ -14,6 +14,9 @@ import { ModuleLoader } from "./module-loader.js";
 import { Transpiler } from "./transpiler.js";
 import { ContextRegistry } from "./context-registry.js";
 
+// eslint-disable-next-line no-underscore-dangle
+const __dirname = nodePath.dirname(new URL(import.meta.url).pathname);
+
 async function loadOpenApiDocument(source) {
   try {
     return $RefParser.dereference(await yaml.load(await readFile(source)));
@@ -35,6 +38,11 @@ export async function counterfact(
     nodePath.join(os.tmpdir(), "counterfact-")
   )}/`;
 
+  fs.copyFile(
+    nodePath.join(__dirname, "../templates/response-builder-factory.ts"),
+    nodePath.join(basePath, "response-builder-factory.ts")
+  );
+
   try {
     await fs.writeFile(
       nodePath.join(modulesPath, "package.json"),

package/src/start.js

@@ -25,7 +25,10 @@ export async function start({
 
         openApiDocument.servers ??= [];
 
-        openApiDocument.servers.unshift({ url: "/" });
+        openApiDocument.servers.unshift({
+          description: "Counterfact",
+          url: `//localhost:${port}`,
+        });
 
         // eslint-disable-next-line require-atomic-updates
         ctx.body = yaml.dump(openApiDocument);

package/src/typescript-generator/coder.js

@@ -27,7 +27,11 @@ export class Coder {
     return new this.constructor(requirement);
   }
 
-  *names(name = this.requirement.url.split("/").at(-1)) {
+  *names(rawName = this.requirement.url.split("/").at(-1)) {
+    const name = rawName
+      .replace(/^\d/u, (digit) => `_${digit}`)
+      .replace(/[^\w$]/gu, "_");
+
     yield name;
 
     let index = 1;

package/src/typescript-generator/context-coder.js

@@ -3,31 +3,37 @@ import nodePath from "node:path";
 import { Coder } from "./coder.js";
 
 export class ContextCoder extends Coder {
-  isRoot() {
-    return this.requirement.url.split("/").at(-2).split("~1").length === 2;
+  pathString() {
+    return this.requirement.url
+      .split("/")
+      .at(-2)
+      .replaceAll("~1", "/")
+      .replaceAll("~0", "~");
   }
 
   names() {
     return super.names("Context");
   }
 
-  write() {
-    if (this.isRoot()) {
+  write(script) {
+    if (script.path === "paths/$context.ts") {
       return "{}";
     }
 
+    const parentPath = nodePath.normalize(
+      nodePath.join(script.path, "../../$context.ts")
+    );
+
+    script.repository.get(parentPath).exportDefault(this);
+
     return { raw: 'export { default } from "../$context.js"' };
   }
 
   modulePath() {
-    const pathString = this.requirement.url
-      .split("/")
-      .at(-2)
-      .replaceAll("~1", "/");
-
-    return `${nodePath.join(
+    return nodePath.join(
       "paths",
-      nodePath.dirname(pathString)
-    )}/$context.ts`;
+      nodePath.dirname(this.pathString()),
+      "$context.ts"
+    );
   }
 }

package/src/typescript-generator/operation-coder.js

@@ -16,20 +16,6 @@ export class OperationCoder extends Coder {
   write() {
     const responses = this.requirement.get("responses");
 
-    const requestProperties = this.requirement.data.parameters
-      ? Array.from(
-          new Set(
-            this.requirement.data.parameters.map((parameter) => parameter.in)
-          )
-        )
-      : [];
-
-    if (this.requestMethod() !== "GET") {
-      requestProperties.push("body");
-    }
-
-    requestProperties.push("context", "tools");
-
     const [firstStatusCode] = responses.map(([statusCode]) => statusCode);
     const [firstResponse] = responses.map(([, response]) => response.data);
 

package/src/typescript-generator/response-type-coder.js

@@ -1,3 +1,5 @@
+import nodePath from "node:path";
+
 import { Coder } from "./coder.js";
 import { SchemaTypeCoder } from "./schema-type-coder.js";
 
@@ -75,9 +77,21 @@ export class ResponseTypeCoder extends Coder {
   }
 
   write(script) {
-    script.importExternalType("ResponseBuilderBuilder", "counterfact");
-    script.importExternalType("HttpStatusCode", "counterfact");
+    const basePath = script.path
+      .split("/")
+      .slice(0, -1)
+      .map(() => "..")
+      .join("/");
+
+    script.importExternalType(
+      "ResponseBuilderFactory",
+      nodePath.join(basePath, "response-builder-factory.js")
+    );
+    script.importExternalType(
+      "HttpStatusCode",
+      nodePath.join(basePath, "response-builder-factory.js")
+    );
 
-    return `ResponseBuilderBuilder<${this.buildResponseObjectType(script)}>`;
+    return `ResponseBuilderFactory<${this.buildResponseObjectType(script)}>`;
   }
 }

package/templates/response-builder-factory.ts

@@ -0,0 +1,142 @@
+interface OpenApiHeader {
+  schema: unknown;
+}
+
+interface OpenApiContent {
+  schema: unknown;
+}
+
+type OmitValueWhenNever<Base> = Pick<
+  Base,
+  {
+    [Key in keyof Base]: [Base[Key]] extends [never] ? never : Key;
+  }[keyof Base]
+>;
+
+type MediaType = `${string}/${string}`;
+
+interface OpenApiResponse {
+  headers: { [key: string]: OpenApiHeader };
+  content: { [key: MediaType]: OpenApiContent };
+}
+
+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<{
+    headers: Response["headers"];
+    content: Omit<Response["content"], ContentType>;
+  }>,
+  never
+>;
+
+type MatchFunction<Response extends OpenApiResponse> = <
+  ContentType extends MediaType & keyof Response["content"]
+>(
+  contentType: ContentType,
+  body: Response["content"][ContentType]["schema"]
+) => ResponseBuilder<{
+  headers: Response["headers"];
+  content: Omit<Response["content"], ContentType>;
+}>;
+
+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>;
+}>;
+
+type ResponseBuilder<Response extends 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>;
+      match: [keyof Response["content"]] extends [never]
+        ? never
+        : MatchFunction<Response>;
+      text: MaybeShortcut<"text/plain", Response>;
+      json: MaybeShortcut<"application/json", Response>;
+      html: MaybeShortcut<"text/html", Response>;
+      random: [keyof Response["content"]] extends [never] ? never : () => void;
+    }>;
+
+export type ResponseBuilderFactory<Responses extends 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;