@opentok/client 2.35.0-alpha.23 → 2.35.0-alpha.24

package/dist/js/opentok.d.ts

@@ -28,7 +28,7 @@ declare namespace OT {
 
   export function checkScreenSharingCapability(
     callback: (response: ScreenSharingCapabilityResponse) => void
-  ): void;
+  ): Promise<ScreenSharingCapabilityResponse>;
 
   export function checkSystemRequirements(): number;
 
@@ -67,7 +67,7 @@ declare namespace OT {
 
   export function getDevices(
     callback: (error: OTError | undefined, devices?: Device[]) => void
-  ): void;
+  ): Promise<Device[]>;
 
   export function getAudioOutputDevices(): Promise<AudioOutputDevice[]>;
 
@@ -485,6 +485,15 @@ declare namespace OT {
     callback?: (error?: OTError) => void
   ): Publisher;
 
+  export namespace initPublisher {
+    var promise: (
+      targetElement?: HTMLElement | string,
+      properties?: PublisherProperties,
+      callback?: (error?: OTError) => void
+    ) =>
+      Promise<Publisher>;
+  }
+
   export function log(message: string): void;
 
   export function off(
@@ -845,7 +854,7 @@ declare namespace OT {
     version: number
   ): void;
 
-  export function reportIssue(callback: (error?: OTError, reportId?: string) => void): void;
+  export function reportIssue(callback: (error?: OTError, reportId?: string) => void): Promise<string>;
 
   export function setAudioOutputDevice(deviceId: string): Promise<void>;
 

package/dist/js/opentok.js

@@ -1,11 +1,11 @@
 /**
- * @license OpenTok.js 2.35.0 b3cd7abe5
+ * @license OpenTok.js 2.35.0 6076fa4b4
  *
  * Copyright (c) 2010-2026 TokBox, Inc.
  * Subject to the applicable Software Development Kit (SDK) License Agreement:
  * https://www.vonage.com/legal/communications-apis/terms-of-use/
  *
- * Date: Wed, 13 May 2026 13:03:31 GMT
+ * Date: Mon, 18 May 2026 08:41:01 GMT
  */
 
 (function webpackUniversalModuleDefinition(root, factory) {
@@ -4628,43 +4628,58 @@ const _deviceHelpers = (0, _deviceHelpers2.default)(),
 
 /**
  * Enumerates the audio input devices (such as microphones) and video input devices
- * (cameras) available to the browser.
+ * (cameras) available to the browser. This returns a promise containing the array of
+ * devices. Each object has three properties: <code>kind</code>,
+ * <code>deviceId</code>, and <code>label</code>, each of which are strings.
  * <p>
- * The array of devices is passed in as the <code>devices</code> parameter of
- * the <code>callback</code> function passed into the method.
+ * The <code>kind</code> property is set to <code>"audioInput"</code> for audio input
+ * devices or <code>"videoInput"</code> for video input devices.
+ * <p>
+ * The <code>deviceId</code> property is a unique ID for the device. You can pass
+ * the <code>deviceId</code> in as the <code>audioSource</code> or <code>videoSource</code>
+ * property of the <code>options</code> parameter of the
+ * <a href="#initPublisher">OT.initPublisher()</a> method.
+ * <p>
+ * The <code>label</code> property identifies the device. The <code>label</code>
+ * property is set to an empty string if the user has not previously granted access to
+ * a camera and microphone.
  *
- * @param callback {Function} The callback function invoked when the list of devices
+ * @param callback {Function} Optional callback function invoked when the list of devices
  * devices is available. This function takes two parameters:
  * <ul>
  *   <li><code>error</code> &mdash; This is set to an error object when
  *   there is an error in calling this method; it is set to <code>null</code>
  *   when the call succeeds.</li>
- *
  *   <li><p><code>devices</code> &mdash; An array of objects corresponding to
- *   available microphones and cameras. Each object has three properties: <code>kind</code>,
- *   <code>deviceId</code>, and <code>label</code>, each of which are strings.
- *   <p>
- *   The <code>kind</code> property is set to <code>"audioInput"</code> for audio input
- *   devices or <code>"videoInput"</code> for video input devices.
- *   <p>
- *   The <code>deviceId</code> property is a unique ID for the device. You can pass
- *   the <code>deviceId</code> in as the <code>audioSource</code> or <code>videoSource</code>
- *   property of the <code>options</code> parameter of the
- *   <a href="#initPublisher">OT.initPublisher()</a> method.
- *   <p>
- *   The <code>label</code> property identifies the device. The <code>label</code>
- *   property is set to an empty string if the user has not previously granted access to
- *   a camera and microphone.</li>
+ *   available microphones and cameras.
+ *   </li>
  * </ul>
  * <i>Note:</i> The browser may limit the number of returned audio and video input devices
  * to one each before the user has granted access to a camera or microphone.
  *
+ * @returns {Promise<Device[]>} A promise containing the list of devices
+ *
  * @see <a href="#initPublisher">OT.initPublisher()</a>
  * @method OT.getDevices
  * @memberof OT
  */
 function getDevices(callback) {
-  getInputMediaDevices().then(devices => callback(undefined, devices), callback);
+  const hasCallback = typeof callback === 'function';
+  const promise = getInputMediaDevices().then(devices => {
+    if (hasCallback) {
+      callback(undefined, devices);
+    }
+    return devices;
+  }, err => {
+    if (hasCallback) {
+      callback(err);
+    }
+    throw err;
+  });
+  if (hasCallback) {
+    promise.catch(() => {});
+  }
+  return promise;
 }
 
 /***/ }),
@@ -29218,6 +29233,8 @@ function RaptorSocketFactory(deps) {
 var _interopRequireDefault = __webpack_require__(95709);
 exports.__esModule = true;
 exports["default"] = getUserMediaFactory;
+var _regenerator = _interopRequireDefault(__webpack_require__(92207));
+var _asyncToGenerator2 = _interopRequireDefault(__webpack_require__(79092));
 var _assign = _interopRequireDefault(__webpack_require__(86139));
 var _isObject = _interopRequireDefault(__webpack_require__(23805));
 var _eventing = _interopRequireDefault(__webpack_require__(12607));
@@ -29505,23 +29522,41 @@ function getUserMediaFactory(deps) {
       // it when creating `finalized` above.
       const error = parseErrorEvent(browserError);
       if (error.name === Errors.UNABLE_TO_CAPTURE_SCREEN) {
-        return new Promise((resolve, reject) => {
-          screenSharing.checkCapability(response => {
-            if (response.extensionRequired === 'chrome') {
-              if (response.extensionRegistered && !response.extensionInstalled) {
-                const newErr = otError(Errors.SCREEN_SHARING_EXTENSION_NOT_INSTALLED, error);
-                newErr.message = 'Screen sharing extension not installed see https://tokbox.com/developer/guides/screen-sharing/js/#chrome-extension';
-                reject(newErr);
-              } else if (!response.extensionRegistered) {
-                const newErr = otError(Errors.SCREEN_SHARING_EXTENSION_NOT_REGISTERED, error);
-                newErr.message = 'Screen sharing extension not registered see https://tokbox.com/developer/guides/screen-sharing/js/#chrome-extension';
-                reject(newErr);
+        return new Promise( /*#__PURE__*/function () {
+          var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(_, reject) {
+            var response, newErr;
+            return _regenerator.default.wrap(function _callee$(_context2) {
+              while (1) switch (_context2.prev = _context2.next) {
+                case 0:
+                  _context2.next = 2;
+                  return screenSharing.checkCapability();
+                case 2:
+                  response = _context2.sent;
+                  if (response.extensionRequired === 'chrome') {
+                    if (response.extensionRegistered && !response.extensionInstalled) {
+                      newErr = otError(Errors.SCREEN_SHARING_EXTENSION_NOT_INSTALLED, error);
+                      newErr.message = 'Screen sharing extension not installed see https://tokbox.com/developer/guides/screen-sharing/js/#chrome-extension';
+                      reject(newErr);
+                    } else if (!response.extensionRegistered) {
+                      newErr = otError(Errors.SCREEN_SHARING_EXTENSION_NOT_REGISTERED, error);
+                      newErr.message = 'Screen sharing extension not registered see https://tokbox.com/developer/guides/screen-sharing/js/#chrome-extension';
+                      reject(newErr);
+                    } else {
+                      reject(error);
+                    }
+                  } else {
+                    reject(error);
+                  }
+                case 4:
+                case "end":
+                  return _context2.stop();
               }
-            } else {
-              reject(error);
-            }
-          });
-        });
+            }, _callee);
+          }));
+          return function (_x, _x2) {
+            return _ref.apply(this, arguments);
+          };
+        }());
       }
       throw error;
     }).then(stream => {
@@ -41658,7 +41693,7 @@ function staticConfigFactory(_temp) {
     _ref$axios = _ref.axios,
     axios = _ref$axios === void 0 ? _axios.default : _ref$axios,
     _ref$properties = _ref.properties,
-    properties = _ref$properties === void 0 ? {"version":"v2.35.0","buildHash":"b3cd7abe5","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","vonageApiURL":""} : _ref$properties;
+    properties = _ref$properties === void 0 ? {"version":"v2.35.0","buildHash":"6076fa4b4","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","vonageApiURL":""} : _ref$properties;
   /** @type builtInConfig */
   const builtInConfig = (0, _cloneDeep.default)(properties);
   /**
@@ -59400,42 +59435,24 @@ function screenSharingFactory(deps) {
   screenSharing.pickHelper = () => screenSharingPickHelper();
 
   /**
-   * Checks for support for publishing screen-sharing streams on the client browser. The object
-   * passed to the callback function defines whether screen sharing is supported, as well as
+   * Checks for support for publishing screen-sharing streams on the client browser. The returned
+   * object in the promise defines whether screen sharing is supported, as well as
    * which screen-sharing sources (application, screen, or window) are supported. It also indicates
    * whether an extension is required, installed, and registered (if needed).
    * <p>
    * <pre>
-   * OT.checkScreenSharingCapability(function(response) {
-   *   if (!response.supported || response.extensionRegistered === false) {
-   *     // This browser does not support screen sharing
-   *   } else if (response.extensionInstalled === false) {
-   *     // Prompt to install the extension
-   *   } else {
-   *     // Screen sharing is available.
-   *   }
-   * });
+   * const response = await OT.checkScreenSharingCapability();
+   * if (!response.supported || response.extensionRegistered === false) {
+   * // This browser does not support screen sharing
+   * } else if (response.extensionInstalled === false) {
+   *   // Prompt to install the extension
+   * } else {
+   *   // Screen sharing is available.
+   * }
    * </pre>
    * <p>
-   * Chrome 72+, Firefox 52+, Safari 13+, Edge 79+, and Opera 59+ have screen-sharing
-   * support built-in, with no extension required. (Note that support for the Vonage Video API
-   * plugin for Internet Explorer is removed in Vonage Video API 2.17.) Screen sharing is
-   * <i>not</i> supported in mobile browsers. In Electron, screen sharing is supported if
-   * the <code>webPreferences.contextIsolation</code> option of the Electron BrowserWindow is
-   * set to <code>false</code> or if the app uses a preload script to access the desktop capturer.
-   * (The default value of <code>webPreferences.contextIsolation</code> option is <code>true</code>
-   * in Electron 12 and <code>false</code> in previous versions). To publish a screen-sharing video
-   * in older versions of Chrome or Opera, the client adds an extension that enables publishing a
-   * screen-sharing video stream on your domain. The Vonage Video API
-   * <a href="https://github.com/opentok/screensharing-extensions">screensharing-extensions</a>
-   * sample includes code for creating an extension for screen-sharing support in
-   * older versions of Chrome and Opera.
-   * <p>
-   * For more information, see the <a href="https://tokbox.com/developer/guides/screen-sharing/js/">
-   * Vonage Video API Screen Sharing</a> developer guide.
    *
-   * @param {function} callback The callback invoked with the support options object passed as
-   * the parameter. This object has the following properties that indicate support for publishing
+   * This object has the following properties that indicate support for publishing
    * screen-sharing streams in the client:
    * <p>
    * <ul>
@@ -59482,47 +59499,80 @@ function screenSharingFactory(deps) {
    *   </li>
    * </ul>
    *
+   * Chrome 72+, Firefox 52+, Safari 13+, Edge 79+, and Opera 59+ have screen-sharing
+   * support built-in, with no extension required. (Note that support for the Vonage Video API
+   * plugin for Internet Explorer is removed in Vonage Video API 2.17.) Screen sharing is
+   * <i>not</i> supported in mobile browsers. In Electron, screen sharing is supported if
+   * the <code>webPreferences.contextIsolation</code> option of the Electron BrowserWindow is
+   * set to <code>false</code> or if the app uses a preload script to access the desktop capturer.
+   * (The default value of <code>webPreferences.contextIsolation</code> option is <code>true</code>
+   * in Electron 12 and <code>false</code> in previous versions). To publish a screen-sharing video
+   * in older versions of Chrome or Opera, the client adds an extension that enables publishing a
+   * screen-sharing video stream on your domain. The Vonage Video API
+   * <a href="https://github.com/opentok/screensharing-extensions">screensharing-extensions</a>
+   * sample includes code for creating an extension for screen-sharing support in
+   * older versions of Chrome and Opera.
+   * <p>
+   * For more information, see the <a href="https://tokbox.com/developer/guides/screen-sharing/js/">
+   * Vonage Video API Screen Sharing</a> developer guide.
+   *
+   * @param {function} callback Optional callback invoked with the support options object passed as
+   * the parameter.
+   *
+   * @returns {Promise<ScreenSharingCapabilityResponse>} A promise with the capability
+   *
    * @see <a href="OT.html#initPublisher">OT.initPublisher()</a>
    * @see <a href="OT.html#registerScreenSharingExtension">OT.registerScreenSharingExtension()</a>
    * @method OT.checkScreenSharingCapability
    * @memberof OT
    */
-  screenSharing.checkCapability = callback => {
-    const response = {
-      supported: false,
-      extensionRequired: undefined,
-      extensionRegistered: undefined,
-      extensionInstalled: undefined,
-      supportedSources: {}
-    };
-
-    // find a supported browser
+  screenSharing.checkCapability = function (callback) {
+    if (callback === void 0) {
+      callback = () => {};
+    }
+    return new Promise(resolve => {
+      const response = {
+        supported: false,
+        extensionRequired: undefined,
+        extensionRegistered: undefined,
+        extensionInstalled: undefined,
+        supportedSources: {}
+      };
 
-    const helper = screenSharingPickHelper();
-    if (helper.name === undefined) {
-      setTimeout(callback.bind(null, response));
-      return;
-    }
-    response.supported = true;
-    response.extensionRequired = helper.proto.extensionRequired ? helper.name : undefined;
-    response.supportedSources = {
-      screen: helper.proto.sources.screen,
-      application: helper.proto.sources.application,
-      window: helper.proto.sources.window,
-      browser: helper.proto.sources.browser
-    };
-    if (!helper.instance) {
-      response.extensionRegistered = false;
-      if (response.extensionRequired) {
-        response.extensionInstalled = false;
+      // find a supported browser
+      const helper = screenSharingPickHelper();
+      if (helper.name === undefined) {
+        setTimeout(() => {
+          callback(response);
+        });
+        resolve(response);
+        return;
       }
-      setTimeout(callback.bind(null, response));
-      return;
-    }
-    response.extensionRegistered = response.extensionRequired ? true : undefined;
-    helper.instance.isInstalled(installed => {
-      response.extensionInstalled = response.extensionRequired || OTHelpers.env.name === 'Firefox' ? installed : undefined;
-      callback(response);
+      response.supported = true;
+      response.extensionRequired = helper.proto.extensionRequired ? helper.name : undefined;
+      response.supportedSources = {
+        screen: helper.proto.sources.screen,
+        application: helper.proto.sources.application,
+        window: helper.proto.sources.window,
+        browser: helper.proto.sources.browser
+      };
+      if (!helper.instance) {
+        response.extensionRegistered = false;
+        if (response.extensionRequired) {
+          response.extensionInstalled = false;
+        }
+        setTimeout(() => {
+          callback(response);
+        });
+        resolve(response);
+        return;
+      }
+      response.extensionRegistered = response.extensionRequired ? true : undefined;
+      helper.instance.isInstalled(installed => {
+        response.extensionInstalled = response.extensionRequired || OTHelpers.env.name === 'Firefox' ? installed : undefined;
+        callback(response);
+        resolve(response);
+      });
     });
   };
   screenSharing.registerExtensionHelper('electron', electronExtensionHelper);
@@ -59538,7 +59588,7 @@ function screenSharingFactory(deps) {
       videoSource = opt.videoSource,
       constraints = opt.constraints;
     return new Promise((resolve, reject) => {
-      screenSharing.checkCapability(response => {
+      screenSharing.checkCapability().then(response => {
         if (!response.supported) {
           let errorMessage = 'Screen Sharing is not supported in this browser';
           if (OTHelpers.env.isElectron) {
@@ -61739,41 +61789,51 @@ function reportIssueFactory(deps) {
   * <a href="https://tokbox.com/developer/tools/inspector/">Inspector</a> or when discussing
   * an issue with the Vonage API support team.
   *
-  * @param completionHandler {Function} A function that is called when the call to this method
+  * @param completionHandler {Function} Optional Function that is called when the call to this method
   * succeeds or fails. This function has two parameters. The first parameter is an
   * <a href="Error.html">Error</a> object that is set when the call to the
   * <code>reportIssue()</code> method fails (for example, if the client is not connected to the
   * network) or <code>null</code> when the call to the <code>reportIssue()</code> method succeeds.
   * The second parameter is set to the report ID (a unique string) when the call succeeds.
   *
+  * @returns {Promise<string>} A promise resolving to the report ID
+  *
   * @method OT.reportIssue
   * @memberof OT
   */
   return function reportIssue(completionHandler) {
-    if (completionHandler === void 0) {
-      completionHandler = () => {};
-    }
-    const reportIssueId = uuid();
-    function onDone(err) {
-      if (err) {
-        completionHandler(otError(errors.REPORT_ISSUE_FAILED, new Error('Error calling OT.reportIssue(). Check the client\'s network connection.'), ExceptionCodes.REPORT_ISSUE_ERROR));
+    const hasCompletionHandler = typeof completionHandler === 'function';
+    const callback = hasCompletionHandler ? completionHandler : () => {};
+    const promise = new Promise((resolve, reject) => {
+      const reportIssueId = uuid();
+      function onDone(err) {
+        if (err) {
+          const error = otError(errors.REPORT_ISSUE_FAILED, new Error('Error calling OT.reportIssue(). Check the client\'s network connection.'), ExceptionCodes.REPORT_ISSUE_ERROR);
+          callback(error);
+          reject(error);
+        } else {
+          callback(null, reportIssueId);
+          resolve(reportIssueId);
+        }
+      }
+      if (sessionObjects.sessions.length() === 0) {
+        analytics.logEvent({
+          action: 'ReportIssue',
+          variation: 'Event',
+          payload: {
+            reportIssueId
+          }
+        }, null, onDone);
       } else {
-        completionHandler(null, reportIssueId);
+        Promise.all(sessionObjects.sessions.map(session => session.reportIssue({
+          id: reportIssueId
+        }))).then(() => onDone(), err => onDone(err));
       }
+    });
+    if (hasCompletionHandler) {
+      promise.catch(() => {});
     }
-    if (sessionObjects.sessions.length() === 0) {
-      analytics.logEvent({
-        action: 'ReportIssue',
-        variation: 'Event',
-        payload: {
-          reportIssueId
-        }
-      }, null, onDone);
-    } else {
-      Promise.all(sessionObjects.sessions.map(session => session.reportIssue({
-        id: reportIssueId
-      }))).then(() => onDone(), err => onDone(err));
-    }
+    return promise;
   };
 }
 
@@ -67254,6 +67314,7 @@ exports["default"] = _default;
 /***/ ((__unused_webpack_module, exports, __webpack_require__) => {
 
 "use strict";
+/* provided dependency */ var Promise = __webpack_require__(86964);
 
 
 var _interopRequireDefault = __webpack_require__(95709);
@@ -67958,7 +68019,7 @@ function initPublisherFactory(deps) {
   * @method OT.initPublisher
   * @memberof OT
   */
-  return function initPublisher(targetElement, properties, completionHandler) {
+  function initPublisher(targetElement, properties, completionHandler) {
     logging.debug(`OT.initPublisher(${targetElement})`);
 
     // To support legacy (apikey, targetElement, properties) users
@@ -68015,7 +68076,6 @@ function initPublisherFactory(deps) {
     };
     let removeHandlersAndCallComplete = function removeHandlersAndCallComplete(err) {
       publisher.off('initSuccess', removeInitSuccessAndCallComplete);
-
       // We're only handling the error case here as we're just
       // initing the publisher, not actually attempting to publish.
       if (err) {
@@ -68026,7 +68086,24 @@ function initPublisherFactory(deps) {
     publisher.once('publishComplete', removeHandlersAndCallComplete);
     publisher.publish(targetElement);
     return publisher;
-  };
+  }
+
+  /**
+  * The <code>initPublisher</code> function is also available in a promisifed flavour.
+  * Note that this function will only resolve to a publisher object if there were no
+  * errors involved in its creation.
+  */
+  initPublisher.promise = (targetElement, properties) => new Promise((resolve, reject) => {
+    const args = [targetElement, properties].filter(arg => arg !== undefined);
+    const publisher = initPublisher(...args, error => {
+      if (error) {
+        reject(error);
+      } else {
+        resolve(publisher);
+      }
+    });
+  });
+  return initPublisher;
 }
 
 /***/ }),
@@ -68176,6 +68253,7 @@ module.exports = baseRest;
 /***/ ((__unused_webpack_module, exports, __webpack_require__) => {
 
 "use strict";
+/* provided dependency */ var Promise = __webpack_require__(86964);
 
 
 var _interopRequireDefault = __webpack_require__(95709);
@@ -68185,13 +68263,24 @@ var _get_rtc_stats_report_adapter = _interopRequireDefault(__webpack_require__(5
 var _createRtcStatsReportParser = _interopRequireDefault(__webpack_require__(14848));
 // This returns the array-ified list of stats our users are accustomed to
 var _default = (peerConnection, track, completion) => {
-  (0, _get_rtc_stats_report_adapter.default)(peerConnection, track, (err, rtcStatsReport) => {
-    if (err) {
-      completion(err);
-      return;
-    }
-    completion(null, (0, _createRtcStatsReportParser.default)()(rtcStatsReport));
+  const hasCompletion = typeof completion === 'function';
+  const callback = hasCompletion ? completion : () => {};
+  const promise = new Promise((resolve, reject) => {
+    (0, _get_rtc_stats_report_adapter.default)(peerConnection, track, (err, rtcStatsReport) => {
+      if (err) {
+        callback(err);
+        reject(err);
+        return;
+      }
+      const parsedReport = (0, _createRtcStatsReportParser.default)()(rtcStatsReport);
+      callback(null, parsedReport);
+      resolve(parsedReport);
+    });
   });
+  if (hasCompletion) {
+    promise.catch(() => {});
+  }
+  return promise;
 };
 exports["default"] = _default;