@nestia/sdk 11.0.0-dev.20260316 → 11.0.1

package/src/generates/internal/SwaggerOperationResponseComposer.ts

@@ -1,110 +1,110 @@
-import { MetadataSchema } from "@typia/core";
-import { OpenApi } from "@typia/interface";
-import { VariadicSingleton } from "tstl";
-
-import { ITypedHttpRoute } from "../../structures/ITypedHttpRoute";
-import { StringUtil } from "../../utils/StringUtil";
-import { SwaggerDescriptionComposer } from "./SwaggerDescriptionComposer";
-
-export namespace SwaggerOperationResponseComposer {
-  export const compose = (props: {
-    schema: (metadata: MetadataSchema) => 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: {},
-            },
-          },
-        };
-    }
-
-    // SUCCESS
-    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 { MetadataSchema } from "@typia/core";
+import { OpenApi } from "@typia/interface";
+import { VariadicSingleton } from "tstl";
+
+import { ITypedHttpRoute } from "../../structures/ITypedHttpRoute";
+import { StringUtil } from "../../utils/StringUtil";
+import { SwaggerDescriptionComposer } from "./SwaggerDescriptionComposer";
+
+export namespace SwaggerOperationResponseComposer {
+  export const compose = (props: {
+    schema: (metadata: MetadataSchema) => 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: {},
+            },
+          },
+        };
+    }
+
+    // SUCCESS
+    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/module.ts

@@ -1,4 +1,4 @@
-export * from "./INestiaConfig";
-export * from "./NestiaSdkApplication";
-export * from "./NestiaSwaggerComposer";
-export * from "./decorators/OperationMetadata";
+export * from "./INestiaConfig";
+export * from "./NestiaSdkApplication";
+export * from "./NestiaSwaggerComposer";
+export * from "./decorators/OperationMetadata";

package/src/structures/IReflectHttpOperationException.ts

@@ -1,18 +1,18 @@
-import { MetadataFactory } from "@typia/core";
-import { IMetadataComponents, IMetadataSchema } from "@typia/interface";
-
-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: IMetadataSchema;
-  components: IMetadataComponents;
-  validate: MetadataFactory.Validator;
-}
+import { MetadataFactory } from "@typia/core";
+import { IMetadataComponents, IMetadataSchema } from "@typia/interface";
+
+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: IMetadataSchema;
+  components: IMetadataComponents;
+  validate: MetadataFactory.Validator;
+}

package/src/structures/IReflectHttpOperationParameter.ts

@@ -1,79 +1,79 @@
-import { MetadataFactory } from "@typia/core";
-import {
-  IJsDocTagInfo,
-  IMetadataComponents,
-  IMetadataSchema,
-} from "@typia/interface";
-
-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: IMetadataSchema;
-    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 { MetadataFactory } from "@typia/core";
+import {
+  IJsDocTagInfo,
+  IMetadataComponents,
+  IMetadataSchema,
+} from "@typia/interface";
+
+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: IMetadataSchema;
+    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,21 +1,21 @@
-import { MetadataFactory } from "@typia/core";
-import { IMetadataComponents, IMetadataSchema } from "@typia/interface";
-
-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: IMetadataSchema;
-  validate: MetadataFactory.Validator;
-  example?: any;
-  examples?: Record<string, any>;
-}
+import { MetadataFactory } from "@typia/core";
+import { IMetadataComponents, IMetadataSchema } from "@typia/interface";
+
+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: IMetadataSchema;
+  validate: MetadataFactory.Validator;
+  example?: any;
+  examples?: Record<string, any>;
+}

package/src/structures/ITypedApplication.ts

@@ -1,11 +1,11 @@
-import { IMetadataDictionary } from "@typia/core";
-
-import { INestiaProject } from "./INestiaProject";
-import { ITypedHttpRoute } from "./ITypedHttpRoute";
-import { ITypedWebSocketRoute } from "./ITypedWebSocketRoute";
-
-export interface ITypedApplication {
-  project: INestiaProject;
-  collection: IMetadataDictionary;
-  routes: Array<ITypedHttpRoute | ITypedWebSocketRoute>;
-}
+import { IMetadataDictionary } from "@typia/core";
+
+import { INestiaProject } from "./INestiaProject";
+import { ITypedHttpRoute } from "./ITypedHttpRoute";
+import { ITypedWebSocketRoute } from "./ITypedWebSocketRoute";
+
+export interface ITypedApplication {
+  project: INestiaProject;
+  collection: IMetadataDictionary;
+  routes: Array<ITypedHttpRoute | ITypedWebSocketRoute>;
+}

