@redhat-developer/page-objects 1.10.0 → 1.12.0

package/out/components/ActionButtonElementDropdown.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License", destination); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { ContextMenu } from './menu/ContextMenu';
+import { AbstractElement } from './AbstractElement';
+export declare abstract class ActionButtonElementDropdown extends AbstractElement {
+    open(): Promise<ContextMenu>;
+}

package/out/components/ActionButtonElementDropdown.js

@@ -0,0 +1,46 @@
+"use strict";
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License", destination); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActionButtonElementDropdown = void 0;
+const ElementWithContextMenu_1 = require("./ElementWithContextMenu");
+const ContextMenu_1 = require("./menu/ContextMenu");
+const selenium_webdriver_1 = require("selenium-webdriver");
+const AbstractElement_1 = require("./AbstractElement");
+class ActionButtonElementDropdown extends AbstractElement_1.AbstractElement {
+    async open() {
+        await this.click();
+        const shadowRootHost = await this.enclosingItem.findElements(selenium_webdriver_1.By.className('shadow-root-host'));
+        const actions = this.getDriver().actions();
+        await actions.clear();
+        await actions.sendKeys(selenium_webdriver_1.Key.ESCAPE).perform();
+        if (shadowRootHost.length > 0) {
+            if ((await this.getAttribute('aria-expanded')) !== 'true') {
+                await this.click();
+            }
+            const shadowRoot = await shadowRootHost[0].getShadowRoot();
+            return new ContextMenu_1.ContextMenu(await shadowRoot.findElement(selenium_webdriver_1.By.className('monaco-menu-container'))).wait();
+        }
+        else {
+            await this.click();
+            const workbench = await this.getDriver().findElement(ElementWithContextMenu_1.ElementWithContextMenu.locators.Workbench.constructor);
+            return new ContextMenu_1.ContextMenu(workbench).wait();
+        }
+    }
+}
+exports.ActionButtonElementDropdown = ActionButtonElementDropdown;
+//# sourceMappingURL=ActionButtonElementDropdown.js.map

package/out/components/WebviewMixin.d.ts

@@ -24,7 +24,7 @@ type Constructor<T = object> = new (...args: any[]) => T;
  * The interface that a class is required to have in order to use the Webview mixin.
  */
 interface WebviewMixable extends AbstractElement {
-    getViewToSwitchTo(handle: string): Promise<WebElement | undefined>;
+    getViewToSwitchTo(): Promise<WebElement | undefined>;
 }
 /**
  * The interface that is exposed by applying this mixin.

package/out/components/WebviewMixin.js

@@ -63,7 +63,7 @@ function default_1(Base) {
             if (!this.handle) {
                 this.handle = await this.getDriver().getWindowHandle();
             }
-            const view = await this.getViewToSwitchTo(this.handle);
+            const view = await this.getViewToSwitchTo();
             if (!view) {
                 return;
             }

package/out/components/bottomBar/WebviewView.d.ts

@@ -14,14 +14,14 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { WebElement } from 'selenium-webdriver';
+import { Locator, WebElement } from 'selenium-webdriver';
 import { AbstractElement } from '../AbstractElement';
 /**
  * Page object representing a user-contributed panel implemented using a Webview.
  */
 declare class WebviewViewBase extends AbstractElement {
-    constructor();
-    getViewToSwitchTo(handle: string): Promise<WebElement | undefined>;
+    constructor(base?: Locator | WebElement, enclosingItem?: WebElement | Locator);
+    getViewToSwitchTo(): Promise<WebElement | undefined>;
 }
 export declare const WebviewView: new (...args: any[]) => WebviewViewBase & import("../WebviewMixin").WebviewMixinType;
 export type WebviewView = InstanceType<typeof WebviewView>;

package/out/components/bottomBar/WebviewView.js

@@ -22,16 +22,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebviewView = void 0;
 const AbstractElement_1 = require("../AbstractElement");
 const WebviewMixin_1 = __importDefault(require("../WebviewMixin"));
