@stream-io/video-client 1.27.4 → 1.28.0

package/dist/src/Call.d.ts

@@ -1,6 +1,6 @@
 import { Publisher, Subscriber } from './rtc';
 import { CallState } from './store';
-import type { AcceptCallResponse, BlockUserResponse, CallRingEvent, CallSettingsResponse, CollectUserFeedbackRequest, CollectUserFeedbackResponse, DeleteCallRequest, DeleteCallResponse, EndCallResponse, GetCallReportResponse, GetCallResponse, GetOrCreateCallRequest, GetOrCreateCallResponse, GoLiveRequest, GoLiveResponse, JoinCallResponse, ListRecordingsResponse, ListTranscriptionsResponse, MuteUsersResponse, PinRequest, PinResponse, QueryCallMembersRequest, QueryCallMembersResponse, RejectCallResponse, RequestPermissionRequest, RequestPermissionResponse, 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, GetOrCreateCallRequest, GetOrCreateCallResponse, GoLiveRequest, GoLiveResponse, JoinCallResponse, KickUserRequest, KickUserResponse, ListRecordingsResponse, ListTranscriptionsResponse, MuteUsersResponse, PinRequest, PinResponse, QueryCallMembersRequest, QueryCallMembersResponse, RejectCallResponse, RequestPermissionRequest, RequestPermissionResponse, 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';
@@ -433,6 +433,11 @@ export declare class Call {
      * @param userId the id of the user to unblock.
      */
     unblockUser: (userId: string) => Promise<UnblockUserResponse>;
+    /**
+     * Kicks the user with the given `userId`.
+     * @param data the kick request.
+     */
+    kickUser: (data: KickUserRequest) => Promise<KickUserResponse>;
     /**
      * Mutes the current user.
      *

package/dist/src/StreamVideoClient.d.ts

@@ -47,6 +47,11 @@ export declare class StreamVideoClient {
      */
     get state(): StreamVideoReadOnlyStateStore;
     private registerEffects;
+    /**
+     * Initializes a call from a call created or ringing event.
+     * @param e the event.
+     */
+    private initCallFromEvent;
     /**
      * 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.
@@ -87,6 +92,7 @@ export declare class StreamVideoClient {
      *
      * @param type the type of the call.
      * @param id the id of the call.
+     * @param options additional options for call creation.
      */
     call: (type: string, id: string, options?: {
         reuseInstance?: boolean;

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

@@ -1618,6 +1618,12 @@ export interface CallReportResponse {
  * @interface CallRequest
  */
 export interface CallRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof CallRequest
+     */
+    channel_cid?: string;
     /**
      *
      * @type {{ [key: string]: any; }}
@@ -1681,6 +1687,12 @@ export interface CallResponse {
      * @memberof CallResponse
      */
     captioning: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof CallResponse
+     */
+    channel_cid?: string;
     /**
      * The unique identifier for a call (<type>:<id>)
      * @type {string}
@@ -2268,6 +2280,12 @@ export interface CallSettingsRequest {
      * @memberof CallSettingsRequest
      */
     geofencing?: GeofenceSettingsRequest;
+    /**
+     *
+     * @type {IngressSettingsRequest}
+     * @memberof CallSettingsRequest
+     */
+    ingress?: IngressSettingsRequest;
     /**
      *
      * @type {LimitsSettingsRequest}
@@ -2353,6 +2371,12 @@ export interface CallSettingsResponse {
      * @memberof CallSettingsResponse
      */
     geofencing: GeofenceSettingsResponse;
+    /**
+     *
+     * @type {IngressSettingsResponse}
+     * @memberof CallSettingsResponse
+     */
+    ingress?: IngressSettingsResponse;
     /**
      *
      * @type {LimitsSettingsResponse}
@@ -2732,6 +2756,75 @@ export interface CallUpdatedEvent {
      */
     type: string;
 }
+/**
+ * This event is sent when a user submits feedback for a call.
+ * @export
+ * @interface CallUserFeedbackSubmittedEvent
+ */
+export interface CallUserFeedbackSubmittedEvent {
+    /**
+     *
+     * @type {string}
+     * @memberof CallUserFeedbackSubmittedEvent
+     */
+    call_cid: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CallUserFeedbackSubmittedEvent
+     */
+    created_at: string;
+    /**
+     * Custom data provided by the user
+     * @type {{ [key: string]: any; }}
+     * @memberof CallUserFeedbackSubmittedEvent
+     */
+    custom?: {
+        [key: string]: any;
+    };
+    /**
+     * The rating given by the user (1-5)
+     * @type {number}
+     * @memberof CallUserFeedbackSubmittedEvent
+     */
+    rating: number;
+    /**
+     * The reason provided by the user for the rating
+     * @type {string}
+     * @memberof CallUserFeedbackSubmittedEvent
+     */
+    reason?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CallUserFeedbackSubmittedEvent
+     */
+    sdk?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CallUserFeedbackSubmittedEvent
+     */
+    sdk_version?: string;
+    /**
+     * Call session ID
+     * @type {string}
+     * @memberof CallUserFeedbackSubmittedEvent
+     */
+    session_id: string;
+    /**
+     * The type of event, "call.user_feedback" in this case
+     * @type {string}
+     * @memberof CallUserFeedbackSubmittedEvent
+     */
+    type: string;
+    /**
+     *
+     * @type {UserResponse}
+     * @memberof CallUserFeedbackSubmittedEvent
+     */
+    user: UserResponse;
+}
 /**
  * This event is sent when a call member is muted
  * @export
@@ -4059,6 +4152,226 @@ export interface ICEServer {
      */
     username: string;
 }
+/**
+ *
+ * @export
+ * @interface IngressAudioEncodingOptionsRequest
+ */
+export interface IngressAudioEncodingOptionsRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof IngressAudioEncodingOptionsRequest
+     */
+    bitrate: number;
+    /**
+     *
+     * @type {number}
+     * @memberof IngressAudioEncodingOptionsRequest
+     */
+    channels: IngressAudioEncodingOptionsRequestChannelsEnum;
+    /**
+     *
+     * @type {boolean}
+     * @memberof IngressAudioEncodingOptionsRequest
+     */
+    enable_dtx?: boolean;
+}
+/**
+ * @export
+ */
+export declare const IngressAudioEncodingOptionsRequestChannelsEnum: {
+    readonly NUMBER_1: 1;
+    readonly NUMBER_2: 2;
+};
+export type IngressAudioEncodingOptionsRequestChannelsEnum = (typeof IngressAudioEncodingOptionsRequestChannelsEnum)[keyof typeof IngressAudioEncodingOptionsRequestChannelsEnum];
+/**
+ *
+ * @export
+ * @interface IngressAudioEncodingResponse
+ */
+export interface IngressAudioEncodingResponse {
+    /**
+     *
+     * @type {number}
+     * @memberof IngressAudioEncodingResponse
+     */
+    bitrate: number;
+    /**
+     *
+     * @type {number}
+     * @memberof IngressAudioEncodingResponse
+     */
+    channels: number;
+    /**
+     *
+     * @type {boolean}
+     * @memberof IngressAudioEncodingResponse
+     */
+    enable_dtx: boolean;
+}
+/**
+ *
+ * @export
+ * @interface IngressSettingsRequest
+ */
+export interface IngressSettingsRequest {
+    /**
+     *
+     * @type {IngressAudioEncodingOptionsRequest}
+     * @memberof IngressSettingsRequest
+     */
+    audio_encoding_options?: IngressAudioEncodingOptionsRequest;
+    /**
+     *
+     * @type {boolean}
+     * @memberof IngressSettingsRequest
+     */
+    enabled?: boolean;
+    /**
+     *
+     * @type {{ [key: string]: IngressVideoEncodingOptionsRequest; }}
+     * @memberof IngressSettingsRequest
+     */
+    video_encoding_options?: {
+        [key: string]: IngressVideoEncodingOptionsRequest;
+    };
+}
+/**
+ *
+ * @export
+ * @interface IngressSettingsResponse
+ */
+export interface IngressSettingsResponse {
+    /**
+     *
+     * @type {IngressAudioEncodingResponse}
+     * @memberof IngressSettingsResponse
+     */
+    audio_encoding_options?: IngressAudioEncodingResponse;
+    /**
+     *
+     * @type {boolean}
+     * @memberof IngressSettingsResponse
+     */
+    enabled: boolean;
+    /**
+     *
+     * @type {{ [key: string]: IngressVideoEncodingResponse; }}
+     * @memberof IngressSettingsResponse
+     */
+    video_encoding_options?: {
+        [key: string]: IngressVideoEncodingResponse;
+    };
+}
+/**
+ *
+ * @export
+ * @interface IngressVideoEncodingOptionsRequest
+ */
+export interface IngressVideoEncodingOptionsRequest {
+    /**
+     *
+     * @type {Array<IngressVideoLayerRequest>}
+     * @memberof IngressVideoEncodingOptionsRequest
+     */
+    layers: Array<IngressVideoLayerRequest>;
+}
+/**
+ *
+ * @export
+ * @interface IngressVideoEncodingResponse
+ */
+export interface IngressVideoEncodingResponse {
+    /**
+     *
+     * @type {Array<IngressVideoLayerResponse>}
+     * @memberof IngressVideoEncodingResponse
+     */
+    layers: Array<IngressVideoLayerResponse>;
+}
+/**
+ *
+ * @export
+ * @interface IngressVideoLayerRequest
+ */
+export interface IngressVideoLayerRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof IngressVideoLayerRequest
+     */
+    bitrate: number;
+    /**
+     *
+     * @type {string}
+     * @memberof IngressVideoLayerRequest
+     */
+    codec: IngressVideoLayerRequestCodecEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof IngressVideoLayerRequest
+     */
+    frame_rate_limit: number;
+    /**
+     *
+     * @type {number}
+     * @memberof IngressVideoLayerRequest
+     */
+    max_dimension: number;
+    /**
+     *
+     * @type {number}
+     * @memberof IngressVideoLayerRequest
+     */
+    min_dimension: number;
+}
+/**
+ * @export
+ */
+export declare const IngressVideoLayerRequestCodecEnum: {
+    readonly H264: "h264";
+    readonly VP8: "vp8";
+};
+export type IngressVideoLayerRequestCodecEnum = (typeof IngressVideoLayerRequestCodecEnum)[keyof typeof IngressVideoLayerRequestCodecEnum];
+/**
+ *
+ * @export
+ * @interface IngressVideoLayerResponse
+ */
+export interface IngressVideoLayerResponse {
+    /**
+     *
+     * @type {number}
+     * @memberof IngressVideoLayerResponse
+     */
+    bitrate: number;
+    /**
+     *
+     * @type {string}
+     * @memberof IngressVideoLayerResponse
+     */
+    codec: string;
+    /**
+     *
+     * @type {number}
+     * @memberof IngressVideoLayerResponse
+     */
+    frame_rate_limit: number;
+    /**
+     *
+     * @type {number}
+     * @memberof IngressVideoLayerResponse
+     */
+    max_dimension: number;
+    /**
+     *
+     * @type {number}
+     * @memberof IngressVideoLayerResponse
+     */
+    min_dimension: number;
+}
 /**
  *
  * @export
@@ -4169,6 +4482,75 @@ export interface JoinCallResponse {
      */
     stats_options: StatsOptions;
 }
