Add more details to the returned API error

package.json

@@ -1,7 +1,7 @@
 {
   "name": "screenshotone-api-sdk",
   "homepage": "https://screenshotone.com",
-  "version": "1.1.13",
+  "version": "1.1.14",
   "description": "Use ScreenshotOne.com API to generate screenshots of any website.",
   "repository": {
     "type": "git",

src/errors.ts

@@ -0,0 +1,18 @@
+
+class APIError extends Error {
+    public readonly httpStatusCode?: number; 
+    public readonly errorCode?: string;
+    public readonly errorMessage?: string;
+    public readonly documentationUrl?: string;
+
+    constructor(message: string, httpStatusCode?: number, errorCode?: string, errorMessage?: string, documentationUrl?: string) {
+        super(message);
+
+        this.httpStatusCode = httpStatusCode;
+        this.errorCode = errorCode;
+        this.errorMessage = errorMessage;
+        this.documentationUrl = documentationUrl;
+    }
+}
+
+export default APIError;

src/main.ts

@@ -1,6 +1,7 @@
 import Big from "big.js";
 import fetch from "cross-fetch";
 import { signQueryString } from "./signature";
+import APIError from "./errors";
 
 const API_BASE_URL = "https://api.screenshotone.com";
 const API_TAKE_PATH = "/take";
@@ -120,12 +121,20 @@ export class Client {
         try {
             const data = await response.json();
 
-            throw new Error(
-                `failed to generate animation, response returned ${response.status} ${response.statusText}: ${data?.error_message}`
-            );
+            throw new APIError(
+                `Failed to generate animation, response returned ${response.status} (${response.statusText}): ${data?.error_message}`,
+                response.status,
+                data?.error_code,
+                data?.error_message,
+                data?.documentation_url
+            );            
         } catch (e) {
+            if (e instanceof APIError) {
+                throw e;
+            }
+
             throw new Error(
-                `failed to generate animation, response returned ${response.status} ${response.statusText}`
+                `Failed to generate animation, response returned ${response.status} (${response.statusText})`
             );
         }
     }

tests/main.test.ts

@@ -1,3 +1,4 @@
+import APIError from "../src/errors";
 import { TakeOptions, Client, AnimateOptions } from "../src/main";
 
 describe("testing client", () => {
@@ -52,4 +53,25 @@ describe("testing client", () => {
 
         expect(options.toQuery().getAll("block_ads").length).toBe(1);
     });
+
+    test("returning an API error when the response is not successful", async () => {
+        jest.mock('cross-fetch', () => ({
+            __esModule: true,
+            default: jest.fn().mockImplementationOnce(() =>
+                Promise.resolve({
+                    ok: false,
+                    status: 400,
+                    statusText: "Bad Request",
+                    json: () => Promise.resolve({
+                        error_code: "name_not_resolved",
+                        error_message: "Usually, the error happens when the domain name of the requested URL is not resolved. If you are trying to take a screenshot of the new site, please, wait a bit until the DNS records are refreshed.",
+                        documentation_url: "https://screenshotone.com/docs/errors/"
+                    })
+                })
+            )
+        }));
+
+        const options = AnimateOptions.url("https://example.com");
+        await expect(client.animate(options)).rejects.toThrow(APIError);
+    });
 });