mailgun.js 5.0.0 → 5.0.3

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

@@ -2,6 +2,4 @@
 
 /*! https://mths.be/base64 v1.0.0 by @mathias | MIT license */
 
-/*! https://mths.be/punycode v1.3.2 by @mathias */
-
-/*! mailgun.js v4.2.3 */
+/*! mailgun.js v5.0.2 */

package/examples/send-email.js

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

package/lib/domains.ts

@@ -208,7 +208,7 @@ export default class DomainClient {
 
   updateDKIMAuthority(domain: string, data: DKIMAuthorityInfo): Promise<UpdatedDKIMAuthority> {
     return this.request.put(`/v3/domains/${domain}/dkim_authority`, {}, { query: `self=${data.self}` })
-      .then((res : APIResponse) => res)
+      .then((res : APIResponse) => res as UpdatedDKIMAuthorityResponse)
       .then((res : UpdatedDKIMAuthorityResponse) => res.body as UpdatedDKIMAuthority);
   }
 

package/lib/events.ts

@@ -13,7 +13,7 @@ export default class EventClient {
   }
 
   _parsePageNumber(url: string) : string {
-    return url.split('/').pop();
+    return url.split('/').pop() || '';
   }
 
   _parsePage(id: string, url: string) : EventsPage {
@@ -23,9 +23,9 @@ export default class EventClient {
   _parsePageLinks(response: EventsResponse) : ParsedPagesList {
     const pages = Object.entries(response.body.paging as PagesList);
     return pages.reduce(
-      (acc: PagesListAccumulator, entrie: [url: string, id: string]) => {
-        const id = entrie[0];
-        const url = entrie[1];
+      (acc: PagesListAccumulator, pair: [url: string, id: string]) => {
+        const id = pair[0];
+        const url = pair[1];
         acc[id] = this._parsePage(id, url);
         return acc;
       }, {}

package/lib/index.ts

@@ -2,7 +2,8 @@ import Client from './client';
 import { InputFormData } from './interfaces/IFormData';
 import Options from './interfaces/Options';
 
-class Mailgun {
+export default class Mailgun {
+  static get default(): typeof Mailgun { return this; }
   private formData: InputFormData
 
   constructor(FormData: InputFormData) {
@@ -13,5 +14,3 @@ class Mailgun {
     return new Client(options, this.formData);
   }
 }
-
-export = Mailgun;

package/lib/interfaces/DomainTags.ts

@@ -238,7 +238,6 @@ export interface DomainTagDevicesAggregation {
     device: DevicesTypes;
 }
 
-
 export interface IDomainTagsClient {
     list(domain: string): Promise<DomainTagsList>
     get(domain: string, tag: string): Promise<DomainTagsItem>

package/lib/interfaces/DomainTemplates.ts

@@ -206,7 +206,7 @@ export interface ListDomainTemplateVersionsResult {
 
 export interface IDomainTemplatesClient {
     list(domain: string, query?: DomainTemplatesQuery): Promise<ListDomainTemplatesResult>
-    get(domain: string, templateName: string, query: TemplateQuery): Promise<DomainTemplateItem>
+    get(domain: string, templateName: string, query?: TemplateQuery): Promise<DomainTemplateItem>
     create(domain: string, data: DomainTemplateData): Promise<DomainTemplateItem>
     update(
         domain: string,

package/lib/interfaces/Domains.ts

@@ -1,9 +1,9 @@
 /* eslint-disable camelcase */
 export interface DomainsQuery {
-    authority : string;
-    state: 'active' | 'unverified' | 'disabled';
-    limit: number;
-    skip: number;
+    authority? : string;
+    state?: 'active' | 'unverified' | 'disabled';
+    limit?: number;
+    skip?: number;
 }
 
 export interface DomainInfo {

package/lib/interfaces/IFormData.ts

@@ -1,4 +1,4 @@
-import NodeFormData from 'form-data';
+import * as NodeFormData from 'form-data';
 
 export interface IFormDataOptions {
   [key: string]: any;

package/lib/interfaces/StatsOptions.ts

@@ -14,10 +14,12 @@ export interface StatsOptions {
   stats: Stat[];
 }
 
+export type StatsEvent = 'accepted' | 'delivered' | 'opened' | 'clicked' | 'unsubscribed' | 'stored' | 'rejected' | 'complained' | 'failed-temporary' | 'failed-permanent';
+
 export interface StatsQuery {
-  event: string | string[];
-  start: string | Date;
-  end: string | Date;
-  resolution: 'hour'| 'day' | 'month';
-  duration: string;
+  event: StatsEvent | StatsEvent[];
+  start?: string | Date;
+  end?: string | Date;
+  resolution?: 'hour'| 'day' | 'month';
+  duration?: string;
 }

package/lib/interfaces/Supressions.ts

@@ -1,3 +1,7 @@
+import {
+  Bounce, Complaint, Unsubscribe, WhiteList
+} from '../suppressions';
+
 /* eslint-disable camelcase */
 export interface BounceData {
   address: string;
@@ -23,3 +27,97 @@ export interface WhiteListData {
   reason: string;
   createdAt: string | Date;
 }
+
+export interface ParsedPage {
+  id: string;
+  page: string | null | undefined;
+  address: string | null | undefined;
+  url: string
+}
+export interface ParsedPagesList {
+  previous: ParsedPage;
+  first: ParsedPage;
+  last: ParsedPage;
+  next: ParsedPage;
+}
+
+export interface SuppressionList {
+  items: (Bounce | Complaint | Unsubscribe | WhiteList)[];
+  pages: ParsedPagesList;
+}
+
+export interface PagesList {
+  previous: string;
+  first: string;
+  last: string;
+  next: string;
+}
+
+export enum SuppressionModels {
+  BOUNCES = 'bounces',
+  COMPLAINTS = 'complaints',
+  UNSUBSCRIBES = 'unsubscribes',
+  WHITELISTS = 'whitelists'
+}
+
+export interface PagesListAccumulator {
+  [index: string]: ParsedPage;
+}
+
+export interface SuppressionListQuery {
+  limit?: number;
+}
+
+export interface SuppressionListResponse {
+  body: {
+    items: BounceData[] | ComplaintData[] | UnsubscribeData[] | WhiteListData[];
+    paging: PagesList;
+  }
+  status: number;
+}
+
+export interface SuppressionResponse {
+  body: BounceData | ComplaintData | UnsubscribeData | WhiteListData;
+  status: number;
+}
+
+export interface SuppressionDestroyResponse {
+  body: {
+    message: string;
+    value?: string;
+    address?: string;
+  }
+  status: number;
+}
+
+export interface SuppressionDestroyResult {
+  message: string;
+  value: string;
+  address: string;
+  status: number;
+}
+
+export interface SuppressionCreationData {
+  address: string;
+  code?: number;
+  error?: string;
+  domain?: string;
+  tag?: string;
+  created_at?: string ;
+}
+
+export interface SuppressionCreationResponse {
+  body:{
+    message:string;
+    type?: string;
+    value?: string;
+  }
+  status: number;
+}
+
+export interface SuppressionCreationResult {
+  message:string;
+  type: string;
+  value: string;
+  status: number;
+}

package/lib/interfaces/Webhooks.ts

@@ -28,3 +28,13 @@ export interface ValidationResponse {
     code: number;
     message: string;
 }
+
+export enum WebhooksIds {
+    CLICKED = 'clicked',
+    COMPLAINED = 'complained',
+    DELIVERED = 'delivered',
+    OPENED = 'opened',
+    PERMANENT_FAIL = 'permanent_fail',
+    TEMPORARY_FAIL = 'temporary_fail',
+    UNSUBSCRIBED = 'unsubscribe',
+}

package/lib/request.ts

@@ -1,5 +1,5 @@
-import NodeFormData from 'form-data';
-import base64 from 'base-64';
+import * as NodeFormData from 'form-data';
+import * as base64 from 'base-64';
 import urljoin from 'url-join';
 import ky from 'ky-universal';
 import APIError from './error';

package/lib/stats.ts

@@ -27,8 +27,8 @@ export default class StatsClient {
     this.request = request;
   }
 
-  private prepareSearchParams(query: StatsQuery): Array<Array<string>> {
-    let searchParams = [];
+  private prepareSearchParams(query: StatsQuery | undefined): Array<Array<string>> {
+    let searchParams = [] as Array<Array<string>>;
     if (typeof query === 'object' && Object.keys(query).length) {
       searchParams = Object.entries(query).reduce((arrayWithPairs, currentPair) => {
         const [key, value] = currentPair;
@@ -38,7 +38,7 @@ export default class StatsClient {
         }
         arrayWithPairs.push([key, value]);
         return arrayWithPairs;
-      }, []);
+      }, [] as Array<Array<string>>);
     }
 
     return searchParams;

package/lib/suppressions.ts

@@ -1,28 +1,47 @@
 /* eslint-disable camelcase */
-import url from 'url';
 import urljoin from 'url-join';
 
 import Request from './request';
 import {
   BounceData,
   ComplaintData,
+  PagesList,
+  PagesListAccumulator,
+  ParsedPage,
+  ParsedPagesList,
+  SuppressionCreationData,
+  SuppressionCreationResponse,
+  SuppressionCreationResult,
+  SuppressionDestroyResponse,
+  SuppressionDestroyResult,
+  SuppressionList,
+  SuppressionListQuery,
+  SuppressionListResponse,
+  SuppressionModels,
+  SuppressionResponse,
   UnsubscribeData,
-  WhiteListData
+  WhiteListData,
 } from './interfaces/Supressions';
+import APIError from './error';
+import APIErrorOptions from './interfaces/APIErrorOptions';
 
 const createOptions = {
   headers: { 'Content-Type': 'application/json' }
 };
-
-class Bounce {
+export class Suppression {
   type: string;
+  constructor(type: SuppressionModels) {
+    this.type = type;
+  }
+}
+export class Bounce extends Suppression {
   address: string;
   code: number;
   error: string;
   created_at: Date;
 
   constructor(data: BounceData) {
-    this.type = 'bounces';
+    super(SuppressionModels.BOUNCES);
     this.address = data.address;
     this.code = +data.code;
     this.error = data.error;
@@ -30,126 +49,173 @@ class Bounce {
   }
 }
 
-class Complaint {
-  type: string;
-  address: any;
+export class Complaint extends Suppression {
+  address: string | undefined;
   created_at: Date;
 
   constructor(data: ComplaintData) {
-    this.type = 'complaints';
+    super(SuppressionModels.COMPLAINTS);
     this.address = data.address;
     this.created_at = new Date(data.created_at);
   }
 }
 
-class Unsubscribe {
-  type: string;
+export class Unsubscribe extends Suppression {
   address: string;
-  tags: any;
+  tags: string[];
   created_at: Date;
 
   constructor(data: UnsubscribeData) {
-    this.type = 'unsubscribes';
+    super(SuppressionModels.UNSUBSCRIBES);
     this.address = data.address;
     this.tags = data.tags;
     this.created_at = new Date(data.created_at);
   }
 }
 
-class WhiteList {
-  type: string;
+export class WhiteList extends Suppression {
   value: string;
   reason: string;
   createdAt: Date;
 
   constructor(data: WhiteListData) {
-    this.type = 'whitelists';
+    super(SuppressionModels.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;
-  models: {
-    bounces: typeof Bounce;
-    complaints: typeof Complaint;
-    unsubscribes: typeof Unsubscribe;
-    whitelists: typeof WhiteList;
-  };
+  request: Request;
+  models: Map<string, any>;
 
   constructor(request: Request) {
     this.request = request;
-    this.models = {
-      bounces: Bounce,
-      complaints: Complaint,
-      unsubscribes: Unsubscribe,
-      whitelists: WhiteList,
-    };
+    this.models = new Map();
+    this.models.set('bounces', Bounce);
+    this.models.set('complaints', Complaint);
+    this.models.set('unsubscribes', Unsubscribe);
+    this.models.set('whitelists', WhiteList);
   }
 
-  _parsePage(id: string, pageUrl: string) {
-    const parsedUrl = url.parse(pageUrl, true);
-    const { query } = parsedUrl;
-
+  _parsePage(id: string, pageUrl: string) : ParsedPage {
+    const parsedUrl = new URL(pageUrl);
+    const { searchParams } = parsedUrl;
     return {
       id,
-      page: query.page,
-      address: query.address,
+      page: searchParams.has('page') ? searchParams.get('page') : undefined,
+      address: searchParams.has('address') ? searchParams.get('address') : undefined,
       url: pageUrl
     };
   }
 
-  _parsePageLinks(response: { body: { paging: any } }) {
-    const pages = Object.entries(response.body.paging);
+  _parsePageLinks(response: SuppressionListResponse): ParsedPagesList {
+    const pages = Object.entries(response.body.paging as PagesList);
     return pages.reduce(
-      (acc: any, [id, pageUrl]: [pageUrl: string, id: string]) => {
+      (acc: PagesListAccumulator, pair: [pageUrl: string, id: string]) => {
+        const id = pair[0];
+        const pageUrl = pair[1];
         acc[id] = this._parsePage(id, pageUrl);
         return acc;
       }, {}
-    );
+    ) as unknown as ParsedPagesList;
   }
 
-  _parseList(response: { body: { items: any, paging: any } }, Model: TModel) {
-    const data = {} as any;
-
-    data.items = response.body.items.map((d: any) => new Model(d));
+  _parseList(
+    response: SuppressionListResponse,
+    Model: {
+      new(data: BounceData | ComplaintData | UnsubscribeData | WhiteListData):
+      Bounce | Complaint | Unsubscribe | WhiteList
+    }
+  ): SuppressionList {
+    const data = {} as SuppressionList;
+    data.items = response.body.items.map((item) => new Model(item));
 
     data.pages = this._parsePageLinks(response);
 
     return data;
   }
 
-  _parseItem(response: { body: any }, Model: TModel) {
-    return new Model(response.body);
+  _parseItem<T extends Suppression>(
+    data : BounceData | ComplaintData | UnsubscribeData | WhiteListData,
+    Model: {
+      new(data: BounceData | ComplaintData | UnsubscribeData | WhiteListData):
+      T
+    }
+  ): T {
+    return new Model(data);
   }
 
-  private createWhiteList(domain: string, data: any) {
+  private createWhiteList(
+    domain: string,
+    data: SuppressionCreationData | SuppressionCreationData[]
+  ): Promise<SuppressionCreationResult> {
+    if (Array.isArray(data)) {
+      throw new APIError({
+        status: 400,
+        statusText: 'Data property should be an object',
+        body: {
+          message: 'Whitelist\'s creation process does not support multiple creations. Data property should be an object'
+        }
+      } as APIErrorOptions);
+    }
     return this.request
-      .postWithFD(urljoin('v3', domain, 'whitelists'), data, createOptions)
-      .then((response: { body: any }) => response.body);
+      .postWithFD(urljoin('v3', domain, 'whitelists'), data)
+      .then(this.prepareResponse);
+  }
+
+  private checkType(type: string) {
+    if (!this.models.has(type)) {
+      throw new APIError({
+        status: 400,
+        statusText: 'Unknown type value',
+        body: { message: 'Type may be only one of [bounces, complaints, unsubscribes, whitelists]' }
+      } as APIErrorOptions);
+    }
+  }
+
+  private prepareResponse(response: SuppressionCreationResponse): SuppressionCreationResult {
+    return {
+      message: response.body.message,
+      type: response.body.type || '',
+      value: response.body.value || '',
+      status: response.status
+    };
   }
 
-  list(domain: string, type: string, query: any) {
-    const model = (this.models as any)[type];
+  list(
+    domain: string,
+    type: string,
+    query?: SuppressionListQuery
+  ): Promise<SuppressionList> {
+    this.checkType(type);
 
+    const model = this.models.get(type);
     return this.request
       .get(urljoin('v3', domain, type), query)
-      .then((response: { body: { items: any, paging: any } }) => this._parseList(response, model));
+      .then((response: SuppressionListResponse) => this._parseList(response, model));
   }
 
-  get(domain: string, type: string, address: string) {
-    const model = (this.models as any)[type];
+  get(
+    domain: string,
+    type: string,
+    address: string
+  ): Promise<Bounce | Complaint | Unsubscribe | WhiteList> {
+    this.checkType(type);
 
+    const model = this.models.get(type);
     return this.request
       .get(urljoin('v3', domain, type, encodeURIComponent(address)))
-      .then((response: { body: any }) => this._parseItem(response, model));
+      .then((response: SuppressionResponse) => this._parseItem<typeof model>(response.body, model));
   }
 
-  create(domain: string, type: string, data: any) {
+  create(
+    domain: string,
+    type: string,
+    data: SuppressionCreationData | SuppressionCreationData[]
+  ): Promise<SuppressionCreationResult> {
+    this.checkType(type);
     // supports adding multiple suppressions by default
     let postData;
     if (type === 'whitelists') {
@@ -164,13 +230,23 @@ export default class SuppressionClient {
 
     return this.request
       .post(urljoin('v3', domain, type), JSON.stringify(postData), createOptions)
-      .then((response: { body: any }) => response.body);
+      .then(this.prepareResponse);
   }
 
-  destroy(domain: string, type: string, address: string) {
+  destroy(
+    domain: string,
+    type: string,
+    address: string
+  ): Promise<SuppressionDestroyResult> {
+    this.checkType(type);
     return this.request
       .delete(urljoin('v3', domain, type, encodeURIComponent(address)))
-      .then((response: { body: any }) => response.body);
+      .then((response: SuppressionDestroyResponse) => ({
+        message: response.body.message,
+        value: response.body.value || '',
+        address: response.body.address || '',
+        status: response.status
+      }));
   }
 }
 

package/lib/webhooks.ts

@@ -4,15 +4,16 @@ import {
   ValidationResponse,
   WebhookList,
   WebhookResponse,
+  WebhooksIds,
   WebhooksQuery
 } from './interfaces/Webhooks';
 import Request from './request';
 
 class Webhook {
   id: string;
-  url: string;
+  url: string | undefined;
 
-  constructor(id: string, url: string) {
+  constructor(id: string, url: string | undefined) {
     this.id = id;
     this.url = url;
   }
@@ -34,7 +35,9 @@ export default class WebhookClient {
       const webhookResponse = response?.body?.webhook;
       let url = webhookResponse?.url;
       if (!url) {
-        url = webhookResponse?.urls && webhookResponse.urls.length ? webhookResponse.urls[0] : null;
+        url = webhookResponse?.urls && webhookResponse.urls.length
+          ? webhookResponse.urls[0]
+          : undefined;
       }
       return new Webhook(id, url);
     };
@@ -50,7 +53,7 @@ export default class WebhookClient {
       .then(this._parseWebhookList);
   }
 
-  get(domain: string, id: string): Promise<Webhook> {
+  get(domain: string, id: WebhooksIds): Promise<Webhook> {
     return this.request.get(urljoin('/v3/domains', domain, 'webhooks', id))
       .then(this._parseWebhookWithID(id));
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mailgun.js",
-  "version": "5.0.0",
+  "version": "5.0.3",
   "main": "dist/mailgun.node.js",
   "browser": "dist/mailgun.web.js",
   "types": "dist/mailgun.js.d.ts",
@@ -38,8 +38,7 @@
     "bluebird": "^3.7.2",
     "ky": "^0.25.1",
     "ky-universal": "^0.8.2",
-    "url": "^0.11.0",
-    "url-join": "0.0.1",
+    "url-join": "^4.0.1",
     "web-streams-polyfill": "^3.0.1",
     "webpack-merge": "^5.4.0"
   },
@@ -51,7 +50,7 @@
     "@types/base-64": "^1.0.0",
     "@types/chai": "^4.2.14",
     "@types/mocha": "^8.2.0",
-    "@types/url-join": "^4.0.0",
+    "@types/url-join": "^4.0.1",
     "@typescript-eslint/eslint-plugin": "^4.26.0",
     "@typescript-eslint/parser": "^4.26.0",
     "babel-loader": "^8.1.0",