@janiscommerce/app-push-notification 0.0.2 → 0.0.4

package/CHANGELOG.md

@@ -1,8 +1,20 @@
 # Changelog
 
-[Unreleased]
+## [Unreleased]
 
-## [0.0.1] - 2024-05-03
+## [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
 

package/README.md

@@ -34,7 +34,7 @@ For more information about this, read https://rnfirebase.io/reference/messaging/
 ## Functions
 
 <dl>
-<dt><a href="#NotificationProvider">NotificationProvider(children, appName, events, environment)</a> ⇒ <code>null</code> | <code>React.element</code></dt>
+<dt><a href="#NotificationProvider">NotificationProvider(children, appName, events, environment, additionalInfo, channelConfigs)</a> ⇒ <code>null</code> | <code>React.element</code></dt>
 <dd><p>It is the main component of the package, it is a HOC that is responsible for handling the logic of subscribing to notifications and receiving messages from the Firebase console. The HOC contains listeners to listen to notifications in the foreground and background, so (unless we cancel the subscription), we will receive notifications from the app even when it is closed.</p>
 </dd>
 <dt><a href="#setupBackgroundMessageHandler">setupBackgroundMessageHandler(callback)</a></dt>
@@ -70,6 +70,10 @@ For more information about this, read https://rnfirebase.io/reference/messaging/
 <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>
 </tr>
 <tr>
+<td>updateSuscription</td>
+<td>This function is responsible for updating the subscription to the notification service</td>
+</tr>
+<tr>
 <td>addNewEvent</td>
 <td>This function allows you to add a new event to receive notifications.</td>
 </tr>
@@ -87,7 +91,7 @@ For more information about this, read https://rnfirebase.io/reference/messaging/
 
 <a name="NotificationProvider"></a>
 
-## NotificationProvider(children, appName, events, environment) ⇒ <code>null</code> \| <code>React.element</code>
+## NotificationProvider(children, appName, events, environment, additionalInfo, channelConfigs) ⇒ <code>null</code> \| <code>React.element</code>
 It is the main component of the package, it is a HOC that is responsible for handling the logic of subscribing to notifications and receiving messages from the Firebase console. The HOC contains listeners to listen to notifications in the foreground and background, so (unless we cancel the subscription), we will receive notifications from the app even when it is closed.
 
 **Kind**: global function  
@@ -102,6 +106,8 @@ It is the main component of the package, it is a HOC that is responsible for han
 | appName | <code>string</code> | name of the aplication |
 | events | <code>Array.&lt;string&gt;</code> | is an array that will contain the events to which the user wants to subscribe |
 | environment | <code>string</code> | The environment is necessary for the API that we are going to use to subscribe the device to notifications. |
