@nestia/fetcher 1.0.0 → 1.1.0-dev.20230413

package/lib/Fetcher.d.ts

@@ -16,7 +16,7 @@ import { Primitive } from "./Primitive";
  */
 export declare class Fetcher {
     /**
-     * Fetch function for the `GET` or `DELETE` methods.
+     * Fetch function for the `GET` methods.
      *
      * @param connection Connection information for the remote HTTP server
      * @param encrypted Whether the request/response body be encrypted or not
@@ -24,9 +24,9 @@ export declare class Fetcher {
      * @param path Path of the HTTP request
      * @return Response body data from the remote HTTP server
      */
-    static fetch<Output>(connection: IConnection, encrypted: Fetcher.IEncrypted, method: "GET" | "DELETE", path: string): Promise<Primitive<Output>>;
+    static fetch<Output>(connection: IConnection, encrypted: Fetcher.IEncrypted, method: "GET", path: string): Promise<Primitive<Output>>;
     /**
-     * Fetch function for the `POST`, `PUT` and `PATCH` methods.
+     * Fetch function for the `POST`, `PUT`, `PATCH` and `DELETE` methods.
      *
      * @param connection Connection information for the remote HTTP server
      * @param encrypted Whether the request/response body be encrypted or not
@@ -36,7 +36,7 @@ export declare class Fetcher {
      * @param stringify JSON string conversion function, default is the `JSON.stringify`
      * @return Response body data from the remote HTTP server
      */
-    static fetch<Input, Output>(connection: IConnection, encrypted: Fetcher.IEncrypted, method: "POST" | "PUT" | "PATCH", path: string, input: Input, stringify?: (input: Input) => string): Promise<Primitive<Output>>;
+    static fetch<Input, Output>(connection: IConnection, encrypted: Fetcher.IEncrypted, method: "POST" | "PUT" | "PATCH" | "DELETE", path: string, input?: Input, stringify?: (input: Input) => string): Promise<Primitive<Output>>;
 }
 export declare namespace Fetcher {
     /**

package/lib/HttpError.d.ts

@@ -18,4 +18,29 @@ export declare class HttpError extends Error {
      * @param message Error message from the remote HTTP server.
      */
     constructor(method: "GET" | "DELETE" | "POST" | "PUT" | "PATCH", path: string, status: number, message: string);
+    /**
+     * `HttpError` to JSON.
+     *
+     * When you call `JSON.stringify()` function on current `HttpError` instance,
+     * this `HttpError.toJSON()` method would be automatically called.
+     *
+     * Also, if response body from the remote HTTP server forms a JSON object,
+     * this `HttpError.toJSON()` method would be useful because it returns the
+     * parsed JSON object about the {@link message} property.
+     *
+     * @template T Expected type of the response body.
+     * @returns JSON object of the `HttpError`.
+     */
+    toJSON<T>(): HttpError.IProps<T>;
+}
+export declare namespace HttpError {
+    /**
+     * Returned type of {@link HttpError.toJSON} method.
+     */
+    interface IProps<T> {
+        method: "GET" | "DELETE" | "POST" | "PUT" | "PATCH";
+        path: string;
+        status: number;
+        message: T;
+    }
 }

package/lib/HttpError.js

