@markwharton/pwa-push 1.5.3 → 2.0.0

package/dist/client/subscribe.d.ts

@@ -1,88 +0,0 @@
-/**
- * Push subscription helpers for main thread
- */
-import { Result } from '@markwharton/pwa-core/types';
-import { PushSubscription, SubscriptionRequest, PushPermissionState } from '../shared';
-/**
- * Gets the current notification permission state.
- * @returns The current permission state ('granted', 'denied', or 'default')
- * @example
- * const state = getPermissionState();
- * if (state === 'granted') {
- *   // Can show notifications
- * }
- */
-export declare function getPermissionState(): PushPermissionState;
-/**
- * Requests notification permission from the user.
- * Shows browser permission dialog if not already granted/denied.
- * @returns The resulting permission state
- * @example
- * const permission = await requestPermission();
- * if (permission === 'granted') {
- *   await subscribeToPush(vapidKey);
- * }
- */
-export declare function requestPermission(): Promise<PushPermissionState>;
-/**
- * Checks if push notifications are supported in the current browser.
- * Requires both Service Worker and Push API support.
- * @returns True if push notifications are supported
- * @example
- * if (!isPushSupported()) {
- *   console.log('Push not supported on this browser');
- *   return;
- * }
- */
-export declare function isPushSupported(): boolean;
-/**
- * Converts a browser PushSubscription to the simplified format for backend storage.
- * Works in both main thread and service worker contexts.
- * @param browserSub - The native browser PushSubscription object
- * @returns A simplified PushSubscription with endpoint and keys
- * @example
- * const browserSub = await registration.pushManager.subscribe({ ... });
- * const subscription = toPushSubscription(browserSub);
- * await fetch('/api/subscribe', { body: JSON.stringify(subscription) });
- */
-export declare function toPushSubscription(browserSub: globalThis.PushSubscription): PushSubscription;
-/**
- * Subscribes to push notifications and prepares a request for backend registration.
- * Handles permission request, service worker subscription, and data persistence.
- * @param vapidPublicKey - The VAPID public key from your server
- * @param basePath - Optional base path for notification click handling (default: '/')
- * @returns Result with subscription request on success, or error message on failure
- * @example
- * const result = await subscribeToPush(vapidPublicKey);
- * if (result.ok) {
- *   await fetch('/api/push/subscribe', {
- *     method: 'POST',
- *     body: JSON.stringify(result.data)
- *   });
- * }
- */
-export declare function subscribeToPush(vapidPublicKey: string, basePath?: string): Promise<Result<SubscriptionRequest>>;
-/**
- * Unsubscribes from push notifications.
- * Removes the browser push subscription and clears stored subscription data.
- * @returns Result with ok=true on success, or error message on failure
- * @example
- * const result = await unsubscribeFromPush();
- * if (result.ok) {
- *   await fetch('/api/push/unsubscribe', { method: 'POST' });
- * }
- */
-export declare function unsubscribeFromPush(): Promise<Result<void>>;
-/**
- * Gets the current push subscription if one exists.
- * Useful for checking subscription status or syncing with backend.
- * @returns Result with the current subscription, or error if not subscribed
- * @example
- * const result = await getCurrentSubscription();
- * if (result.ok) {
- *   console.log('Endpoint:', result.data.endpoint);
- * } else {
- *   console.log('Not subscribed:', result.error);
- * }
- */
-export declare function getCurrentSubscription(): Promise<Result<PushSubscription>>;

package/dist/client/subscribe.js

