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

package/dist/core/IHMSStore.d.ts

@@ -1,56 +1,54 @@
-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'> {
-}
-export {};
+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>;
+}
+export 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 declare type IHMSStoreReadOnly = Omit<IHMSStore, 'setState' | 'namedSetState' | 'destroy'>;

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

@@ -1,25 +1,25 @@
-import { IHMSNotifications } from '../IHMSNotifications';
-import { IHMSStore } from '../IHMSStore';
-import * as sdkTypes from './sdkTypes';
-import { HMSNotification, HMSPeer, HMSException, HMSMessage, HMSTrackID, HMSChangeTrackStateRequest, HMSChangeMultiTrackStateRequest, HMSLeaveRoomRequest, HMSDeviceChangeEvent, HMSPlaylistItem } from '../schema';
-export declare class HMSNotifications implements IHMSNotifications {
-    private id;
-    private eventEmitter;
-    private store;
-    constructor(store: IHMSStore);
-    onNotification: (cb: (notification: HMSNotification) => void) => (() => void);
-    sendPlaylistTrackEnded<T>(item: HMSPlaylistItem<T>): void;
-    sendDeviceChange(request: HMSDeviceChangeEvent): void;
-    sendLeaveRoom(request: HMSLeaveRoomRequest): void;
-    sendPeerList(peers: HMSPeer[]): void;
-    sendPeerUpdate(type: sdkTypes.HMSPeerUpdate, peer: HMSPeer | null): void;
-    sendTrackUpdate(type: sdkTypes.HMSTrackUpdate, trackID: HMSTrackID): void;
-    sendMessageReceived(message: HMSMessage): void;
-    sendError(error: HMSException): void;
-    sendReconnecting(error: HMSException): void;
-    sendReconnected(): void;
-    sendChangeTrackStateRequest(request: HMSChangeTrackStateRequest): void;
-    sendChangeMultiTrackStateRequest(request: HMSChangeMultiTrackStateRequest): void;
-    private emitEvent;
-    private createNotification;
-}
+import { IHMSNotifications } from '../IHMSNotifications';
+import { IHMSStore } from '../IHMSStore';
+import * as sdkTypes from './sdkTypes';
+import { HMSNotification, HMSPeer, HMSException, HMSMessage, HMSTrackID, HMSChangeTrackStateRequest, HMSChangeMultiTrackStateRequest, HMSLeaveRoomRequest, HMSDeviceChangeEvent, HMSPlaylistItem } from '../schema';
+export declare class HMSNotifications implements IHMSNotifications {
+    private id;
+    private eventEmitter;
+    private store;
+    constructor(store: IHMSStore);
+    onNotification: (cb: (notification: HMSNotification) => void) => (() => void);
+    sendPlaylistTrackEnded<T>(item: HMSPlaylistItem<T>): void;
+    sendDeviceChange(request: HMSDeviceChangeEvent): void;
+    sendLeaveRoom(request: HMSLeaveRoomRequest): void;
+    sendPeerList(peers: HMSPeer[]): void;
+    sendPeerUpdate(type: sdkTypes.HMSPeerUpdate, peer: HMSPeer | null): void;
+    sendTrackUpdate(type: sdkTypes.HMSTrackUpdate, trackID: HMSTrackID): void;
+    sendMessageReceived(message: HMSMessage): void;
+    sendError(error: HMSException): void;
+    sendReconnecting(error: HMSException): void;
+    sendReconnected(): void;
+    sendChangeTrackStateRequest(request: HMSChangeTrackStateRequest): void;
+    sendChangeMultiTrackStateRequest(request: HMSChangeMultiTrackStateRequest): void;
+    private emitEvent;
+    private createNotification;
+}

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

