@nestia/fetcher 11.0.0-dev.20260305 → 11.0.0-dev.20260312

package/lib/AesPkcs5.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Utility class for the AES-128/256 encryption.
+ *
+ * - AES-128/256
+ * - CBC mode
+ * - PKCS#5 Padding
+ * - Base64 Encoding
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare namespace AesPkcs5 {
+    /**
+     * Encrypt data
+     *
+     * @param data Target data
+     * @param key Key value of the encryption.
+     * @param iv Initializer Vector for the encryption
+     * @returns Encrypted data
+     */
+    function encrypt(data: string, key: string, iv: string): string;
+    /**
+     * Decrypt data.
+     *
+     * @param data Target data
+     * @param key Key value of the decryption.
+     * @param iv Initializer Vector for the decryption
+     * @returns Decrypted data.
+     */
+    function decrypt(data: string, key: string, iv: string): string;
+}

package/lib/AesPkcs5.js

@@ -0,0 +1,49 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AesPkcs5 = void 0;
+const crypto_1 = __importDefault(require("crypto"));
+/**
+ * Utility class for the AES-128/256 encryption.
+ *
+ * - AES-128/256
+ * - CBC mode
+ * - PKCS#5 Padding
+ * - Base64 Encoding
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+var AesPkcs5;
+(function (AesPkcs5) {
+    /**
+     * Encrypt data
+     *
+     * @param data Target data
+     * @param key Key value of the encryption.
+     * @param iv Initializer Vector for the encryption
+     * @returns Encrypted data
+     */
+    function encrypt(data, key, iv) {
+        const bytes = key.length * 8;
+        const cipher = crypto_1.default.createCipheriv(`AES-${bytes}-CBC`, key, iv);
+        return cipher.update(data, "utf8", "base64") + cipher.final("base64");
+    }
+    AesPkcs5.encrypt = encrypt;
+    /**
+     * Decrypt data.
+     *
+     * @param data Target data
+     * @param key Key value of the decryption.
+     * @param iv Initializer Vector for the decryption
+     * @returns Decrypted data.
+     */
+    function decrypt(data, key, iv) {
+        const bytes = key.length * 8;
+        const decipher = crypto_1.default.createDecipheriv(`AES-${bytes}-CBC`, key, iv);
+        return decipher.update(data, "base64", "utf8") + decipher.final("utf8");
+    }
+    AesPkcs5.decrypt = decrypt;
+})(AesPkcs5 || (exports.AesPkcs5 = AesPkcs5 = {}));
+//# sourceMappingURL=AesPkcs5.js.map

package/lib/AesPkcs5.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AesPkcs5.js","sourceRoot":"","sources":["../src/AesPkcs5.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA4B;AAE5B;;;;;;;;;GASG;AACH,IAAiB,QAAQ,CA4BxB;AA5BD,WAAiB,QAAQ;IACvB;;;;;;;OAOG;IACH,SAAgB,OAAO,CAAC,IAAY,EAAE,GAAW,EAAE,EAAU;QAC3D,MAAM,KAAK,GAAW,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC;QACrC,MAAM,MAAM,GAAG,gBAAM,CAAC,cAAc,CAAC,OAAO,KAAK,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;QAClE,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACxE,CAAC;IAJe,gBAAO,UAItB,CAAA;IAED;;;;;;;OAOG;IACH,SAAgB,OAAO,CAAC,IAAY,EAAE,GAAW,EAAE,EAAU;QAC3D,MAAM,KAAK,GAAW,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC;QACrC,MAAM,QAAQ,GAAG,gBAAM,CAAC,gBAAgB,CAAC,OAAO,KAAK,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;QACtE,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC1E,CAAC;IAJe,gBAAO,UAItB,CAAA;AACH,CAAC,EA5BgB,QAAQ,wBAAR,QAAQ,QA4BxB"}

package/lib/EncryptedFetcher.d.ts

@@ -0,0 +1,47 @@
+import { IConnection } from "./IConnection";
+import { IFetchRoute } from "./IFetchRoute";
+import { IPropagation } from "./IPropagation";
+/**
+ * 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 declare 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
+     * @returns Nothing because of `HEAD` method
+     */
+    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
+     * @returns Response body data from the remote API
+     */
+    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
+     * @returns Response body data from the remote API
+     */
+    function fetch<Input, Output>(connection: IConnection, route: IFetchRoute<"POST" | "PUT" | "PATCH" | "DELETE">, input?: Input, stringify?: (input: Input) => string): Promise<Output>;
+    function propagate<Output extends IPropagation<any, any>>(connection: IConnection, route: IFetchRoute<"GET" | "HEAD">): Promise<Output>;
+    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>;
+}

