@nestia/fetcher 6.0.6 → 7.0.0-dev.20250604

package/src/IFetchRoute.ts

@@ -1,69 +1,69 @@
-/**
- * Properties of remote API route.
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export interface IFetchRoute<
-  Method extends "HEAD" | "GET" | "POST" | "PUT" | "PATCH" | "DELETE",
-> {
-  /**
-   * Method of the HTTP request.
-   */
-  method: Method;
-
-  /**
-   * Path of the HTTP request.
-   */
-  path: string;
-
-  /**
-   * Path template.
-   *
-   * Filled since 3.2.2 version.
-   */
-  template?: string;
-
-  /**
-   * Request body data info.
-   */
-  request: Method extends "DELETE" | "POST" | "PUT" | "PATCH"
-    ? IFetchRoute.IBody | null
-    : null;
-
-  /**
-   * Response body data info.
-   */
-  response: Method extends "HEAD" ? null : IFetchRoute.IBody;
-
-  /**
-   * When special status code being used.
-   */
-  status: number | null;
-
-  /**
-   * Parser of the query string.
-   *
-   * If content type of response body is `application/x-www-form-urlencoded`,
-   * then this `parseQuery` function would be called.
-   *
-   * If you've forgotten to configuring this `parseQuery` property about the
-   * `application/x-www-form-urlencoded` typed response body data, then
-   * only the `URLSearchParams` typed instance would be returned instead.
-   */
-  parseQuery?(input: URLSearchParams): any;
-}
-export namespace IFetchRoute {
-  /**
-   * Metadata of body.
-   *
-   * Describes how content-type being used in body, and whether encrypted or not.
-   */
-  export interface IBody {
-    type:
-      | "application/json"
-      | "application/x-www-form-urlencoded"
-      | "multipart/form-data"
-      | "text/plain";
-    encrypted?: boolean;
-  }
-}
+/**
+ * Properties of remote API route.
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export interface IFetchRoute<
+  Method extends "HEAD" | "GET" | "POST" | "PUT" | "PATCH" | "DELETE",
+> {
+  /**
+   * Method of the HTTP request.
+   */
+  method: Method;
+
+  /**
+   * Path of the HTTP request.
+   */
+  path: string;
+
+  /**
+   * Path template.
+   *
+   * Filled since 3.2.2 version.
+   */
+  template?: string;
+
+  /**
+   * Request body data info.
+   */
+  request: Method extends "DELETE" | "POST" | "PUT" | "PATCH"
+    ? IFetchRoute.IBody | null
+    : null;
+
+  /**
+   * Response body data info.
+   */
+  response: Method extends "HEAD" ? null : IFetchRoute.IBody;
+
+  /**
+   * When special status code being used.
+   */
+  status: number | null;
+
+  /**
+   * Parser of the query string.
+   *
+   * If content type of response body is `application/x-www-form-urlencoded`,
+   * then this `parseQuery` function would be called.
+   *
+   * If you've forgotten to configuring this `parseQuery` property about the
+   * `application/x-www-form-urlencoded` typed response body data, then
+   * only the `URLSearchParams` typed instance would be returned instead.
+   */
+  parseQuery?(input: URLSearchParams): any;
+}
+export namespace IFetchRoute {
+  /**
+   * Metadata of body.
+   *
+   * Describes how content-type being used in body, and whether encrypted or not.
+   */
+  export interface IBody {
+    type:
+      | "application/json"
+      | "application/x-www-form-urlencoded"
+      | "multipart/form-data"
+      | "text/plain";
+    encrypted?: boolean;
+  }
+}

package/src/IPropagation.ts

