@nestia/sdk 7.1.1-dev.20250714 → 7.2.0

package/src/analyses/ImportAnalyzer.ts

@@ -1,171 +1,126 @@
-import ts from "typescript";
-
-import { IReflectType } from "../structures/IReflectType";
-import { IReflectTypeImport } from "../structures/IReflectTypeImport";
-import { MapUtil } from "../utils/MapUtil";
-
-export namespace ImportAnalyzer {
-  export interface IOutput {
-    imports: IReflectTypeImport[];
-    type: IReflectType | null;
-  }
-  export const analyze = (
-    checker: ts.TypeChecker,
-    generics: WeakMap<ts.Type, ts.Type>,
-    type: ts.Type,
-  ): IOutput => {
-    const imports: Map<string, Set<string>> = new Map();
-    try {
-      type = escape(checker, type);
-      return {
-        type: explore({
-          checker,
-          generics,
-          imports,
-          type,
-        }),
-        imports: [...imports].map(([file, instances]) => ({
-          file,
-          instances: Array.from(instances),
-        })),
-      };
-    } catch {
-      return {
-        imports: [],
-        type: null,
-      };
-    }
-  };
-
-  export const unique = (
-    imports: IReflectTypeImport[],
-  ): IReflectTypeImport[] => {
-    const map: Map<string, Set<string>> = new Map();
-    imports.forEach(({ file, instances }) => {
-      const set: Set<string> = MapUtil.take(map, file, () => new Set());
-      instances.forEach((instance) => set.add(instance));
-    });
-    return [...map].map(([file, instances]) => ({
-      file,
-      instances: Array.from(instances),
-    }));
-  };
-
-  /* ---------------------------------------------------------
-    TYPE
-  --------------------------------------------------------- */
-  const escape = (checker: ts.TypeChecker, type: ts.Type): ts.Type => {
-    if (type.symbol && getNameOfSymbol(type.symbol) === "Promise") {
-      const generic: readonly ts.Type[] = checker.getTypeArguments(
-        type as ts.TypeReference,
-      );
-      if (generic.length !== 1)
-        throw new Error(
-          "Error on ImportAnalyzer.analyze(): invalid promise type.",
-        );
-      type = generic[0];
-    }
-    return type;
-  };
-
-  const getNameOfSymbol = (symbol: ts.Symbol): string =>
-    exploreName(
-      symbol.escapedName.toString(),
-      symbol.getDeclarations()?.[0]?.parent,
-    );
-
-  /* ---------------------------------------------------------
-    ESCAPED TEXT WITH IMPORT STATEMENTS
-  --------------------------------------------------------- */
-  const explore = (props: {
-    checker: ts.TypeChecker;
-    generics: WeakMap<ts.Type, ts.Type>;
-    imports: Map<string, Set<string>>;
-    type: ts.Type;
-  }): IReflectType => {
-    //----
-    // CONDITIONAL BRANCHES
-    //----
-    // DECOMPOSE GENERIC ARGUMENT
-    let type: ts.Type = props.type;
-    while (props.generics.has(type) === true) type = props.generics.get(type)!;
-
-    // PRIMITIVE
-    const symbol: ts.Symbol | undefined = type.aliasSymbol ?? type.symbol;
-
-    // UNION OR INTERSECT
-    if (type.aliasSymbol === undefined && type.isUnionOrIntersection()) {
-      const joiner: string = type.isIntersection() ? " & " : " | ";
-      return {
-        name: type.types
-          .map((child) =>
-            explore({
-              ...props,
-              type: child,
-            }),
-          )
-          .map(getEscapedText)
-          .join(joiner),
-      };
-    }
-    // NO SYMBOL
-    else if (symbol === undefined)
-      return {
-        name: props.checker.typeToString(
-          type,
-          undefined,
-          ts.TypeFormatFlags.NoTruncation,
-        ),
-      };
-
-    //----
-    // SPECIALIZATION
-    //----
-    const name: string = getNameOfSymbol(symbol);
-    const sourceFile: ts.SourceFile | undefined =
-      symbol.declarations?.[0]?.getSourceFile();
-    if (sourceFile === undefined) return { name };
-    else if (sourceFile.fileName.indexOf("typescript/lib") === -1) {
-      const set: Set<string> = MapUtil.take(
-        props.imports,
-        sourceFile.fileName,
-        () => new Set(),
-      );
-      set.add(name.split(".")[0]);
-    }
-
-    // CHECK GENERIC
-    const generic: readonly ts.Type[] = type.aliasSymbol
-      ? type.aliasTypeArguments ?? []
-      : props.checker.getTypeArguments(type as ts.TypeReference);
-    return generic.length
-      ? name === "Promise"
-        ? explore({
-            ...props,
-            type: generic[0],
-          })
-        : {
-            name,
-            typeArguments: generic.map((child) =>
-              explore({
-                ...props,
-                type: child,
-              }),
-            ),
-          }
-      : { name };
-  };
-
-  const exploreName = (name: string, decl?: ts.Node): string =>
-    decl && ts.isModuleBlock(decl)
-      ? exploreName(
-          `${decl.parent.name.getFullText().trim()}.${name}`,
-          decl.parent.parent,
-        )
-      : name;
-
-  const getEscapedText = (type: IReflectType): string =>
-    type.typeArguments
-      ? `${type.name}<${type.typeArguments.map(getEscapedText).join(", ")}>`
-      : type.name;
-}
+import path from "path";
+import ts from "typescript";
+
+import { IReflectImport } from "../structures/IReflectImport";
+import { MapUtil } from "../utils/MapUtil";
+
+export namespace ImportAnalyzer {
+  export const analyze = (file: ts.SourceFile): IReflectImport[] =>
+    file.statements
+      .filter(ts.isImportDeclaration)
+      .map((imp) => {
+        const clause: ts.ImportClause | undefined = imp.importClause;
+        if (clause === undefined) return null;
+        try {
+          // no real position
+          // import statement generated by transformer like typia
+          imp.moduleSpecifier.getText();
+        } catch {
+          return null;
+        }
+
+        const reflect: IReflectImport = {
+          file: normalizePath(
+            path.dirname(file.fileName),
+            ts.isStringLiteral(imp.moduleSpecifier)
+              ? imp.moduleSpecifier.text
+              : escapeQuotes(imp.moduleSpecifier.getText()),
+          ),
+          elements: [],
+          default: null,
+          asterisk: null,
+        };
+        if (clause.name) reflect.default = clause.name.getText();
+        if (clause.namedBindings === undefined) return reflect;
+        else if (ts.isNamedImports(clause.namedBindings))
+          reflect.elements = clause.namedBindings.elements.map((e) =>
+            e.name.getText(),
+          );
+        else if (ts.isNamespaceImport(clause.namedBindings))
+          reflect.asterisk = clause.namedBindings.name.getText();
+        return reflect;
+      })
+      .filter((r) => r !== null);
+
+  export const merge = (imports: IReflectImport[]): IReflectImport[] => {
+    // group by files
+    const fileGroups: Map<string, IReflectImport[]> = new Map();
+    for (const imp of imports) {
+      const array: IReflectImport[] = MapUtil.take(
+        fileGroups,
+        imp.file,
+        () => [],
+      );
+      array.push(imp);
+    }
+    return Array.from(fileGroups.entries())
+      .map(([key, value]) => mergeGroup(key, value))
+      .flat();
+  };
+
+  function mergeGroup(
+    file: string,
+    imports: IReflectImport[],
+  ): IReflectImport[] {
+    const allStarImports: IReflectImport[] = Array.from(
+      new Set(
+        imports
+          .filter((imp) => imp.asterisk !== null)
+          .map((imp) => imp.asterisk!),
+      ),
+    )
+      .sort()
+      .map(
+        (allStarImport) =>
+          ({
+            file,
+            elements: [],
+            default: null,
+            asterisk: allStarImport,
+          }) satisfies IReflectImport,
+      );
+    const defaultImports: IReflectImport[] = Array.from(
+      new Set(
+        imports
+          .filter((imp) => imp.default !== null)
+          .map((imp) => imp.default!),
+      ),
+    )
+      .sort()
+      .map(
+        (defaultImport) =>
+          ({
+            file,
+            elements: [],
+            default: defaultImport,
+            asterisk: null,
+          }) satisfies IReflectImport,
+      );
+    const instances: Set<string> = new Set(
+      imports.map((imp) => imp.elements).flat(),
+    );
+    if (instances.size !== 0) {
+      if (defaultImports.length !== 0)
+        defaultImports[0].elements = Array.from(instances).sort();
+      else
+        defaultImports.push({
+          file,
+          elements: Array.from(instances).sort(),
+          default: null,
+          asterisk: null,
+        });
+    }
+    return [...allStarImports, ...defaultImports];
+  }
+
+  function escapeQuotes(str: string): string {
+    if (str.startsWith("'") && str.endsWith("'")) return str.slice(1, -1);
+    else if (str.startsWith('"') && str.endsWith('"')) return str.slice(1, -1);
+    return str;
+  }
+
+  function normalizePath(root: string, str: string): string {
+    if (str.startsWith(".")) return path.resolve(root, str);
+    return `node_modules/${str}`;
+  }
+}

