@wdio/protocols - npm Package Compare versions

Comparing version 8.16.5 to 8.18.0

build/commands/appium.d.ts

@@ -95,6 +95,6 @@ import type { StringsReturn, SettingsReturn, ProtocolCommandResponse } from '../types.js';
      * Rotate the device in three dimensions.
-     * @ref https://appium.github.io/appium.io/docs/en/commands/device/interactions/rotate/
+     * @ref https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-rotation
      *
      */
-    rotateDevice(x: number, y: number, radius: number, rotation: number, touchCount: number, duration: number, element?: string): Promise<void>;
+    rotateDevice(x: number, y: number, z: number): Promise<void>;
     /**
@@ -303,4 +303,5 @@ * Appium Protocol Command
      *
-     * Launch an app on device. iOS tests with XCUITest can also use the `mobile: launchApp` method. See detailed [documentation](https://appium.github.io/appium.io/docs/en/writing-running-appium/ios/ios-xctest-mobile-apps-management/index.html#mobile-launchapp).
+     * Launch an app on device.
      * @ref https://appium.github.io/appium.io/docs/en/commands/device/app/launch-app/
+     * @deprecated For iOS, utilize `driver.execute('mobile: launchApp', { ... })`, and for Android, make use of `driver.execute('mobile: activateApp', { ... })`.
      *
@@ -314,2 +315,3 @@ */
      * @ref https://appium.github.io/appium.io/docs/en/commands/device/app/close-app/
+     * @deprecated Use `driver.execute('mobile: terminateApp', { ... })` instead
      *
@@ -321,4 +323,5 @@ */
      *
-     * Send the currently running app for this session to the background. iOS tests with XCUITest can also use the `mobile: terminateApp` method to terminate the current app (see detailed [documentation](https://appium.github.io/appium.io/docs/en/writing-running-appium/ios/ios-xctest-mobile-apps-management/index.html#mobile-terminateapp)), and the `mobile: activateApp` to activate an existing application on the device under test and moves it to the foreground (see detailed [documentation](https://appium.github.io/appium.io/docs/en/writing-running-appium/ios/ios-xctest-mobile-apps-management/index.html#mobile-activateapp)).
+     * Send the currently running app for this session to the background.
      * @ref https://appium.github.io/appium.io/docs/en/commands/device/app/background-app/
+     * @deprecated Use `driver.execute('mobile: backgroundApp', { ... })` instead
      *
@@ -350,3 +353,3 @@ */
      */
-    setValueImmediate(elementId: string, value: string): Promise<void>;
+    setValueImmediate(elementId: string, text: string): Promise<void>;
     /**
@@ -513,7 +516,7 @@ * Appium Protocol Command
      *
-     * This command allows you to define a webdriverio script in a string and send it to the Appium server to be executed locally to the server itself, thus reducing latency that might otherwise occur along with each command.
+     * This command enables you to specify a webdriverio script as a string and transmit it to the Appium server for local execution on the server itself. This approach helps minimize potential latency associated with each command. ***To utilize this command with Appium 2.0, you must have the [`execute-driver-plugin`](https://github.com/appium/appium/tree/master/packages/execute-driver-plugin) plugin installed.***
      * @ref https://github.com/appium/appium/blob/master/docs/en/commands/session/execute-driver.md
      *
      */
-    driverScript(script: string, type?: string, timeout?: number): Promise<ProtocolCommandResponse>;
+    executeDriverScript(script: string, type?: string, timeout?: number): Promise<ProtocolCommandResponse>;
     /**
@@ -538,3 +541,3 @@ * Appium Protocol Command
      *
-     * Performs images comparison using OpenCV framework features. It is expected that both OpenCV framework and opencv4nodejs module are installed on the machine where Appium server is running.
+     * This feature conducts image comparisons utilizing the capabilities of the OpenCV framework. Please note that for this functionality to work, both the OpenCV framework and the opencv4nodejs module must be installed on the machine where the Appium server is operational. ***Furthermore, you'll need to have the [`images-plugin`](https://github.com/appium/appium/tree/master/packages/images-plugin) plugin installed to use this feature with Appium 2.0.***
      * @ref https://appium.github.io/appium.io/docs/en/writing-running-appium/image-comparison/
@@ -541,0 +544,0 @@ *

build/commands/mjsonwp.d.ts

@@ -32,2 +32,3 @@ import type { Context } from '../types.js';
      * @ref https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#mobile-json-wire-protocol-endpoints
+     * @deprecated In Appium 2.0, this method is marked as deprecated and currently has no available alternatives.
      *
@@ -34,0 +35,0 @@ */

build/protocols/appium.d.ts

@@ -95,2 +95,5 @@ declare const _default: {
                 };
+                windows: {
+                    Windows: string;
+                };
             };
@@ -122,2 +125,5 @@ };
                 };
