@100mslive/hms-video-store 0.10.0 → 0.10.1-alpha.1

package/dist/controller/beam/BeamController.d.ts

@@ -1,14 +1,16 @@
-import { HMSNotifications, IHMSNotifications, IHMSStore } from '../../core';
+import { HMSGenericTypes, HMSNotifications, IHMSNotifications, IHMSStore } from '../../core';
 import { IHMSActions } from '../../core/IHMSActions';
 import { IHMSStoreReadOnly } from '../../core/IHMSStore';
 /**
  * @internal
  */
-export declare class BeamControllerStore {
+export declare class BeamControllerStore<T extends HMSGenericTypes = {
+    sessionStore: Record<string, any>;
+}> {
     private readonly actions;
     private readonly store;
     private readonly notifications;
-    constructor(hmsStore: IHMSStore, hmsActions: IHMSActions, hmsNotifications: HMSNotifications);
+    constructor(hmsStore: IHMSStore<T>, hmsActions: IHMSActions<T>, hmsNotifications: HMSNotifications);
     /**
      * 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

package/dist/controller/beam/BeamSpeakerLabelsLogger.d.ts

@@ -1,10 +1,10 @@
-import { HMSPeer, IHMSStore } from '../../core';
+import { HMSGenericTypes, HMSPeer, IHMSStore } from '../../core';
 import { IHMSActions } from '../../core/IHMSActions';
 /**
  * Log data of audio level and speaker speaking periodically to beam for transcript
  * diarization.
  */
-export declare class BeamSpeakerLabelsLogger {
+export declare class BeamSpeakerLabelsLogger<T extends HMSGenericTypes> {
     private audioContext?;
     private readonly intervalMs;
     private shouldMonitor;
@@ -13,7 +13,7 @@ export declare class BeamSpeakerLabelsLogger {
     private readonly analysers;
     private readonly store;
     private actions;
-    constructor(store: IHMSStore, actions: IHMSActions);
+    constructor(store: IHMSStore<T>, actions: IHMSActions<T>);
     start(): Promise<void>;
     stop(): Promise<void>;
     monitorAudioLevels(): Promise<void>;

package/dist/core/IHMSActions.d.ts

@@ -1,6 +1,6 @@
 import { HLSTimedMetadata, HMSAudioPlugin, HMSAudioTrackSettings, HMSConfig, HMSLogLevel, HMSPluginSupportResult, HMSPreferredSimulcastLayer, HMSPreviewConfig, HMSScreenShareConfig, HMSVideoPlugin, HMSVideoTrackSettings, TokenRequest, TokenRequestOptions } from '@100mslive/hms-video';
 import { HLSConfig, RTMPRecordingConfig } from './hmsSDKStore/sdkTypes';
-import { HMSChangeMultiTrackStateParams, HMSMessageID, HMSPeerID, HMSRoleName, HMSTrackID, HMSTrackSource, IHMSPlaylistActions } from './schema';
+import { HMSChangeMultiTrackStateParams, HMSGenericTypes, HMSMessageID, HMSPeerID, HMSRoleName, HMSTrackID, HMSTrackSource, IHMSPlaylistActions, IHMSSessionStoreActions } from './schema';
 import { HMSRoleChangeRequest } from './selectors';
 /**
  * The below interface defines our SDK API Surface for taking room related actions.
@@ -18,7 +18,9 @@ import { HMSRoleChangeRequest } from './selectors';
  *
  * @category Core
  */
-export interface IHMSActions {
+export interface IHMSActions<T extends HMSGenericTypes = {
+    sessionStore: Record<string, any>;
+}> {
     preview(config: HMSPreviewConfig): Promise<void>;
     /**
      * join function can be used to join the room, if the room join is successful,
@@ -118,9 +120,13 @@ export interface IHMSActions {
     /**
      * Change settings of the local peer's video track
      * @param settings HMSVideoTrackSettings
-     * `({ width, height, codec, maxFramerate, maxBitrate, deviceId, advanced })`
+     * `({ width, height, codec, maxFramerate, maxBitrate, deviceId, advanced, facingMode })`
      */
     setVideoSettings(settings: Partial<HMSVideoTrackSettings>): Promise<void>;
+    /**
+     * Toggle the camera between front and back if the both the camera's exist
+     */
+    switchCamera(): 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
@@ -309,13 +315,13 @@ export interface IHMSActions {
      * Session metadata is available to every peer in the room and is persisted throughout a session
      * till the last peer leaves a room
      *
-     * @alpha - the API is not stable and might have breaking changes later
+     * @deprecated use `actions.sessionStore.set` instead
      */
     setSessionMetadata(metadata: any): Promise<void>;
     /**
      * Fetch the current room metadata from the server and populate it in store
      *
-     * @alpha - the API is not stable and might have breaking changes later
+     * @deprecated use `actions.sessionStore.observe` instead
      */
     populateSessionMetadata(): Promise<void>;
     /**
@@ -412,4 +418,11 @@ export interface IHMSActions {
      * @alpha
      */
     enableBeamSpeakerLabelsLogging(): Promise<void>;
+    /**
+     * actions that can be performed on the real-time key-value store
+     *
+     * Values in the session store are available to every peer in the room(who have observed the relevant keys) and
+     * is persisted throughout a session till the last peer leaves a room(cleared after the last peer leaves the room)
+     */
+    sessionStore: IHMSSessionStoreActions<T['sessionStore']>;
 }

package/dist/core/IHMSStore.d.ts

@@ -5,7 +5,7 @@
  */
 import { State, StateSelector, StoreApi, Subscribe } from 'zustand/vanilla';
 import { NamedSetState } from './hmsSDKStore/internalTypes';
-import { HMSStatsStore, HMSStore } from './schema';
+import { HMSGenericTypes, HMSStatsStore, HMSStore } from './schema';
 /**
  * HMS Reactive store can be used to subscribe to different parts of the store using selectors
  * and get a callback when the value changes.
@@ -50,7 +50,9 @@ export declare type IStoreReadOnly<T extends State> = Omit<IStore<T>, 'setState'
  * 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 IStore<HMSStore> {
+export interface IHMSStore<T extends HMSGenericTypes = {
+    sessionStore: Record<string, any>;
+}> extends IStore<HMSStore<T>> {
 }
 /**
  * HMS store can be used to:
@@ -66,7 +68,9 @@ export interface IHMSStore extends IStore<HMSStore> {
  *
  * @category Core
  */
-export interface IHMSStoreReadOnly extends IStoreReadOnly<HMSStore> {
+export interface IHMSStoreReadOnly<T extends HMSGenericTypes = {
+    sessionStore: Record<string, any>;
+}> extends IStoreReadOnly<HMSStore<T>> {
 }
 export interface IHMSStatsStore extends IStore<HMSStatsStore> {
 }

package/dist/core/hmsSDKStore/HMSNotifications.d.ts

@@ -1,13 +1,15 @@
 import * as sdkTypes from './sdkTypes';
 import { IHMSStore } from '../IHMSStore';
-import { HMSChangeMultiTrackStateRequest, HMSChangeTrackStateRequest, HMSDeviceChangeEvent, HMSException, HMSLeaveRoomRequest, HMSMessage, HMSPeer, HMSPlaylistItem, HMSTrackID } from '../schema';
+import { HMSChangeMultiTrackStateRequest, HMSChangeTrackStateRequest, HMSDeviceChangeEvent, HMSException, HMSGenericTypes, HMSLeaveRoomRequest, HMSMessage, HMSPeer, HMSPlaylistItem, HMSTrackID } from '../schema';
 import { HMSNotificationCallback, HMSNotificationTypeParam, IHMSNotifications } from '../schema/notification';
-export declare class HMSNotifications implements IHMSNotifications {
+export declare class HMSNotifications<T extends HMSGenericTypes = {
+    sessionStore: Record<string, any>;
+}> implements IHMSNotifications {
     private id;
     private eventEmitter;
     private store;
-    constructor(store: IHMSStore);
-    onNotification: <T extends HMSNotificationTypeParam>(cb: HMSNotificationCallback<T>, type?: T | undefined) => () => void;
+    constructor(store: IHMSStore<T>);
+    onNotification: <T_1 extends HMSNotificationTypeParam>(cb: HMSNotificationCallback<T_1>, type?: T_1 | undefined) => () => void;
     sendPlaylistTrackEnded<T>(item: HMSPlaylistItem<T>): void;
     sendDeviceChange(request: HMSDeviceChangeEvent): void;
     sendLeaveRoom(request: HMSLeaveRoomRequest): void;

package/dist/core/hmsSDKStore/HMSPlaylist.d.ts

@@ -1,12 +1,12 @@
 import { HMSPlaylistManager } from './sdkTypes';
 import { IHMSStore } from '../IHMSStore';
-import { HMSPlaylistItem, HMSPlaylistType, IHMSPlaylistActions } from '../schema';
-export declare class HMSPlaylist implements IHMSPlaylistActions {
+import { HMSGenericTypes, HMSPlaylistItem, HMSPlaylistType, IHMSPlaylistActions } from '../schema';
+export declare class HMSPlaylist<T extends HMSGenericTypes> implements IHMSPlaylistActions {
     private playlistManager;
     private syncPlaylistState;
     private store;
     private type;
-    constructor(playlistManager: HMSPlaylistManager, type: HMSPlaylistType, syncPlaylistState: (action: string) => void, store: IHMSStore);
+    constructor(playlistManager: HMSPlaylistManager, type: HMSPlaylistType, syncPlaylistState: (action: string) => void, store: IHMSStore<T>);
     play(id: string): Promise<void>;
     pause(): Promise<void>;
     playNext(): Promise<void>;

package/dist/core/hmsSDKStore/HMSReactiveStore.d.ts

@@ -3,6 +3,7 @@ import { HMSNotifications } from './HMSNotifications';
 import { BeamControllerStore } from '../../controller/beam/BeamController';
 import { IHMSActions } from '../IHMSActions';
 import { IHMSStatsStoreReadOnly, IHMSStore, IHMSStoreReadOnly, IStore } from '../IHMSStore';
+import { HMSGenericTypes } from '../schema';
 import { IHMSNotifications } from '../schema/notification';
 declare global {
     interface Window {
@@ -11,7 +12,9 @@ declare global {
         __triggerBeamEvent__: (args: any) => void;
     }
 }
-export declare class HMSReactiveStore {
+export declare class HMSReactiveStore<T extends HMSGenericTypes = {
+    sessionStore: Record<string, any>;
+}> {
     private readonly sdk?;
     private readonly actions;
     private readonly store;
@@ -19,7 +22,7 @@ export declare class HMSReactiveStore {
     private stats?;
     /** @TODO store flag for both HMSStore and HMSInternalsStore */
     private initialTriggerOnSubscribe;
-    constructor(hmsStore?: IHMSStore, hmsActions?: IHMSActions, hmsNotifications?: HMSNotifications);
+    constructor(hmsStore?: IHMSStore<T>, hmsActions?: IHMSActions<T>, hmsNotifications?: HMSNotifications<T>);
     /**
      * 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
@@ -42,12 +45,12 @@ export declare class HMSReactiveStore {
      *
      * @deprecated use getActions
      */
-    getHMSActions(): IHMSActions;
+    getHMSActions(): IHMSActions<T>;
     /**
      * Any action which may modify the store or may need to talk to the SDK will happen
      * through the IHMSActions instance returned by this
      */
-    getActions(): IHMSActions;
+    getActions(): IHMSActions<T>;
     /**
      * 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

package/dist/core/hmsSDKStore/HMSSDKActions.d.ts

@@ -3,7 +3,7 @@ import { HMSNotifications } from './HMSNotifications';
 import * as sdkTypes from './sdkTypes';
 import { IHMSActions } from '../IHMSActions';
 import { IHMSStore } from '../IHMSStore';
-import { HMSChangeMultiTrackStateParams, HMSMessage, HMSRoleName, HMSTrackID, HMSTrackSource, IHMSPlaylistActions } from '../schema';
+import { HMSChangeMultiTrackStateParams, HMSGenericTypes, HMSMessage, HMSRoleName, HMSTrackID, HMSTrackSource, IHMSPlaylistActions, IHMSSessionStoreActions } from '../schema';
 import { HMSRoleChangeRequest } from '../selectors';
 /**
  * This class implements the IHMSActions interface for 100ms SDK. It connects with SDK
@@ -25,7 +25,9 @@ import { HMSRoleChangeRequest } from '../selectors';
  * 5. State is immutable, a new copy with new references is created when there is a change,
  *    if you try to modify state outside of setState, there'll be an error.
  */
-export declare class HMSSDKActions implements IHMSActions {
+export declare class HMSSDKActions<T extends HMSGenericTypes = {
+    sessionStore: Record<string, any>;
+}> implements IHMSActions<T> {
     private hmsSDKTracks;
     private hmsSDKPeers;
     private readonly sdk;
@@ -35,8 +37,9 @@ export declare class HMSSDKActions implements IHMSActions {
     private ignoredMessageTypes;
     audioPlaylist: IHMSPlaylistActions;
     videoPlaylist: IHMSPlaylistActions;
+    sessionStore: IHMSSessionStoreActions<T['sessionStore']>;
     private beamSpeakerLabelsLogger?;
-    constructor(store: IHMSStore, sdk: HMSSdk, notificationManager: HMSNotifications);
+    constructor(store: IHMSStore<T>, sdk: HMSSdk, notificationManager: HMSNotifications<T>);
     refreshDevices(): Promise<void>;
     unblockAudio(): Promise<void>;
     setVolume(value: number, trackId?: HMSTrackID): Promise<void>;
@@ -54,6 +57,7 @@ export declare class HMSSDKActions implements IHMSActions {
     setEnabledTrack(trackID: string, enabled: boolean): Promise<void>;
     setAudioSettings(settings: Partial<sdkTypes.HMSAudioTrackSettings>): Promise<void>;
     setVideoSettings(settings: Partial<sdkTypes.HMSVideoTrackSettings>): Promise<void>;
+    switchCamera(): Promise<void>;
     sendMessage(message: string): void;
     sendBroadcastMessage(message: string, type?: string): Promise<void>;
     sendGroupMessage(message: string, roles: string[], type?: string): Promise<void>;
@@ -103,6 +107,7 @@ export declare class HMSSDKActions implements IHMSActions {
     private onDeviceChange;
     private sdkPreviewWithListeners;
     private onNetworkQuality;
+    private onSessionStoreUpdate;
     private startScreenShare;
     private stopScreenShare;
     private attachVideoInternal;
@@ -167,6 +172,7 @@ export declare class HMSSDKActions implements IHMSActions {
     private setProgress;
     private syncPlaylistState;
     private sendPeerUpdateNotification;
+    private setSessionStoreValueLocally;
     /**
      * setState is separate so any future changes to how state change can be done from one place.
      * @param fn

package/dist/core/hmsSDKStore/HMSSessionStore.d.ts

@@ -0,0 +1,11 @@
+import { HMSSdk, SessionStoreUpdate } from '@100mslive/hms-video';
+import { IHMSSessionStoreActions } from '../schema';
+export declare class HMSSessionStore<T extends Record<string, any>> implements IHMSSessionStoreActions<T> {
+    private sdk;
+    private setLocally;
+    constructor(sdk: HMSSdk, setLocally: (updates: SessionStoreUpdate | SessionStoreUpdate[], actionName?: string) => void);
+    private get sdkSessionStore();
+    set<K extends keyof T>(key: K, value?: T[K]): Promise<void>;
+    observe(keys: keyof T | Array<keyof T>): Promise<void>;
+    unobserve(keys: keyof T | Array<keyof T>): Promise<void>;
+}

package/dist/core/hmsSDKStore/internalTypes.d.ts

@@ -1,4 +1,4 @@
 import { PartialState, State } from 'zustand/vanilla';
 export declare type NamedSetState<T extends State> = {
-    <K1 extends keyof T, K2 extends keyof T = K1, K3 extends keyof T = K2, K4 extends keyof T = K3>(partial: PartialState<T, K1, K2, K3, K4>, name?: string): void;
+    <K1 extends keyof T, K2 extends keyof T = K1, K3 extends keyof T = K2, K4 extends keyof T = K3>(partial: PartialState<T, K1, K2, K3, K4>, name: string): void;
 };

package/dist/core/schema/index.d.ts

@@ -9,3 +9,4 @@ export * from './error';
 export * from './requests';
 export * from './device-change';
 export * from './playlist';
+export * from './session-store';

package/dist/core/schema/schema.d.ts

@@ -7,7 +7,12 @@ import { HMSRole } from './role';
 import { HMSRoom } from './room';
 import { HMSMediaSettings } from './settings';
 import { DeviceMap, HMSConnectionQuality, HMSPeerStats, HMSTrackStats } from '../hmsSDKStore/sdkTypes';
-export interface HMSStore {
+export interface HMSGenericTypes {
+    sessionStore: Record<string, any>;
+}
+export interface HMSStore<T extends HMSGenericTypes = {
+    sessionStore: Record<string, any>;
+}> {
     room: HMSRoom;
     peers: Record<HMSPeerID, HMSPeer>;
     speakers: Record<HMSTrackID, HMSSpeaker>;
@@ -23,6 +28,7 @@ export interface HMSStore {
     roles: Record<string, HMSRole>;
     appData?: Record<string, any>;
     roleChangeRequests: HMSRoleChangeStoreRequest[];
+    /** @deprecated use `sessionStore` instead */
     sessionMetadata?: any;
     preview?: {
         localPeer?: HMSPeerID;
@@ -31,6 +37,7 @@ export interface HMSStore {
         audioTrack?: HMSTrackID;
     };
     errors: HMSException[];
+    sessionStore: T['sessionStore'];
 }
 export interface HMSStatsStore {
     remoteTrackStats: Record<HMSTrackID, HMSTrackStats | undefined>;
@@ -45,5 +52,5 @@ export interface HMSStatsStore {
 /**
  * @internal
  */
-export declare const createDefaultStoreState: () => HMSStore;
+export declare const createDefaultStoreState: <T extends HMSGenericTypes>() => HMSStore<T>;
 export declare const createDefaultStatsStore: () => HMSStatsStore;

package/dist/core/schema/session-store.d.ts

@@ -0,0 +1,11 @@
+export interface IHMSSessionStoreActions<T> {
+    set<K extends keyof T>(key: K, value?: T[K]): Promise<void>;
+    /**
+     * observe a particular key or set of keys to receive updates of its latest value when its changed
+     */
+    observe(keys: keyof T | Array<keyof T>): Promise<void>;
+    /**
+     * unobserve a particular key or set of keys to stop receiving updates of its latest value
+     */
+    unobserve(keys: keyof T | Array<keyof T>): Promise<void>;
+}

package/dist/core/selectors/derivedSelectors.d.ts

@@ -13,16 +13,24 @@ export interface HMSRoleChangeRequest {
     role: HMSRole;
     token: string;
 }
-export declare const selectPeersWithAudioStatus: import("reselect").OutputSelector<HMSStore, HMSPeerWithMuteStatus[], (res1: Record<string, HMSPeer>, res2: Record<string, import("../schema").HMSTrack>) => HMSPeerWithMuteStatus[]>;
+export declare const selectPeersWithAudioStatus: import("reselect").OutputSelector<HMSStore<{
+    sessionStore: Record<string, any>;
+}>, HMSPeerWithMuteStatus[], (res1: Record<string, HMSPeer>, res2: Record<string, import("../schema").HMSTrack>) => HMSPeerWithMuteStatus[]>;
 /**
  * Select the role change request received for your local peer.
  */
-export declare const selectRoleChangeRequest: import("reselect").OutputSelector<HMSStore, HMSRoleChangeRequest | null, (res1: import("../schema").HMSRoleChangeStoreRequest, res2: Record<string, HMSPeer>, res3: Record<string, HMSRole>) => HMSRoleChangeRequest | null>;
+export declare const selectRoleChangeRequest: import("reselect").OutputSelector<HMSStore<{
+    sessionStore: Record<string, any>;
+}>, HMSRoleChangeRequest | null, (res1: import("../schema").HMSRoleChangeStoreRequest, res2: Record<string, HMSPeer>, res3: Record<string, HMSRole>) => HMSRoleChangeRequest | null>;
 /**
  * Select what streams is the local peer allowed to publish from video, audio and screenshare.
  */
-export declare const selectIsAllowedToPublish: import("reselect").OutputSelector<HMSStore, import("../schema").HMSPublishAllowed, (res: HMSRole | null) => import("../schema").HMSPublishAllowed>;
+export declare const selectIsAllowedToPublish: import("reselect").OutputSelector<HMSStore<{
+    sessionStore: Record<string, any>;
+}>, import("../schema").HMSPublishAllowed, (res: HMSRole | null) => import("../schema").HMSPublishAllowed>;
 /**
  * Select what streams is the local peer allowed to preview from video, audio
  */
-export declare const selectIsAllowedToPreviewMedia: import("reselect").OutputSelector<HMSStore, import("../schema").HMSPublishAllowed, (res: HMSRole | null) => import("../schema").HMSPublishAllowed>;
+export declare const selectIsAllowedToPreviewMedia: import("reselect").OutputSelector<HMSStore<{
+    sessionStore: Record<string, any>;
+}>, import("../schema").HMSPublishAllowed, (res: HMSRole | null) => import("../schema").HMSPublishAllowed>;