chore: rename ready -> channelListInitialized

Author: isekovanic

package/src/components/ChannelList/ChannelList.tsx

@@ -342,13 +342,13 @@ export const ChannelList = <
   }, [channelManager]);
 
   const {
+    channelListInitialized,
     channels,
     error,
     hasNextPage,
     loadingChannels,
     loadingNextPage,
     loadNextPage,
-    ready,
     refreshing,
     refreshList,
     reloadList,
@@ -375,7 +375,12 @@ export const ChannelList = <
   const channelIdsStr = channels?.reduce((acc, channel) => `${acc}${channel.cid}`, '');
 
   useEffect(() => {
-    if (channels == null || !ready || staticChannelsActive || !enableOfflineSupport) {
+    if (
+      channels == null ||
+      !channelListInitialized ||
+      staticChannelsActive ||
+      !enableOfflineSupport
+    ) {
       return;
     }
 
@@ -389,6 +394,7 @@ export const ChannelList = <
 
   const channelsContext = useCreateChannelsContext({
     additionalFlatListProps,
+    channelListInitialized,
     channels: channelRenderFilterFn ? channelRenderFilterFn(channels ?? []) : channels,
     EmptyStateIndicator,
     error,
@@ -414,7 +420,6 @@ export const ChannelList = <
     PreviewStatus,
     PreviewTitle,
     PreviewUnreadCount,
-    ready,
     refreshing,
     refreshList,
     reloadList,

package/src/components/ChannelList/ChannelListMessenger.tsx

@@ -86,6 +86,7 @@ const ChannelListMessengerWithContext = <
   const onEndReachedCalledDuringCurrentScrollRef = useRef<boolean>(false);
   const {
     additionalFlatListProps,
+    channelListInitialized,
     channels,
     EmptyStateIndicator,
     error,
@@ -99,7 +100,6 @@ const ChannelListMessengerWithContext = <
     loadingNextPage,
     loadMoreThreshold,
     loadNextPage,
-    ready,
     refreshing,
     refreshList,
     reloadList,
@@ -141,7 +141,7 @@ const ChannelListMessengerWithContext = <
       });
   }
 
-  if (error && !refreshing && !loadingChannels && (channels === null || !ready)) {
+  if (error && !refreshing && !loadingChannels && (channels === null || !channelListInitialized)) {
     return (
       <LoadingErrorIndicator
         error={error}
@@ -212,6 +212,7 @@ export const ChannelListMessenger = <
 ) => {
   const {
     additionalFlatListProps,
+    channelListInitialized,
     channels,
     EmptyStateIndicator,
     error,
@@ -225,7 +226,6 @@ export const ChannelListMessenger = <
     loadingNextPage,
     loadMoreThreshold,
     loadNextPage,
-    ready,
     refreshing,
     refreshList,
     reloadList,
@@ -236,6 +236,7 @@ export const ChannelListMessenger = <
     <ChannelListMessengerWithContext
       {...{
         additionalFlatListProps,
+        channelListInitialized,
         channels,
         EmptyStateIndicator,
         error,
@@ -249,7 +250,6 @@ export const ChannelListMessenger = <
         loadingNextPage,
         loadMoreThreshold,
         loadNextPage,
-        ready,
         refreshing,
         refreshList,
         reloadList,

package/src/components/ChannelList/hooks/useCreateChannelsContext.ts

@@ -7,6 +7,7 @@ export const useCreateChannelsContext = <
   StreamChatGenerics extends DefaultStreamChatGenerics = DefaultStreamChatGenerics,
 >({
   additionalFlatListProps,
+  channelListInitialized,
   channels,
   EmptyStateIndicator,
   error,
@@ -32,7 +33,6 @@ export const useCreateChannelsContext = <
   PreviewStatus,
   PreviewTitle,
   PreviewUnreadCount,
-  ready,
   refreshing,
   refreshList,
   reloadList,
@@ -52,6 +52,7 @@ export const useCreateChannelsContext = <
   const channelsContext: ChannelsContextValue<StreamChatGenerics> = useMemo(
     () => ({
       additionalFlatListProps,
+      channelListInitialized,
       channels,
       EmptyStateIndicator,
       error,
@@ -77,7 +78,6 @@ export const useCreateChannelsContext = <
       PreviewStatus,
       PreviewTitle,
       PreviewUnreadCount,
-      ready,
       refreshing,
       refreshList,
       reloadList,
@@ -92,7 +92,7 @@ export const useCreateChannelsContext = <
       hasNextPage,
       loadingChannels,
       loadingNextPage,
-      ready,
+      channelListInitialized,
       refreshing,
     ],
   );

package/src/components/ChannelList/hooks/usePaginatedChannels.ts

@@ -49,10 +49,9 @@ const selector = <StreamChatGenerics extends DefaultStreamChatGenerics = Default
   nextValue: ChannelManagerState<StreamChatGenerics>,
 ) =>
   ({
+    channelListInitialized: nextValue.initialized,
     channels: nextValue.channels,
     pagination: nextValue.pagination,
-    // TODO: rename this properly everywhere
-    ready: nextValue.initialized,
   } as const);
 
 export const usePaginatedChannels = <
@@ -71,7 +70,8 @@ export const usePaginatedChannels = <
   const activeChannels = useActiveChannelsRefContext();
   const isMountedRef = useIsMountedRef();
   const { client } = useChatContext<StreamChatGenerics>();
-  const { channels, pagination, ready } = useStateStore(channelManager?.state, selector) ?? {};
+  const { channelListInitialized, channels, pagination } =
+    useStateStore(channelManager?.state, selector) ?? {};
   const hasNextPage = pagination?.hasNext;
 
   const filtersRef = useRef<typeof filters | null>(null);
@@ -268,22 +268,22 @@ export const usePaginatedChannels = <
   }, [filterStr, sortStr, channelManager]);
 
   return {
+    channelListInitialized,
     channels,
     error,
     hasNextPage,
     loadingChannels:
       activeQueryType.current === 'queryLocalDB'
         ? true
-        : // Although channels.length === 0 should come as a given when we have !ready,
+        : // Although channels.length === 0 should come as a given when we have !channelListInitialized,
           // due to the way offline storage works currently we have to do this additional
           // check to make sure channels were not populated before the reactive list becomes
           // ready. I do not like providing a way to set the ready state, as it should be managed
           // in the LLC entirely. Once we move offline support to the LLC, we can remove this check
           // too as it'll be redundant.
-          pagination?.isLoading || (!ready && channels.length === 0),
+          pagination?.isLoading || (!channelListInitialized && channels.length === 0),
     loadingNextPage: pagination?.isLoadingNext,
     loadNextPage: channelManager.loadNext,
-    ready,
     refreshing: activeQueryType.current === 'refresh',
     refreshList,
     reloadList,

package/src/contexts/channelsContext/ChannelsContext.tsx

@@ -42,6 +42,10 @@ export type ChannelsContextValue<
    * **Note:** Don't use `additionalFlatListProps` to access the FlatList ref, use `setFlatListRef`
    */
   additionalFlatListProps: Partial<FlatListProps<Channel<StreamChatGenerics>>>;
+  /**
+   * A control prop used to determine whether the first query of the channel list has succeeded.
+   */
+  channelListInitialized: boolean;
   /**
    * Channels can be either an array of channels or a promise which resolves to an array of channels
    */
@@ -120,7 +124,6 @@ export type ChannelsContextValue<
    * Default: [ChannelPreviewMessenger](https://getstream.io/chat/docs/sdk/reactnative/ui-components/channel-preview-messenger/)
    */
   Preview: React.ComponentType<ChannelPreviewMessengerProps<StreamChatGenerics>>;
-  ready: boolean;
   /**
    * Triggered when the channel list is refreshing, displays a loading spinner at the top of the list
    */