@nestia/sdk 2.0.0-dev.20230903 → 2.0.0-dev.20230904-2

package/src/INestiaConfig.ts

@@ -1,9 +1,6 @@
-import type ts from "typescript";
-
 import type { ISwagger } from "./structures/ISwagger";
 import { ISwaggerInfo } from "./structures/ISwaggerInfo";
 import { ISwaggerSecurityScheme } from "./structures/ISwaggerSecurityScheme";
-import type { StripEnums } from "./utils/StripEnums";
 
 /**
  * Definition for the `nestia.config.ts` file.
@@ -56,26 +53,43 @@ export interface INestiaConfig {
     e2e?: string;
 
     /**
-     * Compiler options for the TypeScript.
+     * 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;
+
+    /**
+     * Allow simulation mode.
      *
-     * 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.
+     * If you configure this property to be `true`, the SDK library would be contain
+     * simulation mode. In the simulation mode, the SDK library would not communicate
+     * with the real backend server, but just returns random mock-up data
+     * with requestion data validation.
      *
-     * ```typescript
-     * import ts from "typescript";
+     * For reference, random mock-up data would be generated by `typia.random<T>()`
+     * function.
      *
-     * const tsconfig: ts.TsConfig;
-     * const nestiaConfig: IConfiguration;
+     * @default false
+     */
+    simulate?: boolean;
+
+    /**
+     * Location of `tsconfig.json` file.
+     *
+     * If be configured, target file will replace the `tsconfig.json` file.
      *
-     * const compilerOptions: ts.CompilerOptions = {
-     *     ...tsconfig.compilerOptions,
-     *     ...(nestiaConfig.compilerOptions ?? {})
-     * }
-     * ```
+     * @default tsconfig.json
      */
