Merge pull request #3176 from GetStream/feat/query-channels-override-prop

feat: add a way to override query channels

Author: isekovanic

examples/SampleApp/yarn.lock

@@ -7922,10 +7922,10 @@ [email protected]:
   version "0.0.0"
   uid ""
 
-stream-chat@^9.11.0:
-  version "9.11.0"
-  resolved "https://registry.yarnpkg.com/stream-chat/-/stream-chat-9.11.0.tgz#412b5f2f55cc3b76e862d88cb3e95b9720493575"
-  integrity sha512-mnf86LMBPmCZUrmrU6bdaOUoxRqpXUvw7prl4b5q6WPNWZ+p/41UN8vllBAaZvAS7jPj9JYWvbhUe40VZ6o8/g==
+stream-chat@^9.12.0:
+  version "9.12.0"
+  resolved "https://registry.yarnpkg.com/stream-chat/-/stream-chat-9.12.0.tgz#d27b1319844d100ca419c61463f5c65f53c87952"
+  integrity sha512-/A4y8jBmWdP53RUY9f8dlc8dRjC/irR5KUMiOhn0IiAEmK2fKuD/7IpUzXi7cNmR8QMxlHdDMJZdB2wMDkiskQ==
   dependencies:
     "@types/jsonwebtoken" "^9.0.8"
     "@types/ws" "^8.5.14"

package/package.json

@@ -78,7 +78,7 @@
     "path": "0.12.7",
     "react-native-markdown-package": "1.8.2",
     "react-native-url-polyfill": "^2.0.0",
-    "stream-chat": "^9.11.0",
+    "stream-chat": "^9.12.0",
     "use-sync-external-store": "^1.5.0"
   },
   "peerDependencies": {

package/src/components/ChannelList/ChannelList.tsx

@@ -2,7 +2,14 @@ import React, { useEffect, useMemo, useState } from 'react';
 
 import type { FlatList } from 'react-native-gesture-handler';
 
-import { Channel, ChannelFilters, ChannelOptions, ChannelSort, Event } from 'stream-chat';
+import {
+  Channel,
+  ChannelFilters,
+  ChannelOptions,
+  ChannelSort,
+  Event,
+  QueryChannelsRequestType,
+} from 'stream-chat';
 
 import { ChannelListFooterLoadingIndicator } from './ChannelListFooterLoadingIndicator';
 import { ChannelListHeaderErrorIndicator } from './ChannelListHeaderErrorIndicator';
@@ -215,6 +222,15 @@ export type ChannelListProps = Partial<
    * @see See [Channel query documentation](https://getstream.io/chat/docs/query_channels) for a list of available sorting fields
    * */
   sort?: ChannelSort;
+
+  /**
+   * A function that overrides the default ChannelManager queryChannels method, which is StreamChat.queryChannels.
+   * It is particularly useful whenever we want to pass specific cids that we want to query but also want to
+   * paginate over them (which is not possible through normal filters). It comes with with several rules/assumptions:
+   * - StreamChat.queryChannels has to be called inside of queryChannelsOverride (as it updates important client state)
+   * - The return type has to be Channel[] (which is the return type of StreamChat.queryChannels)
+   */
+  queryChannelsOverride?: QueryChannelsRequestType;
 };
 
 const DEFAULT_FILTERS = {};
@@ -268,6 +284,7 @@ export const ChannelList = (props: ChannelListProps) => {
     setFlatListRef,
     Skeleton = SkeletonDefault,
     sort = DEFAULT_SORT,
+    queryChannelsOverride,
   } = props;
 
   const [forceUpdate, setForceUpdate] = useState(0);
@@ -319,6 +336,12 @@ export const ChannelList = (props: ChannelListProps) => {
     sort,
   ]);
 
+  useEffect(() => {
+    if (queryChannelsOverride) {
+      channelManager.setQueryChannelsRequest(queryChannelsOverride);
+    }
+  }, [channelManager, queryChannelsOverride]);
+
   useEffect(() => {
     channelManager.setOptions({ abortInFlightQuery: false, lockChannelOrder });
   }, [channelManager, lockChannelOrder]);

package/yarn.lock

@@ -8314,10 +8314,10 @@ statuses@~1.5.0:
   resolved "https://registry.yarnpkg.com/statuses/-/statuses-1.5.0.tgz#161c7dac177659fd9811f43771fa99381478628c"
   integrity sha512-OpZ3zP+jT1PI7I8nemJX4AKmAX070ZkYPVWV/AaKTJl+tXCTGyVdC1a4SL8RUQYEwk/f34ZX8UTykN68FwrqAA==
 
-stream-chat@^9.11.0:
-  version "9.11.0"
-  resolved "https://registry.yarnpkg.com/stream-chat/-/stream-chat-9.11.0.tgz#412b5f2f55cc3b76e862d88cb3e95b9720493575"
-  integrity sha512-mnf86LMBPmCZUrmrU6bdaOUoxRqpXUvw7prl4b5q6WPNWZ+p/41UN8vllBAaZvAS7jPj9JYWvbhUe40VZ6o8/g==
+stream-chat@^9.12.0:
+  version "9.12.0"
+  resolved "https://registry.yarnpkg.com/stream-chat/-/stream-chat-9.12.0.tgz#d27b1319844d100ca419c61463f5c65f53c87952"
+  integrity sha512-/A4y8jBmWdP53RUY9f8dlc8dRjC/irR5KUMiOhn0IiAEmK2fKuD/7IpUzXi7cNmR8QMxlHdDMJZdB2wMDkiskQ==
   dependencies:
     "@types/jsonwebtoken" "^9.0.8"
     "@types/ws" "^8.5.14"