@janiscommerce/app-push-notification 0.1.0 → 0.2.0

package/lib/NotificationProvider/index.js

@@ -5,11 +5,13 @@ import {
   isString,
   isArray,
   isFunction,
-  setupForegroundMessageHandler,
-  setupNotificationOpenedHandler,
   isObject,
   prepareEventsToSubscribe,
 } from '../utils';
+import {
+  setupForegroundMessageHandler,
+  setupNotificationOpenedHandler,
+} from '../utils/notificationHandlers';
 import usePushNotification from '../usePushNotification';
 import {
   makeDefaultChannel,

package/lib/entities/Storage/constants/defaultStorageConfig.js

@@ -0,0 +1,8 @@
+/* istanbul ignore file */
+
+const DEFAULT_STORAGE_CONFIG = {
+  maxStorageQuantity: 50,
+  expirationTime: 7200, // 5 days in minutes
+};
+
+export default DEFAULT_STORAGE_CONFIG;

package/lib/entities/Storage/helpers/storeNotification/index.js

@@ -0,0 +1,33 @@
+import saveNotification from '../../utils/saveNotification';
+import hasNotificationStore from '../../utils/hasNotificationStore';
+
+/**
+ * Stores a notification under a type, initializing storage when needed.
+ *
+ * If the store does not exist for the given type, it saves the notification
+ * using the provided storageConfig (if any). Otherwise, it appends without
+ * passing storageConfig.
+ *
+ * @param {{ type: string, notification: object, storageConfig?: object }} params - Store parameters.
+ * @param {string} params.type - Storage key (notification type/channel).
+ * @param {object} params.notification - Notification payload to store.
+ * @param {object} [params.storageConfig] - Optional storage configuration for initialization.
+ * @returns {void}
+ */
+const storeNotification = ({
+  type = '',
+  notification = {},
+  storageConfig = {},
+}) => {
+  if (!hasNotificationStore(type)) {
+    saveNotification({
+      type,
+      notification,
+      storageConfig,
+    });
+    return;
+  }
+  saveNotification({type, notification});
+};
+
+export default storeNotification;

package/lib/entities/Storage/index.js

@@ -0,0 +1,8 @@
+export {default as Storage} from './instance';
+export {default as DEFAULT_STORAGE_CONFIG} from './constants/defaultStorageConfig';
+export {default as saveNotification} from './utils/saveNotification';
+export {default as removeOldestNotification} from './utils/removeOldestNotification';
+export {default as removeStoredNotification} from './utils/removeStoredNotification';
+export {default as getStoredNotification} from './utils/getStoredNotification';
+export {default as storeNotification} from './helpers/storeNotification';
+export {default as hasNotificationStore} from './utils/hasNotificationStore';

package/lib/entities/Storage/instance/index.js

@@ -0,0 +1,7 @@
+import MMKVStorage from '@janiscommerce/app-storage';
+
+const Storage = new MMKVStorage({
+  id: 'push-notification',
+});
+
+export default Storage;

package/lib/entities/Storage/utils/getStoredNotification/index.js

@@ -0,0 +1,25 @@
+import Storage from '../../instance';
+
+/**
+ * Retrieves a stored notification by type and messageId.
+ *
+ * @param {{ type: string, messageId: string|number }} params - Query parameters.
+ * @param {string} params.type - Storage key (notification type/channel).
+ * @param {string|number} params.messageId - Unique identifier of the notification.
+ * @returns {object} The found notification object, or an empty object when not found.
+ */
+const getStoredNotification = ({type = '', messageId}) => {
+  if (!type) return {};
+
+  const storedNotifications = Storage.get(type) || [];
+
+  if (!storedNotifications?.length) return {};
+
+  const foundNotification = storedNotifications.find(
+    (notification) => notification.messageId === messageId,
+  );
+
+  return foundNotification || {};
+};
+
+export default getStoredNotification;

package/lib/entities/Storage/utils/hasNotificationStore/index.js

@@ -0,0 +1,15 @@
+import Storage from '../../instance';
+
+/**
+ * Checks whether there is an existing store entry for the given notification type.
+ *
+ * @param {string} notificationType - Storage key (notification type/channel).
+ * @returns {boolean} True if the key exists and a value is set; otherwise false.
+ */
+const hasNotificationStore = (notificationType = '') => {
+  if (!Storage.db.contains(notificationType)) return false;
+
+  return !!Storage.get(notificationType);
+};
+
+export default hasNotificationStore;

package/lib/entities/Storage/utils/removeOldestNotification/index.js

@@ -0,0 +1,19 @@
+import Storage from '../../instance';
+
+/**
+ * Removes the oldest (first) stored notification for a given event/type.
+ *
+ * @param {string} notificationEvent - Storage key (notification type/event).
+ * @returns {void}
+ */
+const removeOldestNotification = (notificationEvent = '') => {
+  const storedNotifications = Storage.get(notificationEvent) || [];
+
+  if (!storedNotifications?.length) return;
+
+  storedNotifications.shift();
+
+  Storage.set(notificationEvent, storedNotifications);
+};
+
+export default removeOldestNotification;

package/lib/entities/Storage/utils/removeStoredNotification/index.js

@@ -0,0 +1,29 @@
+import Storage from '../../instance';
+
+/**
+ * Removes a stored notification matching the given type and messageId.
+ *
+ * @param {{ type: string, messageId: string|number }} params - Removal parameters.
+ * @param {string} params.type - Storage key (notification type/channel).
+ * @param {string|number} params.messageId - Identifier of the notification to remove.
+ * @returns {void}
+ */
+const removeStoredNotification = ({type = '', messageId = ''}) => {
+  if (!type || !messageId) return;
+
+  const storedNotifications = Storage.get(type) || [];
+
+  if (!storedNotifications?.length) return;
+
+  const notificationIndex = storedNotifications?.findIndex(
+    (notification) => notification.messageId === messageId,
+  );
+
+  if (notificationIndex < 0) return;
+
+  storedNotifications.splice(notificationIndex, 1);
+
+  Storage.set(type, storedNotifications);
+};
+
+export default removeStoredNotification;

package/lib/entities/Storage/utils/saveNotification/index.js

@@ -0,0 +1,26 @@
+import Storage from '../../instance';
+import {isObject} from '../../../../utils';
+
+/**
+ * Appends a notification to the stored list for a given type.
+ *
+ * When a storageConfig is provided, it will be forwarded to the underlying
+ * storage set operation.
+ *
+ * @param {{ type: string, notification: object, storageConfig?: object }} params - Save parameters.
+ * @param {string} params.type - Storage key (notification type/channel).
+ * @param {object} params.notification - Notification payload to store.
+ * @param {object} [params.storageConfig] - Optional storage configuration.
+ * @returns {void}
+ */
+const saveNotification = ({type = '', notification = {}, storageConfig}) => {
+  if (!type || !isObject(notification) || !Object?.keys(notification).length)
+    return;
+
+  const storedNotifications = Storage.get(type) || [];
+  const notifications = [...storedNotifications, notification];
+
+  Storage.set(type, notifications, storageConfig);
+};
+
+export default saveNotification;

package/lib/index.js

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

package/lib/utils/index.js

@@ -1,7 +1,3 @@
-import messaging from '@react-native-firebase/messaging';
-
-// Helpers
-
 /**
  * @function isFunction
  * @param {function} fn
@@ -106,47 +102,3 @@ export const prepareEventsToSubscribe = (events = []) => {
 
   return events.filter((event) => !!event && isString(event));
 };
-// MESSAGING UTILS
-
-// esto actualmente no funciona con la versión RN de picking. Pero será necesario eventualemnte.
-// A partir de la versión 13 (api >= 33 ) de android el usuario tiene que otorgar los permisos manualmente.
-// por lo que deberemos agregarlo dentro del package futuro y sumarlo a picking una vez que esté actualizado.
-
-// export const requestUserPermission = async () => {
-//   const permission = await PermissionsAndroid.request(PermissionsAndroid.PERMISSIONS.POST_NOTIFICATIONS);
-
-//   return permission;
-// };
-
-/** *
- * @function setupForegroundMessageHandler
- * @description This function is responsible for handling any callbacks from Firebase cloud messaging in the foreground and rendering them using a callback
- * @param {Function} callback is the function that will receive the payload and render it as appropriate
- */
-
-export const setupForegroundMessageHandler = (callback) =>
-  messaging().onMessage(async (remoteMessage) => {
-    callback(remoteMessage);
-  });
-
-/** *
- * @function setupBackgroundMessageHandler
- * @description This function is responsible for handling any callbacks from Firebase cloud messaging in the background or with the application closed
- * @param {Function} callback is the function that will receive the payload and render it as appropriate
- */
-
-export const setupBackgroundMessageHandler = (callback = () => {}) =>
-  messaging().setBackgroundMessageHandler(async (remoteMessage) => {
-    callback(remoteMessage);
-  });
-
-/** *
- * @function setupNotificationOpenedHandler
- * @description This function is responsible for handling any Firebase Cloud Messaging callbacks that the app will have from the background
- * @param {Function} callback is the function that will receive the payload and render it as appropriate
- */
-
-export const setupNotificationOpenedHandler = (callback) =>
-  messaging().onNotificationOpenedApp(async (remoteMessage) => {
-    callback(remoteMessage);
-  });

package/lib/utils/notificationHandlers/index.js

@@ -0,0 +1,3 @@
+export {default as setupForegroundMessageHandler} from './setupForegroundMessageHandler';
+export {default as setupBackgroundMessageHandler} from './setupBackgroundMessageHandler';
+export {default as setupNotificationOpenedHandler} from './setupNotificationOpenedHandler';

package/lib/utils/notificationHandlers/setupBackgroundMessageHandler/index.js

@@ -0,0 +1,42 @@
+import messaging from '@react-native-firebase/messaging';
+import {
+  DEFAULT_STORAGE_CONFIG,
+  storeNotification,
+  removeOldestNotification,
+  Storage,
+} from '../../../entities/Storage/index';
+
+/**
+ * @function setupBackgroundMessageHandler
+ * @description This function is responsible for handling any callbacks from Firebase cloud messaging in the background or with the application closed
+ * @param {object.<{notificationEvent: {maxStorageQuantity: number, expirationTime: number}}>}  storageConfigs configuration for handling the storage of notifications in mmkv: this applicates
+
+ * @param {Function} callback is the function that will receive the payload and render it as appropriate
+ */
+
+const setupBackgroundMessageHandler = (
+  storageConfigs = {},
+  callback = () => {},
+) =>
+  messaging().setBackgroundMessageHandler(async (remoteMessage) => {
+    const {event: type} = remoteMessage?.data || {};
+    const {maxStorageQuantity, expirationTime} = {
+      ...DEFAULT_STORAGE_CONFIG,
+      ...storageConfigs[type],
+    };
+    const storedQuantity = Storage.get(type)?.length || 0;
+
+    if (storedQuantity >= maxStorageQuantity) {
+      removeOldestNotification(type);
+    }
+
+    storeNotification({
+      type,
+      notification: remoteMessage,
+      storageConfig: {expiresAt: expirationTime},
+    });
+
+    await Promise.resolve(callback(remoteMessage));
+  });
+
+export default setupBackgroundMessageHandler;

package/lib/utils/notificationHandlers/setupForegroundMessageHandler/index.js

@@ -0,0 +1,14 @@
+import messaging from '@react-native-firebase/messaging';
+
+/**
+ * @function setupForegroundMessageHandler
+ * @description This function is responsible for handling any callbacks from Firebase cloud messaging in the foreground and rendering them using a callback
+ * @param {Function} callback is the function that will receive the payload and render it as appropriate
+ */
+
+const setupForegroundMessageHandler = (callback) =>
+  messaging().onMessage(async (remoteMessage) => {
+    callback(remoteMessage);
+  });
+
+export default setupForegroundMessageHandler;

package/lib/utils/notificationHandlers/setupNotificationOpenedHandler/index.js

@@ -0,0 +1,19 @@
+import messaging from '@react-native-firebase/messaging';
+import {removeStoredNotification} from '../../../entities/Storage';
+
+/**
+ * @function setupNotificationOpenedHandler
+ * @description This function is responsible for handling any Firebase Cloud Messaging callbacks that the app will have from the background
+ * @param {Function} callback is the function that will receive the payload and render it as appropriate
+ */
+
+const setupNotificationOpenedHandler = (callback) =>
+  messaging().onNotificationOpenedApp(async (remoteMessage) => {
+    const {data, messageId} = remoteMessage || {};
+    const {event: type = ''} = data || {};
+
+    removeStoredNotification({type, messageId});
+    await Promise.resolve(callback(remoteMessage));
+  });
+
+export default setupNotificationOpenedHandler;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@janiscommerce/app-push-notification",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "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",
@@ -27,14 +27,15 @@
   "author": "Janis",
   "license": "ISC",
   "dependencies": {
+    "@notifee/react-native": "^7.8.2"
+  },
+  "peerDependencies": {
+    "@janiscommerce/app-storage": ">=1.0.0",
     "@janiscommerce/app-request": "^2.2.0",
-    "@notifee/react-native": "^7.8.2",
     "@react-native-async-storage/async-storage": "^1.18.1",
     "@react-native-firebase/app": "^18.9.0",
     "@react-native-firebase/messaging": "^18.9.0",
-    "axios": "^1.3.6"
-  },
-  "peerDependencies": {
+    "axios": "^1.3.6",
     "react": ">=17.0.2 <19.0.0",
     "react-native": ">=0.67.5 <0.75.0"
   },
@@ -46,6 +47,8 @@
     "@babel/preset-env": "^7.22.10",
     "@babel/runtime": "^7.12.5",
     "@janiscommerce/app-request": "^2.2.0",
+    "@janiscommerce/app-storage": "^1.0.0",
+    "@react-native-async-storage/async-storage": "^1.18.1",
     "@react-native-community/eslint-config": "^2.0.0",
     "@react-native-firebase/app": "^18.9.0",
     "@react-native-firebase/messaging": "^18.9.0",
@@ -69,9 +72,11 @@
     "metro-react-native-babel-preset": "^0.66.2",
     "nock": "^13.0.11",
     "prettier": "^2.4.1",
-    "react": "^17.0.2",
-    "react-native": "^0.67.5",
-    "react-test-renderer": "^17.0.2"
+    "react": "18.2.0",
+    "react-native": "0.71.6",
+    "react-native-device-info": "^10.12.0",
+    "react-native-mmkv": "^2.12.2",
+    "react-test-renderer": "18.2.0"
   },
   "bugs": {
     "url": "https://github.com/janis-commerce/app-push-notification/issues"

package/CHANGELOG.md

@@ -1,47 +0,0 @@
-# Changelog
-
-## [Unreleased]
-
-## [0.1.0] - 2025-11-11
-
-### Added
-
-- Support up to react 19
-
-## [0.0.7] - 2025-07-23
-
-### Fixed
-
-- The subscription request is only made when the user is not subscribed.
-
-## [0.0.6] - 2025-07-13
-
-### Added
-
-- cancelNotificationSuscription method
-
-## [0.0.5] - 2025-06-17
-
-### Added
-
-- Sound to notifications
-
-## [0.0.4] - 2024-06-25
-
-### Added
-
-- Added notification channels
-
-## [0.0.3] - 2024-06-13
-
-### Added
-
-- additional info to send in subscription
-
-## [0.0.2] - 2024-05-03
-
-### Added
-
-- NotificationProvider (HOC) to receive notifications at background and foreground
-- Github actions to deploy to npm
-- Callback to handle notification