@wdio/protocols - npm Package Compare versions

Comparing version 8.32.0 to 9.0.0-alpha.0

build/commands/appium.d.ts

@@ -564,3 +564,179 @@ import type { Context, StringsReturn, SettingsReturn, ProtocolCommandResponse } from '../types.js';
     compareImages(mode: string, firstImage: string, secondImage: string, options: object): Promise<ProtocolCommandResponse>;
+    /**
+     * Appium Protocol Command
+     *
+     * Set the amount of time the driver should wait when searching for elements. When searching for a single element, the driver should poll the page until an element is found or the timeout expires, whichever occurs first. When searching for multiple elements, the driver should poll the page until at least one element is found or the timeout expires, at which point it should return an empty list. If this command is never sent, the driver should default to an implicit wait of 0ms.
+     * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     *
+     */
+    implicitWait(ms: number): Promise<void>;
+    /**
+     * Appium Protocol Command
+     *
+     * Determine an element's location on the screen once it has been scrolled into view.<br /><br />__Note:__ This is considered an internal command and should only be used to determine an element's location for correctly generating native events.
+     * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     *
+     */
+    getLocationInView(elementId: string): Promise<ProtocolCommandResponse>;
+    /**
+     * Appium Protocol Command
+     *
+     * Send a sequence of key strokes to the active element
+     * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     *
+     */
+    sendKeys(value: string[]): Promise<void>;
+    /**
+     * Appium Protocol Command
+     *
+     * List all available engines on the machine. To use an engine, it has to be present in this list.
+     * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     *
+     */
+    availableIMEEngines(): Promise<string[]>;
+    /**
+     * Appium Protocol Command
+     *
+     * Get the name of the active IME engine. The name string is platform specific.
+     * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     *
+     */
+    getActiveIMEEngine(): Promise<string>;
+    /**
+     * Appium Protocol Command
+     *
+     * Indicates whether IME input is active at the moment
+     * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     *
+     */
+    isIMEActivated(): Promise<boolean>;
+    /**
+     * Appium Protocol Command
+     *
+     * De-activates the currently-active IME engine.
+     * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     *
+     */
+    deactivateIMEEngine(): Promise<void>;
+    /**
+     * Appium Protocol Command
+     *
+     * Make an engines that is available
+     * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     *
+     */
+    activateIMEEngine(engine: string): Promise<void>;
+    /**
+     * Appium Protocol Command
+     *
+     * Set the amount of time, in milliseconds, that asynchronous scripts executed by `/session/:sessionId/execute_async` are permitted to run before they are aborted and a `Timeout` error is returned to the client.
+     * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     *
+     */
+    asyncScriptTimeout(ms: number): Promise<void>;
+    /**
+     * Appium Protocol Command
+     *
+     * Submit a form element.
+     * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     *
+     */
+    submit(elementId: string): Promise<void>;
+    /**
+     * Appium Protocol Command
+     *
+     * Determine an element's size in pixels. The size will be returned as a JSON object with `width` and `height` properties.
+     * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     *
+     */
+    getElementSize(elementId: string): Promise<ProtocolCommandResponse>;
+    /**
+     * Appium Protocol Command
+     *
+     * Determine an element's location on the page. The point `(0, 0)` refers to the upper-left corner of the page. The element's coordinates are returned as a JSON object with `x` and `y` properties.
+     * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     *
+     */
+    getElementLocation(elementId: string): Promise<ProtocolCommandResponse>;
+    /**
+     * Appium Protocol Command
+     *
+     * Single tap on the touch enabled device.
+     * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     *
+     */
+    touchClick(element: string): Promise<void>;
+    /**
+     * Appium Protocol Command
+     *
+     * Finger down on the screen.
+     * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     *
+     */
+    touchDown(x: number, y: number): Promise<void>;
+    /**
+     * Appium Protocol Command
+     *
+     * Finger up on the screen.
+     * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     *
+     */
+    touchUp(x: number, y: number): Promise<void>;
+    /**
+     * Appium Protocol Command
+     *
+     * Finger move on the screen.
+     * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     *
+     */
+    touchMove(x: number, y: number): Promise<void>;
+    /**
+     * Appium Protocol Command
+     *
+     * Long press on the touch screen using finger motion events.
+     * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     *
+     */
+    touchLongClick(element: string): Promise<void>;
+    /**
+     * Appium Protocol Command
+     *
+     * Flick on the touch screen using finger motion events. This flick command starts at a particular screen location.
+     * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     *
+     */
+    touchFlick(xoffset?: number, yoffset?: number, element?: string, speed?: number, xspeed?: number, yspeed?: number): Promise<void>;
+    /**
+     * Appium Protocol Command
+     *
+     * Get the current device orientation.
+     * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     *
+     */
+    getOrientation(): Promise<string>;
+    /**
+     * Appium Protocol Command
+     *
+     * Set the device orientation
+     * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     *
+     */
+    setOrientation(orientation: string): Promise<void>;
+    /**
+     * Appium Protocol Command
+     *
+     * Get the log for a given log type. Log buffer is reset after each request.
+     * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     *
+     */
+    getLogs(type: string): Promise<object[]>;
+    /**
+     * Appium Protocol Command
+     *
+     * Get available log types.
+     * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     *
+     */
+    getLogTypes(): Promise<string[]>;
 }
 //# sourceMappingURL=appium.d.ts.map

