stream-chat 9.52.1 → 9.53.0

package/dist/types/channel_batch_updater.d.ts

@@ -1,5 +1,5 @@
 import type { StreamChat } from './client';
-import type { APIResponse, BatchChannelDataUpdate, NewMemberPayload, UpdateChannelsBatchFilters, UpdateChannelsBatchResponse } from './types';
+import type { APIResponse, BatchChannelDataUpdate, ChannelBatchDataUpdateOptions, NewMemberPayload, UpdateChannelsBatchFilters, UpdateChannelsBatchResponse } from './types';
 /**
  * ChannelBatchUpdater - A class that provides convenience methods for batch channel operations
  */
@@ -85,9 +85,16 @@ export declare class ChannelBatchUpdater {
     /**
      * updateData - Update data on channels matching the filter
      *
+     * `data.custom` replaces the channel's whole custom object. To patch
+     * individual custom keys, pass an options object with `custom_set` or
+     * `custom_unset`. The client sends those fields at the request root rather
+     * than inside `data`. The options object can also include `data` to update
+     * channel fields in the same request.
+     *
      * @param {UpdateChannelsBatchFilters} filter Filter to select channels
-     * @param {BatchChannelDataUpdate} data Data to update
+     * @param {BatchChannelDataUpdate | ChannelBatchDataUpdateOptions} update Data or update options
      * @return {Promise<APIResponse & UpdateChannelsBatchResponse>} The server response
      */
     updateData(filter: UpdateChannelsBatchFilters, data: BatchChannelDataUpdate): Promise<APIResponse & UpdateChannelsBatchResponse>;
+    updateData(filter: UpdateChannelsBatchFilters, options: ChannelBatchDataUpdateOptions): Promise<APIResponse & UpdateChannelsBatchResponse>;
 }

package/dist/types/client.d.ts

