@wdio/sync - npm Package Compare versions

Comparing version 6.0.0-alpha.1 to 6.0.0-beta.0

package.json

 {
   "name": "@wdio/sync",
-  "version": "6.0.0-alpha.1",
+  "version": "6.0.0-beta.0",
   "description": "A WebdriverIO plugin. Helper module to run WebdriverIO commands synchronously",
@@ -37,3 +37,3 @@ "author": "Christian Bromann <[e-mail]>",
   "dependencies": {
-    "@wdio/logger": "6.0.0-alpha.0",
+    "@wdio/logger": "6.0.0-beta.0",
     "fibers": "^4.0.1"
@@ -44,3 +44,3 @@ },
   },
-  "gitHead": "1b11d192fa30cd92724a21e3febbf40b9e5b3ba2"
+  "gitHead": "478c5546246ce47c8344d29a4d36d067ab3a6983"
 }

webdriverio-core.d.ts

@@ -31,2 +31,3 @@ // -------------------- ATTENTION --------------------
         expiry?: number,
+        sameSite?: boolean,
         isSecure?: boolean,
@@ -106,2 +107,10 @@ isHttpOnly?: boolean
 
+        onWorkerStart?(
+            cid: string,
+            caps: WebDriver.DesiredCapabilities,
+            specs: string[],
+            args: Config,
+            execArgv: string[]
+        ): void;
+
         onComplete?(exitCode: number, config: Config, capabilities: WebDriver.DesiredCapabilities, results: Results): void;
@@ -168,5 +177,5 @@
     type _HooksArray = {
-        [K in keyof Pick<HookFunctions, "onPrepare" | "onComplete" | "before" | "after" | "beforeSession" | "afterSession">]: HookFunctions[K] | Array<HookFunctions[K]>;
+        [K in keyof Pick<HookFunctions, "onPrepare" | "onWorkerStart" | "onComplete" | "before" | "after" | "beforeSession" | "afterSession">]: HookFunctions[K] | Array<HookFunctions[K]>;
     };
-    type _Hooks = Omit<HookFunctions, "onPrepare" | "onComplete" | "before" | "after" | "beforeSession" | "afterSession">;
+    type _Hooks = Omit<HookFunctions, "onPrepare" | "onWorkerStart" | "onComplete" | "before" | "after" | "beforeSession" | "afterSession">;
     interface Hooks extends _HooksArray, _Hooks { }
@@ -191,2 +200,33 @@
 
+    type ReactSelectorOptions = {
+        props?: object,
+        state?: any[] | number | string | object | boolean
+    }
+
+    type MoveToOptions = {
+        xOffset?: number,
+        yOffset?: number
+    }
+
+    type DragAndDropOptions = {
+        duration?: number
+    }
+
+    type NewWindowOptions = {
+        windowName?: string,
+        windowFeatures?: string
+    }
+
+    type ClickOptions = {
+        button?: number | string,
+        x?: number,
+        y?: number
+    }
+
+    type WaitUntilOptions = {
+        timeout?: number,
+        timeoutMsg?: string,
+        interval?: number
+    }
+
     interface Element {
@@ -267,3 +307,3 @@ selector: string;
         click(
-            options?: object
+            options?: ClickOptions
         ): void;
@@ -297,3 +337,3 @@
             target: Element,
-            duration?: number
+            options?: DragAndDropOptions
         ): void;
@@ -309,3 +349,5 @@
         /**
-         * Get a css property from a DOM-element selected by given selector.
+         * Get a css property from a DOM-element selected by given selector. The return value
+         * is formatted to be testable. Colors gets parsed via [rgb2hex](https://www.npmjs.org/package/rgb2hex)
+         * and all other properties get parsed via [css-value](https://www.npmjs.org/package/css-value).
          */
@@ -431,4 +473,3 @@ getCSSProperty(
         moveTo(
-            xoffset?: number,
-            yoffset?: number
+            options?: MoveToOptions
         ): void;
@@ -442,4 +483,3 @@
             selector: string,
-            props?: object,
-            state?: any[] | number | string | object | boolean
+            options?: ReactSelectorOptions
         ): ElementArray;
@@ -453,4 +493,3 @@
             selector: string,
-            props?: object,
-            state?: any[] | number | string | object | boolean
+            options?: ReactSelectorOptions
         ): Element;
@@ -466,4 +505,3 @@
         /**
-         * Scroll element into viewport.
-         * https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView
+         * Scroll element into viewport ([MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView)).
          */
