@nestia/sdk 4.4.2 → 4.5.0-dev.20241218

package/src/generates/internal/SwaggerOperationResponseComposer.ts

@@ -1,110 +1,110 @@
-import { OpenApi } from "@samchon/openapi";
-import { VariadicSingleton } from "tstl";
-import { Metadata } from "typia/lib/schemas/metadata/Metadata";
-
-import { ITypedHttpRoute } from "../../structures/ITypedHttpRoute";
-import { StringUtil } from "../../utils/StringUtil";
-import { SwaggerDescriptionComposer } from "./SwaggerDescriptionComposer";
-
-export namespace SwaggerOperationResponseComposer {
-  export const compose = (props: {
-    schema: (metadata: Metadata) => OpenApi.IJsonSchema | undefined;
-    route: ITypedHttpRoute;
-  }): Record<string, OpenApi.IOperation.IResponse> => {
-    const output: Record<string, OpenApi.IOperation.IResponse> = {};
-    // FROM DECORATOR
-    for (const [status, error] of Object.entries(props.route.exceptions))
-      output[status] = {
-        description: error.description ?? undefined,
-        content: {
-          "application/json": {
-            schema: props.schema(error.metadata),
-            example: error.example,
-            examples: error.examples,
-          },
-        },
-      };
-
-    // FROM COMMENTS
-    for (const tag of props.route.jsDocTags) {
-      if (tag.name !== "throw" && tag.name !== "throws") continue;
-      const text: string | undefined = tag.text?.find(
-        (elem) => elem.kind === "text",
-      )?.text;
-      if (text === undefined) continue;
-
-      const elements: string[] = text.split(" ").map((str) => str.trim());
-      const status: string = elements[0];
-      if (
-        isNaN(Number(status)) &&
-        status !== "2XX" &&
-        status !== "3XX" &&
-        status !== "4XX" &&
-        status !== "5XX"
-      )
-        continue;
-
-      const description: string | undefined =
-        elements.length === 1 ? undefined : elements.slice(1).join(" ");
-      const oldbie = output[status];
-      if (description && oldbie !== undefined)
-        oldbie.description ??= description;
-      else if (oldbie === undefined)
-        output[status] = {
-          description: description,
-          content: {
-            "application/json": {
-              schema: {},
-            },
-          },
-        };
-    }
-
-    // SUCESS
-    const description: string | undefined =
-      SwaggerDescriptionComposer.descriptionFromJsDocTag({
-        jsDocTags: props.route.jsDocTags,
-        tag: "returns",
-      }) ??
-      SwaggerDescriptionComposer.descriptionFromJsDocTag({
-        jsDocTags: props.route.jsDocTags,
-        tag: "return",
-      });
-    output[
-      props.route.success.status ??
-        (props.route.method.toLowerCase() === "post" ? 201 : 200)
-    ] = {
-      description: props.route.success.encrypted
-        ? `${warning.get(!!description, props.route.method)}${description ?? ""}`
-        : (description ?? ""),
-      content: props.route.success.contentType
-        ? {
-            [props.route.success.contentType]: {
-              schema: props.schema(props.route.success.metadata),
-              example: props.route.success.example,
-              examples: props.route.success.examples,
-            },
-          }
-        : undefined,
-      ...(props.route.success.encrypted ? { "x-nestia-encrypted": true } : {}),
-    };
-    return output;
-  };
-}
-
-const warning = new VariadicSingleton((described: boolean, method: string) => {
-  const summary: string = "Response data have been encrypted.";
-  const component: string = `[EncryptedRoute.${StringUtil.capitalize(method)}](https://github.com/samchon/@nestia/core#encryptedroute)`;
-
-  const content: string[] = [
-    "## Warning",
-    "",
-    summary,
-    "",
-    `The response body data would be encrypted as "AES-128(256) / CBC mode / PKCS#5 Padding / Base64 Encoding", through the ${component} component.`,
-    "",
-    `Therefore, just utilize this swagger editor only for referencing. If you need to call the real API, using [SDK](https://github.com/samchon/nestia#software-development-kit) would be much better.`,
-  ];
-  if (described === true) content.push("", "----------------", "", "");
-  return content.join("\n");
-});
+import { OpenApi } from "@samchon/openapi";
+import { VariadicSingleton } from "tstl";
+import { Metadata } from "typia/lib/schemas/metadata/Metadata";
+
+import { ITypedHttpRoute } from "../../structures/ITypedHttpRoute";
+import { StringUtil } from "../../utils/StringUtil";
+import { SwaggerDescriptionComposer } from "./SwaggerDescriptionComposer";
+
+export namespace SwaggerOperationResponseComposer {
+  export const compose = (props: {
+    schema: (metadata: Metadata) => OpenApi.IJsonSchema | undefined;
+    route: ITypedHttpRoute;
+  }): Record<string, OpenApi.IOperation.IResponse> => {
+    const output: Record<string, OpenApi.IOperation.IResponse> = {};
+    // FROM DECORATOR
+    for (const [status, error] of Object.entries(props.route.exceptions))
+      output[status] = {
+        description: error.description ?? undefined,
+        content: {
+          "application/json": {
+            schema: props.schema(error.metadata),
+            example: error.example,
+            examples: error.examples,
+          },
+        },
+      };
+
+    // FROM COMMENTS
+    for (const tag of props.route.jsDocTags) {
+      if (tag.name !== "throw" && tag.name !== "throws") continue;
+      const text: string | undefined = tag.text?.find(
+        (elem) => elem.kind === "text",
+      )?.text;
+      if (text === undefined) continue;
+
+      const elements: string[] = text.split(" ").map((str) => str.trim());
+      const status: string = elements[0];
+      if (
+        isNaN(Number(status)) &&
+        status !== "2XX" &&
+        status !== "3XX" &&
+        status !== "4XX" &&
+        status !== "5XX"
+      )
+        continue;
+
+      const description: string | undefined =
+        elements.length === 1 ? undefined : elements.slice(1).join(" ");
+      const oldbie = output[status];
+      if (description && oldbie !== undefined)
+        oldbie.description ??= description;
+      else if (oldbie === undefined)
+        output[status] = {
+          description: description,
+          content: {
+            "application/json": {
+              schema: {},
+            },
+          },
+        };
+    }
+
+    // SUCESS
+    const description: string | undefined =
+      SwaggerDescriptionComposer.descriptionFromJsDocTag({
+        jsDocTags: props.route.jsDocTags,
+        tag: "returns",
+      }) ??
+      SwaggerDescriptionComposer.descriptionFromJsDocTag({
+        jsDocTags: props.route.jsDocTags,
+        tag: "return",
+      });
+    output[
+      props.route.success.status ??
+        (props.route.method.toLowerCase() === "post" ? 201 : 200)
+    ] = {
+      description: props.route.success.encrypted
+        ? `${warning.get(!!description, props.route.method)}${description ?? ""}`
+        : (description ?? ""),
+      content: props.route.success.contentType
+        ? {
+            [props.route.success.contentType]: {
+              schema: props.schema(props.route.success.metadata),
+              example: props.route.success.example,
+              examples: props.route.success.examples,
+            },
+          }
+        : undefined,
+      ...(props.route.success.encrypted ? { "x-nestia-encrypted": true } : {}),
+    };
+    return output;
+  };
+}
+
+const warning = new VariadicSingleton((described: boolean, method: string) => {
+  const summary: string = "Response data have been encrypted.";
+  const component: string = `[EncryptedRoute.${StringUtil.capitalize(method)}](https://github.com/samchon/@nestia/core#encryptedroute)`;
+
+  const content: string[] = [
+    "## Warning",
+    "",
+    summary,
+    "",
+    `The response body data would be encrypted as "AES-128(256) / CBC mode / PKCS#5 Padding / Base64 Encoding", through the ${component} component.`,
+    "",
+    `Therefore, just utilize this swagger editor only for referencing. If you need to call the real API, using [SDK](https://github.com/samchon/nestia#software-development-kit) would be much better.`,
+  ];
+  if (described === true) content.push("", "----------------", "", "");
+  return content.join("\n");
+});