+                windows: {
+                    Windows: string;
+                };
             };
@@ -214,6 +220,10 @@ };
             }[];
-            support: {};
+            support: {
+                android: {
+                    UiAutomator: string;
+                };
+            };
         };
     };
-    '/session/:sessionId/appium/device/rotate': {
+    '/session/:sessionId/rotation': {
         POST: {
@@ -223,3 +233,3 @@ command: string;
             ref: string;
-            parameters: ({
+            parameters: {
                 name: string;
@@ -230,9 +240,3 @@ type: string;
                 default: number;
-            } | {
-                name: string;
-                type: string;
-                description: string;
-                required: boolean;
-                default?: undefined;
-            })[];
+            }[];
             support: {
@@ -242,2 +246,5 @@ ios: {
                 };
+                android: {
+                    UiAutomator: string;
+                };
             };
@@ -490,2 +497,5 @@ };
                 };
+                windows: {
+                    Windows: string;
+                };
             };
@@ -513,2 +523,5 @@ };
                 };
+                windows: {
+                    Windows: string;
+                };
             };
@@ -541,2 +554,5 @@ returns: {
                 };
+                windows: {
+                    Windows: string;
+                };
             };
@@ -752,2 +768,3 @@ };
             ref: string;
+            deprecated: string;
             parameters: never[];
@@ -770,2 +787,3 @@ support: {
             ref: string;
+            deprecated: string;
             parameters: never[];
@@ -788,2 +806,3 @@ support: {
             ref: string;
+            deprecated: string;
             parameters: {
@@ -870,2 +889,5 @@ name: string;
                 };
+                android: {
+                    UiAutomator: string;
+                };
             };
@@ -959,3 +981,8 @@ };
             }[];
-            support: {};
+            support: {
+                ios: {
+                    XCUITest: string;
+                    UIAutomation: string;
+                };
+            };
         };
@@ -1105,2 +1132,10 @@ };
             };
+            support: {
+                ios: {
+                    XCUITest: string;
+                };
+                android: {
+                    UiAutomator: string;
+                };
+            };
         };
@@ -1124,2 +1159,10 @@ };
             };
+            support: {
+                ios: {
+                    XCUITest: string;
+                };
+                android: {
+                    UiAutomator: string;
+                };
+            };
         };
@@ -1212,2 +1255,10 @@ };
             };
+            support: {
+                android: {
+                    UiAutomator: string;
+                };
+                ios: {
+                    XCUITest: string;
+                };
+            };
         };
@@ -1226,2 +1277,10 @@ };
             }[];
+            support: {
+                android: {
+                    UiAutomator: string;
+                };
+                ios: {
+                    XCUITest: string;
+                };
+            };
         };
@@ -1228,0 +1287,0 @@ };

build/protocols/appium.js

@@ -99,2 +99,5 @@ export default {
                 },
+                windows: {
+                    Windows: '10+',
+                },
             },
@@ -146,2 +149,5 @@ },
                 },
+                windows: {
+                    Windows: '10+',
+                },
             },
@@ -288,10 +294,14 @@ },
             ],
-            support: {},
+            support: {
+                android: {
+                    UiAutomator: '4.2+',
+                },
+            },
         },
     },
