Fix/get subscriber preference channel update (#7172)

Co-authored-by: Pawan Jain <[email protected]>

packages/node/README.md

@@ -337,12 +337,22 @@ await novu.subscribers.updateOnlineStatus('subscriberId', false);
 
 - #### Get subscriber preference for all workflows
 
+This method returns subscriber preference for all workflows with inactive channels by default. To get subscriber preference for all workflows without inactive (means only active) channels, pass `false` as second argument.
+
 ```ts
 import { Novu } from '@novu/node';
 
 const novu = new Novu('<NOVU_SECRET_KEY>');
 
-await novu.subscribers.getPreference('subscriberId');
+// return subscriber preference for all workflows without inactive channels
+await novu.subscribers.getPreference('subscriberId', {
+  includeInactiveChannels: false,
+});
+
+// return subscriber preference for all workflows with inactive channels
+await novu.subscribers.getPreference('subscriberId', {
+  includeInactiveChannels: true,
+});
 ```
 
 - #### Get subscriber global preference
@@ -756,13 +766,23 @@ await novu.messages.list(params);
 - #### Delete a message by `messageId`
 
 ```ts
-import { Novu, ChannelTypeEnum } from '@novu/node';
+import { Novu } from '@novu/node';
 
 const novu = new Novu('<NOVU_SECRET_KEY>');
 
 await novu.messages.deleteById('messageId');
 ```
 
+- #### Delete multiple messages by `transactionId`
+
+```ts
+import { Novu } from '@novu/node';
+
+const novu = new Novu('<NOVU_SECRET_KEY>');
+
+await novu.messages.deleteByTransactionId('transactionId');
+```
+
 ### Layouts
 
 - #### Create a layout

packages/node/package.json

@@ -16,13 +16,10 @@
     "build": "run-p build:*",
     "build:main": "tsc -p tsconfig.json",
     "build:module": "tsc -p tsconfig.module.json",
-    "fix": "run-s fix:*",
-    "fix:prettier": "prettier \"src/**/*.ts\" --write",
-    "lint:fix": "eslint src --fix",
-    "test": "run-s test:*",
-    "lint": "eslint src",
-    "test:prettier": "prettier \"src/**/*.ts\"",
-    "test:unit": "jest src",
+    "test": "jest src",
+    "lint": "run-s lint:*",
+    "lint:eslint": "eslint src --fix",
+    "lint:prettier": "prettier \"src/**/*.ts\" --write",
     "check-cli": "run-s test diff-integration-tests check-integration-tests",
     "check-integration-tests": "run-s check-integration-test:*",
     "diff-integration-tests": "mkdir -p diff && rm -rf diff/test && cp -r test diff/test && rm -rf diff/test/test-*/.git && cd diff && git init --quiet && git add -A && git commit --quiet --no-verify --allow-empty -m 'WIP' && echo '\\n\\nCommitted most recent integration test output in the \"diff\" directory. Review the changes with \"cd diff && git diff HEAD\" or your preferred git diff viewer.'",

packages/node/src/lib/retry.spec.ts

@@ -49,7 +49,7 @@ describe('Novu Node.js package - Retries and idempotency-key', () => {
     nock(BACKEND_URL)
       .post(TRIGGER_PATH)
       .times(3)
-      .reply(function (_url, _body) {
+      .reply(function cb(_url, _body) {
         idempotencyKeys.push(this.req.getHeader('idempotency-key') as string);
 
         return [500, { message: 'Server Exception' }];
@@ -100,7 +100,7 @@ describe('Novu Node.js package - Retries and idempotency-key', () => {
     nock(BACKEND_URL)
       .post(TRIGGER_PATH)
       .times(3)
-      .reply(function () {
+      .reply(function cb() {
         idempotencyKeys.push(this.req.getHeader('idempotency-key') as string);
 
         return [422, { message: 'Unprocessable Content' }];

packages/node/src/lib/subscribers/subscriber.interface.ts

@@ -34,7 +34,10 @@ export interface ISubscribers {
    */
   unsetCredentials(subscriberId: string, providerId: string);
   updateOnlineStatus(subscriberId: string, online: boolean);
-  getPreference(subscriberId: string);
+  getPreference(
+    subscriberId: string,
+    { includeInactiveChannels }: { includeInactiveChannels: boolean },
+  );
   getGlobalPreference(subscriberId: string);
   getPreferenceByLevel(subscriberId: string, level: PreferenceLevelEnum);
   updatePreference(

packages/node/src/lib/subscribers/subscribers.spec.ts

@@ -195,10 +195,19 @@ describe('test use of novus node package - Subscribers class', () => {
 
     await novu.subscribers.getPreference('test-subscriber-preference');
 
-    expect(mockedAxios.get).toHaveBeenCalled();
-    expect(mockedAxios.get).toHaveBeenCalledWith(
+    expect(mockedAxios.get).toHaveBeenNthCalledWith(
+      1,
       '/subscribers/test-subscriber-preference/preferences',
     );
+
+    await novu.subscribers.getPreference('test-subscriber-preference', {
+      includeInactiveChannels: true,
+    });
+
+    expect(mockedAxios.get).toHaveBeenNthCalledWith(
+      2,
+      '/subscribers/test-subscriber-preference/preferences?includeInactiveChannels=true',
+    );
   });
 
   test('should update subscriber preference', async () => {

packages/node/src/lib/subscribers/subscribers.ts

@@ -91,8 +91,25 @@ export class Subscribers extends WithHttp implements ISubscribers {
     return await this.http.delete(`/subscribers/${subscriberId}`);
   }
 
-  async getPreference(subscriberId: string) {
-    return await this.http.get(`/subscribers/${subscriberId}/preferences`);
+  async getPreference(
+    subscriberId: string,
+    options: { includeInactiveChannels?: boolean } = {},
+  ) {
+    const { includeInactiveChannels } = options;
+    const searchParams = new URLSearchParams();
+
+    if (includeInactiveChannels) {
+      searchParams.append('includeInactiveChannels', 'true');
+    }
+
+    const searchParamsString = searchParams.toString();
+
+    let url = `/subscribers/${subscriberId}/preferences`;
+    if (searchParamsString) {
+      url += `?${searchParamsString}`;
+    }
+
+    return await this.http.get(url);
   }
 
   async getGlobalPreference(subscriberId: string) {