appium-android-driver 5.13.1 → 5.13.2

package/build/lib/utils.js

@@ -1,22 +1,27 @@
 "use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.ADB_SHELL_FEATURE = void 0;
-exports.requireArgs = requireArgs;
-require("source-map-support/register");
-var _lodash = _interopRequireDefault(require("lodash"));
-var _driver = require("appium/driver");
-const ADB_SHELL_FEATURE = 'adb_shell';
-exports.ADB_SHELL_FEATURE = ADB_SHELL_FEATURE;
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.requireArgs = exports.ADB_SHELL_FEATURE = void 0;
+const lodash_1 = __importDefault(require("lodash"));
+const driver_1 = require("appium/driver");
+exports.ADB_SHELL_FEATURE = 'adb_shell';
+/**
+ * Assert the presence of particular keys in the given object
+ *
+ * @template {Object} T
+ * @param {string|string[]} argNames one or more key names
+ * @param {T} opts the object to check
+ * @returns {T} the same given object
+ */
 function requireArgs(argNames, opts = {}) {
-  for (const argName of _lodash.default.isArray(argNames) ? argNames : [argNames]) {
-    if (!_lodash.default.has(opts, argName)) {
-      throw new _driver.errors.InvalidArgumentError(`'${argName}' argument must be provided`);
+    for (const argName of (lodash_1.default.isArray(argNames) ? argNames : [argNames])) {
+        if (!lodash_1.default.has(opts, argName)) {
+            throw new driver_1.errors.InvalidArgumentError(`'${argName}' argument must be provided`);
+        }
     }
-  }
-  return opts;
+    return opts;
 }
-//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJuYW1lcyI6WyJfbG9kYXNoIiwiX2ludGVyb3BSZXF1aXJlRGVmYXVsdCIsInJlcXVpcmUiLCJfZHJpdmVyIiwiQURCX1NIRUxMX0ZFQVRVUkUiLCJleHBvcnRzIiwicmVxdWlyZUFyZ3MiLCJhcmdOYW1lcyIsIm9wdHMiLCJhcmdOYW1lIiwiXyIsImlzQXJyYXkiLCJoYXMiLCJlcnJvcnMiLCJJbnZhbGlkQXJndW1lbnRFcnJvciJdLCJzb3VyY2VzIjpbIi4uLy4uL2xpYi91dGlscy5qcyJdLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgXyBmcm9tICdsb2Rhc2gnO1xuaW1wb3J0IHsgZXJyb3JzIH0gZnJvbSAnYXBwaXVtL2RyaXZlcic7XG5cbmV4cG9ydCBjb25zdCBBREJfU0hFTExfRkVBVFVSRSA9ICdhZGJfc2hlbGwnO1xuXG4vKipcbiAqIEFzc2VydCB0aGUgcHJlc2VuY2Ugb2YgcGFydGljdWxhciBrZXlzIGluIHRoZSBnaXZlbiBvYmplY3RcbiAqXG4gKiBAdGVtcGxhdGUge09iamVjdH0gVFxuICogQHBhcmFtIHtzdHJpbmd8c3RyaW5nW119IGFyZ05hbWVzIG9uZSBvciBtb3JlIGtleSBuYW1lc1xuICogQHBhcmFtIHtUfSBvcHRzIHRoZSBvYmplY3QgdG8gY2hlY2tcbiAqIEByZXR1cm5zIHtUfSB0aGUgc2FtZSBnaXZlbiBvYmplY3RcbiAqL1xuZXhwb3J0IGZ1bmN0aW9uIHJlcXVpcmVBcmdzIChhcmdOYW1lcywgb3B0cyA9IHt9KSB7XG4gIGZvciAoY29uc3QgYXJnTmFtZSBvZiAoXy5pc0FycmF5KGFyZ05hbWVzKSA/IGFyZ05hbWVzIDogW2FyZ05hbWVzXSkpIHtcbiAgICBpZiAoIV8uaGFzKG9wdHMsIGFyZ05hbWUpKSB7XG4gICAgICB0aHJvdyBuZXcgZXJyb3JzLkludmFsaWRBcmd1bWVudEVycm9yKGAnJHthcmdOYW1lfScgYXJndW1lbnQgbXVzdCBiZSBwcm92aWRlZGApO1xuICAgIH1cbiAgfVxuICByZXR1cm4gb3B0cztcbn0iXSwibWFwcGluZ3MiOiI7Ozs7Ozs7OztBQUFBLElBQUFBLE9BQUEsR0FBQUMsc0JBQUEsQ0FBQUMsT0FBQTtBQUNBLElBQUFDLE9BQUEsR0FBQUQsT0FBQTtBQUVPLE1BQU1FLGlCQUFpQixHQUFHLFdBQVc7QUFBQ0MsT0FBQSxDQUFBRCxpQkFBQSxHQUFBQSxpQkFBQTtBQVV0QyxTQUFTRSxXQUFXQSxDQUFFQyxRQUFRLEVBQUVDLElBQUksR0FBRyxDQUFDLENBQUMsRUFBRTtFQUNoRCxLQUFLLE1BQU1DLE9BQU8sSUFBS0MsZUFBQyxDQUFDQyxPQUFPLENBQUNKLFFBQVEsQ0FBQyxHQUFHQSxRQUFRLEdBQUcsQ0FBQ0EsUUFBUSxDQUFDLEVBQUc7SUFDbkUsSUFBSSxDQUFDRyxlQUFDLENBQUNFLEdBQUcsQ0FBQ0osSUFBSSxFQUFFQyxPQUFPLENBQUMsRUFBRTtNQUN6QixNQUFNLElBQUlJLGNBQU0sQ0FBQ0Msb0JBQW9CLENBQUUsSUFBR0wsT0FBUSw2QkFBNEIsQ0FBQztJQUNqRjtFQUNGO0VBQ0EsT0FBT0QsSUFBSTtBQUNiIn0=
+exports.requireArgs = requireArgs;
+//# sourceMappingURL=utils.js.map

package/build/lib/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","names":["_lodash","_interopRequireDefault","require","_driver","ADB_SHELL_FEATURE","exports","requireArgs","argNames","opts","argName","_","isArray","has","errors","InvalidArgumentError"],"sources":["../../lib/utils.js"],"sourcesContent":["import _ from 'lodash';\nimport { errors } from 'appium/driver';\n\nexport const ADB_SHELL_FEATURE = 'adb_shell';\n\n/**\n * Assert the presence of particular keys in the given object\n *\n * @template {Object} T\n * @param {string|string[]} argNames one or more key names\n * @param {T} opts the object to check\n * @returns {T} the same given object\n */\nexport function requireArgs (argNames, opts = {}) {\n  for (const argName of (_.isArray(argNames) ? argNames : [argNames])) {\n    if (!_.has(opts, argName)) {\n      throw new errors.InvalidArgumentError(`'${argName}' argument must be provided`);\n    }\n  }\n  return opts;\n}"],"mappings":";;;;;;;;;AAAA,IAAAA,OAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,OAAA,GAAAD,OAAA;AAEO,MAAME,iBAAiB,GAAG,WAAW;AAACC,OAAA,CAAAD,iBAAA,GAAAA,iBAAA;AAUtC,SAASE,WAAWA,CAAEC,QAAQ,EAAEC,IAAI,GAAG,CAAC,CAAC,EAAE;EAChD,KAAK,MAAMC,OAAO,IAAKC,eAAC,CAACC,OAAO,CAACJ,QAAQ,CAAC,GAAGA,QAAQ,GAAG,CAACA,QAAQ,CAAC,EAAG;IACnE,IAAI,CAACG,eAAC,CAACE,GAAG,CAACJ,IAAI,EAAEC,OAAO,CAAC,EAAE;MACzB,MAAM,IAAII,cAAM,CAACC,oBAAoB,CAAE,IAAGL,OAAQ,6BAA4B,CAAC;IACjF;EACF;EACA,OAAOD,IAAI;AACb"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../lib/utils.js"],"names":[],"mappings":";;;;;;AAAA,oDAAuB;AACvB,0CAAuC;AAE1B,QAAA,iBAAiB,GAAG,WAAW,CAAC;AAE7C;;;;;;;GAOG;AACH,SAAgB,WAAW,CAAE,QAAQ,EAAE,IAAI,GAAG,EAAE;IAC9C,KAAK,MAAM,OAAO,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE;QACnE,IAAI,CAAC,gBAAC,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE;YACzB,MAAM,IAAI,eAAM,CAAC,oBAAoB,CAAC,IAAI,OAAO,6BAA6B,CAAC,CAAC;SACjF;KACF;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAPD,kCAOC"}

