Merge pull request #1395 from push-protocol/fix-updated-sdk-to-filter…

…-via-tag fix: added tag parameter for filter in list
push-protocol · Sep 25, 2024 · 21c08ba · 21c08ba
2 parents 665a96d + 27a6eee
commit 21c08ba
Show file tree

Hide file tree

Showing 6 changed files with 40 additions and 10 deletions.
diff --git a/packages/restapi/src/lib/channels/getChannels.ts b/packages/restapi/src/lib/channels/getChannels.ts
@@ -15,22 +15,25 @@ type getChannelsOptionsType = {
   sort?: string;
   order?: string;
   filter?: number;
-}
+  tag?: string;
+};
 
 export const getChannels = async (options: getChannelsOptionsType) => {
-  const { 
-    env = CONSTANTS.ENV.PROD, 
-    page = 1, 
-    limit = 10, 
+  const {
+    env = CONSTANTS.ENV.PROD,
+    page = 1,
+    limit = 10,
     sort = CONSTANTS.FILTER.CHANNEL_LIST.SORT.SUBSCRIBER,
     order = CONSTANTS.FILTER.CHANNEL_LIST.ORDER.DESCENDING,
-    filter
+    filter,
+    tag,
   } = options || {};
 
   const API_BASE_URL = getAPIBaseUrls(env);
   const apiEndpoint = `${API_BASE_URL}/v1/channels`;
-  const requestUrl = `${apiEndpoint}?page=${page}&limit=${limit}&sort=${sort}&order=${order}${filter? '&filter=' + filter : ''}`;
-
+  const requestUrl = `${apiEndpoint}?page=${page}&limit=${limit}&sort=${sort}&order=${order}${
+    filter ? '&filter=' + filter : ''
+  }${tag ? '&tag=' + tag : ''}`;
   return await axiosGet(requestUrl)
     .then((response) => {
       return response.data;

diff --git a/packages/restapi/src/lib/channels/search.ts b/packages/restapi/src/lib/channels/search.ts
@@ -14,6 +14,7 @@ export type SearchChannelOptionsType = {
   page?: number;
   limit?: number;
   filter?: number;
+  tag?: string;
   // temp fix to support both new and old format
   oldFormat?: boolean;
 };
@@ -25,6 +26,7 @@ export const search = async (options: SearchChannelOptionsType) => {
     page = Constants.PAGINATION.INITIAL_PAGE,
     limit = Constants.PAGINATION.LIMIT,
     filter,
+    tag,
     oldFormat = true,
   } = options || {};
 
@@ -35,6 +37,7 @@ export const search = async (options: SearchChannelOptionsType) => {
     page,
     limit: getLimit(limit),
     query,
+    ...(tag && { tag }),
     ...(filter && { filter }),
   };
   const requestUrl = `${apiEndpoint}?${getQueryParams(queryObj)}`;

diff --git a/packages/restapi/src/lib/pushNotification/PushNotificationTypes.ts b/packages/restapi/src/lib/pushNotification/PushNotificationTypes.ts
@@ -56,6 +56,7 @@ export type ChannelSearchOptions = {
   filter?: number;
   // temp fix to support both new and old format
   oldFormat?: boolean;
+  tag?: string;
 };
 
 // Types related to notification
@@ -156,6 +157,7 @@ export type ChannelListOptions = {
   sort?: ChannelListSortType;
   order?: ChannelListOrderType;
   filter?: number;
+  tag?: string;
 };
 
 export type TagListOptions = {

diff --git a/packages/restapi/src/lib/pushNotification/channel.ts b/packages/restapi/src/lib/pushNotification/channel.ts
@@ -78,13 +78,15 @@ export class Channel extends PushNotificationBaseClass {
         page = Constants.PAGINATION.INITIAL_PAGE,
         limit = Constants.PAGINATION.LIMIT,
         filter,
+        tag,
         oldFormat = true
       } = options || {};
       return await PUSH_CHANNEL.search({
         query: query,
         page: page,
         limit: limit,
         filter: filter,
+        tag: tag,
         env: this.env,
         oldFormat
       });
@@ -477,6 +479,7 @@ export class Channel extends PushNotificationBaseClass {
         sort = ChannelListSortType.SUBSCRIBER,
         order = ChannelListOrderType.DESCENDING,
         filter,
+        tag,
       } = options || {};
 
       return await PUSH_CHANNEL.getChannels({
@@ -485,7 +488,8 @@ export class Channel extends PushNotificationBaseClass {
         limit,
         sort,
         order,
-        filter
+        filter,
+        tag
       });
     } catch (error) {
       throw new Error(`Push SDK Error: Contract : channel::list : ${error}`);

diff --git a/packages/restapi/tests/lib/channel/getChannels.test.ts b/packages/restapi/tests/lib/channel/getChannels.test.ts
@@ -10,4 +10,12 @@ describe('PUSH_CHANNELS.getChannels', () => {
     });
     console.log(res);
   });
+
+  it.only('Should fetch channels based on the filter and tags', async () => {
+    const res = await getChannels({
+      env: ENV.DEV,
+      tag: 'Infrastructure'
+    });
+    console.log(res.channels[0]);
+  });
 });
diff --git a/packages/restapi/tests/lib/channel/search.test.ts b/packages/restapi/tests/lib/channel/search.test.ts
@@ -12,7 +12,7 @@ describe('PUSH_CHANNELS.search', () => {
     console.log(res);
   });
 
-  it.only('Should fetch channels based on the filter in new format', async () => {
+  it('Should fetch channels based on the filter in new format', async () => {
     const res = await search({
       filter: 80002,
       env: ENV.DEV,
@@ -21,4 +21,14 @@ describe('PUSH_CHANNELS.search', () => {
     });
     console.log(res);
   });
+
+  it('Should fetch channels based on the filter in new format', async () => {
+    const res = await search({
+      env: ENV.DEV,
+      query: "Channel",
+      oldFormat: false,
+      tag: "Infrastructure"
+    });
+    console.log(res);
+  });
 });