@@ -1,176 +0,0 @@
-"use strict";
-/**
- * Push subscription helpers for main thread
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPermissionState = getPermissionState;
-exports.requestPermission = requestPermission;
-exports.isPushSupported = isPushSupported;
-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");
-/**
- * Gets the current notification permission state.
- * @returns The current permission state ('granted', 'denied', or 'default')
- * @example
- * const state = getPermissionState();
- * if (state === 'granted') {
- *   // Can show notifications
- * }
- */
-function getPermissionState() {
-    return Notification.permission;
-}
-/**
- * Requests notification permission from the user.
- * Shows browser permission dialog if not already granted/denied.
- * @returns The resulting permission state
- * @example
- * const permission = await requestPermission();
- * if (permission === 'granted') {
- *   await subscribeToPush(vapidKey);
- * }
- */
-async function requestPermission() {
-    const result = await Notification.requestPermission();
-    return result;
-}
-/**
- * Checks if push notifications are supported in the current browser.
- * Requires both Service Worker and Push API support.
- * @returns True if push notifications are supported
- * @example
- * if (!isPushSupported()) {
- *   console.log('Push not supported on this browser');
- *   return;
- * }
- */
-function isPushSupported() {
-    return 'serviceWorker' in navigator && 'PushManager' in window;
-}
-/**
- * Converts a browser PushSubscription to the simplified format for backend storage.
- * Works in both main thread and service worker contexts.
- * @param browserSub - The native browser PushSubscription object
- * @returns A simplified PushSubscription with endpoint and keys
- * @example
- * const browserSub = await registration.pushManager.subscribe({ ... });
- * const subscription = toPushSubscription(browserSub);
- * await fetch('/api/subscribe', { body: JSON.stringify(subscription) });
- */
-function toPushSubscription(browserSub) {
-    const json = browserSub.toJSON();
-    return {
-        endpoint: browserSub.endpoint,
-        keys: {
-            p256dh: json.keys?.p256dh || '',
-            auth: json.keys?.auth || ''
-        }
-    };
-}
-/**
- * Subscribes to push notifications and prepares a request for backend registration.
- * Handles permission request, service worker subscription, and data persistence.
- * @param vapidPublicKey - The VAPID public key from your server
- * @param basePath - Optional base path for notification click handling (default: '/')
- * @returns Result with subscription request on success, or error message on failure
- * @example
- * const result = await subscribeToPush(vapidPublicKey);
- * if (result.ok) {
- *   await fetch('/api/push/subscribe', {
- *     method: 'POST',
- *     body: JSON.stringify(result.data)
- *   });
- * }
- */
-async function subscribeToPush(vapidPublicKey, basePath = '/') {
-    if (!isPushSupported()) {
-        return (0, types_1.err)('Push notifications not supported');
-    }
-    const permission = await requestPermission();
-    if (permission !== 'granted') {
-        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);
-    }
-}
-/**
- * Unsubscribes from push notifications.
- * Removes the browser push subscription and clears stored subscription data.
- * @returns Result with ok=true on success, or error message on failure
- * @example
- * const result = await unsubscribeFromPush();
- * if (result.ok) {
- *   await fetch('/api/push/unsubscribe', { method: 'POST' });
- * }
- */
-async function unsubscribeFromPush() {
-    try {
-        const registration = await navigator.serviceWorker.ready;
-        const subscription = await registration.pushManager.getSubscription();
-        if (subscription) {
-            await subscription.unsubscribe();
-        }
-        // Clear stored subscription data from IndexedDB
-        await (0, indexedDb_1.clearSubscriptionData)();
-        return (0, types_1.okVoid)();
-    }
-    catch (error) {
-        const message = error instanceof Error ? error.message : 'Unsubscribe failed';
-        return (0, types_1.err)(message);
-    }
-}
-/**
- * Gets the current push subscription if one exists.
- * Useful for checking subscription status or syncing with backend.
- * @returns Result with the current subscription, or error if not subscribed
- * @example
- * const result = await getCurrentSubscription();
- * if (result.ok) {
- *   console.log('Endpoint:', result.data.endpoint);
- * } else {
- *   console.log('Not subscribed:', result.error);
- * }
- */
-async function getCurrentSubscription() {
-    try {
-        const registration = await navigator.serviceWorker.ready;
-        const subscription = await registration.pushManager.getSubscription();
-        if (!subscription) {
-            return (0, types_1.err)('No active subscription');
-        }
-        return (0, types_1.ok)(toPushSubscription(subscription));
-    }
-    catch (error) {
-        const message = error instanceof Error ? error.message : 'Failed to get subscription';
-        return (0, types_1.err)(message);
-    }
-}

package/dist/server/index.d.ts

@@ -1 +0,0 @@
-export { initPush, initPushFromEnv, getVapidPublicKey, sendPushNotification, sendPushToAll, sendPushWithDetails, isSubscriptionExpired } from './send';

package/dist/server/index.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isSubscriptionExpired = exports.sendPushWithDetails = exports.sendPushToAll = exports.sendPushNotification = exports.getVapidPublicKey = exports.initPushFromEnv = exports.initPush = void 0;
-var send_1 = require("./send");
-Object.defineProperty(exports, "initPush", { enumerable: true, get: function () { return send_1.initPush; } });
-Object.defineProperty(exports, "initPushFromEnv", { enumerable: true, get: function () { return send_1.initPushFromEnv; } });
-Object.defineProperty(exports, "getVapidPublicKey", { enumerable: true, get: function () { return send_1.getVapidPublicKey; } });
-Object.defineProperty(exports, "sendPushNotification", { enumerable: true, get: function () { return send_1.sendPushNotification; } });
-Object.defineProperty(exports, "sendPushToAll", { enumerable: true, get: function () { return send_1.sendPushToAll; } });
-Object.defineProperty(exports, "sendPushWithDetails", { enumerable: true, get: function () { return send_1.sendPushWithDetails; } });
-Object.defineProperty(exports, "isSubscriptionExpired", { enumerable: true, get: function () { return send_1.isSubscriptionExpired; } });

package/dist/types.d.ts

@@ -1,39 +0,0 @@
-/**
- * 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;
-    body: string;
-    type?: string;
-    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 SubscriptionRequest {
-    subscription: PushSubscription;
-    deviceId: string;
-    basePath?: string;
-}
-export interface SubscriptionData {
-    publicKey: string;
-    deviceId: string;
-    basePath: string;
-}
-export type PushPermissionState = 'granted' | 'denied' | 'default';

package/dist/types.js

@@ -1,11 +0,0 @@
-"use strict";
-/**
- * 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; } });