package/src/analyses/PathAnalyzer.ts

@@ -1,69 +1,69 @@
-import path from "path";
-import { Token, parse } from "path-to-regexp";
-
-export namespace PathAnalyzer {
-  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;
-  }
-}
+import path from "path";
+import { Token, parse } from "path-to-regexp";
+
+export namespace PathAnalyzer {
+  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;
+  }
+}

package/src/analyses/ReflectControllerAnalyzer.ts

@@ -1,105 +1,105 @@
-import {
-  HOST_METADATA,
-  PATH_METADATA,
-  SCOPE_OPTIONS_METADATA,
-} from "@nestjs/common/constants";
-
-import { INestiaProject } from "../structures/INestiaProject";
-import { INestiaSdkInput } from "../structures/INestiaSdkInput";
-import { IReflectController } from "../structures/IReflectController";
-import { IReflectHttpOperation } from "../structures/IReflectHttpOperation";
-import { IReflectWebSocketOperation } from "../structures/IReflectWebSocketOperation";
-import { IOperationMetadata } from "../transformers/IOperationMetadata";
-import { ArrayUtil } from "../utils/ArrayUtil";
-import { ReflectHttpOperationAnalyzer } from "./ReflectHttpOperationAnalyzer";
-import { ReflectMetadataAnalyzer } from "./ReflectMetadataAnalyzer";
-import { ReflectWebSocketOperationAnalyzer } from "./ReflectWebSocketOperationAnalyzer";
-
-export namespace ReflectControllerAnalyzer {
-  export interface IProps {
-    project: Omit<INestiaProject, "config">;
-    controller: INestiaSdkInput.IController;
-    unique: WeakSet<Function>;
-  }
-  /* ---------------------------------------------------------
-    CONTROLLER
-  --------------------------------------------------------- */
-  export const analyze = (props: IProps): IReflectController | null => {
-    // MUST BE TYPE OF A CREATOR WHO HAS THE CONSTRUCTOR
-    if (
-      ArrayUtil.has(
-        Reflect.getMetadataKeys(props.controller.class),
-        PATH_METADATA,
-        HOST_METADATA,
-        SCOPE_OPTIONS_METADATA,
-      ) === false
-    )
-      return null;
-
-    // BASIC INFO
-    const controller: IReflectController = {
-      class: props.controller.class,
-      file: props.controller.location,
-      operations: [],
-      prefixes: props.controller.prefixes,
-      paths: ReflectMetadataAnalyzer.paths(props.controller.class).filter(
-        (str) => {
-          if (str.includes("*") === true) {
-            props.project.warnings.push({
-              file: props.controller.location,
-              class: props.controller.class.name,
-              function: null,
-              from: null,
-              contents: ["@nestia/sdk does not compose wildcard controller."],
-            });
-            return false;
-          }
-          return true;
-        },
-      ),
-      versions: ReflectMetadataAnalyzer.versions(props.controller.class),
-      security: ReflectMetadataAnalyzer.securities(props.controller.class),
-      tags:
-        Reflect.getMetadata("swagger/apiUseTags", props.controller.class) ?? [],
-    };
-
-    // OPERATORS
-    for (const [key, value] of _Get_prototype_entries(props.controller.class)) {
-      if (typeof value !== "function") continue;
-      const metadata: IOperationMetadata | undefined = Reflect.getMetadata(
-        "nestia/OperationMetadata",
-        props.controller.class.prototype,
-        key,
-      );
-      if (metadata === undefined) continue;
-      else if (metadata.jsDocTags.some((tag) => tag.name === "ignore"))
-        continue;
-      const next: ReflectHttpOperationAnalyzer.IProps = {
-        project: props.project,
-        controller: controller,
-        name: key,
-        function: value,
-        metadata,
-      };
-      const child: IReflectHttpOperation | IReflectWebSocketOperation | null =
-        ReflectWebSocketOperationAnalyzer.analyze(next) ??
-        ReflectHttpOperationAnalyzer.analyze(next);
-      if (child !== null) controller.operations.push(child);
-    }
-    return controller;
-  };
-
-  function _Get_prototype_entries(creator: any): Array<[string, unknown]> {
-    const keyList = Object.getOwnPropertyNames(creator.prototype);
-    const entries: Array<[string, unknown]> = keyList.map((key) => [
-      key,
-      creator.prototype[key],
-    ]);
-
-    const parent = Object.getPrototypeOf(creator);
-    if (parent.prototype !== undefined)
-      entries.push(..._Get_prototype_entries(parent));
-
-    return entries;
-  }
-}
+import {
+  HOST_METADATA,
+  PATH_METADATA,
+  SCOPE_OPTIONS_METADATA,
+} from "@nestjs/common/constants";
+
+import { INestiaProject } from "../structures/INestiaProject";
+import { INestiaSdkInput } from "../structures/INestiaSdkInput";
+import { IReflectController } from "../structures/IReflectController";
+import { IReflectHttpOperation } from "../structures/IReflectHttpOperation";
+import { IReflectWebSocketOperation } from "../structures/IReflectWebSocketOperation";
+import { IOperationMetadata } from "../transformers/IOperationMetadata";
+import { ArrayUtil } from "../utils/ArrayUtil";
+import { ReflectHttpOperationAnalyzer } from "./ReflectHttpOperationAnalyzer";
+import { ReflectMetadataAnalyzer } from "./ReflectMetadataAnalyzer";
+import { ReflectWebSocketOperationAnalyzer } from "./ReflectWebSocketOperationAnalyzer";
+
+export namespace ReflectControllerAnalyzer {
+  export interface IProps {
+    project: Omit<INestiaProject, "config">;
+    controller: INestiaSdkInput.IController;
+    unique: WeakSet<Function>;
+  }
+  /* ---------------------------------------------------------
+    CONTROLLER
+  --------------------------------------------------------- */
+  export const analyze = (props: IProps): IReflectController | null => {
+    // MUST BE TYPE OF A CREATOR WHO HAS THE CONSTRUCTOR
+    if (
+      ArrayUtil.has(
+        Reflect.getMetadataKeys(props.controller.class),
+        PATH_METADATA,
+        HOST_METADATA,
+        SCOPE_OPTIONS_METADATA,
+      ) === false
+    )
+      return null;
+
+    // BASIC INFO
+    const controller: IReflectController = {
+      class: props.controller.class,
+      file: props.controller.location,
+      operations: [],
+      prefixes: props.controller.prefixes,
+      paths: ReflectMetadataAnalyzer.paths(props.controller.class).filter(
+        (str) => {
+          if (str.includes("*") === true) {
+            props.project.warnings.push({
+              file: props.controller.location,
+              class: props.controller.class.name,
+              function: null,
+              from: null,
+              contents: ["@nestia/sdk does not compose wildcard controller."],
+            });
+            return false;
+          }
+          return true;
+        },
+      ),
+      versions: ReflectMetadataAnalyzer.versions(props.controller.class),
+      security: ReflectMetadataAnalyzer.securities(props.controller.class),
+      tags:
+        Reflect.getMetadata("swagger/apiUseTags", props.controller.class) ?? [],
+    };
+
+    // OPERATORS
+    for (const [key, value] of _Get_prototype_entries(props.controller.class)) {
+      if (typeof value !== "function") continue;
+      const metadata: IOperationMetadata | undefined = Reflect.getMetadata(
+        "nestia/OperationMetadata",
+        props.controller.class.prototype,
+        key,
+      );
+      if (metadata === undefined) continue;
+      else if (metadata.jsDocTags.some((tag) => tag.name === "ignore"))
+        continue;
+      const next: ReflectHttpOperationAnalyzer.IProps = {
+        project: props.project,
+        controller: controller,
+        name: key,
+        function: value,
+        metadata,
+      };
+      const child: IReflectHttpOperation | IReflectWebSocketOperation | null =
+        ReflectWebSocketOperationAnalyzer.analyze(next) ??
+        ReflectHttpOperationAnalyzer.analyze(next);
+      if (child !== null) controller.operations.push(child);
+    }
+    return controller;
+  };
+
+  function _Get_prototype_entries(creator: any): Array<[string, unknown]> {
+    const keyList = Object.getOwnPropertyNames(creator.prototype);
+    const entries: Array<[string, unknown]> = keyList.map((key) => [
+      key,
+      creator.prototype[key],
+    ]);
+
+    const parent = Object.getPrototypeOf(creator);
+    if (parent.prototype !== undefined)
+      entries.push(..._Get_prototype_entries(parent));
+
+    return entries;
+  }
+}