ep_desktop_notifications 11.0.22 → 11.0.24

package/desktop_notifications.js

@@ -1,20 +1,36 @@
 'use strict';
 
-const eejs = require('ep_etherpad-lite/node/eejs/');
-const settings = require('ep_etherpad-lite/node/utils/Settings');
-let checkedState = '';
+const {padToggle} = require('ep_plugin_helpers/pad-toggle-server');
 
-exports.eejsBlock_mySettings = (hookName, args, cb) => {
-  if (!settings.ep_desktop_notifications_default) checkedState = 'checked';
-  args.content +=
-    eejs.require('ep_desktop_notifications/templates/desktop_notifications_entry.ejs',
-        {
-          checked: checkedState,
-        },
-    );
-  return cb();
+// Parallel User Settings + Pad Wide Settings checkboxes for "Desktop
+// Notifications". Helper owns markup, storage, broadcast, enforce, and i18n.
+const desktopToggle = padToggle({
+  pluginName: 'ep_desktop_notifications',
+  settingId: 'desktopNotifications',
+  l10nId: 'ep_desktop_notifications.desktopNotifications',
+  defaultLabel: 'Desktop Notifications',
+  defaultEnabled: true,
+});
+
+// The previous version honored a top-level `ep_desktop_notifications_default`
+// key with inverted semantics (truthy = default off). Translate to the
+// helper's nested `defaultEnabled` so existing installs keep their behavior.
+exports.loadSettings = async (hookName, args) => {
+  const root = args && args.settings;
+  if (root) {
+    const ps = (root.ep_desktop_notifications = root.ep_desktop_notifications || {});
+    if (typeof ps.defaultEnabled !== 'boolean' &&
+        typeof root.ep_desktop_notifications_default === 'boolean') {
+      ps.defaultEnabled = !root.ep_desktop_notifications_default;
+    }
+  }
+  return desktopToggle.loadSettings(hookName, args);
 };
 
+exports.clientVars = desktopToggle.clientVars;
+exports.eejsBlock_mySettings = desktopToggle.eejsBlock_mySettings;
+exports.eejsBlock_padSettings = desktopToggle.eejsBlock_padSettings;
+
 exports.eejsBlock_styles = (hookName, args, cb) => {
   const url = '../static/plugins/ep_desktop_notifications/static/css/desktop_notifications.css';
   args.content += `<link href="${url}" rel='stylesheet'>`;

package/ep.json

@@ -2,12 +2,17 @@
   "parts": [
     {
       "name": "ep_desktop_notifications",
+      "hooks": {
+        "loadSettings": "ep_desktop_notifications/desktop_notifications",
+        "clientVars": "ep_desktop_notifications/desktop_notifications",
+        "eejsBlock_mySettings": "ep_desktop_notifications/desktop_notifications",
+        "eejsBlock_padSettings": "ep_desktop_notifications/desktop_notifications",
+        "eejsBlock_styles": "ep_desktop_notifications/desktop_notifications"
+      },
       "client_hooks": {
         "postAceInit": "ep_desktop_notifications/static/js/desktop_notifications:postAceInit",
-        "chatNewMessage": "ep_desktop_notifications/static/js/desktop_notifications:chatNewMessage"
-      },
-      "hooks": {
-        "eejsBlock_mySettings": "ep_desktop_notifications/desktop_notifications"
+        "chatNewMessage": "ep_desktop_notifications/static/js/desktop_notifications:chatNewMessage",
+        "handleClientMessage_CLIENT_MESSAGE": "ep_desktop_notifications/static/js/desktop_notifications:handleClientMessage_CLIENT_MESSAGE"
       }
     }
   ]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ep_desktop_notifications",
-  "version": "11.0.22",
+  "version": "11.0.24",
   "keywords": [
     "desktop",
     "notifications",
@@ -34,5 +34,8 @@
   "scripts": {
     "lint": "eslint .",
     "lint:fix": "eslint --fix ."
+  },
+  "dependencies": {
+    "ep_plugin_helpers": "^0.5.2"
   }
 }

package/static/js/desktop_notifications.js

@@ -1,6 +1,25 @@
 'use strict';
 /* global webkitNotifications */
 
+// Sub-path import keeps the client bundle clean — the top-level
+// `ep_plugin_helpers` index pulls in server-only modules.
+const {padToggle} = require('ep_plugin_helpers/pad-toggle');
+const padcookie = require('ep_etherpad-lite/static/js/pad_cookie').padcookie;
+
+// Same config as the server-side instance — must agree on pluginName,
+// settingId, l10nId, and defaultLabel so checkbox ids and clientVars line up.
+const desktopToggle = padToggle({
+  pluginName: 'ep_desktop_notifications',
+  settingId: 'desktopNotifications',
+  l10nId: 'ep_desktop_notifications.desktopNotifications',
+  defaultLabel: 'Desktop Notifications',
+  defaultEnabled: true,
+});
+
+// Re-export so the helper sees pad-wide broadcasts and refreshes our state
+// when another user toggles the pad-wide checkbox.
+exports.handleClientMessage_CLIENT_MESSAGE = desktopToggle.handleClientMessage_CLIENT_MESSAGE;
+
 const DesktopNotifications = {
   /* compatilibility layer */
   notificationSupported: () => !!window.Notification || !!window.webkitNotifications,
@@ -108,29 +127,24 @@ const postAceInit = (hook, context) => {
   DesktopNotifications.status = false;
   DesktopNotifications.helpShown = false;
 
-  /* init */
-  const $optionsDesktopNotifications = $('#options-desktopNotifications');
-  const urlDesktopNotifications = DesktopNotifications.getParam('DesktopNotifications');
-  if (urlDesktopNotifications === 'true') {
-    $optionsDesktopNotifications.attr('checked', 'checked');
-  } else if (urlDesktopNotifications === 'false') {
-    $optionsDesktopNotifications.attr('checked', false);
-  }
-  if ($optionsDesktopNotifications.is(':checked')) {
-    DesktopNotifications.handleNotificationPermission(
-        DesktopNotifications.notificationPermission()
-    );
-  } else {
-    DesktopNotifications.disable();
-  }
+  // The README documents `?DesktopNotifications=true|false` as a way to
+  // override the toggle. Now that the helper persists per-user state in
+  // padcookie, write the URL value into the cookie before init reads it
+  // — that way the override survives reload, matching the original intent.
+  const urlOverride = DesktopNotifications.getParam('DesktopNotifications');
+  if (urlOverride === 'true') padcookie.setPref('desktopNotifications', true);
+  else if (urlOverride === 'false') padcookie.setPref('desktopNotifications', false);
 
-  /* on click */
-  $optionsDesktopNotifications.click(() => {
-    if ($optionsDesktopNotifications.is(':checked')) {
-      DesktopNotifications.enable();
-    } else {
-      DesktopNotifications.disable();
-    }
+  desktopToggle.init({
+    onChange: (enabled) => {
+      if (enabled) {
+        DesktopNotifications.handleNotificationPermission(
+            DesktopNotifications.notificationPermission()
+        );
+      } else {
+        DesktopNotifications.disable();
+      }
+    },
   });
 };
 

package/templates/desktop_notifications_entry.ejs

@@ -1,4 +0,0 @@
-<p>
-<input type="checkbox" data-l10n-id="ep_desktop_notifications.desktopNotifications" id="options-desktopNotifications" <%= checked %>></input>
-<label for="options-desktopNotifications" data-l10n-id="ep_desktop_notifications.desktopNotifications" aria-label="Desktop Notifications">Desktop Notifications</label>
-</p>