@nestia/sdk 2.6.3-dev.20240328 → 2.6.4-dev.20240401

package/src/generates/CloneGenerator.ts

@@ -1,62 +1,62 @@
-import fs from "fs";
-import ts from "typescript";
-
-import { INestiaConfig } from "../INestiaConfig";
-import { IRoute } from "../structures/IRoute";
-import { FilePrinter } from "./internal/FilePrinter";
-import { ImportDictionary } from "./internal/ImportDictionary";
-import { SdkCloneProgrammer } from "./internal/SdkCloneProgrammer";
-
-export namespace CloneGenerator {
-  export const write =
-    (checker: ts.TypeChecker) =>
-    (config: INestiaConfig) =>
-    async (routes: IRoute[]): Promise<void> => {
-      const dict: Map<string, SdkCloneProgrammer.IModule> =
-        SdkCloneProgrammer.write(checker)(config)(routes);
-      if (dict.size === 0) return;
-      try {
-        await fs.promises.mkdir(`${config.output}/structures`);
-      } catch {}
-      for (const [key, value] of dict) await writeDtoFile(config)(key, value);
-    };
-
-  const writeDtoFile =
-    (config: INestiaConfig) =>
-    async (key: string, value: SdkCloneProgrammer.IModule): Promise<void> => {
-      const location: string = `${config.output}/structures/${key}.ts`;
-      const importer: ImportDictionary = new ImportDictionary(location);
-      const statements: ts.Statement[] = iterate(importer)(value);
-      if (statements.length === 0) return;
-
-      await FilePrinter.write({
-        location,
-        statements: [
-          ...importer.toStatements(`${config.output}/structures`),
-          ...(importer.empty() ? [] : [FilePrinter.enter()]),
-          ...statements,
-        ],
-      });
-    };
-
-  const iterate =
-    (importer: ImportDictionary) =>
-    (modulo: SdkCloneProgrammer.IModule): ts.Statement[] => {
-      const output: ts.Statement[] = [];
-      if (modulo.programmer !== null) output.push(modulo.programmer(importer));
-      if (modulo.children.size) {
-        const internal: ts.Statement[] = [];
-        for (const child of modulo.children.values())
-          internal.push(...iterate(importer)(child));
-        output.push(
-          ts.factory.createModuleDeclaration(
-            [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
-            ts.factory.createIdentifier(modulo.name),
-            ts.factory.createModuleBlock(internal),
-            ts.NodeFlags.Namespace,
-          ),
-        );
-      }
-      return output;
-    };
-}
+import fs from "fs";
+import ts from "typescript";
+
+import { INestiaConfig } from "../INestiaConfig";
+import { IRoute } from "../structures/IRoute";
+import { FilePrinter } from "./internal/FilePrinter";
+import { ImportDictionary } from "./internal/ImportDictionary";
+import { SdkCloneProgrammer } from "./internal/SdkCloneProgrammer";
+
+export namespace CloneGenerator {
+  export const write =
+    (checker: ts.TypeChecker) =>
+    (config: INestiaConfig) =>
+    async (routes: IRoute[]): Promise<void> => {
+      const dict: Map<string, SdkCloneProgrammer.IModule> =
+        SdkCloneProgrammer.write(checker)(config)(routes);
+      if (dict.size === 0) return;
+      try {
+        await fs.promises.mkdir(`${config.output}/structures`);
+      } catch {}
+      for (const [key, value] of dict) await writeDtoFile(config)(key, value);
+    };
+
+  const writeDtoFile =
+    (config: INestiaConfig) =>
+    async (key: string, value: SdkCloneProgrammer.IModule): Promise<void> => {
+      const location: string = `${config.output}/structures/${key}.ts`;
+      const importer: ImportDictionary = new ImportDictionary(location);
+      const statements: ts.Statement[] = iterate(importer)(value);
+      if (statements.length === 0) return;
+
+      await FilePrinter.write({
+        location,
+        statements: [
+          ...importer.toStatements(`${config.output}/structures`),
+          ...(importer.empty() ? [] : [FilePrinter.enter()]),
+          ...statements,
+        ],
+      });
+    };
+
+  const iterate =
+    (importer: ImportDictionary) =>
+    (modulo: SdkCloneProgrammer.IModule): ts.Statement[] => {
+      const output: ts.Statement[] = [];
+      if (modulo.programmer !== null) output.push(modulo.programmer(importer));
+      if (modulo.children.size) {
+        const internal: ts.Statement[] = [];
+        for (const child of modulo.children.values())
+          internal.push(...iterate(importer)(child));
+        output.push(
+          ts.factory.createModuleDeclaration(
+            [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
+            ts.factory.createIdentifier(modulo.name),
+            ts.factory.createModuleBlock(internal),
+            ts.NodeFlags.Namespace,
+          ),
+        );
+      }
+      return output;
+    };
+}

package/src/generates/E2eGenerator.ts

@@ -1,66 +1,66 @@
-import fs from "fs";
-import path from "path";
-import ts from "typescript";
-
-import { INestiaConfig } from "../INestiaConfig";
-import { ConfigAnalyzer } from "../analyses/ConfigAnalyzer";
-import { IRoute } from "../structures/IRoute";
-import { E2eFileProgrammer } from "./internal/E2eFileProgrammer";
-
-export namespace E2eGenerator {
-  export const generate =
-    (checker: ts.TypeChecker) =>
-    (config: INestiaConfig) =>
-    async (routeList: IRoute[]): Promise<void> => {
-      console.log("Generating E2E Test Functions");
-
-      // PREPARE DIRECTORIES
-      const output: string = path.resolve(config.e2e!);
-      await mkdir(output);
-      await mkdir(path.join(output, "features"));
-      await mkdir(path.join(output, "features", "api"));
-      await mkdir(path.join(output, "features", "api", "automated"));
-
-      // GENERATE TEST INDEX FILE
-      await index(config)(path.join(config.e2e!, "index.ts"));
-
-      // GENERATE EACH TEST FILES
-      for (const route of routeList)
-        await E2eFileProgrammer.generate(checker)(config)({
-          api: path.resolve(config.output!),
-          current: path.join(output, "features", "api", "automated"),
-        })(route);
-    };
-
-  const index =
-    (config: INestiaConfig) =>
-    async (output: string): Promise<void> => {
-      if (fs.existsSync(output)) return;
-
-      const location: string = path.join(
-        __dirname,
-        "..",
-        "..",
-        "assets",
-        "bundle",
-        "e2e",
-        "index.ts",
-      );
-      const content: string = await fs.promises.readFile(location, "utf8");
-
-      await fs.promises.writeFile(
-        output,
-        content.replace(
-          "${input}",
-          JSON.stringify(await ConfigAnalyzer.input(config)),
-        ),
-        "utf8",
-      );
-    };
-}
-
-const mkdir = async (location: string): Promise<void> => {
-  try {
-    await fs.promises.mkdir(location);
-  } catch {}
-};
+import fs from "fs";
+import path from "path";
+import ts from "typescript";
+
+import { INestiaConfig } from "../INestiaConfig";
+import { ConfigAnalyzer } from "../analyses/ConfigAnalyzer";
+import { IRoute } from "../structures/IRoute";
+import { E2eFileProgrammer } from "./internal/E2eFileProgrammer";
+
+export namespace E2eGenerator {
+  export const generate =
+    (checker: ts.TypeChecker) =>
+    (config: INestiaConfig) =>
+    async (routeList: IRoute[]): Promise<void> => {
+      console.log("Generating E2E Test Functions");
+
+      // PREPARE DIRECTORIES
+      const output: string = path.resolve(config.e2e!);
+      await mkdir(output);
+      await mkdir(path.join(output, "features"));
+      await mkdir(path.join(output, "features", "api"));
+      await mkdir(path.join(output, "features", "api", "automated"));
+
+      // GENERATE TEST INDEX FILE
+      await index(config)(path.join(config.e2e!, "index.ts"));
+
+      // GENERATE EACH TEST FILES
+      for (const route of routeList)
+        await E2eFileProgrammer.generate(checker)(config)({
+          api: path.resolve(config.output!),
+          current: path.join(output, "features", "api", "automated"),
+        })(route);
+    };
+
+  const index =
+    (config: INestiaConfig) =>
+    async (output: string): Promise<void> => {
+      if (fs.existsSync(output)) return;
+
+      const location: string = path.join(
+        __dirname,
+        "..",
+        "..",
+        "assets",
+        "bundle",
+        "e2e",
+        "index.ts",
+      );
+      const content: string = await fs.promises.readFile(location, "utf8");
+
+      await fs.promises.writeFile(
+        output,
+        content.replace(
+          "${input}",
+          JSON.stringify(await ConfigAnalyzer.input(config)),
+        ),
+        "utf8",
+      );
+    };
+}
+
+const mkdir = async (location: string): Promise<void> => {
+  try {
+    await fs.promises.mkdir(location);
+  } catch {}
+};

package/src/generates/SdkGenerator.ts

@@ -1,84 +1,84 @@
-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 { CloneGenerator } from "./CloneGenerator";
-import { SdkDistributionComposer } from "./internal/SdkDistributionComposer";
-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");
-
-      // PREPARE NEW DIRECTORIES
-      try {
-        await fs.promises.mkdir(config.output!);
-      } catch {}
-
-      // BUNDLING
-      const bundle: string[] = await fs.promises.readdir(BUNDLE_PATH);
-      for (const file of bundle) {
-        const current: string = `${BUNDLE_PATH}/${file}`;
-        const target: string = `${config.output}/${file}`;
-        const stats: fs.Stats = await fs.promises.stat(current);
-
-        if (stats.isFile() === true) {
-          const content: string = await fs.promises.readFile(current, "utf8");
-          if (fs.existsSync(target) === false)
-            await fs.promises.writeFile(target, content, "utf8");
-          else if (BUNDLE_CHANGES[file] !== undefined) {
-            const r: IPointer<string> = {
-              value: await fs.promises.readFile(target, "utf8"),
-            };
-            for (const [before, after] of BUNDLE_CHANGES[file])
-              r.value = r.value.replace(before, after);
-            await fs.promises.writeFile(target, r.value, "utf8");
-          }
-        }
-      }
-
-      // STRUCTURES
-      if (config.clone) await CloneGenerator.write(checker)(config)(routes);
-
-      // FUNCTIONAL
-      await SdkFileProgrammer.generate(checker)(config)(routes);
-
-      // DISTRIBUTION
-      if (config.distribute !== undefined)
-        await SdkDistributionComposer.compose(config);
-    };
-
-  export const BUNDLE_PATH = NodePath.join(
-    __dirname,
-    "..",
-    "..",
-    "assets",
-    "bundle",
-    "api",
-  );
-}
-
-const BUNDLE_CHANGES: Record<string, [string, string][]> = {
-  "IConnection.ts": [
-    [
-      `export { IConnection } from "@nestia/fetcher"`,
-      `export type { IConnection } from "@nestia/fetcher"`,
-    ],
-  ],
-  "module.ts": [
-    [`export * from "./IConnection"`, `export type * from "./IConnection"`],
-    [`export * from "./Primitive"`, `export type * from "./Primitive"`],
-  ],
-  "Primitive.ts": [
-    [
-      `export { Primitive } from "@nestia/fetcher"`,
-      `export type { Primitive } from "@nestia/fetcher"`,
-    ],
-  ],
-};
+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 { CloneGenerator } from "./CloneGenerator";
+import { SdkDistributionComposer } from "./internal/SdkDistributionComposer";
+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");
+
+      // PREPARE NEW DIRECTORIES
+      try {
+        await fs.promises.mkdir(config.output!);
+      } catch {}
+
+      // BUNDLING
+      const bundle: string[] = await fs.promises.readdir(BUNDLE_PATH);
+      for (const file of bundle) {
+        const current: string = `${BUNDLE_PATH}/${file}`;
+        const target: string = `${config.output}/${file}`;
+        const stats: fs.Stats = await fs.promises.stat(current);
+
+        if (stats.isFile() === true) {
+          const content: string = await fs.promises.readFile(current, "utf8");
+          if (fs.existsSync(target) === false)
+            await fs.promises.writeFile(target, content, "utf8");
+          else if (BUNDLE_CHANGES[file] !== undefined) {
+            const r: IPointer<string> = {
+              value: await fs.promises.readFile(target, "utf8"),
+            };
+            for (const [before, after] of BUNDLE_CHANGES[file])
+              r.value = r.value.replace(before, after);
+            await fs.promises.writeFile(target, r.value, "utf8");
+          }
+        }
+      }
+
+      // STRUCTURES
+      if (config.clone) await CloneGenerator.write(checker)(config)(routes);
+
+      // FUNCTIONAL
+      await SdkFileProgrammer.generate(checker)(config)(routes);
+
+      // DISTRIBUTION
+      if (config.distribute !== undefined)
+        await SdkDistributionComposer.compose(config);
+    };
+
+  export const BUNDLE_PATH = NodePath.join(
+    __dirname,
+    "..",
+    "..",
+    "assets",
+    "bundle",
+    "api",
+  );
+}
+
+const BUNDLE_CHANGES: Record<string, [string, string][]> = {
+  "IConnection.ts": [
+    [
+      `export { IConnection } from "@nestia/fetcher"`,
+      `export type { IConnection } from "@nestia/fetcher"`,
+    ],
+  ],
+  "module.ts": [
+    [`export * from "./IConnection"`, `export type * from "./IConnection"`],
+    [`export * from "./Primitive"`, `export type * from "./Primitive"`],
+  ],
+  "Primitive.ts": [
+    [
+      `export { Primitive } from "@nestia/fetcher"`,
+      `export type { Primitive } from "@nestia/fetcher"`,
+    ],
+  ],
+};

