@janiscommerce/app-push-notification 0.0.4 → 0.0.5

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## [Unreleased]
 
+## [0.0.5] - 2025-06-17
+
+### Added
+
+- Sound to notifications
+
 ## [0.0.4] - 2024-06-25
 
 ### Added

package/README.md

@@ -29,6 +29,31 @@ Inside remoteMessage you get the notifications object that contains the informat
 
 For more information about this, read https://rnfirebase.io/reference/messaging/remotemessage
 
+## Customize background notification sound:
+
+To customize the background notification sound, you can pass the `backgroundNotificationSound` parameter to the `NotificationProvider` component. By default, it uses the 'default' sound.
+
+```javascript
+import NotificationProvider from '@janiscommerce/app-push-notification'
+
+return (
+ <NotificationProvider
+   appName='pickingApp'
+   events={["picking:session:created","picking:session:assigned"]}
+   environment='beta'
+   backgroundNotificationSound='custom_sound' // Custom sound file name
+   >
+   <MyComponent/>
+ </NotificationProvider>
+)
+```
+
+To use a custom sound on Android, you must:
+1. Place the sound file in the `android/app/src/main/res/raw/` folder
+2. The file name must be lowercase and without special characters
+3. The sound file must be in .mp3, .wav, or .aac format
+4. Pass the exactly file name (without extension) as the value of `backgroundNotificationSound`
+
 # This library provides the following components and methods:
 
 ## Functions

package/lib/NotificationProvider/index.js

@@ -24,6 +24,7 @@ import {
  * @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
+ * @param {string} backgroundNotificationSound is the sound that will be played when the app is in the background
  * @throws null when not receive a children argument
  * @returns {null | React.element}
  * @example
@@ -48,6 +49,7 @@ const NotificationProvider = ({
   environment,
   additionalInfo,
   channelConfigs = [],
+  backgroundNotificationSound,
 }) => {
   if (!children) return null;
 
@@ -58,6 +60,11 @@ const NotificationProvider = ({
   const validChannelConfigs =
     !!channelConfigs && isArray(channelConfigs) ? channelConfigs : [];
 
+  const safeBackgroundSound =
+    isString(backgroundNotificationSound) && backgroundNotificationSound?.trim()
+      ? backgroundNotificationSound.trim()
+      : 'default';
+
   const isRegistered = useRef(false);
   const {
     registerDeviceToNotifications,
@@ -113,7 +120,7 @@ const NotificationProvider = ({
 
       await makeNotificationChannels(parsedChannelConfigs);
     }
-    await makeDefaultChannel();
+    await makeDefaultChannel({sound: safeBackgroundSound});
   };
 
   useEffect(() => {

package/lib/constants/defaultChannelConfigs.js

@@ -0,0 +1,13 @@
+import {AndroidImportance, AndroidVisibility} from '@notifee/react-native';
+
+const DEFAULT_CHANNEL_CONFIGS = {
+  badge: true,
+  importance: AndroidImportance.HIGH,
+  lights: true,
+  sound: 'default',
+  vibration: true,
+  vibrationPattern: [500, 1000, 500, 1000],
+  visibility: AndroidVisibility.PUBLIC,
+};
+
+export default DEFAULT_CHANNEL_CONFIGS;

package/lib/utils/channel/index.js

@@ -1,10 +1,11 @@
 import notifee, {AndroidImportance} from '@notifee/react-native';
+import DEFAULT_CHANNEL_CONFIGS from '../../constants/defaultChannelConfigs';
 import {isObject, isString} from '..';
 
 export const parseChannelConfiguration = (params = {}) => {
   if (!params || !isObject(params)) return null;
 
-  const {name, id = '', description = ''} = params;
+  const {name, id = '', description = '', ...restConfigs} = params;
 
   if (!name || !isString(name)) return null;
 
@@ -12,6 +13,8 @@ export const parseChannelConfiguration = (params = {}) => {
   const hasValidId = !!id && isString(id);
 
   return {
+    ...DEFAULT_CHANNEL_CONFIGS,
+    ...restConfigs,
     name,
     id: hasValidId ? id : name,
     importance: AndroidImportance.HIGH,
@@ -56,12 +59,13 @@ export const makeNotificationChannels = async (channelConfigs) => {
 };
 
 /* eslint-disable consistent-return */
-export const makeDefaultChannel = async () => {
+export const makeDefaultChannel = async (configs = {}) => {
   try {
     const parsedChannel = parseChannelConfiguration({
-      id: 'default_channel',
-      name: 'Common notifications',
-      description: 'Default channel to receive notifications',
+      id: 'channel_default',
+      name: 'Operational notifications',
+      description: 'Default channel to receive operational notifications',
+      ...configs,
     });
 
     await makeNotificationChannel(parsedChannel);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@janiscommerce/app-push-notification",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "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",