stream-chat 9.25.0 → 9.26.1

package/src/messageDelivery/MessageDeliveryReporter.ts

@@ -3,16 +3,20 @@ import { Channel } from '../channel';
 import type { ThreadUserReadState } from '../thread';
 import { Thread } from '../thread';
 import type {
+  ErrorFromResponse,
   EventAPIResponse,
   LocalMessage,
   MarkDeliveredOptions,
   MarkReadOptions,
 } from '../types';
+import { type APIErrorResponse } from '../types';
 import { throttle } from '../utils';
+import { isAPIError, isErrorRetryable } from '../errors';
 
 const MAX_DELIVERED_MESSAGE_COUNT_IN_PAYLOAD = 100 as const;
 const MARK_AS_DELIVERED_BUFFER_TIMEOUT = 1000 as const;
 const MARK_AS_READ_THROTTLE_TIMEOUT = 1000 as const;
+const RETRY_COUNT_LIMIT_FOR_TIMEOUT_INCREASE = 3 as const;
 
 const isChannel = (item: Channel | Thread): item is Channel => item instanceof Channel;
 const isThread = (item: Channel | Thread): item is Thread => item instanceof Thread;
@@ -40,6 +44,10 @@ export class MessageDeliveryReporter {
   protected markDeliveredRequestPromise: Promise<EventAPIResponse | void> | null = null;
   protected markDeliveredTimeout: ReturnType<typeof setTimeout> | null = null;
 
+  protected requestTimeoutMs: number = MARK_AS_DELIVERED_BUFFER_TIMEOUT;
+  // increased up to RETRY_COUNT_LIMIT_FOR_TIMEOUT_INCREASE
+  protected requestRetryCount: number = 0;
+
   constructor({ client }: MessageDeliveryReporterOptions) {
     this.client = client;
   }
@@ -47,18 +55,35 @@ export class MessageDeliveryReporter {
   private get markDeliveredRequestInFlight() {
     return this.markDeliveredRequestPromise !== null;
   }
+
   private get hasTimer() {
     return this.markDeliveredTimeout !== null;
   }
+
   private get hasDeliveryCandidates() {
     return this.deliveryReportCandidates.size > 0;
   }
 
+  private get canExecuteRequest() {
+    return !this.markDeliveredRequestInFlight && this.hasDeliveryCandidates;
+  }
+
   private static hasPermissionToReportDeliveryFor(collection: Channel | Thread) {
     if (isChannel(collection)) return !!collection.getConfig()?.delivery_events;
     if (isThread(collection)) return !!collection.channel.getConfig()?.delivery_events;
   }
 
+  private increaseBackOff() {
+    if (this.requestRetryCount >= RETRY_COUNT_LIMIT_FOR_TIMEOUT_INCREASE) return;
+    this.requestRetryCount = this.requestRetryCount + 1;
+    this.requestTimeoutMs = this.requestTimeoutMs * 2;
+  }
+
+  private resetBackOff() {
+    this.requestTimeoutMs = MARK_AS_DELIVERED_BUFFER_TIMEOUT;
+    this.requestRetryCount = 0;
+  }
+
   /**
    * Build latest_delivered_messages payload from an arbitrary buffer (deliveryReportCandidates / nextDeliveryReportCandidates)
    */
@@ -186,7 +211,7 @@ export class MessageDeliveryReporter {
    * @param options
    */
   public announceDelivery = (options?: AnnounceDeliveryOptions) => {
-    if (this.markDeliveredRequestInFlight || !this.hasDeliveryCandidates) return;
+    if (!this.canExecuteRequest) return;
 
     const { latest_delivered_messages, sendBuffer } =
       this.confirmationsFromDeliveryReportCandidates();
@@ -194,7 +219,9 @@ export class MessageDeliveryReporter {
 
     const payload = { ...options, latest_delivered_messages };
 
-    const postFlightReconcile = () => {
+    const postFlightReconcile = ({
+      preventSchedulingRetry,
+    }: { preventSchedulingRetry?: boolean } = {}) => {
       this.markDeliveredRequestPromise = null;
 
       // promote anything that arrived during request
@@ -203,32 +230,47 @@ export class MessageDeliveryReporter {
       }
       this.nextDeliveryReportCandidates = new Map();
 
+      if (preventSchedulingRetry) return;
       // checks internally whether there are candidates to announce
       this.announceDeliveryBuffered(options);
     };
 
-    const handleError = () => {
-      // repopulate relevant candidates for the next report
-      for (const [k, v] of Object.entries(sendBuffer)) {
-        if (!this.deliveryReportCandidates.has(k)) {
-          this.deliveryReportCandidates.set(k, v);
-        }
-      }
+    const handleSuccess = () => {
+      this.resetBackOff();
       postFlightReconcile();
     };
 
+    const handleError = (error: ErrorFromResponse<APIErrorResponse> | Error) => {
+      // re-populate relevant candidates for the next report
+      // but make sure to keep the items that failed to be reported the first next time
+      const newDeliveryReportCandidates = new Map(sendBuffer);
+      for (const [k, v] of this.deliveryReportCandidates.entries()) {
+        newDeliveryReportCandidates.set(k, v);
+      }
+      this.deliveryReportCandidates = newDeliveryReportCandidates;
+
+      if (
+        (isAPIError(error) && isErrorRetryable(error)) ||
+        (error as ErrorFromResponse<APIErrorResponse>).status >= 500
+      ) {
+        this.increaseBackOff();
+        postFlightReconcile();
+      } else {
+        postFlightReconcile({ preventSchedulingRetry: true });
+      }
+    };
+
     this.markDeliveredRequestPromise = this.client
       .markChannelsDelivered(payload)
-      .then(postFlightReconcile, handleError);
+      .then(handleSuccess, handleError);
   };
 
   public announceDeliveryBuffered = (options?: AnnounceDeliveryOptions) => {
-    if (this.hasTimer || this.markDeliveredRequestInFlight || !this.hasDeliveryCandidates)
-      return;
+    if (this.hasTimer || !this.canExecuteRequest) return;
     this.markDeliveredTimeout = setTimeout(() => {
       this.markDeliveredTimeout = null;
       this.announceDelivery(options);
-    }, MARK_AS_DELIVERED_BUFFER_TIMEOUT);
+    }, this.requestTimeoutMs);
   };
 
   /**

package/src/types.ts

@@ -71,6 +71,7 @@ export type Unpacked<T> = T extends (infer U)[]
 
 export type APIResponse = {
   duration: string;
+  blocklist?: BlockListResponse;
 };
 
 export type TranslateResponse = {
@@ -80,6 +81,8 @@ export type TranslateResponse = {
 
 export type AppSettingsAPIResponse = APIResponse & {
   app?: {
+    id?: string | number;
+    allow_multi_user_devices?: boolean;
     // TODO
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     call_types: any;
@@ -108,6 +111,9 @@ export type AppSettingsAPIResponse = APIResponse & {
         read_events?: boolean;
         replies?: boolean;
         search?: boolean;
+        shared_locations?: boolean;
+        skip_last_msg_update_for_system_msgs?: boolean;
+        count_messages?: boolean;
         typing_events?: boolean;
         updated_at?: string;
         uploads?: boolean;
@@ -140,12 +146,28 @@ export type AppSettingsAPIResponse = APIResponse & {
       type: string;
     }>;
     grants?: Record<string, string[]>;
+    guest_user_creation_disabled?: boolean;
     image_moderation_enabled?: boolean;
+    image_moderation_labels?: string[];
     image_upload_config?: FileUploadConfig;
+    allowed_flag_reasons?: string[];
+    max_aggregated_activities_length?: number;
+    moderation_bulk_submit_action_enabled?: boolean;
+    moderation_dashboard_preferences?: Record<string, unknown> | null;
+    moderation_enabled?: boolean;
+    moderation_llm_configurability_enabled?: boolean;
+    moderation_multitenant_blocklist_enabled?: boolean;
+    moderation_webhook_url?: string;
     multi_tenant_enabled?: boolean;
     name?: string;
     organization?: string;
     permission_version?: string;
+    /**
+     * The placement of the app in the form of `${region}.${shard}`.
+     * Examples: "us-east.c1", "dublin.c3", "singapore.c2"
+     * Note: The backend may add/remove regions or shards occasionally.
+     */
+    placement?: string;
     policies?: Record<string, Policy[]>;
     poll_enabled?: boolean;
     push_notifications?: {
@@ -167,6 +189,8 @@ export type AppSettingsAPIResponse = APIResponse & {
     sqs_url?: string;
     suspended?: boolean;
     suspended_explanation?: string;
+    use_hook_v2?: boolean;
+    user_response_time_enabled?: boolean;
     user_search_disallowed_roles?: string[] | null;
     video_provider?: string;
     webhook_events?: Array<string>;
@@ -282,6 +306,7 @@ export type ChannelResponse = CustomChannelData & {
   created_by?: UserResponse | null;
   created_by_id?: string;
   deleted_at?: string;
+  filter_tags?: string[];
   hidden?: boolean;
   invites?: string[];
   joined?: boolean;
@@ -331,6 +356,7 @@ export type ChannelAPIResponse = {
 
 export type ChannelUpdateOptions = {
   hide_history?: boolean;
+  hide_history_before?: string | Date;
   skip_push?: boolean;
 };
 
@@ -786,6 +812,7 @@ export type OwnUserBase = {
   privacy_settings?: PrivacySettings;
   push_preferences?: PushPreference;
   roles?: string[];
+  total_unread_count_by_team?: Record<string, number> | null;
 };
 
 export type OwnUserResponse = UserResponse & OwnUserBase;
@@ -882,10 +909,12 @@ export type UpdateMessageAPIResponse = APIResponse & {
 
 export type UsersAPIResponse = APIResponse & {
   users: Array<UserResponse>;
+  membership_deletion_task_id?: string;
 };
 
 export type UpdateUsersAPIResponse = APIResponse & {
   users: { [key: string]: UserResponse };
+  membership_deletion_task_id?: string;
 };
 
 export type UserResponse = CustomUserData & {
@@ -908,7 +937,7 @@ export type UserResponse = CustomUserData & {
   role?: string;
   shadow_banned?: boolean;
   teams?: string[];
-  teams_role?: TeamsRole;
+  teams_role?: TeamsRole | null;
   updated_at?: string;
   username?: string;
   avg_response_time?: number;
@@ -1032,11 +1061,13 @@ export type CreateChannelOptions = {
   reminders?: boolean;
   replies?: boolean;
   search?: boolean;
+  shared_locations?: boolean;
   skip_last_msg_update_for_system_msgs?: boolean;
   typing_events?: boolean;
   uploads?: boolean;
   url_enrichment?: boolean;
   user_message_reminders?: boolean;
+  count_messages?: boolean;
 };
 
 export type CreateCommandOptions = {
@@ -1064,9 +1095,8 @@ export type DeactivateUsersOptions = {
 export type NewMemberPayload = CustomMemberData &
   Pick<ChannelMemberResponse, 'user_id' | 'channel_role'>;
 
-export type Thresholds = Record<
-  'explicit' | 'spam' | 'toxic',
-  Partial<{ block: number; flag: number }>
+export type Thresholds = Partial<
+  Record<'explicit' | 'spam' | 'toxic', Partial<{ block: number; flag: number }>>
 >;
 
 export type BlockListOptions = {
@@ -1170,6 +1200,7 @@ export type UpdateChannelTypeResponse = {
   reminders: boolean;
   replies: boolean;
   search: boolean;
+  shared_locations: boolean;
   skip_last_msg_update_for_system_msgs: boolean;
   typing_events: boolean;
   updated_at: string;
@@ -1180,9 +1211,11 @@ export type UpdateChannelTypeResponse = {
   blocklist?: string;
   blocklist_behavior?: BlocklistBehavior;
   blocklists?: BlockListOptions[];
+  message_retention?: string;
   partition_size?: number;
   partition_ttl?: string;
   count_messages?: boolean;
+  user_message_reminders?: boolean;
 };
 
 export type GetChannelTypeResponse = {
@@ -1208,6 +1241,7 @@ export type GetChannelTypeResponse = {
   reminders: boolean;
   replies: boolean;
   search: boolean;
+  shared_locations: boolean;
   skip_last_msg_update_for_system_msgs: boolean;
   typing_events: boolean;
   updated_at: string;
@@ -1218,9 +1252,11 @@ export type GetChannelTypeResponse = {
   blocklist?: string;
   blocklist_behavior?: BlocklistBehavior;
   blocklists?: BlockListOptions[];
+  message_retention?: string;
   partition_size?: number;
   partition_ttl?: string;
   count_messages?: boolean;
+  user_message_reminders?: boolean;
 };
 
 export type UpdateChannelOptions = Partial<{
@@ -1260,6 +1296,7 @@ export type MarkUnreadOptions = {
   connection_id?: string;
   message_id?: string;
   thread_id?: string;
+  message_timestamp?: string | Date;
   user?: UserResponse;
   user_id?: string;
 };
@@ -1751,6 +1788,8 @@ export type ReactionFilters = QueryFilters<
 
 export type ChannelFilters = QueryFilters<
   ContainsOperator<Omit<CustomChannelData, 'name'>> & {
+    app_banned?: 'only' | 'excluded';
+    has_unread?: boolean;
     archived?: boolean;
     'member.user.name'?:
       | RequireOnlyOne<{
@@ -2044,7 +2083,7 @@ export type UserFilters = QueryFilters<
   }
 >;
 
-export type InviteStatus = 'pending' | 'accepted' | 'rejected';
+export type InviteStatus = 'pending' | 'accepted' | 'rejected' | 'member';
 
 // https://getstream.io/chat/docs/react/channel_member/#update-channel-members
 export type MemberFilters = QueryFilters<
@@ -2368,6 +2407,8 @@ export type BlockList = {
   team?: string;
   type?: string;
   validate?: boolean;
+  is_leet_check_enabled?: boolean;
+  is_plural_check_enabled?: boolean;
 };
 
 export type ChannelConfig = ChannelConfigFields &
@@ -2403,6 +2444,7 @@ export type ChannelConfigFields = {
   replies?: boolean;
   search?: boolean;
   shared_locations?: boolean;
+  skip_last_msg_update_for_system_msgs?: boolean;
   count_messages?: boolean;
   typing_events?: boolean;
   uploads?: boolean;
@@ -2423,6 +2465,7 @@ export type ChannelData = CustomChannelData &
     members: string[] | Array<NewMemberPayload>;
     blocklist_behavior: AutomodBehavior;
     automod: Automod;
+    filter_tags: string[];
   }>;
 
 export type ChannelMute = {
@@ -3153,6 +3196,11 @@ export type CampaignData = {
     custom?: {};
     id?: string;
     members?: string[];
+    members_template?: Array<{
+      user_id: string;
+      channel_role?: string;
+      custom?: Record<string, unknown>;
+    }>;
     team?: string;
   };
   create_channels?: boolean;
@@ -4435,6 +4483,7 @@ export type EventHook = {
   sns_key?: string;
   sns_secret?: string;
   sns_role_arn?: string;
+  should_send_custom_events?: boolean;
 
   // pending message config
   timeout_ms?: number;

package/src/utils.ts

@@ -104,6 +104,7 @@ export function isOwnUserBaseProperty(property: string) {
     privacy_settings: true,
     roles: true,
     push_preferences: true,
+    total_unread_count_by_team: true,
   };
 
   return ownUserBaseProperties[property as keyof OwnUserBase];