@svkruik/sk-dispatch-connector 0.0.1

package/README.md

@@ -0,0 +1,12 @@
+# SK Dispatch - Connector
+
+[![Publish Package](https://github.com/SVKruik-Organization/Dispatch/actions/workflows/publish.yml/badge.svg)](https://github.com/SVKruik-Organization/Dispatch/actions/workflows/publish.yml)
+[![NPM Version](https://img.shields.io/npm/v/%40svkruik%2Fsk-dispatch-connector?label=%40svkruik%2Fsk-dispatch-connector&color=green)](https://www.npmjs.com/package/@svkruik/sk-dispatch-connector)
+
+Making dispatching mails a breeze. Simplifies communication with SK Dispatch for other apps by removing boilerplate and providing stronger Intellisense.
+
+This package is developed along-side the [server](https://github.com/SVKruik-Organization/Dispatch/tree/main/server) for tight typings and validations.
+
+---
+
+Because a simple `README.md` can only do so much, I have also made an documentation platform, [SK Docs](https://platform.stefankruik.com/documentation). If you are serious about using my products, I highly recommend reading the relevant articles. Don't have time for that? Don't hesitate to [reach out](https://skpvt.io/r/support). I am always open to have a chat and answer questions to your heart's content, unless I am debugging deployment 😄.

package/dist/index.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendMail = sendMail;
+const sk_platform_formatters_1 = require("@svkruik/sk-platform-formatters");
+const sk_uplink_connector_1 = require("@svkruik/sk-uplink-connector");
+const path_1 = require("path");
+async function sendMail(mailDetails, protocol, appName) {
+    if (!process.env.DISPATCH_HTTP_API_URL && protocol === "http")
+        return (0, sk_platform_formatters_1.logError)(new Error("DISPATCH_HTTP_API_URL is not defined in environment variables."));
+    try {
+        const callerFile = (0, path_1.basename)((new Error().stack?.split("\n")[2] || "").trim().split(" ").pop() || "unknown").replaceAll(")", "");
+        // Validate Email
+        if (!/^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(mailDetails.to))
+            throw new Error(`Invalid email address provided: ${mailDetails.to}`);
+        const payload = JSON.stringify({
+            mailDetails
+        });
+        if (protocol === "http") {
+            await fetch(process.env.DISPATCH_HTTP_API_URL, {
+                method: "POST",
+                headers: { "Content-Type": "application/json" },
+                body: payload
+            });
+        }
+        else
+            return await (0, sk_uplink_connector_1.sendUplink)({
+                "name": "unicast-services",
+                "router": "Dispatch",
+                "type": "direct"
+            }, {
+                "content": payload,
+                "reason": `Sending '${mailDetails.fileName}' mail via Dispatch Connector.`,
+                "recipient": "Dispatch",
+                "sender": appName,
+                "triggerSource": callerFile,
+                "task": "sendMail",
+                "timestamp": new Date()
+            });
+    }
+    catch (error) {
+        (0, sk_platform_formatters_1.logError)(error);
+    }
+}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@svkruik/sk-dispatch-connector",
+  "description": "Making dispatching mails a breeze.",
+  "keywords": [
+    "sk-platform",
+    "sk-dispatch",
+    "sk-uplink",
+    "amqp",
+    "rabbitmq"
+  ],
+  "version": "0.0.1",
+  "author": "Stefan Kruik",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/SVKruik-Organization/Dispatch.git"
+  },
+  "bugs": {
+    "url": "https://github.com/SVKruik-Organization/Dispatch/issues"
+  },
+  "homepage": "https://github.com/SVKruik-Organization/Dispatch#readme",
+  "license": "MIT",
+  "scripts": {
+    "build": "npx tsc",
+    "start": "ts-node index.ts"
+  },
+  "types": "types.d.ts",
+  "main": "dist/index.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist",
+    "types.d.ts"
+  ],
+  "dependencies": {
+    "@svkruik/sk-platform-formatters": "^0.0.5",
+    "@svkruik/sk-uplink-connector": "0.1.3"
+  },
+  "devDependencies": {
+    "@types/node": "^20.12.7",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.4.5"
+  }
+}

package/types.d.ts

@@ -0,0 +1,28 @@
+// Functions
+export function sendMail<T extends validFileNames>(
+    mailDetails: MailDetails<T>,
+    protocol: validProtocols
+): Promise<void>;
+
+// Types
+export type validProtocols = "amqp" | "http";
+export type validFileNames = "2fa-code" | "new-guest-login" | "new-login"
+export type ReplacementMap = {
+    "2fa-code": Array<
+        { key: "firstName"; value: string, },
+        { key: "platformName"; value: string },
+        { key: "verificationPin"; value: string | number }>,
+    "new-guest-login": Array<
+        { key: "adminName"; value: string },
+        { key: "guestName"; value: string },
+        { key: "platformName"; value: string }>,
+    "new-login": Array<
+        { key: "firstName"; value: string, },
+        { key: "platformName"; value: string }>,
+};
+
+export type MailDetails<T extends validFileNames> = {
+    to: string; // Email will be validated
+    replacements: ReplacementMap[T];
+    fileName: T;
+};