mailgun.js 3.5.9 → 3.7.1

package/.eslintrc

@@ -7,20 +7,17 @@
     "mocha": true
   },
   "extends": [
-    "airbnb-base",
-    "plugin:@typescript-eslint/eslint-recommended",
-    "plugin:@typescript-eslint/recommended"
+    "airbnb-base"
   ],
-  "plugins": [
-    "eslint-plugin-tsdoc",
-    "@typescript-eslint"
-  ],
-  "parser": "@typescript-eslint/parser",
   "parserOptions": {
     "ecmaVersion": 12
   },
   "settings": {
-    "import/resolver": "webpack"
+      "import/resolver": {
+        "node": {
+          "extensions": [".js", ".jsx", ".ts", ".tsx"]
+        }
+      }
   },
   "ignorePatterns": ["docs/assets/js/*", "dist/**"],
   "rules": {
@@ -33,6 +30,25 @@
     "class-methods-use-this": 0,
     "prefer-destructuring": 0,
     "import/extensions": 0,
-    "lines-between-class-members": ["error", "always", { "exceptAfterSingleLine": true }]
-  }
+    "lines-between-class-members": ["error", "always", { "exceptAfterSingleLine": true }],
+    "import/no-extraneous-dependencies" :["error", {"devDependencies": true, "optionalDependencies": false, "peerDependencies": false}]
+  },
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx"],
+      "extends": [
+        "plugin:@typescript-eslint/eslint-recommended",
+        "plugin:@typescript-eslint/recommended"
+      ],
+      "parser": "@typescript-eslint/parser",
+      "rules": {
+        "import/extensions": 0
+        // "import/no-extraneous-dependencies" :["error", {"devDependencies": true, "optionalDependencies": false, "peerDependencies": false}]
+      },
+      "plugins": [
+        "eslint-plugin-tsdoc",
+        "@typescript-eslint"
+      ]
+    }
+  ]
 }

package/CHANGELOG.md

