@appium/base-driver 10.2.0 → 10.2.2

package/build/lib/helpers/capabilities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"capabilities.d.ts","sourceRoot":"","sources":["../../../lib/helpers/capabilities.js"],"names":[],"mappings":"AAIA;;;;;;GAMG;AACH,gCAHW,GAAG,GACD,IAAI,IAAI,4CAAuC,CAsB3D;AAED;;;;;;;GAOG;AACH,wBAN2B,CAAC,SAAd,WAAY,WACf,GAAG,yBACH,CAAC,OACD,YAAY,GACV,YAAY,CAAC,CAAC,CAAC,CAyC3B;0BAGY,OAAO,eAAe,EAAE,WAAW;2BACnC,OAAO,eAAe,EAAE,YAAY;2BACpC,OAAO,eAAe,EAAE,YAAY;uCACpC,OAAO,eAAe,EAAE,wBAAwB;yBAIlC,CAAC,SAAd,WAAY,IACb,OAAO,eAAe,EAAE,YAAY,CAAC,CAAC,CAAC"}
+{"version":3,"file":"capabilities.d.ts","sourceRoot":"","sources":["../../../lib/helpers/capabilities.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,WAAW,EAAE,eAAe,EAAE,YAAY,EAAE,YAAY,EAAC,MAAM,eAAe,CAAC;AAG5F;;;GAGG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,eAAe,CAAC,WAAW,CAAC,CAqB7E;AAED;;GAEG;AACH,wBAAgB,OAAO,CAAC,CAAC,SAAS,WAAW,EAC3C,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAChC,qBAAqB,EAAE,CAAC,EACxB,GAAG,EAAE,YAAY,GAChB,YAAY,CAAC,CAAC,CAAC,CA6CjB"}

package/build/lib/helpers/capabilities.js

@@ -1,5 +1,4 @@
 "use strict";
-// @ts-check
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -10,76 +9,65 @@ const lodash_1 = __importDefault(require("lodash"));
 /**
  * Determine whether the given argument is valid
  * W3C capabilities instance.
- *
- * @param {any} caps
- * @returns {caps is import('@appium/types').W3CCapabilities}
  */
 function isW3cCaps(caps) {
     if (!lodash_1.default.isPlainObject(caps)) {
         return false;
     }
-    const isFirstMatchValid = () => lodash_1.default.isArray(caps.firstMatch) &&
-        !lodash_1.default.isEmpty(caps.firstMatch) &&
-        lodash_1.default.every(caps.firstMatch, lodash_1.default.isPlainObject);
-    const isAlwaysMatchValid = () => lodash_1.default.isPlainObject(caps.alwaysMatch);
-    if (lodash_1.default.has(caps, 'firstMatch') && lodash_1.default.has(caps, 'alwaysMatch')) {
+    const c = caps;
+    const isFirstMatchValid = () => lodash_1.default.isArray(c.firstMatch) &&
+        !lodash_1.default.isEmpty(c.firstMatch) &&
+        lodash_1.default.every(c.firstMatch, lodash_1.default.isPlainObject);
+    const isAlwaysMatchValid = () => lodash_1.default.isPlainObject(c.alwaysMatch);
+    if (lodash_1.default.has(c, 'firstMatch') && lodash_1.default.has(c, 'alwaysMatch')) {
         return isFirstMatchValid() && isAlwaysMatchValid();
     }
-    if (lodash_1.default.has(caps, 'firstMatch')) {
+    if (lodash_1.default.has(c, 'firstMatch')) {
         return isFirstMatchValid();
     }
-    if (lodash_1.default.has(caps, 'alwaysMatch')) {
+    if (lodash_1.default.has(c, 'alwaysMatch')) {
         return isAlwaysMatchValid();
     }
     return false;
 }
 /**
- *
- * @template {Constraints} C
- * @param {any} oldCaps
- * @param {C} desiredCapConstraints
- * @param {AppiumLogger} log
- * @returns {Capabilities<C>}
+ * Normalize capability values according to constraints (e.g. string 'true' → boolean).
  */
 function fixCaps(oldCaps, desiredCapConstraints, log) {
-    let caps = lodash_1.default.clone(oldCaps);
+    const caps = lodash_1.default.clone(oldCaps);
+    const logCastWarning = (prefix) => log.warn(`${prefix}. This may cause unexpected behavior`);
     // boolean capabilities can be passed in as strings 'false' and 'true'
     // which we want to translate into boolean values
-    let booleanCaps = lodash_1.default.keys(lodash_1.default.pickBy(desiredCapConstraints, (k) => k.isBoolean === true));
-    for (let cap of booleanCaps) {
-        let value = oldCaps[cap];
-        if (lodash_1.default.isString(value)) {
-            value = value.toLowerCase();
-            if (value === 'true' || value === 'false') {
-                log.warn(`Capability '${cap}' changed from string to boolean. This may cause unexpected behavior`);
-                caps[cap] = value === 'true';
-            }
+    const booleanCaps = lodash_1.default.keys(lodash_1.default.pickBy(desiredCapConstraints, (k) => k.isBoolean === true));
+    for (const cap of booleanCaps) {
+        const value = oldCaps[cap];
+        if (!lodash_1.default.isString(value)) {
+            continue;
         }
+        if (!['true', 'false'].includes(value.toLowerCase())) {
+            logCastWarning(`String capability '${cap}' ('${value}') cannot be converted to a boolean`);
+            continue;
+        }
+        logCastWarning(`Capability '${cap}' changed from string '${value}' to boolean`);
+        caps[cap] = value.toLowerCase() === 'true';
     }
     // int capabilities are often sent in as strings by frameworks
-    let intCaps = /** @type {import('type-fest').KeyAsString<typeof caps>[]} */ (lodash_1.default.keys(lodash_1.default.pickBy(desiredCapConstraints, (k) => k.isNumber === true)));
-    for (let cap of intCaps) {
-        let value = oldCaps[cap];
-        if (lodash_1.default.isString(value)) {
-            value = value.trim();
-            let newValue = parseInt(value, 10);
-            if (value !== `${newValue}`) {
-                newValue = parseFloat(value);
-            }
-            log.warn(`Capability '${cap}' changed from string ('${value}') to integer (${newValue}). This may cause unexpected behavior`);
-            caps[cap] = newValue;
+    const intCaps = lodash_1.default.keys(lodash_1.default.pickBy(desiredCapConstraints, (k) => k.isNumber === true));
+    for (const cap of intCaps) {
+        const value = oldCaps[cap];
+        if (!lodash_1.default.isString(value)) {
+            continue;
+        }
+        const intValue = parseInt(value, 10);
+        const floatValue = parseFloat(value);
+        const newValue = floatValue !== intValue ? floatValue : intValue;
+        if (Number.isNaN(newValue)) {
+            logCastWarning(`String capability '${cap}' ('${value}') cannot be converted to a number`);
+            continue;
         }
+        logCastWarning(`Capability '${cap}' changed from string '${value}' to number ${newValue}`);
+        caps[cap] = newValue;
     }
     return caps;
 }
-/**
- * @typedef {import('@appium/types').Constraints} Constraints
- * @typedef {import('@appium/types').AppiumLogger} AppiumLogger
- * @typedef {import('@appium/types').StringRecord} StringRecord
- * @typedef {import('@appium/types').BaseDriverCapConstraints} BaseDriverCapConstraints
- */
-/**
- * @template {Constraints} C
- * @typedef {import('@appium/types').Capabilities<C>} Capabilities
- */
 //# sourceMappingURL=capabilities.js.map

package/build/lib/helpers/capabilities.js.map

@@ -1 +1 @@
-{"version":3,"file":"capabilities.js","sourceRoot":"","sources":["../../../lib/helpers/capabilities.js"],"names":[],"mappings":";AAAA,YAAY;;;;;AAWZ,8BAoBC;AAUD,0BAuCC;AA9ED,oDAAuB;AAEvB;;;;;;GAMG;AACH,SAAgB,SAAS,CAAC,IAAI;IAC5B,IAAI,CAAC,gBAAC,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,iBAAiB,GAAG,GAAG,EAAE,CAC7B,gBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC;QAC1B,CAAC,gBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC;QAC3B,gBAAC,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,EAAE,gBAAC,CAAC,aAAa,CAAC,CAAC;IAC5C,MAAM,kBAAkB,GAAG,GAAG,EAAE,CAAC,gBAAC,CAAC,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACnE,IAAI,gBAAC,CAAC,GAAG,CAAC,IAAI,EAAE,YAAY,CAAC,IAAI,gBAAC,CAAC,GAAG,CAAC,IAAI,EAAE,aAAa,CAAC,EAAE,CAAC;QAC5D,OAAO,iBAAiB,EAAE,IAAI,kBAAkB,EAAE,CAAC;IACrD,CAAC;IACD,IAAI,gBAAC,CAAC,GAAG,CAAC,IAAI,EAAE,YAAY,CAAC,EAAE,CAAC;QAC9B,OAAO,iBAAiB,EAAE,CAAC;IAC7B,CAAC;IACD,IAAI,gBAAC,CAAC,GAAG,CAAC,IAAI,EAAE,aAAa,CAAC,EAAE,CAAC;QAC/B,OAAO,kBAAkB,EAAE,CAAC;IAC9B,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,OAAO,CAAC,OAAO,EAAE,qBAAqB,EAAE,GAAG;IACzD,IAAI,IAAI,GAAG,gBAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAE5B,sEAAsE;IACtE,iDAAiD;IACjD,IAAI,WAAW,GAAG,gBAAC,CAAC,IAAI,CAAC,gBAAC,CAAC,MAAM,CAAC,qBAAqB,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC;IACvF,KAAK,IAAI,GAAG,IAAI,WAAW,EAAE,CAAC;QAC5B,IAAI,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;QACzB,IAAI,gBAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACtB,KAAK,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;YAC5B,IAAI,KAAK,KAAK,MAAM,IAAI,KAAK,KAAK,OAAO,EAAE,CAAC;gBAC1C,GAAG,CAAC,IAAI,CACN,eAAe,GAAG,sEAAsE,CACzF,CAAC;gBACF,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,KAAK,MAAM,CAAC;YAC/B,CAAC;QACH,CAAC;IACH,CAAC;IAED,8DAA8D;IAC9D,IAAI,OAAO,GAAG,6DAA6D,CAAC,CAC1E,gBAAC,CAAC,IAAI,CAAC,gBAAC,CAAC,MAAM,CAAC,qBAAqB,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,IAAI,CAAC,CAAC,CACpE,CAAC;IACF,KAAK,IAAI,GAAG,IAAI,OAAO,EAAE,CAAC;QACxB,IAAI,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;QACzB,IAAI,gBAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACtB,KAAK,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;YACrB,IAAI,QAAQ,GAAG,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;YACnC,IAAI,KAAK,KAAK,GAAG,QAAQ,EAAE,EAAE,CAAC;gBAC5B,QAAQ,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;YAC/B,CAAC;YACD,GAAG,CAAC,IAAI,CACN,eAAe,GAAG,2BAA2B,KAAK,kBAAkB,QAAQ,uCAAuC,CACpH,CAAC;YACF,IAAI,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC;QACvB,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AAEH;;;GAGG"}
+{"version":3,"file":"capabilities.js","sourceRoot":"","sources":["../../../lib/helpers/capabilities.ts"],"names":[],"mappings":";;;;;AAOA,8BAqBC;AAKD,0BAiDC;AAjFD,oDAAuB;AAEvB;;;GAGG;AACH,SAAgB,SAAS,CAAC,IAAa;IACrC,IAAI,CAAC,gBAAC,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,CAAC,GAAG,IAA+B,CAAC;IAC1C,MAAM,iBAAiB,GAAG,GAAG,EAAE,CAC7B,gBAAC,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC;QACvB,CAAC,gBAAC,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC;QACxB,gBAAC,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,EAAE,gBAAC,CAAC,aAAa,CAAC,CAAC;IACzC,MAAM,kBAAkB,GAAG,GAAG,EAAE,CAAC,gBAAC,CAAC,aAAa,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC;IAChE,IAAI,gBAAC,CAAC,GAAG,CAAC,CAAC,EAAE,YAAY,CAAC,IAAI,gBAAC,CAAC,GAAG,CAAC,CAAC,EAAE,aAAa,CAAC,EAAE,CAAC;QACtD,OAAO,iBAAiB,EAAE,IAAI,kBAAkB,EAAE,CAAC;IACrD,CAAC;IACD,IAAI,gBAAC,CAAC,GAAG,CAAC,CAAC,EAAE,YAAY,CAAC,EAAE,CAAC;QAC3B,OAAO,iBAAiB,EAAE,CAAC;IAC7B,CAAC;IACD,IAAI,gBAAC,CAAC,GAAG,CAAC,CAAC,EAAE,aAAa,CAAC,EAAE,CAAC;QAC5B,OAAO,kBAAkB,EAAE,CAAC;IAC9B,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;GAEG;AACH,SAAgB,OAAO,CACrB,OAAgC,EAChC,qBAAwB,EACxB,GAAiB;IAEjB,MAAM,IAAI,GAAG,gBAAC,CAAC,KAAK,CAAC,OAAO,CAA4B,CAAC;IAEzD,MAAM,cAAc,GAAG,CAAC,MAAc,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,MAAM,sCAAsC,CAAC,CAAC;IAErG,sEAAsE;IACtE,iDAAiD;IACjD,MAAM,WAAW,GAAG,gBAAC,CAAC,IAAI,CAAC,gBAAC,CAAC,MAAM,CAAC,qBAAqB,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC;IACzF,KAAK,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC;QAC9B,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;QAC3B,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACvB,SAAS;QACX,CAAC;QAED,IAAI,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;YACrD,cAAc,CAAC,sBAAsB,GAAG,OAAO,KAAK,qCAAqC,CAAC,CAAC;YAC3F,SAAS;QACX,CAAC;QAED,cAAc,CAAC,eAAe,GAAG,0BAA0B,KAAK,cAAc,CAAC,CAAC;QAChF,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,WAAW,EAAE,KAAK,MAAM,CAAC;IAC7C,CAAC;IAED,8DAA8D;IAC9D,MAAM,OAAO,GAAG,gBAAC,CAAC,IAAI,CAAC,gBAAC,CAAC,MAAM,CAAC,qBAAqB,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC;IACpF,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;QAC1B,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;QAC3B,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACvB,SAAS;QACX,CAAC;QAED,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAe,EAAE,EAAE,CAAC,CAAC;QAC/C,MAAM,UAAU,GAAG,UAAU,CAAC,KAAe,CAAC,CAAC;QAC/C,MAAM,QAAQ,GAAG,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC;QAEjE,IAAI,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC3B,cAAc,CAAC,sBAAsB,GAAG,OAAO,KAAK,oCAAoC,CAAC,CAAC;YAC1F,SAAS;QACX,CAAC;QAED,cAAc,CAAC,eAAe,GAAG,0BAA0B,KAAK,eAAe,QAAQ,EAAE,CAAC,CAAC;QAC3F,IAAI,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC;IACvB,CAAC;IAED,OAAO,IAAuB,CAAC;AACjC,CAAC"}

package/build/lib/jsonwp-proxy/protocol-converter.d.ts

@@ -1,89 +1,53 @@
-export const COMMAND_URLS_CONFLICTS: {
-    commandNames: string[];
-    jsonwpConverter: (url: any) => any;
-    w3cConverter: (url: any) => any;
-}[];
-export default ProtocolConverter;
-export type ProxyFunction = (url: string, method: string, body?: import("@appium/types").HTTPBody) => Promise<[import("@appium/types").ProxyResponse, import("@appium/types").HTTPBody]>;
-declare class ProtocolConverter {
-    /**
-     *
-     * @param {ProxyFunction} proxyFunc
-     * @param {import('@appium/types').AppiumLogger | null} [log=null]
-     */
-    constructor(proxyFunc: ProxyFunction, log?: import("@appium/types").AppiumLogger | null);
+import type { AppiumLogger, HTTPBody, ProxyResponse } from '@appium/types';
+export type ProxyFunction = (url: string, method: string, body?: HTTPBody) => Promise<[ProxyResponse, HTTPBody]>;
+export declare const COMMAND_URLS_CONFLICTS: readonly [{
+    readonly commandNames: readonly ["execute", "executeAsync"];
+    readonly jsonwpConverter: (url: string) => string;
+    readonly w3cConverter: (url: string) => string;
+}, {
+    readonly commandNames: readonly ["getElementScreenshot"];
+    readonly jsonwpConverter: (url: string) => string;
+    readonly w3cConverter: (url: string) => string;
+}, {
+    readonly commandNames: readonly ["getWindowHandles", "getWindowHandle"];
+    readonly jsonwpConverter: (url: string) => string;
+    readonly w3cConverter: (url: string) => string;
+}, {
+    readonly commandNames: readonly ["getProperty"];
+    readonly jsonwpConverter: (w3cUrl: string) => string;
+    readonly w3cConverter: (jsonwpUrl: string) => string;
+}];
+export declare class ProtocolConverter {
     proxyFunc: ProxyFunction;
-    _downstreamProtocol: any;
-    _log: import("@appium/types").AppiumLogger | null;
-    get log(): import("@appium/types").AppiumLogger;
-    set downstreamProtocol(value: any);
-    get downstreamProtocol(): any;
-    /**
-     * W3C /timeouts can take as many as 3 timeout types at once, MJSONWP /timeouts only takes one
-     * at a time. So if we're using W3C and proxying to MJSONWP and there's more than one timeout type
-     * provided in the request, we need to do 3 proxies and combine the result
-     *
-     * @param {Object} body Request body
-     * @return {Object[]} Array of W3C + MJSONWP compatible timeout objects
-     */
-    getTimeoutRequestObjects(body: any): any[];
-    /**
-     * Proxy an array of timeout objects and merge the result
-     * @param {string} url Endpoint url
-     * @param {string} method Endpoint method
-     * @param {import('@appium/types').HTTPBody} body Request body
-     * @returns {Promise<[import('@appium/types').ProxyResponse, import('@appium/types').HTTPBody]>}
-     */
-    proxySetTimeouts(url: string, method: string, body: import("@appium/types").HTTPBody): Promise<[import("@appium/types").ProxyResponse, import("@appium/types").HTTPBody]>;
-    /**
-     *
-     * @param {string} url
-     * @param {string} method
-     * @param {import('@appium/types').HTTPBody} body
-     * @returns {Promise<[import('@appium/types').ProxyResponse, import('@appium/types').HTTPBody]>}
-     */
-    proxySetWindow(url: string, method: string, body: import("@appium/types").HTTPBody): Promise<[import("@appium/types").ProxyResponse, import("@appium/types").HTTPBody]>;
+    private _downstreamProtocol;
+    private readonly _log;
     /**
-     *
-     * @param {string} url
-     * @param {string} method
-     * @param {import('@appium/types').HTTPBody} body
-     * @returns {Promise<[import('@appium/types').ProxyResponse, import('@appium/types').HTTPBody]>}
+     * @param proxyFunc - Function to perform the actual proxy request
+     * @param log - Logger instance, or null to use the default
      */
-    proxySetValue(url: string, method: string, body: import("@appium/types").HTTPBody): Promise<[import("@appium/types").ProxyResponse, import("@appium/types").HTTPBody]>;
+    constructor(proxyFunc: ProxyFunction, log?: AppiumLogger | null);
+    get log(): AppiumLogger;
+    set downstreamProtocol(value: string | null | undefined);
+    get downstreamProtocol(): string | null | undefined;
     /**
-     *
-     * @param {string} url
-     * @param {string} method
-     * @param {import('@appium/types').HTTPBody} body
-     * @returns {Promise<[import('@appium/types').ProxyResponse, import('@appium/types').HTTPBody]>}
+     * Handle "crossing" endpoints for the case when upstream and downstream
+     * drivers operate different protocols.
      */
-    proxySetFrame(url: string, method: string, body: import("@appium/types").HTTPBody): Promise<[import("@appium/types").ProxyResponse, import("@appium/types").HTTPBody]>;
+    convertAndProxy(commandName: string, url: string, method: string, body?: HTTPBody): Promise<[ProxyResponse, HTTPBody]>;
     /**
-     *
-     * @param {string} url
-     * @param {string} method
-     * @param {import('@appium/types').HTTPBody} body
-     * @returns {Promise<[import('@appium/types').ProxyResponse, import('@appium/types').HTTPBody]>}
-     */
-    proxyPerformActions(url: string, method: string, body: import("@appium/types").HTTPBody): Promise<[import("@appium/types").ProxyResponse, import("@appium/types").HTTPBody]>;
-    /**
-     *
-     * @param {string} url
-     * @param {string} method
-     * @returns {Promise<[import('@appium/types').ProxyResponse, import('@appium/types').HTTPBody]>}
+     * W3C /timeouts can take as many as 3 timeout types at once, MJSONWP /timeouts only takes one
+     * at a time. So if we're using W3C and proxying to MJSONWP and there's more than one timeout type
+     * provided in the request, we need to do 3 proxies and combine the result.
      */
-    proxyReleaseActions(url: string, method: string): Promise<[import("@appium/types").ProxyResponse, import("@appium/types").HTTPBody]>;
+    private getTimeoutRequestObjects;
     /**
-     * Handle "crossing" endpoints for the case
-     * when upstream and downstream drivers operate different protocols
-     *
-     * @param {string} commandName
-     * @param {string} url
-     * @param {string} method
-     * @param {import('@appium/types').HTTPBody} [body]
-     * @returns {Promise<[import('@appium/types').ProxyResponse, import('@appium/types').HTTPBody]>}
+     * Proxy an array of timeout objects and merge the result.
      */
-    convertAndProxy(commandName: string, url: string, method: string, body?: import("@appium/types").HTTPBody): Promise<[import("@appium/types").ProxyResponse, import("@appium/types").HTTPBody]>;
+    private proxySetTimeouts;
+    private proxySetWindow;
+    private proxySetValue;
+    private proxySetFrame;
+    private proxyPerformActions;
+    private proxyReleaseActions;
 }
 //# sourceMappingURL=protocol-converter.d.ts.map

package/build/lib/jsonwp-proxy/protocol-converter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"protocol-converter.d.ts","sourceRoot":"","sources":["../../../lib/jsonwp-proxy/protocol-converter.js"],"names":[],"mappings":"AAKA;;;;IAmCE;;4BAmRW,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,eAAe,EAAE,QAAQ,KAAK,OAAO,CAAC,CAAC,OAAO,eAAe,EAAE,aAAa,EAAE,OAAO,eAAe,EAAE,QAAQ,CAAC,CAAC;AA/QzK;IACE;;;;OAIG;IACH,uBAHW,aAAa,QACb,OAAO,eAAe,EAAE,YAAY,GAAG,IAAI,EAMrD;IAHC,yBAA0B;IAC1B,yBAA+B;IAC/B,kDAAe;IAGjB,gDAEC;IAED,mCAEC;IAED,8BAEC;IAED;;;;;;;OAOG;IACH,qCAFY,KAAQ,CA4BnB;IAED;;;;;;OAMG;IACH,sBALW,MAAM,UACN,MAAM,QACN,OAAO,eAAe,EAAE,QAAQ,GAC9B,OAAO,CAAC,CAAC,OAAO,eAAe,EAAE,aAAa,EAAE,OAAO,eAAe,EAAE,QAAQ,CAAC,CAAC,CA2B9F;IAED;;;;;;OAMG;IACH,oBALW,MAAM,UACN,MAAM,QACN,OAAO,eAAe,EAAE,QAAQ,GAC9B,OAAO,CAAC,CAAC,OAAO,eAAe,EAAE,aAAa,EAAE,OAAO,eAAe,EAAE,QAAQ,CAAC,CAAC,CA8B9F;IAED;;;;;;OAMG;IACH,mBALW,MAAM,UACN,MAAM,QACN,OAAO,eAAe,EAAE,QAAQ,GAC9B,OAAO,CAAC,CAAC,OAAO,eAAe,EAAE,aAAa,EAAE,OAAO,eAAe,EAAE,QAAQ,CAAC,CAAC,CAyB9F;IAED;;;;;;OAMG;IACH,mBALW,MAAM,UACN,MAAM,QACN,OAAO,eAAe,EAAE,QAAQ,GAC9B,OAAO,CAAC,CAAC,OAAO,eAAe,EAAE,aAAa,EAAE,OAAO,eAAe,EAAE,QAAQ,CAAC,CAAC,CAU9F;IAED;;;;;;OAMG;IACH,yBALW,MAAM,UACN,MAAM,QACN,OAAO,eAAe,EAAE,QAAQ,GAC9B,OAAO,CAAC,CAAC,OAAO,eAAe,EAAE,aAAa,EAAE,OAAO,eAAe,EAAE,QAAQ,CAAC,CAAC,CAW9F;IAED;;;;;OAKG;IACH,yBAJW,MAAM,UACN,MAAM,GACJ,OAAO,CAAC,CAAC,OAAO,eAAe,EAAE,aAAa,EAAE,OAAO,eAAe,EAAE,QAAQ,CAAC,CAAC,CAI9F;IAED;;;;;;;;;OASG;IACH,6BANW,MAAM,OACN,MAAM,UACN,MAAM,SACN,OAAO,eAAe,EAAE,QAAQ,GAC9B,OAAO,CAAC,CAAC,OAAO,eAAe,EAAE,aAAa,EAAE,OAAO,eAAe,EAAE,QAAQ,CAAC,CAAC,CAiD9F;CACF"}
+{"version":3,"file":"protocol-converter.d.ts","sourceRoot":"","sources":["../../../lib/jsonwp-proxy/protocol-converter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,YAAY,EAAE,QAAQ,EAAE,aAAa,EAAC,MAAM,eAAe,CAAC;AAMzE,MAAM,MAAM,aAAa,GAAG,CAC1B,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM,EACd,IAAI,CAAC,EAAE,QAAQ,KACZ,OAAO,CAAC,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC,CAAC;AAExC,eAAO,MAAM,sBAAsB;;oCAGR,MAAM;iCAET,MAAM;;;oCAKH,MAAM;iCACT,MAAM;;;oCAIL,MAAM;iCAKT,MAAM;;;uCAQE,MAAM;uCAKN,MAAM;EAE1B,CAAC;AAKX,qBAAa,iBAAiB;IASnB,SAAS,EAAE,aAAa;IARjC,OAAO,CAAC,mBAAmB,CAAmC;IAC9D,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAsB;IAE3C;;;OAGG;gBAEM,SAAS,EAAE,aAAa,EAC/B,GAAG,GAAE,YAAY,GAAG,IAAW;IAKjC,IAAI,GAAG,IAAI,YAAY,CAEtB;IAED,IAAI,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAEtD;IAED,IAAI,kBAAkB,IAAI,MAAM,GAAG,IAAI,GAAG,SAAS,CAElD;IAED;;;OAGG;IACG,eAAe,CACnB,WAAW,EAAE,MAAM,EACnB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM,EACd,IAAI,CAAC,EAAE,QAAQ,GACd,OAAO,CAAC,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;IA8CrC;;;;OAIG;IACH,OAAO,CAAC,wBAAwB;IA6BhC;;OAEG;YACW,gBAAgB;YA+BhB,cAAc;YAwBd,aAAa;YAoBb,aAAa;YAeb,mBAAmB;YAgBnB,mBAAmB;CAMlC"}

package/build/lib/jsonwp-proxy/protocol-converter.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.COMMAND_URLS_CONFLICTS = void 0;
+exports.ProtocolConverter = exports.COMMAND_URLS_CONFLICTS = void 0;
 const lodash_1 = __importDefault(require("lodash"));
 const support_1 = require("@appium/support");
 const helpers_1 = require("../basedriver/helpers");
@@ -36,23 +36,24 @@ exports.COMMAND_URLS_CONFLICTS = [
         commandNames: ['getProperty'],
         jsonwpConverter: (w3cUrl) => {
             const w3cPropertyRegex = /\/element\/([^/]+)\/property\/([^/]+)/;
-            const jsonwpUrl = w3cUrl.replace(w3cPropertyRegex, '/element/$1/attribute/$2');
-            return jsonwpUrl;
+            return w3cUrl.replace(w3cPropertyRegex, '/element/$1/attribute/$2');
         },
-        w3cConverter: (jsonwpUrl) => jsonwpUrl, // Don't convert JSONWP URL to W3C. W3C accepts /attribute and /property
+        // Don't convert JSONWP URL to W3C. W3C accepts /attribute and /property
+        w3cConverter: (jsonwpUrl) => jsonwpUrl,
     },
 ];
 const { MJSONWP, W3C } = constants_1.PROTOCOLS;
 const DEFAULT_LOG = support_1.logger.getLogger('Protocol Converter');
 class ProtocolConverter {
+    proxyFunc;
+    _downstreamProtocol = null;
+    _log;
     /**
-     *
-     * @param {ProxyFunction} proxyFunc
-     * @param {import('@appium/types').AppiumLogger | null} [log=null]
+     * @param proxyFunc - Function to perform the actual proxy request
+     * @param log - Logger instance, or null to use the default
      */
     constructor(proxyFunc, log = null) {
         this.proxyFunc = proxyFunc;
-        this._downstreamProtocol = null;
         this._log = log;
     }
     get log() {
@@ -64,48 +65,88 @@ class ProtocolConverter {
     get downstreamProtocol() {
         return this._downstreamProtocol;
     }
+    /**
+     * Handle "crossing" endpoints for the case when upstream and downstream
+     * drivers operate different protocols.
+     */
+    async convertAndProxy(commandName, url, method, body) {
+        if (!this.downstreamProtocol) {
+            return await this.proxyFunc(url, method, body);
+        }
+        // Same url, but different arguments
+        switch (commandName) {
+            case 'timeouts':
+                return await this.proxySetTimeouts(url, method, body);
+            case 'setWindow':
+                return await this.proxySetWindow(url, method, body);
+            case 'setValue':
+                return await this.proxySetValue(url, method, body);
+            case 'performActions':
+                return await this.proxyPerformActions(url, method, body);
+            case 'releaseActions':
+                return await this.proxyReleaseActions(url, method);
+            case 'setFrame':
+                return await this.proxySetFrame(url, method, body);
+            default:
+                break;
+        }
+        // Same arguments, but different URLs
+        for (const { commandNames, jsonwpConverter, w3cConverter } of exports.COMMAND_URLS_CONFLICTS) {
+            if (!commandNames.includes(commandName)) {
+                continue;
+            }
+            const rewrittenUrl = this.downstreamProtocol === MJSONWP ? jsonwpConverter(url) : w3cConverter(url);
+            if (rewrittenUrl === url) {
+                this.log.debug(`Did not know how to rewrite the original URL '${url}' for ${this.downstreamProtocol} protocol`);
+                break;
+            }
+            this.log.info(`Rewrote the original URL '${url}' to '${rewrittenUrl}' for ${this.downstreamProtocol} protocol`);
+            return await this.proxyFunc(rewrittenUrl, method, body);
+        }
+        // No matches found. Proceed normally
+        return await this.proxyFunc(url, method, body);
+    }
     /**
      * W3C /timeouts can take as many as 3 timeout types at once, MJSONWP /timeouts only takes one
      * at a time. So if we're using W3C and proxying to MJSONWP and there's more than one timeout type
-     * provided in the request, we need to do 3 proxies and combine the result
-     *
-     * @param {Object} body Request body
-     * @return {Object[]} Array of W3C + MJSONWP compatible timeout objects
+     * provided in the request, we need to do 3 proxies and combine the result.
      */
     getTimeoutRequestObjects(body) {
-        if (this.downstreamProtocol === W3C && lodash_1.default.has(body, 'ms') && lodash_1.default.has(body, 'type')) {
+        if (lodash_1.default.isNil(body)) {
+            return [];
+        }
+        const bodyObj = support_1.util.safeJsonParse(body) ?? {};
+        if (this.downstreamProtocol === W3C && lodash_1.default.has(bodyObj, 'ms') && lodash_1.default.has(bodyObj, 'type')) {
             const typeToW3C = (x) => (x === 'page load' ? 'pageLoad' : x);
             return [
                 {
-                    [typeToW3C(body.type)]: body.ms,
+                    [typeToW3C(bodyObj.type)]: bodyObj.ms,
                 },
             ];
         }
-        if (this.downstreamProtocol === MJSONWP && (!lodash_1.default.has(body, 'ms') || !lodash_1.default.has(body, 'type'))) {
+        if (this.downstreamProtocol === MJSONWP && (!lodash_1.default.has(bodyObj, 'ms') || !lodash_1.default.has(bodyObj, 'type'))) {
             const typeToJSONWP = (x) => (x === 'pageLoad' ? 'page load' : x);
-            return (lodash_1.default.toPairs(body)
+            return lodash_1.default.toPairs(bodyObj)
                 // Only transform the entry if ms value is a valid positive float number
                 .filter((pair) => /^\d+(?:[.,]\d*?)?$/.test(`${pair[1]}`))
-                .map(function (pair) {
-                return {
-                    type: typeToJSONWP(pair[0]),
-                    ms: pair[1],
-                };
+                .map((pair) => ({
+                type: typeToJSONWP(pair[0]),
+                ms: pair[1],
             }));
         }
-        return [body];
+        return [bodyObj];
     }
     /**
-     * Proxy an array of timeout objects and merge the result
-     * @param {string} url Endpoint url
-     * @param {string} method Endpoint method
-     * @param {import('@appium/types').HTTPBody} body Request body
-     * @returns {Promise<[import('@appium/types').ProxyResponse, import('@appium/types').HTTPBody]>}
+     * Proxy an array of timeout objects and merge the result.
      */
     async proxySetTimeouts(url, method, body) {
-        let response, resBody;
         const timeoutRequestObjects = this.getTimeoutRequestObjects(body);
+        if (timeoutRequestObjects.length === 0) {
+            return await this.proxyFunc(url, method, body);
+        }
         this.log.debug(`Will send the following request bodies to /timeouts: ${JSON.stringify(timeoutRequestObjects)}`);
+        let response;
+        let resBody;
         for (const timeoutObj of timeoutRequestObjects) {
             [response, resBody] = await this.proxyFunc(url, method, timeoutObj);
             // If we got a non-MJSONWP response, return the result, nothing left to do
@@ -118,47 +159,28 @@ class ProtocolConverter {
             }
             // ...Otherwise, continue to the next timeouts call
         }
-        return [/** @type {import('@appium/types').ProxyResponse} */ (response), resBody];
+        return [response, resBody];
     }
-    /**
-     *
-     * @param {string} url
-     * @param {string} method
-     * @param {import('@appium/types').HTTPBody} body
-     * @returns {Promise<[import('@appium/types').ProxyResponse, import('@appium/types').HTTPBody]>}
-     */
     async proxySetWindow(url, method, body) {
         const bodyObj = support_1.util.safeJsonParse(body);
         if (lodash_1.default.isPlainObject(bodyObj)) {
+            const obj = bodyObj;
             if (this.downstreamProtocol === W3C && lodash_1.default.has(bodyObj, 'name') && !lodash_1.default.has(bodyObj, 'handle')) {
-                this.log.debug(`Copied 'name' value '${ /** @type {import('@appium/types').StringRecord} */(bodyObj).name}' to 'handle' as per W3C spec`);
-                return await this.proxyFunc(url, method, {
-                    ... /** @type {import('@appium/types').StringRecord} */(bodyObj),
-                    handle: /** @type {import('@appium/types').StringRecord} */ (bodyObj).name,
-                });
+                this.log.debug(`Copied 'name' value '${obj.name}' to 'handle' as per W3C spec`);
+                return await this.proxyFunc(url, method, { ...obj, handle: obj.name });
             }
             if (this.downstreamProtocol === MJSONWP &&
                 lodash_1.default.has(bodyObj, 'handle') &&
                 !lodash_1.default.has(bodyObj, 'name')) {
-                this.log.debug(`Copied 'handle' value '${ /** @type {import('@appium/types').StringRecord} */(bodyObj).handle}' to 'name' as per JSONWP spec`);
-                return await this.proxyFunc(url, method, {
-                    ... /** @type {import('@appium/types').StringRecord} */(bodyObj),
-                    name: /** @type {import('@appium/types').StringRecord} */ (bodyObj).handle,
-                });
+                this.log.debug(`Copied 'handle' value '${obj.handle}' to 'name' as per JSONWP spec`);
+                return await this.proxyFunc(url, method, { ...obj, name: obj.handle });
             }
         }
         return await this.proxyFunc(url, method, body);
     }
-    /**
-     *
-     * @param {string} url
-     * @param {string} method
-     * @param {import('@appium/types').HTTPBody} body
-     * @returns {Promise<[import('@appium/types').ProxyResponse, import('@appium/types').HTTPBody]>}
-     */
     async proxySetValue(url, method, body) {
         const bodyObj = support_1.util.safeJsonParse(body);
-        if (lodash_1.default.isPlainObject(bodyObj) && (support_1.util.hasValue(bodyObj.text) || support_1.util.hasValue(bodyObj.value))) {
+        if (lodash_1.default.isPlainObject(bodyObj) && (support_1.util.hasValue(bodyObj?.text) || support_1.util.hasValue(bodyObj?.value))) {
             let { text, value } = bodyObj;
             if (support_1.util.hasValue(text) && !support_1.util.hasValue(value)) {
                 value = lodash_1.default.isString(text) ? [...text] : lodash_1.default.isArray(text) ? text : [];
@@ -168,104 +190,30 @@ class ProtocolConverter {
                 text = lodash_1.default.isArray(value) ? value.join('') : lodash_1.default.isString(value) ? value : '';
                 this.log.debug(`Added 'text' property to 'setValue' request body`);
             }
-            return await this.proxyFunc(url, method, {
-                ...bodyObj,
-                text,
-                value,
-            });
+            return await this.proxyFunc(url, method, { ...bodyObj, text, value });
         }
         return await this.proxyFunc(url, method, body);
     }
-    /**
-     *
-     * @param {string} url
-     * @param {string} method
-     * @param {import('@appium/types').HTTPBody} body
-     * @returns {Promise<[import('@appium/types').ProxyResponse, import('@appium/types').HTTPBody]>}
-     */
     async proxySetFrame(url, method, body) {
         const bodyObj = support_1.util.safeJsonParse(body);
-        return lodash_1.default.has(bodyObj, 'id') && lodash_1.default.isPlainObject(bodyObj.id)
-            ? await this.proxyFunc(url, method, {
+        if (lodash_1.default.has(bodyObj, 'id') && lodash_1.default.isPlainObject(bodyObj.id)) {
+            return await this.proxyFunc(url, method, {
                 ...bodyObj,
                 id: (0, helpers_1.duplicateKeys)(bodyObj.id, constants_1.MJSONWP_ELEMENT_KEY, constants_1.W3C_ELEMENT_KEY),
-            })
-            : await this.proxyFunc(url, method, body);
+            });
+        }
+        return await this.proxyFunc(url, method, body);
     }
-    /**
-     *
-     * @param {string} url
-     * @param {string} method
-     * @param {import('@appium/types').HTTPBody} body
-     * @returns {Promise<[import('@appium/types').ProxyResponse, import('@appium/types').HTTPBody]>}
-     */
     async proxyPerformActions(url, method, body) {
         const bodyObj = support_1.util.safeJsonParse(body);
-        return lodash_1.default.isPlainObject(bodyObj)
-            ? await this.proxyFunc(url, method, (0, helpers_1.duplicateKeys)(bodyObj, constants_1.MJSONWP_ELEMENT_KEY, constants_1.W3C_ELEMENT_KEY))
-            : await this.proxyFunc(url, method, body);
+        if (lodash_1.default.isPlainObject(bodyObj)) {
+            return await this.proxyFunc(url, method, (0, helpers_1.duplicateKeys)(bodyObj, constants_1.MJSONWP_ELEMENT_KEY, constants_1.W3C_ELEMENT_KEY));
+        }
+        return await this.proxyFunc(url, method, body);
     }
-    /**
-     *
-     * @param {string} url
-     * @param {string} method
-     * @returns {Promise<[import('@appium/types').ProxyResponse, import('@appium/types').HTTPBody]>}
-     */
     async proxyReleaseActions(url, method) {
         return await this.proxyFunc(url, method);
     }
-    /**
-     * Handle "crossing" endpoints for the case
-     * when upstream and downstream drivers operate different protocols
-     *
-     * @param {string} commandName
-     * @param {string} url
-     * @param {string} method
-     * @param {import('@appium/types').HTTPBody} [body]
-     * @returns {Promise<[import('@appium/types').ProxyResponse, import('@appium/types').HTTPBody]>}
-     */
-    async convertAndProxy(commandName, url, method, body) {
-        if (!this.downstreamProtocol) {
-            return await this.proxyFunc(url, method, body);
-        }
-        // Same url, but different arguments
-        switch (commandName) {
-            case 'timeouts':
-                return await this.proxySetTimeouts(url, method, body);
-            case 'setWindow':
-                return await this.proxySetWindow(url, method, body);
-            case 'setValue':
-                return await this.proxySetValue(url, method, body);
-            case 'performActions':
-                return await this.proxyPerformActions(url, method, body);
-            case 'releaseActions':
-                return await this.proxyReleaseActions(url, method);
-            case 'setFrame':
-                return await this.proxySetFrame(url, method, body);
-            default:
-                break;
-        }
-        // Same arguments, but different URLs
-        for (const { commandNames, jsonwpConverter, w3cConverter } of exports.COMMAND_URLS_CONFLICTS) {
-            if (!commandNames.includes(commandName)) {
-                continue;
-            }
-            const rewrittenUrl = this.downstreamProtocol === MJSONWP ? jsonwpConverter(url) : w3cConverter(url);
-            if (rewrittenUrl === url) {
-                this.log.debug(`Did not know how to rewrite the original URL '${url}' ` +
-                    `for ${this.downstreamProtocol} protocol`);
-                break;
-            }
-            this.log.info(`Rewrote the original URL '${url}' to '${rewrittenUrl}' ` +
-                `for ${this.downstreamProtocol} protocol`);
-            return await this.proxyFunc(rewrittenUrl, method, body);
-        }
-        // No matches found. Proceed normally
-        return await this.proxyFunc(url, method, body);
-    }
 }
-exports.default = ProtocolConverter;
-/**
- * @typedef {(url: string, method: string, body?: import('@appium/types').HTTPBody) => Promise<[import('@appium/types').ProxyResponse, import('@appium/types').HTTPBody]>} ProxyFunction
- */
+exports.ProtocolConverter = ProtocolConverter;
 //# sourceMappingURL=protocol-converter.js.map