@orangewall/customer-notifications-util 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Snyk Labs
+
+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,38 @@
+# monitoring-utils
+
+An npm package for demonstration purposes using TypeScript to build for both the ECMAScript Module format (i.e. ESM or ES Module) and CommonJS Module format (CJS). It can be used in Node.js and browser applications.
+
+## Get Started
+
+1. Run `npm install` in your terminal
+1. Then run `npm run build`
+1. Update the `package.json` with the new version that needs to be published
+1. Create an account with [npm](https://www.npmjs.com/signup) if you don't have one already. Also be sure to enable [two-factor authentication](https://docs.npmjs.com/configuring-two-factor-authentication)
+1. Sign in to your npm account in your terminal with `npm login`
+1. Run `npm publish --access=public` to publish your package
+
+### Testing
+
+1. Install developer dependencies using the following command in your terminal `npm i -D mocha @types/mocha chai @types/chai ts-node`
+1. Create a new file `.mocharc.json` in the root directory with the following contents:
+   ```json
+   {
+     "extension": ["ts"],
+     "spec": "./**/*.spec.ts",
+     "require": "ts-node/register"
+   }
+   ```
+1. Create a `tests` folder
+1. Create an `index.spec.ts` file in the `tests` folder
+1. Write unit tests in the `index.spec.ts` file to test the code in `index.ts`
+1. Add a `"test"` property in the `package.json` file and give it a value of `"mocha"`
+1. Run `npm test` in your terminal from the root folder of the project
+
+
+
+
+### References
+
+https://snyk.io/blog/best-practices-create-modern-npm-package
+https://github.com/snyk-snippets/modern-npm-package
+https://github.com/goldbergyoni/javascript-testing-best-practices

package/lib/cjs/customer-notifications/index.mjs

@@ -0,0 +1,75 @@
+"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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendCustomerNotification = void 0;
+const client_sns_1 = require("@aws-sdk/client-sns");
+const config_1 = __importDefault(require("config"));
+/**
+ * Posts a message to customer-notifications SNS
+ * @param {string} messages - Extra parameters to add to description for context.
+ * @returns {Promise} - Resolves with the SNS publish result.
+ */
+function sendCustomerNotification(messages, topicArn) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const snsClient = new client_sns_1.SNSClient(); // Default credentials and region from the environment
+            if (!topicArn) {
+                config_1.default === null || config_1.default === void 0 ? void 0 : config_1.default.get('notifications.customer-notifications-topic-arn');
+                if (!topicArn) {
+                    throw new Error("if topic is not passed as a parameter, you need to install 'config' dependency and define 'notifications.customer-notifications-topic-arn'!");
+                }
+            }
+            const requests = [];
+            for (const message of messages) {
+                requests.push(_sendMessage(message, topicArn, snsClient));
+            }
+            return yield Promise.all(requests);
+        }
+        catch (err) {
+            console.error("Error sending the customer notification:", err);
+        }
+    });
+}
+exports.sendCustomerNotification = sendCustomerNotification;
+function _sendMessage(message, topicArn, snsClient) {
+    validateMessage(message);
+    const params = {
+        TopicArn: topicArn,
+        Message: JSON.stringify(message),
+        MessageAttributes: {},
+    };
+    const command = new client_sns_1.PublishCommand(params);
+    return snsClient.send(command);
+}
+function validateMessage(message) {
+    var _a, _b, _c, _d;
+    if (!message.organizationId) {
+        throw new Error(`Organization Id is required!`);
+    }
+    if (!((_a = message.recipient) === null || _a === void 0 ? void 0 : _a.address)) {
+        throw new Error(`recipient.address is required!`);
+    }
+    if (!message.type) {
+        throw new Error(`type is required!`);
+    }
+    if (!((_b = message.template) === null || _b === void 0 ? void 0 : _b.name)) {
+        throw new Error(`template.name is required!`);
+    }
+    if (!((_c = message.template) === null || _c === void 0 ? void 0 : _c.channelType)) {
+        throw new Error(`template.channelType is required!`);
+    }
+    if (!((_d = message.template) === null || _d === void 0 ? void 0 : _d.version)) {
+        throw new Error(`template.version is required!`);
+    }
+}

