@dvsa/appdev-api-common 0.8.1 → 0.9.1-canary.0

package/http/index.d.ts

@@ -1,6 +1,15 @@
+type HTTPResponse = {
+    url: string;
+    status: number;
+    statusText: string;
+    headers: Record<string, string>;
+    redirected: boolean;
+    type: 'basic' | 'cors' | 'default' | 'error' | 'opaque' | 'opaqueredirect';
+    body?: unknown;
+};
 export declare class HTTPError extends Error {
-    response: Response;
-    constructor(message: string, response: Response);
+    response: HTTPResponse;
+    constructor(message: string, response: HTTPResponse);
 }
 export declare class HTTP {
     /**
@@ -9,7 +18,7 @@ export declare class HTTP {
      * @param url
      * @param options
      */
-    static get(url: string, options?: RequestInit): Promise<Response>;
+    static get(url: string, options?: RequestInit): Promise<HTTPResponse>;
     /**
      * Performs an HTTP POST request.
      * Note: This method will throw an HTTPError if the response is not ok (status code 200-299) to emulate Axios behaviour.
@@ -17,7 +26,7 @@ export declare class HTTP {
      * @param body
      * @param options
      */
-    static post<T>(url: string, body: T, options?: RequestInit): Promise<Response>;
+    static post<T>(url: string, body: T, options?: RequestInit): Promise<HTTPResponse>;
     /**
      * Performs an HTTP PUT request.
      * Note: This method will throw an HTTPError if the response is not ok (status code 200-299) to emulate Axios behaviour.
@@ -25,12 +34,14 @@ export declare class HTTP {
      * @param body
      * @param options
      */
-    static put<T>(url: string, body: T, options?: RequestInit): Promise<Response>;
+    static put<T>(url: string, body: T, options?: RequestInit): Promise<HTTPResponse>;
     /**
      * Performs an HTTP DELETE request.
      * Note: This method will throw an HTTPError if the response is not ok (status code 200-299) to emulate Axios behaviour.
      * @param url
      * @param options
      */
-    static delete(url: string, options?: RequestInit): Promise<Response>;
+    static delete(url: string, options?: RequestInit): Promise<HTTPResponse>;
+    private static serialise;
 }
+export {};

package/http/index.js

@@ -21,10 +21,11 @@ class HTTP {
      */
     static async get(url, options) {
         const response = await fetch(url, { method: "GET", ...options });
+        const serialisedResponse = await HTTP.serialise(response);
         if (!response.ok) {
-            throw new HTTPError(`HTTP GET request failed with status ${response.status}`, response);
+            throw new HTTPError(`HTTP GET request failed with status ${response.status}`, serialisedResponse);
         }
-        return response;
+        return serialisedResponse;
     }
     /**
      * Performs an HTTP POST request.
@@ -40,10 +41,11 @@ class HTTP {
             body: JSON.stringify(body),
             ...options,
         });
+        const serialisedResponse = await HTTP.serialise(response);
         if (!response.ok) {
-            throw new HTTPError(`HTTP POST request failed with status ${response.status}`, response);
+            throw new HTTPError(`HTTP POST request failed with status ${response.status}`, serialisedResponse);
         }
-        return response;
+        return serialisedResponse;
     }
     /**
      * Performs an HTTP PUT request.
@@ -59,10 +61,11 @@ class HTTP {
             body: JSON.stringify(body),
             ...options,
         });
+        const serialisedResponse = await HTTP.serialise(response);
         if (!response.ok) {
-            throw new HTTPError(`HTTP PUT request failed with status ${response.status}`, response);
+            throw new HTTPError(`HTTP PUT request failed with status ${response.status}`, serialisedResponse);
         }
-        return response;
+        return serialisedResponse;
     }
     /**
      * Performs an HTTP DELETE request.
@@ -72,10 +75,36 @@ class HTTP {
      */
     static async delete(url, options) {
         const response = await fetch(url, { method: "DELETE", ...options });
+        const serialisedResponse = await HTTP.serialise(response);
         if (!response.ok) {
-            throw new HTTPError(`HTTP DELETE request failed with status ${response.status}`, response);
+            throw new HTTPError(`HTTP DELETE request failed with status ${response.status}`, serialisedResponse);
         }
-        return response;
+        return serialisedResponse;
+    }
+    static async serialise(response) {
+        let body;
+        try {
+            // Clone the response so we don't consume the original body
+            body = await response.clone().json();
+        }
+        catch {
+            // If JSON parsing fails, try text
+            try {
+                body = await response.clone().text();
+            }
+            catch {
+                body = null;
+            }
+        }
+        return {
+            url: response.url,
+            status: response.status,
+            statusText: response.statusText,
+            headers: Object.fromEntries(response.headers.entries()),
+            redirected: response.redirected,
+            type: response.type,
+            body,
+        };
     }
 }
 exports.HTTP = HTTP;

package/package.json

@@ -1,7 +1,11 @@
 {
 	"name": "@dvsa/appdev-api-common",
-	"version": "0.8.1",
-	"keywords": ["dvsa", "nodejs", "typescript"],
+	"version": "0.9.1-canary.0",
+	"keywords": [
+		"dvsa",
+		"nodejs",
+		"typescript"
+	],
 	"author": "DVSA",
 	"description": "Utils library for common API functionality",
 	"publishConfig": {