stream-chat-react-native-core 3.10.2 → 4.0.0-beta.1

package/src/components/Thread/components/ThreadFooterComponent.tsx

@@ -84,7 +84,7 @@ const ThreadFooterComponentWithContext = <
   const replyCount = thread.reply_count;
 
   return (
-    <View style={styles.threadHeaderContainer}>
+    <View style={styles.threadHeaderContainer} testID='thread-footer-component'>
       <View style={styles.messagePadding}>
         <Message groupStyles={['single']} message={thread} preventPress threadList />
       </View>
@@ -146,6 +146,18 @@ const areEqual = <
     prevThread?.reply_count === nextThread?.reply_count;
   if (!threadEqual) return false;
 
+  const latestReactionsEqual =
+    prevThread &&
+    nextThread &&
+    Array.isArray(prevThread.latest_reactions) &&
+    Array.isArray(nextThread.latest_reactions)
+      ? prevThread.latest_reactions.length === nextThread.latest_reactions.length &&
+        prevThread.latest_reactions.every(
+          ({ type }, index) => type === nextThread.latest_reactions?.[index].type,
+        )
+      : prevThread?.latest_reactions === nextThread?.latest_reactions;
+  if (!latestReactionsEqual) return false;
+
   return true;
 };
 

package/src/components/docs/ListProps.md

