@sendbird/uikit-chat-hooks 2.1.0 → 2.3.0

package/lib/typescript/src/model/CustomQuery.d.ts

@@ -1,5 +1,5 @@
 import type { CustomQueryInterface } from '../types';
-declare type ConstructorParams<T> = {
+type ConstructorParams<T> = {
     next: () => Promise<T[]>;
     isLoading: () => boolean;
     hasNext: () => boolean;

package/lib/typescript/src/types.d.ts

@@ -1,4 +1,4 @@
-import type { SendbirdChatSDK, SendbirdError, SendbirdFileMessage, SendbirdFileMessageCreateParams, SendbirdGroupChannel, SendbirdGroupChannelCollection, SendbirdGroupChannelListQuery, SendbirdMessage, SendbirdMessageCollection, SendbirdPreviousMessageListQuery, SendbirdUserMessage, SendbirdUserMessageCreateParams } from '@sendbird/uikit-utils';
+import type { SendbirdChatSDK, SendbirdError, SendbirdFileMessage, SendbirdFileMessageCreateParams, SendbirdGroupChannel, SendbirdGroupChannelCollection, SendbirdGroupChannelListQuery, SendbirdMessage, SendbirdMessageCollection, SendbirdPreviousMessageListQuery, SendbirdUserMessage, SendbirdUserMessageCreateParams, UserStruct } from '@sendbird/uikit-utils';
 export interface CustomQueryInterface<Data> {
     isLoading: boolean;
     next: () => Promise<Data[]>;
@@ -41,7 +41,7 @@ export interface UseGroupChannelList {
         next: () => Promise<void>;
     };
 }
-export declare type UseGroupChannelListOptions = {
+export type UseGroupChannelListOptions = {
     queryCreator?: () => SendbirdGroupChannelListQuery;
     collectionCreator?: () => SendbirdGroupChannelCollection;
     enableCollectionWithoutLocalCache?: boolean;
@@ -141,16 +141,13 @@ export interface UseGroupChannelMessages {
         deleteMessage: (message: SendbirdFileMessage | SendbirdUserMessage) => Promise<void>;
     };
 }
-export declare type UseGroupChannelMessagesOptions = {
+export type UseGroupChannelMessagesOptions = {
     sortComparator?: (a: SendbirdMessage, b: SendbirdMessage) => number;
     queryCreator?: () => SendbirdPreviousMessageListQuery;
     collectionCreator?: () => SendbirdMessageCollection;
     enableCollectionWithoutLocalCache?: boolean;
     onChannelDeleted?: () => void;
 };
-export interface UserStruct {
-    userId: string;
-}
 /**
  * @interface UseUserListReturn
  * @description interface for user list hook return value
@@ -191,7 +188,7 @@ export interface UseUserListReturn<User extends UserStruct> {
      * */
     next: () => Promise<void>;
 }
-export declare type UseUserListOptions<User extends UserStruct> = {
+export type UseUserListOptions<User extends UserStruct> = {
     sortComparator?: (a: User, b: User) => number;
     queryCreator?: () => CustomQueryInterface<User>;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sendbird/uikit-chat-hooks",
-  "version": "2.1.0",
+  "version": "2.3.0",
   "description": "React hooks that built with SendbirdChat SDK",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",
@@ -38,13 +38,13 @@
     "access": "public"
   },
   "dependencies": {
-    "@sendbird/uikit-utils": "2.1.0"
+    "@sendbird/uikit-utils": "2.3.0"
   },
   "devDependencies": {
     "@types/react": "*",
     "react": "^16.13.1",
     "react-native-builder-bob": "^0.18.0",
-    "typescript": "^4.1.3"
+    "typescript": "4.9.4"
   },
   "peerDependencies": {
     "@sendbird/chat": "^4.0.13",
@@ -69,5 +69,5 @@
     "readmeFile": "./README.md",
     "displayName": "@sendbird/uikit-chat-hooks"
   },
-  "gitHead": "c778a84a632487047fe532db188b32dfa6e93a7f"
+  "gitHead": "a9bf41fd7919436db99f6cc3bacd0f8d791b7729"
 }

package/src/channel/useGroupChannelMessages/reducer.ts

@@ -57,10 +57,6 @@ const defaultReducer = ({ ...draft }: State, action: Action) => {
           .forEach((m) => delete draft[key][m.reqId]);
       }
 
-      if (action.type === 'update_messages') {
-        draft['nextMessageMap'] = {};
-      }
-
       return draft;
     }
     case 'delete_messages':

package/src/channel/useGroupChannelMessages/useGroupChannelMessagesWithCollection.ts

@@ -48,11 +48,18 @@ export const useGroupChannelMessagesWithCollection: UseGroupChannelMessages = (s
     updateRefreshing,
   } = useGroupChannelMessagesReducer(userId, options?.sortComparator);
 
-  const channelMarkAs = async () => {
+  const channelMarkAsRead = async (source?: MessageEventSource) => {
     try {
-      await confirmAndMarkAsRead([channel]);
+      switch (source) {
+        case MessageEventSource.EVENT_MESSAGE_RECEIVED:
+        case MessageEventSource.EVENT_MESSAGE_SENT_SUCCESS:
+        case MessageEventSource.SYNC_MESSAGE_FILL:
+        case undefined:
+          await confirmAndMarkAsRead([channel]);
+          break;
+      }
     } catch (e) {
-      Logger.warn(`[${HOOK_NAME}/channelMarkAs/Read]`, e);
+      Logger.warn(`[${HOOK_NAME}/channelMarkAsRead]`, e);
     }
   };
 
@@ -63,20 +70,25 @@ export const useGroupChannelMessagesWithCollection: UseGroupChannelMessages = (s
       if (uid) {
         collectionRef.current = createMessageCollection(channel, options?.collectionCreator);
         updateNextMessages([], true, sdk.currentUser.userId);
-        channelMarkAs();
+        channelMarkAsRead();
 
         collectionRef.current?.setMessageCollectionHandler({
           onMessagesAdded: (_, __, messages) => {
-            switch (_.source) {
-              case MessageEventSource.EVENT_MESSAGE_RECEIVED:
-              case MessageEventSource.EVENT_MESSAGE_SENT_SUCCESS:
-              case MessageEventSource.SYNC_MESSAGE_FILL:
-                channelMarkAs();
-                break;
-            }
+            channelMarkAsRead(_.source);
             updateNextMessages(messages, false, sdk.currentUser.userId);
           },
           onMessagesUpdated: (_, __, messages) => {
+            channelMarkAsRead(_.source);
+
+            // NOTE: admin message is not added via onMessagesAdded handler, not checked yet is this a bug.
+            if (_.source === MessageEventSource.EVENT_MESSAGE_RECEIVED) {
+              const nextMessageIds = nextMessages.map((it) => it.messageId);
+              const nonAddedMessagesFromReceivedEvent = messages.filter(
+                (it) => nextMessageIds.indexOf(it.messageId) === -1,
+              );
+              updateNextMessages(nonAddedMessagesFromReceivedEvent, false, sdk.currentUser.userId);
+            }
+
             // NOTE: v4 MESSAGE_RECEIVED is called twice from onMessagesAdded and onMessagesUpdated when receiving new message.
             //  This is not intended behavior but not bugs.
             if (_.source !== MessageEventSource.EVENT_MESSAGE_RECEIVED) {

package/src/channel/useGroupChannelMessages/useGroupChannelMessagesWithQuery.ts

@@ -48,11 +48,11 @@ export const useGroupChannelMessagesWithQuery: UseGroupChannelMessages = (sdk, c
     updateRefreshing,
   } = useGroupChannelMessagesReducer(userId, options?.sortComparator);
 
-  const channelMarkAs = async () => {
+  const channelMarkAsRead = async () => {
     try {
       await confirmAndMarkAsRead([channel]);
     } catch (e) {
-      Logger.warn(`[${HOOK_NAME}/channelMarkAs/Read]`, e);
+      Logger.warn(`[${HOOK_NAME}/channelMarkAsRead]`, e);
     }
   };
 
@@ -60,7 +60,7 @@ export const useGroupChannelMessagesWithQuery: UseGroupChannelMessages = (sdk, c
     async (uid?: string) => {
       if (uid) {
         queryRef.current = createMessageQuery(channel, options?.queryCreator);
-        channelMarkAs().catch();
+        channelMarkAsRead().catch();
         if (queryRef.current?.hasNext) {
           const list = await queryRef.current?.load();
           updateMessages(list, true, sdk.currentUser.userId);
@@ -81,7 +81,7 @@ export const useGroupChannelMessagesWithQuery: UseGroupChannelMessages = (sdk, c
     // Messages
     onMessageReceived(eventChannel, message) {
       if (isDifferentChannel(channel, eventChannel)) return;
-      channelMarkAs();
+      channelMarkAsRead();
       updateNextMessages([message], false, sdk.currentUser.userId);
     },
     onMessageUpdated(eventChannel, message) {
@@ -219,8 +219,6 @@ export const useGroupChannelMessagesWithQuery: UseGroupChannelMessages = (sdk, c
     async (failedMessage) => {
       const message = await (() => {
         if (failedMessage.isUserMessage()) return channel.resendUserMessage(failedMessage);
-        // FIXME: v4 bugs
-        // @ts-ignore
         if (failedMessage.isFileMessage()) return channel.resendFileMessage(failedMessage);
         return null;
       })();

package/src/common/useTotalUnreadChannelCount.ts

@@ -1,7 +1,7 @@
 import { useState } from 'react';
 
 import type { SendbirdChatSDK } from '@sendbird/uikit-utils';
-import { truncatedBadgeCount, useAsyncEffect } from '@sendbird/uikit-utils';
+import { truncatedCount, useAsyncEffect } from '@sendbird/uikit-utils';
 import { useUniqId } from '@sendbird/uikit-utils';
 
 import { useUserEventHandler } from '../handler/useUserEventHandler';
@@ -24,5 +24,5 @@ export const useTotalUnreadChannelCount = (sdk: SendbirdChatSDK, params?: Params
     },
   });
 
-  return truncatedBadgeCount(unreadChannelCount, params?.maxCount);
+  return truncatedCount(unreadChannelCount, params?.maxCount);
 };

package/src/common/useTotalUnreadMessageCount.ts

@@ -2,7 +2,7 @@ import { useState } from 'react';
 
 import { SuperChannelFilter, TotalUnreadMessageCountParams } from '@sendbird/chat/groupChannel';
 import type { SendbirdChatSDK } from '@sendbird/uikit-utils';
-import { truncatedBadgeCount, useAsyncEffect, useUniqId } from '@sendbird/uikit-utils';
+import { truncatedCount, useAsyncEffect, useUniqId } from '@sendbird/uikit-utils';
 
 import { useUserEventHandler } from '../handler/useUserEventHandler';
 
@@ -28,5 +28,5 @@ export const useTotalUnreadMessageCount = (sdk: SendbirdChatSDK, options?: Optio
     onTotalUnreadMessageCountUpdated: (totalCount: number) => setUnreadMessageCount(totalCount),
   });
 
-  return truncatedBadgeCount(unreadMessageCount, options?.maxCount);
+  return truncatedCount(unreadMessageCount, options?.maxCount);
 };

package/src/common/useUserList.ts

@@ -1,9 +1,9 @@
 import { useMemo, useRef, useState } from 'react';
 
-import type { Optional, SendbirdChatSDK, SendbirdUser } from '@sendbird/uikit-utils';
+import type { Optional, SendbirdChatSDK, SendbirdUser, UserStruct } from '@sendbird/uikit-utils';
 import { Logger, SBErrorCode, SBErrorMessage, useAsyncEffect, useFreshCallback } from '@sendbird/uikit-utils';
 
-import type { CustomQueryInterface, UseUserListOptions, UseUserListReturn, UserStruct } from '../types';
+import type { CustomQueryInterface, UseUserListOptions, UseUserListReturn } from '../types';
 
 const createUserQuery = <User extends UserStruct>(
   sdk: SendbirdChatSDK,
@@ -83,10 +83,10 @@ export const useUserList = <
   const init = useFreshCallback(async () => {
     query.current = createUserQuery<QueriedUser>(sdk, options?.queryCreator);
     if (query.current?.hasNext) {
-      const users = await query.current?.next().catch((err) => {
-        Logger.error(error);
-        if (err.code === SBErrorCode.NON_AUTHORIZED) Logger.warn(SBErrorMessage.ACL);
-        throw error;
+      const users = await query.current?.next().catch((e) => {
+        Logger.error(e);
+        if (e.code === SBErrorCode.NON_AUTHORIZED) Logger.warn(SBErrorMessage.ACL);
+        throw e;
       });
       updateUsers(users, true);
     }
@@ -118,10 +118,10 @@ export const useUserList = <
 
   const next = useFreshCallback(async () => {
     if (query.current && query.current?.hasNext) {
-      const nextUsers = await query.current.next().catch((err) => {
-        Logger.error(error);
-        if (err.code === SBErrorCode.NON_AUTHORIZED) Logger.warn(SBErrorMessage.ACL);
-        throw error;
+      const nextUsers = await query.current.next().catch((e) => {
+        Logger.error(e);
+        if (e.code === SBErrorCode.NON_AUTHORIZED) Logger.warn(SBErrorMessage.ACL);
+        throw e;
       });
       updateUsers(nextUsers, false);
     }

package/src/index.ts

@@ -21,7 +21,6 @@ export type {
   UseGroupChannelListOptions,
   UseGroupChannelMessages,
   UseGroupChannelMessagesOptions,
-  UserStruct,
   UseUserListOptions,
   UseUserListReturn,
   CustomQueryInterface,

package/src/types.ts

@@ -11,6 +11,7 @@ import type {
   SendbirdPreviousMessageListQuery,
   SendbirdUserMessage,
   SendbirdUserMessageCreateParams,
+  UserStruct,
 } from '@sendbird/uikit-utils';
 
 export interface CustomQueryInterface<Data> {
@@ -189,10 +190,6 @@ export type UseGroupChannelMessagesOptions = {
   onChannelDeleted?: () => void;
 };
 
-export interface UserStruct {
-  userId: string;
-}
-
 /**
  * @interface UseUserListReturn
  * @description interface for user list hook return value