@nestia/sdk 2.5.0-dev.20240131 → 2.5.0

package/src/structures/INormalizedInput.ts

@@ -1,20 +1,20 @@
-import { RouteInfo, VersionValue } from "@nestjs/common/interfaces";
-
-export interface INormalizedInput {
-  include: INormalizedInput.IInput[];
-  globalPrefix?: {
-    prefix: string;
-    exclude?: Array<string | RouteInfo>;
-  };
-  versioning?: {
-    prefix: string;
-    defaultVersion?: VersionValue;
-  };
-}
-export namespace INormalizedInput {
-  export interface IInput {
-    paths: string[];
-    file: string;
-    controller?: Function;
-  }
-}
+import { RouteInfo, VersionValue } from "@nestjs/common/interfaces";
+
+export interface INormalizedInput {
+  include: INormalizedInput.IInput[];
+  globalPrefix?: {
+    prefix: string;
+    exclude?: Array<string | RouteInfo>;
+  };
+  versioning?: {
+    prefix: string;
+    defaultVersion?: VersionValue;
+  };
+}
+export namespace INormalizedInput {
+  export interface IInput {
+    paths: string[];
+    file: string;
+    controller?: Function;
+  }
+}

package/src/structures/IRoute.ts

@@ -1,52 +1,52 @@
-import ts from "typescript";
-import { Metadata } from "typia/lib/schemas/metadata/Metadata";
-
-import { IController } from "./IController";
-
-export interface IRoute {
-  name: string;
-  method: string;
-  path: string;
-  encrypted: boolean;
-  status?: number;
-
-  accessors: string[];
-  parameters: IRoute.IParameter[];
-  imports: [string, string[]][];
-  output: IRoute.IOutput;
-
-  location: string;
-  symbol: {
-    class: string;
-    function: string;
-  };
-  description?: string;
-  operationId?: string;
-  jsDocTags: ts.JSDocTagInfo[];
-  setHeaders: Array<
-    | { type: "setter"; source: string; target?: string }
-    | { type: "assigner"; source: string }
-  >;
-  security: Record<string, string[]>[];
-  exceptions: Record<number | "2XX" | "3XX" | "4XX" | "5XX", IRoute.IOutput>;
-  swaggerTags: string[];
-}
-
-export namespace IRoute {
-  export type IParameter = IController.IParameter & {
-    optional: boolean;
-    type: ts.Type;
-    typeName: string;
-    metadata?: Metadata;
-  };
-  export interface IOutput {
-    type: ts.Type;
-    typeName: string;
-    metadata?: Metadata;
-    description?: string;
-    contentType:
-      | "application/x-www-form-urlencoded"
-      | "application/json"
-      | "text/plain";
-  }
-}
+import ts from "typescript";
+import { Metadata } from "typia/lib/schemas/metadata/Metadata";
+
+import { IController } from "./IController";
+
+export interface IRoute {
+  name: string;
+  method: string;
+  path: string;
+  encrypted: boolean;
+  status?: number;
+
+  accessors: string[];
+  parameters: IRoute.IParameter[];
+  imports: [string, string[]][];
+  output: IRoute.IOutput;
+
+  location: string;
+  symbol: {
+    class: string;
+    function: string;
+  };
+  description?: string;
+  operationId?: string;
+  jsDocTags: ts.JSDocTagInfo[];
+  setHeaders: Array<
+    | { type: "setter"; source: string; target?: string }
+    | { type: "assigner"; source: string }
+  >;
+  security: Record<string, string[]>[];
+  exceptions: Record<number | "2XX" | "3XX" | "4XX" | "5XX", IRoute.IOutput>;
+  swaggerTags: string[];
+}
+
+export namespace IRoute {
+  export type IParameter = IController.IParameter & {
+    optional: boolean;
+    type: ts.Type;
+    typeName: string;
+    metadata?: Metadata;
+  };
+  export interface IOutput {
+    type: ts.Type;
+    typeName: string;
+    metadata?: Metadata;
+    description?: string;
+    contentType:
+      | "application/x-www-form-urlencoded"
+      | "application/json"
+      | "text/plain";
+  }
+}

package/src/structures/ISwaggerComponents.ts