package/src/index.ts

@@ -1,4 +1,4 @@
-import * as nestia from "./module";
-
-export * from "./module";
-export default nestia;
+import * as nestia from "./module";
+
+export * from "./module";
+export default nestia;

package/src/module.ts

@@ -1,3 +1,3 @@
-export * from "./INestiaConfig";
-export * from "./NestiaSdkApplication";
-export * from "./NestiaSwaggerComposer";
+export * from "./INestiaConfig";
+export * from "./NestiaSdkApplication";
+export * from "./NestiaSwaggerComposer";

package/src/structures/INestiaProject.ts

@@ -1,13 +1,13 @@
-import ts from "typescript";
-
-import { INestiaConfig } from "../INestiaConfig";
-import { INestiaSdkInput } from "./INestiaSdkInput";
-import { IReflectOperationError } from "./IReflectOperationError";
-
-export interface INestiaProject {
-  config: INestiaConfig;
-  input: INestiaSdkInput;
-  checker: ts.TypeChecker;
-  errors: IReflectOperationError[];
-  warnings: IReflectOperationError[];
-}
+import ts from "typescript";
+
+import { INestiaConfig } from "../INestiaConfig";
+import { INestiaSdkInput } from "./INestiaSdkInput";
+import { IReflectOperationError } from "./IReflectOperationError";
+
+export interface INestiaProject {
+  config: INestiaConfig;
+  input: INestiaSdkInput;
+  checker: ts.TypeChecker;
+  errors: IReflectOperationError[];
+  warnings: IReflectOperationError[];
+}