@@ -39,6 +39,10 @@ var HttpError = /** @class */ (function (_super) {
         _this.method = method;
         _this.path = path;
         _this.status = status;
+        /**
+         * @internal
+         */
+        _this.body_ = NOT_YET;
         // INHERITANCE POLYFILL
         var proto = _newTarget.prototype;
         if (Object.setPrototypeOf)
@@ -47,7 +51,31 @@ var HttpError = /** @class */ (function (_super) {
             _this.__proto__ = proto;
         return _this;
     }
+    /**
+     * `HttpError` to JSON.
+     *
+     * When you call `JSON.stringify()` function on current `HttpError` instance,
+     * this `HttpError.toJSON()` method would be automatically called.
+     *
+     * Also, if response body from the remote HTTP server forms a JSON object,
+     * this `HttpError.toJSON()` method would be useful because it returns the
+     * parsed JSON object about the {@link message} property.
+     *
+     * @template T Expected type of the response body.
+     * @returns JSON object of the `HttpError`.
+     */
+    HttpError.prototype.toJSON = function () {
+        if (this.body_ === NOT_YET)
+            this.body_ = JSON.parse(this.message);
+        return {
+            method: this.method,
+            path: this.path,
+            status: this.status,
+            message: this.body_,
+        };
+    };
     return HttpError;
 }(Error));
 exports.HttpError = HttpError;
+var NOT_YET = {};
 //# sourceMappingURL=HttpError.js.map

package/lib/HttpError.js.map

@@ -1 +1 @@
-{"version":3,"file":"HttpError.js","sourceRoot":"","sources":["../src/HttpError.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA;;;;;;GAMG;AACH;IAA+B,6BAAK;IAChC;;;;;;;OAOG;IACH,mBACoB,MAAmD,EACnD,IAAY,EACZ,MAAc,EAC9B,OAAe;;QAJnB,YAMI,kBAAM,OAAO,CAAC,SAMjB;QAXmB,YAAM,GAAN,MAAM,CAA6C;QACnD,UAAI,GAAJ,IAAI,CAAQ;QACZ,YAAM,GAAN,MAAM,CAAQ;QAK9B,uBAAuB;QACvB,IAAM,KAAK,GAAc,WAAW,SAAS,CAAC;QAC9C,IAAI,MAAM,CAAC,cAAc;YAAE,MAAM,CAAC,cAAc,CAAC,KAAI,EAAE,KAAK,CAAC,CAAC;;YACxD,KAAY,CAAC,SAAS,GAAG,KAAK,CAAC;;IACzC,CAAC;IACL,gBAAC;AAAD,CAAC,AAtBD,CAA+B,KAAK,GAsBnC;AAtBY,8BAAS"}
+{"version":3,"file":"HttpError.js","sourceRoot":"","sources":["../src/HttpError.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA;;;;;;GAMG;AACH;IAA+B,6BAAK;IAMhC;;;;;;;OAOG;IACH,mBACoB,MAAmD,EACnD,IAAY,EACZ,MAAc,EAC9B,OAAe;;QAJnB,YAMI,kBAAM,OAAO,CAAC,SAMjB;QAXmB,YAAM,GAAN,MAAM,CAA6C;QACnD,UAAI,GAAJ,IAAI,CAAQ;QACZ,YAAM,GAAN,MAAM,CAAQ;QAhBlC;;WAEG;QACK,WAAK,GAAQ,OAAO,CAAC;QAkBzB,uBAAuB;QACvB,IAAM,KAAK,GAAc,WAAW,SAAS,CAAC;QAC9C,IAAI,MAAM,CAAC,cAAc;YAAE,MAAM,CAAC,cAAc,CAAC,KAAI,EAAE,KAAK,CAAC,CAAC;;YACxD,KAAY,CAAC,SAAS,GAAG,KAAK,CAAC;;IACzC,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,0BAAM,GAAb;QACI,IAAI,IAAI,CAAC,KAAK,KAAK,OAAO;YAAE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClE,OAAO;YACH,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,OAAO,EAAE,IAAI,CAAC,KAAK;SACtB,CAAC;IACN,CAAC;IACL,gBAAC;AAAD,CAAC,AAlDD,CAA+B,KAAK,GAkDnC;AAlDY,8BAAS;AA+DtB,IAAM,OAAO,GAAG,EAAS,CAAC"}

package/package.json

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

package/src/Fetcher.ts

@@ -24,7 +24,7 @@ import { Singleton } from "./internal/Singleton";
  */
 export class Fetcher {
     /**
-     * Fetch function for the `GET` or `DELETE` methods.
+     * Fetch function for the `GET` methods.
      *
      * @param connection Connection information for the remote HTTP server
      * @param encrypted Whether the request/response body be encrypted or not
@@ -35,12 +35,12 @@ export class Fetcher {
     public static fetch<Output>(
         connection: IConnection,
         encrypted: Fetcher.IEncrypted,
-        method: "GET" | "DELETE",
+        method: "GET",
         path: string,
     ): Promise<Primitive<Output>>;
 
     /**
-     * Fetch function for the `POST`, `PUT` and `PATCH` methods.
+     * Fetch function for the `POST`, `PUT`, `PATCH` and `DELETE` methods.
      *
      * @param connection Connection information for the remote HTTP server
      * @param encrypted Whether the request/response body be encrypted or not
@@ -53,9 +53,9 @@ export class Fetcher {
     public static fetch<Input, Output>(
         connection: IConnection,
         encrypted: Fetcher.IEncrypted,
-        method: "POST" | "PUT" | "PATCH",
+        method: "POST" | "PUT" | "PATCH" | "DELETE",
         path: string,
-        input: Input,
+        input?: Input,
         stringify?: (input: Input) => string,
     ): Promise<Primitive<Output>>;
 

package/src/HttpError.ts

@@ -6,6 +6,11 @@
  * @author Jeongho Nam - https://github.com/samchon
  */
 export class HttpError extends Error {
+    /**
+     * @internal
+     */
+    private body_: any = NOT_YET;
+
     /**
      * Initializer Constructor.
      *
@@ -27,4 +32,40 @@ export class HttpError extends Error {
         if (Object.setPrototypeOf) Object.setPrototypeOf(this, proto);
         else (this as any).__proto__ = proto;
     }
+
+    /**
+     * `HttpError` to JSON.
+     *
+     * When you call `JSON.stringify()` function on current `HttpError` instance,
+     * this `HttpError.toJSON()` method would be automatically called.
+     *
+     * Also, if response body from the remote HTTP server forms a JSON object,
+     * this `HttpError.toJSON()` method would be useful because it returns the
+     * parsed JSON object about the {@link message} property.
+     *
+     * @template T Expected type of the response body.
+     * @returns JSON object of the `HttpError`.
+     */
+    public toJSON<T>(): HttpError.IProps<T> {
+        if (this.body_ === NOT_YET) this.body_ = JSON.parse(this.message);
+        return {
+            method: this.method,
+            path: this.path,
+            status: this.status,
+            message: this.body_,
+        };
+    }
 }
+export namespace HttpError {
+    /**
+     * Returned type of {@link HttpError.toJSON} method.
+     */
+    export interface IProps<T> {
+        method: "GET" | "DELETE" | "POST" | "PUT" | "PATCH";
+        path: string;
+        status: number;
+        message: T;
+    }
+}
+
+const NOT_YET = {} as any;