stream-chat 9.47.1 → 9.48.0

package/dist/types/channel.d.ts

@@ -4,7 +4,7 @@ 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, UnBanUserOptions, UpdateChannelAPIResponse, UpdateChannelOptions, UpdateLocationPayload, UserResponse } from './types';
+import type { AIState, APIResponse, AscDesc, BanUserOptions, ChannelAPIResponse, ChannelData, ChannelMemberAPIResponse, ChannelMemberResponse, ChannelPushPreference, 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, 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.
@@ -40,7 +40,7 @@ export declare class Channel {
     lastTypingEvent: Date | null;
     isTyping: boolean;
     disconnected: boolean;
-    push_preferences?: PushPreference;
+    push_preferences?: ChannelPushPreference;
     readonly messageComposer: MessageComposer;
     readonly messageReceiptsTracker: MessageReceiptsTracker;
     readonly cooldownTimer: CooldownTimer;

package/dist/types/custom_types.d.ts

@@ -6,6 +6,8 @@ export interface CustomCommandData {
 }
 export interface CustomEventData {
 }
+export interface CustomEventTypes {
+}
 export interface CustomMemberData {
 }
 export interface CustomMessageData {

package/dist/types/index.d.ts

@@ -32,6 +32,6 @@ export * from './uploadManager';
 export * from './channel_manager';
 export * from './offline-support';
 export * from './LiveLocationManager';
-export type { CustomAttachmentData, CustomChannelData, CustomCommandData, CustomEventData, CustomMemberData, CustomMessageComposerData, CustomMessageData, CustomPollOptionData, CustomPollData, CustomReactionData, CustomUserData, CustomThreadData, } from './custom_types';
+export type { CustomAttachmentData, CustomChannelData, CustomCommandData, CustomEventData, CustomEventTypes, CustomMemberData, CustomMessageComposerData, CustomMessageData, CustomPollOptionData, CustomPollData, CustomReactionData, CustomUserData, CustomThreadData, } from './custom_types';
 export { isOwnUser, chatCodes, logChatPromiseExecution, localMessageToNewMessagePayload, formatMessage, promoteChannel, } from './utils';
 export { FixedSizeQueueCache } from './utils/FixedSizeQueueCache';

package/dist/types/thread.d.ts

@@ -49,6 +49,7 @@ export type ThreadUserReadState = {
     unreadMessageCount: number;
     user: UserResponse;
     lastReadMessageId?: string;
+    firstUnreadMessageId?: string;
 };
 export type ThreadReadState = Record<string, ThreadUserReadState | undefined>;
 export declare const THREAD_RESPONSE_RESERVED_KEYS: Record<keyof ThreadResponse, true>;
@@ -74,6 +75,7 @@ export declare class Thread extends WithSubscriptions {
     private subscribeMarkActiveThreadRead;
     private subscribeReloadActiveStaleThread;
     private subscribeMarkThreadStale;
+    private subscribeRepliesUnread;
     private subscribeNewReplies;
     private subscribeRepliesRead;
     private subscribeMessageDeleted;

package/dist/types/types.d.ts

@@ -3,7 +3,7 @@ import type { Channel } from './channel';
 import type { AxiosRequestConfig, AxiosResponse } from 'axios';
 import type { StableWSConnection } from './connection';
 import type { Role } from './permissions';
-import type { CustomAttachmentData, CustomChannelData, CustomCommandData, CustomEventData, CustomMemberData, CustomMessageData, CustomPollData, CustomPollOptionData, CustomReactionData, CustomThreadData, CustomUserData } from './custom_types';
+import type { CustomAttachmentData, CustomChannelData, CustomCommandData, CustomEventData, CustomEventTypes, CustomMemberData, CustomMessageData, CustomPollData, CustomPollOptionData, CustomReactionData, CustomThreadData, CustomUserData } from './custom_types';
 import type { NotificationManager } from './notifications';
 import type { RESERVED_UPDATED_MESSAGE_FIELDS } from './constants';
 /**
@@ -314,7 +314,7 @@ export type ChannelAPIResponse = {
     hidden?: boolean;
     membership?: ChannelMemberResponse | null;
     pending_messages?: PendingMessageResponse[];
-    push_preferences?: PushPreference;
+    push_preferences?: ChannelPushPreference;
     read?: ReadResponse[];
     threads?: ThreadResponse[];
     watcher_count?: number;
@@ -571,21 +571,51 @@ export type GetUnreadCountAPIResponse = APIResponse & {
     total_unread_threads_count: number;
     total_unread_count_by_team?: Record<string, number>;
 };
-export type ChatLevelPushPreference = 'all' | 'none' | 'mentions' | (string & {});
+export type ChatLevelPushPreference = 'all' | 'mentions' | 'direct_mentions' | 'all_mentions' | 'none' | 'default' | (string & {});
+export type CallLevelPushPreference = 'all' | 'none' | 'default' | (string & {});
+/** Granular all/none toggle used by the chat sub-preferences. */
+export type PushPreferenceLevel = 'all' | 'none' | (string & {});
+/** Per-mention-type chat push preferences (matches OpenAPI `ChatPreferencesInput`). */
+export type ChatPreferences = {
+    channel_mentions?: PushPreferenceLevel;
+    default_preference?: PushPreferenceLevel;
+    direct_mentions?: PushPreferenceLevel;
+    group_mentions?: PushPreferenceLevel;
+    here_mentions?: PushPreferenceLevel;
+    role_mentions?: PushPreferenceLevel;
+    thread_replies?: PushPreferenceLevel;
+};
+/**
+ * Input accepted by {@link StreamChat.setPushPreferences} (matches OpenAPI `PushPreferenceInput`).
+ *
+ * Set `channel_cid` to scope the preference to a single channel; leave it empty to
+ * set the user-level default. `user_id` is required for server-side auth and
+ * defaults to the connected user for client-side auth.
+ */
 export type PushPreference = {
-    callLevel?: 'all' | 'none' | (string & {});
-    chatLevel?: ChatLevelPushPreference;
-    disabledUntil?: string;
-    removeDisable?: boolean;
+    call_level?: CallLevelPushPreference;
+    channel_cid?: string;
+    chat_level?: ChatLevelPushPreference;
+    chat_preferences?: ChatPreferences;
+    disabled_until?: string;
+    remove_disable?: boolean;
+    user_id?: string;
 };
+/** Per-user push preferences returned by the API (matches OpenAPI `PushPreferencesResponse`). */
+export type PushPreferencesResponse = {
+    call_level?: CallLevelPushPreference;
+    chat_level?: ChatLevelPushPreference;
+    chat_preferences?: ChatPreferences;
+    disabled_until?: string;
+};
+/** Per-channel push preferences returned by the API (matches OpenAPI `ChannelPushPreferencesResponse`). */
 export type ChannelPushPreference = {
-    chatLevel?: ChatLevelPushPreference;
-    disabledUntil?: string;
-    removeDisable?: boolean;
+    chat_level?: ChatLevelPushPreference;
+    disabled_until?: string;
 };
 export type UpsertPushPreferencesResponse = APIResponse & {
-    userChannelPreferences: Record<string, Record<string, ChannelPushPreference>>;
-    userPreferences: Record<string, PushPreference>;
+    user_channel_preferences: Record<string, Record<string, ChannelPushPreference>>;
+    user_preferences: Record<string, PushPreferencesResponse>;
 };
 export type GetUnreadCountBatchAPIResponse = APIResponse & {
     counts_by_user: {
@@ -731,7 +761,7 @@ export type OwnUserBase = {
     unread_threads: number;
     invisible?: boolean;
     privacy_settings?: PrivacySettings;
-    push_preferences?: PushPreference;
+    push_preferences?: PushPreferencesResponse;
     roles?: string[];
     total_unread_count_by_team?: Record<string, number> | null;
 };
@@ -1473,12 +1503,13 @@ export type Event = CustomEventData & {
     watcher_count?: number;
     channel_last_message_at?: string;
     app?: Record<string, unknown>;
+    thread_id?: string;
 };
 export type UserCustomEvent = CustomEventData & {
     type: string;
 };
 export type EventHandler = (event: Event) => void;
-export type EventTypes = 'all' | keyof typeof EVENT_MAP;
+export type EventTypes = 'all' | keyof typeof EVENT_MAP | keyof CustomEventTypes;
 /**
  * Filter Types
  */

package/package.json

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

package/src/channel.ts

@@ -21,6 +21,7 @@ import type {
   ChannelFilters,
   ChannelMemberAPIResponse,
   ChannelMemberResponse,
+  ChannelPushPreference,
   ChannelQueryOptions,
   ChannelResponse,
   ChannelUpdateOptions,
@@ -56,7 +57,6 @@ import type {
   PinnedMessagePaginationOptions,
   PinnedMessagesSort,
   PollVoteData,
-  PushPreference,
   QueryChannelAPIResponse,
   QueryMembersOptions,
   Reaction,
@@ -112,7 +112,7 @@ export class Channel {
   lastTypingEvent: Date | null;
   isTyping: boolean;
   disconnected: boolean;
-  push_preferences?: PushPreference;
+  push_preferences?: ChannelPushPreference;
   public readonly messageComposer: MessageComposer;
   public readonly messageReceiptsTracker: MessageReceiptsTracker;
   public readonly cooldownTimer: CooldownTimer;

package/src/custom_types.ts

@@ -2,6 +2,7 @@ export interface CustomAttachmentData {}
 export interface CustomChannelData {}
 export interface CustomCommandData {}
 export interface CustomEventData {}
+export interface CustomEventTypes {}
 export interface CustomMemberData {}
 export interface CustomMessageData {}
 export interface CustomPollOptionData {}

package/src/index.ts

@@ -43,6 +43,7 @@ export type {
   CustomChannelData,
   CustomCommandData,
   CustomEventData,
+  CustomEventTypes,
   CustomMemberData,
   CustomMessageComposerData,
   CustomMessageData,

package/src/thread.ts

@@ -63,6 +63,7 @@ export type ThreadUserReadState = {
   unreadMessageCount: number;
   user: UserResponse;
   lastReadMessageId?: string;
+  firstUnreadMessageId?: string;
 };
 
 export type ThreadReadState = Record<string, ThreadUserReadState | undefined>;
@@ -272,6 +273,7 @@ export class Thread extends WithSubscriptions {
     this.addUnsubscribeFunction(this.subscribeMarkThreadStale());
     this.addUnsubscribeFunction(this.subscribeNewReplies());
     this.addUnsubscribeFunction(this.subscribeRepliesRead());
+    this.addUnsubscribeFunction(this.subscribeRepliesUnread());
     this.addUnsubscribeFunction(this.subscribeMessageDeleted());
     this.addUnsubscribeFunction(this.subscribeMessageUpdated());
   };
@@ -330,6 +332,33 @@ export class Thread extends WithSubscriptions {
       this.state.partialNext({ isStateStale: true });
     }).unsubscribe;
 
+  private subscribeRepliesUnread = () =>
+    this.client.on('notification.mark_unread', (event) => {
+      if (!event.user || !event.created_at || !event.thread_id) return;
+      if (event.thread_id !== this.id) return;
+
+      const userId = event.user.id;
+      const createdAt = event.created_at;
+      const user = event.user;
+
+      this.state.next((current) => ({
+        ...current,
+        read: {
+          ...current.read,
+          [userId]: {
+            ...current.read[userId],
+            lastReadAt:
+              typeof event.last_read_at !== 'undefined'
+                ? new Date(event.last_read_at)
+                : new Date(createdAt),
+            user,
+            firstUnreadMessageId: event.first_unread_message_id,
+            unreadMessageCount: event.unread_messages ?? 0,
+          },
+        },
+      }));
+    }).unsubscribe;
+
   private subscribeNewReplies = () =>
     this.client.on('message.new', (event) => {
       if (!this.client.userID || event.message?.parent_id !== this.id) {

package/src/thread_manager.ts

@@ -117,6 +117,7 @@ export class ThreadManager extends WithSubscriptions {
     const unsubscribeFunctions = [
       'health.check',
       'notification.mark_read',
+      'notification.mark_unread',
       'notification.thread_message_new',
       'notification.channel_deleted',
     ].map(

package/src/types.ts

@@ -8,6 +8,7 @@ import type {
   CustomChannelData,
   CustomCommandData,
   CustomEventData,
+  CustomEventTypes,
   CustomMemberData,
   CustomMessageData,
   CustomPollData,
@@ -379,7 +380,7 @@ export type ChannelAPIResponse = {
   hidden?: boolean;
   membership?: ChannelMemberResponse | null;
   pending_messages?: PendingMessageResponse[];
-  push_preferences?: PushPreference;
+  push_preferences?: ChannelPushPreference;
   read?: ReadResponse[];
   threads?: ThreadResponse[];
   watcher_count?: number;
@@ -684,25 +685,67 @@ export type GetUnreadCountAPIResponse = APIResponse & {
   total_unread_count_by_team?: Record<string, number>;
 };
 
-export type ChatLevelPushPreference = 'all' | 'none' | 'mentions' | (string & {});
+export type ChatLevelPushPreference =
+  | 'all'
+  | 'mentions' // deprecated by the API in favor of 'direct_mentions'
+  | 'direct_mentions'
+  | 'all_mentions'
+  | 'none'
+  | 'default'
+  | (string & {});
+
+export type CallLevelPushPreference = 'all' | 'none' | 'default' | (string & {});
+
+/** Granular all/none toggle used by the chat sub-preferences. */
+export type PushPreferenceLevel = 'all' | 'none' | (string & {});
 
+/** Per-mention-type chat push preferences (matches OpenAPI `ChatPreferencesInput`). */
+export type ChatPreferences = {
+  channel_mentions?: PushPreferenceLevel;
+  default_preference?: PushPreferenceLevel;
+  direct_mentions?: PushPreferenceLevel;
+  group_mentions?: PushPreferenceLevel;
+  here_mentions?: PushPreferenceLevel;
+  role_mentions?: PushPreferenceLevel;
+  thread_replies?: PushPreferenceLevel;
+};
+
+/**
+ * Input accepted by {@link StreamChat.setPushPreferences} (matches OpenAPI `PushPreferenceInput`).
+ *
+ * Set `channel_cid` to scope the preference to a single channel; leave it empty to
+ * set the user-level default. `user_id` is required for server-side auth and
+ * defaults to the connected user for client-side auth.
+ */
 export type PushPreference = {
-  callLevel?: 'all' | 'none' | (string & {});
-  chatLevel?: ChatLevelPushPreference;
-  disabledUntil?: string; // snooze till this time
-  removeDisable?: boolean; // Temporary flag for resetting disabledUntil
+  call_level?: CallLevelPushPreference;
+  channel_cid?: string;
+  chat_level?: ChatLevelPushPreference;
+  chat_preferences?: ChatPreferences;
+  disabled_until?: string; // snooze until this time
+  remove_disable?: boolean; // stop snoozing (clears disabled_until)
+  user_id?: string;
 };
 
+/** Per-user push preferences returned by the API (matches OpenAPI `PushPreferencesResponse`). */
+export type PushPreferencesResponse = {
+  call_level?: CallLevelPushPreference;
+  chat_level?: ChatLevelPushPreference;
+  chat_preferences?: ChatPreferences;
+  disabled_until?: string;
+};
+
+/** Per-channel push preferences returned by the API (matches OpenAPI `ChannelPushPreferencesResponse`). */
 export type ChannelPushPreference = {
-  chatLevel?: ChatLevelPushPreference; // "all", "none", "mentions", or other custom strings
-  disabledUntil?: string;
-  removeDisable?: boolean; // Temporary flag for resetting disabledUntil
+  chat_level?: ChatLevelPushPreference; // "all", "mentions", "direct_mentions", "all_mentions", "none", "default" or other custom strings
+  disabled_until?: string;
 };
 
 export type UpsertPushPreferencesResponse = APIResponse & {
-  // Mapping of user IDs to their push preferences
-  userChannelPreferences: Record<string, Record<string, ChannelPushPreference>>;
-  userPreferences: Record<string, PushPreference>; // Mapping of user -> channel id -> push preferences
+  // Mapping of user id -> channel cid -> channel push preferences
+  user_channel_preferences: Record<string, Record<string, ChannelPushPreference>>;
+  // Mapping of user id -> user push preferences
+  user_preferences: Record<string, PushPreferencesResponse>;
 };
 
 export type GetUnreadCountBatchAPIResponse = APIResponse & {
@@ -861,7 +904,7 @@ export type OwnUserBase = {
   unread_threads: number;
   invisible?: boolean;
   privacy_settings?: PrivacySettings;
-  push_preferences?: PushPreference;
+  push_preferences?: PushPreferencesResponse;
   roles?: string[];
   total_unread_count_by_team?: Record<string, number> | null;
 };
@@ -1694,6 +1737,7 @@ export type Event = CustomEventData & {
   watcher_count?: number;
   channel_last_message_at?: string;
   app?: Record<string, unknown>; // TODO: further specify type
+  thread_id?: string;
 };
 
 export type UserCustomEvent = CustomEventData & {
@@ -1702,7 +1746,7 @@ export type UserCustomEvent = CustomEventData & {
 
 export type EventHandler = (event: Event) => void;
 
-export type EventTypes = 'all' | keyof typeof EVENT_MAP;
+export type EventTypes = 'all' | keyof typeof EVENT_MAP | keyof CustomEventTypes;
 
 /**
  * Filter Types