@sendbird/uikit-chat-hooks 1.1.2 → 2.0.0-rc.0

package/lib/typescript/src/channel/useGroupChannelMessages/reducer.d.ts

@@ -1,4 +1,4 @@
-import type { SendbirdBaseMessage, SendbirdMessage } from '@sendbird/uikit-utils';
+import type { SendbirdBaseMessage } from '@sendbird/uikit-utils';
 import type { UseGroupChannelMessagesOptions } from '../../types';
 export declare const useGroupChannelMessagesReducer: (userId?: string, sortComparator?: UseGroupChannelMessagesOptions['sortComparator']) => {
     updateLoading: (status: boolean) => void;
@@ -9,7 +9,7 @@ export declare const useGroupChannelMessagesReducer: (userId?: string, sortCompa
     deleteNextMessages: (messageIds: number[], reqIds: string[]) => void;
     loading: boolean;
     refreshing: boolean;
-    messages: SendbirdMessage[];
-    nextMessages: SendbirdMessage[];
-    newMessagesFromMembers: SendbirdMessage[];
+    messages: import("@sendbird/chat/message").BaseMessage[];
+    nextMessages: import("@sendbird/chat/message").BaseMessage[];
+    newMessagesFromMembers: import("@sendbird/chat/message").BaseMessage[];
 };

package/lib/typescript/src/common/useMessageOutgoingStatus.d.ts

@@ -1,3 +1,3 @@
-import type { SendbirdAdminMessage, SendbirdChatSDK, SendbirdFileMessage, SendbirdGroupChannel, SendbirdUserMessage } from '@sendbird/uikit-utils';
+import type { SendbirdChatSDK, SendbirdGroupChannel, SendbirdMessage } from '@sendbird/uikit-utils';
 export declare type SBUOutgoingStatus = 'NONE' | 'PENDING' | 'FAILED' | 'UNDELIVERED' | 'DELIVERED' | 'UNREAD' | 'READ';
-export declare const useMessageOutgoingStatus: (sdk: SendbirdChatSDK, channel: SendbirdGroupChannel, message?: SendbirdFileMessage | SendbirdUserMessage | SendbirdAdminMessage | null) => SBUOutgoingStatus;
+export declare const useMessageOutgoingStatus: (sdk: SendbirdChatSDK, channel: SendbirdGroupChannel, message?: SendbirdMessage | null) => SBUOutgoingStatus;

package/lib/typescript/src/common/usePushTrigger.d.ts

@@ -1,7 +1,13 @@
+import { PushTriggerOption } from '@sendbird/chat';
 import type { SendbirdChatSDK } from '@sendbird/uikit-utils';
-declare type PushTriggerOptionType = 'all' | 'mention_only' | 'off';
+declare const PushTriggerMap: {
+    all: PushTriggerOption;
+    mention_only: PushTriggerOption;
+    off: PushTriggerOption;
+    default: PushTriggerOption;
+};
 export declare const usePushTrigger: (sdk: SendbirdChatSDK) => {
-    option: PushTriggerOptionType;
-    updateOption: (value: PushTriggerOptionType) => Promise<void>;
+    option: PushTriggerOption;
+    updateOption: (value: keyof typeof PushTriggerMap) => Promise<void>;
 };
 export {};

package/lib/typescript/src/common/useTotalUnreadMessageCount.d.ts

@@ -1,8 +1,8 @@
-import type Sendbird from 'sendbird';
+import { TotalUnreadMessageCountParams } from '@sendbird/chat/groupChannel';
 import type { SendbirdChatSDK } from '@sendbird/uikit-utils';
-declare type Params = {
-    paramCreator?: () => Sendbird.GroupChannelTotalUnreadMessageCountParams;
+declare type Options = {
+    params?: TotalUnreadMessageCountParams;
     maxCount?: number;
 };
-export declare const useTotalUnreadMessageCount: (sdk: SendbirdChatSDK, params?: Params) => string;
+export declare const useTotalUnreadMessageCount: (sdk: SendbirdChatSDK, options?: Options) => string;
 export {};

package/lib/typescript/src/common/useUserList.d.ts

@@ -21,4 +21,4 @@ import type { CustomQueryInterface, UseUserListOptions, UseUserListReturn } from
  *  })
  * ```
  * */
-export declare const useUserList: <Options extends UseUserListOptions<QueriedUser>, QueriedUser = Options["queryCreator"] extends Optional<() => CustomQueryInterface<infer User>> ? User : import("sendbird").User>(sdk: SendbirdChatSDK, options?: Options | undefined) => UseUserListReturn<QueriedUser>;
+export declare const useUserList: <Options extends UseUserListOptions<QueriedUser>, QueriedUser = Options["queryCreator"] extends Optional<() => CustomQueryInterface<infer User>> ? User : import("@sendbird/chat").User>(sdk: SendbirdChatSDK, options?: Options | undefined) => UseUserListReturn<QueriedUser>;

package/lib/typescript/src/handler/useChannelHandler.d.ts

@@ -1,3 +1,3 @@
-import type Sendbird from 'sendbird';
+import { GroupChannelHandler } from '@sendbird/chat/groupChannel';
 import { SendbirdChatSDK } from '@sendbird/uikit-utils';
-export declare const useChannelHandler: (sdk: SendbirdChatSDK, handlerId: string, hookHandler: Partial<Sendbird.ChannelHandler>) => void;
+export declare const useChannelHandler: (sdk: SendbirdChatSDK, handlerId: string, hookHandler: Partial<GroupChannelHandler>) => void;

package/lib/typescript/src/handler/useConnectionHandler.d.ts

@@ -1,4 +1,4 @@
 import React from 'react';
-import type Sendbird from 'sendbird';
+import { ConnectionHandler } from '@sendbird/chat';
 import { SendbirdChatSDK } from '@sendbird/uikit-utils';
-export declare const useConnectionHandler: (sdk: SendbirdChatSDK, handlerId: string, hookHandler: Partial<Sendbird.ConnectionHandler>, deps?: React.DependencyList) => void;
+export declare const useConnectionHandler: (sdk: SendbirdChatSDK, handlerId: string, hookHandler: Partial<ConnectionHandler>, deps?: React.DependencyList) => void;

package/lib/typescript/src/handler/useUserEventHandler.d.ts

@@ -1,4 +1,3 @@
-import React from 'react';
-import type Sendbird from 'sendbird';
+import { UserEventHandler } from '@sendbird/chat';
 import type { SendbirdChatSDK } from '@sendbird/uikit-utils';
-export declare const useUserEventHandler: (sdk: SendbirdChatSDK, handlerId: string, hookHandler: Partial<Sendbird.UserEventHandler>, deps?: React.DependencyList) => void;
+export declare const useUserEventHandler: (sdk: SendbirdChatSDK, handlerId: string, hookHandler: Partial<UserEventHandler>) => void;

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

@@ -1,5 +1,4 @@
-import type Sendbird from 'sendbird';
-import type { SendbirdChatSDK, SendbirdError, SendbirdFileMessage, SendbirdFileMessageParams, SendbirdGroupChannel, SendbirdGroupChannelCollection, SendbirdMessage, SendbirdMessageCollection, SendbirdUserMessage, SendbirdUserMessageParams } from '@sendbird/uikit-utils';
+import type { SendbirdChatSDK, SendbirdError, SendbirdFileMessage, SendbirdFileMessageCreateParams, SendbirdGroupChannel, SendbirdGroupChannelCollection, SendbirdGroupChannelListQuery, SendbirdMessage, SendbirdMessageCollection, SendbirdPreviousMessageListQuery, SendbirdUserMessage, SendbirdUserMessageCreateParams } from '@sendbird/uikit-utils';
 export interface CustomQueryInterface<Data> {
     isLoading: boolean;
     next: () => Promise<Data[]>;
@@ -43,7 +42,7 @@ export interface UseGroupChannelList {
     };
 }
 export declare type UseGroupChannelListOptions = {
-    queryCreator?: () => Sendbird.GroupChannelListQuery;
+    queryCreator?: () => SendbirdGroupChannelListQuery;
     collectionCreator?: () => SendbirdGroupChannelCollection;
     enableCollectionWithoutLocalCache?: boolean;
 };
@@ -106,28 +105,28 @@ export interface UseGroupChannelMessages {
          * @param callback sent message callback
          * @return pending message
          * */
-        sendFileMessage: (params: SendbirdFileMessageParams, onPending?: (message: SendbirdFileMessage, error?: SendbirdError) => void) => Promise<SendbirdFileMessage>;
+        sendFileMessage: (params: SendbirdFileMessageCreateParams, onPending?: (message: SendbirdFileMessage, error?: SendbirdError) => void) => Promise<SendbirdFileMessage>;
         /**
          * Send user message
          * @param params user message params
          * @param callback sent message callback
          * @return pending message
          * */
-        sendUserMessage: (params: SendbirdUserMessageParams, onPending?: (message: SendbirdUserMessage, error?: SendbirdError) => void) => Promise<SendbirdUserMessage>;
+        sendUserMessage: (params: SendbirdUserMessageCreateParams, onPending?: (message: SendbirdUserMessage, error?: SendbirdError) => void) => Promise<SendbirdUserMessage>;
         /**
          * Update file message
          * @param messageId
          * @param params file message params
          * @return updated message
          * */
-        updateFileMessage: (messageId: number, params: SendbirdFileMessageParams) => Promise<SendbirdFileMessage>;
+        updateFileMessage: (messageId: number, params: SendbirdFileMessageCreateParams) => Promise<SendbirdFileMessage>;
         /**
          * Update user message
          * @param messageId
          * @param params user message params
          * @return updated message
          * */
-        updateUserMessage: (messageId: number, params: SendbirdUserMessageParams) => Promise<SendbirdUserMessage>;
+        updateUserMessage: (messageId: number, params: SendbirdUserMessageCreateParams) => Promise<SendbirdUserMessage>;
         /**
          * Resend failed message
          * @param failedMessage failed message to resend
@@ -148,7 +147,7 @@ export interface UseGroupChannelMessages {
 }
 export declare type UseGroupChannelMessagesOptions = {
     sortComparator?: (a: SendbirdMessage, b: SendbirdMessage) => number;
-    queryCreator?: () => Sendbird.PreviousMessageListQuery;
+    queryCreator?: () => SendbirdPreviousMessageListQuery;
     collectionCreator?: () => SendbirdMessageCollection;
     enableCollectionWithoutLocalCache?: boolean;
     onChannelDeleted?: () => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sendbird/uikit-chat-hooks",
-  "version": "1.1.2",
+  "version": "2.0.0-rc.0",
   "description": "React hooks that built with SendbirdChat SDK",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",
@@ -38,7 +38,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@sendbird/uikit-utils": "1.1.2"
+    "@sendbird/uikit-utils": "2.0.0-rc.0"
   },
   "devDependencies": {
     "@types/react": "*",
@@ -47,8 +47,8 @@
     "typescript": "^4.1.3"
   },
   "peerDependencies": {
-    "react": ">=16.13.1",
-    "sendbird": "^3.1.22"
+    "@sendbird/chat": "^4.0.13",
+    "react": ">=16.13.1"
   },
   "react-native-builder-bob": {
     "source": "src",
@@ -69,5 +69,5 @@
     "readmeFile": "./README.md",
     "displayName": "@sendbird/uikit-chat-hooks"
   },
-  "gitHead": "3bfe51786e73bedc419116e447b79d6b57f9178c"
+  "gitHead": "394d5e3e259086c2226a24406462f119d4af9860"
 }

package/src/channel/useActiveGroupChannel.ts

@@ -6,7 +6,7 @@ export const useActiveGroupChannel = (sdk: SendbirdChatSDK, staleChannel: Sendbi
   const [activeChannel, setActiveChannel] = useState(() => staleChannel);
 
   useEffect(() => {
-    sdk.GroupChannel.getChannel(staleChannel.url).then(setActiveChannel);
+    sdk.groupChannel.getChannel(staleChannel.url).then(setActiveChannel);
   }, [staleChannel.url]);
 
   return { activeChannel, setActiveChannel };

package/src/channel/useGroupChannelList/index.ts

@@ -1,9 +1,12 @@
+import { Logger } from '@sendbird/uikit-utils';
+
 import type { UseGroupChannelList } from '../../types';
 import { useGroupChannelListWithCollection } from './useGroupChannelListWithCollection';
 import { useGroupChannelListWithQuery } from './useGroupChannelListWithQuery';
 
 export const useGroupChannelList: UseGroupChannelList = (sdk, userId, options) => {
   if (sdk.isCacheEnabled || options?.enableCollectionWithoutLocalCache) {
+    if (options?.queryCreator) Logger.warn('`queryCreator` is ignored, please use `collectionCreator` instead.');
     return useGroupChannelListWithCollection(sdk, userId, options);
   } else {
     return useGroupChannelListWithQuery(sdk, userId, options);

package/src/channel/useGroupChannelList/useGroupChannelListWithCollection.ts

@@ -1,7 +1,8 @@
 import { useEffect, useRef } from 'react';
 
+import { GroupChannelFilter, GroupChannelListOrder } from '@sendbird/chat/groupChannel';
 import type { SendbirdChatSDK, SendbirdGroupChannelCollection } from '@sendbird/uikit-utils';
-import { useAsyncEffect, useFreshCallback, useUniqId } from '@sendbird/uikit-utils';
+import { confirmAndMarkAsDelivered, useAsyncEffect, useFreshCallback, useUniqId } from '@sendbird/uikit-utils';
 
 import { useAppFeatures } from '../../common/useAppFeatures';
 import { useChannelHandler } from '../../handler/useChannelHandler';
@@ -17,20 +18,14 @@ const createGroupChannelListCollection = (
   const passedCollection = collectionCreator?.();
   if (passedCollection) return passedCollection;
 
-  const defaultOptions = {
-    includeEmpty: false,
+  const filter = new GroupChannelFilter();
+  filter.includeEmpty = false;
+
+  return sdk.groupChannel.createGroupChannelCollection({
+    filter,
     limit: 20,
-    order: sdk.GroupChannelCollection.GroupChannelOrder.LATEST_LAST_MESSAGE,
-  };
-  const collectionBuilder = sdk.GroupChannel.createGroupChannelCollection();
-  const groupChannelFilter = new sdk.GroupChannelFilter();
-  groupChannelFilter.includeEmpty = defaultOptions.includeEmpty;
-
-  return collectionBuilder
-    .setFilter(groupChannelFilter)
-    .setLimit(defaultOptions.limit)
-    .setOrder(defaultOptions.order)
-    .build();
+    order: GroupChannelListOrder.LATEST_LAST_MESSAGE,
+  });
 };
 
 export const useGroupChannelListWithCollection: UseGroupChannelList = (sdk, userId, options) => {
@@ -43,9 +38,11 @@ export const useGroupChannelListWithCollection: UseGroupChannelList = (sdk, user
     useGroupChannelListReducer();
 
   const updateChannelsAndMarkAsDelivered = (markAsDelivered: boolean) => {
-    const channels = collectionRef.current?.channelList ?? [];
+    const channels = collectionRef.current?.channels ?? [];
     setChannels(channels, true);
-    if (markAsDelivered && deliveryReceiptEnabled) channels.forEach((channel) => sdk.markAsDelivered(channel.url));
+    if (markAsDelivered && deliveryReceiptEnabled) {
+      channels.forEach((channel) => confirmAndMarkAsDelivered(sdk, channel));
+    }
   };
 
   const init = useFreshCallback(async (uid?: string) => {
@@ -54,22 +51,22 @@ export const useGroupChannelListWithCollection: UseGroupChannelList = (sdk, user
     if (uid) {
       collectionRef.current = createGroupChannelListCollection(sdk, options?.collectionCreator);
 
-      if (collectionRef.current?.hasMore) {
-        await collectionRef.current?.loadMore();
-        updateChannelsAndMarkAsDelivered(true);
-      }
-
       collectionRef.current?.setGroupChannelCollectionHandler({
-        onChannelsAdded() {
+        onChannelsAdded: () => {
           updateChannelsAndMarkAsDelivered(true);
         },
-        onChannelsUpdated() {
+        onChannelsUpdated: () => {
           updateChannelsAndMarkAsDelivered(true);
         },
-        onChannelsDeleted() {
+        onChannelsDeleted: () => {
           updateChannelsAndMarkAsDelivered(false);
         },
       });
+
+      if (collectionRef.current?.hasMore) {
+        await collectionRef.current?.loadMore();
+        updateChannelsAndMarkAsDelivered(true);
+      }
     }
   });
 

package/src/channel/useGroupChannelList/useGroupChannelListWithQuery.ts

@@ -1,8 +1,8 @@
 import { useRef } from 'react';
-import type Sendbird from 'sendbird';
 
-import type { SendbirdChannel, SendbirdChatSDK } from '@sendbird/uikit-utils';
-import { useAsyncEffect, useFreshCallback } from '@sendbird/uikit-utils';
+import { GroupChannelListOrder } from '@sendbird/chat/groupChannel';
+import type { SendbirdChannel, SendbirdChatSDK, SendbirdGroupChannelListQuery } from '@sendbird/uikit-utils';
+import { confirmAndMarkAsDelivered, useAsyncEffect, useFreshCallback } from '@sendbird/uikit-utils';
 
 import { useAppFeatures } from '../../common/useAppFeatures';
 import { useChannelHandler } from '../../handler/useChannelHandler';
@@ -18,21 +18,16 @@ const createGroupChannelListQuery = (
   const passedQuery = queryCreator?.();
   if (passedQuery) return passedQuery;
 
-  const defaultOptions = {
+  return sdk.groupChannel.createMyGroupChannelListQuery({
     includeEmpty: false,
     limit: 20,
-    order: 'latest_last_message',
-  } as const;
-  const defaultQuery = sdk.GroupChannel.createMyGroupChannelListQuery();
-  defaultQuery.limit = defaultOptions.limit;
-  defaultQuery.order = defaultOptions.order;
-  defaultQuery.includeEmpty = defaultOptions.includeEmpty;
-  return defaultQuery;
+    order: GroupChannelListOrder.LATEST_LAST_MESSAGE,
+  });
 };
 
 export const useGroupChannelListWithQuery: UseGroupChannelList = (sdk, userId, options) => {
   const { deliveryReceiptEnabled } = useAppFeatures(sdk);
-  const queryRef = useRef<Sendbird.GroupChannelListQuery>();
+  const queryRef = useRef<SendbirdGroupChannelListQuery>();
 
   const {
     loading,
@@ -48,7 +43,7 @@ export const useGroupChannelListWithQuery: UseGroupChannelList = (sdk, userId, o
 
   const updateChannelsAndMarkAsDelivered = (channels: SendbirdChannel[]) => {
     updateChannels(channels);
-    if (deliveryReceiptEnabled) channels.forEach((channel) => sdk.markAsDelivered(channel.url));
+    if (deliveryReceiptEnabled) channels.forEach((channel) => confirmAndMarkAsDelivered(sdk, channel));
   };
 
   const init = useFreshCallback(async (uid?: string) => {
@@ -60,7 +55,7 @@ export const useGroupChannelListWithQuery: UseGroupChannelList = (sdk, userId, o
         const channels = await queryRef.current.next();
 
         setChannels(channels, true);
-        if (deliveryReceiptEnabled) channels.forEach((channel) => sdk.markAsDelivered(channel.url));
+        if (deliveryReceiptEnabled) channels.forEach((channel) => confirmAndMarkAsDelivered(sdk, channel));
       }
     }
   });
@@ -100,7 +95,7 @@ export const useGroupChannelListWithQuery: UseGroupChannelList = (sdk, userId, o
     if (queryRef.current?.hasNext) {
       const channels = await queryRef.current.next();
       setChannels(channels, false);
-      if (deliveryReceiptEnabled) channels.forEach((channel) => sdk.markAsDelivered(channel.url));
+      if (deliveryReceiptEnabled) channels.forEach((channel) => confirmAndMarkAsDelivered(sdk, channel));
     }
   });
 

package/src/channel/useGroupChannelMessages/index.ts

@@ -1,9 +1,12 @@
+import { Logger } from '@sendbird/uikit-utils';
+
 import type { UseGroupChannelMessages } from '../../types';
 import { useGroupChannelMessagesWithCollection } from './useGroupChannelMessagesWithCollection';
 import { useGroupChannelMessagesWithQuery } from './useGroupChannelMessagesWithQuery';
 
 export const useGroupChannelMessages: UseGroupChannelMessages = (sdk, channel, userId, options) => {
   if (sdk.isCacheEnabled || options?.enableCollectionWithoutLocalCache) {
+    if (options?.queryCreator) Logger.warn('`queryCreator` is ignored, please use `collectionCreator` instead.');
     return useGroupChannelMessagesWithCollection(sdk, channel, userId, options);
   } else {
     return useGroupChannelMessagesWithQuery(sdk, channel, userId, options);

package/src/channel/useGroupChannelMessages/reducer.ts

@@ -1,11 +1,6 @@
 import { useReducer } from 'react';
 
-import type {
-  SendbirdBaseMessage,
-  SendbirdFileMessage,
-  SendbirdMessage,
-  SendbirdUserMessage,
-} from '@sendbird/uikit-utils';
+import type { SendbirdBaseMessage, SendbirdFileMessage, SendbirdUserMessage } from '@sendbird/uikit-utils';
 import { arrayToMapWithGetter, getMessageUniqId, isMyMessage, isNewMessage, useIIFE } from '@sendbird/uikit-utils';
 
 import type { UseGroupChannelMessagesOptions } from '../../types';
@@ -27,8 +22,8 @@ type Action =
 type State = {
   loading: boolean;
   refreshing: boolean;
-  messageMap: Record<string, SendbirdMessage>;
-  nextMessageMap: Record<string, SendbirdMessage>;
+  messageMap: Record<string, SendbirdBaseMessage>;
+  nextMessageMap: Record<string, SendbirdBaseMessage>;
 };
 
 const defaultReducer = ({ ...draft }: State, action: Action) => {
@@ -42,7 +37,7 @@ const defaultReducer = ({ ...draft }: State, action: Action) => {
     }
     case 'update_messages':
     case 'update_next_messages': {
-      const key = action.type === 'update_messages' ? 'messageMap' : 'nextMessageMap';
+      const key = action.type === 'update_messages' ? 'messageMap' : ('nextMessageMap' as const);
       const messageMap = arrayToMapWithGetter(action.value.messages, getMessageUniqId);
       if (action.value.clearPrev) {
         draft[key] = messageMap;