@nestia/fetcher 7.0.3 → 7.1.1-dev.20250714

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.request({
-      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.request({
+      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/FormDataInput.ts

@@ -1,87 +1,87 @@
-/**
- * FormData input type.
- *
- * `FormDataInput<T>` is a type for the input of the `FormData` request, casting
- * `File` property value type as an union of `File` and {@link FormDataInput.IFileProps},
- * especially for the React Native environment.
- *
- * You know what? In the React Native environment, `File` class is not supported.
- * Therefore, when composing a `FormData` request, you have to put the URI address
- * of the local filesystem with file name and content type that is represented by the
- * {@link FormDataInput.IFileProps} type.
- *
- * This `FormDataInput<T>` type is designed for that purpose. If the property value
- * type is a `File` class, it converts it to an union type of `File` and
- * {@link FormDataInput.IFileProps} type. Also, if the property value type is an array
- * of `File` class, it converts it to an array of union type of `File` and
- * {@link FormDataInput.IFileProps} type too.
- *
- * Before    | After
- * ----------|------------------------
- * `boolean` | `boolean`
- * `bigint`  | `bigint`
- * `number`  | `number`
- * `string`  | `string`
- * `File`    | `File \| IFileProps`
- *
- * @template T Target object type.
- * @author Jeongho Nam - https://github.com/samchon
- */
-export type FormDataInput<T extends object> =
-  T extends Array<any>
-    ? never
-    : T extends Function
-      ? never
-      : {
-          [P in keyof T]: T[P] extends Array<infer U>
-            ? FormDataInput.Value<U>[]
-            : FormDataInput.Value<T[P]>;
-        };
-export namespace FormDataInput {
-  /**
-   * Value type of the `FormDataInput`.
-   *
-   * `Value<T>` is a type for the property value defined in the `FormDataInput`.
-   *
-   * If the original value type is a `File` class, `Value<T>` converts it to an union
-   * type of `File` and {@link IFileProps} type which is a structured data for the
-   * URI file location in the React Native environment.
-   */
-  export type Value<T> = T extends File ? T | IFileProps : T;
-
-  /**
-   * Properties of a file.
-   *
-   * In the React Native, this `IFileProps` structured data can replace the `File`
-   * class instance in the `FormData` request.
-   *
-   * Just put the {@link uri URI address} of the local file system with the file's
-   * {@link name} and {@link type}. It would be casted to the `File` class instance
-   * automatically in the `FormData` request.
-   *
-   * Note that, this `IFileProps` type works only in the React Native environment.
-   * If you are developing a Web or NodeJS application, you have to utilize the
-   * `File` class instance directly.
-   */
-  export interface IFileProps {
-    /**
-     * URI address of the file.
-     *
-     * In the React Native, the URI address in the local file system can replace
-     * the `File` class instance. If
-     *
-     * @format uri
-     */
-    uri: string;
-
-    /**
-     * Name of the file.
-     */
-    name: string;
-
-    /**
-     * Content type of the file.
-     */
-    type: string;
-  }
-}
+/**
+ * FormData input type.
+ *
+ * `FormDataInput<T>` is a type for the input of the `FormData` request, casting
+ * `File` property value type as an union of `File` and {@link FormDataInput.IFileProps},
+ * especially for the React Native environment.
+ *
+ * You know what? In the React Native environment, `File` class is not supported.
+ * Therefore, when composing a `FormData` request, you have to put the URI address
+ * of the local filesystem with file name and content type that is represented by the
+ * {@link FormDataInput.IFileProps} type.
+ *
+ * This `FormDataInput<T>` type is designed for that purpose. If the property value
+ * type is a `File` class, it converts it to an union type of `File` and
+ * {@link FormDataInput.IFileProps} type. Also, if the property value type is an array
+ * of `File` class, it converts it to an array of union type of `File` and
+ * {@link FormDataInput.IFileProps} type too.
+ *
+ * Before    | After
+ * ----------|------------------------
+ * `boolean` | `boolean`
+ * `bigint`  | `bigint`
+ * `number`  | `number`
+ * `string`  | `string`
+ * `File`    | `File \| IFileProps`
+ *
+ * @template T Target object type.
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export type FormDataInput<T extends object> =
+  T extends Array<any>
+    ? never
+    : T extends Function
+      ? never
+      : {
+          [P in keyof T]: T[P] extends Array<infer U>
+            ? FormDataInput.Value<U>[]
+            : FormDataInput.Value<T[P]>;
+        };
+export namespace FormDataInput {
+  /**
+   * Value type of the `FormDataInput`.
+   *
+   * `Value<T>` is a type for the property value defined in the `FormDataInput`.
+   *
+   * If the original value type is a `File` class, `Value<T>` converts it to an union
+   * type of `File` and {@link IFileProps} type which is a structured data for the
+   * URI file location in the React Native environment.
+   */
+  export type Value<T> = T extends File ? T | IFileProps : T;
+
+  /**
+   * Properties of a file.
+   *
+   * In the React Native, this `IFileProps` structured data can replace the `File`
+   * class instance in the `FormData` request.
+   *
+   * Just put the {@link uri URI address} of the local file system with the file's
+   * {@link name} and {@link type}. It would be casted to the `File` class instance
+   * automatically in the `FormData` request.
+   *
+   * Note that, this `IFileProps` type works only in the React Native environment.
+   * If you are developing a Web or NodeJS application, you have to utilize the
+   * `File` class instance directly.
+   */
+  export interface IFileProps {
+    /**
+     * URI address of the file.
+     *
+     * In the React Native, the URI address in the local file system can replace
+     * the `File` class instance. If
+     *
+     * @format uri
+     */
+    uri: string;
+
+    /**
+     * Name of the file.
+     */
+    name: string;
+
+    /**
+     * Content type of the file.
+     */
+    type: string;
+  }
+}

package/src/HttpError.ts

@@ -1 +1 @@
-export { HttpError } from "@samchon/openapi";
+export { HttpError } from "@samchon/openapi";