@nestia/fetcher 3.1.0-dev.20240429 → 3.1.0-dev.20240430

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestia/fetcher",
-  "version": "3.1.0-dev.20240429",
+  "version": "3.1.0-dev.20240430",
   "description": "Fetcher library of Nestia SDK",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",

package/src/AesPkcs5.ts

@@ -1,50 +1,50 @@
-import crypto from "crypto";
-
-/**
- * Utility class for the AES-128/256 encryption.
- *
- *   - AES-128/256
- *   - CBC mode
- *   - PKCS#5 Padding
- *   - Base64 Encoding
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export namespace AesPkcs5 {
-  /**
-   * Encrypt data
-   *
-   * @param data Target data
-   * @param key Key value of the encryption.
-   * @param iv Initializer Vector for the encryption
-   * @return Encrypted data
-   */
-  export function encrypt(data: string, key: string, iv: string): string {
-    const bytes: number = key.length * 8;
-    const cipher: crypto.Cipher = crypto.createCipheriv(
-      `AES-${bytes}-CBC`,
-      key,
-      iv,
-    );
-    return cipher.update(data, "utf8", "base64") + cipher.final("base64");
-  }
-
-  /**
-   * Decrypt data.
-   *
-   * @param data Target data
-   * @param key Key value of the decryption.
-   * @param iv Initializer Vector for the decryption
-   * @return Decrypted data.
-   */
-  export function decrypt(data: string, key: string, iv: string): string {
-    const bytes: number = key.length * 8;
-    const decipher: crypto.Decipher = crypto.createDecipheriv(
-      `AES-${bytes}-CBC`,
-      key,
-      iv,
-    );
-
-    return decipher.update(data, "base64", "utf8") + decipher.final("utf8");
-  }
-}
+import crypto from "crypto";
+
+/**
+ * Utility class for the AES-128/256 encryption.
+ *
+ *   - AES-128/256
+ *   - CBC mode
+ *   - PKCS#5 Padding
+ *   - Base64 Encoding
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export namespace AesPkcs5 {
+  /**
+   * Encrypt data
+   *
+   * @param data Target data
+   * @param key Key value of the encryption.
+   * @param iv Initializer Vector for the encryption
+   * @return Encrypted data
+   */
+  export function encrypt(data: string, key: string, iv: string): string {
+    const bytes: number = key.length * 8;
+    const cipher: crypto.Cipher = crypto.createCipheriv(
+      `AES-${bytes}-CBC`,
+      key,
+      iv,
+    );
+    return cipher.update(data, "utf8", "base64") + cipher.final("base64");
+  }
+
+  /**
+   * Decrypt data.
+   *
+   * @param data Target data
+   * @param key Key value of the decryption.
+   * @param iv Initializer Vector for the decryption
+   * @return Decrypted data.
+   */
+  export function decrypt(data: string, key: string, iv: string): string {
+    const bytes: number = key.length * 8;
+    const decipher: crypto.Decipher = crypto.createDecipheriv(
+      `AES-${bytes}-CBC`,
+      key,
+      iv,
+    );
+
+    return decipher.update(data, "base64", "utf8") + decipher.final("utf8");
+  }
+}

package/src/EncryptedFetcher.ts

