@stream-io/video-client 1.39.2 → 1.40.0

package/dist/src/Call.d.ts

@@ -1,7 +1,7 @@
 import { Publisher, Subscriber, TrackPublishOptions } from './rtc';
 import { CallState } from './store';
 import { ScopedLogger } from './logger';
-import type { AcceptCallResponse, BlockUserResponse, CallRingEvent, CallSettingsResponse, CollectUserFeedbackRequest, CollectUserFeedbackResponse, DeleteCallRequest, DeleteCallResponse, EndCallResponse, GetCallReportResponse, GetCallResponse, GetCallSessionParticipantStatsDetailsResponse, GetOrCreateCallRequest, GetOrCreateCallResponse, GoLiveRequest, GoLiveResponse, JoinCallResponse, KickUserRequest, KickUserResponse, ListRecordingsResponse, ListTranscriptionsResponse, MuteUsersResponse, PinRequest, PinResponse, QueryCallMembersRequest, QueryCallMembersResponse, QueryCallSessionParticipantStatsResponse, QueryCallSessionParticipantStatsTimelineResponse, RejectCallResponse, RequestPermissionRequest, RequestPermissionResponse, RingCallRequest, RingCallResponse, SendCallEventResponse, SendReactionRequest, SendReactionResponse, StartClosedCaptionsRequest, StartClosedCaptionsResponse, StartFrameRecordingRequest, StartFrameRecordingResponse, StartHLSBroadcastingResponse, StartRecordingRequest, StartRecordingResponse, StartRTMPBroadcastsRequest, StartRTMPBroadcastsResponse, StartTranscriptionRequest, StartTranscriptionResponse, StopAllRTMPBroadcastsResponse, StopClosedCaptionsRequest, StopClosedCaptionsResponse, StopFrameRecordingResponse, StopHLSBroadcastingResponse, StopLiveRequest, StopLiveResponse, StopRecordingResponse, StopRTMPBroadcastsResponse, StopTranscriptionResponse, UnblockUserResponse, UnpinRequest, UnpinResponse, UpdateCallMembersRequest, UpdateCallMembersResponse, UpdateCallRequest, UpdateCallResponse, UpdateUserPermissionsRequest, UpdateUserPermissionsResponse } from './gen/coordinator';
+import type { AcceptCallResponse, BlockUserResponse, CallRingEvent, CallSettingsResponse, CollectUserFeedbackRequest, CollectUserFeedbackResponse, DeleteCallRequest, DeleteCallResponse, EndCallResponse, GetCallReportResponse, GetCallResponse, GetCallSessionParticipantStatsDetailsResponse, GetOrCreateCallRequest, GetOrCreateCallResponse, GoLiveRequest, GoLiveResponse, JoinCallResponse, KickUserRequest, KickUserResponse, ListRecordingsResponse, ListTranscriptionsResponse, MuteUsersResponse, PinRequest, PinResponse, QueryCallMembersRequest, QueryCallMembersResponse, QueryCallSessionParticipantStatsResponse, QueryCallSessionParticipantStatsTimelineResponse, QueryCallStatsMapResponse, RejectCallResponse, RequestPermissionRequest, RequestPermissionResponse, RingCallRequest, RingCallResponse, SendCallEventResponse, SendReactionRequest, SendReactionResponse, StartClosedCaptionsRequest, StartClosedCaptionsResponse, StartFrameRecordingRequest, StartFrameRecordingResponse, StartHLSBroadcastingResponse, StartRecordingRequest, StartRecordingResponse, StartRTMPBroadcastsRequest, StartRTMPBroadcastsResponse, StartTranscriptionRequest, StartTranscriptionResponse, StopAllRTMPBroadcastsResponse, StopClosedCaptionsRequest, StopClosedCaptionsResponse, StopFrameRecordingResponse, StopHLSBroadcastingResponse, StopLiveRequest, StopLiveResponse, StopRecordingResponse, StopRTMPBroadcastsResponse, StopTranscriptionResponse, UnblockUserResponse, UnpinRequest, UnpinResponse, UpdateCallMembersRequest, UpdateCallMembersResponse, UpdateCallRequest, UpdateCallResponse, UpdateUserPermissionsRequest, UpdateUserPermissionsResponse } from './gen/coordinator';
 import { AudioTrackType, CallConstructor, CallLeaveOptions, ClientPublishOptions, ClosedCaptionsSettings, JoinCallData, TrackMuteType, VideoTrackType } from './types';
 import { ClientCapability, TrackType, VideoDimension } from './gen/video/sfu/models/models';
 import { Tracer } from './stats';
