@clxmedia/emailhub-client 2.0.2 → 2.0.4

package/dist/client.d.ts

@@ -1,4 +1,4 @@
-import { EmailHubConfig, EmailHubEnvironment, EmailHubMessage, EmailHubPriorityLevel, EmailHubSenderProfile } from "@clxmedia/types/emailhub";
+import { EmailHubConfig, EmailHubEnvironment, EmailHubMessage, EmailHubPriorityLevel, EmailHubSenderProfile } from '@clxmedia/types/emailhub';
 export declare class MockEmailHubClient {
     readonly environment: EmailHubEnvironment;
     private extendedLogging;
@@ -47,8 +47,9 @@ export declare class EmailHubClient {
     private sender;
     private server;
     private pubsubClient;
-    constructor(cfg: EmailHubConfig);
-    static new(cfg: EmailHubConfig, extendedLogging?: boolean): EmailHubClient | MockEmailHubClient;
+    private directApiOnly;
+    constructor(cfg: EmailHubConfig, directApiOnly?: boolean);
+    static new(cfg: EmailHubConfig, extendedLogging?: boolean, directApiOnly?: boolean): EmailHubClient | MockEmailHubClient;
     private loadPubSubClient;
     static validateEmailAddress(email?: string, regex?: RegExp): boolean;
     createSenderProfile(domain: string): Promise<EmailHubSenderProfile>;
@@ -58,5 +59,8 @@ export declare class EmailHubClient {
     sendEmail(msg: EmailHubMessage, options?: {
         priority?: EmailHubPriorityLevel;
         writeToLog?: boolean;
-    }): Promise<string>;
+    }): Promise<{
+        guid: string;
+        messageId?: string;
+    }>;
 }

package/dist/client.js

