@nestia/sdk 3.1.0-dev.20240429 → 3.1.0-dev.20240430

package/src/analyses/ConfigAnalyzer.ts

@@ -1,147 +1,147 @@
-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 path from "path";
-import { HashMap, Pair, Singleton } from "tstl";
-
-import { INestiaConfig } from "../INestiaConfig";
-import { SdkGenerator } from "../generates/SdkGenerator";
-import { INormalizedInput } from "../structures/INormalizedInput";
-import { ArrayUtil } from "../utils/ArrayUtil";
-import { MapUtil } from "../utils/MapUtil";
-import { SourceFinder } from "../utils/SourceFinder";
-
-export namespace ConfigAnalyzer {
-  export const input = (config: INestiaConfig): Promise<INormalizedInput> =>
-    MapUtil.take(memory, config, async () => {
-      const input = config.input;
-      if (Array.isArray(input)) return transform_input(config)(input);
-      else if (typeof input === "function")
-        return analyze_application(await input());
-      else if (typeof input === "object")
-        if (input === null)
-          throw new Error("Invalid input config. It can't be null.");
-        else return transform_input(config)(input.include, input.exclude);
-      else if (typeof input === "string")
-        return transform_input(config)([input]);
-      else throw new Error("Invalid input config.");
-    });
-
-  const analyze_application = async (
-    app: INestApplication,
-  ): Promise<INormalizedInput> => {
-    const files: HashMap<Pair<Function, string>, Set<string>> = new HashMap();
-    const container: NestContainer = (app as any).container as NestContainer;
-    const modules: Module[] = [...container.getModules().values()].filter(
-      (m) => !!m.controllers.size,
-    );
-    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()]) {
-        const file: string | null =
-          (await require("get-function-location")(controller))?.source ?? null;
-        if (file === null) continue;
-
-        const location: string = normalize_file(file);
-        if (location.length === 0) continue;
-
-        const key: Pair<Function, string> = new Pair(
-          controller as Function,
-          location,
-        );
-        files.take(key, () => new Set([])).add(path);
-      }
-    }
-
-    const versioning = (app as any).config?.versioningOptions;
-    return {
-      include: files.toJSON().map((pair) => ({
-        controller: pair.first.first,
-        file: decodeURIComponent(pair.first.second),
-        paths: [...pair.second.values()],
-      })),
-      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 normalize_file = (str: string) =>
-    str.substring(
-      str.startsWith("file:///")
-        ? process.cwd()[0] === "/"
-          ? 7
-          : 8
-        : str.startsWith("file://")
-          ? 7
-          : 0,
-    );
-
-  const transform_input =
-    (config: INestiaConfig) =>
-    async (include: string[], exclude?: string[]) => ({
-      include: (
-        await SourceFinder.find({
-          include,
-          exclude,
-          filter: filter(config),
-        })
-      ).map((file) => ({
-        paths: [""],
-        file,
-      })),
-    });
-
-  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 memory = new Map<INestiaConfig, Promise<INormalizedInput>>();
-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;
-  };
-});
+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 path from "path";
+import { HashMap, Pair, Singleton } from "tstl";
+
+import { INestiaConfig } from "../INestiaConfig";
+import { SdkGenerator } from "../generates/SdkGenerator";
+import { INormalizedInput } from "../structures/INormalizedInput";
+import { ArrayUtil } from "../utils/ArrayUtil";
+import { MapUtil } from "../utils/MapUtil";
+import { SourceFinder } from "../utils/SourceFinder";
+
+export namespace ConfigAnalyzer {
+  export const input = (config: INestiaConfig): Promise<INormalizedInput> =>
+    MapUtil.take(memory, config, async () => {
+      const input = config.input;
+      if (Array.isArray(input)) return transform_input(config)(input);
+      else if (typeof input === "function")
+        return analyze_application(await input());
+      else if (typeof input === "object")
+        if (input === null)
+          throw new Error("Invalid input config. It can't be null.");
+        else return transform_input(config)(input.include, input.exclude);
+      else if (typeof input === "string")
+        return transform_input(config)([input]);
+      else throw new Error("Invalid input config.");
+    });
+
+  const analyze_application = async (
+    app: INestApplication,
+  ): Promise<INormalizedInput> => {
+    const files: HashMap<Pair<Function, string>, Set<string>> = new HashMap();
+    const container: NestContainer = (app as any).container as NestContainer;
+    const modules: Module[] = [...container.getModules().values()].filter(
+      (m) => !!m.controllers.size,
+    );
+    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()]) {
+        const file: string | null =
+          (await require("get-function-location")(controller))?.source ?? null;
+        if (file === null) continue;
+
+        const location: string = normalize_file(file);
+        if (location.length === 0) continue;
+
+        const key: Pair<Function, string> = new Pair(
+          controller as Function,
+          location,
+        );
+        files.take(key, () => new Set([])).add(path);
+      }
+    }
+
+    const versioning = (app as any).config?.versioningOptions;
+    return {
+      include: files.toJSON().map((pair) => ({
+        controller: pair.first.first,
+        file: decodeURIComponent(pair.first.second),
+        paths: [...pair.second.values()],
+      })),
+      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 normalize_file = (str: string) =>
+    str.substring(
+      str.startsWith("file:///")
+        ? process.cwd()[0] === "/"
+          ? 7
+          : 8
+        : str.startsWith("file://")
+          ? 7
+          : 0,
+    );
+
+  const transform_input =
+    (config: INestiaConfig) =>
+    async (include: string[], exclude?: string[]) => ({
+      include: (
+        await SourceFinder.find({
+          include,
+          exclude,
+          filter: filter(config),
+        })
+      ).map((file) => ({
+        paths: [""],
+        file,
+      })),
+    });
+
+  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 memory = new Map<INestiaConfig, Promise<INormalizedInput>>();
+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/GenericAnalyzer.ts

@@ -1,51 +1,51 @@
-import ts from "typescript";
-
-export namespace GenericAnalyzer {
-  export type Dictionary = WeakMap<ts.Type, ts.Type>;
-
-  export function analyze(
-    checker: ts.TypeChecker,
-    classNode: ts.ClassDeclaration,
-  ): Dictionary {
-    const dict: Dictionary = new WeakMap();
-    explore(checker, dict, classNode);
-    return dict;
-  }
-
-  function explore(
-    checker: ts.TypeChecker,
-    dict: Dictionary,
-    classNode: ts.ClassDeclaration,
-  ): void {
-    if (classNode.heritageClauses === undefined) return;
-
-    for (const heritage of classNode.heritageClauses)
-      for (const hType of heritage.types) {
-        // MUST BE CLASS
-        const expression: ts.Type = checker.getTypeAtLocation(hType.expression);
-        const superNode: ts.Declaration | undefined =
-          expression.symbol.getDeclarations()?.[0];
-
-        if (superNode === undefined || !ts.isClassDeclaration(superNode))
-          continue;
-
-        // SPECIFY GENERICS
-        const usages: ReadonlyArray<ts.TypeNode> = hType.typeArguments || [];
-        const parameters: ReadonlyArray<ts.TypeParameterDeclaration> =
-          superNode.typeParameters || [];
-
-        parameters.forEach((param, index) => {
-          const paramType: ts.Type = checker.getTypeAtLocation(param);
-          const usageType: ts.Type =
-            usages[index] !== undefined
-              ? checker.getTypeAtLocation(usages[index])
-              : checker.getTypeAtLocation(param.default!);
-
-          dict.set(paramType, usageType);
-        });
-
-        // RECUSRIVE EXPLORATION
-        explore(checker, dict, superNode);
-      }
-  }
-}
+import ts from "typescript";
+
+export namespace GenericAnalyzer {
+  export type Dictionary = WeakMap<ts.Type, ts.Type>;
+
+  export function analyze(
+    checker: ts.TypeChecker,
+    classNode: ts.ClassDeclaration,
+  ): Dictionary {
+    const dict: Dictionary = new WeakMap();
+    explore(checker, dict, classNode);
+    return dict;
+  }
+
+  function explore(
+    checker: ts.TypeChecker,
+    dict: Dictionary,
+    classNode: ts.ClassDeclaration,
+  ): void {
+    if (classNode.heritageClauses === undefined) return;
+
+    for (const heritage of classNode.heritageClauses)
+      for (const hType of heritage.types) {
+        // MUST BE CLASS
+        const expression: ts.Type = checker.getTypeAtLocation(hType.expression);
+        const superNode: ts.Declaration | undefined =
+          expression.symbol.getDeclarations()?.[0];
+
+        if (superNode === undefined || !ts.isClassDeclaration(superNode))
+          continue;
+
+        // SPECIFY GENERICS
+        const usages: ReadonlyArray<ts.TypeNode> = hType.typeArguments || [];
+        const parameters: ReadonlyArray<ts.TypeParameterDeclaration> =
+          superNode.typeParameters || [];
+
+        parameters.forEach((param, index) => {
+          const paramType: ts.Type = checker.getTypeAtLocation(param);
+          const usageType: ts.Type =
+            usages[index] !== undefined
+              ? checker.getTypeAtLocation(usages[index])
+              : checker.getTypeAtLocation(param.default!);
+
+          dict.set(paramType, usageType);
+        });
+
+        // RECUSRIVE EXPLORATION
+        explore(checker, dict, superNode);
+      }
+  }
+}

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/SecurityAnalyzer.ts

@@ -1,25 +1,25 @@
-import { MapUtil } from "../utils/MapUtil";
-
-export namespace SecurityAnalyzer {
-  export const merge = (...entire: Record<string, string[]>[]) => {
-    const dict: Map<string | typeof none, Set<string>> = new Map();
-    for (const obj of entire) {
-      const entries = Object.entries(obj);
-      for (const [key, value] of entries) {
-        const set = MapUtil.take(dict, key, () => new Set());
-        for (const val of value) set.add(val);
-      }
-      if (entries.length === 0) MapUtil.take(dict, none, () => new Set());
-    }
-    const output: Record<string, string[]>[] = [];
-    for (const [key, set] of dict)
-      key === none
-        ? output.push({})
-        : output.push({
-            [key]: [...set],
-          });
-    return output;
-  };
-
-  const none = Symbol("none");
-}
+import { MapUtil } from "../utils/MapUtil";
+
+export namespace SecurityAnalyzer {
+  export const merge = (...entire: Record<string, string[]>[]) => {
+    const dict: Map<string | typeof none, Set<string>> = new Map();
+    for (const obj of entire) {
+      const entries = Object.entries(obj);
+      for (const [key, value] of entries) {
+        const set = MapUtil.take(dict, key, () => new Set());
+        for (const val of value) set.add(val);
+      }
+      if (entries.length === 0) MapUtil.take(dict, none, () => new Set());
+    }
+    const output: Record<string, string[]>[] = [];
+    for (const [key, set] of dict)
+      key === none
+        ? output.push({})
+        : output.push({
+            [key]: [...set],
+          });
+    return output;
+  };
+
+  const none = Symbol("none");
+}

package/src/analyses/TypedWebSocketOperationAnalyzer.ts

@@ -87,6 +87,7 @@ export namespace TypedWebSocketOperationAnalyzer {
           }`;
         })(),
         description: CommentFactory.description(props.symbol),
+        jsDocTags,
       };
 
       // CONFIGURE PATHS

package/src/executable/internal/CommandParser.ts

@@ -1,15 +1,15 @@
-export namespace CommandParser {
-  export function parse(argList: string[]): Record<string, string> {
-    const output: Record<string, string> = {};
-    argList.forEach((arg, i) => {
-      if (arg.startsWith("--") === false) return;
-
-      const key = arg.slice(2);
-      const value: string | undefined = argList[i + 1];
-      if (value === undefined || value.startsWith("--")) return;
-
-      output[key] = value;
-    });
-    return output;
-  }
-}
+export namespace CommandParser {
+  export function parse(argList: string[]): Record<string, string> {
+    const output: Record<string, string> = {};
+    argList.forEach((arg, i) => {
+      if (arg.startsWith("--") === false) return;
+
+      const key = arg.slice(2);
+      const value: string | undefined = argList[i + 1];
+      if (value === undefined || value.startsWith("--")) return;
+
+      output[key] = value;
+    });
+    return output;
+  }
+}