appium-xcuitest-driver 10.2.2 → 10.4.0

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

@@ -1,35 +1,32 @@
-declare namespace _default {
-    /**
-     * Enrolls biometric authentication on a simulated device.
-     *
-     * @param {boolean} isEnabled - Whether to enable/disable biometric enrollment.
-     * @throws {Error} If enrollment fails or the device is not a Simulator.
-     * @group Simulator Only
-     * @this {XCUITestDriver}
-     */
-    function mobileEnrollBiometric(this: import("../driver").XCUITestDriver, isEnabled?: boolean): Promise<void>;
-    /**
-     * Emulates biometric match or non-match event on a simulated device.
-     *
-     * The biometric feature is expected to be already enrolled via {@linkcode mobileEnrollBiometric|mobile: enrollBiometric} before executing this.
-     *
-     * @param {import('./types').BiometricFeature} type - The biometric feature name.
-     * @param {boolean} match - If `true`, simulate biometic match. If `false`, simulate biometric non-match.
-     * @throws {Error} If matching fails or the device is not a Simulator.
-     * @group Simulator Only
-     * @this {XCUITestDriver}
-     */
-    function mobileSendBiometricMatch(this: import("../driver").XCUITestDriver, type?: import("./types").BiometricFeature, match?: boolean): Promise<void>;
-    /**
-     * Checks whether the biometric feature is currently enrolled on a simulated device.
-     *
-     * @returns {Promise<boolean>} `true` if biometric is enrolled.
-     * @throws {Error} If the detection fails or the device is not a Simulator.
-     * @group Simulator Only
-     * @this {XCUITestDriver}
-     */
-    function mobileIsBiometricEnrolled(this: import("../driver").XCUITestDriver): Promise<boolean>;
-}
-export default _default;
+/**
+ * Enrolls biometric authentication on a simulated device.
+ *
+ * @param {boolean} isEnabled - Whether to enable/disable biometric enrollment.
+ * @throws {Error} If enrollment fails or the device is not a Simulator.
+ * @group Simulator Only
+ * @this {XCUITestDriver}
+ */
+export function mobileEnrollBiometric(this: import("../driver").XCUITestDriver, isEnabled?: boolean): Promise<void>;
+/**
+ * Emulates biometric match or non-match event on a simulated device.
+ *
+ * The biometric feature is expected to be already enrolled via {@linkcode mobileEnrollBiometric|mobile: enrollBiometric} before executing this.
+ *
+ * @param {import('./types').BiometricFeature} type - The biometric feature name.
+ * @param {boolean} match - If `true`, simulate biometic match. If `false`, simulate biometric non-match.
+ * @throws {Error} If matching fails or the device is not a Simulator.
+ * @group Simulator Only
+ * @this {XCUITestDriver}
+ */
+export function mobileSendBiometricMatch(this: import("../driver").XCUITestDriver, type?: import("./types").BiometricFeature, match?: boolean): Promise<void>;
+/**
+ * Checks whether the biometric feature is currently enrolled on a simulated device.
+ *
+ * @returns {Promise<boolean>} `true` if biometric is enrolled.
+ * @throws {Error} If the detection fails or the device is not a Simulator.
+ * @group Simulator Only
+ * @this {XCUITestDriver}
+ */
+export function mobileIsBiometricEnrolled(this: import("../driver").XCUITestDriver): Promise<boolean>;
 export type XCUITestDriver = import("../driver").XCUITestDriver;
 //# sourceMappingURL=biometric.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"biometric.d.ts","sourceRoot":"","sources":["../../../lib/commands/biometric.js"],"names":[],"mappings":";IAME;;;;;;;OAOG;IACH,qFALW,OAAO,iBASjB;IAED;;;;;;;;;;OAUG;IACH,mFANW,OAAO,SAAS,EAAE,gBAAgB,UAClC,OAAO,iBASjB;IAED;;;;;;;OAOG;IACH,8EALa,OAAO,CAAC,OAAO,CAAC,CAS5B;;;6BAIU,OAAO,WAAW,EAAE,cAAc"}
