nodebb-plugin-web-push 0.5.1 → 0.6.0

package/library.js

@@ -10,6 +10,7 @@ const user = require.main.require('./src/user');
 const meta = require.main.require('./src/meta');
 const utils = require.main.require('./src/utils');
 const translator = require.main.require('./src/translator');
+const notifications = require.main.require('./src/notifications');
 
 const controllers = require('./lib/controllers');
 const subscriptions = require('./lib/subscriptions');
@@ -96,6 +97,12 @@ plugin.addRoutes = async ({ router, middleware, helpers }) => {
 		await webPush.sendNotification(subscription, JSON.stringify({
 			title: 'Test notification',
 			body: 'This is a test message sent from NodeBB',
+			tag: 'web-push-test',
+			data: {
+				url: `${nconf.get('url')}/me/web-push`,
+				icon: `${nconf.get('url')}/apple-touch-icon`,
+				badge: `${nconf.get('url')}/apple-touch-icon`,
+			},
 		}));
 	});
 };
@@ -121,7 +128,7 @@ plugin.onNotificationPush = async ({ notification, uidsNotified: uids }) => {
 	db.pexpire(refKey, 1000 * 60 * 60 * 48); // only track last 48 hours
 
 	let payloads = await Promise.all(uids.map(async (uid, idx) => {
-		const payload = await constructPayload(notification, userSettings[idx].userLang);
+		const payload = await constructPayload(notification, uid, userSettings[idx].userLang);
 		return [uid, payload];
 	}));
 	payloads = new Map(payloads);
@@ -180,14 +187,25 @@ plugin.addProfileItem = async (data) => {
 	return data;
 };
 
-async function constructPayload({ nid, mergeId, bodyShort, bodyLong, path }, language) {
-	let { maxLength } = await meta.settings.get('web-push');
+async function constructPayload(notification, uid, language) {
+	let { maxLength, icon, badge } = await meta.settings.get('web-push');
 	maxLength = parseInt(maxLength, 10) || 256;
 
 	if (!language) {
 		language = meta.config.defaultLang || 'en-GB';
 	}
 
+	// Merge with related unread notifications
+	if (notification.mergeId) {
+		const related = await notifications.findRelated([notification.mergeId], `uid:${uid}:notifications:unread`);
+		const merged = await notifications.getMultiple(related).then(notifications.merge);
+		if (merged.length) {
+			notification = merged.pop();
+		}
+	}
+
+	const { nid, mergeId, bodyShort, bodyLong, path } = notification;
+
 	let [title, body] = await translator.translateKeys([bodyShort, bodyLong], language);
 	([title, body] = [title, body].map(str => validator.unescape(utils.stripHTMLTags(str))));
 	const tag = mergeId || nid;
@@ -204,11 +222,14 @@ async function constructPayload({ nid, mergeId, bodyShort, bodyLong, path }, lan
 		body = `${body.slice(0, maxLength)}…`;
 	}
 
+	icon = icon || `${nconf.get('url')}/apple-touch-icon`;
+	badge = badge || `${nconf.get('url')}/apple-touch-icon`;
+
 	return {
 		title,
 		body,
 		tag,
-		data: { url },
+		data: { url, icon, badge },
 	};
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodebb-plugin-web-push",
-  "version": "0.5.1",
+  "version": "0.6.0",
   "description": "A starter kit for quickly creating NodeBB plugins",
   "main": "library.js",
   "repository": {

package/templates/admin/plugins/web-push.tpl

@@ -15,6 +15,24 @@
 							Due to a software limitation, if the message body is greater than 4096 bytes, the message itself will be an attachment in the push notification.
 						</p>
 					</div>
+
+					<div class="mb-3">
+						<label class="form-label" for="badge">Badge URL</label>
+						<input type="text" id="badge" name="badge" title="Badge" class="form-control" placeholder="https://...">
+						<p class="form-text">
+							Optional — overrides the badge for messages sent (usually seen in the notification bar on mobile devices)
+							By default, the site's configured "touch icon" is sent.
+						</p>
+					</div>
+
+					<div class="mb-3">
+						<label class="form-label" for="icon">Icon URL</label>
+						<input type="text" id="icon" name="icon" title="Icon" class="form-control" placeholder="https://...">
+						<p class="form-text">
+							Optional — overrides the icon for messages sent (can be used for branding, etc.)
+							By default, the site's configured "touch icon" is sent.
+						</p>
+					</div>
 				</div>
 			</form>