@@ -2,6 +2,36 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [3.7.1](https://github.com/mailgun/mailgun-js/compare/v3.7.0...v3.7.1) (2021-10-28)
+
+
+### Bug Fixes
+
+* Fix TS2345 error ([e20b8d7](https://github.com/mailgun/mailgun-js/commits/e20b8d7fd03cc94fd49a1c82b4936d5b115024a3))
+
+## [3.7.0](https://github.com/mailgun/mailgun-js/compare/v3.6.1...v3.7.0) (2021-10-20)
+
+
+### Features
+
+* Fix linter errors ([126ba03](https://github.com/mailgun/mailgun-js/commits/126ba039bccfbdb257ddde7d17a58790e4cd30a3))
+
+### [3.6.1](https://github.com/mailgun/mailgun-js/compare/v3.6.0...v3.6.1) (2021-10-18)
+
+
+### Other changes
+
+* Update eslint dependency. Regenerate package-lock file ([0e1fef6](https://github.com/mailgun/mailgun-js/commits/0e1fef683b86e05852a04c6e2f6199db0e39ff22))
+* Update mocha to v9 ([768ed1f](https://github.com/mailgun/mailgun-js/commits/768ed1f5896c2bbb7fff59f4fbb68d425ea5a594))
+
+## [3.6.0](https://github.com/mailgun/mailgun-js/compare/v3.5.9...v3.6.0) (2021-10-13)
+
+
+### Features
+
+* Split the distro for different targets ([1a55085](https://github.com/mailgun/mailgun-js/commits/1a550854765c7cdbb68b13b32c1f1392003abf30))
+* Update commitlint rules ([262ce0c](https://github.com/mailgun/mailgun-js/commits/262ce0ccd594bbcd97c9aa9ba5f11ad6ce6fc8c5))
+
 ### [3.5.9](https://github.com/mailgun/mailgun-js/compare/v3.5.8...v3.5.9) (2021-09-16)
 
 

package/commitlint.config.js

@@ -1,8 +1,7 @@
 module.exports = {
   extends: ['@commitlint/config-conventional'],
   rules: {
-    'type-enum': [2, 'always', ['Breaking', 'Feature', 'Fix', 'Other']],
-    'type-case': [2, 'always', 'pascal-case'],
+    'type-enum': [2, 'always', ['breaking', 'feature', 'fix', 'other']],
     'subject-case': [2, 'always', 'sentence-case']
   },
 };

package/dist/index.d.ts

@@ -1,9 +1,9 @@
 import Client from './lib/client';
+import { InputFormData } from './lib/interfaces/IFormData';
 import Options from './lib/interfaces/Options';
-import IFormData from './lib/interfaces/IFormData';
 declare class Mailgun {
     private formData;
-    constructor(FormData: new (...args: any[]) => IFormData);
+    constructor(FormData: InputFormData);
     client(options: Options): Client;
 }
 export = Mailgun;

package/dist/lib/client.d.ts

@@ -12,7 +12,7 @@ import ParseClient from './parse';
 import IpsClient from './ips';
 import IpPoolsClient from './ip-pools';
 import ListsClient from './lists';
-import IFormData from './interfaces/IFormData';
+import { InputFormData } from './interfaces/IFormData';
 export default class Client {
     private request;
     domains: DomainClient;
@@ -28,5 +28,5 @@ export default class Client {
     ips: IpsClient;
     ip_pools: IpPoolsClient;
     lists: ListsClient;
-    constructor(options: Options, formData: new (...args: any[]) => IFormData);
+    constructor(options: Options, formData: InputFormData);
 }

package/dist/lib/events.d.ts

@@ -1,29 +1,13 @@
-declare const MgRequest: any;
+import { EventsList, EventsPage, EventsResponse, PagesList } from './interfaces/Events';
+import Request from './request';
 export default class EventClient {
-    request: typeof MgRequest;
-    constructor(request: typeof MgRequest);
+    request: Request;
+    constructor(request: Request);
     _parsePageNumber(url: string): string;
-    _parsePage(id: string, url: string): {
-        id: string;
-        number: string;
-        url: string;
-    };
-    _parsePageLinks(response: {
-        body: {
-            paging: any;
-        };
-    }): any;
-    _parseEventList(response: {
-        body: {
-            items: any;
-            paging: any;
-        };
-    }): {
-        items: any;
-        pages: any;
-    };
+    _parsePage(id: string, url: string): EventsPage;
+    _parsePageLinks(response: EventsResponse): PagesList;
+    _parseEventList(response: EventsResponse): EventsList;
     get(domain: string, query: {
-        page: any;
-    }): any;
+        page: string;
+    }): Promise<EventsList>;
 }
-export {};

package/dist/lib/interfaces/APIErrorOptions.d.ts

@@ -1,4 +1,4 @@
-export default interface APIErrorOptions {
+interface APIErrorOptions {
     headers: {
         [key: string]: any;
     };
@@ -8,3 +8,4 @@ export default interface APIErrorOptions {
     url: string;
     statusText: string;
 }
+export default APIErrorOptions;

package/dist/lib/interfaces/ApiResponse.d.ts

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

package/dist/lib/interfaces/Events.d.ts

@@ -0,0 +1,24 @@
+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/dist/lib/interfaces/IFormData.d.ts

@@ -1,15 +1,7 @@
-interface Headers {
+import NodeFormData from 'form-data';
+export interface IFormDataOptions {
     [key: string]: any;
 }
-interface AppendOptions {
-    header?: string | Headers;
-    knownLength?: number;
-    filename?: string;
-    filepath?: string;
-    contentType?: string;
+export interface InputFormData {
+    new (options?: HTMLFormElement | IFormDataOptions): NodeFormData | FormData;
 }
-export default abstract class IFormData {
-    constructor();
-    abstract append(key: string, value: any, options?: AppendOptions | string): void;
-}
-export {};

package/dist/lib/interfaces/IpPools.d.ts

@@ -5,3 +5,15 @@ export interface IpPool {
     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/dist/lib/interfaces/Options.d.ts

@@ -1,7 +1,8 @@
-export default interface Options {
+interface Options {
     username: string;
     key: string;
     url?: string;
     public_key?: string;
     timeout?: number;
 }
+export default Options;

package/dist/lib/interfaces/RequestOptions.d.ts

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

package/dist/lib/interfaces/StatsOptions.d.ts

@@ -1,4 +1,4 @@
-export default interface StatsOptions {
+interface StatsOptions {
     start: string | Date;
     end: string | Date;
     resolution: string;
@@ -11,3 +11,4 @@ export default interface StatsOptions {
         };
     }[];
 }
+export default StatsOptions;

package/dist/lib/interfaces/mailListMembers.d.ts

@@ -1,4 +1,10 @@
 import { MailingList } from './lists';
+export interface MailListMember {
+    address: string;
+    name: string;
+    subscribed: boolean;
+    vars: string | any;
+}
 export interface MailListMembersQuery {
     subscribed?: 'yes' | 'no';
     limit?: number;
@@ -25,12 +31,6 @@ export interface CreateUpdateMailListMembersReq {
     subscribed?: 'yes' | 'no' | boolean;
     upsert?: 'yes' | 'no';
 }
-export interface MailListMember {
-    address: string;
-    name: string;
-    subscribed: boolean;
-    vars: string | any;
-}
 export interface DeletedMember {
     member: {
         address: string;

package/dist/lib/ip-pools.d.ts

@@ -1,24 +1,21 @@
-declare const MgRequest: any;
-import { IpPool } from "./interfaces/IpPools";
+import Request from './request';
+import { IpPool, IpPoolUpdateData } from './interfaces/IpPools';
 export default class IpPoolsClient {
-    request: typeof MgRequest;
-    constructor(request: typeof MgRequest);
-    list(query: any): IpPool[];
+    request: Request;
+    constructor(request: Request);
+    list(query: any): Promise<IpPool[]>;
     create(data: {
         name: string;
         description?: string;
         ips?: string[];
-    }): any;
-    update(poolId: string, data: {
-        name: string;
-        description: string;
-        add_ip: string;
-        remove_ip: string;
-    }): any;
+    }): Promise<{
+        message: string;
+        pool_id: string;
+    }>;
+    update(poolId: string, data: IpPoolUpdateData): Promise<any>;
     delete(poolId: string, data: {
         id: string;
         pool_id: string;
-    }): any;
+    }): Promise<any>;
     private parseIpPoolsResponse;
 }
-export {};

package/dist/lib/ips.d.ts

@@ -1,9 +1,9 @@
-declare const MgRequest: any;
+import MgRequest from './request';
+import { IpData, IpsListResponseBody } from './interfaces/Ips';
 export default class IpsClient {
-    request: typeof MgRequest;
-    constructor(request: typeof MgRequest);
-    list(query: any): any;
-    get(ip: string): any;
+    request: MgRequest;
+    constructor(request: MgRequest);
+    list(query: any): Promise<IpsListResponseBody | IpData>;
+    get(ip: string): Promise<IpsListResponseBody | IpData>;
     private parseIpsResponse;
 }
-export {};

package/dist/lib/messages.d.ts

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

package/dist/lib/request.d.ts

@@ -1,5 +1,6 @@
+import NodeFormData from 'form-data';
 import RequestOptions from './interfaces/RequestOptions';
-import IFormData from './interfaces/IFormData';
+import { InputFormData } from './interfaces/IFormData';
 import APIResponse from './interfaces/ApiResponse';
 declare class Request {
     private username;
@@ -8,7 +9,7 @@ declare class Request {
     private timeout;
     private headers;
     private formData;
-    constructor(options: RequestOptions, formData: new () => IFormData);
+    constructor(options: RequestOptions, formData: InputFormData);
     request(method: string, url: string, inputOptions?: any): Promise<APIResponse>;
     query(method: string, url: string, query: any, options?: any): Promise<APIResponse>;
     command(method: string, url: string, data: any, options?: any): Promise<APIResponse>;
@@ -18,7 +19,7 @@ declare class Request {
     post(url: string, data: any, options?: any): Promise<APIResponse>;
     postWithFD(url: string, data: any): Promise<APIResponse>;
     putWithFD(url: string, data: any): Promise<APIResponse>;
-    createFormData(data: any): IFormData;
+    createFormData(data: any): NodeFormData | FormData;
     put(url: string, data: any, options?: any): Promise<APIResponse>;
     patch(url: string, data: any, options?: any): Promise<APIResponse>;
     delete(url: string, data?: any, options?: any): Promise<APIResponse>;

package/dist/lib/suppressions.d.ts

@@ -1,6 +1,5 @@
 import Request from './request';
 import { BounceData, ComplaintData, UnsubscribeData } from './interfaces/Supressions';
-declare type TModel = typeof Bounce | typeof Complaint | typeof Unsubscribe;
 declare class Bounce {
     type: string;
     address: string;
@@ -22,6 +21,7 @@ declare class Unsubscribe {
     created_at: Date;
     constructor(data: UnsubscribeData);
 }
+declare type TModel = typeof Bounce | typeof Complaint | typeof Unsubscribe;
 export default class SuppressionClient {
     request: any;
     models: {