@nestia/fetcher 2.5.0-dev.20240131 → 2.5.0

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;

package/src/IEncryptionPassword.ts

@@ -1,50 +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 interface IProps {
-    headers: Record<string, IConnection.HeaderValue | undefined>;
-    body: string;
-    direction: "encode" | "decode";
-  }
-}
+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/IRandomGenerator.ts

@@ -1,38 +1,38 @@
-export interface IRandomGenerator {
-  boolean(): boolean;
-  integer(minimum?: number, maximum?: number): number;
-  number(minimum?: number, maximum?: number): number;
-  bigint(minimum?: bigint, maximum?: bigint): bigint;
-  string(length?: number): string;
-  array<T>(closure: (index: number) => T, count?: number): T[];
-  length(): number;
-
-  uuid(): string;
-  email(): string;
-  url(): string;
-  ipv4(): string;
-  ipv6(): string;
-  pattern(regex: RegExp): string;
-  date(minimum?: number, maximum?: number): string;
-  datetime(minimum?: number, maximum?: number): string;
-
-  customs?: IRandomGenerator.CustomMap;
-}
-export namespace IRandomGenerator {
-  export type CustomMap = {
-    [Type in keyof Customizable]?: (
-      tags: ICommentTag[],
-    ) => Customizable[Type] | undefined;
-  };
-
-  export type Customizable = {
-    number: number;
-    string: string;
-    bigint: bigint;
-  };
-
-  export interface ICommentTag {
-    name: string;
-    value?: string;
-  }
-}
+export interface IRandomGenerator {
+  boolean(): boolean;
+  integer(minimum?: number, maximum?: number): number;
+  number(minimum?: number, maximum?: number): number;
+  bigint(minimum?: bigint, maximum?: bigint): bigint;
+  string(length?: number): string;
+  array<T>(closure: (index: number) => T, count?: number): T[];
+  length(): number;
+
+  uuid(): string;
+  email(): string;
+  url(): string;
+  ipv4(): string;
+  ipv6(): string;
+  pattern(regex: RegExp): string;
+  date(minimum?: number, maximum?: number): string;
+  datetime(minimum?: number, maximum?: number): string;
+
+  customs?: IRandomGenerator.CustomMap;
+}
+export namespace IRandomGenerator {
+  export type CustomMap = {
+    [Type in keyof Customizable]?: (
+      tags: ICommentTag[],
+    ) => Customizable[Type] | undefined;
+  };
+
+  export type Customizable = {
+    number: number;
+    string: string;
+    bigint: bigint;
+  };
+
+  export interface ICommentTag {
+    name: string;
+    value?: string;
+  }
+}

package/src/NestiaSimulator.ts

@@ -0,0 +1,82 @@
+import { HttpError } from "./HttpError";
+
+export namespace NestiaSimulator {
+  export interface IProps {
+    host: string;
+    path: string;
+    method: "GET" | "POST" | "PATCH" | "PUT" | "DELETE";
+    contentType: string;
+  }
+
+  export const assert = (props: IProps) => {
+    return {
+      param: param(props),
+      query: query(props),
+      body: body(props),
+    };
+  };
+  const param =
+    (props: IProps) =>
+    (name: string) =>
+    <T>(task: () => T): void => {
+      validate((exp) => `URL parameter "${name}" is not ${exp.expected} type.`)(
+        props,
+      )(task);
+    };
+
+  const query =
+    (props: IProps) =>
+    <T>(task: () => T): void =>
+      validate(
+        () => "Request query parameters are not following the promised type.",
+      )(props)(task);
+
+  const body =
+    (props: IProps) =>
+    <T>(task: () => T): void =>
+      validate(() => "Request body is not following the promised type.")(props)(
+        task,
+      );
+
+  const validate =
+    (message: (exp: TypeGuardError) => string, path?: string) =>
+    (props: IProps) =>
+    <T>(task: () => T): void => {
+      try {
+        task();
+      } catch (exp) {
+        if (isTypeGuardError(exp))
+          throw new HttpError(
+            props.method,
+            props.host + props.path,
+            400,
+            {
+              "Content-Type": props.contentType,
+            },
+            JSON.stringify({
+              method: exp.method,
+              path: path ?? exp.path,
+              expected: exp.expected,
+              value: exp.value,
+              message: message(exp),
+            }),
+          );
+        throw exp;
+      }
+    };
+}
+
+const isTypeGuardError = (input: any): input is TypeGuardError =>
+  "string" === typeof input.method &&
+  (undefined === input.path || "string" === typeof input.path) &&
+  "string" === typeof input.expected &&
+  "string" === typeof input.name &&
+  "string" === typeof input.message &&
+  (undefined === input.stack || "string" === typeof input.stack);
+
+interface TypeGuardError extends Error {
+  method: string;
+  path: string | undefined;
+  expected: string;
+  value: any;
+}