package/src/generates/SwaggerGenerator.ts

@@ -27,6 +27,7 @@ export namespace SwaggerGenerator {
     lazySchemas: Array<ISwaggerLazySchema>;
     lazyProperties: Array<ISwaggerLazyProperty>;
     errors: ISwaggerError[];
+    swagger: ISwagger;
   }
 
   export const generate =
@@ -80,6 +81,7 @@ export namespace SwaggerGenerator {
           lazySchemas,
           lazyProperties,
           errors,
+          swagger,
         })(route);
       }
       swagger.paths = {};
@@ -329,6 +331,7 @@ export namespace SwaggerGenerator {
       },
       paths: {},
       components: {},
+      tags: config.tags ?? [],
     };
   };
 
@@ -344,8 +347,11 @@ export namespace SwaggerGenerator {
   const generate_route =
     (props: IProps) =>
     (route: IRoute): ISwaggerRoute => {
+      // FIND REQUEST BODY
       const body = route.parameters.find((param) => param.category === "body");
-      const getJsDocTexts = (name: string) =>
+
+      // CONSTRUCT SUMMARY & DESCRIPTION
+      const getJsDocTexts = (name: string): string[] =>
         route.jsDocTags
           .filter(
             (tag) =>
@@ -356,7 +362,6 @@ export namespace SwaggerGenerator {
               ) !== undefined,
           )
           .map((tag) => tag.text!.find((elem) => elem.kind === "text")!.text);
-
       const description: string | undefined = route.description?.length
         ? route.description
         : undefined;
@@ -376,9 +381,24 @@ export namespace SwaggerGenerator {
         (tag) => tag.name === "deprecated",
       );
 
+      // CONSTRUCT TAGS
+      const tagSet: Set<string> = new Set(
+        ...route.swaggerTags,
+        getJsDocTexts("tag").map((tag) => tag.split(" ")[0]),
+      );
+      for (const tag of tagSet)
+        if (props.swagger.tags.find((elem) => elem.name === tag) === undefined)
+          props.swagger.tags.push({ name: tag });
+      for (const tag of getJsDocTexts("tag")) {
+        const [name, ...description] = tag.split(" ");
+        if (description.length)
+          props.swagger.tags.find((elem) => elem.name === name)!.description =
+            description.join(" ");
+      }
+      // FINALIZE
       return {
         deprecated: deprecated ? true : undefined,
-        tags: [...route.swaggerTags, ...new Set([...getJsDocTexts("tag")])],
+        tags: [...tagSet],
         operationId:
           route.operationId ??
           props.config.operationId?.({