@djangocfg/nextjs 2.1.36 → 2.1.37

package/src/pwa/worker/index.ts

@@ -0,0 +1,174 @@
+/**
+ * Service Worker Utilities
+ *
+ * Ready-to-use Serwist configuration for Next.js PWA
+ */
+
+/// <reference lib="webworker" />
+
+import { defaultCache } from '@serwist/next/worker';
+import { Serwist } from 'serwist';
+
+export interface ServiceWorkerOptions {
+  /**
+   * Offline fallback URL
+   * @default '/_offline'
+   */
+  offlineFallback?: string;
+
+  /**
+   * Skip waiting - activate new SW immediately
+   * @default true
+   */
+  skipWaiting?: boolean;
+
+  /**
+   * Take control of all clients immediately
+   * @default true
+   */
+  clientsClaim?: boolean;
+
+  /**
+   * Enable navigation preload for faster loads
+   * @default true
+   */
+  navigationPreload?: boolean;
+
+  /**
+   * Enable push notifications
+   * @default false
+   */
+  enablePushNotifications?: boolean;
+
+  /**
+   * Default notification icon
+   */
+  notificationIcon?: string;
+
+  /**
+   * Default notification badge
+   */
+  notificationBadge?: string;
+}
+
+/**
+ * Create and initialize Serwist service worker
+ *
+ * @example
+ * ```ts
+ * // app/sw.ts
+ * import { createServiceWorker } from '@djangocfg/nextjs/worker';
+ *
+ * createServiceWorker({
+ *   offlineFallback: '/_offline',
+ * });
+ * ```
+ */
+export function createServiceWorker(options: ServiceWorkerOptions = {}) {
+  const {
+    offlineFallback = '/_offline',
+    skipWaiting = true,
+    clientsClaim = true,
+    navigationPreload = true,
+    enablePushNotifications = false,
+    notificationIcon,
+    notificationBadge,
+  } = options;
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  const self = globalThis as any;
+  console.log('SW: Worker Initialized 🚀');
+
+  const serwist = new Serwist({
+    // Precache entries injected by Serwist build plugin
+    precacheEntries: self.__SW_MANIFEST,
+
+    // Skip waiting - activate new SW immediately
+    skipWaiting,
+
+    // Take control of all clients immediately
+    clientsClaim,
+
+    // Enable navigation preload for faster loads
+    navigationPreload,
+
+    // Use default Next.js runtime caching strategies
+    runtimeCaching: defaultCache,
+
+    // Fallback pages for offline
+    fallbacks: {
+      entries: [
+        {
+          url: offlineFallback,
+          matcher({ request }) {
+            return request.destination === 'document';
+          },
+        },
+      ],
+    },
+  });
+
+  serwist.addEventListeners();
+
+  // Push notification support
+  if (enablePushNotifications) {
+    // Handle push events
+    self.addEventListener('push', (event: PushEvent) => {
+      let data;
+      try {
+        data = event.data?.json() || {};
+        console.log('SW: Push Received (JSON)', data);
+      } catch (err) {
+        console.log('SW: Push Received (Raw)', event.data?.text());
+        data = {};
+      }
+
+      const {
+        title = 'Notification',
+        body = '',
+        icon = notificationIcon,
+        badge = notificationBadge,
+        data: notificationData = {},
+        tag,
+        requireInteraction = false,
+        vibrate = [200, 100, 200], // Default vibration pattern
+        silent = false,            // Default to playing sound
+      } = data;
+
+      event.waitUntil(
+        self.registration.showNotification(title, {
+          body,
+          icon,
+          badge,
+          data: notificationData,
+          tag,
+          requireInteraction,
+          vibrate,
+          silent,
+        })
+      );
+    });
+
+    // Handle notification clicks
+    self.addEventListener('notificationclick', (event: NotificationEvent) => {
+      event.notification.close();
+
+      const urlToOpen = event.notification.data?.url || '/';
+
+      event.waitUntil(
+        self.clients.matchAll({ type: 'window', includeUncontrolled: true }).then((clientList: readonly WindowClient[]) => {
+          // Check if there's already a window open with the URL
+          for (const client of clientList) {
+            if (client.url === urlToOpen && 'focus' in client) {
+              return client.focus();
+            }
+          }
+          // If not, open a new window
+          if (self.clients.openWindow) {
+            return self.clients.openWindow(urlToOpen);
+          }
+        })
+      );
+    });
+  }
+}

package/src/pwa/worker/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}