Restructure SDK

.github/codeql/codeql-config.yml

@@ -0,0 +1,7 @@
+paths:
+  - 'src'
+paths-ignore:
+  - 'src/__tests__/**/*.js'  
+  - 'src/__tests__/**/*.ts'  
+  - 'src/__tests__/**/*.jsx' 
+  - 'src/__tests__/**/*.tsx' 

.github/workflows/test.yml

@@ -5,8 +5,10 @@ on: push
 jobs:
   lint:
     runs-on: ubuntu-latest
-
     steps:
+      - uses: github/codeql-action/init@v3
+        with:
+          config-file: .github/codeql/codeql-config.yml
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v3
         with:

README.md

@@ -8,7 +8,7 @@ Quickly add email sending functionality to your Node.js application with Mailtra
 
 ## Compatibility with previous releases
 
-Versions of this package up to 2.0.2 were an [unofficial client](https://github.com/vchin/mailtrap-client) developed by [@vchin](https://github.com/vchin). Package version 3 is a completely new package. It is still under development and does not support the testing API yet. Please continue using version 2 if you need access to the testing API.
+Versions of this package up to 2.0.2 were an [unofficial client](https://github.com/vchin/mailtrap-client) developed by [@vchin](https://github.com/vchin). Package version 3 is a completely new package. 
 
 ## Installation
 

examples/bulk/send-mail.ts

@@ -12,9 +12,9 @@ const TOKEN = "<YOUR-TOKEN-HERE>";
 const SENDER_EMAIL = "<SENDER@YOURDOMAIN.COM>";
 const RECIPIENT_EMAIL = "<RECIPIENT@EMAIL.COM>";
 
-const client = new MailtrapClient({ token: TOKEN });
+const client = new MailtrapClient({ token: TOKEN, bulk: true });
 
-client.bulk.send({
+client.send({
   from: { name: "Mailtrap Test", email: SENDER_EMAIL },
   to: [{ email: RECIPIENT_EMAIL }],
   subject: "Hello from Mailtrap!",

examples/general/account-accesses.ts

@@ -1,4 +1,4 @@
-import { MailtrapClient } from "../../src"
+import { MailtrapClient } from "mailtrap"
 
 const TOKEN = "<YOUR-TOKEN-HERE>";
 const TEST_INBOX_ID = "<YOUR-TEST-INBOX-ID-HERE>"

examples/general/accounts.ts

@@ -1,4 +1,4 @@
-import { MailtrapClient } from "../../src"
+import { MailtrapClient } from "mailtrap"
 
 const TOKEN = "<YOUR-TOKEN-HERE>";
 const TEST_INBOX_ID = "<YOUR-TEST-INBOX-ID-HERE>"

examples/general/permissions.ts

@@ -1,4 +1,4 @@
-import { MailtrapClient } from "../../src"
+import { MailtrapClient } from "mailtrap"
 
 const TOKEN = "<YOUR-TOKEN-HERE>";
 const TEST_INBOX_ID = "<YOUR-TEST-INBOX-ID-HERE>"

examples/sending/transport.ts

@@ -13,10 +13,9 @@ const SENDER_EMAIL = "<SENDER@YOURDOMAIN.COM>";
 const RECIPIENT_EMAIL = "<RECIPIENT@EMAIL.COM>";
 
 const transport = Nodemailer.createTransport(MailtrapTransport({
-  token: TOKEN
+  token: TOKEN,
 }))
 
-// Note: 'sandbox: true' can be passed for making requests to Testing API
 transport.sendMail({
   text: "Welcome to Mailtrap Sending!",
   to: {

examples/testing/attachments.ts

@@ -1,4 +1,4 @@
-import { MailtrapClient } from "../../src"
+import { MailtrapClient } from "mailtrap"
 
 const TOKEN = "<YOUR-TOKEN-HERE>";
 const TEST_INBOX_ID = "<YOUR-TEST-INBOX-ID-HERE>"

examples/testing/inboxes.ts

@@ -1,4 +1,4 @@
-import { MailtrapClient } from "../../src"
+import { MailtrapClient } from "mailtrap"
 
 const TOKEN = "<YOUR-TOKEN-HERE>";
 const TEST_INBOX_ID = "<YOUR-TEST-INBOX-ID-HERE>"

examples/testing/messages.ts

@@ -1,4 +1,4 @@
-import { MailtrapClient } from "../../src"
+import { MailtrapClient } from "mailtrap"
 
 const TOKEN = "<YOUR-TOKEN-HERE>";
 const TEST_INBOX_ID = "<YOUR-TEST-INBOX-ID-HERE>"

examples/testing/template.ts

@@ -1,4 +1,4 @@
-import { MailtrapClient } from "../../src"
+import { MailtrapClient } from "mailtrap"
 
 /**
  * For this example to work, you need to set up a sending domain,

src/__tests__/lib/api/Testing.test.ts

@@ -1,151 +1,19 @@
 import axios from "axios";
-import AxiosMockAdapter from "axios-mock-adapter";
 
 import Testing from "../../../lib/api/Testing";
-import handleSendingError from "../../../lib/axios-logger";
-
-import CONFIG from "../../../config";
-import MailtrapError from "../../../lib/MailtrapError";
-
-const { CLIENT_SETTINGS } = CONFIG;
-const { TESTING_ENDPOINT } = CLIENT_SETTINGS;
 
 describe("lib/api/Testing: ", () => {
-  let mock: AxiosMockAdapter;
   const testInboxId = 100;
   const testingAPI = new Testing(axios, testInboxId);
 
   describe("class Testing(): ", () => {
     describe("init: ", () => {
       it("initalizes with all necessary params.", () => {
-        expect(testingAPI).toHaveProperty("send");
         expect(testingAPI).toHaveProperty("projects");
         expect(testingAPI).toHaveProperty("inboxes");
         expect(testingAPI).toHaveProperty("messages");
         expect(testingAPI).toHaveProperty("attachments");
       });
     });
-
-    beforeAll(() => {
-      /**
-       * Init Axios interceptors for handling response.data, errors.
-       */
-      axios.interceptors.response.use(
-        (response) => response.data,
-        handleSendingError
-      );
-      mock = new AxiosMockAdapter(axios);
-    });
-
-    afterEach(() => {
-      mock.reset();
-    });
-
-    describe("send(): ", () => {
-      it("successfully sends email.", async () => {
-        const endpoint = `${TESTING_ENDPOINT}/api/send/${testInboxId}`;
-        const expectedResponseData = {
-          success: true,
-          message_ids: ["0c7fd939-02cf-11ed-88c2-0a58a9feac02"],
-        };
-        mock.onPost(endpoint).reply(200, expectedResponseData);
-
-        const emailData = {
-          from: {
-            email: "sender.mock@email.com",
-            name: "sender",
-          },
-          to: [
-            {
-              email: "recipient.mock@email.com",
-              name: "recipient",
-            },
-          ],
-          subject: "mock-subject",
-          text: "Mock text",
-          html: "<div>Mock text</div>",
-        };
-
-        const result = await testingAPI.send(emailData);
-
-        expect(mock.history.post[0].url).toEqual(endpoint);
-        expect(mock.history.post[0].data).toEqual(JSON.stringify(emailData));
-        expect(result).toEqual(expectedResponseData);
-      });
-
-      it("handles an API error.", async () => {
-        const responseData = {
-          success: false,
-          errors: ["mock-error-1", "mock-error-2"],
-        };
-
-        const endpoint = `${TESTING_ENDPOINT}/api/send/${testInboxId}`;
-
-        mock.onPost(endpoint).reply(400, responseData);
-
-        const emailData = {
-          from: {
-            email: "sender.mock@email.com",
-            name: "sender",
-          },
-          to: [
-            {
-              email: "recipient.mock@email.com",
-              name: "recipient",
-            },
-          ],
-          subject: "mock-subject",
-          text: "Mock text",
-          html: "<div>Mock text</div>",
-        };
-
-        const expectedErrorMessage = responseData.errors.join(",");
-
-        expect.assertions(3);
-
-        try {
-          await testingAPI.send(emailData);
-        } catch (error) {
-          expect(mock.history.post[0].url).toEqual(endpoint);
-          expect(mock.history.post[0].data).toEqual(JSON.stringify(emailData));
-
-          if (error instanceof Error) {
-            expect(error.message).toEqual(expectedErrorMessage);
-          }
-        }
-      });
-
-      it("handles an HTTP transport error.", async () => {
-        const emailData = {
-          from: {
-            email: "sender.mock@email.com",
-            name: "sender",
-          },
-          to: [
-            {
-              email: "recipient.mock@email.com",
-              name: "recipient",
-            },
-          ],
-          subject: "mock-subject",
-          text: "Mock text",
-          html: "<div>Mock text</div>",
-        };
-
-        const expectedErrorMessage = "Request failed with status code 404";
-
-        expect.assertions(2);
-
-        try {
-          await testingAPI.send(emailData);
-        } catch (error) {
-          expect(error).toBeInstanceOf(MailtrapError);
-
-          if (error instanceof MailtrapError) {
-            expect(error.message).toEqual(expectedErrorMessage);
-          }
-        }
-      });
-    });
   });
 });