@nestia/sdk 11.0.0-dev.20260312 → 11.0.0-dev.20260313-3

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;
+  }
+}

package/src/analyses/ReflectMetadataAnalyzer.ts

@@ -1,44 +1,44 @@
-import { VERSION_NEUTRAL } from "@nestjs/common";
-import { PATH_METADATA, VERSION_METADATA } from "@nestjs/common/constants";
-import { VersionValue } from "@nestjs/common/interfaces";
-
-import { SecurityAnalyzer } from "./SecurityAnalyzer";
-
-export namespace ReflectMetadataAnalyzer {
-  export const paths = (target: Function): string[] => {
-    const value: string | string[] = Reflect.getMetadata(PATH_METADATA, target);
-    if (typeof value === "string") return [value];
-    else if (value.length === 0) return [""];
-    else return value;
-  };
-
-  export const extensions = (value: any): Record<string, any> => {
-    const entire: Record<string, any>[] | undefined = Reflect.getMetadata(
-      "swagger/apiExtension",
-      value,
-    );
-    return entire ?? {};
-  };
-
-  export const securities = (value: any): Record<string, string[]>[] => {
-    const entire: Record<string, string[]>[] | undefined = Reflect.getMetadata(
-      "swagger/apiSecurity",
-      value,
-    );
-    return entire ? SecurityAnalyzer.merge(...entire) : [];
-  };
-
-  export const versions = (
-    target: any,
-  ): Array<string | typeof VERSION_NEUTRAL> | undefined => {
-    const value: VersionValue | undefined = Reflect.getMetadata(
-      VERSION_METADATA,
-      target,
-    );
-    return value === undefined
-      ? undefined
-      : Array.isArray(value)
-        ? value
-        : [value];
-  };
-}
+import { VERSION_NEUTRAL } from "@nestjs/common";
+import { PATH_METADATA, VERSION_METADATA } from "@nestjs/common/constants";
+import { VersionValue } from "@nestjs/common/interfaces";
+
+import { SecurityAnalyzer } from "./SecurityAnalyzer";
+
+export namespace ReflectMetadataAnalyzer {
+  export const paths = (target: Function): string[] => {
+    const value: string | string[] = Reflect.getMetadata(PATH_METADATA, target);
+    if (typeof value === "string") return [value];
+    else if (value.length === 0) return [""];
+    else return value;
+  };
+
+  export const extensions = (value: any): Record<string, any> => {
+    const entire: Record<string, any>[] | undefined = Reflect.getMetadata(
+      "swagger/apiExtension",
+      value,
+    );
+    return entire ?? {};
+  };
+
+  export const securities = (value: any): Record<string, string[]>[] => {
+    const entire: Record<string, string[]>[] | undefined = Reflect.getMetadata(
+      "swagger/apiSecurity",
+      value,
+    );
+    return entire ? SecurityAnalyzer.merge(...entire) : [];
+  };
+
+  export const versions = (
+    target: any,
+  ): Array<string | typeof VERSION_NEUTRAL> | undefined => {
+    const value: VersionValue | undefined = Reflect.getMetadata(
+      VERSION_METADATA,
+      target,
+    );
+    return value === undefined
+      ? undefined
+      : Array.isArray(value)
+        ? value
+        : [value];
+  };
+}

package/src/analyses/ReflectWebSocketOperationAnalyzer.ts

