stream-chat 8.14.5 → 8.16.0

package/src/thread.ts

@@ -0,0 +1,116 @@
+import { StreamChat } from './client';
+import {
+  DefaultGenerics,
+  ExtendableGenerics,
+  MessageResponse,
+  ThreadResponse,
+  ChannelResponse,
+  FormatMessageResponse,
+  ReactionResponse,
+  UserResponse,
+} from './types';
+import { addToMessageList, formatMessage } from './utils';
+
+type ThreadReadStatus<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = Record<
+  string,
+  {
+    last_read: Date;
+    last_read_message_id: string;
+    unread_messages: number;
+    user: UserResponse<StreamChatGenerics>;
+  }
+>;
+
+export class Thread<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> {
+  id: string;
+  latestReplies: FormatMessageResponse<StreamChatGenerics>[] = [];
+  participants: ThreadResponse['thread_participants'] = [];
+  message: FormatMessageResponse<StreamChatGenerics>;
+  channel: ChannelResponse<StreamChatGenerics>;
+  _channel: ReturnType<StreamChat<StreamChatGenerics>['channel']>;
+  replyCount = 0;
+  _client: StreamChat<StreamChatGenerics>;
+  read: ThreadReadStatus<StreamChatGenerics> = {};
+
+  constructor(client: StreamChat<StreamChatGenerics>, t: ThreadResponse<StreamChatGenerics>) {
+    this.id = t.parent_message.id;
+    this.message = formatMessage(t.parent_message);
+    this.latestReplies = t.latest_replies.map(formatMessage);
+    this.participants = t.thread_participants;
+    this.replyCount = t.reply_count;
+    this.channel = t.channel;
+    this._channel = client.channel(t.channel.type, t.channel.id);
+    this._client = client;
+    for (const r of t.read) {
+      this.read[r.user.id] = {
+        ...r,
+        last_read: new Date(r.last_read),
+      };
+    }
+  }
+
+  getClient(): StreamChat<StreamChatGenerics> {
+    return this._client;
+  }
+
+  addReply(message: MessageResponse<StreamChatGenerics>) {
+    this.latestReplies = addToMessageList(this.latestReplies, formatMessage(message));
+  }
+
+  updateReply(message: MessageResponse<StreamChatGenerics>) {
+    this.latestReplies = this.latestReplies.map((m) => {
+      if (m.id === message.id) {
+        return formatMessage(message);
+      }
+      return m;
+    });
+  }
+
+  updateMessageOrReplyIfExists(message: MessageResponse<StreamChatGenerics>) {
+    if (!message.parent_id && message.id !== this.message.id) {
+      return;
+    }
+
+    if (message.parent_id && message.parent_id !== this.message.id) {
+      return;
+    }
+
+    if (message.parent_id && message.parent_id === this.message.id) {
+      this.updateReply(message);
+    }
+
+    if (!message.parent_id && message.id === this.message.id) {
+      this.message = formatMessage(message);
+    }
+  }
+
+  addReaction(
+    reaction: ReactionResponse<StreamChatGenerics>,
+    message?: MessageResponse<StreamChatGenerics>,
+    enforce_unique?: boolean,
+  ) {
+    if (!message) return;
+
+    this.latestReplies = this.latestReplies.map((m) => {
+      if (m.id === message.id) {
+        return formatMessage(
+          this._channel.state.addReaction(reaction, message, enforce_unique) as MessageResponse<StreamChatGenerics>,
+        );
+      }
+      return m;
+    });
+  }
+
+  removeReaction(reaction: ReactionResponse<StreamChatGenerics>, message?: MessageResponse<StreamChatGenerics>) {
+    if (!message) return;
+
+    this.latestReplies = this.latestReplies.map((m) => {
+      if (m.id === message.id) {
+        return formatMessage(
+          this._channel.state.removeReaction(reaction, message) as MessageResponse<StreamChatGenerics>,
+        );
+      }
+      return m;
+    });
+  }
+}

package/src/types.ts

