mailgun.js 3.5.8 → 3.7.0

package/examples/list-domains.js

@@ -1,3 +1,4 @@
+/* eslint-disable no-console */
 const mailgun = require('../index');
 
 const mg = mailgun.client({ username: 'api', key: process.env.MAILGUN_API_KEY || '' });

package/examples/send-email.js

@@ -1,3 +1,4 @@
+/* eslint-disable no-console */
 const fs = require('fs');
 const mailgun = require('../index');
 

package/index.ts

@@ -5,7 +5,7 @@ import IFormData from './lib/interfaces/IFormData';
 class Mailgun {
   private formData: new () => IFormData
 
-  constructor(FormData: new (...args: any[]) => IFormData) {
+  constructor(FormData: new (...args: unknown[]) => IFormData) {
     this.formData = FormData;
   }
 

package/lib/client.ts

@@ -1,3 +1,4 @@
+/* eslint-disable camelcase */
 import Request from './request';
 import Options from './interfaces/Options';
 import RequestOptions from './interfaces/RequestOptions';
@@ -34,11 +35,11 @@ export default class Client {
   public ip_pools;
   public lists;
 
-  constructor(options: Options, formData: new (...args: any[]) => IFormData) {
+  constructor(options: Options, formData: new (...args: unknown[]) => IFormData) {
     const config: RequestOptions = { ...options } as RequestOptions;
 
     if (!config.url) {
-      config.url = 'https://api.mailgun.net'
+      config.url = 'https://api.mailgun.net';
     }
 
     if (!config.username) {

package/lib/events.ts

@@ -1,52 +1,54 @@
-const urljoin = require('url-join');
+import urljoin from 'url-join';
+import {
+  EventsList, EventsPage, EventsResponse, PagesList, PagesListAccumulator
+} from './interfaces/Events';
 
-const MgRequest = require('./request');
+import Request from './request';
 
 export default class EventClient {
-  request: typeof MgRequest;
+  request: Request;
 
-  constructor(request: typeof MgRequest) {
+  constructor(request: Request) {
     this.request = request;
   }
 
-  _parsePageNumber(url: string) {
+  _parsePageNumber(url: string) : string {
     return url.split('/').pop();
   }
 
-  _parsePage(id: string, url: string) {
+  _parsePage(id: string, url: string) : EventsPage {
     return { id, number: this._parsePageNumber(url), url };
   }
 
-  _parsePageLinks(response: { body: { paging: any } }) {
-    const pages = Object.entries(response.body.paging);
+  _parsePageLinks(response: EventsResponse) : PagesList {
+    const pages = Object.entries(response.body.paging as PagesList);
     return pages.reduce(
-      (acc: any, entrie: [url: string, id: string]) => {
+      (acc: PagesListAccumulator, entrie: [url: string, id: string]) => {
         const id = entrie[0];
         const url = entrie[1];
         acc[id] = this._parsePage(id, url);
         return acc;
       }, {}
-    );
+    ) as unknown as PagesList;
   }
 
-  _parseEventList(response: { body: { items: any, paging: any } }) {
+  _parseEventList(response: EventsResponse) : EventsList {
     return {
       items: response.body.items,
       pages: this._parsePageLinks(response)
     };
   }
 
-  get(domain: string, query: { page: any }) {
+  get(domain: string, query: { page: string }) : Promise<EventsList> {
     let url;
-
-    if (query && query.page) {
-      url = urljoin('/v2', domain, 'events', query.page);
-      delete query.page;
+    const queryCopy = { ...query };
+    if (queryCopy && queryCopy.page) {
+      url = urljoin('/v2', domain, 'events', queryCopy.page);
+      delete queryCopy.page;
     } else {
       url = urljoin('/v2', domain, 'events');
     }
-
-    return this.request.get(url, query)
-      .then((response: { body: { items: any, paging: any } }) => this._parseEventList(response));
+    return this.request.get(url, queryCopy)
+      .then((response: EventsResponse) => this._parseEventList(response));
   }
 }

package/lib/interfaces/APIErrorOptions.ts

@@ -1,4 +1,4 @@
-export default interface APIErrorOptions {
+interface APIErrorOptions {
   headers: { [key: string]: any };
   status: number | string;
   message: string;
@@ -6,3 +6,5 @@ export default interface APIErrorOptions {
   url: string;
   statusText: string;
 }
+
+export default APIErrorOptions;

package/lib/interfaces/ApiResponse.ts

@@ -1,4 +1,6 @@
-export default interface APIResponse {
+ interface APIResponse {
     status: number;
     body: any;
 }
+
+export default APIResponse;

package/lib/interfaces/Events.ts

@@ -0,0 +1,25 @@
+export interface EventsPage {
+    id: string;
+    number: string;
+    url: string;
+}
+export interface PagesList {
+    previous: string;
+    first: string;
+    last: string;
+    next: string;
+}
+export interface EventsResponse {
+    body: {
+        items: [];
+        paging: PagesList;
+    }
+}
+
+export interface EventsList {
+    items: [];
+    pages: PagesList;
+}
+export interface PagesListAccumulator {
+    [index: string]: EventsPage
+}

package/lib/interfaces/IFormData.ts

@@ -11,8 +11,9 @@ interface AppendOptions {
 }
 
 export default abstract class IFormData {
-    constructor(){ //description of type. Should not be used for creating objects
-    }
+  // 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
+  abstract append(key: string, value: any, options?: AppendOptions | string): void
 }

package/lib/interfaces/IpPools.ts

@@ -1,7 +1,22 @@
+/* eslint-disable camelcase */
 export interface IpPool {
   description: string;
   ips: string[];
   is_linked: boolean;
   name: string;
   pool_id: string;
-}
+}
+
+export interface IpPoolListResponse {
+  body: {
+    ip_pools: IpPool,
+    message: string
+  }
+}
+
+export interface IpPoolUpdateData {
+  name: string,
+  description: string,
+  add_ip: string,
+  remove_ip: string
+}

package/lib/interfaces/Ips.ts

@@ -1,3 +1,4 @@
+/* eslint-disable camelcase */
 export interface IpsListResponseBody {
   assignable_to_pools: boolean;
   items: string[];

package/lib/interfaces/Options.ts

@@ -1,7 +1,10 @@
-export default interface Options {
+/* eslint-disable camelcase */
+ interface Options {
   username: string;
   key: string;
   url?: string;
   public_key?: string;
   timeout?: number;
-}
+}
+
+export default Options;

package/lib/interfaces/RequestOptions.ts

@@ -1,6 +1,8 @@
 import Options from './Options';
 
-export default interface RequestOptions extends Options {
+interface RequestOptions extends Options {
   headers: any;
   timeout: number;
-}
+}
+
+export default RequestOptions;

package/lib/interfaces/StatsOptions.ts

@@ -1,4 +1,4 @@
-export default interface StatsOptions {
+ interface StatsOptions {
   start: string | Date;
   end: string | Date;
   resolution: string;
@@ -10,4 +10,6 @@ export default interface StatsOptions {
       total: number
     }
   }[];
-}
+}
+
+export default StatsOptions;

package/lib/interfaces/Supressions.ts

@@ -1,3 +1,4 @@
+/* eslint-disable camelcase */
 export interface BounceData {
   address: string;
   code: number;
@@ -15,4 +16,3 @@ export interface UnsubscribeData {
   tags: any;
   created_at: string | Date;
 }
-

package/lib/interfaces/lists.ts

@@ -1,3 +1,4 @@
+/* eslint-disable camelcase */
 export interface ListsQuery {
     address?: string;
     limit?: number;

package/lib/interfaces/mailListMembers.ts

@@ -1,5 +1,11 @@
-import {MailingList} from './lists';
+import { MailingList } from './lists';
 
+export interface MailListMember {
+    address: string;
+    name: string;
+    subscribed: boolean,
+    vars: string | any;
+}
 export interface MailListMembersQuery {
     subscribed?: 'yes' | 'no';
     limit?: number;
@@ -31,13 +37,6 @@ export interface CreateUpdateMailListMembersReq {
     upsert?: 'yes' | 'no';
 }
 
-export interface MailListMember {
-    address: string;
-    name: string;
-    subscribed: boolean,
-    vars: string | any;
-}
-
 export interface DeletedMember {
     member: {
         address: string;
@@ -54,8 +53,15 @@ export interface NewMultipleMembersResponse {
 export interface IMailListsMembers {
     listMembers(mailListAddress: string, query?: MailListMembersQuery): Promise<MailListMember[]>;
     getMember(address: string, memberAddress: string): Promise<MailListMember>,
-    createMember(mailListAddress: string, data: CreateUpdateMailListMembers): Promise<MailListMember>,
-    createMembers(mailListAddress: string, data: MultipleMembersData): Promise<NewMultipleMembersResponse>,
-    updateMember(address : string, memberAddress: string, data:CreateUpdateMailListMembers): Promise<MailListMember> ,
+    createMember(
+        mailListAddress: string,
+        data: CreateUpdateMailListMembers): Promise<MailListMember>,
+    createMembers(
+        mailListAddress: string,
+        data: MultipleMembersData): Promise<NewMultipleMembersResponse>,
+    updateMember(
+        address: string,
+        memberAddress: string,
+        data: CreateUpdateMailListMembers): Promise<MailListMember>,
     destroyMember(address : string, memberAddress: string): Promise<DeletedMember>
-}
+}

package/lib/interfaces/routes.ts

@@ -1,3 +1,4 @@
+/* eslint-disable camelcase */
 export interface Route {
     actions: string[];
     created_at: string;

package/lib/ip-pools.ts

@@ -1,17 +1,18 @@
-const MgRequest = require('./request');
+/* eslint-disable camelcase */
+import Request from './request';
 
-import { IpPool } from "./interfaces/IpPools";
+import { IpPool, IpPoolListResponse, IpPoolUpdateData } from './interfaces/IpPools';
 
 export default class IpPoolsClient {
-  request: typeof MgRequest;
+  request: Request;
 
-  constructor(request: typeof MgRequest) {
+  constructor(request: Request) {
     this.request = request;
   }
 
-  list(query: any): IpPool[] {
+  list(query: any): Promise<IpPool[]> {
     return this.request.get('/v1/ip_pools', query)
-      .then((response: { body: { ip_pools: IpPool, message: string } }) => this.parseIpPoolsResponse(response));
+      .then((response: IpPoolListResponse) => this.parseIpPoolsResponse(response));
   }
 
   create(data: { name: string, description?: string, ips?: string[] }) {
@@ -19,7 +20,7 @@ export default class IpPoolsClient {
       .then((response: { body: { message: string, pool_id: string } }) => response?.body);
   }
 
-  update(poolId: string, data: { name: string, description: string, add_ip: string, remove_ip: string }) {
+  update(poolId: string, data: IpPoolUpdateData) : Promise<any> {
     return this.request.patch(`/v1/ip_pools/${poolId}`, data)
       .then((response: { body: any }) => response?.body);
   }

package/lib/ips.ts

@@ -1,10 +1,10 @@
-const MgRequest = require('./request');
+import MgRequest from './request';
 import { IpData, IpsListResponseBody } from './interfaces/Ips';
 
 export default class IpsClient {
-  request: typeof MgRequest;
+  request: MgRequest;
 
-  constructor(request: typeof MgRequest) {
+  constructor(request: MgRequest) {
     this.request = request;
   }
 

package/lib/lists.ts

@@ -5,7 +5,7 @@ import {
   DestroyedList,
   MailingList
 } from './interfaces/lists';
-import {IMailListsMembers} from './interfaces/mailListMembers';
+import { IMailListsMembers } from './interfaces/mailListMembers';
 
 export default class ListsClient {
   baseRoute: string;

package/lib/messages.ts

@@ -1,4 +1,4 @@
-import Request from "./request";
+import Request from './request';
 
 export default class MessagesClient {
   request: Request;

package/lib/parse.ts

@@ -1,3 +1,4 @@
+/* eslint-disable camelcase */
 import Request from './request';
 
 export default class ParseClient {
@@ -11,11 +12,11 @@ export default class ParseClient {
     const query = {} as { addresses: string, syntax_only: boolean };
 
     if (Array.isArray(addresses)) {
-      addresses = addresses.join(',');
+      query.addresses = addresses.join(',');
+    } else {
+      query.addresses = addresses;
     }
 
-    query.addresses = addresses;
-
     if (enableDnsEspChecks) {
       query.syntax_only = false;
     }

package/lib/stats.ts

@@ -13,8 +13,9 @@ class Stats {
     this.end = new Date(data.end);
     this.resolution = data.resolution;
     this.stats = data.stats.map(function (stat: { time: string | Date }) {
-      stat.time = new Date(stat.time);
-      return stat;
+      const res = { ...stat };
+      res.time = new Date(stat.time);
+      return res;
     });
   }
 }

package/lib/suppressions.ts

@@ -1,11 +1,10 @@
+/* eslint-disable camelcase */
 import url from 'url';
 import urljoin from 'url-join';
 
 import Request from './request';
 import { BounceData, ComplaintData, UnsubscribeData } from './interfaces/Supressions';
 
-type TModel = typeof Bounce | typeof Complaint | typeof Unsubscribe;
-
 const createOptions = {
   headers: { 'Content-Type': 'application/json' }
 };
@@ -52,6 +51,8 @@ class Unsubscribe {
   }
 }
 
+type TModel = typeof Bounce | typeof Complaint | typeof Unsubscribe;
+
 export default class SuppressionClient {
   request: any;
   models: {
@@ -84,10 +85,11 @@ export default class SuppressionClient {
   _parsePageLinks(response: { body: { paging: any } }) {
     const pages = Object.entries(response.body.paging);
     return pages.reduce(
-      (acc: any, [id, url]: [url: string, id: string]) => {
-        acc[id] = this._parsePage(id, url)
-        return acc
-      }, {});
+      (acc: any, [id, pageUrl]: [pageUrl: string, id: string]) => {
+        acc[id] = this._parsePage(id, pageUrl);
+        return acc;
+      }, {}
+    );
   }
 
   _parseList(response: { body: { items: any, paging: any } }, Model: TModel) {
@@ -122,19 +124,22 @@ export default class SuppressionClient {
 
   create(domain: string, type: string, data: any) {
     // supports adding multiple suppressions by default
+    let postData;
     if (!Array.isArray(data)) {
-      data = [data];
+      postData = [data];
+    } else {
+      postData = { ...data };
     }
 
     return this.request
-    .post(urljoin('v3', domain, type), data, createOptions)
-    .then((response: { body: any }) => response.body);
+      .post(urljoin('v3', domain, type), postData, createOptions)
+      .then((response: { body: any }) => response.body);
   }
 
   destroy(domain: string, type: string, address: string) {
     return this.request
-    .delete(urljoin('v3', domain, type, encodeURIComponent(address)))
-    .then((response: { body: any }) => response.body);
+      .delete(urljoin('v3', domain, type, encodeURIComponent(address)))
+      .then((response: { body: any }) => response.body);
   }
 }
 

package/lib/validate.ts

@@ -1,4 +1,3 @@
-
 import Request from './request';
 
 export default class ValidateClient {

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "mailgun.js",
-  "version": "3.5.8",
-  "main": "dist/mailgun.js",
+  "version": "3.7.0",
+  "main": "dist/mailgun.node.js",
+  "browser": "dist/mailgun.web.js",
   "types": "dist/index.d.ts",
   "author": "Mailgun",
   "license": "MIT",
@@ -18,9 +19,9 @@
   },
   "homepage": "https://github.com/mailgun/mailgun-js#readme",
   "scripts": {
-    "build": "webpack --config ./webpack.config.js --progress --color",
-    "build:release": "webpack --config ./webpack.release.config.js --progress --color",
-    "start": "webpack --watch --config ./webpack.config.js --progress --color",
+    "build": "webpack --config ./webpack/webpack.dev.config.js --progress --color",
+    "build:release": "webpack --config ./webpack/webpack.release.config.js --progress --color",
+    "start": "webpack --watch --config ./webpack/webpack.dev.config.js --progress --color",
     "release": "standard-version -a",
     "test": "multi='dot=- xunit=./results.xml' mocha -t 10000 -R mocha-multi -r ts-node/register test/*.test.ts",
     "test-watch": "mocha -r ts-node/register -w -R dot test/*.test.ts",
@@ -41,7 +42,7 @@
   "devDependencies": {
     "@babel/core": "^7.12.3",
     "@babel/preset-env": "^7.12.1",
-    "@commitlint/cli": "^12.1.4",
+    "@commitlint/cli": "^13.1.0",
     "@commitlint/config-conventional": "^12.1.4",
     "@types/base-64": "^1.0.0",
     "@types/chai": "^4.2.14",
@@ -51,7 +52,7 @@
     "@typescript-eslint/parser": "^4.26.0",
     "babel-loader": "^8.1.0",
     "chai": "^4.2.0",
-    "eslint": "^7.27.0",
+    "eslint": "^7.32.0",
     "eslint-config-airbnb-base": "^14.2.0",
     "eslint-import-resolver-webpack": "^0.13.1",
     "eslint-plugin-import": "^2.22.1",
@@ -59,11 +60,10 @@
     "form-data": "^3.0.1",
     "husky": "^7.0.1",
     "json-loader": "^0.5.7",
-    "mocha": "^8.2.1",
+    "mocha": "^9.1.3",
     "mocha-multi": "^1.1.3",
     "nock": "^13.0.4",
     "path-browserify": "^1.0.1",
-    "should": "^4.1.0",
     "standard-version": "^9.3.1",
     "terser-webpack-plugin": "^5.2.0",
     "ts-loader": "^8.0.12",
@@ -105,7 +105,7 @@
     "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.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/client.test.ts

@@ -17,13 +17,18 @@ describe('Client', function () {
   let client: any;
 
   beforeEach(function () {
-    client = new Client({ username: 'username', key: 'key', public_key: 'key', timeout: 10000 }, formData);
+    client = new Client({
+      username: 'username',
+      key: 'key',
+      public_key: 'key',
+      timeout: 10000
+    }, formData);
   });
 
   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);
       }
     ).to.throw('Parameter "username" is required');
   });

package/test/events.test.ts

@@ -1,7 +1,6 @@
-const formData = require('form-data'); // importing this way to not have type error in line 13
-
 import nock from 'nock';
 
+import formData from 'form-data';
 import EventClient from '../lib/events';
 import MgRequest from '../lib/request';
 import RequestOptions from '../lib/interfaces/RequestOptions';

package/test/ips.test.ts

@@ -1,6 +1,7 @@
-const formData = require('form-data');
+// const formData = require('form-data');
 
 import nock from 'nock';
+import formData from 'form-data';
 import Request from '../lib/request';
 import RequestOptions from '../lib/interfaces/RequestOptions';
 import IpsClient from '../lib/ips';

package/test/lists.test.ts

@@ -1,6 +1,6 @@
-const formData = require('form-data');
-
 import nock from 'nock';
+import formData from 'form-data';
+
 import Request from '../lib/request';
 import ListsClient from '../lib/lists';
 import RequestOptions from '../lib/interfaces/RequestOptions';
@@ -25,7 +25,7 @@ describe('ListsClient', function () {
       members_count: 1,
       name: '123',
       reply_preference: null
-    } as MailingList
+    } as MailingList;
   });
 
   afterEach(function () {
@@ -40,15 +40,14 @@ describe('ListsClient', function () {
         items: lists
       });
 
-      return client.list().then(function (lists: MailingList[]) {
-        lists[0].should.eql(defaultList);
+      return client.list().then(function (listsRes: MailingList[]) {
+        listsRes[0].should.eql(defaultList);
       });
     });
   });
 
   describe('get', function () {
     it('gets a specific mailing list', function () {
-
       api.get('/v3/lists/testing.example.com').reply(200, {
         list: defaultList
       });
@@ -61,7 +60,6 @@ describe('ListsClient', function () {
 
   describe('create', function () {
     it('creates the list', function () {
-
       api.post('/v3/lists').reply(200, {
         list: defaultList
       });