@nestia/sdk 2.6.3-dev.20240328 → 2.6.4-dev.20240401

package/src/structures/IController.ts

@@ -1,94 +1,94 @@
-import type { VERSION_NEUTRAL, VersionValue } from "@nestjs/common/interfaces";
-
-import type { ParamCategory } from "./ParamCategory";
-
-export interface IController {
-  target: Function;
-  file: string;
-  name: string;
-  prefixes: string[];
-  paths: string[];
-  versions:
-    | Array<Exclude<VersionValue, Array<string | typeof VERSION_NEUTRAL>>>
-    | undefined;
-  functions: IController.IFunction[];
-  security: Record<string, string[]>[];
-  swaggerTgas: string[];
-}
-
-export namespace IController {
-  export interface IFunction {
-    target: Function;
-    name: string;
-    method: string;
-    paths: string[];
-    versions:
-      | Array<Exclude<VersionValue, Array<string | typeof VERSION_NEUTRAL>>>
-      | undefined;
-    encrypted: boolean;
-    parameters: IParameter[];
-    status?: number;
-    type?: string;
-    contentType: "application/json" | "text/plain";
-    security: Record<string, string[]>[];
-    exceptions: Record<
-      number | "2XX" | "3XX" | "4XX" | "5XX",
-      IController.IException
-    >;
-    swaggerTags: string[];
-  }
-
-  export type IParameter =
-    | ICommonParameter
-    | IQueryParameter
-    | IHeadersParameter
-    | IBodyParameter
-    | IPathParameter;
-  export interface ICommonParameter {
-    custom: false;
-    category: ParamCategory;
-    index: number;
-    name: string;
-    field: string | undefined;
-  }
-  export interface IHeadersParameter {
-    custom: true;
-    category: "headers";
-    index: number;
-    name: string;
-    field: string | undefined;
-  }
-  export interface IQueryParameter {
-    custom: true;
-    category: "query";
-    index: number;
-    name: string;
-    field: string | undefined;
-  }
-  export interface IBodyParameter {
-    custom: true;
-    category: "body";
-    index: number;
-    name: string;
-    field: string | undefined;
-    encrypted: boolean;
-    contentType:
-      | "application/json"
-      | "application/x-www-form-urlencoded"
-      | "multipart/form-data"
-      | "text/plain";
-  }
-  export interface IPathParameter {
-    custom: true;
-    category: "param";
-    index: number;
-    name: string;
-    field: string | undefined;
-  }
-
-  export interface IException {
-    type: string;
-    status: number | "2XX" | "3XX" | "4XX" | "5XX";
-    description: string | undefined;
-  }
-}
+import type { VERSION_NEUTRAL, VersionValue } from "@nestjs/common/interfaces";
+
+import type { ParamCategory } from "./ParamCategory";
+
+export interface IController {
+  target: Function;
+  file: string;
+  name: string;
+  prefixes: string[];
+  paths: string[];
+  versions:
+    | Array<Exclude<VersionValue, Array<string | typeof VERSION_NEUTRAL>>>
+    | undefined;
+  functions: IController.IFunction[];
+  security: Record<string, string[]>[];
+  swaggerTgas: string[];
+}
+
+export namespace IController {
+  export interface IFunction {
+    target: Function;
+    name: string;
+    method: string;
+    paths: string[];
+    versions:
+      | Array<Exclude<VersionValue, Array<string | typeof VERSION_NEUTRAL>>>
+      | undefined;
+    encrypted: boolean;
+    parameters: IParameter[];
+    status?: number;
+    type?: string;
+    contentType: "application/json" | "text/plain";
+    security: Record<string, string[]>[];
+    exceptions: Record<
+      number | "2XX" | "3XX" | "4XX" | "5XX",
+      IController.IException
+    >;
+    swaggerTags: string[];
+  }
+
+  export type IParameter =
+    | ICommonParameter
+    | IQueryParameter
+    | IHeadersParameter
+    | IBodyParameter
+    | IPathParameter;
+  export interface ICommonParameter {
+    custom: false;
+    category: ParamCategory;
+    index: number;
+    name: string;
+    field: string | undefined;
+  }
+  export interface IHeadersParameter {
+    custom: true;
+    category: "headers";
+    index: number;
+    name: string;
+    field: string | undefined;
+  }
+  export interface IQueryParameter {
+    custom: true;
+    category: "query";
+    index: number;
+    name: string;
+    field: string | undefined;
+  }
+  export interface IBodyParameter {
+    custom: true;
+    category: "body";
+    index: number;
+    name: string;
+    field: string | undefined;
+    encrypted: boolean;
+    contentType:
+      | "application/json"
+      | "application/x-www-form-urlencoded"
+      | "multipart/form-data"
+      | "text/plain";
+  }
+  export interface IPathParameter {
+    custom: true;
+    category: "param";
+    index: number;
+    name: string;
+    field: string | undefined;
+  }
+
+  export interface IException {
+    type: string;
+    status: number | "2XX" | "3XX" | "4XX" | "5XX";
+    description: string | undefined;
+  }
+}

package/src/structures/IRoute.ts