-    '/session/:sessionId/appium/device/rotate': {
+    '/session/:sessionId/rotation': {
         POST: {
             command: 'rotateDevice',
             description: 'Rotate the device in three dimensions.',
-            ref: 'https://appium.github.io/appium.io/docs/en/commands/device/interactions/rotate/',
+            ref: 'https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-rotation',
             parameters: [
@@ -313,35 +323,8 @@ {
                 {
-                    name: 'radius',
+                    name: 'z',
                     type: 'number',
-                    description: 'the distance in points from the center to the edge of the circular path',
+                    description: 'z offset to use for the center of the rotate gesture',
                     required: true,
                     default: 0,
                 },
-                {
-                    name: 'rotation',
-                    type: 'number',
-                    description: 'the length of rotation in radians',
-                    required: true,
-                    default: 3.14159265359,
-                },
-                {
-                    name: 'touchCount',
-                    type: 'number',
-                    description: 'the number of touches to use in the specified gesture',
-                    required: true,
-                    default: 2,
-                },
-                {
-                    name: 'duration',
-                    type: 'number',
-                    description: 'the length of hold time for the specified gesture, in seconds',
-                    required: true,
-                    default: 1,
-                },
-                {
-                    name: 'element',
-                    type: 'string',
-                    description: 'the id of an element returned in a previous call to execute the rotation on',
-                    required: false,
-                },
             ],
@@ -352,2 +335,5 @@ support: {
                 },
+                android: {
+                    UiAutomator: '4.2+',
+                },
             },
@@ -640,2 +626,5 @@ },
                 },
+                windows: {
+                    Windows: '10+',
+                },
             },
@@ -665,2 +654,5 @@ },
                 },
+                windows: {
+                    Windows: '10+',
+                },
             },
@@ -695,2 +687,5 @@ returns: {
                 },
+                windows: {
+                    Windows: '10+',
+                },
             },
@@ -956,4 +951,5 @@ },
             command: 'launchApp',
-            description: 'Launch an app on device. iOS tests with XCUITest can also use the `mobile: launchApp` method. See detailed [documentation](https://appium.github.io/appium.io/docs/en/writing-running-appium/ios/ios-xctest-mobile-apps-management/index.html#mobile-launchapp).',
+            description: 'Launch an app on device.',
             ref: 'https://appium.github.io/appium.io/docs/en/commands/device/app/launch-app/',
+            deprecated: 'For iOS, utilize `driver.execute(\'mobile: launchApp\', { ... })`, and for Android, make use of `driver.execute(\'mobile: activateApp\', { ... })`.',
             parameters: [],
@@ -976,2 +972,3 @@ support: {
             ref: 'https://appium.github.io/appium.io/docs/en/commands/device/app/close-app/',
+            deprecated: 'Use `driver.execute(\'mobile: terminateApp\', { ... })` instead',
             parameters: [],
@@ -992,4 +989,5 @@ support: {
             command: 'background',
-            description: 'Send the currently running app for this session to the background. iOS tests with XCUITest can also use the `mobile: terminateApp` method to terminate the current app (see detailed [documentation](https://appium.github.io/appium.io/docs/en/writing-running-appium/ios/ios-xctest-mobile-apps-management/index.html#mobile-terminateapp)), and the `mobile: activateApp` to activate an existing application on the device under test and moves it to the foreground (see detailed [documentation](https://appium.github.io/appium.io/docs/en/writing-running-appium/ios/ios-xctest-mobile-apps-management/index.html#mobile-activateapp)).',
+            description: 'Send the currently running app for this session to the background.',
             ref: 'https://appium.github.io/appium.io/docs/en/commands/device/app/background-app/',
+            deprecated: 'Use `driver.execute(\'mobile: backgroundApp\', { ... })` instead',
             parameters: [
@@ -1088,5 +1086,5 @@ {
                 {
-                    name: 'value',
+                    name: 'text',
                     type: 'string',
-                    description: 'value to set on element',
+                    description: 'text to set to an element',
                     required: true,
@@ -1099,2 +1097,5 @@ },
                 },
+                android: {
+                    UiAutomator: '4.2+',
+                },
             },
@@ -1196,3 +1197,8 @@ },
             ],