package/lib/EncryptedFetcher.js

@@ -0,0 +1,98 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EncryptedFetcher = void 0;
+const AesPkcs5_1 = require("./AesPkcs5");
+const FetcherBase_1 = require("./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
+ */
+var EncryptedFetcher;
+(function (EncryptedFetcher) {
+    function fetch(connection, route, input, stringify) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d;
+            if ((((_a = route.request) === null || _a === void 0 ? void 0 : _a.encrypted) === true || ((_b = route.response) === null || _b === void 0 ? void 0 : _b.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) => (headers, body) => connection.encryption({
+                    headers,
+                    body,
+                    direction,
+                })
+                : () => () => connection.encryption;
+            return FetcherBase_1.FetcherBase.request({
+                className: "EncryptedFetcher",
+                encode: ((_c = route.request) === null || _c === void 0 ? void 0 : _c.encrypted) === true
+                    ? (input, headers) => {
+                        const p = closure("encode")(headers, input);
+                        return AesPkcs5_1.AesPkcs5.encrypt((stringify !== null && stringify !== void 0 ? stringify : JSON.stringify)(input), p.key, p.iv);
+                    }
+                    : (input) => input,
+                decode: ((_d = route.response) === null || _d === void 0 ? void 0 : _d.encrypted) === true
+                    ? (input, headers) => {
+                        const p = closure("decode")(headers, input);
+                        const s = AesPkcs5_1.AesPkcs5.decrypt(input, p.key, p.iv);
+                        return s.length ? JSON.parse(s) : s;
+                    }
+                    : (input) => input,
+            })(connection, route, input, stringify);
+        });
+    }
+    EncryptedFetcher.fetch = fetch;
+    function propagate(connection, route, input, stringify) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d;
+            if ((((_a = route.request) === null || _a === void 0 ? void 0 : _a.encrypted) === true || ((_b = route.response) === null || _b === void 0 ? void 0 : _b.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) => (headers, body) => connection.encryption({
+                    headers,
+                    body,
+                    direction,
+                })
+                : () => () => connection.encryption;
+            return FetcherBase_1.FetcherBase.propagate({
+                className: "EncryptedFetcher",
+                encode: ((_c = route.request) === null || _c === void 0 ? void 0 : _c.encrypted) === true
+                    ? (input, headers) => {
+                        const p = closure("encode")(headers, input);
+                        return AesPkcs5_1.AesPkcs5.encrypt((stringify !== null && stringify !== void 0 ? stringify : JSON.stringify)(input), p.key, p.iv);
+                    }
+                    : (input) => input,
+                decode: ((_d = route.response) === null || _d === void 0 ? void 0 : _d.encrypted) === true
+                    ? (input, headers) => {
+                        const p = closure("decode")(headers, input);
+                        const s = AesPkcs5_1.AesPkcs5.decrypt(input, p.key, p.iv);
+                        return s.length ? JSON.parse(s) : s;
+                    }
+                    : (input) => input,
+            })(connection, route, input, stringify);
+        });
+    }
+    EncryptedFetcher.propagate = propagate;
+})(EncryptedFetcher || (exports.EncryptedFetcher = EncryptedFetcher = {}));
+//# sourceMappingURL=EncryptedFetcher.js.map

