fix: add optional raw queryChannels api response (#1530)

## CLA

- [ ] I have signed the [Stream
CLA](https://docs.google.com/forms/d/e/1FAIpQLScFKsKkAJI7mhCr7K9rEIOpqIDThrWxuvxnwUq2XkHyG154vQ/viewform)
(required).
- [ ] Code changes are tested

## Description of the changes, What, Why and How?

This PR allows `client.queryChannels` to optionally return the raw
response and not run hydration at all (and subsequently not provide an
array of `Channel` instances).

It is meant to be used generally server-side so that integrators can
have access to other fields not available in a `Channel` instance. It
should resolve [this Zendesk
ticket](https://getstream.zendesk.com/agent/tickets/64585).

We can probably keep it the same api if we use discriminated unions, but
I feel like it'd complicate things further for no good reason. Keeping
the apis separate made sense to me.

## Changelog

-

Author: isekovanic

src/client.ts

@@ -1735,22 +1735,19 @@ export class StreamChat {
   }
 
   /**
-   * queryChannels - Query channels
+   * queryChannelsRequest - Queries channels and returns the raw response
    *
    * @param {ChannelFilters} filterConditions object MongoDB style filters
    * @param {ChannelSort} [sort] Sort options, for instance {created_at: -1}.
    * When using multiple fields, make sure you use array of objects to guarantee field order, for instance [{last_updated: -1}, {created_at: 1}]
    * @param {ChannelOptions} [options] Options object
-   * @param {ChannelStateOptions} [stateOptions] State options object. These options will only be used for state management and won't be sent in the request.
-   * - stateOptions.skipInitialization - Skips the initialization of the state for the channels matching the ids in the list.
    *
-   * @return {Promise<{ channels: Array<ChannelAPIResponse>}> } search channels response
+   * @return {Promise<Array<ChannelAPIResponse>>} search channels response
    */
-  async queryChannels(
+  async queryChannelsRequest(
     filterConditions: ChannelFilters,
     sort: ChannelSort = [],
     options: ChannelOptions = {},
-    stateOptions: ChannelStateOptions = {},
   ) {
     const defaultOptions: ChannelOptions = {
       state: true,
@@ -1777,15 +1774,39 @@ export class StreamChat {
       payload,
     );
 
+    return data.channels;
+  }
+
+  /**
+   * queryChannels - Query channels
+   *
+   * @param {ChannelFilters} filterConditions object MongoDB style filters
+   * @param {ChannelSort} [sort] Sort options, for instance {created_at: -1}.
+   * When using multiple fields, make sure you use array of objects to guarantee field order, for instance [{last_updated: -1}, {created_at: 1}]
+   * @param {ChannelOptions} [options] Options object
+   * @param {ChannelStateOptions} [stateOptions] State options object. These options will only be used for state management and won't be sent in the request.
+   * - stateOptions.skipInitialization - Skips the initialization of the state for the channels matching the ids in the list.
+   * - stateOptions.skipHydration - Skips returning the channels as instances of the Channel class and rather returns the raw query response.
+   *
+   * @return {Promise<Array<Channel>>} search channels response
+   */
+  async queryChannels(
+    filterConditions: ChannelFilters,
+    sort: ChannelSort = [],
+    options: ChannelOptions = {},
+    stateOptions: ChannelStateOptions = {},
+  ) {
+    const channels = await this.queryChannelsRequest(filterConditions, sort, options);
+
     this.dispatchEvent({
       type: 'channels.queried',
       queriedChannels: {
-        channels: data.channels,
+        channels,
         isLatestMessageSet: true,
       },
     });
 
-    return this.hydrateActiveChannels(data.channels, stateOptions, options);
+    return this.hydrateActiveChannels(channels, stateOptions, options);
   }
 
   /**

src/types.ts

@@ -968,6 +968,7 @@ export type ChannelQueryOptions = {
 export type ChannelStateOptions = {
   offlineMode?: boolean;
   skipInitialization?: string[];
+  skipHydration?: boolean;
 };
 
 export type CreateChannelOptions = {

test/unit/client.test.js

@@ -10,6 +10,8 @@ import { mockChannelQueryResponse } from './test-utils/mockChannelQueryResponse'
 import { DEFAULT_QUERY_CHANNEL_MESSAGE_LIST_PAGE_SIZE } from '../../src/constants';
 
 import { describe, beforeEach, it, expect, beforeAll, afterAll } from 'vitest';
+import { Channel } from '../../src';
+import { ChannelAPIResponse } from '../../src';
 
 describe('StreamChat getInstance', () => {
 	beforeEach(() => {
@@ -665,6 +667,44 @@ describe('StreamChat.queryChannels', async () => {
 		mock.restore();
 	});
 
+	it('should return hydrated channels as Channel instances from queryChannels', async () => {
+		const client = await getClientWithUser();
+		const mockedChannelsQueryResponse = Array.from({ length: 10 }, () => ({
+			...mockChannelQueryResponse,
+			messages: Array.from(
+				{ length: DEFAULT_QUERY_CHANNEL_MESSAGE_LIST_PAGE_SIZE },
+				generateMsg,
+			),
+		}));
+		const postStub = sinon
+			.stub(client, 'post')
+			.returns(Promise.resolve({ channels: mockedChannelsQueryResponse }));
+		const queryChannelsResponse = await client.queryChannels();
+		expect(queryChannelsResponse.length).to.be.equal(mockedChannelsQueryResponse.length);
+		queryChannelsResponse.forEach((item) => {
+			expect(item).to.be.instanceOf(Channel);
+		});
+		postStub.restore();
+	});
+
+	it('should return the raw channels response from queryChannelsRequest', async () => {
+		const client = await getClientWithUser();
+		const mockedChannelsQueryResponse = Array.from({ length: 10 }, () => ({
+			...mockChannelQueryResponse,
+			messages: Array.from(
+				{ length: DEFAULT_QUERY_CHANNEL_MESSAGE_LIST_PAGE_SIZE },
+				generateMsg,
+			),
+		}));
+		const postStub = sinon
+			.stub(client, 'post')
+			.returns(Promise.resolve({ channels: mockedChannelsQueryResponse }));
+		const queryChannelsResponse = await client.queryChannelsRequest();
+		expect(queryChannelsResponse.length).to.be.equal(mockedChannelsQueryResponse.length);
+		expect(queryChannelsResponse).to.deep.equal(mockedChannelsQueryResponse);
+		postStub.restore();
+	});
+
 	it('should not update pagination for queried message set', async () => {
 		const client = await getClientWithUser();
 		const mockedChannelsQueryResponse = Array.from({ length: 10 }, () => ({