@@ -105,6 +105,10 @@ export declare class StreamChat {
     wsConnection: StableWSConnection | null;
     wsFallback?: WSConnectionFallback;
     wsPromise: ConnectAPIResponse | null;
+    private _wsPromiseSettled;
+    private _wsConnectId;
+    private _resolveWsPromise?;
+    private _rejectWsPromise?;
     consecutiveFailures: number;
     insightMetrics: InsightMetrics;
     defaultWSTimeoutWithFallback: number;
@@ -224,6 +228,15 @@ export declare class StreamChat {
      * Creates a new WebSocket connection with the current user. Returns empty promise, if there is an active connection
      */
     openConnection: () => ConnectAPIResponse | undefined;
+    /**
+     * Rejects the shared `wsPromise`, invalidates any in-flight connect attempt
+     */
+    private _rejectPendingWsPromise;
+    /**
+     * Keep a single pending `wsPromise` across close/reopen so callers that already
+     * `await this.wsPromise` are not stranded when `openConnection` starts a new connect.
+     */
+    private _bindWsPromise;
     /**
      * @deprecated Please use client.openConnction instead.
      * @private
@@ -2183,6 +2196,10 @@ export declare class StreamChat {
     /**
      *  Update Channels Batch
      *
+     *  For the `updateData` operation, `data.custom` replaces the channel's whole
+     *  custom object, while the root-level `custom_set` / `custom_unset` patch
+     *  individual keys and leave the rest untouched.
+     *
      *  @param {UpdateChannelsBatchOptions} payload for updating channels in batch
      *  @return {Promise<APIResponse & UpdateChannelsBatchResponse>} The server response
      */

package/dist/types/types.d.ts

@@ -48,6 +48,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;
@@ -93,6 +94,7 @@ export type AppSettingsAPIResponse = APIResponse & {
         before_message_send_hook_attempt_timeout_ms?: number;
         campaign_enabled?: boolean;
         cdn_expiration_seconds?: number;
+        chat_primary_use_case?: string;
         custom_action_handler_url?: string;
         datadog_info?: {
             api_key: string;
@@ -117,13 +119,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;
@@ -160,6 +167,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;
@@ -3713,7 +3721,32 @@ 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'>> | PrimitiveFilter<string[]>;
     types?: RequireOnlyOne<Pick<QueryFilter<string>, '$in' | '$eq'>> | PrimitiveFilter<string[]>;

package/package.json

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

package/src/channel_batch_updater.ts

@@ -2,11 +2,17 @@ import type { StreamChat } from './client';
 import type {
   APIResponse,
   BatchChannelDataUpdate,
+  ChannelBatchDataUpdateOptions,
   NewMemberPayload,
   UpdateChannelsBatchFilters,
   UpdateChannelsBatchResponse,
 } from './types';
 
+const isChannelBatchDataUpdateOptions = (
+  update: BatchChannelDataUpdate | ChannelBatchDataUpdateOptions,
+): update is ChannelBatchDataUpdateOptions =>
+  'data' in update || 'custom_set' in update || 'custom_unset' in update;
+
 /**
  * ChannelBatchUpdater - A class that provides convenience methods for batch channel operations
  */
@@ -194,18 +200,38 @@ export class ChannelBatchUpdater {
   /**
    * updateData - Update data on channels matching the filter
    *
+   * `data.custom` replaces the channel's whole custom object. To patch
+   * individual custom keys, pass an options object with `custom_set` or
+   * `custom_unset`. The client sends those fields at the request root rather
+   * than inside `data`. The options object can also include `data` to update
+   * channel fields in the same request.
+   *
    * @param {UpdateChannelsBatchFilters} filter Filter to select channels
-   * @param {BatchChannelDataUpdate} data Data to update
+   * @param {BatchChannelDataUpdate | ChannelBatchDataUpdateOptions} update Data or update options
    * @return {Promise<APIResponse & UpdateChannelsBatchResponse>} The server response
    */
   async updateData(
     filter: UpdateChannelsBatchFilters,
     data: BatchChannelDataUpdate,
+  ): Promise<APIResponse & UpdateChannelsBatchResponse>;
+  async updateData(
+    filter: UpdateChannelsBatchFilters,
+    options: ChannelBatchDataUpdateOptions,
+  ): Promise<APIResponse & UpdateChannelsBatchResponse>;
+  async updateData(
+    filter: UpdateChannelsBatchFilters,
+    update: BatchChannelDataUpdate | ChannelBatchDataUpdateOptions,
   ): Promise<APIResponse & UpdateChannelsBatchResponse> {
+    const { data, custom_set, custom_unset } = isChannelBatchDataUpdateOptions(update)
+      ? update
+      : { data: update };
+
     return await this.client.updateChannelsBatch({
       operation: 'updateData',
       filter,
-      data,
+      ...(data && { data }),
+      ...(custom_set && { custom_set }),
+      ...(custom_unset && { custom_unset }),
     });
   }
 }

package/src/client.ts

@@ -393,6 +393,10 @@ export class StreamChat {
   wsConnection: StableWSConnection | null;
   wsFallback?: WSConnectionFallback;
   wsPromise: ConnectAPIResponse | null;
+  private _wsPromiseSettled = true;
+  private _wsConnectId = 0;
+  private _resolveWsPromise?: (value: Awaited<ConnectAPIResponse>) => void;
+  private _rejectWsPromise?: (reason?: unknown) => void;
   consecutiveFailures: number;
   insightMetrics: InsightMetrics;
   defaultWSTimeoutWithFallback: number;
@@ -713,18 +717,25 @@ export class StreamChat {
 
     const wsPromise = this.openConnection();
 
-    this.setUserPromise = Promise.all([setTokenPromise, wsPromise]).then(
+    const setUserPromise = Promise.all([setTokenPromise, wsPromise]).then(
       (result) => result[1], // We only return connection promise;
     );
+    this.setUserPromise = setUserPromise;
 
     try {
-      return await this.setUserPromise;
+      return await setUserPromise;
     } catch (err) {
-      if (this.persistUserOnConnectionFailure) {
-        // cleanup client to allow the user to retry connectUser again
-        this.closeConnection();
-      } else {
-        this.disconnectUser();
+      // disconnectUser() rejects an in-flight handshake so this catch can run *after* something else has taken over.
+      // Cleaning up then would tear down whatever replaced us. setUserPromise catches a
+      // newer connectUser(); userID additionally catches connectAnonymousUser(), which
+      // never sets setUserPromise, and a bare disconnectUser() that already cleaned up.
+      if (this.setUserPromise === setUserPromise && this.userID === user.id) {
+        if (this.persistUserOnConnectionFailure) {
+          // cleanup client to allow the user to retry connectUser again
+          this.closeConnection();
+        } else {
+          this.disconnectUser();
+        }
       }
       throw err;
     }
@@ -852,9 +863,58 @@ export class StreamChat {
     }
 
     this.clientID = `${this.userID}--${randomId()}`;
-    this.wsPromise = this.connect();
+    const wsPromise = this._bindWsPromise(this.connect());
     this._startCleaning();
-    return this.wsPromise;
+    return wsPromise;
+  };
+
+  /**
+   * Rejects the shared `wsPromise`, invalidates any in-flight connect attempt
+   */
+  private _rejectPendingWsPromise = (reason: Error) => {
+    if (!this._wsPromiseSettled) {
+      // invalidate in-flight attempts so a late settle cannot revive this promise
+      this._wsConnectId += 1;
+      this._wsPromiseSettled = true;
+      // Avoid unhandled promise rejection errors
+      this.wsPromise?.catch(() => {
+        // noop - real awaiters still observe the rejection
+      });
+      this._rejectWsPromise?.(reason);
+    }
+  };
+
+  /**
+   * Keep a single pending `wsPromise` across close/reopen so callers that already
+   * `await this.wsPromise` are not stranded when `openConnection` starts a new connect.
+   */
+  private _bindWsPromise = (connectPromise: ConnectAPIResponse): ConnectAPIResponse => {
+    const connectId = ++this._wsConnectId;
+
+    let pending = this.wsPromise;
+    if (this._wsPromiseSettled || !pending) {
+      this._wsPromiseSettled = false;
+      pending = new Promise((resolve, reject) => {
+        this._resolveWsPromise = resolve;
+        this._rejectWsPromise = reject;
+      });
+      this.wsPromise = pending;
+    }
+
+    connectPromise.then(
+      (value) => {
+        if (connectId !== this._wsConnectId) return;
+        this._wsPromiseSettled = true;
+        this._resolveWsPromise?.(value);
+      },
+      (error) => {
+        if (connectId !== this._wsConnectId) return;
+        this._wsPromiseSettled = true;
+        this._rejectWsPromise?.(error);
+      },
+    );
+
+    return pending;
   };
 
   /**
@@ -1059,6 +1119,11 @@ export class StreamChat {
 
     this.anonymous = false;
 
+    this._rejectPendingWsPromise(
+      new Error('Connection was closed because disconnectUser() was called'),
+    );
+    this.wsPromise = null;
+
     const closePromise = this.closeConnection(timeout);
 
     for (const channel of Object.values(this.activeChannels)) {
@@ -1751,7 +1816,12 @@ export class StreamChat {
       } as Event);
     }
 
-    this.wsPromise = Promise.resolve();
+    // If state recovery happens afer a failed connect (for example on persistUserOnConnectionFailure: true) we need to flip the wsPromise from rejected to resolved
+    // Otherwise all API calls that wait for the promise will fail
+    // If promise is not yet settled - we leave it for the connect sequence to resolve the promise
+    if (this._wsPromiseSettled) {
+      this.wsPromise = Promise.resolve();
+    }
     this.setUserPromise = Promise.resolve();
   };
 
@@ -5306,6 +5376,10 @@ export class StreamChat {
   /**
    *  Update Channels Batch
    *
+   *  For the `updateData` operation, `data.custom` replaces the channel's whole
+   *  custom object, while the root-level `custom_set` / `custom_unset` patch
+   *  individual keys and leave the rest untouched.
+   *
    *  @param {UpdateChannelsBatchOptions} payload for updating channels in batch
    *  @return {Promise<APIResponse & UpdateChannelsBatchResponse>} The server response
    */

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;
@@ -139,6 +140,7 @@ export type AppSettingsAPIResponse = APIResponse & {
     before_message_send_hook_attempt_timeout_ms?: number;
     campaign_enabled?: boolean;
     cdn_expiration_seconds?: number;
+    chat_primary_use_case?: string;
     custom_action_handler_url?: string;
     datadog_info?: {
       api_key: string;
@@ -163,13 +165,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 +213,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;
@@ -4990,8 +4998,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'>>