webdriverio 9.2.1 → 9.2.4

package/build/commands/browser/keys.d.ts

@@ -4,7 +4,7 @@
  * on it. To use characters like "Left arrow" or "Back space", import the `Key` object from the WebdriverIO package.
  *
  * Modifier like `Control`, `Shift`, `Alt` and `Command` will stay pressed so you need to trigger them again to release
- * them. Modifiying a click however requires you to use the WebDriver Actions API through the
+ * them. Modifying a click however requires you to use the WebDriver Actions API through the
  * [performActions](https://webdriver.io/docs/api/webdriver#performactions) method.
  *
  * :::info

package/build/commands/browser/mock.d.ts

@@ -96,7 +96,7 @@ export declare const SESSION_MOCKS: Record<string, Set<WebDriverInterception>>;
  * </example>
  *
  * @alias browser.mock
- * @param {String|RegExp}       url                             url to mock
+ * @param {String}              url                             url to mock
  * @param {MockFilterOptions=}  filterOptions                   filter mock resource by additional options
  * @param {String|Function=}    filterOptions.method            filter resource by HTTP method
  * @param {Object|Function=}    filterOptions.headers           filter resource by specific request headers

package/build/commands/browser/newWindow.d.ts

@@ -1,23 +1,23 @@
 import type { NewWindowOptions } from '../../types.js';
 /**
  *
- * Open new window in browser. This command is the equivalent function to `window.open()`. This command does not
- * work in mobile environments.
+ * Open new window or tab in browser (defaults to a new window if not specified).
+ * This command is the equivalent function to `window.open()`. This command does not work in mobile environments.
  *
- * __Note:__ When calling this command you automatically switch to the new window.
+ * __Note:__ When calling this command you automatically switch to the new window or tab.
  *
  * <example>
     :newWindowSync.js
-    it('should open a new tab', async () => {
+    it('should open a new window', async () => {
         await browser.url('https://google.com')
         console.log(await browser.getTitle()) // outputs: "Google"
 
-        await browser.newWindow('https://webdriver.io', {
+        const result = await browser.newWindow('https://webdriver.io', {
             windowName: 'WebdriverIO window',
             windowFeature: 'width=420,height=230,resizable,scrollbars=yes,status=1',
         })
         console.log(await browser.getTitle()) // outputs: "WebdriverIO · Next-gen browser and mobile automation test framework for Node.js"
-
+        console.log(result.type) // outputs: "window"
         const handles = await browser.getWindowHandles()
         await browser.switchToWindow(handles[1])
         await browser.closeWindow()
@@ -25,17 +25,45 @@ import type { NewWindowOptions } from '../../types.js';
         console.log(await browser.getTitle()) // outputs: "Google"
     });
  * </example>
+ * <example>
+      :newTabSync.js
+      it('should open a new tab', async () => {
+          await browser.url('https://google.com')
+          console.log(await browser.getTitle()) // outputs: "Google"
+
+          await browser.newWindow('https://webdriver.io', {
+              type:'tab',
+              windowName: 'WebdriverIO window',
+              windowFeature: 'width=420,height=230,resizable,scrollbars=yes,status=1',
+          })
+          console.log(await browser.getTitle()) // outputs: "WebdriverIO · Next-gen browser and mobile automation test framework for Node.js"
+          console.log(result.type) // outputs: "tab"
+          const handles = await browser.getWindowHandles()
+          await browser.switchToWindow(handles[1])
+          await browser.closeWindow()
+          await browser.switchToWindow(handles[0])
+          console.log(await browser.getTitle()) // outputs: "Google"
+     });
+ * </example>
  *
  * @param {string}  url      website URL to open
  * @param {NewWindowOptions=} options                newWindow command options
+ * @param {string=}           options.type           type of new window: 'tab' or 'window'
  * @param {String=}           options.windowName     name of the new window
  * @param {String=}           options.windowFeatures features of opened window (e.g. size, position, scrollbars, etc.)
  *
- * @return {String}          id of window handle of new tab
+ * @return {Object}          An object containing the window handle and the type of new window
+ * @return {String}          handle - The ID of the window handle of the new tab or window
+ * @return {String}          type - The type of the new window, either 'tab' or 'window'
+ *
+ * @throws {Error} If `url` is invalid, if the command is used on mobile, or `type` is not 'tab' or 'window'.
  *
  * @uses browser/execute, protocol/getWindowHandles, protocol/switchToWindow
  * @alias browser.newWindow
- * @type window
+ * @type window or tab
  */
-export declare function newWindow(this: WebdriverIO.Browser, url: string, { windowName, windowFeatures }?: NewWindowOptions): Promise<string>;
+export declare function newWindow(this: WebdriverIO.Browser, url: string, { type, windowName, windowFeatures }?: NewWindowOptions): Promise<{
+    handle: string;
+    type: 'tab' | 'window';
+}>;
 //# sourceMappingURL=newWindow.d.ts.map

package/build/commands/browser/newWindow.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"newWindow.d.ts","sourceRoot":"","sources":["../../../src/commands/browser/newWindow.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAItD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,wBAAsB,SAAS,CAC3B,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,GAAG,EAAE,MAAM,EACX,EAAE,UAAe,EAAE,cAAmB,EAAE,GAAE,gBAAqB,mBAiDlE"}
+{"version":3,"file":"newWindow.d.ts","sourceRoot":"","sources":["../../../src/commands/browser/newWindow.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAMtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8DG;AACH,wBAAsB,SAAS,CAC3B,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,GAAG,EAAE,MAAM,EACX,EAAE,IAAe,EAAE,UAAe,EAAE,cAAmB,EAAE,GAAE,gBAAqB,GACjF,OAAO,CAAC;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,KAAK,GAAG,QAAQ,CAAA;CAAE,CAAC,CA2DrD"}

package/build/commands/browser/switchFrame.d.ts

@@ -9,8 +9,18 @@ type FlatContextTree = Omit<local.BrowsingContextInfo, 'children'> & {
  *
  *   - If given a string it switches to the frame with a matching context id, url or url that contains that string
  *     ```ts
- *     // switch to a frame that has the url "https://the-internet.herokuapp.com/iframe"
- *     await browser.switchFrame('https://the-internet.herokuapp.com/iframe')
+ *     // switch to a frame that has a specific url or contains a string in the url
+ *     await browser.url('https://www.w3schools.com/tags/tryit.asp?filename=tryhtml_iframe')
+ *     // Note: this frame is located in a nested iframe, however you only need to provide
+ *     // the frame url of your desired frame
+ *     await browser.switchFrame('https://www.w3schools.com')
+ *     // check the title of the page
+ *     console.log(await browser.execute(() => [document.title, document.URL]))
+ *     // outputs: [ 'W3Schools Online Web Tutorials', 'https://www.w3schools.com/' ]
+ *     ```
+ *
+ *   - If you have the context id of the frame you can use it directly
+ *     ```ts
  *     // switch to a frame that has a certain context id
  *     await browser.switchFrame('A5734774C41F8C91D483BDD4022B2EF3')
  *     ```
@@ -21,12 +31,14 @@ type FlatContextTree = Omit<local.BrowsingContextInfo, 'children'> & {
  *     await browser.switchFrame($('iframe'))
  *     ```
  *
- *   - If given a function it will loop through all iframes on the page and call the function with the context
- *     object. The function should return a boolean indicating if the frame should be selected. Within the function
- *     you can use WebdriverIO commands to e.g. check if a certain frame element exists.
+ *   - If given a function it will loop through all iframes on the page and call the function within the context
+ *     object. The function should return a boolean indicating if the frame should be selected. The function
+ *     will be executed within the browser and allows access to all Web APIs, e.g.:
  *     ```ts
  *     // switch to first frame that contains an element with id "#frameContent"
- *     await browser.switchFrame(() => $('#frameContent').isExisting())
+ *     await browser.switchFrame(() => Boolean(document.querySelector('#frameContent')))
+ *     // switch to first frame that contains "webdriver" in the URL
+ *     await browser.switchFrame(() => document.URL.includes('webdriver'))
  *     ```
  *
  *   - If given `null` it will switch to the top level frame
@@ -39,10 +51,13 @@ type FlatContextTree = Omit<local.BrowsingContextInfo, 'children'> & {
  *     await browser.switchFrame(null)
  *     ```
  *
+ * Once you switched to a frame, all further commands will be executed in the context of that frame,
+ * including navigating to different pages.
+ *
  * @alias browser.switchFrame
  * @param {string|object|function} context
  * @returns {Promise<string>} the current active context id
  */
-export declare function switchFrame(this: WebdriverIO.Browser, context: WebdriverIO.Element | ChainablePromiseElement | string | null | ((tree: FlatContextTree) => boolean | Promise<boolean>)): Promise<string | ((tree: FlatContextTree) => boolean | Promise<boolean>)>;
+export declare function switchFrame(this: WebdriverIO.Browser, context: WebdriverIO.Element | ChainablePromiseElement | string | null | ((tree: FlatContextTree) => boolean | Promise<boolean>)): Promise<string | void>;
 export {};
 //# sourceMappingURL=switchFrame.d.ts.map

package/build/commands/browser/switchFrame.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"switchFrame.d.ts","sourceRoot":"","sources":["../../../src/commands/browser/switchFrame.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,WAAW,CAAA;AAGtC,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAA;AAE7D,KAAK,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,mBAAmB,EAAE,UAAU,CAAC,GAAG;IAAE,QAAQ,EAAE,MAAM,EAAE,CAAA;CAAE,CAAA;AAE3F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,wBAAsB,WAAW,CAC7B,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,OAAO,EAAE,WAAW,CAAC,OAAO,GAAG,uBAAuB,GAAG,MAAM,GAAG,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,eAAe,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,4BAA/C,eAAe,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,GAgFlI"}
+{"version":3,"file":"switchFrame.d.ts","sourceRoot":"","sources":["../../../src/commands/browser/switchFrame.ts"],"names":[],"mappings":"AACA,OAAO,EAAe,KAAK,KAAK,EAAe,MAAM,WAAW,CAAA;AAOhE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAA;AAE7D,KAAK,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,mBAAmB,EAAE,UAAU,CAAC,GAAG;IAAE,QAAQ,EAAE,MAAM,EAAE,CAAA;CAAE,CAAA;AAG3F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AACH,wBAAsB,WAAW,CAC7B,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,OAAO,EAAE,WAAW,CAAC,OAAO,GAAG,uBAAuB,GAAG,MAAM,GAAG,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,eAAe,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,0BA8NnI"}

package/build/commands/browser/switchWindow.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"switchWindow.d.ts","sourceRoot":"","sources":["../../../src/commands/browser/switchWindow.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAsB,YAAY,CAC9B,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,OAAO,EAAE,MAAM,GAAG,MAAM,mBAmD3B"}
+{"version":3,"file":"switchWindow.d.ts","sourceRoot":"","sources":["../../../src/commands/browser/switchWindow.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAsB,YAAY,CAC9B,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,OAAO,EAAE,MAAM,GAAG,MAAM,mBAqD3B"}

package/build/commands/browser/url.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"url.d.ts","sourceRoot":"","sources":["../../../src/commands/browser/url.ts"],"names":[],"mappings":"AAKA,KAAK,SAAS,GAAG,MAAM,GAAG,aAAa,GAAG,aAAa,GAAG,UAAU,CAAA;AAKpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmGG;AACH,wBAAsB,GAAG,CACrB,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,iBAAsB,GAChC,OAAO,CAAC,WAAW,CAAC,OAAO,GAAG,IAAI,CAAC,CA8FrC;AAED,UAAU,iBAAiB;IACvB;;;;;;;;;;OAUG;IACH,IAAI,CAAC,EAAE,SAAS,CAAA;IAChB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC;;;OAGG;IACH,IAAI,CAAC,EAAE;QACH,IAAI,EAAE,MAAM,CAAA;QACZ,IAAI,EAAE,MAAM,CAAA;KACf,CAAA;IACD;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,CAAA;CAC3B"}
+{"version":3,"file":"url.d.ts","sourceRoot":"","sources":["../../../src/commands/browser/url.ts"],"names":[],"mappings":"AAKA,KAAK,SAAS,GAAG,MAAM,GAAG,aAAa,GAAG,aAAa,GAAG,UAAU,CAAA;AAKpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmGG;AACH,wBAAsB,GAAG,CACrB,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,iBAAsB,GAChC,OAAO,CAAC,WAAW,CAAC,OAAO,GAAG,IAAI,CAAC,CAyGrC;AAED,UAAU,iBAAiB;IACvB;;;;;;;;;;OAUG;IACH,IAAI,CAAC,EAAE,SAAS,CAAA;IAChB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC;;;OAGG;IACH,IAAI,CAAC,EAAE;QACH,IAAI,EAAE,MAAM,CAAA;QACZ,IAAI,EAAE,MAAM,CAAA;KACf,CAAA;IACD;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,CAAA;CAC3B"}

package/build/context.d.ts

@@ -7,7 +7,10 @@ export declare function getContextManager(browser: WebdriverIO.Browser): Context
 export declare class ContextManager {
     #private;
     constructor(browser: WebdriverIO.Browser);
-    initialize(): Promise<boolean>;
+    /**
+     * set context at the start of the session
+     */
+    initialize(): Promise<string>;
     setCurrentContext(context: string): void;
     getCurrentContext(): Promise<string>;
 }

package/build/context.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../src/context.ts"],"names":[],"mappings":"AAMA,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,WAAW,CAAC,OAAO,kBAS7D;AAED;;;;GAIG;AACH,qBAAa,cAAc;;gBAKX,OAAO,EAAE,WAAW,CAAC,OAAO;IAoBlC,UAAU;IAqBhB,iBAAiB,CAAE,OAAO,EAAE,MAAM;IAI5B,iBAAiB;CAM1B"}
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../src/context.ts"],"names":[],"mappings":"AAEA,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,WAAW,CAAC,OAAO,kBAS7D;AAED;;;;GAIG;AACH,qBAAa,cAAc;;gBAIX,OAAO,EAAE,WAAW,CAAC,OAAO;IAiCxC;;OAEG;IACG,UAAU;IAahB,iBAAiB,CAAE,OAAO,EAAE,MAAM;IAI5B,iBAAiB;CAM1B"}