@@ -1,174 +1,174 @@
-import { AesPkcs5 } from "./AesPkcs5";
-import { IConnection } from "./IConnection";
-import { IEncryptionPassword } from "./IEncryptionPassword";
-import { IFetchRoute } from "./IFetchRoute";
-import { IPropagation } from "./IPropagation";
-import { FetcherBase } from "./internal/FetcherBase";
-
-/**
- * Utility class for `fetch` functions used in `@nestia/sdk` with encryption.
- *
- * `EncryptedFetcher` is a utility class designed for SDK functions generated by
- * [`@nestia/sdk`](https://nestia.io/docs/sdk/sdk), interacting with the remote
- * HTTP API encrypted by AES-PKCS algorithm. In other words, this is a collection of
- * dedicated `fetch()` functions for `@nestia/sdk` with encryption.
- *
- * For reference, `EncryptedFetcher` class being used only when target controller
- * method is encrypting body data by `@EncryptedRoute` or `@EncryptedBody` decorators.
- * If those decorators are not used, {@link PlainFetcher} class would be used instead.
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export namespace EncryptedFetcher {
-  /**
-   * Fetch function only for `HEAD` method.
-   *
-   * @param connection Connection information for the remote HTTP server
-   * @param route Route information about the target API
-   * @return Nothing because of `HEAD` method
-   */
-  export function fetch(
-    connection: IConnection,
-    route: IFetchRoute<"HEAD">,
-  ): Promise<void>;
-
-  /**
-   * Fetch function only for `GET` method.
-   *
-   * @param connection Connection information for the remote HTTP server
-   * @param route Route information about the target API
-   * @return Response body data from the remote API
-   */
-  export function fetch<Output>(
-    connection: IConnection,
-    route: IFetchRoute<"GET">,
-  ): Promise<Output>;
-
-  /**
-   * Fetch function for the `POST`, `PUT`, `PATCH` and `DELETE` methods.
-   *
-   * @param connection Connection information for the remote HTTP server
-   * @param route Route information about the target API
-   * @return Response body data from the remote API
-   */
-  export function fetch<Input, Output>(
-    connection: IConnection,
-    route: IFetchRoute<"POST" | "PUT" | "PATCH" | "DELETE">,
-    input?: Input,
-    stringify?: (input: Input) => string,
-  ): Promise<Output>;
-
-  export async function fetch<Input, Output>(
-    connection: IConnection,
-    route: IFetchRoute<"DELETE" | "GET" | "HEAD" | "PATCH" | "POST" | "PUT">,
-    input?: Input,
-    stringify?: (input: Input) => string,
-  ): Promise<Output> {
-    if (
-      (route.request?.encrypted === true || route.response?.encrypted) &&
-      connection.encryption === undefined
-    )
-      throw new Error(
-        "Error on EncryptedFetcher.fetch(): the encryption password has not been configured.",
-      );
-    const closure =
-      typeof connection.encryption === "function"
-        ? (direction: "encode" | "decode") =>
-            (
-              headers: Record<string, IConnection.HeaderValue | undefined>,
-              body: string,
-            ) =>
-              (connection.encryption as IEncryptionPassword.Closure)({
-                headers,
-                body,
-                direction,
-              })
-        : () => () => connection.encryption as IEncryptionPassword;
-
-    return FetcherBase.fetch({
-      className: "EncryptedFetcher",
-      encode:
-        route.request?.encrypted === true
-          ? (input, headers) => {
-              const p: IEncryptionPassword = closure("encode")(headers, input);
-              return AesPkcs5.encrypt(
-                (stringify ?? JSON.stringify)(input),
-                p.key,
-                p.iv,
-              );
-            }
-          : (input) => input,
-      decode:
-        route.response?.encrypted === true
-          ? (input, headers) => {
-              const p: IEncryptionPassword = closure("decode")(headers, input);
-              const s: string = AesPkcs5.decrypt(input, p.key, p.iv);
-              return s.length ? JSON.parse(s) : s;
-            }
-          : (input) => input,
-    })(connection, route, input, stringify);
-  }
-
-  export function propagate<Output extends IPropagation<any, any>>(
-    connection: IConnection,
-    route: IFetchRoute<"GET" | "HEAD">,
-  ): Promise<Output>;
-
-  export function propagate<Input, Output extends IPropagation<any, any>>(
-    connection: IConnection,
-    route: IFetchRoute<"DELETE" | "GET" | "HEAD" | "PATCH" | "POST" | "PUT">,
-    input?: Input,
-    stringify?: (input: Input) => string,
-  ): Promise<Output>;
-
-  export async function propagate<Input, Output extends IPropagation<any, any>>(
-    connection: IConnection,
-    route: IFetchRoute<"DELETE" | "GET" | "HEAD" | "PATCH" | "POST" | "PUT">,
-    input?: Input,
-    stringify?: (input: Input) => string,
-  ): Promise<Output> {
-    if (
-      (route.request?.encrypted === true || route.response?.encrypted) &&
-      connection.encryption === undefined
-    )
-      throw new Error(
-        "Error on EncryptedFetcher.propagate(): the encryption password has not been configured.",
-      );
-    const closure =
-      typeof connection.encryption === "function"
-        ? (direction: "encode" | "decode") =>
-            (
-              headers: Record<string, IConnection.HeaderValue | undefined>,
-              body: string,
-            ) =>
-              (connection.encryption as IEncryptionPassword.Closure)({
-                headers,
-                body,
-                direction,
-              })
-        : () => () => connection.encryption as IEncryptionPassword;
-
-    return FetcherBase.propagate({
-      className: "EncryptedFetcher",
-      encode:
-        route.request?.encrypted === true
-          ? (input, headers) => {
-              const p: IEncryptionPassword = closure("encode")(headers, input);
-              return AesPkcs5.encrypt(
-                (stringify ?? JSON.stringify)(input),
-                p.key,
-                p.iv,
-              );
-            }
-          : (input) => input,
-      decode:
-        route.response?.encrypted === true
-          ? (input, headers) => {
-              const p: IEncryptionPassword = closure("decode")(headers, input);
-              const s: string = AesPkcs5.decrypt(input, p.key, p.iv);
-              return s.length ? JSON.parse(s) : s;
-            }
-          : (input) => input,
-    })(connection, route, input, stringify) as Promise<Output>;
-  }
-}
+import { AesPkcs5 } from "./AesPkcs5";
+import { IConnection } from "./IConnection";
+import { IEncryptionPassword } from "./IEncryptionPassword";
+import { IFetchRoute } from "./IFetchRoute";
+import { IPropagation } from "./IPropagation";
+import { FetcherBase } from "./internal/FetcherBase";
+
+/**
+ * Utility class for `fetch` functions used in `@nestia/sdk` with encryption.
+ *
+ * `EncryptedFetcher` is a utility class designed for SDK functions generated by
+ * [`@nestia/sdk`](https://nestia.io/docs/sdk/sdk), interacting with the remote
+ * HTTP API encrypted by AES-PKCS algorithm. In other words, this is a collection of
+ * dedicated `fetch()` functions for `@nestia/sdk` with encryption.
+ *
+ * For reference, `EncryptedFetcher` class being used only when target controller
+ * method is encrypting body data by `@EncryptedRoute` or `@EncryptedBody` decorators.
+ * If those decorators are not used, {@link PlainFetcher} class would be used instead.
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export namespace EncryptedFetcher {
+  /**
+   * Fetch function only for `HEAD` method.
+   *
+   * @param connection Connection information for the remote HTTP server
+   * @param route Route information about the target API
+   * @return Nothing because of `HEAD` method
+   */
+  export function fetch(
+    connection: IConnection,
+    route: IFetchRoute<"HEAD">,
+  ): Promise<void>;
+
+  /**
+   * Fetch function only for `GET` method.
+   *
+   * @param connection Connection information for the remote HTTP server
+   * @param route Route information about the target API
+   * @return Response body data from the remote API
+   */
+  export function fetch<Output>(
+    connection: IConnection,
+    route: IFetchRoute<"GET">,
+  ): Promise<Output>;
+
+  /**
+   * Fetch function for the `POST`, `PUT`, `PATCH` and `DELETE` methods.
+   *
+   * @param connection Connection information for the remote HTTP server
+   * @param route Route information about the target API
+   * @return Response body data from the remote API
+   */
+  export function fetch<Input, Output>(
+    connection: IConnection,
+    route: IFetchRoute<"POST" | "PUT" | "PATCH" | "DELETE">,
+    input?: Input,
+    stringify?: (input: Input) => string,
+  ): Promise<Output>;
+
+  export async function fetch<Input, Output>(
+    connection: IConnection,
+    route: IFetchRoute<"DELETE" | "GET" | "HEAD" | "PATCH" | "POST" | "PUT">,
+    input?: Input,
+    stringify?: (input: Input) => string,
+  ): Promise<Output> {
+    if (
+      (route.request?.encrypted === true || route.response?.encrypted) &&
+      connection.encryption === undefined
+    )
+      throw new Error(
+        "Error on EncryptedFetcher.fetch(): the encryption password has not been configured.",
+      );
+    const closure =
+      typeof connection.encryption === "function"
+        ? (direction: "encode" | "decode") =>
+            (
+              headers: Record<string, IConnection.HeaderValue | undefined>,
+              body: string,
+            ) =>
+              (connection.encryption as IEncryptionPassword.Closure)({
+                headers,
+                body,
+                direction,
+              })
+        : () => () => connection.encryption as IEncryptionPassword;
+
+    return FetcherBase.fetch({
+      className: "EncryptedFetcher",
+      encode:
+        route.request?.encrypted === true
+          ? (input, headers) => {
+              const p: IEncryptionPassword = closure("encode")(headers, input);
+              return AesPkcs5.encrypt(
+                (stringify ?? JSON.stringify)(input),
+                p.key,
+                p.iv,
+              );
+            }
+          : (input) => input,
+      decode:
+        route.response?.encrypted === true
+          ? (input, headers) => {
+              const p: IEncryptionPassword = closure("decode")(headers, input);
+              const s: string = AesPkcs5.decrypt(input, p.key, p.iv);
+              return s.length ? JSON.parse(s) : s;
+            }
+          : (input) => input,
+    })(connection, route, input, stringify);
+  }
+
+  export function propagate<Output extends IPropagation<any, any>>(
+    connection: IConnection,
+    route: IFetchRoute<"GET" | "HEAD">,
+  ): Promise<Output>;
+
+  export function propagate<Input, Output extends IPropagation<any, any>>(
+    connection: IConnection,
+    route: IFetchRoute<"DELETE" | "GET" | "HEAD" | "PATCH" | "POST" | "PUT">,
+    input?: Input,
+    stringify?: (input: Input) => string,
+  ): Promise<Output>;
+
+  export async function propagate<Input, Output extends IPropagation<any, any>>(
+    connection: IConnection,
+    route: IFetchRoute<"DELETE" | "GET" | "HEAD" | "PATCH" | "POST" | "PUT">,
+    input?: Input,
+    stringify?: (input: Input) => string,
+  ): Promise<Output> {
+    if (
+      (route.request?.encrypted === true || route.response?.encrypted) &&
+      connection.encryption === undefined
+    )
+      throw new Error(
+        "Error on EncryptedFetcher.propagate(): the encryption password has not been configured.",
+      );
+    const closure =
+      typeof connection.encryption === "function"
+        ? (direction: "encode" | "decode") =>
+            (
+              headers: Record<string, IConnection.HeaderValue | undefined>,
+              body: string,
+            ) =>
+              (connection.encryption as IEncryptionPassword.Closure)({
+                headers,
+                body,
+                direction,
+              })
+        : () => () => connection.encryption as IEncryptionPassword;
+
+    return FetcherBase.propagate({
+      className: "EncryptedFetcher",
+      encode:
+        route.request?.encrypted === true
+          ? (input, headers) => {
+              const p: IEncryptionPassword = closure("encode")(headers, input);
+              return AesPkcs5.encrypt(
+                (stringify ?? JSON.stringify)(input),
+                p.key,
+                p.iv,
+              );
+            }
+          : (input) => input,
+      decode:
+        route.response?.encrypted === true
+          ? (input, headers) => {
+              const p: IEncryptionPassword = closure("decode")(headers, input);
+              const s: string = AesPkcs5.decrypt(input, p.key, p.iv);
+              return s.length ? JSON.parse(s) : s;
+            }
+          : (input) => input,
+    })(connection, route, input, stringify) as Promise<Output>;
+  }
+}