package/build/lib/webview-helpers.d.ts

@@ -0,0 +1,223 @@
+export default helpers;
+export type WebviewProc = {
+    /**
+     * - The webview process name (as returned by
+     * getPotentialWebviewProcs
+     */
+    proc: string;
+    /**
+     * - The actual webview context name
+     */
+    webview: string;
+};
+export type WebviewProps = {
+    /**
+     * The name of the Devtools Unix socket
+     */
+    proc: string;
+    /**
+     * The web view alias. Looks like `WEBVIEW_`
+     * prefix plus PID or package name
+     */
+    webview: string;
+    /**
+     * Webview information as it is retrieved by
+     * /json/version CDP endpoint
+     */
+    info: any | null;
+    /**
+     * Webview pages list as it is retrieved by
+     * /json/list CDP endpoint
+     */
+    pages: Array<any> | null;
+};
+export type DetailCollectionOptions = {
+    /**
+     * The starting port to use for webview page
+     * presence check (if not the default of 9222).
+     */
+    webviewDevtoolsPort: (string | number) | null;
+    /**
+     * Whether to check for webview
+     * pages presence
+     */
+    ensureWebviewsHavePages: boolean | null;
+    /**
+     * Whether to collect
+     * web view details and send them to Chromedriver constructor, so it could
+     * select a binary more precisely based on this info.
+     */
+    enableWebviewDetailsCollection: boolean;
+};
+export type GetWebviewsOpts = {
+    /**
+     * [null] - device socket name
+     */
+    androidDeviceSocket: string;
+    /**
+     * [true] - whether to check for webview
+     * page presence
+     */
+    ensureWebviewsHavePages: boolean;
+    /**
+     * [9222] - port to use for webview page
+     * presence check.
+     */
+    webviewDevtoolsPort: number;
+    /**
+     * [true] - whether to collect
+     * web view details and send them to Chromedriver constructor, so it could
+     * select a binary more precisely based on this info.
+     */
+    enableWebviewDetailsCollection: boolean;
+};
+export type WebviewsMapping = {
+    /**
+     * See note on WebviewProps
+     */
+    proc: string;
+    /**
+     * See note on WebviewProps
+     */
+    webview: string;
+    /**
+     * See note on WebviewProps
+     */
+    info: any | null;
+    /**
+     * See note on WebviewProps
+     */
+    pages: Array<any> | null;
+};
+export type ProcessInfo = {
+    /**
+     * The process name
+     */
+    name: string;
+    /**
+     * The process id (if could be retrieved)
+     */
+    id: string | null;
+};
+export type WebViewDetails = {
+    /**
+     * - Web view process details
+     */
+    process: ProcessInfo | null;
+    /**
+     * - Web view details as returned by /json/version CDP endpoint, for example:
+     * {
+     * "Browser": "Chrome/72.0.3601.0",
+     * "Protocol-Version": "1.3",
+     * "User-Agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3601.0 Safari/537.36",
+     * "V8-Version": "7.2.233",
+     * "WebKit-Version": "537.36 (@cfede9db1d154de0468cb0538479f34c0755a0f4)",
+     * "webSocketDebuggerUrl": "ws://localhost:9222/devtools/browser/b0b8a4fb-bb17-4359-9533-a8d9f3908bd8"
+     * }
+     */
+    info: any;
+};
+export namespace helpers {
+    /**
+     * Take a webview name like WEBVIEW_4296 and use 'adb shell ps' to figure out
+     * which app package is associated with that webview. One of the reasons we
+     * want to do this is to make sure we're listing webviews for the actual AUT,
+     * not some other running app
+     *
+     * @param {object} adb - an ADB instance
+     * @param {string} webview - a webview process name
+     *
+     * @returns {string} - the package name of the app running the webview
+     * @throws {Error} If there was a failure while retrieving the process name
+     */
+    function procFromWebview(adb: any, webview: string): string;
+    /**
+     * Parse webview names for getContexts
+     *
+     * @param {Array<WebviewsMapping>} webviewsMapping See note on getWebViewsMapping
+     * @param {GetWebviewsOpts} opts See note on getWebViewsMapping
+     * @return {Array.<string>} - a list of webview names
+     */
+    function parseWebviewNames(webviewsMapping: WebviewsMapping[], { ensureWebviewsHavePages, isChromeSession }?: GetWebviewsOpts): string[];
+    /**
+     * @typedef {Object} GetWebviewsOpts
+     * @property {string} androidDeviceSocket [null] - device socket name
+     * @property {boolean} ensureWebviewsHavePages [true] - whether to check for webview
+     * page presence
+     * @property {number} webviewDevtoolsPort [9222] - port to use for webview page
+     * presence check.
+     * @property {boolean} enableWebviewDetailsCollection [true] - whether to collect
+     * web view details and send them to Chromedriver constructor, so it could
+     * select a binary more precisely based on this info.
+     */
+    /**
+     * @typedef {Object} WebviewsMapping
+     * @property {string} proc See note on WebviewProps
+     * @property {string} webview See note on WebviewProps
+     * @property {?Object} info See note on WebviewProps
+     * @property {?Array<Object>} pages See note on WebviewProps
+     * @propery {?string} webviewName An actual webview name for switching context
+     */
+    /**
+     * Get a list of available webviews mapping by introspecting processes with adb,
+     * where webviews are listed. It's possible to pass in a 'deviceSocket' arg, which
+     * limits the webview possibilities to the one running on the Chromium devtools
+     * socket we're interested in (see note on webviewsFromProcs). We can also
+     * direct this method to verify whether a particular webview process actually
+     * has any pages (if a process exists but no pages are found, Chromedriver will
+     * not actually be able to connect to it, so this serves as a guard for that
+     * strange failure mode). The strategy for checking whether any pages are
+     * active involves sending a request to the remote debug server on the device,
+     * hence it is also possible to specify the port on the host machine which
+     * should be used for this communication.
+     *
+     * @param {object} adb - an ADB instance
+     * @param {GetWebviewsOpts} opts
+     *
+     * @return {Array<WebviewsMapping>} webviewsMapping
+     */
+    function getWebViewsMapping(adb: any, { androidDeviceSocket, ensureWebviewsHavePages, webviewDevtoolsPort, enableWebviewDetailsCollection }?: GetWebviewsOpts): WebviewsMapping[];
+    /**
+     * @typedef {Object} ProcessInfo
+     * @property {string} name The process name
+     * @property {?string} id The process id (if could be retrieved)
+     */
+    /**
+     * @typedef {Object} WebViewDetails
+     * @property {?ProcessInfo} process - Web view process details
+     * @property {Object} info - Web view details as returned by /json/version CDP endpoint, for example:
+     * {
+     *  "Browser": "Chrome/72.0.3601.0",
+     *  "Protocol-Version": "1.3",
+     *  "User-Agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3601.0 Safari/537.36",
+     *  "V8-Version": "7.2.233",
+     *  "WebKit-Version": "537.36 (@cfede9db1d154de0468cb0538479f34c0755a0f4)",
+     *  "webSocketDebuggerUrl": "ws://localhost:9222/devtools/browser/b0b8a4fb-bb17-4359-9533-a8d9f3908bd8"
+     * }
+     */
+    /**
+     * Retrieves web view details previously cached by `getWebviews` call
+     *
+     * @param {ADB} adb ADB instance
+     * @param {string} webview The name of the web view
+     * @returns {?WebViewDetails} Either `undefined` or the recent web view details
+     */
+    function getWebviewDetails(adb: ADB, webview: string): WebViewDetails | null;
+    /**
+     * Create Chrome driver capabilities based on the provided
+     * Appium capabilities
+     *
+     * @param {Object} opts User-provided capabilities object
+     * @param {string} deviceId The identifier of the Android device under test
+     * @param {?WebViewDetails} webViewDetails
+     * @returns {Object} The capabilities object.
+     * See https://chromedriver.chromium.org/capabilities for more details.
+     */
+    function createChromedriverCaps(opts: any, deviceId: string, webViewDetails: WebViewDetails | null): any;
+}
+export const NATIVE_WIN: "NATIVE_APP";
+export const WEBVIEW_WIN: "WEBVIEW";
+export const WEBVIEW_BASE: string;
+export const CHROMIUM_WIN: "CHROMIUM";
+export const KNOWN_CHROME_PACKAGE_NAMES: string[];
+//# sourceMappingURL=webview-helpers.d.ts.map

