stream-chat 9.52.1 → 9.54.0

package/src/types.ts

@@ -83,6 +83,7 @@ export type TranslateResponse = {
 export type AppSettingsAPIResponse = APIResponse & {
   app?: {
     id?: string | number;
+    activity_metrics_config?: Record<string, number>;
     allow_multi_user_devices?: boolean;
     feed_audit_logs_enabled?: boolean;
     moderation_onboarding_complete?: boolean | null;
@@ -137,8 +138,10 @@ export type AppSettingsAPIResponse = APIResponse & {
     auto_translation_enabled?: boolean;
     before_message_send_hook_url?: string;
     before_message_send_hook_attempt_timeout_ms?: number;
+    before_message_send_hook_system_messages?: boolean;
     campaign_enabled?: boolean;
     cdn_expiration_seconds?: number;
+    chat_primary_use_case?: string;
     custom_action_handler_url?: string;
     datadog_info?: {
       api_key: string;
@@ -163,13 +166,18 @@ export type AppSettingsAPIResponse = APIResponse & {
     image_upload_config?: FileUploadConfig;
     allowed_flag_reasons?: string[];
     max_aggregated_activities_length?: number;
+    member_custom_on_mentioned_users_enabled?: boolean;
+    member_custom_on_messages_enabled?: boolean;
+    member_custom_on_typing_events_enabled?: boolean;
     moderation_bulk_submit_action_enabled?: boolean;
     moderation_dashboard_preferences?: Record<string, unknown> | null;
     moderation_audio_call_moderation_enabled?: boolean;
     moderation_enabled?: boolean;
     moderation_flood_rules_enabled?: boolean;
+    moderation_keyframe_video_enabled?: boolean;
     moderation_llm_configurability_enabled?: boolean;
     moderation_multitenant_blocklist_enabled?: boolean;
+    moderation_s3_image_access_role_arn?: string;
     moderation_video_call_moderation_enabled?: boolean;
     moderation_webhook_url?: string;
     multi_tenant_enabled?: boolean;
@@ -206,6 +214,7 @@ export type AppSettingsAPIResponse = APIResponse & {
     use_hook_v2?: boolean;
     user_response_time_enabled?: boolean;
     user_search_disallowed_roles?: string[] | null;
+    video_primary_use_case?: string;
     video_provider?: string;
     webhook_events?: Array<string>;
     webhook_url?: string;
@@ -795,9 +804,7 @@ export type MessageResponseBase = MessageBase & {
   created_at?: string;
   deleted_at?: string;
   deleted_reply_count?: number;
-  i18n?: RequireAtLeastOne<Record<`${TranslationLanguages}_text`, string>> & {
-    language: TranslationLanguages;
-  };
+  i18n?: TranslatedField;
   latest_reactions?: ReactionResponse[];
   member?: ChannelMemberResponse;
   mentioned_users?: UserResponse[];
@@ -3277,6 +3284,13 @@ export type TranslationLanguages =
   | 'zh-TW'
   | (string & {});
 
+// Server-owned translations for a single text field, keyed by language.
+export type TranslatedField = RequireAtLeastOne<
+  Record<`${TranslationLanguages}_text`, string>
+> & {
+  language: TranslationLanguages;
+};
+
 export type TypingStartEvent = Event;
 
 export type ReservedUpdatedMessageFields = keyof typeof RESERVED_UPDATED_MESSAGE_FIELDS;
@@ -3639,7 +3653,9 @@ export type PollResponse = CustomPollData &
     allow_answers?: boolean;
     allow_user_suggested_options?: boolean;
     description?: string;
+    description_i18n?: TranslatedField;
     is_closed?: boolean;
+    name_i18n?: TranslatedField;
     voting_visibility?: VotingVisibility;
   };
 
@@ -3650,6 +3666,7 @@ export type PollOption = {
   text: string;
   updated_at: string;
   vote_count: number;
+  text_i18n?: TranslatedField;
   votes?: PollVote[];
 };
 
@@ -3725,6 +3742,7 @@ export type PollOptionResponse = CustomPollData & {
   text: string;
   updated_at: string;
   vote_count: number;
+  text_i18n?: TranslatedField;
   votes?: PollVote[];
 };
 
@@ -3741,6 +3759,7 @@ export type PollVote = {
 export type PollAnswer = Exclude<PollVote, 'option_id'> & {
   answer_text: string;
   is_answer: boolean; // this is absolutely redundant prop as answer_text indicates that a vote is an answer
+  answer_text_i18n?: TranslatedField;
 };
 
 export type PollVotesAPIResponse = {
@@ -4990,8 +5009,37 @@ export type UpdateChannelsBatchOptions = {
   filter: UpdateChannelsBatchFilters;
   members?: string[] | Array<NewMemberPayload>;
   data?: BatchChannelDataUpdate;
+  /**
+   * `updateData` only. Merges these keys into each matched channel's existing
+   * custom object, leaving every other custom key untouched — unlike
+   * `data.custom`, which replaces the whole object. Keys are dot-paths, so
+   * `a.b` sets key `b` inside object `a` (the parent object must already
+   * exist). Cannot be combined with `data.custom`.
+   *
+   * Lives at the request root, not inside `data`.
+   */
+  custom_set?: Record<string, unknown>;
+  /**
+   * `updateData` only. Deletes these keys from each matched channel's existing
+   * custom object, leaving every other custom key untouched. Keys are
+   * dot-paths; deleting a key that does not exist is a no-op. Cannot be
+   * combined with `data.custom`.
+   *
+   * Lives at the request root, not inside `data`.
+   */
+  custom_unset?: string[];
 };
 
+/**
+ * Options for {@link ChannelBatchUpdater.updateData}. `custom_set` and
+ * `custom_unset` are sent at the request root, while `data` contains the
+ * channel fields to update.
+ */
+export type ChannelBatchDataUpdateOptions = Pick<
+  UpdateChannelsBatchOptions,
+  'data' | 'custom_set' | 'custom_unset'
+>;
+
 export type UpdateChannelsBatchFilters = QueryFilters<{
   cids?:
     | RequireOnlyOne<Pick<QueryFilter<string>, '$in' | '$eq'>>