+const locators_1 = require("../../locators/locators");
 /**
  * Page object representing a user-contributed panel implemented using a Webview.
  */
 class WebviewViewBase extends AbstractElement_1.AbstractElement {
-    constructor() {
-        super(WebviewViewBase.locators.Workbench.constructor);
+    constructor(base = WebviewViewBase.locators.Workbench.constructor, enclosingItem) {
+        super(base, enclosingItem);
     }
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    async getViewToSwitchTo(handle) {
-        return await this.getDriver().findElement(WebviewViewBase.locators.WebviewView.iframe);
+    async getViewToSwitchTo() {
+        const frames = await this.getDriver().findElements(WebviewViewBase.locators.WebView.iframe);
+        return (0, locators_1.findBestContainingElement)(await this.getRect(), frames);
     }
 }
 exports.WebviewView = (0, WebviewMixin_1.default)(WebviewViewBase);

package/out/components/editor/EditorAction.d.ts

@@ -14,16 +14,18 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { EditorGroup } from './EditorView';
-import { ContextMenu, WebElement } from '../..';
-import { ElementWithContextMenu } from '../ElementWithContextMenu';
-export declare class EditorAction extends ElementWithContextMenu {
-    constructor(element: WebElement, parent: EditorGroup);
+import { ActionButtonElementDropdown } from '../ActionButtonElementDropdown';
+/**
+ * Base class for editor actions that provides a common method to get the title.
+ */
+declare abstract class BaseEditorAction extends ActionButtonElementDropdown {
     /**
      * Get text description of the action.
      */
     getTitle(): Promise<string>;
 }
-export declare class EditorActionDropdown extends EditorAction {
-    open(): Promise<ContextMenu>;
+export declare class EditorAction extends BaseEditorAction {
+}
+export declare class EditorActionDropdown extends BaseEditorAction {
 }
+export {};

package/out/components/editor/EditorAction.js

@@ -17,52 +17,22 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EditorActionDropdown = exports.EditorAction = void 0;
-const __1 = require("../..");
-const ElementWithContextMenu_1 = require("../ElementWithContextMenu");
-class EditorAction extends ElementWithContextMenu_1.ElementWithContextMenu {
-    constructor(element, parent) {
-        super(element, parent);
-    }
+const ActionButtonElementDropdown_1 = require("../ActionButtonElementDropdown");
+/**
+ * Base class for editor actions that provides a common method to get the title.
+ */
+class BaseEditorAction extends ActionButtonElementDropdown_1.ActionButtonElementDropdown {
     /**
      * Get text description of the action.
      */
     async getTitle() {
-        return await this.getAttribute(EditorAction.locators.EditorView.attribute);
+        return await this.getAttribute(BaseEditorAction.locators.EditorView.attribute);
     }
 }
+class EditorAction extends BaseEditorAction {
+}
 exports.EditorAction = EditorAction;
-class EditorActionDropdown extends EditorAction {
-    async open() {
-        await this.click();
-        const shadowRootHost = await this.enclosingItem.findElements(EditorAction.locators.EditorAction.shadowRootHost);
-        const actions = this.getDriver().actions();
-        await actions.clear();
-        await actions.sendKeys(__1.Key.ESCAPE).perform();
-        const webdriverCapabilities = await this.getDriver().getCapabilities();
-        const chromiumVersion = webdriverCapabilities.getBrowserVersion();
-        if (shadowRootHost.length > 0) {
-            if ((await this.getAttribute('aria-expanded')) !== 'true') {
-                await this.click();
-            }
-            let shadowRoot;
-            const webdriverCapabilities = await this.getDriver().getCapabilities();
-            const chromiumVersion = webdriverCapabilities.getBrowserVersion();
-            if (chromiumVersion && parseInt(chromiumVersion.split('.')[0]) >= 96) {
-                shadowRoot = await shadowRootHost[0].getShadowRoot();
-                return new __1.ContextMenu(await shadowRoot.findElement(EditorAction.locators.EditorAction.monacoMenuContainer)).wait();
-            }
-            else {
-                shadowRoot = (await this.getDriver().executeScript('return arguments[0].shadowRoot', shadowRootHost[0]));
-                return new __1.ContextMenu(shadowRoot).wait();
-            }
-        }
-        else if (chromiumVersion && parseInt(chromiumVersion.split('.')[0]) >= 100) {
-            await this.click();
-            const workbench = await this.getDriver().findElement(ElementWithContextMenu_1.ElementWithContextMenu.locators.Workbench.constructor);
-            return new __1.ContextMenu(workbench).wait();
-        }
-        return await super.openContextMenu();
-    }
+class EditorActionDropdown extends BaseEditorAction {
 }
 exports.EditorActionDropdown = EditorActionDropdown;
 //# sourceMappingURL=EditorAction.js.map

package/out/components/editor/WebView.d.ts

@@ -20,7 +20,7 @@ import { Editor } from './Editor';
  * Page object representing an open editor containing a web view
  */
 declare class WebViewBase extends Editor {
-    getViewToSwitchTo(handle: string): Promise<WebElement | undefined>;
+    getViewToSwitchTo(): Promise<WebElement | undefined>;
 }
 export declare const WebView: new (...args: any[]) => WebViewBase & import("../WebviewMixin").WebviewMixinType;
 export type WebView = InstanceType<typeof WebView>;

package/out/components/editor/WebView.js

@@ -22,21 +22,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebView = void 0;
 const WebviewMixin_1 = __importDefault(require("../WebviewMixin"));
 const Editor_1 = require("./Editor");
+const locators_1 = require("../../locators/locators");
 /**
  * Page object representing an open editor containing a web view
  */
 class WebViewBase extends Editor_1.Editor {
-    async getViewToSwitchTo(handle) {
-        const handles = await this.getDriver().getAllWindowHandles();
-        for (const handle of handles) {
-            await this.getDriver().switchTo().window(handle);
-            if ((await this.getDriver().getTitle()).includes('Virtual Document')) {
-                await this.getDriver().switchTo().frame(0);
-                return;
-            }
-        }
-        await this.getDriver().switchTo().window(handle);
-        return await this.getDriver().findElement(WebViewBase.locators.WebView.iframe);
+    async getViewToSwitchTo() {
+        const frames = await this.getDriver().findElements(WebViewBase.locators.WebView.iframe);
+        return (0, locators_1.findBestContainingElement)(await this.getRect(), frames);
     }
 }
 exports.WebView = (0, WebviewMixin_1.default)(WebViewBase);

package/out/components/sidebar/ViewSection.d.ts

@@ -17,6 +17,7 @@
 import { WebElement } from 'selenium-webdriver';
 import { ContextMenu, ViewContent, ViewItem, WelcomeContentSection } from '../..';
 import { AbstractElement } from '../AbstractElement';
+import { ActionButtonElementDropdown } from '../ActionButtonElementDropdown';
 export type ViewSectionConstructor<T extends ViewSection> = {
     new (rootElement: WebElement, tree: ViewContent): T;
 };
@@ -102,13 +103,23 @@ export declare abstract class ViewSection extends AbstractElement {
     private isHeaderHidden;
 }
 /**
- * Action button on the header of a view section
+ * Base class for action buttons on view sections.
+ * Provides shared functionality for both standard and dropdown actions.
  */
-export declare class ViewPanelAction extends AbstractElement {
+declare abstract class BaseViewPanelAction extends ActionButtonElementDropdown {
     constructor(element: WebElement, viewPart: ViewSection);
     /**
      * Get label of the action button
      */
     getLabel(): Promise<string>;
+    /**
+     * Wait for the action button to be located within a given timeout.
+     * @param timeout Time in milliseconds (default: 1000ms)
+     */
     wait(timeout?: number): Promise<this>;
 }
+export declare class ViewPanelAction extends BaseViewPanelAction {
+}
+export declare class ViewPanelActionDropdown extends BaseViewPanelAction {
+}
+export {};

package/out/components/sidebar/ViewSection.js

@@ -16,11 +16,12 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ViewPanelAction = exports.ViewSection = void 0;
+exports.ViewPanelActionDropdown = exports.ViewPanelAction = exports.ViewSection = void 0;
 const selenium_webdriver_1 = require("selenium-webdriver");
 const __1 = require("../..");
 const AbstractElement_1 = require("../AbstractElement");
 const ElementWithContextMenu_1 = require("../ElementWithContextMenu");
+const ActionButtonElementDropdown_1 = require("../ActionButtonElementDropdown");
 /**
  * Page object representing a collapsible content section of the side bar view
  */
@@ -49,6 +50,7 @@ class ViewSection extends AbstractElement_1.AbstractElement {
             const collapseExpandButton = await header.findElement(ViewSection.locators.ViewSection.headerCollapseExpandButton);
             await collapseExpandButton.click();
             await this.getDriver().wait((0, __1.waitForAttributeValue)(header, ViewSection.locators.ViewSection.headerExpanded, 'true'), timeout);
+            await this.getDriver().sleep(500);
         }
     }
     /**
@@ -64,6 +66,7 @@ class ViewSection extends AbstractElement_1.AbstractElement {
             const collapseExpandButton = await header.findElement(ViewSection.locators.ViewSection.headerCollapseExpandButton);
             await collapseExpandButton.click();
             await this.getDriver().wait((0, __1.waitForAttributeValue)(header, ViewSection.locators.ViewSection.headerExpanded, 'false'), timeout);
+            await this.getDriver().sleep(500);
         }
     }
     /**
@@ -97,16 +100,17 @@ class ViewSection extends AbstractElement_1.AbstractElement {
      * @returns Promise resolving to array of ViewPanelAction objects
      */
     async getActions() {
-        const actions = [];
-        if (!(await this.isHeaderHidden())) {
-            const header = await this.findElement(ViewSection.locators.ViewSection.header);
-            const act = await header.findElement(ViewSection.locators.ViewSection.actions);
-            const elements = await act.findElements(ViewSection.locators.ViewSection.button);
-            for (const element of elements) {
-                actions.push(await new ViewPanelAction(element, this).wait());
+        await this.getDriver().actions().move({ origin: this }).perform(); // move mouse to bring auto-hided buttons visible
+        const actions = await this.findElement(ViewSection.locators.ViewSection.actions).findElements(ViewSection.locators.ViewSection.button);
+        return Promise.all(actions.map(async (action) => {
+            const dropdown = (await action.getAttribute('aria-haspopup')) || (await action.getAttribute('aria-expanded'));
+            if (dropdown) {
+                return new ViewPanelActionDropdown(action, this);
             }
-        }
-        return actions;
+            else {
+                return new ViewPanelAction(action, this);
+            }
+        }));
     }
     /**
      * Retrieve an action button on the sections's header by its label
@@ -161,9 +165,10 @@ class ViewSection extends AbstractElement_1.AbstractElement {
 }
 exports.ViewSection = ViewSection;
 /**
- * Action button on the header of a view section
+ * Base class for action buttons on view sections.
+ * Provides shared functionality for both standard and dropdown actions.
  */
-class ViewPanelAction extends AbstractElement_1.AbstractElement {
+class BaseViewPanelAction extends ActionButtonElementDropdown_1.ActionButtonElementDropdown {
     constructor(element, viewPart) {
         super(element, viewPart);
     }
@@ -171,12 +176,21 @@ class ViewPanelAction extends AbstractElement_1.AbstractElement {
      * Get label of the action button
      */
     async getLabel() {
-        return await this.getAttribute(ViewSection.locators.ViewSection.buttonLabel);
+        return await this.getAttribute(BaseViewPanelAction.locators.ViewSection.buttonLabel);
     }
-    async wait(timeout = 1000) {
-        await this.getDriver().wait(selenium_webdriver_1.until.elementLocated(ViewSection.locators.ViewSection.actions), timeout);
+    /**
+     * Wait for the action button to be located within a given timeout.
+     * @param timeout Time in milliseconds (default: 1000ms)
+     */
+    async wait(timeout = 1_000) {
+        await this.getDriver().wait(selenium_webdriver_1.until.elementLocated(BaseViewPanelAction.locators.ViewSection.actions), timeout);
         return this;
     }
 }
+class ViewPanelAction extends BaseViewPanelAction {
+}
 exports.ViewPanelAction = ViewPanelAction;
+class ViewPanelActionDropdown extends BaseViewPanelAction {
+}
+exports.ViewPanelActionDropdown = ViewPanelActionDropdown;
 //# sourceMappingURL=ViewSection.js.map

package/out/locators/locators.d.ts

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { By, WebElement } from 'selenium-webdriver';
+import { By, IRectangle, WebElement } from 'selenium-webdriver';
 import { PartialDeep } from 'type-fest';
 import { ViewSection } from '../components/sidebar/ViewSection';
 type WebElementFunction<E extends WebElement, T> = (element: E) => T | PromiseLike<T>;
@@ -214,8 +214,6 @@ export interface Locators {
     WebView: {
         iframe: By;
         activeFrame: By;
-        container: (id: string) => By;
-        attribute: string;
     };
     ExtensionEditorView: {
         constructor: By;
@@ -554,4 +552,5 @@ export declare function hasNotClass(klass: string, locator?: By): (el: WebElemen
 export declare function hasElement(locatorSelector: (l: Locators) => By): (el: WebElement, locators: Locators) => Promise<boolean>;
 export declare function fromAttribute(attribute: string, locator?: By): (el: WebElement) => Promise<string>;
 export declare function fromText(locator?: By): (el: WebElement) => Promise<string>;
+export declare function findBestContainingElement(container: IRectangle, testElements: WebElement[]): Promise<WebElement | undefined>;
 export {};

package/out/locators/locators.js

@@ -22,6 +22,7 @@ exports.hasNotClass = hasNotClass;
 exports.hasElement = hasElement;
 exports.fromAttribute = fromAttribute;
 exports.fromText = fromText;
+exports.findBestContainingElement = findBestContainingElement;
 function hasAttribute(attr, value, locator) {
     return async (el) => {
         el = locator ? await el.findElement(locator) : el;
@@ -64,4 +65,24 @@ function fromText(locator) {
         return await el.getText();
     };
 }
+async function findBestContainingElement(container, testElements) {
+    const areas = await Promise.all(testElements.map(async (value) => {
+        const rect = await value.getRect();
+        const ax = Math.max(container.x, rect.x);
+        const ay = Math.max(container.y, rect.y);
+        const bx = Math.min(container.x + container.width, rect.x + rect.width);
+        const by = Math.min(container.y + container.height, rect.y + rect.height);
+        return (bx - ax) * (by - ay);
+    }));
+    let bestIdx = -1;
+    for (let i = 0; i < testElements.length; i++) {
+        if (areas[i] < 0) {
+            continue;
+        }
+        if (bestIdx === -1 || areas[i] > areas[bestIdx]) {
+            bestIdx = i;
+        }
+    }
+    return bestIdx === -1 ? undefined : testElements[bestIdx];
+}
 //# sourceMappingURL=locators.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redhat-developer/page-objects",
-  "version": "1.10.0",
+  "version": "1.12.0",
   "description": "Page Object API implementation for a VS Code editor used by ExTester framework.",
   "main": "out/index.js",
   "types": "out/index.d.ts",
@@ -41,11 +41,11 @@
     "clone-deep": "^4.0.1",
     "compare-versions": "^6.1.1",
     "fs-extra": "^11.3.0",
-    "type-fest": "^4.34.1"
+    "type-fest": "^4.39.1"
   },
   "peerDependencies": {
     "selenium-webdriver": ">=4.6.1",
     "typescript": ">=4.6.2"
   },
-  "gitHead": "eaf266f43e1dca66cb0d660ecbf8f59e56af4808"
+  "gitHead": "006642fd809f6b11cc662ed0f190295efff61602"
 }