package/src/structures/ITypedHttpRouteException.ts

@@ -1,15 +1,15 @@
-import { MetadataSchema } from "@typia/core";
-
-import { IReflectType } from "./IReflectType";
-
-export interface ITypedHttpRouteException {
-  // BASIC PROPERTIES
-  status: number | "2XX" | "3XX" | "4XX" | "5XX";
-  description: string | null;
-  example: any;
-  examples: Record<string, any>;
-
-  // REFLECTED PROPERTIES
-  type: IReflectType;
-  metadata: MetadataSchema;
-}
+import { MetadataSchema } from "@typia/core";
+
+import { IReflectType } from "./IReflectType";
+
+export interface ITypedHttpRouteException {
+  // BASIC PROPERTIES
+  status: number | "2XX" | "3XX" | "4XX" | "5XX";
+  description: string | null;
+  example: any;
+  examples: Record<string, any>;
+
+  // REFLECTED PROPERTIES
+  type: IReflectType;
+  metadata: MetadataSchema;
+}

package/src/structures/ITypedHttpRouteParameter.ts

@@ -1,41 +1,41 @@
-import { MetadataSchema } from "@typia/core";
-import { IJsDocTagInfo } from "typia";
-
-import { IReflectType } from "./IReflectType";
-
-export type ITypedHttpRouteParameter =
-  | ITypedHttpRouteParameter.IBody
-  | ITypedHttpRouteParameter.IHeaders
-  | ITypedHttpRouteParameter.IPath
-  | ITypedHttpRouteParameter.IQuery;
-export namespace ITypedHttpRouteParameter {
-  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 IPath 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: MetadataSchema;
-    example?: any;
-    examples?: Record<string, any>;
-    description: string | null;
-    jsDocTags: IJsDocTagInfo[];
-  }
-}
+import { MetadataSchema } from "@typia/core";
+import { IJsDocTagInfo } from "typia";
+
+import { IReflectType } from "./IReflectType";
+
+export type ITypedHttpRouteParameter =
+  | ITypedHttpRouteParameter.IBody
+  | ITypedHttpRouteParameter.IHeaders
+  | ITypedHttpRouteParameter.IPath
+  | ITypedHttpRouteParameter.IQuery;
+export namespace ITypedHttpRouteParameter {
+  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 IPath 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: MetadataSchema;
+    example?: any;
+    examples?: Record<string, any>;
+    description: string | null;
+    jsDocTags: IJsDocTagInfo[];
+  }
+}

package/src/structures/ITypedHttpRouteSuccess.ts

@@ -1,22 +1,22 @@
-import { MetadataSchema } from "@typia/core";
-
-import { IReflectType } from "./IReflectType";
-
-export interface ITypedHttpRouteSuccess {
-  type: IReflectType;
-  status: number | null;
-  contentType:
-    | "application/json"
-    | "text/plain"
-    | "application/x-www-form-urlencoded"
-    | "application/json"
-    | null;
-  encrypted: boolean;
-  metadata: MetadataSchema;
-  example?: any;
-  examples?: Record<string, any>;
-  setHeaders: Array<
-    | { type: "setter"; source: string; target?: string }
-    | { type: "assigner"; source: string }
-  >;
-}
+import { MetadataSchema } from "@typia/core";
+
+import { IReflectType } from "./IReflectType";
+
+export interface ITypedHttpRouteSuccess {
+  type: IReflectType;
+  status: number | null;
+  contentType:
+    | "application/json"
+    | "text/plain"
+    | "application/x-www-form-urlencoded"
+    | "application/json"
+    | null;
+  encrypted: boolean;
+  metadata: MetadataSchema;
+  example?: any;
+  examples?: Record<string, any>;
+  setHeaders: Array<
+    | { type: "setter"; source: string; target?: string }
+    | { type: "assigner"; source: string }
+  >;
+}