feat: Add category filter in notification fetch api

Author: bilta-keyvalue

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>

src/types.ts

@@ -128,6 +128,11 @@ export type FetchNotificationsParamsType = {
    * Option for sorting notifications
    */
   sort?: "createdAt" | "updatedAt";
+
+  /**
+   * Option for filtering based on category
+   */
+  category?: string;
 };
 
 /**