@100mslive/hms-video-store 0.2.82 → 0.2.83

package/src/core/hmsSDKStore/HMSNotifications.ts

@@ -1,194 +0,0 @@
-import { EventEmitter2 as EventEmitter } from 'eventemitter2';
-import { IHMSNotifications } from '../IHMSNotifications';
-import { IHMSStore } from '../IHMSStore';
-import { selectPeerByID, selectTrackByID } from '../selectors';
-import * as sdkTypes from './sdkTypes';
-import { PEER_NOTIFICATION_TYPES, TRACK_NOTIFICATION_TYPES } from './common/mapping';
-import {
-  HMSNotification,
-  HMSNotificationTypes,
-  HMSNotificationSeverity,
-  HMSPeer,
-  HMSException,
-  HMSMessage,
-  HMSTrack,
-  HMSTrackID,
-  HMSChangeTrackStateRequest,
-  HMSChangeMultiTrackStateRequest,
-  HMSLeaveRoomRequest,
-  HMSDeviceChangeEvent,
-  HMSPlaylistItem,
-} from '../schema';
-
-const HMS_NOTIFICATION_EVENT = 'hmsNotification';
-export class HMSNotifications implements IHMSNotifications {
-  private id: number = 0;
-  private eventEmitter: EventEmitter;
-  private store: IHMSStore;
-
-  constructor(store: IHMSStore) {
-    this.store = store;
-    this.eventEmitter = new EventEmitter();
-  }
-
-  onNotification = (cb: (notification: HMSNotification) => void): (() => void) => {
-    this.eventEmitter.addListener(HMS_NOTIFICATION_EVENT, cb);
-    return () => {
-      this.eventEmitter.removeListener(HMS_NOTIFICATION_EVENT, cb);
-    };
-  };
-
-  sendPlaylistTrackEnded<T>(item: HMSPlaylistItem<T>): void {
-    const notification = this.createNotification(
-      HMSNotificationTypes.PLAYLIST_TRACK_ENDED,
-      item,
-      HMSNotificationSeverity.INFO,
-    );
-    this.emitEvent(notification);
-  }
-
-  sendDeviceChange(request: HMSDeviceChangeEvent) {
-    const notification = this.createNotification(
-      HMSNotificationTypes.DEVICE_CHANGE_UPDATE,
-      request,
-      request.error ? HMSNotificationSeverity.ERROR : HMSNotificationSeverity.INFO,
-      `Selected ${request.type} device - ${request.selection?.label}`,
-    );
-    this.emitEvent(notification);
-  }
-
-  sendLeaveRoom(request: HMSLeaveRoomRequest) {
-    const peerName = request.requestedBy?.name;
-    const notification = this.createNotification(
-      request.roomEnded || !peerName
-        ? HMSNotificationTypes.ROOM_ENDED
-        : HMSNotificationTypes.REMOVED_FROM_ROOM,
-      request,
-      HMSNotificationSeverity.INFO,
-      `${request.roomEnded ? `Room ended` : 'Removed from room'} ${
-        peerName ? `by ${peerName}` : ''
-      }`,
-    );
-    this.emitEvent(notification);
-  }
-
-  sendPeerList(peers: HMSPeer[]) {
-    const notification = this.createNotification(
-      HMSNotificationTypes.PEER_LIST,
-      peers,
-      HMSNotificationSeverity.INFO,
-    );
-    this.emitEvent(notification);
-  }
-
-  sendPeerUpdate(type: sdkTypes.HMSPeerUpdate, peer: HMSPeer | null) {
-    const hmsPeer = this.store.getState(selectPeerByID(peer?.id)) || peer;
-    const notificationType = PEER_NOTIFICATION_TYPES[type];
-    if (notificationType) {
-      const notification = this.createNotification(
-        notificationType,
-        hmsPeer,
-        HMSNotificationSeverity.INFO,
-      );
-      this.emitEvent(notification);
-    }
-  }
-
-  sendTrackUpdate(type: sdkTypes.HMSTrackUpdate, trackID: HMSTrackID) {
-    const hmsTrack = this.store.getState(selectTrackByID(trackID));
-    const notificationType = TRACK_NOTIFICATION_TYPES[type];
-    if (notificationType) {
-      const notification = this.createNotification(
-        notificationType,
-        hmsTrack,
-        HMSNotificationSeverity.INFO,
-      );
-      this.emitEvent(notification);
-    }
-  }
-
-  sendMessageReceived(message: HMSMessage) {
-    const notification = this.createNotification(
-      HMSNotificationTypes.NEW_MESSAGE,
-      message,
-      HMSNotificationSeverity.INFO,
-    );
-    this.emitEvent(notification);
-  }
-
-  sendError(error: HMSException) {
-    const notification = this.createNotification(
-      HMSNotificationTypes.ERROR,
-      error,
-      HMSNotificationSeverity.ERROR,
-    );
-    this.emitEvent(notification);
-  }
-
-  sendReconnecting(error: HMSException) {
-    const notification = this.createNotification(
-      HMSNotificationTypes.RECONNECTING,
-      error,
-      HMSNotificationSeverity.ERROR,
-    );
-    this.emitEvent(notification);
-  }
-
-  sendReconnected() {
-    const notification = this.createNotification(
-      HMSNotificationTypes.RECONNECTED,
-      null,
-      HMSNotificationSeverity.INFO,
-    );
-    this.emitEvent(notification);
-  }
-
-  sendChangeTrackStateRequest(request: HMSChangeTrackStateRequest) {
-    const notification = this.createNotification(
-      HMSNotificationTypes.CHANGE_TRACK_STATE_REQUEST,
-      request,
-      HMSNotificationSeverity.INFO,
-    );
-    this.emitEvent(notification);
-  }
-
-  sendChangeMultiTrackStateRequest(request: HMSChangeMultiTrackStateRequest) {
-    const notification = this.createNotification(
-      HMSNotificationTypes.CHANGE_MULTI_TRACK_STATE_REQUEST,
-      request,
-      HMSNotificationSeverity.INFO,
-    );
-    this.emitEvent(notification);
-  }
-
-  private emitEvent(notification: HMSNotification) {
-    this.eventEmitter.emit(HMS_NOTIFICATION_EVENT, notification);
-  }
-
-  private createNotification<T>(
-    type: string,
-    data?:
-      | HMSPeer
-      | HMSPeer[]
-      | HMSTrack
-      | HMSMessage
-      | HMSException
-      | HMSChangeTrackStateRequest
-      | HMSChangeMultiTrackStateRequest
-      | HMSLeaveRoomRequest
-      | HMSDeviceChangeEvent
-      | HMSPlaylistItem<T>
-      | null,
-    severity?: HMSNotificationSeverity,
-    message: string = '',
-  ): HMSNotification {
-    this.id++;
-    return {
-      id: this.id,
-      type,
-      message,
-      data,
-      severity,
-    };
-  }
-}