@@ -1,21 +1,21 @@
-import { HMSPlaylistItem, HMSPlaylistType, IHMSPlaylistActions } from '../schema';
-import { HMSPlaylistManager } from './sdkTypes';
-import { IHMSStore } from '../IHMSStore';
-export declare class HMSPlaylist implements IHMSPlaylistActions {
-    private playlistManager;
-    private syncPlaylistState;
-    private store;
-    private type;
-    constructor(playlistManager: HMSPlaylistManager, type: HMSPlaylistType, syncPlaylistState: (action: string) => void, store: IHMSStore);
-    play(id: string): Promise<void>;
-    pause(): Promise<void>;
-    playNext(): Promise<void>;
-    playPrevious(): Promise<void>;
-    seek(seekValue: number): void;
-    seekTo(seekValue: number): void;
-    setVolume(volume: number): void;
-    setList<T>(list: HMSPlaylistItem<T>[]): void;
-    stop(): Promise<void>;
-    setIsAutoplayOn(autoplay: boolean): void;
-    setPlaybackRate(playbackRate: number): void;
-}
+import { HMSPlaylistItem, HMSPlaylistType, IHMSPlaylistActions } from '../schema';
+import { HMSPlaylistManager } from './sdkTypes';
+import { IHMSStore } from '../IHMSStore';
+export declare class HMSPlaylist implements IHMSPlaylistActions {
+    private playlistManager;
+    private syncPlaylistState;
+    private store;
+    private type;
+    constructor(playlistManager: HMSPlaylistManager, type: HMSPlaylistType, syncPlaylistState: (action: string) => void, store: IHMSStore);
+    play(id: string): Promise<void>;
+    pause(): Promise<void>;
+    playNext(): Promise<void>;
+    playPrevious(): Promise<void>;
+    seek(seekValue: number): void;
+    seekTo(seekValue: number): void;
+    setVolume(volume: number): void;
+    setList<T>(list: HMSPlaylistItem<T>[]): void;
+    stop(): Promise<void>;
+    setIsAutoplayOn(autoplay: boolean): void;
+    setPlaybackRate(playbackRate: number): void;
+}

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

@@ -1,79 +1,79 @@
-import { IHMSActions } from '../IHMSActions';
-import { IHMSStore, IHMSStoreReadOnly } from '../IHMSStore';
-import { HMSNotifications } from './HMSNotifications';
-import { IHMSNotifications } from '../IHMSNotifications';
-export declare class HMSReactiveStore {
-    private readonly actions;
-    private readonly store;
-    private readonly notifications;
-    private initialTriggerOnSubscribe;
-    constructor(hmsStore?: IHMSStore, hmsActions?: IHMSActions, hmsNotifications?: HMSNotifications);
-    /**
-     * 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;
-    /**
-     * 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;
-    /**
-     * 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;
-    /**
-     * 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;
-    /**
-     * @internal
-     */
-    static createNewHMSStore(): IHMSStore;
-    /**
-     * @internal
-     */
-    static makeStoreTriggerOnSubscribe(store: IHMSStore): void;
-    /**
-     * 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;
-    /**
-     * @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;
-    /**
-     * https://github.com/zalmoxisus/redux-devtools-extension/blob/master/docs/API/Arguments.md
-     */
-    private static devtoolsOptions;
-    /**
-     * 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;
-}
+import { IHMSActions } from '../IHMSActions';
+import { IHMSStore, IHMSStoreReadOnly } from '../IHMSStore';
+import { HMSNotifications } from './HMSNotifications';
+import { IHMSNotifications } from '../IHMSNotifications';
+export declare class HMSReactiveStore {
+    private readonly actions;
+    private readonly store;
+    private readonly notifications;
+    private initialTriggerOnSubscribe;
+    constructor(hmsStore?: IHMSStore, hmsActions?: IHMSActions, hmsNotifications?: HMSNotifications);
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * @internal
+     */
+    static createNewHMSStore(): IHMSStore;
+    /**
+     * @internal
+     */
+    static makeStoreTriggerOnSubscribe(store: IHMSStore): void;
+    /**
+     * 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;
+    /**
+     * @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;
+    /**
+     * https://github.com/zalmoxisus/redux-devtools-extension/blob/master/docs/API/Arguments.md
+     */
+    private static devtoolsOptions;
+    /**
+     * 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;
+}