@stream-io/video-client 1.13.0 → 1.14.0

package/dist/index.cjs.js

@@ -77,6 +77,48 @@ const ChannelConfigWithInfoBlocklistBehaviorEnum = {
     BLOCK: 'block',
     SHADOW_BLOCK: 'shadow_block',
 };
+/**
+ * All possibility of string to use
+ * @export
+ */
+const ChannelOwnCapability = {
+    BAN_CHANNEL_MEMBERS: 'ban-channel-members',
+    CAST_POLL_VOTE: 'cast-poll-vote',
+    CONNECT_EVENTS: 'connect-events',
+    CREATE_ATTACHMENT: 'create-attachment',
+    CREATE_CALL: 'create-call',
+    DELETE_ANY_MESSAGE: 'delete-any-message',
+    DELETE_CHANNEL: 'delete-channel',
+    DELETE_OWN_MESSAGE: 'delete-own-message',
+    FLAG_MESSAGE: 'flag-message',
+    FREEZE_CHANNEL: 'freeze-channel',
+    JOIN_CALL: 'join-call',
+    JOIN_CHANNEL: 'join-channel',
+    LEAVE_CHANNEL: 'leave-channel',
+    MUTE_CHANNEL: 'mute-channel',
+    PIN_MESSAGE: 'pin-message',
+    QUERY_POLL_VOTES: 'query-poll-votes',
+    QUOTE_MESSAGE: 'quote-message',
+    READ_EVENTS: 'read-events',
+    SEARCH_MESSAGES: 'search-messages',
+    SEND_CUSTOM_EVENTS: 'send-custom-events',
+    SEND_LINKS: 'send-links',
+    SEND_MESSAGE: 'send-message',
+    SEND_POLL: 'send-poll',
+    SEND_REACTION: 'send-reaction',
+    SEND_REPLY: 'send-reply',
+    SEND_TYPING_EVENTS: 'send-typing-events',
+    SET_CHANNEL_COOLDOWN: 'set-channel-cooldown',
+    SKIP_SLOW_MODE: 'skip-slow-mode',
+    SLOW_MODE: 'slow-mode',
+    TYPING_EVENTS: 'typing-events',
+    UPDATE_ANY_MESSAGE: 'update-any-message',
+    UPDATE_CHANNEL: 'update-channel',
+    UPDATE_CHANNEL_MEMBERS: 'update-channel-members',
+    UPDATE_OWN_MESSAGE: 'update-own-message',
+    UPDATE_THREAD: 'update-thread',
+    UPLOAD_FILE: 'upload-file',
+};
 /**
  * @export
  */
