Rewrite webdriverio element commands (#6139)

Co-authored-by: Mykola Grybyk <[email protected]>

Author: christian-bromann

packages/webdriverio/src/commands/browser.js renamed to packages/webdriverio/src/commands/browser.ts

@@ -43,8 +43,11 @@
 import { findElements, enhanceElementsArray } from '../../utils'
 import { getElements } from '../../utils/getElementObject'
 
-export default async function $$ (this: WebdriverIO.BrowserObject, selector: string) {
+export default async function $$ (
+    this: WebdriverIO.BrowserObject,
+    selector: string
+) {
     const res = await findElements.call(this, selector)
     const elements = await getElements.call(this, selector, res)
-    return enhanceElementsArray(elements, this, selector)
+    return enhanceElementsArray(elements, this, selector) as WebdriverIO.Element[]
 }

packages/webdriverio/src/commands/browser/$$.ts

@@ -52,13 +52,18 @@ import { getElement } from '../../utils/getElementObject'
 import { ELEMENT_KEY } from '../../constants'
 import type { ElementReference } from '../../types'
 
-export default async function $ (this: WebdriverIO.BrowserObject, selector: string | ElementReference) {
+export default async function $ (
+    this: WebdriverIO.BrowserObject,
+    selector: string | ElementReference
+) {
+    const elemReference = selector as ElementReference
+
     /**
      * convert protocol result into WebdriverIO element
      * e.g. when element was fetched with `getActiveElement`
      */
-    if (typeof selector !== 'string' && typeof (selector as ElementReference)[ELEMENT_KEY] === 'string') {
-        return getElement.call(this, undefined, selector as ElementReference)
+    if (typeof selector !== 'string' && typeof elemReference[ELEMENT_KEY] === 'string') {
+        return getElement.call(this, undefined, elemReference)
     }
 
     const res = await findElement.call(this, selector)

packages/webdriverio/src/commands/browser/$.ts

@@ -26,14 +26,21 @@ import { getElements } from '../../utils/getElementObject'
 import { ELEMENT_KEY } from '../../constants'
 import type { ElementReference } from '../../types'
 
-async function custom$$ (this: WebdriverIO.BrowserObject, strategyName: string, ...strategyArguments: any[]) {
+export default async function custom$$ (
+    this: WebdriverIO.BrowserObject,
+    strategyName: string,
+    ...strategyArguments: any[]
+) {
     const strategy = this.strategies.get(strategyName)
 
     if (!strategy) {
         throw Error('No strategy found for ' + strategyName)
     }
 
-    let res: ElementReference | ElementReference[] = await this.execute(strategy, ...strategyArguments)
+    let res: ElementReference | ElementReference[] = await this.execute(
+        strategy,
+        ...strategyArguments
+    )
 
     /**
      * if the user's script return just one element
@@ -49,5 +56,3 @@ async function custom$$ (this: WebdriverIO.BrowserObject, strategyName: string,
     const elements = res.length ? await getElements.call(this, strategy.toString(), res) : []
     return enhanceElementsArray(elements, this, strategyName, 'custom$$', [strategyArguments])
 }
-
-export default custom$$

packages/webdriverio/src/commands/browser/custom$$.ts

@@ -25,14 +25,21 @@ import { getElement } from '../../utils/getElementObject'
 import { ELEMENT_KEY } from '../../constants'
 import type { ElementReference } from '../../types'
 
-async function custom$ (this: WebdriverIO.BrowserObject, strategyName: string, ...strategyArguments: any[]) {
+export default async function custom$ (
+    this: WebdriverIO.BrowserObject,
+    strategyName: string,
+    ...strategyArguments: any[]
+) {
     const strategy = this.strategies.get(strategyName)
 
     if (!strategy) {
         throw Error('No strategy found for ' + strategyName)
     }
 
-    let res: ElementReference | ElementReference[] = await this.execute(strategy, ...strategyArguments)
+    let res: ElementReference | ElementReference[] = await this.execute(
+        strategy,
+        ...strategyArguments
+    )
 
     /**
      * if the user's script returns multiple elements
@@ -49,5 +56,3 @@ async function custom$ (this: WebdriverIO.BrowserObject, strategyName: string, .
 
     throw Error('Your locator strategy script must return an element')
 }
-
-export default custom$

packages/webdriverio/src/commands/browser/custom$.ts

@@ -32,7 +32,10 @@
 import { serializeError } from 'serialize-error'
 import WDIORepl from '@wdio/repl'
 
-export default function debug(this: WebdriverIO.BrowserObject, commandTimeout = 5000) {
+export default function debug(
+    this: WebdriverIO.BrowserObject,
+    commandTimeout = 5000
+) {
     const repl = new WDIORepl()
     const { introMessage } = WDIORepl
 

packages/webdriverio/src/commands/browser/debug.ts

@@ -42,7 +42,10 @@
  *
  */
 
-export default function deleteCookies(this: WebdriverIO.BrowserObject, names?: string | string[]) {
+export default function deleteCookies(
+    this: WebdriverIO.BrowserObject,
+    names?: string | string[]
+) {
     if (names === undefined) {
         return this.deleteAllCookies()
     }

packages/webdriverio/src/commands/browser/deleteCookies.ts

@@ -35,15 +35,19 @@ import { verifyArgsAndStripIfElement } from '../../utils'
  *
  */
 
-export default function execute (this: WebdriverIO.BrowserObject, script: string | Function, ...args: any[]) {
-    /*!
+export default function execute (
+    this: WebdriverIO.BrowserObject,
+    script: string | Function,
+    ...args: any[]
+) {
+    /**
      * parameter check
      */
     if ((typeof script !== 'string' && typeof script !== 'function')) {
         throw new Error('number or type of arguments don\'t agree with execute protocol command')
     }
 
-    /*!
+    /**
      * instances started as multibrowserinstance can't getting called with
      * a function parameter, therefor we need to check if it starts with "function () {"
      */

packages/webdriverio/src/commands/browser/execute.ts

@@ -43,15 +43,19 @@ import { verifyArgsAndStripIfElement } from '../../utils'
  *
  */
 
-export default function executeAsync (this: WebdriverIO.BrowserObject, script: string | Function, ...args: any[]) {
-    /*!
+export default function executeAsync (
+    this: WebdriverIO.BrowserObject,
+    script: string | Function,
+    ...args: any[]
+) {
+    /**
      * parameter check
      */
     if ((typeof script !== 'string' && typeof script !== 'function')) {
         throw new Error('number or type of arguments don\'t agree with execute protocol command')
     }
 
-    /*!
+    /**
      * instances started as multibrowserinstance can't getting called with
      * a function parameter, therefor we need to check if it starts with "function () {"
      */

packages/webdriverio/src/commands/browser/executeAsync.ts

@@ -30,9 +30,12 @@
  * @uses webdriver/getAllCookies
  *
  */
-export default async function getCookies(this: WebdriverIO.BrowserObject, names?: string | string[]) {
+export default async function getCookies(
+    this: WebdriverIO.BrowserObject,
+    names?: string | string[]
+) {
     if (names === undefined) {
-        return this.getAllCookies()
+        return this.getAllCookies() as Promise<WebDriver.Cookie[]>
     }
 
     const namesList = Array.isArray(names) ? names : [names]