@stream-io/video-client 0.6.7 → 0.6.9

package/dist/src/Call.d.ts

@@ -1,7 +1,7 @@
 import { Publisher, Subscriber } from './rtc';
 import { TrackType } from './gen/video/sfu/models/models';
 import { CallState } from './store';
-import { AcceptCallResponse, BlockUserResponse, EndCallResponse, GetCallResponse, GetCallStatsResponse, GetOrCreateCallRequest, GetOrCreateCallResponse, GoLiveRequest, GoLiveResponse, ListRecordingsResponse, MuteUsersResponse, PinRequest, PinResponse, QueryMembersRequest, QueryMembersResponse, RejectCallResponse, RequestPermissionRequest, RequestPermissionResponse, SendEventResponse, SendReactionRequest, SendReactionResponse, StartHLSBroadcastingResponse, StartRecordingRequest, StartRecordingResponse, StopHLSBroadcastingResponse, StopLiveResponse, StopRecordingResponse, UnblockUserResponse, UnpinRequest, UnpinResponse, UpdateCallMembersRequest, UpdateCallMembersResponse, UpdateCallRequest, UpdateCallResponse, UpdateUserPermissionsRequest, UpdateUserPermissionsResponse } from './gen/coordinator';
+import { AcceptCallResponse, BlockUserResponse, CollectUserFeedbackRequest, CollectUserFeedbackResponse, EndCallResponse, GetCallResponse, GetCallStatsResponse, GetOrCreateCallRequest, GetOrCreateCallResponse, GoLiveRequest, GoLiveResponse, ListRecordingsResponse, ListTranscriptionsResponse, MuteUsersResponse, PinRequest, PinResponse, QueryMembersRequest, QueryMembersResponse, RejectCallResponse, RequestPermissionRequest, RequestPermissionResponse, SendEventResponse, SendReactionRequest, SendReactionResponse, StartHLSBroadcastingResponse, StartRecordingRequest, StartRecordingResponse, StartTranscriptionRequest, StartTranscriptionResponse, StopHLSBroadcastingResponse, StopLiveResponse, StopRecordingResponse, StopTranscriptionResponse, UnblockUserResponse, UnpinRequest, UnpinResponse, UpdateCallMembersRequest, UpdateCallMembersResponse, UpdateCallRequest, UpdateCallResponse, UpdateUserPermissionsRequest, UpdateUserPermissionsResponse } from './gen/coordinator';
 import { AudioTrackType, CallConstructor, CallLeaveOptions, DebounceType, JoinCallData, PublishOptions, SubscriptionChanges, TrackMuteType, VideoTrackType } from './types';
 import { VideoLayerSetting } from './gen/video/sfu/event/events';
 import { DynascaleManager } from './helpers/DynascaleManager';