@@ -116,9 +158,11 @@ const OwnCapability = {
     SEND_AUDIO: 'send-audio',
     SEND_VIDEO: 'send-video',
     START_BROADCAST_CALL: 'start-broadcast-call',
+    START_CLOSED_CAPTIONS_CALL: 'start-closed-captions-call',
     START_RECORD_CALL: 'start-record-call',
     START_TRANSCRIPTION_CALL: 'start-transcription-call',
     STOP_BROADCAST_CALL: 'stop-broadcast-call',
+    STOP_CLOSED_CAPTIONS_CALL: 'stop-closed-captions-call',
     STOP_RECORD_CALL: 'stop-record-call',
     STOP_TRANSCRIPTION_CALL: 'stop-transcription-call',
     UPDATE_CALL: 'update-call',
@@ -149,6 +193,14 @@ const RecordSettingsRequestQualityEnum = {
     PORTRAIT_1080X1920: 'portrait-1080x1920',
     PORTRAIT_1440X2560: 'portrait-1440x2560',
 };
+/**
+ * @export
+ */
+const TranscriptionSettingsRequestClosedCaptionModeEnum = {
+    AVAILABLE: 'available',
+    DISABLED: 'disabled',
+    AUTO_ON: 'auto-on',
+};
 /**
  * @export
  */
@@ -157,6 +209,14 @@ const TranscriptionSettingsRequestModeEnum = {
     DISABLED: 'disabled',
     AUTO_ON: 'auto-on',
 };
+/**
+ * @export
+ */
+const TranscriptionSettingsResponseClosedCaptionModeEnum = {
+    AVAILABLE: 'available',
+    DISABLED: 'disabled',
+    AUTO_ON: 'auto-on',
+};
 /**
  * @export
  */
@@ -3320,7 +3380,7 @@ const retryable = async (rpc, signal) => {
     return result;
 };
 
-const version = "1.13.0";
+const version = "1.14.0";
 const [major, minor, patch] = version.split('.');
 let sdkInfo = {
     type: SdkType.PLAIN_JAVASCRIPT,
@@ -3331,7 +3391,7 @@ let sdkInfo = {
 let osInfo;
 let deviceInfo;
 let webRtcInfo;
-let deviceState;
+let deviceState = { oneofKind: undefined };
 const setSdkInfo = (info) => {
     sdkInfo = info;
 };
@@ -4122,6 +4182,24 @@ const setCurrentValue = (subject, update) => {
     subject.next(next);
     return next;
 };
+/**
+ * Updates the value of the provided Subject and returns the previous value
+ * and a function to roll back the update.
+ * This is useful when you want to optimistically update a value
+ * and roll back the update if an error occurs.
+ *
+ * @param subject the subject to update.
+ * @param update the update to apply to the subject.
+ */
+const updateValue = (subject, update) => {
+    const lastValue = subject.getValue();
+    const value = setCurrentValue(subject, update);
+    return {
+        lastValue,
+        value,
+        rollback: () => setCurrentValue(subject, lastValue),
+    };
+};
 /**
  * Creates a subscription and returns a function to unsubscribe.
  *
@@ -4155,7 +4233,8 @@ var rxUtils = /*#__PURE__*/Object.freeze({
     createSafeAsyncSubscription: createSafeAsyncSubscription,
     createSubscription: createSubscription,
     getCurrentValue: getCurrentValue,
-    setCurrentValue: setCurrentValue
+    setCurrentValue: setCurrentValue,
+    updateValue: updateValue
 });
 
 /**
@@ -4602,6 +4681,7 @@ class CallState {
         this.sessionSubject = new rxjs.BehaviorSubject(undefined);
         this.settingsSubject = new rxjs.BehaviorSubject(undefined);
         this.transcribingSubject = new rxjs.BehaviorSubject(false);
+        this.captioningSubject = new rxjs.BehaviorSubject(false);
         this.endedBySubject = new rxjs.BehaviorSubject(undefined);
         this.thumbnailsSubject = new rxjs.BehaviorSubject(undefined);
         this.membersSubject = new rxjs.BehaviorSubject([]);
@@ -4612,6 +4692,7 @@ class CallState {
         this.anonymousParticipantCountSubject = new rxjs.BehaviorSubject(0);
         this.participantsSubject = new rxjs.BehaviorSubject([]);
         this.callStatsReportSubject = new rxjs.BehaviorSubject(undefined);
+        this.closedCaptionsSubject = new rxjs.BehaviorSubject([]);
         // These are tracks that were delivered to the Subscriber's onTrack event
         // that we couldn't associate with a participant yet.
         // This happens when the participantJoined event hasn't been received yet.
@@ -4620,10 +4701,18 @@ class CallState {
         this.logger = getLogger(['CallState']);
         /**
          * A list of comparators that are used to sort the participants.
-         *
-         * @private
          */
         this.sortParticipantsBy = defaultSortPreset;
+        this.closedCaptionsTasks = new Map();
+        /**
+         * Runs the cleanup tasks.
+         */
+        this.dispose = () => {
+            for (const [ccKey, taskId] of this.closedCaptionsTasks.entries()) {
+                clearTimeout(taskId);
+                this.closedCaptionsTasks.delete(ccKey);
+            }
+        };
         /**
          * Sets the list of criteria that are used to sort the participants.
          * To disable sorting, you can pass `noopComparator()`.
@@ -4672,6 +4761,15 @@ class CallState {
         this.setStartedAt = (startedAt) => {
             return this.setCurrentValue(this.startedAtSubject, startedAt);
         };
+        /**
+         * Sets the closed captioning state of the current call.
+         *
+         * @internal
+         * @param captioning the closed captioning state.
+         */
+        this.setCaptioning = (captioning) => {
+            return updateValue(this.captioningSubject, captioning);
+        };
         /**
          * Sets the number of anonymous participants in the current call.
          *
@@ -4770,7 +4868,6 @@ class CallState {
             }
             const thePatch = typeof patch === 'function' ? patch(participant) : patch;
             const updatedParticipant = {
-                // FIXME OL: this is not a deep merge, we might want to revisit this
                 ...participant,
                 ...thePatch,
             };
@@ -4832,7 +4929,6 @@ class CallState {
          *
          * @param trackType the kind of subscription to update.
          * @param changes the list of subscription changes to do.
-         * @param type the debounce type to use for the update.
          */
         this.updateParticipantTracks = (trackType, changes) => {
             return this.updateParticipants(Object.entries(changes).reduce((acc, [sessionId, change]) => {
@@ -4935,6 +5031,14 @@ class CallState {
             }
             return orphans;
         };
+        /**
+         * Updates the closed captions settings.
+         *
+         * @param config the new closed captions settings.
+         */
+        this.updateClosedCaptionSettings = (config) => {
+            this.closedCaptionsSettings = { ...this.closedCaptionsSettings, ...config };
+        };
         /**
          * Updates the call state with the data received from the server.
          *
@@ -4958,6 +5062,7 @@ class CallState {
             this.updateParticipantCountFromSession(s);
             this.setCurrentValue(this.settingsSubject, call.settings);
             this.setCurrentValue(this.transcribingSubject, call.transcribing);
+            this.setCurrentValue(this.captioningSubject, call.captioning);
             this.setCurrentValue(this.thumbnailsSubject, call.thumbnails);
         };
         /**
@@ -5149,6 +5254,35 @@ class CallState {
                 this.setCurrentValue(this.ownCapabilitiesSubject, event.own_capabilities);
             }
         };
+        this.updateFromClosedCaptions = (event) => {
+            this.setCurrentValue(this.closedCaptionsSubject, (queue) => {
+                const { closed_caption } = event;
+                const keyOf = (c) => `${c.speaker_id}/${c.start_time}`;
+                const currentKey = keyOf(closed_caption);
+                const duplicate = queue.some((caption) => keyOf(caption) === currentKey);
+                if (duplicate)
+                    return queue;
+                const nextQueue = [...queue, closed_caption];
+                const { visibilityDurationMs = 2700, maxVisibleCaptions = 2 } = this.closedCaptionsSettings || {};
+                // schedule the removal of the closed caption after the retention time
+                if (visibilityDurationMs > 0) {
+                    const taskId = setTimeout(() => {
+                        this.setCurrentValue(this.closedCaptionsSubject, (captions) => captions.filter((caption) => caption !== closed_caption));
+                        this.closedCaptionsTasks.delete(currentKey);
+                    }, visibilityDurationMs);
+                    this.closedCaptionsTasks.set(currentKey, taskId);
+                    // cancel the cleanup tasks for the closed captions that are no longer in the queue
+                    for (let i = 0; i < nextQueue.length - maxVisibleCaptions; i++) {
+                        const key = keyOf(nextQueue[i]);
+                        const task = this.closedCaptionsTasks.get(key);
+                        clearTimeout(task);
+                        this.closedCaptionsTasks.delete(key);
+                    }
+                }
+                // trim the queue
+                return nextQueue.slice(-maxVisibleCaptions);
+            });
+        };
         this.participants$ = this.participantsSubject.asObservable().pipe(
         // maintain stable-sort by mutating the participants stored
         // in the original subject
@@ -5175,6 +5309,7 @@ class CallState {
         this.settings$ = this.settingsSubject.asObservable();
         this.endedBy$ = this.endedBySubject.asObservable();
         this.thumbnails$ = this.thumbnailsSubject.asObservable();
+        this.closedCaptions$ = this.closedCaptionsSubject.asObservable();
         /**
          * Performs shallow comparison of two arrays.
          * Expects primitive values: [1, 2, 3] is equal to [2, 1, 3].
@@ -5204,9 +5339,9 @@ class CallState {
         this.participantCount$ = duc(this.participantCountSubject);
         this.recording$ = duc(this.recordingSubject);
         this.transcribing$ = duc(this.transcribingSubject);
+        this.captioning$ = duc(this.captioningSubject);
         this.eventHandlers = {
             // these events are not updating the call state:
-            'call.closed_caption': undefined,
             'call.deleted': undefined,
             'call.permission_request': undefined,
             'call.recording_ready': undefined,
@@ -5227,6 +5362,16 @@ class CallState {
             // events that update call state:
             'call.accepted': (e) => this.updateFromCallResponse(e.call),
             'call.blocked_user': this.blockUser,
+            'call.closed_caption': this.updateFromClosedCaptions,
+            'call.closed_captions_failed': () => {
+                this.setCurrentValue(this.captioningSubject, false);
+            },
+            'call.closed_captions_started': () => {
+                this.setCurrentValue(this.captioningSubject, true);
+            },
+            'call.closed_captions_stopped': () => {
+                this.setCurrentValue(this.captioningSubject, false);
+            },
             'call.created': (e) => this.updateFromCallResponse(e.call),
             'call.ended': (e) => {
                 this.updateFromCallResponse(e.call);
@@ -5284,6 +5429,12 @@ class CallState {
     get startedAt() {
         return this.getCurrentValue(this.startedAt$);
     }
+    /**
+     * Returns whether closed captions are enabled in the current call.
+     */
+    get captioning() {
+        return this.getCurrentValue(this.captioning$);
+    }
     /**
      * The server-side counted number of anonymous participants connected to the current call.
      * This number includes the anonymous participants as well.
@@ -5447,6 +5598,12 @@ class CallState {
     get thumbnails() {
         return this.getCurrentValue(this.thumbnails$);
     }
+    /**
+     * Returns the current queue of closed captions.
+     */
+    get closedCaptions() {
+        return this.getCurrentValue(this.closedCaptions$);
+    }
 }
 
 const getRtpMap = (line) => {
@@ -10224,6 +10381,7 @@ class Call {
                 this.sfuClient = undefined;
                 this.dynascaleManager.setSfuClient(undefined);
                 this.state.setCallingState(exports.CallingState.LEFT);
+                this.state.dispose();
                 // Call all leave call hooks, e.g. to clean up global event handlers
                 this.leaveCallHooks.forEach((hook) => hook());
                 this.initialized = false;
@@ -11181,7 +11339,43 @@ class Call {
             return this.streamClient.post(`${this.streamClientBasePath}/stop_transcription`);
         };
         /**
-         * 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).
+         * Starts the closed captions of the call.
+         */
+        this.startClosedCaptions = async (options) => {
+            const trx = this.state.setCaptioning(true); // optimistic update
+            try {
+                return await this.streamClient.post(`${this.streamClientBasePath}/start_closed_captions`, options);
+            }
+            catch (err) {
+                trx.rollback(); // revert the optimistic update
+                throw err;
+            }
+        };
+        /**
+         * Stops the closed captions of the call.
+         */
+        this.stopClosedCaptions = async (options) => {
+            const trx = this.state.setCaptioning(false); // optimistic update
+            try {
+                return await this.streamClient.post(`${this.streamClientBasePath}/stop_closed_captions`, options);
+            }
+            catch (err) {
+                trx.rollback(); // revert the optimistic update
+                throw err;
+            }
+        };
+        /**
+         * Updates the closed caption settings.
+         *
+         * @param config the closed caption settings to apply
+         */
+        this.updateClosedCaptionSettings = (config) => {
+            this.state.updateClosedCaptionSettings(config);
+        };
+        /**
+         * Sends a `call.permission_request` event to all users connected to the call.
+         * The call settings object contains information 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).
          */
         this.requestPermissions = async (data) => {
             const { permissions } = data;
@@ -12913,7 +13107,7 @@ class StreamClient {
             return await this.wsConnection.connect(this.defaultWSTimeout);
         };
         this.getUserAgent = () => {
-            const version = "1.13.0";
+            const version = "1.14.0";
             return (this.userAgent ||
                 `stream-video-javascript-client-${this.node ? 'node' : 'browser'}-${version}`);
         };
@@ -13439,6 +13633,7 @@ exports.CameraManagerState = CameraManagerState;
 exports.ChannelConfigWithInfoAutomodBehaviorEnum = ChannelConfigWithInfoAutomodBehaviorEnum;
 exports.ChannelConfigWithInfoAutomodEnum = ChannelConfigWithInfoAutomodEnum;
 exports.ChannelConfigWithInfoBlocklistBehaviorEnum = ChannelConfigWithInfoBlocklistBehaviorEnum;
+exports.ChannelOwnCapability = ChannelOwnCapability;
 exports.CreateDeviceRequestPushProviderEnum = CreateDeviceRequestPushProviderEnum;
 exports.DynascaleManager = DynascaleManager;
 exports.ErrorFromResponse = ErrorFromResponse;
@@ -13461,7 +13656,9 @@ exports.StreamSfuClient = StreamSfuClient;
 exports.StreamVideoClient = StreamVideoClient;
 exports.StreamVideoReadOnlyStateStore = StreamVideoReadOnlyStateStore;
 exports.StreamVideoWriteableStateStore = StreamVideoWriteableStateStore;
+exports.TranscriptionSettingsRequestClosedCaptionModeEnum = TranscriptionSettingsRequestClosedCaptionModeEnum;
 exports.TranscriptionSettingsRequestModeEnum = TranscriptionSettingsRequestModeEnum;
+exports.TranscriptionSettingsResponseClosedCaptionModeEnum = TranscriptionSettingsResponseClosedCaptionModeEnum;
 exports.TranscriptionSettingsResponseModeEnum = TranscriptionSettingsResponseModeEnum;
 exports.VideoSettingsRequestCameraFacingEnum = VideoSettingsRequestCameraFacingEnum;
 exports.VideoSettingsResponseCameraFacingEnum = VideoSettingsResponseCameraFacingEnum;