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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestia/sdk",
-  "version": "2.0.0-dev.20230904-2",
+  "version": "2.0.0-dev.20230906",
   "description": "Nestia SDK and Swagger generator",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -35,7 +35,7 @@
   },
   "homepage": "https://nestia.io",
   "dependencies": {
-    "@nestia/fetcher": "^2.0.0-dev.20230904-2",
+    "@nestia/fetcher": "^2.0.0-dev.20230906",
     "cli": "^1.0.1",
     "glob": "^7.2.0",
     "path-to-regexp": "^6.2.1",
@@ -44,16 +44,16 @@
     "tsconfck": "^2.0.1",
     "tsconfig-paths": "^4.1.1",
     "tstl": "^2.5.13",
-    "typia": "^5.0.1"
+    "typia": "^5.0.2"
   },
   "peerDependencies": {
-    "@nestia/fetcher": ">=2.0.0-dev.20230904-2",
+    "@nestia/fetcher": ">=2.0.0-dev.20230906",
     "@nestjs/common": ">=7.0.1",
     "@nestjs/core": ">=7.0.1",
     "reflect-metadata": ">=0.1.12",
     "ts-node": ">=10.6.0",
     "typescript": ">=4.8.0",
-    "typia": ">=5.0.1 <6.0.0"
+    "typia": ">=5.0.2 <6.0.0"
   },
   "devDependencies": {
     "@nestjs/common": ">= 7.0.1",

package/src/INestiaConfig.ts

@@ -52,6 +52,15 @@ export interface INestiaConfig {
      */
     e2e?: string;
 
+    /**
+     * Whether to clone DTO structures or not.
+     *
+     * If being configured, all of DTOs used in the backend server would be cloned
+     * into the `structures` directory, and the SDK library would be refer to the
+     * cloned DTOs instead of the original.
+     */
+    clone?: boolean;
+
     /**
      * Whether to wrap DTO by primitive type.
      *

package/src/NestiaSdkApplication.ts

@@ -17,7 +17,7 @@ import { NestiaConfigUtil } from "./utils/NestiaConfigUtil";
 import { SourceFinder } from "./utils/SourceFinder";
 
 export class NestiaSdkApplication {
-    private readonly checker_: Singleton<Promise<(str: string) => boolean>> =
+    private readonly bundler_: Singleton<Promise<(str: string) => boolean>> =
         new Singleton(async () => {
             if (!this.config) return () => false;
 
@@ -59,7 +59,7 @@ export class NestiaSdkApplication {
         if (this.config.output)
             return (
                 file.indexOf(path.join(this.config.output, "functional")) ===
-                    -1 && (await this.checker_.get())(file) === false
+                    -1 && (await this.bundler_.get())(file) === false
             );
 
         const content: string = await fs.promises.readFile(file, "utf8");
@@ -97,8 +97,8 @@ export class NestiaSdkApplication {
         await this.generate(
             "e2e",
             (config) => config,
-            () => (config) => async (routes) => {
-                await SdkGenerator.generate(config)(routes);
+            (checker) => (config) => async (routes) => {
+                await SdkGenerator.generate(checker)(config)(routes);
                 await E2eGenerator.generate(config)(routes);
             },
         );
@@ -118,11 +118,7 @@ export class NestiaSdkApplication {
             );
 
         title("Nestia SDK Generator");
-        await this.generate(
-            "sdk",
-            (config) => config,
-            () => SdkGenerator.generate,
-        );
+        await this.generate("sdk", (config) => config, SdkGenerator.generate);
     }
 
     public async swagger(): Promise<void> {

package/src/analyses/ControllerAnalyzer.ts

@@ -145,11 +145,11 @@ export namespace ControllerAnalyzer {
             .map((pair) => [pair.first, pair.second.toJSON()]);
 
         // PARSE COMMENT TAGS
-        const tags = signature.getJsDocTags();
+        const jsDocTags = signature.getJsDocTags();
         const security: Record<string, string[]>[] = SecurityAnalyzer.merge(
             ...controller.security,
             ...func.security,
-            ...tags
+            ...jsDocTags
                 .filter((tag) => tag.name === "security")
                 .map((tag) =>
                     (tag.text ?? []).map((text) => {
@@ -191,12 +191,12 @@ export namespace ControllerAnalyzer {
                 }:${character + 1}`;
             })(),
             description: CommentFactory.description(symbol),
-            operationId: tags
+            operationId: jsDocTags
                 .find(({ name }) => name === "operationId")
                 ?.text!?.[0].text.split(" ")[0]
                 .trim(),
-            tags,
-            setHeaders: tags
+            jsDocTags: jsDocTags,
+            setHeaders: jsDocTags
                 .filter(
                     (t) =>
                         t.text?.length &&

package/src/analyses/ReflectAnalyzer.ts

@@ -90,6 +90,8 @@ export namespace ReflectAnalyzer {
             paths,
             functions: [],
             security: _Get_securities(creator),
+            swaggerTgas:
+                Reflect.getMetadata("swagger/apiUseTags", creator) ?? [],
         };
 
         // PARSE CHILDREN DATA
@@ -228,6 +230,12 @@ export namespace ReflectAnalyzer {
                   )?.value ?? "application/json",
             security: _Get_securities(proto),
             exceptions: _Get_exceptions(proto),
+            swaggerTags: [
+                ...new Set([
+                    ...controller.swaggerTgas,
+                    ...(Reflect.getMetadata("swagger/apiUseTags", proto) ?? []),
+                ]),
+            ],
         };
 
         // VALIDATE PATH ARGUMENTS

package/src/generates/SdkGenerator.ts

@@ -1,14 +1,17 @@
 import fs from "fs";
 import NodePath from "path";
 import { IPointer } from "tstl";
+import ts from "typescript";
 
 import { INestiaConfig } from "../INestiaConfig";
 import { IRoute } from "../structures/IRoute";
 import { DistributionComposer } from "./internal/DistributionComposer";
+import { SdkDtoGenerator } from "./internal/SdkDtoGenerator";
 import { SdkFileProgrammer } from "./internal/SdkFileProgrammer";
 
 export namespace SdkGenerator {
     export const generate =
+        (checker: ts.TypeChecker) =>
         (config: INestiaConfig) =>
         async (routes: IRoute[]): Promise<void> => {
             console.log("Generating SDK Library");
@@ -55,6 +58,10 @@ export namespace SdkGenerator {
                 );
             }
 
+            // STRUCTURES
+            if (config.clone)
+                await SdkDtoGenerator.generate(checker)(config)(routes);
+
             // FUNCTIONAL
             await SdkFileProgrammer.generate(config)(routes);
 

package/src/generates/SwaggerGenerator.ts

@@ -71,7 +71,8 @@ export namespace SwaggerGenerator {
             > = new Map();
 
             for (const route of routeList) {
-                if (route.tags.find((tag) => tag.name === "internal")) continue;
+                if (route.jsDocTags.find((tag) => tag.name === "internal"))
+                    continue;
 
                 const path: Record<string, ISwaggerRoute> = MapUtil.take(
                     pathDict,
@@ -297,8 +298,8 @@ export namespace SwaggerGenerator {
             const body = route.parameters.find(
                 (param) => param.category === "body",
             );
-            const getTagTexts = (name: string) =>
-                route.tags
+            const getJsDocTexts = (name: string) =>
+                route.jsDocTags
                     .filter(
                         (tag) =>
                             tag.name === name &&
@@ -320,7 +321,7 @@ export namespace SwaggerGenerator {
             const summary: string | undefined = (() => {
                 if (description === undefined) return undefined;
 
-                const [explicit] = getTagTexts("summary");
+                const [explicit] = getJsDocTexts("summary");
                 if (explicit?.length) return explicit;
 
                 const index: number = description.indexOf(".");
@@ -329,13 +330,16 @@ export namespace SwaggerGenerator {
                 const content: string = description.substring(0, index).trim();
                 return content.length ? content : undefined;
             })();
-            const deprecated = route.tags.find(
+            const deprecated = route.jsDocTags.find(
                 (tag) => tag.name === "deprecated",
             );
 
             return {
                 deprecated: deprecated ? true : undefined,
-                tags: getTagTexts("tag"),
+                tags: [
+                    ...route.swaggerTags,
+                    ...new Set([...getJsDocTexts("tag")]),
+                ],
                 operationId:
                     route.operationId ??
                     props.config.operationId?.({
@@ -363,7 +367,7 @@ export namespace SwaggerGenerator {
                         .filter((str) => str.length && str[0] !== ":"),
                     route.name,
                 ].join("."),
-                "x-nestia-jsDocTags": route.tags,
+                "x-nestia-jsDocTags": route.jsDocTags,
                 "x-nestia-method": route.method,
             };
         };

package/src/generates/internal/E2eFileProgrammer.ts

@@ -3,6 +3,7 @@ import fs from "fs";
 import { INestiaConfig } from "../../INestiaConfig";
 import { IRoute } from "../../structures/IRoute";
 import { ImportDictionary } from "../../utils/ImportDictionary";
+import { SdkDtoGenerator } from "./SdkDtoGenerator";
 import { SdkImportWizard } from "./SdkImportWizard";
 
 export namespace E2eFileProgrammer {
@@ -11,20 +12,21 @@ export namespace E2eFileProgrammer {
         (props: { api: string; current: string }) =>
         async (route: IRoute): Promise<void> => {
             const importer: ImportDictionary = new ImportDictionary();
-            for (const tuple of route.imports)
-                for (const instance of tuple[1])
-                    importer.internal({
-                        file: tuple[0],
-                        type: true,
-                        instance,
-                    });
-
+            if (config.clone !== true)
+                for (const tuple of route.imports)
+                    for (const instance of tuple[1])
+                        importer.internal({
+                            file: tuple[0],
+                            type: true,
+                            instance,
+                        });
             importer.internal({
                 type: false,
                 file: props.api,
                 instance: null,
                 name: "api",
             });
+
             const body: string = arrow(config)(importer)(route);
             const content: string = [
                 importer.toScript(props.current),
@@ -57,7 +59,9 @@ export namespace E2eFileProgrammer {
                           "        ...(connection.headers ?? {}),",
                           `        ...${SdkImportWizard.typia(
                               importer,
-                          )}.random<${headers.typeName}>(),`,
+                          )}.random<${getTypeName(config)(importer)(
+                              headers,
+                          )}>(),`,
                           "    },",
                           "},",
                       ]
@@ -77,7 +81,7 @@ export namespace E2eFileProgrammer {
                     ? [`    ${output}`]
                     : [
                           `    const output: ${primitive(config)(importer)(
-                              route.output.typeName,
+                              getTypeName(config)(importer)(route.output),
                           )} = `,
                           `        ${output}`,
                           `    ${SdkImportWizard.typia(
@@ -95,7 +99,9 @@ export namespace E2eFileProgrammer {
         (param: IRoute.IParameter): string => {
             const middle: string = `${SdkImportWizard.typia(
                 importer,
-            )}.random<${primitive(config)(importer)(param.typeName)}>()`;
+            )}.random<${primitive(config)(importer)(
+                getTypeName(config)(importer)(param),
+            )}>()`;
             return `${" ".repeat(4 * tab)}${middle},`;
         };
 
@@ -113,3 +119,10 @@ export namespace E2eFileProgrammer {
                 ? `${SdkImportWizard.Primitive(importer)}<${name}>`
                 : name;
 }
+const getTypeName =
+    (config: INestiaConfig) =>
+    (importer: ImportDictionary) =>
+    (p: IRoute.IParameter | IRoute.IOutput) =>
+        p.metadata
+            ? SdkDtoGenerator.decode(config)(importer)(p.metadata)
+            : p.typeName;