@nestia/sdk 10.0.2 → 11.0.0-dev.20260312

package/src/analyses/ImportAnalyzer.ts

@@ -1,126 +1,126 @@
-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}`;
-  }
-}
+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/ReflectHttpOperationAnalyzer.ts

@@ -1,183 +1,183 @@
-import { METHOD_METADATA, PATH_METADATA } from "@nestjs/common/constants";
-import { ranges } from "tstl";
-
-import { INestiaProject } from "../structures/INestiaProject";
-import { IReflectController } from "../structures/IReflectController";
-import { IReflectHttpOperation } from "../structures/IReflectHttpOperation";
-import { IReflectHttpOperationParameter } from "../structures/IReflectHttpOperationParameter";
-import { IReflectHttpOperationSuccess } from "../structures/IReflectHttpOperationSuccess";
-import { IReflectOperationError } from "../structures/IReflectOperationError";
-import { IOperationMetadata } from "../transformers/IOperationMetadata";
-import { ArrayUtil } from "../utils/ArrayUtil";
-import { ImportAnalyzer } from "./ImportAnalyzer";
-import { PathAnalyzer } from "./PathAnalyzer";
-import { ReflectHttpOperationExceptionAnalyzer } from "./ReflectHttpOperationExceptionAnalyzer";
-import { ReflectHttpOperationParameterAnalyzer } from "./ReflectHttpOperationParameterAnalyzer";
-import { ReflectHttpOperationResponseAnalyzer } from "./ReflectHttpOperationResponseAnalyzer";
-import { ReflectMetadataAnalyzer } from "./ReflectMetadataAnalyzer";
-
-export namespace ReflectHttpOperationAnalyzer {
-  export interface IProps {
-    project: Omit<INestiaProject, "config">;
-    controller: IReflectController;
-    function: Function;
-    name: string;
-    metadata: IOperationMetadata;
-  }
-  export const analyze = (props: IProps): IReflectHttpOperation | null => {
-    if (
-      ArrayUtil.has(
-        Reflect.getMetadataKeys(props.function),
-        PATH_METADATA,
-        METHOD_METADATA,
-      ) === false
-    )
-      return null;
-
-    const errors: IReflectOperationError[] = [];
-    const method: string =
-      METHODS[Reflect.getMetadata(METHOD_METADATA, props.function)];
-    if (method === undefined || method === "OPTIONS") return null;
-
-    const parameters: IReflectHttpOperationParameter[] =
-      ReflectHttpOperationParameterAnalyzer.analyze({
-        controller: props.controller,
-        metadata: props.metadata,
-        httpMethod: method,
-        function: props.function,
-        functionName: props.name,
-        errors,
-      });
-    const success: IReflectHttpOperationSuccess | null = (() => {
-      const localErrors: IReflectOperationError[] = [];
-      const success = ReflectHttpOperationResponseAnalyzer.analyze({
-        controller: props.controller,
-        function: props.function,
-        functionName: props.name,
-        httpMethod: method,
-        metadata: props.metadata,
-        errors,
-      });
-      if (localErrors.length) {
-        errors.push(...localErrors);
-        return null;
-      }
-      return success;
-    })();
-    if (errors.length) {
-      props.project.errors.push(...errors);
-      return null;
-    } else if (success === null) return null;
-
-    // DO CONSTRUCT
-    const operation: IReflectHttpOperation = {
-      protocol: "http",
-      function: props.function,
-      name: props.name,
-      method: method === "ALL" ? "POST" : method,
-      paths: ReflectMetadataAnalyzer.paths(props.function).filter((str) => {
-        if (str.includes("*") === true) {
-          props.project.warnings.push({
-            file: props.controller.file,
-            class: props.controller.class.name,
-            function: props.name,
-            from: "",
-            contents: ["@nestia/sdk does not compose wildcard method."],
-          });
-          return false;
-        }
-        return true;
-      }),
-      versions: ReflectMetadataAnalyzer.versions(props.function),
-      parameters,
-      success,
-      security: ReflectMetadataAnalyzer.securities(props.function),
-      exceptions: ReflectHttpOperationExceptionAnalyzer.analyze({
-        controller: props.controller,
-        function: props.function,
-        functionName: props.name,
-        httpMethod: method,
-        metadata: props.metadata,
-        errors,
-      }),
-      tags: Reflect.getMetadata("swagger/apiUseTags", props.function) ?? [],
-      imports: ImportAnalyzer.merge(
-        [
-          ...props.metadata.parameters
-            .filter((x) => parameters.some((y) => x.index === y.index))
-            .map((x) => x.imports),
-          ...props.metadata.success.imports,
-          ...Object.values(props.metadata.exceptions).map((e) => e.imports),
-        ].flat(),
-      ),
-      description: props.metadata.description,
-      jsDocTags: props.metadata.jsDocTags,
-      operationId: props.metadata.jsDocTags
-        .find(({ name }) => name === "operationId")
-        ?.text?.[0].text.split(" ")[0]
-        .trim(),
-      extensions: ReflectMetadataAnalyzer.extensions(props.function),
-    };
-
-    // VALIDATE PATH ARGUMENTS
-    for (const controllerLocation of props.controller.paths)
-      for (const metaLocation of operation.paths) {
-        // NORMALIZE LOCATION
-        const location: string = PathAnalyzer.join(
-          controllerLocation,
-          metaLocation,
-        );
-        if (location.includes("*")) continue;
-
-        // LIST UP PARAMETERS
-        const binded: string[] | null = PathAnalyzer.parameters(location);
-        if (binded === null) {
-          props.project.errors.push({
-            file: props.controller.file,
-            class: props.controller.class.name,
-            function: props.name,
-            from: "{parameters}",
-            contents: [`invalid path (${JSON.stringify(location)})`],
-          });
-          continue;
-        }
-        const parameters: string[] = operation.parameters
-          .filter((param) => param.category === "param")
-          .map((param) => param.field!)
-          .sort();
-
-        // DO VALIDATE
-        if (ranges.equal(binded.sort(), parameters) === false)
-          errors.push({
-            file: props.controller.file,
-            class: props.controller.class.name,
-            function: props.name,
-            from: "{parameters}",
-            contents: [
-              `binded arguments in the "path" between function's decorator and parameters' decorators are different (function: [${binded.join(
-                ", ",
-              )}], parameters: [${parameters.join(", ")}]).`,
-            ],
-          });
-      }
-
-    // RETURNS
-    if (errors.length) {
-      props.project.errors.push(...errors);
-      return null;
-    }
-    return operation;
-  };
-}
-
-// node_modules/@nestjs/common/lib/enums/request-method.enum.ts
-const METHODS = [
-  "GET",
-  "POST",
-  "PUT",
-  "DELETE",
-  "PATCH",
-  "ALL",
-  "OPTIONS",
-  "HEAD",
-];
+import { METHOD_METADATA, PATH_METADATA } from "@nestjs/common/constants";
+import { ranges } from "tstl";
+
+import { INestiaProject } from "../structures/INestiaProject";
+import { IReflectController } from "../structures/IReflectController";
+import { IReflectHttpOperation } from "../structures/IReflectHttpOperation";
+import { IReflectHttpOperationParameter } from "../structures/IReflectHttpOperationParameter";
+import { IReflectHttpOperationSuccess } from "../structures/IReflectHttpOperationSuccess";
+import { IReflectOperationError } from "../structures/IReflectOperationError";
+import { IOperationMetadata } from "../transformers/IOperationMetadata";
+import { ArrayUtil } from "../utils/ArrayUtil";
+import { ImportAnalyzer } from "./ImportAnalyzer";
+import { PathAnalyzer } from "./PathAnalyzer";
+import { ReflectHttpOperationExceptionAnalyzer } from "./ReflectHttpOperationExceptionAnalyzer";
+import { ReflectHttpOperationParameterAnalyzer } from "./ReflectHttpOperationParameterAnalyzer";
+import { ReflectHttpOperationResponseAnalyzer } from "./ReflectHttpOperationResponseAnalyzer";
+import { ReflectMetadataAnalyzer } from "./ReflectMetadataAnalyzer";
+
+export namespace ReflectHttpOperationAnalyzer {
+  export interface IProps {
+    project: Omit<INestiaProject, "config">;
+    controller: IReflectController;
+    function: Function;
+    name: string;
+    metadata: IOperationMetadata;
+  }
+  export const analyze = (props: IProps): IReflectHttpOperation | null => {
+    if (
+      ArrayUtil.has(
+        Reflect.getMetadataKeys(props.function),
+        PATH_METADATA,
+        METHOD_METADATA,
+      ) === false
+    )
+      return null;
+
+    const errors: IReflectOperationError[] = [];
+    const method: string =
+      METHODS[Reflect.getMetadata(METHOD_METADATA, props.function)]!;
+    if (method === undefined || method === "OPTIONS") return null;
+
+    const parameters: IReflectHttpOperationParameter[] =
+      ReflectHttpOperationParameterAnalyzer.analyze({
+        controller: props.controller,
+        metadata: props.metadata,
+        httpMethod: method,
+        function: props.function,
+        functionName: props.name,
+        errors,
+      });
+    const success: IReflectHttpOperationSuccess | null = (() => {
+      const localErrors: IReflectOperationError[] = [];
+      const success = ReflectHttpOperationResponseAnalyzer.analyze({
+        controller: props.controller,
+        function: props.function,
+        functionName: props.name,
+        httpMethod: method,
+        metadata: props.metadata,
+        errors,
+      });
+      if (localErrors.length) {
+        errors.push(...localErrors);
+        return null;
+      }
+      return success;
+    })();
+    if (errors.length) {
+      props.project.errors.push(...errors);
+      return null;
+    } else if (success === null) return null;
+
+    // DO CONSTRUCT
+    const operation: IReflectHttpOperation = {
+      protocol: "http",
+      function: props.function,
+      name: props.name,
+      method: method === "ALL" ? "POST" : method,
+      paths: ReflectMetadataAnalyzer.paths(props.function).filter((str) => {
+        if (str.includes("*") === true) {
+          props.project.warnings.push({
+            file: props.controller.file,
+            class: props.controller.class.name,
+            function: props.name,
+            from: "",
+            contents: ["@nestia/sdk does not compose wildcard method."],
+          });
+          return false;
+        }
+        return true;
+      }),
+      versions: ReflectMetadataAnalyzer.versions(props.function),
+      parameters,
+      success,
+      security: ReflectMetadataAnalyzer.securities(props.function),
+      exceptions: ReflectHttpOperationExceptionAnalyzer.analyze({
+        controller: props.controller,
+        function: props.function,
+        functionName: props.name,
+        httpMethod: method,
+        metadata: props.metadata,
+        errors,
+      }),
+      tags: Reflect.getMetadata("swagger/apiUseTags", props.function) ?? [],
+      imports: ImportAnalyzer.merge(
+        [
+          ...props.metadata.parameters
+            .filter((x) => parameters.some((y) => x.index === y.index))
+            .map((x) => x.imports),
+          ...props.metadata.success.imports,
+          ...Object.values(props.metadata.exceptions).map((e) => e.imports),
+        ].flat(),
+      ),
+      description: props.metadata.description,
+      jsDocTags: props.metadata.jsDocTags,
+      operationId: props.metadata.jsDocTags
+        .find(({ name }) => name === "operationId")
+        ?.text?.[0]?.text.split(" ")[0]
+        ?.trim(),
+      extensions: ReflectMetadataAnalyzer.extensions(props.function),
+    };
+
+    // VALIDATE PATH ARGUMENTS
+    for (const controllerLocation of props.controller.paths)
+      for (const metaLocation of operation.paths) {
+        // NORMALIZE LOCATION
+        const location: string = PathAnalyzer.join(
+          controllerLocation,
+          metaLocation,
+        );
+        if (location.includes("*")) continue;
+
+        // LIST UP PARAMETERS
+        const binded: string[] | null = PathAnalyzer.parameters(location);
+        if (binded === null) {
+          props.project.errors.push({
+            file: props.controller.file,
+            class: props.controller.class.name,
+            function: props.name,
+            from: "{parameters}",
+            contents: [`invalid path (${JSON.stringify(location)})`],
+          });
+          continue;
+        }
+        const parameters: string[] = operation.parameters
+          .filter((param) => param.category === "param")
+          .map((param) => param.field!)
+          .sort();
+
+        // DO VALIDATE
+        if (ranges.equal(binded.sort(), parameters) === false)
+          errors.push({
+            file: props.controller.file,
+            class: props.controller.class.name,
+            function: props.name,
+            from: "{parameters}",
+            contents: [
+              `binded arguments in the "path" between function's decorator and parameters' decorators are different (function: [${binded.join(
+                ", ",
+              )}], parameters: [${parameters.join(", ")}]).`,
+            ],
+          });
+      }
+
+    // RETURNS
+    if (errors.length) {
+      props.project.errors.push(...errors);
+      return null;
+    }
+    return operation;
+  };
+}
+
+// node_modules/@nestjs/common/lib/enums/request-method.enum.ts
+const METHODS = [
+  "GET",
+  "POST",
+  "PUT",
+  "DELETE",
+  "PATCH",
+  "ALL",
+  "OPTIONS",
+  "HEAD",
+];