stream-chat 9.44.1 → 9.45.0

package/dist/types/channel_manager.d.ts

@@ -1,4 +1,4 @@
-import type { StreamChat } from './client';
+import type { QueryChannelsResponseWithChannels, StreamChat } from './client';
 import type { ChannelFilters, ChannelOptions, ChannelSort, ChannelStateOptions, Event } from './types';
 import type { ValueOrPatch } from './store';
 import { StateStore } from './store';
@@ -10,6 +10,8 @@ export type ChannelManagerPagination = {
     isLoading: boolean;
     isLoadingNext: boolean;
     options: ChannelOptions;
+    responseFilters?: ChannelFilters;
+    responseSort?: ChannelSort;
     sort: ChannelSort;
 };
 export type ChannelManagerState = {
@@ -64,7 +66,8 @@ export type ChannelManagerOptions = {
      */
     lockChannelOrder?: boolean;
 };
-export type QueryChannelsRequestType = (...params: Parameters<StreamChat['queryChannels']>) => Promise<Channel[]>;
+export type QueryChannelsRequestOutput = Channel[] | QueryChannelsResponseWithChannels;
+export type QueryChannelsRequestType = (filters: ChannelFilters, sort?: ChannelSort, options?: ChannelOptions, stateOptions?: ChannelStateOptions) => Promise<QueryChannelsRequestOutput>;
 export declare const DEFAULT_CHANNEL_MANAGER_OPTIONS: {
     abortInFlightQuery: boolean;
     allowNotLoadedChannelPromotionForEvent: {

package/dist/types/channel_state.d.ts

@@ -111,7 +111,7 @@ export declare class ChannelState {
      *
      */
     removePinnedMessage(message: MessageResponse): void;
-    addReaction(reaction: ReactionResponse, message?: MessageResponse, enforce_unique?: boolean): LocalMessage | MessageResponse | undefined;
+    addReaction(reaction: ReactionResponse, message?: MessageResponse, enforce_unique?: boolean): MessageResponse | LocalMessage | undefined;
     _addReactionToState(messageFromState: LocalMessage, reaction: ReactionResponse, enforce_unique?: boolean): LocalMessage;
     _addOwnReactionToMessage(ownReactions: ReactionResponse[] | null | undefined, reaction: ReactionResponse, enforce_unique?: boolean): ReactionResponse[];
     _removeOwnReactionFromMessage(ownReactions: ReactionResponse[] | null | undefined, reaction: ReactionResponse): ReactionResponse[] | null | undefined;

package/dist/types/client.d.ts

@@ -8,7 +8,7 @@ import { WSConnectionFallback } from './connection_fallback';
 import { Campaign } from './campaign';
 import { ChannelBatchUpdater } from './channel_batch_updater';
 import { Segment } from './segment';
-import type { ActiveLiveLocationsAPIResponse, APIErrorResponse, APIResponse, AppSettings, AppSettingsAPIResponse, BannedUsersFilters, BannedUsersPaginationOptions, BannedUsersResponse, BannedUsersSort, BanUserOptions, BaseDeviceFields, BlockList, BlockListResponse, BlockUserAPIResponse, CampaignData, CampaignFilters, CampaignQueryOptions, CampaignResponse, CampaignSort, CastVoteAPIResponse, ChannelAPIResponse, ChannelData, ChannelFilters, ChannelMute, ChannelOptions, ChannelResponse, ChannelSort, ChannelStateOptions, CheckPushResponse, CheckSNSResponse, CheckSQSResponse, Configs, ConnectAPIResponse, CreateChannelOptions, CreateChannelResponse, CreateCommandOptions, CreateCommandResponse, CreateImportOptions, CreateImportResponse, CreateImportURLResponse, CreatePollAPIResponse, CreatePollData, CreatePollOptionAPIResponse, CreatePredefinedFilterOptions, CreateReminderOptions, CustomPermissionOptions, DeactivateUsersOptions, DeleteCommandResponse, DeleteMessageOptions, DeleteUserOptions, Device, DeviceIdentifier, DraftFilters, DraftSort, EndpointName, Event, EventAPIResponse, EventHandler, ExportChannelOptions, ExportChannelRequest, ExportChannelResponse, ExportChannelStatusResponse, ExportUsersRequest, ExportUsersResponse, FlagMessageResponse, FlagReportsFilters, FlagReportsPaginationOptions, FlagReportsResponse, FlagsFilters, FlagsPaginationOptions, FlagsResponse, FlagUserResponse, FutureChannelBansResponse, GetBlockedUsersAPIResponse, GetCampaignOptions, GetChannelTypeResponse, GetCommandResponse, GetHookEventsResponse, GetImportResponse, GetMessageOptions, GetPollAPIResponse, GetRateLimitsResponse, GetRetentionPolicyResponse, GetRetentionPolicyRunsOptions, GetRetentionPolicyRunsResponse, GetThreadAPIResponse, GetThreadOptions, GetUnreadCountAPIResponse, GetUnreadCountBatchAPIResponse, ListChannelResponse, ListCommandsResponse, ListImportsPaginationOptions, ListImportsResponse, ListPredefinedFiltersOptions, ListPredefinedFiltersResponse, LocalMessage, Logger, MarkChannelsReadOptions, MarkDeliveredOptions, MessageFilters, MessageFlagsFilters, MessageFlagsPaginationOptions, MessageFlagsResponse, MessageResponse, Mute, MuteUserOptions, MuteUserResponse, OGAttachment, OwnUserResponse, Pager, PartialMessageUpdate, PartialPollUpdate, PartialThreadUpdate, PartialUserUpdate, PermissionAPIResponse, PermissionsAPIResponse, PollAnswersAPIResponse, PollData, PollOptionData, PollSort, PollVote, PollVoteData, PollVotesAPIResponse, PredefinedFilterResponse, Product, PushPreference, PushProvider, PushProviderConfig, PushProviderID, PushProviderListResponse, PushProviderUpsertResponse, QueryDraftsResponse, QueryFutureChannelBansOptions, QueryMessageHistoryFilters, QueryMessageHistoryOptions, QueryMessageHistoryResponse, QueryMessageHistorySort, QueryPollsFilters, QueryPollsOptions, QueryPollsResponse, QueryReactionsAPIResponse, QueryReactionsOptions, QueryRemindersOptions, QueryRemindersResponse, QuerySegmentsOptions, QuerySegmentTargetsFilter, QueryTeamUsageStatsOptions, QueryTeamUsageStatsResponse, QueryThreadsOptions, QueryVotesFilters, QueryVotesOptions, ReactionFilters, ReactionResponse, ReactionSort, ReactivateUserOptions, ReactivateUsersOptions, ReminderAPIResponse, ReviewFlagReportOptions, ReviewFlagReportResponse, SdkIdentifier, SearchAPIResponse, SearchOptions, SegmentData, SegmentResponse, SegmentTargetsResponse, SegmentType, SendFileAPIResponse, SetRetentionPolicyResponse, SharedLocationResponse, SortParam, StreamChatOptions, SyncOptions, SyncResponse, TaskResponse, TaskStatus, TestPushDataInput, TestSNSDataInput, TestSQSDataInput, TokenOrProvider, TranslateResponse, UnBanUserOptions, UpdateChannelsBatchOptions, UpdateChannelTypeRequest, UpdateChannelTypeResponse, UpdateCommandOptions, UpdateCommandResponse, UpdateLocationPayload, UpdateMessageAPIResponse, UpdateMessageOptions, UpdatePollAPIResponse, UpdatePredefinedFilterOptions, UpdateReminderOptions, UpdateSegmentData, UpdateUsersAPIResponse, UpsertPushPreferencesResponse, UserCustomEvent, UserFilters, UserOptions, UserResponse, UserSort, VoteSort } from './types';
+import type { ActiveLiveLocationsAPIResponse, AddUserGroupMembersOptions, AddUserGroupMembersResponse, APIErrorResponse, APIResponse, AppSettings, AppSettingsAPIResponse, BannedUsersFilters, BannedUsersPaginationOptions, BannedUsersResponse, BannedUsersSort, BanUserOptions, BaseDeviceFields, BlockList, BlockListResponse, BlockUserAPIResponse, CampaignData, CampaignFilters, CampaignQueryOptions, CampaignResponse, CampaignSort, CastVoteAPIResponse, ChannelAPIResponse, ChannelData, ChannelFilters, ChannelMute, ChannelOptions, ChannelResponse, ChannelSort, ChannelStateOptions, CheckPushResponse, CheckSNSResponse, CheckSQSResponse, Configs, ConnectAPIResponse, CreateChannelOptions, CreateChannelResponse, CreateCommandOptions, CreateCommandResponse, CreateImportOptions, CreateImportResponse, CreateImportURLResponse, CreatePollAPIResponse, CreatePollData, CreatePollOptionAPIResponse, CreatePredefinedFilterOptions, CreateReminderOptions, CreateRoleAPIResponse, CreateUserGroupOptions, CreateUserGroupResponse, CustomPermissionOptions, DeactivateUsersOptions, DeleteCommandResponse, DeleteMessageOptions, DeleteUserGroupOptions, DeleteUserOptions, Device, DeviceIdentifier, DraftFilters, DraftSort, EndpointName, Event, EventAPIResponse, EventHandler, ExportChannelOptions, ExportChannelRequest, ExportChannelResponse, ExportChannelStatusResponse, ExportUsersRequest, ExportUsersResponse, FlagMessageResponse, FlagReportsFilters, FlagReportsPaginationOptions, FlagReportsResponse, FlagsFilters, FlagsPaginationOptions, FlagsResponse, FlagUserResponse, FutureChannelBansResponse, GetBlockedUsersAPIResponse, GetCampaignOptions, GetChannelTypeResponse, GetCommandResponse, GetHookEventsResponse, GetImportResponse, GetMessageOptions, GetPollAPIResponse, GetRateLimitsResponse, GetRetentionPolicyResponse, GetRetentionPolicyRunsOptions, GetRetentionPolicyRunsResponse, GetThreadAPIResponse, GetThreadOptions, GetUnreadCountAPIResponse, GetUnreadCountBatchAPIResponse, GetUserGroupOptions, GetUserGroupResponse, ListChannelResponse, ListCommandsResponse, ListImportsPaginationOptions, ListImportsResponse, ListPredefinedFiltersOptions, ListPredefinedFiltersResponse, ListRolesAPIResponse, LocalMessage, Logger, MarkChannelsReadOptions, MarkDeliveredOptions, MessageFilters, MessageFlagsFilters, MessageFlagsPaginationOptions, MessageFlagsResponse, MessageResponse, Mute, MuteUserOptions, MuteUserResponse, OGAttachment, OwnUserResponse, Pager, PartialMessageUpdate, PartialPollUpdate, PartialThreadUpdate, PartialUserUpdate, PermissionAPIResponse, PermissionsAPIResponse, PollAnswersAPIResponse, PollData, PollOptionData, PollSort, PollVote, PollVoteData, PollVotesAPIResponse, PredefinedFilterResponse, Product, PushPreference, PushProvider, PushProviderConfig, PushProviderID, PushProviderListResponse, PushProviderUpsertResponse, QueryChannelsAPIResponse, QueryDraftsResponse, QueryFutureChannelBansOptions, QueryMessageHistoryFilters, QueryMessageHistoryOptions, QueryMessageHistoryResponse, QueryMessageHistorySort, QueryPollsFilters, QueryPollsOptions, QueryPollsResponse, QueryReactionsAPIResponse, QueryReactionsOptions, QueryRemindersOptions, QueryRemindersResponse, QuerySegmentsOptions, QuerySegmentTargetsFilter, QueryTeamUsageStatsOptions, QueryTeamUsageStatsResponse, QueryThreadsOptions, QueryUserGroupsOptions, QueryUserGroupsResponse, QueryVotesFilters, QueryVotesOptions, ReactionFilters, ReactionResponse, ReactionSort, ReactivateUserOptions, ReactivateUsersOptions, ReminderAPIResponse, RemoveUserGroupMembersOptions, RemoveUserGroupMembersResponse, ReviewFlagReportOptions, ReviewFlagReportResponse, SdkIdentifier, SearchAPIResponse, SearchOptions, SearchRolesAPIResponse, SearchRolesOptions, SearchUserGroupsOptions, SearchUserGroupsResponse, SegmentData, SegmentResponse, SegmentTargetsResponse, SegmentType, SendFileAPIResponse, SetRetentionPolicyResponse, SharedLocationResponse, SortParam, StreamChatOptions, SyncOptions, SyncResponse, TaskResponse, TaskStatus, TestPushDataInput, TestSNSDataInput, TestSQSDataInput, TokenOrProvider, TranslateResponse, UnBanUserOptions, UpdateChannelsBatchOptions, UpdateChannelTypeRequest, UpdateChannelTypeResponse, UpdateCommandOptions, UpdateCommandResponse, UpdateLocationPayload, UpdateMessageAPIResponse, UpdateMessageOptions, UpdatePollAPIResponse, UpdatePredefinedFilterOptions, UpdateReminderOptions, UpdateSegmentData, UpdateUserGroupOptions, UpdateUserGroupResponse, UpdateUsersAPIResponse, UpsertPushPreferencesResponse, UserCustomEvent, UserFilters, UserOptions, UserResponse, UserSort, VoteSort } from './types';
 import { ErrorFromResponse } from './types';
 import { InsightMetrics } from './insights';
 import { Thread } from './thread';
@@ -24,6 +24,9 @@ import { StateStore } from './store';
 import type { MessageComposer } from './messageComposer';
 import type { AbstractOfflineDB } from './offline-support';
 type MessageComposerTearDownFunction = () => void;
+export type QueryChannelsResponseWithChannels = Omit<QueryChannelsAPIResponse, 'channels'> & {
+    channels: Channel[];
+};
 type MessageComposerSetupFunction = ({ composer, }: {
     composer: MessageComposer;
 }) => void | MessageComposerTearDownFunction;
@@ -486,6 +489,75 @@ export declare class StreamChat {
     queryUsers(filterConditions: UserFilters, sort?: UserSort, options?: UserOptions): Promise<APIResponse & {
         users: Array<UserResponse>;
     }>;
+    /**
+     * queryUserGroups - List user groups with cursor-based pagination.
+     *
+     * @param {QueryUserGroupsOptions} options The query options
+     *
+     * @return {Promise<QueryUserGroupsResponse>} User Group Query Response
+     */
+    queryUserGroups(options?: QueryUserGroupsOptions): Promise<QueryUserGroupsResponse>;
+    /**
+     * createUserGroup - Create a user group
+     *
+     * @param {CreateUserGroupOptions} options The create options
+     *
+     * @return {Promise<CreateUserGroupResponse>} User Group Create Response
+     */
+    createUserGroup(options: CreateUserGroupOptions): Promise<CreateUserGroupResponse>;
+    /**
+     * getUserGroup - Get a user group by ID
+     *
+     * @param {string} id The user group ID
+     * @param {GetUserGroupOptions} options Optional query options
+     *
+     * @return {Promise<GetUserGroupResponse>} User Group Get Response
+     */
+    getUserGroup(id: string, options?: GetUserGroupOptions): Promise<GetUserGroupResponse>;
+    /**
+     * searchUserGroups - Search user groups by prefix for autocomplete
+     *
+     * @param {SearchUserGroupsOptions} options The search options
+     *
+     * @return {Promise<SearchUserGroupsResponse>} User Group Search Response
+     */
+    searchUserGroups(options: SearchUserGroupsOptions): Promise<SearchUserGroupsResponse>;
+    /**
+     * updateUserGroup - Update a user group by ID
+     *
+     * @param {string} id The user group ID
+     * @param {UpdateUserGroupOptions} options The update options
+     *
+     * @return {Promise<UpdateUserGroupResponse>} User Group Update Response
+     */
+    updateUserGroup(id: string, options: UpdateUserGroupOptions): Promise<UpdateUserGroupResponse>;
+    /**
+     * deleteUserGroup - Delete a user group by ID
+     *
+     * @param {string} id The user group ID
+     * @param {DeleteUserGroupOptions} options Optional query options
+     *
+     * @return {Promise<APIResponse>} User Group Delete Response
+     */
+    deleteUserGroup(id: string, options?: DeleteUserGroupOptions): Promise<APIResponse>;
+    /**
+     * addUserGroupMembers - Add members to a user group
+     *
+     * @param {string} id The user group ID
+     * @param {AddUserGroupMembersOptions} options The add-members options
+     *
+     * @return {Promise<AddUserGroupMembersResponse>} User Group Add Members Response
+     */
+    addUserGroupMembers(id: string, options: AddUserGroupMembersOptions): Promise<AddUserGroupMembersResponse>;
+    /**
+     * removeUserGroupMembers - Remove members from a user group
+     *
+     * @param {string} id The user group ID
+     * @param {RemoveUserGroupMembersOptions} options The remove-members options
+     *
+     * @return {Promise<RemoveUserGroupMembersResponse>} User Group Remove Members Response
+     */
+    removeUserGroupMembers(id: string, options: RemoveUserGroupMembersOptions): Promise<RemoveUserGroupMembersResponse>;
     /**
      * queryBannedUsers - Query user bans
      *
@@ -513,7 +585,29 @@ export declare class StreamChat {
      */
     queryMessageFlags(filterConditions?: MessageFlagsFilters, options?: MessageFlagsPaginationOptions): Promise<MessageFlagsResponse>;
     /**
-     * queryChannelsRequest - Queries channels and returns the raw response
+     * queryChannelsRequestWithResponse - Queries channels and returns the full API response
+     * including top-level metadata such as `predefined_filter`.
+     *
+     * This exists as a compatibility bridge, as changing `queryChannelsRequest()` to return
+     * `QueryChannelsAPIResponse` would be a breaking change because it currently returns
+     * only the channel list. In the next major release, the request/response APIs should
+     * be consolidated so callers can access the full response through the primary API.
+     *
+     * @param {ChannelFilters} filterConditions object MongoDB style filters. Can be empty object when using predefined_filter in options.
+     * @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. Can include predefined_filter, filter_values, and sort_values for using predefined filters.
+     *
+     * @return {Promise<QueryChannelsAPIResponse>} full search channels response
+     */
+    queryChannelsRequestWithResponse(filterConditions: ChannelFilters, sort?: ChannelSort, options?: ChannelOptions): Promise<QueryChannelsAPIResponse>;
+    /**
+     * queryChannelsRequest - Queries channels and returns the raw channel response list.
+     *
+     * This preserves the historical return shape for backwards compatibility. Use
+     * `queryChannelsRequestWithResponse()` when response level metadata such as
+     * `predefined_filter` is needed. In the next major release these APIs should be
+     * consolidated into a single full-response API.
      *
      * @param {ChannelFilters} filterConditions object MongoDB style filters. Can be empty object when using predefined_filter in options.
      * @param {ChannelSort} [sort] Sort options, for instance {created_at: -1}.
@@ -533,10 +627,14 @@ export declare class StreamChat {
      * @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.
+     * - stateOptions.withResponse - Returns the full query response with hydrated channels. This is a compatibility bridge for internal callers that need response-level metadata while the default return value remains `Channel[]`.
      *
      * @return {Promise<Array<Channel>>} search channels response
      */
-    queryChannels(filterConditions: ChannelFilters, sort?: ChannelSort, options?: ChannelOptions, stateOptions?: ChannelStateOptions): Promise<Channel[]>;
+    queryChannels(filterConditions: ChannelFilters, sort: ChannelSort, options: ChannelOptions, stateOptions: ChannelStateOptions & {
+        withResponse: true;
+    }): Promise<QueryChannelsResponseWithChannels>;
+    queryChannels(filterConditions?: ChannelFilters, sort?: ChannelSort, options?: ChannelOptions, stateOptions?: ChannelStateOptions): Promise<Channel[]>;
     /**
      * queryReactions - Query reactions
      *
@@ -1032,6 +1130,8 @@ export declare class StreamChat {
         mentioned_users?: UserResponse[];
         mentioned_channel?: boolean;
         mentioned_here?: boolean;
+        mentioned_group_ids?: string[];
+        mentioned_groups?: import("./types").UserGroupResponse[];
         mentioned_roles?: string[];
         message_text_updated_at?: string;
         moderation?: import("./types").ModerationResponse;
@@ -1313,12 +1413,17 @@ export declare class StreamChat {
      * @param {string} name the new role name
      * @returns {Promise<APIResponse>}
      */
-    createRole(name: string): Promise<APIResponse>;
+    createRole(name: string): Promise<CreateRoleAPIResponse>;
+    /** listRoles - returns the list of all roles for this application
+     *
+     * @returns {Promise<APIResponse>}
+     */
+    listRoles(): Promise<ListRolesAPIResponse>;
     /** listRoles - returns the list of all roles for this application
      *
      * @returns {Promise<APIResponse>}
      */
-    listRoles(): Promise<APIResponse>;
+    searchRoles(options: SearchRolesOptions): Promise<SearchRolesAPIResponse>;
     /** deleteRole - deletes a custom role
      *
      * @param {string} name the role name
@@ -1763,6 +1868,8 @@ export declare class StreamChat {
         mentioned_users?: UserResponse[];
         mentioned_channel?: boolean;
         mentioned_here?: boolean;
+        mentioned_group_ids?: string[];
+        mentioned_groups?: import("./types").UserGroupResponse[];
         mentioned_roles?: string[];
         message_text_updated_at?: string;
         moderation?: import("./types").ModerationResponse;

package/dist/types/constants.d.ts

@@ -13,6 +13,7 @@ export declare const RESERVED_UPDATED_MESSAGE_FIELDS: Readonly<{
     pinned_at: true;
     updated_at: true;
     command: true;
+    mentioned_groups: true;
     mentioned_users: true;
     quoted_message: true;
     latest_reactions: true;

package/dist/types/messageComposer/LocationComposer.d.ts

@@ -22,7 +22,7 @@ export declare class LocationComposer {
     readonly composer: MessageComposer;
     private _deviceId;
     constructor({ composer, message }: LocationComposerOptions);
-    get config(): import("./configuration").LocationComposerConfig;
+    get config(): import("..").LocationComposerConfig;
     get deviceId(): string;
     get location(): StaticLocationPayload | LiveLocationPreview | null;
     get validLocation(): StaticLocationPayload | LiveLocationPayload | null;

package/dist/types/messageComposer/configuration/commands.configuration.d.ts

@@ -0,0 +1,6 @@
+import type { CommandsConfig, CommandSendValidator, MessageComposerConfig } from './types';
+import type { DeepPartial } from '../../types.utility';
+export declare const MENTION_ONLY_COMMANDS: Set<string>;
+export declare const defaultCommandSendabilityValidator: CommandSendValidator;
+export declare const DEFAULT_COMMANDS_CONFIG: CommandsConfig;
+export declare const applyCommandValidatorOverride: (targetConfig: MessageComposerConfig, sourceConfig?: DeepPartial<MessageComposerConfig>) => MessageComposerConfig;

package/dist/types/messageComposer/configuration/configuration.d.ts

@@ -1,5 +1,4 @@
-import type { AttachmentManagerConfig, LinkPreviewsManagerConfig, LocationComposerConfig, MessageComposerConfig } from './types';
-import type { TextComposerConfig } from './types';
+import type { AttachmentManagerConfig, LinkPreviewsManagerConfig, LocationComposerConfig, MessageComposerConfig, TextComposerConfig } from './types';
 export declare const DEFAULT_LINK_PREVIEW_MANAGER_CONFIG: LinkPreviewsManagerConfig;
 export declare const DEFAULT_ATTACHMENT_MANAGER_CONFIG: AttachmentManagerConfig;
 export declare const DEFAULT_TEXT_COMPOSER_CONFIG: TextComposerConfig;

package/dist/types/messageComposer/configuration/index.d.ts

@@ -1,2 +1,6 @@
 export * from './configuration';
 export * from './types';
+export { applyCommandValidatorOverride } from './commands.configuration';
+export { DEFAULT_COMMANDS_CONFIG } from './commands.configuration';
+export { defaultCommandSendabilityValidator } from './commands.configuration';
+export { MENTION_ONLY_COMMANDS } from './commands.configuration';

package/dist/types/messageComposer/configuration/types.d.ts

@@ -1,6 +1,8 @@
 import type { LinkPreview } from '../linkPreviewsManager';
 import type { FileUploadFilter } from '../attachmentManager';
+import type { MessageComposer } from '../messageComposer';
 import type { FileLike, FileReference } from '../types';
+import type { CommandResponse, UserResponse } from '../../types';
 export type MinimumUploadRequestResult = {
     file: string;
     thumb_url?: string;
@@ -30,6 +32,23 @@ export type TextComposerConfig = {
     /** Prevents sending a message longer than this length */
     maxLengthOnSend?: number;
 };
+export type CommandSendability = {
+    command: CommandResponse;
+    ready: boolean;
+    reason?: string & {};
+    metadata?: Record<string, unknown>;
+};
+export type CommandSendValidationContext = {
+    command: CommandResponse;
+    composer: MessageComposer;
+    commandArgsText: string;
+    mentionedUsersInText: UserResponse[];
+    rawText: string;
+};
+export type CommandSendValidator = (context: CommandSendValidationContext) => CommandSendability | undefined;
+export type CommandsConfig = {
+    sendValidator: CommandSendValidator;
+};
 export type AttachmentManagerConfig = {
     /**
      * Function that allows to prevent uploading files based on the functions output.
@@ -74,6 +93,8 @@ export type LocationComposerConfig = {
 export type MessageComposerConfig = {
     /** If true, enables creating drafts on the server */
     drafts: DraftsConfiguration;
+    /** Configuration for command sendability validation */
+    commands: CommandsConfig;
     /** Configuration for the attachment manager */
     attachments: AttachmentManagerConfig;
     /** Configuration for the link previews manager */

package/dist/types/messageComposer/fileUtils.d.ts

@@ -13,5 +13,5 @@ export declare const getExtensionFromMimeType: (mimeType: string) => string | un
 export declare const readFileAsArrayBuffer: (file: File) => Promise<ArrayBuffer>;
 export declare const generateFileName: (mimeType: string) => string;
 export declare const isImageFile: (fileLike: FileReference | FileLike) => boolean;
-export declare const getAttachmentTypeFromMimeType: (mimeType: string) => "file" | "image" | "audio" | "video";
+export declare const getAttachmentTypeFromMimeType: (mimeType: string) => "file" | "audio" | "video" | "image";
 export declare const ensureIsLocalAttachment: (attachment: Attachment | LocalAttachment) => LocalAttachment | null;

package/dist/types/messageComposer/messageComposer.d.ts

@@ -14,7 +14,7 @@ import { Thread } from '../thread';
 import type { ChannelAPIResponse, CommandResponse, DraftResponse, LocalMessage, LocalMessageBase, MessageResponse } from '../types';
 import { WithSubscriptions } from '../utils/WithSubscriptions';
 import type { StreamChat } from '../client';
-import type { MessageComposerConfig } from './configuration/types';
+import type { CommandSendability, MessageComposerConfig } from './configuration/types';
 import type { CommandSuggestionDisabledReason, TextComposerCommandActivationEffect, TextComposerCommandClearEffect } from './middleware/textComposer/types';
 import type { AttachmentManagerSnapshot } from './attachmentManager';
 import type { CustomDataManagerSnapshot } from './CustomDataManager';
@@ -101,10 +101,12 @@ export declare class MessageComposer extends WithSubscriptions {
     get draftId(): string | null;
     get lastChange(): LastComposerChange;
     get quotedMessage(): LocalMessageBase | null;
-    getCommandDisabledReason: (command: CommandResponse) => CommandSuggestionDisabledReason | undefined;
-    isCommandDisabled: (command: CommandResponse) => boolean;
     get pollId(): string | null;
     get showReplyInChannel(): boolean;
+    getCommandDisabledReason: (command: CommandResponse) => CommandSuggestionDisabledReason | undefined;
+    isCommandDisabled: (command: CommandResponse) => boolean;
+    validateCommandSendability: (command: CommandResponse, text?: string) => CommandSendability;
+    get isCommandSendable(): boolean;
     get hasSendableData(): boolean;
     get compositionIsEmpty(): boolean;
     get contentIsEmpty(): boolean;
@@ -149,7 +151,7 @@ export declare class MessageComposer extends WithSubscriptions {
     clear: () => void;
     restore: () => void;
     compose: () => Promise<MessageComposerMiddlewareValue["state"] | undefined>;
-    composeDraft: () => Promise<import("./middleware").MessageDraftComposerMiddlewareValueState | undefined>;
+    composeDraft: () => Promise<import("..").MessageDraftComposerMiddlewareValueState | undefined>;
     createDraft: () => Promise<void>;
     deleteDraft: () => Promise<void>;
     getDraft: () => Promise<void>;

package/dist/types/messageComposer/middleware/messageComposer/compositionValidation.d.ts

@@ -1,4 +1,5 @@
+import { CommandSearchSource } from '../textComposer/commands';
 import type { MessageCompositionMiddleware, MessageDraftCompositionMiddleware } from './types';
 import type { MessageComposer } from '../../messageComposer';
-export declare const createCompositionValidationMiddleware: (composer: MessageComposer) => MessageCompositionMiddleware;
+export declare const createCompositionValidationMiddleware: (composer: MessageComposer, commandSearchSource?: CommandSearchSource) => MessageCompositionMiddleware;
 export declare const createDraftCompositionValidationMiddleware: (composer: MessageComposer) => MessageDraftCompositionMiddleware;

package/dist/types/messageComposer/middleware/messageComposer/textComposer.d.ts

@@ -1,4 +1,4 @@
-import type { MessageCompositionMiddleware, MessageDraftCompositionMiddleware } from './types';
 import type { MessageComposer } from '../../messageComposer';
+import type { MessageCompositionMiddleware, MessageDraftCompositionMiddleware } from './types';
 export declare const createTextComposerCompositionMiddleware: (composer: MessageComposer) => MessageCompositionMiddleware;
 export declare const createDraftTextComposerCompositionMiddleware: (composer: MessageComposer) => MessageDraftCompositionMiddleware;

package/dist/types/messageComposer/middleware/textComposer/commandUtils.d.ts

@@ -1,7 +1,16 @@
 import type { MessageComposer } from '../../messageComposer';
-import type { CommandResponse } from '../../../types';
+import type { CommandResponse, UserResponse } from '../../../types';
+import type { CommandSendability } from '../../configuration';
+import type { CommandSearchSource } from './commands';
 export declare function escapeCommandRegExp(text: string): string;
 export declare const getRawCommandName: (text?: string) => string | undefined;
 export declare const getCompleteCommandInString: (text: string) => string | null;
 export declare const stripCommandFromText: (text: string, commandName: string) => string;
+export declare const stripMentionTokens: (text: string, mentionedUsersInText: UserResponse[], trigger?: string) => string;
+export declare const getMentionedUsersInText: (text: string, mentionedUsers: UserResponse[]) => UserResponse[];
+export declare const getCommandByName: (searchSource: CommandSearchSource, commandName?: string) => CommandResponse | undefined;
 export declare const notifyCommandDisabled: (composer: MessageComposer, command: CommandResponse) => true | undefined;
+export declare const notifyCommandNotReady: ({ composer, sendability, }: {
+    composer: MessageComposer;
+    sendability: CommandSendability;
+}) => true | undefined;

package/dist/types/messageComposer/middleware/textComposer/mentionUtils.d.ts

@@ -0,0 +1,8 @@
+import type { UserResponse } from '../../../types';
+import type { MentionEntity, UserMentionEntity, UserSuggestion } from './types';
+export declare const isUserMentionEntity: (entity: MentionEntity) => entity is UserMentionEntity;
+export declare const userResponseToMentionEntity: (user: UserResponse) => UserMentionEntity;
+export declare const userResponsesToMentionEntities: (users: UserResponse[]) => UserMentionEntity[];
+export declare const mentionEntityToUserResponse: (entity: UserMentionEntity) => UserResponse;
+export declare const userSuggestionToUserResponse: (suggestion: UserSuggestion) => UserResponse;
+export declare const userSuggestionToMentionEntity: (suggestion: UserSuggestion) => UserMentionEntity;

package/dist/types/messageComposer/middleware/textComposer/mentions.d.ts

@@ -1,7 +1,7 @@
 import { BaseSearchSource, type SearchSourceOptions } from '../../../search';
-import type { TextComposerMiddlewareOptions, UserSuggestion } from './types';
+import type { ChannelMentionSuggestion, HereMentionSuggestion, MentionSuggestion, RoleMentionSuggestion, TextComposerMiddlewareOptions, UserGroupMentionSuggestion, UserSuggestion } from './types';
 import type { StreamChat } from '../../../client';
-import type { MemberFilters, MemberSort, UserFilters, UserOptions, UserResponse, UserSort } from '../../../types';
+import type { MemberFilters, MemberSort, UserFilters, UserGroupResponse, UserOptions, UserResponse, UserSort } from '../../../types';
 import type { Channel } from '../../../channel';
 import type { Middleware } from '../../../middleware';
 import type { TextComposerMiddlewareExecutorState } from './TextComposerMiddlewareExecutor';
@@ -11,14 +11,46 @@ export declare const accentsMap: {
 export declare const removeDiacritics: (text?: string) => string;
 export declare const calculateLevenshtein: (query: string, name: string) => number;
 export type MentionsSearchSourceOptions = SearchSourceOptions & {
+    allowedMentionTypes?: Partial<Record<MentionType, boolean>>;
     mentionAllAppUsers?: boolean;
+    suggestionFactoryMappers?: MentionSuggestionFactoryMapperOverrides;
     textComposerText?: string;
+    trigger?: string;
     transliterate?: (text: string) => string;
 };
-export declare class MentionsSearchSource extends BaseSearchSource<UserSuggestion> {
+type MentionType = MentionSuggestion['mentionType'];
+type MentionSuggestionFactoryInputByType = {
+    channel: 'channel';
+    here: 'here';
+    role: string;
+    user: UserResponse;
+    user_group: UserGroupResponse;
+};
+type MentionSuggestionByType = {
+    channel: ChannelMentionSuggestion;
+    here: HereMentionSuggestion;
+    role: RoleMentionSuggestion;
+    user: UserSuggestion;
+    user_group: UserGroupMentionSuggestion;
+};
+export type MentionSuggestionFactoryMapperContext = {
+    searchToken: string;
+    source: MentionsSearchSource;
+};
+export type MentionSuggestionFactoryMapper<TMentionType extends MentionType = MentionType> = (value: MentionSuggestionFactoryInputByType[TMentionType], context: MentionSuggestionFactoryMapperContext) => MentionSuggestionByType[TMentionType];
+export type MentionSuggestionFactoryMapperOverrides = {
+    [TMentionType in MentionType]?: MentionSuggestionFactoryMapper<TMentionType>;
+};
+type UserPaginationState = {
+    itemCount: number;
+    nextOffset?: number;
+};
+export declare class MentionsSearchSource extends BaseSearchSource<MentionSuggestion> {
     readonly type = "mentions";
     protected client: StreamChat;
     protected channel: Channel;
+    protected latestUserPaginationState?: UserPaginationState;
+    protected userGroupCursor?: string;
     userFilters: UserFilters | undefined;
     memberFilters: MemberFilters | undefined;
     userSort: UserSort | undefined;
@@ -27,9 +59,20 @@ export declare class MentionsSearchSource extends BaseSearchSource<UserSuggestio
     config: MentionsSearchSourceOptions;
     constructor(channel: Channel, options?: MentionsSearchSourceOptions);
     get allMembersLoadedWithInitialChannelQuery(): boolean;
-    toUserSuggestion: (user: UserResponse) => UserSuggestion;
+    normalizeSearchValue: (value?: string) => string;
+    matchesSearchQuery: (value: string | undefined, searchQuery: string) => boolean;
+    matchesPrefixSearchQuery: (value: string | undefined, searchQuery: string) => boolean;
+    matchesUserNameSearchQuery: (value: string | undefined, searchQuery: string) => boolean;
+    isMentionTypeAllowed: (mentionType: MentionType) => boolean;
+    protected mapMentionSuggestion: <TMentionType extends MentionType>(mentionType: TMentionType, value: MentionSuggestionFactoryInputByType[TMentionType], searchToken?: string) => MentionSuggestionByType[TMentionType];
+    getChannelTeam: () => string | undefined;
+    toUserSuggestion: (user: UserResponse, searchToken?: string) => UserSuggestion;
+    toChannelMentionSuggestion: (searchToken?: string) => ChannelMentionSuggestion;
+    toHereMentionSuggestion: (searchToken?: string) => HereMentionSuggestion;
+    toRoleMentionSuggestion: (role: string, searchToken?: string) => RoleMentionSuggestion;
+    toUserGroupMentionSuggestion: (userGroup: UserGroupResponse, searchToken?: string) => UserGroupMentionSuggestion;
     getStateBeforeFirstQuery(newSearchString: string): {
-        items: UserSuggestion[] | undefined;
+        items: MentionSuggestion[] | undefined;
         hasNext: boolean;
         isActive: boolean;
         isLoading: boolean;
@@ -39,36 +82,54 @@ export declare class MentionsSearchSource extends BaseSearchSource<UserSuggestio
         offset?: number;
     };
     canExecuteQuery: (newSearchString?: string) => boolean;
+    protected updatePaginationStateFromQuery(): {
+        hasNext: boolean;
+        next: undefined;
+        offset: number;
+    };
     transliterate: (text: string) => string;
     getMembersAndWatchers: () => UserResponse[];
+    getBuiltinMentionSuggestions: (searchQuery: string) => MentionSuggestion[];
+    getRoleMentionSuggestions: (query: string) => Promise<RoleMentionSuggestion[]>;
     searchMembersLocally: (searchQuery: string) => UserResponse[];
-    prepareQueryUsersParams: (searchQuery: string) => {
+    prepareQueryUsersParams: (searchQuery: string, offset?: number) => {
         filters: UserFilters;
         sort: UserSort;
         options: {
             limit: number;
-            offset: number | undefined;
+            offset: number;
             include_deactivated_users?: boolean;
             presence?: boolean;
         };
     };
-    prepareQueryMembersParams: (searchQuery: string) => {
+    prepareQueryMembersParams: (searchQuery: string, offset?: number) => {
         filters: MemberFilters;
         sort: MemberSort;
         options: {
             limit: number;
-            offset: number | undefined;
+            offset: number;
             include_deactivated_users?: boolean;
             presence?: boolean;
         };
     };
-    queryUsers: (searchQuery: string) => Promise<UserResponse[]>;
-    queryMembers: (searchQuery: string) => Promise<UserResponse[]>;
-    query(searchQuery: string): Promise<{
+    queryUsers: (searchQuery: string, offset?: number) => Promise<UserResponse[]>;
+    queryMembers: (searchQuery: string, offset?: number) => Promise<UserResponse[]>;
+    getUserSuggestionsPage: (searchQuery: string, userOffset?: number) => Promise<{
         items: UserSuggestion[];
+        nextOffset: number | undefined;
+    }>;
+    buildUserGroupSearchCursor: (items: UserGroupResponse[]) => string | undefined;
+    getUserGroupSuggestionsPage: (searchQuery: string, cursor?: string) => Promise<{
+        items: UserGroupMentionSuggestion[];
+        next: string | undefined;
+    }>;
+    query(searchQuery: string): Promise<{
+        items: MentionSuggestion[];
     }>;
-    filterMutes: (data: UserSuggestion[]) => UserSuggestion[];
-    filterQueryResults(items: UserSuggestion[]): UserSuggestion[];
+    filterMutes(data: UserSuggestion[]): UserSuggestion[];
+    filterMutes(data: MentionSuggestion[]): MentionSuggestion[];
+    filterQueryResults(items: MentionSuggestion[]): MentionSuggestion[];
+    resetState(): void;
 }
 /**
  * TextComposer middleware for mentions
@@ -88,7 +149,8 @@ export declare class MentionsSearchSource extends BaseSearchSource<UserSuggestio
  *   }} options
  * @returns
  */
-export type MentionsMiddleware = Middleware<TextComposerMiddlewareExecutorState<UserSuggestion>, 'onChange' | 'onSuggestionItemSelect'>;
+export type MentionsMiddleware = Middleware<TextComposerMiddlewareExecutorState<MentionSuggestion>, 'onChange' | 'onSuggestionItemSelect'>;
 export declare const createMentionsMiddleware: (channel: Channel, options?: Partial<TextComposerMiddlewareOptions> & {
     searchSource?: MentionsSearchSource;
 }) => MentionsMiddleware;
+export {};

package/dist/types/messageComposer/middleware/textComposer/types.d.ts

@@ -12,9 +12,54 @@ export type BaseSuggestion = {
 };
 export type CommandSuggestionDisabledReason = 'editing' | 'quoted_message';
 export type CommandSuggestion = BaseSuggestion & CommandResponse;
-export type UserSuggestion = BaseSuggestion & UserResponse & TokenizationPayload;
+export type UserSuggestion = BaseSuggestion & UserResponse & TokenizationPayload & {
+    mentionType: 'user';
+};
+export type ChannelMentionSuggestion = BaseSuggestion & TokenizationPayload & {
+    mentionType: 'channel';
+    name: 'channel';
+};
+export type HereMentionSuggestion = BaseSuggestion & TokenizationPayload & {
+    mentionType: 'here';
+    name: 'here';
+};
+export type RoleMentionSuggestion = BaseSuggestion & TokenizationPayload & {
+    mentionType: 'role';
+    name: string;
+};
+export type UserGroupMentionSuggestion = BaseSuggestion & TokenizationPayload & {
+    description?: string;
+    memberCount?: number;
+    mentionType: 'user_group';
+    name: string;
+};
+export type MentionSuggestion = UserSuggestion | ChannelMentionSuggestion | HereMentionSuggestion | RoleMentionSuggestion | UserGroupMentionSuggestion;
 export type CustomValidSuggestion = BaseSuggestion & CustomTextComposerSuggestion;
-export type Suggestion = CommandSuggestion | UserSuggestion | CustomValidSuggestion;
+export type Suggestion = CommandSuggestion | MentionSuggestion | CustomValidSuggestion;
+export type UserMentionEntity = UserResponse & {
+    mentionType: 'user';
+};
+export type ChannelMentionEntity = {
+    id: 'channel';
+    mentionType: 'channel';
+    name: 'channel';
+};
+export type HereMentionEntity = {
+    id: 'here';
+    mentionType: 'here';
+    name: 'here';
+};
+export type RoleMentionEntity = {
+    id: string;
+    mentionType: 'role';
+    name?: string;
+};
+export type UserGroupMentionEntity = {
+    id: string;
+    mentionType: 'user_group';
+    name?: string;
+};
+export type MentionEntity = UserMentionEntity | ChannelMentionEntity | HereMentionEntity | RoleMentionEntity | UserGroupMentionEntity;
 export type TextComposerStateSnapshot = TextComposerState;
 export type TextComposerCommandActivationStateToRestore = Partial<TextComposerStateSnapshot>;
 export type TextComposerCommandActivationEffect = {
@@ -43,7 +88,11 @@ export type TextSelection = {
     start: number;
 };
 export type TextComposerState<T extends Suggestion = Suggestion> = {
+    /**
+     * @deprecated Use `mentions` instead.
+     */
     mentionedUsers: UserResponse[];
+    mentions?: MentionEntity[];
     selection: TextSelection;
     text: string;
     command?: CommandResponse | null;

package/dist/types/messageComposer/pollComposer.d.ts

@@ -21,7 +21,7 @@ export declare class PollComposer {
     get id(): string;
     get max_votes_allowed(): string;
     get name(): string;
-    get options(): import("./middleware").PollComposerOption[];
+    get options(): import("..").PollComposerOption[];
     get user_id(): string | undefined;
     get voting_visibility(): VotingVisibility | undefined;
     get canCreatePoll(): boolean;
@@ -35,5 +35,5 @@ export declare class PollComposer {
      */
     updateFields: (data: UpdateFieldsData, injectedFieldErrors?: PollComposerFieldErrors) => Promise<void>;
     handleFieldBlur: (field: keyof PollComposerState["data"]) => Promise<void>;
-    compose: () => Promise<import("./middleware").PollComposerCompositionMiddlewareValueState | undefined>;
+    compose: () => Promise<import("..").PollComposerCompositionMiddlewareValueState | undefined>;
 }