stream-chat 9.28.0 → 9.30.0

package/dist/types/CooldownTimer.d.ts

@@ -0,0 +1,45 @@
+import { StateStore } from './store';
+import { WithSubscriptions } from './utils/WithSubscriptions';
+import type { Channel } from './channel';
+export type CooldownTimerState = {
+    /**
+     * Slow mode cooldown interval in seconds. Change reported via channel.updated WS event.
+     */
+    cooldownConfigSeconds: number;
+    /**
+     * Whether the current user can skip slow mode. Change is not reported via WS.
+     */
+    canSkipCooldown: boolean;
+    /**
+     * Latest message creation date authored by the current user in this channel. Change reported via message.new WS event.
+     */
+    ownLatestMessageDate?: Date;
+    /**
+     * Remaining cooldown in whole seconds (rounded).
+     */
+    cooldownRemaining: number;
+};
+export declare class CooldownTimer extends WithSubscriptions {
+    readonly state: StateStore<CooldownTimerState>;
+    private timeout;
+    private channel;
+    constructor({ channel }: {
+        channel: Channel;
+    });
+    get cooldownConfigSeconds(): number;
+    get cooldownRemaining(): number;
+    get canSkipCooldown(): boolean;
+    get ownLatestMessageDate(): Date | undefined;
+    registerSubscriptions: () => void;
+    setCooldownRemaining: (cooldownRemaining: number) => void;
+    clearTimeout: () => void;
+    refresh: () => void;
+    /**
+     * Updates the known latest own message date and recomputes remaining time.
+     * Prefer calling this when you already know the message date (e.g. from an event).
+     */
+    setOwnLatestMessageDate: (date: Date | undefined) => void;
+    private getOwnUserId;
+    private findOwnLatestMessageDate;
+    private recalculate;
+}

package/dist/types/channel.d.ts

@@ -1,8 +1,9 @@
 import { ChannelState } from './channel_state';
+import { CooldownTimer } from './CooldownTimer';
 import { MessageComposer } from './messageComposer';
 import { MessageReceiptsTracker } from './messageDelivery';
 import type { StreamChat } from './client';
-import type { AIState, APIResponse, AscDesc, BanUserOptions, ChannelAPIResponse, ChannelData, ChannelMemberAPIResponse, ChannelMemberResponse, ChannelQueryOptions, ChannelResponse, ChannelUpdateOptions, CreateDraftResponse, DeleteChannelAPIResponse, DraftMessagePayload, Event, EventAPIResponse, EventHandler, EventTypes, GetDraftResponse, GetMultipleMessagesAPIResponse, GetReactionsAPIResponse, GetRepliesAPIResponse, LiveLocationPayload, LocalMessage, MarkReadOptions, MarkUnreadOptions, MemberFilters, MemberSort, Message, MessageFilters, MessageOptions, MessagePaginationOptions, MessageResponse, MessageSetType, MuteChannelAPIResponse, NewMemberPayload, PartialUpdateChannel, PartialUpdateChannelAPIResponse, PartialUpdateMember, PartialUpdateMemberAPIResponse, PinnedMessagePaginationOptions, PinnedMessagesSort, PollVoteData, PushPreference, QueryChannelAPIResponse, QueryMembersOptions, Reaction, ReactionAPIResponse, SearchAPIResponse, SearchOptions, SendMessageAPIResponse, SendMessageOptions, SendReactionOptions, StaticLocationPayload, TruncateChannelAPIResponse, TruncateOptions, UpdateChannelAPIResponse, UpdateChannelOptions, UpdateLocationPayload, UserResponse } from './types';
+import type { AIState, APIResponse, AscDesc, BanUserOptions, ChannelAPIResponse, ChannelData, ChannelMemberAPIResponse, ChannelMemberResponse, ChannelQueryOptions, ChannelResponse, ChannelUpdateOptions, CreateDraftResponse, DeleteChannelAPIResponse, DraftMessagePayload, Event, EventAPIResponse, EventHandler, EventTypes, GetDraftResponse, GetMultipleMessagesAPIResponse, GetReactionsAPIResponse, GetRepliesAPIResponse, LiveLocationPayload, LocalMessage, MarkReadOptions, MarkUnreadOptions, MemberFilters, MemberSort, Message, MessageFilters, MessageOptions, MessagePaginationOptions, MessageResponse, MessageSetType, MuteChannelAPIResponse, NewMemberPayload, PartialUpdateChannel, PartialUpdateChannelAPIResponse, PartialUpdateMember, PartialUpdateMemberAPIResponse, PinnedMessagePaginationOptions, PinnedMessagesSort, PollVoteData, PushPreference, QueryChannelAPIResponse, QueryMembersOptions, Reaction, ReactionAPIResponse, SearchAPIResponse, SearchOptions, SendMessageAPIResponse, SendMessageOptions, SendReactionOptions, StaticLocationPayload, TruncateChannelAPIResponse, TruncateOptions, UnBanUserOptions, UpdateChannelAPIResponse, UpdateChannelOptions, UpdateLocationPayload, UserResponse } from './types';
 import type { Role } from './permissions';
 /**
  * Channel - The Channel class manages it's own state.
@@ -41,6 +42,7 @@ export declare class Channel {
     push_preferences?: PushPreference;
     readonly messageComposer: MessageComposer;
     readonly messageReceiptsTracker: MessageReceiptsTracker;
+    readonly cooldownTimer: CooldownTimer;
     /**
      * constructor - Create a channel
      *
@@ -610,9 +612,10 @@ export declare class Channel {
      * unbanUser - Removes the bans for a user on a channel
      *
      * @param {string} targetUserID
+     * @param {UnBanUserOptions} options
      * @returns {Promise<APIResponse>}
      */
