mailgun.js 5.0.0 → 5.0.1

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

@@ -4,4 +4,4 @@
 
 /*! https://mths.be/punycode v1.3.2 by @mathias */
 
-/*! mailgun.js v4.2.3 */
+/*! mailgun.js v5.0.0 */

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/interfaces/Supressions.ts

@@ -23,3 +23,64 @@ export interface WhiteListData {
   reason: string;
   createdAt: string | Date;
 }
+
+export interface IBounce {
+  type: string;
+  address: string;
+  code: number;
+  error: string;
+  created_at: Date;
+}
+export interface IComplaint {
+  type: string;
+  address: any;
+  created_at: Date;
+}
+export interface IUnsubscribe {
+  type: string;
+  address: string;
+  tags: any;
+  created_at: Date;
+}
+export interface IWhiteList {
+  type: string;
+  value: string;
+  reason: string;
+  createdAt: Date;
+}
+
+export interface ParsedPage {
+  id: string;
+  page: string | undefined;
+  address: string | undefined;
+  url: string
+}
+export interface ParsedPagesList {
+  previous: ParsedPage;
+  first: ParsedPage;
+  last: ParsedPage;
+  next: ParsedPage;
+}
+
+export interface SuppressionList {
+  items: IBounce[] | IComplaint[] | IUnsubscribe[] | IWhiteList[];
+  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;
+}

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/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

@@ -6,6 +6,16 @@ import Request from './request';
 import {
   BounceData,
   ComplaintData,
+  IBounce,
+  IComplaint,
+  IUnsubscribe,
+  IWhiteList,
+  PagesList,
+  PagesListAccumulator,
+  ParsedPage,
+  ParsedPagesList,
+  SuppressionList,
+  SuppressionModels,
   UnsubscribeData,
   WhiteListData
 } from './interfaces/Supressions';
@@ -14,7 +24,7 @@ const createOptions = {
   headers: { 'Content-Type': 'application/json' }
 };
 
-class Bounce {
+class Bounce implements IBounce {
   type: string;
   address: string;
   code: number;
@@ -30,7 +40,7 @@ class Bounce {
   }
 }
 
-class Complaint {
+class Complaint implements IComplaint {
   type: string;
   address: any;
   created_at: Date;
@@ -42,7 +52,7 @@ class Complaint {
   }
 }
 
-class Unsubscribe {
+class Unsubscribe implements IUnsubscribe {
   type: string;
   address: string;
   tags: any;
@@ -56,7 +66,7 @@ class Unsubscribe {
   }
 }
 
-class WhiteList {
+class WhiteList implements IWhiteList {
   type: string;
   value: string;
   reason: string;
@@ -91,30 +101,34 @@ export default class SuppressionClient {
     };
   }
 
-  _parsePage(id: string, pageUrl: string) {
+  _parsePage(id: string, pageUrl: string) : ParsedPage {
     const parsedUrl = url.parse(pageUrl, true);
     const { query } = parsedUrl;
 
     return {
       id,
-      page: query.page,
-      address: query.address,
+      page: query.page as string,
+      address: query.address as string,
       url: pageUrl
     };
   }
 
-  _parsePageLinks(response: { body: { paging: any } }) {
-    const pages = Object.entries(response.body.paging);
+  _parsePageLinks(response: { body: { paging: any } }): 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;
+  _parseList(
+    response: { body: { items: any, paging: any } }, Model: TModel
+  ): SuppressionList {
+    const data = {} as SuppressionList;
 
     data.items = response.body.items.map((d: any) => new Model(d));
 
@@ -123,7 +137,10 @@ export default class SuppressionClient {
     return data;
   }
 
-  _parseItem(response: { body: any }, Model: TModel) {
+  _parseItem(
+    response: { body: any },
+    Model: TModel
+  ): IBounce | IComplaint | IUnsubscribe | IWhiteList {
     return new Model(response.body);
   }
 
@@ -133,16 +150,20 @@ export default class SuppressionClient {
       .then((response: { body: any }) => response.body);
   }
 
-  list(domain: string, type: string, query: any) {
-    const model = (this.models as any)[type];
+  list(domain: string, type: SuppressionModels, query: any) : Promise<SuppressionList> {
+    const model = (this.models)[type];
 
     return this.request
       .get(urljoin('v3', domain, type), query)
       .then((response: { body: { items: any, paging: any } }) => this._parseList(response, model));
   }
 
-  get(domain: string, type: string, address: string) {
-    const model = (this.models as any)[type];
+  get(
+    domain: string,
+    type: SuppressionModels,
+    address: string
+  ): Promise<IBounce | IComplaint | IUnsubscribe | IWhiteList> {
+    const model = (this.models)[type];
 
     return this.request
       .get(urljoin('v3', domain, type, encodeURIComponent(address)))

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.1",
   "main": "dist/mailgun.node.js",
   "browser": "dist/mailgun.web.js",
   "types": "dist/mailgun.js.d.ts",

package/tsconfig.json

@@ -10,8 +10,8 @@
 
     "allowSyntheticDefaultImports": true,
     "incremental": true,
-    "skipLibCheck": true
-    // "strict": true,
+    "skipLibCheck": true,
+    "strict": true
   },
   "typedocOptions": {
     "out": "docs",