@@ -114,6 +114,10 @@ export type AppSettingsAPIResponse<StreamChatGenerics extends ExtendableGenerics
     campaign_enabled?: boolean;
     cdn_expiration_seconds?: number;
     custom_action_handler_url?: string;
+    datadog_info?: {
+      api_key: string;
+      site: string;
+    };
     disable_auth_checks?: boolean;
     disable_permissions_checks?: boolean;
     enforce_unique_usernames?: 'no' | 'app' | 'team';
@@ -247,6 +251,7 @@ export type BannedUsersResponse<StreamChatGenerics extends ExtendableGenerics =
 
 export type BlockListResponse = BlockList & {
   created_at?: string;
+  type?: string;
   updated_at?: string;
 };
 
@@ -473,6 +478,58 @@ export type GetMessageAPIResponse<
   StreamChatGenerics extends ExtendableGenerics = DefaultGenerics
 > = SendMessageAPIResponse<StreamChatGenerics>;
 
+export type ThreadResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
+  channel: ChannelResponse<StreamChatGenerics>;
+  channel_cid: string;
+  created_at: string;
+  deleted_at: string;
+  latest_replies: MessageResponse<StreamChatGenerics>[];
+  parent_message: MessageResponse<StreamChatGenerics>;
+  parent_message_id: string;
+  read: {
+    last_read: string;
+    last_read_message_id: string;
+    unread_messages: number;
+    user: UserResponse<StreamChatGenerics>;
+  }[];
+  reply_count: number;
+  thread_participants: {
+    created_at: string;
+    user: UserResponse<StreamChatGenerics>;
+  }[];
+  title: string;
+  updated_at: string;
+};
+
+// TODO: Figure out a way to strongly type set and unset.
+export type PartialThreadUpdate = {
+  set?: Partial<Record<string, unknown>>;
+  unset?: Partial<Record<string, unknown>>;
+};
+
+export type QueryThreadsOptions = {
+  limit?: number;
+  next?: string;
+  participant_limit?: number;
+  reply_limit?: number;
+  watch?: boolean;
+};
+
+export type QueryThreadsAPIResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
+  threads: ThreadResponse<StreamChatGenerics>[];
+  next?: string;
+};
+
+export type GetThreadOptions = {
+  participant_limit?: number;
+  reply_limit?: number;
+  watch?: boolean;
+};
+
+export type GetThreadAPIResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
+  thread: ThreadResponse<StreamChatGenerics>;
+};
+
 export type GetMultipleMessagesAPIResponse<
   StreamChatGenerics extends ExtendableGenerics = DefaultGenerics
 > = APIResponse & {
@@ -505,7 +562,18 @@ export type GetUnreadCountAPIResponse = APIResponse & {
     last_read: string;
     unread_count: number;
   }[];
+  threads: {
+    last_read: string;
+    last_read_message_id: string;
+    parent_message_id: string;
+    unread_count: number;
+  }[];
   total_unread_count: number;
+  total_unread_threads_count: number;
+};
+
+export type GetUnreadCountBatchAPIResponse = APIResponse & {
+  counts_by_user: { [userId: string]: GetUnreadCountAPIResponse };
 };
 
 export type ListChannelResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
@@ -558,6 +626,7 @@ export type MessageResponseBase<
   };
   latest_reactions?: ReactionResponse<StreamChatGenerics>[];
   mentioned_users?: UserResponse<StreamChatGenerics>[];
+  moderation_details?: ModerationDetailsResponse;
   own_reactions?: ReactionResponse<StreamChatGenerics>[] | null;
   pin_expires?: string | null;
   pinned_at?: string | null;
@@ -571,6 +640,18 @@ export type MessageResponseBase<
   updated_at?: string;
 };
 
+export type ModerationDetailsResponse = {
+  action: 'MESSAGE_RESPONSE_ACTION_BOUNCE' | (string & {});
+  error_msg: string;
+  harms: ModerationHarmResponse[];
+  original_text: string;
+};
+
+export type ModerationHarmResponse = {
+  name: string;
+  phrase_list_ids: number[];
+};
+
 export type MuteResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
   user: UserResponse<StreamChatGenerics>;
   created_at?: string;