@@ -320,6 +320,16 @@ export declare class Call {
      * Stops recording the call
      */
     stopRecording: () => Promise<StopRecordingResponse>;
+    /**
+     * Starts the transcription of the call.
+     *
+     * @param request the request data.
+     */
+    startTranscription: (request?: StartTranscriptionRequest) => Promise<StartTranscriptionResponse>;
+    /**
+     * Stops the transcription of the call.
+     */
+    stopTranscription: () => Promise<StopTranscriptionResponse>;
     /**
      * Sends a `call.permission_request` event to all users connected to the call. The call settings object contains infomration about which permissions can be requested during a call (for example a user might be allowed to request permission to publish audio, but not video).
      */
@@ -446,6 +456,12 @@ export declare class Call {
      * @param callSessionId the call session id to retrieve recordings for.
      */
     queryRecordings: (callSessionId?: string) => Promise<ListRecordingsResponse>;
+    /**
+     * Retrieves the list of transcriptions for the current call.
+     *
+     * @returns the list of transcriptions.
+     */
+    queryTranscriptions: () => Promise<ListTranscriptionsResponse>;
     /**
      * Retrieve call statistics for a particular call session (historical).
      * Here `callSessionID` is mandatory.
@@ -454,6 +470,12 @@ export declare class Call {
      * @returns The call stats.
      */
     getCallStats: (callSessionID: string) => Promise<GetCallStatsResponse>;
+    /**
+     * Submit feedback on call experience
+     *
+     * @returns
+     */
+    submitFeedback: (feedback: CollectUserFeedbackRequest) => Promise<CollectUserFeedbackResponse | undefined>;
     /**
      * Sends a custom event to all call participants.
      *

package/dist/src/coordinator/connection/client.d.ts

@@ -123,9 +123,9 @@ export declare class StreamClient {
             maxBodyLength?: number | undefined;
         }) | undefined;
     }) => void;
-    _logApiResponse: <T>(type: string, url: string, response: AxiosResponse<T, any>) => void;
+    _logApiResponse: <T>(type: string, url: string, response: AxiosResponse<T>) => void;
     _logApiError: (type: string, url: string, error: unknown) => void;
-    doAxiosRequest: <T, D = unknown>(type: string, url: string, data?: D | undefined, options?: AxiosRequestConfig & {
+    doAxiosRequest: <T, D = unknown>(type: string, url: string, data?: D, options?: AxiosRequestConfig & {
         config?: AxiosRequestConfig & {
             maxBodyLength?: number;
         };
@@ -133,12 +133,12 @@ export declare class StreamClient {
         publicEndpoint?: boolean;
     }) => Promise<T>;
     get: <T>(url: string, params?: AxiosRequestConfig['params']) => Promise<T>;
-    put: <T, D = unknown>(url: string, data?: D | undefined, params?: AxiosRequestConfig['params']) => Promise<T>;
-    post: <T, D = unknown>(url: string, data?: D | undefined, params?: AxiosRequestConfig['params']) => Promise<T>;
-    patch: <T, D = unknown>(url: string, data?: D | undefined, params?: AxiosRequestConfig['params']) => Promise<T>;
+    put: <T, D = unknown>(url: string, data?: D, params?: AxiosRequestConfig['params']) => Promise<T>;
+    post: <T, D = unknown>(url: string, data?: D, params?: AxiosRequestConfig['params']) => Promise<T>;
+    patch: <T, D = unknown>(url: string, data?: D, params?: AxiosRequestConfig['params']) => Promise<T>;
     delete: <T>(url: string, params?: AxiosRequestConfig['params']) => Promise<T>;
     errorFromResponse: (response: AxiosResponse<APIErrorResponse>) => ErrorFromResponse<APIErrorResponse>;
-    handleResponse: <T>(response: AxiosResponse<T, any>) => T;
+    handleResponse: <T>(response: AxiosResponse<T>) => T;
     dispatchEvent: (event: StreamVideoEvent) => void;
     /**
      * @private

package/dist/src/devices/InputMediaDeviceManager.d.ts

@@ -3,6 +3,7 @@ import { Call } from '../Call';
 import { InputMediaDeviceManagerState } from './InputMediaDeviceManagerState';
 import { Logger } from '../coordinator/connection/types';
 import { TrackType } from '../gen/video/sfu/models/models';
+export type MediaStreamFilter = (stream: MediaStream) => Promise<MediaStream>;
 export declare abstract class InputMediaDeviceManager<T extends InputMediaDeviceManagerState<C>, C = MediaTrackConstraints> {
     protected readonly call: Call;
     readonly state: T;
@@ -22,6 +23,7 @@ export declare abstract class InputMediaDeviceManager<T extends InputMediaDevice
     logger: Logger;
     private subscriptions;
     private isTrackStoppedDueToTrackEnd;
+    private filters;
     protected constructor(call: Call, state: T, trackType: TrackType);
     /**
      * Lists the available audio/video devices
@@ -49,6 +51,16 @@ export declare abstract class InputMediaDeviceManager<T extends InputMediaDevice
      * else it will disable it.
      */
     toggle(): Promise<void>;
+    /**
+     * Registers a filter that will be applied to the stream.
+     *
+     * The registered filter will get the existing stream, and it should return
+     * a new stream with the applied filter.
+     *
+     * @param filter the filter to register.
+     * @returns a function that will unregister the filter.
+     */
+    registerFilter(filter: MediaStreamFilter): Promise<() => Promise<void>>;
     /**
      * Will set the default constraints for the device.
      *
@@ -62,7 +74,12 @@ export declare abstract class InputMediaDeviceManager<T extends InputMediaDevice
      * @param deviceId the device id to select.
      */
     select(deviceId: string | undefined): Promise<void>;
-    removeSubscriptions: () => void;
+    /**
+     * Disposes the manager.
+     *
+     * @internal
+     */
+    dispose: () => void;
     protected applySettingsToStream(): Promise<void>;
     protected abstract getDevices(): Observable<MediaDeviceInfo[] | undefined>;
     protected abstract getStream(constraints: C): Promise<MediaStream>;

package/dist/src/devices/SpeakerManager.d.ts

@@ -22,7 +22,12 @@ export declare class SpeakerManager {
      * @param deviceId empty string means the system default
      */
     select(deviceId: string): void;
-    removeSubscriptions: () => void;
+    /**
+     * Disposes the manager.
+     *
+     * @internal
+     */
+    dispose: () => void;
     /**
      * Set the volume of the audio elements
      * @param volume a number between 0 and 1.

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

@@ -100,6 +100,43 @@ export interface AcceptCallResponse {
      */
     duration: string;
 }
+/**
+ *
+ * @export
+ * @interface AudioFeedbackRequest
+ */
+export interface AudioFeedbackRequest {
+    /**
+     *
+     * @type {boolean}
+     * @memberof AudioFeedbackRequest
+     */
+    cannot_hear_others?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof AudioFeedbackRequest
+     */
+    choppy?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof AudioFeedbackRequest
+     */
+    echo?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof AudioFeedbackRequest
+     */
+    others_could_not_hear_me?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof AudioFeedbackRequest
+     */
+    too_noisy?: boolean;
+}
 /**
  *
  * @export
@@ -367,6 +404,37 @@ export interface CallAcceptedEvent {
      */
     user: UserResponse;
 }
+/**
+ * CallClosedCaption represents a closed caption of a call.
+ * @export
+ * @interface CallClosedCaption
+ */
+export interface CallClosedCaption {
+    /**
+     *
+     * @type {string}
+     * @memberof CallClosedCaption
+     */
+    end_time: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CallClosedCaption
+     */
+    speaker_id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CallClosedCaption
+     */
+    start_time: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CallClosedCaption
+     */
+    text: string;
+}
 /**
  * This event is sent when a call is created. Clients receiving this event should check if the ringing
  * field is set to true and if so, show the call screen
@@ -1697,6 +1765,143 @@ export interface CallTimeline {
      */
     events: Array<CallEvent>;
 }
