add type support for browser properties

webdriverio · May 4, 2020 · ef05501 · ef05501
1 parent add1948
commit ef05501
Show file tree

Hide file tree

Showing 8 changed files with 67 additions and 11 deletions.
diff --git a/packages/wdio-sync/webdriverio-core.d.ts b/packages/wdio-sync/webdriverio-core.d.ts
@@ -827,7 +827,7 @@ declare namespace WebdriverIO {
         script?: number
     }
 
-    interface Browser {
+    interface Browser extends WebDriver.BaseClient {
         config: Config;
         options: RemoteOptions;
 

diff --git a/packages/webdriver/webdriver.d.ts b/packages/webdriver/webdriver.d.ts
@@ -495,6 +495,7 @@ declare namespace WebDriver {
          * Defines the [capabilities](https://w3c.github.io/webdriver/webdriver-spec.html#capabilities) you want to run in your Selenium session.
          */
         capabilities?: DesiredCapabilities;
+        requestedCapabilities?: DesiredCapabilities;
         /**
          * Level of logging verbosity.
          */
@@ -610,9 +611,28 @@ declare namespace WebDriver {
         mjpegScalingFactor?: number,
     }
 
+    interface BaseClient {
+        // id of WebDriver session
+        sessionId: string;
+        // assigned capabilities by the browser driver / WebDriver server
+        capabilities: DesiredCapabilities;
+        // original requested capabilities
+        requestedCapabilities: DesiredCapabilities;
+
+        /**
+         * browser flags
+         */
+        // true if session runs on a mobile device
+        isMobile: boolean;
+        // true if mobile session runs on iOS
+        isIOS: boolean;
+        // true if mobile session runs on Android
+        isAndroid: boolean;
+    }
+
     // generated typings
         // webdriver types
-    interface Client {
+    interface Client extends BaseClient {
 
         /**
          * [webdriver]
@@ -1008,7 +1028,7 @@ declare namespace WebDriver {
     }
 
     // appium types
-    interface Client {
+    interface Client extends BaseClient {
 
         /**
          * [appium]
@@ -1446,7 +1466,7 @@ declare namespace WebDriver {
     }
 
     // jsonwp types
-    interface Client {
+    interface Client extends BaseClient {
 
         /**
          * [jsonwp]
@@ -2115,7 +2135,7 @@ declare namespace WebDriver {
     }
 
     // mjsonwp types
-    interface Client {
+    interface Client extends BaseClient {
 
         /**
          * [mjsonwp]
@@ -2182,7 +2202,7 @@ declare namespace WebDriver {
     }
 
     // chromium types
-    interface Client {
+    interface Client extends BaseClient {
 
         /**
          * [chromium]
@@ -2354,7 +2374,7 @@ declare namespace WebDriver {
     }
 
     // saucelabs types
-    interface Client {
+    interface Client extends BaseClient {
 
         /**
          * [saucelabs]
@@ -2400,7 +2420,7 @@ declare namespace WebDriver {
     }
 
     // selenium types
-    interface Client {
+    interface Client extends BaseClient {
 
         /**
          * [selenium]

diff --git a/packages/webdriverio/webdriverio-core.d.ts b/packages/webdriverio/webdriverio-core.d.ts
@@ -827,7 +827,7 @@ declare namespace WebdriverIO {
         script?: number
     }
 
-    interface Browser {
+    interface Browser extends WebDriver.BaseClient {
         config: Config;
         options: RemoteOptions;
 

diff --git a/scripts/templates/webdriver.tpl.d.ts b/scripts/templates/webdriver.tpl.d.ts
@@ -489,6 +489,7 @@ declare namespace WebDriver {
          * Defines the [capabilities](https://w3c.github.io/webdriver/webdriver-spec.html#capabilities) you want to run in your Selenium session.
          */
         capabilities?: DesiredCapabilities;
+        requestedCapabilities?: DesiredCapabilities;
         /**
          * Level of logging verbosity.
          */
@@ -604,6 +605,25 @@ declare namespace WebDriver {
         mjpegScalingFactor?: number,
     }
 
+    interface BaseClient {
+        // id of WebDriver session
+        sessionId: string;
+        // assigned capabilities by the browser driver / WebDriver server
+        capabilities: DesiredCapabilities;
+        // original requested capabilities
+        requestedCapabilities: DesiredCapabilities;
+
+        /**
+         * browser flags
+         */
+        // true if session runs on a mobile device
+        isMobile: boolean;
+        // true if mobile session runs on iOS
+        isIOS: boolean;
+        // true if mobile session runs on Android
+        isAndroid: boolean;
+    }
+
     // generated typings
     // ... insert here ...
 

diff --git a/scripts/templates/webdriverio.tpl.d.ts b/scripts/templates/webdriverio.tpl.d.ts
@@ -478,7 +478,7 @@ declare namespace WebdriverIO {
         script?: number
     }
 
-    interface Browser {
+    interface Browser extends WebDriver.BaseClient {
         config: Config;
         options: RemoteOptions;
 

diff --git a/scripts/type-generation/webdriver-generate-typings.js b/scripts/type-generation/webdriver-generate-typings.js
@@ -18,7 +18,7 @@ ${INDENTATION} */`
 const lines = []
 for (const [protocolName, definition] of Object.entries(PROTOCOLS)) {
     lines.push(`    // ${protocolName} types`)
-    lines.push('    interface Client {')
+    lines.push('    interface Client extends BaseClient {')
 
     for (const [, methods] of Object.entries(definition)) {
         for (const [, description] of Object.entries(methods)) {

diff --git a/tests/typings/sync/sync.ts b/tests/typings/sync/sync.ts
@@ -166,6 +166,14 @@ browser.addLocatorStrategy('myStrat', () => {})
 browser.sharedStore.get('foo')
 browser.sharedStore.set('foo', ['q', 1, true, null, {'w' : {}, 'e': [] }, [{}]])
 
+// test access to base client properties
+browser.sessionId
+browser.capabilities.browserName
+browser.requestedCapabilities.browserName
+browser.isMobile
+browser.isAndroid
+browser.isIOS
+
 // allure-reporter
 allure.addFeature('')
 

diff --git a/tests/typings/webdriverio/async.ts b/tests/typings/webdriverio/async.ts
@@ -191,6 +191,14 @@ async function bar() {
 
     // addLocatorStrategy
     browser.addLocatorStrategy('myStrat', () => {})
+
+    // test access to base client properties
+    browser.sessionId
+    browser.capabilities.browserName
+    browser.requestedCapabilities.browserName
+    browser.isMobile
+    browser.isAndroid
+    browser.isIOS
 }
 
 // allure-reporter