mailgun.js 4.2.1 → 5.0.0

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

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

package/dts-bundle.js

@@ -0,0 +1,8 @@
+const dts = require('dts-bundle');
+
+dts.bundle({
+  name: 'mailgun.js',
+  main: 'dist/lib/index.d.ts',
+  out: '../mailgun.js.d.ts',
+  removeSource: true
+});

package/examples/addresses.js

@@ -1,5 +1,5 @@
 /* eslint-disable no-console */
-const mailgun = require('../index');
+const mailgun = require('../lib/index');
 
 const mg = mailgun.client({
   username: 'api',

package/examples/list-domains.js

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

package/{index.ts → lib/index.ts}

@@ -1,6 +1,6 @@
-import Client from './lib/client';
-import { InputFormData } from './lib/interfaces/IFormData';
-import Options from './lib/interfaces/Options';
+import Client from './client';
+import { InputFormData } from './interfaces/IFormData';
+import Options from './interfaces/Options';
 
 class Mailgun {
   private formData: InputFormData

package/lib/request.ts

@@ -111,7 +111,7 @@ class Request {
       body: await response?.json(),
       status: response?.status
     };
-    console.log('res ------------->', res);
+
     return res;
   }
 

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "mailgun.js",
-  "version": "4.2.1",
+  "version": "5.0.0",
   "main": "dist/mailgun.node.js",
   "browser": "dist/mailgun.web.js",
-  "types": "dist/index.d.ts",
+  "types": "dist/mailgun.js.d.ts",
   "author": "Mailgun",
   "license": "MIT",
   "keywords": [
@@ -19,15 +19,19 @@
   },
   "homepage": "https://github.com/mailgun/mailgun.js#readme",
   "scripts": {
-    "build": "webpack --config ./webpack/webpack.dev.config.js --progress --color",
-    "build:release": "webpack --config ./webpack/webpack.release.config.js --progress --color",
+    "build": "webpack --config ./webpack/webpack.dev.config.js --progress --color && npm run build-dts",
+    "build:release": "webpack --config ./webpack/webpack.release.config.js --progress --color && npm run build-dts",
     "start": "webpack --watch --config ./webpack/webpack.dev.config.js --progress --color",
     "release": "standard-version -a",
     "test": "multi='dot=- xunit=./results.xml' nyc 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",
     "docs": "typedoc --tsconfig ./tsconfig.json",
     "lint": "eslint . && eslint . --ext .ts",
-    "prepare": "husky install"
+    "prepare": "husky install",
+    "build-dts": "node dts-bundle && rm -rf dist/lib"
+  },
+  "typescript": {
+    "definition": "dist/mailgun.js.d.ts"
   },
   "dependencies": {
     "base-64": "^1.0.0",
@@ -52,6 +56,7 @@
     "@typescript-eslint/parser": "^4.26.0",
     "babel-loader": "^8.1.0",
     "chai": "^4.2.0",
+    "dts-bundle": "^0.7.3",
     "eslint": "^7.32.0",
     "eslint-config-airbnb-base": "^14.2.0",
     "eslint-import-resolver-webpack": "^0.13.1",
@@ -106,7 +111,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/webpack.release.config.js --progress --color && git add -A dist",
+      "prerelease": "npm test && npm run build:release && git add -A dist",
       "posttag": "git push && git push --tags && rm -rf build"
     }
   }

package/webpack/webpack.common.config.js

@@ -9,8 +9,8 @@ const commonConfig = {
   mode: 'development',
   context: SRC_DIR,
   entry: {
-    mailgun: path.join(SRC_DIR, 'index.ts'),
-    'mailgun.min': path.join(SRC_DIR, 'index.ts')
+    mailgun: path.join(SRC_DIR, 'lib/index.ts'),
+    'mailgun.min': path.join(SRC_DIR, 'lib/index.ts')
   },
   output: {
     path: path.join(SRC_DIR, outputDir),

package/dist/index.d.ts

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

package/dist/lib/client.d.ts

@@ -1,28 +0,0 @@
-import Options from './interfaces/Options';
-import DomainClient from './domains';
-import EventClient from './events';
-import StatsClient from './stats';
-import SuppressionClient from './suppressions';
-import WebhookClient from './webhooks';
-import MessagesClient from './messages';
-import RoutesClient from './routes';
-import ValidateClient from './validate';
-import IpsClient from './ips';
-import IpPoolsClient from './ip-pools';
-import ListsClient from './lists';
-import { InputFormData } from './interfaces/IFormData';
-export default class Client {
-    private request;
-    domains: DomainClient;
-    webhooks: WebhookClient;
-    events: EventClient;
-    stats: StatsClient;
-    suppressions: SuppressionClient;
-    messages: MessagesClient;
-    routes: RoutesClient;
-    validate: ValidateClient;
-    ips: IpsClient;
-    ip_pools: IpPoolsClient;
-    lists: ListsClient;
-    constructor(options: Options, formData: InputFormData);
-}

package/dist/lib/domains.d.ts

@@ -1,53 +0,0 @@
-import { DomainsQuery, DomainInfo, DomainShortData, DNSRecord, ConnectionSettings, UpdatedConnectionSettings, DKIMAuthorityInfo, UpdatedDKIMAuthority, DKIMSelectorInfo, UpdatedDKIMSelectorResponse, WebPrefixInfo, UpdatedWebPrefixResponse, ReplacementForPool, MessageResponse } from './interfaces/Domains';
-import APIResponse from './interfaces/ApiResponse';
-import Request from './request';
-import { DomainTrackingData, OpenTrackingInfo, ClickTrackingInfo, UnsubscribeTrackingInfo, UpdatedOpenTracking } from './interfaces/DomainTracking';
-import { IDomainCredentials } from './interfaces/DomainCredentials';
-import { IDomainTemplatesClient } from './interfaces/DomainTemplates';
-import DomainCredentialsClient from './domainsCredentials';
-import DomainTemplatesClient from './domainsTemplates';
-import { IDomainTagsClient } from './interfaces/DomainTags';
-import DomainTagsClient from './domainsTags';
-export declare class Domain {
-    name: string;
-    require_tls: boolean;
-    skip_verification: boolean;
-    state: string;
-    wildcard: boolean;
-    spam_action: string;
-    created_at: string;
-    smtp_password: string;
-    smtp_login: string;
-    type: string;
-    receiving_dns_records: DNSRecord[] | null;
-    sending_dns_records: DNSRecord[] | null;
-    constructor(data: DomainShortData, receiving?: DNSRecord[] | null, sending?: DNSRecord[] | null);
-}
-export default class DomainClient {
-    request: Request;
-    domainCredentials: IDomainCredentials;
-    domainTemplates: IDomainTemplatesClient;
-    domainTags: IDomainTagsClient;
-    constructor(request: Request, domainCredentialsClient: DomainCredentialsClient, domainTemplatesClient: DomainTemplatesClient, domainTagsClient: DomainTagsClient);
-    private _parseMessage;
-    private _parseDomainList;
-    private _parseDomain;
-    private _parseTrackingSettings;
-    private _parseTrackingUpdate;
-    list(query?: DomainsQuery): Promise<Domain[]>;
-    get(domain: string): Promise<Domain>;
-    create(data: DomainInfo): Promise<Domain>;
-    destroy(domain: string): Promise<MessageResponse>;
-    getConnection(domain: string): Promise<ConnectionSettings>;
-    updateConnection(domain: string, data: ConnectionSettings): Promise<UpdatedConnectionSettings>;
-    getTracking(domain: string): Promise<DomainTrackingData>;
-    updateTracking(domain: string, type: string, data: OpenTrackingInfo | ClickTrackingInfo | UnsubscribeTrackingInfo): Promise<UpdatedOpenTracking>;
-    getIps(domain: string): Promise<string[]>;
-    assignIp(domain: string, ip: string): Promise<APIResponse>;
-    deleteIp(domain: string, ip: string): Promise<APIResponse>;
-    linkIpPool(domain: string, pool_id: string): Promise<APIResponse>;
-    unlinkIpPoll(domain: string, replacement: ReplacementForPool): Promise<APIResponse>;
-    updateDKIMAuthority(domain: string, data: DKIMAuthorityInfo): Promise<UpdatedDKIMAuthority>;
-    updateDKIMSelector(domain: string, data: DKIMSelectorInfo): Promise<UpdatedDKIMSelectorResponse>;
-    updateWebPrefix(domain: string, data: WebPrefixInfo): Promise<UpdatedWebPrefixResponse>;
-}

package/dist/lib/domainsCredentials.d.ts

@@ -1,14 +0,0 @@
-import Request from './request';
-import { DomainCredentials, DomainCredentialsList, DomainCredentialsQuery, DomainCredentialsResult, IDomainCredentials, UpdateDomainCredentialsData } from './interfaces/DomainCredentials';
-export default class DomainCredentialsClient implements IDomainCredentials {
-    baseRoute: string;
-    request: Request;
-    constructor(request: Request);
-    private _parseDomainCredentialsList;
-    private _parseMessageResponse;
-    private _parseDeletedResponse;
-    list(domain: string, query?: DomainCredentialsQuery): Promise<DomainCredentialsList>;
-    create(domain: string, data: DomainCredentials): Promise<DomainCredentialsResult>;
-    update(domain: string, credentialsLogin: string, data: UpdateDomainCredentialsData): Promise<DomainCredentialsResult>;
-    destroy(domain: string, credentialsLogin: string): Promise<DomainCredentialsResult>;
-}

package/dist/lib/domainsTags.d.ts

@@ -1,34 +0,0 @@
-import Request from './request';
-import { DomainTagCountriesAggregation, DomainTagDevicesAggregation, DomainTagProvidersAggregation, DomainTagsItem, DomainTagsItemInfo, DomainTagsList, DomainTagsMessageRes, DomainTagsQuery, DomainTagsStatisticQuery, DomainTagStatAPIResponse, DomainTagStatisticItem, DomainTagStatisticResult, IDomainTagsClient, Resolution } from './interfaces/DomainTags';
-export declare class DomainTag implements DomainTagsItem {
-    tag: string;
-    description: string;
-    'first-seen': Date;
-    'last-seen': Date;
-    constructor(tagInfo: DomainTagsItemInfo);
-}
-export declare class DomainTagStatistic implements DomainTagStatisticResult {
-    tag: string;
-    description: string;
-    start: Date;
-    end: Date;
-    resolution: Resolution;
-    stats: DomainTagStatisticItem[];
-    constructor(tagStatisticInfo: DomainTagStatAPIResponse);
-}
-export default class DomainTagsClient implements IDomainTagsClient {
-    baseRoute: string;
-    request: Request;
-    constructor(request: Request);
-    private _parsePageLinks;
-    private _parseDomainTagsList;
-    private _parseTagStatistic;
-    list(domain: string, query?: DomainTagsQuery): Promise<DomainTagsList>;
-    get(domain: string, tag: string): Promise<DomainTagsItem>;
-    update(domain: string, tag: string, description: string): Promise<DomainTagsMessageRes>;
-    destroy(domain: string, tag: string): Promise<DomainTagsMessageRes>;
-    statistic(domain: string, tag: string, query: DomainTagsStatisticQuery): Promise<DomainTagStatistic>;
-    countries(domain: string, tag: string): Promise<DomainTagCountriesAggregation>;
-    providers(domain: string, tag: string): Promise<DomainTagProvidersAggregation>;
-    devices(domain: string, tag: string): Promise<DomainTagDevicesAggregation>;
-}

package/dist/lib/domainsTemplates.d.ts

@@ -1,35 +0,0 @@
-import Request from './request';
-import { CreateDomainTemplateVersionResult, DomainTemplate, DomainTemplateData, DomainTemplatesQuery, DomainTemplateUpdateData, DomainTemplateUpdateVersionData, DomainTemplateVersionData, IDomainTemplatesClient, ListDomainTemplatesResult, ListDomainTemplateVersionsResult, MutateDomainTemplateVersionResult, NotificationResult, ShortTemplateVersion, TemplateQuery, TemplateVersion, UpdateOrDeleteDomainTemplateResult } from './interfaces/DomainTemplates';
-export declare class DomainTemplateItem implements DomainTemplate {
-    name: string;
-    description: string;
-    createdAt: Date | '';
-    createdBy: string;
-    id: string;
-    version?: TemplateVersion;
-    versions?: ShortTemplateVersion[];
-    constructor(domainTemplateFromAPI: DomainTemplate);
-}
-export default class DomainTemplatesClient implements IDomainTemplatesClient {
-    baseRoute: string;
-    request: Request;
-    constructor(request: Request);
-    private parseCreationResponse;
-    private parseCreationVersionResponse;
-    private parseMutationResponse;
-    private parseNotificationResponse;
-    private parseMutateTemplateVersionResponse;
-    private parseList;
-    private parseListTemplateVersions;
-    list(domain: string, query?: DomainTemplatesQuery): Promise<ListDomainTemplatesResult>;
-    get(domain: string, templateName: string, query?: TemplateQuery): Promise<DomainTemplateItem>;
-    create(domain: string, data: DomainTemplateData): Promise<DomainTemplateItem>;
-    update(domain: string, templateName: string, data: DomainTemplateUpdateData): Promise<UpdateOrDeleteDomainTemplateResult>;
-    destroy(domain: string, templateName: string): Promise<UpdateOrDeleteDomainTemplateResult>;
-    destroyAll(domain: string): Promise<NotificationResult>;
-    createVersion(domain: string, templateName: string, data: DomainTemplateVersionData): Promise<CreateDomainTemplateVersionResult>;
-    getVersion(domain: string, templateName: string, tag: string): Promise<DomainTemplateItem>;
-    updateVersion(domain: string, templateName: string, tag: string, data: DomainTemplateUpdateVersionData): Promise<MutateDomainTemplateVersionResult>;
-    destroyVersion(domain: string, templateName: string, tag: string): Promise<MutateDomainTemplateVersionResult>;
-    listVersions(domain: string, templateName: string, query?: DomainTemplatesQuery): Promise<ListDomainTemplateVersionsResult>;
-}

package/dist/lib/error.d.ts

@@ -1,7 +0,0 @@
-import APIErrorOptions from './interfaces/APIErrorOptions';
-export default class APIError extends Error {
-    status: number | string;
-    stack: string;
-    details: string;
-    constructor({ status, statusText, message, body }: APIErrorOptions);
-}

package/dist/lib/events.d.ts

@@ -1,13 +0,0 @@
-import { EventsList, EventsPage, EventsResponse, ParsedPagesList } from './interfaces/Events';
-import Request from './request';
-export default class EventClient {
-    request: Request;
-    constructor(request: Request);
-    _parsePageNumber(url: string): string;
-    _parsePage(id: string, url: string): EventsPage;
-    _parsePageLinks(response: EventsResponse): ParsedPagesList;
-    _parseEventList(response: EventsResponse): EventsList;
-    get(domain: string, query?: {
-        page: string;
-    }): Promise<EventsList>;
-}

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

@@ -1,11 +0,0 @@
-interface APIErrorOptions {
-    headers: {
-        [key: string]: any;
-    };
-    status: number | string;
-    message: string;
-    body: any;
-    url: string;
-    statusText: string;
-}
-export default APIErrorOptions;

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

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

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

@@ -1,52 +0,0 @@
-export interface DomainCredentialsQuery {
-    limit: number;
-    skip: number;
-}
-export interface DomainCredentials {
-    login: string;
-    password: string;
-}
-export interface DomainCredentialsItem {
-    created_at: string;
-    login: string;
-    mailbox: string;
-    size_bytes: number | null;
-}
-export interface DomainCredentialsResponseData {
-    status: number;
-    body: {
-        items: DomainCredentialsItem[];
-        total_count: number;
-    };
-}
-export interface DomainCredentialsList {
-    items: DomainCredentialsItem[];
-    totalCount: number;
-}
-export interface DomainCredentialsResult {
-    status: number;
-    message: string;
-    spec?: string;
-}
-export interface CreatedUpdatedDomainCredentialsResponse {
-    status: number;
-    body: {
-        message: string;
-    };
-}
-export interface DeletedDomainCredentialsResponse {
-    status: number;
-    body: {
-        message: string;
-        spec: string;
-    };
-}
-export interface UpdateDomainCredentialsData {
-    password: string;
-}
-export interface IDomainCredentials {
-    list(domain: string, query: DomainCredentialsQuery): Promise<DomainCredentialsList>;
-    create(domain: string, data: DomainCredentials): Promise<DomainCredentialsResult>;
-    update(domain: string, credentialsLogin: string, data: UpdateDomainCredentialsData): Promise<DomainCredentialsResult>;
-    destroy(domain: string, credentialsLogin: string): Promise<DomainCredentialsResult>;
-}

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

@@ -1,228 +0,0 @@
-import { DomainTagStatistic } from '../domainsTags';
-export declare enum Resolution {
-    HOUR = "hour",
-    DAY = "day",
-    MONTH = "month"
-}
-export interface DomainTagsQuery {
-    limit: number;
-}
-export interface DomainTagsStatisticQuery {
-    event: string;
-    start?: number;
-    end?: number;
-    resolution?: Resolution;
-    duration?: string;
-}
-export interface DomainTagsItemInfo {
-    tag: string;
-    description: string;
-    'first-seen': string;
-    'last-seen': string;
-}
-export interface DomainTagsItem {
-    tag: string;
-    description: string;
-    'first-seen': Date;
-    'last-seen': Date;
-}
-export interface PagesList {
-    previous: string;
-    first: string;
-    last: string;
-    next: string;
-}
-export interface ParsedPage {
-    id: string;
-    url: string;
-}
-export interface ParsedPagesList {
-    previous: ParsedPage;
-    first: ParsedPage;
-    last: ParsedPage;
-    next: ParsedPage;
-}
-export interface TagsPage {
-    id: string;
-    url: string;
-}
-export interface PagesListAccumulator {
-    [index: string]: TagsPage;
-}
-export interface DomainTagsResponseData {
-    status: number;
-    body: {
-        items: DomainTagsItemInfo[];
-        paging: PagesList;
-    };
-}
-export interface DomainTagsList {
-    items: DomainTagsItem[];
-    pages: ParsedPagesList;
-}
-export interface DomainTagsMessageRes {
-    message: string;
-    status?: number;
-}
-export interface DomainTagAPIResponseStatsItem {
-    time: string;
-    accepted?: {
-        incoming: number;
-        outgoing: number;
-        total: number;
-    };
-    delivered?: {
-        smtp: number;
-        http: number;
-        optimized: number;
-        total: number;
-    };
-    opened?: {
-        total: number;
-    };
-    failed?: {
-        temporary: {
-            espblock: number;
-            total: number;
-        };
-        permanent: {
-            'suppress-bounce': number;
-            'suppress-unsubscribe': number;
-            'suppress-complaint': number;
-            bounce: number;
-            'delayed-bounce': number;
-            webhook: number;
-            optimized: number;
-            total: number;
-        };
-    };
-    clicked?: {
-        total: number;
-    };
-    unsubscribed?: {
-        total: number;
-    };
-    complained?: {
-        total: number;
-    };
-    stored?: {
-        total: number;
-    };
-}
-export interface DomainTagStatAPIResponse {
-    body: {
-        tag: string;
-        description: string;
-        start: string;
-        end: string;
-        resolution: Resolution;
-        stats: DomainTagAPIResponseStatsItem[];
-    };
-}
-export interface DomainTagStatisticItem extends Omit<DomainTagAPIResponseStatsItem, 'time'> {
-    time: Date;
-}
-export interface DomainTagStatisticResult {
-    tag: string;
-    description: string;
-    start: Date;
-    end: Date;
-    resolution: Resolution;
-    stats: DomainTagStatisticItem[];
-}
-export interface DomainTagCountriesAPIResponse {
-    body: {
-        tag: string;
-        country: {
-            [key: string]: {
-                clicked: number;
-                complained: number;
-                opened: number;
-                unique_clicked: number;
-                unique_opened: number;
-                unsubscribed: number;
-            };
-        };
-    };
-}
-export interface DomainTagCountriesAggregation {
-    tag: string;
-    country: {
-        [key: string]: {
-            clicked: number;
-            complained: number;
-            opened: number;
-            unique_clicked: number;
-            unique_opened: number;
-            unsubscribed: number;
-        };
-    };
-}
-export interface DomainTagProvidersAPIResponse {
-    body: {
-        tag: string;
-        provider: {
-            [key: string]: {
-                accepted: number;
-                clicked: number;
-                complained: number;
-                delivered: number;
-                opened: number;
-                unique_clicked: number;
-                unique_opened: number;
-                unsubscribed: number;
-            };
-        };
-    };
-    status: number;
-}
-export interface DomainTagProvidersAggregation {
-    tag: string;
-    provider: {
-        [key: string]: {
-            accepted: number;
-            clicked: number;
-            complained: number;
-            delivered: number;
-            opened: number;
-            unique_clicked: number;
-            unique_opened: number;
-            unsubscribed: number;
-        };
-    };
-}
-export interface DeviceStatistic {
-    clicked: number;
-    complained: number;
-    opened: number;
-    unique_clicked: number;
-    unique_opened: number;
-    unsubscribed: number;
-}
-export interface DevicesTypes {
-    desktop: DeviceStatistic;
-    mobile: DeviceStatistic;
-    tablet: DeviceStatistic;
-    unknown: DeviceStatistic;
-}
-export interface DomainTagDevicesAPIResponse {
-    body: {
-        tag: string;
-        device: DevicesTypes;
-    };
-    status: number;
-}
-export interface DomainTagDevicesAggregation {
-    tag: string;
-    device: DevicesTypes;
-}
-export interface IDomainTagsClient {
-    list(domain: string): Promise<DomainTagsList>;
-    get(domain: string, tag: string): Promise<DomainTagsItem>;
-    update(domain: string, tag: string, description: string): Promise<DomainTagsMessageRes>;
-    destroy(domain: string, tag: string): Promise<DomainTagsMessageRes>;
-    statistic(domain: string, tag: string, query: DomainTagsStatisticQuery): Promise<DomainTagStatistic>;
-    countries(domain: string, tag: string): Promise<DomainTagCountriesAggregation>;
-    providers(domain: string, tag: string): Promise<DomainTagProvidersAggregation>;
-    devices(domain: string, tag: string): Promise<DomainTagDevicesAggregation>;
-}