+/**
+ * CallTranscription represents a transcription of a call.
+ * @export
+ * @interface CallTranscription
+ */
+export interface CallTranscription {
+    /**
+     *
+     * @type {string}
+     * @memberof CallTranscription
+     */
+    end_time: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CallTranscription
+     */
+    filename: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CallTranscription
+     */
+    start_time: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CallTranscription
+     */
+    url: string;
+}
+/**
+ * This event is sent when call transcription has failed
+ * @export
+ * @interface CallTranscriptionFailedEvent
+ */
+export interface CallTranscriptionFailedEvent {
+    /**
+     *
+     * @type {string}
+     * @memberof CallTranscriptionFailedEvent
+     */
+    call_cid: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CallTranscriptionFailedEvent
+     */
+    created_at: string;
+    /**
+     * The type of event: "call.transcription_failed" in this case
+     * @type {string}
+     * @memberof CallTranscriptionFailedEvent
+     */
+    type: string;
+}
+/**
+ * This event is sent when call transcription is ready
+ * @export
+ * @interface CallTranscriptionReadyEvent
+ */
+export interface CallTranscriptionReadyEvent {
+    /**
+     *
+     * @type {string}
+     * @memberof CallTranscriptionReadyEvent
+     */
+    call_cid: string;
+    /**
+     *
+     * @type {CallTranscription}
+     * @memberof CallTranscriptionReadyEvent
+     */
+    call_transcription: CallTranscription;
+    /**
+     *
+     * @type {string}
+     * @memberof CallTranscriptionReadyEvent
+     */
+    created_at: string;
+    /**
+     * The type of event: "call.transcription_ready" in this case
+     * @type {string}
+     * @memberof CallTranscriptionReadyEvent
+     */
+    type: string;
+}
+/**
+ * This event is sent when call transcription has started
+ * @export
+ * @interface CallTranscriptionStartedEvent
+ */
+export interface CallTranscriptionStartedEvent {
+    /**
+     *
+     * @type {string}
+     * @memberof CallTranscriptionStartedEvent
+     */
+    call_cid: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CallTranscriptionStartedEvent
+     */
+    created_at: string;
+    /**
+     * The type of event: "call.transcription_started" in this case
+     * @type {string}
+     * @memberof CallTranscriptionStartedEvent
+     */
+    type: string;
+}
+/**
+ * This event is sent when call transcription has stopped
+ * @export
+ * @interface CallTranscriptionStoppedEvent
+ */
+export interface CallTranscriptionStoppedEvent {
+    /**
+     *
+     * @type {string}
+     * @memberof CallTranscriptionStoppedEvent
+     */
+    call_cid: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CallTranscriptionStoppedEvent
+     */
+    created_at: string;
+    /**
+     * The type of event: "call.transcription_stopped" in this case
+     * @type {string}
+     * @memberof CallTranscriptionStoppedEvent
+     */
+    type: string;
+}
 /**
  *
  * @export
@@ -1819,6 +2024,99 @@ export interface CallUserMuted {
      */
     type: string;
 }
