@nestia/sdk 2.4.3 → 2.4.4

package/src/analyses/PathAnalyzer.ts

@@ -1,98 +1,110 @@
-import { RequestMethod } from "@nestjs/common";
-import path from "path";
-import { Token, parse } from "path-to-regexp";
-
-import { INormalizedInput } from "../structures/INormalizedInput";
-
-export namespace PathAnalyzer {
-  export const combinate =
-    (globalPrefix: INormalizedInput["globalPrefix"]) =>
-    (versions: Array<string | null>) =>
-    (props: { path: string; method: string }): string[] => {
-      const out = (str: string) =>
-        versions.map((v) => (v === null ? str : join(v, str)));
-      if (!globalPrefix?.prefix.length) return out(props.path);
-      else if (!globalPrefix.exclude?.length)
-        return out(props.path).map((str) => join(globalPrefix.prefix, str));
-      return globalPrefix.exclude.some((exclude) =>
-        typeof exclude === "string"
-          ? RegExp(exclude).test(props.path)
-          : METHOD(exclude.method) === props.method &&
-            RegExp(exclude.path).test(props.path),
-      )
-        ? out(props.path)
-        : out(props.path).map((str) => join(globalPrefix.prefix, str));
-    };
-
-  export const join = (...args: string[]) =>
-    "/" +
-    _Trim(
-      path
-        .join(...args.filter((s) => !!s.length))
-        .split("\\")
-        .join("/"),
-    );
-
-  export const escape = (str: string, method: () => string) =>
-    "/" +
-    _Parse(str, method)
-      .map((arg) => (arg.type === "param" ? `:${arg.value}` : arg.value))
-      .join("/");
-
-  export const parameters = (str: string, method: () => string) =>
-    _Parse(str, method)
-      .filter((arg) => arg.type === "param")
-      .map((arg) => arg.value);
-
-  function _Parse(str: string, method: () => string): IArgument[] {
-    const tokens: Token[] = parse(path.join(str).split("\\").join("/"));
-    const output: IArgument[] = [];
-
-    for (const key of tokens) {
-      if (typeof key === "string")
-        output.push({
-          type: "path",
-          value: _Trim(key),
-        });
-      else if (typeof key.name === "number" || _Trim(key.name) === "")
-        throw new Error(`Error on ${method}: ${ERROR_MESSAGE}.`);
-      else
-        output.push({
-          type: "param",
-          value: _Trim(key.name),
-        });
-    }
-    return output;
-  }
-
-  function _Trim(str: string): string {
-    if (str[0] === "/") str = str.substring(1);
-    if (str[str.length - 1] === "/") str = str.substring(0, str.length - 1);
-    return str;
-  }
-
-  interface IArgument {
-    type: "param" | "path";
-    value: string;
-  }
-}
-
-const ERROR_MESSAGE = "nestia supports only string typed parameter on path";
-const METHOD = (value: RequestMethod) =>
-  value === RequestMethod.ALL
-    ? "all"
-    : value === RequestMethod.DELETE
-    ? "delete"
-    : value === RequestMethod.GET
-    ? "get"
-    : value === RequestMethod.HEAD
-    ? "head"
-    : value === RequestMethod.OPTIONS
-    ? "options"
-    : value === RequestMethod.PATCH
-    ? "patch"
-    : value === RequestMethod.POST
-    ? "post"
-    : value === RequestMethod.PUT
-    ? "put"
-    : "unknown";
+import { RequestMethod } from "@nestjs/common";
+import path from "path";
+import { Token, parse } from "path-to-regexp";
+
+import { INormalizedInput } from "../structures/INormalizedInput";
+
+export namespace PathAnalyzer {
+  export const combinate =
+    (globalPrefix: INormalizedInput["globalPrefix"]) =>
+    (versions: Array<string | null>) =>
+    (props: { path: string; method: string }): string[] => {
+      const out = (str: string) =>
+        versions.map((v) => (v === null ? str : join(v, str)));
+      if (!globalPrefix?.prefix.length) return out(props.path);
+      else if (!globalPrefix.exclude?.length)
+        return out(props.path).map((str) => join(globalPrefix.prefix, str));
+      return globalPrefix.exclude.some((exclude) =>
+        typeof exclude === "string"
+          ? RegExp(exclude).test(props.path)
+          : METHOD(exclude.method) === props.method &&
+            RegExp(exclude.path).test(props.path),
+      )
+        ? out(props.path)
+        : out(props.path).map((str) => join(globalPrefix.prefix, str));
+    };
+
+  export const join = (...args: string[]) =>
+    "/" +
+    _Trim(
+      path
+        .join(...args.filter((s) => !!s.length))
+        .split("\\")
+        .join("/"),
+    );
+
+  export const escape = (str: string): string | null => {
+    const args = _Parse(str);
+    if (args === null) return null;
+    return (
+      "/" +
+      args
+        .map((arg) => (arg.type === "param" ? `:${arg.value}` : arg.value))
+        .join("/")
+    );
+  };
+
+  export const parameters = (str: string): string[] | null => {
+    const args = _Parse(str);
+    if (args === null) return null;
+    return args.filter((arg) => arg.type === "param").map((arg) => arg.value);
+  };
+
+  function _Parse(str: string): IArgument[] | null {
+    const tokens: Token[] | null = (() => {
+      try {
+        return parse(path.join(str).split("\\").join("/"));
+      } catch {
+        return null;
+      }
+    })();
+    if (tokens === null) return null;
+
+    const output: IArgument[] = [];
+    for (const key of tokens) {
+      if (typeof key === "string")
+        output.push({
+          type: "path",
+          value: _Trim(key),
+        });
+      else if (typeof key.name === "number" || _Trim(key.name) === "")
+        return null;
+      else
+        output.push({
+          type: "param",
+          value: _Trim(key.name),
+        });
+    }
+    return output;
+  }
+
+  function _Trim(str: string): string {
+    if (str[0] === "/") str = str.substring(1);
+    if (str[str.length - 1] === "/") str = str.substring(0, str.length - 1);
+    return str;
+  }
+
+  interface IArgument {
+    type: "param" | "path";
+    value: string;
+  }
+}
+
+const METHOD = (value: RequestMethod) =>
+  value === RequestMethod.ALL
+    ? "all"
+    : value === RequestMethod.DELETE
+    ? "delete"
+    : value === RequestMethod.GET
+    ? "get"
+    : value === RequestMethod.HEAD
+    ? "head"
+    : value === RequestMethod.OPTIONS
+    ? "options"
+    : value === RequestMethod.PATCH
+    ? "patch"
+    : value === RequestMethod.POST
+    ? "post"
+    : value === RequestMethod.PUT
+    ? "put"
+    : "unknown";

package/src/analyses/ReflectAnalyzer.ts

@@ -310,18 +310,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 (equal(binded.sort(), parameters) === false)
             errors.push({
               file: controller.file,
               controller: controller.name,

package/src/analyses/SecurityAnalyzer.ts

@@ -1,20 +1,20 @@
-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 {
+  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;
+  };
+}

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;
+  };
+}