@nestia/sdk 7.1.1-dev.20250714 → 7.2.0

package/src/analyses/ConfigAnalyzer.ts

@@ -1,155 +1,155 @@
-/// <reference path="../typings/get-function-location.d.ts" />
-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 getFunctionLocation from "get-function-location";
-import path from "path";
-import { HashMap, Pair, Singleton } from "tstl";
-
-import { INestiaConfig } from "../INestiaConfig";
-import { SdkGenerator } from "../generates/SdkGenerator";
-import { INestiaSdkInput } from "../structures/INestiaSdkInput";
-import { ArrayUtil } from "../utils/ArrayUtil";
-import { MapUtil } from "../utils/MapUtil";
-import { SourceFinder } from "../utils/SourceFinder";
-
-export namespace ConfigAnalyzer {
-  export const input = async (
-    config: INestiaConfig,
-  ): Promise<INestiaSdkInput> => {
-    return MapUtil.take(memory, config, async () => {
-      if (typeof config.input === "function")
-        return application(await config.input());
-
-      const sources: string[] = await SourceFinder.find({
-        include: Array.isArray(config.input)
-          ? config.input
-          : typeof config.input === "object"
-            ? config.input.include
-            : [config.input],
-        exclude:
-          typeof config.input === "object" && !Array.isArray(config.input)
-            ? (config.input.exclude ?? [])
-            : [],
-        filter: filter(config),
-      });
-      const controllers: INestiaSdkInput.IController[] = [];
-      for (const file of sources) {
-        const external: any[] = await import(file);
-        for (const key in external) {
-          const instance: Function = external[key];
-          if (Reflect.getMetadata("path", instance) !== undefined)
-            controllers.push({
-              class: instance,
-              location: file,
-              prefixes: [],
-            });
-        }
-      }
-      return {
-        controllers,
-      };
-    });
-  };
-
-  export const application = async (
-    app: INestApplication,
-  ): Promise<INestiaSdkInput> => {
-    const container: NestContainer = (app as any).container as NestContainer;
-    const modules: Module[] = [...container.getModules().values()].filter(
-      (m) => !!m.controllers.size,
-    );
-    const unique: HashMap<Function, Set<string>> = new HashMap();
-
-    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()])
-        if (typeof controller === "function")
-          unique.take(controller, () => new Set()).add(path);
-    }
-    const controllers: INestiaSdkInput.IController[] = [];
-    for (const it of unique) {
-      const file: string | null =
-        (await getFunctionLocation(it.first))?.source ?? null;
-      if (file === null) continue;
-      const location: string = normalize_file(file);
-      if (location.length === 0) continue;
-      controllers.push({
-        class: it.first,
-        prefixes: Array.from(it.second),
-        location,
-      });
-    }
-
-    const versioning = (app as any).config?.versioningOptions;
-    return {
-      controllers,
-      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 memory = new Map<INestiaConfig, Promise<INestiaSdkInput>>();
-const normalize_file = (str: string) =>
-  str.substring(
-    str.startsWith("file:///")
-      ? process.cwd()[0] === "/"
-        ? 7
-        : 8
-      : str.startsWith("file://")
-        ? 7
-        : 0,
-  );
-
-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 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;
-  };
-});
+/// <reference path="../typings/get-function-location.d.ts" />
+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 getFunctionLocation from "get-function-location";
+import path from "path";
+import { HashMap, Pair, Singleton } from "tstl";
+
+import { INestiaConfig } from "../INestiaConfig";
+import { SdkGenerator } from "../generates/SdkGenerator";
+import { INestiaSdkInput } from "../structures/INestiaSdkInput";
+import { ArrayUtil } from "../utils/ArrayUtil";
+import { MapUtil } from "../utils/MapUtil";
+import { SourceFinder } from "../utils/SourceFinder";
+
+export namespace ConfigAnalyzer {
+  export const input = async (
+    config: INestiaConfig,
+  ): Promise<INestiaSdkInput> => {
+    return MapUtil.take(memory, config, async () => {
+      if (typeof config.input === "function")
+        return application(await config.input());
+
+      const sources: string[] = await SourceFinder.find({
+        include: Array.isArray(config.input)
+          ? config.input
+          : typeof config.input === "object"
+            ? config.input.include
+            : [config.input],
+        exclude:
+          typeof config.input === "object" && !Array.isArray(config.input)
+            ? (config.input.exclude ?? [])
+            : [],
+        filter: filter(config),
+      });
+      const controllers: INestiaSdkInput.IController[] = [];
+      for (const file of sources) {
+        const external: any[] = await import(file);
+        for (const key in external) {
+          const instance: Function = external[key];
+          if (Reflect.getMetadata("path", instance) !== undefined)
+            controllers.push({
+              class: instance,
+              location: file,
+              prefixes: [],
+            });
+        }
+      }
+      return {
+        controllers,
+      };
+    });
+  };
+
+  export const application = async (
+    app: INestApplication,
+  ): Promise<INestiaSdkInput> => {
+    const container: NestContainer = (app as any).container as NestContainer;
+    const modules: Module[] = [...container.getModules().values()].filter(
+      (m) => !!m.controllers.size,
+    );
+    const unique: HashMap<Function, Set<string>> = new HashMap();
+
+    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()])
+        if (typeof controller === "function")
+          unique.take(controller, () => new Set()).add(path);
+    }
+    const controllers: INestiaSdkInput.IController[] = [];
+    for (const it of unique) {
+      const file: string | null =
+        (await getFunctionLocation(it.first))?.source ?? null;
+      if (file === null) continue;
+      const location: string = normalize_file(file);
+      if (location.length === 0) continue;
+      controllers.push({
+        class: it.first,
+        prefixes: Array.from(it.second),
+        location,
+      });
+    }
+
+    const versioning = (app as any).config?.versioningOptions;
+    return {
+      controllers,
+      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 memory = new Map<INestiaConfig, Promise<INestiaSdkInput>>();
+const normalize_file = (str: string) =>
+  str.substring(
+    str.startsWith("file:///")
+      ? process.cwd()[0] === "/"
+        ? 7
+        : 8
+      : str.startsWith("file://")
+        ? 7
+        : 0,
+  );
+
+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 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/DtoAnalyzer.ts

@@ -0,0 +1,250 @@
+import ts from "typescript";
+
+import { IReflectImport } from "../structures/IReflectImport";
+import { IReflectType } from "../structures/IReflectType";
+import { ImportAnalyzer } from "./ImportAnalyzer";
+
+export namespace DtoAnalyzer {
+  export interface INodeProps {
+    checker: ts.TypeChecker;
+    imports: IReflectImport[];
+    typeNode: ts.TypeNode;
+  }
+  export interface ITypeProps {
+    checker: ts.TypeChecker;
+    imports: IReflectImport[];
+    type: ts.Type;
+  }
+  export interface IOutput {
+    imports: IReflectImport[];
+    type: IReflectType;
+  }
+
+  export const analyzeNode = (props: INodeProps): IOutput | null => {
+    try {
+      const container: IReflectImport[] = [];
+      const type: IReflectType = exploreNode(
+        {
+          checker: props.checker,
+          imports: props.imports,
+          container,
+        },
+        props.typeNode,
+      );
+      return {
+        type,
+        imports: ImportAnalyzer.merge(container),
+      };
+    } catch {
+      return null;
+    }
+  };
+
+  export const analyzeType = (props: ITypeProps): IOutput | null => {
+    try {
+      const container: IReflectImport[] = [];
+      const type: IReflectType = exploreType(
+        {
+          checker: props.checker,
+          imports: props.imports,
+          container,
+        },
+        props.type,
+      );
+      return {
+        type,
+        imports: ImportAnalyzer.merge(container),
+      };
+    } catch {
+      return null;
+    }
+  };
+
+  type IContext = Omit<INodeProps, "typeNode"> & {
+    container: IReflectImport[];
+  };
+
+  const exploreNode = (ctx: IContext, typeNode: ts.TypeNode): IReflectType => {
+    // Analyze symbol, and take special cares
+    if (ts.isIntersectionTypeNode(typeNode))
+      return {
+        name: typeNode.types
+          .map((child) => exploreNode(ctx, child))
+          .map(getEscapedText)
+          .join(" & "),
+      };
+    else if (ts.isUnionTypeNode(typeNode))
+      return {
+        name: typeNode.types
+          .map((child) => exploreNode(ctx, child))
+          .map(getEscapedText)
+          .join(" | "),
+      };
+    else if (ts.isParenthesizedTypeNode(typeNode))
+      return {
+        name: `(${exploreNode(ctx, typeNode.type).name})`,
+      };
+    else if (ts.isTypeOperatorNode(typeNode)) {
+      const prefix: string | null =
+        typeNode.operator === ts.SyntaxKind.KeyOfKeyword
+          ? "keyof"
+          : typeNode.operator === ts.SyntaxKind.UniqueKeyword
+            ? "unique"
+            : typeNode.operator === ts.SyntaxKind.ReadonlyKeyword
+              ? "readonly"
+              : null;
+      if (prefix === null)
+        return exploreType(ctx, ctx.checker.getTypeFromTypeNode(typeNode));
+      return {
+        name: `${prefix} ${exploreNode(ctx, typeNode.type).name}`,
+      };
+    } else if (ts.isTypePredicateNode(typeNode) || ts.isTypeQueryNode(typeNode))
+      return exploreType(ctx, ctx.checker.getTypeFromTypeNode(typeNode));
+    else if (ts.isTypeReferenceNode(typeNode) === false)
+      return {
+        name: typeNode.getText(),
+      };
+
+    // Find matched import statement
+    const name: string = typeNode.typeName.getText();
+    const prefix: string = name.split(".")[0];
+
+    let matched: boolean = false;
+    const insert = (imp: IReflectImport): void => {
+      matched ||= true;
+      ctx.container.push(imp);
+    };
+    for (const imp of ctx.imports)
+      if (prefix === imp.default)
+        insert({
+          file: imp.file,
+          asterisk: null,
+          default: prefix,
+          elements: [],
+        });
+      else if (prefix === imp.asterisk)
+        insert({
+          file: imp.file,
+          asterisk: prefix,
+          default: null,
+          elements: [],
+        });
+      else if (imp.elements.includes(prefix))
+        insert({
+          file: imp.file,
+          asterisk: null,
+          default: null,
+          elements: [prefix],
+        });
+    if (prefix !== "Promise" && matched === false) {
+      const symbol: ts.Symbol | undefined = name.includes(".")
+        ? ctx.checker.getSymbolAtLocation(typeNode.typeName)
+        : ctx.checker.getTypeAtLocation(typeNode).getSymbol();
+      if (symbol !== undefined) emplaceSymbol(ctx, symbol, prefix);
+    }
+
+    // Finalize with generic arguments
+    if (!!typeNode.typeArguments?.length) {
+      const top: ts.TypeNode = typeNode.typeArguments[0];
+      if (name === "Promise") return exploreNode(ctx, top);
+      return {
+        name,
+        typeArguments: typeNode.typeArguments.map((child) =>
+          exploreNode(ctx, child),
+        ),
+      };
+    }
+    return { name };
+  };
+
+  const exploreType = (ctx: IContext, type: ts.Type): IReflectType => {
+    // Analyze symbol, and take special cares
+    const symbol: ts.Symbol | undefined = type.aliasSymbol ?? type.symbol;
+    if (type.aliasSymbol === undefined && type.isUnionOrIntersection()) {
+      const joiner: string = type.isIntersection() ? " & " : " | ";
+      return {
+        name: type.types
+          .map((child) => exploreType(ctx, child))
+          .map(getEscapedText)
+          .join(joiner),
+      };
+    } else if (symbol === undefined)
+      return {
+        name: ctx.checker.typeToString(
+          type,
+          undefined,
+          ts.TypeFormatFlags.NoTruncation,
+        ),
+      };
+
+    // Find matched import statement
+    const name: string = getNameOfSymbol(symbol);
+    const prefix: string = name.split(".")[0];
+
+    let matched: boolean = false;
+    const insert = (imp: IReflectImport): void => {
+      matched ||= true;
+      ctx.container.push(imp);
+    };
+    for (const imp of ctx.imports)
+      if (imp.elements.includes(prefix))
+        insert({
+          file: imp.file,
+          asterisk: null,
+          default: null,
+          elements: [prefix],
+        });
+    if (prefix !== "Promise" && matched === false)
+      emplaceSymbol(ctx, symbol, prefix);
+
+    // Finalize with generic arguments
+    const generic: readonly ts.Type[] = type.aliasSymbol
+      ? (type.aliasTypeArguments ?? [])
+      : ctx.checker.getTypeArguments(type as ts.TypeReference);
+    return generic.length
+      ? name === "Promise"
+        ? exploreType(ctx, generic[0])
+        : {
+            name,
+            typeArguments: generic.map((child) => exploreType(ctx, child)),
+          }
+      : { name };
+  };
+
+  const emplaceSymbol = (
+    ctx: IContext,
+    symbol: ts.Symbol,
+    prefix: string,
+  ): void => {
+    // GET SOURCE FILE
+    const sourceFile: ts.SourceFile | undefined =
+      symbol.declarations?.[0]?.getSourceFile();
+    if (sourceFile === undefined) return;
+    if (sourceFile.fileName.indexOf("/typescript/lib") === -1)
+      ctx.container.push({
+        file: sourceFile.fileName,
+        asterisk: null,
+        default: null,
+        elements: [prefix],
+      });
+  };
+}
+
+const getEscapedText = (type: IReflectType): string =>
+  type.typeArguments
+    ? `${type.name}<${type.typeArguments.map(getEscapedText).join(", ")}>`
+    : type.name;
+
+const getNameOfSymbol = (symbol: ts.Symbol): string =>
+  exploreName(
+    symbol.escapedName.toString(),
+    symbol.getDeclarations()?.[0]?.parent,
+  );
+
+const exploreName = (name: string, decl?: ts.Node): string =>
+  decl && ts.isModuleBlock(decl)
+    ? exploreName(
+        `${decl.parent.name.getFullText().trim()}.${name}`,
+        decl.parent.parent,
+      )
+    : name;