@counterfact/generator 0.1.1

package/dist/type-coder.d.ts

@@ -0,0 +1,5 @@
+import { Coder } from "./coder.js";
+import type { Script } from "./script.js";
+export declare class TypeCoder extends Coder {
+    write(script: Script): string;
+}

package/dist/type-coder.js

@@ -0,0 +1,9 @@
+import { Coder } from "./coder.js";
+export class TypeCoder extends Coder {
+    write(script) {
+        if (this.requirement?.isReference) {
+            return script.importType(this);
+        }
+        return this.writeCode(script);
+    }
+}

package/dist/versions-ts-generator.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Generates the TypeScript source text for `types/versions.ts`.
+ *
+ * Returns an empty string when `versions` is empty.
+ * The returned string is formatted with Prettier.
+ *
+ * @param versions - Ordered list of unique, non-empty version strings.
+ *   The first entry is the oldest version.
+ */
+export declare function generateVersionsTsContent(versions: readonly string[]): Promise<string>;

package/dist/versions-ts-generator.js

@@ -0,0 +1,82 @@
+import { format } from "prettier";
+/**
+ * Builds the `VersionsGTE` map: for each version V at index i,
+ * maps V to all versions at indices >= i (i.e. V and all later-declared
+ * versions, where "later" means "newer").
+ */
+function buildVersionsGTE(versions) {
+    const result = new Map();
+    versions.forEach((version, index) => {
+        result.set(version, versions.slice(index));
+    });
+    return result;
+}
+/**
+ * Generates the TypeScript source text for `types/versions.ts`.
+ *
+ * Returns an empty string when `versions` is empty.
+ * The returned string is formatted with Prettier.
+ *
+ * @param versions - Ordered list of unique, non-empty version strings.
+ *   The first entry is the oldest version.
+ */
+export async function generateVersionsTsContent(versions) {
+    if (versions.length === 0) {
+        return "";
+    }
+    const versionsUnion = versions.map((v) => `"${v}"`).join(" | ");
+    const versionsGTE = buildVersionsGTE(versions);
+    const versionsGTEBody = Array.from(versionsGTE, ([v, gte]) => `  "${v}": ${gte.map((g) => `"${g}"`).join(" | ")};`).join("\n");
+    const source = [
+        "// This file is auto-generated by Counterfact. Do not edit.",
+        "",
+        '/** Union of all version strings declared for this API group (e.g. `"v1" | "v2" | "v3"`). */',
+        `export type Versions = ${versionsUnion};`,
+        "",
+        "/**",
+        " * Maps each version to the set of versions that are greater than or equal to it.",
+        " * Used by `Versioned.minVersion()` to narrow which versions a handler must support.",
+        " */",
+        "export type VersionsGTE = {",
+        versionsGTEBody,
+        "};",
+        "",
+        "type VersionMap = Partial<Record<Versions, object>>;",
+        "",
+        "/**",
+        " * The type of the `$` argument in a versioned route handler.",
+        " *",
+        " * @typeParam T - A map from version string to the `$`-arg type for that version",
+        " *   (e.g. `{ v1: $v1Type; v2: $v2Type }`). Generated by Counterfact from the spec.",
+        " * @typeParam V - The union of currently active version keys; defaults to all keys of `T`.",
+        " *",
+        " * An instance of `Versioned<T, V>` exposes:",
+        " * - All properties of the intersection `T[V]` (request data, response builders, etc.)",
+        ' * - `version` — the version string for the current request (e.g. `"v2"`).',
+        " * - `minVersion(min)` — type predicate that returns `true` when the current version",
+        " *   is at or after `min` in the declared version order and narrows `$` accordingly.",
+        " *",
+        " * @example",
+        " * ```ts",
+        " * export const GET: HTTP_GET = ($) => {",
+        ' *   if ($.minVersion("v2")) {',
+        " *     // $ is now typed as the v2+ arg — v2-only fields are available",
+        " *     return $.response[200].json({ id: $.path.id, extra: $.body.extra });",
+        " *   }",
+        " *   return $.response[200].json({ id: $.path.id });",
+        " * };",
+        " * ```",
+        " */",
+        "export type Versioned<",
+        "  T extends VersionMap,",
+        "  V extends keyof T & Versions = keyof T & Versions,",
+        "> = T[V] & {",
+        "  version: V;",
+        "  minVersion<M extends keyof T & Versions>(",
+        "    min: M,",
+        "  ): this is Versioned<T, Extract<V, VersionsGTE[M]>>;",
+        "};",
+        "",
+    ].join("\n");
+    return format(source, { parser: "typescript" });
+}

