mediasoup-client 3.9.7 → 3.10.0

package/lib/Device.d.ts

@@ -15,6 +15,17 @@ export type DeviceOptions = {
      */
     handlerFactory?: HandlerFactory;
 };
+/**
+ * Async mediasoup-client Handler detection. More powerful than
+ * `detectDevice()`.
+ */
+export declare function detectDeviceAsync(userAgent?: string): Promise<BuiltinHandlerName | undefined>;
+/**
+ * Sync mediasoup-client Handler detection.
+ *
+ * @deprecated It only relies on navigator.userAgent. Use `detectDeviceAsync()`
+ * instead.
+ */
 export declare function detectDevice(userAgent?: string): BuiltinHandlerName | undefined;
 export type DeviceObserver = EnhancedEventEmitter<DeviceObserverEvents>;
 export type DeviceObserverEvents = {
@@ -29,6 +40,13 @@ export declare class Device {
     private readonly _canProduceByKind;
     private _sctpCapabilities?;
     protected readonly _observer: DeviceObserver;
+    /**
+     * Create a new Device to connect to mediasoup server. It uses a more advanced
+     * device detection.
+     *
+     * @throws {UnsupportedError} if device is not supported.
+     */
+    static factory({ handlerName, handlerFactory, }?: DeviceOptions): Promise<Device>;
     /**
      * Create a new Device to connect to mediasoup server.
      *

package/lib/Device.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Device.d.ts","sourceRoot":"","sources":["../src/Device.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAIxD,OAAO,EACN,SAAS,EACT,KAAK,gBAAgB,EAErB,MAAM,aAAa,CAAC;AACrB,OAAO,EACN,KAAK,cAAc,EAEnB,MAAM,6BAA6B,CAAC;AAarC,OAAO,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAClE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAIvC,MAAM,MAAM,kBAAkB,GAC3B,WAAW,GACX,UAAU,GACV,UAAU,GACV,UAAU,GACV,UAAU,GACV,YAAY,GACZ,WAAW,GACX,UAAU,GACV,UAAU,GACV,QAAQ,GACR,wBAAwB,GACxB,aAAa,CAAC;AAEjB,MAAM,MAAM,aAAa,GAAG;IAC3B;;OAEG;IACH,WAAW,CAAC,EAAE,kBAAkB,CAAC;IACjC;;OAEG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC;CAChC,CAAC;AAEF,wBAAgB,YAAY,CAC3B,SAAS,CAAC,EAAE,MAAM,GAChB,kBAAkB,GAAG,SAAS,CAwKhC;AAED,MAAM,MAAM,cAAc,GAAG,oBAAoB,CAAC,oBAAoB,CAAC,CAAC;AAExE,MAAM,MAAM,oBAAoB,GAAG;IAClC,YAAY,EAAE,CAAC,SAAS,CAAC,CAAC;CAC1B,CAAC;AAEF,qBAAa,MAAM;IAElB,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAiB;IAEjD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IAEtC,OAAO,CAAC,OAAO,CAAS;IAExB,OAAO,CAAC,wBAAwB,CAAC,CAAM;IAEvC,OAAO,CAAC,oBAAoB,CAAC,CAAkB;IAG/C,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAmB;IAErD,OAAO,CAAC,iBAAiB,CAAC,CAAmB;IAE7C,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,cAAc,CACM;IAElD;;;;OAIG;gBACS,EAAE,WAAW,EAAE,cAAc,EAAE,GAAE,aAAkB;IAuH/D;;OAEG;IACH,IAAI,WAAW,IAAI,MAAM,CAExB;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED;;;;OAIG;IACH,IAAI,eAAe,IAAI,eAAe,CAMrC;IAED;;;;OAIG;IACH,IAAI,gBAAgB,IAAI,gBAAgB,CAMvC;IAED,IAAI,QAAQ,IAAI,cAAc,CAE7B;IAED;;OAEG;IACG,IAAI,CAAC,EACV,qBAAqB,GACrB,EAAE;QACF,qBAAqB,EAAE,eAAe,CAAC;KACvC,GAAG,OAAO,CAAC,IAAI,CAAC;IA+FjB;;;;;OAKG;IACH,UAAU,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO;IAUpC;;;;;OAKG;IACH,mBAAmB,CAAC,gBAAgB,SAAS,OAAO,GAAG,OAAO,EAAE,EAC/D,EAAE,EACF,aAAa,EACb,aAAa,EACb,cAAc,EACd,cAAc,EACd,UAAU,EACV,kBAAkB,EAClB,kBAAkB,EAClB,sBAAsB,EACtB,OAAO,GACP,EAAE,gBAAgB,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,gBAAgB,CAAC;IAkBnE;;;;;OAKG;IACH,mBAAmB,CAAC,gBAAgB,SAAS,OAAO,GAAG,OAAO,EAAE,EAC/D,EAAE,EACF,aAAa,EACb,aAAa,EACb,cAAc,EACd,cAAc,EACd,UAAU,EACV,kBAAkB,EAClB,kBAAkB,EAClB,sBAAsB,EACtB,OAAO,GACP,EAAE,gBAAgB,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,gBAAgB,CAAC;IAkBnE,OAAO,CAAC,eAAe;CAsDvB"}
+{"version":3,"file":"Device.d.ts","sourceRoot":"","sources":["../src/Device.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAIxD,OAAO,EACN,SAAS,EACT,KAAK,gBAAgB,EAErB,MAAM,aAAa,CAAC;AACrB,OAAO,EACN,KAAK,cAAc,EAEnB,MAAM,6BAA6B,CAAC;AAarC,OAAO,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAClE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAIvC,MAAM,MAAM,kBAAkB,GAC3B,WAAW,GACX,UAAU,GACV,UAAU,GACV,UAAU,GACV,UAAU,GACV,YAAY,GACZ,WAAW,GACX,UAAU,GACV,UAAU,GACV,QAAQ,GACR,wBAAwB,GACxB,aAAa,CAAC;AAEjB,MAAM,MAAM,aAAa,GAAG;IAC3B;;OAEG;IACH,WAAW,CAAC,EAAE,kBAAkB,CAAC;IACjC;;OAEG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC;CAChC,CAAC;AAEF;;;GAGG;AACH,wBAAsB,iBAAiB,CACtC,SAAS,CAAC,EAAE,MAAM,GAChB,OAAO,CAAC,kBAAkB,GAAG,SAAS,CAAC,CAUzC;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAC3B,SAAS,CAAC,EAAE,MAAM,GAChB,kBAAkB,GAAG,SAAS,CAUhC;AAED,MAAM,MAAM,cAAc,GAAG,oBAAoB,CAAC,oBAAoB,CAAC,CAAC;AAExE,MAAM,MAAM,oBAAoB,GAAG;IAClC,YAAY,EAAE,CAAC,SAAS,CAAC,CAAC;CAC1B,CAAC;AAEF,qBAAa,MAAM;IAElB,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAiB;IAEjD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IAEtC,OAAO,CAAC,OAAO,CAAS;IAExB,OAAO,CAAC,wBAAwB,CAAC,CAAM;IAEvC,OAAO,CAAC,oBAAoB,CAAC,CAAkB;IAG/C,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAmB;IAErD,OAAO,CAAC,iBAAiB,CAAC,CAAmB;IAE7C,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,cAAc,CACM;IAElD;;;;;OAKG;WACU,OAAO,CAAC,EACpB,WAAW,EACX,cAAc,GACd,GAAE,aAAkB,GAAG,OAAO,CAAC,MAAM,CAAC;IAoBvC;;;;OAIG;gBACS,EAAE,WAAW,EAAE,cAAc,EAAE,GAAE,aAAkB;IAuH/D;;OAEG;IACH,IAAI,WAAW,IAAI,MAAM,CAExB;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED;;;;OAIG;IACH,IAAI,eAAe,IAAI,eAAe,CAMrC;IAED;;;;OAIG;IACH,IAAI,gBAAgB,IAAI,gBAAgB,CAMvC;IAED,IAAI,QAAQ,IAAI,cAAc,CAE7B;IAED;;OAEG;IACG,IAAI,CAAC,EACV,qBAAqB,GACrB,EAAE;QACF,qBAAqB,EAAE,eAAe,CAAC;KACvC,GAAG,OAAO,CAAC,IAAI,CAAC;IA+FjB;;;;;OAKG;IACH,UAAU,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO;IAUpC;;;;;OAKG;IACH,mBAAmB,CAAC,gBAAgB,SAAS,OAAO,GAAG,OAAO,EAAE,EAC/D,EAAE,EACF,aAAa,EACb,aAAa,EACb,cAAc,EACd,cAAc,EACd,UAAU,EACV,kBAAkB,EAClB,kBAAkB,EAClB,sBAAsB,EACtB,OAAO,GACP,EAAE,gBAAgB,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,gBAAgB,CAAC;IAkBnE;;;;;OAKG;IACH,mBAAmB,CAAC,gBAAgB,SAAS,OAAO,GAAG,OAAO,EAAE,EAC/D,EAAE,EACF,aAAa,EACb,aAAa,EACb,cAAc,EACd,cAAc,EACd,UAAU,EACV,kBAAkB,EAClB,kBAAkB,EAClB,sBAAsB,EACtB,OAAO,GACP,EAAE,gBAAgB,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,gBAAgB,CAAC;IAkBnE,OAAO,CAAC,eAAe;CAsDvB"}

package/lib/Device.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Device = void 0;
+exports.detectDeviceAsync = detectDeviceAsync;
 exports.detectDevice = detectDevice;
 const ua_parser_js_1 = require("ua-parser-js");
 const Logger_1 = require("./Logger");
@@ -22,144 +23,31 @@ const Edge11_1 = require("./handlers/Edge11");
 const ReactNativeUnifiedPlan_1 = require("./handlers/ReactNativeUnifiedPlan");
 const ReactNative_1 = require("./handlers/ReactNative");
 const logger = new Logger_1.Logger('Device');
-function detectDevice(userAgent) {
-    // React-Native.
-    // NOTE: react-native-webrtc >= 1.75.0 is required.
-    // NOTE: For Unified-Plan support, react-native-webrtc version >= 106.0.0 is
-    // required.
-    if (!userAgent &&
-        typeof navigator === 'object' &&
-        navigator.product === 'ReactNative') {
-        logger.debug('detectDevice() | React-Native detected');
-        if (typeof RTCPeerConnection === 'undefined') {
-            logger.warn('detectDevice() | unsupported react-native-webrtc without RTCPeerConnection, forgot to call registerGlobals()?');
-            return undefined;
-        }
-        if (typeof RTCRtpTransceiver !== 'undefined') {
-            logger.debug('detectDevice() | ReactNative UnifiedPlan handler chosen');
-            return 'ReactNativeUnifiedPlan';
-        }
-        else {
-            logger.debug('detectDevice() | ReactNative PlanB handler chosen');
-            return 'ReactNative';
-        }
-    }
-    // Browser.
-    else if (userAgent ||
-        (typeof navigator === 'object' && typeof navigator.userAgent === 'string')) {
-        userAgent ??= navigator.userAgent;
-        const uaParser = new ua_parser_js_1.UAParser(userAgent);
-        logger.debug('detectDevice() | browser detected [userAgent:%s, parsed:%o]', userAgent, uaParser.getResult());
-        const browser = uaParser.getBrowser();
-        const browserName = browser.name?.toLowerCase();
-        const browserVersion = parseInt(browser.major ?? '0');
-        const engine = uaParser.getEngine();
-        const engineName = engine.name?.toLowerCase();
-        const os = uaParser.getOS();
-        const osName = os.name?.toLowerCase();
-        const osVersion = parseFloat(os.version ?? '0');
-        const device = uaParser.getDevice();
-        const deviceModel = device.model?.toLowerCase();
-        const isIOS = osName === 'ios' || deviceModel === 'ipad';
-        const isChrome = browserName &&
-            [
-                'chrome',
-                'chromium',
-                'mobile chrome',
-                'chrome webview',
-                'chrome headless',
-            ].includes(browserName);
-        const isFirefox = browserName &&
-            ['firefox', 'mobile firefox', 'mobile focus'].includes(browserName);
-        const isSafari = browserName && ['safari', 'mobile safari'].includes(browserName);
-        const isEdge = browserName && ['edge'].includes(browserName);
-        // Chrome, Chromium, and Edge.
-        if ((isChrome || isEdge) && !isIOS && browserVersion >= 111) {
-            return 'Chrome111';
-        }
-        else if ((isChrome && !isIOS && browserVersion >= 74) ||
-            (isEdge && !isIOS && browserVersion >= 88)) {
-            return 'Chrome74';
-        }
-        else if (isChrome && !isIOS && browserVersion >= 70) {
-            return 'Chrome70';
-        }
-        else if (isChrome && !isIOS && browserVersion >= 67) {
-            return 'Chrome67';
-        }
-        else if (isChrome && !isIOS && browserVersion >= 55) {
-            return 'Chrome55';
-        }
-        // Firefox.
-        else if (isFirefox && !isIOS && browserVersion >= 120) {
-            return 'Firefox120';
-        }
-        else if (isFirefox && !isIOS && browserVersion >= 60) {
-            return 'Firefox60';
-        }
-        // Firefox on iOS (so Safari).
-        else if (isFirefox && isIOS && osVersion >= 14.3) {
-            return 'Safari12';
-        }
-        // Safari with Unified-Plan support enabled.
-        else if (isSafari &&
-            browserVersion >= 12 &&
-            typeof RTCRtpTransceiver !== 'undefined' &&
-            RTCRtpTransceiver.prototype.hasOwnProperty('currentDirection')) {
-            return 'Safari12';
-        }
-        // Safari with Plab-B support.
-        else if (isSafari && browserVersion >= 11) {
-            return 'Safari11';
-        }
-        // Old Edge with ORTC support.
-        else if (isEdge && !isIOS && browserVersion >= 11 && browserVersion <= 18) {
-            return 'Edge11';
-        }
-        // Best effort for WebKit based browsers in iOS.
-        else if (engineName === 'webkit' &&
-            isIOS &&
-            typeof RTCRtpTransceiver !== 'undefined' &&
-            RTCRtpTransceiver.prototype.hasOwnProperty('currentDirection')) {
-            return 'Safari12';
-        }
-        // Best effort for Chromium based browsers.
-        else if (engineName === 'blink') {
-            // eslint-disable-next-line @typescript-eslint/prefer-regexp-exec
-            const match = userAgent.match(/(?:(?:Chrome|Chromium))[ /](\w+)/i);
-            if (match) {
-                const version = Number(match[1]);
-                if (version >= 111) {
-                    return 'Chrome111';
-                }
-                else if (version >= 74) {
-                    return 'Chrome74';
-                }
-                else if (version >= 70) {
-                    return 'Chrome70';
-                }
-                else if (version >= 67) {
-                    return 'Chrome67';
-                }
-                else {
-                    return 'Chrome55';
-                }
-            }
-            else {
-                return 'Chrome111';
-            }
-        }
-        // Unsupported browser.
-        else {
-            logger.warn('detectDevice() | browser not supported [name:%s, version:%s]', browserName, browserVersion);
-            return undefined;
-        }
+/**
+ * Async mediasoup-client Handler detection. More powerful than
+ * `detectDevice()`.
+ */
+async function detectDeviceAsync(userAgent) {
+    logger.debug('detectDeviceAsync() [userAgent:%s]', userAgent);
+    if (!userAgent && typeof navigator === 'object') {
+        userAgent = navigator.userAgent;
     }
-    // Unknown device.
-    else {
-        logger.warn('detectDevice() | unknown device');
-        return undefined;
+    const uaParserResult = await (0, ua_parser_js_1.UAParser)(userAgent).withFeatureCheck();
+    return detectDeviceImpl(uaParserResult);
+}
+/**
+ * Sync mediasoup-client Handler detection.
+ *
+ * @deprecated It only relies on navigator.userAgent. Use `detectDeviceAsync()`
+ * instead.
+ */
+function detectDevice(userAgent) {
+    logger.debug('detectDevice() [userAgent:%s]', userAgent);
+    if (!userAgent && typeof navigator === 'object') {
+        userAgent = navigator.userAgent;
     }
+    const uaParserResult = (0, ua_parser_js_1.UAParser)(userAgent);
+    return detectDeviceImpl(uaParserResult);
 }
 class Device {
     // RTC handler factory.
@@ -179,6 +67,25 @@ class Device {
     _sctpCapabilities;
     // Observer instance.
     _observer = new enhancedEvents_1.EnhancedEventEmitter();
+    /**
+     * Create a new Device to connect to mediasoup server. It uses a more advanced
+     * device detection.
+     *
+     * @throws {UnsupportedError} if device is not supported.
+     */
+    static async factory({ handlerName, handlerFactory, } = {}) {
+        logger.debug('factory()');
+        if (handlerName && handlerFactory) {
+            throw new TypeError('just one of handlerName or handlerInterface can be given');
+        }
+        if (!handlerName && !handlerFactory) {
+            handlerName = await detectDeviceAsync();
+            if (!handlerName) {
+                throw new errors_1.UnsupportedError('device not supported');
+            }
+        }
+        return new Device({ handlerName, handlerFactory });
+    }
     /**
      * Create a new Device to connect to mediasoup server.
      *
@@ -461,3 +368,132 @@ class Device {
     }
 }
 exports.Device = Device;
+function detectDeviceImpl(uaParserResult) {
+    // React-Native.
+    // NOTE: react-native-webrtc >= 1.75.0 is required.
+    // NOTE: For Unified-Plan support, react-native-webrtc version >= 106.0.0 is
+    // required.
+    if (typeof navigator === 'object' && navigator.product === 'ReactNative') {
+        logger.debug('detectDeviceImpl() | React-Native detected');
+        if (typeof RTCPeerConnection === 'undefined') {
+            logger.warn('detectDeviceImpl() | unsupported react-native-webrtc without RTCPeerConnection, forgot to call registerGlobals()?');
+            return undefined;
+        }
+        if (typeof RTCRtpTransceiver !== 'undefined') {
+            logger.debug('detectDeviceImpl() | ReactNative UnifiedPlan handler chosen');
+            return 'ReactNativeUnifiedPlan';
+        }
+        else {
+            logger.debug('detectDeviceImpl() | ReactNative PlanB handler chosen');
+            return 'ReactNative';
+        }
+    }
+    // Browser.
+    else {
+        logger.debug('detectDeviceImpl() | browser detected [userAgent:%s, parsed:%o]', uaParserResult.ua, uaParserResult);
+        const browser = uaParserResult.browser;
+        const browserName = browser.name?.toLowerCase();
+        const browserVersion = parseInt(browser.major ?? '0');
+        const engine = uaParserResult.engine;
+        const engineName = engine.name?.toLowerCase();
+        const os = uaParserResult.os;
+        const osName = os.name?.toLowerCase();
+        const osVersion = parseFloat(os.version ?? '0');
+        const device = uaParserResult.device;
+        const deviceModel = device.model?.toLowerCase();
+        const isIOS = osName === 'ios' || deviceModel === 'ipad';
+        const isChrome = browserName &&
+            [
+                'chrome',
+                'chromium',
+                'mobile chrome',
+                'chrome webview',
+                'chrome headless',
+            ].includes(browserName);
+        const isFirefox = browserName &&
+            ['firefox', 'mobile firefox', 'mobile focus'].includes(browserName);
+        const isSafari = browserName && ['safari', 'mobile safari'].includes(browserName);
+        const isEdge = browserName && ['edge'].includes(browserName);
+        // Chrome, Chromium, and Edge.
+        if ((isChrome || isEdge) && !isIOS && browserVersion >= 111) {
+            return 'Chrome111';
+        }
+        else if ((isChrome && !isIOS && browserVersion >= 74) ||
+            (isEdge && !isIOS && browserVersion >= 88)) {
+            return 'Chrome74';
+        }
+        else if (isChrome && !isIOS && browserVersion >= 70) {
+            return 'Chrome70';
+        }
+        else if (isChrome && !isIOS && browserVersion >= 67) {
+            return 'Chrome67';
+        }
+        else if (isChrome && !isIOS && browserVersion >= 55) {
+            return 'Chrome55';
+        }
+        // Firefox.
+        else if (isFirefox && !isIOS && browserVersion >= 120) {
+            return 'Firefox120';
+        }
+        else if (isFirefox && !isIOS && browserVersion >= 60) {
+            return 'Firefox60';
+        }
+        // Firefox on iOS (so Safari).
+        else if (isFirefox && isIOS && osVersion >= 14.3) {
+            return 'Safari12';
+        }
+        // Safari with Unified-Plan support enabled.
+        else if (isSafari &&
+            browserVersion >= 12 &&
+            typeof RTCRtpTransceiver !== 'undefined' &&
+            RTCRtpTransceiver.prototype.hasOwnProperty('currentDirection')) {
+            return 'Safari12';
+        }
+        // Safari with Plab-B support.
+        else if (isSafari && browserVersion >= 11) {
+            return 'Safari11';
+        }
+        // Old Edge with ORTC support.
+        else if (isEdge && !isIOS && browserVersion >= 11 && browserVersion <= 18) {
+            return 'Edge11';
+        }
+        // Best effort for WebKit based browsers in iOS.
+        else if (engineName === 'webkit' &&
+            isIOS &&
+            typeof RTCRtpTransceiver !== 'undefined' &&
+            RTCRtpTransceiver.prototype.hasOwnProperty('currentDirection')) {
+            return 'Safari12';
+        }
+        // Best effort for Chromium based browsers.
+        else if (engineName === 'blink') {
+            // eslint-disable-next-line @typescript-eslint/prefer-regexp-exec
+            const match = uaParserResult.ua.match(/(?:(?:Chrome|Chromium))[ /](\w+)/i);
+            if (match) {
+                const version = Number(match[1]);
+                if (version >= 111) {
+                    return 'Chrome111';
+                }
+                else if (version >= 74) {
+                    return 'Chrome74';
+                }
+                else if (version >= 70) {
+                    return 'Chrome70';
+                }
+                else if (version >= 67) {
+                    return 'Chrome67';
+                }
+                else {
+                    return 'Chrome55';
+                }
+            }
+            else {
+                return 'Chrome111';
+            }
+        }
+        // Unsupported browser.
+        else {
+            logger.warn('detectDeviceImpl() | browser not supported [name:%s, version:%s]', browserName, browserVersion);
+            return undefined;
+        }
+    }
+}

package/lib/index.d.ts

@@ -6,11 +6,11 @@ export * as types from './types';
 /**
  * Expose mediasoup-client version.
  */
-export declare const version = "__MEDIASOUP_CLIENT_VERSION__";
+export declare const version = "3.10.0";
 /**
- * Expose Device class and detectDevice() helper.
+ * Expose Device class and device detector helpers.
  */
-export { Device, detectDevice } from './Device';
+export { Device, detectDevice, detectDeviceAsync } from './Device';
 /**
  * Expose parseScalabilityMode() function.
  */

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B;;GAEG;AACH,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AAEjC;;GAEG;AACH,eAAO,MAAM,OAAO,iCAAiC,CAAC;AAEtD;;GAEG;AACH,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAEhD;;GAEG;AACH,OAAO,EAAE,KAAK,IAAI,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAEnE;;GAEG;AACH,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAE/B;;GAEG;AACH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAErD;;GAEG;AACH,OAAO,KAAK,kBAAkB,MAAM,uBAAuB,CAAC;AAE5D;;GAEG;AACH,OAAO,EAAE,KAAK,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B;;GAEG;AACH,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AAEjC;;GAEG;AACH,eAAO,MAAM,OAAO,iCAAiC,CAAC;AAEtD;;GAEG;AACH,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAEnE;;GAEG;AACH,OAAO,EAAE,KAAK,IAAI,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAEnE;;GAEG;AACH,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAE/B;;GAEG;AACH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAErD;;GAEG;AACH,OAAO,KAAK,kBAAkB,MAAM,uBAAuB,CAAC;AAE5D;;GAEG;AACH,OAAO,EAAE,KAAK,EAAE,CAAC"}

package/lib/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.debug = exports.testFakeParameters = exports.FakeHandler = exports.ortc = exports.parseScalabilityMode = exports.detectDevice = exports.Device = exports.version = exports.types = void 0;
+exports.debug = exports.testFakeParameters = exports.FakeHandler = exports.ortc = exports.parseScalabilityMode = exports.detectDeviceAsync = exports.detectDevice = exports.Device = exports.version = exports.types = void 0;
 const debug_1 = require("debug");
 exports.debug = debug_1.default;
 /**
@@ -10,13 +10,14 @@ exports.types = require("./types");
 /**
  * Expose mediasoup-client version.
  */
-exports.version = '__MEDIASOUP_CLIENT_VERSION__';
+exports.version = '3.10.0';
 /**
- * Expose Device class and detectDevice() helper.
+ * Expose Device class and device detector helpers.
  */
 var Device_1 = require("./Device");
 Object.defineProperty(exports, "Device", { enumerable: true, get: function () { return Device_1.Device; } });
 Object.defineProperty(exports, "detectDevice", { enumerable: true, get: function () { return Device_1.detectDevice; } });
+Object.defineProperty(exports, "detectDeviceAsync", { enumerable: true, get: function () { return Device_1.detectDeviceAsync; } });
 /**
  * Expose parseScalabilityMode() function.
  */

package/lib/test/test.js

@@ -13,7 +13,7 @@ const RemoteSdp_1 = require("../handlers/sdp/RemoteSdp");
 const FakeHandler_1 = require("../handlers/FakeHandler");
 const fakeParameters = require("./fakeParameters");
 const uaTestCases_1 = require("./uaTestCases");
-const { Device, detectDevice, parseScalabilityMode, debug } = mediasoupClient;
+const { Device, detectDevice, detectDeviceAsync, parseScalabilityMode, debug } = mediasoupClient;
 const ctx = {};
 beforeEach(async () => {
     ctx.device = new Device({
@@ -1268,11 +1268,11 @@ test('parseScalabilityMode() works', () => {
         temporalLayers: 1,
     });
 });
-describe('detectDevice() assigns proper handler based on UserAgent', () => {
+describe('detectDevice() and detectDeviceAsync() assign proper handler based on UserAgent', () => {
     for (const uaTestCase of uaTestCases_1.uaTestCases) {
         test(
         // eslint-disable-next-line jest/valid-title --- Jest is not that smart.
-        uaTestCase.desc, () => {
+        uaTestCase.desc, async () => {
             const originalRTCRtpTransceiver = global.RTCRtpTransceiver;
             // We need to force presence of RTCRtpTransceiver to test Safari 12.
             if (uaTestCase.expect === 'Safari12') {
@@ -1283,6 +1283,7 @@ describe('detectDevice() assigns proper handler based on UserAgent', () => {
                 };
             }
             expect(detectDevice(uaTestCase.ua)).toBe(uaTestCase.expect);
+            await expect(detectDeviceAsync(uaTestCase.ua)).resolves.toBe(uaTestCase.expect);
             // Cleanup.
             global.RTCRtpTransceiver = originalRTCRtpTransceiver;
         }, 100);

package/npm-scripts.mjs

@@ -53,6 +53,7 @@ async function run() {
 		// So here we compile TypeScript to JavaScript.
 		case 'prepare': {
 			buildTypescript({ force: false });
+			replaceVersion();
 
 			break;
 		}
@@ -155,7 +156,7 @@ function deleteLib() {
 }
 
 function buildTypescript({ force }) {
-	if (!force && fs.existsSync('node/lib')) {
+	if (!force && fs.existsSync('lib')) {
 		return;
 	}
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "mediasoup-client",
-	"version": "3.9.7",
+	"version": "3.10.0",
 	"description": "mediasoup client side TypeScript library",
 	"contributors": [
 		"Iñaki Baz Castillo <ibc@aliax.net> (https://inakibaz.me)",
@@ -81,11 +81,11 @@
 	"devDependencies": {
 		"@eslint/js": "^9.25.1",
 		"@types/jest": "^29.5.14",
-		"@types/node": "^22.14.1",
+		"@types/node": "^22.15.3",
 		"@types/sdp-transform": "^2.4.9",
 		"@types/ua-parser-js": "^0.7.39",
-		"@typescript-eslint/eslint-plugin": "^8.31.0",
-		"@typescript-eslint/parser": "^8.31.0",
+		"@typescript-eslint/eslint-plugin": "^8.31.1",
+		"@typescript-eslint/parser": "^8.31.1",
 		"eslint": "^9.25.1",
 		"eslint-config-prettier": "^10.1.2",
 		"eslint-plugin-jest": "^28.11.0",
@@ -96,6 +96,6 @@
 		"prettier": "^3.5.3",
 		"ts-jest": "^29.3.2",
 		"typescript": "^5.8.3",
-		"typescript-eslint": "^8.31.0"
+		"typescript-eslint": "^8.31.1"
 	}
 }