package/src/structures/INestiaSdkInput.ts

@@ -1,20 +1,20 @@
-import { RouteInfo, VersionValue } from "@nestjs/common/interfaces";
-
-export interface INestiaSdkInput {
-  controllers: INestiaSdkInput.IController[];
-  globalPrefix?: {
-    prefix: string;
-    exclude?: Array<string | RouteInfo>;
-  };
-  versioning?: {
-    prefix: string;
-    defaultVersion?: VersionValue;
-  };
-}
-export namespace INestiaSdkInput {
-  export interface IController {
-    class: Function;
-    location: string;
-    prefixes: string[];
-  }
-}
+import { RouteInfo, VersionValue } from "@nestjs/common/interfaces";
+
+export interface INestiaSdkInput {
+  controllers: INestiaSdkInput.IController[];
+  globalPrefix?: {
+    prefix: string;
+    exclude?: Array<string | RouteInfo>;
+  };
+  versioning?: {
+    prefix: string;
+    defaultVersion?: VersionValue;
+  };
+}
+export namespace INestiaSdkInput {
+  export interface IController {
+    class: Function;
+    location: string;
+    prefixes: string[];
+  }
+}

package/src/structures/IReflectApplication.ts

@@ -1,8 +1,8 @@
-import { INestApplication } from "@nestjs/common";
-
-import { IReflectController } from "./IReflectController";
-
-export interface IReflectApplication {
-  application: INestApplication;
-  controllers: IReflectController[];
-}
+import { INestApplication } from "@nestjs/common";
+
+import { IReflectController } from "./IReflectController";
+
+export interface IReflectApplication {
+  application: INestApplication;
+  controllers: IReflectController[];
+}

package/src/structures/IReflectController.ts