package/src/HttpError.ts

@@ -1,85 +1,85 @@
-/**
- * HTTP Error.
- *
- * `HttpError` is a type of error class who've been thrown by the remote HTTP server.
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export class HttpError extends Error {
-  /**
-   * @internal
-   */
-  private body_: any = NOT_YET;
-
-  /**
-   * Initializer Constructor.
-   *
-   * @param method Method of the HTTP request.
-   * @param path Path of the HTTP request.
-   * @param status Status code from the remote HTTP server.
-   * @param message Error message from the remote HTTP server.
-   */
-  public constructor(
-    public readonly method:
-      | "GET"
-      | "DELETE"
-      | "POST"
-      | "PUT"
-      | "PATCH"
-      | "HEAD",
-    public readonly path: string,
-    public readonly status: number,
-    public readonly headers: Record<string, string | string[]>,
-    message: string,
-  ) {
-    super(message);
-
-    // INHERITANCE POLYFILL
-    const proto: HttpError = new.target.prototype;
-    if (Object.setPrototypeOf) Object.setPrototypeOf(this, proto);
-    else (this as any).__proto__ = proto;
-  }
-
-  /**
-   * `HttpError` to JSON.
-   *
-   * When you call `JSON.stringify()` function on current `HttpError` instance,
-   * this `HttpError.toJSON()` method would be automatically called.
-   *
-   * Also, if response body from the remote HTTP server forms a JSON object,
-   * this `HttpError.toJSON()` method would be useful because it returns the
-   * parsed JSON object about the {@link message} property.
-   *
-   * @template T Expected type of the response body.
-   * @returns JSON object of the `HttpError`.
-   */
-  public toJSON<T>(): HttpError.IProps<T> {
-    if (this.body_ === NOT_YET)
-      try {
-        this.body_ = JSON.parse(this.message);
-      } catch {
-        this.body_ = this.message;
-      }
-    return {
-      method: this.method,
-      path: this.path,
-      status: this.status,
-      headers: this.headers,
-      message: this.body_,
-    };
-  }
-}
-export namespace HttpError {
-  /**
-   * Returned type of {@link HttpError.toJSON} method.
-   */
-  export interface IProps<T> {
-    method: "GET" | "DELETE" | "POST" | "PUT" | "PATCH" | "HEAD";
-    path: string;
-    status: number;
-    headers: Record<string, string | string[]>;
-    message: T;
-  }
-}
-
-const NOT_YET = {} as any;
+/**
+ * HTTP Error.
+ *
+ * `HttpError` is a type of error class who've been thrown by the remote HTTP server.
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export class HttpError extends Error {
+  /**
+   * @internal
+   */
+  private body_: any = NOT_YET;
+
+  /**
+   * Initializer Constructor.
+   *
+   * @param method Method of the HTTP request.
+   * @param path Path of the HTTP request.
+   * @param status Status code from the remote HTTP server.
+   * @param message Error message from the remote HTTP server.
+   */
+  public constructor(
+    public readonly method:
+      | "GET"
+      | "DELETE"
+      | "POST"
+      | "PUT"
+      | "PATCH"
+      | "HEAD",
+    public readonly path: string,
+    public readonly status: number,
+    public readonly headers: Record<string, string | string[]>,
+    message: string,
+  ) {
+    super(message);
+
+    // INHERITANCE POLYFILL
+    const proto: HttpError = new.target.prototype;
+    if (Object.setPrototypeOf) Object.setPrototypeOf(this, proto);
+    else (this as any).__proto__ = proto;
+  }
+
+  /**
+   * `HttpError` to JSON.
+   *
+   * When you call `JSON.stringify()` function on current `HttpError` instance,
+   * this `HttpError.toJSON()` method would be automatically called.
+   *
+   * Also, if response body from the remote HTTP server forms a JSON object,
+   * this `HttpError.toJSON()` method would be useful because it returns the
+   * parsed JSON object about the {@link message} property.
+   *
+   * @template T Expected type of the response body.
+   * @returns JSON object of the `HttpError`.
+   */
+  public toJSON<T>(): HttpError.IProps<T> {
+    if (this.body_ === NOT_YET)
+      try {
+        this.body_ = JSON.parse(this.message);
+      } catch {
+        this.body_ = this.message;
+      }
+    return {
+      method: this.method,
+      path: this.path,
+      status: this.status,
+      headers: this.headers,
+      message: this.body_,
+    };
+  }
+}
+export namespace HttpError {
+  /**
+   * Returned type of {@link HttpError.toJSON} method.
+   */
+  export interface IProps<T> {
+    method: "GET" | "DELETE" | "POST" | "PUT" | "PATCH" | "HEAD";
+    path: string;
+    status: number;
+    headers: Record<string, string | string[]>;
+    message: T;
+  }
+}
+
+const NOT_YET = {} as any;