@@ -1,29 +1,29 @@
-import { IJsonComponents } from "typia";
-
-import { ISwaggerSecurityScheme } from "./ISwaggerSecurityScheme";
-
-/**
- * Reusable components in Swagger.
- *
- * `ISwaggerComponents` is a data structure representing content of `components` object
- * in `swagger.json` file generated by Nestia. Note that, this is not an universal
- * structure, but a dedicated structure only for Nestia.
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export interface ISwaggerComponents {
-  /**
-   * An object to hold reusable DTO schemas.
-   *
-   * For reference, `nestia` stores every object and alias types as reusable DTO
-   * schemas. The alias type means that defined by `type` keyword in TypeScript.
-   */
-  schemas?: Record<string, IJsonComponents.IAlias>;
-
-  /**
-   * An object to hold reusable security schemes.
-   *
-   * This property be configured by user in `nestia.config.ts` file.
-   */
-  securitySchemes?: Record<string, ISwaggerSecurityScheme>;
-}
+import { IJsonComponents } from "typia";
+
+import { ISwaggerSecurityScheme } from "./ISwaggerSecurityScheme";
+
+/**
+ * Reusable components in Swagger.
+ *
+ * `ISwaggerComponents` is a data structure representing content of `components` object
+ * in `swagger.json` file generated by Nestia. Note that, this is not an universal
+ * structure, but a dedicated structure only for Nestia.
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export interface ISwaggerComponents {
+  /**
+   * An object to hold reusable DTO schemas.
+   *
+   * For reference, `nestia` stores every object and alias types as reusable DTO
+   * schemas. The alias type means that defined by `type` keyword in TypeScript.
+   */
+  schemas?: Record<string, IJsonComponents.IAlias>;
+
+  /**
+   * An object to hold reusable security schemes.
+   *
+   * This property be configured by user in `nestia.config.ts` file.
+   */
+  securitySchemes?: Record<string, ISwaggerSecurityScheme>;
+}

package/src/structures/ISwaggerError.ts

@@ -1,8 +1,8 @@
-import { MetadataFactory } from "typia/lib/factories/MetadataFactory";
-
-import { IRoute } from "./IRoute";
-
-export interface ISwaggerError extends MetadataFactory.IError {
-  route: IRoute;
-  from: string;
-}
+import { MetadataFactory } from "typia/lib/factories/MetadataFactory";
+
+import { IRoute } from "./IRoute";
+
+export interface ISwaggerError extends MetadataFactory.IError {
+  route: IRoute;
+  from: string;
+}

package/src/structures/ISwaggerInfo.ts

@@ -1,80 +1,80 @@
-/**
- * Information about the API.
- *
- * @author Samchon
- */
-export interface ISwaggerInfo {
-  /**
-   * The title of the API.
-   */
-  title: string;
-
-  /**
-   * A short description of the API.
-   */
-  description?: string;
-
-  /**
-   * A URL to the Terms of Service for the API.
-   *
-   * @format uri
-   */
-  termsOfService?: string;
-
-  /**
-   * The contact information for the exposed API.
-   */
-  contact?: ISwaggerInfo.IContact;
-
-  /**
-   * The license information for the exposed API.
-   */
-  license?: ISwaggerInfo.ILicense;
-
-  /**
-   * Version of the API.
-   */
-  version: string;
-}
-export namespace ISwaggerInfo {
-  /**
-   * Contact information for the exposed API.
-   */
-  export interface IContact {
-    /**
-     * The identifying name of the contact person/organization.
-     */
-    name?: string;
-
-    /**
-     * The URL pointing to the contact information.
-     *
-     * @format uri
-     */
-    url?: string;
-
-    /**
-     * The email address of the contact person/organization.
-     *
-     * @format email
-     */
-    email?: string;
-  }
-
-  /**
-   * License information for the exposed API.
-   */
-  export interface ILicense {
-    /**
-     * The license name used for the API.
-     */
-    name: string;
-
-    /**
-     * A URL to the license used for the API.
-     *
-     * @format uri
-     */
-    url?: string;
-  }
-}
+/**
+ * Information about the API.
+ *
+ * @author Samchon
+ */
+export interface ISwaggerInfo {
+  /**
+   * The title of the API.
+   */
+  title: string;
+
+  /**
+   * A short description of the API.
+   */
+  description?: string;
+
+  /**
+   * A URL to the Terms of Service for the API.
+   *
+   * @format uri
+   */
+  termsOfService?: string;
+
+  /**
+   * The contact information for the exposed API.
+   */
+  contact?: ISwaggerInfo.IContact;
+
+  /**
+   * The license information for the exposed API.
+   */
+  license?: ISwaggerInfo.ILicense;
+
+  /**
+   * Version of the API.
+   */
+  version: string;
+}
+export namespace ISwaggerInfo {
+  /**
+   * Contact information for the exposed API.
+   */
+  export interface IContact {
+    /**
+     * The identifying name of the contact person/organization.
+     */
+    name?: string;
+
+    /**
+     * The URL pointing to the contact information.
+     *
+     * @format uri
+     */
+    url?: string;
+
+    /**
+     * The email address of the contact person/organization.
+     *
+     * @format email
+     */
+    email?: string;
+  }
+
+  /**
+   * License information for the exposed API.
+   */
+  export interface ILicense {
+    /**
+     * The license name used for the API.
+     */
+    name: string;
+
+    /**
+     * A URL to the license used for the API.
+     *
+     * @format uri
+     */
+    url?: string;
+  }
+}