package/src/core/hmsSDKStore/HMSPlaylist.ts

@@ -1,78 +0,0 @@
-import { HMSPlaylistItem, HMSPlaylistType, IHMSPlaylistActions } from '../schema';
-import { HMSPlaylistManager } from './sdkTypes';
-import { HMSLogger } from '../../common/ui-logger';
-import { IHMSStore } from '../IHMSStore';
-import { selectVideoPlaylist, selectAudioPlaylist } from '../selectors';
-
-export class HMSPlaylist implements IHMSPlaylistActions {
-  private type: HMSPlaylistType;
-  constructor(
-    private playlistManager: HMSPlaylistManager,
-    type: HMSPlaylistType,
-    private syncPlaylistState: (action: string) => void,
-    private store: IHMSStore,
-  ) {
-    this.type = type;
-  }
-
-  async play(id: string): Promise<void> {
-    if (!id) {
-      HMSLogger.w('Please pass id to play');
-      return;
-    }
-    await this.playlistManager.setEnabled(true, { id, type: this.type });
-  }
-
-  async pause(): Promise<void> {
-    const selector =
-      this.type === HMSPlaylistType.audio ? selectAudioPlaylist : selectVideoPlaylist;
-    const selection = this.store.getState(selector.selection);
-    if (!selection.id) {
-      HMSLogger.w('No item is currently playing to pause');
-      return;
-    }
-    await this.playlistManager.setEnabled(false, { id: selection.id, type: this.type });
-  }
-
-  async playNext(): Promise<void> {
-    await this.playlistManager.playNext(this.type);
-  }
-
-  async playPrevious(): Promise<void> {
-    await this.playlistManager.playPrevious(this.type);
-  }
-
-  seek(seekValue: number): void {
-    this.playlistManager.seek(seekValue, this.type);
-    this.syncPlaylistState(`seekOn${this.type}Playlist`);
-  }
-
-  seekTo(seekValue: number): void {
-    this.playlistManager.seekTo(seekValue, this.type);
-    this.syncPlaylistState(`seekToOn${this.type}Playlist`);
-  }
-
-  setVolume(volume: number): void {
-    this.playlistManager.setVolume(volume, this.type);
-    this.syncPlaylistState(`setVolumeOn${this.type}Playlist`);
-  }
-
-  setList<T>(list: HMSPlaylistItem<T>[]): void {
-    this.playlistManager.setList(list);
-    this.syncPlaylistState(`setListOn${this.type}Playlist`);
-  }
-
-  async stop(): Promise<void> {
-    await this.playlistManager.stop(this.type);
-    this.syncPlaylistState(`stop${this.type}Playlist`);
-  }
-
-  setIsAutoplayOn(autoplay: boolean) {
-    this.playlistManager.setIsAutoplayOn(this.type, autoplay);
-  }
-
-  setPlaybackRate(playbackRate: number) {
-    this.playlistManager.setPlaybackRate(this.type, playbackRate);
-    this.syncPlaylistState(`set${this.type}PlaybackRate`);
-  }
-}

