@appium/base-driver 9.17.0 → 10.0.0-beta.1

package/build/lib/protocol/routes.d.ts

@@ -22,8 +22,7 @@ export const METHOD_MAP: {
         readonly POST: {
             readonly command: "createSession";
             readonly payloadParams: {
-                readonly validate: (jsonObj: any) => false | "we require one of \"desiredCapabilities\" or \"capabilities\" object";
-                readonly optional: readonly ["desiredCapabilities", "requiredCapabilities", "capabilities"];
+                readonly optional: readonly ["capabilities", "capabilities", "capabilities"];
             };
         };
     };
@@ -43,8 +42,8 @@ export const METHOD_MAP: {
         readonly POST: {
             readonly command: "timeouts";
             readonly payloadParams: {
-                readonly validate: (jsonObj: any, protocolName: string) => "W3C protocol expects any of script, pageLoad or implicit to be set" | "MJSONWP protocol requires type and ms" | undefined;
-                readonly optional: readonly ["type", "ms", "script", "pageLoad", "implicit"];
+                readonly validate: ({ script, pageLoad, implicit }: any) => "W3C protocol expects any of script, pageLoad or implicit to be set" | undefined;
+                readonly optional: readonly ["script", "pageLoad", "implicit"];
             };
         };
     };
@@ -104,9 +103,7 @@ export const METHOD_MAP: {
         readonly POST: {
             readonly command: "setWindow";
             readonly payloadParams: {
-                readonly optional: readonly ["name", "handle"];
-                readonly makeArgs: (jsonObj: any) => any[];
-                readonly validate: (jsonObj: any) => false | "we require one of \"name\" or \"handle\" to be set";
+                readonly required: readonly ["handle"];
             };
         };
         readonly DELETE: {
@@ -188,10 +185,6 @@ export const METHOD_MAP: {
         readonly GET: {
             readonly command: "active";
         };
-        readonly POST: {
-            readonly command: "active";
-            readonly deprecated: true;
-        };
     };
     readonly '/session/:sessionId/element/:elementId': {
         readonly GET: {};
@@ -226,9 +219,7 @@ export const METHOD_MAP: {
         readonly POST: {
             readonly command: "setValue";
             readonly payloadParams: {
-                readonly validate: (jsonObj: any) => false | "we require one of \"text\" or \"value\" params";
-                readonly optional: readonly ["value", "text"];
-                readonly makeArgs: (jsonObj: any) => any[];
+                readonly required: readonly ["text"];
             };
         };
     };
@@ -321,9 +312,7 @@ export const METHOD_MAP: {
         readonly POST: {
             readonly command: "setAlertText";
             readonly payloadParams: {
-                validate: (jsonObj: any) => false | "either \"text\" or \"value\" must be set";
-                optional: string[];
-                makeArgs: (jsonObj: any) => any[];
+                readonly required: readonly ["text"];
             };
         };
     };
@@ -492,9 +481,6 @@ export const METHOD_MAP: {
     readonly '/session/:sessionId/appium/device/system_time': {
         readonly GET: {
             readonly command: "getDeviceTime";
-            readonly payloadParams: {
-                readonly optional: readonly ["format"];
-            };
         };
         readonly POST: {
             readonly command: "getDeviceTime";
@@ -548,18 +534,11 @@ export const METHOD_MAP: {
         };
     };
     readonly '/session/:sessionId/appium/device/app_state': {
-        readonly GET: {
-            readonly command: "queryAppState";
-            readonly payloadParams: {
-                readonly required: readonly [readonly ["appId"], readonly ["bundleId"]];
-            };
-        };
         readonly POST: {
             readonly command: "queryAppState";
             readonly payloadParams: {
                 readonly required: readonly [readonly ["appId"], readonly ["bundleId"]];
             };
-            readonly deprecated: true;
         };
     };
     readonly '/session/:sessionId/appium/device/hide_keyboard': {
@@ -701,694 +680,6 @@ export const METHOD_MAP: {
             };
         };
     };
-    readonly '/sessions': {
-        readonly GET: {
-            readonly command: "getSessions";
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/timeouts/async_script': {
-        readonly POST: {
-            readonly command: "asyncScriptTimeout";
-            readonly payloadParams: {
-                readonly required: readonly ["ms"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/timeouts/implicit_wait': {
-        readonly POST: {
-            readonly command: "implicitWait";
-            readonly payloadParams: {
-                readonly required: readonly ["ms"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/window_handle': {
-        readonly GET: {
-            readonly command: "getWindowHandle";
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/window/handle': {
-        readonly GET: {
-            readonly command: "getWindowHandle";
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/window_handles': {
-        readonly GET: {
-            readonly command: "getWindowHandles";
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/execute': {
-        readonly POST: {
-            readonly command: "execute";
-            readonly payloadParams: {
-                readonly required: readonly ["script", "args"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/execute_async': {
-        readonly POST: {
-            readonly command: "executeAsync";
-            readonly payloadParams: {
-                readonly required: readonly ["script", "args"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/window/:windowhandle/size': {
-        readonly GET: {
-            readonly command: "getWindowSize";
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/window/:windowhandle/position': {
-        readonly POST: {
-            readonly deprecated: true;
-        };
-        readonly GET: {
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/window/:windowhandle/maximize': {
-        readonly POST: {
-            readonly command: "maximizeWindow";
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/element/:elementId/submit': {
-        readonly POST: {
-            readonly command: "submit";
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/keys': {
-        readonly POST: {
-            readonly command: "keys";
-            readonly payloadParams: {
-                readonly required: readonly ["value"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/element/:elementId/equals/:otherId': {
-        readonly GET: {
-            readonly command: "equalsElement";
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/element/:elementId/location': {
-        readonly GET: {
-            readonly command: "getLocation";
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/element/:elementId/location_in_view': {
-        readonly GET: {
-            readonly command: "getLocationInView";
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/element/:elementId/size': {
-        readonly GET: {
-            readonly command: "getSize";
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/moveto': {
-        readonly POST: {
-            readonly command: "moveTo";
-            readonly payloadParams: {
-                readonly optional: readonly ["element", "xoffset", "yoffset"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/click': {
-        readonly POST: {
-            readonly command: "clickCurrent";
-            readonly payloadParams: {
-                readonly optional: readonly ["button"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/buttondown': {
-        readonly POST: {
-            readonly command: "buttonDown";
-            readonly payloadParams: {
-                readonly optional: readonly ["button"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/buttonup': {
-        readonly POST: {
-            readonly command: "buttonUp";
-            readonly payloadParams: {
-                readonly optional: readonly ["button"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/doubleclick': {
-        readonly POST: {
-            readonly command: "doubleClick";
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/touch/click': {
-        readonly POST: {
-            readonly command: "click";
-            readonly payloadParams: {
-                readonly required: readonly ["element"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/touch/down': {
-        readonly POST: {
-            readonly command: "touchDown";
-            readonly payloadParams: {
-                readonly required: readonly ["x", "y"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/touch/up': {
-        readonly POST: {
-            readonly command: "touchUp";
-            readonly payloadParams: {
-                readonly required: readonly ["x", "y"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/touch/move': {
-        readonly POST: {
-            readonly command: "touchMove";
-            readonly payloadParams: {
-                readonly required: readonly ["x", "y"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/touch/scroll': {
-        readonly POST: {
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/touch/doubleclick': {
-        readonly POST: {
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/touch/longclick': {
-        readonly POST: {
-            readonly command: "touchLongClick";
-            readonly payloadParams: {
-                readonly required: readonly ["elements"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/touch/flick': {
-        readonly POST: {
-            readonly command: "flick";
-            readonly payloadParams: {
-                readonly optional: readonly ["element", "xspeed", "yspeed", "xoffset", "yoffset", "speed"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/local_storage': {
-        readonly GET: {
-            readonly deprecated: true;
-        };
-        readonly POST: {
-            readonly deprecated: true;
-        };
-        readonly DELETE: {
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/local_storage/key/:key': {
-        readonly GET: {
-            readonly deprecated: true;
-        };
-        readonly DELETE: {
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/local_storage/size': {
-        readonly GET: {
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/session_storage': {
-        readonly GET: {
-            readonly deprecated: true;
-        };
-        readonly POST: {
-            readonly deprecated: true;
-        };
-        readonly DELETE: {
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/session_storage/key/:key': {
-        readonly GET: {
-            readonly deprecated: true;
-        };
-        readonly DELETE: {
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/session_storage/size': {
-        readonly GET: {
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/application_cache/status': {
-        readonly GET: {
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/alert_text': {
-        readonly GET: {
-            readonly command: "getAlertText";
-            readonly deprecated: true;
-        };
-        readonly POST: {
-            readonly command: "setAlertText";
-            readonly payloadParams: {
-                validate: (jsonObj: any) => false | "either \"text\" or \"value\" must be set";
-                optional: string[];
-                makeArgs: (jsonObj: any) => any[];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/accept_alert': {
-        readonly POST: {
-            readonly command: "postAcceptAlert";
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/dismiss_alert': {
-        readonly POST: {
-            readonly command: "postDismissAlert";
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/screenshot/:elementId': {
-        readonly GET: {
-            readonly command: "getElementScreenshot";
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/element/:elementId/pageIndex': {
-        readonly GET: {
-            readonly command: "getPageIndex";
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/touch/perform': {
-        readonly POST: {
-            readonly command: "performTouch";
-            readonly payloadParams: {
-                readonly wrap: "actions";
-                readonly required: readonly ["actions"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/touch/multi/perform': {
-        readonly POST: {
-            readonly command: "performMultiAction";
-            readonly payloadParams: {
-                readonly required: readonly ["actions"];
-                readonly optional: readonly ["elementId"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/device/shake': {
-        readonly POST: {
-            readonly command: "mobileShake";
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/device/lock': {
-        readonly POST: {
-            readonly command: "lock";
-            readonly payloadParams: {
-                readonly optional: readonly ["seconds"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/device/unlock': {
-        readonly POST: {
-            readonly command: "unlock";
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/device/is_locked': {
-        readonly POST: {
-            readonly command: "isLocked";
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/start_recording_screen': {
-        readonly POST: {
-            readonly command: "startRecordingScreen";
-            readonly payloadParams: {
-                readonly optional: readonly ["options"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/stop_recording_screen': {
-        readonly POST: {
-            readonly command: "stopRecordingScreen";
-            readonly payloadParams: {
-                readonly optional: readonly ["options"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/performanceData/types': {
-        readonly POST: {
-            readonly command: "getPerformanceDataTypes";
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/getPerformanceData': {
-        readonly POST: {
-            readonly command: "getPerformanceData";
-            readonly payloadParams: {
-                readonly required: readonly ["packageName", "dataType"];
-                readonly optional: readonly ["dataReadTimeout"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/device/press_keycode': {
-        readonly POST: {
-            readonly command: "pressKeyCode";
-            readonly payloadParams: {
-                readonly required: readonly ["keycode"];
-                readonly optional: readonly ["metastate", "flags"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/device/long_press_keycode': {
-        readonly POST: {
-            readonly command: "longPressKeyCode";
-            readonly payloadParams: {
-                readonly required: readonly ["keycode"];
-                readonly optional: readonly ["metastate", "flags"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/device/finger_print': {
-        readonly POST: {
-            readonly command: "fingerprint";
-            readonly payloadParams: {
-                readonly required: readonly ["fingerprintId"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/device/send_sms': {
-        readonly POST: {
-            readonly command: "sendSMS";
-            readonly payloadParams: {
-                readonly required: readonly ["phoneNumber", "message"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/device/gsm_call': {
-        readonly POST: {
-            readonly command: "gsmCall";
-            readonly payloadParams: {
-                readonly required: readonly ["phoneNumber", "action"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/device/gsm_signal': {
-        readonly POST: {
-            readonly command: "gsmSignal";
-            readonly payloadParams: {
-                readonly required: readonly ["signalStrength"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/device/gsm_voice': {
-        readonly POST: {
-            readonly command: "gsmVoice";
-            readonly payloadParams: {
-                readonly required: readonly ["state"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/device/power_capacity': {
-        readonly POST: {
-            readonly command: "powerCapacity";
-            readonly payloadParams: {
-                readonly required: readonly ["percent"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/device/power_ac': {
-        readonly POST: {
-            readonly command: "powerAC";
-            readonly payloadParams: {
-                readonly required: readonly ["state"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/device/network_speed': {
-        readonly POST: {
-            readonly command: "networkSpeed";
-            readonly payloadParams: {
-                readonly required: readonly ["netspeed"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/device/keyevent': {
-        readonly POST: {
-            readonly command: "keyevent";
-            readonly payloadParams: {
-                readonly required: readonly ["keycode"];
-                readonly optional: readonly ["metastate"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/device/current_activity': {
-        readonly GET: {
-            readonly command: "getCurrentActivity";
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/device/current_package': {
-        readonly GET: {
-            readonly command: "getCurrentPackage";
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/device/toggle_airplane_mode': {
-        readonly POST: {
-            readonly command: "toggleFlightMode";
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/device/toggle_data': {
-        readonly POST: {
-            readonly command: "toggleData";
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/device/toggle_wifi': {
-        readonly POST: {
-            readonly command: "toggleWiFi";
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/device/toggle_location_services': {
-        readonly POST: {
-            readonly command: "toggleLocationServices";
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/device/open_notifications': {
-        readonly POST: {
-            readonly command: "openNotifications";
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/device/start_activity': {
-        readonly POST: {
-            readonly command: "startActivity";
-            readonly payloadParams: {
-                readonly required: readonly ["appPackage", "appActivity"];
-                readonly optional: readonly ["appWaitPackage", "appWaitActivity", "intentAction", "intentCategory", "intentFlags", "optionalIntentArguments", "dontStopAppOnReset"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/device/system_bars': {
-        readonly GET: {
-            readonly command: "getSystemBars";
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/device/display_density': {
-        readonly GET: {
-            readonly command: "getDisplayDensity";
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/simulator/touch_id': {
-        readonly POST: {
-            readonly command: "touchId";
-            readonly payloadParams: {
-                readonly required: readonly ["match"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/simulator/toggle_touch_id_enrollment': {
-        readonly POST: {
-            readonly command: "toggleEnrollTouchId";
-            readonly payloadParams: {
-                readonly optional: readonly ["enabled"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/app/launch': {
-        readonly POST: {
-            readonly command: "launchApp";
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/app/close': {
-        readonly POST: {
-            readonly command: "closeApp";
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/app/reset': {
-        readonly POST: {
-            readonly command: "reset";
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/app/background': {
-        readonly POST: {
-            readonly command: "background";
-            readonly payloadParams: {
-                readonly required: readonly ["seconds"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/app/end_test_coverage': {
-        readonly POST: {
-            readonly command: "endCoverage";
-            readonly payloadParams: {
-                readonly required: readonly ["intent", "path"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/app/strings': {
-        readonly POST: {
-            readonly command: "getStrings";
-            readonly payloadParams: {
-                readonly optional: readonly ["language", "stringFile"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/element/:elementId/value': {
-        readonly POST: {
-            readonly command: "setValueImmediate";
-            readonly payloadParams: {
-                readonly required: readonly ["text"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/element/:elementId/replace_value': {
-        readonly POST: {
-            readonly command: "replaceValue";
-            readonly payloadParams: {
-                readonly required: readonly ["text"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/receive_async_response': {
-        readonly POST: {
-            readonly command: "receiveAsyncResponse";
-            readonly payloadParams: {
-                readonly required: readonly ["response"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/device/set_clipboard': {
-        readonly POST: {
-            readonly command: "setClipboard";
-            readonly payloadParams: {
-                readonly required: readonly ["content"];
-                readonly optional: readonly ["contentType", "label"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/appium/device/get_clipboard': {
-        readonly POST: {
-            readonly command: "getClipboard";
-            readonly payloadParams: {
-                readonly optional: readonly ["contentType"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/log': {
-        readonly POST: {
-            readonly command: "getLog";
-            readonly payloadParams: {
-                readonly required: readonly ["type"];
-            };
-            readonly deprecated: true;
-        };
-    };
-    readonly '/session/:sessionId/log/types': {
-        readonly GET: {
-            readonly command: "getLogTypes";
-            readonly deprecated: true;
-        };
-    };
 };
 export const ALL_COMMANDS: any[];
 export const NO_SESSION_ID_COMMANDS: string[];