@nestia/sdk 3.0.0-dev.20231209 → 3.0.0

package/src/analyses/AccessorAnalyzer.ts

@@ -1,60 +1,60 @@
-import { Escaper } from "typia/lib/utils/Escaper";
-
-import { IRoute } from "../structures/IRoute";
-
-export namespace AccessorAnalyzer {
-  export const analyze = (routes: IRoute[]) => {
-    shrink(routes);
-    variable(routes);
-    shrink(routes);
-    for (const r of routes) r.name = r.accessors.at(-1) ?? r.name;
-  };
-
-  const prepare = (routeList: IRoute[]): Map<string, number> => {
-    const dict: Map<string, number> = new Map();
-    for (const route of routeList)
-      route.accessors.forEach((_a, i) => {
-        const key: string = route.accessors.slice(0, i + 1).join(".");
-        dict.set(key, (dict.get(key) ?? 0) + 1);
-      });
-    return dict;
-  };
-
-  const variable = (routeList: IRoute[]) => {
-    const dict: Map<string, number> = prepare(routeList);
-    for (const route of routeList) {
-      const emended: string[] = route.accessors.slice();
-      route.accessors.forEach((accessor, i) => {
-        if (Escaper.variable(accessor)) return;
-        while (true) {
-          accessor = "$" + accessor;
-          const partial: string = [
-            ...route.accessors.slice(0, i),
-            accessor,
-          ].join(".");
-          if (dict.has(partial) === false) {
-            emended[i] = accessor;
-            break;
-          }
-        }
-      });
-      route.accessors.splice(0, route.accessors.length, ...emended);
-    }
-  };
-
-  const shrink = (routeList: IRoute[]) => {
-    const dict: Map<string, number> = prepare(routeList);
-    for (const route of routeList) {
-      if (
-        route.accessors.length < 2 ||
-        route.accessors.at(-1) !== route.accessors.at(-2)
-      )
-        continue;
-
-      const cut: string[] = route.accessors.slice(0, -1);
-      if ((dict.get(cut.join(".")) ?? 0) > 1) continue;
-
-      route.accessors = cut;
-    }
-  };
-}
+import { Escaper } from "typia/lib/utils/Escaper";
+
+import { IRoute } from "../structures/IRoute";
+
+export namespace AccessorAnalyzer {
+  export const analyze = (routes: IRoute[]) => {
+    shrink(routes);
+    variable(routes);
+    shrink(routes);
+    for (const r of routes) r.name = r.accessors.at(-1) ?? r.name;
+  };
+
+  const prepare = (routeList: IRoute[]): Map<string, number> => {
+    const dict: Map<string, number> = new Map();
+    for (const route of routeList)
+      route.accessors.forEach((_a, i) => {
+        const key: string = route.accessors.slice(0, i + 1).join(".");
+        dict.set(key, (dict.get(key) ?? 0) + 1);
+      });
+    return dict;
+  };
+
+  const variable = (routeList: IRoute[]) => {
+    const dict: Map<string, number> = prepare(routeList);
+    for (const route of routeList) {
+      const emended: string[] = route.accessors.slice();
+      route.accessors.forEach((accessor, i) => {
+        if (Escaper.variable(accessor)) return;
+        while (true) {
+          accessor = "$" + accessor;
+          const partial: string = [
+            ...route.accessors.slice(0, i),
+            accessor,
+          ].join(".");
+          if (dict.has(partial) === false) {
+            emended[i] = accessor;
+            break;
+          }
+        }
+      });
+      route.accessors.splice(0, route.accessors.length, ...emended);
+    }
+  };
+
+  const shrink = (routeList: IRoute[]) => {
+    const dict: Map<string, number> = prepare(routeList);
+    for (const route of routeList) {
+      if (
+        route.accessors.length < 2 ||
+        route.accessors.at(-1) !== route.accessors.at(-2)
+      )
+        continue;
+
+      const cut: string[] = route.accessors.slice(0, -1);
+      if ((dict.get(cut.join(".")) ?? 0) > 1) continue;
+
+      route.accessors = cut;
+    }
+  };
+}

package/src/analyses/ConfigAnalyzer.ts