package/src/core/hmsSDKStore/HMSReactiveStore.ts

@@ -1,271 +0,0 @@
-import produce from 'immer';
-import create, {
-  StateSelector,
-  StoreApi,
-  SetState,
-  StateSliceListener,
-  EqualityChecker,
-  PartialState,
-  State,
-} from 'zustand/vanilla';
-import shallow from 'zustand/shallow';
-import { HMSSdk } from '@100mslive/hms-video';
-import { IHMSActions } from '../IHMSActions';
-import { HMSSDKActions } from './HMSSDKActions';
-import { IHMSStore, IHMSStoreReadOnly } from '../IHMSStore';
-import { createDefaultStoreState, HMSStore } from '../schema';
-import { HMSNotifications } from './HMSNotifications';
-import { IHMSNotifications } from '../IHMSNotifications';
-import { NamedSetState } from './internalTypes';
-
-export class HMSReactiveStore {
-  private readonly actions: IHMSActions;
-  private readonly store: IHMSStore;
-  private readonly notifications: HMSNotifications;
-  private initialTriggerOnSubscribe: boolean;
-
-  constructor(hmsStore?: IHMSStore, hmsActions?: IHMSActions, hmsNotifications?: HMSNotifications) {
-    if (hmsStore) {
-      this.store = hmsStore;
-    } else {
-      this.store = HMSReactiveStore.createNewHMSStore();
-    }
-    if (hmsNotifications) {
-      this.notifications = hmsNotifications;
-    } else {
-      this.notifications = new HMSNotifications(this.store);
-    }
-    if (hmsActions) {
-      this.actions = hmsActions;
-    } else {
-      this.actions = new HMSSDKActions(this.store, new HMSSdk(), this.notifications);
-    }
-    this.initialTriggerOnSubscribe = false;
-  }
-
-  /**
-   * By default store.subscribe does not call the handler with the current state at time of subscription,
-   * this behaviour can be modified by calling this function. What it means is that instead of calling the
-   * handler only for changes which happen post subscription we'll also call it exactly once at the time
-   * of subscription with the current state. This behaviour is similar to that of BehaviourSubject in rxjs.
-   * This will be an irreversible change
-   *
-   * Note: you don't need this if you're using our react hooks, it takes care of this requirement.
-   */
-  triggerOnSubscribe(): void {
-    if (this.initialTriggerOnSubscribe) {
-      // already done
-      return;
-    }
-    HMSReactiveStore.makeStoreTriggerOnSubscribe(this.store);
-    this.initialTriggerOnSubscribe = true;
-  }
-
-  /**
-   * A reactive store which has a subscribe method you can use in combination with selectors
-   * to subscribe to a subset of the store. The store serves as a single source of truth for
-   * all data related to the corresponding HMS Room.
-   */
-  getStore(): IHMSStoreReadOnly {
-    return this.store;
-  }
-
-  /**
-   * Any action which may modify the store or may need to talk to the SDK will happen
-   * through the IHMSActions instance returned by this
-   */
-  getHMSActions(): IHMSActions {
-    return this.actions;
-  }
-
-  /**
-   * This return notification handler function to which you can pass your callback to
-   * receive notifications like peer joined, peer left, etc. to show in your UI or use
-   * for analytics
-   */
-  getNotifications(): IHMSNotifications {
-    return { onNotification: this.notifications.onNotification };
-  }
-
-  /**
-   * @internal
-   */
-  static createNewHMSStore(): IHMSStore {
-    const hmsStore = create<HMSStore>(() => createDefaultStoreState());
-    // make set state immutable, by passing functions through immer
-    const savedSetState = hmsStore.setState;
-    hmsStore.setState = (partial: any) => {
-      const nextState = typeof partial === 'function' ? produce(partial) : partial;
-      savedSetState(nextState);
-    };
-    // add option to pass selector to getState
-    const prevGetState = hmsStore.getState;
-    // eslint-disable-next-line complexity
-    hmsStore.getState = <StateSlice>(selector?: StateSelector<HMSStore, StateSlice>) => {
-      if (selector) {
-        const name = selector.name || 'byIDSelector';
-        // @ts-ignore
-        if (!window.selectorsCount) {
-          // @ts-ignore
-          window.selectorsCount = {};
-        }
-        // @ts-ignore
-        window.selectorsCount[name] = (window.selectorsCount[name] || 0) + 1;
-        const start = performance.now();
-        const updatedState = selector(prevGetState());
-        const diff = performance.now() - start;
-        // store selectors that take more than 1ms
-        if (diff > 1) {
-          // @ts-ignore
-          window.expensiveSelectors = window.expensiveSelectors || new Map();
-          // @ts-ignore
-          window.expensiveSelectors.set(name, diff);
-        }
-        return updatedState;
-      }
-      return prevGetState();
-    };
-    HMSReactiveStore.useShallowCheckInSubscribe(hmsStore);
-    const namedSetState = HMSReactiveStore.setUpDevtools(hmsStore, 'HMSStore');
-    return { ...hmsStore, namedSetState };
-  }
-
-  /**
-   * @internal
-   */
-  static makeStoreTriggerOnSubscribe(store: IHMSStore) {
-    const prevSubscribe = store.subscribe;
-    store.subscribe = <StateSlice>(
-      listener: StateSliceListener<StateSlice>,
-      selector?: StateSelector<HMSStore, StateSlice>,
-      equalityFn?: EqualityChecker<StateSlice>,
-    ): (() => void) => {
-      // initial call, the prev state will always be null for this
-      listener(store.getState(selector), (undefined as unknown) as StateSlice);
-      // then subscribe
-      return prevSubscribe(listener, selector!, equalityFn);
-    };
-  }
-
-  /**
-   * use shallow equality check by default for subscribe to optimize for array/object selectors.
-   * by default zustand does only reference matching so something like, getPeers for eg. would trigger
-   * the corresponding component even if peers didn't actually change, as selectPeers creates a new array everytime.
-   * Although the array reference changes, the order of peers and peer objects don't themselves change in this case,
-   * and a shallow check avoids that triggering.
-   * @private
-   */
-  private static useShallowCheckInSubscribe(hmsStore: StoreApi<HMSStore>) {
-    const prevSubscribe = hmsStore.subscribe;
-    hmsStore.subscribe = <StateSlice>(
-      listener: StateSliceListener<StateSlice>,
-      selector?: StateSelector<HMSStore, StateSlice>,
-      equalityFn?: EqualityChecker<StateSlice>,
-    ): (() => void) => {
-      if (!selector) {
-        selector = (store): StateSlice => (store as unknown) as StateSlice;
-      }
-      equalityFn = equalityFn || shallow;
-      return prevSubscribe(listener, selector, equalityFn);
-    };
-  }
-
-  /**
-   * @private
-   * @privateRemarks
-   * sets up redux devtools for the store, so redux extension can be used to visualize the store.
-   * zustand's default devtool middleware only enhances the set function, we're here creating another nameSetState in
-   * IHMStore which behaves like setState but takes an extra parameter for action name
-   * https://github.com/zalmoxisus/redux-devtools-extension/blob/master/docs/API/Methods.md
-   * modified version of zustand's devtools - https://github.com/pmndrs/zustand/blob/v3.5.7/src/middleware.ts#L46
-   */
-  private static setUpDevtools<T extends State>(
-    api: StoreApi<T>,
-    prefix: string,
-  ): NamedSetState<HMSStore> {
-    let extension;
-    try {
-      extension =
-        (window as any).__REDUX_DEVTOOLS_EXTENSION__ ||
-        (window as any).top.__REDUX_DEVTOOLS_EXTENSION__;
-    } catch {}
-    if (!extension) {
-      return (fn: any) => {
-        api.setState(fn);
-      };
-    }
-    const devtools = extension.connect(HMSReactiveStore.devtoolsOptions(prefix));
-    devtools.prefix = prefix ? `${prefix} > ` : '';
-    const savedSetState = api.setState;
-    api.setState = (fn: any) => {
-      savedSetState(fn);
-      devtools.send(`${devtools.prefix}setState`, api.getState());
-    };
-
-    devtools.subscribe(HMSReactiveStore.devtoolsSubscribe(devtools, api, savedSetState));
-
-    devtools.send('setUpStore', api.getState());
-
-    return (fn: any, action?: string) => {
-      savedSetState(fn);
-      const actionName = action ? action : `${devtools.prefix}action`;
-      devtools.send(actionName, api.getState());
-    };
-  }
-
-  /**
-   * https://github.com/zalmoxisus/redux-devtools-extension/blob/master/docs/API/Arguments.md
-   */
-  private static devtoolsOptions(prefix: string) {
-    return {
-      name: prefix,
-      actionsBlacklist: ['audioLevel', 'playlistProgress'], // very high frequency update, pollutes the action history
-    };
-  }
-
-  /**
-   * redux devtools allows for time travel debugging where it sends an action to update the store, users can
-   * also export and import state in the devtools, listen to the corresponding functions from devtools and take
-   * required action.
-   * @param devtools - reference to devtools extension object
-   * @param api
-   * @param savedSetState - setState saved before its modified to update devtools
-   * @private
-   */
-  private static devtoolsSubscribe<T extends State>(
-    devtools: any,
-    api: StoreApi<T>,
-    savedSetState: SetState<T>,
-  ) {
-    // disabling complexity check instead of refactoring so as to keep the code close to zustand's and make
-    // any future update based on upstream changes easier.
-    // eslint-disable-next-line complexity
-    return (message: any) => {
-      if (message.type === 'DISPATCH' && message.state) {
-        const ignoreState = ['JUMP_TO_ACTION', 'JUMP_TO_STATE'].includes(message.payload.type);
-        if (!ignoreState) {
-          // manual dispatch from the extension
-          api.setState(JSON.parse(message.state));
-        } else {
-          // for time travel, no need to add new state changes in devtools
-          savedSetState(JSON.parse(message.state));
-        }
-      } else if (message.type === 'DISPATCH' && message.payload?.type === 'COMMIT') {
-        devtools.init(api.getState());
-      } else if (message.type === 'DISPATCH' && message.payload?.type === 'IMPORT_STATE') {
-        const actions = message.payload.nextLiftedState?.actionsById;
-        const computedStates = message.payload.nextLiftedState?.computedStates || [];
-
-        computedStates.forEach(({ state }: { state: PartialState<T> }, index: number) => {
-          const action = actions[index] || `${devtools.prefix}setState`;
-          if (index === 0) {
-            devtools.init(state);
-          } else {
-            savedSetState(state);
-            devtools.send(action, api.getState());
-          }
-        });
-      }
-    };
-  }
-}