@arkstack/notifications 0.17.25 → 0.18.0

package/dist/index.d.ts

@@ -295,7 +295,7 @@ declare class DbNotification extends NotificationContract<UserNotification> {
    * @param realtime Set to false to disable realtime broadcast
    */
   broadcast(realtime?: boolean): void;
-  create(user: User, payload: DbNotificationPayload): Promise<UserNotification>;
+  create(user: User, payload: DbNotificationPayload): Promise<import("arkormx").Model<string | import("arkormx").ModelQuerySchemaLike | Record<string, unknown>, Record<string, unknown>>>;
   /**
    * Send the database notification
    *
@@ -305,7 +305,7 @@ declare class DbNotification extends NotificationContract<UserNotification> {
    * @param data
    * @returns
    */
-  send(message: string, subject?: string, _recipient?: NotificationRecipient, data?: NotificationData): Promise<UserNotification>;
+  send(message: string, subject?: string, _recipient?: NotificationRecipient, data?: NotificationData): Promise<import("arkormx").Model<string | import("arkormx").ModelQuerySchemaLike | Record<string, unknown>, Record<string, unknown>>>;
 }
 //#endregion
 //#region src/drivers/MailNotification.d.ts
@@ -425,6 +425,31 @@ declare class FirebaseRealtimeDriver implements RealtimeDriver {
   constructor(options?: FirebaseTransportConfig);
   private messaging;
   broadcast(channel: string | string[], event: string, payload: RealtimeNotificationPayload): Promise<string | FirebaseMulticastResult>;
+  /**
+   * Firebase channels do not require server-side authorization.
+   *
+   * @param _socketId
+   * @param _channel
+   * @param _data
+   */
+  auth(_socketId: string, _channel: string, _data?: unknown): Promise<void>;
+  /**
+   * Firebase does not require an authorization route.
+   *
+   * @param _authEndpoint
+   * @param _middleware
+   * @param _channelPrefix
+   * @param _config
+   */
+  static registerAuthRoute(_authEndpoint?: string, _middleware?: unknown | unknown[], _channelPrefix?: string, _config?: FirebaseTransportConfig): Promise<void>;
+  /**
+   * Firebase does not require an authorization route.
+   *
+   * @param _authEndpoint
+   * @param _middleware
+   * @param _channelPrefix
+   */
+  registerAuthRoute(_authEndpoint?: string, _middleware?: unknown | unknown[], _channelPrefix?: string): Promise<void>;
   /**
    * Send to many device tokens at once, chunked to FCM's 500-token limit, and
    * collect the tokens FCM rejects as dead so the caller can prune them.
@@ -497,9 +522,10 @@ declare class PusherRealtimeDriver implements RealtimeDriver {
  */
 interface RealtimeDriver {
   broadcast(channel: string | string[], event: string, payload: RealtimeNotificationPayload): Promise<unknown>;
-  auth?(socketId: string, channel: string, data?: unknown): unknown | Promise<unknown>;
+  auth(socketId: string, channel: string, data?: unknown): unknown | Promise<unknown>;
+  registerAuthRoute(authEndpoint?: string, middleware?: unknown | unknown[], channelPrefix?: string): Promise<void>;
 }
-type RealtimeNotificationDriver<T extends RealtimeDriverName> = T extends 'firebase' ? FirebaseRealtimeDriver : T extends 'firebase' ? PusherRealtimeDriver : RealtimeDriver;
+type RealtimeNotificationDriver<T extends RealtimeDriverName> = T extends 'firebase' ? FirebaseRealtimeDriver : T extends 'pusher' ? PusherRealtimeDriver : RealtimeDriver;
 //#endregion
 //#region src/drivers/RealtimeNotification.d.ts
 /**
@@ -698,8 +724,8 @@ declare class UserNotificationCenter {
    * @param user
    * @param payload
    */
-  static create(user: User, payload: DbNotificationPayload): Promise<UserNotification>;
-  static forUser(user: User): Promise<ArkormCollection<UserNotification, UserNotification[]>>;
+  static create(user: User, payload: DbNotificationPayload): Promise<import("arkormx").Model<string | import("arkormx").ModelQuerySchemaLike | Record<string, unknown>, Record<string, unknown>>>;
+  static forUser(user: User): Promise<ArkormCollection<import("arkormx").Model<string | import("arkormx").ModelQuerySchemaLike | Record<string, unknown>, Record<string, unknown>>, import("arkormx").Model<string | import("arkormx").ModelQuerySchemaLike | Record<string, unknown>, Record<string, unknown>>[]>>;
   /**
    * Fetch all the users unread messages
    *

package/dist/index.js

@@ -561,6 +561,31 @@ var FirebaseRealtimeDriver = class {
 		});
 	}
 	/**
+	* Firebase channels do not require server-side authorization.
+	* 
+	* @param _socketId 
+	* @param _channel 
+	* @param _data 
+	*/
+	async auth(_socketId, _channel, _data) {}
+	/** 
+	* Firebase does not require an authorization route.
+	* 
+	* @param _authEndpoint 
+	* @param _middleware 
+	* @param _channelPrefix 
+	* @param _config 
+	*/
+	static async registerAuthRoute(_authEndpoint = "/realtime/auth", _middleware, _channelPrefix, _config = {}) {}
+	/** 
+	* Firebase does not require an authorization route.
+	* 
+	* @param _authEndpoint 
+	* @param _middleware 
+	* @param _channelPrefix 
+	*/
+	async registerAuthRoute(_authEndpoint = "/realtime/auth", _middleware, _channelPrefix) {}
+	/**
 	* Send to many device tokens at once, chunked to FCM's 500-token limit, and
 	* collect the tokens FCM rejects as dead so the caller can prune them.
 	*/

package/package.json

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