counterfact 0.43.2 → 0.44.0

package/bin/counterfact.js

@@ -1,6 +1,7 @@
 #!/usr/bin/env node
 /* eslint-disable complexity */
 
+import fs from "node:fs";
 import { readFile } from "node:fs/promises";
 import nodePath from "node:path";
 import { fileURLToPath } from "node:url";
@@ -97,7 +98,7 @@ function createWatchMessage(config) {
   return watchMessage;
 }
 
-// eslint-disable-next-line max-statements
+// eslint-disable-next-line max-statements, sonarjs/cognitive-complexity
 async function main(source, destination) {
   debug("executing the main function");
 
@@ -165,6 +166,23 @@ async function main(source, destination) {
 
   debug("loading counterfact (%o)", config);
 
+  let didMigrate = false;
+
+  // eslint-disable-next-line n/no-sync
+  if (fs.existsSync(nodePath.join(config.basePath, "paths"))) {
+    await fs.promises.rmdir(nodePath.join(config.basePath, "paths"), {
+      recursive: true,
+    });
+    await fs.promises.rmdir(nodePath.join(config.basePath, "path-types"), {
+      recursive: true,
+    });
+    await fs.promises.rmdir(nodePath.join(config.basePath, "components"), {
+      recursive: true,
+    });
+
+    didMigrate = true;
+  }
+
   const { start } = await counterfact(config);
 
   debug("loaded counterfact", config);
@@ -205,6 +223,23 @@ async function main(source, destination) {
     await open(guiUrl);
     debug("opened browser");
   }
+
+  if (didMigrate) {
+    process.stdout.write("\n\n\n*******************************\n");
+    process.stdout.write("MIGRATING TO NEW FILE STRUCTURE\n\n");
+    process.stdout.write(
+      "In preparation for version 1.0, Counterfact has migrated to a new file structure.\n",
+    );
+    process.stdout.write("- The paths directory has been renamed to routes.\n");
+    process.stdout.write(
+      "- The path-types and components directories are now stored under types.\n",
+    );
+    process.stdout.write("Your files have automatically been migrated.\n");
+    process.stdout.write(
+      "Please report any issues to https://github.com/pmcelhaney/counterfact/issues\n",
+    );
+    process.stdout.write("*******************************\n\n\n");
+  }
 }
 
 program

package/dist/app.js

@@ -36,7 +36,7 @@ export async function counterfact(config) {
     const contextRegistry = new ContextRegistry();
     const codeGenerator = new CodeGenerator(config.openApiPath, config.basePath, config.generate);
     const dispatcher = new Dispatcher(registry, contextRegistry, await loadOpenApiDocument(config.openApiPath));
-    const transpiler = new Transpiler(nodePath.join(modulesPath, "paths").replaceAll("\\", "/"), compiledPathsDirectory, "commonjs");
+    const transpiler = new Transpiler(nodePath.join(modulesPath, "routes").replaceAll("\\", "/"), compiledPathsDirectory, "commonjs");
     const moduleLoader = new ModuleLoader(compiledPathsDirectory, registry, contextRegistry);
     const middleware = koaMiddleware(dispatcher, config);
     const koaApp = createKoaApp(registry, middleware, config);

package/dist/migrate/paths-to-routes.js

@@ -0,0 +1,29 @@
+/* eslint-disable no-await-in-loop */
+/* eslint-disable no-console */
+import { promises as fs } from "node:fs";
+import path from "node:path";
+// eslint-disable-next-line max-statements
+async function copyAndModifyFiles(sourceDirectory, destinationDirectory) {
+    try {
+        const entries = await fs.readdir(sourceDirectory, { withFileTypes: true });
+        await fs.mkdir(destinationDirectory, { recursive: true });
+        for (const entry of entries) {
+            const sourcePath = path.join(sourceDirectory, entry.name);
+            const destinationPath = path.join(destinationDirectory, entry.name);
+            if (entry.isDirectory()) {
+                await copyAndModifyFiles(sourcePath, destinationPath);
+            }
+            else {
+                let fileContent = await fs.readFile(sourcePath, "utf8");
+                fileContent = fileContent.replaceAll("path-types", "types/paths");
+                await fs.writeFile(destinationPath, fileContent);
+            }
+        }
+    }
+    catch (error) {
+        console.error("Error copying and modifying files:", error);
+    }
+}
+export async function pathsToRoutes(rootDirectory) {
+    await copyAndModifyFiles(path.join(rootDirectory, "paths"), path.join(rootDirectory, "routes"));
+}

package/dist/typescript-generator/generate.js

@@ -47,7 +47,7 @@ export async function generate(source, destination, generateOptions, repository
         debug("processing path %s", key);
         pathDefinition.forEach((operation, requestMethod) => {
             repository
-                .get(`paths${key}.ts`)
+                .get(`routes${key}.ts`)
                 .export(new OperationCoder(operation, requestMethod, securitySchemes));
         });
     });

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

@@ -37,7 +37,7 @@ export class OperationCoder extends Coder {
             .at(-2)
             .replaceAll("~1", "/");
         return `${nodePath
-            .join("path", pathString)
+            .join("routes", pathString)
             .replaceAll("\\", "/")}.types.ts`;
     }
 }

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