+/**
+ *
+ * @export
+ * @interface CollectUserFeedbackRequest
+ */
+export interface CollectUserFeedbackRequest {
+    /**
+     *
+     * @type {AudioFeedbackRequest}
+     * @memberof CollectUserFeedbackRequest
+     */
+    audio?: AudioFeedbackRequest;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CollectUserFeedbackRequest
+     */
+    cannot_join_call?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof CollectUserFeedbackRequest
+     */
+    other?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof CollectUserFeedbackRequest
+     */
+    rating?: number;
+    /**
+     *
+     * @type {ScreenshareFeedbackRequest}
+     * @memberof CollectUserFeedbackRequest
+     */
+    screenshare?: ScreenshareFeedbackRequest;
+    /**
+     *
+     * @type {string}
+     * @memberof CollectUserFeedbackRequest
+     */
+    user_session_id?: string;
+    /**
+     *
+     * @type {VideoFeedbackRequest}
+     * @memberof CollectUserFeedbackRequest
+     */
+    video?: VideoFeedbackRequest;
+}
+/**
+ *
+ * @export
+ * @interface CollectUserFeedbackResponse
+ */
+export interface CollectUserFeedbackResponse {
+    /**
+     * Duration of the request in human-readable format
+     * @type {string}
+     * @memberof CollectUserFeedbackResponse
+     */
+    duration: string;
+}
+/**
+ * This event is sent when closed captions are being sent in a call, clients should use this to show the closed captions in the call screen
+ * @export
+ * @interface ClosedCaptionEvent
+ */
+export interface ClosedCaptionEvent {
+    /**
+     *
+     * @type {string}
+     * @memberof ClosedCaptionEvent
+     */
+    call_cid: string;
+    /**
+     *
+     * @type {CallClosedCaption}
+     * @memberof ClosedCaptionEvent
+     */
+    closed_caption: CallClosedCaption;
+    /**
+     *
+     * @type {string}
+     * @memberof ClosedCaptionEvent
+     */
+    created_at: string;
+    /**
+     * The type of event: "call.closed_caption" in this case
+     * @type {string}
+     * @memberof ClosedCaptionEvent
+     */
+    type: string;
+}
 /**
  *
  * @export
@@ -1845,6 +2143,12 @@ export interface ConnectUserDetailsRequest {
      * @memberof ConnectUserDetailsRequest
      */
     image?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConnectUserDetailsRequest
+     */
+    language?: string;
     /**
      *
      * @type {string}
@@ -2726,6 +3030,12 @@ export interface GoLiveRequest {
      * @memberof GoLiveRequest
      */
     start_transcription?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof GoLiveRequest
+     */
+    transcription_storage_name?: string;
 }
 /**
  *
@@ -3109,6 +3419,25 @@ export interface ListRecordingsResponse {
      */
     recordings: Array<CallRecording>;
 }
+/**
+ *
+ * @export
+ * @interface ListTranscriptionsResponse
+ */
+export interface ListTranscriptionsResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof ListTranscriptionsResponse
+     */
+    duration: string;
+    /**
+     *
+     * @type {Array<CallTranscription>}
+     * @memberof ListTranscriptionsResponse
+     */
+    transcriptions: Array<CallTranscription>;
+}
 /**
  *
  * @export
@@ -4014,6 +4343,37 @@ export interface SFUResponse {
      */
     ws_endpoint: string;
 }
+/**
+ *
+ * @export
+ * @interface ScreenshareFeedbackRequest
+ */
+export interface ScreenshareFeedbackRequest {
+    /**
+     *
+     * @type {boolean}
+     * @memberof ScreenshareFeedbackRequest
+     */
+    blurry?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ScreenshareFeedbackRequest
+     */
+    could_not_present?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ScreenshareFeedbackRequest
+     */
+    could_not_see?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ScreenshareFeedbackRequest
+     */
+    slow_to_update?: boolean;
+}
 /**
  *
  * @export
@@ -4190,6 +4550,19 @@ export interface StartRecordingResponse {
      */
     duration: string;
 }