@@ -1,172 +1,172 @@
-import { ranges } from "tstl";
-
-import { INestiaProject } from "../structures/INestiaProject";
-import { IReflectController } from "../structures/IReflectController";
-import { IReflectImport } from "../structures/IReflectImport";
-import { IReflectWebSocketOperation } from "../structures/IReflectWebSocketOperation";
-import { IReflectWebSocketOperationParameter } from "../structures/IReflectWebSocketOperationParameter";
-import { IOperationMetadata } from "../transformers/IOperationMetadata";
-import { StringUtil } from "../utils/StringUtil";
-import { ImportAnalyzer } from "./ImportAnalyzer";
-import { PathAnalyzer } from "./PathAnalyzer";
-import { ReflectMetadataAnalyzer } from "./ReflectMetadataAnalyzer";
-
-export namespace ReflectWebSocketOperationAnalyzer {
-  export interface IProps {
-    project: Omit<INestiaProject, "config">;
-    controller: IReflectController;
-    function: Function;
-    name: string;
-    metadata: IOperationMetadata;
-  }
-  export const analyze = (ctx: IProps): IReflectWebSocketOperation | null => {
-    const route: { paths: string[] } | undefined = Reflect.getMetadata(
-      "nestia/WebSocketRoute",
-      ctx.function,
-    );
-    if (route === undefined) return null;
-
-    // @todo -> detailing is required
-    const errors: string[] = [];
-    const preconfigured: IReflectWebSocketOperationParameter.IPreconfigured[] =
-      (
-        (Reflect.getMetadata(
-          "nestia/WebSocketRoute/Parameters",
-          ctx.controller.class.prototype,
-          ctx.name,
-        ) ?? []) as IReflectWebSocketOperationParameter[]
-      ).sort((a, b) => a.index - b.index);
-    if (preconfigured.find((p) => (p.category === "acceptor") === undefined))
-      errors.push("@WebSocketRoute.Acceptor() is essentially required");
-    if (preconfigured.length !== ctx.function.length)
-      errors.push(
-        [
-          "Every parameters must be one of below:",
-          "  - @WebSocketRoute.Acceptor()",
-          "  - @WebSocketRoute.Driver()",
-          "  - @WebSocketRoute.Header()",
-          "  - @WebSocketRoute.Param()",
-          "  - @WebSocketRoute.Query()",
-        ].join("\n"),
-      );
-
-    const imports: IReflectImport[] = [];
-    const parameters: IReflectWebSocketOperationParameter[] = preconfigured
-      .map((p) => {
-        // METADATA INFO
-        const matched: IOperationMetadata.IParameter | undefined =
-          ctx.metadata.parameters.find((m) => p.index === m.index);
-
-        // VALIDATE PARAMETER
-        if (matched === undefined)
-          return errors.push(
-            `Unable to find parameter type of the ${p.index} (th).`,
-          );
-        else if (matched.type === null)
-          return errors.push(
-            `Failed to analyze the parameter type of the ${JSON.stringify(matched.name)}.`,
-          );
-        else if (
-          p.category === "param" &&
-          !(p as IReflectWebSocketOperationParameter.IParam).field?.length
-        )
-          return errors.push(`@WebSocketRoute.Param() must have a field name.`);
-        else if (
-          p.category === "acceptor" &&
-          matched.type?.typeArguments?.length !== 3
-        )
-          return `@WebSocketRoute.Acceptor() must have three type arguments.`;
-        else if (
-          p.category === "driver" &&
-          matched.type?.typeArguments?.length !== 1
-        )
-          return errors.push(
-            `@WebSocketRoute.Driver() must have one type argument.`,
-          );
-
-        // COMPLETE COMPOSITION
-        imports.push(
-          ...matched.imports.filter(
-            (i) =>
-              !(
-                i.file.includes("tgrid/lib") &&
-                (i.file.endsWith("Driver.d.ts") ||
-                  i.file.endsWith("WebSocketAcceptor.d.ts"))
-              ),
-          ),
-        );
-        if (
-          p.category === "acceptor" ||
-          p.category === "driver" ||
-          p.category === "query"
-        )
-          return {
-            ...p,
-            name: matched.name,
-            type: matched.type,
-          };
-        else if (p.category === "param")
-          return {
-            ...p,
-            category: "param",
-            field: p.field!,
-            name: matched.name,
-            type: matched.type,
-            imports: matched.imports,
-            description: matched.description,
-            jsDocTags: matched.jsDocTags,
-          } satisfies IReflectWebSocketOperationParameter.IParam;
-        // UNKNOWN TYPE, MAYBE NEW FEATURE
-        else {
-          if (p.category !== "header")
-            errors.push(
-              `@WebSocketRoute.${StringUtil.capitalize(p.category)}() has not been supported yet. How about upgrading the nestia packages?`,
-            );
-          return null;
-        }
-      })
-      .filter((p): p is IReflectWebSocketOperationParameter => !!p);
-
-    const fields: string[] = preconfigured
-      .filter((p) => p.category === "param")
-      .map((p) => p.field ?? "")
-      .filter((field): field is string => !!field?.length)
-      .sort();
-    for (const cLoc of ctx.controller.paths)
-      for (const mLoc of route.paths) {
-        const location: string = PathAnalyzer.join(cLoc, mLoc);
-        if (location.includes("*")) continue;
-
-        const binded: string[] | null = PathAnalyzer.parameters(location);
-        if (binded === null)
-          errors.push(`invalid path (${JSON.stringify(location)})`);
-        else if (ranges.equal(binded.sort(), fields) === false)
-          errors.push(
-            `binded arguments in the "path" between function's decorator and parameters' decorators are different (function: [${binded.join(
-              ", ",
-            )}], parameters: [${fields.join(", ")}]).`,
-          );
-      }
-    if (errors.length) {
-      ctx.project.errors.push({
-        file: ctx.controller.file,
-        class: ctx.controller.class.name,
-        function: ctx.function.name,
-        from: ctx.name,
-        contents: errors,
-      });
-      return null;
-    }
-    return {
-      protocol: "websocket",
-      name: ctx.name,
-      paths: route.paths,
-      function: ctx.function,
-      versions: ReflectMetadataAnalyzer.versions(ctx.function),
-      parameters,
-      imports: ImportAnalyzer.merge(imports),
-      description: ctx.metadata.description ?? null,
-      jsDocTags: ctx.metadata.jsDocTags,
-    };
-  };
-}
+import { ranges } from "tstl";
+
+import { INestiaProject } from "../structures/INestiaProject";
+import { IReflectController } from "../structures/IReflectController";
+import { IReflectImport } from "../structures/IReflectImport";
+import { IReflectWebSocketOperation } from "../structures/IReflectWebSocketOperation";
+import { IReflectWebSocketOperationParameter } from "../structures/IReflectWebSocketOperationParameter";
+import { IOperationMetadata } from "../transformers/IOperationMetadata";
+import { StringUtil } from "../utils/StringUtil";
+import { ImportAnalyzer } from "./ImportAnalyzer";
+import { PathAnalyzer } from "./PathAnalyzer";
+import { ReflectMetadataAnalyzer } from "./ReflectMetadataAnalyzer";
+
+export namespace ReflectWebSocketOperationAnalyzer {
+  export interface IProps {
+    project: Omit<INestiaProject, "config">;
+    controller: IReflectController;
+    function: Function;
+    name: string;
+    metadata: IOperationMetadata;
+  }
+  export const analyze = (ctx: IProps): IReflectWebSocketOperation | null => {
+    const route: { paths: string[] } | undefined = Reflect.getMetadata(
+      "nestia/WebSocketRoute",
+      ctx.function,
+    );
+    if (route === undefined) return null;
+
+    // @todo -> detailing is required
+    const errors: string[] = [];
+    const preconfigured: IReflectWebSocketOperationParameter.IPreconfigured[] =
+      (
+        (Reflect.getMetadata(
+          "nestia/WebSocketRoute/Parameters",
+          ctx.controller.class.prototype,
+          ctx.name,
+        ) ?? []) as IReflectWebSocketOperationParameter[]
+      ).sort((a, b) => a.index - b.index);
+    if (preconfigured.find((p) => (p.category === "acceptor") === undefined))
+      errors.push("@WebSocketRoute.Acceptor() is essentially required");
+    if (preconfigured.length !== ctx.function.length)
+      errors.push(
+        [
+          "Every parameters must be one of below:",
+          "  - @WebSocketRoute.Acceptor()",
+          "  - @WebSocketRoute.Driver()",
+          "  - @WebSocketRoute.Header()",
+          "  - @WebSocketRoute.Param()",
+          "  - @WebSocketRoute.Query()",
+        ].join("\n"),
+      );
+
+    const imports: IReflectImport[] = [];
+    const parameters: IReflectWebSocketOperationParameter[] = preconfigured
+      .map((p) => {
+        // METADATA INFO
+        const matched: IOperationMetadata.IParameter | undefined =
+          ctx.metadata.parameters.find((m) => p.index === m.index);
+
+        // VALIDATE PARAMETER
+        if (matched === undefined)
+          return errors.push(
+            `Unable to find parameter type of the ${p.index} (th).`,
+          );
+        else if (matched.type === null)
+          return errors.push(
+            `Failed to analyze the parameter type of the ${JSON.stringify(matched.name)}.`,
+          );
+        else if (
+          p.category === "param" &&
+          !(p as IReflectWebSocketOperationParameter.IParam).field?.length
+        )
+          return errors.push(`@WebSocketRoute.Param() must have a field name.`);
+        else if (
+          p.category === "acceptor" &&
+          matched.type?.typeArguments?.length !== 3
+        )
+          return `@WebSocketRoute.Acceptor() must have three type arguments.`;
+        else if (
+          p.category === "driver" &&
+          matched.type?.typeArguments?.length !== 1
+        )
+          return errors.push(
+            `@WebSocketRoute.Driver() must have one type argument.`,
+          );
+
+        // COMPLETE COMPOSITION
+        imports.push(
+          ...matched.imports.filter(
+            (i) =>
+              !(
+                i.file.includes("tgrid/lib") &&
+                (i.file.endsWith("Driver.d.ts") ||
+                  i.file.endsWith("WebSocketAcceptor.d.ts"))
+              ),
+          ),
+        );
+        if (
+          p.category === "acceptor" ||
+          p.category === "driver" ||
+          p.category === "query"
+        )
+          return {
+            ...p,
+            name: matched.name,
+            type: matched.type,
+          };
+        else if (p.category === "param")
+          return {
+            ...p,
+            category: "param",
+            field: p.field!,
+            name: matched.name,
+            type: matched.type,
+            imports: matched.imports,
+            description: matched.description,
+            jsDocTags: matched.jsDocTags,
+          } satisfies IReflectWebSocketOperationParameter.IParam;
+        // UNKNOWN TYPE, MAYBE NEW FEATURE
+        else {
+          if (p.category !== "header")
+            errors.push(
+              `@WebSocketRoute.${StringUtil.capitalize(p.category)}() has not been supported yet. How about upgrading the nestia packages?`,
+            );
+          return null;
+        }
+      })
+      .filter((p): p is IReflectWebSocketOperationParameter => !!p);
+
+    const fields: string[] = preconfigured
+      .filter((p) => p.category === "param")
+      .map((p) => p.field ?? "")
+      .filter((field): field is string => !!field?.length)
+      .sort();
+    for (const cLoc of ctx.controller.paths)
+      for (const mLoc of route.paths) {
+        const location: string = PathAnalyzer.join(cLoc, mLoc);
+        if (location.includes("*")) continue;
+
+        const binded: string[] | null = PathAnalyzer.parameters(location);
+        if (binded === null)
+          errors.push(`invalid path (${JSON.stringify(location)})`);
+        else if (ranges.equal(binded.sort(), fields) === false)
+          errors.push(
+            `binded arguments in the "path" between function's decorator and parameters' decorators are different (function: [${binded.join(
+              ", ",
+            )}], parameters: [${fields.join(", ")}]).`,
+          );
+      }
+    if (errors.length) {
+      ctx.project.errors.push({
+        file: ctx.controller.file,
+        class: ctx.controller.class.name,
+        function: ctx.function.name,
+        from: ctx.name,
+        contents: errors,
+      });
+      return null;
+    }
+    return {
+      protocol: "websocket",
+      name: ctx.name,
+      paths: route.paths,
+      function: ctx.function,
+      versions: ReflectMetadataAnalyzer.versions(ctx.function),
+      parameters,
+      imports: ImportAnalyzer.merge(imports),
+      description: ctx.metadata.description ?? null,
+      jsDocTags: ctx.metadata.jsDocTags,
+    };
+  };
+}