@arkstack/realtime 0.19.0 → 0.19.2

package/dist/{RealtimeClient-MI224djP.d.ts → RealtimeClient-CAoMUUkc.d.ts}

@@ -70,7 +70,7 @@ interface RealtimeTransport {
   /**
    * This device's push registration token, when the transport can issue one.
    */
-  deviceToken?(): Promise<string | null>;
+  deviceToken?(options?: DeviceTokenOptions): Promise<string | null>;
   /**
    * Set by transports that push nothing; clients should poll this often instead.
    */
@@ -117,6 +117,15 @@ interface FirebaseClientConfig {
   /** Web push VAPID key used when requesting a messaging token. */
   vapidKey?: string;
 }
+interface DeviceTokenOptions {
+  /**
+   * The service worker that receives background messages: a registration, or
+   * the URL of a script to register. A registered URL receives the Firebase
+   * web config as its `firebaseConfig` query parameter. Defaults to Firebase's
+   * own `/firebase-messaging-sw.js` lookup.
+   */
+  serviceWorker?: ServiceWorkerRegistration | string;
+}
 interface FirebaseDatabaseClientConfig {
   apiKey: string;
   projectId: string;
@@ -241,15 +250,18 @@ declare class RealtimeClient {
   onPoll(handler: () => void, interval?: number): Promise<() => void>;
   /**
    * This device's push registration token, for registering with your API.
-   * Null when the transport cannot issue one.
+   * Uses the transport when it can issue one, otherwise the `firebase` config
+   * (push over FCM while streaming over another transport). Null when neither
+   * can, or the browser cannot receive web push.
    *
+   * @param options
    * @returns
    */
-  deviceToken(): Promise<string | null>;
+  deviceToken(options?: DeviceTokenOptions): Promise<string | null>;
   /** Tear down the underlying transport connection. */
   disconnect(): Promise<void>;
 }
 /** Create a new {@link RealtimeClient}. */
 declare const createRealtime: (config?: RealtimeConfig) => RealtimeClient;
 //#endregion
-export { NotificationHandler as a, RealtimeConfig as c, RealtimeSubscription as d, RealtimeTransport as f, FirebaseDatabaseClientConfig as i, RealtimeEventHandler as l, createRealtime as n, PollingClientConfig as o, RealtimeTransportName as p, FirebaseClientConfig as r, PusherClientConfig as s, RealtimeClient as t, RealtimeNotification as u };
+export { FirebaseDatabaseClientConfig as a, PusherClientConfig as c, RealtimeNotification as d, RealtimeSubscription as f, FirebaseClientConfig as i, RealtimeConfig as l, RealtimeTransportName as m, createRealtime as n, NotificationHandler as o, RealtimeTransport as p, DeviceTokenOptions as r, PollingClientConfig as s, RealtimeClient as t, RealtimeEventHandler as u };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { a as NotificationHandler, c as RealtimeConfig, d as RealtimeSubscription, f as RealtimeTransport, i as FirebaseDatabaseClientConfig, l as RealtimeEventHandler, n as createRealtime, o as PollingClientConfig, p as RealtimeTransportName, r as FirebaseClientConfig, s as PusherClientConfig, t as RealtimeClient, u as RealtimeNotification } from "./RealtimeClient-MI224djP.js";
+import { a as FirebaseDatabaseClientConfig, c as PusherClientConfig, d as RealtimeNotification, f as RealtimeSubscription, i as FirebaseClientConfig, l as RealtimeConfig, m as RealtimeTransportName, n as createRealtime, o as NotificationHandler, p as RealtimeTransport, r as DeviceTokenOptions, s as PollingClientConfig, t as RealtimeClient, u as RealtimeEventHandler } from "./RealtimeClient-CAoMUUkc.js";
 //#region src/transports/pusher.d.ts
 /**
  * Realtime transport backed by [pusher-js](https://github.com/pusher/pusher-js).
@@ -87,4 +87,15 @@ declare const createMemoryTransport: () => RealtimeTransport;
  */
 declare const supersede: (list: RealtimeNotification[], incoming: RealtimeNotification, limit?: number) => RealtimeNotification[];
 //#endregion
-export { type FirebaseClientConfig, type FirebaseDatabaseClientConfig, type NotificationHandler, type PollingClientConfig, type PusherClientConfig, RealtimeClient, type RealtimeConfig, type RealtimeEventHandler, type RealtimeNotification, type RealtimeSubscription, type RealtimeTransport, type RealtimeTransportName, createFirebaseDatabaseTransport, createFirebaseTransport, createMemoryTransport, createPollingTransport, createPusherTransport, createRealtime, emitMemoryEvent, supersede };
+//#region src/push.d.ts
+/**
+ * Issue a device token without a Firebase transport, e.g. when notifications
+ * stream over Pusher but are pushed to devices over FCM.
+ *
+ * @param config
+ * @param options
+ * @returns
+ */
+declare const requestDeviceToken: (config: FirebaseClientConfig, options?: DeviceTokenOptions) => Promise<string | null>;
+//#endregion
+export { type DeviceTokenOptions, type FirebaseClientConfig, type FirebaseDatabaseClientConfig, type NotificationHandler, type PollingClientConfig, type PusherClientConfig, RealtimeClient, type RealtimeConfig, type RealtimeEventHandler, type RealtimeNotification, type RealtimeSubscription, type RealtimeTransport, type RealtimeTransportName, createFirebaseDatabaseTransport, createFirebaseTransport, createMemoryTransport, createPollingTransport, createPusherTransport, createRealtime, emitMemoryEvent, requestDeviceToken, supersede };

package/dist/index.js

@@ -1,16 +1,5 @@
+import { i as __exportAll, r as requestDeviceToken, t as issueDeviceToken } from "./push-TmPMqRUR.js";
 import { t as supersede } from "./supersede-T1ch4wJF.js";
-//#region \0rolldown/runtime.js
-var __defProp = Object.defineProperty;
-var __exportAll = (all, no_symbols) => {
-	let target = {};
-	for (var name in all) __defProp(target, name, {
-		get: all[name],
-		enumerable: true
-	});
-	if (!no_symbols) __defProp(target, Symbol.toStringTag, { value: "Module" });
-	return target;
-};
-//#endregion
 //#region src/RealtimeClient.ts
 /**
 * Consumes Arkstack realtime notifications. Resolves a transport (Pusher,
@@ -159,12 +148,19 @@ var RealtimeClient = class {
 	}
 	/**
 	* This device's push registration token, for registering with your API.
-	* Null when the transport cannot issue one.
+	* Uses the transport when it can issue one, otherwise the `firebase` config
+	* (push over FCM while streaming over another transport). Null when neither
+	* can, or the browser cannot receive web push.
 	*
+	* @param options
 	* @returns
 	*/
-	async deviceToken() {
-		return await (await this.transport()).deviceToken?.() ?? null;
+	async deviceToken(options) {
+		const transport = await this.transport();
+		if (transport.deviceToken) return await transport.deviceToken(options);
+		if (!this.config.firebase) return null;
+		const { requestDeviceToken } = await import("./push-TmPMqRUR.js").then((n) => n.n);
+		return await requestDeviceToken(this.config.firebase, options);
 	}
 	/** Tear down the underlying transport connection. */
 	async disconnect() {
@@ -307,9 +303,8 @@ const createFirebaseTransport = async (config) => {
 			});
 			await databaseApi.remove(eventReference);
 		},
-		async deviceToken() {
-			const getToken = messagingMod.getToken;
-			return await getToken(messaging, config.vapidKey ? { vapidKey: config.vapidKey } : void 0) || null;
+		async deviceToken(options) {
+			return await issueDeviceToken(messagingMod, messaging, config, options);
 		},
 		disconnect() {
 			messageUnsubscribers.forEach((off) => off());
@@ -508,4 +503,4 @@ const createMemoryTransport = () => {
 	};
 };
 //#endregion
-export { RealtimeClient, createFirebaseDatabaseTransport, createFirebaseTransport, createMemoryTransport, createPollingTransport, createPusherTransport, createRealtime, emitMemoryEvent, supersede };
+export { RealtimeClient, createFirebaseDatabaseTransport, createFirebaseTransport, createMemoryTransport, createPollingTransport, createPusherTransport, createRealtime, emitMemoryEvent, requestDeviceToken, supersede };

package/dist/push-TmPMqRUR.js

@@ -0,0 +1,78 @@
+//#region \0rolldown/runtime.js
+var __defProp = Object.defineProperty;
+var __exportAll = (all, no_symbols) => {
+	let target = {};
+	for (var name in all) __defProp(target, name, {
+		get: all[name],
+		enumerable: true
+	});
+	if (!no_symbols) __defProp(target, Symbol.toStringTag, { value: "Module" });
+	return target;
+};
+//#endregion
+//#region src/push.ts
+var push_exports = /* @__PURE__ */ __exportAll({
+	issueDeviceToken: () => issueDeviceToken,
+	requestDeviceToken: () => requestDeviceToken
+});
+const APP_NAME = "arkstack-push";
+/**
+* The public settings a service worker needs to initialize Firebase.
+*
+* @param config
+* @returns
+*/
+const webConfig = (config) => ({
+	apiKey: config.apiKey,
+	projectId: config.projectId,
+	appId: config.appId,
+	messagingSenderId: config.messagingSenderId
+});
+/**
+* Register `url` as the messaging service worker, handing it the Firebase web
+* config as the `firebaseConfig` query parameter.
+*
+* @param url
+* @param config
+* @returns
+*/
+const registerServiceWorker = async (url, config) => {
+	const separator = url.includes("?") ? "&" : "?";
+	const query = `firebaseConfig=${encodeURIComponent(JSON.stringify(webConfig(config)))}`;
+	return await navigator.serviceWorker.register(`${url}${separator}${query}`);
+};
+/**
+* Issue an FCM registration token for this browser, prompting for notification
+* permission when needed. Null when the browser cannot receive web push.
+*
+* @param messagingMod
+* @param messaging
+* @param config
+* @param options
+* @returns
+*/
+const issueDeviceToken = async (messagingMod, messaging, config, options = {}) => {
+	if (!await messagingMod.isSupported().catch(() => false)) return null;
+	const serviceWorkerRegistration = typeof options.serviceWorker === "string" ? await registerServiceWorker(options.serviceWorker, config) : options.serviceWorker;
+	return await messagingMod.getToken(messaging, {
+		...config.vapidKey ? { vapidKey: config.vapidKey } : {},
+		...serviceWorkerRegistration ? { serviceWorkerRegistration } : {}
+	}) || null;
+};
+/**
+* Issue a device token without a Firebase transport, e.g. when notifications
+* stream over Pusher but are pushed to devices over FCM.
+*
+* @param config
+* @param options
+* @returns
+*/
+const requestDeviceToken = async (config, options = {}) => {
+	const [appMod, messagingMod] = await Promise.all([import("firebase/app"), import("firebase/messaging")]).catch(() => {
+		throw new Error("The \"firebase\" package is required for device tokens. Install it with `npm i firebase`.");
+	});
+	const app = appMod.getApps().find((existing) => existing.name === APP_NAME) ?? appMod.initializeApp(webConfig(config), APP_NAME);
+	return await issueDeviceToken(messagingMod, messagingMod.getMessaging(app), config, options);
+};
+//#endregion
+export { __exportAll as i, push_exports as n, requestDeviceToken as r, issueDeviceToken as t };

package/dist/react/index.d.ts

@@ -1,4 +1,4 @@
-import { t as RealtimeClient, u as RealtimeNotification } from "../RealtimeClient-MI224djP.js";
+import { d as RealtimeNotification, t as RealtimeClient } from "../RealtimeClient-CAoMUUkc.js";
 //#region src/react/index.d.ts
 interface UseNotificationsOptions {
   /** Cap the number of retained notifications (newest kept). Default: unbounded. */

package/dist/vue/index.d.ts

@@ -1,4 +1,4 @@
-import { t as RealtimeClient, u as RealtimeNotification } from "../RealtimeClient-MI224djP.js";
+import { d as RealtimeNotification, t as RealtimeClient } from "../RealtimeClient-CAoMUUkc.js";
 import { ComputedRef, Ref } from "vue";
 //#region src/vue/index.d.ts
 interface UseNotificationsOptions {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/realtime",
-  "version": "0.19.0",
+  "version": "0.19.2",
   "type": "module",
   "description": "Client for consuming Arkstack realtime notifications (Pusher/Firebase), with framework-agnostic core plus React and Vue bindings.",
   "homepage": "https://arkstack.toneflix.net/guide/notifications",