Version 1.1.0

Merge pull request #32 from KeyValueSoftwareSystems/dev

Author: nikhin-keyvalue

CHANGELOG.md

@@ -2,8 +2,16 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.1.0] - 2024-05-07
+
+### Changed
+
+- actionCallbacks object structure to handle generic use cases
+- Improved API error handling
+- Improved exposed function names
+
 ## [1.0.0] - 2024-03-26
 
 ### Added
-- JavaScript middleware designed to streamline interaction for managing and displaying in-app notifications
 
+- JavaScript middleware designed to streamline interaction for managing and displaying in-app notifications

README.md

@@ -4,16 +4,20 @@ The Siren JS SDK for In-App Notifications enhances Siren's capabilities by provi
 
 ## Installation
 
-You can install the js sdk from npm 
+You can install the js sdk from npm
 
 ```bash
 npm install @sirenapp/js-sdk
 ```
+
 or from yarn
+
 ```bash
 yarn add @sirenapp/js-sdk
 ```
+
 or from cdn
+
 ```bash
 <script src="https://siren-js.sirenapp.io/siren-js-umd-sdk.js"></script>
 ```
@@ -32,19 +36,18 @@ const sirenInstance = new Siren({
             # error callback function
         });
         actionCallbacks:{
-            onNotificationReceived?: (response: NotificationsApiResponse) => {
-                 # callback function on getting notifications
-            };
-            onUnViewedCountReceived?: (response: UnviewedCountApiResponse) => {
-                 # callback function on getting unviewed count
+            onEventReceive?: (response: NotificationsApiResponse, eventType: 'NOTIFICATIONS'| 'UNVIEWED_COUNT') => {
+                 # callback function to receive data
             };
             onStatusChange?: (status: 'SUCCESS' | 'FAILED' | 'PENDING') =>{
                   # callback function triggered when token verification status changes
             }
         }
 ```
+
 All the exposed methods can be accessed using sirenInstance object.
 For example,to fetch all notifications,
+
 ```bash
 const response = await sirenInstance.fetchAllNotifications({ page: 0, size: 10 })
 ```
@@ -88,24 +91,28 @@ Siren constructor accepts the following arguments
     </tbody>
 </table>
 
-
 ## Siren Methods
 
 ### 1. verifyToken
+
 This method verifies the validity of the given tokens (recipientId and userToken).This method is called automatically while creating the instance . Once the verification is successful, the remaining exposed methods can be accessed.
+
 ```bash
 await sirenInstance.verifyToken();
 ```
 
 ### 2. fetchUnviewedNotificationsCount
+
 This method retrieves the count of unviewed notifications.
+
 ```bash
 const { unviewedCount } = await sirenInstance.fetchUnviewedNotificationsCount()
 ```
 
-
 ### 3. fetchAllNotifications
+
 This method retrieves list of notifications in a paginated manner.
+
 ```bash
 const notifications = await sirenInstance.fetchAllNotifications({ page: 0, size: 15, start: '', end: '', isRead: false });
 ```
@@ -116,7 +123,7 @@ const notifications = await sirenInstance.fetchAllNotifications({ page: 0, size:
             <th>Argument</th>
             <th>Description</th>
             <th>Type</th>
-            <th>Optional</th>
+            <th>Mandatory</th>
             <th>Default</th>
         </tr>
     </thead>
@@ -162,6 +169,7 @@ const notifications = await sirenInstance.fetchAllNotifications({ page: 0, size:
 </table>
 
 #### Response
+
 ```bash
  interface Notifications = {
     id: string;
@@ -182,20 +190,25 @@ const notifications = await sirenInstance.fetchAllNotifications({ page: 0, size:
     isRead: boolean;
 }[]
 ```
-### 4. startRealTimeNotificationFetch
-This method initiates the real-time fetching of notifications
+
+### 4. startRealTimeFetch
+
+By specifying the parameter eventType as either `NOTIFICATIONS` or `UNVIEWED_COUNT`, this method triggers the real-time retrieval of notifications or the count of unviewed notifications. If `NOTIFICATIONS` is selected, further parameters (`params`) can be provided for additional customization or filtering
+
 ```bash
-await sirenInstance.startRealTimeNotificationFetch({ page: 0, size: 15, start: '', end: '', isRead: false });
+sirenInstance.startRealTimeFetch({ eventType: NOTIFICATIONS, params:{ page: 0, size: 15, start: '', end: '', isRead: false }});
+
+sirenInstance.startRealTimeFetch({ eventType: UNVIEWED_COUNT });
 ```
-The notifications received can be subscribed using the `onNotificationReceived` actionCallback.
 
+Below are the accepted filters for notifications
 <table>
     <thead>
         <tr>
             <th>Argument</th>
             <th>Description</th>
             <th>Type</th>
-            <th>Optional</th>
+            <th>Mandatory</th>
             <th>Default</th>
         </tr>
     </thead>
@@ -238,55 +251,56 @@ The notifications received can be subscribed using the `onNotificationReceived`
     </tbody>
 </table>
 
-### 5. startRealTimeUnviewedCountFetch
-This method initiates the real-time fetching of unviewed notification count.The count can be subscribed using the onUnViewedCountReceived actionCallback. It returns the count after the last markNotificationsAsViewed function call.
-```bash
- await sirenInstance.startRealTimeUnviewedCountFetch();
-```
+### 5. stopRealTimeFetch
 
-### 6. stopRealTimeNotificationFetch
-This method stops the fetching of realtime notifications
-```bash
-await sirenInstance.stopRealTimeNotificationFetch();
-```
+By specifying the parameter eventType as either `NOTIFICATIONS` or `UNVIEWED_COUNT`, this method stops the real-time retrieval of notifications or the count of unviewed notifications.
 
-### 7. stopRealTimeUnviewedCountFetch
-This method stops the fetching of realtime unviewed count
 ```bash
-await sirenInstance.stopRealTimeUnviewedCountFetch();
+sirenInstance.stopRealTimeFetch(NOTIFICATIONS);
+
+
+sirenInstance.stopRealTimeFetch(UNVIEWED_COUNT);
 ```
 
-### 8. markAsReadById
+### 6. markAsReadById
+
 This method marks the notification as read. It accepts a notification id as an argument.
+
 ```bash
 await sirenInstance.markAsReadById("your-notification-id");
 ```
 
-### 9. markNotificationsAsReadByDate
+### 7. markAsReadByDate
+
 This method marks the notifications as read till the given date.<br />
 It accepts an ISO date string as an argument.
+
 ```bash
-await sirenInstance.markNotificationsAsReadByDate("2011-10-05T14:48:00.000Z");
+await sirenInstance.markAsReadByDate("2011-10-05T14:48:00.000Z");
 ```
 
-### 10. deleteNotificationById
+### 8. deleteById
+
 This method deletes a notification. It accepts a notification id as an argument.
+
 ```bash
-await sirenInstance.deleteNotificationById("your-notification-id");
+await sirenInstance.deleteById("your-notification-id");
 ```
 
-### 11. deleteNotificationsByDate
+### 9. deleteByDate
+
 This method deletes the notifications till the given date.<br />
 It accepts an ISO date string as an argument
 
 ```bash
-await sirenInstance.deleteNotificationsByDate("2011-10-05T14:48:00.000Z");
+await sirenInstance.deleteByDate("2011-10-05T14:48:00.000Z");
 ```
 
-### 12. markNotificationsAsViewed
+### 10. markAllAsViewed
+
 This method marks the notifications as viewed till the given date. This sets the unviewed count as 0 <br />
 It accepts an ISO date string as an argument
 
 ```bash
-await sirenInstance.markNotificationsAsViewed("2011-10-05T14:48:00.000Z");
+await sirenInstance.markAllAsViewed("2011-10-05T14:48:00.000Z");
 ```

examples/index.html

@@ -57,23 +57,16 @@ <h1>Logs</h1>
         onError: (error) => {
           console.log('Error callback:', error);
         },
-        actionCallbacks:{
-          onNotificationReceived: (response) => {
-            if(response.data.length > 0)
+        actionCallbacks: {
+          onEventReceive: (response, eventType) => {
+            console.log(eventType)
+            if(eventType === 'NOTIFICATIONS' && response.data.length > 0)
               document.getElementById("output").innerHTML = 'New Notifications ' + JSON.stringify(response, null, 2);
-          },
-          onUnViewedCountReceived:(response) => {
-            if(response.data)
+            else if(eventType === 'UNVIEWED_COUNT' && response.data)
               document.getElementById("output").innerHTML = 'Latest unviewed count ' + JSON.stringify(response, null, 2);
-          },
-        },
-        dataFetchIntervalsInMilliSeconds:{
-          notificationFetch: 2000,
-          unViewedCountFetch: 2000
         }
-        
       }
-      );
+    });
     }
 
     async function getUnviewedCount() {
@@ -95,67 +88,67 @@ <h1>Logs</h1>
     function startNotificationsRealTimeFetch() {
       document.getElementById("output").innerHTML = '';
       if (sirenWeb) {
-        sirenWeb.startRealTimeNotificationFetch({ page: 0, size: 10 });
+        sirenWeb.startRealTimeFetch({eventType: 'NOTIFICATIONS', params: { page: 0, size: 10 }});
       }
     }
 
     function stopNotificationsRealTimeFetch() {
       if (sirenWeb) {
-        sirenWeb.stopRealTimeNotificationFetch();
+        sirenWeb.stopRealTimeFetch('NOTIFICATIONS');
         document.getElementById("output").innerHTML = 'Fetch disabled';
       }
     }
 
     function startUnviewedCountRealTimeFetch() {
       document.getElementById("output").innerHTML = '';
       if (sirenWeb) {
-        sirenWeb.startRealTimeUnviewedCountFetch({ page: 0, size: 10 });
+        sirenWeb.startRealTimeFetch({eventType: 'UNVIEWED_COUNT'})
       }
     }
 
     function stopUnviewedCountRealTimeFetch() {
       if (sirenWeb) {
-        sirenWeb.stopRealTimeUnviewedCountFetch();
+        sirenWeb.stopRealTimeFetch('UNVIEWED_COUNT');
         document.getElementById("output").innerHTML = 'Fetch disabled';
       }
     }
 
 
     async function markAsReadById() {
       if (sirenWeb) {
-        const res = await sirenWeb.markNotificationAsReadById(notificationId);
+        const res = await sirenWeb.markAsReadById(notificationId);
         document.getElementById("output").innerHTML = 'Mark Notification as Read ' + JSON.stringify(res, null, 2);
         console.log('markNotificationAsReadById', res);
       }
     }
 
     async function markAllAsRead() {
       if (sirenWeb) {
-       const res= await sirenWeb.markNotificationsAsReadByDate(new Date().toISOString());
+       const res= await sirenWeb.markAsReadByDate(new Date().toISOString());
        document.getElementById("output").innerHTML = 'Mark All as Read ' + JSON.stringify(res, null, 2);
        console.log('markAllNotificationsAsRead', res);
       }
     }
 
     async function deleteById() {
       if (sirenWeb) {
-       const res= await sirenWeb.deleteNotificationById(notificationId);
+       const res= await sirenWeb.deleteById(notificationId);
        document.getElementById("output").innerHTML = 'Delete Notification ' + JSON.stringify(res, null, 2);
        console.log('deleteNotificationById', res);
       }
     }
 
     async function clearAll() {
       if (sirenWeb) {
-       const res = await sirenWeb.deleteNotificationsByDate(new Date().toISOString());
+       const res = await sirenWeb.deleteByDate(new Date().toISOString());
        document.getElementById("output").innerHTML = 'Delete All Notification ' + JSON.stringify(res, null, 2);
        console.log('clearAllNotifications', res);
       }
     }
 
     async function markAsViewed() {
       if (sirenWeb) {
-        const res = await sirenWeb.markNotificationsAsViewed(new Date().toISOString());
+        const res = await sirenWeb.markAllAsViewed(new Date().toISOString());
         document.getElementById("output").innerHTML = 'Mark Notifications as viewed ' + JSON.stringify(res, null, 2);
         console.log('markAllNotificationsAsRead', res);
       }