@@ -871,6 +952,7 @@ export type MarkChannelsReadOptions<StreamChatGenerics extends ExtendableGeneric
 export type MarkReadOptions<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
   client_id?: string;
   connection_id?: string;
+  thread_id?: string;
   user?: UserResponse<StreamChatGenerics>;
   user_id?: string;
 };
@@ -1055,8 +1137,13 @@ export type Event<StreamChatGenerics extends ExtendableGenerics = DefaultGeneric
   cid?: string;
   clear_history?: boolean;
   connection_id?: string;
+  // event creation timestamp, format Date ISO string
   created_at?: string;
+  // id of the message that was marked as unread - all the following messages are considered unread. (notification.mark_unread)
+  first_unread_message_id?: string;
   hard_delete?: boolean;
+  // creation date of a message with last_read_message_id, formatted as Date ISO string
+  last_read_at?: string;
   last_read_message_id?: string;
   mark_messages_deleted?: boolean;
   me?: OwnUserResponse<StreamChatGenerics>;
@@ -1072,9 +1159,15 @@ export type Event<StreamChatGenerics extends ExtendableGenerics = DefaultGeneric
   reaction?: ReactionResponse<StreamChatGenerics>;
   received_at?: string | Date;
   team?: string;
+  thread?: ThreadResponse<StreamChatGenerics>;
+  // @deprecated number of all unread messages across all current user's unread channels, equals unread_count
   total_unread_count?: number;
+  // number of all current user's channels with at least one unread message including the channel in this event
   unread_channels?: number;
+  // number of all unread messages across all current user's unread channels
   unread_count?: number;
+  // number of unread messages in the channel from this event (notification.mark_unread)
+  unread_messages?: number;
   user?: UserResponse<StreamChatGenerics>;
   user_id?: string;
   watcher_count?: number;
@@ -2390,22 +2483,43 @@ export type DeleteUserOptions = {
   user?: DeleteType;
 };
 
+export type SegmentType = 'channel' | 'user';
+
 export type SegmentData = {
   description: string;
   filter: {};
-  name: string;
-  type: 'channel' | 'user';
 };
 
 export type Segment = {
   created_at: string;
+  deleted_at: string;
   id: string;
-  in_use: boolean;
+  locked: boolean;
+  name: string;
   size: number;
-  status: 'computing' | 'ready';
+  type: SegmentType;
   updated_at: string;
 } & SegmentData;
 