package/src/structures/ISwaggerLazyProperty.ts

@@ -1,7 +1,7 @@
-import { IJsonSchema } from "typia";
-
-export interface ISwaggerLazyProperty {
-  schema: IJsonSchema;
-  object: string;
-  property: string;
-}
+import { IJsonSchema } from "typia";
+
+export interface ISwaggerLazyProperty {
+  schema: IJsonSchema;
+  object: string;
+  property: string;
+}

package/src/structures/ISwaggerLazySchema.ts

@@ -1,7 +1,7 @@
-import { IJsonSchema } from "typia";
-import { Metadata } from "typia/lib/schemas/metadata/Metadata";
-
-export interface ISwaggerLazySchema {
-  metadata: Metadata;
-  schema: IJsonSchema;
-}
+import { IJsonSchema } from "typia";
+import { Metadata } from "typia/lib/schemas/metadata/Metadata";
+
+export interface ISwaggerLazySchema {
+  metadata: Metadata;
+  schema: IJsonSchema;
+}

package/src/structures/ISwaggerRoute.ts

@@ -1,51 +1,51 @@
-import { IJsonSchema } from "typia";
-import { IJsDocTagInfo } from "typia/lib/schemas/metadata/IJsDocTagInfo";
-
-export interface ISwaggerRoute {
-  deprecated?: boolean;
-  security?: Record<string, string[]>[];
-  operationId?: string;
-  tags: string[];
-  parameters: ISwaggerRoute.IParameter[];
-  requestBody?: ISwaggerRoute.IRequestBody;
-  responses: ISwaggerRoute.IResponseBody;
-  summary?: string;
-  description?: string;
-  "x-nestia-method"?: string;
-  "x-nestia-namespace"?: string;
-  "x-nestia-jsDocTags"?: IJsDocTagInfo[];
-}
-export namespace ISwaggerRoute {
-  export interface IParameter {
-    name: string;
-    in: string;
-    schema: IJsonSchema;
-    required: boolean;
-    description?: string;
-  }
-  export interface IRequestBody {
-    description?: string;
-    content: IContent;
-    required: true;
-    "x-nestia-encrypted"?: boolean;
-  }
-  export type IResponseBody = Record<
-    string,
-    {
-      description: string;
-      content?: IContent;
-      "x-nestia-encrypted"?: boolean;
-    }
-  >;
-  export interface IContent {
-    "application/x-www-form-urlencoded"?: {
-      schema: IJsonSchema;
-    };
-    "application/json"?: {
-      schema: IJsonSchema;
-    };
-    "text/plain"?: {
-      schema: IJsonSchema;
-    };
-  }
-}
+import { IJsonSchema } from "typia";
+import { IJsDocTagInfo } from "typia/lib/schemas/metadata/IJsDocTagInfo";
+
+export interface ISwaggerRoute {
+  deprecated?: boolean;
+  security?: Record<string, string[]>[];
+  operationId?: string;
+  tags: string[];
+  parameters: ISwaggerRoute.IParameter[];
+  requestBody?: ISwaggerRoute.IRequestBody;
+  responses: ISwaggerRoute.IResponseBody;
+  summary?: string;
+  description?: string;
+  "x-nestia-method"?: string;
+  "x-nestia-namespace"?: string;
+  "x-nestia-jsDocTags"?: IJsDocTagInfo[];
+}
+export namespace ISwaggerRoute {
+  export interface IParameter {
+    name: string;
+    in: string;
+    schema: IJsonSchema;
+    required: boolean;
+    description?: string;
+  }
+  export interface IRequestBody {
+    description?: string;
+    content: IContent;
+    required: true;
+    "x-nestia-encrypted"?: boolean;
+  }
+  export type IResponseBody = Record<
+    string,
+    {
+      description: string;
+      content?: IContent;
+      "x-nestia-encrypted"?: boolean;
+    }
+  >;
+  export interface IContent {
+    "application/x-www-form-urlencoded"?: {
+      schema: IJsonSchema;
+    };
+    "application/json"?: {
+      schema: IJsonSchema;
+    };
+    "text/plain"?: {
+      schema: IJsonSchema;
+    };
+  }
+}

package/src/structures/ISwaggerSecurityScheme.ts

