@clxmedia/emailhub-client 1.1.7 → 2.0.1

package/README.md

@@ -4,7 +4,7 @@
 
 ## Usage
 
-Client connector for internal Conxversion Logix Xperience services.
+Reads and writes to the Xperience EmailHub
 
 ## Change Log
 

package/dist/client.d.ts

@@ -1,11 +1,10 @@
 import { EmailHubConfig, EmailHubEnvironment, EmailHubMessage, EmailHubPriorityLevel, EmailHubSenderProfile } from "@clxmedia/types/emailhub";
-import { HttpStatusCode } from "axios";
 export declare class MockEmailHubClient {
     readonly environment: EmailHubEnvironment;
     private extendedLogging;
     constructor(extendedLogging?: boolean);
     createSenderProfile(_domain: string): Promise<{
-        guid: string;
+        guid: any;
         id: number;
         domain_name: string;
         domain_id: string;
@@ -23,7 +22,7 @@ export declare class MockEmailHubClient {
     }>;
     checkSenderProfile(domainGuid: string): Promise<{
         guid: string;
-        verified_at: string;
+        verified_at: any;
         id: number;
         domain_name: string;
         domain_id: string;
@@ -55,7 +54,7 @@ export declare class EmailHubClient {
     createSenderProfile(domain: string): Promise<EmailHubSenderProfile>;
     getSenderProfile(domainGuid: string): Promise<EmailHubSenderProfile>;
     checkSenderProfile(domainGuid: string): Promise<EmailHubSenderProfile>;
-    deleteSenderProfile(domainGuid: string): Promise<HttpStatusCode>;
+    deleteSenderProfile(domainGuid: string): Promise<number>;
     sendEmail(msg: EmailHubMessage, options?: {
         priority?: EmailHubPriorityLevel;
         writeToLog?: boolean;

package/dist/client.js

@@ -1,21 +1,38 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EmailHubClient = exports.MockEmailHubClient = void 0;
 const pubsub_1 = require("@google-cloud/pubsub");
 const emailhub_1 = require("@clxmedia/types/emailhub");
 const luxon_1 = require("luxon");
-const uuid = require("uuid");
-const Pako = require("pako");
-const axios_1 = require("axios");
+const uuid = __importStar(require("uuid"));
+const Pako = __importStar(require("pako"));
+const axios_1 = __importDefault(require("axios"));
 const DEFAULT_EMAIL_HUB_URL = 'https://emailhub.clxp.us';
 const DEFAULT_EMAIL_REGEX = /^([a-z0-9])([a-z\.0-9_%\-\+\*'’!#`&\$/]*)@(.+)\.(.+)$/;
 const mockEmailHubSenderProfile = {
@@ -40,31 +57,23 @@ class MockEmailHubClient {
         this.environment = emailhub_1.EmailHubEnvironment.localhost;
         this.extendedLogging = extendedLogging;
     }
-    createSenderProfile(_domain) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return Object.assign(Object.assign({}, mockEmailHubSenderProfile), { guid: uuid.v4() });
-        });
+    async createSenderProfile(_domain) {
+        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() });
-        });
+    async checkSenderProfile(domainGuid) {
+        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;
-        });
+    async deleteSenderProfile() {
+        return;
     }
-    sendEmail(msg, options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this.extendedLogging) {
-                console.log(`----------------Begin mock email send: Priority: [${(options === null || options === void 0 ? void 0 : options.priority) || 'default'}]-----------------`);
-                console.log(JSON.stringify(msg));
-                console.log('----------------End mock email send-----------------');
-            }
-            const xMailGuid = msg && msg.CustomID ? msg.CustomID : uuid.v4();
-            return xMailGuid;
-        });
+    async sendEmail(msg, options) {
+        if (this.extendedLogging) {
+            console.log(`----------------Begin mock email send: Priority: [${(options === null || options === void 0 ? void 0 : options.priority) || 'default'}]-----------------`);
+            console.log(JSON.stringify(msg));
+            console.log('----------------End mock email send-----------------');
+        }
+        const xMailGuid = msg && msg.CustomID ? msg.CustomID : uuid.v4();
+        return xMailGuid;
     }
 }
 exports.MockEmailHubClient = MockEmailHubClient;
@@ -77,22 +86,20 @@ class EmailHubClient {
     static new(cfg, extendedLogging = false) {
         return (cfg.sender.guid && cfg.sender.secret) ? new EmailHubClient(cfg) : new MockEmailHubClient(extendedLogging);
     }
-    loadPubSubClient() {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this.pubsubClient) {
-                return;
-            }
-            try {
-                this.pubsubClient = new pubsub_1.PubSub();
-                yield this.pubsubClient.auth.getCredentials();
-                return;
-            }
-            catch (e) {
-                this.pubsubClient = null;
-                console.log('Could not load default GCP credentials. Sending email directly via API.');
-                return;
-            }
-        });
+    async loadPubSubClient() {
+        if (this.pubsubClient) {
+            return;
+        }
+        try {
+            this.pubsubClient = new pubsub_1.PubSub();
+            await this.pubsubClient.auth.getCredentials();
+            return;
+        }
+        catch (e) {
+            this.pubsubClient = null;
+            console.log('Could not load default GCP credentials. Sending email directly via API.');
+            return;
+        }
     }
     static validateEmailAddress(email, regex = DEFAULT_EMAIL_REGEX) {
         if (!email) {
@@ -100,71 +107,61 @@ class EmailHubClient {
         }
         return regex.test(email.toLocaleLowerCase());
     }
-    createSenderProfile(domain) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const result = yield 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 }
-            });
-            if (result.status === 400) {
-                throw Error('Domain already taken or configured.');
-            }
-            return result.data;
+    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 }
         });
