@nestia/sdk 3.0.0-dev.20231209 → 3.0.0-dev.20240412

package/src/analyses/ReflectAnalyzer.ts

@@ -1,7 +1,8 @@
 import * as Constants from "@nestjs/common/constants";
+import { RouteParamtypes } from "@nestjs/common/enums/route-paramtypes.enum";
 import { VERSION_NEUTRAL, VersionValue } from "@nestjs/common/interfaces";
 import "reflect-metadata";
-import { equal } from "tstl/ranges/module";
+import { ranges } from "tstl";
 
 import { IController } from "../structures/IController";
 import { IErrorReport } from "../structures/IErrorReport";
@@ -94,6 +95,7 @@ export namespace ReflectAnalyzer {
       //----
       // BASIC INFO
       const meta: IController = {
+        target: creator,
         file,
         name,
         functions: [],
@@ -261,6 +263,7 @@ export namespace ReflectAnalyzer {
 
       // DO CONSTRUCT
       const meta: IController.IFunction = {
+        target: proto,
         name,
         method: method === "ALL" ? "POST" : method,
         paths: _Get_paths(proto).filter((str) => {
@@ -280,15 +283,15 @@ export namespace ReflectAnalyzer {
         status: Reflect.getMetadata(Constants.HTTP_CODE_METADATA, proto),
         encrypted,
         contentType: encrypted
-          ? "application/octet-stream"
+          ? "text/plain"
           : query
-          ? "application/x-www-form-urlencoded"
-          : Reflect.getMetadata(Constants.HEADERS_METADATA, proto)?.find(
-              (h: Record<string, string>) =>
-                typeof h?.name === "string" &&
-                typeof h?.value === "string" &&
-                h.name.toLowerCase() === "content-type",
-            )?.value ?? "application/json",
+            ? "application/x-www-form-urlencoded"
+            : Reflect.getMetadata(Constants.HEADERS_METADATA, proto)?.find(
+                (h: Record<string, string>) =>
+                  typeof h?.name === "string" &&
+                  typeof h?.value === "string" &&
+                  h.name.toLowerCase() === "content-type",
+              )?.value ?? "application/json",
         security: _Get_securities(proto),
         exceptions: _Get_exceptions(proto),
         swaggerTags: [
@@ -310,18 +313,23 @@ export namespace ReflectAnalyzer {
           if (location.includes("*")) continue;
 
           // LIST UP PARAMETERS
-          const binded: string[] = PathAnalyzer.parameters(
-            location,
-            () => `${controller.name}.${name}()`,
-          ).sort();
-
+          const binded: string[] | null = PathAnalyzer.parameters(location);
+          if (binded === null) {
+            project.errors.push({
+              file: controller.file,
+              controller: controller.name,
+              function: name,
+              message: `invalid path ("${location}")`,
+            });
+            continue;
+          }
           const parameters: string[] = meta.parameters
             .filter((param) => param.category === "param")
             .map((param) => param.field!)
             .sort();
 
           // DO VALIDATE
-          if (equal(binded, parameters) === false)
+          if (ranges.equal(binded.sort(), parameters) === false)
             errors.push({
               file: controller.file,
               controller: controller.name,
@@ -351,10 +359,10 @@ export namespace ReflectAnalyzer {
     if (symbol.indexOf("__custom") !== -1)
       return _Analyze_custom_parameter(param);
 
-    const typeIndex: number = Number(symbol[0]);
+    const typeIndex: RouteParamtypes = Number(symbol[0]) as RouteParamtypes;
     if (isNaN(typeIndex) === true) return null;
 
-    const type: ParamCategory | undefined = NEST_PARAMETER_TYPES[typeIndex];
+    const type: ParamCategory | undefined = getNestParamType(typeIndex);
     if (type === undefined) return null;
 
     return {
@@ -374,7 +382,8 @@ export namespace ReflectAnalyzer {
       param.factory.name === "EncryptedBody" ||
       param.factory.name === "PlainBody" ||
       param.factory.name === "TypedQueryBody" ||
-      param.factory.name === "TypedBody"
+      param.factory.name === "TypedBody" ||
+      param.factory.name === "TypedFormDataBody"
     )
       return {
         custom: true,
@@ -388,8 +397,10 @@ export namespace ReflectAnalyzer {
           param.factory.name === "EncryptedBody"
             ? "text/plain"
             : param.factory.name === "TypedQueryBody"
-            ? "application/x-www-form-urlencoded"
-            : "application/json",
+              ? "application/x-www-form-urlencoded"
+              : param.factory.name === "TypedFormDataBody"
+                ? "multipart/form-data"
+                : "application/json",
       };
     else if (param.factory.name === "TypedHeaders")
       return {
@@ -442,18 +453,11 @@ const METHODS = [
   "HEAD",
 ];
 
-// node_modules/@nestjs/common/lib/route-paramtypes.enum.ts
-const NEST_PARAMETER_TYPES = [
-  undefined,
-  undefined,
-  undefined,
-  "body",
-  "query",
-  "param",
-  "headers",
-  undefined,
-  undefined,
-  undefined,
-  undefined,
-  undefined,
-] as const;
+// https://github.com/nestjs/nest/blob/master/packages/common/enums/route-paramtypes.enum.ts
+const getNestParamType = (value: RouteParamtypes) => {
+  if (value === RouteParamtypes.BODY) return "body";
+  else if (value === RouteParamtypes.HEADERS) return "headers";
+  else if (value === RouteParamtypes.QUERY) return "query";
+  else if (value === RouteParamtypes.PARAM) return "param";
+  return undefined;
+};

package/src/analyses/SecurityAnalyzer.ts

@@ -1,20 +1,24 @@
-import { MapUtil } from "../utils/MapUtil";
-
-export namespace SecurityAnalyzer {
-  export const merge = (...entire: Record<string, string[]>[]) => {
-    const dict: Map<string, Set<string>> = new Map();
-    for (const obj of entire)
-      for (const [key, value] of Object.entries(obj)) {
-        const set = MapUtil.take(dict, key, () => new Set());
-        for (const val of value) set.add(val);
-      }
-    const output: Record<string, string[]>[] = [];
-    for (const [key, set] of dict) {
-      const obj = {
-        [key]: [...set],
-      };
-      output.push(obj);
-    }
-    return output;
-  };
-}
+import { MapUtil } from "../utils/MapUtil";
+
+export namespace SecurityAnalyzer {
+  const none = Symbol("none");
+  export const merge = (...entire: Record<string, string[]>[]) => {
+    const dict: Map<string | typeof none, Set<string>> = new Map();
+    for (const obj of entire) {
+      const entries = Object.entries(obj);
+      for (const [key, value] of entries) {
+        const set = MapUtil.take(dict, key, () => new Set());
+        for (const val of value) set.add(val);
+      }
+      if (entries.length === 0) MapUtil.take(dict, none, () => new Set());
+    }
+    const output: Record<string, string[]>[] = [];
+    for (const [key, set] of dict)
+      key === none
+        ? output.push({})
+        : output.push({
+            [key]: [...set],
+          });
+    return output;
+  };
+}

package/src/executable/internal/CommandParser.ts

@@ -1,15 +1,15 @@
-export namespace CommandParser {
-  export function parse(argList: string[]): Record<string, string> {
-    const output: Record<string, string> = {};
-    argList.forEach((arg, i) => {
-      if (arg.startsWith("--") === false) return;
-
-      const key = arg.slice(2);
-      const value: string | undefined = argList[i + 1];
-      if (value === undefined || value.startsWith("--")) return;
-
-      output[key] = value;
-    });
-    return output;
-  }
-}
+export namespace CommandParser {
+  export function parse(argList: string[]): Record<string, string> {
+    const output: Record<string, string> = {};
+    argList.forEach((arg, i) => {
+      if (arg.startsWith("--") === false) return;
+
+      const key = arg.slice(2);
+      const value: string | undefined = argList[i + 1];
+      if (value === undefined || value.startsWith("--")) return;
+
+      output[key] = value;
+    });
+    return output;
+  }
+}

package/src/executable/internal/NestiaConfigLoader.ts

@@ -1,67 +1,67 @@
-import fs from "fs";
-import path from "path";
-import { register } from "ts-node";
-import { parseNative } from "tsconfck";
-import ts from "typescript";
-import typia from "typia";
-
-import { INestiaConfig } from "../../INestiaConfig";
-
-export namespace NestiaConfigLoader {
-  export const compilerOptions = async (
-    project: string,
-  ): Promise<ts.CompilerOptions> => {
-    const configFileName = ts.findConfigFile(
-      process.cwd(),
-      ts.sys.fileExists,
-      project,
-    );
-    if (!configFileName) throw new Error(`unable to find "${project}" file.`);
-
-    const { tsconfig } = await parseNative(configFileName);
-    const configFileText = JSON.stringify(tsconfig);
-    const { config } = ts.parseConfigFileTextToJson(
-      configFileName,
-      configFileText,
-    );
-    const configParseResult = ts.parseJsonConfigFileContent(
-      config,
-      ts.sys,
-      path.dirname(configFileName),
-    );
-
-    const { moduleResolution, ...result } =
-      configParseResult.raw.compilerOptions;
-    return result;
-  };
-
-  export const config = async (
-    file: string,
-    options: ts.CompilerOptions,
-  ): Promise<INestiaConfig> => {
-    if (fs.existsSync(path.resolve(file)) === false)
-      throw new Error(`Unable to find "${file}" file.`);
-
-    register({
-      emit: false,
-      compilerOptions: options,
-      require: options.baseUrl ? ["tsconfig-paths/register"] : undefined,
-    });
-
-    const loaded: INestiaConfig & { default?: INestiaConfig } = await import(
-      path.resolve(file)
-    );
-    const config: INestiaConfig =
-      typeof loaded?.default === "object" && loaded.default !== null
-        ? loaded.default
-        : loaded;
-
-    try {
-      return typia.assert(config);
-    } catch (exp) {
-      if (typia.is<typia.TypeGuardError>(exp))
-        exp.message = `invalid "${file}" data.`;
-      throw exp;
-    }
-  };
-}
+import fs from "fs";
+import path from "path";
+import { register } from "ts-node";
+import { parseNative } from "tsconfck";
+import ts from "typescript";
+import typia from "typia";
+
+import { INestiaConfig } from "../../INestiaConfig";
+
+export namespace NestiaConfigLoader {
+  export const compilerOptions = async (
+    project: string,
+  ): Promise<ts.CompilerOptions> => {
+    const configFileName = ts.findConfigFile(
+      process.cwd(),
+      ts.sys.fileExists,
+      project,
+    );
+    if (!configFileName) throw new Error(`unable to find "${project}" file.`);
+
+    const { tsconfig } = await parseNative(configFileName);
+    const configFileText = JSON.stringify(tsconfig);
+    const { config } = ts.parseConfigFileTextToJson(
+      configFileName,
+      configFileText,
+    );
+    const configParseResult = ts.parseJsonConfigFileContent(
+      config,
+      ts.sys,
+      path.dirname(configFileName),
+    );
+
+    const { moduleResolution, ...result } =
+      configParseResult.raw.compilerOptions;
+    return result;
+  };
+
+  export const config = async (
+    file: string,
+    options: ts.CompilerOptions,
+  ): Promise<INestiaConfig> => {
+    if (fs.existsSync(path.resolve(file)) === false)
+      throw new Error(`Unable to find "${file}" file.`);
+
+    register({
+      emit: false,
+      compilerOptions: options,
+      require: options.baseUrl ? ["tsconfig-paths/register"] : undefined,
+    });
+
+    const loaded: INestiaConfig & { default?: INestiaConfig } = await import(
+      path.resolve(file)
+    );
+    const config: INestiaConfig =
+      typeof loaded?.default === "object" && loaded.default !== null
+        ? loaded.default
+        : loaded;
+
+    try {
+      return typia.assert(config);
+    } catch (exp) {
+      if (typia.is<typia.TypeGuardError>(exp))
+        exp.message = `invalid "${file}" data.`;
+      throw exp;
+    }
+  };
+}

package/src/executable/internal/NestiaSdkCommand.ts

@@ -1,60 +1,60 @@
-import ts from "typescript";
-
-import { INestiaConfig } from "../../INestiaConfig";
-import { NestiaSdkApplication } from "../../NestiaSdkApplication";
-import { NestiaConfigLoader } from "./NestiaConfigLoader";
-
-export namespace NestiaSdkCommand {
-  export const sdk = () => main((app) => app.sdk());
-  export const swagger = () => main((app) => app.swagger());
-  export const e2e = () => main((app) => app.e2e());
-
-  const main = async (task: (app: NestiaSdkApplication) => Promise<void>) => {
-    await generate(task);
-  };
-
-  const generate = async (
-    task: (app: NestiaSdkApplication) => Promise<void>,
-  ) => {
-    // LOAD CONFIG INFO
-    const compilerOptions: ts.CompilerOptions =
-      await NestiaConfigLoader.compilerOptions(
-        getFileArgument({
-          type: "project",
-          extension: "json",
-        }) ?? "tsconfig.json",
-      );
-    const config: INestiaConfig = await NestiaConfigLoader.config(
-      getFileArgument({
-        type: "config",
-        extension: "ts",
-      }) ?? "nestia.config.ts",
-      compilerOptions,
-    );
-
-    // GENERATE
-    const app: NestiaSdkApplication = new NestiaSdkApplication(
-      config,
-      compilerOptions,
-    );
-    await task(app);
-  };
-
-  const getFileArgument = (props: {
-    type: string;
-    extension: string;
-  }): string | null => {
-    const argv: string[] = process.argv.slice(3);
-    if (argv.length === 0) return null;
-
-    const index: number = argv.findIndex((str) => str === `--${props.type}`);
-    if (index === -1) return null;
-    else if (argv.length === 1)
-      throw new Error(`${props.type} file must be provided`);
-
-    const file: string = argv[index + 1];
-    if (file.endsWith(props.extension) === false)
-      throw new Error(`${props.type} file must be ${props.extension} file`);
-    return file;
-  };
-}
+import ts from "typescript";
+
+import { INestiaConfig } from "../../INestiaConfig";
+import { NestiaSdkApplication } from "../../NestiaSdkApplication";
+import { NestiaConfigLoader } from "./NestiaConfigLoader";
+
+export namespace NestiaSdkCommand {
+  export const sdk = () => main((app) => app.sdk());
+  export const swagger = () => main((app) => app.swagger());
+  export const e2e = () => main((app) => app.e2e());
+
+  const main = async (task: (app: NestiaSdkApplication) => Promise<void>) => {
+    await generate(task);
+  };
+
+  const generate = async (
+    task: (app: NestiaSdkApplication) => Promise<void>,
+  ) => {
+    // LOAD CONFIG INFO
+    const compilerOptions: ts.CompilerOptions =
+      await NestiaConfigLoader.compilerOptions(
+        getFileArgument({
+          type: "project",
+          extension: "json",
+        }) ?? "tsconfig.json",
+      );
+    const config: INestiaConfig = await NestiaConfigLoader.config(
+      getFileArgument({
+        type: "config",
+        extension: "ts",
+      }) ?? "nestia.config.ts",
+      compilerOptions,
+    );
+
+    // GENERATE
+    const app: NestiaSdkApplication = new NestiaSdkApplication(
+      config,
+      compilerOptions,
+    );
+    await task(app);
+  };
+
+  const getFileArgument = (props: {
+    type: string;
+    extension: string;
+  }): string | null => {
+    const argv: string[] = process.argv.slice(3);
+    if (argv.length === 0) return null;
+
+    const index: number = argv.findIndex((str) => str === `--${props.type}`);
+    if (index === -1) return null;
+    else if (argv.length === 1)
+      throw new Error(`${props.type} file must be provided`);
+
+    const file: string = argv[index + 1];
+    if (file.endsWith(props.extension) === false)
+      throw new Error(`${props.type} file must be ${props.extension} file`);
+    return file;
+  };
+}

package/src/executable/sdk.ts

@@ -1,73 +1,73 @@
-#!/usr/bin/env node
-import cp from "child_process";
-import fs from "fs";
-import process from "process";
-
-import { CommandParser } from "./internal/CommandParser";
-import type { NestiaSdkCommand } from "./internal/NestiaSdkCommand";
-
-const USAGE = `Wrong command has been detected. Use like below:
-
-npx @nestia/sdk [command] [options?]
-
-  1. npx @nestia/sdk dependencies --manager (npm|pnpm|yarn)
-    - npx @nestia/sdk dependencies
-    - npx @nestia/sdk dependencies --manager pnpm
-  2. npx @nestia/sdk init
-  3. npx @nestia/sdk sdk --config? [config file]
-  4. npx @nestia/sdk swagger --config? [config file]
-  5. npx @nestia/sdk e2e --config? [config file]
-`;
-
-function halt(desc: string): never {
-  console.error(desc);
-  process.exit(-1);
-}
-
-function dependencies(argv: string[]): void {
-  // INSTALL DEPENDENCIES
-  const module = CommandParser.parse(argv).module ?? "npm";
-  const prefix: string = module === "yarn" ? "yarn add" : `${module} install`;
-
-  for (const lib of ["@nestia/fetcher", "typia"]) {
-    const command: string = `${prefix} ${lib}`;
-    console.log(`\n$ ${command}`);
-    cp.execSync(command, { stdio: "inherit" });
-  }
-}
-
-async function initialize(): Promise<void> {
-  if (fs.existsSync("nestia.config.ts") === true)
-    halt(
-      `Error on nestia.sdk.initialize(): "nestia.config.ts" file already has been configured.`,
-    );
-  await fs.promises.copyFile(
-    `${__dirname}/../../assets/config/nestia.config.ts`,
-    "nestia.config.ts",
-  );
-}
-
-async function execute(
-  closure: (commander: typeof NestiaSdkCommand) => Promise<void>,
-): Promise<void> {
-  const module = await import("./internal/NestiaSdkCommand");
-  await closure(module.NestiaSdkCommand);
-}
-
-async function main() {
-  const type: string | undefined = process.argv[2];
-  const argv: string[] = process.argv.slice(3);
-
-  if (type === "dependencies") dependencies(argv);
-  else if (type === "init") await initialize();
-  else if (type === "sdk") await execute((c) => c.sdk());
-  else if (type === "swagger") await execute((c) => c.swagger());
-  else if (type === "e2e") await execute((c) => c.e2e());
-  else halt(USAGE);
-
-  process.exit(0);
-}
-main().catch((exp) => {
-  console.log(exp);
-  process.exit(-1);
-});
+#!/usr/bin/env node
+import cp from "child_process";
+import fs from "fs";
+import process from "process";
+
+import { CommandParser } from "./internal/CommandParser";
+import type { NestiaSdkCommand } from "./internal/NestiaSdkCommand";
+
+const USAGE = `Wrong command has been detected. Use like below:
+
+npx @nestia/sdk [command] [options?]
+
+  1. npx @nestia/sdk dependencies --manager (npm|pnpm|yarn)
+    - npx @nestia/sdk dependencies
+    - npx @nestia/sdk dependencies --manager pnpm
+  2. npx @nestia/sdk init
+  3. npx @nestia/sdk sdk --config? [config file]
+  4. npx @nestia/sdk swagger --config? [config file]
+  5. npx @nestia/sdk e2e --config? [config file]
+`;
+
+function halt(desc: string): never {
+  console.error(desc);
+  process.exit(-1);
+}
+
+function dependencies(argv: string[]): void {
+  // INSTALL DEPENDENCIES
+  const module = CommandParser.parse(argv).module ?? "npm";
+  const prefix: string = module === "yarn" ? "yarn add" : `${module} install`;
+
+  for (const lib of ["@nestia/fetcher", "typia"]) {
+    const command: string = `${prefix} ${lib}`;
+    console.log(`\n$ ${command}`);
+    cp.execSync(command, { stdio: "inherit" });
+  }
+}
+
+async function initialize(): Promise<void> {
+  if (fs.existsSync("nestia.config.ts") === true)
+    halt(
+      `Error on nestia.sdk.initialize(): "nestia.config.ts" file already has been configured.`,
+    );
+  await fs.promises.copyFile(
+    `${__dirname}/../../assets/config/nestia.config.ts`,
+    "nestia.config.ts",
+  );
+}
+
+async function execute(
+  closure: (commander: typeof NestiaSdkCommand) => Promise<void>,
+): Promise<void> {
+  const module = await import("./internal/NestiaSdkCommand");
+  await closure(module.NestiaSdkCommand);
+}
+
+async function main() {
+  const type: string | undefined = process.argv[2];
+  const argv: string[] = process.argv.slice(3);
+
+  if (type === "dependencies") dependencies(argv);
+  else if (type === "init") await initialize();
+  else if (type === "sdk") await execute((c) => c.sdk());
+  else if (type === "swagger") await execute((c) => c.swagger());
+  else if (type === "e2e") await execute((c) => c.e2e());
+  else halt(USAGE);
+
+  process.exit(0);
+}
+main().catch((exp) => {
+  console.log(exp);
+  process.exit(-1);
+});