Cleanup and adjustments

Author: arnautov-anton

src/LiveLocationManager.ts

@@ -11,9 +11,10 @@
 import { withCancellation } from './utils/concurrency';
 import { StateStore } from './store';
 import { WithSubscriptions } from './utils/WithSubscriptions';
-import type { ListenerKeys, StreamChat } from './client';
+import type { StreamChat } from './client';
 import type { Unsubscribe } from './store';
 import type {
+  EventType,
   MessageResponse,
   SharedLiveLocationResponse,
   SharedLocationResponse,
@@ -221,7 +222,7 @@ export class LiveLocationManager extends WithSubscriptions {
           'live_location_sharing.started',
           'message.updated',
           'message.deleted',
-        ] satisfies ListenerKeys[]
+        ] satisfies EventType[]
       ).map((eventType) =>
         this.client.on(eventType, (event) => {
           if (!event.message) return;

src/channel.ts

@@ -8,7 +8,7 @@ import {
   logChatPromiseExecution,
   messageSetPagination,
 } from './utils';
-import type { ListenerKeys, StreamChat } from './client';
+import type { StreamChat } from './client';
 import { chatLoggerSystem } from './logger';
 import { DEFAULT_QUERY_CHANNEL_MESSAGE_LIST_PAGE_SIZE } from './constants';
 import type {
@@ -21,10 +21,11 @@ import type {
   ChannelQueryOptions,
   ChannelResponse,
   ChannelUpdateOptions,
-  CombinedEvents,
   CreateDraftResponse,
+  Event,
   EventHandler,
   EventPayload,
+  EventType,
   GetRepliesAPIResponse,
   GetRepliesRequest,
   LiveLocationPayload,
@@ -76,7 +77,7 @@ export class Channel extends ChannelApi {
   _data: ChannelData;
   cid: string;
   /**  */
-  listeners: Map<ListenerKeys, Set<EventHandler>>;
+  listeners: Map<EventType, Set<EventHandler>>;
   state: ChannelState;
   /**
    * This boolean is a vague indication of whether the channel exists on chat backend.
@@ -283,7 +284,7 @@ export class Channel extends ChannelApi {
    * @param event - For example `{ type: 'message.read' }`.
    * @returns The server response.
    */
-  override async sendEvent(request: { event: CombinedEvents }) {
+  override async sendEvent(request: { event: Event }) {
     this._checkInitialized();
     return await super.sendEvent(request);
   }
@@ -1497,7 +1498,7 @@ export class Channel extends ChannelApi {
    * @param callbackOrNothing - The callback to call when an event type was provided (optional).
    * @returns An object with an `unsubscribe()` method.
    */
-  on<T extends ListenerKeys | string>(
+  on<T extends EventType | string>(
     eventType: T,
     callback: EventHandler<T>,
   ): { unsubscribe: () => void };
@@ -1506,7 +1507,7 @@ export class Channel extends ChannelApi {
     callbackOrString: EventHandler | string,
     callbackOrNothing?: EventHandler,
   ): { unsubscribe: () => void } {
-    const key = callbackOrNothing ? (callbackOrString as ListenerKeys) : 'all';
+    const key = callbackOrNothing ? (callbackOrString as EventType) : 'all';
     const callback = callbackOrNothing
       ? callbackOrNothing
       : (callbackOrString as EventHandler);
@@ -1541,10 +1542,10 @@ export class Channel extends ChannelApi {
    * @param callbackOrString - The event type, or the callback when removing an all-events listener.
    * @param callbackOrNothing - The callback to remove when an event type was provided (optional).
    */
-  off<T extends ListenerKeys | string>(eventType: T, callback: EventHandler): void;
+  off<T extends EventType | string>(eventType: T, callback: EventHandler): void;
   off(callback: EventHandler): void;
   off(callbackOrString: EventHandler | string, callbackOrNothing?: EventHandler): void {
-    const key = callbackOrNothing ? (callbackOrString as ListenerKeys) : 'all';
+    const key = callbackOrNothing ? (callbackOrString as EventType) : 'all';
     const callback = callbackOrNothing
       ? callbackOrNothing
       : (callbackOrString as EventHandler);
@@ -1562,7 +1563,7 @@ export class Channel extends ChannelApi {
     }
   }
 
-  _handleChannelEvent(event: CombinedEvents) {
+  _handleChannelEvent(event: Event) {
     // eslint-disable-next-line @typescript-eslint/no-this-alias
     const channel = this;
     logger

src/channel_manager.ts

@@ -3,7 +3,7 @@ import type {
   ChannelFilters,
   ChannelSort,
   ChannelStateOptions,
-  CombinedEvents,
+  Event,
   EventPayload,
   QueryChannelsAPIResponse,
   QueryChannelsRequest,
@@ -59,9 +59,9 @@ export type ChannelSetterParameterType = ValueOrPatch<ChannelManagerState['chann
 export type ChannelSetterType = (arg: ChannelSetterParameterType) => void;
 
 export type GenericEventHandlerType<T extends unknown[]> = (...args: T) => any;
-export type EventHandlerType = GenericEventHandlerType<[CombinedEvents]>;
+export type EventHandlerType = GenericEventHandlerType<[Event]>;
 export type EventHandlerOverrideType = GenericEventHandlerType<
-  [ChannelSetterType, CombinedEvents]
+  [ChannelSetterType, Event]
 >;
 
 export type ChannelManagerEventTypes =
@@ -527,7 +527,7 @@ export class ChannelManager extends WithSubscriptions {
     }
   };
 
-  private notificationAddedToChannelHandler = async (event_: CombinedEvents) => {
+  private notificationAddedToChannelHandler = async (event_: Event) => {
     const event = event_ as EventPayload<'notification.added_to_channel'>;
     const { id, type, members } = event?.channel ?? {};
 
@@ -569,7 +569,7 @@ export class ChannelManager extends WithSubscriptions {
     );
   };
 
-  private channelDeletedHandler = (event_: CombinedEvents) => {
+  private channelDeletedHandler = (event_: Event) => {
     const event = event_ as EventPayload<
       'channel.deleted' | 'channel.hidden' | 'notification.removed_from_channel'
     >;
@@ -594,7 +594,7 @@ export class ChannelManager extends WithSubscriptions {
 
   private channelHiddenHandler = this.channelDeletedHandler;
 
-  private newMessageHandler = (event_: CombinedEvents) => {
+  private newMessageHandler = (event_: Event) => {
     const event = event_ as EventPayload<'message.new'>;
 
     const { pagination, channels } = this.state.getLatestValue();
@@ -646,7 +646,7 @@ export class ChannelManager extends WithSubscriptions {
     );
   };
 
-  private notificationNewMessageHandler = async (event_: CombinedEvents) => {
+  private notificationNewMessageHandler = async (event_: Event) => {
     const event = event_ as EventPayload<'notification.message_new'>;
 
     const { id, type } = event?.channel ?? {};
@@ -685,7 +685,7 @@ export class ChannelManager extends WithSubscriptions {
     );
   };
 
-  private channelVisibleHandler = async (event_: CombinedEvents) => {
+  private channelVisibleHandler = async (event_: Event) => {
     const event = event_ as EventPayload<'channel.visible' | 'channel.hidden'>;
     const { channel_type: channelType, channel_id: channelId } = event;
 
@@ -725,7 +725,7 @@ export class ChannelManager extends WithSubscriptions {
 
   private notificationRemovedFromChannelHandler = this.channelDeletedHandler;
 
-  private memberUpdatedHandler = (event_: CombinedEvents) => {
+  private memberUpdatedHandler = (event_: Event) => {
     const event = event_ as EventPayload<'member.updated'>;
     const { pagination, channels } = this.state.getLatestValue();
     const { filters, sort = [] } = getResponseFiltersAndSort(pagination);
@@ -795,7 +795,7 @@ export class ChannelManager extends WithSubscriptions {
     this.setChannels(newChannels);
   };
 
-  private subscriptionOrOverride = (event: CombinedEvents) => {
+  private subscriptionOrOverride = (event: Event) => {
     const handlerName =
       channelManagerEventToHandlerMapping[event.type as ChannelManagerEventTypes];
     const defaultEventHandler = this.eventHandlers.get(handlerName);

src/client.ts

@@ -33,11 +33,12 @@ import type {
   ChannelOptions,
   ChannelResponse,
   ChannelStateOptions,
-  CombinedEvents,
   Configs,
   ConnectAPIResponse,
   DeviceIdentifier,
+  Event,
   EventHandler,
+  EventType,
   FlagMessageResponse,
   FlagUserResponse,
   GetThreadOptions,
@@ -130,8 +131,6 @@ export type MessageComposerSetupState = {
   setupFunction: MessageComposerSetupFunction | null;
 };
 
-export type ListenerKeys = CombinedEvents['type'] | 'all';
-
 type ClientUser = PartializeAllBut<OwnUserResponse, 'id'> & { anon?: boolean };
 
 export class StreamChat extends ChatApi {
@@ -162,7 +161,7 @@ export class StreamChat extends ChatApi {
   clientId?: string;
   configs: Configs;
   key: string;
-  listeners: Map<ListenerKeys, Set<EventHandler>>;
+  listeners: Map<EventType, Set<EventHandler>>;
   /**
    * When network is recovered, we re-query the active channels on client. But in single query, you can recover
    * only 30 channels. So its not guaranteed that all the channels in activeChannels object have updated state.
@@ -727,15 +726,15 @@ export class StreamChat extends ChatApi {
    * @returns An object with an `unsubscribe()` method.
    */
   on(callback: EventHandler): { unsubscribe: () => void };
-  on<T extends ListenerKeys | string>(
+  on<T extends EventType | string>(
     eventType: T,
     callback: EventHandler<T>,
   ): { unsubscribe: () => void };
   on(
     callbackOrString: EventHandler | string,
     callbackOrNothing?: EventHandler,
   ): { unsubscribe: () => void } {
-    const key = callbackOrNothing ? (callbackOrString as ListenerKeys) : 'all';
+    const key = callbackOrNothing ? (callbackOrString as EventType) : 'all';
     const callback = callbackOrNothing
       ? callbackOrNothing
       : (callbackOrString as EventHandler);
@@ -769,7 +768,7 @@ export class StreamChat extends ChatApi {
   off(callback: EventHandler): void;
   off(eventType: string, callback: EventHandler): void;
   off(callbackOrString: EventHandler | string, callbackOrNothing?: EventHandler) {
-    const key = callbackOrNothing ? (callbackOrString as ListenerKeys) : 'all';
+    const key = callbackOrNothing ? (callbackOrString as EventType) : 'all';
     const callback = callbackOrNothing
       ? callbackOrNothing
       : (callbackOrString as EventHandler);
@@ -785,14 +784,14 @@ export class StreamChat extends ChatApi {
     }
   }
 
-  dispatchEvent = (event: CombinedEvents) => {
+  dispatchEvent = (event: Event) => {
     if (!event.received_at) event.received_at = new Date();
 
     // client event handlers
     const postListenerCallbacks = this._handleClientEvent(event as WSEvent);
 
     // channel event handlers
-    const cid = (event as Extract<CombinedEvents, { cid?: any }>).cid;
+    const cid = (event as Extract<Event, { cid?: any }>).cid;
     const channel = cid ? this.activeChannels[cid] : undefined;
     if (channel) {
       channel._handleChannelEvent(event as WSEvent);
@@ -1060,7 +1059,7 @@ export class StreamChat extends ChatApi {
     };
   }
 
-  _callClientListeners = (event: CombinedEvents) => {
+  _callClientListeners = (event: Event) => {
     const allSet = this.listeners.get('all');
     const targetSet = this.listeners.get(event.type);
 

src/messageComposer/messageComposer.ts

@@ -23,13 +23,14 @@ import type {
   CommandResponse,
   DraftMessage,
   DraftResponse,
+  EventType,
   LocalMessage,
   MessageResponse,
   UserResponse,
 } from '../types';
 import { chatLoggerSystem } from '../logger';
 import { WithSubscriptions } from '../utils/WithSubscriptions';
-import type { ListenerKeys, StreamChat } from '../client';
+import type { StreamChat } from '../client';
 import type { CommandSendability, MessageComposerConfig } from './configuration/types';
 import type {
   CommandSuggestionDisabledReason,
@@ -621,7 +622,7 @@ export class MessageComposer extends WithSubscriptions {
       'reaction.new',
       'reaction.deleted', // todo: do we need to subscribe to this especially when the whole state is overriden?
       'reaction.updated', // todo: do we need to subscribe to this especially when the whole state is overriden?
-    ] satisfies ListenerKeys[];
+    ] satisfies EventType[];
 
     const unsubscribeFunctions = eventTypes.map(
       (eventType) =>

src/offline-support/offline_support_api.ts

@@ -1,8 +1,9 @@
 import type {
   APIErrorResponse,
   ChannelResponse,
-  CombinedEvents,
+  Event,
   EventPayload,
+  EventType,
   LocalMessage,
   Message,
   MessageResponse,
@@ -17,7 +18,7 @@ import type {
   PrepareBatchDBQueries,
 } from './types';
 import { OfflineError } from './types';
-import type { ListenerKeys, StreamChat } from '../client';
+import type { StreamChat } from '../client';
 import type { AxiosError } from 'axios';
 import { OfflineDBSyncManager } from './offline_sync_manager';
 import { chatLoggerSystem } from '../logger';
@@ -966,7 +967,7 @@ export abstract class AbstractOfflineDB implements OfflineDBApi {
       return [];
     }
 
-    const getReactionMethod = (type: ListenerKeys) => {
+    const getReactionMethod = (type: EventType) => {
       switch (type) {
         case 'reaction.new':
           return this.insertReaction;
@@ -1039,7 +1040,7 @@ export abstract class AbstractOfflineDB implements OfflineDBApi {
     event,
     execute = true,
   }: {
-    event: CombinedEvents;
+    event: Event;
     execute?: boolean;
   }) => {
     const { type } = event;

src/reminders/ReminderManager.ts

@@ -6,8 +6,8 @@ import { WithSubscriptions } from '../utils/WithSubscriptions';
 import type { ReminderResponseBaseOrResponse } from './Reminder';
 import type { StreamChat } from '../client';
 import type {
-  CombinedEvents,
   CreateReminderOptions,
+  Event,
   EventPayload,
   LocalMessage,
   MessageResponse,
@@ -160,7 +160,7 @@ export class ReminderManager extends WithSubscriptions {
   // Timers API END //
 
   // WS event handling START //
-  static isReminderWsEventPayload = (event: CombinedEvents): event is ReminderEvent =>
+  static isReminderWsEventPayload = (event: Event): event is ReminderEvent =>
     'reminder' in event &&
     !!event.reminder &&
     (event.type.startsWith('reminder.') || event.type === 'notification.reminder_due');

src/thread.ts

@@ -7,6 +7,7 @@ import {
   throttle,
 } from './utils';
 import type {
+  EventType,
   LocalMessage,
   MessagePaginationOptions,
   MessageResponse,
@@ -16,7 +17,7 @@ import type {
 } from './types';
 import type { SortParamRequest as Gen_SortParamRequest } from './gen/models';
 import type { Channel } from './channel';
-import type { ListenerKeys, StreamChat } from './client';
+import type { StreamChat } from './client';
 import type { CustomThreadData } from './custom_types';
 import { MessageComposer } from './messageComposer';
 import { WithSubscriptions } from './utils/WithSubscriptions';
@@ -400,7 +401,7 @@ export class Thread extends WithSubscriptions {
       'reaction.new',
       'reaction.deleted',
       'reaction.updated',
-    ] satisfies ListenerKeys[];
+    ] satisfies EventType[];
 
     const unsubscribeFunctions = eventTypes.map(
       (eventType) =>