@nestia/migrate 0.6.1 → 0.6.3

package/package.json

@@ -1,64 +1,67 @@
-{
-  "name": "@nestia/migrate",
-  "version": "0.6.1",
-  "description": "Migration program from swagger to NestJS",
-  "main": "lib/index.js",
-  "typings": "lib/index.d.ts",
-  "bin": {
-    "@nestia/migrate": "lib/executable/migrate.js"
-  },
-  "scripts": {
-    "build": "rimraf lib && tsc",
-    "dev": "npm run build -- --watch",
-    "prepare": "ts-patch install && typia patch && ts-node src/executable/bundle.ts",
-    "test": "node lib/test"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/samchon/nestia"
-  },
-  "keywords": [
-    "migration",
-    "swagger",
-    "NestJS",
-    "nestia"
-  ],
-  "author": "Jeongho Nam",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/samchon/nestia/issues"
-  },
-  "homepage": "https://github.com/samchon/nestia#readme",
-  "devDependencies": {
-    "@nestia/core": "^2.4.0",
-    "@nestia/fetcher": "^2.4.0",
-    "@nestjs/common": "^10.3.1",
-    "@nestjs/core": "^10.3.1",
-    "@nestjs/platform-express": "^10.3.1",
-    "@nestjs/platform-fastify": "^10.3.1",
-    "@types/express": "^4.17.21",
-    "@types/node": "^20.3.3",
-    "dotenv": "^16.3.1",
-    "dotenv-expand": "^10.0.0",
-    "rimraf": "^5.0.1",
-    "serialize-error": "^4.1.0",
-    "source-map-support": "^0.5.21",
-    "ts-node": "^10.9.1",
-    "ts-patch": "^3.1.0",
-    "tstl": "^2.5.13",
-    "typescript-transform-paths": "^3.4.6"
-  },
-  "dependencies": {
-    "typia": "^5.4.1",
-    "typescript": "^5.3.3"
-  },
-  "files": [
-    "lib",
-    "src",
-    "!lib/test",
-    "!src/test",
-    "package.json",
-    "README.md",
-    "LICENSE"
-  ]
-}
+{
+  "name": "@nestia/migrate",
+  "version": "0.6.3",
+  "description": "Migration program from swagger to NestJS",
+  "main": "lib/index.js",
+  "typings": "lib/index.d.ts",
+  "bin": {
+    "@nestia/migrate": "lib/executable/migrate.js"
+  },
+  "scripts": {
+    "build": "rimraf lib && tsc",
+    "dev": "npm run build -- --watch",
+    "prepare": "ts-patch install && typia patch && ts-node src/executable/bundle.ts",
+    "test": "node lib/test"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/samchon/nestia"
+  },
+  "keywords": [
+    "migration",
+    "swagger",
+    "NestJS",
+    "nestia"
+  ],
+  "author": "Jeongho Nam",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/samchon/nestia/issues"
+  },
+  "homepage": "https://github.com/samchon/nestia#readme",
+  "devDependencies": {
+    "@nestia/core": "2.5.0-dev.20240201",
+    "@nestia/fetcher": "2.5.0-dev.20240201",
+    "@nestjs/common": "^10.3.1",
+    "@nestjs/core": "^10.3.1",
+    "@nestjs/platform-express": "^10.3.1",
+    "@nestjs/platform-fastify": "^10.3.1",
+    "@types/express": "^4.17.21",
+    "@types/inquirer": "^9.0.7",
+    "@types/node": "^20.3.3",
+    "dotenv": "^16.3.1",
+    "dotenv-expand": "^10.0.0",
+    "rimraf": "^5.0.1",
+    "serialize-error": "^4.1.0",
+    "source-map-support": "^0.5.21",
+    "ts-node": "^10.9.1",
+    "ts-patch": "^3.1.0",
+    "tstl": "^2.5.13",
+    "typescript-transform-paths": "^3.4.6"
+  },
+  "dependencies": {
+    "commander": "10.0.0",
+    "inquirer": "8.2.5",
+    "typescript": "^5.3.3",
+    "typia": "^5.4.1"
+  },
+  "files": [
+    "lib",
+    "src",
+    "!lib/test",
+    "!src/test",
+    "package.json",
+    "README.md",
+    "LICENSE"
+  ]
+}

