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

package/dist/index.js

@@ -1,8 +0,0 @@
-
-'use strict'
-
-if (process.env.NODE_ENV === 'production') {
-  module.exports = require('./hms-video-store.cjs.production.min.js')
-} else {
-  module.exports = require('./hms-video-store.cjs.development.js')
-}

package/dist/test/fakeStore.d.ts

@@ -1,23 +0,0 @@
-import { HMSPeer, HMSSpeaker, HMSStore, HMSTrack } from '../core';
-import { HMSPlaylist, HMSRole } from '../core/schema';
-export declare let localPeer: HMSPeer;
-export declare let remotePeerOne: HMSPeer;
-export declare let remotePeerTwo: HMSPeer;
-export declare let peerScreenSharing: HMSPeer;
-export declare let localVideo: HMSTrack;
-export declare let localAudio: HMSTrack;
-export declare let remoteVideo: HMSTrack;
-export declare let screenShare: HMSTrack;
-export declare let auxiliaryAudio: HMSTrack;
-export declare let localSpeaker: HMSSpeaker;
-export declare let screenshareAudio: HMSTrack;
-export declare let hostRole: HMSRole;
-export declare let speakerRole: HMSRole;
-export declare let playlist: HMSPlaylist<any>;
-export declare const ROLES: {
-    HOST: string;
-    SPEAKER: string;
-    VIEWER: string;
-    NOSUBSCRIBE: string;
-};
-export declare const makeFakeStore: () => HMSStore;

package/dist/test/fixtures.d.ts

@@ -1,3 +0,0 @@
-import { HMSPeer, HMSTrack, HMSTrackType } from '../core';
-export declare const makeFakeTrack: (type?: HMSTrackType | undefined) => HMSTrack;
-export declare const makeFakePeer: () => HMSPeer;

package/src/common/ui-logger.ts

@@ -1,88 +0,0 @@
-import { HMSLogLevel } from '../core/hmsSDKStore/sdkTypes';
-
-const HMS_STORE_TAG = 'HMS-Store:';
-
-export class HMSLogger {
-  static level: HMSLogLevel = HMSLogLevel.VERBOSE;
-
-  static v(tag: string, ...data: any[]) {
-    this.log(HMSLogLevel.VERBOSE, tag, ...data);
-  }
-
-  static d(...data: any[]) {
-    this.log(HMSLogLevel.DEBUG, ...data);
-  }
-
-  static i(...data: any[]) {
-    this.log(HMSLogLevel.INFO, ...data);
-  }
-
-  static w(...data: any[]) {
-    this.log(HMSLogLevel.WARN, ...data);
-  }
-
-  static e(...data: any[]) {
-    this.log(HMSLogLevel.ERROR, ...data);
-  }
-
-  static time(mark: string) {
-    this.log(HMSLogLevel.TIME, '[HMSPerformanceTiming]', mark);
-  }
-
-  static timeEnd(mark: string) {
-    this.log(HMSLogLevel.TIMEEND, '[HMSPerformanceTiming]', mark, mark);
-  }
-
-  static cleanUp() {
-    performance.clearMarks();
-    performance.clearMeasures();
-  }
-
-  /* eslint-disable */
-  private static log(level: HMSLogLevel, ...data: any[]) {
-    if (this.level.valueOf() > level.valueOf()) {
-      return;
-    }
-
-    switch (level) {
-      case HMSLogLevel.VERBOSE: {
-        console.log(HMS_STORE_TAG, ...data);
-        break;
-      }
-      case HMSLogLevel.DEBUG: {
-        console.debug(HMS_STORE_TAG, ...data);
-        break;
-      }
-      case HMSLogLevel.INFO: {
-        console.info(HMS_STORE_TAG, ...data);
-        break;
-      }
-      case HMSLogLevel.WARN: {
-        console.warn(HMS_STORE_TAG, ...data);
-        break;
-      }
-      case HMSLogLevel.ERROR: {
-        console.error(HMS_STORE_TAG, ...data);
-        break;
-      }
-      case HMSLogLevel.TIME: {
-        performance.mark(data[1]);
-        break;
-      }
-      case HMSLogLevel.TIMEEND: {
-        const tag = data[0];
-        const mark = data[1];
-        try {
-          const entry = performance.measure(mark, mark);
-          //@ts-ignore
-          this.log(HMSLogLevel.DEBUG, tag, mark, entry?.duration);
-          performance.clearMarks(mark);
-          performance.clearMeasures(mark);
-        } catch (error) {
-          this.log(HMSLogLevel.DEBUG, tag, mark, error);
-        }
-        break;
-      }
-    }
-  }
-}