-    unbanUser(targetUserID: string): Promise<APIResponse>;
+    unbanUser(targetUserID: string, options?: UnBanUserOptions): Promise<APIResponse>;
     /**
      * shadowBan - Shadow bans a user from a channel
      *

package/dist/types/channel_state.d.ts

@@ -109,7 +109,7 @@ export declare class ChannelState {
      *
      */
     removePinnedMessage(message: MessageResponse): void;
-    addReaction(reaction: ReactionResponse, message?: MessageResponse, enforce_unique?: boolean): MessageResponse | LocalMessage | undefined;
+    addReaction(reaction: ReactionResponse, message?: MessageResponse, enforce_unique?: boolean): LocalMessage | MessageResponse | 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, 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, GetBlockedUsersAPIResponse, GetCampaignOptions, GetChannelTypeResponse, GetCommandResponse, GetHookEventsResponse, GetImportResponse, GetMessageOptions, GetPollAPIResponse, GetRateLimitsResponse, GetThreadAPIResponse, GetThreadOptions, GetUnreadCountAPIResponse, GetUnreadCountBatchAPIResponse, ListChannelResponse, ListCommandsResponse, ListImportsPaginationOptions, ListImportsResponse, 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, Product, PushPreference, PushProvider, PushProviderConfig, PushProviderID, PushProviderListResponse, PushProviderUpsertResponse, QueryDraftsResponse, QueryMessageHistoryFilters, QueryMessageHistoryOptions, QueryMessageHistoryResponse, QueryMessageHistorySort, QueryPollsFilters, QueryPollsOptions, QueryPollsResponse, QueryReactionsAPIResponse, QueryReactionsOptions, QueryRemindersOptions, QueryRemindersResponse, QuerySegmentsOptions, QuerySegmentTargetsFilter, QueryThreadsOptions, QueryVotesFilters, QueryVotesOptions, ReactionFilters, ReactionResponse, ReactionSort, ReactivateUserOptions, ReactivateUsersOptions, ReminderAPIResponse, ReviewFlagReportOptions, ReviewFlagReportResponse, SdkIdentifier, SearchAPIResponse, SearchOptions, SegmentData, SegmentResponse, SegmentTargetsResponse, SegmentType, SendFileAPIResponse, SharedLocationResponse, SortParam, StreamChatOptions, SyncOptions, SyncResponse, TaskResponse, TaskStatus, TestPushDataInput, TestSNSDataInput, TestSQSDataInput, TokenOrProvider, TranslateResponse, UnBanUserOptions, UpdateChannelsBatchOptions, UpdateChannelTypeRequest, UpdateChannelTypeResponse, UpdateCommandOptions, UpdateCommandResponse, UpdateLocationPayload, UpdateMessageAPIResponse, UpdateMessageOptions, UpdatePollAPIResponse, UpdateReminderOptions, UpdateSegmentData, UpdateUsersAPIResponse, UpsertPushPreferencesResponse, UserCustomEvent, UserFilters, UserOptions, UserResponse, UserSort, VoteSort } from './types';
+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, 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, QueryThreadsOptions, QueryVotesFilters, QueryVotesOptions, ReactionFilters, ReactionResponse, ReactionSort, ReactivateUserOptions, ReactivateUsersOptions, ReminderAPIResponse, ReviewFlagReportOptions, ReviewFlagReportResponse, SdkIdentifier, SearchAPIResponse, SearchOptions, SegmentData, SegmentResponse, SegmentTargetsResponse, SegmentType, SendFileAPIResponse, 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 { ErrorFromResponse } from './types';
 import { InsightMetrics } from './insights';
 import { Thread } from './thread';