package/lib/cjs/index.mjs

@@ -0,0 +1,17 @@
+"use strict";
+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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./customer-notifications/index.mjs"), exports);

package/lib/cjs/models/message.model.mjs

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/types/customer-notifications/index.d.mts

@@ -0,0 +1,8 @@
+import { Message } from '../models/message.model.mjs';
+/**
+ * Posts a message to customer-notifications SNS
+ * @param {string} messages - Extra parameters to add to description for context.
+ * @returns {Promise} - Resolves with the SNS publish result.
+ */
+export declare function sendCustomerNotification(messages: Message[], topicArn?: string): Promise<any>;
+//# sourceMappingURL=index.d.mts.map

package/lib/cjs/types/customer-notifications/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../../src/customer-notifications/index.mts"],"names":[],"mappings":"AAGA,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AAEtD;;;;GAIG;AACH,wBAAsB,wBAAwB,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAmBnG"}

package/lib/cjs/types/index.d.mts

@@ -0,0 +1,2 @@
+export * from './customer-notifications/index.mjs';
+//# sourceMappingURL=index.d.mts.map

package/lib/cjs/types/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/index.mts"],"names":[],"mappings":"AAAA,cAAc,oCAAoC,CAAA"}

package/lib/cjs/types/models/message.model.d.mts

@@ -0,0 +1,18 @@
+export type Message = {
+    organizationId: String;
+    recipient: Recipient;
+    type: String;
+    template: Template;
+    substitutions?: String;
+};
+export type Recipient = {
+    employeeId?: String;
+    employeeName?: String;
+    address: String;
+};
+export type Template = {
+    name: String;
+    channelType: String;
+    version: Number;
+};
+//# sourceMappingURL=message.model.d.mts.map

package/lib/cjs/types/models/message.model.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"message.model.d.mts","sourceRoot":"","sources":["../../../../src/models/message.model.mts"],"names":[],"mappings":"AAAA,MAAM,MAAM,OAAO,GAAG;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,SAAS,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,QAAQ,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;CACnB,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;CACnB,CAAA"}

package/lib/esm/customer-notifications/index.mjs

@@ -0,0 +1,56 @@
+import { SNSClient, PublishCommand } from "@aws-sdk/client-sns";
+import config from 'config';
+/**
+ * Posts a message to customer-notifications SNS
+ * @param {string} messages - Extra parameters to add to description for context.
+ * @returns {Promise} - Resolves with the SNS publish result.
+ */
+export async function sendCustomerNotification(messages, topicArn) {
+    try {
+        const snsClient = new SNSClient(); // Default credentials and region from the environment
+        if (!topicArn) {
+            config?.get('notifications.customer-notifications-topic-arn');
+            if (!topicArn) {
+                throw new Error("if topic is not passed as a parameter, you need to install 'config' dependency and define 'notifications.customer-notifications-topic-arn'!");
+            }
+        }
+        const requests = [];
+        for (const message of messages) {
+            requests.push(_sendMessage(message, topicArn, snsClient));
+        }
+        return await Promise.all(requests);
+    }
+    catch (err) {
+        console.error("Error sending the customer notification:", err);
+    }
+}
+function _sendMessage(message, topicArn, snsClient) {
+    validateMessage(message);
+    const params = {
+        TopicArn: topicArn,
+        Message: JSON.stringify(message),
+        MessageAttributes: {},
+    };
+    const command = new PublishCommand(params);
+    return snsClient.send(command);
+}
+function validateMessage(message) {
+    if (!message.organizationId) {
+        throw new Error(`Organization Id is required!`);
+    }
+    if (!message.recipient?.address) {
+        throw new Error(`recipient.address is required!`);
+    }
+    if (!message.type) {
+        throw new Error(`type is required!`);
+    }
+    if (!message.template?.name) {
+        throw new Error(`template.name is required!`);
+    }
+    if (!message.template?.channelType) {
+        throw new Error(`template.channelType is required!`);
+    }
+    if (!message.template?.version) {
+        throw new Error(`template.version is required!`);
+    }
+}

package/lib/esm/index.mjs

