@appium/base-driver 10.0.0 → 10.1.0

package/lib/protocol/routes.js

@@ -16,14 +16,8 @@ const COMMAND_NAMES_CACHE = new LRUCache({
  */
 export const METHOD_MAP = /** @type {const} */ ({
 
-  //
-  // W3C WebDriver
-  // https://www.w3.org/TR/webdriver1/
+  // #region W3C WebDriver
   // https://www.w3.org/TR/webdriver2/
-  //
-  '/status': {
-    GET: {command: 'getStatus'},
-  },
   '/session': {
     POST: {
       command: 'createSession',
@@ -33,10 +27,13 @@ export const METHOD_MAP = /** @type {const} */ ({
     },
   },
   '/session/:sessionId': {
-    // TODO: Decide on the future of this route later
+    // TODO: JSONWP route, remove in the future
     GET: {command: 'getSession', deprecated: true},
     DELETE: {command: 'deleteSession'},
   },
+  '/status': {
+    GET: {command: 'getStatus'},
+  },
   '/session/:sessionId/timeouts': {
     GET: {command: 'getTimeouts'},
     POST: {
@@ -46,9 +43,6 @@ export const METHOD_MAP = /** @type {const} */ ({
       },
     },
   },
-  '/session/:sessionId/window/handles': {
-    GET: {command: 'getWindowHandles'},
-  },
   '/session/:sessionId/url': {
     GET: {command: 'getUrl'},
     POST: {command: 'setUrl', payloadParams: {required: ['url']}},
@@ -62,15 +56,8 @@ export const METHOD_MAP = /** @type {const} */ ({
   '/session/:sessionId/refresh': {
     POST: {command: 'refresh'},
   },
-
-  '/session/:sessionId/screenshot': {
-    GET: {command: 'getScreenshot'},
-  },
-  '/session/:sessionId/frame': {
-    POST: {command: 'setFrame', payloadParams: {required: ['id']}},
-  },
-  '/session/:sessionId/frame/parent': {
-    POST: {command: 'switchToParentFrame'},
+  '/session/:sessionId/title': {
+    GET: {command: 'title'},
   },
   '/session/:sessionId/window': {
     GET: {command: 'getWindowHandle'},
@@ -82,6 +69,25 @@ export const METHOD_MAP = /** @type {const} */ ({
     },
     DELETE: {command: 'closeWindow'},
   },
+  '/session/:sessionId/window/handles': {
+    GET: {command: 'getWindowHandles'},
+  },
+  '/session/:sessionId/window/new': {
+    POST: {command: 'createNewWindow', payloadParams: {optional: ['type']}},
+  },
+  '/session/:sessionId/frame': {
+    POST: {command: 'setFrame', payloadParams: {required: ['id']}},
+  },
+  '/session/:sessionId/frame/parent': {
+    POST: {command: 'switchToParentFrame'},
+  },
+  '/session/:sessionId/window/rect': {
+    GET: {command: 'getWindowRect'},
+    POST: {
+      command: 'setWindowRect',
+      payloadParams: {optional: ['x', 'y', 'width', 'height']},
+    },
+  },
   '/session/:sessionId/window/maximize': {
     POST: {command: 'maximizeWindow'},
   },
@@ -91,23 +97,11 @@ export const METHOD_MAP = /** @type {const} */ ({
   '/session/:sessionId/window/fullscreen': {
     POST: {command: 'fullScreenWindow'},
   },
-  '/session/:sessionId/window/new': {
-    POST: {command: 'createNewWindow', payloadParams: {optional: ['type']}},
-  },
-  '/session/:sessionId/cookie': {
-    GET: {command: 'getCookies'},
-    POST: {command: 'setCookie', payloadParams: {required: ['cookie']}},
-    DELETE: {command: 'deleteCookies'},
-  },
-  '/session/:sessionId/cookie/:name': {
-    GET: {command: 'getCookie'},
-    DELETE: {command: 'deleteCookie'},
-  },
-  '/session/:sessionId/source': {
-    GET: {command: 'getPageSource'},
+  '/session/:sessionId/element/active': {
+    GET: {command: 'active'},
   },
-  '/session/:sessionId/title': {
-    GET: {command: 'title'},
+  '/session/:sessionId/element/:elementId/shadow': {
+    GET: {command: 'elementShadowRoot'},
   },
   '/session/:sessionId/element': {
     POST: {
@@ -121,12 +115,6 @@ export const METHOD_MAP = /** @type {const} */ ({
       payloadParams: {required: ['using', 'value']},
     },
   },
-  '/session/:sessionId/element/active': {
-    GET: {command: 'active'},
-  },
-  '/session/:sessionId/element/:elementId': {
-    GET: {},
-  },
   '/session/:sessionId/element/:elementId/element': {
     POST: {
       command: 'findElementFromElement',
@@ -139,88 +127,67 @@ export const METHOD_MAP = /** @type {const} */ ({
       payloadParams: {required: ['using', 'value']},
     },
   },
-  '/session/:sessionId/element/:elementId/click': {
-    POST: {command: 'click'},
-  },
-  '/session/:sessionId/element/:elementId/text': {
-    GET: {command: 'getText'},
-  },
-  '/session/:sessionId/element/:elementId/value': {
+  '/session/:sessionId/shadow/:shadowId/element': {
     POST: {
-      command: 'setValue',
-      payloadParams: {
-        required: ['text'],
-      },
+      command: 'findElementFromShadowRoot',
+      payloadParams: {required: ['using', 'value']},
     },
   },
-  '/session/:sessionId/element/:elementId/name': {
-    GET: {command: 'getName'},
-  },
-  '/session/:sessionId/element/:elementId/clear': {
-    POST: {command: 'clear'},
+  '/session/:sessionId/shadow/:shadowId/elements': {
+    POST: {
+      command: 'findElementsFromShadowRoot',
+      payloadParams: {required: ['using', 'value']},
+    },
   },
   '/session/:sessionId/element/:elementId/selected': {
     GET: {command: 'elementSelected'},
   },
-  '/session/:sessionId/element/:elementId/enabled': {
-    GET: {command: 'elementEnabled'},
+  '/session/:sessionId/element/:elementId/displayed': {
+    GET: {command: 'elementDisplayed'},
   },
   '/session/:sessionId/element/:elementId/attribute/:name': {
     GET: {command: 'getAttribute'},
   },
-  '/session/:sessionId/element/:elementId/displayed': {
-    GET: {command: 'elementDisplayed'},
+  '/session/:sessionId/element/:elementId/property/:name': {
+    GET: {command: 'getProperty'},
   },
-  '/session/:sessionId/element/:elementId/shadow': {
-    GET: {command: 'elementShadowRoot'},
+  '/session/:sessionId/element/:elementId/css/:propertyName': {
+    GET: {command: 'getCssProperty'},
   },
-  '/session/:sessionId/shadow/:shadowId/element': {
-    POST: {
-      command: 'findElementFromShadowRoot',
-      payloadParams: {required: ['using', 'value']},
-    },
+  '/session/:sessionId/element/:elementId/text': {
+    GET: {command: 'getText'},
   },
-  '/session/:sessionId/shadow/:shadowId/elements': {
-    POST: {
-      command: 'findElementsFromShadowRoot',
-      payloadParams: {required: ['using', 'value']},
-    },
+  '/session/:sessionId/element/:elementId/name': {
+    GET: {command: 'getName'},
   },
-  '/session/:sessionId/element/:elementId/css/:propertyName': {
-    GET: {command: 'getCssProperty'},
+  '/session/:sessionId/element/:elementId/rect': {
+    GET: {command: 'getElementRect'},
   },
-  '/session/:sessionId/element/:elementId/property/:name': {
-    GET: {command: 'getProperty'},
+  '/session/:sessionId/element/:elementId/enabled': {
+    GET: {command: 'elementEnabled'},
   },
-  // w3c v2 https://www.w3.org/TR/webdriver2/#get-computed-role
-  'session/:sessionId/element/:elementId/computedrole': {
+  '/session/:sessionId/element/:elementId/computedrole': {
     GET: {command: 'getComputedRole'},
   },
-  // W3C v2  https://www.w3.org/TR/webdriver2/#get-computed-label
-  'session/:sessionId/element/:elementId/computedlabel': {
+  '/session/:sessionId/element/:elementId/computedlabel': {
     GET: {command: 'getComputedLabel'},
   },
-  '/session/:sessionId/actions': {
-    POST: {command: 'performActions', payloadParams: {required: ['actions']}},
-    DELETE: {command: 'releaseActions'},
+  '/session/:sessionId/element/:elementId/click': {
+    POST: {command: 'click'},
   },
-  '/session/:sessionId/alert/text': {
-    GET: {command: 'getAlertText'},
+  '/session/:sessionId/element/:elementId/clear': {
+    POST: {command: 'clear'},
+  },
+  '/session/:sessionId/element/:elementId/value': {
     POST: {
-      command: 'setAlertText',
+      command: 'setValue',
       payloadParams: {
         required: ['text'],
       },
     },
   },
-  '/session/:sessionId/alert/accept': {
-    POST: {command: 'postAcceptAlert'},
-  },
-  '/session/:sessionId/alert/dismiss': {
-    POST: {command: 'postDismissAlert'},
-  },
-  '/session/:sessionId/element/:elementId/rect': {
-    GET: {command: 'getElementRect'},
+  '/session/:sessionId/source': {
+    GET: {command: 'getPageSource'},
   },
   '/session/:sessionId/execute/sync': {
     POST: {command: 'execute', payloadParams: {required: ['script', 'args']}},
@@ -231,20 +198,60 @@ export const METHOD_MAP = /** @type {const} */ ({
       payloadParams: {required: ['script', 'args']},
     },
   },
+  '/session/:sessionId/cookie': {
+    GET: {command: 'getCookies'},
+    POST: {command: 'setCookie', payloadParams: {required: ['cookie']}},
+    DELETE: {command: 'deleteCookies'},
+  },
+  '/session/:sessionId/cookie/:name': {
+    GET: {command: 'getCookie'},
+    DELETE: {command: 'deleteCookie'},
+  },
+  '/session/:sessionId/actions': {
+    POST: {command: 'performActions', payloadParams: {required: ['actions']}},
+    DELETE: {command: 'releaseActions'},
+  },
+  '/session/:sessionId/alert/dismiss': {
+    POST: {command: 'postDismissAlert'},
+  },
+  '/session/:sessionId/alert/accept': {
+    POST: {command: 'postAcceptAlert'},
+  },
+  '/session/:sessionId/alert/text': {
+    GET: {command: 'getAlertText'},
+    POST: {
+      command: 'setAlertText',
+      payloadParams: {
+        required: ['text'],
+      },
+    },
+  },
+  '/session/:sessionId/screenshot': {
+    GET: {command: 'getScreenshot'},
+  },
   '/session/:sessionId/element/:elementId/screenshot': {
     GET: {command: 'getElementScreenshot'},
   },
-  '/session/:sessionId/window/rect': {
-    GET: {command: 'getWindowRect'},
+  '/session/:sessionId/print': {
     POST: {
-      command: 'setWindowRect',
-      payloadParams: {optional: ['x', 'y', 'width', 'height']},
-    },
+      command: 'printPage',
+      payloadParams: {
+        optional: [
+          'orientation',
+          'scale',
+          'background',
+          'page',
+          'margin',
+          'shrinkToFit',
+          'pageRanges',
+        ],
+      }
+    }
   },
+  // #endregion
 
-  //
-  // Appium specific
-  //
+  // #region JSONWP
+  // https://www.selenium.dev/documentation/legacy/json_wire_protocol/
   '/session/:sessionId/ime/available_engines': {
     GET: {command: 'availableIMEEngines', deprecated: true},
   },
@@ -264,9 +271,12 @@ export const METHOD_MAP = /** @type {const} */ ({
       deprecated: true,
     },
   },
-  '/session/:sessionId/rotation': {
-    GET: {command: 'getRotation'},
-    POST: {command: 'setRotation', payloadParams: {required: ['x', 'y', 'z']}},
+  '/session/:sessionId/orientation': {
+    GET: {command: 'getOrientation'},
+    POST: {
+      command: 'setOrientation',
+      payloadParams: {required: ['orientation']}
+    },
   },
   '/session/:sessionId/location': {
     GET: {
@@ -279,12 +289,13 @@ export const METHOD_MAP = /** @type {const} */ ({
       deprecated: true,
     },
   },
-  '/session/:sessionId/orientation': {
-    GET: {command: 'getOrientation'},
-    POST: {
-      command: 'setOrientation',
-      payloadParams: {required: ['orientation']}
-    },
+  // #endregion
+
+  // #region MJSONWP
+  // https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md
+  '/session/:sessionId/rotation': {
+    GET: {command: 'getRotation'},
+    POST: {command: 'setRotation', payloadParams: {required: ['x', 'y', 'z']}},
   },
   '/session/:sessionId/context': {
     GET: {command: 'getCurrentContext'},
@@ -301,77 +312,90 @@ export const METHOD_MAP = /** @type {const} */ ({
       deprecated: true,
     },
   },
-  '/session/:sessionId/receive_async_response': {
-    POST: {
-      command: 'receiveAsyncResponse',
-      payloadParams: {required: ['status', 'value']},
-      deprecated: true,
-    },
-  },
+  // #endregion
+
+  // #region Appium
   '/appium/sessions': {
     GET: {command: 'getAppiumSessions'},
   },
   '/session/:sessionId/appium/capabilities': {
     GET: {command: 'getAppiumSessionCapabilities'}
   },
+  '/session/:sessionId/appium/settings': {
+    POST: {command: 'updateSettings', payloadParams: {required: ['settings']}},
+    GET: {command: 'getSettings'},
+  },
+  '/session/:sessionId/appium/commands': {
+    GET: {command: 'listCommands'},
+  },
+  '/session/:sessionId/appium/extensions': {
+    GET: {command: 'listExtensions'},
+  },
+  '/session/:sessionId/appium/events': {
+    POST: {command: 'getLogEvents', payloadParams: {optional: ['type']}},
+  },
+  '/session/:sessionId/appium/log_event': {
+    POST: {
+      command: 'logCustomEvent',
+      payloadParams: {required: ['vendor', 'event']},
+    },
+  },
   '/session/:sessionId/appium/device/system_time': {
     GET: {command: 'getDeviceTime'},
     POST: {command: 'getDeviceTime', payloadParams: {optional: ['format']}},
   },
-  // #region Applications Management
-  '/session/:sessionId/appium/device/install_app': {
+  '/session/:sessionId/appium/device/activate_app': {
     POST: {
-      command: 'installApp',
+      command: 'activateApp',
       payloadParams: {
-        required: ['appPath'],
+        required: [['appId'], ['bundleId']],
         optional: ['options'],
       },
     },
   },
-  '/session/:sessionId/appium/device/activate_app': {
+  '/session/:sessionId/appium/device/terminate_app': {
     POST: {
-      command: 'activateApp',
+      command: 'terminateApp',
       payloadParams: {
         required: [['appId'], ['bundleId']],
         optional: ['options'],
       },
     },
   },
-  '/session/:sessionId/appium/device/remove_app': {
+  '/session/:sessionId/appium/device/app_state': {
     POST: {
-      command: 'removeApp',
+      command: 'queryAppState',
       payloadParams: {
         required: [['appId'], ['bundleId']],
-        optional: ['options'],
       },
     },
   },
-  '/session/:sessionId/appium/device/terminate_app': {
+  '/session/:sessionId/appium/device/install_app': {
     POST: {
-      command: 'terminateApp',
+      command: 'installApp',
       payloadParams: {
-        required: [['appId'], ['bundleId']],
+        required: ['appPath'],
         optional: ['options'],
       },
     },
   },
-  '/session/:sessionId/appium/device/app_installed': {
+  '/session/:sessionId/appium/device/remove_app': {
     POST: {
-      command: 'isAppInstalled',
+      command: 'removeApp',
       payloadParams: {
         required: [['appId'], ['bundleId']],
+        optional: ['options'],
       },
     },
   },
-  '/session/:sessionId/appium/device/app_state': {
+  '/session/:sessionId/appium/device/app_installed': {
     POST: {
-      command: 'queryAppState',
+      command: 'isAppInstalled',
       payloadParams: {
         required: [['appId'], ['bundleId']],
       },
     },
   },
-  // #endregion
   '/session/:sessionId/appium/device/hide_keyboard': {
     POST: {
       command: 'hideKeyboard',
@@ -390,48 +414,75 @@ export const METHOD_MAP = /** @type {const} */ ({
   '/session/:sessionId/appium/device/pull_folder': {
     POST: {command: 'pullFolder', payloadParams: {required: ['path']}},
   },
-  '/session/:sessionId/appium/settings': {
-    POST: {command: 'updateSettings', payloadParams: {required: ['settings']}},
-    GET: {command: 'getSettings'},
-  },
-  '/session/:sessionId/appium/events': {
-    POST: {command: 'getLogEvents', payloadParams: {optional: ['type']}},
-  },
-  '/session/:sessionId/appium/log_event': {
+  // #endregion
+
+  // #region Unknown
+  '/session/:sessionId/receive_async_response': {
     POST: {
-      command: 'logCustomEvent',
-      payloadParams: {required: ['vendor', 'event']},
+      command: 'receiveAsyncResponse',
+      payloadParams: {required: ['status', 'value']},
+      deprecated: true,
     },
   },
-  // #region Inspector
-  '/session/:sessionId/appium/commands': {
-    GET: {command: 'listCommands'},
-  },
-  '/session/:sessionId/appium/extensions': {
-    GET: {command: 'listExtensions'},
+  '/session/:sessionId/element/:elementId': {
+    GET: {},
   },
   // #endregion
 
-  //
-  // 3rd party vendor/protocol support
-  //
-  // #region Selenium/Chromium browsers
+  // #region Other Protocols
+  // Selenium/Chromium browsers
   '/session/:sessionId/se/log': {
     POST: {command: 'getLog', payloadParams: {required: ['type']}},
   },
   '/session/:sessionId/se/log/types': {
     GET: {command: 'getLogTypes'},
   },
-  // #endregion
-
-  // #region chromium devtools
+  // Chromium devtools
   // https://chromium.googlesource.com/chromium/src/+/master/chrome/test/chromedriver/server/http_handler.cc
   '/session/:sessionId/:vendor/cdp/execute': {
     POST: {command: 'executeCdp', payloadParams: {required: ['cmd', 'params']}},
   },
-  // #endregion
-
-  // #region Webauthn
+  // Reporting
+  // https://www.w3.org/TR/reporting-1/
+  '/session/:sessionId/reporting/generate_test_report': {
+    POST: {
+      command: 'generateTestReport',
+      payloadParams: {required: ['message'], optional: ['group']},
+    },
+  },
+  // Permissions
+  // https://www.w3.org/TR/permissions/
+  '/session/:sessionId/permissions': {
+    POST: {command: 'setPermissions', payloadParams: {required: ['descriptor', 'state']}},
+  },
+  // Device Posture
+  // https://www.w3.org/TR/device-posture/
+  '/session/:sessionId/deviceposture': {
+    POST: {command: 'setDevicePosture', payloadParams: {required: ['posture']}},
+    DELETE: {command: 'clearDevicePosture'},
+  },
+  // Generic Sensor
+  // https://www.w3.org/TR/generic-sensor/
+  '/session/:sessionId/sensor': {
+    POST: {
+      command: 'createVirtualSensor',
+      payloadParams: {
+        required: ['type'],
+        optional: ['connected', 'maxSamplingFrequency', 'minSamplingFrequency'],
+      },
+    },
+  },
+  '/session/:sessionId/sensors/:sensorType': {
+    GET: {command: 'getVirtualSensorInfo'},
+    POST: {command: 'updateVirtualSensorReading', payloadParams: {required: ['reading']}},
+    DELETE: {command: 'deleteVirtualSensor'},
+  },
+  // Custom Handlers
+  // https://html.spec.whatwg.org/multipage/system-state.html#user-agent-automation
+  '/session/:sessionId/custom-handlers/set-mode': {
+    POST: {command: 'setRPHRegistrationMode', payloadParams: {required: ['mode']}},
+  },
+  // Webauthn
   // https://www.w3.org/TR/webauthn-2/#sctn-automation-add-virtual-authenticator
   '/session/:sessionId/webauthn/authenticator': {
     POST: {
@@ -471,6 +522,49 @@ export const METHOD_MAP = /** @type {const} */ ({
       },
     },
   },
+  // Secure Payment Confirmation
+  // https://www.w3.org/TR/secure-payment-confirmation/
+  '/session/:sessionId/secure-payment-confirmation/set-mode': {
+    POST: {command: 'setSPCTransactionMode', payloadParams: {required: ['mode']}},
+  },
+  // Federated Credential Management
+  // https://www.w3.org/TR/fedcm-1/
+  '/session/:sessionId/fedcm/canceldialog': {
+    POST: {command: 'fedCMCancelDialog'},
+  },
+  '/session/:sessionId/fedcm/selectaccount': {
+    POST: {command: 'fedCMSelectAccount', payloadParams: {required: ['accountIndex']}},
+  },
+  '/session/:sessionId/fedcm/clickdialogbutton': {
+    POST: {command: 'fedCMClickDialogButton', payloadParams: {required: ['dialogButton']}},
+  },
+  '/session/:sessionId/fedcm/accountlist': {
+    GET: {command: 'fedCMGetAccounts'},
+  },
+  '/session/:sessionId/fedcm/gettitle': {
+    GET: {command: 'fedCMGetTitle'},
+  },
+  '/session/:sessionId/fedcm/getdialogtype': {
+    GET: {command: 'fedCMGetDialogType'},
+  },
+  '/session/:sessionId/fedcm/setdelayenabled': {
+    POST: {command: 'fedCMSetDelayEnabled', payloadParams: {required: ['enabled']}},
+  },
+  '/session/:sessionId/fedcm/resetcooldown': {
+    POST: {command: 'fedCMResetCooldown'},
+  },
+  // Compute Pressure
+  // https://www.w3.org/TR/compute-pressure/
+  '/session/:sessionId/pressuresource': {
+    POST: {
+      command: 'createVirtualPressureSource',
+      payloadParams: {required: ['type'], optional: ['supported']},
+    },
+  },
+  '/session/:sessionId/pressuresource/:pressureSourceType': {
+    POST: {command: 'updateVirtualPressureSource', payloadParams: {required: ['sample']}},
+    DELETE: {command: 'deleteVirtualPressureSource'},
+  },
   // #endregion
 });
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/base-driver",
-  "version": "10.0.0",
+  "version": "10.1.0",
   "description": "Base driver class for Appium drivers",
   "keywords": [
     "automation",
@@ -44,25 +44,25 @@
     "test:types": "tsd"
   },
   "dependencies": {
-    "@appium/support": "^7.0.0",
-    "@appium/types": "^1.0.0",
+    "@appium/support": "^7.0.2",
+    "@appium/types": "^1.1.0",
     "@colors/colors": "1.6.0",
     "async-lock": "1.4.1",
     "asyncbox": "3.0.0",
-    "axios": "1.11.0",
+    "axios": "1.12.2",
     "bluebird": "3.7.2",
     "body-parser": "2.2.0",
     "express": "5.1.0",
     "fastest-levenshtein": "1.0.16",
     "http-status-codes": "2.3.0",
     "lodash": "4.17.21",
-    "lru-cache": "11.1.0",
+    "lru-cache": "11.2.2",
     "method-override": "3.0.0",
     "morgan": "1.10.1",
-    "path-to-regexp": "8.2.0",
+    "path-to-regexp": "8.3.0",
     "serve-favicon": "2.5.1",
     "source-map-support": "0.5.21",
-    "type-fest": "4.41.0"
+    "type-fest": "5.0.1"
   },
   "optionalDependencies": {
     "spdy": "4.0.2"
@@ -74,7 +74,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "284da50353921343fa5a7f82574e64ce0c146db7",
+  "gitHead": "c00cbfa1fb6d4bd0d8dac00eed02f87587e0eadf",
   "tsd": {
     "directory": "test/types"
   }