@arkstack/notifications 0.16.11 → 0.16.13

package/dist/index.d.ts

@@ -4,6 +4,7 @@ import { Model } from "@arkstack/database";
 import { User } from "@app/models/User";
 import { User as User$1 } from "@arkstack/auth";
 import { PhoneNumber } from "@kanun-hq/plugin-phone";
+import { ArkormCollection, LengthAwarePaginator } from "arkormx";
 
 //#region src/Contracts/UserNotification.d.ts
 declare abstract class UserNotification extends Model {
@@ -214,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
@@ -357,10 +374,19 @@ declare class RealtimeNotification extends NotificationContract<RealtimeBroadcas
    * @returns
    */
   store(store?: boolean): this;
-  type(type: DbNotificationType | null): this;
+  type(type?: DbNotificationType | null): this;
   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
@@ -421,12 +447,53 @@ declare class Notification<D extends keyof DriverMap = keyof DriverMap> {
 //#region src/UserNotificationCenter.d.ts
 declare class UserNotificationCenter {
   private static getModel;
+  /**
+   * Create a database notification then broadcast it using the configured realtime driver
+   *
+   * @param user
+   * @param payload
+   */
+  static send(user: User, payload: DbNotificationPayload, channel?: string[]): Promise<RealtimeBroadcastResult>;
+  private static resolvePushTokens;
+  /**
+   * Create a database notification
+   *
+   * @param user
+   * @param payload
+   */
   static create(user: User, payload: DbNotificationPayload): Promise<UserNotification>;
-  static forUser(user: User): Promise<import("arkormx").ArkormCollection<UserNotification, UserNotification[]>>;
-  static unreadForUser(user: User): Promise<import("arkormx").ArkormCollection<UserNotification, UserNotification[]>>;
-  static markRead(notification: UserNotification | UserNotification['id']): Promise<void>;
-  static markAllRead(user: User): Promise<void>;
-  static delete(notification: UserNotification | UserNotification['id']): Promise<void>;
+  static forUser(user: User): Promise<ArkormCollection<UserNotification, UserNotification[]>>;
+  /**
+   * Fetch all the users unread messages
+   *
+   * @param user
+   */
+  static unreadForUser(user: User): Promise<ArkormCollection<UserNotification, UserNotification[]>>;
+  /**
+   * Fetch all the users unread messages with a lenght aware paginator instance
+   *
+   * @param user
+   * @param perPage
+   */
+  static unreadForUser(user: User, perPage: number): Promise<LengthAwarePaginator<UserNotification>>;
+  /**
+   * Mark the notification as read
+   *
+   * @param notification
+   */
+  static markRead(notification: UserNotification | string | number): Promise<void>;
+  /**
+   * Mark all unread notifications as read
+   *
+   * @param user
+   */
+  static markAllRead(user: User, ids?: string[] | number[]): Promise<void>;
+  /**
+   * Delete the indicated notifications
+   *
+   * @param notification
+   */
+  static delete(notification: UserNotification | string | number | UserNotification[] | string[] | number[]): Promise<void>;
 }
 //#endregion
 //#region src/config.d.ts

package/dist/index.js

@@ -29,6 +29,26 @@ var UserNotificationCenter = class {
 	static async getModel() {
 		return await getModel("UserNotification");
 	}
+	/**
+	* Create a database notification then broadcast it using the configured realtime driver
+	* 
+	* @param user 
+	* @param payload 
+	*/
+	static async send(user, payload, channel = []) {
+		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
+	* 
+	* @param user 
+	* @param payload 
+	*/
 	static async create(user, payload) {
 		return await (await this.getModel()).query().create({
 			userId: user.id,
@@ -43,12 +63,19 @@ var UserNotificationCenter = class {
 	static async forUser(user) {
 		return await (await this.getModel()).query().where({ userId: user.id }).get();
 	}
-	static async unreadForUser(user) {
-		return await (await this.getModel()).query().where({
+	static async unreadForUser(user, perPage) {
+		const query = (await this.getModel()).query().where({
 			userId: user.id,
 			readAt: null
-		}).get();
+		});
+		if (perPage) return await query.paginate();
+		return await query.get();
 	}
+	/**
+	* Mark the notification as read
+	* 
+	* @param notification 
+	*/
 	static async markRead(notification) {
 		const Model = await this.getModel();
 		const id = typeof notification === "object" ? notification.id : notification;
@@ -56,16 +83,33 @@ var UserNotificationCenter = class {
 		await Model.query().where({ id }).update({ readAt });
 		if (typeof notification === "object") notification.readAt = readAt;
 	}
-	static async markAllRead(user) {
-		await (await this.getModel()).query().where({
+	/**
+	* Mark all unread notifications as read
+	* 
+	* @param user 
+	*/
+	static async markAllRead(user, ids) {
+		const query = (await this.getModel()).query().where({
 			userId: user.id,
 			readAt: null
-		}).update({ readAt: /* @__PURE__ */ new Date() });
+		});
+		if (ids) query.whereIn("id", ids);
+		await query.update({ readAt: /* @__PURE__ */ new Date() });
 	}
+	/**
+	* Delete the indicated notifications
+	* 
+	* @param notification 
+	*/
 	static async delete(notification) {
 		const Model = await this.getModel();
-		const id = typeof notification === "object" ? notification.id : notification;
-		await Model.query().where({ id }).delete();
+		if (Array.isArray(notification)) {
+			const ids = notification.map((e) => typeof e === "object" ? e.id : e);
+			await Model.query().whereIn("id", ids).delete();
+		} else {
+			const id = typeof notification === "object" ? notification.id : notification;
+			await Model.query().where({ id }).delete();
+		}
 	}
 };
 //#endregion
@@ -81,6 +125,7 @@ const interpolate = (value, data = {}) => {
 var DbNotification = class extends NotificationContract {
 	user;
 	payload = {};
+	realtime = false;
 	from(_from) {
 		return this;
 	}
@@ -108,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);
@@ -545,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);
@@ -568,7 +640,7 @@ var RealtimeNotification = class extends NotificationContract {
 			read_at: stored?.readAt ? new Date(stored.readAt).toISOString() : null,
 			created_at: stored?.createdAt ? new Date(stored.createdAt).toISOString() : (/* @__PURE__ */ new Date()).toISOString()
 		};
-		await this.driver.broadcast(channel, this.eventName, payload);
+		if (channel && channel.length > 0) await this.driver.broadcast(channel, this.eventName, payload);
 		return {
 			channel,
 			event: this.eventName,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/notifications",
-  "version": "0.16.11",
+  "version": "0.16.13",
   "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.11"
+    "@arkstack/common": "^0.16.13"
   },
   "peerDependencies": {
     "@kanun-hq/plugin-phone": "^0.1.8",
     "firebase-admin": "^13.0.0",
     "pusher": "^5.2.0",
-    "@arkstack/contract": "^0.16.11",
-    "@arkstack/database": "^0.16.11"
+    "@arkstack/contract": "^0.16.13",
+    "@arkstack/database": "^0.16.13"
   },
   "peerDependenciesMeta": {
     "pusher": {