@@ -1,100 +1,100 @@
-/**
- * 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: 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"]]>;
-}
+/**
+ * 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: 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/MigrateFetcher.ts

@@ -1,118 +1,118 @@
-import { IHttpMigrateRoute } from "@samchon/openapi";
-
-import { IConnection } from "./IConnection";
-import { IPropagation } from "./IPropagation";
-import { PlainFetcher } from "./PlainFetcher";
-
-/**
- * Use `HttpMigration.execute()` function of `@samchon/openapi` instead.
- *
- * This module would be removed in the next major update.
- *
- * @deprecated
- */
-export namespace MigrateFetcher {
-  export interface IProps {
-    route: IHttpMigrateRoute;
-    connection: IConnection;
-    arguments: any[];
-  }
-
-  export async function request(props: IProps): Promise<any> {
-    const length: number =
-      props.route.parameters.length +
-      (props.route.query ? 1 : 0) +
-      (props.route.body ? 1 : 0);
-    if (props.arguments.length !== length)
-      throw new Error(
-        `Error on MigrateFetcher.request(): arguments length is not matched with the route (expected: ${length}, actual: ${props.arguments.length}).`,
-      );
-    else if (
-      props.route.body?.["x-nestia-encrypted"] === true ||
-      props.route.success?.["x-nestia-encrypted"] === true
-    )
-      throw new Error(
-        `Error on MigrateFetcher.request(): encrypted API is not supported yet.`,
-      );
-    return PlainFetcher.fetch(
-      props.connection,
-      {
-        method: props.route.method.toUpperCase() as "POST",
-        path: getPath(props),
-        template: props.route.path,
-        status: null,
-        request: props.route.body
-          ? {
-              encrypted: false,
-              type: props.route.body.type,
-            }
-          : null,
-        response: {
-          encrypted: false,
-          type: props.route.success?.type ?? "application/json",
-        },
-      },
-      props.route.body ? props.arguments.at(-1) : undefined,
-    );
-  }
-
-  export async function propagate(
-    props: IProps,
-  ): Promise<IPropagation.IBranch<boolean, number, any>> {
-    const length: number =
-      props.route.parameters.length +
-      (props.route.query ? 1 : 0) +
-      (props.route.body ? 1 : 0);
-    if (props.arguments.length !== length)
-      throw new Error(
-        `Error on MigrateFetcher.propagate(): arguments length is not matched with the route (expected: ${length}, actual: ${props.arguments.length}).`,
-      );
-    else if (
-      props.route.body?.["x-nestia-encrypted"] === true ||
-      props.route.success?.["x-nestia-encrypted"] === true
-    )
-      throw new Error(
-        `Error on MigrateFetcher.propagate(): encrypted API is not supported yet.`,
-      );
-    return PlainFetcher.propagate(
-      props.connection,
-      {
-        method: props.route.method.toUpperCase() as "POST",
-        path: getPath(props),
-        template: props.route.path,
-        status: null,
-        request: props.route.body
-          ? {
-              encrypted: false,
-              type: props.route.body.type,
-            }
-          : null,
-        response: {
-          encrypted: false,
-          type: props.route.success?.type ?? "application/json",
-        },
-      },
-      props.route.body ? props.arguments.at(-1) : undefined,
-    ) as Promise<IPropagation.IBranch<boolean, number, any>>;
-  }
-
-  function getPath(props: Pick<IProps, "arguments" | "route">): string {
-    let path: string = props.route.emendedPath;
-    props.route.parameters.forEach((p, i) => {
-      path = path.replace(`:${p.key}`, props.arguments[i]);
-    });
-    if (props.route.query)
-      path += getQueryPath(props.arguments[props.route.parameters.length]);
-    return path;
-  }
-
-  function getQueryPath(query: Record<string, any>): string {
-    const variables = new URLSearchParams();
-    for (const [key, value] of Object.entries(query))
-      if (undefined === value) continue;
-      else if (Array.isArray(value))
-        value.forEach((elem: any) => variables.append(key, String(elem)));
-      else variables.set(key, String(value));
-    return 0 === variables.size ? "" : `?${variables.toString()}`;
-  }
-}
+import { IHttpMigrateRoute } from "@samchon/openapi";
+
+import { IConnection } from "./IConnection";
+import { IPropagation } from "./IPropagation";
+import { PlainFetcher } from "./PlainFetcher";
+
+/**
+ * Use `HttpMigration.execute()` function of `@samchon/openapi` instead.
+ *
+ * This module would be removed in the next major update.
+ *
+ * @deprecated
+ */
+export namespace MigrateFetcher {
+  export interface IProps {
+    route: IHttpMigrateRoute;
+    connection: IConnection;
+    arguments: any[];
+  }
+
+  export async function request(props: IProps): Promise<any> {
+    const length: number =
+      props.route.parameters.length +
+      (props.route.query ? 1 : 0) +
+      (props.route.body ? 1 : 0);
+    if (props.arguments.length !== length)
+      throw new Error(
+        `Error on MigrateFetcher.request(): arguments length is not matched with the route (expected: ${length}, actual: ${props.arguments.length}).`,
+      );
+    else if (
+      props.route.body?.["x-nestia-encrypted"] === true ||
+      props.route.success?.["x-nestia-encrypted"] === true
+    )
+      throw new Error(
+        `Error on MigrateFetcher.request(): encrypted API is not supported yet.`,
+      );
+    return PlainFetcher.fetch(
+      props.connection,
+      {
+        method: props.route.method.toUpperCase() as "POST",
+        path: getPath(props),
+        template: props.route.path,
+        status: null,
+        request: props.route.body
+          ? {
+              encrypted: false,
+              type: props.route.body.type,
+            }
+          : null,
+        response: {
+          encrypted: false,
+          type: props.route.success?.type ?? "application/json",
+        },
+      },
+      props.route.body ? props.arguments.at(-1) : undefined,
+    );
+  }
+
+  export async function propagate(
+    props: IProps,
+  ): Promise<IPropagation.IBranch<boolean, number, any>> {
+    const length: number =
+      props.route.parameters.length +
+      (props.route.query ? 1 : 0) +
+      (props.route.body ? 1 : 0);
+    if (props.arguments.length !== length)
+      throw new Error(
+        `Error on MigrateFetcher.propagate(): arguments length is not matched with the route (expected: ${length}, actual: ${props.arguments.length}).`,
+      );
+    else if (
+      props.route.body?.["x-nestia-encrypted"] === true ||
+      props.route.success?.["x-nestia-encrypted"] === true
+    )
+      throw new Error(
+        `Error on MigrateFetcher.propagate(): encrypted API is not supported yet.`,
+      );
+    return PlainFetcher.propagate(
+      props.connection,
+      {
+        method: props.route.method.toUpperCase() as "POST",
+        path: getPath(props),
+        template: props.route.path,
+        status: null,
+        request: props.route.body
+          ? {
+              encrypted: false,
+              type: props.route.body.type,
+            }
+          : null,
+        response: {
+          encrypted: false,
+          type: props.route.success?.type ?? "application/json",
+        },
+      },
+      props.route.body ? props.arguments.at(-1) : undefined,
+    ) as Promise<IPropagation.IBranch<boolean, number, any>>;
+  }
+
+  function getPath(props: Pick<IProps, "arguments" | "route">): string {
+    let path: string = props.route.emendedPath;
+    props.route.parameters.forEach((p, i) => {
+      path = path.replace(`:${p.key}`, props.arguments[i]);
+    });
+    if (props.route.query)
+      path += getQueryPath(props.arguments[props.route.parameters.length]);
+    return path;
+  }
+
+  function getQueryPath(query: Record<string, any>): string {
+    const variables = new URLSearchParams();
+    for (const [key, value] of Object.entries(query))
+      if (undefined === value) continue;
+      else if (Array.isArray(value))
+        value.forEach((elem: any) => variables.append(key, String(elem)));
+      else variables.set(key, String(value));
+    return 0 === variables.size ? "" : `?${variables.toString()}`;
+  }
+}