+export type UpdateSegmentData = {
+  name: string;
+} & SegmentData;
+
+export type SortParam = {
+  field: string;
+  direction?: AscDesc;
+};
+
+export type Pager = {
+  limit?: number;
+  next?: string;
+  prev?: string;
+};
+
+export type QuerySegmentsOptions = {
+  sort?: SortParam[];
+} & Pager;
+
 export type CampaignSortField = {
   field: string;
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -2423,12 +2537,9 @@ export type CampaignQueryOptions = {
 };
 
 export type SegmentQueryOptions = CampaignQueryOptions;
-export type RecipientQueryOptions = CampaignQueryOptions;
 
 // TODO: add better typing
-export type SegmentFilters = {};
 export type CampaignFilters = {};
-export type RecipientFilters = {};
 
 export type CampaignData = {
   attachments: Attachment[];
@@ -2469,20 +2580,7 @@ export type TestCampaignResponse = {
   results?: Record<string, string>;
 };
 
-export type DeleteCampaignOptions = {
-  recipients?: boolean;
-};
-
-export type Recipient = {
-  campaign_id: string;
-  channel_cid: string;
-  created_at: string;
-  status: 'pending' | 'sent' | 'failed';
-  updated_at: string;
-  details?: string;
-  message_id?: string;
-  receiver_id?: string;
-};
+export type DeleteCampaignOptions = {};
 
 export type TaskStatus = {
   created_at: string;

package/src/utils.ts

@@ -1,5 +1,14 @@
 import FormData from 'form-data';
-import { AscDesc, ExtendableGenerics, DefaultGenerics, OwnUserBase, OwnUserResponse, UserResponse } from './types';
+import {
+  AscDesc,
+  ExtendableGenerics,
+  DefaultGenerics,
+  OwnUserBase,
+  OwnUserResponse,
+  UserResponse,
+  MessageResponse,
+  FormatMessageResponse,
+} from './types';
 import { AxiosRequestConfig } from 'axios';
 
 /**
@@ -263,3 +272,94 @@ export const axiosParamsSerializer: AxiosRequestConfig['paramsSerializer'] = (pa
 
   return newParams.join('&');
 };
+
+/**
+ * formatMessage - Takes the message object. Parses the dates, sets __html
+ * and sets the status to received if missing. Returns a message object
+ *
+ * @param {MessageResponse<StreamChatGenerics>} message a message object
+ *
+ */
+export function formatMessage<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics>(
+  message: MessageResponse<StreamChatGenerics>,
+): FormatMessageResponse<StreamChatGenerics> {
+  return {
+    ...message,
+    /**
+     * @deprecated please use `html`
+     */
+    __html: message.html,
+    // parse the date..
+    pinned_at: message.pinned_at ? new Date(message.pinned_at) : null,
+    created_at: message.created_at ? new Date(message.created_at) : new Date(),
+    updated_at: message.updated_at ? new Date(message.updated_at) : new Date(),
+    status: message.status || 'received',
+  };
+}
+
+export function addToMessageList<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics>(
+  messages: Array<FormatMessageResponse<StreamChatGenerics>>,
+  message: FormatMessageResponse<StreamChatGenerics>,
+  timestampChanged = false,
+  sortBy: 'pinned_at' | 'created_at' = 'created_at',
+  addIfDoesNotExist = true,
+) {
+  const addMessageToList = addIfDoesNotExist || timestampChanged;
+  let messageArr = messages;
+
+  // if created_at has changed, message should be filtered and re-inserted in correct order
+  // slow op but usually this only happens for a message inserted to state before actual response with correct timestamp
+  if (timestampChanged) {
+    messageArr = messageArr.filter((msg) => !(msg.id && message.id === msg.id));
+  }
+
+  // Get array length after filtering
+  const messageArrayLength = messageArr.length;
+
+  // for empty list just concat and return unless it's an update or deletion
+  if (messageArrayLength === 0 && addMessageToList) {
+    return messageArr.concat(message);
+  } else if (messageArrayLength === 0) {
+    return [...messageArr];
+  }
+
+  const messageTime = (message[sortBy] as Date).getTime();
+  const messageIsNewest = (messageArr[messageArrayLength - 1][sortBy] as Date).getTime() < messageTime;
+
+  // if message is newer than last item in the list concat and return unless it's an update or deletion
+  if (messageIsNewest && addMessageToList) {
+    return messageArr.concat(message);
+  } else if (messageIsNewest) {
+    return [...messageArr];
+  }
+
+  // find the closest index to push the new message
+  let left = 0;
+  let middle = 0;
+  let right = messageArrayLength - 1;
+  while (left <= right) {
+    middle = Math.floor((right + left) / 2);
+    if ((messageArr[middle][sortBy] as Date).getTime() <= messageTime) left = middle + 1;
+    else right = middle - 1;
+  }
+
+  // message already exists and not filtered due to timestampChanged, update and return
+  if (!timestampChanged && message.id) {
+    if (messageArr[left] && message.id === messageArr[left].id) {
+      messageArr[left] = message;
+      return [...messageArr];
+    }
+
+    if (messageArr[left - 1] && message.id === messageArr[left - 1].id) {
+      messageArr[left - 1] = message;
+      return [...messageArr];
+    }
+  }
+
+  // Do not add updated or deleted messages to the list if they do not already exist
+  // or have a timestamp change.
+  if (addMessageToList) {
+    messageArr.splice(left, 0, message);
+  }
+  return [...messageArr];
+}