@@ -1,147 +1,147 @@
-import { INestApplication, VersioningType } from "@nestjs/common";
-import { MODULE_PATH } from "@nestjs/common/constants";
-import { NestContainer } from "@nestjs/core";
-import { Module } from "@nestjs/core/injector/module";
-import fs from "fs";
-import path from "path";
-import { HashMap, Pair, Singleton } from "tstl";
-
-import { INestiaConfig } from "../INestiaConfig";
-import { SdkGenerator } from "../generates/SdkGenerator";
-import { INormalizedInput } from "../structures/INormalizedInput";
-import { ArrayUtil } from "../utils/ArrayUtil";
-import { MapUtil } from "../utils/MapUtil";
-import { SourceFinder } from "../utils/SourceFinder";
-
-export namespace ConfigAnalyzer {
-  export const input = (config: INestiaConfig): Promise<INormalizedInput> =>
-    MapUtil.take(memory, config, async () => {
-      const input = config.input;
-      if (Array.isArray(input)) return transform_input(config)(input);
-      else if (typeof input === "function")
-        return analyze_application(await input());
-      else if (typeof input === "object")
-        if (input === null)
-          throw new Error("Invalid input config. It can't be null.");
-        else return transform_input(config)(input.include, input.exclude);
-      else if (typeof input === "string")
-        return transform_input(config)([input]);
-      else throw new Error("Invalid input config.");
-    });
-
-  const analyze_application = async (
-    app: INestApplication,
-  ): Promise<INormalizedInput> => {
-    const files: HashMap<Pair<Function, string>, Set<string>> = new HashMap();
-    const container: NestContainer = (app as any).container as NestContainer;
-    const modules: Module[] = [...container.getModules().values()].filter(
-      (m) => !!m.controllers.size,
-    );
-    for (const m of modules) {
-      const path: string =
-        Reflect.getMetadata(
-          MODULE_PATH + container.getModules().applicationId,
-          m.metatype,
-        ) ??
-        Reflect.getMetadata(MODULE_PATH, m.metatype) ??
-        "";
-      for (const controller of [...m.controllers.keys()]) {
-        const file: string | null =
-          (await require("get-function-location")(controller))?.source ?? null;
-        if (file === null) continue;
-
-        const location: string = normalize_file(file);
-        if (location.length === 0) continue;
-
-        const key: Pair<Function, string> = new Pair(
-          controller as Function,
-          location,
-        );
-        files.take(key, () => new Set([])).add(path);
-      }
-    }
-
-    const versioning = (app as any).config?.versioningOptions;
-    return {
-      include: files.toJSON().map((pair) => ({
-        controller: pair.first.first,
-        file: pair.first.second,
-        paths: [...pair.second.values()],
-      })),
-      globalPrefix:
-        typeof (app as any).config?.globalPrefix === "string"
-          ? {
-              prefix: (app as any).config.globalPrefix,
-              exclude: (app as any).config.globalPrefixOptions?.exclude ?? {},
-            }
-          : undefined,
-      versioning:
-        versioning === undefined || versioning.type !== VersioningType.URI
-          ? undefined
-          : {
-              prefix:
-                versioning.prefix === undefined || versioning.prefix === false
-                  ? "v"
-                  : versioning.prefix,
-              defaultVersion: versioning.defaultVersion,
-            },
-    };
-  };
-
-  const normalize_file = (str: string) =>
-    str.substring(
-      str.startsWith("file:///")
-        ? process.cwd()[0] === "/"
-          ? 7
-          : 8
-        : str.startsWith("file://")
-        ? 7
-        : 0,
-    );
-
-  const transform_input =
-    (config: INestiaConfig) =>
-    async (include: string[], exclude?: string[]) => ({
-      include: (
-        await SourceFinder.find({
-          include,
-          exclude,
-          filter: filter(config),
-        })
-      ).map((file) => ({
-        paths: [""],
-        file,
-      })),
-    });
-
-  const filter =
-    (config: INestiaConfig) =>
-    async (location: string): Promise<boolean> =>
-      location.endsWith(".ts") &&
-      !location.endsWith(".d.ts") &&
-      (config.output === undefined ||
-        (location.indexOf(path.join(config.output, "functional")) === -1 &&
-          (await (
-            await bundler.get(config.output)
-          )(location))) === false);
-}
-
-const memory = new Map<INestiaConfig, Promise<INormalizedInput>>();
-const bundler = new Singleton(async (output: string) => {
-  const assets: string[] = await fs.promises.readdir(SdkGenerator.BUNDLE_PATH);
-  const tuples: Pair<string, boolean>[] = await ArrayUtil.asyncMap(
-    assets,
-    async (file) => {
-      const relative: string = path.join(output, file);
-      const location: string = path.join(SdkGenerator.BUNDLE_PATH, file);
-      const stats: fs.Stats = await fs.promises.stat(location);
-      return new Pair(relative, stats.isDirectory());
-    },
-  );
-  return async (file: string): Promise<boolean> => {
-    for (const it of tuples)
-      if (it.second === false && file === it.first) return true;
-      else if (it.second === true && file.indexOf(it.first) === 0) return true;
-    return false;
-  };
-});
+import { INestApplication, VersioningType } from "@nestjs/common";
+import { MODULE_PATH } from "@nestjs/common/constants";
+import { NestContainer } from "@nestjs/core";
+import { Module } from "@nestjs/core/injector/module";
+import fs from "fs";
+import path from "path";
+import { HashMap, Pair, Singleton } from "tstl";
+
+import { INestiaConfig } from "../INestiaConfig";
+import { SdkGenerator } from "../generates/SdkGenerator";
+import { INormalizedInput } from "../structures/INormalizedInput";
+import { ArrayUtil } from "../utils/ArrayUtil";
+import { MapUtil } from "../utils/MapUtil";
+import { SourceFinder } from "../utils/SourceFinder";
+
+export namespace ConfigAnalyzer {
+  export const input = (config: INestiaConfig): Promise<INormalizedInput> =>
+    MapUtil.take(memory, config, async () => {
+      const input = config.input;
+      if (Array.isArray(input)) return transform_input(config)(input);
+      else if (typeof input === "function")
+        return analyze_application(await input());
+      else if (typeof input === "object")
+        if (input === null)
+          throw new Error("Invalid input config. It can't be null.");
+        else return transform_input(config)(input.include, input.exclude);
+      else if (typeof input === "string")
+        return transform_input(config)([input]);
+      else throw new Error("Invalid input config.");
+    });
+
+  const analyze_application = async (
+    app: INestApplication,
+  ): Promise<INormalizedInput> => {
+    const files: HashMap<Pair<Function, string>, Set<string>> = new HashMap();
+    const container: NestContainer = (app as any).container as NestContainer;
+    const modules: Module[] = [...container.getModules().values()].filter(
+      (m) => !!m.controllers.size,
+    );
+    for (const m of modules) {
+      const path: string =
+        Reflect.getMetadata(
+          MODULE_PATH + container.getModules().applicationId,
+          m.metatype,
+        ) ??
+        Reflect.getMetadata(MODULE_PATH, m.metatype) ??
+        "";
+      for (const controller of [...m.controllers.keys()]) {
+        const file: string | null =
+          (await require("get-function-location")(controller))?.source ?? null;
+        if (file === null) continue;
+
+        const location: string = normalize_file(file);
+        if (location.length === 0) continue;
+
+        const key: Pair<Function, string> = new Pair(
+          controller as Function,
+          location,
+        );
+        files.take(key, () => new Set([])).add(path);
+      }
+    }
+
+    const versioning = (app as any).config?.versioningOptions;
+    return {
+      include: files.toJSON().map((pair) => ({
+        controller: pair.first.first,
+        file: decodeURIComponent(pair.first.second),
+        paths: [...pair.second.values()],
+      })),
+      globalPrefix:
+        typeof (app as any).config?.globalPrefix === "string"
+          ? {
+              prefix: (app as any).config.globalPrefix,
+              exclude: (app as any).config.globalPrefixOptions?.exclude ?? {},
+            }
+          : undefined,
+      versioning:
+        versioning === undefined || versioning.type !== VersioningType.URI
+          ? undefined
+          : {
+              prefix:
+                versioning.prefix === undefined || versioning.prefix === false
+                  ? "v"
+                  : versioning.prefix,
+              defaultVersion: versioning.defaultVersion,
+            },
+    };
+  };
+
+  const normalize_file = (str: string) =>
+    str.substring(
+      str.startsWith("file:///")
+        ? process.cwd()[0] === "/"
+          ? 7
+          : 8
+        : str.startsWith("file://")
+          ? 7
+          : 0,
+    );
+
+  const transform_input =
+    (config: INestiaConfig) =>
+    async (include: string[], exclude?: string[]) => ({
+      include: (
+        await SourceFinder.find({
+          include,
+          exclude,
+          filter: filter(config),
+        })
+      ).map((file) => ({
+        paths: [""],
+        file,
+      })),
+    });
+
+  const filter =
+    (config: INestiaConfig) =>
+    async (location: string): Promise<boolean> =>
+      location.endsWith(".ts") &&
+      !location.endsWith(".d.ts") &&
+      (config.output === undefined ||
+        (location.indexOf(path.join(config.output, "functional")) === -1 &&
+          (await (
+            await bundler.get(config.output)
+          )(location))) === false);
+}
+
+const memory = new Map<INestiaConfig, Promise<INormalizedInput>>();
+const bundler = new Singleton(async (output: string) => {
+  const assets: string[] = await fs.promises.readdir(SdkGenerator.BUNDLE_PATH);
+  const tuples: Pair<string, boolean>[] = await ArrayUtil.asyncMap(
+    assets,
+    async (file) => {
+      const relative: string = path.join(output, file);
+      const location: string = path.join(SdkGenerator.BUNDLE_PATH, file);
+      const stats: fs.Stats = await fs.promises.stat(location);
+      return new Pair(relative, stats.isDirectory());
+    },
+  );
+  return async (file: string): Promise<boolean> => {
+    for (const it of tuples)
+      if (it.second === false && file === it.first) return true;
+      else if (it.second === true && file.indexOf(it.first) === 0) return true;
+    return false;
+  };
+});