package/src/IMigrateConfig.ts

@@ -0,0 +1,3 @@
+export interface IMigrateConfig {
+  simulate: boolean;
+}

package/src/MigrateApplication.ts

@@ -2,10 +2,12 @@ import cp from "child_process";
 import fs from "fs";
 import typia from "typia";
 
+import { IMigrateConfig } from "./IMigrateConfig";
 import { MigrateAnalyzer } from "./analyzers/MigrateAnalyzer";
 import { FileArchiver } from "./archivers/FileArchiver";
 import { TEMPLATE } from "./bundles/TEMPLATE";
-import { MigrateProgrammer } from "./programmers/NestProgrammer";
+import { ApiProgrammer } from "./programmers/ApiProgrammer";
+import { NestProgrammer } from "./programmers/NestProgrammer";
 import { IMigrateFile } from "./structures/IMigrateFile";
 import { IMigrateProgram } from "./structures/IMigrateProgram";
 import { ISwagger } from "./structures/ISwagger";
@@ -15,7 +17,10 @@ export class MigrateApplication {
   private program: IMigrateProgram | null;
   private files: IMigrateFile[] | null;
 
-  public constructor(swagger: ISwagger) {
+  public constructor(
+    public readonly config: IMigrateConfig,
+    swagger: ISwagger,
+  ) {
     this.swagger = typia.assert(swagger);
     this.program = null;
     this.files = null;
@@ -23,47 +28,51 @@ export class MigrateApplication {
 
   public analyze(): IMigrateProgram {
     if (this.program === null)
-      this.program = MigrateAnalyzer.analyze(this.swagger);
+      this.program = MigrateAnalyzer.analyze(this.config)(this.swagger);
     return this.program;
   }
 
   public write(): IMigrateFile[] {
     if (this.files === null) {
-      const program: IMigrateProgram = this.analyze();
-      this.files = MigrateProgrammer.write(program);
+      this.program ??= this.analyze();
+      this.files = [
+        ...ApiProgrammer.write(this.program),
+        ...NestProgrammer.write(this.program),
+      ];
     }
     return this.files;
   }
 
-  public generate =
-    (archiver: NestiaMigrateApplication.IArchiver) =>
-    (output: string): void => {
-      const program: IMigrateProgram = this.analyze();
-      const files: IMigrateFile[] = MigrateProgrammer.write(program);
-
+  public async generate(output: string): Promise<void> {
+    const files: IMigrateFile[] = this.write();
+    const archiver = FileArchiver.archive({
+      mkdir: fs.promises.mkdir,
+      writeFile: (file, content) =>
+        fs.promises.writeFile(file, content, "utf8"),
+    })(output);
+    try {
+      cp.execSync(
+        `git clone https://github.com/samchon/nestia-template "${output}"`,
+        { stdio: "ignore" },
+      );
       try {
-        cp.execSync(
-          `git clone https://github.com/samchon/nestia-template "${output}"`,
-          { stdio: "ignore" },
-        );
-        try {
-          for (const path of [
-            "/.git",
-            "/src/api",
-            "/src/controllers",
-            "/src/providers",
-            "/test/features",
-          ])
-            fs.rmSync(`${output}${path}`, {
-              recursive: true,
-              force: true,
-            });
-        } catch {}
-      } catch {
-        FileArchiver.archive(archiver)(output)(TEMPLATE);
-      }
-      FileArchiver.archive(archiver)(output)(files);
-    };
+        for (const path of [
+          "/.git",
+          "/src/api",
+          "/src/controllers",
+          "/src/providers",
+          "/test/features",
+        ])
+          fs.rmSync(`${output}${path}`, {
+            recursive: true,
+            force: true,
+          });
+      } catch {}
+    } catch (exp) {
+      await archiver(TEMPLATE);
+    }
+    await archiver(files);
+  }
 }
 export namespace NestiaMigrateApplication {
   export interface IArchiver {

package/src/analyzers/ControllerAnalyzer.ts

@@ -1,3 +1,5 @@
+import { Escaper } from "typia/lib/utils/Escaper";
+
 import { ISwagger } from "../module";
 import { IMigrateController } from "../structures/IMigrateController";
 import { IMigrateRoute } from "../structures/IMigrateRoute";
@@ -62,7 +64,7 @@ export namespace ControllerAnalyzer {
           routes,
         };
         if (controller.name === "Controller") controller.name = "__Controller";
-        naming(controller);
+        emend(controller);
         return controller;
       });
   };
@@ -73,7 +75,7 @@ export namespace ControllerAnalyzer {
       .slice(0, -1)
       .reverse();
 
-  const naming = (controller: IMigrateController): void => {
+  const emend = (controller: IMigrateController): void => {
     interface IRouteCapsule {
       variables: string[];
       route: IMigrateRoute;
@@ -93,7 +95,6 @@ export namespace ControllerAnalyzer {
           route,
         });
     }
-
     for (const [method, capsules] of dict) {
       const emended: string = method === "delete" ? "erase" : method;
       for (const c of capsules) {
@@ -103,5 +104,20 @@ export namespace ControllerAnalyzer {
           : StringUtil.camel(`${emended}By/${c.variables.join("/and/")}`);
       }
     }
+    for (const method of controller.routes) {
+      if (Escaper.variable(method.name) === false)
+        method.name = "_" + method.name;
+      for (const spec of [method.headers, method.query, method.body])
+        if (spec)
+          spec.key = StringUtil.escapeDuplicate(
+            method.parameters.map((p) => p.key),
+          )(spec.key);
+    }
+    controller.routes.forEach(
+      (r, i) =>
+        (r.name = StringUtil.escapeDuplicate(
+          controller.routes.filter((_r, j) => i !== j).map((x) => x.name),
+        )(r.name)),
+    );
   };
 }

package/src/analyzers/MethodAnalyzer.ts

@@ -161,14 +161,18 @@ export namespace MethodAnalzyer {
         name: "@lazy",
         path: props.path,
         method: props.method,
-        headers,
+        headers: headers
+          ? {
+              key: "headers",
+              schema: headers,
+            }
+          : null,
         parameters: (route.parameters ?? [])
           .filter((p) => p.in === "path")
           .map((p, i) => ({
             key: (() => {
               let key: string = StringUtil.normalize(parameterNames[i]);
               if (Escaper.variable(key)) return key;
-
               while (true) {
                 key = "_" + key;
                 if (!parameterNames.some((s) => s === key)) return key;
@@ -179,7 +183,12 @@ export namespace MethodAnalzyer {
               description: p.schema.description ?? p.description,
             },
           })),
-        query,
+        query: query
+          ? {
+              key: "query",
+              schema: query,
+            }
+          : null,
         body,
         success,
         exceptions: Object.fromEntries(
@@ -198,8 +207,9 @@ export namespace MethodAnalzyer {
               },
             ]),
         ),
+        deprecated: route.deprecated ?? false,
         description: describe(route),
-        "x-nestia-jsDocTags": route["x-nestia-jsDocTags"],
+        tags: route.tags ?? [],
       };
     };
 
@@ -274,6 +284,7 @@ export namespace MethodAnalzyer {
         const { schema } = json[1];
         return {
           type: "application/json",
+          key: "body",
           schema: isNotObjectLiteral(schema) ? schema : emplacer(schema),
           "x-nestia-encrypted": meta["x-nestia-encrypted"],
         };
@@ -286,12 +297,14 @@ export namespace MethodAnalzyer {
         const { schema } = query[1];
         return {
           type: "application/x-www-form-urlencoded",
+          key: "body",
           schema: isNotObjectLiteral(schema) ? schema : emplacer(schema),
         };
       }
 
       const text = entries.find((e) => e[0].includes("text/plain"));
-      if (text) return { type: "text/plain", schema: { type: "string" } };
+      if (text)
+        return { type: "text/plain", key: "body", schema: { type: "string" } };
       return false;
     };
 

package/src/analyzers/MigrateAnalyzer.ts

@@ -1,9 +1,13 @@
+import { IMigrateConfig } from "../IMigrateConfig";
 import { IMigrateProgram, ISwagger } from "../module";
 import { ControllerAnalyzer } from "./ControllerAnalyzer";
 
 export namespace MigrateAnalyzer {
-  export const analyze = (swagger: ISwagger): IMigrateProgram => ({
-    swagger,
-    controllers: ControllerAnalyzer.analyze(swagger),
-  });
+  export const analyze =
+    (config: IMigrateConfig) =>
+    (swagger: ISwagger): IMigrateProgram => ({
+      config,
+      swagger,
+      controllers: ControllerAnalyzer.analyze(swagger),
+    });
 }

package/src/archivers/FileArchiver.ts

@@ -2,18 +2,21 @@ import { IMigrateFile } from "../structures/IMigrateFile";
 
 export namespace FileArchiver {
   export interface IOperator {
-    mkdir(path: string): void;
-    writeFile(path: string, content: string): void;
+    mkdir(path: string): Promise<void>;
+    writeFile(path: string, content: string): Promise<void>;
   }
 
   export const archive =
     (operator: IOperator) =>
     (output: string) =>
-    (files: IMigrateFile[]): void => {
+    async (files: IMigrateFile[]): Promise<void> => {
       const visited: Set<string> = new Set();
       for (const f of files) {
-        mkdir(operator.mkdir)(output)(visited)(f.location);
-        operator.writeFile([output, f.location, f.file].join("/"), f.content);
+        await mkdir(operator.mkdir)(output)(visited)(f.location);
+        await operator.writeFile(
+          [output, f.location, f.file].join("/"),
+          f.content,
+        );
       }
     };
 
@@ -21,14 +24,14 @@ export namespace FileArchiver {
     (creator: (path: string) => void) =>
     (output: string) =>
     (visited: Set<string>) =>
-    (path: string): void => {
+    async (path: string): Promise<void> => {
       const sequence: string[] = path
         .split("/")
         .map((_str, i, entire) => entire.slice(0, i + 1).join("/"));
       for (const s of sequence)
         if (visited.has(s) === false)
           try {
-            creator([output, s].join("/"));
+            await creator([output, s].join("/"));
             visited.add(s);
           } catch {}
     };

package/src/executable/migrate.ts

@@ -8,9 +8,10 @@ import { SetupWizard } from "../utils/SetupWizard";
 
 const USAGE = `Wrong command has been detected. Use like below:
 
-npx @nestia/migrate [input] [output]
+npx @nestia/migrate <nest|sdk> --input <swagger.json> --output <directory>
 
-  ex) npx @nestia/migrate swagger.json my-new-project
+  ex) npx @nestia/migrate nest --input swagger.json --output my-nest-project
+  ex) npx @nestia/migrate sdk --input swagger.json --output my-sdk-library
 `;
 
 function halt(desc: string): never {
@@ -18,7 +19,7 @@ function halt(desc: string): never {
   process.exit(-1);
 }
 
-const main = (argv: string[]) => {
+const main = async (argv: string[]): Promise<void> => {
   const resolve = (str: string | undefined) =>
     str ? path.resolve(str).split("\\").join("/") : undefined;
   const input: string | undefined = resolve(argv[0]);
@@ -47,13 +48,18 @@ const main = (argv: string[]) => {
   })();
 
   // DO GENERATE
-  const app = new MigrateApplication(swagger);
-  app.generate({
-    mkdir: fs.mkdirSync,
-    writeFile: (path, content) => fs.writeFileSync(path, content, "utf8"),
-  })(output);
+  const app: MigrateApplication = new MigrateApplication(
+    {
+      simulate: false,
+    },
+    swagger,
+  );
+  await app.generate(output);
 
   // RUN SCRIPTS
   SetupWizard.setup(output);
 };
-main(process.argv.slice(2));
+main(process.argv.slice(2)).catch((exp) => {
+  console.error(exp);
+  process.exit(-1);
+});

package/src/internal/MigrateArguments.ts

@@ -0,0 +1,74 @@
+import commander from "commander";
+import inquirer from "inquirer";
+
+export namespace MigrateArguments {
+  export interface IOutput {
+    mode: "nest" | "sdk";
+    input: string;
+    output: string;
+  }
+
+  export const parse = async (): Promise<IOutput> => {
+    // PREPARE ASSETS
+    commander.program.option("--node [nest/sdk]", "migration mode");
+    commander.program.option(
+      "--input [swagger.json]",
+      "location of target swagger.json file",
+    );
+    commander.program.option("--output [directory]", "output directory path");
+
+    // INTERNAL PROCEDURES
+    const questioned = { value: false };
+    const action = (
+      closure: (options: Partial<IOutput>) => Promise<IOutput>,
+    ) => {
+      return new Promise<IOutput>((resolve, reject) => {
+        commander.program.action(async (options) => {
+          try {
+            resolve(await closure(options));
+          } catch (exp) {
+            reject(exp);
+          }
+        });
+        commander.program.parseAsync().catch(reject);
+      });
+    };
+    const select =
+      (name: string) =>
+      (message: string) =>
+      async <Choice extends string>(
+        choices: Choice[],
+        filter?: (value: string) => Choice,
+      ): Promise<Choice> => {
+        questioned.value = true;
+        return (
+          await inquirer.createPromptModule()({
+            type: "list",
+            name: name,
+            message: message,
+            choices: choices,
+            filter,
+          })
+        )[name];
+      };
+    const input = (name: string) => async (message: string) =>
+      (
+        await inquirer.createPromptModule()({
+          type: "input",
+          name,
+          message,
+        })
+      )[name];
+
+    // DO CONSTRUCT
+    return action(async (partial) => {
+      partial.mode ??= await select("mode")("Migration mode")(
+        ["NestJS" as "nest", "SDK" as "sdk"],
+        (value) => (value === "NestJS" ? "nest" : "sdk"),
+      );
+      partial.input ??= await input("input")("Swagger file location");
+      partial.output ??= await input("output")("Output directory path");
+      return partial as IOutput;
+    });
+  };
+}

package/src/programmers/ApiFileProgrammer.ts

@@ -0,0 +1,53 @@
+import ts from "typescript";
+
+import { IMigrateConfig } from "../IMigrateConfig";
+import { IMigrateController } from "../structures/IMigrateController";
+import { IMigrateRoute } from "../structures/IMigrateRoute";
+import { ISwaggerComponents } from "../structures/ISwaggerComponents";
+import { ApiFunctionProgrammer } from "./ApiFunctionProgrammer";
+import { ApiNamespaceProgrammer } from "./ApiNamespaceProgrammer";
+import { ImportProgrammer } from "./ImportProgrammer";
+
+export namespace ApiFileProgrammer {
+  export interface IProps {
+    namespace: string[];
+    entries: IEntry[];
+    children: Set<string>;
+  }
+  export interface IEntry {
+    controller: IMigrateController;
+    route: IMigrateRoute;
+    alias: string;
+  }
+
+  export const write =
+    (config: IMigrateConfig) =>
+    (components: ISwaggerComponents) =>
+    (props: IProps): ts.Statement[] => {
+      const importer: ImportProgrammer = new ImportProgrammer();
+      const statements: ts.Statement[] = props.entries
+        .map((p) => [
+          ApiFunctionProgrammer.write(config)(components)(importer)(p),
+          ApiNamespaceProgrammer.write(config)(components)(importer)(p),
+        ])
+        .flat();
+      return [
+        ...importer.toStatements(
+          (ref) =>
+            `../${"../".repeat(props.namespace.length)}structures/${ref}`,
+        ),
+        ...[...props.children].map((child) =>
+          ts.factory.createExportDeclaration(
+            undefined,
+            false,
+            ts.factory.createNamespaceExport(
+              ts.factory.createIdentifier(child),
+            ),
+            ts.factory.createStringLiteral(`./${child}`),
+            undefined,
+          ),
+        ),
+        ...statements,
+      ];
+    };
+}