@opentok/client 2.30.1-alpha.2 → 2.30.1-alpha.4

package/dist/js/opentok.d.ts

@@ -183,6 +183,7 @@ declare namespace OT {
     creationTime: number;
     frameRate: number;
     hasAudio: boolean;
+    hasCaptions: boolean;
     hasVideo: boolean;
     initials: string;
     name: string;
@@ -521,6 +522,7 @@ declare namespace OT {
         stream: Stream;
       } & (
         { changedProperty: 'hasAudio'; oldValue: boolean; newValue: boolean; } |
+        { changedProperty: 'hasCaptions'; oldValue: boolean; newValue: boolean; } |
         { changedProperty: 'hasVideo'; oldValue: boolean; newValue: boolean; } |
         { changedProperty: 'videoDimensions'; oldValue: Dimensions; newValue: Dimensions; }
       )

package/dist/js/opentok.js

@@ -1,11 +1,11 @@
 /**
- * @license OpenTok.js 2.30.1 8989bb63b
+ * @license OpenTok.js 2.30.1 b842fa8df
  *
  * Copyright (c) 2010-2025 TokBox, Inc.
  * Subject to the applicable Software Development Kit (SDK) License Agreement:
  * https://www.vonage.com/legal/communications-apis/terms-of-use/
  *
- * Date: Thu, 15 May 2025 16:31:07 GMT
+ * Date: Wed, 28 May 2025 22:09:19 GMT
  */
 
 (function webpackUniversalModuleDefinition(root, factory) {
@@ -4169,7 +4169,7 @@ function EventsFactory(deps) {
    *
    * @class StreamPropertyChangedEvent
    * @property {String} changedProperty The property of the stream that changed. This value
-   * is either <code>"hasAudio"</code>, <code>"hasVideo"</code>, or <code>"videoDimensions"</code>.
+   * is either <code>"hasAudio"</code>, <code>"hasVideo"</code>, <code>"hasCaptions"</code>, or <code>"videoDimensions"</code>.
    * @property {Object} newValue The new value of the property (after the change).
    * @property {Object} oldValue The old value of the property (before the change).
    * @property {Stream} stream The Stream object for which a property has changed.
@@ -8672,7 +8672,7 @@ const logging = (0, _log.default)('StaticConfig');
 */
 
 /** @type builtInConfig */
-const builtInConfig = (0, _cloneDeep.default)({"version":"v2.30.1","buildHash":"8989bb63b","minimumVersion":{"firefox":52,"chrome":49},"debug":false,"websiteURL":"http://www.tokbox.com","configURL":"https://config.opentok.com","ipWhitelistConfigURL":"","cdnURL":"","loggingURL":"https://hlg.tokbox.com/prod","apiURL":"https://anvil.opentok.com"});
+const builtInConfig = (0, _cloneDeep.default)({"version":"v2.30.1","buildHash":"b842fa8df","minimumVersion":{"firefox":52,"chrome":49},"debug":false,"websiteURL":"http://www.tokbox.com","configURL":"https://config.opentok.com","ipWhitelistConfigURL":"","cdnURL":"","loggingURL":"https://hlg.tokbox.com/prod","apiURL":"https://anvil.opentok.com"});
 const whitelistAllowedRuntimeProperties = (0, _pick.default)(['apiURL', 'assetURL', 'cdnURL', 'sessionInfoOverrides', 'loggingURL']);
 const liveConfigMap = {
   apiUrl: 'apiURL',
@@ -17776,8 +17776,9 @@ function PublisherFactory(_ref) {
       });
     });
     function getCommonAnalyticsFields() {
+      var _getSession, _getSession2, _getSession2$connecti;
       return {
-        connectionId: getSession().isConnected() ? getSession().connection.connectionId : null,
+        connectionId: (_getSession = getSession()) != null && _getSession.isConnected() ? (_getSession2 = getSession()) == null ? void 0 : (_getSession2$connecti = _getSession2.connection) == null ? void 0 : _getSession2$connecti.connectionId : null,
         streamId: getStreamId(),
         widgetType: 'Publisher'
       };
@@ -18079,7 +18080,7 @@ function PublisherFactory(_ref) {
       logAnalyticsEvent('GetRtcStatsReport', 'Called');
     });
     const recordQOS = _ref4 => {
-      var _properties$audioFall;
+      var _this$session2, _this$session3, _this$session3$connec, _properties$audioFall;
       let parsedStats = _ref4.parsedStats,
         simulcastEnabled = _ref4.simulcastEnabled,
         remoteConnectionId = _ref4.remoteConnectionId,
@@ -18088,7 +18089,7 @@ function PublisherFactory(_ref) {
       const QoSBlob = {
         peerId,
         widgetType: 'Publisher',
-        connectionId: this.session && this.session.isConnected() ? this.session.connection.connectionId : null,
+        connectionId: (_this$session2 = this.session) != null && _this$session2.isConnected() ? (_this$session3 = this.session) == null ? void 0 : (_this$session3$connec = _this$session3.connection) == null ? void 0 : _this$session3$connec.connectionId : null,
         streamId: this.streamId,
         width: widgetView.width,
         height: widgetView.height,
@@ -19625,6 +19626,8 @@ function PublisherFactory(_ref) {
     * @see <a href="OT.html#initPublisher">OT.initPublisher()</a>
     * @see <a href="Subscriber.html#subscribeToCaptions">subscribeToCaptions()</a>
     * @see <a href="Subscriber.html#isSubscribedToCaptions">isSubscribedToCaptions()</a>
+    * @see <a href="Stream.html#hasCaptions">Stream.hasCaptions</a>
+    * @see StreamPropertyChangedEvent
     * @method #publishCaptions
     * @memberOf Publisher
     */
@@ -20892,7 +20895,7 @@ function PublisherFactory(_ref) {
       document.addEventListener('visibilitychange', visibilityHandler);
     };
     const handleBuggedUnMutedLocalAudioTrack = audioTrack => {
-      var _this$session2;
+      var _this$session4;
       if (hasAudio()) {
         if (!hasVideo()) {
           // We only need to reset the audio source when the publisher is audio only.
@@ -20907,7 +20910,7 @@ function PublisherFactory(_ref) {
           this.videoElement().pause();
         }
       }
-      this == null ? void 0 : (_this$session2 = this.session) == null ? void 0 : _this$session2.trigger('gsmCallEnded');
+      this == null ? void 0 : (_this$session4 = this.session) == null ? void 0 : _this$session4.trigger('gsmCallEnded');
     };
 
     /**
@@ -23992,6 +23995,12 @@ const validPropertyNames = ['name', 'archiving'];
  * the publisher of the stream specifies a frame rate when calling the
  * <code>OT.initPublisher()</code> method; otherwise, this property is undefined.
  *
+ * @property {Boolean} hasCaptions Whether the stream has captions. This property can change if the
+ * publisher turns on or off captions (by calling
+ * <a href="Publisher.html#publishCaptions">Publisher.publishCaptions()</a>). When this occurs, the
+ * {@link Session} object dispatches a <code>streamPropertyChanged</code> event (see
+ * {@link StreamPropertyChangedEvent}).
+ *
  * @property {Boolean} hasAudio Whether the stream has audio. This property can change if the
  * publisher turns on or off audio (by calling
  * <a href="Publisher.html#publishAudio">Publisher.publishAudio()</a>). When this occurs, the
@@ -24055,7 +24064,13 @@ function Stream(id, name, creationTime, connection, session, channel, initials)
     let _key = key;
     switch (_key) {
       case 'active':
-        _key = channel.type === 'audio' ? 'hasAudio' : 'hasVideo';
+        if (channel.type === 'audio') {
+          _key = 'hasAudio';
+        } else if (channel.type === 'video') {
+          _key = 'hasVideo';
+        } else if (channel.type === 'data' && channel.id === 'caption1') {
+          _key = 'hasCaptions';
+        }
         self[_key] = newValue;
         break;
       case 'disableWarning':
@@ -24129,11 +24144,13 @@ function Stream(id, name, creationTime, connection, session, channel, initials)
 
   const audioChannel = this.getChannelsOfType('audio')[0];
   const videoChannel = this.getChannelsOfType('video')[0];
+  const captionChannel = this.getChannelsOfType('data').find(channel => channel.id === 'caption1');
 
   // @todo this should really be: "has at least one video/audio track" instead of
   // "the first video/audio track"
-  this.hasAudio = audioChannel != null && audioChannel.active;
-  this.hasVideo = videoChannel != null && videoChannel.active;
+  this.hasAudio = !!(audioChannel != null && audioChannel.active);
+  this.hasVideo = !!(videoChannel != null && videoChannel.active);
+  this.hasCaptions = !!(captionChannel != null && captionChannel.active);
   this.videoType = videoChannel && videoChannel.source;
   this.defaultFitMode = videoChannel && videoChannel.fitMode;
   this.videoDimensions = {};
@@ -24144,9 +24161,8 @@ function Stream(id, name, creationTime, connection, session, channel, initials)
     videoChannel.on('update', onChannelUpdate);
     this.frameRate = videoChannel.frameRate;
   }
-  if (audioChannel) {
-    audioChannel.on('update', onChannelUpdate);
-  }
+  audioChannel == null ? void 0 : audioChannel.on('update', onChannelUpdate);
+  captionChannel == null ? void 0 : captionChannel.on('update', onChannelUpdate);
   this.setChannelActiveState = function setChannelActiveState(_ref) {
     let channelType = _ref.channelType,
       activeState = _ref.activeState,
@@ -37157,18 +37173,18 @@ function SubscriberFactory(_ref2) {
       return _webRTCStream.getAudioTracks().length > 0;
     };
     const logAnalyticsEvent = (action, variation, payload, options, throttle) => {
-      var _session2;
+      var _session2, _session3, _session3$connection, _session$sessionInfo$, _session4, _session4$sessionInfo, _session5;
       let stats = (0, _assign.default)({
         action,
         variation,
         payload,
         streamId: _stream ? _stream.id : null,
         sessionId: _session ? _session.sessionId : null,
-        connectionId: _session && _session.isConnected() ? _session.connection.connectionId : null,
-        partnerId: _session && _session.sessionInfo ? _session.sessionInfo.partnerId : null,
+        connectionId: (_session2 = _session) != null && _session2.isConnected() ? (_session3 = _session) == null ? void 0 : (_session3$connection = _session3.connection) == null ? void 0 : _session3$connection.connectionId : null,
+        partnerId: (_session$sessionInfo$ = (_session4 = _session) == null ? void 0 : (_session4$sessionInfo = _session4.sessionInfo) == null ? void 0 : _session4$sessionInfo.partnerId) != null ? _session$sessionInfo$ : null,
         subscriberId: _widgetId,
         widgetType: 'Subscriber',
-        singlePeerConnection: !!((_session2 = _session) != null && _session2._singlePeerConnectionController)
+        singlePeerConnection: !!((_session5 = _session) != null && _session5._singlePeerConnectionController)
       }, options);
       if (variation === 'Failure' || variation === 'iceconnectionstatechange' && payload === 'closed') {
         stats = (0, _assign.default)(stats, _preDisconnectStats);
@@ -37340,8 +37356,9 @@ function SubscriberFactory(_ref2) {
     (0, _connectivityAttemptPinger.default)({
       connectivityState,
       logAttempt() {
+        var _session6, _session7, _session7$connection;
         logAnalyticsEvent('Subscribe', 'Attempting', null, {
-          connectionId: _session && _session.isConnected() ? _session.connection.connectionId : null
+          connectionId: (_session6 = _session) != null && _session6.isConnected() ? (_session7 = _session) == null ? void 0 : (_session7$connection = _session7.connection) == null ? void 0 : _session7$connection.connectionId : null
         });
       }
     });
@@ -37366,7 +37383,7 @@ function SubscriberFactory(_ref2) {
       logAnalyticsEvent('ICERestart', variation, payload);
     };
     const recordQOS = _ref12 => {
-      var _properties$preferred, _properties$preferred2;
+      var _session$connection$c, _session8, _session8$connection, _properties$preferred, _properties$preferred2;
       let parsedStats = _ref12.parsedStats,
         remoteConnectionId = _ref12.remoteConnectionId,
         peerId = _ref12.peerId,
@@ -37380,7 +37397,7 @@ function SubscriberFactory(_ref2) {
         subscribeToAudio: _isSubscribingToAudio,
         audioVolume: this.getAudioVolume(),
         videoTrack: _streamHasTracks('video'),
-        connectionId: _session ? _session.connection.connectionId : null,
+        connectionId: (_session$connection$c = (_session8 = _session) == null ? void 0 : (_session8$connection = _session8.connection) == null ? void 0 : _session8$connection.connectionId) != null ? _session$connection$c : null,
         hasVideo: _stream && _stream.hasVideo,
         subscribeToVideo: _properties.subscribeToVideo,
         congestionLevel: _congestionLevel,
@@ -37904,13 +37921,13 @@ function SubscriberFactory(_ref2) {
     }();
     const onRemoteStreamAdded = (0, _queue.default)( /*#__PURE__*/function () {
       var _ref21 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee11(_ref20, done) {
-        var webRTCStream, peerConnection, sourceStreamId, _session3, sessionInfo, forceDisable;
+        var webRTCStream, peerConnection, sourceStreamId, _session9, sessionInfo, forceDisable;
         return _regenerator.default.wrap(function _callee11$(_context11) {
           while (1) switch (_context11.prev = _context11.next) {
             case 0:
               webRTCStream = _ref20.webRTCStream, peerConnection = _ref20.peerConnection;
               sourceStreamId = peerConnection == null ? void 0 : peerConnection.getSourceStreamId();
-              _session3 = _session, sessionInfo = _session3.sessionInfo;
+              _session9 = _session, sessionInfo = _session9.sessionInfo;
               setStream(webRTCStream, sourceStreamId);
               logging.debug('OT.Subscriber.onRemoteStreamAdded with sourceStreamId', sourceStreamId);
               if (!_state.isMigrating()) {
@@ -38619,6 +38636,7 @@ function SubscriberFactory(_ref2) {
       };
     }();
     this._destroy = _ref30 => {
+      var _session10, _session11, _session11$connection, _session$sessionInfo$2, _session12, _session12$sessionInf;
       let _ref30$reason = _ref30.reason,
         reason = _ref30$reason === void 0 ? 'Unknown' : _ref30$reason,
         quiet = _ref30.quiet,
@@ -38634,8 +38652,8 @@ function SubscriberFactory(_ref2) {
       }
       _preDisconnectStats = {
         sessionId: _session.sessionId,
-        connectionId: _session && _session.isConnected() ? _session.connection.connectionId : null,
-        partnerId: _session && _session.sessionInfo ? _session.sessionInfo.partnerId : null,
+        connectionId: (_session10 = _session) != null && _session10.isConnected() ? (_session11 = _session) == null ? void 0 : (_session11$connection = _session11.connection) == null ? void 0 : _session11$connection.connectionId : null,
+        partnerId: (_session$sessionInfo$2 = (_session12 = _session) == null ? void 0 : (_session12$sessionInf = _session12.sessionInfo) == null ? void 0 : _session12$sessionInf.partnerId) != null ? _session$sessionInfo$2 : null,
         streamId: _stream && !_stream.destroyed ? _stream.id : null
       };
       this._disconnect({
@@ -39631,7 +39649,7 @@ function SubscriberFactory(_ref2) {
               _activeSourceStreamId = sourceStreamId;
               peerConnectionsAsync[sourceStreamId] = new Promise((resolve, reject) => {
                 _session._.getIceConfig().then(iceConfig => {
-                  var _session4;
+                  var _session13;
                   if (iceConfig.needRumorIceServersFallback) {
                     iceConfig.servers = [...(fallbackIceServers || []), ...(iceConfig.servers || [])];
                   }
@@ -39648,7 +39666,7 @@ function SubscriberFactory(_ref2) {
                     keyStore: _session.keyStore,
                     sFrameClientStore: _session.sFrameClientStore,
                     isE2ee: _session._.isE2ee(),
-                    sessionId: (_session4 = _session) == null ? void 0 : _session4.sessionId
+                    sessionId: (_session13 = _session) == null ? void 0 : _session13.sessionId
                   };
                   if (Object.prototype.hasOwnProperty.call(_properties, 'codecFlags')) {
                     props.codecFlags = _properties.codecFlags;
@@ -40028,6 +40046,7 @@ function SubscriberFactory(_ref2) {
     *
     * @see <a href="#isSubscribedToCaptions">isSubscribedToCaptions()</a>
     * @see <a href="#event:captionReceived">captionReceived</a> event
+    * @see <a href="StreamPropertyChangedEvent.html">StreamPropertyChangedEvent</a>
     *
     * @method #subscribeToCaptions
     * @memberOf Subscriber
@@ -44809,6 +44828,7 @@ function SessionFactory(deps) {
     * @memberOf Session
     */
     this.subscribe = function (stream, targetElement, properties, completionHandler) {
+      var _this$connection;
       if (typeof targetElement === 'function') {
         completionHandler = targetElement;
         targetElement = undefined;
@@ -44819,7 +44839,7 @@ function SessionFactory(deps) {
         properties = undefined;
       }
       completionHandler = completionHandler || function () {};
-      if (!this.connection || !this.connection.connectionId) {
+      if (!((_this$connection = this.connection) != null && _this$connection.connectionId)) {
         dispatchOTError(otError(errors.NOT_CONNECTED, new Error('Session.subscribe :: Connection required to subscribe'), ExceptionCodes.UNABLE_TO_SUBSCRIBE), completionHandler);
         return undefined;
       }
@@ -45017,12 +45037,13 @@ function SessionFactory(deps) {
         _isSocketReconnecting = false;
         this.dispatchEvent(new Events.SessionReconnectedEvent());
         if (this.sessionInfo.reconnection) {
+          var _this$session, _this$session$session;
           sessionObjects.publishers.where({
             session: this
           }).forEach(publisher => {
             publisher._.iceRestart();
           });
-          if (!this.session.sessionInfo.p2pEnabled) {
+          if (!((_this$session = this.session) != null && (_this$session$session = _this$session.sessionInfo) != null && _this$session$session.p2pEnabled)) {
             sessionObjects.subscribers.where({
               session: this
             }).forEach(subscriber => {
@@ -46200,8 +46221,9 @@ function SessionFactory(deps) {
    * in the following conditions:
    * <p>
    * <ul>
-   *   <li> A stream has started or stopped publishing audio or video (see
-   *     <a href="Publisher.html#publishAudio">Publisher.publishAudio()</a> and
+   *   <li> A stream has started or stopped publishing audio, captions, or video (see
+   *     <a href="Publisher.html#publishAudio">Publisher.publishAudio()</a>,
+   *     <a href="Publisher.html#publishCaptions">Publisher.publishCaptions()</a> and
    *     <a href="Publisher.html#publishVideo">Publisher.publishVideo()</a>). Note
    *     that a subscriber's video can be disabled or enabled for reasons other than
    *     the publisher disabling or enabling it. A Subscriber object dispatches
@@ -46222,8 +46244,10 @@ function SessionFactory(deps) {
    * @memberof Session
    * @see StreamPropertyChangedEvent
    * @see <a href="Publisher.html#publishAudio">Publisher.publishAudio()</a>
+   * @see <a href="Publisher.html#publishCaptions">Publisher.publishCaptions()</a>
    * @see <a href="Publisher.html#publishVideo">Publisher.publishVideo()</a>
    * @see <a href="Stream.html#hasAudio">Stream.hasAudio</a>
+   * @see <a href="Stream.html#hasCaptions">Stream.hasCaptions</a>
    * @see <a href="Stream.html#hasVideo">Stream.hasVideo</a>
    * @see <a href="Stream.html#videoDimensions">Stream.videoDimensions</a>
    * @see <a href="Subscriber.html#event:videoDisabled">Subscriber videoDisabled event</a>