package/src/analyses/ControllerAnalyzer.ts

@@ -1,6 +1,6 @@
 import { VERSION_NEUTRAL, VersionValue } from "@nestjs/common/interfaces";
 import path from "path";
-import { HashMap } from "tstl/container/HashMap";
+import { HashMap } from "tstl";
 import ts from "typescript";
 import { CommentFactory } from "typia/lib/factories/CommentFactory";
 
@@ -132,7 +132,12 @@ export namespace ControllerAnalyzer {
         importDict,
         signature.getReturnType(),
       );
-      if (outputType === null || outputType.typeName === "__type") {
+      if (
+        outputType === null ||
+        (project.config.clone !== true &&
+          (outputType.typeName === "__type" ||
+            outputType.typeName === "__object"))
+      ) {
         project.errors.push({
           file: controller.file,
           controller: controller.name,
@@ -172,16 +177,18 @@ export namespace ControllerAnalyzer {
         ...jsDocTags
           .filter((tag) => tag.name === "security")
           .map((tag) =>
-            (tag.text ?? []).map((text) => {
-              const line: string[] = text.text
-                .split(" ")
-                .filter((s) => s.trim())
-                .filter((s) => !!s.length);
-              if (line.length === 0) return {};
-              return {
-                [line[0]]: line.slice(1),
-              };
-            }),
+            tag.text === undefined
+              ? [{}]
+              : tag.text.map((text) => {
+                  const line: string[] = text.text
+                    .split(" ")
+                    .filter((s) => s.trim())
+                    .filter((s) => !!s.length);
+                  if (line.length === 0) return {};
+                  return {
+                    [line[0]]: line.slice(1),
+                  };
+                }),
           )
           .flat(),
       );
@@ -189,6 +196,7 @@ export namespace ControllerAnalyzer {
       // CONSTRUCT COMMON DATA
       const common: Omit<IRoute, "path" | "accessors"> = {
         ...func,
+        controller: controller.target,
         parameters: parameters.filter((p) => p !== null) as IRoute.IParameter[],
         output: {
           type: outputType.type,
@@ -197,9 +205,9 @@ export namespace ControllerAnalyzer {
         },
         imports,
         status: func.status,
-        symbol: {
-          class: controller.name,
-          function: func.name,
+        target: {
+          class: controller.target,
+          function: func.target,
         },
         location: (() => {
           const file = declaration.getSourceFile();
@@ -265,8 +273,8 @@ export namespace ControllerAnalyzer {
               v === null
                 ? null
                 : project.input.versioning?.prefix?.length
-                ? `${project.input.versioning.prefix}${v}`
-                : v,
+                  ? `${project.input.versioning.prefix}${v}`
+                  : v,
             ),
           )({
             method: func.method,
@@ -274,9 +282,20 @@ export namespace ControllerAnalyzer {
           }),
         )
         .flat()
+        .filter((path) => {
+          const escaped: string | null = PathAnalyzer.escape(path);
+          if (escaped === null)
+            project.errors.push({
+              file: controller.file,
+              controller: controller.name,
+              function: func.name,
+              message: `unable to escape the path "${path}".`,
+            });
+          return escaped !== null;
+        })
         .map((path) => ({
           ...common,
-          path: PathAnalyzer.escape(path, () => "ControllerAnalyzer.analyze()"),
+          path: PathAnalyzer.escape(path)!,
           accessors: [...PathUtil.accessors(path), func.name],
         }));
     };
@@ -348,7 +367,11 @@ export namespace ControllerAnalyzer {
         importDict,
         type,
       );
-      if (tuple === null || tuple.typeName === "__type")
+      if (
+        tuple === null ||
+        (project.config.clone !== true &&
+          (tuple.typeName === "__type" || tuple.typeName === "__object"))
+      )
         errors.push({
           file: controller.file,
           controller: controller.name,