@markwharton/pwa-push 3.0.0 → 3.1.0

package/dist/server.d.ts

@@ -44,39 +44,17 @@ 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.
@@ -106,3 +84,9 @@ export declare function broadcastPush<TSub extends PushSubscription>(subscriptio
  * }
  */
 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,14 +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;
@@ -76,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');
     }
@@ -155,7 +128,7 @@ async function broadcastPush(subscriptions, payload) {
     await Promise.all(subscriptions.map(async (subscription) => {
         const actualPayload = typeof payload === 'function'
             ? payload(subscription) : payload;
-        const result = await sendPushWithDetails(subscription, actualPayload);
+        const result = await sendPush(subscription, actualPayload);
         if (result.ok) {
             sent++;
         }
@@ -181,3 +154,15 @@ async function broadcastPush(subscriptions, payload) {
 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/package.json

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