package/src/core/IHMSActions.ts

@@ -1,318 +0,0 @@
-import {
-  HMSConfig,
-  HMSSimulcastLayer,
-  HMSAudioTrackSettings,
-  HMSVideoTrackSettings,
-  HMSLogLevel,
-  HMSVideoPlugin,
-  HMSAudioPlugin,
-} from '@100mslive/hms-video';
-import {
-  HMSMessageID,
-  HMSPeerID,
-  HMSRoleName,
-  HMSTrackID,
-  HMSTrackSource,
-  IHMSPlaylistActions,
-  HMSChangeMultiTrackStateParams,
-} from './schema';
-import { HMSRoleChangeRequest } from './selectors';
-import { RTMPRecordingConfig } from './hmsSDKStore/sdkTypes';
-
-/**
- * The below interface defines our SDK API Surface for taking room related actions.
- * It talks to our 100ms backend and handles error reconnections, state managements
- * and lots of other things so you don't have to. You can use this gateway with any
- * sort of UI to make connecting to our backend easier.
- * In case you use react, we also provide a HMSProvider class with very powerful hooks
- * and out of box components which you can use to setup your website in minutes. Our
- * components have in built integration with this interface and you won't have to worry
- * about passing props if you use them.
- *
- * @remarks
- * There is a one to one mapping between an instance of this class and a 100ms room,
- * in case you're creating multiple rooms please create new instance per room.
- *
- * @category Core
- */
-export interface IHMSActions {
-  preview(config: HMSConfig): Promise<void>;
-  /**
-   * join function can be used to join the room, if the room join is successful,
-   * current details of participants and track details are populated in the store.
-   *
-   * @remarks
-   * If join is called while an earlier join is in progress for the room id, it
-   * is ignored
-   *
-   * @param config join config with room id, required for joining the room
-   */
-  join(config: HMSConfig): void;
-
-  /**
-   * This function can be used to leave the room, if the call is repeated it's ignored.
-   */
-  leave(): Promise<void>;
-
-  /**
-   * If you want to enable screenshare for the local peer this class can be called.
-   * The store will be populated with the incoming track, and the subscriber(or
-   * react component if our hook is used) will be notified/rerendered
-   * @param enabled boolean
-   * @param audioOnly boolean To publish only audio from screenshare
-   */
-  setScreenShareEnabled(enabled: boolean, audioOnly?: boolean): Promise<void>;
-
-  /**
-   * You can use the addTrack method to add an auxiliary track(canvas capture, electron screen-share, etc...)
-   * This method adds the track to the local peer's list of auxiliary tracks and publishes it to make it available to remote peers.
-   * @param track MediaStreamTrack - Track to be added
-   * @param type HMSTrackSource - 'regular' | 'screen' | 'plugin' - Source of track - default: 'regular'
-   */
-  addTrack(track: MediaStreamTrack, type: HMSTrackSource): Promise<void>;
-
-  /**
-   * You can use the removeTrack method to remove an auxiliary track.
-   * This method removes the track from the local peer's list of auxiliary tracks and unpublishes it.
-   * @param trackId string - ID of the track to be removed
-   */
-  removeTrack(trackId: HMSTrackID): Promise<void>;
-
-  /**
-   * @deprecated The method should not be used
-   * @see sendBroadcastMessage
-   * Send a plain text message to all the other participants in the room.
-   * @param message - string message to broadcast
-   */
-  sendMessage(message: string): void;
-
-  /**
-   * Send a plain text message to all the other participants in the room.
-   * @param message - string message to broadcast
-   * @param type - type of message eg: image, video etc. - optional defaults to chat
-   */
-  sendBroadcastMessage(message: string, type?: string): Promise<void>;
-  /**
-   *
-   * @param message - string message to send
-   * @param roles - roles to which to send the message
-   * @param type - type of message eg: image, video etc. - optional defaults to chat
-   */
-  sendGroupMessage(message: string, roles: HMSRoleName[], type?: string): Promise<void>;
-  /**
-   *
-   * @param message
-   * @param peerID - id of the peer to which message has to be sent
-   * @param type - type of message eg: image, video etc. - optional defaults to chat
-   */
-  sendDirectMessage(message: string, peerID: HMSPeerID, type?: string): Promise<void>;
-
-  /**
-   * If just readStatus argument is passed, the function will set read flag of every message
-   * as the readStatus argument passed.
-   * If both readStatus and messageId argument is passed, then just read flag of message
-   * with passed messageId will be set as readStatus argument. if message with passed messageId is not
-   * found in store, no change in store will take place.
-   *
-   * @param readStatus boolean value which you want to set as read flag for message/messages.
-   * @param messageId message id whose read falg you want to set.
-   */
-  setMessageRead(readStatus: boolean, messageId?: HMSMessageID): void;
-
-  /**
-   * This function can be used to enable/disable(unmute/mute) local audio track
-   * @param enabled boolean - true to unmute, false to mute
-   */
-  setLocalAudioEnabled(enabled: boolean): Promise<void>;
-
-  /**
-   * This function can be used to enable/disable(unmute/mute) local video track
-   * @param enabled boolean - true to unmute, false to mute
-   */
-  setLocalVideoEnabled(enabled: boolean): Promise<void>;
-
-  /**
-   * @param trackId string - ID of the track whose mute status needs to be set
-   * @param enabled boolean - true when we want to unmute the track and false when we want to unmute it
-   */
-  setEnabledTrack(trackId: HMSTrackID, enabled: boolean): Promise<void>;
-
-  /**
-   * Change settings of the local peer's audio track
-   * @param settings HMSAudioTrackSettings
-   * ({ volume, codec, maxBitrate, deviceId, advanced })
-   */
-  setAudioSettings(settings: Partial<HMSAudioTrackSettings>): Promise<void>;
-  /**
-   * Change settings of the local peer's video track
-   * @param settings HMSVideoTrackSettings
-   * ({ width, height, codec, maxFramerate, maxBitrate, deviceId, advanced })
-   */
-  setVideoSettings(settings: Partial<HMSVideoTrackSettings>): Promise<void>;
-
-  /**
-   * You can use the attach and detach video function
-   * to add/remove video from an element for a track ID. The benefit of using this
-   * instead of removing the video yourself is that it'll also auto unsubscribe to
-   * the stream coming from server saving significant bandwidth for the user.
-   * @param localTrackID trackID as stored in the store for the peer
-   * @param videoElement HTML native element where the video has to be shown
-   */
-  attachVideo(localTrackID: HMSTrackID, videoElement: HTMLVideoElement): Promise<void>;
-
-  /**
-   * @see attachVideo
-   */
-  detachVideo(localTrackID: HMSTrackID, videoElement: HTMLVideoElement): Promise<void>;
-
-  /**
-   * Set the output volume of audio tracks(overall/particular audio track)
-   * @param value number between 0-100
-   * @param trackId string If undefined sets the overall volume(of every audio track in the room); If valid - set the volume of particular audio track
-   *
-   */
-  setVolume(value: number, trackId?: HMSTrackID): void;
-
-  /**
-   * Set the audio output(speaker) device
-   * @param deviceId string deviceId of the audio output device
-   */
-  setAudioOutputDevice(deviceId: string): void;
-
-  /**
-   * set the quality of the selected videoTrack
-   * @param trackId
-   * @param layer
-   */
-  setPreferredLayer(trackId: HMSTrackID, layer: HMSSimulcastLayer): void;
-
-  /**
-   * Add or remove a video plugin from/to the local peer video track. Eg. Virtual Background, Face Filters etc.
-   * Video plugins can be added/removed at any time after the join is successful.
-   * pluginFrameRate is the rate at which the output plugin will do processing
-   * @param plugin HMSVideoPlugin
-   * @param pluginFrameRate number
-   * @see HMSVideoPlugin
-   */
-  addPluginToVideoTrack(plugin: HMSVideoPlugin, pluginFrameRate?: number): Promise<void>;
-
-  addPluginToAudioTrack(plugin: HMSAudioPlugin): Promise<void>;
-
-  /**
-   * @see addPluginToVideoTrack
-   */
-  removePluginFromVideoTrack(plugin: HMSVideoPlugin): Promise<void>;
-
-  removePluginFromAudioTrack(plugin: HMSAudioPlugin): Promise<void>;
-
-  /**
-   * Request for a role change of a remote peer. Can be forced.
-   * @param forPeerId The remote peer id whose role needs to be changed
-   * @param toRole The name of the new role.
-   * @param [force] this being true would mean that user won't get a request to accept role change
-   */
-  changeRole(forPeerId: HMSPeerID, toRole: HMSRoleName, force?: boolean): Promise<void>;
-
-  /**
-   * Accept the role change request received
-   * @param {HMSRoleChangeRequest} request The original request that was received
-   */
-  acceptChangeRole(request: HMSRoleChangeRequest): Promise<void>;
-
-  /**
-   * Reject pending role change request
-   * @param {HMSRoleChangeRequest} request The original request that was received
-   */
-  rejectChangeRole(request: HMSRoleChangeRequest): void;
-
-  /**
-   * Change track state a remote peer's track
-   * This can be used to mute/unmute a remote peer's track
-   * @param forRemoteTrackID The track ID or array of track IDs for which you want to change the state
-   * @param enabled `true` if you wish to enable(unmute permission is required) the track, `false` if you wish to disable(mute permission is required) the track
-   */
-  setRemoteTrackEnabled(
-    forRemoteTrackID: HMSTrackID | HMSTrackID[],
-    enabled: boolean,
-  ): Promise<void>;
-
-  /**
-   * Use this to mute/unmute multipe tracks by source, role or type
-   * @param {HMSChangeMultiTrackStateParams} params
-   */
-  setRemoteTracksEnabled(params: HMSChangeMultiTrackStateParams): Promise<void>;
-
-  /**
-   * Method to be called with some UI interaction after autoplay error is received
-   * Most browsers have limitations where an audio can not be played if there was no user interaction.
-   * SDK throws an autoplay error in this case, this method can be called after an UI interaction
-   * to resolve the autoplay error
-   */
-  unblockAudio: () => Promise<void>;
-
-  /**
-   * If you have the **endRoom** permission, you can end the room. That means everyone will be kicked out.
-   * If lock is passed as true, the room cannot be used further.
-   */
-  endRoom: (lock: boolean, reason: string) => Promise<void>;
-
-  /**
-   * If you have **removeOthers** permission, you can remove a peer from the room.
-   * @param peerID peerID of the peer to be removed from the room
-   * @param reason a string explaining why the peer is removed from the room.
-   * This string could be used to notify the user before they're removed from the room
-   * using the `REMOVED_FROM_ROOM` type of notification
-   */
-  removePeer(peerID: HMSPeerID, reason: string): Promise<void>;
-
-  /**
-   * If you want to start RTMP streaming or recording.
-   * @param params.meetingURL This is the meeting url which is opened in a headless chrome instance for streaming and recording.
-   * Make sure this url leads the joiner straight to the room without any preview screen or requiring additional clicks.
-   * @param params.RTMPURLs The list of ingest URLs where the call as visible in the meeting url should be streamed.
-   * Optional, when not specified the method is used to just start the recording.
-   * @param params.record If you want to start the recording or not.
-   */
-  startRTMPOrRecording(params: RTMPRecordingConfig): Promise<void>;
-
-  /**
-   * If you want to stop both RTMP streaming and recording.
-   */
-  stopRTMPAndRecording(): Promise<void>;
-
-  /**
-   * If you want to update the name of peer.
-   */
-  changeName(name: string): Promise<void>;
-
-  /**
-   * If you want to update the metadata of peer.
-   */
-  changeMetadata(metadata: string | any): Promise<void>;
-
-  /**
-   * Set the type of logs from the SDK you want to be logged in the browser console.
-   *
-   * Note that HMSLogLevel is decremental meaning,
-   * - HMSLogLevel.VERBOSE(0) - will log every message from SDK.
-   * - HMSLogLevel.DEBUG(1) - will log messages that are helpful in debugging, important info, warnings and errors.
-   * - HMSLogLevel.INFO(2) - will log important info, warnings and errors.
-   * - HMSLogLevel.WARN(3) - will log warnings and errors.
-   * - HMSLogLevel.ERROR(4) - will log only errors.
-   * - HMSLogLevel.NONE(5) - won't log anything.
-   *
-   * Usage: `hmsActions.setLogLevel(4)` or `hmsActions.setLogLevel(HMSlogLevel.ERROR)`.
-   */
-  setLogLevel(level: HMSLogLevel): void;
-
-  /**
-   * audio Playlist contains all actions that can be performed on the audio playlist
-   * This will be available after joining the room
-   */
-  audioPlaylist: IHMSPlaylistActions;
-  /**
-   * video Playlist contains all actions that can be performed on the video playlist
-   * This will be available after joining the room
-   */
-  videoPlaylist: IHMSPlaylistActions;
-}

