stream-chat 9.2.0 → 9.3.0

package/dist/types/channel.d.ts

@@ -139,7 +139,7 @@ export declare class Channel {
     sendReaction(messageID: string, reaction: Reaction, options?: {
         enforce_unique?: boolean;
         skip_push?: boolean;
-    }): Promise<ReactionAPIResponse | undefined>;
+    }): Promise<ReactionAPIResponse>;
     /**
      * sendReaction - Send a reaction about a message
      *
@@ -152,10 +152,8 @@ export declare class Channel {
     _sendReaction(messageID: string, reaction: Reaction, options?: {
         enforce_unique?: boolean;
         skip_push?: boolean;
-    }): Promise<ReactionAPIResponse | undefined>;
-    deleteReaction(messageID: string, reactionType: string, user_id?: string): Promise<(APIResponse & {
-        message: MessageResponse;
-    }) | undefined>;
+    }): Promise<ReactionAPIResponse>;
+    deleteReaction(messageID: string, reactionType: string, user_id?: string): Promise<ReactionAPIResponse>;
     /**
      * deleteReaction - Delete a reaction by user and type
      *

package/dist/types/client.d.ts

@@ -227,7 +227,24 @@ export declare class StreamChat {
           'data_template': 'data handlebars template',
           'apn_template': 'apn notification handlebars template under v2'
         },
-        'webhook_url': 'https://acme.com/my/awesome/webhook/'
+        'webhook_url': 'https://acme.com/my/awesome/webhook/',
+        'event_hooks': [
+          {
+            'hook_type': 'webhook',
+            'enabled': true,
+            'event_types': ['message.new'],
+            'webhook_url': 'https://acme.com/my/awesome/webhook/'
+          },
+          {
+            'hook_type': 'sqs',
+            'enabled': true,
+            'event_types': ['message.new'],
+            'sqs_url': 'https://sqs.us-east-1.amazonaws.com/1234567890/my-queue',
+            'sqs_auth_type': 'key',
+            'sqs_key': 'my-access-key',
+            'sqs_secret': 'my-secret-key'
+          }
+        ]
       }
      */
     updateAppSettings(options: AppSettings): Promise<APIResponse>;