+        if (result.status === 400) {
+            throw Error('Domain already taken or configured.');
+        }
+        return result.data;
     }
-    getSenderProfile(domainGuid) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const result = yield 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 }
-            });
-            if (result.status >= 400) {
-                throw Error('Domain locator invalid or record not found.');
-            }
-            return result.data;
+    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 }
         });
+        if (result.status >= 400) {
+            throw Error('Domain locator invalid or record not found.');
+        }
+        return result.data;
     }
-    checkSenderProfile(domainGuid) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const result = yield 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 }
-            });
-            if (result.status >= 400) {
-                throw Error('Domain locator invalid or record not found.');
-            }
-            return result.data;
+    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 }
         });
+        if (result.status >= 400) {
+            throw Error('Domain locator invalid or record not found.');
+        }
+        return result.data;
     }
-    deleteSenderProfile(domainGuid) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const result = yield 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 }
-            });
-            return result.status;
+    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 }
         });
+        return result.status;
     }
-    sendEmail(msg, options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield 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';
-            if (this.pubsubClient !== null) {
-                try {
-                    yield 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 }
-                    });
-                    return xMailGuid;
-                }
-                catch (e) {
-                    console.log('Failed to send email via PubSub queue. Falling back to Direct API connection.');
-                }
+    async sendEmail(msg, options) {
+        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';
+        if (this.pubsubClient !== null) {
+            try {
+                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 }
+                });
+                return xMailGuid;
             }
-            yield 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;
+            catch (e) {
+                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 }
         });
+        return xMailGuid;
     }
 }
 exports.EmailHubClient = EmailHubClient;

package/package.json

@@ -1,19 +1,26 @@
 {
   "name": "@clxmedia/emailhub-client",
-  "version": "1.1.7",
+  "version": "2.0.1",
   "description": "CLXperience EmailHub Client",
   "author": "Brandon Thompson <brandont@clxmedia.com>",
   "license": "MIT",
   "readmeFilename": "README.md",
-  "main": "dist/client.js",
-  "typings": "dist/client.d.ts",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "files": [
     "dist/**/*",
     "*.md"
   ],
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    },
+    "./client": "./dist/client.js"
+  },
   "scripts": {
     "start:dev": "tsc -w",
-    "build": "tsc",
+    "build": "rm -Rf dist && tsc",
     "prepare": "npm run build",
     "format": "prettier --write \"src/**/*.ts\"",
     "lint": "tslint -p tsconfig.json -c tslint.json",
@@ -35,30 +42,21 @@
   "bugs": "https://github.com/adsupnow/xperience-clients/emailhub",
   "peerDependencies": {},
   "dependencies": {
-    "@google-cloud/pubsub": "^3.6.0",
-    "axios": "^1.4.0",
-    "luxon": "^3.3.0",
-    "pako": "^2.1.0",
-    "uuid": "^9.0.0"
+    "@google-cloud/pubsub": "4.3.3",
+    "uuid": "9.0.1",
+    "axios": "1.6.8",
+    "pako": "2.1.0",
+    "luxon": "3.4.4"
   },
   "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",
-    "@types/uuid": "^9.0.1",
-    "jest": "28.1.3",
-    "prettier": "2.7.1",
-    "supertest": "6.2.4",
-    "ts-jest": "28.0.8",
-    "ts-node": "10.9.1",
-    "tsc-watch": "5.0.3",
-    "tsconfig-paths": "4.1.0",
-    "tslint": "6.1.3",
-    "typescript": "4.7.4",
-    "@clxmedia/types": "1.0.3"
+    "typescript": "^5.2.2",
+    "@clxmedia/types": "1.0.15",
+    "@types/node": "^20",
+    "@types/jsonwebtoken": "9.0.6",
+    "jest": "29.7.0",
+    "ts-jest": "29.1.2",
+    "nock": "13.5.4",
+    "tslint": "6.1.3"
   },
   "jest": {
     "moduleFileExtensions": [

package/CHANGELOG.md

@@ -1,3 +0,0 @@
-RELEASE 1.0.0
-
-Initial release

package/CONTRIBUTING.md

@@ -1,31 +0,0 @@
-# Contributing
-
-1. [Fork it](https://help.github.com/articles/fork-a-repo/)
-2. Install dependencies (`npm install`)
-3. Create your feature branch (`git checkout -b my-new-feature`)
-4. Commit your changes (`git commit -am 'Added some feature'`)
-5. Test your changes (`npm test`)
-6. Push to the branch (`git push origin my-new-feature`)
-7. [Create new Pull Request](https://help.github.com/articles/creating-a-pull-request/)
-
-## Testing
-
-We use [Jest](https://github.com/facebook/jest) to write tests. Run our test suite with this command:
-
-```
-npm test
-```
-
-## Code Style
-
-We use [Prettier](https://prettier.io/) and tslint to maintain code style and best practices.
-Please make sure your PR adheres to the guides by running:
-
-```
-npm run format
-```
-
-and
-```
-npm run lint
-```