@@ -50,7 +50,7 @@ const mockEmailHubSenderProfile = {
     spf_status: 'Error',
     created_at: luxon_1.DateTime.local().toISO(),
     updated_at: luxon_1.DateTime.local().toISO(),
-    verified_at: undefined
+    verified_at: undefined,
 };
 class MockEmailHubClient {
     constructor(extendedLogging = false) {
@@ -78,16 +78,20 @@ class MockEmailHubClient {
 }
 exports.MockEmailHubClient = MockEmailHubClient;
 class EmailHubClient {
-    constructor(cfg) {
+    constructor(cfg, directApiOnly = false) {
         this.environment = emailhub_1.EmailHubEnvironment.emailhub;
+        this.directApiOnly = false;
         this.sender = cfg.sender;
         this.server = cfg.server ? cfg.server : DEFAULT_EMAIL_HUB_URL;
+        this.directApiOnly = directApiOnly || false;
     }
-    static new(cfg, extendedLogging = false) {
-        return (cfg.sender.guid && cfg.sender.secret) ? new EmailHubClient(cfg) : new MockEmailHubClient(extendedLogging);
+    static new(cfg, extendedLogging = false, directApiOnly = false) {
+        return cfg.sender.guid && cfg.sender.secret
+            ? new EmailHubClient(cfg, directApiOnly)
+            : new MockEmailHubClient(extendedLogging);
     }
     async loadPubSubClient() {
-        if (this.pubsubClient) {
+        if (this.pubsubClient || this.directApiOnly) {
             return;
         }
         try {
@@ -109,7 +113,11 @@ class EmailHubClient {
     }
     async createSenderProfile(domain) {
         const result = await axios_1.default.post(`${this.server}/sender-profiles`, { domain }, {
-            headers: { 'Content-Type': 'application/json', 'x-emailhub-sender-guid': this.sender.guid, 'x-emailhub-sender-secret': this.sender.secret }
+            headers: {
+                'Content-Type': 'application/json',
+                'x-emailhub-sender-guid': this.sender.guid,
+                'x-emailhub-sender-secret': this.sender.secret,
+            },
         });
         if (result.status === 400) {
             throw Error('Domain already taken or configured.');
@@ -118,7 +126,11 @@ class EmailHubClient {
     }
     async getSenderProfile(domainGuid) {
         const result = await axios_1.default.get(`${this.server}/sender-profiles/${domainGuid}`, {
-            headers: { 'Content-Type': 'application/json', 'x-emailhub-sender-guid': this.sender.guid, 'x-emailhub-sender-secret': this.sender.secret }
+            headers: {
+                'Content-Type': 'application/json',
+                'x-emailhub-sender-guid': this.sender.guid,
+                'x-emailhub-sender-secret': this.sender.secret,
+            },
         });
         if (result.status >= 400) {
             throw Error('Domain locator invalid or record not found.');
@@ -127,7 +139,11 @@ class EmailHubClient {
     }
     async checkSenderProfile(domainGuid) {
         const result = await axios_1.default.post(`${this.server}/sender-profiles/${domainGuid}`, undefined, {
-            headers: { 'Content-Type': 'application/json', 'x-emailhub-sender-guid': this.sender.guid, 'x-emailhub-sender-secret': this.sender.secret }
+            headers: {
+                'Content-Type': 'application/json',
+                'x-emailhub-sender-guid': this.sender.guid,
+                'x-emailhub-sender-secret': this.sender.secret,
+            },
         });
         if (result.status >= 400) {
             throw Error('Domain locator invalid or record not found.');
@@ -136,7 +152,11 @@ class EmailHubClient {
     }
     async deleteSenderProfile(domainGuid) {
         const result = await axios_1.default.delete(`${this.server}/sender-profiles/${domainGuid}`, {
-            headers: { 'Content-Type': 'application/json', 'x-emailhub-sender-guid': this.sender.guid, 'x-emailhub-sender-secret': this.sender.secret }
+            headers: {
+                'Content-Type': 'application/json',
+                'x-emailhub-sender-guid': this.sender.guid,
+                'x-emailhub-sender-secret': this.sender.secret,
+            },
         });
         return result.status;
     }
@@ -144,13 +164,22 @@ class EmailHubClient {
         await this.loadPubSubClient();
         const xMailGuid = msg && msg.CustomID ? msg.CustomID : uuid.v4();
         msg.CustomID = xMailGuid;
-        const topic = options && options.priority && options.priority === emailhub_1.EmailHubPriorityLevel.BULK ? 'send-new-email-bulk' : 'send-new-email';
+        const topic = options &&
+            options.priority &&
+            options.priority === emailhub_1.EmailHubPriorityLevel.BULK
+            ? 'send-new-email-bulk'
+            : 'send-new-email';
         if (this.pubsubClient !== null) {
             try {
-                await this.pubsubClient.topic(`projects/xperience-prod/topics/${topic}`)
+                await this.pubsubClient
+                    .topic(`projects/xperience-prod/topics/${topic}`)
                     .publishMessage({
-                    json: { sender_guid: this.sender.guid, sender_secret: this.sender.secret, payload: Buffer.from(Pako.deflate(Buffer.from(JSON.stringify(msg)).toString('base64'))).toString('base64') },
-                    attributes: { sender_guid: this.sender.guid }
+                    json: {
+                        sender_guid: this.sender.guid,
+                        sender_secret: this.sender.secret,
+                        payload: Buffer.from(Pako.deflate(Buffer.from(JSON.stringify(msg)).toString('base64'))).toString('base64'),
+                    },
+                    attributes: { sender_guid: this.sender.guid },
                 });
                 return xMailGuid;
             }
@@ -158,10 +187,14 @@ class EmailHubClient {
                 console.log('Failed to send email via PubSub queue. Falling back to Direct API connection.');
             }
         }
-        await axios_1.default.post(`${this.server}/email/send`, msg, {
-            headers: { 'Content-Type': 'application/json', 'x-emailhub-sender-guid': this.sender.guid, 'x-emailhub-sender-secret': this.sender.secret }
+        const result = await axios_1.default.post(`${this.server}/email/send`, msg, {
+            headers: {
+                'Content-Type': 'application/json',
+                'x-emailhub-sender-guid': this.sender.guid,
+                'x-emailhub-sender-secret': this.sender.secret,
+            },
         });
-        return xMailGuid;
+        return { guid: xMailGuid, messageId: result.data };
     }
 }
 exports.EmailHubClient = EmailHubClient;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clxmedia/emailhub-client",
-  "version": "2.0.2",
+  "version": "2.0.4",
   "description": "CLXperience EmailHub Client",
   "author": "Brandon Thompson <brandont@clxmedia.com>",
   "license": "MIT",