@nestia/sdk 11.0.0-dev.20260305 → 11.0.0-dev.20260312

package/src/generates/SdkGenerator.ts

@@ -1,160 +1,160 @@
-import fs from "fs";
-import NodePath from "path";
-import { IPointer } from "tstl";
-
-import { INestiaConfig } from "../INestiaConfig";
-import { IReflectOperationError } from "../structures/IReflectOperationError";
-import { IReflectType } from "../structures/IReflectType";
-import { ITypedApplication } from "../structures/ITypedApplication";
-import { ITypedHttpRoute } from "../structures/ITypedHttpRoute";
-import { CloneGenerator } from "./CloneGenerator";
-import { SdkDistributionComposer } from "./internal/SdkDistributionComposer";
-import { SdkFileProgrammer } from "./internal/SdkFileProgrammer";
-import { SdkHttpParameterProgrammer } from "./internal/SdkHttpParameterProgrammer";
-
-export namespace SdkGenerator {
-  export const generate = async (app: ITypedApplication): Promise<void> => {
-    if (app.project.config.output === undefined)
-      throw new Error("Output directory is not defined.");
-
-    // PREPARE NEW DIRECTORIES
-    console.log("Generating SDK Library");
-    try {
-      await fs.promises.mkdir(app.project.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 = `${app.project.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 (app.project.config.clone === true) await CloneGenerator.write(app);
-
-    // FUNCTIONAL
-    await SdkFileProgrammer.generate(app);
-
-    // DISTRIBUTION
-    if (app.project.config.distribute !== undefined)
-      await SdkDistributionComposer.compose({
-        config: app.project.config,
-        websocket: app.routes.some((r) => r.protocol === "websocket"),
-      });
-  };
-
-  export const validate = (
-    app: ITypedApplication,
-  ): IReflectOperationError[] => {
-    const errors: IReflectOperationError[] = [];
-    if (app.project.config.clone === true) return errors;
-    for (const route of app.routes)
-      if (route.protocol === "http")
-        validateImplicit({
-          config: app.project.config,
-          errors,
-          route,
-        });
-    return errors;
-  };
-
-  const validateImplicit = (props: {
-    config: INestiaConfig;
-    errors: IReflectOperationError[];
-    route: ITypedHttpRoute;
-  }): void => {
-    for (const p of SdkHttpParameterProgrammer.getAll(props.route)) {
-      if (isImplicitType(p.type))
-        props.errors.push({
-          file: props.route.controller.file,
-          class: props.route.controller.class.name,
-          function: props.route.name,
-          from: `parameter ${JSON.stringify(p.name)}`,
-          contents: [`implicit (unnamed) parameter type.`],
-        });
-    }
-    if (props.config.propagate === true)
-      for (const [key, value] of Object.entries(props.route.exceptions))
-        if (isImplicitType(value.type))
-          props.errors.push({
-            file: props.route.controller.file,
-            class: props.route.controller.class.name,
-            function: props.route.name,
-            from: `exception ${JSON.stringify(key)}`,
-            contents: [`implicit (unnamed) exception type.`],
-          });
-    if (isImplicitType(props.route.success.type))
-      props.errors.push({
-        file: props.route.controller.file,
-        class: props.route.controller.class.name,
-        function: props.route.name,
-        from: "success",
-        contents: [`implicit (unnamed) return type.`],
-      });
-  };
-
-  const isImplicitType = (type: IReflectType): boolean =>
-    type.name === "__type" ||
-    type.name === "__object" ||
-    type.name.startsWith("__type.") ||
-    type.name.startsWith("__object.") ||
-    type.name.includes("readonly [") ||
-    (!!type.typeArguments?.length && type.typeArguments.some(isImplicitType));
-
-  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"`],
-  ],
-  "Primitive.ts": [
-    [
-      `export { Primitive } from "@nestia/fetcher"`,
-      `export type { Primitive } from "typia"`,
-    ],
-    [
-      `export type { Primitive } from "@nestia/fetcher"`,
-      `export type { Primitive } from "typia"`,
-    ],
-  ],
-  "Resolved.ts": [
-    [
-      `export { Resolved } from "@nestia/fetcher"`,
-      `export type { Resolved } from "typia"`,
-    ],
-    [
-      `export type { Resolved } from "@nestia/fetcher"`,
-      `export type { Resolved } from "typia"`,
-    ],
-  ],
-};
+import fs from "fs";
+import NodePath from "path";
+import { IPointer } from "tstl";
+
+import { INestiaConfig } from "../INestiaConfig";
+import { IReflectOperationError } from "../structures/IReflectOperationError";
+import { IReflectType } from "../structures/IReflectType";
+import { ITypedApplication } from "../structures/ITypedApplication";
+import { ITypedHttpRoute } from "../structures/ITypedHttpRoute";
+import { CloneGenerator } from "./CloneGenerator";
+import { SdkDistributionComposer } from "./internal/SdkDistributionComposer";
+import { SdkFileProgrammer } from "./internal/SdkFileProgrammer";
+import { SdkHttpParameterProgrammer } from "./internal/SdkHttpParameterProgrammer";
+
+export namespace SdkGenerator {
+  export const generate = async (app: ITypedApplication): Promise<void> => {
+    if (app.project.config.output === undefined)
+      throw new Error("Output directory is not defined.");
+
+    // PREPARE NEW DIRECTORIES
+    console.log("Generating SDK Library");
+    try {
+      await fs.promises.mkdir(app.project.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 = `${app.project.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 (app.project.config.clone === true) await CloneGenerator.write(app);
+
+    // FUNCTIONAL
+    await SdkFileProgrammer.generate(app);
+
+    // DISTRIBUTION
+    if (app.project.config.distribute !== undefined)
+      await SdkDistributionComposer.compose({
+        config: app.project.config,
+        websocket: app.routes.some((r) => r.protocol === "websocket"),
+      });
+  };
+
+  export const validate = (
+    app: ITypedApplication,
+  ): IReflectOperationError[] => {
+    const errors: IReflectOperationError[] = [];
+    if (app.project.config.clone === true) return errors;
+    for (const route of app.routes)
+      if (route.protocol === "http")
+        validateImplicit({
+          config: app.project.config,
+          errors,
+          route,
+        });
+    return errors;
+  };
+
+  const validateImplicit = (props: {
+    config: INestiaConfig;
+    errors: IReflectOperationError[];
+    route: ITypedHttpRoute;
+  }): void => {
+    for (const p of SdkHttpParameterProgrammer.getAll(props.route)) {
+      if (isImplicitType(p.type))
+        props.errors.push({
+          file: props.route.controller.file,
+          class: props.route.controller.class.name,
+          function: props.route.name,
+          from: `parameter ${JSON.stringify(p.name)}`,
+          contents: [`implicit (unnamed) parameter type.`],
+        });
+    }
+    if (props.config.propagate === true)
+      for (const [key, value] of Object.entries(props.route.exceptions))
+        if (isImplicitType(value.type))
+          props.errors.push({
+            file: props.route.controller.file,
+            class: props.route.controller.class.name,
+            function: props.route.name,
+            from: `exception ${JSON.stringify(key)}`,
+            contents: [`implicit (unnamed) exception type.`],
+          });
+    if (isImplicitType(props.route.success.type))
+      props.errors.push({
+        file: props.route.controller.file,
+        class: props.route.controller.class.name,
+        function: props.route.name,
+        from: "success",
+        contents: [`implicit (unnamed) return type.`],
+      });
+  };
+
+  const isImplicitType = (type: IReflectType): boolean =>
+    type.name === "__type" ||
+    type.name === "__object" ||
+    type.name.startsWith("__type.") ||
+    type.name.startsWith("__object.") ||
+    type.name.includes("readonly [") ||
+    (!!type.typeArguments?.length && type.typeArguments.some(isImplicitType));
+
+  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"`],
+  ],
+  "Primitive.ts": [
+    [
+      `export { Primitive } from "@nestia/fetcher"`,
+      `export type { Primitive } from "typia"`,
+    ],
+    [
+      `export type { Primitive } from "@nestia/fetcher"`,
+      `export type { Primitive } from "typia"`,
+    ],
+  ],
+  "Resolved.ts": [
+    [
+      `export { Resolved } from "@nestia/fetcher"`,
+      `export type { Resolved } from "typia"`,
+    ],
+    [
+      `export type { Resolved } from "@nestia/fetcher"`,
+      `export type { Resolved } from "typia"`,
+    ],
+  ],
+};

package/src/generates/SwaggerGenerator.ts

@@ -1,6 +1,12 @@
 import { SwaggerCustomizer } from "@nestia/core";
 import { JsonSchemasProgrammer, MetadataSchema } from "@typia/core";
-import { OpenApi, OpenApiV3, SwaggerV2 } from "@typia/interface";
+import {
+  OpenApi,
+  OpenApiV3,
+  OpenApiV3_1,
+  OpenApiV3_2,
+  SwaggerV2,
+} from "@typia/interface";
 import { OpenApiConverter } from "@typia/utils";
 import fs from "fs";
 import path from "path";
@@ -46,12 +52,12 @@ export namespace SwaggerGenerator {
     const specified:
       | OpenApi.IDocument
       | SwaggerV2.IDocument
-      | OpenApiV3.IDocument =
-      config.openapi === "2.0"
-        ? OpenApiConverter.downgradeDocument(document, config.openapi)
-        : config.openapi === "3.0"
-          ? OpenApiConverter.downgradeDocument(document, config.openapi)
-          : document;
+      | OpenApiV3.IDocument
+      | OpenApiV3_1.IDocument
+      | OpenApiV3_2.IDocument =
+      (config.openapi ?? "3.2") === "3.2"
+        ? document
+        : OpenApiConverter.downgradeDocument(document, config.openapi as "2.0");
     await fs.promises.writeFile(
       location,
       !config.beautify
@@ -86,7 +92,7 @@ export namespace SwaggerGenerator {
       .filter((m) => m.size() !== 0);
 
     // COMPOSE JSON SCHEMAS
-    const json: IJsonSchemaCollection = JsonSchemasProgrammer.write({
+    const json: IJsonSchemaCollection = JsonSchemasProgrammer.writeSchemas({
       version: "3.1",
       metadatas,
     });
@@ -155,7 +161,7 @@ export namespace SwaggerGenerator {
     );
 
     return {
-      openapi: "3.1.0",
+      openapi: "3.2.0",
       servers: config.servers ?? [
         {
           url: "https://github.com/samchon/nestia",
@@ -181,7 +187,7 @@ export namespace SwaggerGenerator {
         securitySchemes: config.security,
       },
       tags: config.tags ?? [],
-      "x-samchon-emended-v4": true,
+      "x-typia-emended-v12": true,
     };
   };
 

package/src/generates/internal/SdkDistributionComposer.ts

@@ -1,103 +1,103 @@
-import cp from "child_process";
-import fs from "fs";
-import path from "path";
-import typia from "typia";
-
-import { INestiaConfig } from "../../INestiaConfig";
-
-export namespace SdkDistributionComposer {
-  export const compose = async (props: {
-    config: INestiaConfig;
-    websocket: boolean;
-  }) => {
-    if (!fs.existsSync(props.config.distribute!))
-      await fs.promises.mkdir(props.config.distribute!);
-
-    const root: string = process.cwd();
-    const output: string = path.resolve(props.config.output!);
-    process.chdir(props.config.distribute!);
-
-    const exit = () => process.chdir(root);
-    if (await configured()) return exit();
-
-    // COPY FILES
-    console.log("Composing SDK distribution environments...");
-    for (const file of await fs.promises.readdir(BUNDLE))
-      await fs.promises.copyFile(`${BUNDLE}/${file}`, file);
-
-    // CONFIGURE PATHS
-    for (const file of ["package.json", "tsconfig.json"])
-      await replace({ root, output })(file);
-
-    // INSTALL PACKAGES
-    const v: IDependencies = await dependencies();
-    execute("npm install --save-dev rimraf");
-    execute(`npm install --save @nestia/fetcher@${v.version}`);
-    execute(`npm install --save typia@${v.typia}`);
-    if (props.websocket) execute(`npm install --save tgrid@${v.tgrid}`);
-    execute("npx typia setup --manager npm");
-
-    exit();
-  };
-
-  const configured = async (): Promise<boolean> =>
-    ["package.json", "tsconfig.json"].every(fs.existsSync) &&
-    (await (async () => {
-      const content = JSON.parse(
-        await fs.promises.readFile("package.json", "utf8"),
-      );
-      return !!content.dependencies?.["@nestia/fetcher"];
-    })());
-
-  const execute = (command: string) => {
-    console.log(`  - ${command}`);
-    cp.execSync(command, { stdio: "ignore" });
-  };
-
-  const replace =
-    (props: { root: string; output: string }) =>
-    async (file: string): Promise<void> => {
-      const relative = (from: string) => (to: string) =>
-        path.relative(from, to).split("\\").join("/");
-      const root: string = relative(process.cwd())(props.root);
-      const output: string = relative(process.cwd())(props.output);
-      const current: string = relative(props.root)(process.cwd());
-
-      const content: string = await fs.promises.readFile(file, "utf8");
-      await fs.promises.writeFile(
-        file,
-        content
-          .split("${root}")
-          .join(root)
-          .split("${output}")
-          .join(output)
-          .split("${current}")
-          .join(current),
-        "utf8",
-      );
-    };
-
-  const dependencies = async (): Promise<IDependencies> => {
-    const content: string = await fs.promises.readFile(
-      __dirname + "/../../../package.json",
-      "utf8",
-    );
-    const json: {
-      version: string;
-      dependencies: Record<string, string>;
-      devDependencies: Record<string, string>;
-    } = JSON.parse(content);
-    return typia.assert<IDependencies>({
-      ...json.devDependencies,
-      ...json.dependencies,
-      version: json.version,
-    });
-  };
-}
-
-interface IDependencies {
-  version: string;
-  typia: string;
-  tgrid: string;
-}
-const BUNDLE = __dirname + "/../../../assets/bundle/distribute";
+import cp from "child_process";
+import fs from "fs";
+import path from "path";
+import typia from "typia";
+
+import { INestiaConfig } from "../../INestiaConfig";
+
+export namespace SdkDistributionComposer {
+  export const compose = async (props: {
+    config: INestiaConfig;
+    websocket: boolean;
+  }) => {
+    if (!fs.existsSync(props.config.distribute!))
+      await fs.promises.mkdir(props.config.distribute!);
+
+    const root: string = process.cwd();
+    const output: string = path.resolve(props.config.output!);
+    process.chdir(props.config.distribute!);
+
+    const exit = () => process.chdir(root);
+    if (await configured()) return exit();
+
+    // COPY FILES
+    console.log("Composing SDK distribution environments...");
+    for (const file of await fs.promises.readdir(BUNDLE))
+      await fs.promises.copyFile(`${BUNDLE}/${file}`, file);
+
+    // CONFIGURE PATHS
+    for (const file of ["package.json", "tsconfig.json"])
+      await replace({ root, output })(file);
+
+    // INSTALL PACKAGES
+    const v: IDependencies = await dependencies();
+    execute("npm install --save-dev rimraf");
+    execute(`npm install --save @nestia/fetcher@${v.version}`);
+    execute(`npm install --save typia@${v.typia}`);
+    if (props.websocket) execute(`npm install --save tgrid@${v.tgrid}`);
+    execute("npx typia setup --manager npm");
+
+    exit();
+  };
+
+  const configured = async (): Promise<boolean> =>
+    ["package.json", "tsconfig.json"].every(fs.existsSync) &&
+    (await (async () => {
+      const content = JSON.parse(
+        await fs.promises.readFile("package.json", "utf8"),
+      );
+      return !!content.dependencies?.["@nestia/fetcher"];
+    })());
+
+  const execute = (command: string) => {
+    console.log(`  - ${command}`);
+    cp.execSync(command, { stdio: "ignore" });
+  };
+
+  const replace =
+    (props: { root: string; output: string }) =>
+    async (file: string): Promise<void> => {
+      const relative = (from: string) => (to: string) =>
+        path.relative(from, to).split("\\").join("/");
+      const root: string = relative(process.cwd())(props.root);
+      const output: string = relative(process.cwd())(props.output);
+      const current: string = relative(props.root)(process.cwd());
+
+      const content: string = await fs.promises.readFile(file, "utf8");
+      await fs.promises.writeFile(
+        file,
+        content
+          .split("${root}")
+          .join(root)
+          .split("${output}")
+          .join(output)
+          .split("${current}")
+          .join(current),
+        "utf8",
+      );
+    };
+
+  const dependencies = async (): Promise<IDependencies> => {
+    const content: string = await fs.promises.readFile(
+      __dirname + "/../../../package.json",
+      "utf8",
+    );
+    const json: {
+      version: string;
+      dependencies: Record<string, string>;
+      devDependencies: Record<string, string>;
+    } = JSON.parse(content);
+    return typia.assert<IDependencies>({
+      ...json.devDependencies,
+      ...json.dependencies,
+      version: json.version,
+    });
+  };
+}
+
+interface IDependencies {
+  version: string;
+  typia: string;
+  tgrid: string;
+}
+const BUNDLE = __dirname + "/../../../assets/bundle/distribute";