@8ms/helpers 2.0.46 → 2.1.0

package/.yarnrc.yml

@@ -1,2 +1,3 @@
 nodeLinker: node-modules
-yarnPath: .yarn/releases/yarn-4.9.2.cjs
+
+yarnPath: .yarn/releases/yarn-4.9.4.cjs

package/aws/ses/SimpleEmail.d.ts

@@ -1,4 +1,10 @@
 import { BaseClass } from "../../_class";
+type AttachmentSource = {
+    filename: string;
+    contentType?: string;
+    data64?: string;
+    url?: string;
+};
 type ConstructorProps = {
     bcc?: string[];
     cc?: string[];
@@ -6,6 +12,7 @@ type ConstructorProps = {
     html?: string;
     subject?: string;
     to?: string | string[];
+    attachments?: AttachmentSource[];
 };
 /**
  * Class to build and send an AWS SES email.
@@ -17,17 +24,29 @@ export declare class SimpleEmail extends BaseClass {
     bcc: string[];
     html?: string;
     subject?: string;
-    constructor({ bcc, cc, from, html, subject, to }: ConstructorProps);
+    attachments: AttachmentSource[];
+    constructor({ bcc, cc, from, html, subject, to, attachments }: ConstructorProps);
     setFrom: (from: string) => this;
     setHtml: (html: string) => this;
     setSubject: (subject: string) => this;
+    setAttachments: (attachments: AttachmentSource[]) => this;
+    addAttachment: (attachment: AttachmentSource) => this;
+    addAttachmentFromData64: (filename: string, data64: string, contentType?: string) => this;
+    addAttachmentFromUrl: (filename: string, url: string, contentType?: string) => this;
+    clearAttachments: () => this;
     pushBcc: (recipient: string | string[]) => this;
     pushCc: (recipient: string | string[]) => this;
     pushTo: (recipient: string | string[]) => this;
     setBcc: (recipient: string | string[]) => this;
     setCc: (recipient: string | string[]) => this;
     setTo: (recipient: string | string[]) => this;
-    getSendParam: () => {
+    getSendParam: () => Promise<{
+        Destinations: string[];
+        RawMessage: {
+            Data: string;
+        };
+        Source: string;
+    } | {
         Destination: {
             BccAddresses: string[];
             CcAddresses: string[];
@@ -50,7 +69,10 @@ export declare class SimpleEmail extends BaseClass {
             };
         };
         Source: string;
-    };
+    }>;
+    private _getRawEmailParams;
+    private _getAttachmentData;
+    private _getContentTypeFromFilename;
     private _filterRecipients;
 }
 export {};

package/aws/ses/SimpleEmail.js

@@ -1,4 +1,37 @@
 "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 __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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -10,11 +43,12 @@ const _class_1 = require("../../_class");
  * Class to build and send an AWS SES email.
  */
 class SimpleEmail extends _class_1.BaseClass {
-    constructor({ bcc, cc, from, html, subject, to }) {
+    constructor({ bcc, cc, from, html, subject, to, attachments }) {
         super();
         this.to = [];
         this.cc = [];
         this.bcc = [];
+        this.attachments = [];
         this.setFrom = (from) => {
             return this._setValue("from", from);
         };
@@ -24,6 +58,31 @@ class SimpleEmail extends _class_1.BaseClass {
         this.setSubject = (subject) => {
             return this._setValue("subject", subject);
         };
+        this.setAttachments = (attachments) => {
+            return this._setValue("attachments", attachments);
+        };
+        this.addAttachment = (attachment) => {
+            this.attachments.push(attachment);
+            return this;
+        };
+        this.addAttachmentFromData64 = (filename, data64, contentType) => {
+            return this.addAttachment({
+                filename,
+                data64,
+                contentType: contentType || this._getContentTypeFromFilename(filename)
+            });
+        };
+        this.addAttachmentFromUrl = (filename, url, contentType) => {
+            return this.addAttachment({
+                filename,
+                url,
+                contentType: contentType || this._getContentTypeFromFilename(filename)
+            });
+        };
+        this.clearAttachments = () => {
+            this.attachments = [];
+            return this;
+        };
         this.pushBcc = (recipient) => {
             return this._push("bcc", recipient);
         };
@@ -42,7 +101,11 @@ class SimpleEmail extends _class_1.BaseClass {
         this.setTo = (recipient) => {
             return this._setArray("to", recipient);
         };
-        this.getSendParam = () => {
+        this.getSendParam = async () => {
+            // For emails with attachments, we need to use SendRawEmail instead of SendEmail
+            if (this.attachments.length > 0) {
+                return await this._getRawEmailParams();
+            }
             // https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/ses-examples-sending-email.html
             const params = {
                 Destination: {
@@ -70,6 +133,110 @@ class SimpleEmail extends _class_1.BaseClass {
             };
             return params;
         };
+        this._getRawEmailParams = async () => {
+            const boundary = `----=_NextPart_${Date.now()}_${Math.random()
+                .toString(36)
+                .substr(2, 9)}`;
+            // Build recipients list
+            const allRecipients = [
+                ...this._filterRecipients("to"),
+                ...this._filterRecipients("cc"),
+                ...this._filterRecipients("bcc")
+            ];
+            // Build email headers
+            let rawMessage = "";
+            rawMessage += `From: ${this.from}\r\n`;
+            if (this._filterRecipients("to").length > 0) {
+                rawMessage += `To: ${this._filterRecipients("to")
+                    .join(", ")}\r\n`;
+            }
+            if (this._filterRecipients("cc").length > 0) {
+                rawMessage += `Cc: ${this._filterRecipients("cc")
+                    .join(", ")}\r\n`;
+            }
+            rawMessage += `Subject: ${this.subject}\r\n`;
+            rawMessage += `MIME-Version: 1.0\r\n`;
+            rawMessage += `Content-Type: multipart/mixed; boundary="${boundary}"\r\n\r\n`;
+            // Add HTML body
+            rawMessage += `--${boundary}\r\n`;
+            rawMessage += `Content-Type: text/html; charset=UTF-8\r\n`;
+            rawMessage += `Content-Transfer-Encoding: 7bit\r\n\r\n`;
+            rawMessage += `${this.html}\r\n\r\n`;
+            // Add attachments
+            for (const attachment of this.attachments) {
+                const attachmentData = await this._getAttachmentData(attachment);
+                rawMessage += `--${boundary}\r\n`;
+                rawMessage += `Content-Type: ${attachment.contentType || "application/octet-stream"}\r\n`;
+                rawMessage += `Content-Disposition: attachment; filename="${attachment.filename}"\r\n`;
+                rawMessage += `Content-Transfer-Encoding: base64\r\n\r\n`;
+                rawMessage += `${attachmentData}\r\n\r\n`;
+            }
+            rawMessage += `--${boundary}--\r\n`;
+            return {
+                Destinations: allRecipients,
+                RawMessage: {
+                    Data: rawMessage
+                },
+                Source: this.from
+            };
+        };
+        this._getAttachmentData = async (attachment) => {
+            // If data is already provided as base64
+            if (attachment.data64) {
+                // Remove data URL prefix if present (e.g., "data:image/png;base64,")
+                return attachment.data64.replace(/^data:[^;]+;base64,/, "");
+            }
+            // If URL is provided, fetch the data
+            if (attachment.url) {
+                const fetch = await Promise.resolve().then(() => __importStar(require("node-fetch"))).then(mod => mod.default);
+                const response = await fetch(attachment.url);
+                const buffer = await response.buffer();
+                return buffer.toString("base64");
+            }
+            throw new Error(`No valid data source provided for attachment: ${attachment.filename}`);
+        };
+        this._getContentTypeFromFilename = (filename) => {
+            const extension = filename.split(".")
+                .pop()
+                ?.toLowerCase();
+            const mimeTypes = {
+                // Images
+                "jpg": "image/jpeg",
+                "jpeg": "image/jpeg",
+                "png": "image/png",
+                "gif": "image/gif",
+                "svg": "image/svg+xml",
+                "webp": "image/webp",
+                "bmp": "image/bmp",
+                "ico": "image/x-icon",
+                // Documents
+                "pdf": "application/pdf",
+                "doc": "application/msword",
+                "docx": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
+                "xls": "application/vnd.ms-excel",
+                "xlsx": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
+                "ppt": "application/vnd.ms-powerpoint",
+                "pptx": "application/vnd.openxmlformats-officedocument.presentationml.presentation",
+                // Data
+                "csv": "text/csv",
+                "json": "application/json",
+                "xml": "application/xml",
+                "txt": "text/plain",
+                // Archives
+                "zip": "application/zip",
+                "rar": "application/x-rar-compressed",
+                "7z": "application/x-7z-compressed",
+                "tar": "application/x-tar",
+                "gz": "application/gzip",
+                // Audio/Video
+                "mp3": "audio/mpeg",
+                "wav": "audio/wav",
+                "mp4": "video/mp4",
+                "avi": "video/x-msvideo",
+                "mov": "video/quicktime",
+            };
+            return mimeTypes[extension || ""] || "application/octet-stream";
+        };
         this._filterRecipients = (field) => {
             // Remove all undefined and null values
             let response = this[field].filter(recipient => recipient && null !== recipient);
@@ -100,6 +267,9 @@ class SimpleEmail extends _class_1.BaseClass {
         if (to) {
             this.setTo(to);
         }
+        if (attachments) {
+            this.setAttachments(attachments);
+        }
         return this;
     }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@8ms/helpers",
 	"license": "UNLICENSED",
-	"version": "2.0.46",
+	"version": "2.1.0",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/8millionstories-organisation/8ms-helpers-ts.git"
@@ -183,5 +183,5 @@
 		"tslib": "2.8.1",
 		"typescript": "^5.0.0"
 	},
-	"packageManager": "yarn@4.9.2"
+	"packageManager": "yarn@4.9.4"
 }

package/util/promiseChunks.d.ts

@@ -2,4 +2,4 @@
  * Chunk a queue of promises into controlled chunks to prevent overloading.
  * https://stackoverflow.com/a/53964407
  */
-export declare const promiseChunks: (promises: Promise<any>[], size: number) => Promise<any[]>;
+export declare const promiseChunks: (promises: Promise<any>[], size: number, sleepSeconds?: number) => Promise<any[]>;

package/util/promiseChunks.js

@@ -2,17 +2,19 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.promiseChunks = void 0;
 const lodash_1 = require("lodash");
+const sleep_1 = require("./sleep");
 /**
  * Chunk a queue of promises into controlled chunks to prevent overloading.
  * https://stackoverflow.com/a/53964407
  */
-const promiseChunks = async (promises, size) => {
+const promiseChunks = async (promises, size, sleepSeconds = 0) => {
     const batches = (0, lodash_1.chunk)(promises, size);
     let results = [];
     while (batches.length) {
         const batch = batches.shift();
         const result = await Promise.all(batch);
         results.push(result);
+        await (0, sleep_1.sleep)(sleepSeconds);
     }
     return (0, lodash_1.flatten)(results);
 };