-            support: {},
+            support: {
+                ios: {
+                    XCUITest: '9.3+',
+                    UIAutomation: '8.0 to 9.3',
+                }
+            },
         },
@@ -1388,2 +1394,10 @@ },
             },
+            support: {
+                ios: {
+                    XCUITest: '9.3+',
+                },
+                android: {
+                    UiAutomator: '4.2+',
+                },
+            },
         },
@@ -1409,2 +1423,10 @@ },
             },
+            support: {
+                ios: {
+                    XCUITest: '9.3+',
+                },
+                android: {
+                    UiAutomator: '4.2+',
+                },
+            },
         },
@@ -1507,4 +1529,4 @@ },
         POST: {
-            command: 'driverScript',
-            description: 'This command allows you to define a webdriverio script in a string and send it to the Appium server to be executed locally to the server itself, thus reducing latency that might otherwise occur along with each command.',
+            command: 'executeDriverScript',
+            description: 'This command enables you to specify a webdriverio script as a string and transmit it to the Appium server for local execution on the server itself. This approach helps minimize potential latency associated with each command. ***To utilize this command with Appium 2.0, you must have the [`execute-driver-plugin`](https://github.com/appium/appium/tree/master/packages/execute-driver-plugin) plugin installed.***',
             ref: 'https://github.com/appium/appium/blob/master/docs/en/commands/session/execute-driver.md',
@@ -1556,2 +1578,10 @@ parameters: [
             },
+            support: {
+                android: {
+                    UiAutomator: '4.2+',
+                },
+                ios: {
+                    XCUITest: '9.3+',
+                },
+            },
         },
@@ -1578,2 +1608,10 @@ },
             ],
+            support: {
+                android: {
+                    UiAutomator: '4.2+',
+                },
+                ios: {
+                    XCUITest: '9.3+',
+                },
+            },
         },
@@ -1584,3 +1622,3 @@ },
             command: 'compareImages',
-            description: 'Performs images comparison using OpenCV framework features. It is expected that both OpenCV framework and opencv4nodejs module are installed on the machine where Appium server is running.',
+            description: 'This feature conducts image comparisons utilizing the capabilities of the OpenCV framework. Please note that for this functionality to work, both the OpenCV framework and the opencv4nodejs module must be installed on the machine where the Appium server is operational. ***Furthermore, you\'ll need to have the [`images-plugin`](https://github.com/appium/appium/tree/master/packages/images-plugin) plugin installed to use this feature with Appium 2.0.***',
             ref: 'https://appium.github.io/appium.io/docs/en/writing-running-appium/image-comparison/',
@@ -1587,0 +1625,0 @@ parameters: [

build/protocols/mjsonwp.d.ts

@@ -40,2 +40,3 @@ declare const _default: {
             ref: string;
+            deprecated: string;
             parameters: never[];
@@ -42,0 +43,0 @@ returns: {

build/protocols/mjsonwp.js

@@ -42,2 +42,3 @@ export default {
             ref: 'https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#mobile-json-wire-protocol-endpoints',
+            deprecated: 'In Appium 2.0, this method is marked as deprecated and currently has no available alternatives.',
             parameters: [],
@@ -44,0 +45,0 @@ returns: {

build/types.d.ts

@@ -117,2 +117,6 @@ export interface ProtocolCommandResponse {
     /**
+     * description for the deprecated command
+     */
+    deprecated?: string;
+    /**
      * supported command parameters
@@ -119,0 +123,0 @@ */

package.json

 {
   "name": "@wdio/protocols",
-  "version": "8.16.5",
+  "version": "8.18.0",
   "description": "Utility package providing information about automation protocols",
@@ -30,3 +30,3 @@ "author": "Christian Bromann <[e-mail]>",
   },
-  "gitHead": "ca2069d80b7804bd4680850b92a6cd7b4fa4499f"
+  "gitHead": "66cd3ccfe1c8a94f89afa11fb51f58742ae379c5"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

561462

increased by0.43%

Lines of code

14223

increased by0.76%

No dependency changes