@zerobounce/zero-bounce-sdk 1.0.0 → 1.1.0

package/src/utils.js

@@ -35,8 +35,12 @@ export async function createRequest({
         return JSON.parse(finalResult);
       }
     }
-    const finalResult = await response.json();
-    return finalResult;
+    if (response.status === 403) {  
+      throw new Error('[Error]: api_key is invalid');
+    } else {
+      const finalResult = await response.json();
+      return finalResult;
+    }
   } catch (error) {
     throw new Error(error);
   }

package/src/zero-bounce.js

@@ -338,4 +338,35 @@ export class ZeroBounceSDK {
   deleteScoringFile(fileId) {
     return this._deleteFileUtil(fileId, "/scoring/deletefile", true);
   }
+
+  // EMAIL FINDER
+
+  guessFormat ({
+    domain, 
+    first_name = null, 
+    middle_name = null, 
+    last_name = null
+  }) {
+    if (!this._initialized) {
+      notInitialized();
+      return;
+    } else if (!domain) {
+      parameterIsMissing("domain");
+      return;
+    }
+
+    const params = {
+      api_key: this._api_key,
+      domain: domain,
+      first_name: first_name,
+      middle_name: middle_name,
+      last_name: last_name,
+    };
+
+    return createRequest({
+      requestType: "GET",
+      params,
+      path: "/guessformat",
+    });
+  }
 }

package/tests/zero-bounce.test.js

@@ -1,5 +1,6 @@
 import { ZeroBounceSDK } from "../src/zero-bounce.js";
 import * as utils from "../src/utils.js";