@@ -1,6 +1,6 @@
 All props available in the [ChannelList](#channellist) component are passed along to the List component. Additionally, the following props are provided to the List component:
 
-- `error` {boolean} Error in channels query, if any
+- `error` {boolean | Error} Error in channels query, if any
 - `channels` {array} List of channel objects
 - `forceUpdate` {number} Incremental number change to force update the FlatList
 - `hasNextPage` {boolean} Whether or not the FlatList has another page to render

package/src/components/index.ts

@@ -18,12 +18,9 @@ export * from './AttachmentPicker/components/ImageOverlaySelectedComponent';
 export * from './AttachmentPicker/components/ImageSelectorIcon';
 
 export * from './AutoCompleteInput/AutoCompleteInput';
-export * from './AutoCompleteInput/CommandsHeader';
-export * from './AutoCompleteInput/CommandsItem';
-export * from './AutoCompleteInput/EmojisHeader';
-export * from './AutoCompleteInput/EmojisItem';
-export * from './AutoCompleteInput/MentionsItem';
-export * from './AutoCompleteInput/SuggestionsList';
+export * from './AutoCompleteInput/AutoCompleteSuggestionHeader';
+export * from './AutoCompleteInput/AutoCompleteSuggestionItem';
+export * from './AutoCompleteInput/AutoCompleteSuggestionList';
 
 export * from './Avatar/Avatar';
 export * from './Avatar/GroupAvatar';
@@ -91,11 +88,14 @@ export * from './Indicators/LoadingIndicator';
 export * from './KeyboardCompatibleView/KeyboardCompatibleView';
 
 export * from './Message/hooks/useCreateMessageContext';
+export * from './Message/hooks/useMessageActions';
+export * from './Message/hooks/useMessageActionHandlers';
 export * from './Message/Message';
 export * from './Message/MessageSimple/MessageAvatar';
 export * from './Message/MessageSimple/MessageContent';
 export * from './Message/MessageSimple/MessageDeleted';
 export * from './Message/MessageSimple/MessageFooter';
+export * from './Message/MessageSimple/MessagePinnedHeader';
 export * from './Message/MessageSimple/MessageReplies';
 export * from './Message/MessageSimple/MessageRepliesAvatars';
 export * from './Message/MessageSimple/MessageSimple';
@@ -108,6 +108,7 @@ export * from './Message/utils/removeReservedFields';
 
 export * from './MessageInput/AttachButton';
 export * from './MessageInput/CommandsButton';
+export * from './MessageInput/CooldownTimer';
 export * from './MessageInput/FileUploadPreview';
 export * from './MessageInput/ImageUploadPreview';
 export * from './MessageInput/InputButtons';
@@ -136,8 +137,11 @@ export * from './MessageList/utils/getGroupStyles';
 export * from './MessageList/utils/getLastReceivedMessage';
 export * from './MessageList/utils/getReadStates';
 
-export * from './MessageOverlay/MessageActions';
+export * from './MessageOverlay/hooks/useMessageActionAnimation';
+export * from './MessageOverlay/MessageActionList';
+export * from './MessageOverlay/MessageActionListItem';
 export * from './MessageOverlay/MessageOverlay';
+export * from './MessageOverlay/OverlayBackdrop';
 export * from './MessageOverlay/OverlayReactions';
 export * from './MessageOverlay/OverlayReactionList';
 

package/src/contexts/activeChannelsRefContext/ActiveChannelsRefContext.tsx

@@ -0,0 +1,33 @@
+import React, { PropsWithChildren, useContext } from 'react';
+
+import { getDisplayName } from '../utils/getDisplayName';
+
+import type { UnknownType } from '../../types/types';
+
+type ActiveChannels = React.MutableRefObject<string[]>;
+
+const ActiveChannelsContext = React.createContext({ current: [] } as ActiveChannels);
+
+export const ActiveChannelsProvider = ({
+  children,
+  value,
+}: PropsWithChildren<{
+  value: ActiveChannels;
+}>) => <ActiveChannelsContext.Provider value={value}>{children}</ActiveChannelsContext.Provider>;
+
+export const useActiveChannelsRefContext = () =>
+  useContext(ActiveChannelsContext) as unknown as ActiveChannels;
+
+export const withActiveChannelsRefContext = <P extends UnknownType>(
+  Component: React.ComponentType<P>,
+): React.FC<Omit<P, 'activeChannels'>> => {
+  const WithActiveChannelsContextComponent = (props: Omit<P, 'activeChannels'>) => {
+    const ActiveChannelsContext = useActiveChannelsRefContext();
+
+    return <Component {...(props as P)} activeChannels={ActiveChannelsContext} />;
+  };
+  WithActiveChannelsContextComponent.displayName = `WithActiveChannelsContext${getDisplayName(
+    Component,
+  )}`;
+  return WithActiveChannelsContextComponent;
+};

package/src/contexts/channelContext/ChannelContext.tsx

@@ -17,11 +17,6 @@ import type {
   UnknownType,
 } from '../../types/types';
 
-export type ChannelConfig = {
-  readEventsEnabled?: boolean;
-  typingEventsEnabled?: boolean;
-};
-
 export type ChannelContextValue<
   At extends UnknownType = DefaultAttachmentType,
   Ch extends UnknownType = DefaultChannelType,
@@ -31,6 +26,29 @@ export type ChannelContextValue<
   Re extends UnknownType = DefaultReactionType,
   Us extends UnknownType = DefaultUserType,
 > = {
+  /**
+   * Instance of channel object from stream-chat package.
+   *
+   * Please check the docs around how to create or query channel - https://getstream.io/chat/docs/javascript/creating_channels/?language=javascript
+   *
+   * ```
+   * import { StreamChat, Channel } from 'stream-chat';
+   * import { Chat, Channel} from 'stream-chat-react-native';
+   *
+   * const client = StreamChat.getInstance('api_key');
+   * await client.connectUser('user_id', 'user_token');
+   * const channel = client.channel('messaging', 'channel_id');
+   * await channel.watch();
+   *
+   * <Chat client={client}>
+   *  <Channel channel={channel}>
+   *  </Channel>
+   * </Chat>
+   * ```
+   *
+   * @overrideType Channel
+   */
+  channel: Channel<At, Ch, Co, Ev, Me, Re, Us>;
   /**
    * Custom UI component to display empty state when channel has no messages.
    *
@@ -44,7 +62,7 @@ export type ChannelContextValue<
    * This is similar to reaction UX on [iMessage application](https://en.wikipedia.org/wiki/IMessage).
    */
   enforceUniqueReaction: boolean;
-  error: boolean;
+  error: boolean | Error;
   /**
    * When set to false, it will disable giphy command on MessageInput component.
    */
@@ -141,31 +159,9 @@ export type ChannelContextValue<
    * ```
    */
   watchers: ChannelState<At, Ch, Co, Ev, Me, Re, Us>['watchers'];
-  /**
-   * Instance of channel object from stream-chat package.
-   *
-   * Please check the docs around how to create or query channel - https://getstream.io/chat/docs/javascript/creating_channels/?language=javascript
-   *
-   * ```
-   * import { StreamChat, Channel } from 'stream-chat';
-   * import { Chat, Channel} from 'stream-chat-react-native';
-   *
-   * const client = StreamChat.getInstance('api_key');
-   * await client.connectUser('user_id', 'user_token');
-   * const channel = client.channel('messaging', 'channel_id');
-   * await channel.watch();
-   *
-   * <Chat client={client}>
-   *  <Channel channel={channel}>
-   *  </Channel>
-   * </Chat>
-   * ```
-   *
-   * @overrideType Channel
-   */
-  channel?: Channel<At, Ch, Co, Ev, Me, Re, Us>;
   disabled?: boolean;
   enableMessageGroupingByUser?: boolean;
+  isChannelActive?: boolean;
   lastRead?: Date;
   /**
    * Maximum time in milliseconds that should occur between messages
@@ -183,8 +179,9 @@ export type ChannelContextValue<
    * You will see a highlighted background for targetted message, when opened.
    */
   targetedMessage?: string;
+  threadList?: boolean;
   watcherCount?: ChannelState<At, Ch, Co, Ev, Me, Re, Us>['watcher_count'];
-} & ChannelConfig;
+};
 
 export const ChannelContext = React.createContext({} as ChannelContextValue);
 

package/src/contexts/channelsContext/ChannelsContext.tsx

@@ -67,7 +67,7 @@ export type ChannelsContextValue<
   /**
    * Error in channels query, if any
    */
-  error: boolean;
+  error: boolean | Error;
   /**
    * Custom loading indicator to display at bottom of the list, while loading further pages
    *

package/src/contexts/channelsStateContext/ChannelsStateContext.tsx

@@ -0,0 +1,287 @@
+import React, {
+  ReactNode,
+  useCallback,
+  useContext,
+  useEffect,
+  useMemo,
+  useReducer,
+  useRef,
+} from 'react';
+
+import { ActiveChannelsProvider } from '../activeChannelsRefContext/ActiveChannelsRefContext';
+
+import type { ChannelContextValue } from '../channelContext/ChannelContext';
+import type { PaginatedMessageListContextValue } from '../paginatedMessageListContext/PaginatedMessageListContext';
+import type { ThreadContextValue } from '../threadContext/ThreadContext';
+import type { TypingContextValue } from '../typingContext/TypingContext';
+import { getDisplayName } from '../utils/getDisplayName';
+
+import type {
+  DefaultAttachmentType,
+  DefaultChannelType,
+  DefaultCommandType,
+  DefaultEventType,
+  DefaultMessageType,
+  DefaultReactionType,
+  DefaultUserType,
+  UnknownType,
+} from '../../types/types';
+
+export type ChannelState<
+  At extends UnknownType = DefaultAttachmentType,
+  Ch extends UnknownType = DefaultChannelType,
+  Co extends string = DefaultCommandType,
+  Ev extends UnknownType = DefaultEventType,
+  Me extends UnknownType = DefaultMessageType,
+  Re extends UnknownType = DefaultReactionType,
+  Us extends UnknownType = DefaultUserType,
+> = {
+  members: ChannelContextValue<At, Ch, Co, Ev, Me, Re, Us>['members'];
+  messages: PaginatedMessageListContextValue<At, Ch, Co, Ev, Me, Re, Us>['messages'];
+  read: ChannelContextValue<At, Ch, Co, Ev, Me, Re, Us>['read'];
+  subscriberCount: number;
+  threadMessages: ThreadContextValue<At, Ch, Co, Ev, Me, Re, Us>['threadMessages'];
+  typing: TypingContextValue<At, Ch, Co, Ev, Me, Re, Us>['typing'];
+  watcherCount: ChannelContextValue<At, Ch, Co, Ev, Me, Re, Us>['watcherCount'];
+  watchers: ChannelContextValue<At, Ch, Co, Ev, Me, Re, Us>['watchers'];
+};
+
+type ChannelsState<
+  At extends UnknownType = DefaultAttachmentType,
+  Ch extends UnknownType = DefaultChannelType,
+  Co extends string = DefaultCommandType,
+  Ev extends UnknownType = DefaultEventType,
+  Me extends UnknownType = DefaultMessageType,
+  Re extends UnknownType = DefaultReactionType,
+  Us extends UnknownType = DefaultUserType,
+> = { [cid: string]: ChannelState<At, Ch, Co, Ev, Me, Re, Us> };
+
+export type Keys = keyof ChannelState;
+
+export type Payload<
+  Key extends Keys = Keys,
+  At extends UnknownType = DefaultAttachmentType,
+  Ch extends UnknownType = DefaultChannelType,
+  Co extends string = DefaultCommandType,
+  Ev extends UnknownType = DefaultEventType,
+  Me extends UnknownType = DefaultMessageType,
+  Re extends UnknownType = DefaultReactionType,
+  Us extends UnknownType = DefaultUserType,
+> = {
+  cid: string;
+  key: Key;
+  value: ChannelState<At, Ch, Co, Ev, Me, Re, Us>[Key];
+};
+
+type SetStateAction<
+  At extends UnknownType = DefaultAttachmentType,
+  Ch extends UnknownType = DefaultChannelType,
+  Co extends string = DefaultCommandType,
+  Ev extends UnknownType = DefaultEventType,
+  Me extends UnknownType = DefaultMessageType,
+  Re extends UnknownType = DefaultReactionType,
+  Us extends UnknownType = DefaultUserType,
+> = { payload: Payload<Keys, At, Ch, Co, Ev, Me, Re, Us>; type: 'SET_STATE' };
+
+type IncreaseSubscriberCountAction = {
+  payload: { cid: string };
+  type: 'INCREASE_SUBSCRIBER_COUNT';
+};
+type DecreaseSubscriberCountAction = {
+  payload: { cid: string };
+  type: 'DECREASE_SUBSCRIBER_COUNT';
+};
+
+type Action<
+  At extends UnknownType = DefaultAttachmentType,
+  Ch extends UnknownType = DefaultChannelType,
+  Co extends string = DefaultCommandType,
+  Ev extends UnknownType = DefaultEventType,
+  Me extends UnknownType = DefaultMessageType,
+  Re extends UnknownType = DefaultReactionType,
+  Us extends UnknownType = DefaultUserType,
+> =
+  | SetStateAction<At, Ch, Co, Ev, Me, Re, Us>
+  | IncreaseSubscriberCountAction
+  | DecreaseSubscriberCountAction;
+
+export type ChannelsStateContextValue<
+  At extends UnknownType = DefaultAttachmentType,
+  Ch extends UnknownType = DefaultChannelType,
+  Co extends string = DefaultCommandType,
+  Ev extends UnknownType = DefaultEventType,
+  Me extends UnknownType = DefaultMessageType,
+  Re extends UnknownType = DefaultReactionType,
+  Us extends UnknownType = DefaultUserType,
+> = {
+  decreaseSubscriberCount: (value: { cid: string }) => void;
+  increaseSubscriberCount: (value: { cid: string }) => void;
+  setState: (value: Payload<Keys, At, Ch, Co, Ev, Me, Re, Us>) => void;
+  state: ChannelsState<At, Ch, Co, Ev, Me, Re, Us>;
+};
+
+type Reducer<
+  At extends UnknownType = DefaultAttachmentType,
+  Ch extends UnknownType = DefaultChannelType,
+  Co extends string = DefaultCommandType,
+  Ev extends UnknownType = DefaultEventType,
+  Me extends UnknownType = DefaultMessageType,
+  Re extends UnknownType = DefaultReactionType,
+  Us extends UnknownType = DefaultUserType,
+> = (
+  state: ChannelsState<At, Ch, Co, Ev, Me, Re, Us>,
+  action: Action<At, Ch, Co, Ev, Me, Re, Us>,
+) => ChannelsState<At, Ch, Co, Ev, Me, Re, Us>;
+
+function reducer(state: ChannelsState, action: Action) {
+  switch (action.type) {
+    case 'SET_STATE':
+      return {
+        ...state,
+        [action.payload.cid]: {
+          ...(state[action.payload.cid] || {}),
+          [action.payload.key]: action.payload.value,
+        },
+      };
+
+    case 'INCREASE_SUBSCRIBER_COUNT': {
+      const currentCount = state[action.payload.cid]?.subscriberCount ?? 0;
+      return {
+        ...state,
+        [action.payload.cid]: {
+          ...(state[action.payload.cid] || {}),
+          subscriberCount: currentCount + 1,
+        },
+      };
+    }
+
+    case 'DECREASE_SUBSCRIBER_COUNT': {
+      const currentCount = state[action.payload.cid]?.subscriberCount ?? 0;
+
+      // If there last subscribed Channel component unsubscribes, we clear the channel state.
+      if (currentCount <= 1) {
+        const stateShallowCopy = {
+          ...state,
+        };
+
+        delete stateShallowCopy[action.payload.cid];
+
+        return stateShallowCopy;
+      }
+
+      return {
+        ...state,
+        [action.payload.cid]: {
+          ...(state[action.payload.cid] || {}),
+          subscriberCount: currentCount - 1,
+        },
+      };
+    }
+    default:
+      throw new Error();
+  }
+}
+
+const ChannelsStateContext = React.createContext({
+  removeChannelState: () => {
+    // do nothing.
+  },
+  setState: () => {
+    // do nothing.
+  },
+  state: {},
+} as unknown as ChannelsStateContextValue);
+
+export const ChannelsStateProvider = <
+  At extends UnknownType = DefaultAttachmentType,
+  Ch extends UnknownType = DefaultChannelType,
+  Co extends string = DefaultCommandType,
+  Ev extends UnknownType = DefaultEventType,
+  Me extends UnknownType = DefaultMessageType,
+  Re extends UnknownType = DefaultReactionType,
+  Us extends UnknownType = DefaultUserType,
+>({
+  children,
+}: {
+  children: ReactNode;
+}) => {
+  const [state, dispatch] = useReducer(reducer as Reducer<At, Ch, Co, Ev, Me, Re, Us>, {});
+
+  const setState = useCallback((payload: Payload<Keys, At, Ch, Co, Ev, Me, Re, Us>) => {
+    dispatch({ payload, type: 'SET_STATE' });
+  }, []);
+
+  const increaseSubscriberCount = useCallback((payload: { cid: string }) => {
+    dispatch({ payload, type: 'INCREASE_SUBSCRIBER_COUNT' });
+  }, []);
+
+  const decreaseSubscriberCount = useCallback((payload: { cid: string }) => {
+    dispatch({ payload, type: 'DECREASE_SUBSCRIBER_COUNT' });
+  }, []);
+
+  const value = useMemo(
+    () => ({
+      decreaseSubscriberCount,
+      increaseSubscriberCount,
+      setState,
+      state,
+    }),
+    [state],
+  );
+
+  const activeChannelsRef = useRef(Object.keys(state));
+
+  useEffect(() => {
+    activeChannelsRef.current = Object.keys(state);
+  }, [state]);
+
+  return (
+    <ChannelsStateContext.Provider value={value as unknown as ChannelsStateContextValue}>
+      <ActiveChannelsProvider value={activeChannelsRef}>{children}</ActiveChannelsProvider>
+    </ChannelsStateContext.Provider>
+  );
+};
+
+export const useChannelsStateContext = <
+  At extends UnknownType = DefaultAttachmentType,
+  Ch extends UnknownType = DefaultChannelType,
+  Co extends string = DefaultCommandType,
+  Ev extends UnknownType = DefaultEventType,
+  Me extends UnknownType = DefaultMessageType,
+  Re extends UnknownType = DefaultReactionType,
+  Us extends UnknownType = DefaultUserType,
+>() =>
+  useContext(ChannelsStateContext) as unknown as ChannelsStateContextValue<
+    At,
+    Ch,
+    Co,
+    Ev,
+    Me,
+    Re,
+    Us
+  >;
+
+export const withChannelsStateContext = <
+  P extends UnknownType,
+  At extends UnknownType = DefaultAttachmentType,
+  Ch extends UnknownType = DefaultChannelType,
+  Co extends string = DefaultCommandType,
+  Ev extends UnknownType = DefaultEventType,
+  Me extends UnknownType = DefaultMessageType,
+  Re extends UnknownType = DefaultReactionType,
+  Us extends UnknownType = DefaultUserType,
+>(
+  Component: React.ComponentType<P>,
+): React.FC<Omit<P, keyof ChannelsStateContextValue<At, Ch, Co, Ev, Me, Re, Us>>> => {
+  const WithChannelsStateContextComponent = (
+    props: Omit<P, keyof ChannelsStateContextValue<At, Ch, Co, Ev, Me, Re, Us>>,
+  ) => {
+    const channelsStateContext = useChannelsStateContext<At, Ch, Co, Ev, Me, Re, Us>();
+
+    return <Component {...(props as P)} {...channelsStateContext} />;
+  };
+  WithChannelsStateContextComponent.displayName = `WithChannelsStateContext${getDisplayName(
+    Component,
+  )}`;
+  return WithChannelsStateContextComponent;
+};