appium-webdriveragent 8.4.0 → 8.5.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [8.5.1](https://github.com/appium/WebDriverAgent/compare/v8.5.0...v8.5.1) (2024-04-08)
+
+
+### Miscellaneous Chores
+
+* Add more type declarations ([#886](https://github.com/appium/WebDriverAgent/issues/886)) ([9ca7632](https://github.com/appium/WebDriverAgent/commit/9ca7632faf999931e7f5edf47267fcce6d6392b2))
+
+## [8.5.0](https://github.com/appium/WebDriverAgent/compare/v8.4.0...v8.5.0) (2024-04-07)
+
+
+### Features
+
+* Add types for WDA caps and settings ([#885](https://github.com/appium/WebDriverAgent/issues/885)) ([4b3c220](https://github.com/appium/WebDriverAgent/commit/4b3c220c0c609802924b7b6ff9a4dfa7a98eb5f4))
+
 ## [8.4.0](https://github.com/appium/WebDriverAgent/compare/v8.3.1...v8.4.0) (2024-04-01)
 
 

package/WebDriverAgentLib/Info.plist

@@ -15,11 +15,11 @@
     <key>CFBundlePackageType</key>
     <string>FMWK</string>
     <key>CFBundleShortVersionString</key>
-    <string>8.4.0</string>
+    <string>8.5.1</string>
     <key>CFBundleSignature</key>
     <string>????</string>
     <key>CFBundleVersion</key>
-    <string>8.4.0</string>
+    <string>8.5.1</string>
     <key>NSPrincipalClass</key>
     <string/>
   </dict>

package/build/index.d.ts

@@ -0,0 +1,7 @@
+export { checkForDependencies, bundleWDASim } from './lib/check-dependencies';
+export { NoSessionProxy } from './lib/no-session-proxy';
+export { WebDriverAgent } from './lib/webdriveragent';
+export { WDA_BASE_URL, WDA_RUNNER_BUNDLE_ID, PROJECT_FILE } from './lib/constants';
+export { resetTestProcesses, BOOTSTRAP_PATH } from './lib/utils';
+export * from './lib/types';
+//# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAC9E,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AACnF,OAAO,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAEjE,cAAc,aAAa,CAAC"}

package/build/index.js

@@ -10,37 +10,24 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     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 (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WDA_BASE_URL = exports.PROJECT_FILE = exports.WDA_RUNNER_BUNDLE_ID = exports.BOOTSTRAP_PATH = exports.resetTestProcesses = exports.bundleWDASim = exports.checkForDependencies = exports.NoSessionProxy = exports.WebDriverAgent = void 0;
-const dependencies = __importStar(require("./lib/check-dependencies"));
-const proxies = __importStar(require("./lib/no-session-proxy"));
-const driver = __importStar(require("./lib/webdriveragent"));
-const constants = __importStar(require("./lib/constants"));
-const utils = __importStar(require("./lib/utils"));
-const { checkForDependencies, bundleWDASim } = dependencies;
-exports.checkForDependencies = checkForDependencies;
-exports.bundleWDASim = bundleWDASim;
-const { NoSessionProxy } = proxies;
-exports.NoSessionProxy = NoSessionProxy;
-const { WebDriverAgent } = driver;
-exports.WebDriverAgent = WebDriverAgent;
-const { WDA_BASE_URL, WDA_RUNNER_BUNDLE_ID, PROJECT_FILE } = constants;
-exports.WDA_BASE_URL = WDA_BASE_URL;
-exports.WDA_RUNNER_BUNDLE_ID = WDA_RUNNER_BUNDLE_ID;
-exports.PROJECT_FILE = PROJECT_FILE;
-const { resetTestProcesses, BOOTSTRAP_PATH } = utils;
-exports.resetTestProcesses = resetTestProcesses;
-exports.BOOTSTRAP_PATH = BOOTSTRAP_PATH;
+exports.BOOTSTRAP_PATH = exports.resetTestProcesses = exports.PROJECT_FILE = exports.WDA_RUNNER_BUNDLE_ID = exports.WDA_BASE_URL = exports.WebDriverAgent = exports.NoSessionProxy = exports.bundleWDASim = exports.checkForDependencies = void 0;
+var check_dependencies_1 = require("./lib/check-dependencies");
+Object.defineProperty(exports, "checkForDependencies", { enumerable: true, get: function () { return check_dependencies_1.checkForDependencies; } });
+Object.defineProperty(exports, "bundleWDASim", { enumerable: true, get: function () { return check_dependencies_1.bundleWDASim; } });
+var no_session_proxy_1 = require("./lib/no-session-proxy");
+Object.defineProperty(exports, "NoSessionProxy", { enumerable: true, get: function () { return no_session_proxy_1.NoSessionProxy; } });
+var webdriveragent_1 = require("./lib/webdriveragent");
+Object.defineProperty(exports, "WebDriverAgent", { enumerable: true, get: function () { return webdriveragent_1.WebDriverAgent; } });
+var constants_1 = require("./lib/constants");
+Object.defineProperty(exports, "WDA_BASE_URL", { enumerable: true, get: function () { return constants_1.WDA_BASE_URL; } });
+Object.defineProperty(exports, "WDA_RUNNER_BUNDLE_ID", { enumerable: true, get: function () { return constants_1.WDA_RUNNER_BUNDLE_ID; } });
+Object.defineProperty(exports, "PROJECT_FILE", { enumerable: true, get: function () { return constants_1.PROJECT_FILE; } });
+var utils_1 = require("./lib/utils");
+Object.defineProperty(exports, "resetTestProcesses", { enumerable: true, get: function () { return utils_1.resetTestProcesses; } });
+Object.defineProperty(exports, "BOOTSTRAP_PATH", { enumerable: true, get: function () { return utils_1.BOOTSTRAP_PATH; } });
+__exportStar(require("./lib/types"), exports);
 //# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,+DAA8E;AAArE,0HAAA,oBAAoB,OAAA;AAAE,kHAAA,YAAY,OAAA;AAC3C,2DAAwD;AAA/C,kHAAA,cAAc,OAAA;AACvB,uDAAsD;AAA7C,gHAAA,cAAc,OAAA;AACvB,6CAAmF;AAA1E,yGAAA,YAAY,OAAA;AAAE,iHAAA,oBAAoB,OAAA;AAAE,yGAAA,YAAY,OAAA;AACzD,qCAAiE;AAAxD,2GAAA,kBAAkB,OAAA;AAAE,uGAAA,cAAc,OAAA;AAE3C,8CAA4B"}

package/build/lib/check-dependencies.d.ts

@@ -1,3 +1,9 @@
 export function checkForDependencies(): Promise<boolean>;
-export function bundleWDASim(xcodebuild: any): Promise<string>;
+/**
+ *
+ * @param {XcodeBuild} xcodebuild
+ * @returns {Promise<string>}
+ */
+export function bundleWDASim(xcodebuild: XcodeBuild): Promise<string>;
+import XcodeBuild from './xcodebuild';
 //# sourceMappingURL=check-dependencies.d.ts.map

package/build/lib/check-dependencies.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"check-dependencies.d.ts","sourceRoot":"","sources":["../../lib/check-dependencies.js"],"names":[],"mappings":"AAwBA,yDAGC;AAED,+DAYC"}
+{"version":3,"file":"check-dependencies.d.ts","sourceRoot":"","sources":["../../lib/check-dependencies.js"],"names":[],"mappings":"AAyBA,yDAGC;AAED;;;;GAIG;AACH,yCAHW,UAAU,GACR,QAAQ,MAAM,CAAC,CAiB3B;uBA9CsB,cAAc"}

package/build/lib/check-dependencies.js

@@ -9,6 +9,7 @@ const lodash_1 = __importDefault(require("lodash"));
 const teen_process_1 = require("teen_process");
 const path_1 = __importDefault(require("path"));
 const xcodebuild_1 = __importDefault(require("./xcodebuild"));
+const appium_xcode_1 = __importDefault(require("appium-xcode"));
 const constants_1 = require("./constants");
 const utils_1 = require("./utils");
 const logger_1 = __importDefault(require("./logger"));
@@ -29,11 +30,19 @@ async function checkForDependencies() {
     return false;
 }
 exports.checkForDependencies = checkForDependencies;
+/**
+ *
+ * @param {XcodeBuild} xcodebuild
+ * @returns {Promise<string>}
+ */
 async function bundleWDASim(xcodebuild) {
     if (xcodebuild && !lodash_1.default.isFunction(xcodebuild.retrieveDerivedDataPath)) {
-        xcodebuild = new xcodebuild_1.default('', {});
+        xcodebuild = new xcodebuild_1.default(/** @type {import('appium-xcode').XcodeVersion} */ (await appium_xcode_1.default.getVersion(true)), {});
     }
     const derivedDataPath = await xcodebuild.retrieveDerivedDataPath();
+    if (!derivedDataPath) {
+        throw new Error('Cannot retrieve the path to the Xcode derived data folder');
+    }
     const wdaBundlePath = path_1.default.join(derivedDataPath, 'Build', 'Products', 'Debug-iphonesimulator', constants_1.WDA_RUNNER_APP);
     if (await support_1.fs.exists(wdaBundlePath)) {
         return wdaBundlePath;

package/build/lib/check-dependencies.js.map

@@ -1 +1 @@
-{"version":3,"file":"check-dependencies.js","sourceRoot":"","sources":["../../lib/check-dependencies.js"],"names":[],"mappings":";;;;;;AAAA,6CAAqC;AACrC,oDAAuB;AACvB,+CAAoC;AACpC,gDAAwB;AACxB,8DAAsC;AACtC,2CAEqB;AACrB,mCAAyC;AACzC,sDAA2B;AAE3B,KAAK,UAAU,WAAW;IACxB,MAAM,IAAI,GAAG;QACX,UAAU,EAAE,cAAI,CAAC,IAAI,CAAC,sBAAc,EAAE,0BAA0B,CAAC;QACjE,SAAS,EAAE,sBAAU;QACrB,MAAM,EAAE,yBAAa;QACrB,uBAAuB;QACvB,4BAA4B;QAC5B,gCAAgC;KACjC,CAAC;IACF,MAAM,IAAA,mBAAI,EAAC,YAAY,EAAE,IAAI,CAAC,CAAC;AACjC,CAAC;AAED,yCAAyC;AACzC,KAAK,UAAU,oBAAoB;IACjC,gBAAG,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC;IACzC,OAAO,KAAK,CAAC;AACf,CAAC;AAgBQ,oDAAoB;AAd7B,KAAK,UAAU,YAAY,CAAE,UAAU;IACrC,IAAI,UAAU,IAAI,CAAC,gBAAC,CAAC,UAAU,CAAC,UAAU,CAAC,uBAAuB,CAAC,EAAE,CAAC;QACpE,UAAU,GAAG,IAAI,oBAAU,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IACtC,CAAC;IAED,MAAM,eAAe,GAAG,MAAM,UAAU,CAAC,uBAAuB,EAAE,CAAC;IACnE,MAAM,aAAa,GAAG,cAAI,CAAC,IAAI,CAAC,eAAe,EAAE,OAAO,EAAE,UAAU,EAAE,uBAAuB,EAAE,0BAAc,CAAC,CAAC;IAC/G,IAAI,MAAM,YAAE,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC;QACnC,OAAO,aAAa,CAAC;IACvB,CAAC;IACD,MAAM,WAAW,EAAE,CAAC;IACpB,OAAO,aAAa,CAAC;AACvB,CAAC;AAE8B,oCAAY"}
+{"version":3,"file":"check-dependencies.js","sourceRoot":"","sources":["../../lib/check-dependencies.js"],"names":[],"mappings":";;;;;;AAAA,6CAAqC;AACrC,oDAAuB;AACvB,+CAAoC;AACpC,gDAAwB;AACxB,8DAAsC;AACtC,gEAAiC;AACjC,2CAEqB;AACrB,mCAAyC;AACzC,sDAA2B;AAE3B,KAAK,UAAU,WAAW;IACxB,MAAM,IAAI,GAAG;QACX,UAAU,EAAE,cAAI,CAAC,IAAI,CAAC,sBAAc,EAAE,0BAA0B,CAAC;QACjE,SAAS,EAAE,sBAAU;QACrB,MAAM,EAAE,yBAAa;QACrB,uBAAuB;QACvB,4BAA4B;QAC5B,gCAAgC;KACjC,CAAC;IACF,MAAM,IAAA,mBAAI,EAAC,YAAY,EAAE,IAAI,CAAC,CAAC;AACjC,CAAC;AAED,yCAAyC;AAClC,KAAK,UAAU,oBAAoB;IACxC,gBAAG,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC;IACzC,OAAO,KAAK,CAAC;AACf,CAAC;AAHD,oDAGC;AAED;;;;GAIG;AACI,KAAK,UAAU,YAAY,CAAE,UAAU;IAC5C,IAAI,UAAU,IAAI,CAAC,gBAAC,CAAC,UAAU,CAAC,UAAU,CAAC,uBAAuB,CAAC,EAAE,CAAC;QACpE,UAAU,GAAG,IAAI,oBAAU,CAAC,kDAAkD,CAAC,CAAC,MAAM,sBAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IACrH,CAAC;IAED,MAAM,eAAe,GAAG,MAAM,UAAU,CAAC,uBAAuB,EAAE,CAAC;IACnE,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAC;IAC/E,CAAC;IACD,MAAM,aAAa,GAAG,cAAI,CAAC,IAAI,CAAC,eAAe,EAAE,OAAO,EAAE,UAAU,EAAE,uBAAuB,EAAE,0BAAc,CAAC,CAAC;IAC/G,IAAI,MAAM,YAAE,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC;QACnC,OAAO,aAAa,CAAC;IACvB,CAAC;IACD,MAAM,WAAW,EAAE,CAAC;IACpB,OAAO,aAAa,CAAC;AACvB,CAAC;AAfD,oCAeC"}

package/build/lib/types.d.ts

@@ -0,0 +1,48 @@
+export interface WDASettings {
+    elementResponseAttribute?: string;
+    shouldUseCompactResponses?: boolean;
+    mjpegServerScreenshotQuality?: number;
+    mjpegServerFramerate?: number;
+    screenshotQuality?: number;
+    elementResponseAttributes?: string;
+    mjpegScalingFactor?: number;
+    mjpegFixOrientation?: boolean;
+    keyboardAutocorrection?: boolean;
+    keyboardPrediction?: boolean;
+    customSnapshotTimeout?: number;
+    snapshotMaxDepth?: number;
+    useFirstMatch?: boolean;
+    boundElementsByIndex?: boolean;
+    reduceMotion?: boolean;
+    defaultActiveApplication?: string;
+    activeAppDetectionPoint?: string;
+    includeNonModalElements?: boolean;
+    defaultAlertAction?: 'accept' | 'dismiss';
+    acceptAlertButtonSelector?: string;
+    dismissAlertButtonSelector?: string;
+    screenshotOrientation?: 'auto' | 'portrait' | 'portraitUpsideDown' | 'landscapeRight' | 'landscapeLeft';
+    waitForIdleTimeout?: number;
+    animationCoolOffTimeout?: number;
+}
+export interface WDACapabilities {
+    bundleId?: string;
+    initialUrl?: string;
+    arguments?: string[];
+    environment?: Record<string, string>;
+    eventloopIdleDelaySec?: number;
+    shouldWaitForQuiescence?: boolean;
+    shouldUseTestManagerForVisibilityDetection?: boolean;
+    maxTypingFrequency?: number;
+    shouldUseSingletonTestManager?: boolean;
+    waitForIdleTimeout?: number;
+    shouldUseCompactResponses?: number;
+    elementResponseFields?: unknown;
+    disableAutomaticScreenshots?: boolean;
+    shouldTerminateApp?: boolean;
+    forceAppLaunch?: boolean;
+    useNativeCachingStrategy?: boolean;
+    forceSimulatorSoftwareKeyboardPresence?: boolean;
+    defaultAlertAction?: 'accept' | 'dismiss';
+    appLaunchStateTimeoutSec?: number;
+}
+//# sourceMappingURL=types.d.ts.map

package/build/lib/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../lib/types.ts"],"names":[],"mappings":"AACA,MAAM,WAAW,WAAW;IAC1B,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC,4BAA4B,CAAC,EAAE,MAAM,CAAC;IACtC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,kBAAkB,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAC1C,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC,qBAAqB,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,oBAAoB,GAAG,gBAAgB,GAAG,eAAe,CAAA;IACvG,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,uBAAuB,CAAC,EAAE,MAAM,CAAC;CAClC;AAGD,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACrC,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,0CAA0C,CAAC,EAAE,OAAO,CAAC;IACrD,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,6BAA6B,CAAC,EAAE,OAAO,CAAC;IACxC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,2BAA2B,CAAC,EAAE,OAAO,CAAC;IACtC,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC,sCAAsC,CAAC,EAAE,OAAO,CAAC;IACjD,kBAAkB,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAC1C,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC"}

package/build/lib/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/build/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../lib/types.ts"],"names":[],"mappings":""}

package/build/lib/webdriveragent.d.ts

@@ -1,8 +1,18 @@
-export default WebDriverAgent;
+/// <reference types="node" />
 export class WebDriverAgent {
-    constructor(xcodeVersion: any, args?: {}, log?: null);
-    xcodeVersion: any;
-    args: {};
+    /**
+     * @param {import('appium-xcode').XcodeVersion} xcodeVersion
+     * // TODO: make args typed
+     * @param {import('@appium/types').StringRecord} [args={}]
+     * @param {import('@appium/types').AppiumLogger?} [log=null]
+     */
+    constructor(xcodeVersion: import('appium-xcode').XcodeVersion, args?: import("@appium/types").StringRecord<any> | undefined, log?: import("@appium/types").AppiumLogger | null | undefined);
+    /** @type {string} */
+    bootstrapPath: string;
+    /** @type {string} */
+    agentPath: string;
+    xcodeVersion: import("appium-xcode/build/lib/xcode").XcodeVersion;
+    args: import("@appium/types").StringRecord<any>;
     log: import("@appium/types").AppiumLogger;
     device: any;
     platformVersion: any;
@@ -43,9 +53,14 @@ export class WebDriverAgent {
      * @returns {string} Bundle ID for Xctest.
      */
     get bundleIdForXctest(): string;
-    setWDAPaths(bootstrapPath: any, agentPath: any): void;
-    bootstrapPath: any;
-    agentPath: any;
+    /**
+     * @param {string} [bootstrapPath]
+     * @param {string} [agentPath]
+     */
+    setWDAPaths(bootstrapPath?: string | undefined, agentPath?: string | undefined): void;
+    /**
+     * @returns {Promise<void>}
+     */
     cleanupObsoleteProcesses(): Promise<void>;
     /**
      * Return boolean if WDA is running or not
@@ -53,7 +68,10 @@ export class WebDriverAgent {
      * @throws {Error} If there was invalid response code or body
      */
     isRunning(): Promise<boolean>;
-    get basePath(): any;
+    /**
+     * @returns {string}
+     */
+    get basePath(): string;
     /**
      * Return current running WDA's status like below
      * {
@@ -85,6 +103,8 @@ export class WebDriverAgent {
      * Uninstall WDAs from the test device.
      * Over Xcode 11, multiple WDA can be in the device since Xcode 11 generates different WDA.
      * Appium does not expect multiple WDAs are running on a device.
+     *
+     * @returns {Promise<void>}
      */
     uninstall(): Promise<void>;
     _cleanupProjectIfFresh(): Promise<void>;
@@ -142,38 +162,83 @@ export class WebDriverAgent {
      * @throws {Error} If there was invalid response code or body
      */
     launch(sessionId: string): Promise<any | null>;
-    set url(_url: any);
-    get url(): any;
-    startWithIDB(): Promise<any>;
-    parseBundleId(wdaBundlePath: any): Promise<any>;
+    /**
+     * @param {string} _url
+     * @returns {void}
+     */
+    set url(_url: url.UrlWithStringQuery);
+    /**
+     * @returns {import('url').UrlWithStringQuery}
+     */
+    get url(): url.UrlWithStringQuery;
+    /**
+     * @returns {Promise<void>}
+     */
+    startWithIDB(): Promise<void>;
+    /**
+     *
+     * @param {string} wdaBundlePath
+     * @returns {Promise<string>}
+     */
+    parseBundleId(wdaBundlePath: string): Promise<string>;
+    /**
+     * @returns {Promise<{wdaBundleId: string, testBundleId: string, wdaBundlePath: string}>}
+     */
     prepareWDA(): Promise<{
-        wdaBundleId: any;
-        testBundleId: any;
+        wdaBundleId: string;
+        testBundleId: string;
         wdaBundlePath: string;
     }>;
+    /**
+     * @returns {Promise<string>}
+     */
     fetchWDABundle(): Promise<string>;
+    /**
+     * @returns {Promise<boolean>}
+     */
     isSourceFresh(): Promise<boolean>;
-    setupProxies(sessionId: any): void;
+    /**
+     * @param {string} sessionId
+     * @returns {void}
+     */
+    setupProxies(sessionId: string): void;
     jwproxy: JWProxy | undefined;
     proxyReqRes: any;
     noSessionProxy: NoSessionProxy | undefined;
+    /**
+     * @returns {Promise<void>}
+     */
     quit(): Promise<void>;
-    _url: any;
+    _url: url.UrlWithStringQuery | undefined;
+    /**
+     * @param {boolean} started
+     * @returns {void}s
+     */
     set fullyStarted(started: boolean);
+    /**
+     * @returns {boolean}
+     */
     get fullyStarted(): boolean;
-    retrieveDerivedDataPath(): Promise<any>;
+    /**
+     * @returns {Promise<string|undefined>}
+     */
+    retrieveDerivedDataPath(): Promise<string | undefined>;
     /**
      * Reuse running WDA if it has the same bundle id with updatedWDABundleId.
      * Or reuse it if it has the default id without updatedWDABundleId.
      * Uninstall it if the method faces an exception for the above situation.
+     * @returns {Promise<void>}
      */
     setupCaching(): Promise<void>;
     /**
      * Quit and uninstall running WDA.
+     * @returns {Promise<void>}
      */
     quitAndUninstall(): Promise<void>;
 }
+export default WebDriverAgent;
 import XcodeBuild from './xcodebuild';
+import url from 'url';
 import { JWProxy } from '@appium/base-driver';
 import { NoSessionProxy } from './no-session-proxy';
 //# sourceMappingURL=webdriveragent.d.ts.map

package/build/lib/webdriveragent.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"webdriveragent.d.ts","sourceRoot":"","sources":["../../lib/webdriveragent.js"],"names":[],"mappings":";AA6BA;IACE,sDAuEC;IAtEC,kBAAgC;IAEhC,SAAyB;IACzB,0CAA+B;IAE/B,YAAyB;IACzB,qBAA2C;IAC3C,kBAAqC;IACrC,mBAAuC;IACvC,UAAqB;IACrB,sBAAqC;IACrC,SAAkC;IAClC,mBAAuC;IAIvC,kBAAqC;IACrC,mBAAwD;IACxD,gBAAiD;IAEjD,iBAAmC;IAKnC,uBAA+C;IAE/C,iBAAoB;IAEpB,0BAAqD;IAErD,sBAA6C;IAC7C,oBAAyC;IACzC,qBAA2C;IAC3C,qBAA2C;IAE3C,wBAAiD;IAEjD,sBAAmE;IACnE,wBAAiD;IACjD,qBAA2B;IAC3B,8BAA2F;IAE3F,8BA0Bc;IAGhB;;;OAGG;IACH,iCAIC;IAED;;;;;;;OAOG;IACH,gCAEC;IAED,sDASC;IANC,mBAAoD;IAIpD,eAA0F;IAI5F,0CAmBC;IAED;;;;OAIG;IACH,aAHY,QAAQ,OAAO,CAAC,CAK3B;IAED,oBAKC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,2CAJY,QAAQ,OAAO,eAAe,EAAE,YAAY,GAAC,IAAI,CAAC,CA4C7D;IAED;;;;OAIG;IACH,2BAiBC;IAED,wCA4DC;IAGD;;;OAGG;IAEH;;;;;;;;;;;OAWG;IACH;;;;;oBAFY,QAAQ,IAAI,CAAC,CAQxB;IAED;;;;;;OAMG;IACH,qCALW,MAAM,GACL,QAAQ,OAAO,eAAe,EAAE,YAAY,GAAC,IAAI,CAAC,CA+C7D;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,kBAJW,MAAM,GACL,QAAQ,GAAG,QAAE,CAmDxB;IAyHD,mBAEC;IAfD,eAWC;IArHD,6BAYC;IAED,gDAOC;IAED;;;;OAQC;IAED,kCAWC;IAED,kCAMC;IAED,mCAeC;IALC,6BAAqC;IAErC,iBAA8D;IAE9D,2CAAmD;IAGrD,sBAiCC;IAKK,UAA6C;IAkBnD,mCAEC;IAND,4BAEC;IAMD,wCAMC;IAED;;;;OAIG;IACH,8BAoCC;IAED;;OAEG;IACH,kCAGC;CACF;uBA/oBsB,cAAc;wBAPb,qBAAqB;+BAGd,oBAAoB"}
+{"version":3,"file":"webdriveragent.d.ts","sourceRoot":"","sources":["../../lib/webdriveragent.js"],"names":[],"mappings":";AA6BA;IAOE;;;;;OAKG;IACH,0BALW,OAAO,cAAc,EAAE,YAAY,+HA4E7C;IAnFD,qBAAqB;IACrB,eADW,MAAM,CACH;IAEd,qBAAqB;IACrB,WADW,MAAM,CACP;IASR,kEAAgC;IAEhC,gDAAyB;IACzB,0CAA+B;IAE/B,YAAyB;IACzB,qBAA2C;IAC3C,kBAAqC;IACrC,mBAAuC;IACvC,UAAqB;IACrB,sBAAqC;IACrC,SAAkC;IAClC,mBAAuC;IAIvC,kBAAqC;IACrC,mBAAwD;IACxD,gBAAiD;IAEjD,iBAAmC;IAKnC,uBAA+C;IAE/C,iBAAoB;IAEpB,0BAAqD;IAErD,sBAA6C;IAC7C,oBAAyC;IACzC,qBAA2C;IAC3C,qBAA2C;IAE3C,wBAAiD;IAEjD,sBAAmE;IACnE,wBAAiD;IACjD,qBAA2B;IAC3B,8BAA2F;IAE3F,8BA0Bc;IAGhB;;;OAGG;IACH,iCAIC;IAED;;;;;;;OAOG;IACH,gCAEC;IAED;;;OAGG;IACH,sFASC;IAED;;OAEG;IACH,4BAFa,QAAQ,IAAI,CAAC,CAqBzB;IAED;;;;OAIG;IACH,aAHY,QAAQ,OAAO,CAAC,CAK3B;IAED;;OAEG;IACH,uBAKC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,2CAJY,QAAQ,OAAO,eAAe,EAAE,YAAY,GAAC,IAAI,CAAC,CA4C7D;IAED;;;;;;OAMG;IACH,aAFa,QAAQ,IAAI,CAAC,CAmBzB;IAED,wCA4DC;IAGD;;;OAGG;IAEH;;;;;;;;;;;OAWG;IACH;;;;;oBAFY,QAAQ,IAAI,CAAC,CAQxB;IAED;;;;;;OAMG;IACH,qCALW,MAAM,GACL,QAAQ,OAAO,eAAe,EAAE,YAAY,GAAC,IAAI,CAAC,CA+C7D;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,kBAJW,MAAM,GACL,QAAQ,GAAG,QAAE,CAmDxB;IAoJD;;;OAGG;IACH,sCAEC;IAtBD;;OAEG;IACH,kCAWC;IAhJD;;OAEG;IACH,gBAFa,QAAQ,IAAI,CAAC,CAczB;IAED;;;;OAIG;IACH,6BAHW,MAAM,GACJ,QAAQ,MAAM,CAAC,CAS3B;IAED;;OAEG;IACH,cAFa,QAAQ;QAAC,WAAW,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,MAAM,CAAC;QAAC,aAAa,EAAE,MAAM,CAAA;KAAC,CAAC,CAUvF;IAED;;OAEG;IACH,kBAFa,QAAQ,MAAM,CAAC,CAa3B;IAED;;OAEG;IACH,iBAFa,QAAQ,OAAO,CAAC,CAQ5B;IAED;;;OAGG;IACH,wBAHW,MAAM,GACJ,IAAI,CAiBhB;IALC,6BAAqC;IAErC,iBAA8D;IAE9D,2CAAmD;IAGrD;;OAEG;IACH,QAFa,QAAQ,IAAI,CAAC,CAmCzB;IAQK,yCAA6C;IAyBnD;;;OAGG;IACH,mCAEC;IAbD;;OAEG;IACH,4BAEC;IAUD;;OAEG;IACH,2BAFa,QAAQ,MAAM,GAAC,SAAS,CAAC,CAOrC;IAED;;;;;OAKG;IACH,gBAFa,QAAQ,IAAI,CAAC,CAsCzB;IAED;;;OAGG;IACH,oBAFa,QAAQ,IAAI,CAAC,CAKzB;CACF;;uBAjtBsB,cAAc;gBATrB,KAAK;wBAEG,qBAAqB;+BAGd,oBAAoB"}

package/build/lib/webdriveragent.js

@@ -27,6 +27,12 @@ const WDA_CF_BUNDLE_NAME = 'WebDriverAgentRunner-Runner';
 const SHARED_RESOURCES_GUARD = new async_lock_1.default();
 const RECENT_MODULE_VERSION_ITEM_NAME = 'recentWdaModuleVersion';
 class WebDriverAgent {
+    /**
+     * @param {import('appium-xcode').XcodeVersion} xcodeVersion
+     * // TODO: make args typed
+     * @param {import('@appium/types').StringRecord} [args={}]
+     * @param {import('@appium/types').AppiumLogger?} [log=null]
+     */
     constructor(xcodeVersion, args = {}, log = null) {
         this.xcodeVersion = xcodeVersion;
         this.args = lodash_1.default.clone(args);
@@ -107,6 +113,10 @@ class WebDriverAgent {
     get bundleIdForXctest() {
         return `${this.updatedWDABundleId ? this.updatedWDABundleId : constants_1.WDA_RUNNER_BUNDLE_ID}${this.updatedWDABundleIdSuffix}`;
     }
+    /**
+     * @param {string} [bootstrapPath]
+     * @param {string} [agentPath]
+     */
     setWDAPaths(bootstrapPath, agentPath) {
         // allow the user to specify a place for WDA. This is undocumented and
         // only here for the purposes of testing development of WDA
@@ -116,8 +126,11 @@ class WebDriverAgent {
         this.agentPath = agentPath || path_1.default.resolve(this.bootstrapPath, 'WebDriverAgent.xcodeproj');
         this.log.info(`Using WDA agent: '${this.agentPath}'`);
     }
+    /**
+     * @returns {Promise<void>}
+     */
     async cleanupObsoleteProcesses() {
-        const obsoletePids = await (0, utils_1.getPIDsListeningOnPort)(this.url.port, (cmdLine) => cmdLine.includes('/WebDriverAgentRunner') &&
+        const obsoletePids = await (0, utils_1.getPIDsListeningOnPort)(/** @type {string} */ (this.url.port), (cmdLine) => cmdLine.includes('/WebDriverAgentRunner') &&
             !cmdLine.toLowerCase().includes(this.device.udid.toLowerCase()));
         if (lodash_1.default.isEmpty(obsoletePids)) {
             this.log.debug(`No obsolete cached processes from previous WDA sessions ` +
@@ -142,6 +155,9 @@ class WebDriverAgent {
     async isRunning() {
         return !!(await this.getStatus());
     }
+    /**
+     * @returns {string}
+     */
     get basePath() {
         if (this.url.path === '/') {
             return '';
@@ -219,6 +235,8 @@ class WebDriverAgent {
      * Uninstall WDAs from the test device.
      * Over Xcode 11, multiple WDA can be in the device since Xcode 11 generates different WDA.
      * Appium does not expect multiple WDAs are running on a device.
+     *
+     * @returns {Promise<void>}
      */
     async uninstall() {
         try {
@@ -430,6 +448,9 @@ class WebDriverAgent {
         // @ts-ignore xcodebuild should be set
         return await this.xcodebuild.start();
     }
+    /**
+     * @returns {Promise<void>}
+     */
     async startWithIDB() {
         this.log.info('Will launch WDA with idb instead of xcodebuild since the corresponding flag is enabled');
         const { wdaBundleId, testBundleId } = await this.prepareWDA();
@@ -442,6 +463,11 @@ class WebDriverAgent {
         }
         return await this.idb.runXCUITest(wdaBundleId, wdaBundleId, testBundleId, { env });
     }
+    /**
+     *
+     * @param {string} wdaBundlePath
+     * @returns {Promise<string>}
+     */
     async parseBundleId(wdaBundlePath) {
         const infoPlistPath = path_1.default.join(wdaBundlePath, 'Info.plist');
         const infoPlist = await support_1.plist.parsePlist(await support_1.fs.readFile(infoPlistPath));
@@ -450,6 +476,9 @@ class WebDriverAgent {
         }
         return infoPlist.CFBundleIdentifier;
     }
+    /**
+     * @returns {Promise<{wdaBundleId: string, testBundleId: string, wdaBundlePath: string}>}
+     */
     async prepareWDA() {
         const wdaBundlePath = this.wdaBundlePath || await this.fetchWDABundle();
         const wdaBundleId = await this.parseBundleId(wdaBundlePath);
@@ -459,9 +488,12 @@ class WebDriverAgent {
         const testBundleId = await this.idb.installXCTestBundle(path_1.default.join(wdaBundlePath, 'PlugIns', 'WebDriverAgentRunner.xctest'));
         return { wdaBundleId, testBundleId, wdaBundlePath };
     }
+    /**
+     * @returns {Promise<string>}
+     */
     async fetchWDABundle() {
         if (!this.derivedDataPath) {
-            return await (0, check_dependencies_1.bundleWDASim)(this.xcodebuild);
+            return await (0, check_dependencies_1.bundleWDASim)(/** @type {XcodeBuild} */ (this.xcodebuild));
         }
         const wdaBundlePaths = await support_1.fs.glob(`${this.derivedDataPath}/**/*${constants_1.WDA_RUNNER_APP}/`, {
             absolute: true,
@@ -471,13 +503,20 @@ class WebDriverAgent {
         }
         return wdaBundlePaths[0];
     }
+    /**
+     * @returns {Promise<boolean>}
+     */
     async isSourceFresh() {
         const existsPromises = [
             'Resources',
             `Resources${path_1.default.sep}WebDriverAgent.bundle`,
-        ].map((subPath) => support_1.fs.exists(path_1.default.resolve(this.bootstrapPath, subPath)));
+        ].map((subPath) => support_1.fs.exists(path_1.default.resolve(/** @type {String} */ (this.bootstrapPath), subPath)));
         return (await bluebird_1.default.all(existsPromises)).some((v) => v === false);
     }
+    /**
+     * @param {string} sessionId
+     * @returns {void}
+     */
     setupProxies(sessionId) {
         const proxyOpts = {
             log: this.log,
@@ -492,6 +531,9 @@ class WebDriverAgent {
         this.proxyReqRes = this.jwproxy.proxyReqRes.bind(this.jwproxy);
         this.noSessionProxy = new no_session_proxy_1.NoSessionProxy(proxyOpts);
     }
+    /**
+     * @returns {Promise<void>}
+     */
     async quit() {
         if (this.usePreinstalledWDA) {
             this.log.info('Stopping the XCTest session');
@@ -527,6 +569,9 @@ class WebDriverAgent {
             this.webDriverAgentUrl = null;
         }
     }
+    /**
+     * @returns {import('url').UrlWithStringQuery}
+     */
     get url() {
         if (!this._url) {
             if (this.webDriverAgentUrl) {
@@ -540,26 +585,40 @@ class WebDriverAgent {
         }
         return this._url;
     }
+    /**
+     * @param {string} _url
+     * @returns {void}
+     */
     set url(_url) {
         this._url = url_1.default.parse(_url);
     }
+    /**
+     * @returns {boolean}
+     */
     get fullyStarted() {
         return this.started;
     }
+    /**
+     * @param {boolean} started
+     * @returns {void}s
+     */
     set fullyStarted(started) {
         this.started = started ?? false;
     }
+    /**
+     * @returns {Promise<string|undefined>}
+     */
     async retrieveDerivedDataPath() {
         if (this.canSkipXcodebuild) {
             return;
         }
-        // @ts-ignore xcodebuild should be set
-        return await this.xcodebuild.retrieveDerivedDataPath();
+        return await /** @type {XcodeBuild} */ (this.xcodebuild).retrieveDerivedDataPath();
     }
     /**
      * Reuse running WDA if it has the same bundle id with updatedWDABundleId.
      * Or reuse it if it has the default id without updatedWDABundleId.
      * Uninstall it if the method faces an exception for the above situation.
+     * @returns {Promise<void>}
      */
     async setupCaching() {
         const status = await this.getStatus();
@@ -594,6 +653,7 @@ class WebDriverAgent {
     }
     /**
      * Quit and uninstall running WDA.
+     * @returns {Promise<void>}
      */
     async quitAndUninstall() {
         await this.quit();