@@ -1,15 +1,15 @@
-import type { VERSION_NEUTRAL } from "@nestjs/common/interfaces";
-
-import { IReflectHttpOperation } from "./IReflectHttpOperation";
-import { IReflectWebSocketOperation } from "./IReflectWebSocketOperation";
-
-export interface IReflectController {
-  class: Function;
-  prefixes: string[];
-  paths: string[];
-  file: string;
-  versions: Array<string | typeof VERSION_NEUTRAL> | undefined;
-  operations: Array<IReflectHttpOperation | IReflectWebSocketOperation>;
-  security: Record<string, string[]>[];
-  tags: string[];
-}
+import type { VERSION_NEUTRAL } from "@nestjs/common/interfaces";
+
+import { IReflectHttpOperation } from "./IReflectHttpOperation";
+import { IReflectWebSocketOperation } from "./IReflectWebSocketOperation";
+
+export interface IReflectController {
+  class: Function;
+  prefixes: string[];
+  paths: string[];
+  file: string;
+  versions: Array<string | typeof VERSION_NEUTRAL> | undefined;
+  operations: Array<IReflectHttpOperation | IReflectWebSocketOperation>;
+  security: Record<string, string[]>[];
+  tags: string[];
+}

package/src/structures/IReflectHttpOperation.ts

@@ -1,26 +1,26 @@
-import { VERSION_NEUTRAL } from "@nestjs/common/interfaces";
-import { IJsDocTagInfo } from "typia";
-
-import { IReflectHttpOperationException } from "./IReflectHttpOperationException";
-import { IReflectHttpOperationParameter } from "./IReflectHttpOperationParameter";
-import { IReflectHttpOperationSuccess } from "./IReflectHttpOperationSuccess";
-import { IReflectTypeImport } from "./IReflectTypeImport";
-
-export interface IReflectHttpOperation {
-  protocol: "http";
-  function: Function;
-  name: string;
-  method: string;
-  paths: string[];
-  versions: Array<string | typeof VERSION_NEUTRAL> | undefined;
-  parameters: IReflectHttpOperationParameter[];
-  success: IReflectHttpOperationSuccess;
-  exceptions: Record<string, IReflectHttpOperationException>;
-  security: Record<string, string[]>[];
-  tags: string[];
-  imports: IReflectTypeImport[];
-  operationId: string | undefined;
-  description: string | null;
-  jsDocTags: IJsDocTagInfo[];
-  extensions?: Record<string, any>;
-}
+import { VERSION_NEUTRAL } from "@nestjs/common/interfaces";
+import { IJsDocTagInfo } from "typia";
+
+import { IReflectHttpOperationException } from "./IReflectHttpOperationException";
+import { IReflectHttpOperationParameter } from "./IReflectHttpOperationParameter";
+import { IReflectHttpOperationSuccess } from "./IReflectHttpOperationSuccess";
+import { IReflectTypeImport } from "./IReflectTypeImport";
+
+export interface IReflectHttpOperation {
+  protocol: "http";
+  function: Function;
+  name: string;
+  method: string;
+  paths: string[];
+  versions: Array<string | typeof VERSION_NEUTRAL> | undefined;
+  parameters: IReflectHttpOperationParameter[];
+  success: IReflectHttpOperationSuccess;
+  exceptions: Record<string, IReflectHttpOperationException>;
+  security: Record<string, string[]>[];
+  tags: string[];
+  imports: IReflectTypeImport[];
+  operationId: string | undefined;
+  description: string | null;
+  jsDocTags: IJsDocTagInfo[];
+  extensions?: Record<string, any>;
+}

package/src/structures/IReflectHttpOperationException.ts

