webdriverio 9.1.5 → 9.2.1

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

@@ -0,0 +1,48 @@
+import { type local } from 'webdriver';
+import type { ChainablePromiseElement } from '../../types.js';
+type FlatContextTree = Omit<local.BrowsingContextInfo, 'children'> & {
+    children: string[];
+};
+/**
+ * Switches the active context to a frame, e.g. an iframe on the page. There are multiple ways you can query a frame
+ * on the page:
+ *
+ *   - 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 certain context id
+ *     await browser.switchFrame('A5734774C41F8C91D483BDD4022B2EF3')
+ *     ```
+ *
+ *   - If given a WebdriverIO element that references an `iframe` element it will switch to that frame
+ *     ```ts
+ *     // switch to a frame element queried from current context
+ *     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.
+ *     ```ts
+ *     // switch to first frame that contains an element with id "#frameContent"
+ *     await browser.switchFrame(() => $('#frameContent').isExisting())
+ *     ```
+ *
+ *   - If given `null` it will switch to the top level frame
+ *     ```ts
+ *     // first switch into a frame
+ *     await browser.switchFrame($('iframe'))
+ *     // do more automation within that frame, then ...
+ *
+ *     // switch to the top level frame
+ *     await browser.switchFrame(null)
+ *     ```
+ *
+ * @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 {};
+//# sourceMappingURL=switchFrame.d.ts.map

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

@@ -0,0 +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"}

package/build/commands/browser.d.ts

@@ -34,6 +34,7 @@ export * from './browser/setTimeout.js';
 export * from './browser/setViewport.js';
 export * from './browser/setWindowSize.js';
 export * from './browser/switchWindow.js';
+export * from './browser/switchFrame.js';
 export * from './browser/throttle.js';
 export * from './browser/throttleCPU.js';
 export * from './browser/throttleNetwork.js';

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

@@ -1 +1 @@
-{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../src/commands/browser.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,qBAAqB,CAAA;AACnC,cAAc,sBAAsB,CAAA;AACpC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,mBAAmB,CAAA;AACjC,cAAc,uBAAuB,CAAA;AACrC,cAAc,sBAAsB,CAAA;AACpC,cAAc,oBAAoB,CAAA;AAClC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,2BAA2B,CAAA;AACzC,cAAc,sBAAsB,CAAA;AACpC,cAAc,sBAAsB,CAAA;AACpC,cAAc,2BAA2B,CAAA;AACzC,cAAc,yBAAyB,CAAA;AACvC,cAAc,2BAA2B,CAAA;AACzC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,mBAAmB,CAAA;AACjC,cAAc,mBAAmB,CAAA;AACjC,cAAc,2BAA2B,CAAA;AACzC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,wBAAwB,CAAA;AACtC,cAAc,oBAAoB,CAAA;AAClC,cAAc,sBAAsB,CAAA;AACpC,cAAc,qBAAqB,CAAA;AACnC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,sBAAsB,CAAA;AACpC,cAAc,sBAAsB,CAAA;AACpC,cAAc,kCAAkC,CAAA;AAChD,cAAc,6BAA6B,CAAA;AAC3C,cAAc,qBAAqB,CAAA;AACnC,cAAc,yBAAyB,CAAA;AACvC,cAAc,yBAAyB,CAAA;AACvC,cAAc,0BAA0B,CAAA;AACxC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,2BAA2B,CAAA;AACzC,cAAc,uBAAuB,CAAA;AACrC,cAAc,0BAA0B,CAAA;AACxC,cAAc,8BAA8B,CAAA;AAC5C,cAAc,0BAA0B,CAAA;AACxC,cAAc,yBAAyB,CAAA;AACvC,cAAc,kBAAkB,CAAA;AAChC,cAAc,wBAAwB,CAAA"}
+{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../src/commands/browser.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,qBAAqB,CAAA;AACnC,cAAc,sBAAsB,CAAA;AACpC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,mBAAmB,CAAA;AACjC,cAAc,uBAAuB,CAAA;AACrC,cAAc,sBAAsB,CAAA;AACpC,cAAc,oBAAoB,CAAA;AAClC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,2BAA2B,CAAA;AACzC,cAAc,sBAAsB,CAAA;AACpC,cAAc,sBAAsB,CAAA;AACpC,cAAc,2BAA2B,CAAA;AACzC,cAAc,yBAAyB,CAAA;AACvC,cAAc,2BAA2B,CAAA;AACzC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,mBAAmB,CAAA;AACjC,cAAc,mBAAmB,CAAA;AACjC,cAAc,2BAA2B,CAAA;AACzC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,wBAAwB,CAAA;AACtC,cAAc,oBAAoB,CAAA;AAClC,cAAc,sBAAsB,CAAA;AACpC,cAAc,qBAAqB,CAAA;AACnC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,sBAAsB,CAAA;AACpC,cAAc,sBAAsB,CAAA;AACpC,cAAc,kCAAkC,CAAA;AAChD,cAAc,6BAA6B,CAAA;AAC3C,cAAc,qBAAqB,CAAA;AACnC,cAAc,yBAAyB,CAAA;AACvC,cAAc,yBAAyB,CAAA;AACvC,cAAc,0BAA0B,CAAA;AACxC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,2BAA2B,CAAA;AACzC,cAAc,0BAA0B,CAAA;AACxC,cAAc,uBAAuB,CAAA;AACrC,cAAc,0BAA0B,CAAA;AACxC,cAAc,8BAA8B,CAAA;AAC5C,cAAc,0BAA0B,CAAA;AACxC,cAAc,yBAAyB,CAAA;AACvC,cAAc,kBAAkB,CAAA;AAChC,cAAc,wBAAwB,CAAA"}

package/build/index.js

@@ -122,6 +122,7 @@ __export(browser_exports, {
   setTimeout: () => setTimeout2,
   setViewport: () => setViewport,
   setWindowSize: () => setWindowSize,
+  switchFrame: () => switchFrame,
   switchWindow: () => switchWindow,
   throttle: () => throttle,
   throttleCPU: () => throttleCPU,
@@ -4164,6 +4165,112 @@ async function switchWindow(matcher) {
   throw new Error(`No window found with title, url or name matching "${matcher}"`);
 }
 
+// src/commands/browser/switchFrame.ts
+async function switchFrame(context) {
+  if (context === null) {
+    const handle = await this.getWindowHandle();
+    await switchToFrameHelper(this, handle);
+    return handle;
+  }
+  if (typeof context === "string") {
+    const tree = await this.browsingContextGetTree({});
+    const urlContext = findContext(context, tree.contexts, byUrl)?.context;
+    if (urlContext) {
+      await switchToFrameHelper(this, urlContext);
+      return urlContext;
+    }
+    const urlContextContaining = findContext(context, tree.contexts, byUrlContaining)?.context;
+    if (urlContextContaining) {
+      await switchToFrameHelper(this, urlContextContaining);
+      return urlContextContaining;
+    }
+    const contextIdContext = findContext(context, tree.contexts, byContextId)?.context;
+    if (contextIdContext) {
+      await switchToFrameHelper(this, contextIdContext);
+      return contextIdContext;
+    }
+    throw new Error(`Frame with url or context id "${context}" not found`);
+  }
+  if (typeof context === "object" && typeof context.getElement === "function") {
+    const element = await context.getElement();
+    return switchToFrameUsingElement(this, element);
+  }
+  if (typeof context === "function") {
+    const tree = await this.browsingContextGetTree({});
+    const mapContext = (context2) => [
+      context2.context,
+      ...(context2.children || []).map(mapContext)
+    ];
+    const sessionContext = getContextManager(this);
+    const currentContext = await sessionContext.getCurrentContext();
+    const allContexts = tree.contexts.map(mapContext).flat(Infinity).filter((ctx) => ctx !== currentContext).reduce((acc, ctx) => {
+      const context2 = findContext(ctx, tree.contexts, byContextId);
+      acc[ctx] = context2;
+      return acc;
+    }, {});
+    for (const [contextId, ctx] of Object.entries(allContexts)) {
+      sessionContext.setCurrentContext(contextId);
+      const isDesiredFrame = await context(ctx);
+      if (isDesiredFrame) {
+        return context;
+      }
+    }
+    sessionContext.setCurrentContext(currentContext);
+    throw new Error("Could not find the desired frame");
+  }
+  throw new Error(
+    `Invalid type for context parameter: ${typeof context}, expected one of number, string or null. Check out our docs: https://webdriver.io/docs/api/browser/switchToFrame.html`
+  );
+}
+function switchToFrameHelper(browser, context) {
+  const sessionContext = getContextManager(browser);
+  sessionContext.setCurrentContext(context);
+}
+async function switchToFrameUsingElement(browser, element) {
+  let frameSrc = await element.getAttribute("src");
+  if (!frameSrc) {
+    const source = await element.getHTML({ includeSelectorTag: true });
+    throw new Error(
+      `The provided frame element ("${source}") does not have a src attribute needed to detect the context, please use a different method to select the frame. For more information checkout our docs: https://webdriver.io/docs/api/browser/switchFrame.html`
+    );
+  }
+  if (!frameSrc.startsWith("http")) {
+    frameSrc = await browser.execute((urlPath) => URL.parse(urlPath, window.location.href)?.href, frameSrc) || frameSrc;
+  }
+  const tree = await browser.browsingContextGetTree({});
+  const urlContext = findContext(frameSrc, tree.contexts, byUrl)?.context;
+  if (!urlContext) {
+    throw new Error(
+      `Frame with url "${frameSrc}" not found! Please try a different method to select the frame. For more information checkout our docs: https://webdriver.io/docs/api/browser/switchFrame.html`
+    );
+  }
+  await switchToFrameHelper(browser, urlContext);
+  return urlContext;
+}
+function byUrl(context, url6) {
+  return context.url === url6;
+}
+function byUrlContaining(context, url6) {
+  return context.url.includes(url6);
+}
+function byContextId(context, contextId) {
+  return context.context === contextId;
+}
+function findContext(url6, contexts, matcher) {
+  for (const context of contexts || []) {
+    if (matcher(context, url6)) {
+      return context;
+    }
+    if (Array.isArray(context.children) && context.children.length > 0) {
+      const result = findContext(url6, context.children, matcher);
+      if (result) {
+        return result;
+      }
+    }
+  }
+  return void 0;
+}
+
 // src/commands/browser/throttle.ts
 import logger13 from "@wdio/logger";
 import { getBrowserObject as getBrowserObject8 } from "@wdio/utils";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "webdriverio",
   "description": "Next-gen browser and mobile automation test framework for Node.js",
-  "version": "9.1.5",
+  "version": "9.2.1",
   "homepage": "https://webdriver.io",
   "author": "Christian Bromann <mail@bromann.dev>",
   "license": "MIT",
@@ -78,7 +78,7 @@
     "@types/sinonjs__fake-timers": "^8.1.5",
     "@wdio/config": "9.1.3",
     "@wdio/logger": "9.1.3",
-    "@wdio/protocols": "9.0.8",
+    "@wdio/protocols": "9.2.0",
     "@wdio/repl": "9.0.8",
     "@wdio/types": "9.1.3",
     "@wdio/utils": "9.1.3",
@@ -100,7 +100,7 @@
     "rgb2hex": "0.2.5",
     "serialize-error": "^11.0.3",
     "urlpattern-polyfill": "^10.0.0",
-    "webdriver": "9.1.5"
+    "webdriver": "9.2.0"
   },
   "peerDependencies": {
     "puppeteer-core": "^22.3.0"
@@ -110,5 +110,5 @@
       "optional": true
     }
   },
-  "gitHead": "1c712c15d861b68ce516aa77dcf0ec0228ac3a94"
+  "gitHead": "3da8b097c684b0ed9cda7224c41f96151bcd4104"
 }