@stream-io/video-client 1.5.0-0 → 1.5.0

package/dist/src/gen/video/sfu/models/models.d.ts

@@ -270,10 +270,49 @@ export interface TrackInfo {
      * @generated from protobuf field: bool red = 9;
      */
     red: boolean;
+}
+/**
+ * todo remove this
+ *
+ * @generated from protobuf message stream.video.sfu.models.Call
+ */
+export interface Call {
+    /**
+     * the call type
+     *
+     * @generated from protobuf field: string type = 1;
+     */
+    type: string;
     /**
-     * @generated from protobuf field: bool muted = 10;
+     * the call id
+     *
+     * @generated from protobuf field: string id = 2;
+     */
+    id: string;
+    /**
+     * the id of the user that created this call
+     *
+     * @generated from protobuf field: string created_by_user_id = 3;
+     */
+    createdByUserId: string;
+    /**
+     * the id of the current host for this call
+     *
+     * @generated from protobuf field: string host_user_id = 4;
      */
-    muted: boolean;
+    hostUserId: string;
+    /**
+     * @generated from protobuf field: google.protobuf.Struct custom = 5;
+     */
+    custom?: Struct;
+    /**
+     * @generated from protobuf field: google.protobuf.Timestamp created_at = 6;
+     */
+    createdAt?: Timestamp;
+    /**
+     * @generated from protobuf field: google.protobuf.Timestamp updated_at = 7;
+     */
+    updatedAt?: Timestamp;
 }
 /**
  * @generated from protobuf message stream.video.sfu.models.Error
@@ -377,47 +416,6 @@ export interface Device {
      */
     version: string;
 }
-/**
- * @generated from protobuf message stream.video.sfu.models.Call
- */
-export interface Call {
-    /**
-     * the call type
-     *
-     * @generated from protobuf field: string type = 1;
-     */
-    type: string;
-    /**
-     * the call id
-     *
-     * @generated from protobuf field: string id = 2;
-     */
-    id: string;
-    /**
-     * the id of the user that created this call
-     *
-     * @generated from protobuf field: string created_by_user_id = 3;
-     */
-    createdByUserId: string;
-    /**
-     * the id of the current host for this call
-     *
-     * @generated from protobuf field: string host_user_id = 4;
-     */
-    hostUserId: string;
-    /**
-     * @generated from protobuf field: google.protobuf.Struct custom = 5;
-     */
-    custom?: Struct;
-    /**
-     * @generated from protobuf field: google.protobuf.Timestamp created_at = 6;
-     */
-    createdAt?: Timestamp;
-    /**
-     * @generated from protobuf field: google.protobuf.Timestamp updated_at = 7;
-     */
-    updatedAt?: Timestamp;
-}
 /**
  * CallGrants represents the set of permissions given
  * to the user for the current call.
@@ -726,11 +724,7 @@ export declare enum CallEndedReason {
     /**
      * @generated from protobuf enum value: CALL_ENDED_REASON_KICKED = 3;
      */
-    KICKED = 3,
-    /**
-     * @generated from protobuf enum value: CALL_ENDED_REASON_SESSION_ENDED = 4;
-     */
-    SESSION_ENDED = 4
+    KICKED = 3
 }
 /**
  * WebsocketReconnectStrategy defines the ws strategies available for handling reconnections.
@@ -743,7 +737,7 @@ export declare enum WebsocketReconnectStrategy {
      */
     UNSPECIFIED = 0,
     /**
-     * Sent after reaching the maximum reconnection attempts, or any other unrecoverable error leading to permanent disconnect.
+     * Sent after reaching the maximum reconnection attempts, leading to permanent disconnect.
      *
      * @generated from protobuf enum value: WEBSOCKET_RECONNECT_STRATEGY_DISCONNECT = 1;
      */