@@ -1,19 +1,19 @@
-import { MetadataFactory } from "typia/lib/factories/MetadataFactory";
-import { IMetadata } from "typia/lib/schemas/metadata/IMetadata";
-import { IMetadataComponents } from "typia/lib/schemas/metadata/IMetadataComponents";
-
-import { IReflectType } from "./IReflectType";
-
-export interface IReflectHttpOperationException {
-  // BASIC PROPERTIES
-  status: number | "2XX" | "3XX" | "4XX" | "5XX";
-  description: string | null;
-  example?: any;
-  examples?: Record<string, any>;
-
-  // REFLECTED PROPERTIES
-  type: IReflectType;
-  metadata: IMetadata;
-  components: IMetadataComponents;
-  validate: MetadataFactory.Validator;
-}
+import { MetadataFactory } from "typia/lib/factories/MetadataFactory";
+import { IMetadata } from "typia/lib/schemas/metadata/IMetadata";
+import { IMetadataComponents } from "typia/lib/schemas/metadata/IMetadataComponents";
+
+import { IReflectType } from "./IReflectType";
+
+export interface IReflectHttpOperationException {
+  // BASIC PROPERTIES
+  status: number | "2XX" | "3XX" | "4XX" | "5XX";
+  description: string | null;
+  example?: any;
+  examples?: Record<string, any>;
+
+  // REFLECTED PROPERTIES
+  type: IReflectType;
+  metadata: IMetadata;
+  components: IMetadataComponents;
+  validate: MetadataFactory.Validator;
+}

package/src/structures/IReflectHttpOperationParameter.ts

@@ -1,81 +1,81 @@
-import { IJsDocTagInfo } from "typia";
-import { MetadataFactory } from "typia/lib/factories/MetadataFactory";
-import { IMetadata } from "typia/lib/schemas/metadata/IMetadata";
-import { IMetadataComponents } from "typia/lib/schemas/metadata/IMetadataComponents";
-
-import { IReflectType } from "./IReflectType";
-
-export type IReflectHttpOperationParameter =
-  | IReflectHttpOperationParameter.IBody
-  | IReflectHttpOperationParameter.IHeaders
-  | IReflectHttpOperationParameter.IParam
-  | IReflectHttpOperationParameter.IQuery;
-export namespace IReflectHttpOperationParameter {
-  export interface IBody extends IBase<"body"> {
-    contentType:
-      | "application/json"
-      | "application/x-www-form-urlencoded"
-      | "multipart/form-data"
-      | "text/plain";
-    encrypted: boolean;
-  }
-  export interface IHeaders extends IBase<"headers"> {
-    field: string | null;
-  }
-  export interface IParam extends IBase<"param"> {
-    field: string;
-  }
-  export interface IQuery extends IBase<"query"> {
-    field: string | null;
-  }
-  interface IBase<Category extends string> {
-    category: Category;
-    name: string;
-    index: number;
-    type: IReflectType;
-    metadata: IMetadata;
-    components: IMetadataComponents;
-    validate: MetadataFactory.Validator;
-    example?: any;
-    examples?: Record<string, any>;
-    description: string | null;
-    jsDocTags: IJsDocTagInfo[];
-  }
-
-  /**
-   * @internal
-   */
-  export type IPreconfigured =
-    | IPreconfigured.IBody
-    | IPreconfigured.IHeaders
-    | IPreconfigured.IParam
-    | IPreconfigured.IQuery;
-
-  /**
-   * @internal
-   */
-  export namespace IPreconfigured {
-    export interface IBody extends IBase<"body"> {
-      field?: string;
-      encrypted?: boolean;
-      contentType:
-        | "application/json"
-        | "application/x-www-form-urlencoded"
-        | "multipart/form-data"
-        | "text/plain";
-    }
-    export interface IHeaders extends IBase<"headers"> {
-      field?: string;
-    }
-    export interface IParam extends IBase<"param"> {
-      field?: string;
-    }
-    export interface IQuery extends IBase<"query"> {
-      field?: string;
-    }
-    interface IBase<Category extends string> {
-      category: Category;
-      index: number;
-    }
-  }
-}
+import { IJsDocTagInfo } from "typia";
+import { MetadataFactory } from "typia/lib/factories/MetadataFactory";
+import { IMetadata } from "typia/lib/schemas/metadata/IMetadata";
+import { IMetadataComponents } from "typia/lib/schemas/metadata/IMetadataComponents";
+
+import { IReflectType } from "./IReflectType";
+
+export type IReflectHttpOperationParameter =
+  | IReflectHttpOperationParameter.IBody
+  | IReflectHttpOperationParameter.IHeaders
+  | IReflectHttpOperationParameter.IParam
+  | IReflectHttpOperationParameter.IQuery;
+export namespace IReflectHttpOperationParameter {
+  export interface IBody extends IBase<"body"> {
+    contentType:
+      | "application/json"
+      | "application/x-www-form-urlencoded"
+      | "multipart/form-data"
+      | "text/plain";
+    encrypted: boolean;
+  }
+  export interface IHeaders extends IBase<"headers"> {
+    field: string | null;
+  }
+  export interface IParam extends IBase<"param"> {
+    field: string;
+  }
+  export interface IQuery extends IBase<"query"> {
+    field: string | null;
+  }
+  interface IBase<Category extends string> {
+    category: Category;
+    name: string;
+    index: number;
+    type: IReflectType;
+    metadata: IMetadata;
+    components: IMetadataComponents;
+    validate: MetadataFactory.Validator;
+    example?: any;
+    examples?: Record<string, any>;
+    description: string | null;
+    jsDocTags: IJsDocTagInfo[];
+  }
+
+  /**
+   * @internal
+   */
+  export type IPreconfigured =
+    | IPreconfigured.IBody
+    | IPreconfigured.IHeaders
+    | IPreconfigured.IParam
+    | IPreconfigured.IQuery;
+
+  /**
+   * @internal
+   */
+  export namespace IPreconfigured {
+    export interface IBody extends IBase<"body"> {
+      field?: string;
+      encrypted?: boolean;
+      contentType:
+        | "application/json"
+        | "application/x-www-form-urlencoded"
+        | "multipart/form-data"
+        | "text/plain";
+    }
+    export interface IHeaders extends IBase<"headers"> {
+      field?: string;
+    }
+    export interface IParam extends IBase<"param"> {
+      field?: string;
+    }
+    export interface IQuery extends IBase<"query"> {
+      field?: string;
+    }
+    interface IBase<Category extends string> {
+      category: Category;
+      index: number;
+    }
+  }
+}

