@nestia/sdk 1.0.4 → 1.0.6

package/src/INestiaConfig.ts

@@ -1,147 +1,147 @@
-import ts from "typescript";
-
-import { ISwaggerDocument } from "./structures/ISwaggerDocument";
-import type { StripEnums } from "./utils/StripEnums";
-
-/**
- * Definition for the `nestia.config.ts` file.
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export interface INestiaConfig {
-    /**
-     * List of files or directories containing the NestJS controller classes.
-     */
-    input: string | string[] | INestiaConfig.IInput;
-
-    /**
-     * Output directory that SDK would be placed in.
-     *
-     * If not configured, you can't build the SDK library.
-     */
-    output?: string;
-
-    /**
-     * Compiler options for the TypeScript.
-     *
-     * If you've omitted this property or the assigned property cannot fully cover the
-     * `tsconfig.json`, the properties from the `tsconfig.json` would be assigned to here.
-     * Otherwise, this property has been configured and it's detailed values are different
-     * with the `tsconfig.json`, this property values would be used instead.
-     *
-     * ```typescript
-     * import ts from "typescript";
-     *
-     * const tsconfig: ts.TsConfig;
-     * const nestiaConfig: IConfiguration;
-     *
-     * const compilerOptions: ts.CompilerOptions = {
-     *     ...tsconfig.compilerOptions,
-     *     ...(nestiaConfig.compilerOptions || {})
-     * }
-     * ```
-     */
-    compilerOptions?: StripEnums<ts.CompilerOptions>;
-
-    /**
-     * Whether to assert parameter types or not.
-     *
-     * If you configure this property to be `true`, all of the function parameters
-     * would be checked through [typia](https://github.com/samchon/typia#runtime-validators).
-     * This option would make your SDK library slower, but would enahcne the type safety
-     * even in the runtime level.
-     *
-     * @default false
-     */
-    assert?: boolean;
-
-    /**
-     * Whether to optimize JSON string conversion 10x faster or not.
-     *
-     * If you configure this property to be `true`, the SDK library would utilize the
-     * [typia](https://github.com/samchon/typia#enhanced-json)
-     * and the JSON string conversion speed really be 10x faster.
-     *
-     * @default false
-     */
-    json?: boolean;
-
-    /**
-     * Whether to wrap DTO by primitive type.
-     *
-     * If you don't configure this property as `false`, all of DTOs in the
-     * SDK library would be automatically wrapped by {@link Primitive} type.
-     *
-     * For refenrece, if a DTO type be capsuled by the {@link Primitive} type,
-     * all of methods in the DTO type would be automatically erased. Also, if
-     * the DTO has a `toJSON()` method, the DTO type would be automatically
-     * converted to return type of the `toJSON()` method.
-     *
-     * @default true
-     */
-    primitive?: boolean;
-
-    /**
-     * Building `swagger.json` is also possible.
-     *
-     * If not specified, you can't build the `swagger.json`.
-     */
-    swagger?: INestiaConfig.ISwaggerConfig;
-}
-export namespace INestiaConfig {
-    /**
-     * List of files or directories to include or exclude to specifying the NestJS
-     * controllers.
-     */
-    export interface IInput {
-        /**
-         * List of files or directories containing the NestJS controller classes.
-         */
-        include: string[];
-
-        /**
-         * List of files or directories to be excluded.
-         */
-        exclude?: string[];
-    }
-
-    /**
-     * Building `swagger.json` is also possible.
-     */
-    export interface ISwaggerConfig {
-        /**
-         * Output path of the `swagger.json`.
-         *
-         * If you've configured only directory, the file name would be the `swagger.json`.
-         * Otherwise you've configured the full path with file name and extension, the
-         * `swagger.json` file would be renamed to it.
-         */
-        output: string;
-
-        /**
-         * Security schemes.
-         */
-        security?: Record<string, ISwaggerConfig.ISecurityScheme>;
-    }
-    export namespace ISwaggerConfig {
-        export type ISecurityScheme =
-            | IApiKey
-            | Exclude<
-                  ISwaggerDocument.ISecurityScheme,
-                  ISwaggerDocument.ISecurityScheme.IApiKey
-              >;
-        export interface IApiKey {
-            type: "apiKey";
-
-            /**
-             * @default header
-             */
-            in?: "header" | "query" | "cookie";
-
-            /**
-             * @default Authorization
-             */
-            name?: string;
-        }
-    }
-}
+import ts from "typescript";
+
+import { ISwaggerDocument } from "./structures/ISwaggerDocument";
+import type { StripEnums } from "./utils/StripEnums";
+
+/**
+ * Definition for the `nestia.config.ts` file.
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export interface INestiaConfig {
+    /**
+     * List of files or directories containing the NestJS controller classes.
+     */
+    input: string | string[] | INestiaConfig.IInput;
+
+    /**
+     * Output directory that SDK would be placed in.
+     *
+     * If not configured, you can't build the SDK library.
+     */
+    output?: string;
+
+    /**
+     * Compiler options for the TypeScript.
+     *
+     * If you've omitted this property or the assigned property cannot fully cover the
+     * `tsconfig.json`, the properties from the `tsconfig.json` would be assigned to here.
+     * Otherwise, this property has been configured and it's detailed values are different
+     * with the `tsconfig.json`, this property values would be used instead.
+     *
+     * ```typescript
+     * import ts from "typescript";
+     *
+     * const tsconfig: ts.TsConfig;
+     * const nestiaConfig: IConfiguration;
+     *
+     * const compilerOptions: ts.CompilerOptions = {
+     *     ...tsconfig.compilerOptions,
+     *     ...(nestiaConfig.compilerOptions || {})
+     * }
+     * ```
+     */
+    compilerOptions?: StripEnums<ts.CompilerOptions>;
+
+    /**
+     * Whether to assert parameter types or not.
+     *
+     * If you configure this property to be `true`, all of the function parameters
+     * would be checked through [typia](https://github.com/samchon/typia#runtime-validators).
+     * This option would make your SDK library slower, but would enahcne the type safety
+     * even in the runtime level.
+     *
+     * @default false
+     */
+    assert?: boolean;
+
+    /**
+     * Whether to optimize JSON string conversion 10x faster or not.
+     *
+     * If you configure this property to be `true`, the SDK library would utilize the
+     * [typia](https://github.com/samchon/typia#enhanced-json)
+     * and the JSON string conversion speed really be 10x faster.
+     *
+     * @default false
+     */
+    json?: boolean;
+
+    /**
+     * Whether to wrap DTO by primitive type.
+     *
+     * If you don't configure this property as `false`, all of DTOs in the
+     * SDK library would be automatically wrapped by {@link Primitive} type.
+     *
+     * For refenrece, if a DTO type be capsuled by the {@link Primitive} type,
+     * all of methods in the DTO type would be automatically erased. Also, if
+     * the DTO has a `toJSON()` method, the DTO type would be automatically
+     * converted to return type of the `toJSON()` method.
+     *
+     * @default true
+     */
+    primitive?: boolean;
+
+    /**
+     * Building `swagger.json` is also possible.
+     *
+     * If not specified, you can't build the `swagger.json`.
+     */
+    swagger?: INestiaConfig.ISwaggerConfig;
+}
+export namespace INestiaConfig {
+    /**
+     * List of files or directories to include or exclude to specifying the NestJS
+     * controllers.
+     */
+    export interface IInput {
+        /**
+         * List of files or directories containing the NestJS controller classes.
+         */
+        include: string[];
+
+        /**
+         * List of files or directories to be excluded.
+         */
+        exclude?: string[];
+    }
+
+    /**
+     * Building `swagger.json` is also possible.
+     */
+    export interface ISwaggerConfig {
+        /**
+         * Output path of the `swagger.json`.
+         *
+         * If you've configured only directory, the file name would be the `swagger.json`.
+         * Otherwise you've configured the full path with file name and extension, the
+         * `swagger.json` file would be renamed to it.
+         */
+        output: string;
+
+        /**
+         * Security schemes.
+         */
+        security?: Record<string, ISwaggerConfig.ISecurityScheme>;
+    }
+    export namespace ISwaggerConfig {
+        export type ISecurityScheme =
+            | IApiKey
+            | Exclude<
+                  ISwaggerDocument.ISecurityScheme,
+                  ISwaggerDocument.ISecurityScheme.IApiKey
+              >;
+        export interface IApiKey {
+            type: "apiKey";
+
+            /**
+             * @default header
+             */
+            in?: "header" | "query" | "cookie";
+
+            /**
+             * @default Authorization
+             */
+            name?: string;
+        }
+    }
+}

