nodebb-plugin-web-push 0.6.1 → 0.7.0

package/library.js

@@ -45,6 +45,12 @@ plugin.appendConfig = async (config) => {
 	return config;
 };
 
+plugin.registerServiceWorker = async (data) => {
+	const { scripts } = data;
+	scripts.add(`nodebb-plugin-web-push/static/web-push.js`);
+	return data;
+};
+
 async function assertVapidConfiguration() {
 	let { publicKey, privateKey } = await meta.settings.get('web-push');
 	if (!publicKey || !privateKey) {
@@ -99,7 +105,7 @@ plugin.addRoutes = async ({ router, middleware, helpers }) => {
 			nid: utils.generateUUID(),
 			bodyShort: 'Test notification',
 			bodyLong: 'This is a test message sent from NodeBB',
-			path: `${nconf.get('url')}/me/web-push`,
+			path: `/me/web-push`,
 		}, req.uid, userLang);
 		await webPush.sendNotification(subscription, JSON.stringify(payload));
 	});
@@ -223,7 +229,9 @@ async function constructPayload(notification, uid, lang) {
 	}
 
 	icon = icon || `${nconf.get('url')}/apple-touch-icon`;
-	badge = badge || `${nconf.get('url')}/apple-touch-icon`;
+	if (!badge) { // badge fallbacks
+		badge = `${nconf.get('url')}${meta.config['brand:maskableIcon'] || '/apple-touch-icon'}`;
+	}
 
 	return {
 		title,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodebb-plugin-web-push",
-  "version": "0.6.1",
+  "version": "0.7.0",
   "description": "A starter kit for quickly creating NodeBB plugins",
   "main": "library.js",
   "repository": {
@@ -31,7 +31,7 @@
   },
   "readmeFilename": "README.md",
   "nbbpm": {
-    "compatibility": "^4.0.0"
+    "compatibility": "^3.10.x"
   },
   "devDependencies": {
     "@commitlint/cli": "19.5.0",

package/plugin.json

@@ -9,12 +9,16 @@
 		{ "hook": "filter:config.get", "method": "appendConfig" },
 		{ "hook": "action:notification.pushed", "method": "onNotificationPush" },
 		{ "hook": "static:notifications.rescind", "method": "onNotificationRescind" },
-		{ "hook": "filter:user.profileMenu", "method": "addProfileItem" }
+		{ "hook": "filter:user.profileMenu", "method": "addProfileItem" },
+		{ "hook": "filter:service-worker.scripts", "method": "registerServiceWorker" }
 	],
 	"languages": "public/languages",
 	"modules": {
 		"../client/account/web-push.js": "./public/lib/settings.js",
 		"../admin/plugins/web-push.js": "./public/lib/admin.js"
 	},
+	"staticDirs": {
+		"static": "./static"
+	},
 	"templates": "templates"
 }

package/static/web-push.js

@@ -0,0 +1,56 @@
+/* eslint-disable no-undef */
+
+'use strict';
+
+// Register event listener for the 'push' event.
+self.addEventListener('push', (event) => {
+	// Keep the service worker alive until the notification is created.
+	const { title, body, tag, data } = event.data.json();
+
+	if (title && body) {
+		const { icon } = data;
+		delete data.icon;
+		const { badge } = data;
+		delete data.badge;
+
+		event.waitUntil(
+			self.registration.showNotification(title, { body, tag, data, icon, badge })
+		);
+	} else if (tag) {
+		event.waitUntil(
+			self.registration.getNotifications({ tag }).then((notifications) => {
+				notifications.forEach((notification) => {
+					notification.close();
+				});
+			})
+		);
+	}
+});
+
+self.addEventListener('notificationclick', (event) => {
+	event.notification.close();
+	let target;
+	if (event.notification.data && event.notification.data.url) {
+		target = new URL(event.notification.data.url);
+	}
+
+	// This looks to see if the current is already open and focuses if it is
+	event.waitUntil(
+		self.clients
+			.matchAll({ type: 'window' })
+			.then((clientList) => {
+				// eslint-disable-next-line no-restricted-syntax
+				for (const client of clientList) {
+					const { hostname } = new URL(client.url);
+					if (target && hostname === target.hostname && 'focus' in client) {
+						client.postMessage({
+							action: 'ajaxify',
+							url: target.pathname,
+						});
+						return client.focus();
+					}
+				}
+				if (self.clients.openWindow) return self.clients.openWindow(target.pathname);
+			})
+	);
+});

package/static/samplefile.html

@@ -1,5 +0,0 @@
-<h1>Hello!</h1>
-
-<p>This file is served by nodebb at domain.com/assets/plugins/nodebb-plugin-web-push/static/samplefile.html</p>
-
-Check plugin.json for the "staticDirs" property if you want to change the path.