package/src/structures/IReflectHttpOperationSuccess.ts

@@ -1,22 +1,22 @@
-import { MetadataFactory } from "typia/lib/factories/MetadataFactory";
-import { IMetadata } from "typia/lib/schemas/metadata/IMetadata";
-import { IMetadataComponents } from "typia/lib/schemas/metadata/IMetadataComponents";
-
-import { IReflectType } from "./IReflectType";
-
-export interface IReflectHttpOperationSuccess {
-  type: IReflectType;
-  status: number;
-  contentType:
-    | "application/json"
-    | "text/plain"
-    | "application/x-www-form-urlencoded"
-    | "application/json"
-    | null;
-  encrypted: boolean;
-  components: IMetadataComponents;
-  metadata: IMetadata;
-  validate: MetadataFactory.Validator;
-  example?: any;
-  examples?: Record<string, any>;
-}
+import { MetadataFactory } from "typia/lib/factories/MetadataFactory";
+import { IMetadata } from "typia/lib/schemas/metadata/IMetadata";
+import { IMetadataComponents } from "typia/lib/schemas/metadata/IMetadataComponents";
+
+import { IReflectType } from "./IReflectType";
+
+export interface IReflectHttpOperationSuccess {
+  type: IReflectType;
+  status: number;
+  contentType:
+    | "application/json"
+    | "text/plain"
+    | "application/x-www-form-urlencoded"
+    | "application/json"
+    | null;
+  encrypted: boolean;
+  components: IMetadataComponents;
+  metadata: IMetadata;
+  validate: MetadataFactory.Validator;
+  example?: any;
+  examples?: Record<string, any>;
+}