feat(ts): Add better tests for typescript (#2445)

* feat(ts): Add better tests for typescript

* fix

* fix

* f

* add more tests

* add tests for helper

* f

* add tests

* added methods

* improve ts

* improve typings

* improve typings

* remove appium jobs from PR

* draft

* fix

* fix tests

* add tests for all wdio methods

* fix

* fix tests

* fix

Author: Vorobeyko

.github/workflows/appium.yml

@@ -4,9 +4,6 @@ on:
   push:
     branches:
       - master
-  pull_request:
-    branches:
-      - '**'
 
 env:
   CI: true

.github/workflows/dtslint.yml

@@ -0,0 +1,25 @@
+name: Typings tests
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - '**'
+
+jobs:
+  test:
+    runs-on: ubuntu-18.04
+    strategy:
+      matrix:
+        node-version: [12.x]
+    steps:
+    - uses: actions/checkout@v1
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: npm install
+    - run: npm run def
+    - run: npm run dtslint

docs/webapi/clearField.mustache

@@ -5,4 +5,4 @@ I.clearField('Email');
 I.clearField('user[email]');
 I.clearField('#email');
 ```
-@param {string|object} editable field located by label|name|CSS|XPath|strict locator.
+@param {LocatorOrString} editable field located by label|name|CSS|XPath|strict locator.

docs/webapi/closeCurrentTab.mustache

@@ -0,0 +1,5 @@
+ Close current tab.
+
+ ```js
+ I.closeCurrentTab();
+ ```

docs/webapi/closeOtherTabs.mustache

@@ -0,0 +1,6 @@
+ Close all tabs except for the current one.
+
+
+ ```js
+ I.closeOtherTabs();
+ ```

docs/webapi/dragAndDrop.mustache

@@ -4,5 +4,5 @@ Drag an item to a destination element.
 I.dragAndDrop('#dragHandle', '#container');
 ```
 
-@param {string|object} srcElement located by CSS|XPath|strict locator.
-@param {string|object} destElement located by CSS|XPath|strict locator.
+@param {LocatorOrString} srcElement located by CSS|XPath|strict locator.
+@param {LocatorOrString} destElement located by CSS|XPath|strict locator.

docs/webapi/grabAllWindowHandles.mustache

@@ -0,0 +1,7 @@
+Get all Window Handles.
+Useful for referencing a specific handle when calling `I.switchToWindow(handle)`
+
+```js
+const windows = await I.grabAllWindowHandles();
+```
+@returns {Promise<string[]>}

docs/webapi/grabBrowserLogs.mustache

@@ -6,4 +6,4 @@ let logs = await I.grabBrowserLogs();
 console.log(JSON.stringify(logs))
 ```
 
-@returns {Promise<Array<*>>} all browser logs
+@returns {Promise<object[]>|undefined} all browser logs

docs/webapi/grabCookie.mustache

@@ -8,4 +8,4 @@ assert(cookie.value, '123456');
 ```
 
 @param {?string} [name=null] cookie name.
-@returns {Promise<string>} attribute value
+@returns {Promise<string>|Promise<string[]>} attribute value

docs/webapi/grabCurrentWindowHandle.mustache

@@ -0,0 +1,6 @@
+Get the current Window Handle.
+Useful for referencing it when calling `I.switchToWindow(handle)`
+```js
+const window = await I.grabCurrentWindowHandle();
+```
+@returns {Promise<string>}

docs/webapi/grabElementBoundingRect.mustache

@@ -15,6 +15,6 @@ To get only one metric use second parameter:
 const width = await I.grabElementBoundingRect('h3', 'width');
 // width == 527
 ```
-@param {string|object} locator element located by CSS|XPath|strict locator.
-@param {string} elementSize x, y, width or height of the given element.
-@returns {object} Element bounding rectangle
+@param {LocatorOrString} locator element located by CSS|XPath|strict locator.
+@param {string=} elementSize x, y, width or height of the given element.
+@returns {Promise<DOMRect>|Promise<number>} Element bounding rectangle

docs/webapi/grabNumberOfOpenTabs.mustache

@@ -5,4 +5,4 @@ Resumes test execution, so **should be used inside async function with `await`**
 let tabs = await I.grabNumberOfOpenTabs();
 ```
 
-@returns {Promise<number>} number of open tabs
+@returns {Promise<number>} number of open tabs

docs/webapi/grabPageScrollPosition.mustache

@@ -5,4 +5,4 @@ Resumes test execution, so **should be used inside an async function with `await
 let { x, y } = await I.grabPageScrollPosition();
 ```
 
-@returns {Promise<Object<string, *>>} scroll position
+@returns {Promise<PageScrollPosition>} scroll position

docs/webapi/grabPopupText.mustache

@@ -0,0 +1,5 @@
+Grab the text within the popup. If no popup is visible then it will return null.
+```js
+await I.grabPopupText();
+```
+@returns {Promise<string>}

docs/webapi/openNewTab.mustache

@@ -0,0 +1,5 @@
+ Open new tab and switch to it.
+
+ ```js
+ I.openNewTab();
+ ```

docs/webapi/scrollIntoView.mustache

@@ -6,5 +6,5 @@ I.scrollIntoView('#submit', true);
 I.scrollIntoView('#submit', { behavior: "smooth", block: "center", inline: "center" });
 ```
 
-@param {string|object} locator located by CSS|XPath|strict locator.
-@param {boolean|object} alignToTop (optional) or scrollIntoViewOptions (optional), see https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView.
+@param {LocatorOrString} locator located by CSS|XPath|strict locator.
+@param {ScrollIntoViewOptions} scrollIntoViewOptions see https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView.

docs/webapi/seeTitleEquals.mustache

@@ -0,0 +1,7 @@
+ Checks that title is equal to provided one.
+
+ ```js
+ I.seeTitleEquals('Test title.');
+ ```
+
+ @param {string} text value to check.

docs/webapi/selectOption.mustache

@@ -16,5 +16,5 @@ Provide an array for the second argument to select multiple options.
 ```js
 I.selectOption('Which OS do you use?', ['Android', 'iOS']);
 ```
-@param {CodeceptJS.LocatorOrString} select field located by label|name|CSS|XPath|strict locator.
-@param {string|Array<*>} option visible text or value of option.
+@param {LocatorOrString} select field located by label|name|CSS|XPath|strict locator.
+@param {string|Array<*>} option visible text or value of option.

docs/webapi/setCookie.mustache

@@ -12,4 +12,4 @@ I.setCookie([
 ]);
 ```
 
-@param {object|array} cookie a cookie object or array of cookie objects.
+@param {Cookie|Array<Cookie>} cookie a cookie object or array of cookie objects.

docs/webapi/setGeoLocation.mustache

@@ -8,4 +8,4 @@ I.setGeoLocation(121.21, 11.56, 10);
 
 @param {number} latitude to set.
 @param {number} longitude to set
-@param {number} altitude (optional, null by default) to set
+@param {number=} altitude (optional, null by default) to set

docs/webapi/switchToNextTab.mustache

@@ -0,0 +1,9 @@
+ Switch focus to a particular tab by its number. It waits tabs loading and then switch tab.
+
+ ```js
+ I.switchToNextTab();
+ I.switchToNextTab(2);
+ ```
+
+ @param {number} [num] (optional) number of tabs to switch forward, default: 1.
+ @param {number | null} [sec] (optional) time in seconds to wait.

docs/webapi/switchToPreviousTab.mustache

@@ -0,0 +1,9 @@
+ Switch focus to a particular tab by its number. It waits tabs loading and then switch tab.
+
+ ```js
+ I.switchToPreviousTab();
+ I.switchToPreviousTab(2);
+ ```
+
+ @param {number} [num] (optional) number of tabs to switch backward, default: 1.
+ @param {number?} [sec] (optional) time in seconds to wait.

docs/webapi/waitForValue.mustache

@@ -4,6 +4,6 @@ Waits for the specified value to be in value attribute.
 I.waitForValue('//input', "GoodValue");
 ```
 
-@param {string|object} field input field.
+@param {LocatorOrString} field input field.
 @param {string }value expected value.
-@param {number} [sec=1] (optional, `1` by default) time in seconds to wait
+@param {number} [sec=1] (optional, `1` by default) time in seconds to wait

lib/command/definitions.js

@@ -48,12 +48,12 @@ module.exports = function (genPath, options) {
       helperPaths[name] = require;
       helperNames.push(name);
     } else {
-      helperNames.push(`CodeceptJS.${name}`);
+      helperNames.push(name);
     }
   }
 
   const supportObject = new Map();
-  supportObject.set('I', 'CodeceptJS.I');
+  supportObject.set('I', 'I');
   for (const name in codecept.config.include) {
     const includePath = codecept.config.include[name];
     if (name === 'I' || name === translations.I) {