@janiscommerce/app-push-notification 0.0.5 → 0.0.6

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## [Unreleased]
 
+## [0.0.6] - 2025-07-13
+
+### Added
+
+- cancelNotificationSuscription method
+
 ## [0.0.5] - 2025-06-17
 
 ### Added

package/README.md

@@ -92,7 +92,7 @@ To use a custom sound on Android, you must:
 </tr>
 <tr>
 <td>cancelNotifications</td>
-<td>This util is responsible for making the request to unsubscribe from all notification events. If no arguments are received, the request will be made with the previously registered events.</td>
+<td>This util is responsible for making the request to unsubscribe from all notification events. If no arguments are received, the request will be made with the previously registered events. <em>⚠️ Deprecated: Use cancelNotificationsSubscription instead.</em></td>
 </tr>
 <tr>
 <td>updateSuscription</td>

package/lib/index.js

@@ -1,6 +1,11 @@
 import NotificationProvider from './NotificationProvider';
 import {usePushNotification} from './NotificationContext';
 import {setupBackgroundMessageHandler} from './utils';
+import cancelNotificationsSubscription from './utils/api/cancelNotificationsSubscription';
 
-export {usePushNotification, setupBackgroundMessageHandler};
+export {
+  usePushNotification,
+  setupBackgroundMessageHandler,
+  cancelNotificationsSubscription,
+};
 export default NotificationProvider;

package/lib/usePushNotification.js

@@ -100,6 +100,7 @@ const usePushNotification = (
    * @description This util is responsible for making the request to unsubscribe from all notification events. If no arguments are received, the request will be made with the previously registered events.
    * @param {Array<string>} events is the list of events to which I want to unsubscribe the device
    * @returns {Promise}
+   * @deprecated Use cancelNotificationsSubscription from the main export instead
    *
    * @example
    *
@@ -109,6 +110,10 @@ const usePushNotification = (
    */
 
   const cancelNotifications = async (cancelEvents) => {
+    console.warn(
+      '⚠️ cancelNotifications is deprecated. Use cancelNotificationsSubscription instead.',
+    );
+
     const eventsAreValid = cancelEvents && isArray(cancelEvents);
     const eventsToCancel = eventsAreValid ? cancelEvents : pushEvents;
     try {

package/lib/utils/api/cancelNotificationsSubscription/index.js

@@ -0,0 +1,39 @@
+import RequestInstance from '@janiscommerce/app-request';
+
+/**
+ * Cancels push notification subscriptions for specified events
+ * @param {Object} params - The parameters object
+ * @param {string[]} [params.events=[]] - Array of event names to unsubscribe from
+ * @param {string} params.env - Environment identifier (required)
+ * @returns {Promise<Object>} Promise that resolves with the API response
+ * @throws {Error} When environment is not provided or API request fails
+ * @example
+ * // Cancel subscription for specific events
+ * await cancelNotificationsSubscription({
+ *   events: ['user.login', 'order.created'],
+ *   env: 'janisdev'
+ * });
+ */
+
+const cancelNotificationsSubscription = async (params = {}) => {
+  try {
+    const {events = [], env = ''} = params;
+
+    if (!env) throw new Error('invalid environment');
+
+    const Request = new RequestInstance({JANIS_ENV: String(env)});
+
+    return await Request.post({
+      service: 'notification',
+      namespace: 'unsubscribe',
+      pathParams: ['push'],
+      body: {
+        events,
+      },
+    });
+  } catch (error) {
+    return Promise.reject(error);
+  }
+};
+
+export default cancelNotificationsSubscription;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@janiscommerce/app-push-notification",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "type": "commonjs",
   "description": "This package will take care of performing the main actions for registration to receive notifications in the foreground and background.",
   "main": "lib/index.js",