@clxmedia/emailhub-client 1.0.0

package/CHANGELOG.md

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

package/CONTRIBUTING.md

@@ -0,0 +1,31 @@
+# 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
+```

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 John Biundo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,19 @@
+<h1 align="center"></h1>
+
+<h3 align="center">CLXperience EmailHub Client</h3>
+
+## Usage
+
+Client connector for internal Conxversion Logix Xperience services.
+
+## Change Log
+
+See [Changelog](CHANGELOG.md) for more information.
+
+## Author
+
+**Brandon Thompson**
+
+## License
+
+Licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

package/dist/client.d.ts

@@ -0,0 +1,48 @@
+export declare enum EmailHubPriorityLevel {
+    NORMAL = "normal",
+    BULK = "bulk"
+}
+export interface EmailHubAttachment {
+    ContentType: string;
+    Filename: string;
+    Base64Content: string;
+}
+export interface EmailHubInlineAttachment extends EmailHubAttachment {
+    ContentID: string;
+}
+export interface EmailHubRecipient {
+    Email: string;
+    Name: string;
+}
+export interface EmailHubMessage {
+    From: {
+        Email: string;
+        Name: string;
+    };
+    To: EmailHubRecipient[];
+    Cc?: EmailHubRecipient[];
+    Bcc?: EmailHubRecipient[];
+    Subject: string;
+    TextPart?: string;
+    HTMLPart?: string;
+    CustomID?: string;
+    Attachments?: EmailHubAttachment[];
+    InlinedAttachments?: EmailHubInlineAttachment[];
+}
+export interface EmailHubSender {
+    guid: string;
+    secret: string;
+}
+export interface EmailHubConfig {
+    sender: EmailHubSender;
+}
+export declare class EmailHubClient {
+    private cloudPubSub;
+    private sender;
+    constructor(cfg: EmailHubConfig);
+    static compressMessage(msg: EmailHubMessage): string;
+    sendEmail(msg: EmailHubMessage, options?: {
+        priority?: EmailHubPriorityLevel;
+        xMailGuid?: string;
+    }): Promise<string>;
+}

package/dist/client.js

@@ -0,0 +1,43 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmailHubClient = exports.EmailHubPriorityLevel = void 0;
+const pubsub_1 = require("@google-cloud/pubsub");
+const uuid = require("uuid");
+const Pako = require("pako");
+var EmailHubPriorityLevel;
+(function (EmailHubPriorityLevel) {
+    EmailHubPriorityLevel["NORMAL"] = "normal";
+    EmailHubPriorityLevel["BULK"] = "bulk";
+})(EmailHubPriorityLevel = exports.EmailHubPriorityLevel || (exports.EmailHubPriorityLevel = {}));
+class EmailHubClient {
+    constructor(cfg) {
+        this.cloudPubSub = new pubsub_1.PubSub();
+        this.sender = cfg.sender;
+    }
+    static compressMessage(msg) {
+        return Buffer.from(Pako.deflate(Buffer.from(JSON.stringify(msg)).toString('base64'))).toString('base64');
+    }
+    sendEmail(msg, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const xMailGuid = options && options.xMailGuid ? options.xMailGuid : uuid.v4();
+            msg.CustomID = xMailGuid;
+            const topic = options && options.priority && options.priority === EmailHubPriorityLevel.BULK ? 'send-new-email-bulk' : 'send-new-email';
+            yield this.cloudPubSub.topic(`projects/xperience-prod/topics/${topic}`)
+                .publishMessage({
+                json: { sender_guid: this.sender.guid, sender_secret: this.sender.secret, payload: EmailHubClient.compressMessage(msg) },
+                attributes: { sender_guid: this.sender.guid }
+            });
+            return xMailGuid;
+        });
+    }
+}
+exports.EmailHubClient = EmailHubClient;

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { EmailHubClient, EmailHubMessage, EmailHubAttachment, EmailHubConfig, EmailHubInlineAttachment, EmailHubRecipient, EmailHubPriorityLevel, EmailHubSender } from './client';

package/dist/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmailHubPriorityLevel = exports.EmailHubClient = void 0;
+var client_1 = require("./client");
+Object.defineProperty(exports, "EmailHubClient", { enumerable: true, get: function () { return client_1.EmailHubClient; } });
+Object.defineProperty(exports, "EmailHubPriorityLevel", { enumerable: true, get: function () { return client_1.EmailHubPriorityLevel; } });

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@clxmedia/emailhub-client",
+  "version": "1.0.0",
+  "description": "CLXperience EmailHub Client",
+  "author": "Brandon Thompson <brandont@clxmedia.com>",
+  "license": "MIT",
+  "readmeFilename": "README.md",
+  "main": "dist/client.js",
+  "typings": "dist/client.d.ts",
+  "files": [
+    "dist/**/*",
+    "*.md"
+  ],
+  "scripts": {
+    "start:dev": "tsc -w",
+    "build": "tsc",
+    "prepare": "npm run build",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "lint": "tslint -p tsconfig.json -c tslint.json",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:cov": "jest --coverage",
+    "test:e2e": "jest --config ./test/jest-e2e.json"
+  },
+  "keywords": [
+    "nestjs"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/adsupnow/xperience-clients/emailhub"
+  },
+  "bugs": "https://github.com/adsupnow/xperience-clients/emailhub",
+  "peerDependencies": {},
+  "dependencies": {
+    "@google-cloud/pubsub": "^3.6.0",
+    "pako": "^2.1.0",
+    "uuid": "^9.0.0"
+  },
+  "devDependencies": {
+    "@types/jest": "28.1.7",
+    "@types/node": "^20.1.7",
+    "@types/supertest": "2.0.12",
+    "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"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": "src",
+    "testRegex": ".spec.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "coverageDirectory": "../coverage",
+    "testEnvironment": "node"
+  }
+}