web-api(fix):Update SearchMessagesArguments to support cursor pagination (#2361)

vegeris · web-flow · commit 16bd88edb318 · 2025-10-23T16:24:06.000-04:00
diff --git a/packages/web-api/src/types/request/search.ts b/packages/web-api/src/types/request/search.ts
@@ -12,9 +12,23 @@ interface Searchable extends OptionalTeamAssignable, SortDir {
   sort?: 'score' | 'timestamp';
 }
 
+interface SearchMessagesCursorPagination {
+  /**
+   * @description Paginate through collections of data by setting the `cursor` parameter to `*` for the first "page"
+   * or a `next_cursor` attribute returned by a previous request's `response_metadata`.
+   * Use the `count` parameter to set the number of items to return per page rather than `limit`.
+   * @see {@link https://docs.slack.dev/apis/web-api/pagination pagination} for more detail.
+   */
+  cursor?: string;
+}
+
 // https://docs.slack.dev/reference/methods/search.all
 export interface SearchAllArguments extends TokenOverridable, TraditionalPagingEnabled, Searchable {}
 // https://docs.slack.dev/reference/methods/search.files
 export interface SearchFilesArguments extends TokenOverridable, TraditionalPagingEnabled, Searchable {}
 // https://docs.slack.dev/reference/methods/search.messages
-export interface SearchMessagesArguments extends TokenOverridable, TraditionalPagingEnabled, Searchable {}
+export interface SearchMessagesArguments
+  extends TokenOverridable,
+    TraditionalPagingEnabled,
+    Searchable,
+    SearchMessagesCursorPagination {}
diff --git a/packages/web-api/test/types/methods/search.test-d.ts b/packages/web-api/test/types/methods/search.test-d.ts
@@ -35,3 +35,10 @@ expectAssignable<Parameters<typeof web.search.messages>>([
     query: '1234', // must specify query
   },
 ]);
+expectAssignable<Parameters<typeof web.search.messages>>([
+  {
+    query: '1234',
+    cursor: '*', // optional: enable cursor pagination
+    count: 30, // optional: the number of results to return per page
+  },
+]);