+{"version":3,"file":"biometric.d.ts","sourceRoot":"","sources":["../../../lib/commands/biometric.js"],"names":[],"mappings":"AAKA;;;;;;;GAOG;AACH,4FALW,OAAO,iBASjB;AAED;;;;;;;;;;GAUG;AACH,0FANW,OAAO,SAAS,EAAE,gBAAgB,UAClC,OAAO,iBASjB;AAED;;;;;;;GAOG;AACH,qFALa,OAAO,CAAC,OAAO,CAAC,CAS5B;6BAGY,OAAO,WAAW,EAAE,cAAc"}

package/build/lib/commands/biometric.js

@@ -3,50 +3,51 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.mobileEnrollBiometric = mobileEnrollBiometric;
+exports.mobileSendBiometricMatch = mobileSendBiometricMatch;
+exports.mobileIsBiometricEnrolled = mobileIsBiometricEnrolled;
 const lodash_1 = __importDefault(require("lodash"));
 const utils_1 = require("../utils");
 const assertSimulator = lodash_1.default.partial(utils_1.assertSimulator, 'Biometric enrollment');
-exports.default = {
-    /**
-     * Enrolls biometric authentication on a simulated device.
-     *
-     * @param {boolean} isEnabled - Whether to enable/disable biometric enrollment.
-     * @throws {Error} If enrollment fails or the device is not a Simulator.
-     * @group Simulator Only
-     * @this {XCUITestDriver}
-     */
-    async mobileEnrollBiometric(isEnabled = true) {
-        assertSimulator(this);
-        await /** @type {import('../driver').Simulator} */ (this.device).enrollBiometric(isEnabled);
-    },
-    /**
-     * Emulates biometric match or non-match event on a simulated device.
-     *
-     * The biometric feature is expected to be already enrolled via {@linkcode mobileEnrollBiometric|mobile: enrollBiometric} before executing this.
-     *
-     * @param {import('./types').BiometricFeature} type - The biometric feature name.
-     * @param {boolean} match - If `true`, simulate biometic match. If `false`, simulate biometric non-match.
-     * @throws {Error} If matching fails or the device is not a Simulator.
-     * @group Simulator Only
-     * @this {XCUITestDriver}
-     */
-    async mobileSendBiometricMatch(type = 'touchId', match = true) {
-        assertSimulator(this);
-        await /** @type {import('../driver').Simulator} */ (this.device).sendBiometricMatch(match, type);
-    },
-    /**
-     * Checks whether the biometric feature is currently enrolled on a simulated device.
-     *
-     * @returns {Promise<boolean>} `true` if biometric is enrolled.
-     * @throws {Error} If the detection fails or the device is not a Simulator.
-     * @group Simulator Only
-     * @this {XCUITestDriver}
-     */
-    async mobileIsBiometricEnrolled() {
-        assertSimulator(this);
-        return await /** @type {import('../driver').Simulator} */ (this.device).isBiometricEnrolled();
-    },
-};
+/**
+ * Enrolls biometric authentication on a simulated device.
+ *
+ * @param {boolean} isEnabled - Whether to enable/disable biometric enrollment.
+ * @throws {Error} If enrollment fails or the device is not a Simulator.
+ * @group Simulator Only
+ * @this {XCUITestDriver}
+ */
+async function mobileEnrollBiometric(isEnabled = true) {
+    assertSimulator(this);
+    await /** @type {import('../driver').Simulator} */ (this.device).enrollBiometric(isEnabled);
+}
+/**
+ * Emulates biometric match or non-match event on a simulated device.
+ *
+ * The biometric feature is expected to be already enrolled via {@linkcode mobileEnrollBiometric|mobile: enrollBiometric} before executing this.
+ *
+ * @param {import('./types').BiometricFeature} type - The biometric feature name.
+ * @param {boolean} match - If `true`, simulate biometic match. If `false`, simulate biometric non-match.
+ * @throws {Error} If matching fails or the device is not a Simulator.
+ * @group Simulator Only
+ * @this {XCUITestDriver}
+ */
+async function mobileSendBiometricMatch(type = 'touchId', match = true) {
+    assertSimulator(this);
+    await /** @type {import('../driver').Simulator} */ (this.device).sendBiometricMatch(match, type);
+}
+/**
+ * Checks whether the biometric feature is currently enrolled on a simulated device.
+ *
+ * @returns {Promise<boolean>} `true` if biometric is enrolled.
+ * @throws {Error} If the detection fails or the device is not a Simulator.
+ * @group Simulator Only
+ * @this {XCUITestDriver}
+ */
+async function mobileIsBiometricEnrolled() {
+    assertSimulator(this);
+    return await /** @type {import('../driver').Simulator} */ (this.device).isBiometricEnrolled();
+}
 /**
  * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
  */

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