build/index.d.ts

 import type AppiumCommands from './commands/appium.js';
 import type ChromiumCommands from './commands/chromium.js';
 import type GeckoCommands from './commands/gecko.js';
-import type JSONWPCommands from './commands/jsonwp.js';
 import type MJSONWPCommands from './commands/mjsonwp.js';
@@ -12,3 +11,2 @@ import type SauceLabsCommands from './commands/saucelabs.js';
 import MJsonWProtocol from './protocols/mjsonwp.js';
-import JsonWProtocol from './protocols/jsonwp.js';
 import AppiumProtocol from './protocols/appium.js';
@@ -19,7 +17,7 @@ import ChromiumProtocol from './protocols/chromium.js';
 import SeleniumProtocol from './protocols/selenium.js';
-export interface ProtocolCommands extends WebDriverCommands, Omit<JSONWPCommands, keyof WebDriverCommands>, AppiumCommands, ChromiumCommands, Omit<MJSONWPCommands, keyof AppiumCommands | keyof ChromiumCommands>, SauceLabsCommands, SeleniumCommands, GeckoCommands {
+export interface ProtocolCommands extends WebDriverCommands, AppiumCommands, ChromiumCommands, Omit<MJSONWPCommands, keyof AppiumCommands | keyof ChromiumCommands>, SauceLabsCommands, SeleniumCommands, GeckoCommands {
 }
 export * from './types.js';
-export { WebDriverProtocol, MJsonWProtocol, JsonWProtocol, AppiumProtocol, ChromiumProtocol, SauceLabsProtocol, SeleniumProtocol, GeckoProtocol, WebDriverBidiProtocol, AppiumCommands, ChromiumCommands, JSONWPCommands, MJSONWPCommands, SauceLabsCommands, SeleniumCommands, WebDriverCommands, GeckoCommands };
+export { WebDriverProtocol, MJsonWProtocol, AppiumProtocol, ChromiumProtocol, SauceLabsProtocol, SeleniumProtocol, GeckoProtocol, WebDriverBidiProtocol, AppiumCommands, ChromiumCommands, MJSONWPCommands, SauceLabsCommands, SeleniumCommands, WebDriverCommands, GeckoCommands };
 export declare const CAPABILITY_KEYS: string[];
 //# sourceMappingURL=index.d.ts.map

build/index.js

 import WebDriverProtocol from './protocols/webdriver.js';
 import WebDriverBidiProtocol from './protocols/webdriverBidi.js';
 import MJsonWProtocol from './protocols/mjsonwp.js';
-import JsonWProtocol from './protocols/jsonwp.js';
 import AppiumProtocol from './protocols/appium.js';
@@ -13,3 +12,3 @@ import ChromiumProtocol from './protocols/chromium.js';
 // protocols
-WebDriverProtocol, MJsonWProtocol, JsonWProtocol, AppiumProtocol, ChromiumProtocol, SauceLabsProtocol, SeleniumProtocol, GeckoProtocol, WebDriverBidiProtocol };
+WebDriverProtocol, MJsonWProtocol, AppiumProtocol, ChromiumProtocol, SauceLabsProtocol, SeleniumProtocol, GeckoProtocol, WebDriverBidiProtocol };
 export const CAPABILITY_KEYS = [
@@ -16,0 +15,0 @@ 'browserName', 'browserVersion', 'platformName', 'acceptInsecureCerts',

build/protocols/appium.d.ts

@@ -1335,4 +1335,439 @@ declare const _default: {
     };
+    '/session/:sessionId/timeouts/implicit_wait': {
+        POST: {
+            command: string;
+            description: string;
+            ref: string;
+            parameters: {
+                name: string;
+                type: string;
+                description: string;
+                required: boolean;
+            }[];
+            support: {
+                android: {
+                    UiAutomator: string;
+                };
+                ios: {
+                    XCUITest: string;
+                };
+            };
+        };
+    };
+    '/session/:sessionId/element/:elementId/location_in_view': {
+        GET: {
+            command: string;
+            description: string;
+            ref: string;
+            variables: {
+                name: string;
+                description: string;
+            }[];
+            parameters: never[];
+            returns: {
+                type: string;
+                name: string;
+                description: string;
+            };
+            support: {
+                android: {
+                    UiAutomator: string;
+                };
+                ios: {
+                    XCUITest: string;
+                };
+            };
+        };
+    };
+    '/session/:sessionId/keys': {
+        POST: {
+            command: string;
+            description: string;
+            ref: string;
+            parameters: {
+                name: string;
+                type: string;
+                description: string;
+                required: boolean;
+            }[];
+            support: {
+                android: {
+                    UiAutomator: string;
+                };
+                ios: {
+                    XCUITest: string;
+                };
+            };
+        };
+    };
+    '/session/:sessionId/ime/available_engines': {
+        GET: {
+            command: string;
+            description: string;
+            ref: string;
+            parameters: never[];
+            returns: {
+                type: string;
+                name: string;
+                description: string;
+            };
+            support: {
+                android: {
+                    UiAutomator: string;
+                };
+            };
+        };
+    };
+    '/session/:sessionId/ime/active_engine': {
+        GET: {
+            command: string;
+            description: string;
+            ref: string;
+            parameters: never[];
+            returns: {
+                type: string;
+                name: string;
+                description: string;
+            };
+            support: {
+                android: {
+                    UiAutomator: string;
+                };
+            };
+        };
+    };
+    '/session/:sessionId/ime/activated': {
+        GET: {
+            command: string;
+            description: string;
+            ref: string;
+            parameters: never[];
+            returns: {
+                type: string;
+                name: string;
+                description: string;
+            };
+            support: {
+                android: {
+                    UiAutomator: string;
+                };
+            };
+        };
+    };
+    '/session/:sessionId/ime/deactivate': {
+        POST: {
+            command: string;
+            description: string;
+            ref: string;
+            parameters: never[];
+            support: {
+                android: {
+                    UiAutomator: string;
+                };
+            };
+        };
+    };
+    '/session/:sessionId/ime/activate': {
+        POST: {
+            command: string;
+            description: string;
+            ref: string;
+            parameters: {
+                name: string;
+                type: string;
+                description: string;
+                required: boolean;
+            }[];
+            support: {
+                android: {
+                    UiAutomator: string;
+                };
+            };
+        };
+    };
+    '/session/:sessionId/timeouts/async_script': {
+        POST: {
+            command: string;
+            description: string;
+            ref: string;
+            parameters: {
+                name: string;
+                type: string;
+                description: string;
+                required: boolean;
+            }[];
+            support: {
+                ios: {
+                    XCUITest: string;
+                };
+            };
+        };
+    };
+    '/session/:sessionId/element/:elementId/submit': {
+        POST: {
+            command: string;
+            description: string;
+            ref: string;
+            variables: {
+                name: string;
+                description: string;
+            }[];
+            parameters: never[];
+            support: {
+                ios: {
+                    XCUITest: string;
+                };
+            };
+        };
+    };
+    '/session/:sessionId/element/:elementId/size': {
+        GET: {
+            command: string;
+            description: string;
+            ref: string;
+            variables: {
+                name: string;
+                description: string;
+            }[];
+            parameters: never[];
+            returns: {
+                type: string;
+                name: string;
+                description: string;
+            };
+            support: {
+                android: {
+                    UiAutomator: string;
+                };
+                ios: {
+                    XCUITest: string;
+                };
+            };
+        };
+    };
+    '/session/:sessionId/element/:elementId/location': {
+        GET: {
+            command: string;
+            description: string;
+            ref: string;
+            variables: {
+                name: string;
+                description: string;
+            }[];
+            parameters: never[];
+            returns: {
+                type: string;
+                name: string;
+                description: string;
+            };
+            support: {
+                android: {
+                    UiAutomator: string;
+                };
+                ios: {
+                    XCUITest: string;
+                };
+            };
+        };
+    };
+    '/session/:sessionId/touch/click': {
+        POST: {
+            command: string;
+            description: string;
+            ref: string;
+            parameters: {
+                name: string;
+                type: string;
+                description: string;
+                required: boolean;
+            }[];
+            support: {
+                android: {
+                    UiAutomator: string;
+                };
+                ios: {
+                    XCUITest: string;
+                };
+            };
+        };
+    };
+    '/session/:sessionId/touch/down': {
+        POST: {
+            command: string;
+            description: string;
+            ref: string;
+            parameters: {
+                name: string;
+                type: string;
+                description: string;
+                required: boolean;
+            }[];
+            support: {
+                android: {
+                    UiAutomator: string;
+                };
+            };
+        };
+    };
+    '/session/:sessionId/touch/up': {
+        POST: {
+            command: string;
+            description: string;
+            ref: string;
+            parameters: {
+                name: string;
+                type: string;
+                description: string;
+                required: boolean;
+            }[];
+            support: {
+                android: {
+                    UiAutomator: string;
+                };
+            };
+        };
+    };
+    '/session/:sessionId/touch/move': {
+        POST: {
+            command: string;
+            description: string;
+            ref: string;
+            parameters: {
+                name: string;
+                type: string;
+                description: string;
+                required: boolean;
+            }[];
+            support: {
+                android: {
+                    UiAutomator: string;
+                };
+            };
+        };
+    };
+    '/session/:sessionId/touch/longclick': {
+        POST: {
+            command: string;
+            description: string;
+            ref: string;
+            parameters: {
+                name: string;
+                type: string;
+                description: string;
+                required: boolean;
+            }[];
+            support: {
+                android: {
+                    UiAutomator: string;
+                };
+            };
+        };
+    };
+    '/session/:sessionId/touch/flick': {
+        POST: {
+            command: string;
+            description: string;
+            ref: string;
+            parameters: {
+                name: string;
+                type: string;
+                description: string;
+                required: boolean;
+            }[];
+            support: {
+                android: {
+                    UiAutomator: string;
+                };
+            };
+        };
+    };
+    '/session/:sessionId/orientation': {
+        GET: {
+            command: string;
+            description: string;
+            ref: string;
+            parameters: never[];
+            returns: {
+                type: string;
+                name: string;
+                description: string;
+            };
+            support: {
+                android: {
+                    UiAutomator: string;
+                };
+                ios: {
+                    XCUITest: string;
+                };
+            };
+        };
+        POST: {
+            command: string;
+            description: string;
+            ref: string;
+            parameters: {
+                name: string;
+                type: string;
+                description: string;
+                required: boolean;
+            }[];
+            support: {
+                android: {
+                    UiAutomator: string;
+                };
+                ios: {
+                    XCUITest: string;
+                };
+            };
+        };
+    };
+    '/session/:sessionId/log': {
+        POST: {
+            command: string;
+            description: string;
+            ref: string;
+            parameters: {
+                name: string;
+                type: string;
+                description: string;
+                required: boolean;
+            }[];
+            returns: {
+                type: string;
+                name: string;
+                description: string;
+            };
+            support: {
+                android: {
+                    UiAutomator: string;
+                };
+                ios: {
+                    XCUITest: string;
+                };
+            };
+        };
+    };
+    '/session/:sessionId/log/types': {
+        GET: {
+            command: string;
+            description: string;
+            ref: string;
+            parameters: never[];
+            returns: {
+                type: string;
+                name: string;
+                description: string;
+            };
+            support: {
+                android: {
+                    UiAutomator: string;
+                };
+                ios: {
+                    XCUITest: string;
+                };
+            };
+        };
+    };
 };
 export default _default;
 //# sourceMappingURL=appium.d.ts.map

package.json

 {
   "name": "@wdio/protocols",
-  "version": "8.32.0",
+  "version": "9.0.0-alpha.0",
   "description": "Utility package providing information about automation protocols",
@@ -30,3 +30,3 @@ "author": "Christian Bromann <[e-mail]>",
   },
-  "gitHead": "912ff55c216bbcd99ab5b376246cdd04e52dc099"
+  "gitHead": "75d45a1efff8705785f0fbcd2379ac624d16e007"
 }

README.md

@@ -27,3 +27,3 @@ WebdriverIO Protocol Helper
 ```js
-import { WebDriverProtocol, MJsonWProtocol, JsonWProtocol, AppiumProtocol, ChromiumProtocol, SauceLabsProtocol, SeleniumProtocol } from '@wdio/protocols'
+import { WebDriverProtocol, MJsonWProtocol, AppiumProtocol, ChromiumProtocol, SauceLabsProtocol, SeleniumProtocol } from '@wdio/protocols'
 
@@ -30,0 +30,0 @@ /**

New alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

499844

decreased by-16.47%

Number of package files

56

decreased by-9.68%

Lines of code

12155

decreased by-16.55%

Number of low quality alerts

2

increased by100%

No dependency changes