appium-xcuitest-driver 10.2.2 → 10.4.0

package/build/lib/commands/location.js

@@ -1,117 +1,118 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getGeoLocation = getGeoLocation;
+exports.setGeoLocation = setGeoLocation;
+exports.mobileResetLocationService = mobileResetLocationService;
 const appium_ios_device_1 = require("appium-ios-device");
 const driver_1 = require("appium/driver");
 const support_1 = require("appium/support");
 const enum_1 = require("./enum");
 const utils_1 = require("../utils");
-exports.default = {
-    /**
-     * Returns location of the device under test.
-     * The device under test must allow the location services for WDA
-     * as 'Always' to get the location data correctly.
-     *
-     * The 'latitude', 'longitude' and 'altitude' could be zero even
-     * if the Location Services are set to 'Always', because the device
-     * needs some time to update the location data.
-     *
-     * For iOS 17, the return value could be the result of
-     * "mobile:getSimulatedLocation" if the simulated location has been previously set
-     * "mobile:setSimulatedLocation" already.
-     *
-     * @returns {Promise<import('./types').LocationWithAltitude>}
-     * @throws {Error} If the device under test returns an error message.
-     *                 i.e.: tvOS returns unsupported error
-     * @this {XCUITestDriver}
-     */
-    async getGeoLocation() {
-        // Currently we proxy the setGeoLocation to mobile:setSimulatedLocation for iOS 17+.
-        // It would be helpful to address to use "mobile:getSimulatedLocation" for iOS 17+.
-        if ((0, utils_1.isIos17OrNewer)(this.opts)) {
-            const { latitude, longitude } = await this.mobileGetSimulatedLocation();
-            if (latitude && longitude) {
-                this.log.debug('Returning the geolocation that has been previously set by mobile:setSimulatedLocation. ' +
-                    'mobile:resetSimulatedLocation can reset the location configuration.');
-                return { latitude, longitude, altitude: 0 };
-            }
-            this.log.warn(`No location was set by mobile:setSimulatedLocation. Trying to return the location from the device.`);
-        }
-        // Please do not change the way to get the location here with '/wda/simulatedLocation'
-        // endpoint because they could return different value before setting the simulated location.
-        // '/wda/device/location' returns current device location information,
-        // but '/wda/simulatedLocation' returns `null` values until the WDA process
-        // sets a simulated location. After setting the value, both returns the same values.
-        const { authorizationStatus, latitude, longitude, altitude } = /** @type {WDALocationInfo} */ (await this.proxyCommand('/wda/device/location', 'GET'));
-        // '3' is 'Always' in the privacy
-        // https://developer.apple.com/documentation/corelocation/clauthorizationstatus
-        if (authorizationStatus !== enum_1.AuthorizationStatus.authorizedAlways) {
-            throw this.log.errorWithException(`Location service must be set to 'Always' in order to ` +
-                `retrieve the current geolocation data. Please set it up manually via ` +
-                `'Settings > Privacy > Location Services -> WebDriverAgentRunner-Runner'. ` +
-                `Or please use 'mobile:getSimulatedLocation'/'mobile:setSimulatedLocation' commands ` +
-                `to simulate locations instead.`);
-        }
-        return { latitude, longitude, altitude };
-    },
-    /**
-     * Set location of the device under test.
-     *
-     * iOS 17+ real device environment will be via "mobile:setSimulatedLocation" as
-     * setting simulated location for XCTest session.
-     *
-     * @param {Partial<Location>} location
-     * @this {XCUITestDriver}
-     */
-    async setGeoLocation(location) {
-        let { latitude, longitude } = location;
-        if (!support_1.util.hasValue(latitude) || !support_1.util.hasValue(longitude)) {
-            throw new driver_1.errors.InvalidArgumentError(`Both latitude and longitude should be set`);
-        }
-        if (this.isSimulator()) {
-            await /** @type {import('../driver').Simulator} */ (this.device).setGeolocation(`${latitude}`, `${longitude}`);
-            return /** @type {Location} */ ({ latitude, longitude, altitude: 0 });
-        }
-        if ((0, utils_1.isIos17OrNewer)(this.opts)) {
-            this.log.info(`Proxying to mobile:setSimulatedLocation method for iOS 17+ platform version`);
-            await this.mobileSetSimulatedLocation(latitude, longitude);
-        }
-        else {
-            const service = await appium_ios_device_1.services.startSimulateLocationService(this.opts.udid);
-            try {
-                service.setLocation(latitude, longitude);
-            }
-            catch (e) {
-                throw this.log.errorWithException(`Can't set the location on device '${this.opts.udid}'. Original error: ${e.message}`);
-            }
-            finally {
-                service.close();
-            }
+/**
+ * Returns location of the device under test.
+ * The device under test must allow the location services for WDA
+ * as 'Always' to get the location data correctly.
+ *
+ * The 'latitude', 'longitude' and 'altitude' could be zero even
+ * if the Location Services are set to 'Always', because the device
+ * needs some time to update the location data.
+ *
+ * For iOS 17, the return value could be the result of
+ * "mobile:getSimulatedLocation" if the simulated location has been previously set
+ * "mobile:setSimulatedLocation" already.
+ *
+ * @returns {Promise<import('./types').LocationWithAltitude>}
+ * @throws {Error} If the device under test returns an error message.
+ *                 i.e.: tvOS returns unsupported error
+ * @this {XCUITestDriver}
+ */
+async function getGeoLocation() {
+    // Currently we proxy the setGeoLocation to mobile:setSimulatedLocation for iOS 17+.
+    // It would be helpful to address to use "mobile:getSimulatedLocation" for iOS 17+.
+    if ((0, utils_1.isIos17OrNewer)(this.opts)) {
+        const { latitude, longitude } = await this.mobileGetSimulatedLocation();
+        if (latitude && longitude) {
+            this.log.debug('Returning the geolocation that has been previously set by mobile:setSimulatedLocation. ' +
+                'mobile:resetSimulatedLocation can reset the location configuration.');
+            return { latitude, longitude, altitude: 0 };
         }
+        this.log.warn(`No location was set by mobile:setSimulatedLocation. Trying to return the location from the device.`);
+    }
+    // Please do not change the way to get the location here with '/wda/simulatedLocation'
+    // endpoint because they could return different value before setting the simulated location.
+    // '/wda/device/location' returns current device location information,
+    // but '/wda/simulatedLocation' returns `null` values until the WDA process
+    // sets a simulated location. After setting the value, both returns the same values.
+    const { authorizationStatus, latitude, longitude, altitude } = /** @type {WDALocationInfo} */ (await this.proxyCommand('/wda/device/location', 'GET'));
+    // '3' is 'Always' in the privacy
+    // https://developer.apple.com/documentation/corelocation/clauthorizationstatus
+    if (authorizationStatus !== enum_1.AuthorizationStatus.authorizedAlways) {
+        throw this.log.errorWithException(`Location service must be set to 'Always' in order to ` +
+            `retrieve the current geolocation data. Please set it up manually via ` +
+            `'Settings > Privacy > Location Services -> WebDriverAgentRunner-Runner'. ` +
+            `Or please use 'mobile:getSimulatedLocation'/'mobile:setSimulatedLocation' commands ` +
+            `to simulate locations instead.`);
+    }
+    return { latitude, longitude, altitude };
+}
+/**
+ * Set location of the device under test.
+ *
+ * iOS 17+ real device environment will be via "mobile:setSimulatedLocation" as
+ * setting simulated location for XCTest session.
+ *
+ * @param {Partial<Location>} location
+ * @this {XCUITestDriver}
+ */
+async function setGeoLocation(location) {
+    let { latitude, longitude } = location;
+    if (!support_1.util.hasValue(latitude) || !support_1.util.hasValue(longitude)) {
+        throw new driver_1.errors.InvalidArgumentError(`Both latitude and longitude should be set`);
+    }
+    if (this.isSimulator()) {
+        await /** @type {import('../driver').Simulator} */ (this.device).setGeolocation(`${latitude}`, `${longitude}`);
         return /** @type {Location} */ ({ latitude, longitude, altitude: 0 });
-    },
-    /**
-     * Reset the location service on real device.
-     * Raises not implemented error for simulator.
-     * @throws {Error} If the device is simulator, or 'resetLocation' raises an error.
-     * @this {XCUITestDriver}
-     */
-    async mobileResetLocationService() {
-        if (this.isSimulator()) {
-            throw new driver_1.errors.NotImplementedError();
-        }
+    }
+    if ((0, utils_1.isIos17OrNewer)(this.opts)) {
+        this.log.info(`Proxying to mobile:setSimulatedLocation method for iOS 17+ platform version`);
+        await this.mobileSetSimulatedLocation(latitude, longitude);
+    }
+    else {
         const service = await appium_ios_device_1.services.startSimulateLocationService(this.opts.udid);
         try {
-            service.resetLocation();
+            service.setLocation(latitude, longitude);
         }
-        catch (err) {
-            throw this.log.errorWithException(`Failed to reset the location on the device on device '${this.opts.udid}'. ` +
-                `Original error: ${err.message}`);
+        catch (e) {
+            throw this.log.errorWithException(`Can't set the location on device '${this.opts.udid}'. Original error: ${e.message}`);
         }
         finally {
             service.close();
         }
-    },
-};
+    }
+    return /** @type {Location} */ ({ latitude, longitude, altitude: 0 });
+}
+/**
+ * Reset the location service on real device.
+ * Raises not implemented error for simulator.
+ * @throws {Error} If the device is simulator, or 'resetLocation' raises an error.
+ * @this {XCUITestDriver}
+ */
+async function mobileResetLocationService() {
+    if (this.isSimulator()) {
+        throw new driver_1.errors.NotImplementedError();
+    }
+    const service = await appium_ios_device_1.services.startSimulateLocationService(this.opts.udid);
+    try {
+        service.resetLocation();
+    }
+    catch (err) {
+        throw this.log.errorWithException(`Failed to reset the location on the device on device '${this.opts.udid}'. ` +
+            `Original error: ${err.message}`);
+    }
+    finally {
+        service.close();
+    }
+}
 /**
  * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
  * @typedef {import('./types').WDALocationInfo} WDALocationInfo

package/build/lib/commands/location.js.map

@@ -1 +1 @@
-{"version":3,"file":"location.js","sourceRoot":"","sources":["../../../lib/commands/location.js"],"names":[],"mappings":";;AAAA,yDAA2C;AAC3C,0CAAqC;AACrC,4CAAoC;AACpC,iCAA2C;AAC3C,oCAA0C;AAE1C,kBAAe;IACb;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,cAAc;QAClB,oFAAoF;QACpF,mFAAmF;QACnF,IAAI,IAAA,sBAAc,EAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC9B,MAAM,EAAC,QAAQ,EAAE,SAAS,EAAC,GAAG,MAAM,IAAI,CAAC,0BAA0B,EAAE,CAAC;YACtE,IAAI,QAAQ,IAAI,SAAS,EAAE,CAAC;gBAC1B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,yFAAyF;oBACtG,qEAAqE,CAAC,CAAC;gBACzE,OAAO,EAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,EAAC,CAAC;YAC5C,CAAC;YAED,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,oGAAoG,CAAC,CAAC;QACtH,CAAC;QAED,sFAAsF;QACtF,4FAA4F;QAC5F,sEAAsE;QACtE,2EAA2E;QAC3E,oFAAoF;QACpF,MAAM,EAAC,mBAAmB,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAC,GAAG,8BAA8B,CAAC,CAC1F,MAAM,IAAI,CAAC,YAAY,CAAC,sBAAsB,EAAE,KAAK,CAAC,CACvD,CAAC;QAEF,iCAAiC;QACjC,+EAA+E;QAC/E,IAAI,mBAAmB,KAAK,0BAAmB,CAAC,gBAAgB,EAAE,CAAC;YACjE,MAAM,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAC/B,uDAAuD;gBACrD,uEAAuE;gBACvE,2EAA2E;gBAC3E,qFAAqF;gBACrF,gCAAgC,CACnC,CAAC;QACJ,CAAC;QAED,OAAO,EAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAC,CAAC;IACzC,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,cAAc,CAAC,QAAQ;QAC3B,IAAI,EAAC,QAAQ,EAAE,SAAS,EAAC,GAAG,QAAQ,CAAC;QAErC,IAAI,CAAC,cAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YAC1D,MAAM,IAAI,eAAM,CAAC,oBAAoB,CAAC,2CAA2C,CAAC,CAAC;QACrF,CAAC;QAED,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACvB,MAAM,4CAA4C,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,cAAc,CAAC,GAAG,QAAQ,EAAE,EAAE,GAAG,SAAS,EAAE,CAAC,CAAC;YAC/G,OAAO,uBAAuB,CAAC,CAAC,EAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,EAAC,CAAC,CAAC;QACtE,CAAC;QAED,IAAI,IAAA,sBAAc,EAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC9B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,6EAA6E,CAAC,CAAC;YAC7F,MAAM,IAAI,CAAC,0BAA0B,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QAC7D,CAAC;aAAM,CAAC;YACN,MAAM,OAAO,GAAG,MAAM,4BAAQ,CAAC,4BAA4B,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC5E,IAAI,CAAC;gBACH,OAAO,CAAC,WAAW,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;YAC3C,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,MAAM,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAC/B,qCAAqC,IAAI,CAAC,IAAI,CAAC,IAAI,sBAAsB,CAAC,CAAC,OAAO,EAAE,CACrF,CAAC;YACJ,CAAC;oBAAS,CAAC;gBACT,OAAO,CAAC,KAAK,EAAE,CAAC;YAClB,CAAC;QACH,CAAC;QAED,OAAO,uBAAuB,CAAC,CAAC,EAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,EAAC,CAAC,CAAC;IACtE,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,0BAA0B;QAC9B,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACvB,MAAM,IAAI,eAAM,CAAC,mBAAmB,EAAE,CAAC;QACzC,CAAC;QAED,MAAM,OAAO,GAAG,MAAM,4BAAQ,CAAC,4BAA4B,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5E,IAAI,CAAC;YACH,OAAO,CAAC,aAAa,EAAE,CAAC;QAC1B,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAC/B,yDAAyD,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK;gBAC1E,mBAAmB,GAAG,CAAC,OAAO,EAAE,CACnC,CAAC;QACJ,CAAC;gBAAS,CAAC;YACT,OAAO,CAAC,KAAK,EAAE,CAAC;QAClB,CAAC;IACH,CAAC;CACF,CAAC;AAEF;;;;GAIG"}
+{"version":3,"file":"location.js","sourceRoot":"","sources":["../../../lib/commands/location.js"],"names":[],"mappings":";;AAwBA,wCAoCC;AAWD,wCA6BC;AAQD,gEAgBC;AA5HD,yDAA2C;AAC3C,0CAAqC;AACrC,4CAAoC;AACpC,iCAA2C;AAC3C,oCAA0C;AAE1C;;;;;;;;;;;;;;;;;GAiBG;AACI,KAAK,UAAU,cAAc;IAClC,oFAAoF;IACpF,mFAAmF;IACnF,IAAI,IAAA,sBAAc,EAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAC9B,MAAM,EAAC,QAAQ,EAAE,SAAS,EAAC,GAAG,MAAM,IAAI,CAAC,0BAA0B,EAAE,CAAC;QACtE,IAAI,QAAQ,IAAI,SAAS,EAAE,CAAC;YAC1B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,yFAAyF;gBACtG,qEAAqE,CAAC,CAAC;YACzE,OAAO,EAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,EAAC,CAAC;QAC5C,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,oGAAoG,CAAC,CAAC;IACtH,CAAC;IAED,sFAAsF;IACtF,4FAA4F;IAC5F,sEAAsE;IACtE,2EAA2E;IAC3E,oFAAoF;IACpF,MAAM,EAAC,mBAAmB,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAC,GAAG,8BAA8B,CAAC,CAC1F,MAAM,IAAI,CAAC,YAAY,CAAC,sBAAsB,EAAE,KAAK,CAAC,CACvD,CAAC;IAEF,iCAAiC;IACjC,+EAA+E;IAC/E,IAAI,mBAAmB,KAAK,0BAAmB,CAAC,gBAAgB,EAAE,CAAC;QACjE,MAAM,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAC/B,uDAAuD;YACrD,uEAAuE;YACvE,2EAA2E;YAC3E,qFAAqF;YACrF,gCAAgC,CACnC,CAAC;IACJ,CAAC;IAED,OAAO,EAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAC,CAAC;AACzC,CAAC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,cAAc,CAAC,QAAQ;IAC3C,IAAI,EAAC,QAAQ,EAAE,SAAS,EAAC,GAAG,QAAQ,CAAC;IAErC,IAAI,CAAC,cAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;QAC1D,MAAM,IAAI,eAAM,CAAC,oBAAoB,CAAC,2CAA2C,CAAC,CAAC;IACrF,CAAC;IAED,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QACvB,MAAM,4CAA4C,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,cAAc,CAAC,GAAG,QAAQ,EAAE,EAAE,GAAG,SAAS,EAAE,CAAC,CAAC;QAC/G,OAAO,uBAAuB,CAAC,CAAC,EAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,EAAC,CAAC,CAAC;IACtE,CAAC;IAED,IAAI,IAAA,sBAAc,EAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAC9B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,6EAA6E,CAAC,CAAC;QAC7F,MAAM,IAAI,CAAC,0BAA0B,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IAC7D,CAAC;SAAM,CAAC;QACN,MAAM,OAAO,GAAG,MAAM,4BAAQ,CAAC,4BAA4B,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5E,IAAI,CAAC;YACH,OAAO,CAAC,WAAW,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QAC3C,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAC/B,qCAAqC,IAAI,CAAC,IAAI,CAAC,IAAI,sBAAsB,CAAC,CAAC,OAAO,EAAE,CACrF,CAAC;QACJ,CAAC;gBAAS,CAAC;YACT,OAAO,CAAC,KAAK,EAAE,CAAC;QAClB,CAAC;IACH,CAAC;IAED,OAAO,uBAAuB,CAAC,CAAC,EAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,EAAC,CAAC,CAAC;AACtE,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,0BAA0B;IAC9C,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QACvB,MAAM,IAAI,eAAM,CAAC,mBAAmB,EAAE,CAAC;IACzC,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,4BAAQ,CAAC,4BAA4B,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5E,IAAI,CAAC;QACH,OAAO,CAAC,aAAa,EAAE,CAAC;IAC1B,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAC/B,yDAAyD,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK;YAC1E,mBAAmB,GAAG,CAAC,OAAO,EAAE,CACnC,CAAC;IACJ,CAAC;YAAS,CAAC;QACT,OAAO,CAAC,KAAK,EAAE,CAAC;IAClB,CAAC;AACH,CAAC;AAED;;;;GAIG"}

package/build/lib/commands/lock.d.ts

@@ -1,26 +1,23 @@
-declare namespace _default {
-    /**
-     * Lock the device (and optionally unlock the device after a certain amount of time)
-     *
-     * @param {number|string} [seconds] - the number of seconds after which to unlock the device. Set to `0` or leave empty to require manual unlock (do not automatically unlock).
-     * @defaultValue 0
-     * @this {XCUITestDriver}
-     */
-    function lock(this: import("../driver").XCUITestDriver, seconds?: number | string): Promise<void>;
-    /**
-     * Unlock the device
-     *
-     * @this {XCUITestDriver}
-     */
-    function unlock(this: import("../driver").XCUITestDriver): Promise<void>;
-    /**
-     * Determine whether the device is locked
-     *
-     * @this {XCUITestDriver}
-     * @returns {Promise<boolean>} `true` if the device is locked, `false` otherwise
-     */
-    function isLocked(this: import("../driver").XCUITestDriver): Promise<boolean>;
-}
-export default _default;
+/**
+ * Lock the device (and optionally unlock the device after a certain amount of time)
+ *
+ * @param {number|string} [seconds] - the number of seconds after which to unlock the device. Set to `0` or leave empty to require manual unlock (do not automatically unlock).
+ * @defaultValue 0
+ * @this {XCUITestDriver}
+ */
+export function lock(this: import("../driver").XCUITestDriver, seconds?: number | string): Promise<void>;
+/**
+ * Unlock the device
+ *
+ * @this {XCUITestDriver}
+ */
+export function unlock(this: import("../driver").XCUITestDriver): Promise<void>;
+/**
+ * Determine whether the device is locked
+ *
+ * @this {XCUITestDriver}
+ * @returns {Promise<boolean>} `true` if the device is locked, `false` otherwise
+ */
+export function isLocked(this: import("../driver").XCUITestDriver): Promise<boolean>;
 export type XCUITestDriver = import("../driver").XCUITestDriver;
 //# sourceMappingURL=lock.d.ts.map

package/build/lib/commands/lock.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"lock.d.ts","sourceRoot":"","sources":["../../../lib/commands/lock.js"],"names":[],"mappings":";IAGE;;;;;;OAMG;IACH,kEAJW,MAAM,GAAC,MAAM,iBAiBvB;IACD;;;;OAIG;IACH,yEAEC;IACD;;;;;OAKG;IACH,6DAFa,OAAO,CAAC,OAAO,CAAC,CAI5B;;;6BAIU,OAAO,WAAW,EAAE,cAAc"}
+{"version":3,"file":"lock.d.ts","sourceRoot":"","sources":["../../../lib/commands/lock.js"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,yEAJW,MAAM,GAAC,MAAM,iBAiBvB;AAED;;;;GAIG;AACH,gFAEC;AAED;;;;;GAKG;AACH,oEAFa,OAAO,CAAC,OAAO,CAAC,CAI5B;6BAGY,OAAO,WAAW,EAAE,cAAc"}

package/build/lib/commands/lock.js

@@ -3,45 +3,46 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.lock = lock;
+exports.unlock = unlock;
+exports.isLocked = isLocked;
 const bluebird_1 = __importDefault(require("bluebird"));
-exports.default = {
-    /**
-     * Lock the device (and optionally unlock the device after a certain amount of time)
-     *
-     * @param {number|string} [seconds] - the number of seconds after which to unlock the device. Set to `0` or leave empty to require manual unlock (do not automatically unlock).
-     * @defaultValue 0
-     * @this {XCUITestDriver}
-     */
-    async lock(seconds) {
-        await this.proxyCommand('/wda/lock', 'POST');
-        if (isNaN(Number(seconds))) {
-            return;
-        }
-        const floatSeconds = parseFloat(String(seconds));
-        if (floatSeconds <= 0) {
-            return;
-        }
-        await bluebird_1.default.delay(floatSeconds * 1000);
-        await this.proxyCommand('/wda/unlock', 'POST');
-    },
-    /**
-     * Unlock the device
-     *
-     * @this {XCUITestDriver}
-     */
-    async unlock() {
-        await this.proxyCommand('/wda/unlock', 'POST');
-    },
-    /**
-     * Determine whether the device is locked
-     *
-     * @this {XCUITestDriver}
-     * @returns {Promise<boolean>} `true` if the device is locked, `false` otherwise
-     */
-    async isLocked() {
-        return /** @type {boolean} */ (await this.proxyCommand('/wda/locked', 'GET'));
-    },
-};
+/**
+ * Lock the device (and optionally unlock the device after a certain amount of time)
+ *
+ * @param {number|string} [seconds] - the number of seconds after which to unlock the device. Set to `0` or leave empty to require manual unlock (do not automatically unlock).
+ * @defaultValue 0
+ * @this {XCUITestDriver}
+ */
+async function lock(seconds) {
+    await this.proxyCommand('/wda/lock', 'POST');
+    if (isNaN(Number(seconds))) {
+        return;
+    }
+    const floatSeconds = parseFloat(String(seconds));
+    if (floatSeconds <= 0) {
+        return;
+    }
+    await bluebird_1.default.delay(floatSeconds * 1000);
+    await this.proxyCommand('/wda/unlock', 'POST');
+}
+/**
+ * Unlock the device
+ *
+ * @this {XCUITestDriver}
+ */
+async function unlock() {
+    await this.proxyCommand('/wda/unlock', 'POST');
+}
+/**
+ * Determine whether the device is locked
+ *
+ * @this {XCUITestDriver}
+ * @returns {Promise<boolean>} `true` if the device is locked, `false` otherwise
+ */
+async function isLocked() {
+    return /** @type {boolean} */ (await this.proxyCommand('/wda/locked', 'GET'));
+}
 /**
  * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
  */

package/build/lib/commands/lock.js.map

@@ -1 +1 @@
-{"version":3,"file":"lock.js","sourceRoot":"","sources":["../../../lib/commands/lock.js"],"names":[],"mappings":";;;;;AAAA,wDAAyB;AAEzB,kBAAe;IACb;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,CAAC,OAAO;QAChB,MAAM,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;QAC7C,IAAI,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;YAC3B,OAAO;QACT,CAAC;QAED,MAAM,YAAY,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;QACjD,IAAI,YAAY,IAAI,CAAC,EAAE,CAAC;YACtB,OAAO;QACT,CAAC;QAED,MAAM,kBAAC,CAAC,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;QACnC,MAAM,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;IACjD,CAAC;IACD;;;;OAIG;IACH,KAAK,CAAC,MAAM;QACV,MAAM,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;IACjD,CAAC;IACD;;;;;OAKG;IACH,KAAK,CAAC,QAAQ;QACZ,OAAO,sBAAsB,CAAC,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC,CAAC;IAChF,CAAC;CACF,CAAC;AAEF;;GAEG"}
+{"version":3,"file":"lock.js","sourceRoot":"","sources":["../../../lib/commands/lock.js"],"names":[],"mappings":";;;;;AASA,oBAaC;AAOD,wBAEC;AAQD,4BAEC;AAzCD,wDAAyB;AAEzB;;;;;;GAMG;AACI,KAAK,UAAU,IAAI,CAAC,OAAO;IAChC,MAAM,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IAC7C,IAAI,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;QAC3B,OAAO;IACT,CAAC;IAED,MAAM,YAAY,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;IACjD,IAAI,YAAY,IAAI,CAAC,EAAE,CAAC;QACtB,OAAO;IACT,CAAC;IAED,MAAM,kBAAC,CAAC,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;IACnC,MAAM,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;AACjD,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,MAAM;IAC1B,MAAM,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;AACjD,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,QAAQ;IAC5B,OAAO,sBAAsB,CAAC,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC,CAAC;AAChF,CAAC;AAED;;GAEG"}

package/build/lib/commands/log.d.ts

@@ -1,3 +1,44 @@
+/**
+ *
+ * @param {XCUITestDriverLogTypes} logType
+ * @param {Partial<Record<XCUITestDriverLogTypes,{getLogs(): Promise<any>}>>} [logsContainer]
+ * @this {XCUITestDriver}
+ */
+export function extractLogs(this: import("../driver").XCUITestDriver, logType: XCUITestDriverLogTypes, logsContainer?: Partial<Record<XCUITestDriverLogTypes, {
+    getLogs(): Promise<any>;
+}>>): Promise<any>;
+/**
+ * @this {XCUITestDriver}
+ */
+export function startLogCapture(this: import("../driver").XCUITestDriver): Promise<boolean>;
+export class startLogCapture {
+    logs: import("../driver").DriverLogs;
+}
+/**
+ * Starts an iOS system logs broadcast websocket.
+ *
+ * The websocket listens on the same host and port as Appium.  The endpoint created is `/ws/session/:sessionId:/appium/syslog`.
+ *
+ * If the websocket is already running, this command does nothing.
+ *
+ * Each connected webcoket listener will receive syslog lines as soon as they are visible to Appium.
+ * @see https://appiumpro.com/editions/55-using-mobile-execution-commands-to-continuously-stream-device-logs-with-appium
+ * @returns {Promise<void>}
+ * @this {XCUITestDriver}
+ */
+export function mobileStartLogsBroadcast(this: import("../driver").XCUITestDriver): Promise<void>;
+export class mobileStartLogsBroadcast {
+    _syslogWebsocketListener: ((logRecord: {
+        message: string;
+    }) => void) | null;
+}
+/**
+ * Stops the syslog broadcasting wesocket server previously started by `mobile: startLogsBroadcast`.
+ * If no websocket server is running, this command does nothing.
+ * @this {XCUITestDriver}
+ * @returns {Promise<void>}
+ */
+export function mobileStopLogsBroadcast(this: import("../driver").XCUITestDriver): Promise<void>;
 /**
  * https://w3c.github.io/webdriver-bidi/#event-log-entryAdded
  *
@@ -8,43 +49,7 @@
  * @returns {[EE, import('./types').LogListener]}
  */
 export function assignBiDiLogListener<EE extends import("node:events").EventEmitter>(this: import("../driver").XCUITestDriver, logEmitter: EE, properties: BiDiListenerProperties): [EE, import("./types").LogListener];
-declare namespace _default {
-    export { SUPPORTED_LOG_TYPES as supportedLogTypes };
-    /**
-     *
-     * @param {XCUITestDriverLogTypes} logType
-     * @param {Partial<Record<XCUITestDriverLogTypes,{getLogs(): Promise<any>}>>} [logsContainer]
-     * @this {XCUITestDriver}
-     */
-    export function extractLogs(this: import("../driver").XCUITestDriver, logType: XCUITestDriverLogTypes, logsContainer?: Partial<Record<XCUITestDriverLogTypes, {
-        getLogs(): Promise<any>;
-    }>>): Promise<any>;
-    /**
-     * @this {XCUITestDriver}
-     */
-    export function startLogCapture(this: import("../driver").XCUITestDriver): Promise<boolean>;
-    /**
-     * Starts an iOS system logs broadcast websocket.
-     *
-     * The websocket listens on the same host and port as Appium.  The endpoint created is `/ws/session/:sessionId:/appium/syslog`.
-     *
-     * If the websocket is already running, this command does nothing.
-     *
-     * Each connected webcoket listener will receive syslog lines as soon as they are visible to Appium.
-     * @see https://appiumpro.com/editions/55-using-mobile-execution-commands-to-continuously-stream-device-logs-with-appium
-     * @returns {Promise<void>}
-     * @this {XCUITestDriver}
-     */
-    export function mobileStartLogsBroadcast(this: import("../driver").XCUITestDriver): Promise<void>;
-    /**
-     * Stops the syslog broadcasting wesocket server previously started by `mobile: startLogsBroadcast`.
-     * If no websocket server is running, this command does nothing.
-     * @this {XCUITestDriver}
-     * @returns {Promise<void>}
-     */
-    export function mobileStopLogsBroadcast(this: import("../driver").XCUITestDriver): Promise<void>;
-}
-export default _default;
+export const supportedLogTypes: import("@appium/types").LogDefRecord;
 export type XCUITestDriver = import("../driver").XCUITestDriver;
 export type XCUITestDriverLogTypes = keyof typeof SUPPORTED_LOG_TYPES;
 export type AppiumServer = import("@appium/types").AppiumServer;
@@ -59,4 +64,5 @@ export type BiDiListenerProperties = {
  * @privateRemarks The return types for these getters should be specified
  */
 declare const SUPPORTED_LOG_TYPES: import("@appium/types").LogDefRecord;
+export {};
 //# sourceMappingURL=log.d.ts.map

package/build/lib/commands/log.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"log.d.ts","sourceRoot":"","sources":["../../../lib/commands/log.js"],"names":[],"mappings":"AAmSA;;;;;;;;GAQG;AACH,sCANkD,EAAE,SAAvC,OAAQ,aAAa,EAAE,YAAa,wDAEtC,EAAE,cACF,sBAAsB,GACpB,CAAC,EAAE,EAAE,OAAO,SAAS,EAAE,WAAW,CAAC,CAe/C;;;IAvOC;;;;;OAKG;IACH,+EAJW,sBAAsB,kBACtB,OAAO,CAAC,MAAM,CAAC,sBAAsB,EAAC;QAAC,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,CAAA;KAAC,CAAC,CAAC,gBAwB3E;IAED;;OAEG;IACH,4FAqFC;IAED;;;;;;;;;;;OAWG;IACH,oFAHa,OAAO,CAAC,IAAI,CAAC,CA8DzB;IAED;;;;;OAKG;IACH,mFAFa,OAAO,CAAC,IAAI,CAAC,CAUzB;;;6BA4BU,OAAO,WAAW,EAAE,cAAc;qCAClC,MAAM,OAAO,mBAAmB;2BAChC,OAAO,eAAe,EAAE,YAAY;;UAKnC,MAAM;;;oCAGS,OAAO,SAAS,EAAE,QAAQ;;AAjSvD;;;GAGG;AACH,mCAHU,OAAO,eAAe,EAAE,YAAY,CAkC5C"}
+{"version":3,"file":"log.d.ts","sourceRoot":"","sources":["../../../lib/commands/log.js"],"names":[],"mappings":"AAqEA;;;;;GAKG;AACH,+EAJW,sBAAsB,kBACtB,OAAO,CAAC,MAAM,CAAC,sBAAsB,EAAC;IAAC,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,CAAA;CAAC,CAAC,CAAC,gBAwB3E;AAED;;GAEG;AACH,4FAqFC;;IApFC,qCAA2B;;AAsF7B;;;;;;;;;;;GAWG;AACH,oFAHa,OAAO,CAAC,IAAI,CAAC,CA8DzB;;IA5BK;;uBAIC;;AA0BP;;;;;GAKG;AACH,mFAFa,OAAO,CAAC,IAAI,CAAC,CAUzB;AAED;;;;;;;;GAQG;AACH,sCANkD,EAAE,SAAvC,OAAQ,aAAa,EAAE,YAAa,wDAEtC,EAAE,cACF,sBAAsB,GACpB,CAAC,EAAE,EAAE,OAAO,SAAS,EAAE,WAAW,CAAC,CAe/C;AAxOD,qEAAqD;6BAwPxC,OAAO,WAAW,EAAE,cAAc;qCAClC,MAAM,OAAO,mBAAmB;2BAChC,OAAO,eAAe,EAAE,YAAY;;UAKnC,MAAM;;;oCAGS,OAAO,SAAS,EAAE,QAAQ;;AA7SvD;;;GAGG;AACH,mCAHU,OAAO,eAAe,EAAE,YAAY,CAkC5C"}