@modernman00/shared-js-lib 1.2.82 → 1.2.87

package/PwaManager.js

@@ -0,0 +1,342 @@
+/**
+ * 📱 PwaManager — Universal Cross-App Service Worker & PWA Controller
+ * Part of @modernman00/shared-js-lib
+ *
+ * Implements:
+ * 1. Clean root /sw.js registration with scope '/'
+ * 2. Purging of legacy orphaned workers (/public/sw.js, /service-worker.js)
+ * 3. User-prompted updates via 'postMessage' with zero jarring auto-reloads
+ * 4. Safe cache purging on user logout (clears API & session caches)
+ * 5. Custom event dispatching for seamless Blade UI integration
+ */
+
+export class PwaManager {
+  static registration = null;
+  static options = {
+    swUrl: '/sw.js',
+    scope: '/',
+    appName: 'App',
+    enableUpdateToast: true,
+    enableBadgingSync: true,
+    badgeEndpoint: '/api/notifications/unread',
+    onUpdateAvailable: null
+  };
+
+  /**
+   * Initializes Service Worker registration and lifecycle monitoring
+   */
+  static async init(userOptions = {}) {
+    if (typeof window === 'undefined' || !('serviceWorker' in navigator)) {
+      return null;
+    }
+
+    this.options = { ...this.options, ...userOptions };
+
+    window.addEventListener('load', async () => {
+      try {
+        await this.purgeLegacyWorkers();
+        this.registration = await navigator.serviceWorker.register(this.options.swUrl, {
+          scope: this.options.scope
+        });
+
+        console.log(`[PwaManager] ${this.options.appName} ServiceWorker active with scope:`, this.registration.scope);
+
+        // Listen for new workers entering 'installing' or 'waiting' states
+        this.registration.addEventListener('updatefound', () => {
+          const installingWorker = this.registration.installing;
+          if (!installingWorker) return;
+
+          installingWorker.addEventListener('statechange', () => {
+            if (installingWorker.state === 'installed' && navigator.serviceWorker.controller) {
+              console.log(`[PwaManager] New version of ${this.options.appName} installed and waiting.`);
+              this.handleUpdateAvailable(installingWorker);
+            }
+          });
+        });
+
+        // Detect if a worker was already waiting prior to page load
+        if (this.registration.waiting && navigator.serviceWorker.controller) {
+          this.handleUpdateAvailable(this.registration.waiting);
+        }
+      } catch (error) {
+        console.error(`[PwaManager] ServiceWorker registration failed:`, error);
+      }
+    });
+
+    // Listen for controller changes (when skipWaiting activates new worker)
+    navigator.serviceWorker.addEventListener('controllerchange', () => {
+      console.log('[PwaManager] ServiceWorker controller changed. Page ready for reload.');
+    });
+
+    // Automatic Home Screen Badging Synchronization
+    if (this.options.enableBadgingSync && typeof window !== 'undefined') {
+      this.syncAppBadge();
+
+      window.addEventListener('focus', () => this.syncAppBadge());
+      document.addEventListener('visibilitychange', () => {
+        if (document.visibilityState === 'visible') {
+          this.syncAppBadge();
+        }
+      });
+
+      navigator.serviceWorker.addEventListener('message', (event) => {
+        if (event.data?.type === 'ON_APP_NOTIFICATION') {
+          this.syncAppBadge();
+          if (typeof window !== 'undefined' && window.dispatchEvent) {
+            window.dispatchEvent(new CustomEvent('pwa:notification-received', { detail: event.data.payload }));
+          }
+        }
+      });
+    }
+
+    return this.registration;
+  }
+
+  /**
+   * Drops legacy or misconfigured workers from older architecture iterations
+   */
+  static async purgeLegacyWorkers() {
+    try {
+      const registrations = await navigator.serviceWorker.getRegistrations();
+      for (const reg of registrations) {
+        const scriptURL = (reg.active || reg.waiting || reg.installing || {}).scriptURL || '';
+        // If worker is scoped to /public/ or named /service-worker.js, unregister it
+        if (scriptURL.endsWith('/public/sw.js') || scriptURL.endsWith('/service-worker.js')) {
+          console.warn('[PwaManager] Unregistering legacy orphaned worker:', scriptURL);
+          await reg.unregister();
+        }
+      }
+    } catch (err) {
+      console.warn('[PwaManager] Legacy cleanup check error:', err);
+    }
+  }
+
+  /**
+   * Handles update notification
+   */
+  static handleUpdateAvailable(worker) {
+    if (typeof window !== 'undefined' && window.dispatchEvent) {
+      window.dispatchEvent(new CustomEvent('pwa:update-available', {
+        detail: { worker, appName: this.options.appName }
+      }));
+    }
+
+    if (this.options.enableUpdateToast) {
+      this.showUpdateToast(worker);
+    }
+
+    if (typeof this.options.onUpdateAvailable === 'function') {
+      this.options.onUpdateAvailable(worker);
+    }
+  }
+
+  /**
+   * Renders a discreet, glassmorphic floating update pill to prompt user refresh
+   */
+  static showUpdateToast(worker) {
+    if (typeof document === 'undefined' || document.getElementById('pwaUniversalUpdateToast')) {
+      return;
+    }
+
+    const toast = document.createElement('div');
+    toast.id = 'pwaUniversalUpdateToast';
+    toast.setAttribute('role', 'status');
+    toast.setAttribute('aria-live', 'polite');
+    toast.setAttribute('aria-label', `${this.options.appName || 'App'} update available`);
+
+    toast.style.position = 'fixed';
+    toast.style.bottom = 'max(16px, env(safe-area-inset-bottom, 16px))';
+    toast.style.left = '50%';
+    toast.style.transform = 'translateX(-50%)';
+    toast.style.zIndex = '99999';
+    toast.style.display = 'flex';
+    toast.style.alignItems = 'center';
+    toast.style.gap = '12px';
+    toast.style.padding = '8px 14px 8px 16px';
+    toast.style.backgroundColor = 'rgba(15, 23, 42, 0.94)';
+    toast.style.backdropFilter = 'blur(12px)';
+    toast.style.webkitBackdropFilter = 'blur(12px)';
+    toast.style.border = '1px solid rgba(255, 255, 255, 0.12)';
+    toast.style.borderRadius = '9999px';
+    toast.style.boxShadow = '0 12px 32px rgba(0, 0, 0, 0.45)';
+    toast.style.color = '#ffffff';
+    toast.style.fontFamily = 'system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, sans-serif';
+    toast.style.fontSize = '14px';
+    toast.style.lineHeight = '1.4';
+    toast.style.maxWidth = 'calc(100vw - 32px)';
+    toast.style.boxSizing = 'border-box';
+    toast.style.transition = 'all 0.25s cubic-bezier(0.16, 1, 0.3, 1)';
+
+    const appTitle = this.options.appName || 'App';
+
+    toast.innerHTML = `
+      <div style="display: flex; align-items: center; gap: 8px; white-space: nowrap;">
+        <span style="display: inline-block; width: 8px; height: 8px; border-radius: 50%; background-color: #10b981; box-shadow: 0 0 8px #10b981;"></span>
+        <span style="font-weight: 500;">${appTitle} updated</span>
+      </div>
+      <button id="pwaUpdateActionBtn" type="button" style="
+        background: #2563eb;
+        color: #ffffff;
+        border: none;
+        padding: 6px 14px;
+        border-radius: 9999px;
+        font-size: 13px;
+        font-weight: 600;
+        cursor: pointer;
+        display: inline-flex;
+        align-items: center;
+        justify-content: center;
+        min-height: 36px;
+        transition: background 0.2s;
+        white-space: nowrap;
+      ">Refresh</button>
+      <button id="pwaUpdateDismissBtn" type="button" style="
+        background: transparent;
+        color: #94a3b8;
+        border: none;
+        font-size: 16px;
+        cursor: pointer;
+        padding: 6px;
+        min-width: 36px;
+        min-height: 36px;
+        display: inline-flex;
+        align-items: center;
+        justify-content: center;
+        line-height: 1;
+      " aria-label="Dismiss">✕</button>
+    `;
+
+    document.body.appendChild(toast);
+
+    const updateBtn = document.getElementById('pwaUpdateActionBtn');
+    if (updateBtn) {
+      updateBtn.addEventListener('click', () => {
+        toast.remove();
+        this.applyUpdate(worker);
+      });
+    }
+
+    const dismissBtn = document.getElementById('pwaUpdateDismissBtn');
+    if (dismissBtn) {
+      dismissBtn.addEventListener('click', () => {
+        toast.remove();
+      });
+    }
+  }
+
+  /**
+   * Sends skipWaiting postMessage to the waiting worker and triggers clean reload
+   */
+  static applyUpdate(worker = null) {
+    const targetWorker = worker || (this.registration ? this.registration.waiting : null);
+    if (targetWorker) {
+      targetWorker.postMessage({ action: 'skipWaiting' });
+    } else if (navigator.serviceWorker.controller) {
+      navigator.serviceWorker.controller.postMessage({ action: 'skipWaiting' });
+    }
+
+    navigator.serviceWorker.addEventListener('controllerchange', () => {
+      window.location.reload();
+    }, { once: true });
+  }
+
+  /**
+   * Purges sensitive API and user caches from the Service Worker upon user logout
+   */
+  static async clearUserCacheOnLogout() {
+    if ('serviceWorker' in navigator && navigator.serviceWorker.controller) {
+      navigator.serviceWorker.controller.postMessage({ action: 'clearUserCache' });
+    }
+
+    if (typeof caches !== 'undefined') {
+      try {
+        const keys = await caches.keys();
+        await Promise.all(
+          keys.filter(k => k.includes('api-cache') || k.includes('user-cache')).map(k => caches.delete(k))
+        );
+        console.log('[PwaManager] Client-side sensitive user caches purged.');
+      } catch (e) {
+        console.warn('[PwaManager] Failed to purge user caches:', e);
+      }
+    }
+  }
+
+  /**
+   * Sets app badge counter on the phone's home screen icon (Web Badging API)
+   *
+   * @param {number|string} count
+   * @returns {Promise<void>}
+   */
+  static setAppBadge(count) {
+    const num = Math.max(0, parseInt(count, 10) || 0);
+    if (typeof window !== 'undefined' && window.dispatchEvent) {
+      window.dispatchEvent(new CustomEvent('pwa:badge-updated', { detail: { count: num } }));
+    }
+    if (typeof navigator !== 'undefined' && 'setAppBadge' in navigator) {
+      return (num > 0 ? navigator.setAppBadge(num) : navigator.clearAppBadge()).catch(() => {});
+    }
+    return Promise.resolve();
+  }
+
+  /**
+   * Clears app badge counter from the phone's home screen icon
+   *
+   * @returns {Promise<void>}
+   */
+  static clearAppBadge() {
+    if (typeof window !== 'undefined' && window.dispatchEvent) {
+      window.dispatchEvent(new CustomEvent('pwa:badge-updated', { detail: { count: 0 } }));
+    }
+    if (typeof navigator !== 'undefined' && 'clearAppBadge' in navigator) {
+      return navigator.clearAppBadge().catch(() => {});
+    }
+    return Promise.resolve();
+  }
+
+  /**
+   * Synchronizes app badge with the server's unread notifications endpoint
+   *
+   * @param {string|null} endpoint
+   * @returns {Promise<void>}
+   */
+  static async syncAppBadge(endpoint = null) {
+    const url = endpoint || this.options.badgeEndpoint || '/api/notifications/unread';
+
+    try {
+      const res = await fetch(url, { headers: { Accept: 'application/json' } });
+      if (!res.ok) {
+        // Release the stream before bailing. An abandoned response body stays
+        // "in flight" in Chromium indefinitely, which keeps the tab from ever
+        // reaching network idle — it silently wedges Playwright's
+        // `networkidle` waits and any load-state detection for the whole page.
+        await res.body?.cancel();
+        return;
+      }
+      const data = await res.json();
+      let count = 0;
+      if (data) {
+        if (typeof data.unread_count === 'number') {
+          count = data.unread_count;
+        } else if (typeof data.count === 'number') {
+          count = data.count;
+        } else if (typeof data.unreadCount === 'number') {
+          count = data.unreadCount;
+        } else if (data.status === 'success' && Array.isArray(data.message)) {
+          count = data.message.length;
+        } else if (Array.isArray(data.data)) {
+          count = data.data.length;
+        } else if (Array.isArray(data.notifications)) {
+          count = data.notifications.length;
+        }
+      }
+      const num = Math.max(0, parseInt(count, 10) || 0);
+      if (num > 0) {
+        await this.setAppBadge(num);
+      } else {
+        await this.clearAppBadge();
+      }
+    } catch (e) {
+      // Harmless no-op on network failure or offline mode
+    }
+  }
+}