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

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

@@ -0,0 +1,16 @@
+/**
+ * Remote server definition.
+ */
+export interface ISwaggerServer {
+  /**
+   * A URL to the target host.
+   *
+   * @format uri
+   */
+  url: string;
+
+  /**
+   * An optional string describing the target server.
+   */
+  description?: string;
+}

package/src/structures/ISwaggerTag.ts

@@ -0,0 +1,9 @@
+/**
+ * Tag name and description.
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export interface ISwaggerTag {
+  name: string;
+  description?: string;
+}

package/src/structures/ParamCategory.ts

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

package/src/structures/TypeEntry.ts

@@ -1,22 +1,22 @@
-import { hash } from "tstl";
-import ts from "typescript";
-
-export class TypeEntry {
-  public constructor(
-    public readonly type: ts.Type,
-    public readonly nullable: boolean,
-    public readonly required: boolean,
-  ) {}
-
-  public equals(obj: TypeEntry): boolean {
-    return (
-      this.type === obj.type &&
-      this.nullable === obj.nullable &&
-      this.required === obj.required
-    );
-  }
-
-  public hashCode(): number {
-    return hash(this.type, this.nullable, this.required);
-  }
-}
+import { hash } from "tstl";
+import ts from "typescript";
+
+export class TypeEntry {
+  public constructor(
+    public readonly type: ts.Type,
+    public readonly nullable: boolean,
+    public readonly required: boolean,
+  ) {}
+
+  public equals(obj: TypeEntry): boolean {
+    return (
+      this.type === obj.type &&
+      this.nullable === obj.nullable &&
+      this.required === obj.required
+    );
+  }
+
+  public hashCode(): number {
+    return hash(this.type, this.nullable, this.required);
+  }
+}

package/src/utils/StringUtil.ts

@@ -1,6 +1,6 @@
-export namespace StringUtil {
-  export const escapeDuplicate =
-    (keep: string[]) =>
-    (change: string): string =>
-      keep.includes(change) ? escapeDuplicate(keep)(`_${change}`) : change;
-}
+export namespace StringUtil {
+  export const escapeDuplicate =
+    (keep: string[]) =>
+    (change: string): string =>
+      keep.includes(change) ? escapeDuplicate(keep)(`_${change}`) : change;
+}