@nestia/sdk 1.3.1 → 1.3.3

package/src/analyses/ControllerAnalyzer.ts

@@ -1,261 +1,261 @@
-import { HashMap } from "tstl/container/HashMap";
-import ts from "typescript";
-
-import { CommentFactory } from "typia/lib/factories/CommentFactory";
-
-import { IController } from "../structures/IController";
-import { IRoute } from "../structures/IRoute";
-import { ITypeTuple } from "../structures/ITypeTuple";
-import { GenericAnalyzer } from "./GenericAnalyzer";
-import { ImportAnalyzer } from "./ImportAnalyzer";
-import { PathAnalyzer } from "./PathAnalyzer";
-
-export namespace ControllerAnalyzer {
-    export function analyze(
-        checker: ts.TypeChecker,
-        sourceFile: ts.SourceFile,
-        controller: IController,
-    ): IRoute[] {
-        // FIND CONTROLLER CLASS
-        const ret: IRoute[] = [];
-        ts.forEachChild(sourceFile, (node) => {
-            if (
-                ts.isClassDeclaration(node) &&
-                node.name?.escapedText === controller.name
-            ) {
-                // ANALYZE THE CONTROLLER
-                ret.push(..._Analyze_controller(checker, controller, node));
-                return;
-            }
-        });
-        return ret;
-    }
-
-    /* ---------------------------------------------------------
-        CLASS
-    --------------------------------------------------------- */
-    function _Analyze_controller(
-        checker: ts.TypeChecker,
-        controller: IController,
-        classNode: ts.ClassDeclaration,
-    ): IRoute[] {
-        const classType: ts.InterfaceType = checker.getTypeAtLocation(
-            classNode,
-        ) as ts.InterfaceType;
-        const genericDict: GenericAnalyzer.Dictionary = GenericAnalyzer.analyze(
-            checker,
-            classNode,
-        );
-
-        const ret: IRoute[] = [];
-        for (const property of classType.getProperties()) {
-            // GET METHOD DECLARATION
-            const declaration: ts.Declaration | undefined =
-                (property.declarations || [])[0];
-            if (!declaration || !ts.isMethodDeclaration(declaration)) continue;
-
-            // IDENTIFIER MUST BE
-            const identifier = declaration.name;
-            if (!ts.isIdentifier(identifier)) continue;
-
-            // ANALYZED WITH THE REFLECTED-FUNCTION
-            const runtime: IController.IFunction | undefined =
-                controller.functions.find(
-                    (f) => f.name === identifier.escapedText,
-                );
-            if (runtime === undefined) continue;
-
-            const routes: IRoute[] = _Analyze_function(
-                checker,
-                controller,
-                genericDict,
-                runtime,
-                property,
-            );
-            ret.push(...routes);
-        }
-        return ret;
-    }
-
-    /* ---------------------------------------------------------
-        FUNCTION
-    --------------------------------------------------------- */
-    function _Analyze_function(
-        checker: ts.TypeChecker,
-        controller: IController,
-        genericDict: GenericAnalyzer.Dictionary,
-        func: IController.IFunction,
-        symbol: ts.Symbol,
-    ): IRoute[] {
-        // PREPARE ASSETS
-        const type: ts.Type = checker.getTypeOfSymbolAtLocation(
-            symbol,
-            symbol.valueDeclaration!,
-        );
-        const signature: ts.Signature | undefined = checker.getSignaturesOfType(
-            type,
-            ts.SignatureKind.Call,
-        )[0];
-
-        if (signature === undefined)
-            throw new Error(
-                `Error on ControllerAnalyzer.analyze(): unable to get the signature from the ${controller.name}.${func.name}().`,
-            );
-
-        const importDict: ImportAnalyzer.Dictionary = new HashMap();
-
-        // EXPLORE CHILDREN TYPES
-        const parameters: IRoute.IParameter[] = func.parameters.map((param) =>
-            _Analyze_parameter(
-                checker,
-                genericDict,
-                importDict,
-                controller,
-                func.name,
-                param,
-                signature.getParameters()[param.index],
-            ),
-        );
-        const output: ITypeTuple | null = ImportAnalyzer.analyze(
-            checker,
-            genericDict,
-            importDict,
-            signature.getReturnType(),
-        );
-        if (output === null)
-            throw new Error(
-                `Error on ControllerAnalyzer.analyze(): unnamed return type from ${controller.name}.${func.name}().`,
-            );
-
-        const imports: [string, string[]][] = importDict
-            .toJSON()
-            .map((pair) => [pair.first, pair.second.toJSON()]);
-
-        // CONSTRUCT COMMON DATA
-        const tags = signature.getJsDocTags();
-        const common: Omit<IRoute, "path"> = {
-            ...func,
-            parameters,
-            output,
-            imports,
-            status: func.status,
-
-            symbol: `${controller.name}.${func.name}()`,
-            description: CommentFactory.description(symbol),
-            tags,
-            setHeaders: tags
-                .filter(
-                    (t) =>
-                        t.text?.length &&
-                        t.text[0].text &&
-                        (t.name === "setHeader" || t.name === "assignHeaders"),
-                )
-                .map((t) =>
-                    t.name === "setHeader"
-                        ? {
-                              type: "setter",
-                              source: t.text![0].text.split(" ")[0].trim(),
-                              target: t.text![0].text.split(" ")[1]?.trim(),
-                          }
-                        : {
-                              type: "assigner",
-                              source: t.text![0].text,
-                          },
-                ),
-        };
-
-        // CONFIGURE PATHS
-        const pathList: string[] = [];
-        for (const controllerPath of controller.paths)
-            for (const filePath of func.paths) {
-                const path: string = PathAnalyzer.join(
-                    controllerPath,
-                    filePath,
-                );
-                pathList.push(
-                    PathAnalyzer.espace(
-                        path,
-                        () => "ControllerAnalyzer.analyze()",
-                    ),
-                );
-            }
-
-        // RETURNS
-        return pathList.map((path) => ({
-            ...common,
-            path,
-        }));
-    }
-
-    /* ---------------------------------------------------------
-        PARAMETER
-    --------------------------------------------------------- */
-    function _Analyze_parameter(
-        checker: ts.TypeChecker,
-        genericDict: GenericAnalyzer.Dictionary,
-        importDict: ImportAnalyzer.Dictionary,
-        controller: IController,
-        funcName: string,
-        param: IController.IParameter,
-        symbol: ts.Symbol,
-    ): IRoute.IParameter {
-        const type: ts.Type = checker.getTypeOfSymbolAtLocation(
-            symbol,
-            symbol.valueDeclaration!,
-        );
-        const name: string = symbol.getEscapedName().toString();
-        const method: string = `${controller.name}.${funcName}()`;
-
-        const optional: boolean = !!checker.symbolToParameterDeclaration(
-            symbol,
-            undefined,
-            undefined,
-        )?.questionToken;
-
-        // DO NOT SUPPORT BODY PARAMETER
-        if (param.category === "body" && param.field !== undefined)
-            throw new Error(
-                `Error on ${method}: nestia does not support body field specification. ` +
-                    `Therefore, erase the ${method}#${name} parameter and ` +
-                    `re-define a new body decorator accepting full structured message.`,
-            );
-        else if (optional === true && param.category !== "query")
-            throw new Error(
-                `Error on ${method}: nestia does not support optional parameter except query parameter. ` +
-                    `Therefore, erase question mark on ${method}#${name} parameter, ` +
-                    `or re-define a new method without the "name" parameter.`,
-            );
-        else if (
-            optional === true &&
-            param.category === "query" &&
-            param.field === undefined
-        )
-            throw new Error(
-                `Error on ${method}: nestia does not support optional query parameter without field specification. ` +
-                    `Therefore, erase question mark on ${method}#${name} parameter, ` +
-                    `or re-define re-define parameters for each query parameters.`,
-            );
-
-        // GET TYPE NAME
-        const tuple: ITypeTuple | null = ImportAnalyzer.analyze(
-            checker,
-            genericDict,
-            importDict,
-            type,
-        );
-        if (tuple === null)
-            throw new Error(
-                `Error on ${method}: unnamed parameter type from ${method}#${name}.`,
-            );
-
-        return {
-            name,
-            category: param.category,
-            field: param.field,
-            encrypted: param.encrypted,
-            type: tuple,
-            optional,
-            meta: param.meta,
-        };
-    }
-}
+import { HashMap } from "tstl/container/HashMap";
+import ts from "typescript";
+
+import { CommentFactory } from "typia/lib/factories/CommentFactory";
+
+import { IController } from "../structures/IController";
+import { IRoute } from "../structures/IRoute";
+import { ITypeTuple } from "../structures/ITypeTuple";
+import { GenericAnalyzer } from "./GenericAnalyzer";
+import { ImportAnalyzer } from "./ImportAnalyzer";
+import { PathAnalyzer } from "./PathAnalyzer";
+
+export namespace ControllerAnalyzer {
+    export function analyze(
+        checker: ts.TypeChecker,
+        sourceFile: ts.SourceFile,
+        controller: IController,
+    ): IRoute[] {
+        // FIND CONTROLLER CLASS
+        const ret: IRoute[] = [];
+        ts.forEachChild(sourceFile, (node) => {
+            if (
+                ts.isClassDeclaration(node) &&
+                node.name?.escapedText === controller.name
+            ) {
+                // ANALYZE THE CONTROLLER
+                ret.push(..._Analyze_controller(checker, controller, node));
+                return;
+            }
+        });
+        return ret;
+    }
+
+    /* ---------------------------------------------------------
+        CLASS
+    --------------------------------------------------------- */
+    function _Analyze_controller(
+        checker: ts.TypeChecker,
+        controller: IController,
+        classNode: ts.ClassDeclaration,
+    ): IRoute[] {
+        const classType: ts.InterfaceType = checker.getTypeAtLocation(
+            classNode,
+        ) as ts.InterfaceType;
+        const genericDict: GenericAnalyzer.Dictionary = GenericAnalyzer.analyze(
+            checker,
+            classNode,
+        );
+
+        const ret: IRoute[] = [];
+        for (const property of classType.getProperties()) {
+            // GET METHOD DECLARATION
+            const declaration: ts.Declaration | undefined =
+                (property.declarations || [])[0];
+            if (!declaration || !ts.isMethodDeclaration(declaration)) continue;
+
+            // IDENTIFIER MUST BE
+            const identifier = declaration.name;
+            if (!ts.isIdentifier(identifier)) continue;
+
+            // ANALYZED WITH THE REFLECTED-FUNCTION
+            const runtime: IController.IFunction | undefined =
+                controller.functions.find(
+                    (f) => f.name === identifier.escapedText,
+                );
+            if (runtime === undefined) continue;
+
+            const routes: IRoute[] = _Analyze_function(
+                checker,
+                controller,
+                genericDict,
+                runtime,
+                property,
+            );
+            ret.push(...routes);
+        }
+        return ret;
+    }
+
+    /* ---------------------------------------------------------
+        FUNCTION
+    --------------------------------------------------------- */
+    function _Analyze_function(
+        checker: ts.TypeChecker,
+        controller: IController,
+        genericDict: GenericAnalyzer.Dictionary,
+        func: IController.IFunction,
+        symbol: ts.Symbol,
+    ): IRoute[] {
+        // PREPARE ASSETS
+        const type: ts.Type = checker.getTypeOfSymbolAtLocation(
+            symbol,
+            symbol.valueDeclaration!,
+        );
+        const signature: ts.Signature | undefined = checker.getSignaturesOfType(
+            type,
+            ts.SignatureKind.Call,
+        )[0];
+
+        if (signature === undefined)
+            throw new Error(
+                `Error on ControllerAnalyzer.analyze(): unable to get the signature from the ${controller.name}.${func.name}().`,
+            );
+
+        const importDict: ImportAnalyzer.Dictionary = new HashMap();
+
+        // EXPLORE CHILDREN TYPES
+        const parameters: IRoute.IParameter[] = func.parameters.map((param) =>
+            _Analyze_parameter(
+                checker,
+                genericDict,
+                importDict,
+                controller,
+                func.name,
+                param,
+                signature.getParameters()[param.index],
+            ),
+        );
+        const output: ITypeTuple | null = ImportAnalyzer.analyze(
+            checker,
+            genericDict,
+            importDict,
+            signature.getReturnType(),
+        );
+        if (output === null)
+            throw new Error(
+                `Error on ControllerAnalyzer.analyze(): unnamed return type from ${controller.name}.${func.name}().`,
+            );
+
+        const imports: [string, string[]][] = importDict
+            .toJSON()
+            .map((pair) => [pair.first, pair.second.toJSON()]);
+
+        // CONSTRUCT COMMON DATA
+        const tags = signature.getJsDocTags();
+        const common: Omit<IRoute, "path"> = {
+            ...func,
+            parameters,
+            output,
+            imports,
+            status: func.status,
+
+            symbol: `${controller.name}.${func.name}()`,
+            description: CommentFactory.description(symbol),
+            tags,
+            setHeaders: tags
+                .filter(
+                    (t) =>
+                        t.text?.length &&
+                        t.text[0].text &&
+                        (t.name === "setHeader" || t.name === "assignHeaders"),
+                )
+                .map((t) =>
+                    t.name === "setHeader"
+                        ? {
+                              type: "setter",
+                              source: t.text![0].text.split(" ")[0].trim(),
+                              target: t.text![0].text.split(" ")[1]?.trim(),
+                          }
+                        : {
+                              type: "assigner",
+                              source: t.text![0].text,
+                          },
+                ),
+        };
+
+        // CONFIGURE PATHS
+        const pathList: string[] = [];
+        for (const controllerPath of controller.paths)
+            for (const filePath of func.paths) {
+                const path: string = PathAnalyzer.join(
+                    controllerPath,
+                    filePath,
+                );
+                pathList.push(
+                    PathAnalyzer.espace(
+                        path,
+                        () => "ControllerAnalyzer.analyze()",
+                    ),
+                );
+            }
+
+        // RETURNS
+        return pathList.map((path) => ({
+            ...common,
+            path,
+        }));
+    }
+
+    /* ---------------------------------------------------------
+        PARAMETER
+    --------------------------------------------------------- */
+    function _Analyze_parameter(
+        checker: ts.TypeChecker,
+        genericDict: GenericAnalyzer.Dictionary,
+        importDict: ImportAnalyzer.Dictionary,
+        controller: IController,
+        funcName: string,
+        param: IController.IParameter,
+        symbol: ts.Symbol,
+    ): IRoute.IParameter {
+        const type: ts.Type = checker.getTypeOfSymbolAtLocation(
+            symbol,
+            symbol.valueDeclaration!,
+        );
+        const name: string = symbol.getEscapedName().toString();
+        const method: string = `${controller.name}.${funcName}()`;
+
+        const optional: boolean = !!checker.symbolToParameterDeclaration(
+            symbol,
+            undefined,
+            undefined,
+        )?.questionToken;
+
+        // DO NOT SUPPORT BODY PARAMETER
+        if (param.category === "body" && param.field !== undefined)
+            throw new Error(
+                `Error on ${method}: nestia does not support body field specification. ` +
+                    `Therefore, erase the ${method}#${name} parameter and ` +
+                    `re-define a new body decorator accepting full structured message.`,
+            );
+        else if (optional === true && param.category !== "query")
+            throw new Error(
+                `Error on ${method}: nestia does not support optional parameter except query parameter. ` +
+                    `Therefore, erase question mark on ${method}#${name} parameter, ` +
+                    `or re-define a new method without the "name" parameter.`,
+            );
+        else if (
+            optional === true &&
+            param.category === "query" &&
+            param.field === undefined
+        )
+            throw new Error(
+                `Error on ${method}: nestia does not support optional query parameter without field specification. ` +
+                    `Therefore, erase question mark on ${method}#${name} parameter, ` +
+                    `or re-define re-define parameters for each query parameters.`,
+            );
+
+        // GET TYPE NAME
+        const tuple: ITypeTuple | null = ImportAnalyzer.analyze(
+            checker,
+            genericDict,
+            importDict,
+            type,
+        );
+        if (tuple === null)
+            throw new Error(
+                `Error on ${method}: unnamed parameter type from ${method}#${name}.`,
+            );
+
+        return {
+            name,
+            category: param.category,
+            field: param.field,
+            encrypted: param.encrypted,
+            type: tuple,
+            optional,
+            meta: param.meta,
+        };
+    }
+}

package/src/analyses/GenericAnalyzer.ts

@@ -1,53 +1,53 @@
-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 =
-                    expression.symbol.getDeclarations()![0];
-
-                if (!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 =
+                    expression.symbol.getDeclarations()![0];
+
+                if (!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);
+            }
+    }
+}