package/lib/EncryptedFetcher.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EncryptedFetcher.js","sourceRoot":"","sources":["../src/EncryptedFetcher.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yCAAsC;AAKtC,wDAAqD;AAErD;;;;;;;;;;;;;;;GAeG;AACH,IAAiB,gBAAgB,CAwJhC;AAxJD,WAAiB,gBAAgB;IAuC/B,SAAsB,KAAK,CACzB,UAAuB,EACvB,KAAwE,EACxE,KAAa,EACb,SAAoC;;;YAEpC,IACE,CAAC,CAAA,MAAA,KAAK,CAAC,OAAO,0CAAE,SAAS,MAAK,IAAI,KAAI,MAAA,KAAK,CAAC,QAAQ,0CAAE,SAAS,CAAA,CAAC;gBAChE,UAAU,CAAC,UAAU,KAAK,SAAS;gBAEnC,MAAM,IAAI,KAAK,CACb,qFAAqF,CACtF,CAAC;YACJ,MAAM,OAAO,GACX,OAAO,UAAU,CAAC,UAAU,KAAK,UAAU;gBACzC,CAAC,CAAC,CAAC,SAA8B,EAAE,EAAE,CACjC,CACE,OAA4D,EAC5D,IAAY,EACZ,EAAE,CACD,UAAU,CAAC,UAA0C,CAAC;oBACrD,OAAO;oBACP,IAAI;oBACJ,SAAS;iBACV,CAAC;gBACR,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,UAAiC,CAAC;YAE/D,OAAO,yBAAW,CAAC,OAAO,CAAC;gBACzB,SAAS,EAAE,kBAAkB;gBAC7B,MAAM,EACJ,CAAA,MAAA,KAAK,CAAC,OAAO,0CAAE,SAAS,MAAK,IAAI;oBAC/B,CAAC,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;wBACjB,MAAM,CAAC,GAAwB,OAAO,CAAC,QAAQ,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;wBACjE,OAAO,mBAAQ,CAAC,OAAO,CACrB,CAAC,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,IAAI,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,EACpC,CAAC,CAAC,GAAG,EACL,CAAC,CAAC,EAAE,CACL,CAAC;oBACJ,CAAC;oBACH,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK;gBACtB,MAAM,EACJ,CAAA,MAAA,KAAK,CAAC,QAAQ,0CAAE,SAAS,MAAK,IAAI;oBAChC,CAAC,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;wBACjB,MAAM,CAAC,GAAwB,OAAO,CAAC,QAAQ,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;wBACjE,MAAM,CAAC,GAAW,mBAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;wBACvD,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;oBACtC,CAAC;oBACH,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK;aACvB,CAAC,CAAC,UAAU,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;QAC1C,CAAC;KAAA;IAjDqB,sBAAK,QAiD1B,CAAA;IAcD,SAAsB,SAAS,CAC7B,UAAuB,EACvB,KAAwE,EACxE,KAAa,EACb,SAAoC;;;YAEpC,IACE,CAAC,CAAA,MAAA,KAAK,CAAC,OAAO,0CAAE,SAAS,MAAK,IAAI,KAAI,MAAA,KAAK,CAAC,QAAQ,0CAAE,SAAS,CAAA,CAAC;gBAChE,UAAU,CAAC,UAAU,KAAK,SAAS;gBAEnC,MAAM,IAAI,KAAK,CACb,yFAAyF,CAC1F,CAAC;YACJ,MAAM,OAAO,GACX,OAAO,UAAU,CAAC,UAAU,KAAK,UAAU;gBACzC,CAAC,CAAC,CAAC,SAA8B,EAAE,EAAE,CACjC,CACE,OAA4D,EAC5D,IAAY,EACZ,EAAE,CACD,UAAU,CAAC,UAA0C,CAAC;oBACrD,OAAO;oBACP,IAAI;oBACJ,SAAS;iBACV,CAAC;gBACR,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,UAAiC,CAAC;YAE/D,OAAO,yBAAW,CAAC,SAAS,CAAC;gBAC3B,SAAS,EAAE,kBAAkB;gBAC7B,MAAM,EACJ,CAAA,MAAA,KAAK,CAAC,OAAO,0CAAE,SAAS,MAAK,IAAI;oBAC/B,CAAC,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;wBACjB,MAAM,CAAC,GAAwB,OAAO,CAAC,QAAQ,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;wBACjE,OAAO,mBAAQ,CAAC,OAAO,CACrB,CAAC,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,IAAI,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,EACpC,CAAC,CAAC,GAAG,EACL,CAAC,CAAC,EAAE,CACL,CAAC;oBACJ,CAAC;oBACH,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK;gBACtB,MAAM,EACJ,CAAA,MAAA,KAAK,CAAC,QAAQ,0CAAE,SAAS,MAAK,IAAI;oBAChC,CAAC,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;wBACjB,MAAM,CAAC,GAAwB,OAAO,CAAC,QAAQ,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;wBACjE,MAAM,CAAC,GAAW,mBAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;wBACvD,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;oBACtC,CAAC;oBACH,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK;aACvB,CAAC,CAAC,UAAU,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,CAAoB,CAAC;QAC7D,CAAC;KAAA;IAjDqB,0BAAS,YAiD9B,CAAA;AACH,CAAC,EAxJgB,gBAAgB,gCAAhB,gBAAgB,QAwJhC"}

