@arkstack/notifications 0.17.11 → 0.17.13

package/dist/index.d.ts

@@ -392,6 +392,20 @@ declare class FirebaseRealtimeDriver implements RealtimeDriver {
 }
 //#endregion
 //#region src/drivers/realtime/PusherRealtimeDriver.d.ts
+/** The slice of the `pusher` server SDK this driver uses. */
+interface PusherClient {
+  trigger(channel: string | string[], event: string, data: unknown): Promise<unknown>;
+  authorizeChannel(socketId: string, channel: string, data?: {
+    user_id: string;
+    user_info?: {
+      [key: string]: any;
+    };
+  }): {
+    auth: string;
+    channel_data?: string;
+    shared_secret?: string;
+  };
+}
 /**
  * Broadcasts notifications over [Pusher Channels](https://pusher.com/channels).
  *
@@ -404,6 +418,21 @@ declare class PusherRealtimeDriver implements RealtimeDriver {
   constructor(options?: PusherTransportConfig);
   private client;
   broadcast(channel: string | string[], event: string, payload: RealtimeNotificationPayload): Promise<unknown>;
+  /**
+   * Authourize a pusher channel
+   *
+   * @param socketId
+   * @param channel
+   * @returns
+   */
+  auth(socketId: string, channel: string, data?: Parameters<PusherClient['authorizeChannel']>[2]): Promise<ReturnType<PusherClient['authorizeChannel']>>;
+  /**
+   * Register a realtime autorization route
+   *
+   * @param authEndpoint
+   * @param middleware
+   */
+  registerAuthRoute(authEndpoint?: string, middleware?: unknown | unknown[]): Promise<void>;
 }
 //#endregion
 //#region src/Contracts/RealtimeDriver.d.ts
@@ -417,6 +446,7 @@ 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>;
 }
 type RealtimeNotificationDriver<T extends RealtimeDriverName> = T extends 'firebase' ? FirebaseRealtimeDriver : T extends 'firebase' ? PusherRealtimeDriver : RealtimeDriver;
 //#endregion

package/dist/index.js

@@ -222,18 +222,19 @@ var MailNotification = class extends NotificationContract {
 	* Prepare the mail driver so we can use it to relay the message
 	*/
 	async prepareDriver() {
+		const options = this.options;
+		this.fromAddress = options.from ?? this.driverConfig.from ?? env("MAIL_FROM_ADDRESS", "no-reply@example.com");
 		if (typeof this.transport !== "string") {
 			this.driver = nodemailer.createTransport(this.transport);
 			return;
 		}
-		const options = this.options;
 		const transport = configure(`transports.${this.transport}`, {});
+		this.fromAddress = transport.from || this.fromAddress;
 		/**
 		* Setup nodemailer to stream messages so we can store the mail to file
 		*/
 		if (this.transport === "file") {
 			this.fileDirectory = options.directory ?? transport.directory ?? env("MAIL_FILE_PATH", join(Arkstack.rootDir(), "./storage/framework/mails"));
-			this.fromAddress = options.from ?? this.driverConfig.from ?? transport.from ?? env("MAIL_FROM_ADDRESS", "no-reply@example.com");
 			this.driver = nodemailer.createTransport({
 				streamTransport: true,
 				buffer: true
@@ -272,7 +273,6 @@ var MailNotification = class extends NotificationContract {
 		}
 		const user = options.user ?? transport.auth?.user ?? transport.user ?? env("MAIL_USERNAME", "");
 		const pass = options.pass ?? transport.auth?.pass ?? transport.pass ?? env("MAIL_PASSWORD", "");
-		this.fromAddress = options.from ?? this.driverConfig.from ?? transport.from ?? env("MAIL_FROM_ADDRESS", "no-reply@example.com");
 		this.driver = nodemailer.createTransport({
 			url: transport.url ?? options.url ?? env("MAIL_URL"),
 			host: options.host ?? transport.host ?? env("MAIL_HOST", "localhost"),
@@ -560,6 +560,44 @@ var PusherRealtimeDriver = class {
 	async broadcast(channel, event, payload) {
 		return await (await this.client()).trigger(channel, event, payload);
 	}
+	/**
+	* Authourize a pusher channel
+	* 
+	* @param socketId 
+	* @param channel 
+	* @returns 
+	*/
+	async auth(socketId, channel, data) {
+		return (await this.client()).authorizeChannel(socketId, channel, data);
+	}
+	/**
+	* Register a realtime autorization route
+	* 
+	* @param authEndpoint 
+	* @param middleware 
+	*/
+	async registerAuthRoute(authEndpoint = "/realtime/auth", middleware) {
+		const client = await this.client();
+		for (const [name, path] of Object.entries({
+			express: "@arkstack/driver-express",
+			h3: "@arkstack/driver-express"
+		})) {
+			const midsPath = `${path}/middlewares`;
+			try {
+				const { Router } = await import(path);
+				const { auth } = await import(midsPath);
+				const middlewares = new Set(Array.isArray(middleware) ? middleware.concat(auth) : [middleware, auth]);
+				Router.post(authEndpoint, ({ clearRequest }) => {
+					const channel = clearRequest.input("channel_name");
+					const socketId = clearRequest.input("socket_id");
+					return client.authorizeChannel(socketId, channel);
+				}).middleware(Array.from(middlewares));
+				break;
+			} catch (e) {
+				console.error(`Failed to register auth route for ${name}: ${e instanceof Error ? e.message : e}`);
+			}
+		}
+	}
 };
 //#endregion
 //#region src/drivers/RealtimeNotification.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/notifications",
-  "version": "0.17.11",
+  "version": "0.17.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,16 +34,24 @@
     "africastalking": "^0.8.0",
     "nodemailer": "^9.0.3",
     "twilio": "^6.0.2",
-    "@arkstack/common": "^0.17.11"
+    "@arkstack/common": "^0.17.13"
   },
   "peerDependencies": {
     "@kanun-hq/plugin-phone": "^0.1.8",
     "firebase-admin": "^13.0.0",
     "pusher": "^5.2.0",
-    "@arkstack/contract": "^0.17.11",
-    "@arkstack/database": "^0.17.11"
+    "@arkstack/contract": "^0.17.13",
+    "@arkstack/database": "^0.17.13",
+    "@arkstack/driver-express": "^0.17.13",
+    "@arkstack/driver-h3": "^0.17.13"
   },
   "peerDependenciesMeta": {
+    "@arkstack/driver-express": {
+      "optional": true
+    },
+    "@arkstack/driver-h3": {
+      "optional": true
+    },
     "pusher": {
       "optional": true
     },