stream-chat 8.49.0 → 8.51.0

package/src/thread.ts

@@ -11,6 +11,7 @@ import type {
   MessageResponse,
   ReadResponse,
   ThreadResponse,
+  ThreadResponseCustomData,
   UserResponse,
 } from './types';
 import { addToMessageList, findIndexInSortedArray, formatMessage, throttle } from './utils';
@@ -27,6 +28,7 @@ export type ThreadState<SCG extends ExtendableGenerics = DefaultGenerics> = {
   active: boolean;
   channel: Channel<SCG>;
   createdAt: Date;
+  custom: ThreadResponseCustomData;
   deletedAt: Date | null;
   isLoading: boolean;
   isStateStale: boolean;
@@ -40,6 +42,7 @@ export type ThreadState<SCG extends ExtendableGenerics = DefaultGenerics> = {
   read: ThreadReadState;
   replies: Array<FormatMessageResponse<SCG>>;
   replyCount: number;
+  title: string;
   updatedAt: Date | null;
 };
 
@@ -65,6 +68,43 @@ export type ThreadReadState<SCG extends ExtendableGenerics = DefaultGenerics> =
 const DEFAULT_PAGE_LIMIT = 50;
 const DEFAULT_SORT: { created_at: AscDesc }[] = [{ created_at: -1 }];
 const MARK_AS_READ_THROTTLE_TIMEOUT = 1000;
+// TODO: remove this once we move to API v2
+export const THREAD_RESPONSE_RESERVED_KEYS: Record<keyof ThreadResponse, true> = {
+  channel: true,
+  channel_cid: true,
+  created_at: true,
+  created_by_user_id: true,
+  parent_message_id: true,
+  title: true,
+  updated_at: true,
+  latest_replies: true,
+  active_participant_count: true,
+  deleted_at: true,
+  last_message_at: true,
+  participant_count: true,
+  reply_count: true,
+  read: true,
+  thread_participants: true,
+  created_by: true,
+  parent_message: true,
+};
+
+// TODO: remove this once we move to API v2
+const constructCustomDataObject = <T extends ThreadResponse>(threadData: T) => {
+  const custom: ThreadResponseCustomData = {};
+
+  for (const key in threadData) {
+    if (THREAD_RESPONSE_RESERVED_KEYS[key as keyof ThreadResponse]) {
+      continue;
+    }
+
+    const customKey = key as keyof ThreadResponseCustomData;
+
+    custom[customKey] = threadData[customKey];
+  }
+
+  return custom;
+};
 
 export class Thread<SCG extends ExtendableGenerics = DefaultGenerics> {
   public readonly state: StateStore<ThreadState<SCG>>;
@@ -87,12 +127,15 @@ export class Thread<SCG extends ExtendableGenerics = DefaultGenerics> {
       : [];
 
     this.state = new StateStore<ThreadState<SCG>>({
+      // local only
       active: false,
+      isLoading: false,
+      isStateStale: false,
+      // 99.9% should never change
       channel,
       createdAt: new Date(threadData.created_at),
+      // rest
       deletedAt: threadData.deleted_at ? new Date(threadData.deleted_at) : null,
-      isLoading: false,
-      isStateStale: false,
       pagination: repliesPaginationFromInitialThread(threadData),
       parentMessage: formatMessage(threadData.parent_message),
       participants: threadData.thread_participants,
@@ -102,6 +145,8 @@ export class Thread<SCG extends ExtendableGenerics = DefaultGenerics> {
       replies: threadData.latest_replies.map(formatMessage),
       replyCount: threadData.reply_count ?? 0,
       updatedAt: threadData.updated_at ? new Date(threadData.updated_at) : null,
+      title: threadData.title,
+      custom: constructCustomDataObject(threadData),
     });
 
     this.id = threadData.parent_message_id;
@@ -186,6 +231,7 @@ export class Thread<SCG extends ExtendableGenerics = DefaultGenerics> {
       return;
     }
 
+    this.unsubscribeFunctions.add(this.subscribeThreadUpdated());
     this.unsubscribeFunctions.add(this.subscribeMarkActiveThreadRead());
     this.unsubscribeFunctions.add(this.subscribeReloadActiveStaleThread());
     this.unsubscribeFunctions.add(this.subscribeMarkThreadStale());
@@ -195,6 +241,24 @@ export class Thread<SCG extends ExtendableGenerics = DefaultGenerics> {
     this.unsubscribeFunctions.add(this.subscribeMessageUpdated());
   };
 
+  private subscribeThreadUpdated = () => {
+    return this.client.on('thread.updated', (event) => {
+      if (!event.thread || event.thread.parent_message_id !== this.id) {
+        return;
+      }
+
+      const threadData = event.thread;
+
+      this.state.partialNext({
+        title: threadData.title,
+        updatedAt: new Date(threadData.updated_at),
+        deletedAt: threadData.deleted_at ? new Date(threadData.deleted_at) : null,
+        // TODO: use threadData.custom once we move to API v2
+        custom: constructCustomDataObject(threadData),
+      });
+    }).unsubscribe;
+  };
+
   private subscribeMarkActiveThreadRead = () => {
     return this.state.subscribeWithSelector(
       (nextValue) => ({

package/src/types.ts

@@ -520,7 +520,10 @@ export type GetMessageAPIResponse<
   StreamChatGenerics extends ExtendableGenerics = DefaultGenerics
 > = SendMessageAPIResponse<StreamChatGenerics>;
 
-export interface ThreadResponse<SCG extends ExtendableGenerics = DefaultGenerics> {
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface ThreadResponseCustomData {}
+
+export interface ThreadResponse<SCG extends ExtendableGenerics = DefaultGenerics> extends ThreadResponseCustomData {
   // FIXME: according to OpenAPI, `channel` could be undefined but since cid is provided I'll asume that it's wrong
   channel: ChannelResponse<SCG>;
   channel_cid: string;
@@ -531,6 +534,7 @@ export interface ThreadResponse<SCG extends ExtendableGenerics = DefaultGenerics
   parent_message_id: string;
   title: string;
   updated_at: string;
+  active_participant_count?: number;
   created_by?: UserResponse<SCG>;
   deleted_at?: string;
   last_message_at?: string;
@@ -547,6 +551,8 @@ export interface ThreadResponse<SCG extends ExtendableGenerics = DefaultGenerics
     user?: UserResponse<SCG>;
     user_id?: string;
   }>;
+  // TODO: when moving to API v2 we should do this instead
+  // custom: ThreadResponseCustomData;
 }
 
 // TODO: Figure out a way to strongly type set and unset.
@@ -1943,8 +1949,7 @@ export type ReactionSortBase<StreamChatGenerics extends ExtendableGenerics = Def
 
 export type ChannelSort<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> =
   | ChannelSortBase<StreamChatGenerics>
-  | Array<ChannelSortBase<StreamChatGenerics>>
-  | { pinned_at: AscDesc };
+  | Array<ChannelSortBase<StreamChatGenerics>>;
 
 export type ChannelSortBase<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = Sort<
   StreamChatGenerics['channelType']
@@ -1954,6 +1959,7 @@ export type ChannelSortBase<StreamChatGenerics extends ExtendableGenerics = Defa
   last_message_at?: AscDesc;
   last_updated?: AscDesc;
   member_count?: AscDesc;
+  pinned_at?: AscDesc;
   unread_count?: AscDesc;
   updated_at?: AscDesc;
 };
@@ -2990,6 +2996,7 @@ export type CampaignData = {
   name?: string;
   segment_ids?: string[];
   sender_id?: string;
+  sender_mode?: 'exclude' | 'include' | null;
   skip_push?: boolean;
   skip_webhook?: boolean;
   user_ids?: string[];