@markwharton/pwa-push 1.0.1 → 1.1.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,7 +1,7 @@
 /**
  * Push subscription helpers for main thread
  */
-import { PushSubscription, SubscriptionRequest, PushPermissionState } from '../types';
+import { PushSubscription, SubscriptionRequest, PushPermissionState, ClientResult } from '../types';
 /**
  * Check current notification permission state
  */
@@ -21,14 +21,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<ClientResult<SubscriptionRequest>>;
 /**
  * Unsubscribe from push notifications
+ *
+ * @returns Result indicating success or failure
  */
-export declare function unsubscribeFromPush(): Promise<boolean>;
+export declare function unsubscribeFromPush(): Promise<ClientResult<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<ClientResult<PushSubscription>>;

package/dist/client/subscribe.js

@@ -48,40 +48,50 @@ 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 { ok: false, error: 'Push notifications not supported' };
     }
     const permission = await requestPermission();
     if (permission !== 'granted') {
-        console.warn('Push permission denied');
-        return null;
+        return { ok: false, error: '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 {
+            ok: true,
+            data: {
+                subscription: toPushSubscription(browserSub),
+                deviceId,
+                basePath
+            }
+        };
+    }
+    catch (error) {
+        const message = error instanceof Error ? error.message : 'Subscription failed';
+        return { ok: false, error: 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 +100,29 @@ async function unsubscribeFromPush() {
         if (subscription) {
             await subscription.unsubscribe();
         }
-        return true;
+        return { ok: true };
     }
     catch (error) {
-        console.error('Unsubscribe failed:', error);
-        return false;
+        const message = error instanceof Error ? error.message : 'Unsubscribe failed';
+        return { ok: false, error: 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 { ok: false, error: 'No active subscription' };
         }
-        return toPushSubscription(subscription);
+        return { ok: true, data: toPushSubscription(subscription) };
     }
-    catch {
-        return null;
+    catch (error) {
+        const message = error instanceof Error ? error.message : 'Failed to get subscription';
+        return { ok: false, error: message };
     }
 }

package/dist/server/send.d.ts

@@ -18,15 +18,18 @@ 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<SendResult>;
 /**
  * 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[]>;
 /**
  * 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>;
 /**

package/dist/server/send.js

@@ -51,14 +51,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,19 +67,25 @@ 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 { ok: false, error: '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 { ok: true };
     }
     catch (error) {
         const webPushError = error;
         return {
-            success: false,
+            ok: false,
             error: webPushError.message || 'Unknown error',
             statusCode: webPushError.statusCode
         };

package/dist/types.d.ts

@@ -7,6 +7,7 @@ export interface PushSubscription {
         p256dh: string;
         auth: string;
     };
+    basePath?: string;
 }
 export interface NotificationPayload {
     title: string;
@@ -15,23 +16,34 @@ 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;
 }
+/**
+ * Result type for push operations.
+ * Aligned with Result<T> pattern from @markwharton/pwa-core
+ */
 export interface SendResult {
-    success: boolean;
+    ok: boolean;
     error?: string;
     statusCode?: number;
 }
-export interface SubscriptionRequest {
-    subscription: PushSubscription;
-    deviceId: string;
-    basePath?: string;
+/**
+ * Generic result type for client operations.
+ * Aligned with Result<T> pattern from @markwharton/pwa-core
+ */
+export interface ClientResult<T> {
+    ok: boolean;
+    data?: T;
+    error?: string;
 }
-export interface RenewalRequest {
+export interface SubscriptionRequest {
     subscription: PushSubscription;
     deviceId: string;
     basePath?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@markwharton/pwa-push",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "Web push notifications for Azure PWA projects",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

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 || ''
-        }
-    };
-}