package/src/PlainFetcher.ts

@@ -1,106 +1,106 @@
-import { IConnection } from "./IConnection";
-import { IPropagation } from "./IPropagation";
-import { Primitive } from "./Primitive";
-import { FetcherBase } from "./internal/FetcherBase";
-import { IFetchRoute } from "./internal/IFetchRoute";
-
-/**
- * Utility class for `fetch` functions used in `@nestia/sdk`.
- *
- * `PlainFetcher` is a utility class designed for SDK functions generated by
- * [`@nestia/sdk`](https://nestia.io/docs/sdk/sdk), interacting with the remote
- * HTTP sever API. In other words, this is a collection of dedicated `fetch()`
- * functions for `@nestia/sdk`.
- *
- * For reference, `PlainFetcher` class does not encrypt or decrypt the body data
- * at all. It just delivers plain data without any post processing. If you've
- * defined a controller method through `@EncryptedRoute` or `@EncryptedBody`
- * decorator, then {@liink EncryptedFetcher} class would be used instead.
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export namespace PlainFetcher {
-  /**
-   * 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<Primitive<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<Primitive<Output>>;
-
-  export async function fetch<Input, Output>(
-    connection: IConnection,
-    route: IFetchRoute<"DELETE" | "GET" | "HEAD" | "PATCH" | "POST" | "PUT">,
-    input?: Input,
-    stringify?: (input: Input) => string,
-  ): Promise<Primitive<Output>> {
-    if (route.request?.encrypted === true || route.response?.encrypted === true)
-      throw new Error(
-        "Error on PlainFetcher.fetch(): PlainFetcher doesn't have encryption ability. Use EncryptedFetcher instead.",
-      );
-    return FetcherBase.fetch({
-      className: "PlainFetcher",
-      encode: (input) => input,
-      decode: (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 === true)
-      throw new Error(
-        "Error on PlainFetcher.propagate(): PlainFetcher doesn't have encryption ability. Use EncryptedFetcher instead.",
-      );
-    return FetcherBase.propagate({
-      className: "PlainFetcher",
-      encode: (input) => input,
-      decode: (input) => input,
-    })(connection, route, input, stringify) as Promise<Output>;
-  }
-}
+import { IConnection } from "./IConnection";
+import { IPropagation } from "./IPropagation";
+import { Primitive } from "./Primitive";
+import { FetcherBase } from "./internal/FetcherBase";
+import { IFetchRoute } from "./internal/IFetchRoute";
+
+/**
+ * Utility class for `fetch` functions used in `@nestia/sdk`.
+ *
+ * `PlainFetcher` is a utility class designed for SDK functions generated by
+ * [`@nestia/sdk`](https://nestia.io/docs/sdk/sdk), interacting with the remote
+ * HTTP sever API. In other words, this is a collection of dedicated `fetch()`
+ * functions for `@nestia/sdk`.
+ *
+ * For reference, `PlainFetcher` class does not encrypt or decrypt the body data
+ * at all. It just delivers plain data without any post processing. If you've
+ * defined a controller method through `@EncryptedRoute` or `@EncryptedBody`
+ * decorator, then {@liink EncryptedFetcher} class would be used instead.
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export namespace PlainFetcher {
+  /**
+   * 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<Primitive<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<Primitive<Output>>;
+
+  export async function fetch<Input, Output>(
+    connection: IConnection,
+    route: IFetchRoute<"DELETE" | "GET" | "HEAD" | "PATCH" | "POST" | "PUT">,
+    input?: Input,
+    stringify?: (input: Input) => string,
+  ): Promise<Primitive<Output>> {
+    if (route.request?.encrypted === true || route.response?.encrypted === true)
+      throw new Error(
+        "Error on PlainFetcher.fetch(): PlainFetcher doesn't have encryption ability. Use EncryptedFetcher instead.",
+      );
+    return FetcherBase.fetch({
+      className: "PlainFetcher",
+      encode: (input) => input,
+      decode: (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 === true)
+      throw new Error(
+        "Error on PlainFetcher.propagate(): PlainFetcher doesn't have encryption ability. Use EncryptedFetcher instead.",
+      );
+    return FetcherBase.propagate({
+      className: "PlainFetcher",
+      encode: (input) => input,
+      decode: (input) => input,
+    })(connection, route, input, stringify) as Promise<Output>;
+  }
+}

package/src/index.ts

@@ -1,7 +1,7 @@
-export * from "./IConnection";
-export * from "./IEncryptionPassword";
-export * from "./IPropagation";
-export * from "./IRandomGenerator";
-export * from "./HttpError";
-export * from "./Primitive";
-export * from "./Resolved";
+export * from "./IConnection";
+export * from "./IEncryptionPassword";
+export * from "./IPropagation";
+export * from "./IRandomGenerator";
+export * from "./HttpError";
+export * from "./Primitive";
+export * from "./Resolved";