@nestia/fetcher 2.5.0-dev.20240131 → 2.5.0

package/lib/NestiaSimulator.d.ts

@@ -0,0 +1,13 @@
+export declare namespace NestiaSimulator {
+    interface IProps {
+        host: string;
+        path: string;
+        method: "GET" | "POST" | "PATCH" | "PUT" | "DELETE";
+        contentType: string;
+    }
+    const assert: (props: IProps) => {
+        param: (name: string) => <T>(task: () => T) => void;
+        query: <T_1>(task: () => T_1) => void;
+        body: <T_2>(task: () => T_2) => void;
+    };
+}

package/lib/NestiaSimulator.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NestiaSimulator = void 0;
+var HttpError_1 = require("./HttpError");
+var NestiaSimulator;
+(function (NestiaSimulator) {
+    NestiaSimulator.assert = function (props) {
+        return {
+            param: param(props),
+            query: query(props),
+            body: body(props),
+        };
+    };
+    var param = function (props) {
+        return function (name) {
+            return function (task) {
+                validate(function (exp) { return "URL parameter \"".concat(name, "\" is not ").concat(exp.expected, " type."); })(props)(task);
+            };
+        };
+    };
+    var query = function (props) {
+        return function (task) {
+            return validate(function () { return "Request query parameters are not following the promised type."; })(props)(task);
+        };
+    };
+    var body = function (props) {
+        return function (task) {
+            return validate(function () { return "Request body is not following the promised type."; })(props)(task);
+        };
+    };
+    var validate = function (message, path) {
+        return function (props) {
+            return function (task) {
+                try {
+                    task();
+                }
+                catch (exp) {
+                    if (isTypeGuardError(exp))
+                        throw new HttpError_1.HttpError(props.method, props.host + props.path, 400, {
+                            "Content-Type": props.contentType,
+                        }, JSON.stringify({
+                            method: exp.method,
+                            path: path !== null && path !== void 0 ? path : exp.path,
+                            expected: exp.expected,
+                            value: exp.value,
+                            message: message(exp),
+                        }));
+                    throw exp;
+                }
+            };
+        };
+    };
+})(NestiaSimulator || (exports.NestiaSimulator = NestiaSimulator = {}));
+var isTypeGuardError = function (input) {
+    return "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);
+};
+//# sourceMappingURL=NestiaSimulator.js.map

package/lib/NestiaSimulator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NestiaSimulator.js","sourceRoot":"","sources":["../src/NestiaSimulator.ts"],"names":[],"mappings":";;;AAAA,yCAAwC;AAExC,IAAiB,eAAe,CAgE/B;AAhED,WAAiB,eAAe;IAQjB,sBAAM,GAAG,UAAC,KAAa;QAClC,OAAO;YACL,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC;YACnB,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC;YACnB,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC;SAClB,CAAC;IACJ,CAAC,CAAC;IACF,IAAM,KAAK,GACT,UAAC,KAAa;QACd,OAAA,UAAC,IAAY;YACb,OAAA,UAAI,IAAa;gBACf,QAAQ,CAAC,UAAC,GAAG,IAAK,OAAA,0BAAkB,IAAI,uBAAY,GAAG,CAAC,QAAQ,WAAQ,EAAtD,CAAsD,CAAC,CACvE,KAAK,CACN,CAAC,IAAI,CAAC,CAAC;YACV,CAAC;QAJD,CAIC;IALD,CAKC,CAAC;IAEJ,IAAM,KAAK,GACT,UAAC,KAAa;QACd,OAAA,UAAI,IAAa;YACf,OAAA,QAAQ,CACN,cAAM,OAAA,+DAA+D,EAA/D,CAA+D,CACtE,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC;QAFd,CAEc;IAHhB,CAGgB,CAAC;IAEnB,IAAM,IAAI,GACR,UAAC,KAAa;QACd,OAAA,UAAI,IAAa;YACf,OAAA,QAAQ,CAAC,cAAM,OAAA,kDAAkD,EAAlD,CAAkD,CAAC,CAAC,KAAK,CAAC,CACvE,IAAI,CACL;QAFD,CAEC;IAHH,CAGG,CAAC;IAEN,IAAM,QAAQ,GACZ,UAAC,OAAwC,EAAE,IAAa;QACxD,OAAA,UAAC,KAAa;YACd,OAAA,UAAI,IAAa;gBACf,IAAI,CAAC;oBACH,IAAI,EAAE,CAAC;gBACT,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACb,IAAI,gBAAgB,CAAC,GAAG,CAAC;wBACvB,MAAM,IAAI,qBAAS,CACjB,KAAK,CAAC,MAAM,EACZ,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,EACvB,GAAG,EACH;4BACE,cAAc,EAAE,KAAK,CAAC,WAAW;yBAClC,EACD,IAAI,CAAC,SAAS,CAAC;4BACb,MAAM,EAAE,GAAG,CAAC,MAAM;4BAClB,IAAI,EAAE,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,GAAG,CAAC,IAAI;4BACtB,QAAQ,EAAE,GAAG,CAAC,QAAQ;4BACtB,KAAK,EAAE,GAAG,CAAC,KAAK;4BAChB,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC;yBACtB,CAAC,CACH,CAAC;oBACJ,MAAM,GAAG,CAAC;gBACZ,CAAC;YACH,CAAC;QAtBD,CAsBC;IAvBD,CAuBC,CAAC;AACN,CAAC,EAhEgB,eAAe,+BAAf,eAAe,QAgE/B;AAED,IAAM,gBAAgB,GAAG,UAAC,KAAU;IAClC,OAAA,QAAQ,KAAK,OAAO,KAAK,CAAC,MAAM;QAChC,CAAC,SAAS,KAAK,KAAK,CAAC,IAAI,IAAI,QAAQ,KAAK,OAAO,KAAK,CAAC,IAAI,CAAC;QAC5D,QAAQ,KAAK,OAAO,KAAK,CAAC,QAAQ;QAClC,QAAQ,KAAK,OAAO,KAAK,CAAC,IAAI;QAC9B,QAAQ,KAAK,OAAO,KAAK,CAAC,OAAO;QACjC,CAAC,SAAS,KAAK,KAAK,CAAC,KAAK,IAAI,QAAQ,KAAK,OAAO,KAAK,CAAC,KAAK,CAAC;AAL9D,CAK8D,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestia/fetcher",
-  "version": "2.5.0-dev.20240131",
+  "version": "2.5.0",
   "description": "Fetcher library of Nestia SDK",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",