package/build/lib/webview-helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webview-helpers.d.ts","sourceRoot":"","sources":["../../lib/webview-helpers.js"],"names":[],"mappings":";;;;;;UA0Fc,MAAM;;;;aAEN,MAAM;;;;;;UAyFN,MAAM;;;;;aACN,MAAM;;;;;;;;;;WAIL,UAAa;;;;;;;0BAMb,MAAM,GAAC,MAAM;;;;;6BAEb,OAAO;;;;;;oCAER,OAAO;;;;;;yBAsJP,MAAM;;;;;6BACN,OAAO;;;;;yBAEP,MAAM;;;;;;oCAEN,OAAO;;;;;;UAOP,MAAM;;;;aACN,MAAM;;;;;;;;WAEL,UAAa;;;;;;UA0Ed,MAAM;;;;QACL,MAAM;;;;;;aAKN,WAAW;;;;;;;;;;;;;;;IAzJ1B;;;;;;;;;;;OAWG;IACH,4DAYC;IAED;;;;;;OAMG;IACH,yIAqBC;IAED;;;;;;;;;;OAUG;IAEH;;;;;;;OAOG;IAEH;;;;;;;;;;;;;;;;;OAiBG;IACH,kLAgDC;IAED;;;;OAIG;IAEH;;;;;;;;;;;;OAYG;IAEH;;;;;;OAMG;IACH,6EAGC;IAED;;;;;;;;;OASG;IACH,yGAsFC;;AAviBD,sCAAgC;AAChC,oCAA8B;AAE9B,kCAAuC;AADvC,sCAAgC;AAQhC,kDAKE"}