@nestia/fetcher 3.0.0-dev.20231209 → 3.0.0

package/src/IConnection.ts

@@ -1,237 +1,247 @@
-/// <reference lib="dom" />
-import { IEncryptionPassword } from "./IEncryptionPassword";
-import { IRandomGenerator } from "./IRandomGenerator";
-
-/**
- * Connection information.
- *
- * `IConnection` is an interface ttype who represents connection information of the
- * remote HTTP server. You can target the remote HTTP server by wring the
- * {@link IConnection.host} variable down. Also, you can configure special header values
- * by specializing the {@link IConnection.headers} variable.
- *
- * If the remote HTTP server encrypts or decrypts its body data through the AES-128/256
- * algorithm, specify the {@link IConnection.encryption} with {@link IEncryptionPassword}
- * or {@link IEncryptionPassword.Closure} variable.
- *
- * @author Jenogho Nam - https://github.com/samchon
- * @author Seungjun We - https://github.com/SeungjunWe
- */
-export interface IConnection<Headers extends object = {}> {
-  /**
-   * Host address of the remote HTTP server.
-   */
-  host: string;
-
-  /**
-   * Header values delivered to the remote HTTP server.
-   */
-  headers?: Record<string, IConnection.HeaderValue> &
-    IConnection.Headerify<Headers>;
-
-  /**
-   * Use simulation mode.
-   *
-   * If you configure this property to be `true` or assign an {@link IRandomGenerator}
-   * instance, your SDK library does not send any request to remote backend server,
-   * but just returns random data generated by `typia.random<T>()` function with
-   * request data validation.
-   *
-   * By the way, to utilize this simulation mode, SDK library must be generated with
-   * {@link INestiaConfig.simulate} option, too. Open `nestia.config.ts` file, and
-   * configure {@link INestiaConfig.simulate} property to be `true`. Them, newly
-   * generated SDK library would have a built-in mock-up data generator.
-   *
-   * @default false
-   */
-  simulate?: boolean | Partial<IRandomGenerator>;
-
-  /**
-   * Additional options for the `fetch` function.
-   */
-  options?: IConnection.IOptions;
-
-  /**
-   * Encryption password of its closure function.
-   *
-   * Define it only when target backend server is encrypting body data through
-   * `@EncryptedRoute` or `@EncryptedBody` decorators of `@nestia/core` for
-   * security reason.
-   */
-  encryption?: IEncryptionPassword | IEncryptionPassword.Closure;
-
-  /**
-   * Custom fetch function.
-   *
-   * If you want to use custom `fetch` function instead of built-in function,
-   * assign your custom `fetch` function into this property.
-   */
-  fetch?: typeof fetch;
-}
-export namespace IConnection {
-  /**
-   * Addiotional options for the `fetch` function.
-   *
-   * Almost same with {@link RequestInit} type of the {@link fetch} function,
-   * but `body`, `headers` and `method` properties are omitted.
-   *
-   * The reason why defining duplicated definition of {@link RequestInit}
-   * is for legacy NodeJS environments, which does not have the {@link fetch}
-   * function type.
-   */
-  export interface IOptions {
-    /**
-     * A string indicating how the request will interact with the browser's
-     * cache to set request's cache.
-     */
-    cache?:
-      | "default"
-      | "force-cache"
-      | "no-cache"
-      | "no-store"
-      | "only-if-cached"
-      | "reload";
-
-    /**
-     * A string indicating whether credentials will be sent with the request
-     * always, never, or only when sent to a same-origin URL. Sets request's
-     * credentials.
-     */
-    credentials?: "omit" | "same-origin" | "include";
-
-    /**
-     * A cryptographic hash of the resource to be fetched by request.
-     *
-     * Sets request's integrity.
-     */
-    integrity?: string;
-
-    /**
-     * A boolean to set request's keepalive.
-     */
-    keepalive?: boolean;
-
-    /**
-     * A string to indicate whether the request will use CORS, or will be
-     * restricted to same-origin URLs.
-     *
-     * Sets request's mode.
-     */
-    mode?: "cors" | "navigate" | "no-cors" | "same-origin";
-
-    /**
-     * A string indicating whether request follows redirects, results in
-     * an error upon encountering a redirect, or returns the redirect
-     * (in an opaque fashion).
-     *
-     * Sets request's redirect.
-     */
-    redirect?: "error" | "follow" | "manual";
-
-    /**
-     * A string whose value is a same-origin URL, "about:client", or the
-     * empty string, to set request's referrer.
-     */
-    referrer?: string;
-
-    /**
-     * A referrer policy to set request's referrerPolicy.
-     */
-    referrerPolicy?:
-      | ""
-      | "no-referrer"
-      | "no-referrer-when-downgrade"
-      | "origin"
-      | "origin-when-cross-origin"
-      | "same-origin"
-      | "strict-origin"
-      | "strict-origin-when-cross-origin"
-      | "unsafe-url";
-
-    /**
-     * An AbortSignal to set request's signal.
-     */
-    signal?: AbortSignal | null;
-  }
-
-  /**
-   * Type of allowed header values.
-   *
-   * Only atomic or array of atomic values are allowed.
-   */
-  export type HeaderValue =
-    | string
-    | boolean
-    | number
-    | bigint
-    | string
-    | Array<boolean>
-    | Array<number>
-    | Array<bigint>
-    | Array<number>
-    | Array<string>;
-
-  /**
-   * Type of headers
-   *
-   * `Headerify` removes every properties that are not allowed in the
-   * HTTP headers type.
-   *
-   * Below are list of prohibited in HTTP headers.
-   *
-   * 1. Value type one of {@link HeaderValue}
-   * 2. Key is "set-cookie", but value is not an Array type
-   * 3. Key is one of them, but value is Array type
-   *   - "age"
-   *   - "authorization"
-   *   - "content-length"
-   *   - "content-type"
-   *   - "etag"
-   *   - "expires"
-   *   - "from"
-   *   - "host"
-   *   - "if-modified-since"
-   *   - "if-unmodified-since"
-   *   - "last-modified"
-   *   - "location"
-   *   - "max-forwards"
-   *   - "proxy-authorization"
-   *   - "referer"
-   *   - "retry-after"
-   *   - "server"
-   *   - "user-agent"
-   */
-  export type Headerify<T extends object> = {
-    [P in keyof T]?: T[P] extends HeaderValue | undefined
-      ? P extends string
-        ? Lowercase<P> extends "set-cookie"
-          ? T[P] extends Array<HeaderValue>
-            ? T[P] | undefined
-            : never
-          : Lowercase<P> extends
-              | "age"
-              | "authorization"
-              | "content-length"
-              | "content-type"
-              | "etag"
-              | "expires"
-              | "from"
-              | "host"
-              | "if-modified-since"
-              | "if-unmodified-since"
-              | "last-modified"
-              | "location"
-              | "max-forwards"
-              | "proxy-authorization"
-              | "referer"
-              | "retry-after"
-              | "server"
-              | "user-agent"
-          ? T[P] extends Array<HeaderValue>
-            ? never
-            : T[P] | undefined
-          : T[P] | undefined
-        : never
-      : never;
-  };
-}
+/// <reference lib="dom" />
+import { IEncryptionPassword } from "./IEncryptionPassword";
+import { IFetchEvent } from "./IFetchEvent";
+import { IRandomGenerator } from "./IRandomGenerator";
+
+/**
+ * Connection information.
+ *
+ * `IConnection` is an interface ttype who represents connection information of the
+ * remote HTTP server. You can target the remote HTTP server by wring the
+ * {@link IConnection.host} variable down. Also, you can configure special header values
+ * by specializing the {@link IConnection.headers} variable.
+ *
+ * If the remote HTTP server encrypts or decrypts its body data through the AES-128/256
+ * algorithm, specify the {@link IConnection.encryption} with {@link IEncryptionPassword}
+ * or {@link IEncryptionPassword.Closure} variable.
+ *
+ * @author Jenogho Nam - https://github.com/samchon
+ * @author Seungjun We - https://github.com/SeungjunWe
+ */
+export interface IConnection<Headers extends object = {}> {
+  /**
+   * Host address of the remote HTTP server.
+   */
+  host: string;
+
+  /**
+   * Header values delivered to the remote HTTP server.
+   */
+  headers?: Record<string, IConnection.HeaderValue> &
+    IConnection.Headerify<Headers>;
+
+  /**
+   * Use simulation mode.
+   *
+   * If you configure this property to be `true` or assign an {@link IRandomGenerator}
+   * instance, your SDK library does not send any request to remote backend server,
+   * but just returns random data generated by `typia.random<T>()` function with
+   * request data validation.
+   *
+   * By the way, to utilize this simulation mode, SDK library must be generated with
+   * {@link INestiaConfig.simulate} option, too. Open `nestia.config.ts` file, and
+   * configure {@link INestiaConfig.simulate} property to be `true`. Them, newly
+   * generated SDK library would have a built-in mock-up data generator.
+   *
+   * @default false
+   */
+  simulate?: boolean | Partial<IRandomGenerator>;
+
+  /**
+   * Logger function.
+   *
+   * This function is called when the fetch event is completed.
+   *
+   * @param event Event information of the fetch event.
+   */
+  logger?: (event: IFetchEvent) => Promise<void>;
+
+  /**
+   * Encryption password of its closure function.
+   *
+   * Define it only when target backend server is encrypting body data through
+   * `@EncryptedRoute` or `@EncryptedBody` decorators of `@nestia/core` for
+   * security reason.
+   */
+  encryption?: IEncryptionPassword | IEncryptionPassword.Closure;
+
+  /**
+   * Additional options for the `fetch` function.
+   */
+  options?: IConnection.IOptions;
+
+  /**
+   * Custom fetch function.
+   *
+   * If you want to use custom `fetch` function instead of built-in function,
+   * assign your custom `fetch` function into this property.
+   */
+  fetch?: typeof fetch;
+}
+export namespace IConnection {
+  /**
+   * Addiotional options for the `fetch` function.
+   *
+   * Almost same with {@link RequestInit} type of the {@link fetch} function,
+   * but `body`, `headers` and `method` properties are omitted.
+   *
+   * The reason why defining duplicated definition of {@link RequestInit}
+   * is for legacy NodeJS environments, which does not have the {@link fetch}
+   * function type.
+   */
+  export interface IOptions {
+    /**
+     * A string indicating how the request will interact with the browser's
+     * cache to set request's cache.
+     */
+    cache?:
+      | "default"
+      | "force-cache"
+      | "no-cache"
+      | "no-store"
+      | "only-if-cached"
+      | "reload";
+
+    /**
+     * A string indicating whether credentials will be sent with the request
+     * always, never, or only when sent to a same-origin URL. Sets request's
+     * credentials.
+     */
+    credentials?: "omit" | "same-origin" | "include";
+
+    /**
+     * A cryptographic hash of the resource to be fetched by request.
+     *
+     * Sets request's integrity.
+     */
+    integrity?: string;
+
+    /**
+     * A boolean to set request's keepalive.
+     */
+    keepalive?: boolean;
+
+    /**
+     * A string to indicate whether the request will use CORS, or will be
+     * restricted to same-origin URLs.
+     *
+     * Sets request's mode.
+     */
+    mode?: "cors" | "navigate" | "no-cors" | "same-origin";
+
+    /**
+     * A string indicating whether request follows redirects, results in
+     * an error upon encountering a redirect, or returns the redirect
+     * (in an opaque fashion).
+     *
+     * Sets request's redirect.
+     */
+    redirect?: "error" | "follow" | "manual";
+
+    /**
+     * A string whose value is a same-origin URL, "about:client", or the
+     * empty string, to set request's referrer.
+     */
+    referrer?: string;
+
+    /**
+     * A referrer policy to set request's referrerPolicy.
+     */
+    referrerPolicy?:
+      | ""
+      | "no-referrer"
+      | "no-referrer-when-downgrade"
+      | "origin"
+      | "origin-when-cross-origin"
+      | "same-origin"
+      | "strict-origin"
+      | "strict-origin-when-cross-origin"
+      | "unsafe-url";
+
+    /**
+     * An AbortSignal to set request's signal.
+     */
+    signal?: AbortSignal | null;
+  }
+
+  /**
+   * Type of allowed header values.
+   *
+   * Only atomic or array of atomic values are allowed.
+   */
+  export type HeaderValue =
+    | string
+    | boolean
+    | number
+    | bigint
+    | string
+    | Array<boolean>
+    | Array<number>
+    | Array<bigint>
+    | Array<number>
+    | Array<string>;
+
+  /**
+   * Type of headers
+   *
+   * `Headerify` removes every properties that are not allowed in the
+   * HTTP headers type.
+   *
+   * Below are list of prohibited in HTTP headers.
+   *
+   * 1. Value type one of {@link HeaderValue}
+   * 2. Key is "set-cookie", but value is not an Array type
+   * 3. Key is one of them, but value is Array type
+   *   - "age"
+   *   - "authorization"
+   *   - "content-length"
+   *   - "content-type"
+   *   - "etag"
+   *   - "expires"
+   *   - "from"
+   *   - "host"
+   *   - "if-modified-since"
+   *   - "if-unmodified-since"
+   *   - "last-modified"
+   *   - "location"
+   *   - "max-forwards"
+   *   - "proxy-authorization"
+   *   - "referer"
+   *   - "retry-after"
+   *   - "server"
+   *   - "user-agent"
+   */
+  export type Headerify<T extends object> = {
+    [P in keyof T]?: T[P] extends HeaderValue | undefined
+      ? P extends string
+        ? Lowercase<P> extends "set-cookie"
+          ? T[P] extends Array<HeaderValue>
+            ? T[P] | undefined
+            : never
+          : Lowercase<P> extends
+                | "age"
+                | "authorization"
+                | "content-length"
+                | "content-type"
+                | "etag"
+                | "expires"
+                | "from"
+                | "host"
+                | "if-modified-since"
+                | "if-unmodified-since"
+                | "last-modified"
+                | "location"
+                | "max-forwards"
+                | "proxy-authorization"
+                | "referer"
+                | "retry-after"
+                | "server"
+                | "user-agent"
+            ? T[P] extends Array<HeaderValue>
+              ? never
+              : T[P] | undefined
+            : T[P] | undefined
+        : never
+      : never;
+  };
+}