@@ -93,6 +93,8 @@ export declare class Call {
     private lastOfflineTimestamp;
     private networkAvailableTask;
     private trackPublishOrder;
+    private joinResponseTimeout?;
+    private rpcRequestTimeout?;
     private joinCallData?;
     private hasJoinedOnce;
     private deviceSettingsAppliedOnce;
@@ -228,8 +230,10 @@ export declare class Call {
      *
      * @returns a promise which resolves once the call join-flow has finished.
      */
-    join: ({ maxJoinRetries, ...data }?: JoinCallData & {
+    join: ({ maxJoinRetries, joinResponseTimeout, rpcRequestTimeout, ...data }?: JoinCallData & {
         maxJoinRetries?: number;
+        joinResponseTimeout?: number;
+        rpcRequestTimeout?: number;
     }) => Promise<void>;
     /**
      * Will make a single attempt to watch for call related WebSocket events
@@ -692,6 +696,17 @@ export declare class Call {
      * @param custom Custom data
      */
     submitFeedback: (rating: number, { reason, custom, }?: Pick<CollectUserFeedbackRequest, "reason" | "custom">) => Promise<CollectUserFeedbackResponse>;
+    /**
+     * Retrieves the call stats for the current call session in a format suitable
+     * for displaying in map-like UIs.
+     */
+    getCallStatsMap: (params?: {
+        start_time?: Date | string;
+        end_time?: Date | string;
+        exclude_publishers?: boolean;
+        exclude_subscribers?: boolean;
+        exclude_sfus?: boolean;
+    }, callSessionId?: string | undefined) => Promise<QueryCallStatsMapResponse>;
     /**
      * Sends a custom event to all call participants.
      *

package/dist/src/StreamSfuClient.d.ts

@@ -31,6 +31,11 @@ export type StreamSfuClientConstructor = {
      * Defaults to 5000ms.
      */
     joinResponseTimeout?: number;
+    /**
+     * The request timeout in milliseconds for RPC requests.
+     * Defaults to 5000ms.
+     */
+    rpcRequestTimeout?: number;
     /**
      * Callback for when the WebSocket connection is closed.
      */
@@ -137,7 +142,7 @@ export declare class StreamSfuClient {
     /**
      * Constructs a new SFU client.
      */
-    constructor({ dispatcher, credentials, sessionId, cid, tag, joinResponseTimeout, onSignalClose, streamClient, enableTracing, }: StreamSfuClientConstructor);
+    constructor({ dispatcher, credentials, sessionId, cid, tag, joinResponseTimeout, rpcRequestTimeout, onSignalClose, streamClient, enableTracing, }: StreamSfuClientConstructor);
     private createWebSocket;
     get isHealthy(): boolean;
     get joinTask(): Promise<JoinResponse>;

package/dist/src/gen/coordinator/index.d.ts

@@ -1476,6 +1476,12 @@ export interface CallRecording {
      * @memberof CallRecording
      */
     filename: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CallRecording
+     */
+    recording_type: string;
     /**
      *
      * @type {string}
@@ -2586,6 +2592,12 @@ export interface CallStatsLocation {
      * @memberof CallStatsLocation
      */
     country?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CallStatsLocation
+     */
+    country_iso_code?: string;
     /**
      *
      * @type {number}
@@ -2605,6 +2617,162 @@ export interface CallStatsLocation {
      */
     subdivision?: string;
 }
+/**
+ *
+ * @export
+ * @interface CallStatsMapLocation
+ */
+export interface CallStatsMapLocation {
+    /**
+     *
+     * @type {number}
+     * @memberof CallStatsMapLocation
+     */
+    count: number;
+    /**
+     *
+     * @type {number}
+     * @memberof CallStatsMapLocation
+     */
+    live_count: number;
+    /**
+     *
+     * @type {CallStatsLocation}
+     * @memberof CallStatsMapLocation
+     */
+    location?: CallStatsLocation;
+}
+/**
+ *
+ * @export
+ * @interface CallStatsMapPublisher
+ */
+export interface CallStatsMapPublisher {
+    /**
+     *
+     * @type {boolean}
+     * @memberof CallStatsMapPublisher
+     */
+    is_live: boolean;
+    /**
+     *
+     * @type {CallStatsLocation}
+     * @memberof CallStatsMapPublisher
+     */
+    location?: CallStatsLocation;
+    /**
+     *
+     * @type {string}
+     * @memberof CallStatsMapPublisher
+     */
+    name?: string;
+    /**
+     *
+     * @type {PublishedTrackFlags}
+     * @memberof CallStatsMapPublisher
+     */
+    published_tracks: PublishedTrackFlags;
+    /**
+     *
+     * @type {string}
+     * @memberof CallStatsMapPublisher
+     */
+    publisher_type?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CallStatsMapPublisher
+     */
+    user_id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CallStatsMapPublisher
+     */
+    user_session_id: string;
+}
+/**
+ *
+ * @export
+ * @interface CallStatsMapPublishers
+ */
+export interface CallStatsMapPublishers {
+    /**
+     *
+     * @type {Array<CallStatsMapPublisher>}
+     * @memberof CallStatsMapPublishers
+     */
+    publishers: Array<CallStatsMapPublisher>;
+}
+/**
+ *
+ * @export
+ * @interface CallStatsMapSFUs
+ */
+export interface CallStatsMapSFUs {
+    /**
+     *
+     * @type {Array<SFULocationResponse>}
+     * @memberof CallStatsMapSFUs
+     */
+    locations: Array<SFULocationResponse>;
+}
+/**
+ *
+ * @export
+ * @interface CallStatsMapSubscriber
+ */
+export interface CallStatsMapSubscriber {
+    /**
+     *
+     * @type {boolean}
+     * @memberof CallStatsMapSubscriber
+     */
+    is_live: boolean;
+    /**
+     *
+     * @type {CallStatsLocation}
+     * @memberof CallStatsMapSubscriber
+     */
+    location?: CallStatsLocation;
+    /**
+     *
+     * @type {string}
+     * @memberof CallStatsMapSubscriber
+     */
+    name?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CallStatsMapSubscriber
+     */
+    user_id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CallStatsMapSubscriber
+     */
+    user_session_id: string;
+}
+/**
+ *
+ * @export
+ * @interface CallStatsMapSubscribers
+ */
+export interface CallStatsMapSubscribers {
+    /**
+     *
+     * @type {Array<CallStatsMapLocation>}
+     * @memberof CallStatsMapSubscribers
+     */
+    locations: Array<CallStatsMapLocation>;
+    /**
+     *
+     * @type {Array<CallStatsMapSubscriber>}
+     * @memberof CallStatsMapSubscribers
+     */
+    participants?: Array<CallStatsMapSubscriber>;
+}
 /**
  *
  * @export
@@ -3452,6 +3620,25 @@ export interface ConnectionErrorEvent {
      */
     type: string;
 }
+/**
+ *
+ * @export
+ * @interface Coordinates
+ */
+export interface Coordinates {
+    /**
+     *
+     * @type {number}
+     * @memberof Coordinates
+     */
+    latitude: number;
+    /**
+     *
+     * @type {number}
+     * @memberof Coordinates
+     */
+    longitude: number;
+}
 /**
  *
  * @export
@@ -4008,6 +4195,88 @@ export interface EndCallResponse {
      */
     duration: string;
 }
+/**
+ *
+ * @export
+ * @interface FeedsPreferencesResponse
+ */
+export interface FeedsPreferencesResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof FeedsPreferencesResponse
+     */
+    comment?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FeedsPreferencesResponse
+     */
+    comment_reaction?: string;
+    /**
+     *
+     * @type {{ [key: string]: string; }}
+     * @memberof FeedsPreferencesResponse
+     */
+    custom_activity_types?: {
+        [key: string]: string;
+    };
+    /**
+     *
+     * @type {string}
+     * @memberof FeedsPreferencesResponse
+     */
+    follow?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FeedsPreferencesResponse
+     */
+    mention?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FeedsPreferencesResponse
+     */
+    reaction?: string;
+}
+/**
+ *
+ * @export
+ * @interface FileUploadConfig
+ */
+export interface FileUploadConfig {
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof FileUploadConfig
+     */
+    allowed_file_extensions: Array<string>;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof FileUploadConfig
+     */
+    allowed_mime_types: Array<string>;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof FileUploadConfig
+     */
+    blocked_file_extensions: Array<string>;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof FileUploadConfig
+     */
+    blocked_mime_types: Array<string>;
+    /**
+     *
+     * @type {number}
+     * @memberof FileUploadConfig
+     */
+    size_limit: number;
+}
 /**
  *
  * @export
@@ -5211,6 +5480,31 @@ export interface ListTranscriptionsResponse {
      */
     transcriptions: Array<CallTranscription>;
 }
+/**
+ *
+ * @export
+ * @interface Location
+ */
+export interface Location {
+    /**
+     *
+     * @type {string}
+     * @memberof Location
+     */
+    continent_code: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Location
+     */
+    country_iso_code: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Location
+     */
+    subdivision_iso_code: string;
+}
 /**
  * MemberRequest is the payload for adding a member to a call.
  * @export
@@ -5600,10 +5894,10 @@ export interface OwnUserResponse {
     privacy_settings?: object;
     /**
      *
-     * @type {PushPreferences}
+     * @type {PushPreferencesResponse}
      * @memberof OwnUserResponse
      */
-    push_preferences?: PushPreferences;
+    push_preferences?: PushPreferencesResponse;
     /**
      *
      * @type {string}
@@ -6160,27 +6454,39 @@ export interface PublisherStatsResponse {
 /**
  *
  * @export
- * @interface PushPreferences
+ * @interface PushPreferencesResponse
  */
-export interface PushPreferences {
+export interface PushPreferencesResponse {
     /**
      *
      * @type {string}
-     * @memberof PushPreferences
+     * @memberof PushPreferencesResponse
      */
     call_level?: string;
     /**
      *
      * @type {string}
-     * @memberof PushPreferences
+     * @memberof PushPreferencesResponse
      */
     chat_level?: string;
     /**
      *
      * @type {string}
-     * @memberof PushPreferences
+     * @memberof PushPreferencesResponse
      */
     disabled_until?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PushPreferencesResponse
+     */
+    feeds_level?: string;
+    /**
+     *
+     * @type {FeedsPreferencesResponse}
+     * @memberof PushPreferencesResponse
+     */
+    feeds_preferences?: FeedsPreferencesResponse;
 }
 /**
  *
@@ -6556,6 +6862,97 @@ export interface QueryCallSessionParticipantStatsTimelineResponse {
      */
     user_session_id: string;
 }
+/**
+ * Basic response information
+ * @export
+ * @interface QueryCallStatsMapResponse
+ */
+export interface QueryCallStatsMapResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof QueryCallStatsMapResponse
+     */
+    call_ended_at?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QueryCallStatsMapResponse
+     */
+    call_id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QueryCallStatsMapResponse
+     */
+    call_session_id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QueryCallStatsMapResponse
+     */
+    call_started_at?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QueryCallStatsMapResponse
+     */
+    call_type: string;
+    /**
+     *
+     * @type {CallStatsParticipantCounts}
+     * @memberof QueryCallStatsMapResponse
+     */
+    counts: CallStatsParticipantCounts;
+    /**
+     *
+     * @type {string}
+     * @memberof QueryCallStatsMapResponse
+     */
+    data_source?: string;
+    /**
+     * Duration of the request in milliseconds
+     * @type {string}
+     * @memberof QueryCallStatsMapResponse
+     */
+    duration: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QueryCallStatsMapResponse
+     */
+    end_time?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QueryCallStatsMapResponse
+     */
+    generated_at?: string;
+    /**
+     *
+     * @type {CallStatsMapPublishers}
+     * @memberof QueryCallStatsMapResponse
+     */
+    publishers?: CallStatsMapPublishers;
+    /**
+     *
+     * @type {CallStatsMapSFUs}
+     * @memberof QueryCallStatsMapResponse
+     */
+    sfus?: CallStatsMapSFUs;
+    /**
+     *
+     * @type {string}
+     * @memberof QueryCallStatsMapResponse
+     */
+    start_time?: string;
+    /**
+     *
+     * @type {CallStatsMapSubscribers}
+     * @memberof QueryCallStatsMapResponse
+     */
+    subscribers?: CallStatsMapSubscribers;
+}
 /**
  *
  * @export
@@ -7237,6 +7634,37 @@ export interface SDKUsageReportResponse {
      */
     daily: Array<DailyAggregateSDKUsageReportResponse>;
 }
