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

package/src/NestiaSwaggerComposer.ts

@@ -1,6 +1,6 @@
 import { INestApplication } from "@nestjs/common";
 import { IMetadataDictionary } from "@typia/core";
-import { OpenApiV3, SwaggerV2 } from "@typia/interface";
+import { OpenApiV3, OpenApiV3_1, SwaggerV2 } from "@typia/interface";
 import { OpenApiConverter } from "@typia/utils";
 import path from "path";
 import { TreeMap } from "tstl";
@@ -25,18 +25,21 @@ export namespace NestiaSwaggerComposer {
   export const document = async (
     app: INestApplication,
     config: Omit<INestiaConfig.ISwaggerConfig, "output">,
-  ): Promise<OpenApi.IDocument | OpenApiV3.IDocument | SwaggerV2.IDocument> => {
+  ): Promise<
+    | OpenApi.IDocument
+    | OpenApiV3_1.IDocument
+    | OpenApiV3.IDocument
+    | SwaggerV2.IDocument
+  > => {
     const input: INestiaSdkInput = await ConfigAnalyzer.application(app);
     const document: OpenApi.IDocument = await SwaggerGenerator.compose({
       config,
       routes: analyze(input),
       document: await SwaggerGenerator.initialize(config),
     });
-    return config.openapi === "2.0"
-      ? OpenApiConverter.downgradeDocument(document, "2.0")
-      : config.openapi === "3.0"
-        ? OpenApiConverter.downgradeDocument(document, "3.0")
-        : document;
+    return (config.openapi ?? "3.2") === "3.2"
+      ? document
+      : OpenApiConverter.downgradeDocument(document, config.openapi as "2.0");
   };
 
   const analyze = (input: INestiaSdkInput): ITypedHttpRoute[] => {

package/src/analyses/ConfigAnalyzer.ts

@@ -1,155 +1,155 @@
-/// <reference path="../typings/get-function-location.d.ts" />
-import { INestApplication, VersioningType } from "@nestjs/common";
-import { MODULE_PATH } from "@nestjs/common/constants";
-import { NestContainer } from "@nestjs/core";
-import { Module } from "@nestjs/core/injector/module";
-import fs from "fs";
-import getFunctionLocation from "get-function-location";
-import path from "path";
-import { HashMap, Pair, Singleton } from "tstl";
-
-import { INestiaConfig } from "../INestiaConfig";
-import { SdkGenerator } from "../generates/SdkGenerator";
-import { INestiaSdkInput } from "../structures/INestiaSdkInput";
-import { ArrayUtil } from "../utils/ArrayUtil";
-import { MapUtil } from "../utils/MapUtil";
-import { SourceFinder } from "../utils/SourceFinder";
-
-export namespace ConfigAnalyzer {
-  export const input = async (
-    config: INestiaConfig,
-  ): Promise<INestiaSdkInput> => {
-    return MapUtil.take(memory, config, async () => {
-      if (typeof config.input === "function")
-        return application(await config.input());
-
-      const sources: string[] = await SourceFinder.find({
-        include: Array.isArray(config.input)
-          ? config.input
-          : typeof config.input === "object"
-            ? config.input.include
-            : [config.input],
-        exclude:
-          typeof config.input === "object" && !Array.isArray(config.input)
-            ? (config.input.exclude ?? [])
-            : [],
-        filter: filter(config),
-      });
-      const controllers: INestiaSdkInput.IController[] = [];
-      for (const file of sources) {
-        const external: any[] = await import(file);
-        for (const key in external) {
-          const instance: Function = external[key];
-          if (Reflect.getMetadata("path", instance) !== undefined)
-            controllers.push({
-              class: instance,
-              location: file,
-              prefixes: [],
-            });
-        }
-      }
-      return {
-        controllers,
-      };
-    });
-  };
-
-  export const application = async (
-    app: INestApplication,
-  ): Promise<INestiaSdkInput> => {
-    const container: NestContainer = (app as any).container as NestContainer;
-    const modules: Module[] = [...container.getModules().values()].filter(
-      (m) => !!m.controllers.size,
-    );
-    const unique: HashMap<Function, Set<string>> = new HashMap();
-
-    for (const m of modules) {
-      const path: string =
-        Reflect.getMetadata(
-          MODULE_PATH + container.getModules().applicationId,
-          m.metatype,
-        ) ??
-        Reflect.getMetadata(MODULE_PATH, m.metatype) ??
-        "";
-      for (const controller of [...m.controllers.keys()])
-        if (typeof controller === "function")
-          unique.take(controller, () => new Set()).add(path);
-    }
-    const controllers: INestiaSdkInput.IController[] = [];
-    for (const it of unique) {
-      const file: string | null =
-        (await getFunctionLocation(it.first))?.source ?? null;
-      if (file === null) continue;
-      const location: string = normalize_file(file);
-      if (location.length === 0) continue;
-      controllers.push({
-        class: it.first,
-        prefixes: Array.from(it.second),
-        location,
-      });
-    }
-
-    const versioning = (app as any).config?.versioningOptions;
-    return {
-      controllers,
-      globalPrefix:
-        typeof (app as any).config?.globalPrefix === "string"
-          ? {
-              prefix: (app as any).config.globalPrefix,
-              exclude: (app as any).config.globalPrefixOptions?.exclude ?? {},
-            }
-          : undefined,
-      versioning:
-        versioning === undefined || versioning.type !== VersioningType.URI
-          ? undefined
-          : {
-              prefix:
-                versioning.prefix === undefined || versioning.prefix === false
-                  ? "v"
-                  : versioning.prefix,
-              defaultVersion: versioning.defaultVersion,
-            },
-    };
-  };
-}
-const memory = new Map<INestiaConfig, Promise<INestiaSdkInput>>();
-const normalize_file = (str: string) =>
-  str.substring(
-    str.startsWith("file:///")
-      ? process.cwd()[0] === "/"
-        ? 7
-        : 8
-      : str.startsWith("file://")
-        ? 7
-        : 0,
-  );
-
-const filter =
-  (config: INestiaConfig) =>
-  async (location: string): Promise<boolean> =>
-    location.endsWith(".ts") &&
-    !location.endsWith(".d.ts") &&
-    (config.output === undefined ||
-      (location.indexOf(path.join(config.output, "functional")) === -1 &&
-        (await (
-          await bundler.get(config.output)
-        )(location))) === false);
-
-const bundler = new Singleton(async (output: string) => {
-  const assets: string[] = await fs.promises.readdir(SdkGenerator.BUNDLE_PATH);
-  const tuples: Pair<string, boolean>[] = await ArrayUtil.asyncMap(
-    assets,
-    async (file) => {
-      const relative: string = path.join(output, file);
-      const location: string = path.join(SdkGenerator.BUNDLE_PATH, file);
-      const stats: fs.Stats = await fs.promises.stat(location);
-      return new Pair(relative, stats.isDirectory());
-    },
-  );
-  return async (file: string): Promise<boolean> => {
-    for (const it of tuples)
-      if (it.second === false && file === it.first) return true;
-      else if (it.second === true && file.indexOf(it.first) === 0) return true;
-    return false;
-  };
-});
+/// <reference path="../typings/get-function-location.d.ts" />
+import { INestApplication, VersioningType } from "@nestjs/common";
+import { MODULE_PATH } from "@nestjs/common/constants";
+import { NestContainer } from "@nestjs/core";
+import { Module } from "@nestjs/core/injector/module";
+import fs from "fs";
+import getFunctionLocation from "get-function-location";
+import path from "path";
+import { HashMap, Pair, Singleton } from "tstl";
+
+import { INestiaConfig } from "../INestiaConfig";
+import { SdkGenerator } from "../generates/SdkGenerator";
+import { INestiaSdkInput } from "../structures/INestiaSdkInput";
+import { ArrayUtil } from "../utils/ArrayUtil";
+import { MapUtil } from "../utils/MapUtil";
+import { SourceFinder } from "../utils/SourceFinder";
+
+export namespace ConfigAnalyzer {
+  export const input = async (
+    config: INestiaConfig,
+  ): Promise<INestiaSdkInput> => {
+    return MapUtil.take(memory, config, async () => {
+      if (typeof config.input === "function")
+        return application(await config.input());
+
+      const sources: string[] = await SourceFinder.find({
+        include: Array.isArray(config.input)
+          ? config.input
+          : typeof config.input === "object"
+            ? config.input.include
+            : [config.input],
+        exclude:
+          typeof config.input === "object" && !Array.isArray(config.input)
+            ? (config.input.exclude ?? [])
+            : [],
+        filter: filter(config),
+      });
+      const controllers: INestiaSdkInput.IController[] = [];
+      for (const file of sources) {
+        const external: any[] = await import(file);
+        for (const key in external) {
+          const instance: Function = external[key];
+          if (Reflect.getMetadata("path", instance) !== undefined)
+            controllers.push({
+              class: instance,
+              location: file,
+              prefixes: [],
+            });
+        }
+      }
+      return {
+        controllers,
+      };
+    });
+  };
+
+  export const application = async (
+    app: INestApplication,
+  ): Promise<INestiaSdkInput> => {
+    const container: NestContainer = (app as any).container as NestContainer;
+    const modules: Module[] = [...container.getModules().values()].filter(
+      (m) => !!m.controllers.size,
+    );
+    const unique: HashMap<Function, Set<string>> = new HashMap();
+
+    for (const m of modules) {
+      const path: string =
+        Reflect.getMetadata(
+          MODULE_PATH + container.getModules().applicationId,
+          m.metatype,
+        ) ??
+        Reflect.getMetadata(MODULE_PATH, m.metatype) ??
+        "";
+      for (const controller of [...m.controllers.keys()])
+        if (typeof controller === "function")
+          unique.take(controller, () => new Set()).add(path);
+    }
+    const controllers: INestiaSdkInput.IController[] = [];
+    for (const it of unique) {
+      const file: string | null =
+        (await getFunctionLocation(it.first))?.source ?? null;
+      if (file === null) continue;
+      const location: string = normalize_file(file);
+      if (location.length === 0) continue;
+      controllers.push({
+        class: it.first,
+        prefixes: Array.from(it.second),
+        location,
+      });
+    }
+
+    const versioning = (app as any).config?.versioningOptions;
+    return {
+      controllers,
+      globalPrefix:
+        typeof (app as any).config?.globalPrefix === "string"
+          ? {
+              prefix: (app as any).config.globalPrefix,
+              exclude: (app as any).config.globalPrefixOptions?.exclude ?? {},
+            }
+          : undefined,
+      versioning:
+        versioning === undefined || versioning.type !== VersioningType.URI
+          ? undefined
+          : {
+              prefix:
+                versioning.prefix === undefined || versioning.prefix === false
+                  ? "v"
+                  : versioning.prefix,
+              defaultVersion: versioning.defaultVersion,
+            },
+    };
+  };
+}
+const memory = new Map<INestiaConfig, Promise<INestiaSdkInput>>();
+const normalize_file = (str: string) =>
+  str.substring(
+    str.startsWith("file:///")
+      ? process.cwd()[0] === "/"
+        ? 7
+        : 8
+      : str.startsWith("file://")
+        ? 7
+        : 0,
+  );
+
+const filter =
+  (config: INestiaConfig) =>
+  async (location: string): Promise<boolean> =>
+    location.endsWith(".ts") &&
+    !location.endsWith(".d.ts") &&
+    (config.output === undefined ||
+      (location.indexOf(path.join(config.output, "functional")) === -1 &&
+        (await (
+          await bundler.get(config.output)
+        )(location))) === false);
+
+const bundler = new Singleton(async (output: string) => {
+  const assets: string[] = await fs.promises.readdir(SdkGenerator.BUNDLE_PATH);
+  const tuples: Pair<string, boolean>[] = await ArrayUtil.asyncMap(
+    assets,
+    async (file) => {
+      const relative: string = path.join(output, file);
+      const location: string = path.join(SdkGenerator.BUNDLE_PATH, file);
+      const stats: fs.Stats = await fs.promises.stat(location);
+      return new Pair(relative, stats.isDirectory());
+    },
+  );
+  return async (file: string): Promise<boolean> => {
+    for (const it of tuples)
+      if (it.second === false && file === it.first) return true;
+      else if (it.second === true && file.indexOf(it.first) === 0) return true;
+    return false;
+  };
+});

package/src/analyses/ExceptionAnalyzer.ts

@@ -1,154 +1,154 @@
-// import path from "path";
-// import ts from "typescript";
-// import { MetadataCollection } from "typia/lib/factories/MetadataCollection";
-// import { MetadataFactory } from "typia/lib/factories/MetadataFactory";
-// import { Metadata } from "typia/lib/schemas/metadata/Metadata";
-
-// import { INestiaProject } from "../structures/INestiaProject";
-// import { IReflectController } from "../structures/IReflectController";
-// import { IReflectHttpOperation } from "../structures/IReflectHttpOperation";
-// import { ITypeTuple } from "../structures/ITypeTuple";
-// import { ITypedHttpRoute } from "../structures/ITypedHttpRoute";
-// import { GenericAnalyzer } from "./GenericAnalyzer";
-// import { ImportAnalyzer } from "./ImportAnalyzer";
-
-// export namespace ExceptionAnalyzer {
-//   export const analyze =
-//     (project: INestiaProject) =>
-//     (props: {
-//       generics: GenericAnalyzer.Dictionary;
-//       imports: ImportAnalyzer.Dictionary;
-//       controller: IReflectController;
-//       operation: IReflectHttpOperation;
-//       declaration: ts.MethodDeclaration;
-//     }): Record<
-//       number | "2XX" | "3XX" | "4XX" | "5XX",
-//       ITypedHttpRoute.IOutput
-//     > => {
-//       const output: Record<
-//         number | "2XX" | "3XX" | "4XX" | "5XX",
-//         ITypedHttpRoute.IOutput
-//       > = {} as any;
-//       for (const decorator of props.declaration.modifiers ?? [])
-//         if (ts.isDecorator(decorator))
-//           analyzeTyped(project)({
-//             ...props,
-//             output,
-//             decorator,
-//           });
-//       return output;
-//     };
-
-//   const analyzeTyped =
-//     (project: INestiaProject) =>
-//     (props: {
-//       generics: GenericAnalyzer.Dictionary;
-//       imports: ImportAnalyzer.Dictionary;
-//       controller: IReflectController;
-//       operation: IReflectHttpOperation;
-//       output: Record<
-//         number | "2XX" | "3XX" | "4XX" | "5XX",
-//         ITypedHttpRoute.IOutput
-//       >;
-//       decorator: ts.Decorator;
-//     }): boolean => {
-//       // CHECK DECORATOR
-//       if (!ts.isCallExpression(props.decorator.expression)) return false;
-//       else if ((props.decorator.expression.typeArguments ?? []).length !== 1)
-//         return false;
-
-//       // CHECK SIGNATURE
-//       const signature: ts.Signature | undefined =
-//         project.checker.getResolvedSignature(props.decorator.expression);
-//       if (!signature || !signature.declaration) return false;
-//       else if (
-//         path
-//           .resolve(signature.declaration.getSourceFile().fileName)
-//           .indexOf(TYPED_EXCEPTION_PATH) === -1
-//       )
-//         return false;
-
-//       // GET TYPE INFO
-//       const status: string | null = getStatus(project.checker)(
-//         props.decorator.expression.arguments[0] ?? null,
-//       );
-//       if (status === null) return false;
-
-//       const node: ts.TypeNode = props.decorator.expression.typeArguments![0];
-//       const type: ts.Type = project.checker.getTypeFromTypeNode(node);
-//       if (type.isTypeParameter()) {
-//         project.errors.push({
-//           file: props.controller.file,
-//           controller: props.controller.name,
-//           function: props.operation.name,
-//           message: "TypedException() without generic argument specification.",
-//         });
-//         return false;
-//       }
-
-//       const tuple: ITypeTuple | null = ImportAnalyzer.analyze(project.checker)({
-//         generics: props.generics,
-//         imports: props.imports,
-//         type,
-//       });
-//       if (tuple === null) {
-//         project.errors.push({
-//           file: props.controller.file,
-//           controller: props.controller.name,
-//           function: props.operation.name,
-//           message: `TypeException() with unknown type on ${status} status.`,
-//         });
-//         return false;
-//       }
-
-//       // DO ASSIGN
-//       const matched: IReflectHttpOperation.IException[] = Object.entries(
-//         props.operation.exceptions,
-//       )
-//         .filter(([key]) => status === key)
-//         .map(([_key, value]) => value);
-//       for (const m of matched)
-//         props.output[m.status] = {
-//           type: tuple.type,
-//           typeName: tuple.typeName,
-//           contentType: "application/json",
-//           description: m.description,
-//         };
-//       return true;
-//     };
-
-//   const getStatus =
-//     (checker: ts.TypeChecker) =>
-//     (expression: ts.Expression | null): string | null => {
-//       if (expression === null) return null;
-
-//       const type: ts.Type = checker.getTypeAtLocation(expression);
-//       const result = MetadataFactory.analyze(checker)({
-//         escape: true,
-//         constant: true,
-//         absorb: true,
-//       })(new MetadataCollection())(type);
-//       if (false === result.success) return null;
-
-//       const meta: Metadata = result.data;
-//       if (meta.constants.length === 1)
-//         return meta.constants[0].values[0].value.toString();
-//       else if (meta.escaped && meta.escaped.returns.constants.length === 1)
-//         return meta.escaped.returns.constants[0].values[0].value.toString();
-//       else if (ts.isStringLiteral(expression)) return expression.text;
-//       else if (ts.isNumericLiteral(expression)) {
-//         const value: number = Number(expression.text.split("_").join(""));
-//         if (false === isNaN(value)) return value.toString();
-//       }
-//       return null;
-//     };
-// }
-
-// const TYPED_EXCEPTION_PATH = path.join(
-//   "node_modules",
-//   "@nestia",
-//   "core",
-//   "lib",
-//   "decorators",
-//   "TypedException.d.ts",
-// );
+// import path from "path";
+// import ts from "typescript";
+// import { MetadataCollection } from "typia/lib/factories/MetadataCollection";
+// import { MetadataFactory } from "typia/lib/factories/MetadataFactory";
+// import { Metadata } from "typia/lib/schemas/metadata/Metadata";
+
+// import { INestiaProject } from "../structures/INestiaProject";
+// import { IReflectController } from "../structures/IReflectController";
+// import { IReflectHttpOperation } from "../structures/IReflectHttpOperation";
+// import { ITypeTuple } from "../structures/ITypeTuple";
+// import { ITypedHttpRoute } from "../structures/ITypedHttpRoute";
+// import { GenericAnalyzer } from "./GenericAnalyzer";
+// import { ImportAnalyzer } from "./ImportAnalyzer";
+
+// export namespace ExceptionAnalyzer {
+//   export const analyze =
+//     (project: INestiaProject) =>
+//     (props: {
+//       generics: GenericAnalyzer.Dictionary;
+//       imports: ImportAnalyzer.Dictionary;
+//       controller: IReflectController;
+//       operation: IReflectHttpOperation;
+//       declaration: ts.MethodDeclaration;
+//     }): Record<
+//       number | "2XX" | "3XX" | "4XX" | "5XX",
+//       ITypedHttpRoute.IOutput
+//     > => {
+//       const output: Record<
+//         number | "2XX" | "3XX" | "4XX" | "5XX",
+//         ITypedHttpRoute.IOutput
+//       > = {} as any;
+//       for (const decorator of props.declaration.modifiers ?? [])
+//         if (ts.isDecorator(decorator))
+//           analyzeTyped(project)({
+//             ...props,
+//             output,
+//             decorator,
+//           });
+//       return output;
+//     };
+
+//   const analyzeTyped =
+//     (project: INestiaProject) =>
+//     (props: {
+//       generics: GenericAnalyzer.Dictionary;
+//       imports: ImportAnalyzer.Dictionary;
+//       controller: IReflectController;
+//       operation: IReflectHttpOperation;
+//       output: Record<
+//         number | "2XX" | "3XX" | "4XX" | "5XX",
+//         ITypedHttpRoute.IOutput
+//       >;
+//       decorator: ts.Decorator;
+//     }): boolean => {
+//       // CHECK DECORATOR
+//       if (!ts.isCallExpression(props.decorator.expression)) return false;
+//       else if ((props.decorator.expression.typeArguments ?? []).length !== 1)
+//         return false;
+
+//       // CHECK SIGNATURE
+//       const signature: ts.Signature | undefined =
+//         project.checker.getResolvedSignature(props.decorator.expression);
+//       if (!signature || !signature.declaration) return false;
+//       else if (
+//         path
+//           .resolve(signature.declaration.getSourceFile().fileName)
+//           .indexOf(TYPED_EXCEPTION_PATH) === -1
+//       )
+//         return false;
+
+//       // GET TYPE INFO
+//       const status: string | null = getStatus(project.checker)(
+//         props.decorator.expression.arguments[0] ?? null,
+//       );
+//       if (status === null) return false;
+
+//       const node: ts.TypeNode = props.decorator.expression.typeArguments![0];
+//       const type: ts.Type = project.checker.getTypeFromTypeNode(node);
+//       if (type.isTypeParameter()) {
+//         project.errors.push({
+//           file: props.controller.file,
+//           controller: props.controller.name,
+//           function: props.operation.name,
+//           message: "TypedException() without generic argument specification.",
+//         });
+//         return false;
+//       }
+
+//       const tuple: ITypeTuple | null = ImportAnalyzer.analyze(project.checker)({
+//         generics: props.generics,
+//         imports: props.imports,
+//         type,
+//       });
+//       if (tuple === null) {
+//         project.errors.push({
+//           file: props.controller.file,
+//           controller: props.controller.name,
+//           function: props.operation.name,
+//           message: `TypeException() with unknown type on ${status} status.`,
+//         });
+//         return false;
+//       }
+
+//       // DO ASSIGN
+//       const matched: IReflectHttpOperation.IException[] = Object.entries(
+//         props.operation.exceptions,
+//       )
+//         .filter(([key]) => status === key)
+//         .map(([_key, value]) => value);
+//       for (const m of matched)
+//         props.output[m.status] = {
+//           type: tuple.type,
+//           typeName: tuple.typeName,
+//           contentType: "application/json",
+//           description: m.description,
+//         };
+//       return true;
+//     };
+
+//   const getStatus =
+//     (checker: ts.TypeChecker) =>
+//     (expression: ts.Expression | null): string | null => {
+//       if (expression === null) return null;
+
+//       const type: ts.Type = checker.getTypeAtLocation(expression);
+//       const result = MetadataFactory.analyze(checker)({
+//         escape: true,
+//         constant: true,
+//         absorb: true,
+//       })(new MetadataCollection())(type);
+//       if (false === result.success) return null;
+
+//       const meta: Metadata = result.data;
+//       if (meta.constants.length === 1)
+//         return meta.constants[0].values[0].value.toString();
+//       else if (meta.escaped && meta.escaped.returns.constants.length === 1)
+//         return meta.escaped.returns.constants[0].values[0].value.toString();
+//       else if (ts.isStringLiteral(expression)) return expression.text;
+//       else if (ts.isNumericLiteral(expression)) {
+//         const value: number = Number(expression.text.split("_").join(""));
+//         if (false === isNaN(value)) return value.toString();
+//       }
+//       return null;
+//     };
+// }
+
+// const TYPED_EXCEPTION_PATH = path.join(
+//   "node_modules",
+//   "@nestia",
+//   "core",
+//   "lib",
+//   "decorators",
+//   "TypedException.d.ts",
+// );