package/lib/FormDataInput.d.ts

@@ -0,0 +1,70 @@
+/**
+ * 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`
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @template T Target object type.
+ */
+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 declare 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.
+     */
+    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.
+     */
+    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/lib/FormDataInput.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=FormDataInput.js.map

package/lib/FormDataInput.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FormDataInput.js","sourceRoot":"","sources":["../src/FormDataInput.ts"],"names":[],"mappings":""}

package/lib/HttpError.d.ts

@@ -0,0 +1 @@
+export { HttpError } from "@typia/utils";

package/lib/HttpError.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpError = void 0;
+var utils_1 = require("@typia/utils");
+Object.defineProperty(exports, "HttpError", { enumerable: true, get: function () { return utils_1.HttpError; } });
+//# sourceMappingURL=HttpError.js.map

package/lib/HttpError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HttpError.js","sourceRoot":"","sources":["../src/HttpError.ts"],"names":[],"mappings":";;;AAAA,sCAAyC;AAAhC,kGAAA,SAAS,OAAA"}

package/lib/IConnection.d.ts

@@ -0,0 +1,165 @@
+import { IEncryptionPassword } from "./IEncryptionPassword";
+import { IFetchEvent } from "./IFetchEvent";
+/**
+ * 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 | undefined = object | undefined> {
+    /** 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`, 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;
+    /**
+     * 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, assign your
+     * custom `fetch` function into this property.
+     *
+     * For reference, the `fetch` function has started to be supported since
+     * version 20 of NodeJS. Therefore, if you are using NodeJS version 19 or
+     * lower, you have to assign the `node-fetch` module into this property.
+     */
+    fetch?: typeof fetch;
+}
+export declare namespace IConnection {
+    /**
+     * Additional 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.
+     */
+    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.
+     */
+    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"
+     */
+    type Headerify<T extends object | undefined> = {
+        [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/lib/IConnection.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IConnection.js.map

package/lib/IConnection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IConnection.js","sourceRoot":"","sources":["../src/IConnection.ts"],"names":[],"mappings":""}

package/lib/IEncryptionPassword.d.ts

@@ -0,0 +1,41 @@
+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 declare 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.
+     */
+    interface Closure {
+        /**
+         * Encryption password getter.
+         *
+         * @param props Properties for predication
+         * @returns Encryption password
+         */
+        (props: IProps): IEncryptionPassword;
+    }
+    /** Properties for the closure. */
+    interface IProps {
+        headers: Record<string, IConnection.HeaderValue | undefined>;
+        body: string;
+        direction: "encode" | "decode";
+    }
+}

package/lib/IEncryptionPassword.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IEncryptionPassword.js.map

package/lib/IEncryptionPassword.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEncryptionPassword.js","sourceRoot":"","sources":["../src/IEncryptionPassword.ts"],"names":[],"mappings":""}

package/lib/IFetchEvent.d.ts

@@ -0,0 +1,11 @@
+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;
+}

package/lib/IFetchEvent.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// 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;
+//   }
+// }
+//# sourceMappingURL=IFetchEvent.js.map

package/lib/IFetchEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IFetchEvent.js","sourceRoot":"","sources":["../src/IFetchEvent.ts"],"names":[],"mappings":";;AAaA,iCAAiC;AACjC,iCAAiC;AACjC,+DAA+D;AAC/D,kBAAkB;AAClB,kFAAkF;AAClF,sBAAsB;AACtB,0BAA0B;AAC1B,wBAAwB;AACxB,8BAA8B;AAC9B,WAAW;AACX,2BAA2B;AAC3B,wBAAwB;AACxB,8BAA8B;AAC9B,WAAW;AACX,SAAS;AACT,6BAA6B;AAC7B,MAAM;AACN,IAAI"}

package/lib/IFetchRoute.d.ts

@@ -0,0 +1,46 @@
+/**
+ * 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 declare namespace IFetchRoute {
+    /**
+     * Metadata of body.
+     *
+     * Describes how content-type being used in body, and whether encrypted or
+     * not.
+     */
+    interface IBody {
+        type: "application/json" | "application/x-www-form-urlencoded" | "multipart/form-data" | "text/plain";
+        encrypted?: boolean;
+    }
+}

package/lib/IFetchRoute.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IFetchRoute.js.map

package/lib/IFetchRoute.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IFetchRoute.js","sourceRoot":"","sources":["../src/IFetchRoute.ts"],"names":[],"mappings":""}