@@ -54,7 +54,7 @@ export class OperationTypeCoder extends TypeCoder {
             .at(-2)
             .replaceAll("~1", "/");
         return `${nodePath
-            .join("path-types", pathString)
+            .join("types/paths", pathString)
             .replaceAll("\\", "/")}.types.ts`;
     }
     userType() {

package/dist/typescript-generator/repository.js

@@ -50,8 +50,8 @@ export class Repository {
             const contents = await script.contents();
             const fullPath = nodePath.join(destination, path).replaceAll("\\", "/");
             await ensureDirectoryExists(fullPath);
-            const shouldWriteRoutes = routes && path.startsWith("paths");
-            const shouldWriteTypes = types && !path.startsWith("paths");
+            const shouldWriteRoutes = routes && path.startsWith("routes");
+            const shouldWriteTypes = types && !path.startsWith("routes");
             if (shouldWriteRoutes &&
                 (await fs
                     .stat(fullPath)
@@ -73,7 +73,7 @@ export class Repository {
         }
     }
     async createDefaultContextFile(destination) {
-        const contextFilePath = nodePath.join(destination, "paths", "_.context.ts");
+        const contextFilePath = nodePath.join(destination, "routes", "_.context.ts");
         if (existsSync(contextFilePath)) {
             return;
         }
@@ -99,11 +99,14 @@ export class Context {
             .replaceAll("\\", "/");
     }
     nearestContextFile(destination, path) {
-        const directory = nodePath.dirname(path).replace("path-types", "paths");
+        const directory = nodePath
+            .dirname(path)
+            .replaceAll("\\", "/")
+            .replace("types/paths", "routes");
         const candidate = nodePath.join(destination, directory, "_.context.ts");
         if (directory.length <= 1) {
             // No _context.ts was found so import the one that should be in the root
-            return nodePath.join(destination, "paths", "_.context.ts");
+            return nodePath.join(destination, "routes", "_.context.ts");
         }
         if (existsSync(candidate)) {
             return candidate;

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

@@ -53,7 +53,7 @@ export class ResponseTypeCoder extends TypeCoder {
         return requiredHeaders.length === 0 ? "never" : requiredHeaders.join(" | ");
     }
     modulePath() {
-        return `components/${this.requirement.data.$ref.split("/").at(-1)}.ts`;
+        return `types/${this.requirement.data.$ref}.ts`;
     }
     writeCode(script) {
         return `{

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

@@ -34,7 +34,7 @@ export class SchemaCoder extends Coder {
         return script.importExternalType("JSONSchema6", "json-schema");
     }
     modulePath() {
-        return `components/${this.requirement.data.$ref.split("/").at(-1)}.ts`;
+        return `types/${this.requirement.data.$ref}.ts`;
     }
     writeCode(script) {
         const { type } = this.requirement.data;

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

@@ -70,7 +70,7 @@ export class SchemaTypeCoder extends TypeCoder {
             .join(" | ");
     }
     modulePath() {
-        return `components/${this.requirement.data.$ref.split("/").at(-1)}.ts`;
+        return `types/${this.requirement.data.$ref.replace(/^#\//u, "")}.ts`;
     }
     writeCode(script) {
         // script.comments = READ_ONLY_COMMENTS;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "counterfact",
-  "version": "0.43.2",
+  "version": "0.44.0",
   "description": "a library for building a fake REST API for testing",
   "type": "module",
   "main": "./src/server/counterfact.js",