@markwharton/pwa-push 1.0.1 → 1.2.0

package/dist/client/renewal.js

@@ -33,7 +33,7 @@ async function handleSubscriptionChange(event, renewEndpoint) {
             console.error('Failed to create new subscription');
             return false;
         }
-        // Build renewal request
+        // Build renewal request (uses SubscriptionRequest type)
         const renewalRequest = {
             subscription: newSubscription,
             deviceId: data.deviceId,

package/dist/client/subscribe.d.ts

@@ -1,6 +1,7 @@
 /**
  * Push subscription helpers for main thread
  */
+import { Result } from '@markwharton/pwa-core/types';
 import { PushSubscription, SubscriptionRequest, PushPermissionState } from '../types';
 /**
  * Check current notification permission state
@@ -21,14 +22,19 @@ export declare function isPushSupported(): boolean;
 export declare function toPushSubscription(browserSub: globalThis.PushSubscription): PushSubscription;
 /**
  * Subscribe to push notifications
- * Returns subscription request ready to send to backend
+ *
+ * @returns Result with subscription request ready to send to backend
  */
-export declare function subscribeToPush(vapidPublicKey: string, basePath?: string): Promise<SubscriptionRequest | null>;
+export declare function subscribeToPush(vapidPublicKey: string, basePath?: string): Promise<Result<SubscriptionRequest>>;
 /**
  * Unsubscribe from push notifications
+ *
+ * @returns Result indicating success or failure
  */
-export declare function unsubscribeFromPush(): Promise<boolean>;
+export declare function unsubscribeFromPush(): Promise<Result<void>>;
 /**
  * Get current push subscription if exists
+ *
+ * @returns Result with current subscription, or error if not subscribed
  */
-export declare function getCurrentSubscription(): Promise<PushSubscription | null>;
+export declare function getCurrentSubscription(): Promise<Result<PushSubscription>>;

package/dist/client/subscribe.js

@@ -10,6 +10,7 @@ exports.toPushSubscription = toPushSubscription;
 exports.subscribeToPush = subscribeToPush;
 exports.unsubscribeFromPush = unsubscribeFromPush;
 exports.getCurrentSubscription = getCurrentSubscription;
+const types_1 = require("@markwharton/pwa-core/types");
 const deviceId_1 = require("./deviceId");
 const indexedDb_1 = require("./indexedDb");
 const encoding_1 = require("./encoding");
@@ -48,40 +49,47 @@ function toPushSubscription(browserSub) {
 }
 /**
  * Subscribe to push notifications
- * Returns subscription request ready to send to backend
+ *
+ * @returns Result with subscription request ready to send to backend
  */
 async function subscribeToPush(vapidPublicKey, basePath = '/') {
     if (!isPushSupported()) {
-        console.error('Push notifications not supported');
-        return null;
+        return (0, types_1.err)('Push notifications not supported');
     }
     const permission = await requestPermission();
     if (permission !== 'granted') {
-        console.warn('Push permission denied');
-        return null;
+        return (0, types_1.err)('Push permission denied');
+    }
+    try {
+        const registration = await navigator.serviceWorker.ready;
+        const deviceId = (0, deviceId_1.getDeviceId)();
+        // Convert VAPID key to Uint8Array
+        const applicationServerKey = (0, encoding_1.urlBase64ToUint8Array)(vapidPublicKey);
+        const browserSub = await registration.pushManager.subscribe({
+            userVisibleOnly: true,
+            applicationServerKey
+        });
+        // Save data for service worker renewal
+        await (0, indexedDb_1.saveSubscriptionData)({
+            publicKey: vapidPublicKey,
+            deviceId,
+            basePath
+        });
+        return (0, types_1.ok)({
+            subscription: toPushSubscription(browserSub),
+            deviceId,
+            basePath
+        });
+    }
+    catch (error) {
+        const message = error instanceof Error ? error.message : 'Subscription failed';
+        return (0, types_1.err)(message);
     }
-    const registration = await navigator.serviceWorker.ready;
-    const deviceId = (0, deviceId_1.getDeviceId)();
-    // Convert VAPID key to Uint8Array
-    const applicationServerKey = (0, encoding_1.urlBase64ToUint8Array)(vapidPublicKey);
-    const browserSub = await registration.pushManager.subscribe({
-        userVisibleOnly: true,
-        applicationServerKey
-    });
-    // Save data for service worker renewal
-    await (0, indexedDb_1.saveSubscriptionData)({
-        publicKey: vapidPublicKey,
-        deviceId,
-        basePath
-    });
-    return {
-        subscription: toPushSubscription(browserSub),
-        deviceId,
-        basePath
-    };
 }
 /**
  * Unsubscribe from push notifications
+ *
+ * @returns Result indicating success or failure
  */
 async function unsubscribeFromPush() {
     try {
@@ -90,26 +98,29 @@ async function unsubscribeFromPush() {
         if (subscription) {
             await subscription.unsubscribe();
         }
-        return true;
+        return (0, types_1.okVoid)();
     }
     catch (error) {
-        console.error('Unsubscribe failed:', error);
-        return false;
+        const message = error instanceof Error ? error.message : 'Unsubscribe failed';
+        return (0, types_1.err)(message);
     }
 }
 /**
  * Get current push subscription if exists
+ *
+ * @returns Result with current subscription, or error if not subscribed
  */
 async function getCurrentSubscription() {
     try {
         const registration = await navigator.serviceWorker.ready;
         const subscription = await registration.pushManager.getSubscription();
         if (!subscription) {
-            return null;
+            return (0, types_1.err)('No active subscription');
         }
-        return toPushSubscription(subscription);
+        return (0, types_1.ok)(toPushSubscription(subscription));
     }
-    catch {
-        return null;
+    catch (error) {
+        const message = error instanceof Error ? error.message : 'Failed to get subscription';
+        return (0, types_1.err)(message);
     }
 }

package/dist/pwa-push-sw.js

@@ -0,0 +1,172 @@
+"use strict";
+var PwaPush = (() => {
+  var __create = Object.create;
+  var __defProp = Object.defineProperty;
+  var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+  var __getOwnPropNames = Object.getOwnPropertyNames;
+  var __getProtoOf = Object.getPrototypeOf;
+  var __hasOwnProp = Object.prototype.hasOwnProperty;
+  var __commonJS = (cb, mod) => function __require() {
+    return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
+  };
+  var __export = (target, all) => {
+    for (var name in all)
+      __defProp(target, name, { get: all[name], enumerable: true });
+  };
+  var __copyProps = (to, from, except, desc) => {
+    if (from && typeof from === "object" || typeof from === "function") {
+      for (let key of __getOwnPropNames(from))
+        if (!__hasOwnProp.call(to, key) && key !== except)
+          __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+    }
+    return to;
+  };
+  var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+    // If the importer is in node compatibility mode or this is not an ESM
+    // file that has been converted to a CommonJS file using a Babel-
+    // compatible transform (i.e. "__esModule" has not been set), then set
+    // "default" to the CommonJS "module.exports" for node compatibility.
+    isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+    mod
+  ));
+  var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+  // ../core/dist/types.js
+  var require_types = __commonJS({
+    "../core/dist/types.js"(exports) {
+      "use strict";
+      Object.defineProperty(exports, "__esModule", { value: true });
+      exports.ok = ok2;
+      exports.okVoid = okVoid2;
+      exports.err = err2;
+      function ok2(data) {
+        return { ok: true, data };
+      }
+      function okVoid2() {
+        return { ok: true };
+      }
+      function err2(error, statusCode) {
+        return statusCode !== void 0 ? { ok: false, error, statusCode } : { ok: false, error };
+      }
+    }
+  });
+
+  // src/sw.ts
+  var sw_exports = {};
+  __export(sw_exports, {
+    handleSubscriptionChange: () => handleSubscriptionChange
+  });
+
+  // src/client/encoding.ts
+  function urlBase64ToUint8Array(base64String) {
+    const padding = "=".repeat((4 - base64String.length % 4) % 4);
+    const base64 = (base64String + padding).replace(/-/g, "+").replace(/_/g, "/");
+    const rawData = atob(base64);
+    const buffer = new ArrayBuffer(rawData.length);
+    const outputArray = new Uint8Array(buffer);
+    for (let i = 0; i < rawData.length; ++i) {
+      outputArray[i] = rawData.charCodeAt(i);
+    }
+    return outputArray;
+  }
+
+  // src/client/indexedDb.ts
+  var DB_NAME = "PushSubscriptionDB";
+  var STORE_NAME = "subscriptionData";
+  var DATA_KEY = "current";
+  function openDatabase() {
+    return new Promise((resolve, reject) => {
+      const request = indexedDB.open(DB_NAME, 1);
+      request.onerror = () => reject(request.error);
+      request.onsuccess = () => resolve(request.result);
+      request.onupgradeneeded = (event) => {
+        const db = event.target.result;
+        if (!db.objectStoreNames.contains(STORE_NAME)) {
+          db.createObjectStore(STORE_NAME);
+        }
+      };
+    });
+  }
+  async function withTransaction(mode, operation) {
+    const db = await openDatabase();
+    return new Promise((resolve, reject) => {
+      const transaction = db.transaction(STORE_NAME, mode);
+      const store = transaction.objectStore(STORE_NAME);
+      const request = operation(store);
+      request.onerror = () => reject(request.error);
+      request.onsuccess = () => resolve(request.result);
+      transaction.oncomplete = () => db.close();
+    });
+  }
+  async function getSubscriptionData() {
+    const result = await withTransaction(
+      "readonly",
+      (store) => store.get(DATA_KEY)
+    );
+    return result || null;
+  }
+
+  // src/client/subscribe.ts
+  var import_types = __toESM(require_types());
+  function toPushSubscription(browserSub) {
+    const json = browserSub.toJSON();
+    return {
+      endpoint: browserSub.endpoint,
+      keys: {
+        p256dh: json.keys?.p256dh || "",
+        auth: json.keys?.auth || ""
+      }
+    };
+  }
+
+  // src/client/renewal.ts
+  async function handleSubscriptionChange(event, renewEndpoint) {
+    try {
+      const data = await getSubscriptionData();
+      if (!data) {
+        console.error("No subscription data found for renewal");
+        return false;
+      }
+      const newSubscription = await resubscribe(data);
+      if (!newSubscription) {
+        console.error("Failed to create new subscription");
+        return false;
+      }
+      const renewalRequest = {
+        subscription: newSubscription,
+        deviceId: data.deviceId,
+        basePath: data.basePath
+      };
+      const response = await fetch(renewEndpoint, {
+        method: "POST",
+        headers: { "Content-Type": "application/json" },
+        body: JSON.stringify(renewalRequest)
+      });
+      if (!response.ok) {
+        console.error("Renewal request failed:", response.status);
+        return false;
+      }
+      console.log("Push subscription renewed successfully");
+      return true;
+    } catch (error) {
+      console.error("Subscription renewal failed:", error);
+      return false;
+    }
+  }
+  async function resubscribe(data) {
+    try {
+      const self = globalThis;
+      const registration = self.registration;
+      const applicationServerKey = urlBase64ToUint8Array(data.publicKey);
+      const subscription = await registration.pushManager.subscribe({
+        userVisibleOnly: true,
+        applicationServerKey
+      });
+      return toPushSubscription(subscription);
+    } catch (error) {
+      console.error("Resubscribe failed:", error);
+      return null;
+    }
+  }
+  return __toCommonJS(sw_exports);
+})();

package/dist/server/send.d.ts

@@ -1,4 +1,5 @@
-import { PushSubscription, NotificationPayload, SendResult } from '../types';
+import { Result } from '@markwharton/pwa-core/types';
+import { PushSubscription, NotificationPayload } from '../types';
 /**
  * Initialize VAPID configuration - call once at startup
  * Fails fast if keys are missing
@@ -18,17 +19,20 @@ export declare function initPushFromEnv(): void;
 export declare function getVapidPublicKey(): string;
 /**
  * Send a push notification to a single subscription
+ *
+ * @returns Result with ok status, or error details on failure
  */
-export declare function sendPushNotification(subscription: PushSubscription, payload: NotificationPayload): Promise<boolean>;
+export declare function sendPushNotification(subscription: PushSubscription, payload: NotificationPayload): Promise<Result<void>>;
 /**
  * Send a push notification to multiple subscriptions
- * Returns array of results
+ * Returns array of results, one per subscription
  */
-export declare function sendPushToAll(subscriptions: PushSubscription[], payload: NotificationPayload): Promise<SendResult[]>;
+export declare function sendPushToAll(subscriptions: PushSubscription[], payload: NotificationPayload): Promise<Result<void>[]>;
 /**
  * Send push notification with detailed error information
+ * Auto-injects basePath from subscription to payload if not already set
  */
-export declare function sendPushWithDetails(subscription: PushSubscription, payload: NotificationPayload): Promise<SendResult>;
+export declare function sendPushWithDetails(subscription: PushSubscription, payload: NotificationPayload): Promise<Result<void>>;
 /**
  * Check if a subscription is expired (410 Gone)
  */

package/dist/server/send.js

@@ -11,6 +11,7 @@ exports.sendPushToAll = sendPushToAll;
 exports.sendPushWithDetails = sendPushWithDetails;
 exports.isSubscriptionExpired = isSubscriptionExpired;
 const web_push_1 = __importDefault(require("web-push"));
+const types_1 = require("@markwharton/pwa-core/types");
 /**
  * Server-side Web Push notification utilities
  */
@@ -51,14 +52,15 @@ function getVapidPublicKey() {
 }
 /**
  * Send a push notification to a single subscription
+ *
+ * @returns Result with ok status, or error details on failure
  */
 async function sendPushNotification(subscription, payload) {
-    const result = await sendPushWithDetails(subscription, payload);
-    return result.success;
+    return sendPushWithDetails(subscription, payload);
 }
 /**
  * Send a push notification to multiple subscriptions
- * Returns array of results
+ * Returns array of results, one per subscription
  */
 async function sendPushToAll(subscriptions, payload) {
     const results = await Promise.all(subscriptions.map(sub => sendPushWithDetails(sub, payload)));
@@ -66,22 +68,24 @@ async function sendPushToAll(subscriptions, payload) {
 }
 /**
  * Send push notification with detailed error information
+ * Auto-injects basePath from subscription to payload if not already set
  */
 async function sendPushWithDetails(subscription, payload) {
     if (!vapidConfig) {
-        return { success: false, error: 'Push not initialized' };
+        return (0, types_1.err)('Push not initialized');
     }
+    // Auto-inject basePath from subscription if not set in payload
+    const payloadWithBasePath = {
+        ...payload,
+        basePath: payload.basePath ?? subscription.basePath ?? '/'
+    };
     try {
-        await web_push_1.default.sendNotification(subscription, JSON.stringify(payload));
-        return { success: true };
+        await web_push_1.default.sendNotification(subscription, JSON.stringify(payloadWithBasePath));
+        return (0, types_1.okVoid)();
     }
     catch (error) {
         const webPushError = error;
-        return {
-            success: false,
-            error: webPushError.message || 'Unknown error',
-            statusCode: webPushError.statusCode
-        };
+        return (0, types_1.err)(webPushError.message || 'Unknown error', webPushError.statusCode);
     }
 }
 /**

package/dist/sw.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Service Worker bundle entry point
+ * Exports functions for use via importScripts()
+ *
+ * Usage in sw.js:
+ * ```
+ * importScripts('/path/to/pwa-push-sw.js');
+ *
+ * self.addEventListener('pushsubscriptionchange', (event) => {
+ *     event.waitUntil(PwaPush.handleSubscriptionChange('/api/push/renew'));
+ * });
+ * ```
+ */
+export { handleSubscriptionChange } from './client/renewal';

package/dist/sw.js

@@ -0,0 +1,18 @@
+"use strict";
+/**
+ * Service Worker bundle entry point
+ * Exports functions for use via importScripts()
+ *
+ * Usage in sw.js:
+ * ```
+ * importScripts('/path/to/pwa-push-sw.js');
+ *
+ * self.addEventListener('pushsubscriptionchange', (event) => {
+ *     event.waitUntil(PwaPush.handleSubscriptionChange('/api/push/renew'));
+ * });
+ * ```
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleSubscriptionChange = void 0;
+var renewal_1 = require("./client/renewal");
+Object.defineProperty(exports, "handleSubscriptionChange", { enumerable: true, get: function () { return renewal_1.handleSubscriptionChange; } });

package/dist/types.d.ts

@@ -1,12 +1,14 @@
 /**
  * Push notification types - shared between server and client
  */
+export { Result, ok, okVoid, err } from '@markwharton/pwa-core/types';
 export interface PushSubscription {
     endpoint: string;
     keys: {
         p256dh: string;
         auth: string;
     };
+    basePath?: string;
 }
 export interface NotificationPayload {
     title: string;
@@ -15,27 +17,20 @@ export interface NotificationPayload {
     url?: string;
     tag?: string;
     data?: Record<string, unknown>;
+    id?: string;
+    timestamp?: string;
+    basePath?: string;
 }
 export interface VapidConfig {
     publicKey: string;
     privateKey: string;
     subject: string;
 }
-export interface SendResult {
-    success: boolean;
-    error?: string;
-    statusCode?: number;
-}
 export interface SubscriptionRequest {
     subscription: PushSubscription;
     deviceId: string;
     basePath?: string;
 }
-export interface RenewalRequest {
-    subscription: PushSubscription;
-    deviceId: string;
-    basePath?: string;
-}
 export interface SubscriptionData {
     publicKey: string;
     deviceId: string;

package/dist/types.js

@@ -3,3 +3,9 @@
  * Push notification types - shared between server and client
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.err = exports.okVoid = exports.ok = void 0;
+// Re-export Result from pwa-core for convenience
+var types_1 = require("@markwharton/pwa-core/types");
+Object.defineProperty(exports, "ok", { enumerable: true, get: function () { return types_1.ok; } });
+Object.defineProperty(exports, "okVoid", { enumerable: true, get: function () { return types_1.okVoid; } });
+Object.defineProperty(exports, "err", { enumerable: true, get: function () { return types_1.err; } });

package/package.json

@@ -1,24 +1,29 @@
 {
   "name": "@markwharton/pwa-push",
-  "version": "1.0.1",
+  "version": "1.2.0",
   "description": "Web push notifications for Azure PWA projects",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "exports": {
     ".": "./dist/index.js",
     "./server": "./dist/server/index.js",
-    "./client": "./dist/client/index.js"
+    "./client": "./dist/client/index.js",
+    "./sw": "./dist/pwa-push-sw.js"
   },
   "scripts": {
-    "build": "tsc",
+    "build": "tsc && npm run build:sw",
+    "build:sw": "esbuild src/sw.ts --bundle --outfile=dist/pwa-push-sw.js --format=iife --global-name=PwaPush",
     "clean": "rm -rf dist"
   },
   "peerDependencies": {
+    "@markwharton/pwa-core": "^1.1.0",
     "web-push": "^3.6.0"
   },
   "devDependencies": {
+    "@markwharton/pwa-core": "^1.1.0",
     "@types/node": "^20.10.0",
     "@types/web-push": "^3.6.4",
+    "esbuild": "^0.27.2",
     "typescript": "^5.3.0",
     "web-push": "^3.6.7"
   },
@@ -27,7 +32,7 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/MarkWharton/pwa-packages.git",
+    "url": "git+https://github.com/MarkWharton/pwa-packages.git",
     "directory": "packages/push"
   },
   "author": "Mark Wharton",

package/dist/client/utils.d.ts

@@ -1,14 +0,0 @@
-/**
- * Shared utilities for push notification client code
- */
-import { PushSubscription } from '../types';
-/**
- * Convert base64 URL-encoded string to Uint8Array
- * Works in both main thread and service worker contexts
- */
-export declare function urlBase64ToUint8Array(base64String: string): Uint8Array<ArrayBuffer>;
-/**
- * Convert browser PushSubscription to our format
- * Works in both main thread and service worker contexts
- */
-export declare function toPushSubscription(browserSub: globalThis.PushSubscription): PushSubscription;

package/dist/client/utils.js

@@ -1,38 +0,0 @@
-"use strict";
-/**
- * Shared utilities for push notification client code
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.urlBase64ToUint8Array = urlBase64ToUint8Array;
-exports.toPushSubscription = toPushSubscription;
-/**
- * Convert base64 URL-encoded string to Uint8Array
- * Works in both main thread and service worker contexts
- */
-function urlBase64ToUint8Array(base64String) {
-    const padding = '='.repeat((4 - (base64String.length % 4)) % 4);
-    const base64 = (base64String + padding)
-        .replace(/-/g, '+')
-        .replace(/_/g, '/');
-    const rawData = atob(base64);
-    const buffer = new ArrayBuffer(rawData.length);
-    const outputArray = new Uint8Array(buffer);
-    for (let i = 0; i < rawData.length; ++i) {
-        outputArray[i] = rawData.charCodeAt(i);
-    }
-    return outputArray;
-}
-/**
- * Convert browser PushSubscription to our format
- * Works in both main thread and service worker contexts
- */
-function toPushSubscription(browserSub) {
-    const json = browserSub.toJSON();
-    return {
-        endpoint: browserSub.endpoint,
-        keys: {
-            p256dh: json.keys?.p256dh || '',
-            auth: json.keys?.auth || ''
-        }
-    };
-}