@sendbird/uikit-chat-hooks 2.3.0 → 2.4.0

package/src/types.ts

@@ -3,14 +3,18 @@ import type {
   SendbirdError,
   SendbirdFileMessage,
   SendbirdFileMessageCreateParams,
+  SendbirdFileMessageUpdateParams,
   SendbirdGroupChannel,
   SendbirdGroupChannelCollection,
   SendbirdGroupChannelListQuery,
   SendbirdMessage,
   SendbirdMessageCollection,
+  SendbirdOpenChannel,
+  SendbirdOpenChannelListQuery,
   SendbirdPreviousMessageListQuery,
   SendbirdUserMessage,
   SendbirdUserMessageCreateParams,
+  SendbirdUserMessageUpdateParams,
   UserStruct,
 } from '@sendbird/uikit-utils';
 
@@ -156,7 +160,7 @@ export interface UseGroupChannelMessages {
      * @param params file message params
      * @return updated message
      * */
-    updateFileMessage: (messageId: number, params: SendbirdFileMessageCreateParams) => Promise<SendbirdFileMessage>;
+    updateFileMessage: (messageId: number, params: SendbirdFileMessageUpdateParams) => Promise<SendbirdFileMessage>;
 
     /**
      * Update user message
@@ -164,7 +168,7 @@ export interface UseGroupChannelMessages {
      * @param params user message params
      * @return updated message
      * */
-    updateUserMessage: (messageId: number, params: SendbirdUserMessageCreateParams) => Promise<SendbirdUserMessage>;
+    updateUserMessage: (messageId: number, params: SendbirdUserMessageUpdateParams) => Promise<SendbirdUserMessage>;
 
     /**
      * Resend failed message
@@ -190,6 +194,171 @@ export type UseGroupChannelMessagesOptions = {
   onChannelDeleted?: () => void;
 };
 
+/**
+ * @interface UseOpenChannelList
+ * @description interface for open channel list hook
+ * */
+export interface UseOpenChannelList {
+  (sdk: SendbirdChatSDK, userId?: string, options?: UseOpenChannelListOptions): {
+    /**
+     * Loading state, only available on first render
+     * */
+    loading: boolean;
+
+    /**
+     * Refreshing state, status is changes when the refresh is called.
+     * */
+    refreshing: boolean;
+
+    /**
+     * Refresh, clear and reload messages from latest
+     * @return {Promise<void>}
+     * */
+    refresh: () => Promise<void>;
+
+    /**
+     * Error state
+     * */
+    error: unknown | null;
+
+    /**
+     * Get open channels state
+     * */
+    openChannels: SendbirdOpenChannel[];
+
+    /**
+     * Fetch next channels to state
+     * @return {Promise<void>}
+     * */
+    next: () => Promise<void>;
+  };
+}
+export type UseOpenChannelListOptions = {
+  queryCreator?: () => SendbirdOpenChannelListQuery;
+};
+
+/**
+ * @interface UseOpenChannelMessages
+ * @description interface for open channel messages hook
+ * - Receive new messages from other users -> append to state(nextMessages)
+ * - onTopReached -> prev() -> fetch prev messages and append to state(messages)
+ * - onBottomReached -> next() -> nextMessages append to state(messages)
+ * */
+export interface UseOpenChannelMessages {
+  (sdk: SendbirdChatSDK, channel: SendbirdOpenChannel, userId?: string, options?: UseOpenChannelMessagesOptions): {
+    /**
+     * Loading state, only available on first render
+     * */
+    loading: boolean;
+
+    /**
+     * Refreshing state, status is changes when the refresh is called.
+     * */
+    refreshing: boolean;
+
+    /**
+     * Refresh, clear and reload messages from latest
+     * @return {Promise<void>}
+     * */
+    refresh: () => Promise<void>;
+
+    /**
+     * Get messages, this state is for render
+     * For example, if a user receives a new messages while searching for an old message
+     * for this case, new messages will be included here.
+     * @return {SendbirdMessage[]}
+     * */
+    messages: SendbirdMessage[];
+
+    /**
+     * Fetch prev messages to state
+     * @return {Promise<void>}
+     * */
+    prev: () => Promise<void>;
+
+    /**
+     * Get messages, this state is for temporary data before render
+     * For example, if a user receives a new messages while searching for an old message
+     * for this case, new messages will be included here.
+     * */
+    nextMessages: SendbirdMessage[];
+
+    /**
+     * Get new messages from nextMessages
+     * A new message means a message that meets the below conditions
+     * - Not admin message
+     * - Not updated message
+     * - Not current user's message
+     * */
+    newMessagesFromMembers: SendbirdMessage[];
+
+    /**
+     * Fetch next messages to state
+     * @return {Promise<void>}
+     * */
+    next: () => Promise<void>;
+
+    /**
+     * Send file message
+     * @param params file message params
+     * @param callback sent message callback
+     * @return pending message
+     * */
+    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: 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: SendbirdFileMessageUpdateParams) => Promise<SendbirdFileMessage>;
+
+    /**
+     * Update user message
+     * @param messageId
+     * @param params user message params
+     * @return updated message
+     * */
+    updateUserMessage: (messageId: number, params: SendbirdUserMessageUpdateParams) => Promise<SendbirdUserMessage>;
+
+    /**
+     * Resend failed message
+     * @param failedMessage failed message to resend
+     * @return {Promise<void>}
+     * */
+    resendMessage: (failedMessage: SendbirdFileMessage | SendbirdUserMessage) => Promise<void>;
+
+    /**
+     * Delete message
+     * @param message sent or failed message
+     * @return {Promise<void>}
+     * */
+    deleteMessage: (message: SendbirdFileMessage | SendbirdUserMessage) => Promise<void>;
+  };
+}
+
+export type UseOpenChannelMessagesOptions = {
+  sortComparator?: (a: SendbirdMessage, b: SendbirdMessage) => number;
+  queryCreator?: () => SendbirdPreviousMessageListQuery;
+  onChannelDeleted?: () => void;
+  onError?: (error?: unknown) => void;
+};
+
 /**
  * @interface UseUserListReturn
  * @description interface for user list hook return value

package/lib/commonjs/channel/useActiveGroupChannel.js

@@ -1,22 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.useActiveGroupChannel = void 0;
-
-var _react = require("react");
-
-const useActiveGroupChannel = (sdk, staleChannel) => {
-  const [activeChannel, setActiveChannel] = (0, _react.useState)(() => staleChannel);
-  (0, _react.useEffect)(() => {
-    sdk.groupChannel.getChannel(staleChannel.url).then(setActiveChannel);
-  }, [staleChannel.url]);
-  return {
-    activeChannel,
-    setActiveChannel
-  };
-};
-
-exports.useActiveGroupChannel = useActiveGroupChannel;
-//# sourceMappingURL=useActiveGroupChannel.js.map

package/lib/commonjs/channel/useActiveGroupChannel.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["useActiveGroupChannel","sdk","staleChannel","activeChannel","setActiveChannel","useState","useEffect","groupChannel","getChannel","url","then"],"sources":["useActiveGroupChannel.ts"],"sourcesContent":["import { useEffect, useState } from 'react';\n\nimport type { SendbirdChatSDK, SendbirdGroupChannel } from '@sendbird/uikit-utils';\n\nexport const useActiveGroupChannel = (sdk: SendbirdChatSDK, staleChannel: SendbirdGroupChannel) => {\n  const [activeChannel, setActiveChannel] = useState(() => staleChannel);\n\n  useEffect(() => {\n    sdk.groupChannel.getChannel(staleChannel.url).then(setActiveChannel);\n  }, [staleChannel.url]);\n\n  return { activeChannel, setActiveChannel };\n};\n"],"mappings":";;;;;;;AAAA;;AAIO,MAAMA,qBAAqB,GAAG,CAACC,GAAD,EAAuBC,YAAvB,KAA8D;EACjG,MAAM,CAACC,aAAD,EAAgBC,gBAAhB,IAAoC,IAAAC,eAAA,EAAS,MAAMH,YAAf,CAA1C;EAEA,IAAAI,gBAAA,EAAU,MAAM;IACdL,GAAG,CAACM,YAAJ,CAAiBC,UAAjB,CAA4BN,YAAY,CAACO,GAAzC,EAA8CC,IAA9C,CAAmDN,gBAAnD;EACD,CAFD,EAEG,CAACF,YAAY,CAACO,GAAd,CAFH;EAIA,OAAO;IAAEN,aAAF;IAAiBC;EAAjB,CAAP;AACD,CARM"}

package/lib/module/channel/useActiveGroupChannel.js

@@ -1,12 +0,0 @@
-import { useEffect, useState } from 'react';
-export const useActiveGroupChannel = (sdk, staleChannel) => {
-  const [activeChannel, setActiveChannel] = useState(() => staleChannel);
-  useEffect(() => {
-    sdk.groupChannel.getChannel(staleChannel.url).then(setActiveChannel);
-  }, [staleChannel.url]);
-  return {
-    activeChannel,
-    setActiveChannel
-  };
-};
-//# sourceMappingURL=useActiveGroupChannel.js.map

package/lib/module/channel/useActiveGroupChannel.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["useEffect","useState","useActiveGroupChannel","sdk","staleChannel","activeChannel","setActiveChannel","groupChannel","getChannel","url","then"],"sources":["useActiveGroupChannel.ts"],"sourcesContent":["import { useEffect, useState } from 'react';\n\nimport type { SendbirdChatSDK, SendbirdGroupChannel } from '@sendbird/uikit-utils';\n\nexport const useActiveGroupChannel = (sdk: SendbirdChatSDK, staleChannel: SendbirdGroupChannel) => {\n  const [activeChannel, setActiveChannel] = useState(() => staleChannel);\n\n  useEffect(() => {\n    sdk.groupChannel.getChannel(staleChannel.url).then(setActiveChannel);\n  }, [staleChannel.url]);\n\n  return { activeChannel, setActiveChannel };\n};\n"],"mappings":"AAAA,SAASA,SAAT,EAAoBC,QAApB,QAAoC,OAApC;AAIA,OAAO,MAAMC,qBAAqB,GAAG,CAACC,GAAD,EAAuBC,YAAvB,KAA8D;EACjG,MAAM,CAACC,aAAD,EAAgBC,gBAAhB,IAAoCL,QAAQ,CAAC,MAAMG,YAAP,CAAlD;EAEAJ,SAAS,CAAC,MAAM;IACdG,GAAG,CAACI,YAAJ,CAAiBC,UAAjB,CAA4BJ,YAAY,CAACK,GAAzC,EAA8CC,IAA9C,CAAmDJ,gBAAnD;EACD,CAFQ,EAEN,CAACF,YAAY,CAACK,GAAd,CAFM,CAAT;EAIA,OAAO;IAAEJ,aAAF;IAAiBC;EAAjB,CAAP;AACD,CARM"}

package/lib/typescript/src/channel/useActiveGroupChannel.d.ts

@@ -1,5 +0,0 @@
-import type { SendbirdChatSDK, SendbirdGroupChannel } from '@sendbird/uikit-utils';
-export declare const useActiveGroupChannel: (sdk: SendbirdChatSDK, staleChannel: SendbirdGroupChannel) => {
-    activeChannel: import("@sendbird/chat/groupChannel").GroupChannel;
-    setActiveChannel: import("react").Dispatch<import("react").SetStateAction<import("@sendbird/chat/groupChannel").GroupChannel>>;
-};

package/src/channel/useActiveGroupChannel.ts

@@ -1,13 +0,0 @@
-import { useEffect, useState } from 'react';
-
-import type { SendbirdChatSDK, SendbirdGroupChannel } from '@sendbird/uikit-utils';
-
-export const useActiveGroupChannel = (sdk: SendbirdChatSDK, staleChannel: SendbirdGroupChannel) => {
-  const [activeChannel, setActiveChannel] = useState(() => staleChannel);
-
-  useEffect(() => {
-    sdk.groupChannel.getChannel(staleChannel.url).then(setActiveChannel);
-  }, [staleChannel.url]);
-
-  return { activeChannel, setActiveChannel };
-};