@amityco/ts-sdk-react-native 6.13.2 → 6.14.0

package/src/messageRepository/observers/tests/getMessages.test.ts

@@ -9,6 +9,7 @@ import {
   generateRawMessage,
   convertRawMessage,
   pause,
+  messagesDesc,
 } from '~/utils/tests';
 
 import { queryMessages } from '../../api/queryMessages';
@@ -71,11 +72,12 @@ describe('getMessages', () => {
     });
 
     getMessages({ subChannelId }, callback);
+    await pause();
 
-    expect(callback).toHaveBeenCalledTimes(1);
+    expect(callback).toHaveBeenCalledTimes(2);
 
-    // check if cache data returned (should be empty)
-    expect(callback).toHaveBeenCalledWith(
+    expect(callback).toHaveBeenNthCalledWith(
+      1,
       expect.objectContaining({
         data: [],
         error: undefined,
@@ -83,11 +85,8 @@ describe('getMessages', () => {
       }),
     );
 
-    await expect(queryMessages({ subChannelId })).resolves.toBeTruthy();
-
-    expect(callback).toHaveBeenCalledTimes(2);
-
-    expect(callback).toHaveBeenCalledWith(
+    expect(callback).toHaveBeenNthCalledWith(
+      2,
       expect.objectContaining({
         data: returnValue.map(convertRawMessage),
         error: undefined,
@@ -108,8 +107,9 @@ describe('getMessages', () => {
     client.http.get = jest.fn().mockRejectedValue(error);
 
     getMessages({ subChannelId }, callback);
+    await pause();
 
-    expect(callback).toHaveBeenCalledTimes(1);
+    expect(callback).toHaveBeenCalledTimes(2);
 
     // check if cache data returned (should be empty)
     expect(callback).toHaveBeenCalledWith(
@@ -150,11 +150,16 @@ describe('getMessages', () => {
     });
 
     getMessages({ subChannelId, includeDeleted: false }, callback);
+    await pause();
 
-    expect(callback).toHaveBeenCalledTimes(1);
+    // not use queryMessages anymore
+    // await expect(queryMessages({ subChannelId })).resolves.toBeTruthy();
+
+    expect(callback).toHaveBeenCalledTimes(2);
 
     // check if cache data returned (should be empty)
-    expect(callback).toHaveBeenCalledWith(
+    expect(callback).toHaveBeenNthCalledWith(
+      1,
       expect.objectContaining({
         data: [],
         error: undefined,
@@ -162,11 +167,8 @@ describe('getMessages', () => {
       }),
     );
 
-    await expect(queryMessages({ subChannelId })).resolves.toBeTruthy();
-
-    expect(callback).toHaveBeenCalledTimes(2);
-
-    expect(callback).toHaveBeenCalledWith(
+    expect(callback).toHaveBeenNthCalledWith(
+      2,
       expect.objectContaining({
         // @ts-ignore
         data: [returnValue[1]].map(convertRawMessage),
@@ -202,10 +204,11 @@ describe('getMessages', () => {
       });
 
     getMessages({ subChannelId, includeDeleted: true }, callback);
+    await pause();
 
     expect(callback).toHaveBeenCalled();
 
-    await expect(queryMessages({ subChannelId })).resolves.toBeTruthy();
+    // await expect(queryMessages({ subChannelId })).resolves.toBeTruthy();
 
     expect(callback.mock.lastCall).toHaveLength(1);
 
@@ -215,8 +218,9 @@ describe('getMessages', () => {
     expect(onNextPage).toBeTruthy();
 
     onNextPage();
+    await pause();
 
-    await expect(queryMessages({ subChannelId })).resolves.toBeTruthy();
+    // await expect(queryMessages({ subChannelId })).resolves.toBeTruthy();
 
     // 4 -> becuase 1 local & server call each per call (2)
     expect(callback).toHaveBeenCalledTimes(4);
@@ -232,7 +236,8 @@ describe('getMessages', () => {
     );
   });
 
-  test('it should add new message to collection onFetch', async () => {
+  // skip this test for now because onFecth should not add a new message to the collection
+  test.skip('it should add new message to collection onFetch', async () => {
     const callback = jest.fn();
     client.http.get = jest.fn().mockResolvedValue({
       data: {
@@ -242,8 +247,9 @@ describe('getMessages', () => {
     });
 
     getMessages({ subChannelId }, callback);
+    await pause();
 
-    await expect(queryMessages({ subChannelId })).resolves.toBeTruthy();
+    // await expect(queryMessages({ subChannelId })).resolves.toBeTruthy();
     expect(callback).toHaveBeenCalledTimes(2);
 
     client.emitter.emit('local.message.fetched', { messages: [message] });
@@ -275,8 +281,9 @@ describe('getMessages', () => {
     });
 
     getMessages({ subChannelId }, callback);
+    await pause();
 
-    await expect(queryMessages({ subChannelId })).resolves.toBeTruthy();
+    // await expect(queryMessages({ subChannelId })).resolves.toBeTruthy();
     expect(callback).toHaveBeenCalledTimes(2);
 
     // fire new message creation event
@@ -312,8 +319,9 @@ describe('getMessages', () => {
     });
 
     getMessages({ subChannelId }, callback);
+    await pause();
 
-    await expect(queryMessages({ subChannelId })).resolves.toBeTruthy();
+    // await expect(queryMessages({ subChannelId })).resolves.toBeTruthy();
     expect(callback).toHaveBeenCalledTimes(2);
 
     // fire new message creation event
@@ -345,14 +353,15 @@ describe('getMessages', () => {
       },
     });
 
-    getMessages({ subChannelId }, callback);
+    getMessages({ subChannelId, includeDeleted: true }, callback);
+    await pause();
 
-    await expect(queryMessages({ subChannelId })).resolves.toBeTruthy();
+    // await expect(queryMessages({ subChannelId })).resolves.toBeTruthy();
     expect(callback).toHaveBeenCalledTimes(2);
 
-    // fire new message creation event
+    // fire new message deletion event
     client.emitter.emit('message.deleted', {
-      messages: [rawMessage],
+      messages: [{ ...rawMessage, isDeleted: true }],
       messageFeeds: [],
       users: [],
       files: [],
@@ -364,7 +373,7 @@ describe('getMessages', () => {
     expect(callback).toHaveBeenNthCalledWith(
       3,
       expect.objectContaining({
-        data: [message],
+        data: [{ ...message, isDeleted: true }],
         error: undefined,
         loading: false,
       }),
@@ -395,7 +404,8 @@ describe('getMessages', () => {
           params: {
             isDeleted: false,
             messageFeedId: 'message-feed-id',
-            options: { token: 'eyJsaW1pdCI6NX0=' },
+            // first time call will not have token, message set limit to COLLECTION_DEFAULT_PAGINATION_LIMIT by default
+            options: { limit: 5 },
           },
         });
 
@@ -442,7 +452,11 @@ describe('getMessages', () => {
           params: {
             isDeleted: false,
             messageFeedId: 'message-feed-id',
-            options: { sortBy: 'segmentDesc', token: 'eyJsaW1pdCI6NX0=' },
+            options: {
+              sortBy: 'segmentDesc',
+              // first time call will not have token, message set limit to COLLECTION_DEFAULT_PAGINATION_LIMIT by default
+              limit: 5,
+            },
           },
         });
 
@@ -489,7 +503,11 @@ describe('getMessages', () => {
           params: {
             isDeleted: false,
             messageFeedId: 'message-feed-id',
-            options: { sortBy: 'segmentDesc', token: 'eyJsaW1pdCI6NX0=' },
+            options: {
+              sortBy: 'segmentDesc',
+              // first time call will not have token, message set limit to COLLECTION_DEFAULT_PAGINATION_LIMIT by default
+              limit: 5,
+            },
           },
         });
 
@@ -540,7 +558,11 @@ describe('getMessages', () => {
           params: {
             isDeleted: false,
             messageFeedId: 'message-feed-id',
-            options: { token: 'eyJsaW1pdCI6NX0=', sortBy: 'segmentAsc' },
+            options: {
+              sortBy: 'segmentAsc',
+              // first time call will not have token, message set limit to COLLECTION_DEFAULT_PAGINATION_LIMIT by default
+              limit: 5,
+            },
           },
         });
 
@@ -587,7 +609,11 @@ describe('getMessages', () => {
           params: {
             isDeleted: false,
             messageFeedId: 'message-feed-id',
-            options: { token: 'eyJsaW1pdCI6NX0=', sortBy: 'segmentAsc' },
+            options: {
+              sortBy: 'segmentAsc',
+              // first time call will not have token, message set limit to COLLECTION_DEFAULT_PAGINATION_LIMIT by default
+              limit: 5,
+            },
           },
         });
 
@@ -617,6 +643,12 @@ describe('getMessages', () => {
       });
     });
 
+    /**
+     * TODO: check filtering test cases again
+     * The filtering should be on server side when query message from API
+     * But on SDK side, we should filter the message after we get the message RTE event from server
+     */
+
     describe('filtering', () => {
       test('tags', async () => {
         const { subChannelId } = messages;
@@ -641,7 +673,7 @@ describe('getMessages', () => {
             isDeleted: false,
             messageFeedId: 'message-feed-id',
             includeTags: ['tag1', 'tag2'],
-            options: { token: 'eyJsaW1pdCI6NX0=' },
+            options: { limit: 5 },
           },
         });
 
@@ -690,7 +722,7 @@ describe('getMessages', () => {
             isDeleted: false,
             messageFeedId: 'message-feed-id',
             excludeTags: ['tag1'],
-            options: { token: 'eyJsaW1pdCI6NX0=' },
+            options: { limit: 5 },
           },
         });
 
@@ -724,9 +756,10 @@ describe('getMessages', () => {
         ];
 
         const callback = jest.fn();
+        // dataType filtering by server, so query messages api v5 response from server will return only image dataType
         const spyGet = jest.spyOn(client.http, 'get').mockResolvedValue({
           data: {
-            messages: returnValue,
+            messages: [returnValue[1]],
             paging: {},
           },
         });
@@ -738,7 +771,7 @@ describe('getMessages', () => {
             isDeleted: false,
             messageFeedId: 'message-feed-id',
             dataType: 'image',
-            options: { token: 'eyJsaW1pdCI6NX0=' },
+            options: { limit: 5 },
           },
         });
 
@@ -772,10 +805,13 @@ describe('getMessages', () => {
           generateRawMessage({ messageId: messages.page3[0], parentId: 'parent-id-2' }),
         ];
 
+        // parentId filtering by server,
+        // query messages api v5 from server will return only that parentId
+
         const callback = jest.fn();
         const spyGet = jest.spyOn(client.http, 'get').mockResolvedValue({
           data: {
-            messages: returnValue,
+            messages: [returnValue[0], returnValue[1]],
             paging: {},
           },
         });
@@ -787,7 +823,7 @@ describe('getMessages', () => {
             isDeleted: false,
             messageFeedId: 'message-feed-id',
             parentId,
-            options: { token: 'eyJsaW1pdCI6NX0=' },
+            options: { limit: 5 },
           },
         });
 
@@ -839,7 +875,7 @@ describe('getMessages', () => {
             isDeleted: false,
             messageFeedId: 'message-feed-id',
             includeTags: ['tag3'],
-            options: { sortBy: 'segmentAsc', token: 'eyJsaW1pdCI6NX0=' },
+            options: { sortBy: 'segmentAsc', limit: 5 },
           },
         });
 
@@ -911,7 +947,7 @@ describe('getMessages', () => {
       params: {
         isDeleted: false,
         messageFeedId: 'message-feed-id',
-        options: { sortBy: 'segmentDesc', token: 'eyJsaW1pdCI6NX0=' },
+        options: { sortBy: 'segmentDesc', limit: 5 },
       },
     });
 
@@ -919,7 +955,7 @@ describe('getMessages', () => {
       params: {
         isDeleted: false,
         messageFeedId: 'message-feed-id',
-        options: { sortBy: 'segmentAsc', token: 'eyJsaW1pdCI6NX0=' },
+        options: { sortBy: 'segmentAsc', limit: 5 },
       },
     });
 
@@ -958,18 +994,20 @@ describe('getMessages', () => {
     const callback2 = jest.fn();
 
     const { subChannelId } = messages;
+    // Value1 is for segmentDesc sorting
     const returnValue1Page1: Amity.RawMessage[] = [
-      generateRawMessage({ messageId: messages.page3[2], segment: 100 }),
-      generateRawMessage({ messageId: messages.page3[1], segment: 99 }),
-      generateRawMessage({ messageId: messages.page3[0], segment: 98 }),
+      generateRawMessage({ messageId: messagesDesc.page1[0], segment: 100 }),
+      generateRawMessage({ messageId: messagesDesc.page1[1], segment: 99 }),
+      generateRawMessage({ messageId: messagesDesc.page1[2], segment: 98 }),
     ];
 
     const returnValue1Page2: Amity.RawMessage[] = [
-      generateRawMessage({ messageId: messages.page3[2], segment: 97 }),
-      generateRawMessage({ messageId: messages.page3[1], segment: 96 }),
-      generateRawMessage({ messageId: messages.page3[0], segment: 95 }),
+      generateRawMessage({ messageId: messagesDesc.page2[0], segment: 97 }),
+      generateRawMessage({ messageId: messagesDesc.page2[1], segment: 96 }),
+      generateRawMessage({ messageId: messagesDesc.page2[2], segment: 95 }),
     ];
 
+    // Value2 is for segmentAsc sorting
     const returnValue2Page1: Amity.RawMessage[] = [
       generateRawMessage({ messageId: messages.page1[0], segment: 1 }),
       generateRawMessage({ messageId: messages.page1[1], segment: 2 }),
@@ -977,42 +1015,46 @@ describe('getMessages', () => {
     ];
 
     const returnValue2Page2: Amity.RawMessage[] = [
-      generateRawMessage({ messageId: messages.page1[0], segment: 4 }),
-      generateRawMessage({ messageId: messages.page1[1], segment: 5 }),
-      generateRawMessage({ messageId: messages.page1[2], segment: 6 }),
+      generateRawMessage({ messageId: messages.page2[0], segment: 4 }),
+      generateRawMessage({ messageId: messages.page2[1], segment: 5 }),
+      generateRawMessage({ messageId: messages.page2[2], segment: 6 }),
     ];
 
     const returnValue2Page3: Amity.RawMessage[] = [
-      generateRawMessage({ messageId: messages.page1[0], segment: 7 }),
-      generateRawMessage({ messageId: messages.page1[1], segment: 8 }),
-      generateRawMessage({ messageId: messages.page1[2], segment: 9 }),
+      generateRawMessage({ messageId: messages.page3[0], segment: 7 }),
+      generateRawMessage({ messageId: messages.page3[1], segment: 8 }),
+      generateRawMessage({ messageId: messages.page3[2], segment: 9 }),
     ];
 
     const spyGet = jest.spyOn(client.http, 'get').mockImplementation((url: string, params) => {
       if (url !== '/api/v5/messages') return Promise.resolve();
+
+      // segmentDesc page#1
       if (params?.params?.options?.sortBy === 'segmentDesc') {
-        if (
-          params.params.options.token === 'eyJsaW1pdCI6MiwiYmVmb3JlIjo2MzQ3MTYxNDM5MTExMTAwMDAwMH0='
-        ) {
-          return Promise.resolve({
-            data: {
-              messages: returnValue1Page2,
-              paging: {
-                previous: 'eyJsaW1pdCI6MiwiYmVmb3JlIjo2MzQ3MTYxNDM5MTExMTAwMDAwMH0',
-              },
-            },
-          });
-        }
         return Promise.resolve({
           data: {
             messages: returnValue1Page1,
             paging: {
               previous: 'eyJsaW1pdCI6MiwiYmVmb3JlIjo2MzQ3MTYxNDM5MTExMTAwMDAwMH0',
-              next: 'eyJsaW1pdCI6MiwiYmVmb3JlIjo2MzQ3MTYxNDM5MTExMTAwMDAwMH0',
+              next: 'eyJsaW1pdCI6MywiYmVmb3JlIjoibWVzc2FnZUlkMTAxIn0=',
             },
           },
         });
       }
+
+      // segmentDesc page#2, option contains only token
+      if (params?.params?.options?.token === 'eyJsaW1pdCI6MywiYmVmb3JlIjoibWVzc2FnZUlkMTAxIn0=') {
+        return Promise.resolve({
+          data: {
+            messages: returnValue1Page2,
+            paging: {
+              previous: 'eyJsaW1pdCI6MiwiYmVmb3JlIjo2MzQ3MTYxNDM5MTExMTAwMDAwMH0',
+            },
+          },
+        });
+      }
+
+      // segmentAsc page#2
       if (
         params?.params?.options?.token ===
         'eyJsaW1pdCI6MiwiYmVmb3JlIjo2MzQ3MTYxNDM5MTExMTAwMDAwMH0='
@@ -1027,6 +1069,8 @@ describe('getMessages', () => {
           },
         });
       }
+
+      // segmentAsc page#3
       if (
         params?.params?.options?.token ===
         'eyJsaW1pdCI6MiwiYmVmb3JlIjo2MzQ3MTYxNDQ5MTExMTAwMDAwMH0='
@@ -1041,6 +1085,7 @@ describe('getMessages', () => {
         });
       }
 
+      // segmentAsc page#1
       return Promise.resolve({
         data: {
           messages: returnValue2Page1,
@@ -1052,14 +1097,14 @@ describe('getMessages', () => {
       });
     });
 
-    getMessages({ subChannelId, sortBy: 'segmentDesc' }, callback);
+    getMessages({ subChannelId, sortBy: 'segmentDesc', limit: 3 }, callback);
     getMessages({ subChannelId, sortBy: 'segmentAsc', limit: 3 }, callback2);
 
     expect(spyGet).toHaveBeenCalledWith('/api/v5/messages', {
       params: {
         isDeleted: false,
         messageFeedId: 'message-feed-id',
-        options: { sortBy: 'segmentDesc', token: 'eyJsaW1pdCI6NX0=' },
+        options: { sortBy: 'segmentDesc', limit: 3 },
       },
     });
 
@@ -1067,7 +1112,7 @@ describe('getMessages', () => {
       params: {
         isDeleted: false,
         messageFeedId: 'message-feed-id',
-        options: { sortBy: 'segmentAsc', token: 'eyJsaW1pdCI6M30=' },
+        options: { sortBy: 'segmentAsc', limit: 3 },
       },
     });
 
@@ -1091,7 +1136,7 @@ describe('getMessages', () => {
       }),
     );
 
-    // get more page for live collection #2
+    // ge more page for live collection #2
     callback2.mock.lastCall[0].onNextPage();
 
     await pause(100);
@@ -1100,9 +1145,11 @@ describe('getMessages', () => {
 
     await pause(100);
 
-    callback2.mock.lastCall[0].onNextPage();
-
-    await pause(100);
+    /**
+     * collection #1
+     * should contains 1 pages
+     * should call the callback function 2 times
+     */
 
     expect(callback.mock.calls.length).toBeGreaterThan(1);
     expect(callback).lastCalledWith(
@@ -1113,24 +1160,31 @@ describe('getMessages', () => {
       }),
     );
 
+    /**
+     * collection #2
+     * should contains 3 pages, because of 2 times calling onNextPage()
+     * should call the callback function 6 times
+     */
+
     expect(callback2.mock.calls.length).toBeGreaterThan(5);
     expect(callback2).lastCalledWith(
       expect.objectContaining({
-        data: returnValue2Page3.map(convertRawMessage),
+        data: [...returnValue2Page1, ...returnValue2Page2, ...returnValue2Page3].map(
+          convertRawMessage,
+        ),
         error: undefined,
         loading: false,
       }),
     );
 
     // get more page for live collection #1
-
     callback.mock.lastCall[0].onNextPage();
 
     await pause(100);
 
     expect(callback).lastCalledWith(
       expect.objectContaining({
-        data: returnValue1Page2.map(convertRawMessage),
+        data: [...returnValue1Page1, ...returnValue1Page2].map(convertRawMessage),
         error: undefined,
         loading: false,
       }),

package/src/messageRepository/utils/prepareMessagePayload.ts

@@ -9,6 +9,7 @@ import { getMessageReadCount } from './getMessageReadCount';
 import { MessageContentType } from '~/@types';
 import { convertFromRaw as convertSubChannelFromRaw } from '~/subChannelRepository/utils/convertSubChannelFromRaw';
 import { updateSubChannelCache } from '~/subChannelRepository/utils/updateSubChannelCache';
+import { COLLECTION_DEFAULT_PAGINATION_LIMIT } from '~/utils/constants';
 
 export function convertFromRaw(
   message: Amity.RawMessage,
@@ -137,14 +138,26 @@ type RawQueryMessages = Omit<
   /*
    * include deleted is for internal sdk use only. The server expects isDeleted
    */
-  'page' | 'sortBy' | 'subChannelId' | 'tags' | 'includeDeleted'
+  | 'page'
+  | 'sortBy'
+  | 'subChannelId'
+  | 'tags'
+  | 'includeDeleted'
+  | 'aroundMessageId'
+  | 'dataType'
+  | 'includingTags'
+  | 'excludingTags'
 > & {
-  includeTags?: Amity.QueryMessages['tags'];
+  includeTags?: Amity.QueryMessages['includingTags'];
+  excludeTags?: Amity.QueryMessages['excludingTags'];
   isDeleted?: Amity.Message['isDeleted'];
   messageFeedId: Amity.QueryMessages['subChannelId'];
+  dataType?: Amity.MessageContentType;
   options: {
     sortBy?: Amity.QueryMessages['sortBy'];
-    token: string;
+    token?: string;
+    limit?: number;
+    around?: Amity.Message['messageId'];
   };
 };
 
@@ -171,27 +184,43 @@ export function convertParams({
 }
 
 export function convertQueryParams({
-  page,
   sortBy,
   subChannelId,
   tags,
+  includingTags,
+  excludingTags,
   includeDeleted,
+  aroundMessageId,
+  limit,
+  type,
   ...rest
-}: Amity.QueryMessages): RawQueryMessages {
+}: Amity.MessagesLiveCollection): RawQueryMessages {
   const out: RawQueryMessages = {
     ...rest,
     messageFeedId: subChannelId,
     isDeleted: inferIsDeleted(includeDeleted),
-    options: { token: toToken(page || { limit: 10 }, 'afterbeforeraw')! },
+    options: {
+      sortBy,
+      limit: limit || COLLECTION_DEFAULT_PAGINATION_LIMIT,
+      around: aroundMessageId,
+    },
   };
 
-  if (sortBy !== undefined) {
-    out.options.sortBy = sortBy;
-  }
-
   if (tags) {
     out.includeTags = tags;
   }
 
+  if (includingTags) {
+    out.includeTags = includingTags;
+  }
+
+  if (type) {
+    out.dataType = type;
+  }
+
+  if (excludingTags) {
+    out.excludeTags = excludingTags;
+  }
+
   return out;
 }

package/src/userRepository/api/flagUser.ts

@@ -18,7 +18,7 @@ import { fireEvent } from '~/core/events';
  * @category User API
  * @async
  * */
-export const flagUser = async (userId: Amity.InternalUser['userId']): Promise<boolean> => {
+export const flagUser = async (userId: Amity.User['userId']): Promise<boolean> => {
   const client = getActiveClient();
   client.log('user/flagUser', userId);
 

package/src/userRepository/api/getUserByIds.ts

@@ -62,7 +62,7 @@ export const getUserByIds = async (
  */
 getUserByIds.locally = (
   userIds: Amity.User['userId'][],
-): Amity.Cached<Amity.InternalUser[]> | undefined => {
+): Amity.Cached<Amity.User[]> | undefined => {
   const client = getActiveClient();
   client.log('user/getUsers.locally', userIds);
 

package/src/userRepository/api/isUserFlaggedByMe.ts

@@ -16,7 +16,7 @@ import { synchronousWSCall } from '~/core/transports';
  * @category Report API
  * @async
  * */
-export const isUserFlaggedByMe = async (userId: Amity.InternalUser['userId']): Promise<boolean> => {
+export const isUserFlaggedByMe = async (userId: Amity.User['userId']): Promise<boolean> => {
   const client = getActiveClient();
   client.log('user/isUserFlaggedByMe', userId);
 

package/src/userRepository/api/queryBlockedUsers.ts

@@ -11,7 +11,7 @@ import { toPageRaw } from '~/core/query';
  * ```
  *
  * @param query The query parameters
- * @returns A page of {@link Amity.InternalUser} objects
+ * @returns A page of {@link Amity.User} objects
  *
  * @category Block API
  * @async
@@ -20,7 +20,7 @@ import { toPageRaw } from '~/core/query';
 export const queryBlockedUsers = async (
   query?: Amity.QueryBlockedUser,
 ): Promise<
-  Amity.Cached<Amity.Paged<Amity.InternalUser, Amity.PageRaw>> & {
+  Amity.Cached<Amity.Paged<Amity.User, Amity.PageRaw>> & {
     total: number;
   }
 > => {
@@ -66,11 +66,11 @@ export const queryBlockedUsers = async (
  * const { data: users } = queryBlockedUsers.locally({ page: 'page_token' })
  * ```
  *
- * Queries a paginable list of {@link Amity.InternalUser} objects from cache
+ * Queries a paginable list of {@link Amity.User} objects from cache
  * Search is performed by displayName such as `.startsWith(search)`
  *
  * @param query The query parameters
- * @returns A page of {@link Amity.InternalUser} objects
+ * @returns A page of {@link Amity.User} objects
  *
  * @category Block API
  */