@nestia/sdk 8.1.0 → 9.0.0-dev.20251107

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",
+];

package/src/analyses/ReflectHttpOperationExceptionAnalyzer.ts

@@ -1,71 +1,71 @@
-import { TypedException } from "@nestia/core";
-import { JsonMetadataFactory } from "typia/lib/factories/JsonMetadataFactory";
-
-import { IReflectController } from "../structures/IReflectController";
-import { IReflectHttpOperationException } from "../structures/IReflectHttpOperationException";
-import { IReflectOperationError } from "../structures/IReflectOperationError";
-import { IOperationMetadata } from "../transformers/IOperationMetadata";
-
-export namespace ReflectHttpOperationExceptionAnalyzer {
-  export interface IContext {
-    controller: IReflectController;
-    function: Function;
-    functionName: string;
-    httpMethod: string;
-    metadata: IOperationMetadata;
-    errors: IReflectOperationError[];
-  }
-  export const analyze = (
-    ctx: IContext,
-  ): Record<string, IReflectHttpOperationException> => {
-    const preconfigured: TypedException.IProps<any>[] = analyzePreconfigured(
-      ctx.function,
-    )
-      .slice()
-      .reverse();
-    const errors: IReflectOperationError[] = [];
-    const exceptions: IReflectHttpOperationException[] = preconfigured
-      .map((pre, i) => {
-        const matched: IOperationMetadata.IException | null =
-          ctx.metadata.exceptions[i];
-        if (matched === undefined) {
-          errors.push({
-            file: ctx.controller.file,
-            class: ctx.controller.class.name,
-            function: ctx.functionName,
-            from: `exception (status: ${pre.status})`,
-            contents: ["Unable to find exception type."],
-          });
-          return null;
-        } else if (matched.type === null) {
-          errors.push({
-            file: ctx.controller.file,
-            class: ctx.controller.class.name,
-            function: ctx.functionName,
-            from: `exception (status: ${pre.status})`,
-            contents: ["Failed to get the type info."],
-          });
-        }
-        const schema: IOperationMetadata.ISchema | null = matched.primitive
-          .success
-          ? matched.primitive.data
-          : null;
-        if (schema === null || matched.type === null) return null; // unreachable
-        return {
-          status: pre.status,
-          description: pre.description ?? null,
-          example: pre.example,
-          examples: pre.examples,
-          type: matched.type,
-          ...schema,
-          validate: JsonMetadataFactory.validate,
-        } satisfies IReflectHttpOperationException;
-      })
-      .filter((e) => e !== null);
-    if (errors.length) ctx.errors.push(...errors);
-    return Object.fromEntries(exceptions.map((e) => [e.status, e]));
-  };
-
-  const analyzePreconfigured = (func: Function): TypedException.IProps<any>[] =>
-    Reflect.getMetadata("nestia/TypedException", func) ?? [];
-}
+import { TypedException } from "@nestia/core";
+import { JsonMetadataFactory } from "typia/lib/factories/JsonMetadataFactory";
+
+import { IReflectController } from "../structures/IReflectController";
+import { IReflectHttpOperationException } from "../structures/IReflectHttpOperationException";
+import { IReflectOperationError } from "../structures/IReflectOperationError";
+import { IOperationMetadata } from "../transformers/IOperationMetadata";
+
+export namespace ReflectHttpOperationExceptionAnalyzer {
+  export interface IContext {
+    controller: IReflectController;
+    function: Function;
+    functionName: string;
+    httpMethod: string;
+    metadata: IOperationMetadata;
+    errors: IReflectOperationError[];
+  }
+  export const analyze = (
+    ctx: IContext,
+  ): Record<string, IReflectHttpOperationException> => {
+    const preconfigured: TypedException.IProps<any>[] = analyzePreconfigured(
+      ctx.function,
+    )
+      .slice()
+      .reverse();
+    const errors: IReflectOperationError[] = [];
+    const exceptions: IReflectHttpOperationException[] = preconfigured
+      .map((pre, i) => {
+        const matched: IOperationMetadata.IException | null =
+          ctx.metadata.exceptions[i];
+        if (matched === undefined) {
+          errors.push({
+            file: ctx.controller.file,
+            class: ctx.controller.class.name,
+            function: ctx.functionName,
+            from: `exception (status: ${pre.status})`,
+            contents: ["Unable to find exception type."],
+          });
+          return null;
+        } else if (matched.type === null) {
+          errors.push({
+            file: ctx.controller.file,
+            class: ctx.controller.class.name,
+            function: ctx.functionName,
+            from: `exception (status: ${pre.status})`,
+            contents: ["Failed to get the type info."],
+          });
+        }
+        const schema: IOperationMetadata.ISchema | null = matched.primitive
+          .success
+          ? matched.primitive.data
+          : null;
+        if (schema === null || matched.type === null) return null; // unreachable
+        return {
+          status: pre.status,
+          description: pre.description ?? null,
+          example: pre.example,
+          examples: pre.examples,
+          type: matched.type,
+          ...schema,
+          validate: JsonMetadataFactory.validate,
+        } satisfies IReflectHttpOperationException;
+      })
+      .filter((e) => e !== null);
+    if (errors.length) ctx.errors.push(...errors);
+    return Object.fromEntries(exceptions.map((e) => [e.status, e]));
+  };
+
+  const analyzePreconfigured = (func: Function): TypedException.IProps<any>[] =>
+    Reflect.getMetadata("nestia/TypedException", func) ?? [];
+}