@nestia/sdk 2.4.3 → 2.4.4

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,2 +1,2 @@
-export * from "./INestiaConfig";
-export * from "./NestiaSdkApplication";
+export * from "./INestiaConfig";
+export * from "./NestiaSdkApplication";

package/src/structures/IErrorReport.ts

@@ -1,6 +1,6 @@
-export interface IErrorReport {
-  file: string;
-  controller: string;
-  function: string | null;
-  message: string;
-}
+export interface IErrorReport {
+  file: string;
+  controller: string;
+  function: string | null;
+  message: string;
+}

package/src/structures/INestiaProject.ts

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

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/ISwagger.ts

@@ -1,91 +1,91 @@
-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 url
-     */
-    url: string;
-
-    /**
-     * An optional string describing the target server.
-     */
-    description?: string;
-  }
-
-  export interface IExternalDocs {
-    /**
-     * The URL for target documentation.
-     *
-     * @format url
-     */
-    url: string;
-
-    /**
-     * A short description of the target documentation.
-     */
-    description?: string;
-  }
-}
+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 url
+     */
+    url: string;
+
+    /**
+     * An optional string describing the target server.
+     */
+    description?: string;
+  }
+
+  export interface IExternalDocs {
+    /**
+     * The URL for target documentation.
+     *
+     * @format url
+     */
+    url: string;
+
+    /**
+     * A short description of the target documentation.
+     */
+    description?: string;
+  }
+}

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.IObject | 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 url
-   */
-  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 url
-     */
-    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 url
-     */
-    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 url
+   */
+  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 url
+     */
+    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 url
+     */
+    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;
+    };
+  }
+}