@arkstack/notifications 0.19.2 → 0.19.4

package/README.md

@@ -5,21 +5,19 @@
 Framework-agnostic notification module for Arkstack and Nodejs, providing support for multi-channel notification delivery.
 
 ```ts
-import { Notification } from '@arkstack/notifications';
+import { Notification } from '@arkstack/notifications'
 
 await Notification.mail()
   .recipient({ 'ada@example.com': 'Ada Lovelace' })
   .subject('Welcome, {name}')
   .data({ name: 'Ada' })
-  .send('Hello {name}, thanks for joining.');
+  .send('Hello {name}, thanks for joining.')
 
 await Notification.sms()
   .recipient('+2348012345678')
-  .send('Your code is {code}', undefined, undefined, { code: '123456' });
+  .send('Your code is {code}', undefined, undefined, { code: '123456' })
 
-await Notification.db()
-  .recipient(user)
-  .send('Your payout has settled', 'Payout settled');
+await Notification.db().recipient(user).send('Your payout has settled', 'Payout settled')
 ```
 
 Apps using database notifications should provide a `UserNotification` model backed by a `user_notifications` table. The starter templates include this model and migration.
@@ -73,7 +71,7 @@ export default () => ({
       from: env('TWILIO_FROM'),
     },
   },
-});
+})
 ```
 
 `default_driver` selects the notification channel used by `Notification.channel()`. `drivers.sms.transport` selects the SMS provider transport, either `africastalking` or `twilio`.

package/dist/index.d.ts

@@ -281,9 +281,17 @@ declare class PusherRealtimeDriver implements RealtimeDriver {
   private cluster;
   private useTLS;
   private server;
+  /**
+   * The server address and TLS browsers connect with. Defaults to the address
+   * the server uses, which differs when it reaches the server over a private
+   * network (e.g. `soketi` inside Docker).
+   *
+   * @returns
+   */
+  private publicServer;
   /**
    * Public settings a `pusher-js` client needs, including the self-hosted
-   * server address when `host` is set.
+   * server address when one is set.
    *
    * @returns
    */
@@ -450,6 +458,12 @@ type PusherTransportConfig = {
    */
   host?: string;
   port?: number;
+  /** The address browsers connect to, when it differs from `host` (defaults to `host`). */
+  public_host?: string;
+  /** The port browsers connect to (defaults to `port`). */
+  public_port?: number;
+  /** Whether browsers connect over TLS (defaults to `use_tls`). */
+  public_use_tls?: boolean;
 };
 type FirebaseTransportConfig = {
   project_id?: string;
@@ -767,6 +781,9 @@ interface NotificationConfig<T = any> {
       use_tls?: boolean;
       host?: string;
       port?: number;
+      public_host?: string;
+      public_port?: number;
+      public_use_tls?: boolean;
     };
     firebase?: ({
       project_id: string;

package/dist/index.js

@@ -49,12 +49,12 @@ var NotificationContract = class {
 	}
 	/**
 	* Send the notification to our configured queue
-	* 
-	* @param message 
-	* @param subject 
-	* @param recipient 
-	* @param data 
-	* @returns 
+	*
+	* @param message
+	* @param subject
+	* @param recipient
+	* @param data
+	* @returns
 	*/
 	async queue(message, subject, recipient, data) {
 		const job = SendNotification.dispatch(this, message, subject, recipient, data);
@@ -91,9 +91,9 @@ var UserNotificationCenter = class {
 	}
 	/**
 	* Create a database notification
-	* 
-	* @param user 
-	* @param payload 
+	*
+	* @param user
+	* @param payload
 	*/
 	static async create(user, payload) {
 		return await (await this.getModel()).query().create({
@@ -116,8 +116,8 @@ var UserNotificationCenter = class {
 	}
 	/**
 	* Mark the notification as read
-	* 
-	* @param notification 
+	*
+	* @param notification
 	*/
 	static async markRead(notification) {
 		const Model = await this.getModel();
@@ -128,8 +128,8 @@ var UserNotificationCenter = class {
 	}
 	/**
 	* Mark all unread notifications as read
-	* 
-	* @param user 
+	*
+	* @param user
 	*/
 	static async markAllRead(user, ids) {
 		const query = (await this.getModel()).query().where({ userId: user.id }).whereNull("readAt");
@@ -137,8 +137,8 @@ var UserNotificationCenter = class {
 	}
 	/**
 	* Delete the indicated notifications
-	* 
-	* @param notification 
+	*
+	* @param notification
 	*/
 	static async delete(notification) {
 		const Model = await this.getModel();
@@ -194,7 +194,7 @@ var DbNotification = class extends NotificationContract {
 	}
 	/**
 	* Broadcast the notification using the default realtime driver.
-	* 
+	*
 	* @param realtime Set to false to disable realtime broadcast
 	* @returns
 	*/
@@ -209,12 +209,12 @@ var DbNotification = class extends NotificationContract {
 	}
 	/**
 	* Send the database notification
-	* 
-	* @param message 
-	* @param subject 
-	* @param _recipient 
-	* @param data 
-	* @returns 
+	*
+	* @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");
@@ -339,8 +339,8 @@ var MailNotification = class extends NotificationContract {
 	}
 	/**
 	* Attachemnts to send with the mail
-	* 
-	* @param attachments 
+	*
+	* @param attachments
 	*/
 	attachments(attachments) {
 		this.attachmentList = attachments;
@@ -348,7 +348,7 @@ var MailNotification = class extends NotificationContract {
 	}
 	/**
 	* A single attachemnt to send with the mail
-	* 
+	*
 	* @param attachment
 	*/
 	attachment(attachment) {
@@ -755,9 +755,9 @@ var FirebaseRealtimeDriver = class {
 	* derived only once the message is demonstrably a *visible* push, which a
 	* caller declares through the `apns` escape hatch. Guessing otherwise would
 	* mean sending APNs something it is documented to reject.
-	* 
-	* @param delivery 
-	* @returns 
+	*
+	* @param delivery
+	* @returns
 	*/
 	overridesFor(delivery) {
 		const base = this.options.delivery ?? {};
@@ -820,11 +820,11 @@ var FirebaseRealtimeDriver = class {
 	/**
 	* Fold a caller's raw override over the derived settings, dropping the block
 	* entirely when neither contributed anything.
-	* 
-	* @param key 
-	* @param derived 
-	* @param override 
-	* @returns 
+	*
+	* @param key
+	* @param derived
+	* @param override
+	* @returns
 	*/
 	flatBlock(key, derived, override) {
 		const block = {
@@ -836,11 +836,11 @@ var FirebaseRealtimeDriver = class {
 	/**
 	* As `flatBlock`, but for the platforms whose settings live under `headers` —
 	* merged key by key, so an override adding one header keeps the rest.
-	* 
-	* @param key 
-	* @param derived 
-	* @param override 
-	* @returns 
+	*
+	* @param key
+	* @param derived
+	* @param override
+	* @returns
 	*/
 	headerBlock(key, derived, override) {
 		const { headers: overrideHeaders, ...rest } = override ?? {};
@@ -863,27 +863,27 @@ var FirebaseRealtimeDriver = class {
 	}
 	/**
 	* Firebase channels do not require server-side authorization.
-	* 
-	* @param _socketId 
-	* @param _channel 
-	* @param _data 
+	*
+	* @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 
+	*
+	* @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 
+	*
+	* @param _authEndpoint
+	* @param _middleware
+	* @param _channelPrefix
 	*/
 	async registerAuthRoute(_authEndpoint = "/realtime/auth", _middleware, _channelPrefix) {}
 	/**
@@ -1032,17 +1032,35 @@ var PusherRealtimeDriver = class PusherRealtimeDriver {
 		};
 	}
 	/**
+	* The server address and TLS browsers connect with. Defaults to the address
+	* the server uses, which differs when it reaches the server over a private
+	* network (e.g. `soketi` inside Docker).
+	*
+	* @returns
+	*/
+	publicServer() {
+		const server = this.server();
+		const host = this.options.public_host ?? (env("PUSHER_PUBLIC_HOST", "") || server.host);
+		const port = this.options.public_port ?? (Number(env("PUSHER_PUBLIC_PORT", 0)) || server.port);
+		const tls = env("PUSHER_PUBLIC_USE_TLS", "");
+		return {
+			host,
+			port,
+			useTLS: this.options.public_use_tls ?? (tls === "" ? this.useTLS() : String(tls) === "true")
+		};
+	}
+	/**
 	* Public settings a `pusher-js` client needs, including the self-hosted
-	* server address when `host` is set.
+	* server address when one is set.
 	*
 	* @returns
 	*/
 	clientConfig() {
-		const { host, port } = this.server();
+		const { host, port, useTLS } = this.publicServer();
 		return {
 			key: this.key(),
 			cluster: this.cluster(),
-			forceTLS: this.useTLS(),
+			forceTLS: useTLS,
 			...host ? {
 				wsHost: host,
 				wsPort: port,
@@ -1054,43 +1072,43 @@ var PusherRealtimeDriver = class PusherRealtimeDriver {
 	* `delivery` is accepted for contract parity and ignored: Pusher pushes over a
 	* connection the client already holds open, so there is no dozing radio to
 	* wake and no per-message priority, TTL or collapse key to set.
-	* 
-	* @param channel 
-	* @param event 
-	* @param payload 
-	* @param _delivery 
-	* @returns 
+	*
+	* @param channel
+	* @param event
+	* @param payload
+	* @param _delivery
+	* @returns
 	*/
 	async broadcast(channel, event, payload, _delivery) {
 		return await (await this.client()).trigger(channel, event, payload);
 	}
 	/**
 	* Authourize a pusher channel
-	* 
-	* @param socketId 
-	* @param channel 
-	* @returns 
+	*
+	* @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 
-	* @param config 
-	* @param channelPrefix 
+	*
+	* @param authEndpoint
+	* @param middleware
+	* @param config
+	* @param channelPrefix
 	*/
 	static async registerAuthRoute(authEndpoint = "/realtime/auth", middleware, channelPrefix, config = {}) {
 		return new PusherRealtimeDriver(config).registerAuthRoute(authEndpoint, middleware, channelPrefix);
 	}
 	/**
 	* Register a realtime autorization route
-	* 
-	* @param authEndpoint 
-	* @param middleware 
-	* @param channelPrefix 
+	*
+	* @param authEndpoint
+	* @param middleware
+	* @param channelPrefix
 	*/
 	async registerAuthRoute(authEndpoint = "/realtime/auth", middleware, channelPrefix) {
 		for (const path of ["@arkstack/driver-express", "@arkstack/driver-h3"]) try {
@@ -1393,10 +1411,10 @@ var RealtimeNotification = class extends NotificationContract {
 	}
 	/**
 	* Overide the default transport
-	* 
-	* @param transport 
-	* @param options 
-	* @returns 
+	*
+	* @param transport
+	* @param options
+	* @returns
 	*/
 	transport(transport, options) {
 		this.driver = Broadcast.make(transport, options);
@@ -1425,20 +1443,20 @@ var RealtimeNotification = class extends NotificationContract {
 		return this;
 	}
 	/**
-	* The event name clients subscribe to (default `notification`). 
-	* 
-	* @param channel 
-	* @returns 
+	* The event name clients subscribe to (default `notification`).
+	*
+	* @param channel
+	* @returns
 	*/
 	event(event) {
 		this.eventName = event;
 		return this;
 	}
 	/**
-	* Also persist the notification (requires a `User` recipient). 
-	* 
-	* @param channel 
-	* @returns 
+	* Also persist the notification (requires a `User` recipient).
+	*
+	* @param channel
+	* @returns
 	*/
 	store(store = true) {
 		this.shouldStore = store;
@@ -1590,12 +1608,12 @@ var RealtimeNotification = class extends NotificationContract {
 	}
 	/**
 	* Send a realtime notification using the default realtime driver
-	* 
-	* @param message 
-	* @param subject 
-	* @param _recipient 
-	* @param data 
-	* @returns 
+	*
+	* @param message
+	* @param subject
+	* @param _recipient
+	* @param data
+	* @returns
 	*/
 	async send(message = "", subject, _recipient, data) {
 		const channel = this.resolveChannel();
@@ -1741,46 +1759,46 @@ var Notification = class Notification {
 	}
 	/**
 	* Send an email notification
-	* 
-	* @param options 
-	* @returns 
+	*
+	* @param options
+	* @returns
 	*/
 	static mail(options) {
 		return new MailNotification(options);
 	}
 	/**
 	* Send an email notification
-	* 
-	* @param options 
+	*
+	* @param options
 	* @alias {@link mail}
-	* @returns 
+	* @returns
 	*/
 	static email(options) {
 		return this.mail(options);
 	}
 	/**
 	* Send an sms notification
-	* 
-	* @param options 
-	* @returns 
+	*
+	* @param options
+	* @returns
 	*/
 	static sms(options) {
 		return new SmsNotification(options);
 	}
 	/**
 	* Send a database notification
-	* 
-	* @param options 
-	* @returns 
+	*
+	* @param options
+	* @returns
 	*/
 	static db() {
 		return new DbNotification();
 	}
 	/**
 	* Send a realtime notification
-	* 
-	* @param options 
-	* @returns 
+	*
+	* @param options
+	* @returns
 	*/
 	static realtime(options) {
 		return new RealtimeNotification(options);
@@ -1791,10 +1809,10 @@ var Notification = class Notification {
 	}
 	/**
 	* Prepare the notification
-	* 
-	* @param recipient 
-	* @param data 
-	* @returns 
+	*
+	* @param recipient
+	* @param data
+	* @returns
 	*/
 	prepare(recipient, data = {}) {
 		this.driver.data(data);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/notifications",
-  "version": "0.19.2",
+  "version": "0.19.4",
   "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.19.2"
+    "@arkstack/common": "^0.19.4"
   },
   "peerDependencies": {
     "@kanun-hq/plugin-phone": "^0.1.8",
     "firebase-admin": "^13.0.0",
     "pusher": "^5.2.0",
-    "@arkstack/contract": "^0.19.2",
-    "@arkstack/database": "^0.19.2",
-    "@arkstack/driver-express": "^0.19.2",
-    "@arkstack/driver-h3": "^0.19.2",
-    "@arkstack/jobs": "^0.19.2"
+    "@arkstack/database": "^0.19.4",
+    "@arkstack/driver-h3": "^0.19.4",
+    "@arkstack/contract": "^0.19.4",
+    "@arkstack/jobs": "^0.19.4",
+    "@arkstack/driver-express": "^0.19.4"
   },
   "peerDependenciesMeta": {
     "@arkstack/driver-express": {