package/src/NestiaSdkApplication.ts

@@ -1,183 +1,183 @@
-import fs from "fs";
-import path from "path";
-import * as runner from "ts-node";
-import { Singleton } from "tstl/thread/Singleton";
-import { Pair } from "tstl/utility/Pair";
-import ts from "typescript";
-
-import { INestiaConfig } from "./INestiaConfig";
-import { ControllerAnalyzer } from "./analyses/ControllerAnalyzer";
-import { ReflectAnalyzer } from "./analyses/ReflectAnalyzer";
-import { SourceFinder } from "./analyses/SourceFinder";
-import { NestiaConfigCompilerOptions } from "./executable/internal/NestiaConfigCompilerOptions";
-import { SdkGenerator } from "./generates/SdkGenerator";
-import { SwaggerGenerator } from "./generates/SwaggerGenerator";
-import { IController } from "./structures/IController";
-import { IRoute } from "./structures/IRoute";
-import { ArrayUtil } from "./utils/ArrayUtil";
-
-export class NestiaSdkApplication {
-    private readonly config_: INestiaConfig;
-    private readonly bundle_checker_: Singleton<
-        Promise<(str: string) => boolean>
-    >;
-
-    public constructor(config: INestiaConfig) {
-        this.config_ = config;
-        this.bundle_checker_ = new Singleton(async () => {
-            if (!this.config_.output) return () => false;
-
-            const bundles: string[] = await fs.promises.readdir(
-                SdkGenerator.BUNDLE_PATH,
-            );
-            const tuples: Pair<string, boolean>[] = await ArrayUtil.asyncMap(
-                bundles,
-                async (file) => {
-                    const relative: string = path.join(
-                        this.config_.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 (file: string): 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;
-            };
-        });
-    }
-
-    public async sdk(): Promise<void> {
-        if (!this.config_.output)
-            throw new Error(
-                "Error on NestiaApplication.sdk(): output path is not specified.",
-            );
-
-        const parent: string = path.resolve(this.config_.output + "/..");
-        const stats: fs.Stats = await fs.promises.lstat(parent);
-        if (stats.isDirectory() === false)
-            throw new Error(
-                "Error on NestiaApplication.sdk(): output directory does not exists.",
-            );
-
-        await this.generate((config) => config, SdkGenerator.generate);
-    }
-
-    public async swagger(): Promise<void> {
-        if (!this.config_.swagger || !this.config_.swagger.output)
-            throw new Error(
-                `Error on NestiaApplication.swagger(): output path of the "swagger.json" is not specified.`,
-            );
-
-        const parsed: path.ParsedPath = path.parse(this.config_.swagger.output);
-        const directory: string = !!parsed.ext
-            ? path.resolve(parsed.dir)
-            : this.config_.swagger.output;
-        const stats: fs.Stats = await fs.promises.lstat(directory);
-        if (stats.isDirectory() === false)
-            throw new Error(
-                "Error on NestiaApplication.swagger(): output directory does not exists.",
-            );
-
-        await this.generate(
-            (config) => config.swagger!,
-            SwaggerGenerator.generate,
-        );
-    }
-
-    private async generate<Config>(
-        config: (entire: INestiaConfig) => Config,
-        archiver: (
-            checker: ts.TypeChecker,
-            config: Config,
-            routes: IRoute[],
-        ) => Promise<void>,
-    ): Promise<void> {
-        // MOUNT TS-NODE
-        this.prepare();
-
-        // LOAD CONTROLLER FILES
-        const input: INestiaConfig.IInput =
-            this.config_.input instanceof Array
-                ? { include: this.config_.input }
-                : typeof this.config_.input === "string"
-                ? { include: [this.config_.input] }
-                : this.config_.input;
-        const fileList: string[] = await ArrayUtil.asyncFilter(
-            await SourceFinder.find(input),
-            (file) => this.is_not_excluded(file),
-        );
-
-        // ANALYZE REFLECTS
-        const unique: WeakSet<any> = new WeakSet();
-        const controllerList: IController[] = [];
-
-        for (const file of fileList)
-            controllerList.push(
-                ...(await ReflectAnalyzer.analyze(unique, file)),
-            );
-
-        // ANALYZE TYPESCRIPT CODE
-        const program: ts.Program = ts.createProgram(
-            controllerList.map((c) => c.file),
-            this.config_.compilerOptions || { noEmit: true },
-        );
-        const checker: ts.TypeChecker = program.getTypeChecker();
-
-        const routeList: IRoute[] = [];
-        for (const controller of controllerList) {
-            const sourceFile: ts.SourceFile | undefined = program.getSourceFile(
-                controller.file,
-            );
-            if (sourceFile === undefined) continue;
-
-            routeList.push(
-                ...ControllerAnalyzer.analyze(checker, sourceFile, controller),
-            );
-        }
-
-        // DO GENERATE
-        await archiver(checker, config(this.config_), routeList);
-    }
-
-    private prepare(): void {
-        // CONSTRUCT OPTIONS
-        if (!this.config_.compilerOptions)
-            this.config_.compilerOptions =
-                NestiaConfigCompilerOptions.DEFAULT_OPTIONS as any;
-        const absoluted: boolean = !!this.config_.compilerOptions?.baseUrl;
-
-        // MOUNT TS-NODE
-        runner.register({
-            emit: false,
-            compiler: "ttypescript",
-            compilerOptions: this.config_.compilerOptions,
-            require: absoluted ? ["tsconfig-paths/register"] : undefined,
-        });
-    }
-
-    private async is_not_excluded(file: string): Promise<boolean> {
-        if (this.config_.output)
-            return (
-                file.indexOf(path.join(this.config_.output, "functional")) ===
-                    -1 && (await this.bundle_checker_.get())(file) === false
-            );
-
-        const content: string = await fs.promises.readFile(file, "utf8");
-        return (
-            content.indexOf(
-                " * @nestia Generated by Nestia - https://github.com/samchon/nestia",
-            ) === -1
-        );
-    }
-}
+import fs from "fs";
+import path from "path";
+import * as runner from "ts-node";
+import { Singleton } from "tstl/thread/Singleton";
+import { Pair } from "tstl/utility/Pair";
+import ts from "typescript";
+
+import { INestiaConfig } from "./INestiaConfig";
+import { ControllerAnalyzer } from "./analyses/ControllerAnalyzer";
+import { ReflectAnalyzer } from "./analyses/ReflectAnalyzer";
+import { SourceFinder } from "./analyses/SourceFinder";
+import { NestiaConfigCompilerOptions } from "./executable/internal/NestiaConfigCompilerOptions";
+import { SdkGenerator } from "./generates/SdkGenerator";
+import { SwaggerGenerator } from "./generates/SwaggerGenerator";
+import { IController } from "./structures/IController";
+import { IRoute } from "./structures/IRoute";
+import { ArrayUtil } from "./utils/ArrayUtil";
+
+export class NestiaSdkApplication {
+    private readonly config_: INestiaConfig;
+    private readonly bundle_checker_: Singleton<
+        Promise<(str: string) => boolean>
+    >;
+
+    public constructor(config: INestiaConfig) {
+        this.config_ = config;
+        this.bundle_checker_ = new Singleton(async () => {
+            if (!this.config_.output) return () => false;
+
+            const bundles: string[] = await fs.promises.readdir(
+                SdkGenerator.BUNDLE_PATH,
+            );
+            const tuples: Pair<string, boolean>[] = await ArrayUtil.asyncMap(
+                bundles,
+                async (file) => {
+                    const relative: string = path.join(
+                        this.config_.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 (file: string): 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;
+            };
+        });
+    }
+
+    public async sdk(): Promise<void> {
+        if (!this.config_.output)
+            throw new Error(
+                "Error on NestiaApplication.sdk(): output path is not specified.",
+            );
+
+        const parent: string = path.resolve(this.config_.output + "/..");
+        const stats: fs.Stats = await fs.promises.lstat(parent);
+        if (stats.isDirectory() === false)
+            throw new Error(
+                "Error on NestiaApplication.sdk(): output directory does not exists.",
+            );
+
+        await this.generate((config) => config, SdkGenerator.generate);
+    }
+
+    public async swagger(): Promise<void> {
+        if (!this.config_.swagger || !this.config_.swagger.output)
+            throw new Error(
+                `Error on NestiaApplication.swagger(): output path of the "swagger.json" is not specified.`,
+            );
+
+        const parsed: path.ParsedPath = path.parse(this.config_.swagger.output);
+        const directory: string = !!parsed.ext
+            ? path.resolve(parsed.dir)
+            : this.config_.swagger.output;
+        const stats: fs.Stats = await fs.promises.lstat(directory);
+        if (stats.isDirectory() === false)
+            throw new Error(
+                "Error on NestiaApplication.swagger(): output directory does not exists.",
+            );
+
+        await this.generate(
+            (config) => config.swagger!,
+            SwaggerGenerator.generate,
+        );
+    }
+
+    private async generate<Config>(
+        config: (entire: INestiaConfig) => Config,
+        archiver: (
+            checker: ts.TypeChecker,
+            config: Config,
+            routes: IRoute[],
+        ) => Promise<void>,
+    ): Promise<void> {
+        // MOUNT TS-NODE
+        this.prepare();
+
+        // LOAD CONTROLLER FILES
+        const input: INestiaConfig.IInput =
+            this.config_.input instanceof Array
+                ? { include: this.config_.input }
+                : typeof this.config_.input === "string"
+                ? { include: [this.config_.input] }
+                : this.config_.input;
+        const fileList: string[] = await ArrayUtil.asyncFilter(
+            await SourceFinder.find(input),
+            (file) => this.is_not_excluded(file),
+        );
+
+        // ANALYZE REFLECTS
+        const unique: WeakSet<any> = new WeakSet();
+        const controllerList: IController[] = [];
+
+        for (const file of fileList)
+            controllerList.push(
+                ...(await ReflectAnalyzer.analyze(unique, file)),
+            );
+
+        // ANALYZE TYPESCRIPT CODE
+        const program: ts.Program = ts.createProgram(
+            controllerList.map((c) => c.file),
+            this.config_.compilerOptions || { noEmit: true },
+        );
+        const checker: ts.TypeChecker = program.getTypeChecker();
+
+        const routeList: IRoute[] = [];
+        for (const controller of controllerList) {
+            const sourceFile: ts.SourceFile | undefined = program.getSourceFile(
+                controller.file,
+            );
+            if (sourceFile === undefined) continue;
+
+            routeList.push(
+                ...ControllerAnalyzer.analyze(checker, sourceFile, controller),
+            );
+        }
+
+        // DO GENERATE
+        await archiver(checker, config(this.config_), routeList);
+    }
+
+    private prepare(): void {
+        // CONSTRUCT OPTIONS
+        if (!this.config_.compilerOptions)
+            this.config_.compilerOptions =
+                NestiaConfigCompilerOptions.DEFAULT_OPTIONS as any;
+        const absoluted: boolean = !!this.config_.compilerOptions?.baseUrl;
+
+        // MOUNT TS-NODE
+        runner.register({
+            emit: false,
+            compiler: "ttypescript",
+            compilerOptions: this.config_.compilerOptions,
+            require: absoluted ? ["tsconfig-paths/register"] : undefined,
+        });
+    }
+
+    private async is_not_excluded(file: string): Promise<boolean> {
+        if (this.config_.output)
+            return (
+                file.indexOf(path.join(this.config_.output, "functional")) ===
+                    -1 && (await this.bundle_checker_.get())(file) === false
+            );
+
+        const content: string = await fs.promises.readFile(file, "utf8");
+        return (
+            content.indexOf(
+                " * @nestia Generated by Nestia - https://github.com/samchon/nestia",
+            ) === -1
+        );
+    }
+}