@arkstack/notifications 0.17.20 → 0.17.21

package/dist/index.d.ts

@@ -5,6 +5,7 @@ import { Logger } from "nodemailer/lib/shared/index.js";
 import MailMessage from "nodemailer/lib/mailer/mail-message.js";
 import { User } from "@app/models/User";
 import { User as User$1 } from "@arkstack/auth";
+import { Attachment } from "nodemailer/lib/mailer/index.js";
 import { PhoneNumber } from "@kanun-hq/plugin-phone";
 import { ArkormCollection, LengthAwarePaginator } from "arkormx";
 //#region src/Contracts/UserNotification.d.ts
@@ -299,6 +300,7 @@ declare class MailNotification extends NotificationContract {
   private htmlTemplate?;
   private textTemplate?;
   private fileDirectory?;
+  private attachmentList?;
   constructor(options?: MailNotificationOptions);
   /**
    * Prepare the mail driver so we can use it to relay the message
@@ -312,6 +314,18 @@ declare class MailNotification extends NotificationContract {
    * @returns
    */
   subject(subject: string): this;
+  /**
+   * Attachemnts to send with the mail
+   *
+   * @param attachments
+   */
+  attachments(attachments: Attachment[]): void;
+  /**
+   * A single attachemnt to send with the mail
+   *
+   * @param attachment
+   */
+  attachment(attachment: Attachment): void;
   /**
    * Set email the notification recipeint
    *

package/dist/index.js

@@ -212,6 +212,7 @@ var MailNotification = class extends NotificationContract {
 	htmlTemplate;
 	textTemplate;
 	fileDirectory;
+	attachmentList;
 	constructor(options = {}) {
 		super();
 		this.driverConfig = configure("drivers.mail", {});
@@ -305,6 +306,22 @@ var MailNotification = class extends NotificationContract {
 		return this;
 	}
 	/**
+	* Attachemnts to send with the mail
+	* 
+	* @param attachments 
+	*/
+	attachments(attachments) {
+		this.attachmentList = attachments;
+	}
+	/**
+	* A single attachemnt to send with the mail
+	* 
+	* @param attachment
+	*/
+	attachment(attachment) {
+		this.attachmentList = [...this.attachmentList ?? [], attachment];
+	}
+	/**
 	* Set email the notification recipeint
 	*
 	* @param recipient string or array of email addresses
@@ -391,6 +408,7 @@ var MailNotification = class extends NotificationContract {
 			html: this.htmlTemplate ? interpolate(this.htmlTemplate, templateData) : await globalThis.view(this.ViewName, templateData)
 		};
 		if (this.transport === "ses") payload.ses = this.sesOptions;
+		if (this.attachmentList) payload.attachments = this.attachmentList;
 		const result = await this.driver.sendMail(payload);
 		if (this.fileDirectory) await this.storeFileMail(payload, result);
 		return result;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/notifications",
-  "version": "0.17.20",
+  "version": "0.17.21",
   "type": "module",
   "description": "Framework-agnostic notification module for Arkstack and Nodejs, providing support for multi-channel notification delivery.",
   "homepage": "https://arkstack.toneflix.net/guide/notifications",
@@ -34,16 +34,16 @@
     "africastalking": "^0.8.0",
     "nodemailer": "^9.0.3",
     "twilio": "^6.0.2",
-    "@arkstack/common": "^0.17.20"
+    "@arkstack/common": "^0.17.21"
   },
   "peerDependencies": {
     "@kanun-hq/plugin-phone": "^0.1.8",
     "firebase-admin": "^13.0.0",
     "pusher": "^5.2.0",
-    "@arkstack/contract": "^0.17.20",
-    "@arkstack/database": "^0.17.20",
-    "@arkstack/driver-express": "^0.17.20",
-    "@arkstack/driver-h3": "^0.17.20"
+    "@arkstack/contract": "^0.17.21",
+    "@arkstack/database": "^0.17.21",
+    "@arkstack/driver-h3": "^0.17.21",
+    "@arkstack/driver-express": "^0.17.21"
   },
   "peerDependenciesMeta": {
     "@arkstack/driver-express": {