@arkstack/notifications 0.17.21 → 0.17.23

package/dist/index.d.ts

@@ -237,6 +237,10 @@ interface NotificationConfig<T = any> {
       admin_sdk_path: string;
     };
   };
+  queue?: {
+    name?: string;
+    connection?: string;
+  };
 }
 type MergedTransportConfig = MergedConfig<Required<NotificationConfig['transports']>[NonNullable<MailDriverOptions['transport']>]>;
 type MailNotificationOptions = MailDriverOptions & {
@@ -246,11 +250,29 @@ type MailNotificationOptions = MailDriverOptions & {
 //#region src/Contracts/NotificationContract.d.ts
 declare abstract class NotificationContract<TResult = DriverResult> {
   protected contextData: NotificationData;
+  /**
+   * Send your notification
+   *
+   * @param message
+   * @param subject
+   * @param recipient
+   * @param data
+   */
   abstract send(message: string, subject?: string, recipient?: NotificationRecipient, data?: NotificationData): Promise<TResult>;
   abstract from(from: string): this;
   abstract subject(subject: string): this;
   abstract recipient(recipient: NotificationRecipient): this;
   data(data: NotificationData): this;
+  /**
+   * Send the notification to our configured queue
+   *
+   * @param message
+   * @param subject
+   * @param recipient
+   * @param data
+   * @returns
+   */
+  queue(message: string, subject?: string, recipient?: NotificationRecipient, data?: NotificationData): Promise<string>;
   protected mergeData(data?: NotificationData): {
     year: number;
   };
@@ -319,13 +341,13 @@ declare class MailNotification extends NotificationContract {
    *
    * @param attachments
    */
-  attachments(attachments: Attachment[]): void;
+  attachments(attachments: Attachment[]): this;
   /**
    * A single attachemnt to send with the mail
    *
    * @param attachment
    */
-  attachment(attachment: Attachment): void;
+  attachment(attachment: Attachment): this;
   /**
    * Set email the notification recipeint
    *
@@ -712,7 +734,7 @@ declare class UserNotificationCenter {
 }
 //#endregion
 //#region src/config.d.ts
-declare const configure: <T extends DotPath<NotificationConfig>>(key: T, defaultValue: unknown) => DotPathValue<NotificationConfig, T>;
+declare const configure: <T extends DotPath<NotificationConfig>>(key: T, defaultValue?: unknown) => DotPathValue<NotificationConfig, T>;
 //#endregion
 //#region src/utils/template.d.ts
 declare const interpolate: (value: string, data?: NotificationData) => string;

package/dist/index.js

@@ -1,3 +1,4 @@
+import { Job } from "@arkstack/jobs";
 import { RequestException, config as config$1, env, getModel } from "@arkstack/common";
 import { mkdir, writeFile } from "node:fs/promises";
 import path, { join } from "node:path";
@@ -8,6 +9,37 @@ import { randomUUID } from "node:crypto";
 import africastalking from "africastalking";
 import twilio from "twilio";
 import { Model } from "@arkstack/database";
+//#region src/jobs/SendNotification.ts
+var SendNotification = class extends Job {
+	notification;
+	message;
+	subject;
+	recipient;
+	data;
+	tries = 3;
+	backoff = 30;
+	constructor(notification, message, subject, recipient, data) {
+		super();
+		this.notification = notification;
+		this.message = message;
+		this.subject = subject;
+		this.recipient = recipient;
+		this.data = data;
+	}
+	async handle() {
+		await this.notification.send(this.message, this.subject, this.recipient, this.data);
+	}
+};
+//#endregion
+//#region src/config.ts
+const configure = (key, defaultValue) => {
+	try {
+		return config$1(`notifications.${key}`, defaultValue);
+	} catch {
+		return defaultValue;
+	}
+};
+//#endregion
 //#region src/Contracts/NotificationContract.ts
 var NotificationContract = class {
 	contextData = {};
@@ -15,6 +47,21 @@ var NotificationContract = class {
 		this.contextData = data;
 		return this;
 	}
+	/**
+	* Send the notification to our configured queue
+	* 
+	* @param message 
+	* @param subject 
+	* @param recipient 
+	* @param data 
+	* @returns 
+	*/
+	async queue(message, subject, recipient, data) {
+		const job = SendNotification.dispatch(this, message, subject, recipient, data);
+		if (configure("queue.name")) job.onQueue(configure("queue.name"));
+		if (configure("queue.connection")) job.onConnection(configure("queue.connection"));
+		return job;
+	}
 	mergeData(data) {
 		return {
 			...this.contextData,
@@ -189,15 +236,6 @@ var DbNotification = class extends NotificationContract {
 	}
 };
 //#endregion
-//#region src/config.ts
-const configure = (key, defaultValue) => {
-	try {
-		return config$1(`notifications.${key}`, defaultValue);
-	} catch {
-		return defaultValue;
-	}
-};
-//#endregion
 //#region src/drivers/MailNotification.ts
 var MailNotification = class extends NotificationContract {
 	driver;
@@ -312,6 +350,7 @@ var MailNotification = class extends NotificationContract {
 	*/
 	attachments(attachments) {
 		this.attachmentList = attachments;
+		return this;
 	}
 	/**
 	* A single attachemnt to send with the mail
@@ -320,6 +359,7 @@ var MailNotification = class extends NotificationContract {
 	*/
 	attachment(attachment) {
 		this.attachmentList = [...this.attachmentList ?? [], attachment];
+		return this;
 	}
 	/**
 	* Set email the notification recipeint

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/notifications",
-  "version": "0.17.21",
+  "version": "0.17.23",
   "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,17 @@
     "africastalking": "^0.8.0",
     "nodemailer": "^9.0.3",
     "twilio": "^6.0.2",
-    "@arkstack/common": "^0.17.21"
+    "@arkstack/common": "^0.17.23"
   },
   "peerDependencies": {
     "@kanun-hq/plugin-phone": "^0.1.8",
     "firebase-admin": "^13.0.0",
     "pusher": "^5.2.0",
-    "@arkstack/contract": "^0.17.21",
-    "@arkstack/database": "^0.17.21",
-    "@arkstack/driver-h3": "^0.17.21",
-    "@arkstack/driver-express": "^0.17.21"
+    "@arkstack/contract": "^0.17.22",
+    "@arkstack/database": "^0.17.22",
+    "@arkstack/driver-express": "^0.17.23",
+    "@arkstack/jobs": "^0.17.23",
+    "@arkstack/driver-h3": "^0.17.23"
   },
   "peerDependenciesMeta": {
     "@arkstack/driver-express": {