mailgun.js 4.0.0 → 4.1.2

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

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

package/lib/interfaces/StatsOptions.ts

@@ -1,15 +1,23 @@
- interface StatsOptions {
+export interface Stat {
+  time: string | Date,
+  delivered: {
+    smtp: number,
+    http: number,
+    total: number
+  }
+}
+
+export interface StatsOptions {
   start: string | Date;
   end: string | Date;
   resolution: string;
-  stats: {
-    time: string | Date,
-    delivered: {
-      smtp: number,
-      http: number,
-      total: number
-    }
-  }[];
+  stats: Stat[];
 }
 
-export default StatsOptions;
+export interface StatsQuery {
+  event: string | string[];
+  start: string | Date;
+  end: string | Date;
+  resolution: 'hour'| 'day' | 'month';
+  duration: string;
+}

package/lib/interfaces/Supressions.ts

@@ -16,3 +16,10 @@ export interface UnsubscribeData {
   tags: any;
   created_at: string | Date;
 }
+
+export interface WhiteListData {
+  type: string;
+  value: string;
+  reason: string;
+  createdAt: string | Date;
+}

package/lib/ip-pools.ts

@@ -16,12 +16,12 @@ export default class IpPoolsClient {
   }
 
   create(data: { name: string, description?: string, ips?: string[] }) {
-    return this.request.post('/v1/ip_pools', data)
+    return this.request.postWithFD('/v1/ip_pools', data)
       .then((response: { body: { message: string, pool_id: string } }) => response?.body);
   }
 
   update(poolId: string, data: IpPoolUpdateData) : Promise<any> {
-    return this.request.patch(`/v1/ip_pools/${poolId}`, data)
+    return this.request.patchWithFD(`/v1/ip_pools/${poolId}`, data)
       .then((response: { body: any }) => response?.body);
   }
 

package/lib/request.ts

@@ -50,7 +50,7 @@ class Request {
   private url: string;
   private timeout: number;
   private headers: any;
-  private formData: InputFormData;
+  private FormDataConstructor: InputFormData;
 
   constructor(options: RequestOptions, formData: InputFormData) {
     this.username = options.username;
@@ -58,7 +58,7 @@ class Request {
     this.url = options.url as string;
     this.timeout = options.timeout;
     this.headers = options.headers || {};
-    this.formData = formData;
+    this.FormDataConstructor = formData;
   }
 
   async request(method: string, url: string, inputOptions?: any): Promise<APIResponse> {
@@ -165,50 +165,94 @@ class Request {
     return this.command('put', url, formData, params);
   }
 
+  patchWithFD(url: string, data: any): Promise<APIResponse> {
+    if (!data) {
+      throw new Error('Please provide data object');
+    }
+    const params: any = {
+      headers: { 'Content-Type': null }
+    };
+    const formData = this.createFormData(data);
+    return this.command('patch', url, formData, params);
+  }
+
   createFormData(data: any): NodeFormData | FormData {
+    const formData: NodeFormData | FormData = Object.keys(data)
+      .filter(function (key) { return data[key]; })
+      .reduce((formDataAcc: NodeFormData | FormData, key) => {
+        const fileKeys = ['attachment', 'inline', 'file'];
+        if (fileKeys.includes(key)) {
+          this.addFilesToFD(key, data[key], formDataAcc);
+          return formDataAcc;
+        }
+
+        if (key === 'message') { // mime message
+          this.addMimeDataToFD(key, data[key], formDataAcc);
+          return formDataAcc;
+        }
+
+        this.addCommonPropertyToFD(key, data[key], formDataAcc);
+        return formDataAcc;
+      }, new this.FormDataConstructor());
+    return formData;
+  }
+
+  private addMimeDataToFD(
+    key: string,
+    data: Buffer | Blob,
+    formDataInstance: NodeFormData | FormData
+  ): void {
+    if (isNodeFormData(formDataInstance)) {
+      if (Buffer.isBuffer(data)) {
+        formDataInstance.append(key, data, { filename: 'MimeMessage' });
+      }
+    } else {
+      formDataInstance.append(key, data as Blob, 'MimeMessage');
+    }
+  }
+
+  private addFilesToFD(
+    propertyName: string,
+    value: any,
+    formDataInstance: NodeFormData | FormData
+  ): void {
     const appendFileToFD = (
       key: string,
       obj: any,
-      formDataInstance: NodeFormData | FormData
+      formData: NodeFormData | FormData
     ): void => {
       const isStreamData = isStream(obj);
       const objData = isStreamData ? obj : obj.data;
+      // getAttachmentOptions should be called with obj parameter to prevent loosing filename
       const options = getAttachmentOptions(obj);
-      if (isNodeFormData(formDataInstance)) {
-        formDataInstance.append(key, objData, options);
+      if (isNodeFormData(formData)) {
+        formData.append(key, objData, options);
         return;
       }
-      formDataInstance.append(key, objData, options.filename);
+      formData.append(key, objData, options.filename);
     };
 
-    const formData: NodeFormData | FormData = Object.keys(data)
-      .filter(function (key) { return data[key]; })
-      .reduce((formDataAcc: NodeFormData | FormData, key) => {
-        if (key === 'attachment' || key === 'inline' || key === 'file') {
-          const obj = data[key];
-
-          if (Array.isArray(obj)) {
-            obj.forEach(function (item) {
-              appendFileToFD(key, item, formDataAcc);
-            });
-          } else {
-            appendFileToFD(key, obj, formDataAcc);
-          }
-
-          return formDataAcc;
-        }
+    if (Array.isArray(value)) {
+      value.forEach(function (item) {
+        appendFileToFD(propertyName, item, formDataInstance);
+      });
+    } else {
+      appendFileToFD(propertyName, value, formDataInstance);
+    }
+  }
 
-        if (Array.isArray(data[key])) {
-          data[key].forEach(function (item: any) {
-            formDataAcc.append(key, item);
-          });
-        } else if (data[key] != null) {
-          formDataAcc.append(key, data[key]);
-        }
-        return formDataAcc;
-      // eslint-disable-next-line new-cap
-      }, new this.formData());
-    return formData;
+  private addCommonPropertyToFD(
+    key: string,
+    value: any,
+    formDataAcc: NodeFormData | FormData
+  ): void {
+    if (Array.isArray(value)) {
+      value.forEach(function (item: any) {
+        formDataAcc.append(key, item);
+      });
+    } else if (value != null) {
+      formDataAcc.append(key, value);
+    }
   }
 
   put(url: string, data: any, options?: any): Promise<APIResponse> {

package/lib/stats.ts

@@ -1,18 +1,18 @@
 import urljoin from 'url-join';
 import Request from './request';
-import StatsOptions from './interfaces/StatsOptions';
+import { StatsQuery, StatsOptions, Stat } from './interfaces/StatsOptions';
 
 class Stats {
   start: Date;
   end: Date;
   resolution: string;
-  stats: any;
+  stats: Stat[];
 
   constructor(data: StatsOptions) {
     this.start = new Date(data.start);
     this.end = new Date(data.end);
     this.resolution = data.resolution;
-    this.stats = data.stats.map(function (stat: { time: string | Date }) {
+    this.stats = data.stats.map(function (stat: Stat) {
       const res = { ...stat };
       res.time = new Date(stat.time);
       return res;
@@ -27,17 +27,36 @@ export default class StatsClient {
     this.request = request;
   }
 
-  _parseStats(response: { body: StatsOptions }) {
+  private prepareSearchParams(query: StatsQuery): Array<Array<string>> {
+    let searchParams = [];
+    if (typeof query === 'object' && Object.keys(query).length) {
+      searchParams = Object.entries(query).reduce((arrayWithPairs, currentPair) => {
+        const [key, value] = currentPair;
+        if (Array.isArray(value) && value.length) {
+          const repeatedProperty = value.map((item) => [key, item]);
+          return [...arrayWithPairs, ...repeatedProperty];
+        }
+        arrayWithPairs.push([key, value]);
+        return arrayWithPairs;
+      }, []);
+    }
+
+    return searchParams;
+  }
+
+  _parseStats(response: { body: StatsOptions }): Stats {
     return new Stats(response.body);
   }
 
-  getDomain(domain: string, query: any) {
-    return this.request.get(urljoin('/v3', domain, 'stats/total'), query)
+  getDomain(domain: string, query?: StatsQuery): Promise<Stats> {
+    const searchParams = this.prepareSearchParams(query);
+    return this.request.get(urljoin('/v3', domain, 'stats/total'), searchParams)
       .then(this._parseStats);
   }
 
-  getAccount(query: any) {
-    return this.request.get('/v3/stats/total', query)
+  getAccount(query?: StatsQuery): Promise<Stats> {
+    const searchParams = this.prepareSearchParams(query);
+    return this.request.get('/v3/stats/total', searchParams)
       .then(this._parseStats);
   }
 }

package/lib/suppressions.ts

@@ -3,7 +3,12 @@ import url from 'url';
 import urljoin from 'url-join';
 
 import Request from './request';
-import { BounceData, ComplaintData, UnsubscribeData } from './interfaces/Supressions';
+import {
+  BounceData,
+  ComplaintData,
+  UnsubscribeData,
+  WhiteListData
+} from './interfaces/Supressions';
 
 const createOptions = {
   headers: { 'Content-Type': 'application/json' }
@@ -51,7 +56,21 @@ class Unsubscribe {
   }
 }
 
-type TModel = typeof Bounce | typeof Complaint | typeof Unsubscribe;
+class WhiteList {
+  type: string;
+  value: string;
+  reason: string;
+  createdAt: Date;
+
+  constructor(data: WhiteListData) {
+    this.type = 'whitelists';
+    this.value = data.value;
+    this.reason = data.reason;
+    this.createdAt = new Date(data.createdAt);
+  }
+}
+
+type TModel = typeof Bounce | typeof Complaint | typeof Unsubscribe | typeof WhiteList;
 
 export default class SuppressionClient {
   request: any;
@@ -59,6 +78,7 @@ export default class SuppressionClient {
     bounces: typeof Bounce;
     complaints: typeof Complaint;
     unsubscribes: typeof Unsubscribe;
+    whitelists: typeof WhiteList;
   };
 
   constructor(request: Request) {
@@ -66,7 +86,8 @@ export default class SuppressionClient {
     this.models = {
       bounces: Bounce,
       complaints: Complaint,
-      unsubscribes: Unsubscribe
+      unsubscribes: Unsubscribe,
+      whitelists: WhiteList,
     };
   }
 
@@ -106,6 +127,12 @@ export default class SuppressionClient {
     return new Model(response.body);
   }
 
+  private createWhiteList(domain: string, data: any) {
+    return this.request
+      .postWithFD(urljoin('v3', domain, 'whitelists'), data, createOptions)
+      .then((response: { body: any }) => response.body);
+  }
+
   list(domain: string, type: string, query: any) {
     const model = (this.models as any)[type];
 
@@ -125,14 +152,18 @@ export default class SuppressionClient {
   create(domain: string, type: string, data: any) {
     // supports adding multiple suppressions by default
     let postData;
+    if (type === 'whitelists') {
+      return this.createWhiteList(domain, data);
+    }
+
     if (!Array.isArray(data)) {
       postData = [data];
     } else {
-      postData = { ...data };
+      postData = [...data];
     }
 
     return this.request
-      .post(urljoin('v3', domain, type), postData, createOptions)
+      .post(urljoin('v3', domain, type), JSON.stringify(postData), createOptions)
       .then((response: { body: any }) => response.body);
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mailgun.js",
-  "version": "4.0.0",
+  "version": "4.1.2",
   "main": "dist/mailgun.node.js",
   "browser": "dist/mailgun.web.js",
   "types": "dist/index.d.ts",
@@ -105,7 +105,8 @@
     "commitUrlFormat": "https://github.com/mailgun/mailgun.js/commits/{{hash}}",
     "compareUrlFormat": "https://github.com/mailgun/mailgun.js/compare/{{previousTag}}...{{currentTag}}",
     "scripts": {
-      "prerelease": "npm test && webpack --config ./webpack/webpack.release.config.js --progress --color && git add -A dist"
+      "prerelease": "npm test && webpack --config ./webpack/webpack.release.config.js --progress --color && git add -A dist",
+      "posttag": "git push && git push --tags && rm -rf build"
     }
   }
 }

package/test/stats.test.ts

@@ -4,7 +4,7 @@ import nock from 'nock';
 import Request from '../lib/request';
 import StatsClient from '../lib/stats';
 import RequestOptions from '../lib/interfaces/RequestOptions';
-import StatsOptions from '../lib/interfaces/StatsOptions';
+import { StatsOptions } from '../lib/interfaces/StatsOptions';
 import { InputFormData } from '../lib/interfaces/IFormData';
 
 describe('StatsClient', function () {