+/**
+ * KickUserRequest is the payload for kicking a user from a call. Optionally block the user as well.
+ * @export
+ * @interface KickUserRequest
+ */
+export interface KickUserRequest {
+    /**
+     * If true, also block the user from rejoining the call
+     * @type {boolean}
+     * @memberof KickUserRequest
+     */
+    block?: boolean;
+    /**
+     * The user to kick
+     * @type {string}
+     * @memberof KickUserRequest
+     */
+    user_id: string;
+}
+/**
+ * KickUserResponse is the payload for kicking a user from a call.
+ * @export
+ * @interface KickUserResponse
+ */
+export interface KickUserResponse {
+    /**
+     * Duration of the request in milliseconds
+     * @type {string}
+     * @memberof KickUserResponse
+     */
+    duration: string;
+}
+/**
+ * This event is sent to call participants to notify when a user is kicked from a call. Clients should make the kicked user leave the call UI.
+ * @export
+ * @interface KickedUserEvent
+ */
+export interface KickedUserEvent {
+    /**
+     *
+     * @type {string}
+     * @memberof KickedUserEvent
+     */
+    call_cid: string;
+    /**
+     *
+     * @type {string}
+     * @memberof KickedUserEvent
+     */
+    created_at: string;
+    /**
+     *
+     * @type {UserResponse}
+     * @memberof KickedUserEvent
+     */
+    kicked_by_user?: UserResponse;
+    /**
+     * The type of event: "call.kicked_user" in this case
+     * @type {string}
+     * @memberof KickedUserEvent
+     */
+    type: string;
+    /**
+     *
+     * @type {UserResponse}
+     * @memberof KickedUserEvent
+     */
+    user: UserResponse;
+}
 /**
  *
  * @export
@@ -4237,6 +4619,18 @@ export interface LimitsSettingsRequest {
      * @memberof LimitsSettingsRequest
      */
     max_participants?: number;
