@markwharton/pwa-push 2.0.1 → 3.1.0

package/dist/pwa-push-sw.js

@@ -31,9 +31,9 @@ var PwaPush = (() => {
   ));
   var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-  // node_modules/@markwharton/pwa-core/dist/shared.js
+  // ../core/dist/shared.js
   var require_shared = __commonJS({
-    "node_modules/@markwharton/pwa-core/dist/shared.js"(exports) {
+    "../core/dist/shared.js"(exports) {
       "use strict";
       Object.defineProperty(exports, "__esModule", { value: true });
       exports.HTTP_STATUS = void 0;
@@ -50,8 +50,8 @@ var PwaPush = (() => {
       function okVoid2() {
         return { ok: true };
       }
-      function err2(error, statusCode) {
-        return statusCode !== void 0 ? { ok: false, error, statusCode } : { ok: false, error };
+      function err2(error, status) {
+        return status !== void 0 ? { ok: false, error, status } : { ok: false, error };
       }
       function hasUsername(payload) {
         return "username" in payload && typeof payload.username === "string";

package/dist/server.d.ts

@@ -3,7 +3,7 @@
  *
  * Requires: web-push package
  */
-import { Result, PushSubscription, NotificationPayload } from './shared';
+import { Result, PushSubscription, NotificationPayload, BroadcastResult } from './shared';
 /**
  * Initializes VAPID configuration for Web Push. Call once at application startup.
  * @param config - VAPID configuration
@@ -44,47 +44,49 @@ export declare function initPushFromEnv(): void;
 export declare function getVapidPublicKey(): string;
 /**
  * Sends a push notification to a single subscription.
- * @param subscription - The push subscription to send to
- * @param payload - The notification payload (title, body, etc.)
- * @returns Result with ok=true on success, or error message and statusCode on failure
- * @example
- * const result = await sendPushNotification(subscription, {
- *   title: 'New Message',
- *   body: 'You have a new message'
- * });
- */
-export declare function sendPushNotification(subscription: PushSubscription, payload: NotificationPayload): Promise<Result<void>>;
-/**
- * Sends a push notification to multiple subscriptions in parallel.
- * @param subscriptions - Array of push subscriptions
- * @param payload - The notification payload (title, body, etc.)
- * @returns Array of Results, one per subscription (in same order)
- * @example
- * const results = await sendPushToAll(subscriptions, { title: 'Alert', body: 'System update' });
- * const failed = results.filter(r => !r.ok);
- */
-export declare function sendPushToAll(subscriptions: PushSubscription[], payload: NotificationPayload): Promise<Result<void>[]>;
-/**
- * Sends a push notification with detailed error information.
  * Automatically injects basePath from subscription if not set in payload.
  * @param subscription - The push subscription to send to
  * @param payload - The notification payload
- * @returns Result with ok=true on success, or error with statusCode on failure
+ * @returns Result with ok=true on success, or error with status on failure
  * @example
- * const result = await sendPushWithDetails(subscription, { title: 'Alert' });
- * if (!result.ok && isSubscriptionExpired(result.statusCode)) {
+ * const result = await sendPush(subscription, { title: 'Alert', body: 'Update' });
+ * if (!result.ok && isSubscriptionExpired(result.status)) {
  *   await deleteSubscription(subscription);
  * }
  */
-export declare function sendPushWithDetails(subscription: PushSubscription, payload: NotificationPayload): Promise<Result<void>>;
+export declare function sendPush(subscription: PushSubscription, payload: NotificationPayload): Promise<Result<void>>;
+/**
+ * Broadcasts a push notification to multiple subscriptions in parallel.
+ * Returns structured results with counts and invalid endpoint tracking.
+ * Generic `<TSub>` lets the payload callback receive app-extended subscription types.
+ * @typeParam TSub - Push subscription type (extends PushSubscription)
+ * @param subscriptions - Array of push subscriptions
+ * @param payload - Static payload or per-subscription callback
+ * @returns BroadcastResult with sent/failed counts and invalid endpoints
+ * @example
+ * const result = await broadcastPush(subscriptions, { title: 'Alert', body: 'Update' });
+ * await cleanupInvalid(result.invalidEndpoints);
+ *
+ * // Per-subscription payload:
+ * const result = await broadcastPush(subscriptions, (sub) => ({
+ *   title: 'Alert', body: 'Update', basePath: sub.basePath
+ * }));
+ */
+export declare function broadcastPush<TSub extends PushSubscription>(subscriptions: TSub[], payload: NotificationPayload | ((subscription: TSub) => NotificationPayload)): Promise<BroadcastResult>;
 /**
  * Checks if a status code indicates an expired subscription (410 Gone).
  * Use this to clean up stale subscriptions from your database.
- * @param statusCode - The HTTP status code from a failed push attempt
+ * @param status - The HTTP status code from a failed push attempt
  * @returns True if the subscription should be deleted
  * @example
- * if (!result.ok && isSubscriptionExpired(result.statusCode)) {
+ * if (!result.ok && isSubscriptionExpired(result.status)) {
  *   await db.deleteSubscription(subscription.endpoint);
  * }
  */
-export declare function isSubscriptionExpired(statusCode: number | undefined): boolean;
+export declare function isSubscriptionExpired(status: number | undefined): boolean;
+/** @deprecated Use `sendPush` instead */
+export declare const sendPushNotification: typeof sendPush;
+/** @deprecated Use `sendPush` instead */
+export declare const sendPushWithDetails: typeof sendPush;
+/** @deprecated Use `broadcastPush` instead */
+export declare function sendPushToAll(subscriptions: PushSubscription[], payload: NotificationPayload): Promise<Result<void>[]>;

package/dist/server.js

@@ -8,13 +8,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendPushWithDetails = exports.sendPushNotification = void 0;
 exports.initPush = initPush;
 exports.initPushFromEnv = initPushFromEnv;
 exports.getVapidPublicKey = getVapidPublicKey;
-exports.sendPushNotification = sendPushNotification;
-exports.sendPushToAll = sendPushToAll;
-exports.sendPushWithDetails = sendPushWithDetails;
+exports.sendPush = sendPush;
+exports.broadcastPush = broadcastPush;
 exports.isSubscriptionExpired = isSubscriptionExpired;
+exports.sendPushToAll = sendPushToAll;
 const web_push_1 = __importDefault(require("web-push"));
 const shared_1 = require("./shared");
 let vapidConfig = null;
@@ -75,44 +76,17 @@ function getVapidPublicKey() {
 }
 /**
  * Sends a push notification to a single subscription.
- * @param subscription - The push subscription to send to
- * @param payload - The notification payload (title, body, etc.)
- * @returns Result with ok=true on success, or error message and statusCode on failure
- * @example
- * const result = await sendPushNotification(subscription, {
- *   title: 'New Message',
- *   body: 'You have a new message'
- * });
- */
-async function sendPushNotification(subscription, payload) {
-    return sendPushWithDetails(subscription, payload);
-}
-/**
- * Sends a push notification to multiple subscriptions in parallel.
- * @param subscriptions - Array of push subscriptions
- * @param payload - The notification payload (title, body, etc.)
- * @returns Array of Results, one per subscription (in same order)
- * @example
- * const results = await sendPushToAll(subscriptions, { title: 'Alert', body: 'System update' });
- * const failed = results.filter(r => !r.ok);
- */
-async function sendPushToAll(subscriptions, payload) {
-    const results = await Promise.all(subscriptions.map(sub => sendPushWithDetails(sub, payload)));
-    return results;
-}
-/**
- * Sends a push notification with detailed error information.
  * Automatically injects basePath from subscription if not set in payload.
  * @param subscription - The push subscription to send to
  * @param payload - The notification payload
- * @returns Result with ok=true on success, or error with statusCode on failure
+ * @returns Result with ok=true on success, or error with status on failure
  * @example
- * const result = await sendPushWithDetails(subscription, { title: 'Alert' });
- * if (!result.ok && isSubscriptionExpired(result.statusCode)) {
+ * const result = await sendPush(subscription, { title: 'Alert', body: 'Update' });
+ * if (!result.ok && isSubscriptionExpired(result.status)) {
  *   await deleteSubscription(subscription);
  * }
  */
-async function sendPushWithDetails(subscription, payload) {
+async function sendPush(subscription, payload) {
     if (!vapidConfig) {
         return (0, shared_1.err)('Push not initialized');
     }
@@ -130,16 +104,65 @@ async function sendPushWithDetails(subscription, payload) {
         return (0, shared_1.err)(webPushError.message || 'Unknown error', webPushError.statusCode);
     }
 }
+/**
+ * Broadcasts a push notification to multiple subscriptions in parallel.
+ * Returns structured results with counts and invalid endpoint tracking.
+ * Generic `<TSub>` lets the payload callback receive app-extended subscription types.
+ * @typeParam TSub - Push subscription type (extends PushSubscription)
+ * @param subscriptions - Array of push subscriptions
+ * @param payload - Static payload or per-subscription callback
+ * @returns BroadcastResult with sent/failed counts and invalid endpoints
+ * @example
+ * const result = await broadcastPush(subscriptions, { title: 'Alert', body: 'Update' });
+ * await cleanupInvalid(result.invalidEndpoints);
+ *
+ * // Per-subscription payload:
+ * const result = await broadcastPush(subscriptions, (sub) => ({
+ *   title: 'Alert', body: 'Update', basePath: sub.basePath
+ * }));
+ */
+async function broadcastPush(subscriptions, payload) {
+    let sent = 0;
+    let failed = 0;
+    const invalidEndpoints = [];
+    await Promise.all(subscriptions.map(async (subscription) => {
+        const actualPayload = typeof payload === 'function'
+            ? payload(subscription) : payload;
+        const result = await sendPush(subscription, actualPayload);
+        if (result.ok) {
+            sent++;
+        }
+        else {
+            failed++;
+            if (isSubscriptionExpired(result.status)) {
+                invalidEndpoints.push(subscription.endpoint);
+            }
+        }
+    }));
+    return { sent, failed, invalidEndpoints };
+}
 /**
  * Checks if a status code indicates an expired subscription (410 Gone).
  * Use this to clean up stale subscriptions from your database.
- * @param statusCode - The HTTP status code from a failed push attempt
+ * @param status - The HTTP status code from a failed push attempt
  * @returns True if the subscription should be deleted
  * @example
- * if (!result.ok && isSubscriptionExpired(result.statusCode)) {
+ * if (!result.ok && isSubscriptionExpired(result.status)) {
  *   await db.deleteSubscription(subscription.endpoint);
  * }
  */
-function isSubscriptionExpired(statusCode) {
-    return statusCode === 410;
+function isSubscriptionExpired(status) {
+    return status === 410;
+}
+// =============================================================================
+// Deprecated aliases (remove in next major)
+// =============================================================================
+/** @deprecated Use `sendPush` instead */
+exports.sendPushNotification = sendPush;
+/** @deprecated Use `sendPush` instead */
+exports.sendPushWithDetails = sendPush;
+/** @deprecated Use `broadcastPush` instead */
+async function sendPushToAll(subscriptions, payload) {
+    const results = await Promise.all(subscriptions.map(sub => sendPush(sub, payload)));
+    return results;
 }

package/dist/shared.d.ts

@@ -57,3 +57,11 @@ export interface SubscriptionData {
  * Browser notification permission state.
  */
 export type PushPermissionState = 'granted' | 'denied' | 'default';
+/**
+ * Result of broadcasting push notifications to multiple subscriptions.
+ */
+export interface BroadcastResult {
+    sent: number;
+    failed: number;
+    invalidEndpoints: string[];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@markwharton/pwa-push",
-  "version": "2.0.1",
+  "version": "3.1.0",
   "description": "Web push notifications for Azure PWA projects",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -30,11 +30,11 @@
     "clean": "rm -rf dist"
   },
   "peerDependencies": {
-    "@markwharton/pwa-core": "^2.0.0 || ^3.0.0",
+    "@markwharton/pwa-core": "^2.0.0 || ^3.0.0 || ^4.0.0",
     "web-push": "^3.6.0"
   },
   "devDependencies": {
-    "@markwharton/pwa-core": "^3.0.0",
+    "@markwharton/pwa-core": "^4.0.0",
     "@types/node": "^20.10.0",
     "@types/web-push": "^3.6.4",
     "esbuild": "^0.27.2",