package/dist/wait-for-event.d.ts

@@ -0,0 +1,2 @@
+import { EventEmitter } from "node:events";
+export declare function waitForEvent(target: EventEmitter | EventTarget, eventName: string): Promise<unknown>;

package/dist/wait-for-event.js

@@ -0,0 +1,17 @@
+import { EventEmitter } from "node:events";
+export async function waitForEvent(target, eventName) {
+    return await new Promise((resolve) => {
+        const handler = (event) => {
+            if (target instanceof EventTarget) {
+                target.removeEventListener(eventName, handler);
+            }
+            resolve(event);
+        };
+        if (target instanceof EventEmitter) {
+            target.once(eventName, handler);
+        }
+        else {
+            target.addEventListener(eventName, handler);
+        }
+    });
+}

package/dist/watch-options.d.ts

@@ -0,0 +1,5 @@
+/** Generator-owned watcher policy, independent of the Counterfact runtime. */
+export declare const CHOKIDAR_OPTIONS: {
+    ignoreInitial: boolean;
+    usePolling: boolean;
+};

package/dist/watch-options.js

@@ -0,0 +1,5 @@
+/** Generator-owned watcher policy, independent of the Counterfact runtime. */
+export const CHOKIDAR_OPTIONS = {
+    ignoreInitial: true,
+    usePolling: process.platform === "win32",
+};

package/dist/windows-escape.d.ts

@@ -0,0 +1 @@
+export declare function escapePathForWindows(path: string): string;

package/dist/windows-escape.js

@@ -0,0 +1,9 @@
+const UNICODE_RATIO_SYMBOL = "∶";
+const REGULAR_COLON = ":";
+export function escapePathForWindows(path) {
+    if (path.at(1) === ":") {
+        return (path.slice(0, 2) +
+            path.slice(2).replaceAll(REGULAR_COLON, UNICODE_RATIO_SYMBOL));
+    }
+    return path.replaceAll(REGULAR_COLON, UNICODE_RATIO_SYMBOL);
+}

package/examples/generate-routes.mjs

@@ -0,0 +1,40 @@
+import assert from "node:assert/strict";
+import { mkdtemp, readFile, rm, writeFile } from "node:fs/promises";
+import { tmpdir } from "node:os";
+import path from "node:path";
+
+import { CodeGenerator } from "@counterfact/generator";
+
+const directory = await mkdtemp(path.join(tmpdir(), "counterfact-generator-"));
+
+try {
+  const specPath = path.join(directory, "openapi.yaml");
+  const outputPath = path.join(directory, "generated");
+  await writeFile(
+    specPath,
+    `openapi: 3.0.3
+info:
+  title: Package example
+  version: 1.0.0
+paths:
+  /health:
+    get:
+      operationId: getHealth
+      responses:
+        "204":
+          description: Healthy
+`,
+  );
+
+  await new CodeGenerator(specPath, outputPath, {
+    routes: true,
+    types: true,
+  }).generate();
+
+  assert.match(
+    await readFile(path.join(outputPath, "routes", "health.ts"), "utf8"),
+    /export const GET/u,
+  );
+} finally {
+  await rm(directory, { force: true, recursive: true });
+}

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@counterfact/generator",
+  "version": "0.1.1",
+  "description": "Generate Counterfact route scaffolds and OpenAPI-derived TypeScript contracts.",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "examples",
+    "README.md",
+    "License.md"
+  ],
+  "sideEffects": false,
+  "author": "Patrick McElhaney <pmcelhaney@gmail.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/counterfact/api-simulator.git",
+    "directory": "packages/generator"
+  },
+  "bugs": "https://github.com/counterfact/api-simulator/issues",
+  "homepage": "https://counterfact.dev",
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/pmcelhaney"
+  },
+  "keywords": [
+    "counterfact",
+    "openapi",
+    "code-generator",
+    "api-mocking",
+    "typescript",
+    "testing"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "rimraf dist && tsc --build --force && copyfiles -f \"../types/src/*.ts\" dist/templates/counterfact-types && rimraf dist/templates/counterfact-types/streaming-content-types.ts",
+    "prepack": "yarn build",
+    "test": "node --experimental-vm-modules ../../node_modules/jest-cli/bin/jest.js --config ../../jest.config.js packages/generator/test",
+    "test:packed-consumer": "node test/package/generator-consumer-smoke.mjs"
+  },
+  "dependencies": {
+    "@counterfact/openapi": "0.1.1",
+    "@counterfact/types": "0.1.0",
+    "chokidar": "5.0.0",
+    "debug": "4.4.3",
+    "prettier": "3.9.6"
+  }
+}