@@ -484,6 +484,13 @@ export declare class StreamChat {
      * @return {Promise<BannedUsersResponse>} Ban Query Response
      */
     queryBannedUsers(filterConditions?: BannedUsersFilters, sort?: BannedUsersSort, options?: BannedUsersPaginationOptions): Promise<BannedUsersResponse>;
+    /**
+     * queryFutureChannelBans - Query future channel bans created by a user
+     *
+     * @param {QueryFutureChannelBansOptions} options Option object with user_id, exclude_expired_bans, limit, offset
+     * @returns {Promise<FutureChannelBansResponse>} Future Channel Bans Response
+     */
+    queryFutureChannelBans(options?: QueryFutureChannelBansOptions): Promise<FutureChannelBansResponse>;
     /**
      * queryMessageFlags - Query message flags
      *
@@ -496,10 +503,10 @@ export declare class StreamChat {
     /**
      * queryChannelsRequest - Queries channels and returns the raw response
      *
-     * @param {ChannelFilters} filterConditions object MongoDB style filters
+     * @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
+     * @param {ChannelOptions} [options] Options object. Can include predefined_filter, filter_values, and sort_values for using predefined filters.
      *
      * @return {Promise<Array<ChannelAPIResponse>>} search channels response
      */
@@ -1986,5 +1993,46 @@ export declare class StreamChat {
     updateChannelsBatch(payload: UpdateChannelsBatchOptions): Promise<APIResponse & {
         result: Record<string, string>;
     } & Partial<TaskResponse>>;
+    /**
+     * createPredefinedFilter - Creates a new predefined filter (server-side only)
+     *
+     * @param {CreatePredefinedFilterOptions} options Predefined filter options
+     *
+     * @return {Promise<PredefinedFilterResponse>} The created predefined filter
+     */
+    createPredefinedFilter(options: CreatePredefinedFilterOptions): Promise<PredefinedFilterResponse>;
+    /**
+     * getPredefinedFilter - Gets a predefined filter by name (server-side only)
+     *
+     * @param {string} name Predefined filter name
+     *
+     * @return {Promise<PredefinedFilterResponse>} The predefined filter
+     */
+    getPredefinedFilter(name: string): Promise<PredefinedFilterResponse>;
+    /**
+     * updatePredefinedFilter - Updates a predefined filter (server-side only)
+     *
+     * @param {string} name Predefined filter name
+     * @param {UpdatePredefinedFilterOptions} options Predefined filter options
+     *
+     * @return {Promise<PredefinedFilterResponse>} The updated predefined filter
+     */
+    updatePredefinedFilter(name: string, options: UpdatePredefinedFilterOptions): Promise<PredefinedFilterResponse>;
+    /**
+     * deletePredefinedFilter - Deletes a predefined filter (server-side only)
+     *
+     * @param {string} name Predefined filter name
+     *
+     * @return {Promise<APIResponse>} The server response
+     */
+    deletePredefinedFilter(name: string): Promise<APIResponse>;
+    /**
+     * listPredefinedFilters - Lists all predefined filters (server-side only)
+     *
+     * @param {ListPredefinedFiltersOptions} options Query options
+     *
+     * @return {Promise<ListPredefinedFiltersResponse>} The list of predefined filters
+     */
+    listPredefinedFilters(options?: ListPredefinedFiltersOptions): Promise<ListPredefinedFiltersResponse>;
 }
 export {};

package/dist/types/index.d.ts

@@ -6,6 +6,7 @@ export * from './client_state';
 export * from './channel';
 export * from './channel_state';
 export * from './connection';
+export { type CooldownTimerState } from './CooldownTimer';
 export * from './events';
 export * from './insights';
 export * from './messageComposer';

package/dist/types/insights.d.ts

@@ -16,7 +16,7 @@ export declare class InsightMetrics {
  */
 export declare const postInsights: (insightType: InsightTypes, insights: Record<string, unknown>) => Promise<void>;
 export declare function buildWsFatalInsight(connection: StableWSConnection, event: Record<string, unknown>): {
-    ready_state: 0 | 1 | 2 | 3 | undefined;
+    ready_state: 0 | 2 | 1 | 3 | undefined;
     url: string;
     api_key: string;
     start_ts: number | null;
@@ -36,7 +36,7 @@ export declare function buildWsFatalInsight(connection: StableWSConnection, even
     instance_client_id: string;
 };
 export declare function buildWsSuccessAfterFailureInsight(connection: StableWSConnection): {
-    ready_state: 0 | 1 | 2 | 3 | undefined;
+    ready_state: 0 | 2 | 1 | 3 | undefined;
     url: string;
     api_key: string;
     start_ts: number | null;

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" | "video" | "audio" | "image";
+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

@@ -57,12 +57,12 @@ export declare class MessageComposer extends WithSubscriptions {
     locationComposer: LocationComposer;
     customDataManager: CustomDataManager;
     constructor({ composition, config, compositionContext, client, }: MessageComposerOptions);
-    static evaluateContextType(compositionContext: CompositionContext): "message" | "channel" | "thread" | "legacy_thread";
+    static evaluateContextType(compositionContext: CompositionContext): "channel" | "message" | "thread" | "legacy_thread";
     static constructTag(compositionContext: CompositionContext): `${ReturnType<typeof MessageComposer.evaluateContextType>}_${string}`;
     static generateId: typeof generateUUIDv4;
     get config(): MessageComposerConfig;
-    get contextType(): "message" | "channel" | "thread" | "legacy_thread";
-    get tag(): `message_${string}` | `channel_${string}` | `thread_${string}` | `legacy_thread_${string}`;
+    get contextType(): "channel" | "message" | "thread" | "legacy_thread";
+    get tag(): `channel_${string}` | `message_${string}` | `thread_${string}` | `legacy_thread_${string}`;
     get threadId(): string | null;
     get client(): StreamChat;
     get id(): string;

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

@@ -21,12 +21,12 @@ export declare class CommandSearchSource extends BaseSearchSourceSync<CommandSug
     };
     query(searchQuery: string): {
         items: {
-            id: "all" | "ban" | "fun_set" | "giphy" | "moderation_set" | "mute" | "unban" | "unmute";
+            id: "all" | "mute" | "unmute" | "giphy" | "ban" | "fun_set" | "moderation_set" | "unban";
             created_at?: string | undefined;
             updated_at?: string | undefined;
             args?: string;
             description?: string;
-            name: "all" | "ban" | "fun_set" | "giphy" | "moderation_set" | "mute" | "unban" | "unmute";
+            name: "all" | "mute" | "unmute" | "giphy" | "ban" | "fun_set" | "moderation_set" | "unban";
             set?: import("../../..").CommandVariants;
         }[];
         next: null;

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

@@ -55,10 +55,18 @@ export type BaseLocalAttachmentMetadata = {
 };
 export type LocalAttachmentUploadMetadata = {
     file: File | FileReference;
+    /**
+     * Local preview URI, typically a Blob URL from `URL.createObjectURL(file)`
+     * or (for React Native `FileReference`) the provided `uri`.
+     */
+    previewUri?: string;
     uploadState: AttachmentLoadingState;
     uploadPermissionCheck?: UploadPermissionCheckResult;
 };
 export type LocalImageAttachmentUploadMetadata = LocalAttachmentUploadMetadata & {
+    /**
+     * @deprecated `previewUri` is now available on `LocalAttachmentUploadMetadata`.
+     */
     previewUri?: string;
 };
 export type LocalNotImageAttachment = LocalFileAttachment | LocalAudioAttachment | LocalVideoAttachment | LocalVoiceRecordingAttachment;

package/dist/types/types.d.ts

@@ -234,6 +234,23 @@ export type BannedUsersResponse = APIResponse & {
         timeout?: number;
     }>;
 };
+export type FutureChannelBan = {
+    user: UserResponse;
+    expires?: string;
+    reason?: string;
+    shadow?: boolean;
+    created_at: string;
+};
+export type FutureChannelBansResponse = APIResponse & {
+    bans: FutureChannelBan[];
+};
+export type QueryFutureChannelBansOptions = {
+    user_id?: string;
+    target_user_id?: string;
+    exclude_expired_bans?: boolean;
+    limit?: number;
+    offset?: number;
+};
 export type BlockListResponse = BlockList & {
     created_at?: string;
     type?: string;
@@ -847,6 +864,7 @@ export type BannedUsersPaginationOptions = Omit<PaginationOptions, 'id_gt' | 'id
     exclude_expired_bans?: boolean;
 };
 export type BanUserOptions = UnBanUserOptions & {
+    ban_from_future_channels?: boolean;
     banned_by?: UserResponse;
     banned_by_id?: string;
     ip_ban?: boolean;
@@ -863,6 +881,21 @@ export type ChannelOptions = {
     state?: boolean;
     user_id?: string;
     watch?: boolean;
+    /**
+     * Name of a predefined filter to use instead of filter_conditions.
+     * When provided, filter_conditions and sort parameters are ignored.
+     */
+    predefined_filter?: string;
+    /**
+     * Values to interpolate into the predefined filter template placeholders.
+     * Only used when predefined_filter is provided.
+     */
+    filter_values?: Record<string, unknown>;
+    /**
+     * Values to interpolate into the predefined filter sort template placeholders.
+     * Only used when predefined_filter is provided.
+     */
+    sort_values?: Record<string, unknown>;
 };
 export type ChannelQueryOptions = {
     client_id?: string;
@@ -1287,6 +1320,7 @@ export type UnBanUserOptions = {
     client_id?: string;
     connection_id?: string;
     id?: string;
+    remove_future_channels_ban?: boolean;
     shadow?: boolean;
     target_user_id?: string;
     type?: string;
@@ -3326,4 +3360,43 @@ export type UpdateChannelsBatchFilters = QueryFilters<{
 export type UpdateChannelsBatchResponse = {
     result: Record<string, string>;
 } & Partial<TaskResponse>;
+/**
+ * Predefined Filter Types
+ */
+export type PredefinedFilterOperation = 'QueryChannels';
+export type PredefinedFilterSortParam = {
+    field: string;
+    direction?: AscDesc;
+    type?: string;
+};
+export type PredefinedFilter = {
+    name: string;
+    operation: PredefinedFilterOperation;
+    filter: Record<string, unknown>;
+    created_at: string;
+    updated_at: string;
+    description?: string;
+    sort?: PredefinedFilterSortParam[];
+    query_id?: number;
+};
+export type CreatePredefinedFilterOptions = {
+    name: string;
+    operation: PredefinedFilterOperation;
+    filter: Record<string, unknown>;
+    description?: string;
+    sort?: PredefinedFilterSortParam[];
+};
+export type UpdatePredefinedFilterOptions = Omit<CreatePredefinedFilterOptions, 'name'>;
+export type PredefinedFilterResponse = APIResponse & {
+    predefined_filter: PredefinedFilter;
+};
+export type ListPredefinedFiltersResponse = APIResponse & {
+    predefined_filters: PredefinedFilter[];
+    next?: string;
+    prev?: string;
+};
+export type PredefinedFilterSort = SortParam[];
+export type ListPredefinedFiltersOptions = Pager & {
+    sort?: PredefinedFilterSort;
+};
 export {};

package/dist/types/utils.d.ts

@@ -87,6 +87,10 @@ export declare const toDeletedMessage: ({ message, deletedAt, hardDelete, }: {
     attachments: never[];
     type: string;
     deleted_at: Date | null;
+    text?: string | undefined;
+    user_id?: string | undefined;
+    user?: (UserResponse | null) | undefined;
+    channel?: import("./types").ChannelResponse | undefined;
     command?: string | undefined;
     mentioned_users?: UserResponse[] | undefined;
     latest_reactions?: import("./types").ReactionResponse[] | undefined;
@@ -99,10 +103,9 @@ export declare const toDeletedMessage: ({ message, deletedAt, hardDelete, }: {
         language: import("./types").TranslationLanguages;
     }) | undefined;
     html?: string | undefined;
-    user?: (UserResponse | null) | undefined;
+    parent_id?: string | undefined;
     id: string;
     mml?: string | undefined;
-    parent_id?: string | undefined;
     pin_expires?: string | null | undefined;
     pinned?: boolean | undefined;
     poll_id?: string | undefined;
@@ -110,11 +113,8 @@ export declare const toDeletedMessage: ({ message, deletedAt, hardDelete, }: {
     restricted_visibility?: string[] | undefined;
     show_in_channel?: boolean | undefined;
     silent?: boolean | undefined;
-    text?: string | undefined;
-    user_id?: string | undefined;
     args?: string | undefined;
     before_message_send_failed?: boolean | undefined;
-    channel?: import("./types").ChannelResponse | undefined;
     cid?: string | undefined;
     command_info?: {
         name?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stream-chat",
-  "version": "9.28.0",
+  "version": "9.30.0",
   "description": "JS SDK for the Stream Chat API",
   "homepage": "https://getstream.io/chat/",
   "author": {

package/src/CooldownTimer.ts

@@ -0,0 +1,196 @@
+import { StateStore } from './store';
+import type { ChannelResponse, LocalMessage } from './types';
+import { WithSubscriptions } from './utils/WithSubscriptions';
+import type { Channel } from './channel';
+
+export type CooldownTimerState = {
+  /**
+   * Slow mode cooldown interval in seconds. Change reported via channel.updated WS event.
+   */
+  cooldownConfigSeconds: number;
+  /**
+   * Whether the current user can skip slow mode. Change is not reported via WS.
+   */
+  canSkipCooldown: boolean;
+  /**
+   * Latest message creation date authored by the current user in this channel. Change reported via message.new WS event.
+   */
+  ownLatestMessageDate?: Date;
+  /**
+   * Remaining cooldown in whole seconds (rounded).
+   */
+  cooldownRemaining: number;
+};
+
+const toDateOrUndefined = (value: unknown): Date | undefined => {
+  if (value instanceof Date) return value;
+  if (typeof value === 'string' || typeof value === 'number') {
+    const parsed = new Date(value);
+    if (!Number.isNaN(parsed.getTime())) return parsed;
+  }
+  return undefined;
+};
+
+export class CooldownTimer extends WithSubscriptions {
+  public readonly state: StateStore<CooldownTimerState>;
+  private timeout: ReturnType<typeof setTimeout> | null = null;
+  private channel: Channel;
+
+  constructor({ channel }: { channel: Channel }) {
+    super();
+    this.channel = channel;
+    this.state = new StateStore<CooldownTimerState>({
+      cooldownConfigSeconds: 0,
+      cooldownRemaining: 0,
+      ownLatestMessageDate: undefined,
+      canSkipCooldown: false,
+    });
+    this.refresh();
+  }
+
+  get cooldownConfigSeconds() {
+    return this.state.getLatestValue().cooldownConfigSeconds;
+  }
+
+  get cooldownRemaining() {
+    return this.state.getLatestValue().cooldownRemaining;
+  }
+
+  get canSkipCooldown() {
+    return this.state.getLatestValue().canSkipCooldown;
+  }
+
+  get ownLatestMessageDate() {
+    return this.state.getLatestValue().ownLatestMessageDate;
+  }
+
+  public registerSubscriptions = () => {
+    this.incrementRefCount();
+    if (this.hasSubscriptions) return;
+
+    this.addUnsubscribeFunction(
+      this.channel.on('message.new', (event) => {
+        const isOwnMessage =
+          event.message?.user?.id && event.message.user.id === this.getOwnUserId();
+        if (!isOwnMessage) return;
+        this.setOwnLatestMessageDate(toDateOrUndefined(event.message?.created_at));
+      }).unsubscribe,
+    );
+
+    this.addUnsubscribeFunction(
+      this.channel.on('channel.updated', (event) => {
+        const cooldownChanged = event.channel?.cooldown !== this.cooldownConfigSeconds;
+        if (!cooldownChanged) return;
+        this.refresh();
+      }).unsubscribe,
+    );
+  };
+
+  public setCooldownRemaining = (cooldownRemaining: number) => {
+    this.state.partialNext({ cooldownRemaining });
+  };
+
+  public clearTimeout = () => {
+    if (!this.timeout) return;
+    clearTimeout(this.timeout);
+    this.timeout = null;
+  };
+
+  public refresh = () => {
+    const { cooldown: cooldownConfigSeconds = 0, own_capabilities } = (this.channel
+      .data ?? {}) as Partial<ChannelResponse>;
+    const canSkipCooldown = (own_capabilities ?? []).includes('skip-slow-mode');
+
+    const ownLatestMessageDate = this.findOwnLatestMessageDate({
+      messages: this.channel.state.latestMessages,
+    });
+
+    if (
+      cooldownConfigSeconds !== this.cooldownConfigSeconds ||
+      ownLatestMessageDate?.getTime() !== this.ownLatestMessageDate?.getTime() ||
+      canSkipCooldown !== this.canSkipCooldown
+    ) {
+      this.state.partialNext({
+        cooldownConfigSeconds,
+        ownLatestMessageDate,
+        canSkipCooldown,
+      });
+    }
+
+    if (this.canSkipCooldown || this.cooldownConfigSeconds === 0) {
+      this.clearTimeout();
+      if (this.cooldownRemaining !== 0) {
+        this.setCooldownRemaining(0);
+      }
+      return;
+    }
+
+    this.recalculate();
+  };
+
+  /**
+   * Updates the known latest own message date and recomputes remaining time.
+   * Prefer calling this when you already know the message date (e.g. from an event).
+   */
+  public setOwnLatestMessageDate = (date: Date | undefined) => {
+    this.state.partialNext({ ownLatestMessageDate: date });
+    this.recalculate();
+  };
+
+  private getOwnUserId() {
+    const client = this.channel.getClient();
+    return client.userID ?? client.user?.id;
+  }
+
+  private findOwnLatestMessageDate({
+    messages,
+  }: {
+    messages: LocalMessage[];
+  }): Date | undefined {
+    const ownUserId = this.getOwnUserId();
+    if (!ownUserId) return undefined;
+
+    let latest: Date | undefined;
+    for (let i = messages.length - 1; i >= 0; i -= 1) {
+      const message = messages[i];
+      if (message.user?.id !== ownUserId) continue;
+      const createdAt = toDateOrUndefined(message.created_at);
+      if (!createdAt) continue;
+      if (!latest || createdAt.getTime() > latest.getTime()) {
+        latest = createdAt;
+      }
+      if (latest.getTime() > createdAt.getTime()) break;
+    }
+    return latest;
+  }
+
+  private recalculate = () => {
+    this.clearTimeout();
+
+    const { cooldownConfigSeconds, ownLatestMessageDate, canSkipCooldown } =
+      this.state.getLatestValue();
+
+    const timeSinceOwnLastMessage =
+      ownLatestMessageDate != null
+        ? // prevent negative values
+          Math.max(0, (Date.now() - ownLatestMessageDate.getTime()) / 1000)
+        : undefined;
+
+    const remaining =
+      !canSkipCooldown &&
+      typeof timeSinceOwnLastMessage !== 'undefined' &&
+      cooldownConfigSeconds > timeSinceOwnLastMessage
+        ? Math.round(cooldownConfigSeconds - timeSinceOwnLastMessage)
+        : 0;
+
+    if (remaining !== this.cooldownRemaining) {
+      this.setCooldownRemaining(remaining);
+    }
+
+    if (remaining <= 0) return;
+
+    this.timeout = setTimeout(() => {
+      this.recalculate();
+    }, 1000);
+  };
+}