@amityco/ts-sdk 0.0.1-beta.43.1 → 0.0.1-beta.44.0

package/src/post/observers/tests/livePosts.test.ts

@@ -66,7 +66,7 @@ describe('livePosts', () => {
 
   const filters: [string, Amity.PostLiveCollection, number?][] = [
     ['not deleted', { ...params, includeDeleted: false }],
-    ['tags', { ...params, tags: ['test_tag'] }, 1],
+    ['tags', { ...params, tags: ['test_tag'], includeDeleted: true }, 1],
   ];
 
   test.each(filters)(
@@ -104,7 +104,7 @@ describe('livePosts', () => {
       .mockResolvedValue(postQueryResponse)
       .mockResolvedValueOnce(postQueryResponsePage2);
 
-    livePosts(params, callback);
+    livePosts({ ...params, includeDeleted: true }, callback);
 
     expect(callback).toHaveBeenCalled();
 
@@ -292,7 +292,10 @@ describe('livePosts', () => {
     const callback = jest.fn();
     client.http.get = jest.fn().mockResolvedValue(postQueryResponsePage2);
 
-    livePosts({ ...params, targetType: 'community', feedType: 'reviewing' }, callback);
+    livePosts(
+      { ...params, targetType: 'community', feedType: 'reviewing', includeDeleted: true },
+      callback,
+    );
 
     await pause();
     const payload = postQueryResponsePage2.data.posts;
@@ -335,7 +338,10 @@ describe('livePosts', () => {
     const callback = jest.fn();
     client.http.get = jest.fn().mockResolvedValue(postQueryResponsePage2);
 
-    livePosts({ ...params, targetType: 'community', feedType: 'published' }, callback);
+    livePosts(
+      { ...params, targetType: 'community', feedType: 'published', includeDeleted: true },
+      callback,
+    );
 
     await pause();
     const payload = postQueryResponsePage2.data.posts;

package/src/subChannel/api/querySubChannels.ts

@@ -4,6 +4,8 @@ import { getActiveClient } from '~/client/api';
 import { getResolver } from '~/core/model';
 import { toPage, toToken } from '~/core/query';
 import { fireEvent } from '~/core/events';
+
+import { inferIsDeleted } from '~/utils/inferIsDeleted';
 import { convertQueryParams, prepareSubChannelPayload } from '../utils';
 
 /* begin_public_function
@@ -36,7 +38,7 @@ export const querySubChannels = async (
     {
       params: {
         ...params,
-        isDeleted: includeDeleted === false ? false : undefined,
+        isDeleted: inferIsDeleted(includeDeleted),
         options: {
           token: toToken(page, 'skiplimit'),
         },

package/src/subChannel/observers/liveSubChannels.ts

@@ -59,7 +59,7 @@ export const liveSubChannels = (
   const responder = (data: Amity.SubChannelLiveCollectionCache) => {
     let subChannels: Amity.SubChannel[] = data.data;
 
-    if (params.includeDeleted === false) {
+    if (!params.includeDeleted) {
       subChannels = filterByPropEquality(subChannels, 'isDeleted', false);
     }
 

package/src/utils/inferIsDeleted.ts

@@ -0,0 +1,16 @@
+/*
+ * This is a simple utility that infers the value of isDeleted based on the
+ * value of includeDeleted
+ *
+ * There are two important things to note here:
+ *  1. `includeDeleted` is purely client side query param and not recognized by
+ *  the server
+ *  2. The only values we wish to expose with regards to `isDeleted` (the server
+ *  param for queries) is false | undefined and want to disallow users to query
+ *  for deleted entities
+ *
+ *  Although this is a very simple utility, it's only purpose is to keep things
+ *  DRY
+ */
+export const inferIsDeleted = (includeDeleted?: boolean): boolean | undefined =>
+  includeDeleted === true ? undefined : false;

package/src/utils/tests/inferIsDeleted.test.ts

@@ -0,0 +1,15 @@
+import { inferIsDeleted } from '../inferIsDeleted';
+
+describe('utils > inferIsDeleted', () => {
+  test('it should return false if includeDeleted false', () => {
+    expect(inferIsDeleted(false)).toBe(false);
+  });
+
+  test('it should return false if includeDeleted undefined', () => {
+    expect(inferIsDeleted(undefined)).toBe(false);
+  });
+
+  test('it should return undefined if includeDeleted true', () => {
+    expect(inferIsDeleted(true)).toBeUndefined();
+  });
+});