@@ -1103,9 +1120,9 @@ export declare class StreamChat {
     partialUpdateMessage(id: string, partialMessageObject: PartialMessageUpdate, partialUserOrUserId?: string | {
         id: string;
     }, options?: UpdateMessageOptions): Promise<UpdateMessageAPIResponse>;
-    deleteMessage(messageID: string, hardDelete?: boolean): Promise<(APIResponse & {
+    deleteMessage(messageID: string, hardDelete?: boolean): Promise<APIResponse & {
         message: MessageResponse;
-    }) | undefined>;
+    }>;
     _deleteMessage(messageID: string, hardDelete?: boolean): Promise<APIResponse & {
         message: MessageResponse;
     }>;

package/dist/types/offline-support/offline_support_api.d.ts

@@ -522,11 +522,9 @@ export declare abstract class AbstractOfflineDB implements OfflineDBApi {
      * It will return the response from the execution if it succeeded.
      * @param task - the pending task we want to execute
      */
-    queueTask: ({ task }: {
+    queueTask: <T>({ task }: {
         task: PendingTask;
-    }) => Promise<(import("..").APIResponse & {
-        message: import("..").MessageResponse;
-    }) | undefined>;
+    }) => Promise<T>;
     /**
      * A utility method that determines if a failed task should be added to the
      * queue based on its error.

package/dist/types/offline-support/types.d.ts

@@ -1,4 +1,4 @@
-import type { AppSettingsAPIResponse, ChannelAPIResponse, ChannelFilters, ChannelMemberResponse, ChannelResponse, ChannelSort, LocalMessage, Message, MessageResponse, PollResponse, ReactionFilters, ReactionResponse, ReactionSort, ReadResponse } from '../types';
+import type { AppSettingsAPIResponse, ChannelAPIResponse, ChannelFilters, ChannelMemberResponse, ChannelResponse, ChannelSort, LocalMessage, MessageResponse, PollResponse, ReactionFilters, ReactionResponse, ReactionSort, ReadResponse } from '../types';
 import type { Channel } from '../channel';
 import type { StreamChat } from '../client';
 export type PrepareBatchDBQueries = [string] | [string, Array<unknown> | Array<Array<unknown>>];
@@ -322,6 +322,16 @@ export type PendingTask = {
     payload: Parameters<Channel['sendMessage']>;
     type: PendingTaskTypes['sendMessage'];
 });
-export type PendingTaskExtraData = {
-    message?: Message;
-};
+export type OfflineErrorType = 'connection:lost';
+export declare class OfflineError extends Error {
+    type: OfflineErrorType;
+    name: string;
+    constructor(message: string, { type, }: {
+        type: OfflineError['type'];
+    });
+    toJSON(): {
+        message: string;
+        stack: string | undefined;
+        name: string;
+    };
+}

package/dist/types/types.d.ts

@@ -90,6 +90,7 @@ export type AppSettingsAPIResponse = APIResponse & {
         disable_auth_checks?: boolean;
         disable_permissions_checks?: boolean;
         enforce_unique_usernames?: 'no' | 'app' | 'team';
+        event_hooks?: Array<EventHook>;
         file_upload_config?: FileUploadConfig;
         geofences?: Array<{
             country_codes: Array<string>;
@@ -1698,6 +1699,7 @@ export type AppSettings = {
     disable_auth_checks?: boolean;
     disable_permissions_checks?: boolean;
     enforce_unique_usernames?: 'no' | 'app' | 'team';
+    event_hooks?: Array<EventHook> | null;
     file_upload_config?: FileUploadConfig;
     firebase_config?: {
         apn_template?: string;
@@ -2905,4 +2907,26 @@ export type ThreadFilters = QueryFilters<{
 } & {
     last_message_at?: RequireOnlyOne<Pick<QueryFilter<ThreadResponse['last_message_at']>, '$eq' | '$gt' | '$lt' | '$gte' | '$lte'>> | PrimitiveFilter<ThreadResponse['last_message_at']>;
 }>;
+export type HookType = 'webhook' | 'sqs' | 'sns';
+export type EventHook = {
+    id?: string;
+    hook_type?: HookType;
+    enabled?: boolean;
+    event_types?: Array<string>;
+    webhook_url?: string;
+    sqs_queue_url?: string;
+    sqs_region?: string;
+    sqs_auth_type?: string;
+    sqs_key?: string;
+    sqs_secret?: string;
+    sqs_role_arn?: string;
+    sns_topic_arn?: string;
+    sns_region?: string;
+    sns_auth_type?: string;
+    sns_key?: string;
+    sns_secret?: string;
+    sns_role_arn?: string;
+    created_at?: string;
+    updated_at?: string;
+};
 export {};

package/package.json

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

package/src/channel.ts

@@ -207,7 +207,7 @@ export class Channel {
       if (offlineDb) {
         const messageId = message.id;
         if (messageId) {
-          return (await offlineDb.queueTask({
+          return await offlineDb.queueTask<SendMessageAPIResponse>({
             task: {
               channelId: this.id as string,
               channelType: this.type,
@@ -215,7 +215,7 @@ export class Channel {
               payload: [message, options],
               type: 'send-message',
             },
-          })) as SendMessageAPIResponse;
+          });
         }
       }
     } catch (error) {
@@ -410,7 +410,7 @@ export class Channel {
     messageID: string,
     reaction: Reaction,
     options?: { enforce_unique?: boolean; skip_push?: boolean },
-  ): Promise<ReactionAPIResponse | undefined> {
+  ) {
     if (!messageID) {
       throw Error(`Message id is missing`);
     }
@@ -454,7 +454,7 @@ export class Channel {
     messageID: string,
     reaction: Reaction,
     options?: { enforce_unique?: boolean; skip_push?: boolean },
-  ): Promise<ReactionAPIResponse | undefined> {
+  ) {
     if (!messageID) {
       throw Error(`Message id is missing`);
     }
@@ -498,7 +498,7 @@ export class Channel {
           });
         }
 
-        return await offlineDb.queueTask({
+        return await offlineDb.queueTask<ReactionAPIResponse>({
           task: {
             channelId: this.id as string,
             channelType: this.type,

package/src/client.ts

@@ -777,7 +777,24 @@ export class StreamChat {
         'data_template': 'data handlebars template',
         'apn_template': 'apn notification handlebars template under v2'
       },
-      'webhook_url': 'https://acme.com/my/awesome/webhook/'
+      'webhook_url': 'https://acme.com/my/awesome/webhook/',
+      'event_hooks': [
+        {
+          'hook_type': 'webhook',
+          'enabled': true,
+          'event_types': ['message.new'],
+          'webhook_url': 'https://acme.com/my/awesome/webhook/'
+        },
+        {
+          'hook_type': 'sqs',
+          'enabled': true,
+          'event_types': ['message.new'],
+          'sqs_url': 'https://sqs.us-east-1.amazonaws.com/1234567890/my-queue',
+          'sqs_auth_type': 'key',
+          'sqs_key': 'my-access-key',
+          'sqs_secret': 'my-secret-key'
+        }
+      ]
     }
    */
   async updateAppSettings(options: AppSettings) {
@@ -3019,13 +3036,15 @@ export class StreamChat {
         } else {
           await this.offlineDb.softDeleteMessage({ id: messageID });
         }
-        return await this.offlineDb.queueTask({
-          task: {
-            messageId: messageID,
-            payload: [messageID, hardDelete],
-            type: 'delete-message',
+        return await this.offlineDb.queueTask<APIResponse & { message: MessageResponse }>(
+          {
+            task: {
+              messageId: messageID,
+              payload: [messageID, hardDelete],
+              type: 'delete-message',
+            },
           },
-        });
+        );
       }
     } catch (error) {
       this.logger('error', `offlineDb:deleteMessage`, {

package/src/offline-support/offline_support_api.ts

@@ -6,6 +6,7 @@ import type {
   PendingTask,
   PrepareBatchDBQueries,
 } from './types';
+import { OfflineError } from './types';
 import type { StreamChat } from '../client';
 import type { AxiosError } from 'axios';
 import { OfflineDBSyncManager } from './offline_sync_manager';
@@ -986,22 +987,24 @@ export abstract class AbstractOfflineDB implements OfflineDBApi {
    * It will return the response from the execution if it succeeded.
    * @param task - the pending task we want to execute
    */
-  public queueTask = async ({ task }: { task: PendingTask }) => {
-    let response;
-    try {
+  public queueTask = async <T>({ task }: { task: PendingTask }): Promise<T> => {
+    const attemptTaskExecution = async () => {
       if (!this.client.wsConnection?.isHealthy) {
-        await this.addPendingTask(task);
-        return;
+        throw new OfflineError(
+          'Cannot execute task because the connection has been lost.',
+          { type: 'connection:lost' },
+        );
       }
-      response = await this.executeTask({ task });
+      return (await this.executeTask({ task })) as T;
+    };
+    try {
+      return await attemptTaskExecution();
     } catch (e) {
       if (!this.shouldSkipQueueingTask(e as AxiosError<APIErrorResponse>)) {
         await this.addPendingTask(task);
-        throw e;
       }
+      throw e;
     }
-
-    return response;
   };
 
   /**

package/src/offline-support/types.ts

@@ -6,7 +6,6 @@ import type {
   ChannelResponse,
   ChannelSort,
   LocalMessage,
-  Message,
   MessageResponse,
   PollResponse,
   ReactionFilters,
@@ -398,6 +397,31 @@ export type PendingTask = {
     }
 );
 
-export type PendingTaskExtraData = {
-  message?: Message;
-};
+export type OfflineErrorType = 'connection:lost';
+
+export class OfflineError extends Error {
+  public type: OfflineErrorType;
+  public name = 'OfflineError';
+
+  constructor(
+    message: string,
+    {
+      type,
+    }: {
+      type: OfflineError['type'];
+    },
+  ) {
+    super(message);
+    this.type = type;
+  }
+
+  // Vitest helper (serialized errors are too large to read)
+  // https://github.com/vitest-dev/vitest/blob/v3.1.3/packages/utils/src/error.ts#L60-L62
+  toJSON() {
+    return {
+      message: `${this.type} - ${this.message}`,
+      stack: this.stack,
+      name: this.name,
+    };
+  }
+}

package/src/types.ts

@@ -129,6 +129,7 @@ export type AppSettingsAPIResponse = APIResponse & {
     disable_auth_checks?: boolean;
     disable_permissions_checks?: boolean;
     enforce_unique_usernames?: 'no' | 'app' | 'team';
+    event_hooks?: Array<EventHook>;
     file_upload_config?: FileUploadConfig;
     geofences?: Array<{
       country_codes: Array<string>;
@@ -2213,6 +2214,7 @@ export type AppSettings = {
   disable_auth_checks?: boolean;
   disable_permissions_checks?: boolean;
   enforce_unique_usernames?: 'no' | 'app' | 'team';
+  event_hooks?: Array<EventHook> | null;
   // all possible file mime types are https://www.iana.org/assignments/media-types/media-types.xhtml
   file_upload_config?: FileUploadConfig;
   firebase_config?: {
@@ -4006,3 +4008,27 @@ export type ThreadFilters = QueryFilters<
       | PrimitiveFilter<ThreadResponse['last_message_at']>;
   }
 >;
+
+export type HookType = 'webhook' | 'sqs' | 'sns';
+
+export type EventHook = {
+  id?: string;
+  hook_type?: HookType;
+  enabled?: boolean;
+  event_types?: Array<string>;
+  webhook_url?: string;
+  sqs_queue_url?: string;
+  sqs_region?: string;
+  sqs_auth_type?: string;
+  sqs_key?: string;
+  sqs_secret?: string;
+  sqs_role_arn?: string;
+  sns_topic_arn?: string;
+  sns_region?: string;
+  sns_auth_type?: string;
+  sns_key?: string;
+  sns_secret?: string;
+  sns_role_arn?: string;
+  created_at?: string;
+  updated_at?: string;
+};

package/src/utils/mergeWith/mergeWithCore.ts

@@ -438,7 +438,13 @@ export function createMergeCore<T extends object>(options: { trackDiff?: boolean
       return false;
     }
 
-    function createNewTarget(targetValue: unknown, srcValue: unknown): object {
+    function createNewTarget(targetValue: unknown, srcValue: object): object {
+      if (targetValue === null || typeof targetValue === 'undefined') {
+        return srcValue;
+      }
+      if (!Array.isArray(targetValue) && typeof targetValue !== 'object') {
+        return srcValue;
+      }
       if (targetValue && typeof targetValue === 'object') {
         // Check if it's a class instance (not a plain object)
         const isTargetClassInstance = isClassInstance(targetValue);