@@ -0,0 +1 @@
+export * from './customer-notifications/index.mjs';

package/lib/esm/models/message.model.mjs

@@ -0,0 +1 @@
+export {};

package/lib/esm/types/customer-notifications/index.d.mts

@@ -0,0 +1,8 @@
+import { Message } from '../models/message.model.mjs';
+/**
+ * Posts a message to customer-notifications SNS
+ * @param {string} messages - Extra parameters to add to description for context.
+ * @returns {Promise} - Resolves with the SNS publish result.
+ */
+export declare function sendCustomerNotification(messages: Message[], topicArn?: string): Promise<any>;
+//# sourceMappingURL=index.d.mts.map

package/lib/esm/types/customer-notifications/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../../src/customer-notifications/index.mts"],"names":[],"mappings":"AAGA,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AAEtD;;;;GAIG;AACH,wBAAsB,wBAAwB,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAmBnG"}

package/lib/esm/types/index.d.mts

@@ -0,0 +1,2 @@
+export * from './customer-notifications/index.mjs';
+//# sourceMappingURL=index.d.mts.map

package/lib/esm/types/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/index.mts"],"names":[],"mappings":"AAAA,cAAc,oCAAoC,CAAA"}

package/lib/esm/types/models/message.model.d.mts

@@ -0,0 +1,18 @@
+export type Message = {
+    organizationId: String;
+    recipient: Recipient;
+    type: String;
+    template: Template;
+    substitutions?: String;
+};
+export type Recipient = {
+    employeeId?: String;
+    employeeName?: String;
+    address: String;
+};
+export type Template = {
+    name: String;
+    channelType: String;
+    version: Number;
+};
+//# sourceMappingURL=message.model.d.mts.map

package/lib/esm/types/models/message.model.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"message.model.d.mts","sourceRoot":"","sources":["../../../../src/models/message.model.mts"],"names":[],"mappings":"AAAA,MAAM,MAAM,OAAO,GAAG;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,SAAS,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,QAAQ,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;CACnB,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;CACnB,CAAA"}

package/package.json

@@ -0,0 +1,75 @@
+{
+  "name": "@orangewall/customer-notifications-util",
+  "version": "0.0.1",
+  "description": "library to send customer notifications ",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./lib/esm/types/index.d.ts",
+        "default": "./lib/esm/index.mjs"
+      },
+      "require": {
+        "types": "./lib/cjs/types/index.d.ts",
+        "default": "./lib/cjs/index.js"
+      }
+    }
+  },
+  "types": "./lib/cjs/types/index.d.ts",
+  "main": "./lib/cjs/index.js",
+  "files": [
+    "lib/**/*"
+  ],
+  "scripts": {
+    "clean": "rm -rf ./lib",
+    "build": "npm run clean && npm run build:esm && npm run build:cjs",
+    "build:esm": "tsc -p ./configs/tsconfig.esm.json ",
+    "build:cjs": "tsc -p ./configs/tsconfig.cjs.json",
+    "test": "mocha",
+    "semantic-release": "semantic-release",
+    "prepack": "npm run build",
+    "publish": "npm run build && npm publish --access public"
+  },
+  "release": {
+    "branches": [
+      "master"
+    ]
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://gitlab.com/orangewall-trucking/public/customer-notifications-util"
+  },
+  "keywords": [
+    "npm",
+    "javascript",
+    "typescript",
+    "esm",
+    "cjs",
+    "nodejs",
+    "commonjs",
+    "ecmascript",
+    "beginner",
+    "example",
+    "demonstration"
+  ],
+  "author": "Orangewall",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://gitlab.com/orangewall-trucking/public/customer-notifications-util/issues"
+  },
+  "homepage": "https://gitlab.com/orangewall-trucking/public/customer-notifications-util#readme",
+  "devDependencies": {
+    "@aws-sdk/client-sns": "^3.716.0",
+    "@types/chai": "^4.3.3",
+    "@types/config": "^3.3.5",
+    "@types/mocha": "^9.1.1",
+    "chai": "^4.3.6",
+    "config": "^3.3.12",
+    "mocha": "^10.0.0",
+    "semantic-release": "^19.0.3",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.7.4"
+  }
+}