package/src/IEncryptionPassword.ts

@@ -1,56 +1,50 @@
-import { IConnection } from "./IConnection";
-
-/**
- * Encryption password.
- *
- * `IEncryptionPassword` is a type of interface who represents encryption password used by
- * the {@link Fetcher} with AES-128/256 algorithm. If your encryption password is not fixed
- * but changes according to the input content, you can utilize the
- * {@link IEncryptionPassword.Closure} function type.
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export interface IEncryptionPassword {
-  /**
-   * Secret key.
-   */
-  key: string;
-
-  /**
-   * Initialization Vector.
-   */
-  iv: string;
-}
-export namespace IEncryptionPassword {
-  /**
-   * Type of a closure function returning the {@link IEncryptionPassword} object.
-   *
-   * `IEncryptionPassword.Closure` is a type of closure function who are returning the
-   * {@link IEncryptionPassword} object. It would be used when your encryption password
-   * be changed according to the input content.
-   */
-  export interface Closure {
-    /**
-     * Encryption password getter.
-     *
-     * @param props Properties for predication
-     * @returns Encryption password
-     */
-    (props: IProps): IEncryptionPassword;
-  }
-
-  /**
-   * Properties for the closure.
-   */
-  export type IProps = IDecodeProps | IEncodeProps;
-  export interface IDecodeProps {
-    headers: Record<string, IConnection.HeaderValue | undefined>;
-    body: Uint8Array;
-    direction: "decode";
-  }
-  export interface IEncodeProps {
-    headers: Record<string, IConnection.HeaderValue | undefined>;
-    body: string;
-    direction: "encode";
-  }
-}
+import { IConnection } from "./IConnection";
+
+/**
+ * Encryption password.
+ *
+ * `IEncryptionPassword` is a type of interface who represents encryption password used by
+ * the {@link Fetcher} with AES-128/256 algorithm. If your encryption password is not fixed
+ * but changes according to the input content, you can utilize the
+ * {@link IEncryptionPassword.Closure} function type.
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export interface IEncryptionPassword {
+  /**
+   * Secret key.
+   */
+  key: string;
+
+  /**
+   * Initialization Vector.
+   */
+  iv: string;
+}
+export namespace IEncryptionPassword {
+  /**
+   * Type of a closure function returning the {@link IEncryptionPassword} object.
+   *
+   * `IEncryptionPassword.Closure` is a type of closure function who are returning the
+   * {@link IEncryptionPassword} object. It would be used when your encryption password
+   * be changed according to the input content.
+   */
+  export interface Closure {
+    /**
+     * Encryption password getter.
+     *
+     * @param props Properties for predication
+     * @returns Encryption password
+     */
+    (props: IProps): IEncryptionPassword;
+  }
+
+  /**
+   * Properties for the closure.
+   */
+  export interface IProps {
+    headers: Record<string, IConnection.HeaderValue | undefined>;
+    body: string;
+    direction: "encode" | "decode";
+  }
+}

package/src/IFetchEvent.ts

@@ -0,0 +1,31 @@
+// import { IConnection } from "./IConnection";
+import { IFetchRoute } from "./IFetchRoute";
+
+export interface IFetchEvent {
+  route: IFetchRoute<"DELETE" | "GET" | "HEAD" | "PATCH" | "POST" | "PUT">;
+  path: string;
+  status: number | null;
+  input: any;
+  output: any;
+  started_at: Date;
+  respond_at: Date | null;
+  completed_at: Date;
+}
+// export namespace IFetchEvent {
+//   export interface IFunction {
+//     (connection: IConnection, ...args: any[]): Promise<any>;
+//     METADATA: {
+//       method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
+//       path: string;
+//       request: null | {
+//         type: string;
+//         encrypted: boolean;
+//       };
+//       response: null | {
+//         type: string;
+//         encrypted: boolean;
+//       };
+//     };
+//     status: null | number;
+//   }
+// }