+    /**
+     *
+     * @type {boolean}
+     * @memberof LimitsSettingsRequest
+     */
+    max_participants_exclude_owner?: boolean;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof LimitsSettingsRequest
+     */
+    max_participants_exclude_roles?: Array<string>;
 }
 /**
  *
@@ -4256,6 +4650,18 @@ export interface LimitsSettingsResponse {
      * @memberof LimitsSettingsResponse
      */
     max_participants?: number;
+    /**
+     *
+     * @type {boolean}
+     * @memberof LimitsSettingsResponse
+     */
+    max_participants_exclude_owner?: boolean;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof LimitsSettingsResponse
+     */
+    max_participants_exclude_roles: Array<string>;
 }
 /**
  * List devices response
@@ -4528,6 +4934,7 @@ export declare const OwnCapability: {
     readonly JOIN_BACKSTAGE: "join-backstage";
     readonly JOIN_CALL: "join-call";
     readonly JOIN_ENDED_CALL: "join-ended-call";
+    readonly KICK_USER: "kick-user";
     readonly MUTE_USERS: "mute-users";
     readonly PIN_FOR_EVERYONE: "pin-for-everyone";
     readonly READ_CALL: "read-call";
@@ -4557,6 +4964,12 @@ export type OwnCapability = (typeof OwnCapability)[keyof typeof OwnCapability];
  * @interface OwnUserResponse
  */
 export interface OwnUserResponse {
+    /**
+     *
+     * @type {number}
+     * @memberof OwnUserResponse
+     */
+    avg_response_time?: number;
     /**
      *
      * @type {Array<string>}
@@ -7067,6 +7480,12 @@ export interface UserRequest {
  * @interface UserResponse
  */
 export interface UserResponse {
+    /**
+     *
+     * @type {number}
+     * @memberof UserResponse
+     */
+    avg_response_time?: number;
     /**
      *
      * @type {Array<string>}
@@ -7168,6 +7587,12 @@ export interface UserResponse {
  * @interface UserResponsePrivacyFields
  */
 export interface UserResponsePrivacyFields {
+    /**
+     *
+     * @type {number}
+     * @memberof UserResponsePrivacyFields
+     */
+    avg_response_time?: number;
     /**
      *
      * @type {Array<string>}
@@ -7352,6 +7777,8 @@ export type VideoEvent = ({
 } & CallHLSBroadcastingStartedEvent) | ({
     type: 'call.hls_broadcasting_stopped';
 } & CallHLSBroadcastingStoppedEvent) | ({
+    type: 'call.kicked_user';
+} & KickedUserEvent) | ({
     type: 'call.live_started';
 } & CallLiveStartedEvent) | ({
     type: 'call.member_added';
@@ -7418,6 +7845,8 @@ export type VideoEvent = ({
 } & UnblockedUserEvent) | ({
     type: 'call.updated';
 } & CallUpdatedEvent) | ({
+    type: 'call.user_feedback_submitted';
+} & CallUserFeedbackSubmittedEvent) | ({
     type: 'call.user_muted';
 } & CallUserMutedEvent) | ({
     type: 'connection.error';

package/dist/src/helpers/clientUtils.d.ts

@@ -5,6 +5,13 @@ import type { StreamVideoClientOptions } from '../StreamVideoClient';
  * Utility function to get the instance key.
  */
 export declare const getInstanceKey: (apiKey: string, user: User) => string;
+/**
+ * Returns a concurrency tag for call initialization.
+ * @internal
+ *
+ * @param cid the call cid.
+ */
+export declare const getCallInitConcurrencyTag: (cid: string) => string;
 /**
  * Creates a coordinator client.
  */

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

@@ -66,13 +66,6 @@ export declare class StreamVideoReadOnlyStateStore {
      * A list of {@link Call} objects created/tracked by this client.
      */
     calls$: Observable<Call[]>;
-    /**
-     * This method allows you the get the current value of a state variable.
-     *
-     * @param observable the observable to get the current value of.
-     * @returns the current value of the observable.
-     */
-    getCurrentValue: <T>(observable$: Observable<T>) => T;
     constructor(store: StreamVideoWriteableStateStore);
     /**
      * The current user connected over WS to the backend.

package/package.json

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

package/src/Call.ts

@@ -44,6 +44,8 @@ import type {
   GoLiveResponse,
   JoinCallRequest,
   JoinCallResponse,
+  KickUserRequest,
+  KickUserResponse,
   ListRecordingsResponse,
   ListTranscriptionsResponse,
   MuteUsersRequest,
@@ -1990,6 +1992,17 @@ export class Call {
     );
   };
 
+  /**
+   * Kicks the user with the given `userId`.
+   * @param data the kick request.
+   */
+  kickUser = async (data: KickUserRequest): Promise<KickUserResponse> => {
+    return this.streamClient.post<KickUserResponse, KickUserRequest>(
+      `${this.streamClientBasePath}/kick`,
+      data,
+    );
+  };
+
   /**
    * Mutes the current user.
    *