[CHAT-1814] Updates to message search

src/channel.ts

@@ -7,6 +7,7 @@ import {
   BanUserOptions,
   ChannelAPIResponse,
   ChannelData,
+  ChannelFilters,
   ChannelMemberAPIResponse,
   ChannelMemberResponse,
   ChannelQueryOptions,
@@ -33,6 +34,8 @@ import {
   QueryMembersOptions,
   Reaction,
   ReactionAPIResponse,
+  SearchOptions,
+  SearchPayload,
   SearchAPIResponse,
   SendMessageAPIResponse,
   TruncateChannelAPIResponse,
@@ -41,6 +44,7 @@ import {
   UserFilters,
   UserResponse,
   UserSort,
+  SearchMessageSort,
 } from './types';
 import { Role } from './permissions';
 
@@ -299,7 +303,7 @@ export class Channel<
    * search - Query messages
    *
    * @param {MessageFilters<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType> | string}  query search query or object MongoDB style filters
-   * @param {{client_id?: string; connection_id?: string; limit?: number; offset?: number; query?: string; message_filter_conditions?: MessageFilters<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>}} options Option object, {user_id: 'tommaso'}
+   * @param {{client_id?: string; connection_id?: string; query?: string; message_filter_conditions?: MessageFilters<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>}} options Option object, {user_id: 'tommaso'}
    *
    * @return {Promise<SearchAPIResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>>} search messages response
    */
@@ -314,10 +318,9 @@ export class Channel<
           UserType
         >
       | string,
-    options: {
+    options: SearchOptions<MessageType> & {
       client_id?: string;
       connection_id?: string;
-      limit?: number;
       message_filter_conditions?: MessageFilters<
         AttachmentType,
         ChannelType,
@@ -326,14 +329,28 @@ export class Channel<
         ReactionType,
         UserType
       >;
-      offset?: number;
       query?: string;
     } = {},
   ) {
+    if ('offset' in options && ('sort' in options || 'next' in options)) {
+      throw Error(`Cannot specify offset with sort or next parameters`);
+    }
     // Return a list of channels
-    const payload = {
-      filter_conditions: { cid: this.cid },
-      ...options,
+    const { sort: sortValue, ...optionsWithoutSort } = { ...options };
+    const payload: SearchPayload<
+      AttachmentType,
+      ChannelType,
+      CommandType,
+      MessageType,
+      ReactionType,
+      UserType
+    > = {
+      filter_conditions: { cid: this.cid } as ChannelFilters<
+        ChannelType,
+        CommandType,
+        UserType
+      >,
+      ...optionsWithoutSort,
     };
     if (typeof query === 'string') {
       payload.query = query;
@@ -342,7 +359,9 @@ export class Channel<
     } else {
       throw Error(`Invalid type ${typeof query} for query parameter`);
     }
-
+    if (sortValue) {
+      payload.sort = normalizeQuerySort<SearchMessageSort<MessageType>>(sortValue);
+    }
     // Make sure we wait for the connect promise if there is a pending one
     await this.getClient().wsPromise;
 

src/client.ts

@@ -81,9 +81,9 @@ import {
   PermissionAPIResponse,
   PermissionsAPIResponse,
   ReactionResponse,
-  SearchAPIResponse,
   SearchOptions,
   SearchPayload,
+  SearchAPIResponse,
   SendFileAPIResponse,
   StreamChatOptions,
   TestPushDataInput,
@@ -102,6 +102,7 @@ import {
   UserOptions,
   UserResponse,
   UserSort,
+  SearchMessageSort,
 } from './types';
 
 function isString(x: unknown): x is string {
@@ -1761,7 +1762,7 @@ export class StreamChat<
    *
    * @param {ChannelFilters<ChannelType, CommandType, UserType>} filterConditions MongoDB style filter conditions
    * @param {MessageFilters<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType> | string} query search query or object MongoDB style filters
-   * @param {SearchOptions} [options] Option object, {user_id: 'tommaso'}
+   * @param {SearchOptions<MessageType>} [options] Option object, {user_id: 'tommaso'}
    *
    * @return {Promise<SearchAPIResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>>} search messages response
    */
@@ -1777,9 +1778,12 @@ export class StreamChat<
           ReactionType,
           UserType
         >,
-    options: SearchOptions = {},
+    options: SearchOptions<MessageType> = {},
   ) {
-    // Return a list of channels
+    if ('offset' in options && ('sort' in options || 'next' in options)) {
+      throw Error(`Cannot specify offset with sort or next parameters`);
+    }
+    const { sort: sortValue, ...optionsWithoutSort } = { ...options };
     const payload: SearchPayload<
       AttachmentType,
       ChannelType,
@@ -1789,7 +1793,7 @@ export class StreamChat<
       UserType
     > = {
       filter_conditions: filterConditions,
-      ...options,
+      ...optionsWithoutSort,
     };
     if (typeof query === 'string') {
       payload.query = query;
@@ -1798,6 +1802,9 @@ export class StreamChat<
     } else {
       throw Error(`Invalid type ${typeof query} for query parameter`);
     }
+    if (sortValue) {
+      payload.sort = normalizeQuerySort<SearchMessageSort<MessageType>>(sortValue);
+    }
 
     // Make sure we wait for the connect promise if there is a pending one
     await this.setUserPromise;

src/types.ts

@@ -649,8 +649,17 @@ export type SearchAPIResponse<
       UserType
     >;
   }[];
+  next?: string;
+  previous?: string;
+  results_warning?: SearchWarning;
 };
 
+export type SearchWarning = {
+  channel_search_cids: string[];
+  channel_search_count: number;
+  warning_code: number;
+  warning_description: string;
+};
 export type SendFileAPIResponse = APIResponse & { file: string };
 
 export type SendMessageAPIResponse<
@@ -935,9 +944,11 @@ export type QueryMembersOptions = {
   user_id_lte?: string;
 };
 
-export type SearchOptions = {
+export type SearchOptions<MessageType = UnknownType> = {
   limit?: number;
+  next?: string;
   offset?: number;
+  sort?: SearchMessageSort<MessageType>;
 };
 
 export type StreamChatOptions = AxiosRequestConfig & {
@@ -1407,9 +1418,34 @@ export type UserSort<UserType = UnknownType> =
   | Sort<UserResponse<UserType>>
   | Array<Sort<UserResponse<UserType>>>;
 
-export type QuerySort<ChannelType = UnknownType, UserType = UnknownType> =
+export type SearchMessageSortBase<MessageType = UnknownType> = Sort<MessageType> & {
+  attachments?: AscDesc;
+  'attachments.type'?: AscDesc;
+  created_at?: AscDesc;
+  id?: AscDesc;
+  'mentioned_users.id'?: AscDesc;
+  parent_id?: AscDesc;
+  pinned?: AscDesc;
+  relevance?: AscDesc;
+  reply_count?: AscDesc;
+  text?: AscDesc;
+  type?: AscDesc;
+  updated_at?: AscDesc;
+  'user.id'?: AscDesc;
+};
+
+export type SearchMessageSort<MessageType = UnknownType> =
+  | SearchMessageSortBase<MessageType>
+  | Array<SearchMessageSortBase<MessageType>>;
+
+export type QuerySort<
+  ChannelType = UnknownType,
+  UserType = UnknownType,
+  MessageType = UnknownType
+> =
   | BannedUsersSort
   | ChannelSort<ChannelType>
+  | SearchMessageSort<MessageType>
   | UserSort<UserType>;
 
 /**
@@ -1898,7 +1934,7 @@ export type SearchPayload<
   MessageType = UnknownType,
   ReactionType = UnknownType,
   UserType = UnknownType
-> = SearchOptions & {
+> = Omit<SearchOptions<MessageType>, 'sort'> & {
   client_id?: string;
   connection_id?: string;
   filter_conditions?: ChannelFilters<ChannelType, CommandType, UserType>;
@@ -1911,6 +1947,10 @@ export type SearchPayload<
     UserType
   >;
   query?: string;
+  sort?: Array<{
+    direction: AscDesc;
+    field: Extract<keyof SearchMessageSortBase<MessageType>, string>;
+  }>;
 };
 
 export type TestPushDataInput = {

src/utils.ts

@@ -102,7 +102,7 @@ export function normalizeQuerySort<T extends QuerySort>(sort: T) {
   const sortArr = Array.isArray(sort) ? sort : [sort];
   for (const item of sortArr) {
     const entries = (Object.entries(item) as unknown) as [
-      T extends (infer K)[] ? keyof K : keyof T,
+      T extends (infer K)[] ? Extract<keyof K, string> : Extract<keyof T, string>,
       AscDesc,
     ][];
     if (entries.length > 1) {

test/unit/channel.js

@@ -425,3 +425,34 @@ describe('event subscription and unsubscription', () => {
 		expect(channel.listeners['all'].length).to.be.equal(0);
 	});
 });
+describe('Channel search', async () => {
+	const client = await getClientWithUser();
+	const channel = client.channel('messaging', uuidv4());
+
+	it('search with sorting by defined field', async () => {
+		client.get = (url, config) => {
+			expect(config.payload.sort).to.be.eql([
+				{ field: 'updated_at', direction: -1 },
+			]);
+		};
+		await channel.search('query', { sort: [{ updated_at: -1 }] });
+	});
+	it('search with sorting by custom field', async () => {
+		client.get = (url, config) => {
+			expect(config.payload.sort).to.be.eql([
+				{ field: 'custom_field', direction: -1 },
+			]);
+		};
+		await channel.search('query', { sort: [{ custom_field: -1 }] });
+	});
+	it('sorting and offset fails', async () => {
+		await expect(
+			channel.search('query', { offset: 1, sort: [{ custom_field: -1 }] }),
+		).to.be.rejectedWith(Error);
+	});
+	it('next and offset fails', async () => {
+		await expect(
+			channel.search('query', { offset: 1, next: 'next' }),
+		).to.be.rejectedWith(Error);
+	});
+});

test/unit/client.js

@@ -1,11 +1,12 @@
 import chai from 'chai';
-
+import chaiAsPromised from 'chai-as-promised';
 import { generateMsg } from './test-utils/generateMessage';
 import { getClientWithUser } from './test-utils/getClient';
 
 import { StreamChat } from '../../src/client';
 
 const expect = chai.expect;
+chai.use(chaiAsPromised);
 
 describe('StreamChat getInstance', () => {
 	beforeEach(() => {
@@ -268,3 +269,44 @@ describe('updateMessage should ensure sanity of `mentioned_users`', () => {
 		);
 	});
 });
+
+describe('Client search', async () => {
+	const client = await getClientWithUser();
+
+	it('search with sorting by defined field', async () => {
+		client.get = (url, config) => {
+			expect(config.payload.sort).to.be.eql([
+				{ field: 'updated_at', direction: -1 },
+			]);
+		};
+		await client.search({ cid: 'messaging:my-cid' }, 'query', {
+			sort: [{ updated_at: -1 }],
+		});
+	});
+	it('search with sorting by custom field', async () => {
+		client.get = (url, config) => {
+			expect(config.payload.sort).to.be.eql([
+				{ field: 'custom_field', direction: -1 },
+			]);
+		};
+		await client.search({ cid: 'messaging:my-cid' }, 'query', {
+			sort: [{ custom_field: -1 }],
+		});
+	});
+	it('sorting and offset fails', async () => {
+		await expect(
+			client.search({ cid: 'messaging:my-cid' }, 'query', {
+				offset: 1,
+				sort: [{ custom_field: -1 }],
+			}),
+		).to.be.rejectedWith(Error);
+	});
+	it('next and offset fails', async () => {
+		await expect(
+			client.search({ cid: 'messaging:my-cid' }, 'query', {
+				offset: 1,
+				next: 'next',
+			}),
+		).to.be.rejectedWith(Error);
+	});
+});