stream-chat 9.11.0 → 9.13.0

package/src/messageComposer/configuration/types.ts

@@ -11,6 +11,7 @@ export type UploadRequestFn = (
 export type DraftsConfiguration = {
   enabled: boolean;
 };
+
 export type TextComposerConfig = {
   /** If false, the text input, change and selection events are disabled */
   enabled: boolean;
@@ -23,6 +24,7 @@ export type TextComposerConfig = {
   /** Prevents sending a message longer than this length */
   maxLengthOnSend?: number;
 };
+
 export type AttachmentManagerConfig = {
   // todo: document removal of noFiles prop showing how to achieve the same with custom fileUploadFilter function
   /**
@@ -53,6 +55,16 @@ export type LinkPreviewsManagerConfig = {
   onLinkPreviewDismissed?: (linkPreview: LinkPreview) => void;
 };
 
+export type LocationComposerConfig = {
+  /**
+   * Allows for toggling the location addition.
+   * By default, the feature is enabled but has to be enabled also on channel level config via shared_locations.
+   */
+  enabled: boolean;
+  /** Function that provides a stable id for a device from which the location is shared */
+  getDeviceId: () => string;
+};
+
 export type MessageComposerConfig = {
   /** If true, enables creating drafts on the server */
   drafts: DraftsConfiguration;
@@ -60,6 +72,8 @@ export type MessageComposerConfig = {
   attachments: AttachmentManagerConfig;
   /** Configuration for the link previews manager */
   linkPreviews: LinkPreviewsManagerConfig;
+  /** Configuration for the location composer */
+  location: LocationComposerConfig;
   /** Maximum number of characters in a message */
   text: TextComposerConfig;
 };

package/src/messageComposer/index.ts

@@ -4,6 +4,7 @@ export * from './configuration';
 export * from './CustomDataManager';
 export * from './fileUtils';
 export * from './linkPreviewsManager';
+export * from './LocationComposer';
 export * from './messageComposer';
 export * from './middleware';
 export * from './pollComposer';

package/src/messageComposer/messageComposer.ts

@@ -1,14 +1,16 @@
 import { AttachmentManager } from './attachmentManager';
 import { CustomDataManager } from './CustomDataManager';
 import { LinkPreviewsManager } from './linkPreviewsManager';
+import { LocationComposer } from './LocationComposer';
 import { PollComposer } from './pollComposer';
 import { TextComposer } from './textComposer';
-import { DEFAULT_COMPOSER_CONFIG } from './configuration/configuration';
+import { DEFAULT_COMPOSER_CONFIG } from './configuration';
 import type { MessageComposerMiddlewareValue } from './middleware';
 import {
   MessageComposerMiddlewareExecutor,
   MessageDraftComposerMiddlewareExecutor,
 } from './middleware';
+import type { Unsubscribe } from '../store';
 import { StateStore } from '../store';
 import { formatMessage, generateUUIDv4, isLocalMessage, unformatMessage } from '../utils';
 import { mergeWith } from '../utils/mergeWith';
@@ -24,11 +26,11 @@ import type {
   MessageResponse,
   MessageResponseBase,
 } from '../types';
+import { WithSubscriptions } from '../utils/WithSubscriptions';
 import type { StreamChat } from '../client';
 import type { MessageComposerConfig } from './configuration/types';
 import type { DeepPartial } from '../types.utility';
-import type { Unsubscribe } from '../store';
-import { WithSubscriptions } from '../utils/WithSubscriptions';
+import type { MergeWithCustomizer } from '../utils/mergeWith/mergeWithCore';
 
 type UnregisterSubscriptions = Unsubscribe;
 
@@ -129,6 +131,7 @@ export class MessageComposer extends WithSubscriptions {
   linkPreviewsManager: LinkPreviewsManager;
   textComposer: TextComposer;
   pollComposer: PollComposer;
+  locationComposer: LocationComposer;
   customDataManager: CustomDataManager;
   // todo: mediaRecorder: MediaRecorderController;
 
@@ -142,10 +145,6 @@ export class MessageComposer extends WithSubscriptions {
 
     this.compositionContext = compositionContext;
 
-    this.configState = new StateStore<MessageComposerConfig>(
-      mergeWith(DEFAULT_COMPOSER_CONFIG, config ?? {}),
-    );
-
     // channel is easily inferable from the context
     if (compositionContext instanceof Channel) {
       this.channel = compositionContext;
@@ -160,6 +159,32 @@ export class MessageComposer extends WithSubscriptions {
       );
     }
 
+    const mergeChannelConfigCustomizer: MergeWithCustomizer<
+      DeepPartial<MessageComposerConfig>
+    > = (originalVal, channelConfigVal, key) =>
+      typeof originalVal === 'object'
+        ? undefined
+        : originalVal === false && key === 'enabled' // prevent enabling features that are disabled client-side
+          ? false
+          : ['string', 'number', 'bigint', 'boolean', 'symbol'].includes(
+                // prevent enabling features that are disabled server-side
+                typeof channelConfigVal,
+              )
+            ? channelConfigVal // scalar values get overridden by server-side config
+            : originalVal;
+
+    this.configState = new StateStore<MessageComposerConfig>(
+      mergeWith(
+        mergeWith(DEFAULT_COMPOSER_CONFIG, config ?? {}),
+        {
+          location: {
+            enabled: this.channel.getConfig()?.shared_locations,
+          },
+        },
+        mergeChannelConfigCustomizer,
+      ),
+    );
+
     let message: LocalMessage | DraftMessage | undefined = undefined;
     if (compositionIsDraftResponse(composition)) {
       message = composition.message;
@@ -170,6 +195,7 @@ export class MessageComposer extends WithSubscriptions {
 
     this.attachmentManager = new AttachmentManager({ composer: this, message });
     this.linkPreviewsManager = new LinkPreviewsManager({ composer: this, message });
+    this.locationComposer = new LocationComposer({ composer: this, message });
     this.textComposer = new TextComposer({ composer: this, message });
     this.pollComposer = new PollComposer({ composer: this });
     this.customDataManager = new CustomDataManager({ composer: this, message });
@@ -289,7 +315,8 @@ export class MessageComposer extends WithSubscriptions {
       (!this.attachmentManager.uploadsInProgressCount &&
         (!this.textComposer.textIsEmpty ||
           this.attachmentManager.successfulUploadsCount > 0)) ||
-      this.pollId
+      this.pollId ||
+      !!this.locationComposer.validLocation
     );
   }
 
@@ -298,7 +325,8 @@ export class MessageComposer extends WithSubscriptions {
       !this.quotedMessage &&
       this.textComposer.textIsEmpty &&
       !this.attachmentManager.attachments.length &&
-      !this.pollId
+      !this.pollId &&
+      !this.locationComposer.validLocation
     );
   }
 
@@ -320,6 +348,10 @@ export class MessageComposer extends WithSubscriptions {
 
   static generateId = generateUUIDv4;
 
+  refreshId = () => {
+    this.state.partialNext({ id: MessageComposer.generateId() });
+  };
+
   initState = ({
     composition,
   }: { composition?: DraftResponse | MessageResponse | LocalMessage } = {}) => {
@@ -333,6 +365,7 @@ export class MessageComposer extends WithSubscriptions {
           : formatMessage(composition);
     this.attachmentManager.initState({ message });
     this.linkPreviewsManager.initState({ message });
+    this.locationComposer.initState({ message });
     this.textComposer.initState({ message });
     this.pollComposer.initState();
     this.customDataManager.initState({ message });
@@ -403,6 +436,7 @@ export class MessageComposer extends WithSubscriptions {
       this.addUnsubscribeFunction(this.subscribeTextComposerStateChanged());
       this.addUnsubscribeFunction(this.subscribeAttachmentManagerStateChanged());
       this.addUnsubscribeFunction(this.subscribeLinkPreviewsManagerStateChanged());
+      this.addUnsubscribeFunction(this.subscribeLocationComposerStateChanged());
       this.addUnsubscribeFunction(this.subscribePollComposerStateChanged());
       this.addUnsubscribeFunction(this.subscribeCustomDataManagerStateChanged());
       this.addUnsubscribeFunction(this.subscribeMessageComposerStateChanged());
@@ -535,6 +569,18 @@ export class MessageComposer extends WithSubscriptions {
       }
     });
 
+  private subscribeLocationComposerStateChanged = () =>
+    this.locationComposer.state.subscribe((_, previousValue) => {
+      if (typeof previousValue === 'undefined') return;
+
+      this.logStateUpdateTimestamp();
+
+      if (this.compositionIsEmpty) {
+        this.deleteDraft();
+        return;
+      }
+    });
+
   private subscribeLinkPreviewsManagerStateChanged = () =>
     this.linkPreviewsManager.state.subscribe((_, previousValue) => {
       if (typeof previousValue === 'undefined') return;
@@ -800,4 +846,30 @@ export class MessageComposer extends WithSubscriptions {
       throw error;
     }
   };
+
+  sendLocation = async () => {
+    const location = this.locationComposer.validLocation;
+    if (this.threadId || !location) return;
+    try {
+      await this.channel.sendSharedLocation(location);
+      this.refreshId();
+      this.locationComposer.initState();
+    } catch (error) {
+      this.client.notifications.addError({
+        message: 'Failed to share the location',
+        origin: {
+          emitter: 'MessageComposer',
+          context: { composer: this },
+        },
+        options: {
+          type: 'api:location:create:failed',
+          metadata: {
+            reason: (error as Error).message,
+          },
+          originalError: error instanceof Error ? error : undefined,
+        },
+      });
+      throw error;
+    }
+  };
 }

package/src/messageComposer/middleware/messageComposer/MessageComposerMiddlewareExecutor.ts

@@ -32,6 +32,7 @@ import {
 } from './customData';
 import { createUserDataInjectionMiddleware } from './userDataInjection';
 import { createPollOnlyCompositionMiddleware } from './pollOnly';
+import { createSharedLocationCompositionMiddleware } from './sharedLocation';
 
 export class MessageComposerMiddlewareExecutor extends MiddlewareExecutor<
   MessageComposerMiddlewareState,
@@ -47,6 +48,7 @@ export class MessageComposerMiddlewareExecutor extends MiddlewareExecutor<
       createTextComposerCompositionMiddleware(composer),
       createAttachmentsCompositionMiddleware(composer),
       createLinkPreviewsCompositionMiddleware(composer),
+      createSharedLocationCompositionMiddleware(composer),
       createMessageComposerStateCompositionMiddleware(composer),
       createCustomDataCompositionMiddleware(composer),
       createCompositionValidationMiddleware(composer),

package/src/messageComposer/middleware/messageComposer/compositionValidation.ts

@@ -20,15 +20,11 @@ export const createCompositionValidationMiddleware = (
     }: MiddlewareHandlerParams<MessageComposerMiddlewareState>) => {
       const { maxLengthOnSend } = composer.config.text ?? {};
       const inputText = state.message.text ?? '';
-      const isEmptyMessage =
-        textIsEmpty(inputText) &&
-        !state.message.attachments?.length &&
-        !state.message.poll_id;
 
       const hasExceededMaxLength =
         typeof maxLengthOnSend === 'number' && inputText.length > maxLengthOnSend;
 
-      if (isEmptyMessage || hasExceededMaxLength) {
+      if (composer.compositionIsEmpty || hasExceededMaxLength) {
         return await discard();
       }
 

package/src/messageComposer/middleware/messageComposer/index.ts

@@ -5,6 +5,7 @@ export * from './compositionValidation';
 export * from './linkPreviews';
 export * from './MessageComposerMiddlewareExecutor';
 export * from './messageComposerState';
+export * from './sharedLocation';
 export * from './textComposer';
 export * from './types';
 export * from './commandInjection';

package/src/messageComposer/middleware/messageComposer/sharedLocation.ts

@@ -0,0 +1,42 @@
+import type { MiddlewareHandlerParams } from '../../../middleware';
+import type { MessageComposer } from '../../messageComposer';
+import type {
+  MessageComposerMiddlewareState,
+  MessageCompositionMiddleware,
+} from './types';
+
+export const createSharedLocationCompositionMiddleware = (
+  composer: MessageComposer,
+): MessageCompositionMiddleware => ({
+  id: 'stream-io/message-composer-middleware/shared-location',
+  handlers: {
+    compose: ({
+      state,
+      next,
+      forward,
+    }: MiddlewareHandlerParams<MessageComposerMiddlewareState>) => {
+      const { locationComposer } = composer;
+      const location = locationComposer.validLocation;
+      if (!locationComposer || !location || !composer.client.user) return forward();
+      const timestamp = new Date().toISOString();
+
+      return next({
+        ...state,
+        localMessage: {
+          ...state.localMessage,
+          shared_location: {
+            ...location,
+            channel_cid: composer.channel.cid,
+            created_at: timestamp,
+            updated_at: timestamp,
+            user_id: composer.client.user.id,
+          },
+        },
+        message: {
+          ...state.message,
+          shared_location: location,
+        },
+      });
+    },
+  },
+});

package/src/offline-support/offline_sync_manager.ts

@@ -1,6 +1,9 @@
 import type { ExecuteBatchDBQueriesType } from './types';
 import type { StreamChat } from '../client';
 import type { AbstractOfflineDB } from './offline_support_api';
+import type { AxiosError } from 'axios';
+import { isAxiosError } from 'axios';
+import type { APIErrorResponse } from '../types';
 
 /**
  * Manages synchronization between the local offline database and the Stream backend.
@@ -174,8 +177,21 @@ export class OfflineDBSyncManager {
       });
     } catch (e) {
       console.log('An error has occurred while syncing the DB.', e);
+
+      if (isAxiosError(e) && e.code === 'ECONNABORTED') {
+        // If the sync was aborted due to timeout, we can simply return
+        return;
+      }
+
+      const error = e as AxiosError<APIErrorResponse>;
+
+      if (error.response?.data?.code === 23) {
+        return;
+      }
+
       // Error will be raised by the sync API if there are too many events.
       // In that case reset the entire DB and start fresh.
+      // We avoid resetting the DB if the error is due to timeout.
       await this.offlineDb.resetDB();
     }
   };

package/src/types.ts

@@ -576,6 +576,23 @@ export type GetRateLimitsResponse = APIResponse & {
   web?: RateLimitsMap;
 };
 
+export enum Product {
+  Chat = 'chat',
+  Video = 'video',
+  Moderation = 'moderation',
+  Feeds = 'feeds',
+}
+
+export type HookEvent = {
+  name: string;
+  description: string;
+  products: Product[];
+};
+
+export type GetHookEventsResponse = APIResponse & {
+  events: HookEvent[];
+};
+
 export type GetReactionsAPIResponse = APIResponse & {
   reactions: ReactionResponse[];
 };
@@ -2287,7 +2304,6 @@ export type Attachment = CustomAttachmentData & {
   original_height?: number;
   original_width?: number;
   pretext?: string;
-  stopped_sharing?: boolean;
   text?: string;
   thumb_url?: string;
   title?: string;
@@ -2348,6 +2364,7 @@ export type ChannelConfigFields = {
   read_events?: boolean;
   replies?: boolean;
   search?: boolean;
+  shared_locations?: boolean;
   typing_events?: boolean;
   uploads?: boolean;
   url_enrichment?: boolean;
@@ -2705,7 +2722,7 @@ export type Logger = (
 export type Message = Partial<
   MessageBase & {
     mentioned_users: string[];
-    shared_location?: SharedLocationRequest;
+    shared_location?: StaticLocationPayload | LiveLocationPayload;
   }
 >;
 
@@ -3966,13 +3983,14 @@ export type DraftMessage = {
   parent_id?: string;
   poll_id?: string;
   quoted_message_id?: string;
+  shared_location?: StaticLocationPayload | LiveLocationPayload; // todo: live-location verify if possible
   show_in_channel?: boolean;
   silent?: boolean;
   type?: MessageLabel;
 };
 
 export type ActiveLiveLocationsAPIResponse = APIResponse & {
-  active_live_locations: SharedLocationResponse[];
+  active_live_locations: SharedLiveLocationResponse[];
 };
 
 export type SharedLocationResponse = {
@@ -3987,11 +4005,51 @@ export type SharedLocationResponse = {
   user_id: string;
 };
 
-export type SharedLocationRequest = {
+export type SharedStaticLocationResponse = {
+  channel_cid: string;
+  created_at: string;
   created_by_device_id: string;
+  latitude: number;
+  longitude: number;
+  message_id: string;
+  updated_at: string;
+  user_id: string;
+};
+
+export type SharedLiveLocationResponse = {
+  channel_cid: string;
+  created_at: string;
+  created_by_device_id: string;
+  end_at: string;
+  latitude: number;
+  longitude: number;
+  message_id: string;
+  updated_at: string;
+  user_id: string;
+};
+
+export type UpdateLocationPayload = {
+  message_id: string;
+  created_by_device_id?: string;
   end_at?: string;
   latitude?: number;
   longitude?: number;
+  user?: { id: string };
+  user_id?: string;
+};
+
+export type StaticLocationPayload = {
+  created_by_device_id: string;
+  latitude: number;
+  longitude: number;
+  message_id: string;
+};
+
+export type LiveLocationPayload = {
+  created_by_device_id: string;
+  end_at: string;
+  latitude: number;
+  longitude: number;
   message_id: string;
 };
 
@@ -4064,9 +4122,9 @@ export type ReminderResponseBase = {
 };
 
 export type ReminderResponse = ReminderResponseBase & {
-  channel: ChannelResponse;
   user: UserResponse;
   message: MessageResponse;
+  channel?: ChannelResponse;
 };
 
 export type ReminderAPIResponse = APIResponse & {