package/src/core/IHMSNotifications.ts

@@ -1,16 +0,0 @@
-import { HMSNotification } from './schema/notification';
-
-type NotificationCallback = (notification: HMSNotification) => void;
-
-/**
- * @category Core
- */
-export interface IHMSNotifications {
-  /**
-   * you can subscribe to notifications for new message, peer add etc. using this function.
-   * note that this is not meant to maintain any state on your side, as the reactive store already
-   * does that. The intent of this function is mainly to display toast notifications or send analytics.
-   * We'll provide a display message which can be displayed as it is for common cases.
-   */
-  onNotification: (cb: NotificationCallback) => () => void;
-}

package/src/core/IHMSStore.ts

@@ -1,60 +0,0 @@
-import { HMSStore } from './schema';
-import { StateSelector, StoreApi, Subscribe } from 'zustand/vanilla';
-import { NamedSetState } from './hmsSDKStore/internalTypes';
-
-/**
- * HMS Reactive store can be used to subscribe to different parts of the store using selectors
- * and get a callback when the value changes.
- */
-export interface IHMSStore extends StoreApi<HMSStore> {
-  /**
-   * Get a part of store using a selector which is true at the current point of time.
-   *
-   * Usage: `store.getState(selectDominantSpeaker);`
-   */
-  getState: GetState<HMSStore>;
-
-  /**
-   * Subscribe to a part of store using selectors, whenever the subscribed part changes, the callback
-   * is called with both the latest and previous value of the changed part.
-   *
-   * Usage:
-   * ```
-   * const onSpeakerUpdate = (speaker, prevSpeaker) => {
-   *  console.log("speaker changed from - ", prevSpeaker, ", to - ", speaker);
-   * }
-   * store.subscribe(onSpeakerUpdate, selectDominantSpeaker);
-   * ```
-   */
-  subscribe: Subscribe<HMSStore>;
-
-  /**
-   * @private
-   * @internal
-   * @privateRemarks
-   * wraps setState to take an additional action name parameter which can show up in redux devtools.
-   */
-  namedSetState: NamedSetState<HMSStore>;
-}
-
-interface GetState<T> {
-  (): T;
-  <StateSlice>(selector?: StateSelector<HMSStore, StateSlice>): StateSlice;
-}
-
-/**
- * HMS store can be used to:
- * - Get a part of the current store or state(getState)
- * - Subscribe to different parts of the store using selectors and execute a callback when the value changes.
- *
- * Both getState and subscribe use selectors to query a part the store.
- *
- *
- * Selectors are functions with HMSStore as an argument and returns a part of the store.
- *
- * **StoreSelector** is a type alias for this type of function.
- *
- * @category Core
- */
-export interface IHMSStoreReadOnly
-  extends Omit<IHMSStore, 'setState' | 'namedSetState' | 'destroy'> {}