@arkstack/notifications 0.16.12 → 0.17.0

package/dist/index.d.ts

@@ -215,13 +215,29 @@ declare abstract class NotificationContract<TResult = DriverResult> {
 declare class DbNotification extends NotificationContract<UserNotification> {
   private user?;
   private payload;
+  private realtime;
   from(_from: string): this;
   subject(subject: string): this;
   recipient(recipient: NotificationRecipient | User): this;
   type(type: DbNotificationPayload['type']): this;
   action(text?: string | null, link?: string | null): this;
   meta(meta?: NotificationData | null): this;
+  /**
+   * Broadcast the notification using the default realtime driver.
+   *
+   * @param realtime Set to false to disable realtime broadcast
+   */
+  broadcast(realtime?: boolean): void;
   create(user: User, payload: DbNotificationPayload): Promise<UserNotification>;
+  /**
+   * Send the database notification
+   *
+   * @param message
+   * @param subject
+   * @param _recipient
+   * @param data
+   * @returns
+   */
   send(message: string, subject?: string, _recipient?: NotificationRecipient, data?: NotificationData): Promise<UserNotification>;
 }
 //#endregion
@@ -362,6 +378,15 @@ declare class RealtimeNotification extends NotificationContract<RealtimeBroadcas
   action(text?: string | null, link?: string | null): this;
   meta(meta?: NotificationData | null): this;
   private resolveChannel;
+  /**
+   * Send a realtime notification using the default realtime driver
+   *
+   * @param message
+   * @param subject
+   * @param _recipient
+   * @param data
+   * @returns
+   */
   send(message: string, subject?: string, _recipient?: NotificationRecipient, data?: NotificationData): Promise<RealtimeBroadcastResult>;
 }
 //#endregion
@@ -429,6 +454,7 @@ declare class UserNotificationCenter {
    * @param payload
    */
   static send(user: User, payload: DbNotificationPayload, channel?: string[]): Promise<RealtimeBroadcastResult>;
+  private static resolvePushTokens;
   /**
    * Create a database notification
    *

package/dist/index.js

@@ -36,7 +36,12 @@ var UserNotificationCenter = class {
 	* @param payload 
 	*/
 	static async send(user, payload, channel = []) {
-		return await Notification.realtime().store().channel(user.pushTokens ?? channel).meta(payload.meta).type(payload.type).subject(payload.title).action(payload.actionText, payload.actionLink).send(payload.description, payload.title, void 0, payload);
+		return await Notification.realtime().store().channel(this.resolvePushTokens(user.pushTokens ?? channel)).meta(payload.meta).type(payload.type).subject(payload.title).action(payload.actionText, payload.actionLink).send(payload.description, payload.title, void 0, payload);
+	}
+	static resolvePushTokens(pushTokens) {
+		if (!pushTokens) return [];
+		if (Array.isArray(pushTokens)) return pushTokens.map((e) => typeof e === "string" ? e : e.token);
+		return [typeof pushTokens === "string" ? pushTokens : pushTokens.token];
 	}
 	/**
 	* Create a database notification
@@ -120,6 +125,7 @@ const interpolate = (value, data = {}) => {
 var DbNotification = class extends NotificationContract {
 	user;
 	payload = {};
+	realtime = false;
 	from(_from) {
 		return this;
 	}
@@ -147,10 +153,28 @@ var DbNotification = class extends NotificationContract {
 		this.payload.meta = meta;
 		return this;
 	}
+	/**
+	* Broadcast the notification using the default realtime driver.
+	* 
+	* @param realtime Set to false to disable realtime broadcast
+	*/
+	broadcast(realtime = true) {
+		this.realtime = realtime;
+	}
 	async create(user, payload) {
 		await getModel("UserNotification");
+		if (this.realtime) return await UserNotificationCenter.send(user, payload);
 		return await UserNotificationCenter.create(user, payload);
 	}
+	/**
+	* Send the database notification
+	* 
+	* @param message 
+	* @param subject 
+	* @param _recipient 
+	* @param data 
+	* @returns 
+	*/
 	async send(message, subject, _recipient, data) {
 		if (!this.user) throw new Error("No user recipient provided for database notification");
 		const mergedData = this.mergeData(data);
@@ -584,6 +608,15 @@ var RealtimeNotification = class extends NotificationContract {
 		if (this.user) return `${this.channelPrefix}${this.user.id}`;
 		throw new Error("No channel resolved for realtime notification (provide a user or channel)");
 	}
+	/**
+	* Send a realtime notification using the default realtime driver
+	* 
+	* @param message 
+	* @param subject 
+	* @param _recipient 
+	* @param data 
+	* @returns 
+	*/
 	async send(message, subject, _recipient, data) {
 		const channel = this.resolveChannel();
 		const mergedData = this.mergeData(data);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/notifications",
-  "version": "0.16.12",
+  "version": "0.17.0",
   "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,14 +34,14 @@
     "africastalking": "^0.8.0",
     "nodemailer": "^8.0.7",
     "twilio": "^6.0.0",
-    "@arkstack/common": "^0.16.12"
+    "@arkstack/common": "^0.17.0"
   },
   "peerDependencies": {
     "@kanun-hq/plugin-phone": "^0.1.8",
     "firebase-admin": "^13.0.0",
     "pusher": "^5.2.0",
-    "@arkstack/contract": "^0.16.12",
-    "@arkstack/database": "^0.16.12"
+    "@arkstack/contract": "^0.17.0",
+    "@arkstack/database": "^0.17.0"
   },
   "peerDependenciesMeta": {
     "pusher": {