+import 'whatwg-fetch'
 
 describe("ZeroBounceSDK", () => {
   let zeroBounceSDK;
@@ -31,8 +32,11 @@ describe("ZeroBounceSDK", () => {
 
     it("should return error response with invalid API key", async () => {
       zeroBounceSDK.init("invalid-api-key");
-      const response = await zeroBounceSDK.getCredits();
-      expect(response).toEqual({ "Credits": "-1" });
+      try {
+        await zeroBounceSDK.getCredits();
+      } catch (error) {
+        expect(error.message).toEqual('TypeError: Network request failed');
+      }
     });
 
     it("should return the correct number of credits", async () => {
@@ -62,7 +66,7 @@ describe("ZeroBounceSDK", () => {
     });
 
     it("should throw an error if stardDate is missing", async () => {
-      zeroBounceSDK.init("invalid-api-key");
+      zeroBounceSDK.init("valid-api-key");
       await zeroBounceSDK.getApiUsage(null, endDate);
       expect(console.error).toHaveBeenCalledWith(
         expect.stringContaining(missingParamMessage)
@@ -70,7 +74,7 @@ describe("ZeroBounceSDK", () => {
     });
 
     it("should throw an error if endDate is missing", async () => {
-      zeroBounceSDK.init("invalid-api-key");
+      zeroBounceSDK.init("valid-api-key");
       await zeroBounceSDK.getApiUsage(startDate, null);
       expect(console.error).toHaveBeenCalledWith(
         expect.stringContaining(missingParamMessage)
@@ -79,8 +83,11 @@ describe("ZeroBounceSDK", () => {
 
     it("should return error response with invalid API key", async () => {
       zeroBounceSDK.init("invalid-api-key");
-      const response = await zeroBounceSDK.getApiUsage(startDate, endDate);
-      expect(response).toEqual({ "error": "Invalid API key" });
+      try {
+        await zeroBounceSDK.getApiUsage(startDate, endDate);
+      } catch (error) {
+        expect(error.message).toEqual('TypeError: Network request failed');
+      }
     });
 
     it("should return API usage data", async () => {
@@ -143,7 +150,7 @@ describe("ZeroBounceSDK", () => {
     });
 
     it("should throw an error if email is missing", async () => {
-      zeroBounceSDK.init("invalid-api-key");
+      zeroBounceSDK.init("valid-api-key");
       await zeroBounceSDK.validateEmail(null);
       expect(console.error).toHaveBeenCalledWith(
         expect.stringContaining(missingParamMessage)
@@ -152,10 +159,11 @@ describe("ZeroBounceSDK", () => {
 
     it("should return error response with invalid API key", async () => {
       zeroBounceSDK.init("invalid-api-key");
-      const response = await zeroBounceSDK.validateEmail(email, ip_address);
-      expect(response).toEqual({
-        "error": "Invalid API key or your account ran out of credits"
-      });
+      try {
+        await zeroBounceSDK.validateEmail(email, ip_address);
+      } catch (error) {
+        expect(error.message).toEqual('TypeError: Network request failed');
+      }
     });
 
     it("should return the validated email data", async () => {
@@ -205,7 +213,7 @@ describe("ZeroBounceSDK", () => {
     });
 
     it("should throw an error if email list is missing", async () => {
-      zeroBounceSDK.init("invalid-api-key");
+      zeroBounceSDK.init("valid-api-key");
       await zeroBounceSDK.validateBatch(null);
       expect(console.error).toHaveBeenCalledWith(
         expect.stringContaining(missingParamMessage)
@@ -214,16 +222,11 @@ describe("ZeroBounceSDK", () => {
 
     it("should return error response with invalid API key", async () => {
       zeroBounceSDK.init("invalid-api-key");
-      const response = await zeroBounceSDK.validateBatch(emailBatch);
-      expect(response).toEqual({
-        "email_batch": [],
-        "errors": [
-            {
-                "email_address": "all",
-                "error": "Invalid API Key or your account ran out of credits"
-            }
-        ]
-      });
+      try {
+        await zeroBounceSDK.validateBatch(emailBatch);
+      } catch (error) {
+        expect(error.message).toEqual('TypeError: Network request failed');
+      }
     });
 
     it("should return the validated emails data", async () => {
@@ -296,7 +299,7 @@ describe("ZeroBounceSDK", () => {
     });
 
     it("should throw an error if email is missing", async () => {
-      zeroBounceSDK.init("invalid-api-key");
+      zeroBounceSDK.init("valid-api-key");
       await zeroBounceSDK.getEmailActivity(null);
       expect(console.error).toHaveBeenCalledWith(
         expect.stringContaining(missingParamMessage)
@@ -305,10 +308,11 @@ describe("ZeroBounceSDK", () => {
 
     it("should return error response with invalid API key", async () => {
       zeroBounceSDK.init("invalid-api-key");
-      const response = await zeroBounceSDK.getEmailActivity(email);
-      expect(response).toEqual({
-        "error": "Invalid API key or your account ran out of credits"
-      });
+      try {
+        await zeroBounceSDK.getEmailActivity(email);
+      } catch (error) {
+        expect(error.message).toEqual('TypeError: Network request failed');
+      }
     });
 
     it("should return the email activity data", async () => {
@@ -348,7 +352,7 @@ describe("ZeroBounceSDK", () => {
         email_address_column: 1,
       };
 
-      zeroBounceSDK.init("invalid-api-key");
+      zeroBounceSDK.init("valid-api-key");
       await zeroBounceSDK.sendFile(payload);
       expect(console.error).toHaveBeenCalledWith(
         expect.stringContaining(missingParamMessage)
@@ -360,7 +364,7 @@ describe("ZeroBounceSDK", () => {
         file: file,
       };
 
-      zeroBounceSDK.init("invalid-api-key");
+      zeroBounceSDK.init("valid-api-key");
       await zeroBounceSDK.sendFile(payload);
       expect(console.error).toHaveBeenCalledWith(
         expect.stringContaining(missingParamMessage)
@@ -417,7 +421,7 @@ describe("ZeroBounceSDK", () => {
         email_address_column: 1,
       };
 
-      zeroBounceSDK.init("invalid-api-key");
+      zeroBounceSDK.init("valid-api-key");
       await zeroBounceSDK.sendScoringFile(payload);
       expect(console.error).toHaveBeenCalledWith(
         expect.stringContaining(missingParamMessage)
@@ -429,7 +433,7 @@ describe("ZeroBounceSDK", () => {
         file: file,
       };
 
-      zeroBounceSDK.init("invalid-api-key");
+      zeroBounceSDK.init("valid-api-key");
       await zeroBounceSDK.sendScoringFile(payload);
       expect(console.error).toHaveBeenCalledWith(
         expect.stringContaining(missingParamMessage)
@@ -476,7 +480,7 @@ describe("ZeroBounceSDK", () => {
     });
 
     it("should throw an error if file id is missing", async () => {
-      zeroBounceSDK.init("invalid-api-key");
+      zeroBounceSDK.init("valid-api-key");
       await zeroBounceSDK.getFileStatus(null);
       expect(console.error).toHaveBeenCalledWith(
         expect.stringContaining(missingParamMessage)
@@ -485,13 +489,11 @@ describe("ZeroBounceSDK", () => {
 
     it("should return error response with invalid API key", async () => {
       zeroBounceSDK.init("invalid-api-key");
-      const response = await zeroBounceSDK.getFileStatus(fileId);
-      expect(response).toEqual({
-        "success": "False",
-        "message": [
-            "api_key is invalid"
-        ]
-      });
+      try {
+        await zeroBounceSDK.getFileStatus(fileId);
+      } catch (error) {
+        expect(error.message).toEqual('TypeError: Network request failed');
+      }
     });
 
     it("should return the completion status of a previously sent file", async () => {
@@ -527,7 +529,7 @@ describe("ZeroBounceSDK", () => {
     });
 
     it("should throw an error if file id is missing", async () => {
-      zeroBounceSDK.init("invalid-api-key");
+      zeroBounceSDK.init("valid-api-key");
       await zeroBounceSDK.getScoringFileStatus(null);
       expect(console.error).toHaveBeenCalledWith(
         expect.stringContaining(missingParamMessage)
@@ -536,13 +538,11 @@ describe("ZeroBounceSDK", () => {
 
     it("should return error response with invalid API key", async () => {
       zeroBounceSDK.init("invalid-api-key");
-      const response = await zeroBounceSDK.getScoringFileStatus(fileId);
-      expect(response).toEqual({
-        "success": "False",
-        "message": [
-            "api_key is invalid"
-        ]
-      });
+      try {
+        await zeroBounceSDK.getScoringFileStatus(fileId);
+      } catch (error) {
+        expect(error.message).toEqual('TypeError: Network request failed');
+      }
     });
 
     it("should return the completion status of a previously sent scoring file", async () => {
@@ -577,7 +577,7 @@ describe("ZeroBounceSDK", () => {
     });
 
     it("should throw an error if file id is missing", async () => {
-      zeroBounceSDK.init("invalid-api-key");
+      zeroBounceSDK.init("valid-api-key");
       await zeroBounceSDK.getFile(null);
       expect(console.error).toHaveBeenCalledWith(
         expect.stringContaining(missingParamMessage)
@@ -586,13 +586,11 @@ describe("ZeroBounceSDK", () => {
 
     it("should return error response with invalid API key", async () => {
       zeroBounceSDK.init("invalid-api-key");
-      const response = await zeroBounceSDK.getFile(fileId);
-      expect(response).toEqual({
-        "success": "False",
-        "message": [
-            "api_key is invalid"
-        ]
-      });
+      try {
+        await zeroBounceSDK.getFile(fileId);
+      } catch (error) {
+        expect(error.message).toEqual('TypeError: Network request failed');
+      }
     });
 
     it("should return the previously sent file", async () => {
@@ -619,7 +617,7 @@ describe("ZeroBounceSDK", () => {
     });
 
     it("should throw an error if file id is missing", async () => {
-      zeroBounceSDK.init("invalid-api-key");
+      zeroBounceSDK.init("valid-api-key");
       await zeroBounceSDK.getScoringFile(null);
       expect(console.error).toHaveBeenCalledWith(
         expect.stringContaining(missingParamMessage)
@@ -628,13 +626,11 @@ describe("ZeroBounceSDK", () => {
 
     it("should return error response with invalid API key", async () => {
       zeroBounceSDK.init("invalid-api-key");
-      const response = await zeroBounceSDK.getScoringFile(fileId);
-      expect(response).toEqual({
-        "success": "False",
-        "message": [
-            "api_key is invalid"
-        ]
-      });
+      try {
+        await zeroBounceSDK.getScoringFile(fileId);
+      } catch (error) {
+        expect(error.message).toEqual('TypeError: Network request failed');
+      }
     });
 
     it("should return the previously sent scoring file", async () => {
@@ -661,7 +657,7 @@ describe("ZeroBounceSDK", () => {
     });
 
     it("should throw an error if file id is missing", async () => {
-      zeroBounceSDK.init("invalid-api-key");
+      zeroBounceSDK.init("valid-api-key");
       await zeroBounceSDK.deleteFile(null);
       expect(console.error).toHaveBeenCalledWith(
         expect.stringContaining(missingParamMessage)
@@ -670,13 +666,11 @@ describe("ZeroBounceSDK", () => {
 
     it("should return error response with invalid API key", async () => {
       zeroBounceSDK.init("invalid-api-key");
-      const response = await zeroBounceSDK.deleteFile(fileId);
-      expect(response).toEqual({
-        "success": "False",
-        "message": [
-            "api_key is invalid"
-        ]
-      });
+      try {
+        await zeroBounceSDK.deleteFile(fileId);
+      } catch (error) {
+        expect(error.message).toEqual('TypeError: Network request failed');
+      }
     });
 
     it("should delete previously sent file", async () => {
@@ -708,7 +702,7 @@ describe("ZeroBounceSDK", () => {
     });
 
     it("should throw an error if file id is missing", async () => {
-      zeroBounceSDK.init("invalid-api-key");
+      zeroBounceSDK.init("valid-api-key");
       await zeroBounceSDK.deleteScoringFile(null);
       expect(console.error).toHaveBeenCalledWith(
         expect.stringContaining(missingParamMessage)
@@ -717,13 +711,11 @@ describe("ZeroBounceSDK", () => {
 
     it("should return error response with invalid API key", async () => {
       zeroBounceSDK.init("invalid-api-key");
-      const response = await zeroBounceSDK.deleteScoringFile(fileId);
-      expect(response).toEqual({
-        "success": "False",
-        "message": [
-            "api_key is invalid"
-        ]
-      });
+      try {
+        await zeroBounceSDK.deleteScoringFile(fileId);
+      } catch (error) {
+        expect(error.message).toEqual('TypeError: Network request failed');
+      }
     });
 
     it("should delete previously sent scoring file", async () => {
@@ -744,4 +736,58 @@ describe("ZeroBounceSDK", () => {
       expect(response).toEqual(expectedResponse);
     });
   });
+
+  // EMAIL FINDER
+  describe("guessFormat", () => {
+    const payload = {
+      domain: "example.com",
+      first_name: "John",
+      last_name: "Doe",
+    }
+
+    it("should throw an error if not initialized", async () => {
+      await zeroBounceSDK.guessFormat(payload);
+      expect(console.error).toHaveBeenCalledWith(initErrorMessage);
+    });
+
+    it("should throw an error if domain is missing", async () => {
+      zeroBounceSDK.init("valid-api-key");
+      await zeroBounceSDK.guessFormat({domain: null});
+      expect(console.error).toHaveBeenCalledWith(
+        expect.stringContaining(missingParamMessage)
+      );
+    });
+
+    it("should return error response with invalid API key", async () => {
+      zeroBounceSDK.init("invalid-api-key");
+      try {
+        await zeroBounceSDK.guessFormat(payload);
+      } catch (error) {
+        expect(error.message).toEqual('TypeError: Network request failed');
+      }
+    });
+
+    it("should return the validated format data", async () => {
+      const expectedResponse = {
+        "email": "john.doe@example.com",
+        "domain": "",
+        "format": "first.last",
+        "status": "valid",
+        "sub_status": "",
+        "confidence": "high",
+        "did_you_mean": "",
+        "failure_reason": "",
+        "other_domain_formats": []
+      }
+
+      jest.spyOn(global, "fetch").mockImplementationOnce(() => Promise.resolve({
+        json: () => Promise.resolve(expectedResponse),
+        text: () => Promise.resolve(JSON.stringify(expectedResponse)),
+      }));
+
+      zeroBounceSDK.init("valid-api-key");
+      const response = await zeroBounceSDK.guessFormat(payload);
+      expect(response).toEqual(expectedResponse);
+    });
+  });
 });