+| additionalInfo | <code>object</code> | fields to be sent as part of the body of the subscription request |
+| channelConfigs | <code>Array.&lt;(string\|object)&gt;</code> | is the configuration that will be used to create new notification channels |
 
 **Example**  
 ```js
@@ -139,6 +145,7 @@ is a hook, which returns the elements contained within the notifications context
  | backgroundNotification | An object containing all data received when a background push notification is triggered. |
  | subscribeError | An object containing all data received from a notification service subscription failure. |
  | cancelNotifications | 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. |
+ | updateSuscription | This function is responsible for updating the subscription to the notification service |
  | addNewEvent | This function allows you to add a new event to receive notifications. |
  | deleteReceivedNotification | An util that clears the foreground or background notification state to the depending on the type it receives by parameter
  | getSubscribedEvents | This function returns an array with the events to which the user is subscribed. |

package/lib/NotificationContext.js

@@ -18,6 +18,7 @@ export const NotificationContext = React.createContext(null);
  *  | backgroundNotification | An object containing all data received when a background push notification is triggered. |
  *  | subscribeError | An object containing all data received from a notification service subscription failure. |
  *  | cancelNotifications | 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. |
+ *  | updateSuscription | This function is responsible for updating the subscription to the notification service |
  *  | addNewEvent | This function allows you to add a new event to receive notifications. |
  *  | deleteReceivedNotification | An util that clears the foreground or background notification state to the depending on the type it receives by parameter
  *  | getSubscribedEvents | This function returns an array with the events to which the user is subscribed. |

package/lib/NotificationProvider/index.js

@@ -9,6 +9,11 @@ import {
   isObject,
 } from '../utils';
 import usePushNotification from '../usePushNotification';
+import {
+  makeDefaultChannel,
+  makeNotificationChannels,
+  parseNotificationChannel,
+} from '../utils/channel';
 
 /**
  * @function NotificationProvider
@@ -17,6 +22,8 @@ import usePushNotification from '../usePushNotification';
  * @param {string} appName name of the aplication
  * @param {Array<string>} events is an array that will contain the events to which the user wants to subscribe
  * @param {string} environment The environment is necessary for the API that we are going to use to subscribe the device to notifications.
+ * @param {object} additionalInfo fields to be sent as part of the body of the subscription request
+ * @param {Array<string | object>} channelConfigs is the configuration that will be used to create new notification channels
  * @throws null when not receive a children argument
  * @returns {null | React.element}
  * @example
@@ -34,13 +41,22 @@ import usePushNotification from '../usePushNotification';
  * )
  */
 
-const NotificationProvider = ({children, appName, events, environment}) => {
+const NotificationProvider = ({
+  children,
+  appName,
+  events,
+  environment,
+  additionalInfo,
+  channelConfigs = [],
+}) => {
   if (!children) return null;
 
   const validAppName = !!appName && isString(appName) ? appName : '';
   const validEnvironment =
     !!environment && isString(environment) ? environment : '';
   const validEvents = !!events && isArray(events) ? events : [];
+  const validChannelConfigs =
+    !!channelConfigs && isArray(channelConfigs) ? channelConfigs : [];
 
   const isRegistered = useRef(false);
   const {
@@ -53,6 +69,7 @@ const NotificationProvider = ({children, appName, events, environment}) => {
     validEvents,
     validAppName,
     isRegistered,
+    additionalInfo,
   );
 
   // @function handlerForegroundData
@@ -87,6 +104,18 @@ const NotificationProvider = ({children, appName, events, environment}) => {
     return updateNotificationState({backgroundNotification: data});
   };
 
+  const createNotificationChannels = async () => {
+    /* istanbul ignore else */
+    if (validChannelConfigs) {
+      const parsedChannelConfigs = validChannelConfigs
+        ?.map((config) => parseNotificationChannel(config))
+        .filter(Boolean);
+
+      await makeNotificationChannels(parsedChannelConfigs);
+    }
+    await makeDefaultChannel();
+  };
+
   useEffect(() => {
     const alreadySuscribed = isRegistered.current;
     if (environment && appName && !!pushEvents.length && !alreadySuscribed) {
@@ -94,6 +123,10 @@ const NotificationProvider = ({children, appName, events, environment}) => {
     }
   }, [pushEvents]);
 
+  useEffect(() => {
+    createNotificationChannels();
+  }, []);
+
   /* istanbul ignore next */
   useEffect(() => {
     const foregroundMessageHandler = setupForegroundMessageHandler(

package/lib/usePushNotification.js

@@ -4,7 +4,13 @@ import {getFCMToken, isArray, isString} from './utils';
 import SubscribeNotifications from './utils/api/SubscribeNotifications';
 import UnSubscribeNotifications from './utils/api/UnSubscribeNotifications';
 
-const usePushNotification = (environment, events, appName, isRegistered) => {
+const usePushNotification = (
+  environment,
+  events,
+  appName,
+  isRegistered,
+  additionalInfo,
+) => {
   const [notificationState, setNotificationState] = useState({
     deviceToken: null,
     foregroundNotification: {},
@@ -54,6 +60,7 @@ const usePushNotification = (environment, events, appName, isRegistered) => {
         events: pushEvents,
         deviceToken: token,
         request: Request,
+        additionalInfo,
       });
 
       isRegistered.current = true;
@@ -63,6 +70,31 @@ const usePushNotification = (environment, events, appName, isRegistered) => {
     }
   }, [pushEvents]);
 
+  /**
+   * @function updateSuscription
+   * @description This function is responsible for updating the subscription to the notification service
+   * @param {object} props all properties that will be sent as additional data in the subscription
+   * @returns {Promise}
+   */
+
+  const updateSuscription = async (props = {}) => {
+    try {
+      const token = await getDeviceToken();
+
+      const response = await SubscribeNotifications({
+        appName,
+        events: pushEvents,
+        deviceToken: token,
+        request: Request,
+        additionalInfo: props,
+      });
+
+      return response;
+    } catch (error) {
+      return Promise.reject(error);
+    }
+  };
+
   /**
    * @function cancelNotifications
    * @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.
@@ -161,6 +193,7 @@ const usePushNotification = (environment, events, appName, isRegistered) => {
     updateNotificationState,
     getSubscribedEvents,
     deleteReceivedNotification,
+    updateSuscription,
   };
 };
 

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

@@ -1,11 +1,11 @@
-import {isString, isArray} from '../../index';
+import {isString, isArray, isObject} from '../../index';
 
 const SubscribeNotifications = async (params = {}) => {
   try {
     if (!params || !Object.keys(params).length)
       throw new Error('params is not a valid object');
 
-    const {deviceToken, events, appName, request} = params;
+    const {deviceToken, events, appName, request, additionalInfo} = params;
 
     if (!deviceToken || !isString(deviceToken))
       throw new Error('device token is invalid or null');
@@ -19,10 +19,16 @@ const SubscribeNotifications = async (params = {}) => {
     if (!parsedEvents.length)
       throw new Error('events to be suscribed are invalids');
 
+    const validAdditionalInfo =
+      isObject(additionalInfo) && !!Object.keys(additionalInfo).length;
+
     const body = {
       token: deviceToken,
       events: parsedEvents,
       platformApplicationName: appName,
+      ...(validAdditionalInfo && {
+        additionalInfo,
+      }),
     };
 
     const response = await request.post({

package/lib/utils/channel/index.js

@@ -0,0 +1,71 @@
+import notifee, {AndroidImportance} from '@notifee/react-native';
+import {isObject, isString} from '..';
+
+export const parseChannelConfiguration = (params = {}) => {
+  if (!params || !isObject(params)) return null;
+
+  const {name, id = '', description = ''} = params;
+
+  if (!name || !isString(name)) return null;
+
+  const isValidDescription = !!description && isString(description);
+  const hasValidId = !!id && isString(id);
+
+  return {
+    name,
+    id: hasValidId ? id : name,
+    importance: AndroidImportance.HIGH,
+    ...(isValidDescription && {
+      description,
+    }),
+  };
+};
+
+export const parseNotificationChannel = (channel) => {
+  const channelType = typeof channel;
+  const allowedConfigs = ['string', 'object'];
+
+  if (!allowedConfigs.includes(channelType)) return null;
+  const channelData = channelType === 'string' ? {name: channel} : channel;
+
+  const parsedChannel = parseChannelConfiguration(channelData);
+
+  return parsedChannel;
+};
+
+/* eslint-disable consistent-return */
+export const makeNotificationChannel = async (channelConfig = {}) => {
+  const {id, name} = channelConfig;
+
+  if (!id || !name || !isString(id) || !isString(name)) return null;
+
+  try {
+    await notifee.createChannel(channelConfig);
+  } catch (error) {
+    return Promise.reject(error);
+  }
+};
+
+/* eslint-disable consistent-return */
+export const makeNotificationChannels = async (channelConfigs) => {
+  try {
+    await notifee.createChannels(channelConfigs);
+  } catch (error) {
+    return Promise.reject(error);
+  }
+};
+
+/* eslint-disable consistent-return */
+export const makeDefaultChannel = async () => {
+  try {
+    const parsedChannel = parseChannelConfiguration({
+      id: 'default_channel',
+      name: 'Common notifications',
+      description: 'Default channel to receive notifications',
+    });
+
+    await makeNotificationChannel(parsedChannel);
+  } catch (error) {
+    return Promise.reject(error);
+  }
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@janiscommerce/app-push-notification",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "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",
@@ -28,6 +28,7 @@
   "license": "ISC",
   "dependencies": {
     "@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.3.1",
     "@react-native-firebase/messaging": "^18.3.1",