V 1.2.0

- Add category support

Author: bilta-keyvalue

.env

@@ -1 +1 @@
-API_DOMAIN = https://api.sirenapp.io/
+API_DOMAIN = https://api.trysiren.io/

.prettierrc

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://json.schemastore.org/prettierrc",
+  "semi": true,
+  "tabWidth": 2,
+  "singleQuote": true,
+  "printWidth": 100,
+  "trailingComma": "none",
+  "jsxSingleQuote": true,
+  "bracketSpacing": true,
+  "bracketSameLine": false,
+  "arrowParens": "always",
+  "useTabs": false,
+  "quoteProps": "as-needed",
+  "vueIndentScriptAndStyle": false,
+  "braceStyle": "stroustrup"
+}

README.md

@@ -114,16 +114,16 @@ const { unviewedCount } = await sirenInstance.fetchUnviewedNotificationsCount()
 This method retrieves list of notifications in a paginated manner.
 
 ```bash
-const notifications = await sirenInstance.fetchAllNotifications({ page: 0, size: 15, start: '', end: '', isRead: false });
+const notifications = await sirenInstance.fetchAllNotifications({ page: 0, size: 15, start: '', end: '', isRead: false, category: 'posts' });
 ```
 
+Below are the accepted optional filters
 <table>
     <thead>
         <tr>
             <th>Argument</th>
             <th>Description</th>
             <th>Type</th>
-            <th>Mandatory</th>
             <th>Default</th>
         </tr>
     </thead>
@@ -132,37 +132,38 @@ const notifications = await sirenInstance.fetchAllNotifications({ page: 0, size:
             <td>page</td>
             <td>Current page</td>
             <td>number</td>
-            <td>false</td>
             <td>0</td>
         </tr>
         <tr>
             <td>size</td>
             <td>Number of items fetched </td>
             <td>number</td>
-            <td>false</td>
             <td>10</td>
         </tr>
         <tr>
             <td>start</td>
             <td>Accepts an ISO date string to filter notifications created after the specified date. By default, only the first 20 notifications will be fetched <br />
             eg: 2024-02-19T06:37:33.792+00:00</td>
             <td>string</td>
-            <td>false</td>
             <td>null</td>
         </tr>
          <tr>
             <td>end</td>
             <td>Accepts an ISO date string to filter notifications created before the specified date. By default, only the first 20 notifications will be fetched <br />
             eg: 2024-02-19T06:37:33.792+00:00</td>
             <td>string</td>
-            <td>false</td>
             <td>null</td>
         </tr>
         <tr>
             <td>isRead</td>
             <td>Filter to fetch read or unread notifications. If not specified, it retrieves both read and unread notifications</td>
             <td>boolean</td>
-            <td>false</td>
+            <td>null</td>
+        </tr>
+         <tr>
+            <td>category</td>
+            <td>Filter to fetch notifications by category. If not specified, it retrieves all notifications</td>
+            <td>string</td>
             <td>null</td>
         </tr>
     </tbody>
@@ -196,19 +197,19 @@ const notifications = await sirenInstance.fetchAllNotifications({ page: 0, size:
 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
-sirenInstance.startRealTimeFetch({ eventType: NOTIFICATIONS, params:{ page: 0, size: 15, start: '', end: '', isRead: false }});
+sirenInstance.startRealTimeFetch({ eventType: NOTIFICATIONS, params:{ page: 0, size: 15, start: '', end: '', isRead: false, category: 'posts' }});
 
 sirenInstance.startRealTimeFetch({ eventType: UNVIEWED_COUNT });
 ```
 
-Below are the accepted filters for notifications
+Below are the accepted optional filters for `NOTIFICATIONS` event type
+
 <table>
     <thead>
         <tr>
             <th>Argument</th>
             <th>Description</th>
             <th>Type</th>
-            <th>Mandatory</th>
             <th>Default</th>
         </tr>
     </thead>
@@ -217,35 +218,36 @@ Below are the accepted filters for notifications
             <td>page</td>
             <td>Represents the current page</td>
             <td>number</td>
-            <td>false</td>
             <td>0</td>
         </tr>
         <tr>
             <td>size</td>
             <td>The number of items to be fetched in a single call</td>
             <td>number</td>
-            <td>false</td>
             <td>10</td>
         </tr>
         <tr>
             <td>start</td>
             <td>Accepts an ISO date string to filter notifications created after the specified date. By default, only the first 20 notifications will be fetched </td>
             <td>string</td>
-            <td>false</td>
             <td>null</td>
         </tr>
          <tr>
             <td>end</td>
             <td>Accepts an ISO date string to filter notifications created before the specified date. By default, only the first 20 notifications will be fetched</td>
             <td>string</td>
-            <td>false</td>
             <td>null</td>
         </tr>
         <tr>
             <td>isRead</td>
             <td>Filter to fetch read or unread notifications. If not specified, it retrieves both read and unread notifications</td>
             <td>number</td>
-            <td>false</td>
+            <td>null</td>
+        </tr>
+         <tr>
+            <td>category</td>
+            <td>Filter to fetch notifications by category. If not specified, it retrieves all notifications</td>
+            <td>string</td>
             <td>null</td>
         </tr>
     </tbody>
@@ -273,10 +275,10 @@ await sirenInstance.markAsReadById("your-notification-id");
 ### 7. markAsReadByDate
 
 This method marks the notifications as read till the given date.<br />
-It accepts an ISO date string as an argument.
+It accepts a param object as an argument with keys startDate (ISO date string) and category(string).
 
 ```bash
-await sirenInstance.markAsReadByDate("2011-10-05T14:48:00.000Z");
+await sirenInstance.markAsReadByDate({startDate: "2011-10-05T14:48:00.000Z"});
 ```
 
 ### 8. deleteById
@@ -290,10 +292,10 @@ await sirenInstance.deleteById("your-notification-id");
 ### 9. deleteByDate
 
 This method deletes the notifications till the given date.<br />
-It accepts an ISO date string as an argument
+It accepts a param object as an argument with keys startDate (ISO date string), isRead(boolean) and category(string).
 
 ```bash
-await sirenInstance.deleteByDate("2011-10-05T14:48:00.000Z");
+await sirenInstance.deleteByDate({startDate: "2011-10-05T14:48:00.000Z"});
 ```
 
 ### 10. markAllAsViewed

examples/index.html

@@ -124,7 +124,7 @@ <h1>Logs</h1>
 
     async function markAllAsRead() {
       if (sirenWeb) {
-       const res= await sirenWeb.markAsReadByDate(new Date().toISOString());
+       const res= await sirenWeb.markAsReadByDate({startDate: new Date().toISOString()});
        document.getElementById("output").innerHTML = 'Mark All as Read ' + JSON.stringify(res, null, 2);
        console.log('markAllNotificationsAsRead', res);
       }
@@ -140,7 +140,7 @@ <h1>Logs</h1>
 
     async function clearAll() {
       if (sirenWeb) {
-       const res = await sirenWeb.deleteByDate(new Date().toISOString());
+       const res = await sirenWeb.deleteByDate({startDate: Date().toISOString(), isRead: true});
        document.getElementById("output").innerHTML = 'Delete All Notification ' + JSON.stringify(res, null, 2);
        console.log('clearAllNotifications', res);
       }