-    compilerOptions?: StripEnums<ts.CompilerOptions>;
+    project?: string;
 
     /**
      * Whether to assert parameter types or not.
@@ -105,36 +119,6 @@ export interface INestiaConfig {
      * @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;
-
-    /**
-     * Allow simulation mode.
-     *
-     * If you configure this property to be `true`, the SDK library would be contain
-     * simulation mode. In the simulation mode, the SDK library would not communicate
-     * with the real backend server, but just returns random mock-up data
-     * with requestion data validation.
-     *
-     * For reference, random mock-up data would be generated by `typia.random<T>()`
-     * function.
-     *
-     * @default false
-     */
-    simulate?: boolean;
 }
 export namespace INestiaConfig {
     /**

package/src/NestiaSdkApplication.ts

@@ -1,6 +1,5 @@
 import fs from "fs";
 import path from "path";
-import * as runner from "ts-node";
 import { Pair, Singleton } from "tstl";
 import ts from "typescript";
 
@@ -8,7 +7,6 @@ import { INestiaConfig } from "./INestiaConfig";
 import { AccessorAnalyzer } from "./analyses/AccessorAnalyzer";
 import { ControllerAnalyzer } from "./analyses/ControllerAnalyzer";
 import { ReflectAnalyzer } from "./analyses/ReflectAnalyzer";
-import { NestiaConfigCompilerOptions } from "./executable/internal/NestiaConfigCompilerOptions";
 import { E2eGenerator } from "./generates/E2eGenerator";
 import { SdkGenerator } from "./generates/SdkGenerator";
 import { SwaggerGenerator } from "./generates/SwaggerGenerator";
@@ -19,13 +17,9 @@ import { NestiaConfigUtil } from "./utils/NestiaConfigUtil";
 import { SourceFinder } from "./utils/SourceFinder";
 
 export class NestiaSdkApplication {
-    private readonly bundle_checker_: Singleton<
-        Promise<(str: string) => boolean>
-    >;
-
-    public constructor(private readonly config_: INestiaConfig) {
-        this.bundle_checker_ = new Singleton(async () => {
-            if (!this.config_.output) return () => false;
+    private readonly checker_: Singleton<Promise<(str: string) => boolean>> =
+        new Singleton(async () => {
+            if (!this.config) return () => false;
 
             const bundles: string[] = await fs.promises.readdir(
                 SdkGenerator.BUNDLE_PATH,
@@ -34,7 +28,7 @@ export class NestiaSdkApplication {
                 bundles,
                 async (file) => {
                     const relative: string = path.join(
-                        this.config_.output!,
+                        this.config!.output!,
                         file,
                     );
                     const location: string = path.join(
@@ -55,14 +49,33 @@ export class NestiaSdkApplication {
                 return false;
             };
         });
+
+    public constructor(
+        private readonly config: INestiaConfig,
+        private readonly compilerOptions: ts.CompilerOptions,
+    ) {}
+
+    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.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
+        );
     }
 
     public async e2e(): Promise<void> {
-        if (!this.config_.output)
+        if (!this.config.output)
             throw new Error(
                 "Error on NestiaApplication.e2e(): output path of SDK is not specified.",
             );
-        else if (!this.config_.e2e)
+        else if (!this.config.e2e)
             throw new Error(
                 "Error on NestiaApplication.e2e(): output path of e2e test files is not specified.",
             );
@@ -77,8 +90,8 @@ export class NestiaSdkApplication {
                         `Error on NestiaApplication.e2e(): output directory of ${title} does not exists.`,
                     );
             };
-        await validate("sdk")(this.config_.output);
-        await validate("e2e")(this.config_.e2e);
+        await validate("sdk")(this.config.output);
+        await validate("e2e")(this.config.e2e);
 
         title("Nestia E2E Generator");
         await this.generate(
@@ -92,12 +105,12 @@ export class NestiaSdkApplication {
     }
 
     public async sdk(): Promise<void> {
-        if (!this.config_.output)
+        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 parent: string = path.resolve(this.config.output + "/..");
         const stats: fs.Stats = await fs.promises.lstat(parent);
         if (stats.isDirectory() === false)
             throw new Error(
@@ -113,15 +126,15 @@ export class NestiaSdkApplication {
     }
 
     public async swagger(): Promise<void> {
-        if (!this.config_.swagger?.output)
+        if (!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 parsed: path.ParsedPath = path.parse(this.config.swagger.output);
         const directory: string = !!parsed.ext
             ? path.resolve(parsed.dir)
-            : this.config_.swagger.output;
+            : this.config.swagger.output;
         const stats: fs.Stats = await fs.promises.lstat(directory);
         if (stats.isDirectory() === false)
             throw new Error(
@@ -143,12 +156,9 @@ export class NestiaSdkApplication {
             checker: ts.TypeChecker,
         ) => (config: Config) => (routes: IRoute[]) => Promise<void>,
     ): Promise<void> {
-        // MOUNT TS-NODE
-        this.prepare(method);
-
         // LOAD CONTROLLER FILES
         const input: INestiaConfig.IInput = NestiaConfigUtil.input(
-            this.config_.input,
+            this.config.input,
         );
         const fileList: string[] = await ArrayUtil.asyncFilter(
             await SourceFinder.find({
@@ -197,7 +207,7 @@ export class NestiaSdkApplication {
         console.log("Analyzing source codes");
         const program: ts.Program = ts.createProgram(
             controllers.map((c) => c.file),
-            this.config_.compilerOptions || { noEmit: true },
+            this.compilerOptions,
         );
         const checker: ts.TypeChecker = program.getTypeChecker();
 
@@ -224,59 +234,7 @@ export class NestiaSdkApplication {
 
         // DO GENERATE
         AccessorAnalyzer.analyze(routeList);
-        await archiver(checker)(config(this.config_))(routeList);
-    }
-
-    private prepare(method: string): void {
-        // CONSTRUCT OPTIONS
-        if (!this.config_.compilerOptions)
-            this.config_.compilerOptions =
-                NestiaConfigCompilerOptions.DEFAULT_OPTIONS as any;
-        const absoluted: boolean = !!this.config_.compilerOptions?.baseUrl;
-
-        // CHECK STRICT OPTION
-        const strict: boolean =
-            this.config_.compilerOptions?.strictNullChecks !== undefined
-                ? !!this.config_.compilerOptions.strictNullChecks
-                : !!this.config_.compilerOptions?.strict;
-        if (strict === false)
-            throw new Error(
-                `Error on NestiaSdkApplication.${method}(): nestia requires \`compilerOptions.strictNullChecks\` to be true.`,
-            );
-
-        const ttsc: boolean =
-            ts.version < "5.0.0" &&
-            (() => {
-                try {
-                    require.resolve("ttypescript");
-                    return true;
-                } catch (e) {
-                    return false;
-                }
-            })();
-
-        // MOUNT TS-NODE
-        runner.register({
-            emit: false,
-            compiler: ttsc ? "ttypescript" : undefined,
-            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
-        );
+        await archiver(checker)(config(this.config))(routeList);
     }
 }
 
@@ -301,4 +259,5 @@ const is_implicit_return_typed = (route: IRoute): boolean => {
         else if (VARIABLE.test(name[i])) return false;
     return true;
 };
+
 const VARIABLE = /[a-zA-Z_$0-9]/;

package/src/analyses/ControllerAnalyzer.ts

@@ -192,7 +192,7 @@ export namespace ControllerAnalyzer {
             })(),
             description: CommentFactory.description(symbol),
             operationId: tags
-                .find(({ name }) => name === "operation")
+                .find(({ name }) => name === "operationId")
                 ?.text!?.[0].text.split(" ")[0]
                 .trim(),
             tags,

package/src/executable/internal/NestiaConfigLoader.ts

@@ -0,0 +1,82 @@
+import fs from "fs";
+import path from "path";
+import { WorkerConnector } from "tgrid/protocols/workers/WorkerConnector";
+import { register } from "ts-node";
+import { parseNative } from "tsconfck";
+import ts from "typescript";
+
+import typia from "typia";
+
+import { INestiaConfig } from "../../INestiaConfig";
+import { NestiaProjectGetter } from "./NestiaProjectGetter";
+
+export namespace NestiaConfigLoader {
+    export const compilerOptions = async (
+        project: string,
+    ): Promise<ts.CompilerOptions> => {
+        const configFileName = ts.findConfigFile(
+            process.cwd(),
+            ts.sys.fileExists,
+            project,
+        );
+        if (!configFileName)
+            throw new Error(`unable to find "tsconfig.json" file.`);
+
+        const { tsconfig } = await parseNative(configFileName);
+        const configFileText = JSON.stringify(tsconfig);
+        const { config } = ts.parseConfigFileTextToJson(
+            configFileName,
+            configFileText,
+        );
+        const configParseResult = ts.parseJsonConfigFileContent(
+            config,
+            ts.sys,
+            path.dirname(configFileName),
+        );
+
+        const { moduleResolution, ...result } =
+            configParseResult.raw.compilerOptions;
+        return result;
+    };
+
+    export const config = async (
+        options: ts.CompilerOptions,
+    ): Promise<INestiaConfig> => {
+        if (fs.existsSync(path.resolve("nestia.config.ts")) === false)
+            throw new Error(`unable to find "nestia.config.ts" file.`);
+
+        register({
+            emit: false,
+            compilerOptions: options,
+            require: options.baseUrl ? ["tsconfig-paths/register"] : undefined,
+        });
+
+        const loaded: INestiaConfig & { default?: INestiaConfig } =
+            await import(path.resolve("nestia.config.ts"));
+        const config: INestiaConfig =
+            typeof loaded?.default === "object" && loaded.default !== null
+                ? loaded.default
+                : loaded;
+
+        try {
+            return typia.assert(config);
+        } catch (exp) {
+            if (typia.is<typia.TypeGuardError>(exp))
+                exp.message = `invalid "nestia.config.ts" data.`;
+            throw exp;
+        }
+    };
+
+    export const project = async (): Promise<string> => {
+        const connector = new WorkerConnector(null, null, "process");
+        await connector.connect(
+            `${__dirname}/nestia.project.getter.${__filename.substr(-2)}`,
+        );
+
+        const driver = await connector.getDriver<typeof NestiaProjectGetter>();
+        const project: string = await driver.get();
+        await connector.close();
+
+        return project;
+    };
+}

package/src/executable/internal/NestiaProjectGetter.ts

@@ -0,0 +1,11 @@
+import { NestiaConfigLoader } from "./NestiaConfigLoader";
+
+export namespace NestiaProjectGetter {
+    export async function get(): Promise<string> {
+        const config = await NestiaConfigLoader.config({
+            module: "CommonJS" as any,
+            noEmit: true,
+        });
+        return config.project ?? "tsconfig.json";
+    }
+}

package/src/executable/internal/NestiaSdkCommand.ts

@@ -1,157 +1,34 @@
-import cli from "cli";
-import path from "path";
-import { WorkerConnector } from "tgrid/protocols/workers/WorkerConnector";
-import { parseNative } from "tsconfck";
 import ts from "typescript";
 
 import { INestiaConfig } from "../../INestiaConfig";
 import { NestiaSdkApplication } from "../../NestiaSdkApplication";
-import { NestiaSdkConfig } from "./NestiaSdkConfig";
-
-interface ICommand {
-    exclude: string | null;
-    out: string | null;
-    e2e: string | null;
-}
-
-interface IProps {
-    assign: (config: INestiaConfig, output: string) => void;
-    validate: (config: INestiaConfig) => boolean;
-    location: (config: INestiaConfig) => string;
-}
+import { NestiaConfigLoader } from "./NestiaConfigLoader";
 
 export namespace NestiaSdkCommand {
-    export const sdk = (argv: string[]) =>
-        main({
-            assign: (config, output) => (config.output = output),
-            validate: (config) => !!config.output,
-            location: (config) => config.output!,
-        })(argv)((app) => app.sdk());
-
-    export const swagger = (argv: string[]) =>
-        main({
-            assign: (config, output) => {
-                if (!config.swagger) config.swagger = { output };
-                else config.swagger.output = output;
-            },
-            validate: (config) => !!config.swagger && !!config.swagger.output,
-            location: (config) => config.swagger!.output!,
-        })(argv)((app) => app.swagger());
-
-    export const e2e = (argv: string[]) =>
-        main({
-            assign: (config, output) => (config.output = output),
-            validate: (config) => !!config.output,
-            location: (config) => config.output!,
-        })(argv)((app) => app.e2e());
-
-    const main =
-        (props: IProps) =>
-        (argv: string[]) =>
-        async (task: (app: NestiaSdkApplication) => Promise<void>) => {
-            const command: ICommand = cli.parse({
-                exclude: ["e", "Something to exclude", "string", null],
-                out: ["o", "Output path of the SDK files", "string", null],
-                e2e: [
-                    "e",
-                    "Output path of e2e test function files",
-                    "string",
-                    null,
-                ],
-            });
-
-            const inputs: string[] = [];
-            for (const r of argv) {
-                if (r[0] === "-") break;
-                inputs.push(r);
-            }
-            await generate(props)(command)(inputs)(task);
-        };
-
-    const generate =
-        (props: IProps) =>
-        (command: ICommand) =>
-        (include: string[]) =>
-        async (task: (app: NestiaSdkApplication) => Promise<void>) => {
-            // CONFIGURATION
-            const config: INestiaConfig =
-                (await get_nestia_config(props.validate)) ??
-                parse_cli(props)(command)(include);
-
-            const options: ts.CompilerOptions | null =
-                await get_typescript_options();
-            config.compilerOptions = {
-                ...(options ?? {}),
-                ...(config.compilerOptions ?? {}),
-            };
-
-            // CALL THE APP.GENERATE()
-            const app: NestiaSdkApplication = new NestiaSdkApplication(config);
-            await task(app);
-        };
-
-    async function get_typescript_options(): Promise<ts.CompilerOptions | null> {
-        const configFileName = ts.findConfigFile(
-            process.cwd(),
-            ts.sys.fileExists,
-            "tsconfig.json",
+    export const sdk = () => main((app) => app.sdk());
+    export const swagger = () => main((app) => app.swagger());
+    export const e2e = () => main((app) => app.e2e());
+
+    const main = async (task: (app: NestiaSdkApplication) => Promise<void>) => {
+        await generate(task);
+    };
+
+    const generate = async (
+        task: (app: NestiaSdkApplication) => Promise<void>,
+    ) => {
+        // LOAD CONFIG INFO
+        const project: string = await NestiaConfigLoader.project();
+        const compilerOptions: ts.CompilerOptions =
+            await NestiaConfigLoader.compilerOptions(project);
+        const config: INestiaConfig = await NestiaConfigLoader.config(
+            compilerOptions,
         );
-        if (!configFileName) return null;
 
-        const { tsconfig } = await parseNative(configFileName);
-        const configFileText = JSON.stringify(tsconfig);
-        const { config } = ts.parseConfigFileTextToJson(
-            configFileName,
-            configFileText,
-        );
-        const configParseResult = ts.parseJsonConfigFileContent(
+        // GENERATE
+        const app: NestiaSdkApplication = new NestiaSdkApplication(
             config,
-            ts.sys,
-            path.dirname(configFileName),
-        );
-
-        const { moduleResolution, ...result } =
-            configParseResult.raw.compilerOptions;
-        return result;
-    }
-
-    async function get_nestia_config(
-        validate: (config: INestiaConfig) => boolean,
-    ): Promise<INestiaConfig | null> {
-        const connector = new WorkerConnector(null, null, "process");
-        await connector.connect(
-            `${__dirname}/nestia.config.getter.${__filename.substr(-2)}`,
+            compilerOptions,
         );
-
-        const driver = await connector.getDriver<typeof NestiaSdkConfig>();
-        const config: INestiaConfig | null = await driver.get();
-        await connector.close();
-
-        if (config !== null && validate(config) === false)
-            throw new Error(
-                `Error on NestiaCommand.main(): output path is not specified in the "nestia.config.ts".`,
-            );
-
-        return config;
-    }
-
-    const parse_cli =
-        (props: IProps) =>
-        (command: ICommand) =>
-        (include: string[]): INestiaConfig => {
-            if (command.out === null)
-                throw new Error(
-                    `Error on NestiaCommand.main(): output directory is not specified. Add the "--out <output_directory>" option.`,
-                );
-
-            const config: INestiaConfig = {
-                input: {
-                    include,
-                    exclude: command.exclude ? [command.exclude] : undefined,
-                },
-                e2e: command.e2e ?? undefined,
-            };
-            props.assign(config, command.out);
-            return config;
-        };
+        await task(app);
+    };
 }

package/src/executable/internal/{nestia.config.getter.ts → nestia.project.getter.ts}

@@ -1,10 +1,10 @@
 import { WorkerServer } from "tgrid/protocols/workers/WorkerServer";
 
-import { NestiaSdkConfig } from "./NestiaSdkConfig";
+import { NestiaProjectGetter } from "./NestiaProjectGetter";
 
 async function main(): Promise<void> {
     const worker = new WorkerServer();
-    await worker.open(NestiaSdkConfig);
+    await worker.open(NestiaProjectGetter);
 }
 main().catch((exp) => {
     console.log(exp);

package/src/executable/sdk.ts

@@ -59,9 +59,9 @@ async function main() {
 
     if (type === "dependencies") dependencies(argv);
     else if (type === "init") await initialize();
-    else if (type === "sdk") await execute((c) => c.sdk(argv));
-    else if (type === "swagger") await execute((c) => c.swagger(argv));
-    else if (type === "e2e") await execute((c) => c.e2e(argv));
+    else if (type === "sdk") await execute((c) => c.sdk());
+    else if (type === "swagger") await execute((c) => c.swagger());
+    else if (type === "e2e") await execute((c) => c.e2e());
     else halt(USAGE);
 }
 main().catch((exp) => {

package/src/generates/SwaggerGenerator.ts

@@ -111,9 +111,9 @@ export namespace SwaggerGenerator {
             if (errors.length) {
                 for (const e of errors)
                     console.error(
-                        `${path.relative(location, process.cwd())}:${
-                            e.route.symbol
-                        }:${
+                        `${path.relative(e.route.location, process.cwd())}:${
+                            e.route.symbol.class
+                        }.${e.route.symbol.function}:${
                             e.from
                         } - error TS(@nestia/sdk): invalid type detected.\n\n` +
                             e.messages.map((m) => `  - ${m}`).join("\n"),
@@ -348,7 +348,8 @@ export namespace SwaggerGenerator {
                     .filter((param) => param.category !== "body")
                     .map((param) =>
                         SwaggerSchemaGenerator.parameter(props)(route)(param),
-                    ),
+                    )
+                    .flat(),
                 requestBody: body
                     ? SwaggerSchemaGenerator.body(props)(route)(body)
                     : undefined,