+/**
+ *
+ * @export
+ * @interface StartTranscriptionRequest
+ */
+export interface StartTranscriptionRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof StartTranscriptionRequest
+     */
+    transcription_external_storage?: string;
+}
 /**
  *
  * @export
@@ -4395,7 +4768,13 @@ export interface TranscriptionSettings {
      */
     closed_caption_mode: string;
     /**
-     *
+     * omitempty,max=2,dive,oneof= en, fr, es, de, it, nl, pt, pl, ca, cs, da, el, fi, id, ja, ru, sv, ta, th, tr, hu, ro, zh, ar, tl, he, hi, hr, ko, ms, no, uk
+     * @type {Array<string>}
+     * @memberof TranscriptionSettings
+     */
+    languages: Array<string>;
+    /**
+     * oneof=available disabled auto-on
      * @type {string}
      * @memberof TranscriptionSettings
      */
@@ -4423,7 +4802,13 @@ export interface TranscriptionSettingsRequest {
      */
     closed_caption_mode?: string;
     /**
-     *
+     * omitempty,max=2,dive,oneof= en, fr, es, de, it, nl, pt, pl, ca, cs, da, el, fi, id, ja, ru, sv, ta, th, tr, hu, ro, zh, ar, tl, he, hi, hr, ko, ms, no, uk
+     * @type {Array<string>}
+     * @memberof TranscriptionSettingsRequest
+     */
+    languages?: Array<string>;
+    /**
+     * oneof=available disabled auto-on
      * @type {string}
      * @memberof TranscriptionSettingsRequest
      */
@@ -5020,6 +5405,8 @@ export type VideoEvent = ({
 } & CallAcceptedEvent) | ({
     type: 'call.blocked_user';
 } & BlockedUserEvent) | ({
+    type: 'call.closed_caption';
+} & ClosedCaptionEvent) | ({
     type: 'call.created';
 } & CallCreatedEvent) | ({
     type: 'call.ended';
@@ -5068,6 +5455,14 @@ export type VideoEvent = ({
 } & CallSessionParticipantLeftEvent) | ({
     type: 'call.session_started';
 } & CallSessionStartedEvent) | ({
+    type: 'call.transcription_failed';
+} & CallTranscriptionFailedEvent) | ({
+    type: 'call.transcription_ready';
+} & CallTranscriptionReadyEvent) | ({
+    type: 'call.transcription_started';
+} & CallTranscriptionStartedEvent) | ({
+    type: 'call.transcription_stopped';
+} & CallTranscriptionStoppedEvent) | ({
     type: 'call.unblocked_user';
 } & UnblockedUserEvent) | ({
     type: 'call.updated';
@@ -5082,6 +5477,43 @@ export type VideoEvent = ({
 } & CustomVideoEvent) | ({
     type: 'health.check';
 } & HealthCheckEvent);
+/**
+ *
+ * @export
+ * @interface VideoFeedbackRequest
+ */
+export interface VideoFeedbackRequest {
+    /**
+     *
+     * @type {boolean}
+     * @memberof VideoFeedbackRequest
+     */
+    blurry?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof VideoFeedbackRequest
+     */
+    camera_not_working?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof VideoFeedbackRequest
+     */
+    could_not_see_others?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof VideoFeedbackRequest
+     */
+    freezing?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof VideoFeedbackRequest
+     */
+    video_audio_out_of_sync?: boolean;
+}
 /**
  *
  * @export

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

@@ -1,3 +1,4 @@
+/// <reference types="ws" />
 import WebSocket from 'isomorphic-ws';
 import { DispatchableMessage, SfuEventKinds } from './Dispatcher';
 export declare const createWebSocketSignalChannel: (opts: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stream-io/video-client",
-  "version": "0.6.7",
+  "version": "0.6.9",
   "packageManager": "yarn@3.2.4",
   "main": "dist/index.cjs.js",
   "module": "dist/index.es.js",
@@ -44,8 +44,8 @@
   },
   "devDependencies": {
     "@openapitools/openapi-generator-cli": "^2.7.0",
-    "@rollup/plugin-replace": "^5.0.4",
-    "@rollup/plugin-typescript": "^11.1.5",
+    "@rollup/plugin-replace": "^5.0.5",
+    "@rollup/plugin-typescript": "^11.1.6",
     "@types/jsonwebtoken": "^9.0.3",
     "@types/sdp-transform": "^2.4.7",
     "@types/ua-parser-js": "^0.7.37",
@@ -55,7 +55,7 @@
     "prettier": "^2.8.8",
     "rimraf": "^5.0.5",
     "rollup": "^3.29.4",
-    "typescript": "^5.2.2",
+    "typescript": "^5.4.3",
     "vite": "^4.4.11",
     "vitest": "^0.34.4",
     "vitest-mock-extended": "^1.2.1"