+/**
+ *
+ * @export
+ * @interface SFULocationResponse
+ */
+export interface SFULocationResponse {
+    /**
+     *
+     * @type {Coordinates}
+     * @memberof SFULocationResponse
+     */
+    coordinates: Coordinates;
+    /**
+     *
+     * @type {string}
+     * @memberof SFULocationResponse
+     */
+    datacenter: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SFULocationResponse
+     */
+    id: string;
+    /**
+     *
+     * @type {Location}
+     * @memberof SFULocationResponse
+     */
+    location: Location;
+}
 /**
  *
  * @export
@@ -7487,6 +7915,12 @@ export interface SIPInboundRoutingRuleResponse {
      * @memberof SIPInboundRoutingRuleResponse
      */
     caller_numbers?: Array<string>;
+    /**
+     * Creation timestamp
+     * @type {string}
+     * @memberof SIPInboundRoutingRuleResponse
+     */
+    created_at: string;
     /**
      *
      * @type {SIPDirectRoutingRuleCallConfigsResponse}
@@ -7530,11 +7964,11 @@ export interface SIPInboundRoutingRuleResponse {
      */
     trunk_ids: Array<string>;
     /**
-     *
-     * @type {object}
+     * Last update timestamp
+     * @type {string}
      * @memberof SIPInboundRoutingRuleResponse
      */
