mailgun.js 4.1.1 → 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 v4.1.0 */
+/*! 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/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/package.json

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

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 () {