@nestia/sdk 3.0.0-dev.20231209 → 3.0.0-dev.20240412

package/src/structures/ISwagger.ts

@@ -1,91 +0,0 @@
-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 +0,0 @@
-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>;
-}

package/src/structures/ISwaggerInfo.ts

@@ -1,80 +0,0 @@
-/**
- * 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/ISwaggerRoute.ts

@@ -1,51 +0,0 @@
-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 +0,0 @@
-/**
- * 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>;
-    }
-  }
-}