@@ -1,65 +1,65 @@
-/**
- * Security scheme of Swagger Documents.
- *
- * `ISwaggerSecurityScheme` is a data structure representing content of
- * `securitySchemes` in `swagger.json` file. It is composed with 5 types of security
- * schemes as an union type like below.
- *
- * @reference https://swagger.io/specification/#security-scheme-object
- * @author Jeongho Nam - https://github.com/samchon
- */
-export type ISwaggerSecurityScheme =
-  | ISwaggerSecurityScheme.IHttpBasic
-  | ISwaggerSecurityScheme.IHttpBearer
-  | ISwaggerSecurityScheme.IApiKey
-  | ISwaggerSecurityScheme.IOpenId
-  | ISwaggerSecurityScheme.IOAuth2;
-export namespace ISwaggerSecurityScheme {
-  export interface IHttpBasic {
-    type: "http";
-    scheme: "basic";
-  }
-  export interface IHttpBearer {
-    type: "http";
-    scheme: "bearer";
-    bearerFormat?: string;
-  }
-  export interface IApiKey {
-    type: "apiKey";
-
-    /**
-     * @default header
-     */
-    in?: "header" | "query" | "cookie";
-
-    /**
-     * @default Authorization
-     */
-    name?: string;
-  }
-
-  export interface IOpenId {
-    type: "openIdConnect";
-    openIdConnectUrl: string;
-  }
-
-  export interface IOAuth2 {
-    type: "oauth2";
-    flows: IOAuth2.IFlowSet;
-    description?: string;
-  }
-  export namespace IOAuth2 {
-    export interface IFlowSet {
-      authorizationCode?: IFlow;
-      implicit?: Omit<IFlow, "tokenUrl">;
-      password?: Omit<IFlow, "authorizationUrl">;
-      clientCredentials?: Omit<IFlow, "authorizationUrl">;
-    }
-    export interface IFlow {
-      authorizationUrl: string;
-      tokenUrl: string;
-      refreshUrl: string;
-      scopes?: Record<string, string>;
-    }
-  }
-}
+/**
+ * Security scheme of Swagger Documents.
+ *
+ * `ISwaggerSecurityScheme` is a data structure representing content of
+ * `securitySchemes` in `swagger.json` file. It is composed with 5 types of security
+ * schemes as an union type like below.
+ *
+ * @reference https://swagger.io/specification/#security-scheme-object
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export type ISwaggerSecurityScheme =
+  | ISwaggerSecurityScheme.IHttpBasic
+  | ISwaggerSecurityScheme.IHttpBearer
+  | ISwaggerSecurityScheme.IApiKey
+  | ISwaggerSecurityScheme.IOpenId
+  | ISwaggerSecurityScheme.IOAuth2;
+export namespace ISwaggerSecurityScheme {
+  export interface IHttpBasic {
+    type: "http";
+    scheme: "basic";
+  }
+  export interface IHttpBearer {
+    type: "http";
+    scheme: "bearer";
+    bearerFormat?: string;
+  }
+  export interface IApiKey {
+    type: "apiKey";
+
+    /**
+     * @default header
+     */
+    in?: "header" | "query" | "cookie";
+
+    /**
+     * @default Authorization
+     */
+    name?: string;
+  }
+
+  export interface IOpenId {
+    type: "openIdConnect";
+    openIdConnectUrl: string;
+  }
+
+  export interface IOAuth2 {
+    type: "oauth2";
+    flows: IOAuth2.IFlowSet;
+    description?: string;
+  }
+  export namespace IOAuth2 {
+    export interface IFlowSet {
+      authorizationCode?: IFlow;
+      implicit?: Omit<IFlow, "tokenUrl">;
+      password?: Omit<IFlow, "authorizationUrl">;
+      clientCredentials?: Omit<IFlow, "authorizationUrl">;
+    }
+    export interface IFlow {
+      authorizationUrl: string;
+      tokenUrl: string;
+      refreshUrl: string;
+      scopes?: Record<string, string>;
+    }
+  }
+}

package/src/structures/ITypeTuple.ts

@@ -1,6 +1,6 @@
-import ts from "typescript";
-
-export interface ITypeTuple {
-  type: ts.Type;
-  typeName: string;
-}
+import ts from "typescript";
+
+export interface ITypeTuple {
+  type: ts.Type;
+  typeName: string;
+}

package/src/structures/MethodType.ts

@@ -1,5 +1,5 @@
-export type MethodType = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
-
-export namespace MethodType {
-  export const VALUES: MethodType[] = ["GET", "POST", "PUT", "PATCH", "DELETE"];
-}
+export type MethodType = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+
+export namespace MethodType {
+  export const VALUES: MethodType[] = ["GET", "POST", "PUT", "PATCH", "DELETE"];
+}

package/src/structures/ParamCategory.ts

@@ -1 +1 @@
-export type ParamCategory = "param" | "query" | "body" | "headers";
+export type ParamCategory = "param" | "query" | "body" | "headers";