@@ -1 +1 @@
-{"version":3,"file":"biometric.js","sourceRoot":"","sources":["../../../lib/commands/biometric.js"],"names":[],"mappings":";;;;;AAAA,oDAAuB;AACvB,oCAA6D;AAE7D,MAAM,eAAe,GAAG,gBAAC,CAAC,OAAO,CAAC,uBAAgB,EAAE,sBAAsB,CAAC,CAAC;AAE5E,kBAAe;IACb;;;;;;;OAOG;IACH,KAAK,CAAC,qBAAqB,CAAC,SAAS,GAAG,IAAI;QAC1C,eAAe,CAAC,IAAI,CAAC,CAAC;QAEtB,MAAM,4CAA4C,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,wBAAwB,CAAC,IAAI,GAAG,SAAS,EAAE,KAAK,GAAG,IAAI;QAC3D,eAAe,CAAC,IAAI,CAAC,CAAC;QAEtB,MAAM,4CAA4C,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,kBAAkB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,yBAAyB;QAC7B,eAAe,CAAC,IAAI,CAAC,CAAC;QAEtB,OAAO,MAAM,4CAA4C,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,mBAAmB,EAAE,CAAC;IAChG,CAAC;CACF,CAAC;AAEF;;GAEG"}
+{"version":3,"file":"biometric.js","sourceRoot":"","sources":["../../../lib/commands/biometric.js"],"names":[],"mappings":";;;;;AAaA,sDAIC;AAaD,4DAIC;AAUD,8DAIC;AAhDD,oDAAuB;AACvB,oCAA6D;AAE7D,MAAM,eAAe,GAAG,gBAAC,CAAC,OAAO,CAAC,uBAAgB,EAAE,sBAAsB,CAAC,CAAC;AAE5E;;;;;;;GAOG;AACI,KAAK,UAAU,qBAAqB,CAAC,SAAS,GAAG,IAAI;IAC1D,eAAe,CAAC,IAAI,CAAC,CAAC;IAEtB,MAAM,4CAA4C,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;AAC9F,CAAC;AAED;;;;;;;;;;GAUG;AACI,KAAK,UAAU,wBAAwB,CAAC,IAAI,GAAG,SAAS,EAAE,KAAK,GAAG,IAAI;IAC3E,eAAe,CAAC,IAAI,CAAC,CAAC;IAEtB,MAAM,4CAA4C,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,kBAAkB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;AACnG,CAAC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,yBAAyB;IAC7C,eAAe,CAAC,IAAI,CAAC,CAAC;IAEtB,OAAO,MAAM,4CAA4C,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,mBAAmB,EAAE,CAAC;AAChG,CAAC;AAED;;GAEG"}

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

