mailgun.js 3.7.0 → 3.7.1

package/dist/mailgun.web.js.LICENSE.txt

@@ -4,4 +4,4 @@
 
 /*! https://mths.be/punycode v1.3.2 by @mathias */
 
-/*! mailgun.js v3.6.1 */
+/*! mailgun.js v3.7.0 */

package/index.ts

@@ -1,11 +1,11 @@
 import Client from './lib/client';
+import { InputFormData } from './lib/interfaces/IFormData';
 import Options from './lib/interfaces/Options';
-import IFormData from './lib/interfaces/IFormData';
 
 class Mailgun {
-  private formData: new () => IFormData
+  private formData: InputFormData
 
-  constructor(FormData: new (...args: unknown[]) => IFormData) {
+  constructor(FormData: InputFormData) {
     this.formData = FormData;
   }
 

package/lib/client.ts

@@ -16,7 +16,7 @@ import IpsClient from './ips';
 import IpPoolsClient from './ip-pools';
 import ListsClient from './lists';
 import MailListsMembers from './mailListMembers';
-import IFormData from './interfaces/IFormData';
+import { InputFormData } from './interfaces/IFormData';
 
 export default class Client {
   private request;
@@ -35,7 +35,7 @@ export default class Client {
   public ip_pools;
   public lists;
 
-  constructor(options: Options, formData: new (...args: unknown[]) => IFormData) {
+  constructor(options: Options, formData: InputFormData) {
     const config: RequestOptions = { ...options } as RequestOptions;
 
     if (!config.url) {

package/lib/interfaces/IFormData.ts

@@ -1,19 +1,9 @@
-interface Headers {
-    [key: string]: any;
-}
+import NodeFormData from 'form-data';
 
-interface AppendOptions {
-    header?: string | Headers;
-    knownLength?: number;
-    filename?: string;
-    filepath?: string;
-    contentType?: string;
+export interface IFormDataOptions {
+  [key: string]: any;
 }
 
-export default abstract class IFormData {
-  // eslint-disable-next-line no-useless-constructor
-  constructor() { // description of type. Should not be used for creating objects
-  }
-
-  abstract append(key: string, value: any, options?: AppendOptions | string): void
+export interface InputFormData {
+  new (options?: HTMLFormElement | IFormDataOptions): NodeFormData | FormData;
 }

package/lib/request.ts

@@ -1,14 +1,20 @@
+import NodeFormData from 'form-data';
 import base64 from 'base-64';
 import urljoin from 'url-join';
 import ky from 'ky-universal';
 import APIError from './error';
 import RequestOptions from './interfaces/RequestOptions';
 import APIErrorOptions from './interfaces/APIErrorOptions';
-import IFormData from './interfaces/IFormData';
+import { InputFormData } from './interfaces/IFormData';
 import APIResponse from './interfaces/ApiResponse';
 
 const isStream = (attachment: any) => typeof attachment === 'object' && typeof attachment.pipe === 'function';
 
+function isNodeFormData(formDataInstance: NodeFormData | FormData)
+  : formDataInstance is NodeFormData {
+  return (<NodeFormData>formDataInstance).getHeaders !== undefined;
+}
+
 const getAttachmentOptions = (item: any): {
   filename?: string,
   contentType?: string,
@@ -44,9 +50,9 @@ class Request {
   private url: string;
   private timeout: number;
   private headers: any;
-  private formData: new () => IFormData;
+  private formData: InputFormData;
 
-  constructor(options: RequestOptions, formData: new () => IFormData) {
+  constructor(options: RequestOptions, formData: InputFormData) {
     this.username = options.username;
     this.key = options.key;
     this.url = options.url as string;
@@ -151,21 +157,25 @@ class Request {
     return this.command('put', url, formData, params);
   }
 
-  createFormData(data: any): IFormData {
-    const appendFileToFD = (key: string, obj : any, formDataInstance: IFormData): void => {
+  createFormData(data: any): NodeFormData | FormData {
+    const appendFileToFD = (
+      key: string,
+      obj: any,
+      formDataInstance: NodeFormData | FormData
+    ): void => {
       const isStreamData = isStream(obj);
       const objData = isStreamData ? obj : obj.data;
       const options = getAttachmentOptions(obj);
-      if (isStreamData) {
+      if (isNodeFormData(formDataInstance)) {
         formDataInstance.append(key, objData, options);
         return;
       }
       formDataInstance.append(key, objData, options.filename);
     };
 
-    const formData: IFormData = Object.keys(data)
+    const formData: NodeFormData | FormData = Object.keys(data)
       .filter(function (key) { return data[key]; })
-      .reduce((formDataAcc, key) => {
+      .reduce((formDataAcc: NodeFormData | FormData, key) => {
         if (key === 'attachment' || key === 'inline') {
           const obj = data[key];
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mailgun.js",
-  "version": "3.7.0",
+  "version": "3.7.1",
   "main": "dist/mailgun.node.js",
   "browser": "dist/mailgun.web.js",
   "types": "dist/index.d.ts",

package/test/client.test.ts

@@ -12,6 +12,7 @@ import MessagesClient from '../lib/messages';
 import RoutesClient from '../lib/routes';
 import ValidateClient from '../lib/validate';
 import ParseClient from '../lib/parse';
+import { InputFormData } from '../lib/interfaces/IFormData';
 
 describe('Client', function () {
   let client: any;
@@ -22,13 +23,13 @@ describe('Client', function () {
       key: 'key',
       public_key: 'key',
       timeout: 10000
-    }, formData);
+    }, formData as InputFormData);
   });
 
   it('raises error when username is not provided', function () {
     expect(
       function () {
-        return new Client({ key: 'key' } as any, formData);
+        return new Client({ key: 'key' } as any, formData as InputFormData);
       }
     ).to.throw('Parameter "username" is required');
   });
@@ -36,7 +37,7 @@ describe('Client', function () {
   it('raises error when key is not provided', function () {
     expect(
       function () {
-        return new Client({ username: 'username' } as any, formData);
+        return new Client({ username: 'username' } as any, formData as InputFormData);
       }
     ).to.throw('Parameter "key" is required');
   });

package/test/domains.test.ts

@@ -5,6 +5,7 @@ import { expect } from 'chai';
 import Request from '../lib/request';
 import DomainClient from '../lib/domains';
 import RequestOptions from '../lib/interfaces/RequestOptions';
+import { InputFormData } from '../lib/interfaces/IFormData';
 
 // TODO: fix types
 describe('DomainClient', function () {
@@ -12,7 +13,7 @@ describe('DomainClient', function () {
   let api: any;
 
   beforeEach(function () {
-    client = new DomainClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData));
+    client = new DomainClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData));
     api = nock('https://api.mailgun.net');
   });
 

package/test/events.test.ts

@@ -4,13 +4,14 @@ import formData from 'form-data';
 import EventClient from '../lib/events';
 import MgRequest from '../lib/request';
 import RequestOptions from '../lib/interfaces/RequestOptions';
+import { InputFormData } from '../lib/interfaces/IFormData';
 
 describe('EventsClient', function () {
   let client: any;
   let api: any;
 
   beforeEach(function () {
-    client = new EventClient(new MgRequest({ url: 'https://api.mailgun.net' } as RequestOptions, formData));
+    client = new EventClient(new MgRequest({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData));
     api = nock('https://api.mailgun.net');
   });
 

package/test/ips.test.ts

@@ -7,6 +7,7 @@ import RequestOptions from '../lib/interfaces/RequestOptions';
 import IpsClient from '../lib/ips';
 
 import { IpData, IpsListResponseBody } from '../lib/interfaces/Ips';
+import { InputFormData } from '../lib/interfaces/IFormData';
 
 // TODO: fix types
 describe('DomainClient', function () {
@@ -14,7 +15,7 @@ describe('DomainClient', function () {
   let api: any;
 
   beforeEach(function () {
-    client = new IpsClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData));
+    client = new IpsClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData));
     api = nock('https://api.mailgun.net');
   });
 

package/test/lists.test.ts

@@ -6,6 +6,7 @@ import ListsClient from '../lib/lists';
 import RequestOptions from '../lib/interfaces/RequestOptions';
 import MailListMembers from '../lib/mailListMembers';
 import { MailingList } from '../lib/interfaces/lists';
+import { InputFormData } from '../lib/interfaces/IFormData';
 
 describe('ListsClient', function () {
   let client: any;
@@ -13,7 +14,7 @@ describe('ListsClient', function () {
   let defaultList : MailingList;
 
   beforeEach(function () {
-    const reqObject = new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData);
+    const reqObject = new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData);
     const mailListMembers = new MailListMembers(reqObject);
     client = new ListsClient(reqObject, mailListMembers);
     api = nock('https://api.mailgun.net');

package/test/mailListMembers.test.ts

@@ -4,6 +4,7 @@ import Request from '../lib/request';
 import RequestOptions from '../lib/interfaces/RequestOptions';
 import MailListMembers from '../lib/mailListMembers';
 import { DeletedMember, MailListMember, NewMultipleMembersResponse } from '../lib/interfaces/mailListMembers';
+import { InputFormData } from '../lib/interfaces/IFormData';
 
 describe('mailListsMembersClient', function () {
   let client: any;
@@ -11,7 +12,7 @@ describe('mailListsMembersClient', function () {
   let defaultListMember : MailListMember;
 
   beforeEach(function () {
-    const reqObject = new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData);
+    const reqObject = new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData);
     client = new MailListMembers(reqObject);
     api = nock('https://api.mailgun.net');
     defaultListMember = {

package/test/messageAttachment.test.ts

@@ -6,6 +6,7 @@ import formData from 'form-data';
 import Request from '../lib/request';
 import MessagesClient from '../lib/messages';
 import RequestOptions from '../lib/interfaces/RequestOptions';
+import { InputFormData } from '../lib/interfaces/IFormData';
 
 const mailgunLogo = fs.createReadStream(`${__dirname}/img/mailgun.png`);
 
@@ -14,7 +15,7 @@ describe('MessagesClient', function () {
   let api: any;
 
   beforeEach(function () {
-    client = new MessagesClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData));
+    client = new MessagesClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData));
     api = nock('https://api.mailgun.net');
   });
 

package/test/messages.test.ts

@@ -7,6 +7,7 @@ import { expect } from 'chai';
 import Request from '../lib/request';
 import MessagesClient from '../lib/messages';
 import RequestOptions from '../lib/interfaces/RequestOptions';
+import { InputFormData } from '../lib/interfaces/IFormData';
 
 const mailgunLogo = fs.createReadStream(`${__dirname}/img/mailgun.png`);
 
@@ -15,7 +16,7 @@ describe('MessagesClient', function () {
   let api: any;
 
   beforeEach(function () {
-    client = new MessagesClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData));
+    client = new MessagesClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData));
     api = nock('https://api.mailgun.net');
   });
 

package/test/parse.test.ts

@@ -6,6 +6,7 @@ import Request from '../lib/request';
 import ParseClient from '../lib/parse';
 
 import RequestOptions from '../lib/interfaces/RequestOptions';
+import { InputFormData } from '../lib/interfaces/IFormData';
 
 interface Data {
   parsed: string[],
@@ -17,7 +18,7 @@ describe('ParseClient', function () {
   let api: any;
 
   beforeEach(function () {
-    client = new ParseClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData));
+    client = new ParseClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData));
     api = nock('https://api.mailgun.net');
   });
 

package/test/request.test.ts

@@ -8,6 +8,7 @@ import Request from '../lib/request';
 import RequestOptions from '../lib/interfaces/RequestOptions';
 import APIError from '../lib/error';
 import APIResponse from '../lib/interfaces/ApiResponse';
+import { InputFormData } from '../lib/interfaces/IFormData';
 
 describe('Request', function () {
   let headers: { [key: string]: string };
@@ -33,7 +34,7 @@ describe('Request', function () {
         url: 'https://api.mailgun.com',
         headers: { 'X-CSRF-Token': 'protectme' },
         timeout: 10000
-      }, formData);
+      }, formData as InputFormData);
 
       await req.request('get', '/v2/some/resource1', {
         headers: { Test: 'Custom Header', 'X-CSRF-Token': 'protectme' },
@@ -46,7 +47,7 @@ describe('Request', function () {
         .get('/v2/some/resource')
         .reply(200, { id: 1, message: 'hello' });
 
-      const req = new Request({ username: 'api', key: 'key', url: 'https://api.mailgun.com' } as RequestOptions, formData);
+      const req = new Request({ username: 'api', key: 'key', url: 'https://api.mailgun.com' } as RequestOptions, formData as InputFormData);
       const res = req.request('get', '/v2/some/resource')
         .then(function (response: APIResponse) {
           expect(response.status).to.eql(200);
@@ -61,7 +62,7 @@ describe('Request', function () {
         .get('/v2/some/resource')
         .reply(429, 'Too many requests');
 
-      const req = new Request({ username: 'api', key: 'key', url: 'https://api.mailgun.com' } as RequestOptions, formData);
+      const req = new Request({ username: 'api', key: 'key', url: 'https://api.mailgun.com' } as RequestOptions, formData as InputFormData);
       const res = req.request('get', '/v2/some/resource').catch(function (error: APIError) {
         expect(error.status).to.eql(429);
         expect(error.details).to.eql('Too many requests');
@@ -80,7 +81,7 @@ describe('Request', function () {
         .query(search)
         .reply(200, {});
 
-      const req = new Request({ url: 'https://api.mailgun.com' } as RequestOptions, formData);
+      const req = new Request({ url: 'https://api.mailgun.com' } as RequestOptions, formData as InputFormData);
       await req.query('get', '/v2/some/resource2', search);
     });
   });
@@ -93,7 +94,7 @@ describe('Request', function () {
         .post('/v2/some/resource')
         .reply(200, {});
 
-      const req = new Request({ url: 'https://api.mailgun.com' } as RequestOptions, formData);
+      const req = new Request({ url: 'https://api.mailgun.com' } as RequestOptions, formData as InputFormData);
       const res = req.command('post', '/v2/some/resource', body);
 
       return res;

package/test/routes.test.ts

@@ -4,6 +4,7 @@ import nock from 'nock';
 import Request from '../lib/request';
 import RoutesClient from '../lib/routes';
 import RequestOptions from '../lib/interfaces/RequestOptions';
+import { InputFormData } from '../lib/interfaces/IFormData';
 
 interface Data {
   actions: string[],
@@ -19,7 +20,7 @@ describe('RoutesClient', function () {
   let api: any;
 
   beforeEach(function () {
-    client = new RoutesClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData));
+    client = new RoutesClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData));
     api = nock('https://api.mailgun.net');
   });
 

package/test/stats.test.ts

@@ -5,13 +5,14 @@ import Request from '../lib/request';
 import StatsClient from '../lib/stats';
 import RequestOptions from '../lib/interfaces/RequestOptions';
 import StatsOptions from '../lib/interfaces/StatsOptions';
+import { InputFormData } from '../lib/interfaces/IFormData';
 
 describe('StatsClient', function () {
   let client: any;
   let api: any;
 
   beforeEach(function () {
-    client = new StatsClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData));
+    client = new StatsClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData));
     api = nock('https://api.mailgun.net');
   });
 

package/test/suppressions.test.ts

@@ -5,6 +5,7 @@ import nock from 'nock';
 import Request from '../lib/request';
 import SuppressionClient from '../lib/suppressions';
 import RequestOptions from '../lib/interfaces/RequestOptions';
+import { InputFormData } from '../lib/interfaces/IFormData';
 
 chai.should();
 
@@ -13,7 +14,7 @@ describe('SuppressionsClient', function () {
   let api: any;
 
   beforeEach(function () {
-    client = new SuppressionClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData));
+    client = new SuppressionClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData));
     api = nock('https://api.mailgun.net');
   });
 

package/test/validate.test.ts

@@ -4,13 +4,14 @@ import nock from 'nock';
 import Request from '../lib/request';
 import ValidateClient from '../lib/validate';
 import RequestOptions from '../lib/interfaces/RequestOptions';
+import { InputFormData } from '../lib/interfaces/IFormData';
 
 describe('ValidateClient', function () {
   let client: any;
   let api: any;
 
   beforeEach(function () {
-    client = new ValidateClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData));
+    client = new ValidateClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData));
     api = nock('https://api.mailgun.net');
   });
 

package/test/webhooks.test.ts

@@ -3,13 +3,14 @@ import nock from 'nock';
 import Request from '../lib/request';
 import WebhookClient from '../lib/webhooks';
 import RequestOptions from '../lib/interfaces/RequestOptions';
+import { InputFormData } from '../lib/interfaces/IFormData';
 
 describe('WebhookClient', function () {
   let client: any;
   let api: any;
 
   beforeEach(function () {
-    client = new WebhookClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData));
+    client = new WebhookClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData));
     api = nock('https://api.mailgun.net');
   });