package/src/AesPkcs5.ts

@@ -1,50 +1,50 @@
-import crypto from "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
- */
-export namespace AesPkcs5 {
-  /**
-   * Encrypt data
-   *
-   * @param data Target data
-   * @param key Key value of the encryption.
-   * @param iv Initializer Vector for the encryption
-   * @return Encrypted data
-   */
-  export function encrypt(data: string, key: string, iv: string): string {
-    const bytes: number = key.length * 8;
-    const cipher: crypto.Cipher = crypto.createCipheriv(
-      `AES-${bytes}-CBC`,
-      key,
-      iv,
-    );
-    return cipher.update(data, "utf8", "base64") + cipher.final("base64");
-  }
-
-  /**
-   * Decrypt data.
-   *
-   * @param data Target data
-   * @param key Key value of the decryption.
-   * @param iv Initializer Vector for the decryption
-   * @return Decrypted data.
-   */
-  export function decrypt(data: string, key: string, iv: string): string {
-    const bytes: number = key.length * 8;
-    const decipher: crypto.Decipher = crypto.createDecipheriv(
-      `AES-${bytes}-CBC`,
-      key,
-      iv,
-    );
-
-    return decipher.update(data, "base64", "utf8") + decipher.final("utf8");
-  }
-}
+import crypto from "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
+ */
+export namespace AesPkcs5 {
+  /**
+   * Encrypt data
+   *
+   * @param data Target data
+   * @param key Key value of the encryption.
+   * @param iv Initializer Vector for the encryption
+   * @return Encrypted data
+   */
+  export function encrypt(data: string, key: string, iv: string): string {
+    const bytes: number = key.length * 8;
+    const cipher: crypto.Cipher = crypto.createCipheriv(
+      `AES-${bytes}-CBC`,
+      key,
+      iv,
+    );
+    return cipher.update(data, "utf8", "base64") + cipher.final("base64");
+  }
+
+  /**
+   * Decrypt data.
+   *
+   * @param data Target data
+   * @param key Key value of the decryption.
+   * @param iv Initializer Vector for the decryption
+   * @return Decrypted data.
+   */
+  export function decrypt(data: string, key: string, iv: string): string {
+    const bytes: number = key.length * 8;
+    const decipher: crypto.Decipher = crypto.createDecipheriv(
+      `AES-${bytes}-CBC`,
+      key,
+      iv,
+    );
+
+    return decipher.update(data, "base64", "utf8") + decipher.final("utf8");
+  }
+}

package/src/EncryptedFetcher.ts

@@ -1,175 +1,175 @@
-import { AesPkcs5 } from "./AesPkcs5";
-import { IConnection } from "./IConnection";
-import { IEncryptionPassword } from "./IEncryptionPassword";
-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` 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<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) &&
-      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.fetch({
-      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 { 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` 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<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) &&
+      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.fetch({
+      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>;
+  }
+}