@@ -523,3 +561,6 @@ scrollIntoView(
         /**
-         * [appium] The Touch Action API provides the basis of all gestures that can be automated in Appium.
+         * The Touch Action API provides the basis of all gestures that can be automated in Appium.
+         * It is currently only available to native apps and can not be used to interact with webapps.
+         * At its core is the ability to chain together _ad hoc_ individual actions, which will then be
+         * applied to an element in the application on the device. The basic actions that can be used are:
          */
@@ -543,5 +584,3 @@ touchAction(
         waitForDisplayed(
-            ms?: number,
-            reverse?: boolean,
-            error?: string
+            options?: WaitForOptions
         ): boolean;
@@ -555,5 +594,3 @@
         waitForEnabled(
-            ms?: number,
-            reverse?: boolean,
-            error?: string
+            options?: WaitForOptions
         ): boolean;
@@ -569,6 +606,14 @@
         waitForExist(
-            ms?: number,
-            reverse?: boolean,
-            error?: string
+            options?: WaitForOptions
         ): boolean;
+
+        /**
+         * This wait command is your universal weapon if you want to wait on something. It expects a condition
+         * and waits until that condition is fulfilled with a truthy value. If you use the WDIO testrunner the
+         * commands within the condition are getting executed synchronously like in your test.
+         */
+        waitUntil(
+            condition: () => Boolean,
+            options?: WaitUntilOptions
+        ): boolean;
     }
@@ -670,3 +715,3 @@
         deleteCookies(
-            names?: string[]
+            names?: string | string[]
         ): void;
@@ -676,5 +721,7 @@
          * Retrieve a [cookie](https://w3c.github.io/webdriver/webdriver-spec.html#cookies)
+         * visible to the current page. You can query a specific cookie by providing the cookie name or
+         * retrieve all.
          */
         getCookies(
-            names?: string[]
+            names?: string[] | string
         ): Cookie[];
@@ -703,4 +750,3 @@
             url: string,
-            windowName?: string,
-            windowFeatures?: string
+            options?: NewWindowOptions
         ): string;
@@ -723,4 +769,3 @@
             selector: string,
-            props?: object,
-            state?: any[] | number | string | object | boolean
+            options?: ReactSelectorOptions
         ): ElementArray;
@@ -734,4 +779,3 @@
             selector: string,
-            props?: object,
-            state?: any[] | number | string | object | boolean
+            options?: ReactSelectorOptions
         ): Element;
@@ -766,10 +810,14 @@
         /**
-         * Sets one or more [cookies](https://w3c.github.io/webdriver/#cookies) for the current page.
+         * Sets one or more [cookies](https://w3c.github.io/webdriver/#cookies) for the current page. Make sure you are
+         * on the page that should receive the cookie. You can't set a cookie for an arbitrary page without
+         * being on that page.
          */
         setCookies(
-            cookie: Cookie
+            cookie: Cookie[] | Cookie
         ): void;
 
         /**
-         * Sets the timeouts (implicit, pageLoad, script) associated with the current session.
+         * Sets the timeouts associated with the current session, timeout durations control such
+         * behaviour as timeouts on script injection, document navigation, and element retrieval.
+         * For more information and examples, see [timeouts guide](https://webdriver.io/docs/timeouts.html#selenium-timeouts).
          */
@@ -796,3 +844,6 @@ setTimeout(
         /**
-         * [appium] The Touch Action API provides the basis of all gestures that can be automated in Appium.
+         * The Touch Action API provides the basis of all gestures that can be automated in Appium.
+         * It is currently only available to native apps and can not be used to interact with webapps.
+         * At its core is the ability to chain together _ad hoc_ individual actions, which will then be
+         * applied to an element in the application on the device. The basic actions that can be used are:
          */
@@ -821,2 +872,12 @@ touchAction(
         ): void;
+
+        /**
+         * This wait command is your universal weapon if you want to wait on something. It expects a condition
+         * and waits until that condition is fulfilled with a truthy value. If you use the WDIO testrunner the
+         * commands within the condition are getting executed synchronously like in your test.
+         */
+        waitUntil(
+            condition: () => Boolean,
+            options?: WaitUntilOptions
+        ): boolean;
     }
@@ -823,0 +884,0 @@

webdriverio.d.ts

@@ -6,12 +6,2 @@ /// <reference types="@wdio/sync/webdriverio-core"/>
         /**
-         * waits until the condition is fulfilled with a truthy value
-         */
-        waitUntil(
-            condition: () => boolean,
-            timeout?: number,
-            timeoutMsg?: string,
-            interval?: number
-        ): boolean
-
-        /**
          * execute any async action within your test spec
@@ -18,0 +8,0 @@ */

No alert changes

Improved metrics

Total package byte prevSize

42252

increased by6.4%

Lines of code

1090

increased by4.11%

Dependency changes

• + Added@wdio/logger@6.0.0-beta.0(transitive)

• - Removed@wdio/logger@6.0.0-alpha.0(transitive)

• Updated@wdio/logger@6.0.0-beta.0