feat: Update notificationsBulkUpdates api to support category and isRead flag based bulk update

Author: abhay-keyvalue

README.md

@@ -275,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
@@ -292,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);
       }

src/Siren.ts

@@ -32,6 +32,8 @@ import type {
   ActionResponse,
   MarkAsViewedResponse,
   UnviewedCountReturnResponse,
+  BulkUpdateParamsType,
+  BulkUpdateApiParams,
 } from "./types";
 
 export class Siren {
@@ -113,9 +115,9 @@ export class Siren {
         res && res.data?.status === VerificationStatus.SUCCESS
           ? VerificationStatus.SUCCESS
           : VerificationStatus.FAILED; // api returns null in failed scenarios
-    if(this.actionCallbacks?.onStatusChange) 
+    if(this.actionCallbacks?.onStatusChange)
       this.actionCallbacks.onStatusChange(this.tokenValidationStatus);
-    
+
     return res;
   }
 
@@ -196,7 +198,7 @@ export class Siren {
 
   /**
    * Stops the real-time data fetching , if active.
-   * 
+   *
    * @param {EventType} eventType - For identifying the event type. This can be either `NOTIFICATIONS` or `UNVIEWED_COUNT`.
    */
   stopRealTimeFetch(eventType: EventType): void {
@@ -243,20 +245,29 @@ export class Siren {
    *   - An `ActionResponse` object on success, contains "SUCCESS" as data.
    */
 
-  async markAsReadByDate(
-    startDate: string
-  ): Promise<ActionResponse | null> {
+  async markAsReadByDate(params: BulkUpdateParamsType): Promise<ActionResponse | null> {
+    const { startDate, category } = params || {};
     const hasPermission = this.authorizeUserAction();
 
     if (!hasPermission) return this.getErrorForUnauthorizedAction();
     let response;
 
-    if (startDate)
-      response = await notificationsBulkUpdates(this.token, this.recipientId, {
+    if (startDate) {
+      const params: BulkUpdateApiParams = {
         until: startDate,
         operation: BulkUpdateType.MARK_AS_READ,
-      });
-    else response = this.emitMissingParameterError();
+      };
+
+      if(category) params.category = category;
+
+      response = await notificationsBulkUpdates(
+        this.token,
+        this.recipientId,
+        params
+      );
+    } else {
+      response = this.emitMissingParameterError();
+    }
 
     return response;
   }
@@ -291,21 +302,31 @@ export class Siren {
    * @returns {Promise<ActionResponse>}
    *   - An `ActionResponse` object on success, containing details about the operation.
    */
-  async deleteByDate(
-    startDate: string
-  ): Promise<ActionResponse | null> {
+  async deleteByDate(params: BulkUpdateParamsType): Promise<ActionResponse | null> {
+    const { startDate, isRead, category } = params || {};
     const hasPermission = this.authorizeUserAction();
 
     if (!hasPermission) return this.getErrorForUnauthorizedAction();
     let response;
 
-    if (startDate)
-      response = await notificationsBulkUpdates(this.token, this.recipientId, {
+    if (startDate) {
+      const params: BulkUpdateApiParams = {
         until: startDate,
         operation: BulkUpdateType.MARK_AS_DELETED,
-      });
-    else response = this.emitMissingParameterError();
+      };
 
+      if (isRead !== undefined) params.isRead = isRead;
+      if(category) params.category = category;
+      response = await notificationsBulkUpdates(
+        this.token,
+        this.recipientId,
+        params
+      );
+    } else {
+
+      response = this.emitMissingParameterError();
+    }
+    
     return response;
   }
 

src/api/notificationsBulkUpdates.ts

@@ -10,7 +10,11 @@ const operations = {
 const notificationsBulkUpdates = (
   token: string,
   inAppRecipientId: string,
-  data: { until: string; operation: BulkUpdateType}
+  data: {
+    until: string;
+    isRead?: boolean;
+    operation: BulkUpdateType;
+  }
 ): Promise<ActionResponse> => {
   const path = `api/v2/in-app/recipients/${inAppRecipientId}/notifications/bulk-update`;
 

src/types.ts

@@ -1,5 +1,10 @@
 import "promise-polyfill/src/polyfill";
-import type { VerificationStatus, EventType, ApiOperationType } from "./constants/generic";
+import type {
+  VerificationStatus,
+  EventType,
+  ApiOperationType,
+  BulkUpdateType
+} from "./constants/generic";
 
 /**
  * An interface representing the response structure of the Notifications API.
@@ -266,3 +271,24 @@ export type UnviewedCountReturnResponse = {
   data?: { unviewedCount: number } | null;
   error?: SirenErrorType | null;
 };
+
+/**
+ * Defining the structure of the input param from user calling bulk update functions.
+ */
+
+export type BulkUpdateParamsType = {
+  startDate: string;
+  isRead?: boolean;
+  category?: string;
+};
+
+/**
+ * Defining the structure of input param from user while calling bulk update api.
+ */
+
+export type BulkUpdateApiParams = {
+  until: string;
+  isRead?: boolean;
+  operation: BulkUpdateType;
+  category?: string;
+};

tests/siren.spec.ts

@@ -338,9 +338,9 @@ describe("Siren Class", () => {
         .mockImplementation(() =>
           Promise.resolve({ data: Response, error: null })
         );
-      const res = await sirenInstance.markAsReadByDate(
-        "2024-02-24T05:47:38.519+00:00"
-      );
+      const res = await sirenInstance.markAsReadByDate({
+        startDate: "2024-02-24T05:47:38.519+00:00"
+      });
 
       expect(mockApi).toHaveBeenCalledTimes(1);
       expect(mockApi).toHaveBeenCalledWith(
@@ -365,9 +365,9 @@ describe("Siren Class", () => {
             error: ApiError,
           })
         );
-      const res = await sirenInstance.markAsReadByDate(
-        "2024-02-24T05:47:38.519+00:00"
-      );
+      const res = await sirenInstance.markAsReadByDate({
+        startDate: "2024-02-24T05:47:38.519+00:00"
+      });
 
       expect(mockApi).toHaveBeenCalledWith(
         constructorProps.token,
@@ -468,9 +468,9 @@ describe("Siren Class", () => {
         .mockImplementation(() =>
           Promise.resolve({ data: Response, error: null })
         );
-      const res = await sirenInstance.deleteByDate(
-        "2024-02-24T05:47:38.519+00:00"
-      );
+      const res = await sirenInstance.deleteByDate({
+        startDate: "2024-02-24T05:47:38.519+00:00"
+      });
 
       expect(mockApi).toHaveBeenCalledTimes(1);
       expect(mockApi).toHaveBeenCalledWith(
@@ -495,9 +495,9 @@ describe("Siren Class", () => {
             error: ApiError,
           })
         );
-      const res = await sirenInstance.deleteByDate(
-        "2024-02-24T05:47:38.519+00:00"
-      );
+      const res = await sirenInstance.deleteByDate({
+        startDate: "2024-02-24T05:47:38.519+00:00"
+      });
 
       expect(mockApi).toHaveBeenCalledWith(
         constructorProps.token,