-    updated_at: object;
+    updated_at: string;
 }
 /**
  * PIN protection configuration response
@@ -7574,11 +8008,11 @@ export interface SIPPinProtectionConfigsResponse {
  */
 export interface SIPTrunkResponse {
     /**
-     *
-     * @type {object}
+     * Creation timestamp
+     * @type {string}
      * @memberof SIPTrunkResponse
      */
-    created_at: object;
+    created_at: string;
     /**
      * Unique identifier for the SIP trunk
      * @type {string}
@@ -7604,11 +8038,11 @@ export interface SIPTrunkResponse {
      */
     password: string;
     /**
-     *
-     * @type {object}
+     * Last update timestamp
+     * @type {string}
      * @memberof SIPTrunkResponse
      */
-    updated_at: object;
+    updated_at: string;
     /**
      * The URI for the SIP trunk
      * @type {string}

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

@@ -5,7 +5,9 @@ import type { Trace } from '../stats';
 import type { ScopedLogger } from '../logger';
 import type { LogLevel } from '@stream-io/logger';
 export declare const withHeaders: (headers: Record<string, string>) => RpcInterceptor;
-export declare const withRequestLogger: (logger: ScopedLogger, level: LogLevel) => RpcInterceptor;
+export declare const TIMEOUT_SYMBOL = "@@stream-io/timeout";
+export declare const withTimeout: (timeoutMs: number, trace?: Trace) => RpcInterceptor;
+export declare const withRequestLogger: (logger: ScopedLogger, level?: LogLevel) => RpcInterceptor;
 export declare const withRequestTracer: (trace: Trace) => RpcInterceptor;
 /**
  * Creates new SignalServerClient instance.

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

@@ -1,5 +1,6 @@
 import { FinishedUnaryCall, UnaryCall } from '@protobuf-ts/runtime-rpc';
 import { Error as SfuError } from '../gen/video/sfu/models/models';
+import type { RpcInvocationMeta } from './types';
 /**
  * An internal interface which asserts that "retryable" SFU responses
  * contain a field called "error".
@@ -19,5 +20,6 @@ export interface SfuResponseWithError {
  *
  * @param rpc the closure around the RPC call to execute.
  * @param signal the signal to abort the RPC call and retries loop.
+ * @param maxRetries the maximum number of retries to perform. Defaults to `Number.POSITIVE_INFINITY`.
  */
-export declare const retryable: <I extends object, O extends SfuResponseWithError>(rpc: () => UnaryCall<I, O>, signal?: AbortSignal) => Promise<FinishedUnaryCall<I, O>>;
+export declare const retryable: <I extends object, O extends SfuResponseWithError>(rpc: (invocationMeta: RpcInvocationMeta) => UnaryCall<I, O>, signal?: AbortSignal, maxRetries?: number) => Promise<FinishedUnaryCall<I, O>>;

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

@@ -0,0 +1,8 @@
+export type RpcInvocationMeta = {
+    attempt: number;
+};
+declare module '@protobuf-ts/runtime-rpc' {
+    interface RpcOptions {
+        invocationMeta?: RpcInvocationMeta;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stream-io/video-client",
-  "version": "1.39.2",
+  "version": "1.40.0",
   "main": "dist/index.cjs.js",
   "module": "dist/index.es.js",
   "browser": "dist/index.browser.es.js",