@nestia/fetcher 2.4.3 → 2.4.4-dev.20240109

package/src/IPropagation.ts

@@ -1,102 +1,102 @@
-import { Primitive } from "./Primitive";
-
-/**
- * Propagation type.
- *
- * `IPropagation` is a type gathering all possible status codes and their body
- * data types as a discriminated union type. You can specify the status code and
- * its body data type just by using conditional statement like below.
- *
- * ```typescript
- * type Output = IPropagation<{
- *    200: ISeller.IAuthorized;
- *    400: TypeGuardError.IProps;
- * >};
- *
- * const output: Output = await sdk.sellers.authenticate.join(input);
- * if (output.success) {
- *     // automatically casted to "ISeller.IAuthorized" type
- *     const authorized: ISeller.IAuthorized = output.data;
- * } else if (output.status === 400) {
- *     // automatically casted to "TypeGuardError.IProps" type
- *     const error: TypeGuardError.IProps = output.data;
- * } else {
- *     // unknown type when out of pre-defined status codes
- *     const result: unknown = output.data;
- * }
- * ```
- *
- * For reference, this `IPropagation` type is utilized by SDK library generated by
- * `@nestia/sdk`, when you've configured {@link INestiaConfig.propagate} to be `true`.
- * In that case, SDK functions generated by `@nestia/sdk` no more returns response DTO
- * typed data directly, but returns this `IPropagation` typed object instead.
- *
- * @template StatusMap Map of status code and its body data type.
- * @template Success Default success status code.
- * @author Jeongho Nam - https://github.com/samchon
- */
-export type IPropagation<
-  StatusMap extends {
-    [P in IPropagation.Status]?: any;
-  },
-  Success extends number = 200 | 201,
-> =
-  | {
-      [P in keyof StatusMap]: IPropagation.IBranch<
-        P extends Success ? true : false,
-        P,
-        StatusMap[P]
-      >;
-    }[keyof StatusMap]
-  | IPropagation.IBranch<false, unknown, unknown>;
-export namespace IPropagation {
-  /**
-   * Type of configurable status codes.
-   *
-   * The special characters like `2XX`, `3XX`, `4XX`, `5XX` are meaning the range
-   * of status codes. If `5XX` is specified, it means the status code is in the
-   * range of `500` to `599`.
-   */
-  export type Status = number | "2XX" | "3XX" | "4XX" | "5XX";
-
-  /**
-   * Branch type of propagation.
-   *
-   * `IPropagation.IBranch` is a branch type composing `IPropagation` type,
-   * which is gathering all possible status codes and their body data types
-   * as a union type.
-   */
-  export interface IBranch<Success extends boolean, StatusValue, BodyData> {
-    success: Success;
-    status: StatusValue extends "2XX" | "3XX" | "4XX" | "5XX"
-      ? StatusRange<StatusValue>
-      : StatusValue extends number
-      ? StatusValue
-      : never;
-    data: Primitive<BodyData>;
-    headers: Record<string, string | string[]>;
-  }
-
-  /**
-   * Range of status codes by the first digit.
-   */
-  export type StatusRange<T extends "2XX" | "3XX" | "4XX" | "5XX"> = T extends 0
-    ? IntRange<200, 299>
-    : T extends 3
-    ? IntRange<300, 399>
-    : T extends 4
-    ? IntRange<400, 499>
-    : IntRange<500, 599>;
-
-  type IntRange<F extends number, T extends number> = Exclude<
-    Enumerate<T>,
-    Enumerate<F>
-  >;
-
-  type Enumerate<
-    N extends number,
-    Acc extends number[] = [],
-  > = Acc["length"] extends N
-    ? Acc[number]
-    : Enumerate<N, [...Acc, Acc["length"]]>;
-}
+import { Primitive } from "./Primitive";
+
+/**
+ * Propagation type.
+ *
+ * `IPropagation` is a type gathering all possible status codes and their body
+ * data types as a discriminated union type. You can specify the status code and
+ * its body data type just by using conditional statement like below.
+ *
+ * ```typescript
+ * type Output = IPropagation<{
+ *    200: ISeller.IAuthorized;
+ *    400: TypeGuardError.IProps;
+ * >};
+ *
+ * const output: Output = await sdk.sellers.authenticate.join(input);
+ * if (output.success) {
+ *     // automatically casted to "ISeller.IAuthorized" type
+ *     const authorized: ISeller.IAuthorized = output.data;
+ * } else if (output.status === 400) {
+ *     // automatically casted to "TypeGuardError.IProps" type
+ *     const error: TypeGuardError.IProps = output.data;
+ * } else {
+ *     // unknown type when out of pre-defined status codes
+ *     const result: unknown = output.data;
+ * }
+ * ```
+ *
+ * For reference, this `IPropagation` type is utilized by SDK library generated by
+ * `@nestia/sdk`, when you've configured {@link INestiaConfig.propagate} to be `true`.
+ * In that case, SDK functions generated by `@nestia/sdk` no more returns response DTO
+ * typed data directly, but returns this `IPropagation` typed object instead.
+ *
+ * @template StatusMap Map of status code and its body data type.
+ * @template Success Default success status code.
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export type IPropagation<
+  StatusMap extends {
+    [P in IPropagation.Status]?: any;
+  },
+  Success extends number = 200 | 201,
+> =
+  | {
+      [P in keyof StatusMap]: IPropagation.IBranch<
+        P extends Success ? true : false,
+        P,
+        StatusMap[P]
+      >;
+    }[keyof StatusMap]
+  | IPropagation.IBranch<false, unknown, unknown>;
+export namespace IPropagation {
+  /**
+   * Type of configurable status codes.
+   *
+   * The special characters like `2XX`, `3XX`, `4XX`, `5XX` are meaning the range
+   * of status codes. If `5XX` is specified, it means the status code is in the
+   * range of `500` to `599`.
+   */
+  export type Status = number | "2XX" | "3XX" | "4XX" | "5XX";
+
+  /**
+   * Branch type of propagation.
+   *
+   * `IPropagation.IBranch` is a branch type composing `IPropagation` type,
+   * which is gathering all possible status codes and their body data types
+   * as a union type.
+   */
+  export interface IBranch<Success extends boolean, StatusValue, BodyData> {
+    success: Success;
+    status: StatusValue extends "2XX" | "3XX" | "4XX" | "5XX"
+      ? StatusRange<StatusValue>
+      : StatusValue extends number
+      ? StatusValue
+      : never;
+    data: Primitive<BodyData>;
+    headers: Record<string, string | string[]>;
+  }
+
+  /**
+   * Range of status codes by the first digit.
+   */
+  export type StatusRange<T extends "2XX" | "3XX" | "4XX" | "5XX"> = T extends 0
+    ? IntRange<200, 299>
+    : T extends 3
+    ? IntRange<300, 399>
+    : T extends 4
+    ? IntRange<400, 499>
+    : IntRange<500, 599>;
+
+  type IntRange<F extends number, T extends number> = Exclude<
+    Enumerate<T>,
+    Enumerate<F>
+  >;
+
+  type Enumerate<
+    N extends number,
+    Acc extends number[] = [],
+  > = Acc["length"] extends N
+    ? Acc[number]
+    : Enumerate<N, [...Acc, Acc["length"]]>;
+}

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/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>;
+  }
+}