@stream-io/video-client 1.61.0 → 2.0.0-beta.1

package/dist/src/Call.d.ts

@@ -109,7 +109,7 @@ export declare class Call {
     private lastStatsOptions?;
     private ringTimeout;
     private ringStatePoller;
-    private readonly clientStore;
+    private readonly clientState;
     readonly streamClient: StreamClient;
     readonly clientEventReporter: ClientEventReporter;
     private sfuClient?;
@@ -167,7 +167,7 @@ export declare class Call {
      * Use the [`StreamVideoClient.call`](./StreamVideoClient.md/#call)
      * method to construct a `Call` instance.
      */
-    constructor({ type, id, streamClient, clientEventReporter, members, ownCapabilities, sortParticipantsBy, clientStore, ringing, watching, }: CallConstructor);
+    constructor({ type, id, streamClient, clientEventReporter, members, ownCapabilities, sortParticipantsBy, clientState, ringing, watching, }: CallConstructor);
     /**
      * Sets up the call instance.
      *
@@ -521,7 +521,7 @@ export declare class Call {
      */
     notifyTrackMuteState: (muted: boolean, ...trackTypes: TrackType[]) => Promise<void>;
     /**
-     * Will enhance the reported stats with additional participant-specific information (`callStatsReport$` state [store variable](./StreamVideoClient.md/#readonlystatestore)).
+     * Will enhance the reported stats with additional participant-specific information (the `callStatsReport$` state variable).
      * This is usually helpful when detailed stats for a specific participant are needed.
      *
      * @param sessionId the sessionId to start reporting for.

package/dist/src/StreamVideoClient.d.ts

@@ -1,28 +1,22 @@
 import { Call } from './Call';
 import { StreamClient } from './coordinator/connection/client';
-import { StreamVideoReadOnlyStateStore, StreamVideoWriteableStateStore } from './store';
+import { ClientState } from './store';
 import type { ConnectedEvent, CreateDeviceRequest, CreateGuestRequest, CreateGuestResponse, GetEdgesResponse, ListDevicesResponse, QueryAggregateCallStatsRequest, QueryAggregateCallStatsResponse, QueryCallsRequest, QueryCallStatsRequest, QueryCallStatsResponse } from './gen/coordinator';
 import { AllClientEvents, ClientEventListener, StreamClientOptions, TokenOrProvider, User } from './coordinator/connection/types';
 import type { StreamVideoClientOptions } from './types';
 import { ScopedLogger } from './logger';
-import { ClientEventReporter } from './reporting';
 /**
  * A `StreamVideoClient` instance lets you communicate with our API, and authenticate users.
  */
 export declare class StreamVideoClient {
     /**
-     * A reactive store that exposes all the state variables reactively.
+     * The reactive state of this client.
      * You can subscribe to changes of the different state variables.
-     * Our library is built in a way that all state changes are exposed in this store,
-     * o all UI changes in your application should be handled by subscribing to these variables.
-     *
-     * @deprecated use the `client.state` getter.
      */
-    readonly readOnlyStateStore: StreamVideoReadOnlyStateStore;
+    readonly state: ClientState;
     readonly logger: ScopedLogger;
-    protected readonly writeableStateStore: StreamVideoWriteableStateStore;
-    streamClient: StreamClient;
-    readonly clientEventReporter: ClientEventReporter;
+    readonly streamClient: StreamClient;
+    private readonly clientEventReporter;
     private effectsRegistered;
     private eventHandlersToUnregister;
     private readonly connectionConcurrencyTag;
@@ -40,10 +34,6 @@ export declare class StreamVideoClient {
         user: User;
     }): StreamVideoClient;
     private registerClientInstance;
-    /**
-     * Return the reactive state store, use this if you want to be notified about changes to the client state
-     */
-    get state(): StreamVideoReadOnlyStateStore;
     private registerEffects;
     /**
      * Initializes a call from a call created or ringing event.
@@ -62,26 +52,30 @@ export declare class StreamVideoClient {
     private rewatchCalls;
     /**
      * Connects the given user to the client.
-     * Only one user can connect at a time, if you want to change users, call `disconnectUser` before connecting a new user.
-     * If the connection is successful, the connected user [state variable](#readonlystatestore) will be updated accordingly.
      *
      * @param user the user to connect.
      * @param tokenOrProvider a token or a function that returns a token.
      */
     connectUser: (user: User, tokenOrProvider?: TokenOrProvider) => Promise<void | ConnectedEvent>;
+    /**
+     * Leaves every call this client still tracks. Runs while the coordinator
+     * connection is alive, so that the leave requests each call sends reach the
+     * backend.
+     */
+    private leaveAllCalls;
     /**
      * Disconnects the currently connected user from the client.
-     *
-     * If the connection is successfully disconnected, the connected user [state variable](#readonlystatestore) will be updated accordingly
+     * Leaves every call the user is still in, and updates `client.state`accordingly.
      *
      * @param timeout Max number of ms, to wait for close event of websocket, before forcefully assuming successful disconnection.
-     *                https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent
      */
     disconnectUser: (timeout?: number) => Promise<void>;
     /**
      * You can subscribe to WebSocket events provided by the API.
      * To remove a subscription, call the `off` method or, execute the returned unsubscribe function.
-     * Please note that subscribing to WebSocket events is an advanced use-case, for most use-cases it should be enough to watch for changes in the reactive [state store](#readonlystatestore).
+     * Please note that subscribing to WebSocket events is an advanced use-case,
+     * for most use-cases it should be enough to watch for changes in the reactive
+     * `client.state`.
      *
      * @param eventName the event name or 'all'.
      * @param callback the callback which will be called when the event is emitted.

package/dist/src/store/CallState.d.ts

@@ -1,5 +1,4 @@
-import { Observable } from 'rxjs';
-import type { Patch } from './rxUtils';
+import { type Patch } from './rxUtils';
 import { CallingState } from './CallingState';
 import { type ClosedCaptionsSettings, type StreamVideoParticipant, type StreamVideoParticipantPatch, type StreamVideoParticipantPatches, type SubscriptionChanges, VideoTrackType } from '../types';
 import { CallStatsReport } from '../stats';
@@ -19,6 +18,9 @@ type OrphanedTrack = {
  * @react You don't have to use this class directly, as we are exposing the state through Hooks.
  */
 export declare class CallState {
+    readonly logger: import("@stream-io/logger").Logger<string & {}>;
+    /** A list of comparators that are used to sort the participants. */
+    private sortParticipantsBy;
     private backstageSubject;
     private blockedUserIdsSubject;
     private createdAtSubject;
@@ -48,59 +50,86 @@ export declare class CallState {
     private participantsSubject;
     private callStatsReportSubject;
     private closedCaptionsSubject;
-    private orphanedTracks;
     private callGrantsSubject;
+    /** The backstage state. */
+    backstage$: import("rxjs").Observable<boolean>;
+    /** Will provide the list of blocked user IDs. */
+    blockedUserIds$: import("rxjs").Observable<string[]>;
+    /** Will provide the time when this call has been created. */
+    createdAt$: import("rxjs").Observable<Date>;
+    /** Will provide the time when this call has been ended. */
+    endedAt$: import("rxjs").Observable<Date | undefined>;
+    /** Will provide the time when this call has been scheduled to start. */
+    startsAt$: import("rxjs").Observable<Date | undefined>;
+    /** Will provide the time when this call has been updated. */
+    updatedAt$: import("rxjs").Observable<Date>;
+    /** Will provide the user who created this call. */
+    createdBy$: import("rxjs").Observable<UserResponse | undefined>;
+    /** Will provide the custom data of this call. */
+    custom$: import("rxjs").Observable<Record<string, any>>;
+    /** Will provide the egress data of this call. */
+    egress$: import("rxjs").Observable<EgressResponse | undefined>;
+    /** Will provide the ingress data of this call. */
+    ingress$: import("rxjs").Observable<CallIngressResponse | undefined>;
+    /** Will provide the recording state of this call. */
+    recording$: import("rxjs").Observable<boolean>;
+    /** Will provide the recording state of this call. */
+    individualRecording$: import("rxjs").Observable<boolean>;
+    /** Will provide the recording state of this call. */
+    rawRecording$: import("rxjs").Observable<boolean>;
+    /** Will provide the session data of this call. */
+    session$: import("rxjs").Observable<CallSessionResponse | undefined>;
+    /** Will provide the settings of this call. */
+    settings$: import("rxjs").Observable<CallSettingsResponse | undefined>;
+    /** Will provide the transcribing state of this call. */
+    transcribing$: import("rxjs").Observable<boolean>;
+    /** Will provide the closed captioning state of this call. */
+    captioning$: import("rxjs").Observable<boolean>;
+    /**
+     * Whether end-to-end encryption is active for this call, as reported by the
+     * SFU in the join response.
+     */
+    e2eeEnabled$: import("rxjs").Observable<boolean>;
+    /** Will provide the user who ended this call. */
+    endedBy$: import("rxjs").Observable<UserResponse | undefined>;
+    /** Will provide the thumbnails of this call. */
+    thumbnails$: import("rxjs").Observable<ThumbnailResponse | undefined>;
+    /** The list of members in the current call. */
+    members$: import("rxjs").Observable<MemberResponse[]>;
+    /** The calling state. */
+    callingState$: import("rxjs").Observable<CallingState>;
     /**
      * The time the call session actually started.
      * Useful for displaying the call duration.
      */
-    startedAt$: Observable<Date | undefined>;
+    startedAt$: import("rxjs").Observable<Date | undefined>;
     /**
      * The server-side counted number of participants connected to the current call.
      * This number includes the anonymous participants as well.
      */
-    participantCount$: Observable<number>;
+    participantCount$: import("rxjs").Observable<number>;
     /**
      * The server-side counted number of anonymous participants connected to the current call.
      * This number excludes the regular participants.
      */
-    anonymousParticipantCount$: Observable<number>;
+    anonymousParticipantCount$: import("rxjs").Observable<number>;
     /**
      * All participants of the current call (this includes the current user and other participants as well),
      * unsorted. This observable only updates when participants join or leave the call.
      */
-    rawParticipants$: Observable<StreamVideoParticipant[]>;
-    /**
-     * All participants of the current call (this includes the current user and other participants as well),
-     * sorted according to the current `sortByParticipantsBy` setting
-     */
-    participants$: Observable<StreamVideoParticipant[]>;
-    /**
-     * Remote participants of the current call (this includes every participant except the logged-in user).
-     */
-    remoteParticipants$: Observable<StreamVideoParticipant[]>;
-    /**
-     * The local participant of the current call (the logged-in user).
-     */
-    localParticipant$: Observable<StreamVideoParticipant | undefined>;
-    /**
-     * Pinned participants of the current call.
-     */
-    pinnedParticipants$: Observable<StreamVideoParticipant[]>;
-    /**
-     * The currently elected dominant speaker in the current call.
-     */
-    dominantSpeaker$: Observable<StreamVideoParticipant | undefined>;
-    /**
-     * Emits true whenever there is an active screen sharing session within
-     * the current call. Useful for displaying a "screen sharing" indicator and
-     * switching the layout to a screen sharing layout.
-     *
-     * The actual screen sharing track isn't exposed here, but can be retrieved
-     * from the list of call participants. We also don't want to be limiting
-     * to the number of share screen tracks are displayed in a call.
-     */
-    hasOngoingScreenShare$: Observable<boolean>;
+    rawParticipants$: import("rxjs").Observable<StreamVideoParticipant[]>;
+    /** All participants of the current call sorted according to the current `sortByParticipantsBy` setting. */
+    participants$: import("rxjs").Observable<StreamVideoParticipant[]>;
+    /** The local participant of the current call. */
+    localParticipant$: import("rxjs").Observable<StreamVideoParticipant | undefined>;
+    /** Remote participants of the current call (all except the local participant). */
+    remoteParticipants$: import("rxjs").Observable<StreamVideoParticipant[]>;
+    /** Pinned participants of the current call. */
+    pinnedParticipants$: import("rxjs").Observable<StreamVideoParticipant[]>;
+    /** The currently elected dominant speaker in the current call. */
+    dominantSpeaker$: import("rxjs").Observable<StreamVideoParticipant | undefined>;
+    /** Emits true whenever there is an active screen sharing session within the current call. */
+    hasOngoingScreenShare$: import("rxjs").Observable<boolean>;
     /**
      * The latest stats report of the current call.
      * When stats gathering is enabled, this observable will emit a new value
@@ -109,123 +138,19 @@ export declare class CallState {
      * Consumers of this observable can implement their own batching logic
      * in case they want to show historical stats data.
      */
-    callStatsReport$: Observable<CallStatsReport | undefined>;
-    /**
-     * The list of members in the current call.
-     */
-    members$: Observable<MemberResponse[]>;
-    /**
-     * The list of capabilities of the current user.
-     */
-    ownCapabilities$: Observable<OwnCapability[]>;
-    /**
-     * The calling state.
-     */
-    callingState$: Observable<CallingState>;
-    /**
-     * The backstage state.
-     */
-    backstage$: Observable<boolean>;
-    /**
-     * Will provide the list of blocked user IDs.
-     */
-    blockedUserIds$: Observable<string[]>;
-    /**
-     * Will provide the time when this call has been created.
-     */
-    createdAt$: Observable<Date>;
-    /**
-     * Will provide the time when this call has been ended.
-     */
-    endedAt$: Observable<Date | undefined>;
-    /**
-     * Will provide the time when this call has been scheduled to start.
-     */
-    startsAt$: Observable<Date | undefined>;
-    /**
-     * Will provide the time when this call has been updated.
-     */
-    updatedAt$: Observable<Date>;
-    /**
-     * Will provide the user who created this call.
-     */
-    createdBy$: Observable<UserResponse | undefined>;
-    /**
-     * Will provide the custom data of this call.
-     */
-    custom$: Observable<Record<string, any>>;
-    /**
-     * Will provide the egress data of this call.
-     */
-    egress$: Observable<EgressResponse | undefined>;
-    /**
-     * Will provide the ingress data of this call.
-     */
-    ingress$: Observable<CallIngressResponse | undefined>;
-    /**
-     * Will provide the recording state of this call.
-     */
-    recording$: Observable<boolean>;
-    /**
-     * Will provide the recording state of this call.
-     */
-    individualRecording$: Observable<boolean>;
-    /**
-     * Will provide the recording state of this call.
-     */
-    rawRecording$: Observable<boolean>;
-    /**
-     * Will provide the session data of this call.
-     */
-    session$: Observable<CallSessionResponse | undefined>;
-    /**
-     * Will provide the settings of this call.
-     */
-    settings$: Observable<CallSettingsResponse | undefined>;
-    /**
-     * Will provide the transcribing state of this call.
-     */
-    transcribing$: Observable<boolean>;
-    /**
-     * Will provide the closed captioning state of this call.
-     */
-    captioning$: Observable<boolean>;
-    /**
-     * Whether end-to-end encryption is active for this call, as reported by the
-     * SFU in the join response.
-     */
-    e2eeEnabled$: Observable<boolean>;
-    /**
-     * Will provide the user who ended this call.
-     */
-    endedBy$: Observable<UserResponse | undefined>;
-    /**
-     * Will provide the thumbnails of this call.
-     */
-    thumbnails$: Observable<ThumbnailResponse | undefined>;
-    /**
-     * The queue of closed captions.
-     */
-    closedCaptions$: Observable<CallClosedCaption[]>;
-    readonly logger: import("@stream-io/logger").Logger<string & {}>;
-    /**
-     * A list of comparators that are used to sort the participants.
-     */
-    private sortParticipantsBy;
-    /**
-     * The closed captions configuration.
-     */
+    callStatsReport$: import("rxjs").Observable<CallStatsReport | undefined>;
+    /** The queue of closed captions. */
+    closedCaptions$: import("rxjs").Observable<CallClosedCaption[]>;
+    /** The list of capabilities of the current user. */
+    ownCapabilities$: import("rxjs").Observable<OwnCapability[]>;
+    private orphanedTracks;
+    /** The closed captions configuration. */
     private closedCaptionsSettings;
     private closedCaptionsTasks;
     private readonly eventHandlers;
-    /**
-     * Creates a new instance of the CallState class.
-     *
-     */
+    /** Creates a new instance of the CallState class. */
     constructor();
-    /**
-     * Runs the cleanup tasks.
-     */
+    /** Runs the cleanup tasks. */
     dispose: () => void;
     /**
      * Sets the list of criteria that are used to sort the participants.
@@ -234,29 +159,8 @@ export declare class CallState {
      * @param comparator the comparator to use to sort the participants.
      */
     setSortParticipantsBy: (comparator: Comparator<StreamVideoParticipant>) => void;
-    /**
-     * Returns the comparator currently used to sort the participants.
-     */
+    /** Returns the comparator currently used to sort the participants. */
     getSortParticipantsBy: () => Comparator<StreamVideoParticipant>;
-    /**
-     * Gets the current value of an observable, or undefined if the observable has
-     * not emitted a value yet.
-     *
-     * @param observable$ the observable to get the value from.
-     */
-    getCurrentValue: <T>(observable$: Observable<T>) => T;
-    /**
-     * Updates the value of the provided Subject.
-     * An `update` can either be a new value or a function which takes
-     * the current value and returns a new value.
-     *
-     * @internal
-     *
-     * @param subject the subject to update.
-     * @param update the update to apply to the subject.
-     * @return the updated value.
-     */
-    setCurrentValue: <T>(subject: import("rxjs").Subject<T>, update: Patch<T>) => T;
     /**
      * The server-side counted number of participants connected to the current call.
      * This number includes the anonymous participants as well.
@@ -281,9 +185,7 @@ export declare class CallState {
      * @param startedAt the time the call session actually started.
      */
     setStartedAt: (startedAt: Patch<Date | undefined>) => Date | undefined;
-    /**
-     * Returns whether closed captions are enabled in the current call.
-     */
+    /** Returns whether closed captions are enabled in the current call. */
     get captioning(): boolean;
     /**
      * Sets the closed captioning state of the current call.
@@ -308,13 +210,9 @@ export declare class CallState {
      * @param count the number of anonymous participants.
      */
     setAnonymousParticipantCount: (count: Patch<number>) => number;
-    /**
-     * The list of participants in the current call.
-     */
+    /** The list of participants in the current call. */
     get participants(): StreamVideoParticipant[];
-    /**
-     * The stable list of participants in the current call, unsorted.
-     */
+    /** The stable list of participants in the current call, unsorted. */
     get rawParticipants(): StreamVideoParticipant[];
     /**
      * Returns the current participants array directly from the BehaviorSubject.
@@ -333,29 +231,17 @@ export declare class CallState {
      * @param participants the list of participants.
      */
     setParticipants: (participants: Patch<StreamVideoParticipant[]>) => StreamVideoParticipant[];
-    /**
-     * The local participant in the current call.
-     */
+    /** The local participant in the current call. */
     get localParticipant(): StreamVideoParticipant | undefined;
-    /**
-     * The list of remote participants in the current call.
-     */
+    /** The list of remote participants in the current call. */
     get remoteParticipants(): StreamVideoParticipant[];
-    /**
-     * The dominant speaker in the current call.
-     */
+    /** The dominant speaker in the current call. */
     get dominantSpeaker(): StreamVideoParticipant | undefined;
-    /**
-     * The list of pinned participants in the current call.
-     */
+    /** The list of pinned participants in the current call. */
     get pinnedParticipants(): StreamVideoParticipant[];
-    /**
-     * Tell if there is an ongoing screen share in this call.
-     */
+    /** Tell if there is an ongoing screen share in this call. */
     get hasOngoingScreenShare(): boolean;
-    /**
-     * The calling state.
-     */
+    /** The calling state. */
     get callingState(): CallingState;
     /**
      * Sets the calling state.
@@ -364,9 +250,7 @@ export declare class CallState {
      * @param state the new calling state.
      */
     setCallingState: (state: Patch<CallingState>) => CallingState;
-    /**
-     * The call stats report.
-     */
+    /** The call stats report. */
     get callStatsReport(): CallStatsReport | undefined;
     /**
      * Returns whether the call stats report is being observed or not.
@@ -380,9 +264,7 @@ export declare class CallState {
      * @param report the report to set.
      */
     setCallStatsReport: (report: Patch<CallStatsReport | undefined>) => CallStatsReport | undefined;
-    /**
-     * The members of the current call.
-     */
+    /** The members of the current call. */
     get members(): MemberResponse[];
     /**
      * Sets the members of the current call.
@@ -391,9 +273,7 @@ export declare class CallState {
      * @param members the members to set.
      */
     setMembers: (members: Patch<MemberResponse[]>) => void;
-    /**
-     * The capabilities of the current user for the current call.
-     */
+    /** The capabilities of the current user for the current call. */
     get ownCapabilities(): OwnCapability[];
     /**
      * Sets the own capabilities.
@@ -409,95 +289,59 @@ export declare class CallState {
      * @param grants the grants to set.
      */
     setCallGrants: (grants: Patch<CallGrants>) => CallGrants;
-    /**
-     * The backstage state.
-     */
+    /** The backstage state. */
     get backstage(): boolean;
     /**
      * Sets the backstage state.
      * @param backstage the backstage state.
      */
     setBackstage: (backstage: Patch<boolean>) => boolean;
-    /**
-     * Will provide the list of blocked user IDs.
-     */
+    /** Will provide the list of blocked user IDs. */
     get blockedUserIds(): string[];
-    /**
-     * Will provide the time when this call has been created.
-     */
+    /** Will provide the time when this call has been created. */
     get createdAt(): Date;
-    /**
-     * Will provide the time when this call has been ended.
-     */
+    /** Will provide the time when this call has been ended. */
     get endedAt(): Date | undefined;
     /**
      * Sets the time when this call has been ended.
      * @param endedAt the time when this call has been ended.
      */
     setEndedAt: (endedAt: Patch<Date | undefined>) => Date | undefined;
-    /**
-     * Will provide the time when this call has been scheduled to start.
-     */
+    /** Will provide the time when this call has been scheduled to start. */
     get startsAt(): Date | undefined;
-    /**
-     * Will provide the time when this call has been updated.
-     */
+    /** Will provide the time when this call has been updated. */
     get updatedAt(): Date;
-    /**
-     * Will provide the user who created this call.
-     */
+    /** Will provide the user who created this call. */
     get createdBy(): UserResponse | undefined;
-    /**
-     * Will provide the custom data of this call.
-     */
+    /** Will provide the custom data of this call. */
     get custom(): Record<string, any>;
     /**
      * Will provide the egress data of this call.
      */
     get egress(): EgressResponse | undefined;
-    /**
-     * Will provide the ingress data of this call.
-     */
+    /** Will provide the ingress data of this call. */
     get ingress(): CallIngressResponse | undefined;
-    /**
-     * Will provide the composite recording state of this call.
-     */
+    /** Will provide the composite recording state of this call. */
     get recording(): boolean;
-    /**
-     * Will provide the individual recording state of this call.
-     */
+    /** Will provide the individual recording state of this call. */
     get individualRecording(): boolean;
-    /**
-     * Will provide the raw recording state of this call.
-     */
+    /** Will provide the raw recording state of this call. */
     get rawRecording(): boolean;
-    /**
-     * Will provide the session data of this call.
-     */
+    /** Will provide the session data of this call. */
     get session(): CallSessionResponse | undefined;
-    /**
-     * Will provide the settings of this call.
-     */
+    /** Will provide the settings of this call. */
     get settings(): CallSettingsResponse | undefined;
-    /**
-     * Will provide the transcribing state of this call.
-     */
+    /** Will provide the transcribing state of this call. */
     get transcribing(): boolean;
-    /**
-     * Whether end-to-end encryption is active for this call.
-     */
+    /** Whether end-to-end encryption is active for this call. */
     get e2eeEnabled(): boolean;
-    /**
-     * Will provide the user who ended this call.
-     */
+    /** Will provide the user who ended this call. */
     get endedBy(): UserResponse | undefined;
     /**
      * Will provide the thumbnails of this call, if enabled in the call settings.
      */
     get thumbnails(): ThumbnailResponse | undefined;
-    /**
-     * Returns the current queue of closed captions.
-     */
+    /** Returns the current queue of closed captions. */
     get closedCaptions(): CallClosedCaption[];
     /**
      * Will try to find the participant with the given sessionId in the current call.
@@ -506,9 +350,7 @@ export declare class CallState {
      * @returns the participant with the given sessionId or undefined if not found.
      */
     findParticipantBySessionId: (sessionId: string) => StreamVideoParticipant | undefined;
-    /**
-     * Returns a new lookup table of participants indexed by their session ID.
-     */
+    /** Returns a new lookup table of participants indexed by their session ID. */
     getParticipantLookupBySessionId: () => {
         [sessionId: string]: StreamVideoParticipant | undefined;
     };