@limrun/appium-xcuitest-driver 10.4.3-lim.1

package/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+that You distribute, all copyright, patent, trademark, and
+attribution notices from the Source form of the Work,
+excluding those notices that do not pertain to any part of
+the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must
+include a readable copy of the attribution notices contained
+within such NOTICE file, excluding those notices that do not
+pertain to any part of the Derivative Works, in at least one
+of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or,
+within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and
+do not modify the License. You may add Your own attribution
+notices within Derivative Works that You distribute, alongside
+or as an addendum to the NOTICE text from the Work, provided
+that such additional attribution notices cannot be construed
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following
+boilerplate notice, with the fields enclosed by brackets "{}"
+replaced with your own identifying information. (Don't include
+the brackets!)  The text should be enclosed in the appropriate
+comment syntax for the file format. We also recommend that a
+file or class name and description of purpose be included on the
+same "printed page" as the copyright notice for easier
+identification within third-party archives.
+
+Copyright JS Foundation and other contributors, https://js.foundation
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,55 @@
+# appium-xcuitest-driver
+
+[![npm version](http://img.shields.io/npm/v/appium-xcuitest-driver.svg)](https://npmjs.org/package/appium-xcuitest-driver)
+[![Downloads](http://img.shields.io/npm/dm/appium-xcuitest-driver.svg)](https://npmjs.org/package/appium-xcuitest-driver)
+
+[![Release](https://github.com/appium/appium-xcuitest-driver/actions/workflows/publish.js.yml/badge.svg)](https://github.com/appium/appium-xcuitest-driver/actions/workflows/publish.js.yml)
+
+This is an [Appium](https://appium.github.io/appium) driver for automating iOS applications on iOS,
+iPadOS, and tvOS.
+
+> [!IMPORTANT]
+> Only macOS is supported as the host platform, as it requires Xcode and developer tools.
+
+> [!IMPORTANT]
+> Since major version *10.0.0*, this driver is only compatible with Appium 3. Use the `appium driver install xcuitest`
+> command to add it to your distribution.
+
+
+## Documentation
+
+The [Documentation](https://appium.github.io/appium-xcuitest-driver) is hosted separately at
+[https://appium.github.io/appium-xcuitest-driver](https://appium.github.io/appium-xcuitest-driver)
+
+## Contributing & Development
+
+Clone this project from GitHub and run:
+
+```bash
+npm install
+```
+
+To watch changes during the development:
+
+```bash
+npm run watch
+```
+
+To run unit/functional tests:
+
+```bash
+npm test # unit
+npm run e2e-test # functional
+```
+
+There are also a number of environment variables that can be used when running
+the tests locally. These include:
+
+* `REAL_DEVICE` - set to anything truthy, makes the tests use real device capabilities
+* `_FORCE_LOGS` - set to `1` to get the log output, not just spec
+* `PLATFORM_VERSION` - change the version to run the tests against (defaults to `9.3`)
+* `XCCONFIG_FILE` - specify where the xcode config file is for a real device run (if
+  blank, and running a real device test, it will search for the first file in
+  the root directory of the repo with the extension "xcconfig")
+* `UICATALOG_REAL_DEVICE` - path to the real device build of UICatalog, in case
+  the npm installed one is not built for real device

package/build/index.d.ts

@@ -0,0 +1,5 @@
+export { XCUITestDriver };
+export * as doctor from "./lib/doctor/checks";
+export default XCUITestDriver;
+import { XCUITestDriver } from './lib/driver';
+//# sourceMappingURL=index.d.ts.map

package/build/index.js

@@ -0,0 +1,41 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.doctor = exports.XCUITestDriver = void 0;
+const driver_1 = require("./lib/driver");
+Object.defineProperty(exports, "XCUITestDriver", { enumerable: true, get: function () { return driver_1.XCUITestDriver; } });
+exports.doctor = __importStar(require("./lib/doctor/checks"));
+exports.default = driver_1.XCUITestDriver;
+//# sourceMappingURL=index.js.map

package/build/lib/app-infos-cache.d.ts

@@ -0,0 +1,62 @@
+export class AppInfosCache {
+    /**
+     * @param {import('@appium/types').AppiumLogger} log
+     */
+    constructor(log: import("@appium/types").AppiumLogger);
+    log: import("@appium/types").AppiumLogger;
+    /**
+     *
+     * @param {string} bundlePath Full path to the .ipa or .app bundle
+     * @param {string} propertyName
+     * @returns {Promise<any>}
+     */
+    extractManifestProperty(bundlePath: string, propertyName: string): Promise<any>;
+    /**
+     *
+     * @param {string} bundlePath Full path to the .ipa or .app bundle
+     * @returns {Promise<string>}
+     */
+    extractBundleId(bundlePath: string): Promise<string>;
+    /**
+     *
+     * @param {string} bundlePath Full path to the .ipa or .app bundle
+     * @returns {Promise<string>}
+     */
+    extractBundleVersion(bundlePath: string): Promise<string>;
+    /**
+     *
+     * @param {string} bundlePath Full path to the .ipa or .app bundle
+     * @returns {Promise<string[]>}
+     */
+    extractAppPlatforms(bundlePath: string): Promise<string[]>;
+    /**
+     *
+     * @param {string} bundlePath Full path to the .ipa or .app bundle
+     * @returns {Promise<string>}
+     */
+    extractExecutableName(bundlePath: string): Promise<string>;
+    /**
+     *
+     * @param {string} bundlePath Full path to the .ipa or .app bundle
+     * @returns {Promise<import('@appium/types').StringRecord>} The payload of the manifest plist
+     * @throws {Error} If the given app is not a valid bundle
+     */
+    put(bundlePath: string): Promise<import("@appium/types").StringRecord>;
+    /**
+     * @param {string} ipaPath Fill path to the .ipa bundle
+     * @returns {Promise<import('@appium/types').StringRecord>} The payload of the manifest plist
+     */
+    _putIpa(ipaPath: string): Promise<import("@appium/types").StringRecord>;
+    /**
+     * @param {string} appPath Fill path to the .app bundle
+     * @returns {Promise<import('@appium/types').StringRecord>} The payload of the manifest plist
+     */
+    _putApp(appPath: string): Promise<import("@appium/types").StringRecord>;
+    /**
+     * @param {string} plistPath Full path to the plist
+     * @param {string} bundlePath Full path to .ipa or .app bundle
+     * @returns {Promise<any>} The payload of the plist file
+     */
+    _readPlist(plistPath: string, bundlePath: string): Promise<any>;
+}
+//# sourceMappingURL=app-infos-cache.d.ts.map

package/build/lib/app-infos-cache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-infos-cache.d.ts","sourceRoot":"","sources":["../../lib/app-infos-cache.js"],"names":[],"mappings":"AAiBA;IACE;;OAEG;IACH,iBAFW,OAAO,eAAe,EAAE,YAAY,EAI9C;IADC,0CAAc;IAGhB;;;;;OAKG;IACH,oCAJW,MAAM,gBACN,MAAM,GACJ,OAAO,CAAC,GAAG,CAAC,CAMxB;IAED;;;;OAIG;IACH,4BAHW,MAAM,GACJ,OAAO,CAAC,MAAM,CAAC,CAI3B;IAED;;;;OAIG;IACH,iCAHW,MAAM,GACJ,OAAO,CAAC,MAAM,CAAC,CAI3B;IAED;;;;OAIG;IACH,gCAHW,MAAM,GACJ,OAAO,CAAC,MAAM,EAAE,CAAC,CAQ7B;IAED;;;;OAIG;IACH,kCAHW,MAAM,GACJ,OAAO,CAAC,MAAM,CAAC,CAI3B;IAED;;;;;OAKG;IACH,gBAJW,MAAM,GACJ,OAAO,CAAC,OAAO,eAAe,EAAE,YAAY,CAAC,CAOzD;IAED;;;OAGG;IACH,iBAHW,MAAM,GACJ,OAAO,CAAC,OAAO,eAAe,EAAE,YAAY,CAAC,CAyDzD;IAED;;;OAGG;IACH,iBAHW,MAAM,GACJ,OAAO,CAAC,OAAO,eAAe,EAAE,YAAY,CAAC,CAmBzD;IAED;;;;OAIG;IACH,sBAJW,MAAM,cACN,MAAM,GACJ,OAAO,CAAC,GAAG,CAAC,CASxB;CACF"}

package/build/lib/app-infos-cache.js

@@ -0,0 +1,180 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppInfosCache = void 0;
+const lodash_1 = __importDefault(require("lodash"));
+const path_1 = __importDefault(require("path"));
+const support_1 = require("appium/support");
+const lru_cache_1 = require("lru-cache");
+const bluebird_1 = __importDefault(require("bluebird"));
+/** @type {LRUCache<string, import('@appium/types').StringRecord>} */
+const MANIFEST_CACHE = new lru_cache_1.LRUCache({
+    max: 40,
+    updateAgeOnHas: true,
+});
+const MANIFEST_FILE_NAME = 'Info.plist';
+const IPA_ROOT_PLIST_PATH_PATTERN = new RegExp(`^Payload/[^/]+\\.app/${lodash_1.default.escapeRegExp(MANIFEST_FILE_NAME)}$`);
+const MAX_MANIFEST_SIZE = 1024 * 1024; // 1 MiB
+class AppInfosCache {
+    /**
+     * @param {import('@appium/types').AppiumLogger} log
+     */
+    constructor(log) {
+        this.log = log;
+    }
+    /**
+     *
+     * @param {string} bundlePath Full path to the .ipa or .app bundle
+     * @param {string} propertyName
+     * @returns {Promise<any>}
+     */
+    async extractManifestProperty(bundlePath, propertyName) {
+        const result = (await this.put(bundlePath))[propertyName];
+        this.log.debug(`${propertyName}: ${JSON.stringify(result)}`);
+        return result;
+    }
+    /**
+     *
+     * @param {string} bundlePath Full path to the .ipa or .app bundle
+     * @returns {Promise<string>}
+     */
+    async extractBundleId(bundlePath) {
+        return await this.extractManifestProperty(bundlePath, 'CFBundleIdentifier');
+    }
+    /**
+     *
+     * @param {string} bundlePath Full path to the .ipa or .app bundle
+     * @returns {Promise<string>}
+     */
+    async extractBundleVersion(bundlePath) {
+        return await this.extractManifestProperty(bundlePath, 'CFBundleVersion');
+    }
+    /**
+     *
+     * @param {string} bundlePath Full path to the .ipa or .app bundle
+     * @returns {Promise<string[]>}
+     */
+    async extractAppPlatforms(bundlePath) {
+        const result = await this.extractManifestProperty(bundlePath, 'CFBundleSupportedPlatforms');
+        if (!Array.isArray(result)) {
+            throw new Error(`${path_1.default.basename(bundlePath)}': CFBundleSupportedPlatforms is not a valid list`);
+        }
+        return result;
+    }
+    /**
+     *
+     * @param {string} bundlePath Full path to the .ipa or .app bundle
+     * @returns {Promise<string>}
+     */
+    async extractExecutableName(bundlePath) {
+        return await this.extractManifestProperty(bundlePath, 'CFBundleExecutable');
+    }
+    /**
+     *
+     * @param {string} bundlePath Full path to the .ipa or .app bundle
+     * @returns {Promise<import('@appium/types').StringRecord>} The payload of the manifest plist
+     * @throws {Error} If the given app is not a valid bundle
+     */
+    async put(bundlePath) {
+        return (await support_1.fs.stat(bundlePath)).isFile()
+            ? await this._putIpa(bundlePath)
+            : await this._putApp(bundlePath);
+    }
+    /**
+     * @param {string} ipaPath Fill path to the .ipa bundle
+     * @returns {Promise<import('@appium/types').StringRecord>} The payload of the manifest plist
+     */
+    async _putIpa(ipaPath) {
+        /** @type {import('@appium/types').StringRecord|undefined} */
+        let manifestPayload;
+        /** @type {Error|undefined} */
+        let lastError;
+        try {
+            await support_1.zip.readEntries(ipaPath, async ({ entry, extractEntryTo }) => {
+                // For a future reference:
+                // If the directory name includes `.app` suffix (case insensitive) like 'Payload/something.App.app/filename',
+                // then 'entry.fileName' would return 'Payload/something.App/filename'.
+                // The behavior is specific for unzip. Technically such naming is possible and valid,
+                // although Info.plist retrieval would fail in Appium.
+                // https://github.com/appium/appium/issues/20075
+                if (!IPA_ROOT_PLIST_PATH_PATTERN.test(entry.fileName)) {
+                    return true;
+                }
+                const hash = `${entry.crc32}`;
+                if (MANIFEST_CACHE.has(hash)) {
+                    manifestPayload = MANIFEST_CACHE.get(hash);
+                    return false;
+                }
+                const tmpRoot = await support_1.tempDir.openDir();
+                try {
+                    await extractEntryTo(tmpRoot);
+                    const plistPath = path_1.default.resolve(tmpRoot, entry.fileName);
+                    manifestPayload = await this._readPlist(plistPath, ipaPath);
+                    if (lodash_1.default.isPlainObject(manifestPayload) && entry.uncompressedSize <= MAX_MANIFEST_SIZE) {
+                        this.log.debug(`Caching the manifest '${entry.fileName}' for ${manifestPayload?.CFBundleIdentifier} app ` +
+                            `from the compressed source using the key '${hash}'`);
+                        MANIFEST_CACHE.set(hash, manifestPayload);
+                    }
+                }
+                catch (e) {
+                    this.log.debug(e.stack);
+                    lastError = e;
+                }
+                finally {
+                    await support_1.fs.rimraf(tmpRoot);
+                }
+                return false;
+            });
+        }
+        catch (e) {
+            this.log.debug(e.stack);
+            throw new Error(`Cannot find ${MANIFEST_FILE_NAME} in '${ipaPath}'. Is it a valid application bundle?`);
+        }
+        if (!manifestPayload) {
+            let errorMessage = `Cannot extract ${MANIFEST_FILE_NAME} from '${ipaPath}'. Is it a valid application bundle?`;
+            if (lastError) {
+                errorMessage += ` Original error: ${lastError.message}`;
+            }
+            throw new Error(errorMessage);
+        }
+        return manifestPayload;
+    }
+    /**
+     * @param {string} appPath Fill path to the .app bundle
+     * @returns {Promise<import('@appium/types').StringRecord>} The payload of the manifest plist
+     */
+    async _putApp(appPath) {
+        const manifestPath = path_1.default.join(appPath, MANIFEST_FILE_NAME);
+        const hash = await support_1.fs.hash(manifestPath);
+        if (MANIFEST_CACHE.has(hash)) {
+            return /** @type {import('@appium/types').StringRecord} */ (MANIFEST_CACHE.get(hash));
+        }
+        const [payload, stat] = await bluebird_1.default.all([
+            this._readPlist(manifestPath, appPath),
+            support_1.fs.stat(manifestPath),
+        ]);
+        if (stat.size <= MAX_MANIFEST_SIZE && lodash_1.default.isPlainObject(payload)) {
+            this.log.debug(`Caching the manifest for ${payload.CFBundleIdentifier} app from a file source using the key '${hash}'`);
+            MANIFEST_CACHE.set(hash, payload);
+        }
+        return payload;
+    }
+    /**
+     * @param {string} plistPath Full path to the plist
+     * @param {string} bundlePath Full path to .ipa or .app bundle
+     * @returns {Promise<any>} The payload of the plist file
+     */
+    async _readPlist(plistPath, bundlePath) {
+        try {
+            return await support_1.plist.parsePlistFile(plistPath);
+        }
+        catch (e) {
+            this.log.debug(e.stack);
+            throw new Error(`Cannot parse ${MANIFEST_FILE_NAME} of '${bundlePath}'. Is it a valid application bundle?`);
+        }
+    }
+}
+exports.AppInfosCache = AppInfosCache;
+//# sourceMappingURL=app-infos-cache.js.map

package/build/lib/app-infos-cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-infos-cache.js","sourceRoot":"","sources":["../../lib/app-infos-cache.js"],"names":[],"mappings":";;;;;;AAAA,oDAAuB;AACvB,gDAAwB;AACxB,4CAAuD;AACvD,yCAAmC;AACnC,wDAAyB;AAEzB,qEAAqE;AACrE,MAAM,cAAc,GAAG,IAAI,oBAAQ,CAAC;IAClC,GAAG,EAAE,EAAE;IACP,cAAc,EAAE,IAAI;CACrB,CAAC,CAAC;AACH,MAAM,kBAAkB,GAAG,YAAY,CAAC;AACxC,MAAM,2BAA2B,GAAG,IAAI,MAAM,CAC5C,wBAAwB,gBAAC,CAAC,YAAY,CAAC,kBAAkB,CAAC,GAAG,CAC9D,CAAC;AACF,MAAM,iBAAiB,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC,QAAQ;AAE/C,MAAa,aAAa;IACxB;;OAEG;IACH,YAAa,GAAG;QACd,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,uBAAuB,CAAE,UAAU,EAAE,YAAY;QACrD,MAAM,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;QAC1D,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,YAAY,KAAK,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC7D,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,eAAe,CAAE,UAAU;QAC/B,OAAO,MAAM,IAAI,CAAC,uBAAuB,CAAC,UAAU,EAAE,oBAAoB,CAAC,CAAC;IAC9E,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,oBAAoB,CAAE,UAAU;QACpC,OAAO,MAAM,IAAI,CAAC,uBAAuB,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;IAC3E,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,mBAAmB,CAAE,UAAU;QACnC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC,UAAU,EAAE,4BAA4B,CAAC,CAAC;QAC5F,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,GAAG,cAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,mDAAmD,CAAC,CAAC;QACnG,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,qBAAqB,CAAE,UAAU;QACrC,OAAO,MAAM,IAAI,CAAC,uBAAuB,CAAC,UAAU,EAAE,oBAAoB,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,GAAG,CAAE,UAAU;QACnB,OAAO,CAAC,MAAM,YAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,EAAE;YACzC,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC;YAChC,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACrC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,OAAO,CAAC,OAAO;QACnB,6DAA6D;QAC7D,IAAI,eAAe,CAAC;QACpB,8BAA8B;QAC9B,IAAI,SAAS,CAAC;QACd,IAAI,CAAC;YACH,MAAM,aAAG,CAAC,WAAW,CAAC,OAAO,EAAE,KAAK,EAAE,EAAC,KAAK,EAAE,cAAc,EAAC,EAAE,EAAE;gBAC/D,0BAA0B;gBAC1B,6GAA6G;gBAC7G,uEAAuE;gBACvE,qFAAqF;gBACrF,sDAAsD;gBAEtD,gDAAgD;gBAChD,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACtD,OAAO,IAAI,CAAC;gBACd,CAAC;gBAED,MAAM,IAAI,GAAG,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC;gBAC9B,IAAI,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC7B,eAAe,GAAG,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;oBAC3C,OAAO,KAAK,CAAC;gBACf,CAAC;gBACD,MAAM,OAAO,GAAG,MAAM,iBAAO,CAAC,OAAO,EAAE,CAAC;gBACxC,IAAI,CAAC;oBACH,MAAM,cAAc,CAAC,OAAO,CAAC,CAAC;oBAC9B,MAAM,SAAS,GAAG,cAAI,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;oBACxD,eAAe,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;oBAC5D,IAAI,gBAAC,CAAC,aAAa,CAAC,eAAe,CAAC,IAAI,KAAK,CAAC,gBAAgB,IAAI,iBAAiB,EAAE,CAAC;wBACpF,IAAI,CAAC,GAAG,CAAC,KAAK,CACZ,yBAAyB,KAAK,CAAC,QAAQ,SAAS,eAAe,EAAE,kBAAkB,OAAO;4BAC1F,6CAA6C,IAAI,GAAG,CACrD,CAAC;wBACF,cAAc,CAAC,GAAG,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;oBAC5C,CAAC;gBACH,CAAC;gBAAC,OAAO,CAAC,EAAE,CAAC;oBACX,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;oBACxB,SAAS,GAAG,CAAC,CAAC;gBAChB,CAAC;wBAAS,CAAC;oBACT,MAAM,YAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;gBAC3B,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,eAAe,kBAAkB,QAAQ,OAAO,sCAAsC,CAAC,CAAC;QAC1G,CAAC;QACD,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,IAAI,YAAY,GAAG,kBAAkB,kBAAkB,UAAU,OAAO,sCAAsC,CAAC;YAC/G,IAAI,SAAS,EAAE,CAAC;gBACd,YAAY,IAAI,oBAAoB,SAAS,CAAC,OAAO,EAAE,CAAC;YAC1D,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;QAChC,CAAC;QACD,OAAO,eAAe,CAAC;IACzB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,OAAO,CAAC,OAAO;QACnB,MAAM,YAAY,GAAG,cAAI,CAAC,IAAI,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAC;QAC5D,MAAM,IAAI,GAAG,MAAM,YAAE,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACzC,IAAI,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7B,OAAO,mDAAmD,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;QACxF,CAAC;QACD,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,GAAG,MAAM,kBAAC,CAAC,GAAG,CAAC;YAClC,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC;YACtC,YAAE,CAAC,IAAI,CAAC,YAAY,CAAC;SACtB,CAAC,CAAC;QACH,IAAI,IAAI,CAAC,IAAI,IAAI,iBAAiB,IAAI,gBAAC,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;YAC/D,IAAI,CAAC,GAAG,CAAC,KAAK,CACZ,4BAA4B,OAAO,CAAC,kBAAkB,0CAA0C,IAAI,GAAG,CACxG,CAAC;YACF,cAAc,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACpC,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAU,CAAC,SAAS,EAAE,UAAU;QACpC,IAAI,CAAC;YACH,OAAO,MAAM,eAAK,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;QAC/C,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,gBAAgB,kBAAkB,QAAQ,UAAU,sCAAsC,CAAC,CAAC;QAC9G,CAAC;IACH,CAAC;CACF;AAzKD,sCAyKC"}

package/build/lib/app-utils.d.ts

@@ -0,0 +1,89 @@
+/**
+ * Verify whether the given application is compatible to the
+ * platform where it is going to be installed and tested.
+ *
+ * @this {XCUITestDriver}
+ * @returns {Promise<void>}
+ * @throws {Error} If bundle architecture does not match the expected device architecture.
+ */
+export function verifyApplicationPlatform(this: import("./driver").XCUITestDriver): Promise<void>;
+/**
+ * @typedef {Object} LocalizableStringsOptions
+ * @property {string} [app]
+ * @property {string} [language='en']
+ * @property {string} [localizableStringsDir]
+ * @property {string} [stringFile]
+ * @property {boolean} [strictMode]
+ */
+/**
+ * Extracts string resources from an app
+ *
+ * @this {XCUITestDriver}
+ * @param {LocalizableStringsOptions} opts
+ * @returns {Promise<import('@appium/types').StringRecord>}
+ */
+export function parseLocalizableStrings(this: import("./driver").XCUITestDriver, opts?: LocalizableStringsOptions): Promise<import("@appium/types").StringRecord>;
+/**
+ * @typedef {Object} UnzipInfo
+ * @property {string} rootDir
+ * @property {number} archiveSize
+ */
+/**
+ * Unzips a ZIP archive on the local file system.
+ *
+ * @param {string} archivePath Full path to a .zip archive
+ * @returns {Promise<UnzipInfo>} temporary folder root where the archive has been extracted
+ */
+export function unzipFile(archivePath: string): Promise<UnzipInfo>;
+/**
+ * Unzips a ZIP archive from a stream.
+ * Uses bdstar tool for this purpose.
+ * This allows to optimize the time needed to prepare the app under test
+ * to MAX(download, unzip) instead of SUM(download, unzip)
+ *
+ * @param {import('node:stream').Readable} zipStream
+ * @returns {Promise<UnzipInfo>}
+ */
+export function unzipStream(zipStream: import("node:stream").Readable): Promise<UnzipInfo>;
+/**
+ * Builds Safari preferences object based on the given session capabilities
+ *
+ * @param {import('./driver').XCUITestDriverOpts} opts
+ * @return {Promise<import('@appium/types').StringRecord>}
+ */
+export function buildSafariPreferences(opts: import("./driver").XCUITestDriverOpts): Promise<import("@appium/types").StringRecord>;
+/**
+ * The callback invoked by configureApp helper
+ * when it is necessary to download the remote application.
+ * We assume the remote file could be anythingm, but only
+ * .zip and .ipa formats are supported.
+ * A .zip archive can contain one or more
+ *
+ * @this {XCUITestDriver}
+ * @param {import('@appium/types').DownloadAppOptions} opts
+ * @returns {Promise<string>}
+ */
+export function onDownloadApp(this: import("./driver").XCUITestDriver, { stream, headers }: import("@appium/types").DownloadAppOptions): Promise<string>;
+/**
+ * @this {XCUITestDriver}
+ * @param {import('@appium/types').PostProcessOptions} opts
+ * @returns {Promise<import('@appium/types').PostProcessResult|false>}
+ */
+export function onPostConfigureApp(this: import("./driver").XCUITestDriver, { cachedAppInfo, isUrl, appPath }: import("@appium/types").PostProcessOptions): Promise<import("@appium/types").PostProcessResult | false>;
+export const SAFARI_BUNDLE_ID: "com.apple.mobilesafari";
+export const APP_EXT: ".app";
+export const IPA_EXT: ".ipa";
+export const SUPPORTED_EXTENSIONS: string[];
+export type LocalizableStringsOptions = {
+    app?: string | undefined;
+    language?: string | undefined;
+    localizableStringsDir?: string | undefined;
+    stringFile?: string | undefined;
+    strictMode?: boolean | undefined;
+};
+export type UnzipInfo = {
+    rootDir: string;
+    archiveSize: number;
+};
+export type XCUITestDriver = import("./driver").XCUITestDriver;
+//# sourceMappingURL=app-utils.d.ts.map

package/build/lib/app-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-utils.d.ts","sourceRoot":"","sources":["../../lib/app-utils.js"],"names":[],"mappings":"AA+BA;;;;;;;GAOG;AACH,oFAHa,OAAO,CAAC,IAAI,CAAC,CAgEzB;AAgBD;;;;;;;GAOG;AAEH;;;;;;GAMG;AACH,wFAHW,yBAAyB,GACvB,OAAO,CAAC,OAAO,eAAe,EAAE,YAAY,CAAC,CA6FzD;AA0BD;;;;GAIG;AAEH;;;;;GAKG;AACH,uCAHW,MAAM,GACJ,OAAO,CAAC,SAAS,CAAC,CAqB9B;AAED;;;;;;;;GAQG;AACH,uCAHW,OAAO,aAAa,EAAE,QAAQ,GAC5B,OAAO,CAAC,SAAS,CAAC,CAoD9B;AAoJD;;;;;GAKG;AACH,6CAHW,OAAO,UAAU,EAAE,kBAAkB,GACpC,OAAO,CAAC,OAAO,eAAe,EAAE,YAAY,CAAC,CAexD;AAyGD;;;;;;;;;;GAUG;AACH,4FAHW,OAAO,eAAe,EAAE,kBAAkB,GACxC,OAAO,CAAC,MAAM,CAAC,CAM3B;AAED;;;;GAIG;AACH,+GAHW,OAAO,eAAe,EAAE,kBAAkB,GACxC,OAAO,CAAC,OAAO,eAAe,EAAE,iBAAiB,GAAC,KAAK,CAAC,CA0DpE;AAtqBD,+BAAgC,wBAAwB,CAAC;AACzD,sBAAuB,MAAM,CAAC;AAC9B,sBAAuB,MAAM,CAAC;AAW9B,4CAAuD;;;;;;;;;aAiOzC,MAAM;iBACN,MAAM;;6BAwcP,OAAO,UAAU,EAAE,cAAc"}