@@ -1,47 +1,50 @@
-export function parseCommonName(stringCertificate: any): string;
-declare namespace _default {
-    /**
-     * Installs a custom certificate onto the device.
-     *
-     * Since Xcode SDK 11.4, Apple has added a dedicated `simctl` subcommand to quickly handle
-     * certificates on Simulator over CLI.
-     *
-     * On real devices (or simulators before Xcode SDK 11.4), Apple provides no "official" way to do this via the command line.  In such a case (and also as a fallback if CLI setup fails), this method tries to wrap the certificate into `.mobileconfig` format, then deploys the wrapped file to the internal HTTP server so that it can be opened via mobile Safari. This command then goes through the profile installation procedure by clicking the necessary buttons using WebDriverAgent.
-     * @param {string} content - Base64-encoded content of the public certificate in [PEM](https://knowledge.digicert.com/quovadis/ssl-certificates/ssl-general-topics/what-is-pem-format.html) format
-     * @param {string} [commonName] - Common name of the certificate. If this is not set, the command will try to parse it from the provided `content`.
-     * @param {boolean} isRoot - Defines where the certificate should be installed; either the Trusted Root Store (`true`) or the Keychain (`false`). On environments other than Xcode 11.4+ Simulator, this option is ignored.
-     * @returns {Promise<string|void>} The content of the generated `.mobileconfig` file as
-     * a base64-encoded string. This config might be useful for debugging purposes.  If the certificate has been successfully set via CLI, then nothing is returned.
-     * @this {XCUITestDriver}
-     */
-    function mobileInstallCertificate(this: import("../driver").XCUITestDriver, content: string, commonName?: string, isRoot?: boolean): Promise<string | void>;
-    /**
-     * Removes installed certificates.
-     *
-     * This only works _if and only if_ `py-ios-device` is installed on the same machine Appium is running on.
-     *
-     * @see https://github.com/YueChen-C/py-ios-device
-     * @since 4.19.2
-     * @param {string} name - Name of the profile
-     * @returns {Promise<string>} Returns status acknowledgment status if
-     * tht certificate is successfully removed or 'None' (basically just
-     * forwards the original pyidevice output)
-     * @throws {Error} If attempting to remove certificates for a simulated device or if `py-ios-device` is not installed
-     * @group Real Device Only
-     */
-    function mobileRemoveCertificate(name: string): Promise<string>;
-    /**
-     * Returns map of certificates installed on the real device.
-     *
-     * This only works _if and only if_ `py-ios-device` is installed on the same machine Appium is running on.
-     * @since 4.10.0
-     * @see https://github.com/YueChen-C/py-ios-device
-     * @returns {Promise<import('./types').CertificateList>} An object describing the certificates installed on the real device.
-     * @throws {Error} If attempting to list certificates for a simulated device or if `py-ios-device` is not installed
-     * @this {XCUITestDriver}
-     */
-    function mobileListCertificates(this: import("../driver").XCUITestDriver): Promise<import("./types").CertificateList>;
-}
-export default _default;
+/**
+ * Parses the common name of the certificate from the given string.
+ *
+ * @param {string} stringCertificate
+ * @returns {string} The common name of the certificate
+ */
+export function parseCommonName(stringCertificate: string): string;
+/**
+ * Installs a custom certificate onto the device.
+ *
+ * Since Xcode SDK 11.4, Apple has added a dedicated `simctl` subcommand to quickly handle
+ * certificates on Simulator over CLI.
+ *
+ * On real devices (or simulators before Xcode SDK 11.4), Apple provides no "official" way to do this via the command line.  In such a case (and also as a fallback if CLI setup fails), this method tries to wrap the certificate into `.mobileconfig` format, then deploys the wrapped file to the internal HTTP server so that it can be opened via mobile Safari. This command then goes through the profile installation procedure by clicking the necessary buttons using WebDriverAgent.
+ * @param {string} content - Base64-encoded content of the public certificate in [PEM](https://knowledge.digicert.com/quovadis/ssl-certificates/ssl-general-topics/what-is-pem-format.html) format
+ * @param {string} [commonName] - Common name of the certificate. If this is not set, the command will try to parse it from the provided `content`.
+ * @param {boolean} isRoot - Defines where the certificate should be installed; either the Trusted Root Store (`true`) or the Keychain (`false`). On environments other than Xcode 11.4+ Simulator, this option is ignored.
+ * @returns {Promise<string|void>} The content of the generated `.mobileconfig` file as
+ * a base64-encoded string. This config might be useful for debugging purposes.  If the certificate has been successfully set via CLI, then nothing is returned.
+ * @this {XCUITestDriver}
+ */
+export function mobileInstallCertificate(this: import("../driver").XCUITestDriver, content: string, commonName?: string, isRoot?: boolean): Promise<string | void>;
+/**
+ * Removes installed certificates.
+ *
+ * This only works _if and only if_ `py-ios-device` is installed on the same machine Appium is running on.
+ *
+ * @see https://github.com/YueChen-C/py-ios-device
+ * @since 4.19.2
+ * @param {string} name - Name of the profile
+ * @returns {Promise<string>} Returns status acknowledgment status if
+ * tht certificate is successfully removed or 'None' (basically just
+ * forwards the original pyidevice output)
+ * @throws {Error} If attempting to remove certificates for a simulated device or if `py-ios-device` is not installed
+ * @group Real Device Only
+ */
+export function mobileRemoveCertificate(name: string): Promise<string>;
+/**
+ * Returns map of certificates installed on the real device.
+ *
+ * This only works _if and only if_ `py-ios-device` is installed on the same machine Appium is running on.
+ * @since 4.10.0
+ * @see https://github.com/YueChen-C/py-ios-device
+ * @returns {Promise<import('./types').CertificateList>} An object describing the certificates installed on the real device.
+ * @throws {Error} If attempting to list certificates for a simulated device or if `py-ios-device` is not installed
+ * @this {XCUITestDriver}
+ */
+export function mobileListCertificates(this: import("../driver").XCUITestDriver): Promise<import("./types").CertificateList>;
 export type XCUITestDriver = import("../driver").XCUITestDriver;
 //# sourceMappingURL=certificate.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"certificate.d.ts","sourceRoot":"","sources":["../../../lib/commands/certificate.js"],"names":[],"mappings":"AAiFA,gEAYC;;IAiMC;;;;;;;;;;;;;OAaG;IACH,qFAPW,MAAM,eACN,MAAM,WACN,OAAO,GACL,OAAO,CAAC,MAAM,GAAC,IAAI,CAAC,CAwIhC;IAED;;;;;;;;;;;;;OAaG;IACH,uCAPW,MAAM,GACJ,OAAO,CAAC,MAAM,CAAC,CAgB3B;IAED;;;;;;;;;OASG;IACH,2EAJa,OAAO,CAAC,OAAO,SAAS,EAAE,eAAe,CAAC,CActD;;;6BAIU,OAAO,WAAW,EAAE,cAAc"}
+{"version":3,"file":"certificate.d.ts","sourceRoot":"","sources":["../../../lib/commands/certificate.js"],"names":[],"mappings":"AA8DA;;;;;GAKG;AACH,mDAHW,MAAM,GACJ,MAAM,CAclB;AAED;;;;;;;;;;;;;GAaG;AACH,4FAPW,MAAM,eACN,MAAM,WACN,OAAO,GACL,OAAO,CAAC,MAAM,GAAC,IAAI,CAAC,CAwIhC;AAED;;;;;;;;;;;;;GAaG;AACH,8CAPW,MAAM,GACJ,OAAO,CAAC,MAAM,CAAC,CAgB3B;AAED;;;;;;;;;GASG;AACH,kFAJa,OAAO,CAAC,OAAO,SAAS,EAAE,eAAe,CAAC,CActD;6BA2NY,OAAO,WAAW,EAAE,cAAc"}