@clxmedia/emailhub-client 1.1.2 → 1.1.4

package/dist/client.d.ts

@@ -3,6 +3,10 @@ export declare enum EmailHubPriorityLevel {
     NORMAL = "normal",
     BULK = "bulk"
 }
+export declare enum EmailHubEnvironment {
+    emailhub = "emailhub",
+    localhost = "localhost"
+}
 export interface EmailHubAttachment {
     ContentType: string;
     Filename: string;
@@ -60,11 +64,55 @@ export interface EmailHubSenderProfile {
     updated_at?: string;
     verified_at?: string;
 }
+export declare class MockEmailHubClient {
+    readonly environment: EmailHubEnvironment;
+    createSenderProfile(_domain: string): Promise<{
+        guid: string;
+        id: number;
+        domain_name: string;
+        domain_id: string;
+        mailjet_sender_id: string;
+        dkim_txt_name: string;
+        dkim_txt_value: string;
+        dkim_status: string;
+        token_txt_name: string;
+        token_txt_value: string;
+        spf_txt_value: string;
+        spf_status: string;
+        created_at: string;
+        updated_at?: string;
+        verified_at?: string;
+    }>;
+    checkSenderProfile(domainGuid: string): Promise<{
+        guid: string;
+        verified_at: string;
+        id: number;
+        domain_name: string;
+        domain_id: string;
+        mailjet_sender_id: string;
+        dkim_txt_name: string;
+        dkim_txt_value: string;
+        dkim_status: string;
+        token_txt_name: string;
+        token_txt_value: string;
+        spf_txt_value: string;
+        spf_status: string;
+        created_at: string;
+        updated_at?: string;
+    }>;
+    deleteSenderProfile(): Promise<void>;
+    sendEmail(msg: EmailHubMessage, options?: {
+        priority?: EmailHubPriorityLevel;
+        writeToLog?: boolean;
+    }): Promise<string>;
+}
 export declare class EmailHubClient {
+    readonly environment: EmailHubEnvironment;
     private sender;
     private server;
     private pubsubClient;
     constructor(cfg: EmailHubConfig);
+    static new(cfg: EmailHubConfig): EmailHubClient | MockEmailHubClient;
     private loadPubSubClient;
     static validateEmailAddress(email?: string, regex?: RegExp): boolean;
     createSenderProfile(domain: string): Promise<EmailHubSenderProfile>;
@@ -73,5 +121,6 @@ export declare class EmailHubClient {
     deleteSenderProfile(domainGuid: string): Promise<HttpStatusCode>;
     sendEmail(msg: EmailHubMessage, options?: {
         priority?: EmailHubPriorityLevel;
+        writeToLog?: boolean;
     }): Promise<string>;
 }

package/dist/client.js

@@ -9,8 +9,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EmailHubClient = exports.EmailHubPriorityLevel = void 0;
+exports.EmailHubClient = exports.MockEmailHubClient = exports.EmailHubEnvironment = exports.EmailHubPriorityLevel = void 0;
 const pubsub_1 = require("@google-cloud/pubsub");
+const luxon_1 = require("luxon");
 const uuid = require("uuid");
 const Pako = require("pako");
 const axios_1 = require("axios");
@@ -19,13 +20,70 @@ var EmailHubPriorityLevel;
     EmailHubPriorityLevel["NORMAL"] = "normal";
     EmailHubPriorityLevel["BULK"] = "bulk";
 })(EmailHubPriorityLevel = exports.EmailHubPriorityLevel || (exports.EmailHubPriorityLevel = {}));
+var EmailHubEnvironment;
+(function (EmailHubEnvironment) {
+    EmailHubEnvironment["emailhub"] = "emailhub";
+    EmailHubEnvironment["localhost"] = "localhost";
+})(EmailHubEnvironment = exports.EmailHubEnvironment || (exports.EmailHubEnvironment = {}));
 const DEFAULT_EMAIL_HUB_URL = 'https://emailhub.clxp.us';
 const DEFAULT_EMAIL_REGEX = /^([a-z0-9])([a-z\.0-9_%\-\+\*'’!#`&\$/]*)@(.+)\.(.+)$/;
+const mockEmailHubSenderProfile = {
+    id: 1,
+    guid: 'mock-guid',
+    domain_name: 'mock-domain-name',
+    domain_id: 'mock-domain-id',
+    mailjet_sender_id: 'mock-mailjet-sender-id',
+    dkim_txt_name: 'mock-dkim-txt-name',
+    dkim_txt_value: 'mock-dkim-txt-value',
+    dkim_status: 'OK',
+    token_txt_name: 'mock-token-txt-name',
+    token_txt_value: 'mock-token-txt-value',
+    spf_txt_value: 'mock-spf-txt-value',
+    spf_status: 'Error',
+    created_at: luxon_1.DateTime.local().toISO(),
+    updated_at: luxon_1.DateTime.local().toISO(),
+    verified_at: undefined
+};
+class MockEmailHubClient {
+    constructor() {
+        this.environment = EmailHubEnvironment.localhost;
+    }
+    createSenderProfile(_domain) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return Object.assign(Object.assign({}, mockEmailHubSenderProfile), { guid: uuid.v4() });
+        });
+    }
+    checkSenderProfile(domainGuid) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return Object.assign(Object.assign({}, mockEmailHubSenderProfile), { guid: domainGuid, verified_at: luxon_1.DateTime.local().toISO() });
+        });
+    }
+    deleteSenderProfile() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return;
+        });
+    }
+    sendEmail(msg, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (options === null || options === void 0 ? void 0 : options.writeToLog) {
+                console.log('----------------Begin mock email send-----------------');
+                console.log(JSON.stringify(msg));
+                console.log('----------------End mock email send-----------------');
+            }
+            return uuid.v4();
+        });
+    }
+}
+exports.MockEmailHubClient = MockEmailHubClient;
 class EmailHubClient {
     constructor(cfg) {
+        this.environment = EmailHubEnvironment.emailhub;
         this.sender = cfg.sender;
         this.server = cfg.server ? cfg.server : DEFAULT_EMAIL_HUB_URL;
     }
+    static new(cfg) {
+        return (cfg.sender.guid && cfg.sender.secret) ? new EmailHubClient(cfg) : new MockEmailHubClient();
+    }
     loadPubSubClient() {
         return __awaiter(this, void 0, void 0, function* () {
             if (this.pubsubClient) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clxmedia/emailhub-client",
-  "version": "1.1.2",
+  "version": "1.1.4",
   "description": "CLXperience EmailHub Client",
   "author": "Brandon Thompson <brandont@clxmedia.com>",
   "license": "MIT",
@@ -37,12 +37,14 @@
   "dependencies": {
     "@google-cloud/pubsub": "^3.6.0",
     "axios": "^1.4.0",
+    "luxon": "^3.3.0",
     "pako": "^2.1.0",
     "uuid": "^9.0.0"
   },
   "devDependencies": {
     "@types/axios": "^0.14.0",
     "@types/jest": "28.1.7",
+    "@types/luxon": "^3.3.0",
     "@types/node": "^20.1.7",
     "@types/pako": "^2.0.0",
     "@types/supertest": "2.0.12",