@@ -756,18 +750,25 @@ export declare enum WebsocketReconnectStrategy {
      */
     FAST = 2,
     /**
-     * SDK should obtain new credentials from the coordinator, drops existing pc instances, set a new session_id and initializes
+     * SDK should drop existing pc instances and creates a fresh WebSocket connection,
+     * ensuring a clean state for the reconnection.
+     *
+     * @generated from protobuf enum value: WEBSOCKET_RECONNECT_STRATEGY_CLEAN = 3;
+     */
+    CLEAN = 3,
+    /**
+     * SDK should obtain new credentials from the coordinator, drops existing pc instances, and initializes
      * a completely new WebSocket connection, ensuring a comprehensive reset.
      *
-     * @generated from protobuf enum value: WEBSOCKET_RECONNECT_STRATEGY_REJOIN = 3;
+     * @generated from protobuf enum value: WEBSOCKET_RECONNECT_STRATEGY_FULL = 4;
      */
-    REJOIN = 3,
+    FULL = 4,
     /**
      * SDK should migrate to a new SFU instance
      *
-     * @generated from protobuf enum value: WEBSOCKET_RECONNECT_STRATEGY_MIGRATE = 4;
+     * @generated from protobuf enum value: WEBSOCKET_RECONNECT_STRATEGY_MIGRATE = 5;
      */
-    MIGRATE = 4
+    MIGRATE = 5
 }
 declare class CallState$Type extends MessageType<CallState> {
     constructor();
@@ -869,6 +870,16 @@ declare class TrackInfo$Type extends MessageType<TrackInfo> {
  * @generated MessageType for protobuf message stream.video.sfu.models.TrackInfo
  */
 export declare const TrackInfo: TrackInfo$Type;
+declare class Call$Type extends MessageType<Call> {
+    constructor();
+    create(value?: PartialMessage<Call>): Call;
+    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: Call): Call;
+    internalBinaryWrite(message: Call, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
+}
+/**
+ * @generated MessageType for protobuf message stream.video.sfu.models.Call
+ */
+export declare const Call: Call$Type;
 declare class Error$Type extends MessageType<Error> {
     constructor();
     create(value?: PartialMessage<Error>): Error;
@@ -929,16 +940,6 @@ declare class Device$Type extends MessageType<Device> {
  * @generated MessageType for protobuf message stream.video.sfu.models.Device
  */
 export declare const Device: Device$Type;
-declare class Call$Type extends MessageType<Call> {
-    constructor();
-    create(value?: PartialMessage<Call>): Call;
-    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: Call): Call;
-    internalBinaryWrite(message: Call, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
-}
-/**
- * @generated MessageType for protobuf message stream.video.sfu.models.Call
- */
-export declare const Call: Call$Type;
 declare class CallGrants$Type extends MessageType<CallGrants> {
     constructor();
     create(value?: PartialMessage<CallGrants>): CallGrants;

package/dist/src/logger.d.ts

@@ -3,5 +3,4 @@ export declare const logLevels: Record<LogLevel, number>;
 export declare const logToConsole: Logger;
 export declare const setLogger: (l: Logger, lvl?: LogLevel) => void;
 export declare const setLogLevel: (l: LogLevel) => void;
-export declare const getLogLevel: () => LogLevel;
 export declare const getLogger: (withTags?: string[]) => Logger;

package/dist/src/rpc/createClient.d.ts

@@ -1,9 +1,7 @@
 import { RpcInterceptor } from '@protobuf-ts/runtime-rpc';
 import { TwirpOptions } from '@protobuf-ts/twirp-transport';
 import { SignalServerClient } from '../gen/video/sfu/signal_rpc/signal.client';
-import { Logger, LogLevel } from '../coordinator/connection/types';
 export declare const withHeaders: (headers: Record<string, string>) => RpcInterceptor;
-export declare const withRequestLogger: (logger: Logger, level: LogLevel) => RpcInterceptor;
 /**
  * Creates new SignalServerClient instance.
  *

package/dist/src/rpc/index.d.ts

@@ -1,2 +1 @@
 export * from './createClient';
-export * from './retryable';

package/dist/src/rtc/Dispatcher.d.ts

@@ -19,7 +19,7 @@ export declare const isSfuEvent: (eventName: SfuEventKinds | EventTypes) => even
 export declare class Dispatcher {
     private readonly logger;
     private subscribers;
-    dispatch: <K extends SfuEventKinds>(message: DispatchableMessage<K>, logTag: string) => void;
+    dispatch: <K extends SfuEventKinds>(message: DispatchableMessage<K>) => void;
     on: <E extends keyof AllSfuEvents>(eventName: E, fn: CallEventListener<E>) => () => void;
     off: <E extends keyof AllSfuEvents>(eventName: E, fn: CallEventListener<E>) => void;
     offAll: (eventName?: SfuEventKinds) => void;

package/dist/src/rtc/IceTrickleBuffer.d.ts

@@ -7,5 +7,6 @@ import { ICETrickle } from '../gen/video/sfu/event/events';
 export declare class IceTrickleBuffer {
     readonly subscriberCandidates: ReplaySubject<ICETrickle>;
     readonly publisherCandidates: ReplaySubject<ICETrickle>;
+    private readonly logger;
     push: (iceTrickle: ICETrickle) => void;
 }

package/dist/src/rtc/Publisher.d.ts

@@ -11,16 +11,14 @@ export type PublisherConstructorOpts = {
     connectionConfig?: RTCConfiguration;
     isDtxEnabled: boolean;
     isRedEnabled: boolean;
+    iceRestartDelay?: number;
     onUnrecoverableError?: () => void;
-    logTag: string;
 };
 /**
  * The `Publisher` is responsible for publishing/unpublishing media streams to/from the SFU
- *
  * @internal
  */
 export declare class Publisher {
-    private readonly logger;
     private pc;
     private readonly state;
     private readonly transceiverRegistry;
@@ -30,16 +28,18 @@ export declare class Publisher {
      * This is needed because some browsers (Firefox) don't reliably report
      * trackId and `mid` parameters.
      *
-     * @internal
+     * @private
      */
-    private readonly transceiverInitOrder;
+    private transceiverInitOrder;
     private readonly trackKindMapping;
     private readonly trackLayersCache;
     private readonly isDtxEnabled;
     private readonly isRedEnabled;
     private readonly unsubscribeOnIceRestart;
     private readonly onUnrecoverableError?;
+    private readonly iceRestartDelay;
     private isIceRestarting;
+    private iceRestartTimeout?;
     private _connectionConfiguration;
     /**
      * Returns the current connection configuration.
@@ -62,22 +62,15 @@ export declare class Publisher {
      * @param isRedEnabled whether RED is enabled.
      * @param iceRestartDelay the delay in milliseconds to wait before restarting ICE once connection goes to `disconnected` state.
      * @param onUnrecoverableError a callback to call when an unrecoverable error occurs.
-     * @param logTag the log tag to use.
      */
-    constructor({ connectionConfig, sfuClient, dispatcher, state, isDtxEnabled, isRedEnabled, onUnrecoverableError, logTag, }: PublisherConstructorOpts);
+    constructor({ connectionConfig, sfuClient, dispatcher, state, isDtxEnabled, isRedEnabled, iceRestartDelay, onUnrecoverableError, }: PublisherConstructorOpts);
     private createPeerConnection;
     /**
      * Closes the publisher PeerConnection and cleans up the resources.
      */
-    close: ({ stopTracks }: {
-        stopTracks: boolean;
+    close: ({ stopTracks }?: {
+        stopTracks?: boolean | undefined;
     }) => void;
-    /**
-     * Detaches the event handlers from the `RTCPeerConnection`.
-     * This is useful when we want to replace the `RTCPeerConnection`
-     * instance with a new one (in case of migration).
-     */
-    detachEventHandlers: () => void;
     /**
      * Starts publishing the given track of the given media stream.
      *
@@ -103,11 +96,17 @@ export declare class Publisher {
      * @param trackType the track type to check.
      */
     isPublishing: (trackType: TrackType) => boolean;
+    /**
+     * Returns true if the given track type is currently live
+     *
+     * @param trackType the track type to check.
+     */
+    isLive: (trackType: TrackType) => boolean;
     private notifyTrackMuteStateChanged;
     /**
      * Stops publishing all tracks and stop all tracks.
      */
-    private stopPublishing;
+    stopPublishing: () => void;
     updateVideoPublishQuality: (enabledLayers: VideoLayerSetting[]) => Promise<void>;
     /**
      * Returns the result of the `RTCPeerConnection.getStats()` method
@@ -123,6 +122,15 @@ export declare class Publisher {
      * @param sfuClient the SFU client to use.
      */
     setSfuClient: (sfuClient: StreamSfuClient) => void;
+    /**
+     * Performs a migration of this publisher instance to a new SFU.
+     *
+     * Initiates a new `iceRestart` offer/answer exchange with the new SFU.
+     *
+     * @param sfuClient the new SFU client to migrate to.
+     * @param connectionConfig the new connection configuration to use.
+     */
+    migrateTo: (sfuClient: StreamSfuClient, connectionConfig?: RTCConfiguration) => Promise<void>;
     /**
      * Restarts the ICE connection and renegotiates with the SFU.
      */
@@ -134,16 +142,9 @@ export declare class Publisher {
      * @param options the optional offer options to use.
      */
     private negotiate;
-    private enableHighQualityAudio;
     private mungeCodecs;
     private extractMid;
-    /**
-     * Returns a list of tracks that are currently being published.
-     *
-     * @internal
-     * @param sdp an optional SDP to extract the `mid` from.
-     */
-    getAnnouncedTracks: (sdp?: string) => TrackInfo[];
+    getCurrentTrackInfos: (sdp?: string) => TrackInfo[];
     private onIceCandidateError;
     private onIceConnectionStateChange;
     private onIceGatheringStateChange;

package/dist/src/rtc/Subscriber.d.ts

@@ -6,24 +6,23 @@ export type SubscriberOpts = {
     dispatcher: Dispatcher;
     state: CallState;
     connectionConfig?: RTCConfiguration;
+    iceRestartDelay?: number;
     onUnrecoverableError?: () => void;
-    logTag: string;
 };
 /**
  * A wrapper around the `RTCPeerConnection` that handles the incoming
  * media streams from the SFU.
- *
- * @internal
  */
 export declare class Subscriber {
-    private readonly logger;
     private pc;
     private sfuClient;
     private state;
     private readonly unregisterOnSubscriberOffer;
     private readonly unregisterOnIceRestart;
     private readonly onUnrecoverableError?;
+    private readonly iceRestartDelay;
     private isIceRestarting;
+    private iceRestartTimeout?;
     private _connectionConfiguration;
     /**
      * Returns the current connection configuration.
@@ -40,9 +39,8 @@ export declare class Subscriber {
      * @param connectionConfig the connection configuration to use.
      * @param iceRestartDelay the delay in milliseconds to wait before restarting ICE when connection goes to `disconnected` state.
      * @param onUnrecoverableError a callback to call when an unrecoverable error occurs.
-     * @param logTag a tag to use for logging.
      */
-    constructor({ sfuClient, dispatcher, state, connectionConfig, onUnrecoverableError, logTag, }: SubscriberOpts);
+    constructor({ sfuClient, dispatcher, state, connectionConfig, iceRestartDelay, onUnrecoverableError, }: SubscriberOpts);
     /**
      * Creates a new `RTCPeerConnection` instance with the given configuration.
      *
@@ -53,12 +51,6 @@ export declare class Subscriber {
      * Closes the `RTCPeerConnection` and unsubscribes from the dispatcher.
      */
     close: () => void;
-    /**
-     * Detaches the event handlers from the `RTCPeerConnection`.
-     * This is useful when we want to replace the `RTCPeerConnection`
-     * instance with a new one (in case of migration).
-     */
-    detachEventHandlers: () => void;
     /**
      * Returns the result of the `RTCPeerConnection.getStats()` method
      * @param selector
@@ -71,6 +63,13 @@ export declare class Subscriber {
      * @param sfuClient the SFU client to use.
      */
     setSfuClient: (sfuClient: StreamSfuClient) => void;
+    /**
+     * Migrates the subscriber to a new SFU client.
+     *
+     * @param sfuClient the new SFU client to migrate to.
+     * @param connectionConfig the new connection configuration to use.
+     */
+    migrateTo: (sfuClient: StreamSfuClient, connectionConfig?: RTCConfiguration) => void;
     /**
      * Restarts the ICE connection and renegotiates with the SFU.
      */

package/dist/src/rtc/flows/join.d.ts

@@ -0,0 +1,20 @@
+import { JoinCallData } from '../../types';
+import { StreamClient } from '../../coordinator/connection/client';
+/**
+ * Collects all necessary information to join a call, talks to the coordinator
+ * and returns the necessary information to join the call.
+ *
+ * @param httpClient the http client to use.
+ * @param type the type of the call.
+ * @param id the id of the call.
+ * @param data the data for the call.
+ */
+export declare const join: (httpClient: StreamClient, type: string, id: string, data?: JoinCallData) => Promise<{
+    connectionConfig: RTCConfiguration | undefined;
+    sfuServer: import("../../gen/coordinator").SFUResponse;
+    token: string;
+    metadata: import("../../gen/coordinator").CallResponse;
+    members: import("../../gen/coordinator").MemberResponse[];
+    ownCapabilities: import("../../gen/coordinator").OwnCapability[];
+    statsOptions: import("../../gen/coordinator").StatsOptions;
+}>;

package/dist/src/rtc/helpers/tracks.d.ts

@@ -1,5 +1,5 @@
 import { TrackType } from '../../gen/video/sfu/models/models';
+import type { StreamVideoParticipant } from '../../types';
 import { TrackMuteType } from '../../types';
-export declare const trackTypeToParticipantStreamKey: (trackType: TrackType) => "audioStream" | "videoStream" | "screenShareStream" | "screenShareAudioStream" | undefined;
-export declare const muteTypeToTrackType: (muteType: TrackMuteType) => TrackType | undefined;
-export declare const toTrackType: (trackType: string) => TrackType | undefined;
+export declare const trackTypeToParticipantStreamKey: (trackType: TrackType) => keyof StreamVideoParticipant;
+export declare const muteTypeToTrackType: (muteType: TrackMuteType) => TrackType;

package/dist/src/rtc/signal.d.ts

@@ -1,6 +1,6 @@
+import WebSocket from 'isomorphic-ws';
 import { DispatchableMessage, SfuEventKinds } from './Dispatcher';
 export declare const createWebSocketSignalChannel: (opts: {
     endpoint: string;
     onMessage: <K extends SfuEventKinds>(message: DispatchableMessage<K>) => void;
-    logTag: string;
 }) => WebSocket;

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

@@ -3,8 +3,7 @@ import type { Patch } from './rxUtils';
 import { StreamVideoParticipant, StreamVideoParticipantPatch, StreamVideoParticipantPatches } from '../types';
 import { CallStatsReport } from '../stats';
 import { CallIngressResponse, CallResponse, CallSessionResponse, CallSettingsResponse, EgressResponse, MemberResponse, OwnCapability, ThumbnailResponse, UserResponse, WSEvent } from '../gen/coordinator';
-import { ReconnectDetails } from '../gen/video/sfu/event/events';
-import { CallState as SfuCallState, Pin, TrackType } from '../gen/video/sfu/models/models';
+import { Pin } from '../gen/video/sfu/models/models';
 import { Comparator } from '../sorting';
 /**
  * Represents the state of the current call.
@@ -52,12 +51,6 @@ export declare enum CallingState {
      */
     OFFLINE = "offline"
 }
-type OrphanedTrack = {
-    id: string;
-    trackLookupPrefix: string;
-    trackType: TrackType;
-    track: MediaStream;
-};
 /**
  * Holds the state of the current call.
  * @react You don't have to use this class directly, as we are exposing the state through Hooks.
@@ -87,7 +80,6 @@ export declare class CallState {
     private anonymousParticipantCountSubject;
     private participantsSubject;
     private callStatsReportSubject;
-    private orphanedTracks;
     /**
      * The time the call session actually started.
      * Useful for displaying the call duration.
@@ -475,7 +467,7 @@ export declare class CallState {
      * @param patch the patch to apply to the participants.
      * @returns all participants, with all patch applied.
      */
-    updateParticipants: (patch: StreamVideoParticipantPatches) => StreamVideoParticipant[];
+    updateParticipants: (patch: StreamVideoParticipantPatches) => StreamVideoParticipant[] | undefined;
     /**
      * Updates the call state with the data received from the server.
      *
@@ -490,31 +482,6 @@ export declare class CallState {
      * @param pins the latest pins from the server.
      */
     setServerSidePins: (pins: Pin[]) => StreamVideoParticipant[];
-    /**
-     * Adds an orphaned track to the call state.
-     *
-     * @internal
-     *
-     * @param orphanedTrack the orphaned track to add.
-     */
-    registerOrphanedTrack: (orphanedTrack: OrphanedTrack) => void;
-    /**
-     * Removes an orphaned track from the call state.
-     *
-     * @internal
-     *
-     * @param id the ID of the orphaned track to remove.
-     */
-    removeOrphanedTrack: (id: string) => void;
-    /**
-     * Takes all orphaned tracks with the given track lookup prefix.
-     * All orphaned tracks with the given track lookup prefix are removed from the call state.
-     *
-     * @internal
-     *
-     * @param trackLookupPrefix the track lookup prefix to match the orphaned tracks by.
-     */
-    takeOrphanedTracks: (trackLookupPrefix: string) => OrphanedTrack[];
     /**
      * Updates the call state with the data received from the server.
      *
@@ -523,16 +490,6 @@ export declare class CallState {
      * @param call the call response from the server.
      */
     updateFromCallResponse: (call: CallResponse) => void;
-    /**
-     * Updates the call state with the data received from the SFU server.
-     *
-     * @internal
-     *
-     * @param callState the call state from the SFU server.
-     * @param currentSessionId the session ID of the current user.
-     * @param reconnectDetails optional reconnect details.
-     */
-    updateFromSfuCallState: (callState: SfuCallState, currentSessionId: string, reconnectDetails?: ReconnectDetails) => void;
     private updateFromMemberRemoved;
     private updateFromMemberAdded;
     private updateFromHLSBroadcastStopped;
@@ -546,4 +503,3 @@ export declare class CallState {
     private blockUser;
     private updateOwnCapabilities;
 }
-export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stream-io/video-client",
-  "version": "1.5.0-0",
+  "version": "1.5.0",
   "packageManager": "yarn@3.2.4",
   "main": "dist/index.cjs.js",
   "module": "dist/index.es.js",
@@ -45,7 +45,7 @@
     "@openapitools/openapi-generator-cli": "^2.13.4",
     "@rollup/plugin-replace": "^5.0.5",
     "@rollup/plugin-typescript": "^11.1.6",
-    "@stream-io/audio-filters-web": "^0.2.1",
+    "@stream-io/audio-filters-web": "workspace:^",
     "@stream-io/node-sdk": "^0.3.0",
     "@types/sdp-transform": "^2.4.7",
     "@types/ua-parser-js": "^0.7.37",
@@ -60,4 +60,4 @@
     "vitest": "^1.0.0",
     "vitest-mock-extended": "^1.2.1"
   }
-}
+}