@@ -1,53 +1,53 @@
-import ts from "typescript";
-import { Metadata } from "typia/lib/schemas/metadata/Metadata";
-
-import { IController } from "./IController";
-
-export interface IRoute {
-  controller: Function;
-  name: string;
-  method: string;
-  path: string;
-  encrypted: boolean;
-  status?: number;
-
-  accessors: string[];
-  parameters: IRoute.IParameter[];
-  imports: [string, string[]][];
-  output: IRoute.IOutput;
-
-  location: string;
-  target: {
-    class: Function;
-    function: Function;
-  };
-  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 {
+  controller: Function;
+  name: string;
+  method: string;
+  path: string;
+  encrypted: boolean;
+  status?: number;
+
+  accessors: string[];
+  parameters: IRoute.IParameter[];
+  imports: [string, string[]][];
+  output: IRoute.IOutput;
+
+  location: string;
+  target: {
+    class: Function;
+    function: Function;
+  };
+  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/ISwagger.ts

@@ -1,91 +1,66 @@
-import { ISwaggerComponents } from "./ISwaggerComponents";
-import { ISwaggerInfo } from "./ISwaggerInfo";
-import { ISwaggerRoute } from "./ISwaggerRoute";
-
-/**
- * Swagger Document.
- *
- * `ISwagger` is a data structure representing content of `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 ISwagger {
-  /**
-   * The version of the OpenAPI document.
-   *
-   * Nestia always generate OpenAPI 3.0.x document.
-   */
-  openapi: `3.0.${number}`;
-
-  /**
-   * List of servers that provide the API.
-   */
-  servers: ISwagger.IServer[];
-
-  /**
-   * Information about the API.
-   */
-  info: ISwaggerInfo;
-
-  /**
-   * The available paths and operations for the API.
-   *
-   * The 1st key is the path, and the 2nd key is the HTTP method.
-   */
-  paths: Record<string, Record<string, ISwaggerRoute>>;
-
-  /**
-   * An object to hold reusable data structures.
-   *
-   * It stores both DTO schemas and security schemes.
-   *
-   * For reference, `nestia` defines every object and alias types as reusable DTO
-   * schemas. The alias type means that defined by `type` keyword in TypeScript.
-   */
-  components: ISwaggerComponents;
-
-  // /**
-  //  * A declaration of which security mechanisms can be used across the API.
-  //  *
-  //  * When this property be configured, it would be overwritten in every API routes.
-  //  *
-  //  * For reference, key means the name of security scheme and value means the `scopes`.
-  //  * The `scopes` can be used only when target security scheme is `oauth2` type,
-  //  * especially for {@link ISwaggerSecurityScheme.IOAuth2.IFlow.scopes} property.
-  //  */
-  // security?: Record<string, string[]>[];
-}
-export namespace ISwagger {
-  /**
-   * Remote server definition.
-   */
-  export interface IServer {
-    /**
-     * A URL to the target host.
-     *
-     * @format uri
-     */
-    url: string;
-
-    /**
-     * An optional string describing the target server.
-     */
-    description?: string;
-  }
-
-  export interface IExternalDocs {
-    /**
-     * The URL for target documentation.
-     *
-     * @format uri
-     */
-    url: string;
-
-    /**
-     * A short description of the target documentation.
-     */
-    description?: string;
-  }
-}
+import { ISwaggerComponents } from "./ISwaggerComponents";
+import { ISwaggerInfo } from "./ISwaggerInfo";
+import { ISwaggerRoute } from "./ISwaggerRoute";
+import { ISwaggerServer } from "./ISwaggerServer";
+import { ISwaggerTag } from "./ISwaggerTag";
+
+/**
+ * Swagger Document.
+ *
+ * `ISwagger` is a data structure representing content of `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 ISwagger {
+  /**
+   * The version of the OpenAPI document.
+   *
+   * Nestia always generate OpenAPI 3.0.x document.
+   */
+  openapi: `3.0.${number}`;
+
+  /**
+   * List of servers that provide the API.
+   */
+  servers: ISwaggerServer[];
+
+  /**
+   * Information about the API.
+   */
+  info: ISwaggerInfo;
+
+  /**
+   * The available paths and operations for the API.
+   *
+   * The 1st key is the path, and the 2nd key is the HTTP method.
+   */
+  paths: Record<string, Record<string, ISwaggerRoute>>;
+
+  /**
+   * An object to hold reusable data structures.
+   *
+   * It stores both DTO schemas and security schemes.
+   *
+   * For reference, `nestia` defines every object and alias types as reusable DTO
+   * schemas. The alias type means that defined by `type` keyword in TypeScript.
+   */
+  components: ISwaggerComponents;
+
+  /**
+   * List of tags.
+   */
+  tags: ISwaggerTag[];
+
+  // /**
+  //  * A declaration of which security mechanisms can be used across the API.
+  //  *
+  //  * When this property be configured, it would be overwritten in every API routes.
+  //  *
+  //  * For reference, key means the name of security scheme and value means the `scopes`.
+  //  * The `scopes` can be used only when target security scheme is `oauth2` type,
+  //  * especially for {@link ISwaggerSecurityScheme.IOAuth2.IFlow.scopes} property.
+  //  */
+  // security?: Record<string, string[]>[];
+}

package/src/structures/ISwaggerRoute.ts

@@ -1,54 +1,54 @@
-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;
-    };
-    "multipart/form-data"?: {
-      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;
+    };
+    "multipart/form-data"?: {
+      schema: IJsonSchema;
+    };
+  }
+}