Remove WebdriverIOAsync namespace (webdriverio#4720)

* get rid of WebdriverIOAsync interface * remove comment

Author: christian-bromann

packages/wdio-applitools-service/applitools-service.d.ts

@@ -1,10 +1,5 @@
 /// <reference types="@applitools/visual-grid-client"/>
 
-declare module WebdriverIOAsync {
- interface Config extends ApplitoolsConfig {}
- interface Browser extends ApplitoolsBrowserAsync {}
-}
-
 declare module WebdriverIO {
  interface Config extends ApplitoolsConfig {}
  interface Browser extends ApplitoolsBrowser {}

packages/webdriverio/webdriverio-v6.d.ts

@@ -1,64 +1,8 @@
-/// <reference types="webdriverio/webdriverio-core-v5"/>
+/// <reference types="webdriverio/webdriverio-core"/>
 
-type $ = (selector: string | Function) => Promise<WebdriverIOAsync.Element>;
-type $$ = (selector: string | Function) => Promise<WebdriverIOAsync.ElementArray>;
-
-// Element commands that should be wrapper with Promise
-type ElementPromise = Omit<WebdriverIO.Element,
- 'addCommand'
- | '$'
- | '$$'
- | 'selector'
- | 'elementId'
- | 'element-6066-11e4-a52e-4f735466cecf'
- | 'ELEMENT'
- | 'index'
- | 'parent'
- | 'dragAndDrop'
- | 'touchAction'
->;
-
-// Methods which return async element(s) so non-async equivalents cannot just be promise-wrapped
-interface AsyncSelectors {
- $: $;
- $$: $$;
-}
-
-// Element commands wrapper with Promise
-type ElementAsync = {
- [K in keyof ElementPromise]:
- (...args: Parameters<ElementPromise[K]>) => Promise<ReturnType<ElementPromise[K]>>;
-} & AsyncSelectors;
-
-// Element commands that should not be wrapper with promise
-type ElementStatic = Pick<WebdriverIO.Element,
- 'addCommand'
- | 'selector'
- | 'elementId'
- | 'element-6066-11e4-a52e-4f735466cecf'
- | 'ELEMENT'
- | 'index'
- | 'parent'
->;
-
-// Browser commands that should be wrapper with Promise
-type BrowserPromise = Omit<WebdriverIO.Browser, 'addCommand' | 'overwriteCommand' | 'options' | 'config' | '$' | '$$' | 'touchAction'>;
-
-// Browser commands wrapper with Promise
-type BrowserAsync = {
- [K in keyof BrowserPromise]:
- (...args: Parameters<BrowserPromise[K]>) => Promise<ReturnType<BrowserPromise[K]>>;
-} & AsyncSelectors;
-
-// Browser commands that should not be wrapper with promise
-type BrowserStatic = Pick<WebdriverIO.Browser, 'addCommand' | 'overwriteCommand' | 'options' | 'config'>;
-
-// Properties of TouchAction which are similar in sync and async mode
-type TouchActionSync = Omit<WebdriverIO.TouchAction, 'element'>
-
-declare namespace WebdriverIOAsync {
+declare namespace WebdriverIO {
  function remote(
- options?: WebdriverIO.RemoteOptions,
+ options?: RemoteOptions,
  modifier?: (...args: any[]) => any
  ): BrowserObject;
 
@@ -67,57 +11,59 @@ declare namespace WebdriverIOAsync {
  ): BrowserObject;
 
  function multiremote(
- options: WebdriverIO.MultiRemoteOptions
+ options: MultiRemoteOptions
  ): BrowserObject;
- interface TouchAction extends TouchActionSync {
-  element?: Element
- }
- type TouchActions = string | TouchAction | TouchAction[];
- interface Browser extends BrowserAsync, BrowserStatic {
+
+ interface Browser {
+  /**
+  * waits until the condition is fulfilled with a truthy value
+  */
  waitUntil(
  condition: () => Promise<boolean>,
  timeout?: number,
  timeoutMsg?: string,
  interval?: number
  ): Promise<boolean>;
 
- // there is no way to wrap generic functions, like `<T>(arg: T) => T`
- // have to declare explicitly for sync and async typings.
- // https://github.com/microsoft/TypeScript/issues/5453
+ /**
+  * execute any async action within your test spec
+  */
  call: <T>(callback: (...args: any[]) => Promise<T>) => Promise<T>;
+
+ /**
+ * Inject a snippet of JavaScript into the page for execution in the context of the currently selected frame.
+ * The executed script is assumed to be synchronous and the result of evaluating the script is returned to
+ * the client.
+ */
  execute: <T>(script: string | ((...arguments: any[]) => T), ...arguments: any[]) => Promise<T>;
 
- // also there is no way to add callback as last parameter after `...args`.
+ // there is no way to add callback as last parameter after `...args`.
  // https://github.com/Microsoft/TypeScript/issues/1360
  // executeAsync: <T>(script: string | ((...arguments: any[], callback: (result: T) => void) => void), ...arguments: any[]) => Promise<T>;
+ /**
+ * Inject a snippet of JavaScript into the page for execution in the context of the currently selected frame.
+ * The executed script is assumed to be asynchronous and must signal that is done by invoking
+ * the provided callback, which is always provided as the final argument to the function. The value
+ * to this callback will be returned to the client.
+ */
  executeAsync: (script: string | ((...arguments: any[]) => void), ...arguments: any[]) => Promise<any>;
- touchAction(action: TouchActions): Promise<void>;
- }
-
- interface Element extends ElementAsync, ElementStatic {
- dragAndDrop(target: Element, duration?: number): Promise<void>;
- touchAction(action: TouchActions): Promise<void>;
  }
- interface ElementArray extends Array<Element> {
- selector: string | Function;
- parent: Element | BrowserObject;
- foundWith: string;
- props: any[];
- }
-
- interface Config { }
 
- interface BrowserObject extends WebDriver.ClientOptions, WebDriver.ClientAsync, WebdriverIOAsync.Browser { }
+ interface BrowserObject extends WebDriver.ClientOptions, WebDriver.ClientAsync, Browser { }
 }
 
-declare namespace WebdriverIO {
- interface BrowserObject extends WebdriverIOAsync.BrowserObject {}
-}
+declare var browser: WebdriverIO.BrowserObject;
+
+/**
+ * find a single element on the page.
+ */
+declare var $: (selector: string | Function) => Promise<WebdriverIO.Element>;
 
-declare var browser: WebdriverIOAsync.BrowserObject;
-declare var $: $;
-declare var $$: $$;
+/**
+ * find multiple elements on the page.
+ */
+declare var $$: (selector: string | Function) => Promise<WebdriverIO.ElementArray>;
 
 declare module "webdriverio" {
- export = WebdriverIOAsync
+ export = WebdriverIO
 }

packages/webdriverio/webdriverio.d.ts

@@ -91,7 +91,7 @@ async function bar() {
  await el5.scrollIntoView(false)
 
  const selector$$: string | Function = elems.selector
- const parent$$: WebdriverIOAsync.Element | WebdriverIOAsync.BrowserObject = elems.parent
+ const parent$$: WebdriverIO.Element | WebdriverIO.BrowserObject = elems.parent
 
  // shadow$ shadow$$
  const el6 = await $('')
@@ -109,7 +109,7 @@ async function bar() {
 
  // touchAction
  const ele = await $('')
- const touchAction: WebdriverIOAsync.TouchAction = {
+ const touchAction: WebdriverIO.TouchAction = {
  action: "longPress",
  element: await $(''),
  ms: 0,
@@ -124,7 +124,7 @@ async function bar() {
 }
 
 // selenium-standalone-service
-const config: WebdriverIOAsync.Config = {
+const config: WebdriverIO.Config = {
  skipSeleniumInstall: true,
  seleniumLogs: ''
 }

tests/typings/webdriverio/async.ts

@@ -3,7 +3,7 @@
  */
 
 // module should be "webdriverio" if used within `ts` file instead of `d.ts`
-declare module WebdriverIOAsync {
+declare module WebdriverIO {
  interface BrowserObject {
  // multiremote
  instances: ['myBrowserInstance']