@amityco/ts-sdk-react-native 6.14.1 → 6.15.0

package/src/channelRepository/observers/tests/getChannels.test.ts

@@ -28,10 +28,12 @@ import {
   channelLastActivity2,
   channelLastActivity3,
   channelDisplayName4,
+  channelQueryResponseWithoutPaging,
 } from '~/utils/tests';
 
 import { getChannels } from '../getChannels';
 import * as getChannelMarkers from '../../../marker/api/getChannelMarkers';
+import { getChannelMessagePreviewWithUser } from '~/messagePreview/utils';
 
 const getSnapshot = (params?: Record<string, any>) => {
   return {
@@ -82,11 +84,7 @@ describe('getChannels', () => {
     );
   });
 
-  test.skip('it should return data from cache', async () => {
-    /**
-     * skip this unit test because the behaviour is changed.
-     * when calling getChannels(), it will create a new instance of the channel collection.
-     */
+  test('it should return data from cache first when call with the same query', async () => {
     const callback = jest.fn();
     client.http.get = jest.fn().mockResolvedValue(channelQueryResponse);
 
@@ -100,7 +98,10 @@ describe('getChannels', () => {
       1,
       expect.objectContaining(
         getSnapshot({
-          data: [],
+          data: convertRawChannelPayload(channelQueryResponse.data).channels.map(
+            getChannelMessagePreviewWithUser,
+          ),
+          loading: true,
         }),
       ),
     );
@@ -108,7 +109,9 @@ describe('getChannels', () => {
       2,
       expect.objectContaining(
         getSnapshot({
-          data: convertRawChannelPayload(channelQueryResponse.data).channels,
+          data: convertRawChannelPayload(channelQueryResponse.data).channels.map(
+            getChannelMessagePreviewWithUser,
+          ),
           loading: false,
         }),
       ),
@@ -119,16 +122,19 @@ describe('getChannels', () => {
     const rawDeletedChannel = generateRawChannel({
       channelId: 'deleted-channel-id',
       isDeleted: true,
+      type: 'conversation',
     });
     const deletedChannel = convertChannelFromRaw(rawDeletedChannel);
     const rawTaggedChannel = generateRawChannel({
       channelId: 'tagged-channel-id',
       tags: ['tag1', 'tag2'],
+      type: 'conversation',
     });
     const taggedChannel = convertChannelFromRaw(rawTaggedChannel);
     const rawTaggedChannel2 = generateRawChannel({
       channelId: 'tagged-channel-id-2',
       tags: ['tag2'],
+      type: 'conversation',
     });
     const taggedChannel2 = convertChannelFromRaw(rawTaggedChannel2);
 
@@ -159,10 +165,6 @@ describe('getChannels', () => {
           { ...taggedChannel2, messagePreview: null },
         ],
       ],
-      /**
-       * TODO: skip this test because the behaviour is changed.
-       * The member filter is not supported yet. SDK use filter member response from backend, so skip this test
-       */
       ['member', { membership: 'member' }, [channel1]],
       [
         'not member',
@@ -309,7 +311,7 @@ describe('getChannels', () => {
         expect.objectContaining(
           getSnapshot({
             loading: false,
-            data: expected.map(convertChannelFromRaw),
+            data: expected.map(convertChannelFromRaw).map(getChannelMessagePreviewWithUser),
           }),
         ),
       );
@@ -340,7 +342,7 @@ describe('getChannels', () => {
           expect.objectContaining(
             getSnapshot({
               loading: false,
-              data: expected.map(convertChannelFromRaw),
+              data: expected.map(convertChannelFromRaw).map(getChannelMessagePreviewWithUser),
             }),
           ),
         );
@@ -351,12 +353,7 @@ describe('getChannels', () => {
   test('when querying two channel collections using different parameters, the results from each collection remain distinct and do not overlap', async () => {
     const callback = jest.fn();
     const callback2 = jest.fn();
-    const callback1Response = [
-      channelDisplayName2,
-      channelDisplayName1,
-      channelDisplayName3,
-      channelDisplayName4,
-    ];
+    const callback1Response = [channelDisplayName2, channelDisplayName1, channelDisplayName3];
     const callback1Expected = [channelDisplayName1, channelDisplayName2, channelDisplayName3];
     const callback2Response = [channelCreatedAt3, channelCreatedAt2, channelCreatedAt1];
 
@@ -395,7 +392,7 @@ describe('getChannels', () => {
       expect.objectContaining(
         getSnapshot({
           loading: false,
-          data: callback1Expected.map(convertChannelFromRaw),
+          data: callback1Expected.map(convertChannelFromRaw).map(getChannelMessagePreviewWithUser),
         }),
       ),
     );
@@ -404,7 +401,7 @@ describe('getChannels', () => {
       expect.objectContaining(
         getSnapshot({
           loading: false,
-          data: callback2Response.map(convertChannelFromRaw),
+          data: callback2Response.map(convertChannelFromRaw).map(getChannelMessagePreviewWithUser),
         }),
       ),
     );
@@ -417,7 +414,7 @@ describe('getChannels', () => {
       expect.objectContaining(
         getSnapshot({
           loading: false,
-          data: callback1Expected.map(convertChannelFromRaw),
+          data: callback1Expected.map(convertChannelFromRaw).map(getChannelMessagePreviewWithUser),
         }),
       ),
     );
@@ -426,7 +423,7 @@ describe('getChannels', () => {
       expect.objectContaining(
         getSnapshot({
           loading: false,
-          data: callback2Response.map(convertChannelFromRaw),
+          data: callback2Response.map(convertChannelFromRaw).map(getChannelMessagePreviewWithUser),
         }),
       ),
     );
@@ -439,7 +436,7 @@ describe('getChannels', () => {
       expect.objectContaining(
         getSnapshot({
           loading: false,
-          data: callback1Expected.map(convertChannelFromRaw),
+          data: callback1Expected.map(convertChannelFromRaw).map(getChannelMessagePreviewWithUser),
         }),
       ),
     );
@@ -448,7 +445,7 @@ describe('getChannels', () => {
       expect.objectContaining(
         getSnapshot({
           loading: false,
-          data: callback2Response.map(convertChannelFromRaw),
+          data: callback2Response.map(convertChannelFromRaw).map(getChannelMessagePreviewWithUser),
         }),
       ),
     );
@@ -503,7 +500,9 @@ describe('getChannels', () => {
             channelUsers: [rawChannelUser],
             files: [],
             users: [user11],
-            ...mockPage,
+            paging: {
+              next: 'eyJza2lwIjowLCJsaW1pdCI6MTB9',
+            },
           },
         });
       }
@@ -521,7 +520,10 @@ describe('getChannels', () => {
           },
         });
       }
-      if (params?.params?.options?.token === 'eyJza2lwIjowfQ==') {
+      if (
+        params?.params?.options?.token ===
+        'eyJsaW1pdCI6MiwiYmVmb3JlIjo2MzQ3MTYxNDQ5MTExMTAwMDAwMH0='
+      ) {
         return Promise.resolve({
           data: {
             channels: returnValue2Page3,
@@ -541,7 +543,9 @@ describe('getChannels', () => {
           channelUsers: [rawChannelUser],
           files: [],
           users: [user11],
-          ...mockPage,
+          paging: {
+            next: 'eyJza2lwIjowLCJsaW1pdCI6MTB9',
+          },
         },
       });
     });
@@ -551,7 +555,7 @@ describe('getChannels', () => {
 
     expect(spyGet).toHaveBeenCalledWith('/api/v3/channels', {
       params: {
-        options: { token: 'eyJza2lwIjowLCJsaW1pdCI6NX0=' },
+        options: { limit: 5 }, // default limit in SDK
       },
     });
 
@@ -570,7 +574,7 @@ describe('getChannels', () => {
 
     expect(callback).lastCalledWith(
       expect.objectContaining({
-        data: returnValue1Page1.map(convertChannelFromRaw),
+        data: returnValue1Page1.map(convertChannelFromRaw).map(getChannelMessagePreviewWithUser),
         error: undefined,
         loading: false,
       }),
@@ -578,17 +582,18 @@ describe('getChannels', () => {
 
     expect(callback2).lastCalledWith(
       expect.objectContaining({
-        data: returnValue2Page1.map(convertChannelFromRaw),
+        data: returnValue2Page1.map(convertChannelFromRaw).map(getChannelMessagePreviewWithUser),
         error: undefined,
         loading: false,
       }),
     );
 
-    // get more page for live collection #2
+    // get page 2 for live collection #2
     callback2.mock.lastCall[0].onNextPage();
 
     await pause(100);
 
+    // get page 3 for live collection #2
     callback2.mock.lastCall[0].onNextPage();
 
     await pause(100);
@@ -596,7 +601,7 @@ describe('getChannels', () => {
     expect(callback.mock.calls.length).toBeGreaterThan(1);
     expect(callback).lastCalledWith(
       expect.objectContaining({
-        data: returnValue1Page1.map(convertChannelFromRaw),
+        data: returnValue1Page1.map(convertChannelFromRaw).map(getChannelMessagePreviewWithUser),
         error: undefined,
         loading: false,
       }),
@@ -605,15 +610,15 @@ describe('getChannels', () => {
     expect(callback2.mock.calls.length).toBe(6);
     expect(callback2).lastCalledWith(
       expect.objectContaining({
-        data: [...returnValue2Page1, ...returnValue2Page2, ...returnValue2Page3].map(
-          convertChannelFromRaw,
-        ),
+        data: [...returnValue2Page1, ...returnValue2Page2, ...returnValue2Page3]
+          .map(convertChannelFromRaw)
+          .map(getChannelMessagePreviewWithUser),
         error: undefined,
         loading: false,
       }),
     );
 
-    // get more page for live collection #1
+    // get page 2 for live collection #1
 
     callback.mock.lastCall[0].onNextPage();
 
@@ -621,7 +626,9 @@ describe('getChannels', () => {
 
     expect(callback).lastCalledWith(
       expect.objectContaining({
-        data: [...returnValue1Page1, ...returnValue1Page2].map(convertChannelFromRaw),
+        data: [...returnValue1Page1, ...returnValue1Page2]
+          .map(convertChannelFromRaw)
+          .map(getChannelMessagePreviewWithUser),
         error: undefined,
         loading: false,
       }),
@@ -672,6 +679,8 @@ describe('getChannels', () => {
   describe('events', () => {
     const rawNewChannel = generateRawChannel({ channelId: 'new-channel-id' });
 
+    const rawUpdatedChannel = { ...channelRaw1, updatedAt: new Date().toISOString() };
+
     const cases: [string, keyof Amity.Events, Amity.RawChannel, Amity.Channel[]][] = [
       [
         'it should add new channel to collection onCreate',
@@ -688,8 +697,8 @@ describe('getChannels', () => {
       [
         'it should update channel in collection onUpdate',
         'channel.updated',
-        channelRaw1,
-        [channel1, channel2],
+        rawUpdatedChannel,
+        [{ ...channel1, updatedAt: rawUpdatedChannel.updatedAt }, channel2],
       ],
       [
         'it should update channel in collection onMuted',
@@ -959,3 +968,107 @@ describe('getChannels', () => {
     );
   });
 });
+
+describe('getChannels by channelIds', () => {
+  jest.spyOn(getChannelMarkers, 'getChannelMarkers').mockResolvedValue({
+    data: [],
+    cachedAt: undefined,
+  });
+
+  beforeAll(connectClient);
+  afterAll(disconnectClient);
+  beforeEach(enableCache);
+  afterEach(disableCache);
+
+  test('it should return channel collection when query by channelIds', async () => {
+    const callback = jest.fn();
+    client.http.get = jest.fn().mockResolvedValue(channelQueryResponseWithoutPaging);
+
+    getChannels({}, callback);
+    await pause();
+
+    expect(callback).toHaveBeenCalledTimes(2);
+    expect(callback).toHaveBeenNthCalledWith(1, expect.objectContaining(getSnapshot()));
+    expect(callback).toHaveBeenNthCalledWith(
+      2,
+      expect.objectContaining(
+        getSnapshot({
+          data: convertRawChannelPayload(channelQueryResponse.data).channels.map(channel => {
+            return { ...channel, messagePreview: null };
+          }),
+          loading: false,
+        }),
+      ),
+    );
+  });
+
+  describe('events', () => {
+    const rawNewChannel = generateRawChannel({ channelId: 'new-channel-id' });
+
+    const rawUpdatedChannel = { ...channelRaw1, updatedAt: new Date().toISOString() };
+
+    const cases: [string, keyof Amity.Events, Amity.RawChannel, Amity.Channel[]][] = [
+      [
+        'it should not add new channel to collection onCreate',
+        'channel.created',
+        rawNewChannel,
+        [channel1, channel2],
+      ],
+      [
+        'it should not add new channel to collection onJoin',
+        'channel.joined',
+        rawNewChannel,
+        [channel1, channel2],
+      ],
+      [
+        'it should update channel in collection onUpdate',
+        'channel.updated',
+        rawUpdatedChannel,
+        [{ ...channel1, updatedAt: rawUpdatedChannel.updatedAt }, channel2],
+      ],
+      [
+        'it should update channel in collection onMuted',
+        'channel.setMuted',
+        { ...channelRaw1, isMuted: true },
+        [{ ...channel1, isMuted: true }, channel2],
+      ],
+      [
+        'it should not remove channel from collection onDelete',
+        'channel.deleted',
+        { ...channelRaw1, isDeleted: true },
+        [channel1, channel2],
+      ],
+      [
+        'it should not remove channel from collection onLeft',
+        'channel.left',
+        { ...channelRaw1, isDeleted: true },
+        [channel1, channel2],
+      ],
+    ];
+
+    test.each(cases)('%s', async (test, event, rawChannel, expected) => {
+      const callback = jest.fn();
+      client.http.get = jest.fn().mockResolvedValue(channelQueryResponse);
+
+      getChannels({ channelIds: [channelRaw1._id, channelRaw2._id] }, callback);
+      await pause();
+      client.emitter.emit(event, {
+        channels: [rawChannel],
+        channelUsers: [rawChannelUser],
+        users: [],
+        files: [],
+      });
+      await pause();
+
+      expect(callback).toHaveBeenNthCalledWith(
+        event === 'channel.updated' || event === 'channel.setMuted' ? 3 : 2,
+        expect.objectContaining(
+          getSnapshot({
+            data: expected,
+            loading: false,
+          }),
+        ),
+      );
+    });
+  });
+});

package/src/channelRepository/utils/prepareChannelPayload.ts

@@ -25,7 +25,7 @@ export function convertFromRaw(channel: Amity.RawChannel): Amity.InternalChannel
   };
 }
 
-const preUpdateChannelCache = (rawPayload: Amity.ChannelPayload) => {
+export const preUpdateChannelCache = (rawPayload: Amity.ChannelPayload) => {
   ingestInCache({
     channels: rawPayload.channels.map(channel => convertFromRaw(channel)),
   });

package/src/client/utils/markerSyncEngine.ts

@@ -3,7 +3,7 @@ import {
   onChannelDeleted,
   onChannelJoined,
   onChannelLeft,
-} from '~/channelRepository';
+} from '~/channelRepository/events';
 import { onUserMarkerSync } from '~/marker/events/onUserMarkerSync';
 import { setIntervalTask } from '~/utils/timer';
 import { getUserMarker } from '~/marker/api';

package/src/communityRepository/api/createCommunity.ts

@@ -3,7 +3,7 @@ import { getActiveClient } from '~/client/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 import { fireEvent } from '~/core/events';
 
-import { prepareCommunityRequest, prepareCommunityPayload } from '../utils';
+import { prepareCommunityPayload, prepareCommunityRequest } from '../utils';
 
 /* begin_public_function
   id: community.create
@@ -33,11 +33,12 @@ export const createCommunity = async (
     | 'postSetting'
     | 'tags'
     | 'metadata'
-  > & {
-    userIds?: string[];
-    categoryIds?: string[];
-    isUniqueDisplayName?: boolean;
-  },
+  > &
+    Amity.CommunityStorySettings & {
+      userIds?: string[];
+      categoryIds?: string[];
+      isUniqueDisplayName?: boolean;
+    },
 ): Promise<Amity.Cached<Amity.Community>> => {
   const client = getActiveClient();
   client.log('user/createCommunity', bundle);

package/src/communityRepository/api/queryCommunities.ts

@@ -25,14 +25,21 @@ import { prepareCommunityPayload } from '../utils';
  */
 export const queryCommunities = async (
   query?: Amity.QueryCommunities,
-): Promise<Amity.Cached<Amity.Paged<Amity.Community>>> => {
+): Promise<Amity.Cached<Amity.PageToken<Amity.Community>>> => {
   const client = getActiveClient();
   client.log('channel/queryCommunities', query);
 
   // safe decapsulation
-  const { page = { limit: 10 }, ...params } = query ?? {};
+  const { page, limit = 10, ...params } = query ?? {};
   const { displayName, membership, includeDeleted, ...restParams } = params ?? {};
 
+  const options = (() => {
+    if (page) return { token: page };
+    if (limit) return { limit };
+
+    return undefined;
+  })();
+
   // API-FIX: parameters should be querystring.
   // API-FIX: backend doesn't answer Amity.Response
   // const { data } = await client.http.get<Amity.Response<Amity.PagedResponse<CommunityPayload>>>(
@@ -44,9 +51,7 @@ export const queryCommunities = async (
         isDeleted: inferIsDeleted(includeDeleted),
         keyword: displayName,
         filter: membership,
-        options: {
-          token: toToken(page, 'skiplimit'),
-        },
+        options,
       },
     },
   );
@@ -60,16 +65,9 @@ export const queryCommunities = async (
   if (client.cache) {
     ingestInCache(unpackedPayload, { cachedAt });
 
-    const cacheKey = [
-      'community',
-      'query',
-      { ...params, options: { ...page } } as Amity.Serializable,
-    ];
+    const cacheKey = ['community', 'query', { ...params, options } as Amity.Serializable];
     pushToCache(cacheKey, { communities: communities.map(getResolver('community')), paging });
   }
 
-  const nextPage = toPage(paging.next);
-  const prevPage = toPage(paging.previous);
-
-  return { data: communities, cachedAt, prevPage, nextPage };
+  return { data: communities, cachedAt, paging };
 };

package/src/communityRepository/api/test/queryCommunity.test.ts

@@ -14,9 +14,11 @@ const pagingToken = {
 const communitiesToQuery = [community11];
 const communityIdsToQuery = communitiesToQuery.map(community => community.communityId);
 const communityUsersToQuery = [communityUser11];
-const queryCriteriaWithoutPage = { displayName: communities[0].displayName };
-const pagingCriteria = { limit: 10 };
-const queryCriteria = { ...queryCriteriaWithoutPage, page: pagingCriteria };
+const queryCriteriaWithoutQueryToken = { displayName: communities[0].displayName, limit: 10 };
+const queryCriteriaWithQueryToken = {
+  ...queryCriteriaWithoutQueryToken,
+  page: pagingToken.next,
+};
 
 const resolvedGetValue = {
   data: {
@@ -34,11 +36,10 @@ describe('queryCommunities', () => {
   test('should return fetched communities with correct paging', async () => {
     client.http.get = jest.fn().mockResolvedValueOnce(resolvedGetValue);
 
-    await expect(queryCommunities(queryCriteria)).resolves.toEqual(
+    await expect(queryCommunities(queryCriteriaWithoutQueryToken)).resolves.toEqual(
       expect.objectContaining({
         data: communitiesToQuery,
-        prevPage: { before: 55, limit: 10 },
-        nextPage: { before: 55, limit: 10 },
+        paging: pagingToken,
       }),
     );
   });
@@ -47,12 +48,17 @@ describe('queryCommunities', () => {
     enableCache();
     client.http.get = jest.fn().mockResolvedValue(resolvedGetValue);
 
-    await queryCommunities(queryCriteria);
+    await queryCommunities(queryCriteriaWithQueryToken);
+
+    const { page, limit, ...params } = queryCriteriaWithQueryToken;
 
     const recieved = pullFromCache([
       'community',
       'query',
-      { ...queryCriteriaWithoutPage, options: pagingCriteria },
+      {
+        ...params,
+        options: { token: queryCriteriaWithQueryToken.page },
+      },
     ])?.data;
 
     expect(recieved).toEqual({
@@ -66,14 +72,14 @@ describe('queryCommunities', () => {
   test('should throw an error if request fails', async () => {
     client.http.get = jest.fn().mockRejectedValueOnce(new Error('error'));
 
-    await expect(queryCommunities(queryCriteria)).rejects.toThrow('error');
+    await expect(queryCommunities(queryCriteriaWithQueryToken)).rejects.toThrow('error');
   });
 
   test('it should set isDeleted to undefined if includeDeleted is true', async () => {
     const mockFn = jest.fn();
     client.http.get = mockFn.mockResolvedValue(resolvedGetValue);
 
-    await queryCommunities({ ...queryCriteriaWithoutPage, includeDeleted: true });
+    await queryCommunities({ ...queryCriteriaWithoutQueryToken, includeDeleted: true });
 
     expect(mockFn.mock.lastCall).toHaveLength(2);
     expect(mockFn.mock.lastCall[1].params.isDeleted).toBeUndefined();
@@ -83,7 +89,7 @@ describe('queryCommunities', () => {
     const mockFn = jest.fn();
     client.http.get = mockFn.mockResolvedValue(resolvedGetValue);
 
-    await queryCommunities({ ...queryCriteriaWithoutPage, includeDeleted: false });
+    await queryCommunities({ ...queryCriteriaWithoutQueryToken, includeDeleted: false });
 
     expect(mockFn.mock.lastCall).toHaveLength(2);
     expect(mockFn.mock.lastCall[1].params.isDeleted).toBe(false);
@@ -93,7 +99,7 @@ describe('queryCommunities', () => {
     const mockFn = jest.fn();
     client.http.get = mockFn.mockResolvedValue(resolvedGetValue);
 
-    await queryCommunities(queryCriteriaWithoutPage);
+    await queryCommunities(queryCriteriaWithoutQueryToken);
 
     expect(mockFn.mock.lastCall).toHaveLength(2);
     expect(mockFn.mock.lastCall[1].params.isDeleted).toBe(false);

package/src/communityRepository/api/updateCommunity.ts

@@ -3,7 +3,7 @@ import { getActiveClient } from '~/client/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 import { fireEvent } from '~/core/events';
 
-import { prepareCommunityRequest, prepareCommunityPayload } from '../utils';
+import { prepareCommunityPayload, prepareCommunityRequest } from '../utils';
 
 /* begin_public_function
   id: community.update
@@ -27,8 +27,9 @@ export const updateCommunity = async (
   communityId: Amity.Community['communityId'],
   patch: Patch<
     Amity.Community,
-    'displayName' | 'description' | 'avatarFileId' | 'postSetting' | 'tags' | 'metadata'
-  >,
+    'displayName' | 'avatarFileId' | 'description' | 'postSetting' | 'tags' | 'metadata'
+  > &
+    Amity.CommunityStorySettings,
 ): Promise<Amity.Cached<Amity.Community>> => {
   const client = getActiveClient();
   client.log('community/updateCommunity', communityId, patch);