@redhat-developer/page-objects 1.7.0 → 1.8.0

package/out/components/AbstractElement.js

@@ -34,7 +34,7 @@ class AbstractElement extends selenium_webdriver_1.WebElement {
      * this will be used to narrow down the search for the underlying DOM element
      */
     constructor(base, enclosingItem) {
-        let item = AbstractElement.driver.findElement(selenium_webdriver_1.By.css('html'));
+        let item = AbstractElement.driver.findElement(AbstractElement.locators.AbstractElement.tag);
         if (!enclosingItem) {
             enclosingItem = item;
         }

package/out/components/bottomBar/BottomBarPanel.js

@@ -108,7 +108,7 @@ class BottomBarPanel extends AbstractElement_1.AbstractElement {
                 await tabs[0].click();
             }
             else {
-                const label = await tabContainer.findElement(selenium_webdriver_1.By.xpath(`.//a[starts-with(@aria-label, '${title}')]`));
+                const label = await tabContainer.findElement(BottomBarPanel.locators.BottomBarPanel.openTabElement(title));
                 await label.click();
             }
         }

package/out/components/editor/EditorAction.js

@@ -34,7 +34,7 @@ exports.EditorAction = EditorAction;
 class EditorActionDropdown extends EditorAction {
     async open() {
         await this.click();
-        const shadowRootHost = await this.enclosingItem.findElements(__1.By.className('shadow-root-host'));
+        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();
@@ -49,7 +49,7 @@ class EditorActionDropdown extends EditorAction {
             const chromiumVersion = webdriverCapabilities.getBrowserVersion();
             if (chromiumVersion && parseInt(chromiumVersion.split('.')[0]) >= 96) {
                 shadowRoot = await shadowRootHost[0].getShadowRoot();
-                return new __1.ContextMenu(await shadowRoot.findElement(__1.By.className('monaco-menu-container'))).wait();
+                return new __1.ContextMenu(await shadowRoot.findElement(EditorAction.locators.EditorAction.monacoMenuContainer)).wait();
             }
             else {
                 shadowRoot = (await this.getDriver().executeScript('return arguments[0].shadowRoot', shadowRootHost[0]));

package/out/components/editor/SettingsEditor.js

@@ -350,7 +350,7 @@ class ArraySetting extends Setting {
      */
     async add() {
         // click 'Add Item' button
-        const button = await this.findElement(SettingsEditor.locators.SettingsEditor.arrayNewRow).findElement(selenium_webdriver_1.By.className('monaco-button'));
+        const button = await this.findElement(SettingsEditor.locators.SettingsEditor.arrayNewRow).findElement(SettingsEditor.locators.SettingsEditor.button);
         await button.click();
         await new Promise((sleep) => setTimeout(sleep, 1_000)); // need to force some time to allow DOM rerender elements
         // get item row switched to 'edit' mode

package/out/components/editor/TextEditor.js

@@ -483,14 +483,14 @@ class TextEditor extends Editor_1.Editor {
     }
     async openContextMenu() {
         await this.getDriver().actions().contextClick(this).perform();
-        const shadowRootHost = await this.enclosingItem.findElements(selenium_webdriver_1.By.className('shadow-root-host'));
+        const shadowRootHost = await this.enclosingItem.findElements(TextEditor.locators.TextEditor.shadowRootHost);
         if (shadowRootHost.length > 0) {
             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(selenium_webdriver_1.By.className('monaco-menu-container'))).wait();
+                return new __1.ContextMenu(await shadowRoot.findElement(TextEditor.locators.TextEditor.monacoMenuContainer)).wait();
             }
             else {
                 shadowRoot = (await this.getDriver().executeScript('return arguments[0].shadowRoot', shadowRootHost[0]));
@@ -524,7 +524,7 @@ class TextEditor extends Editor_1.Editor {
         const lineNum = await margin.findElement(TextEditor.locators.TextEditor.lineNumber(line));
         await this.getDriver().actions().move({ origin: lineNum }).perform();
         const lineOverlay = await margin.findElement(TextEditor.locators.TextEditor.lineOverlay(line));
-        const breakpointContainer = TextEditor.versionInfo.version >= '1.80.0' ? await this.findElement(selenium_webdriver_1.By.className('glyph-margin-widgets')) : lineOverlay;
+        const breakpointContainer = TextEditor.versionInfo.version >= '1.80.0' ? await this.findElement(TextEditor.locators.TextEditor.glyphMarginWidget) : lineOverlay;
         const breakPoint = await breakpointContainer.findElements(TextEditor.locators.TextEditor.breakpoint.generalSelector);
         if (breakPoint.length > 0) {
             if (this.breakPoints.indexOf(line) !== -1) {
@@ -549,7 +549,7 @@ class TextEditor extends Editor_1.Editor {
      */
     async getPausedBreakpoint() {
         const breakpointLocators = Breakpoint_1.Breakpoint.locators.TextEditor.breakpoint;
-        const breakpointContainer = TextEditor.versionInfo.version >= '1.80.0' ? await this.findElement(selenium_webdriver_1.By.className('glyph-margin-widgets')) : this;
+        const breakpointContainer = TextEditor.versionInfo.version >= '1.80.0' ? await this.findElement(TextEditor.locators.TextEditor.glyphMarginWidget) : this;
         const breakpoints = await breakpointContainer.findElements(breakpointLocators.pauseSelector);
         if (breakpoints.length === 0) {
             return undefined;
@@ -561,10 +561,10 @@ class TextEditor extends Editor_1.Editor {
         let lineElement;
         if (TextEditor.versionInfo.version >= '1.80.0') {
             const styleTopAttr = await breakpoints[0].getCssValue('top');
-            lineElement = await this.findElement(TextEditor.locators.TextEditor.marginArea).findElement(selenium_webdriver_1.By.xpath(`.//div[contains(@style, "${styleTopAttr}")]`));
+            lineElement = await this.findElement(TextEditor.locators.TextEditor.marginArea).findElement(TextEditor.locators.TextEditor.lineElement(styleTopAttr));
         }
         else {
-            lineElement = await breakpoints[0].findElement(selenium_webdriver_1.By.xpath('./..'));
+            lineElement = await breakpoints[0].findElement(TextEditor.locators.TextEditor.elementLevelBack);
         }
         return new Breakpoint_1.Breakpoint(breakpoints[0], lineElement);
     }
@@ -589,16 +589,16 @@ class TextEditor extends Editor_1.Editor {
     async getBreakpoints() {
         const breakpoints = [];
         const breakpointLocators = Breakpoint_1.Breakpoint.locators.TextEditor.breakpoint;
-        const breakpointContainer = TextEditor.versionInfo.version >= '1.80.0' ? await this.findElement(selenium_webdriver_1.By.className('glyph-margin-widgets')) : this;
+        const breakpointContainer = TextEditor.versionInfo.version >= '1.80.0' ? await this.findElement(TextEditor.locators.TextEditor.glyphMarginWidget) : this;
         const breakpointsSelectors = await breakpointContainer.findElements(breakpointLocators.generalSelector);
         for (const breakpointSelector of breakpointsSelectors) {
             let lineElement;
             if (TextEditor.versionInfo.version >= '1.80.0') {
                 const styleTopAttr = await breakpointSelector.getCssValue('top');
-                lineElement = await this.findElement(TextEditor.locators.TextEditor.marginArea).findElement(selenium_webdriver_1.By.xpath(`.//div[contains(@style, "${styleTopAttr}")]`));
+                lineElement = await this.findElement(TextEditor.locators.TextEditor.marginArea).findElement(TextEditor.locators.TextEditor.lineElement(styleTopAttr));
             }
             else {
-                lineElement = await breakpointSelector.findElement(selenium_webdriver_1.By.xpath('./..'));
+                lineElement = await breakpointSelector.findElement(TextEditor.locators.TextEditor.elementLevelBack);
             }
             breakpoints.push(new Breakpoint_1.Breakpoint(breakpointSelector, lineElement));
         }
@@ -610,8 +610,8 @@ class TextEditor extends Editor_1.Editor {
      */
     async getCodeLenses() {
         const lenses = [];
-        const widgets = await this.findElement(selenium_webdriver_1.By.className('contentWidgets'));
-        const items = await widgets.findElements(selenium_webdriver_1.By.xpath(`.//span[contains(@widgetid, 'codelens.widget')]/a[@id]`));
+        const widgets = await this.findElement(TextEditor.locators.TextEditor.contentWidgets);
+        const items = await widgets.findElements(TextEditor.locators.TextEditor.contentWidgetsElements);
         for (const item of items) {
             lenses.push(await new CodeLens(item, this).wait());
         }
@@ -651,14 +651,14 @@ class Selection extends ElementWithContextMenu_1.ElementWithContextMenu {
     async openContextMenu() {
         const ed = this.getEnclosingElement();
         await this.getDriver().actions().contextClick(this).perform();
-        const shadowRootHost = await ed.getEnclosingElement().findElements(selenium_webdriver_1.By.className('shadow-root-host'));
+        const shadowRootHost = await ed.getEnclosingElement().findElements(TextEditor.locators.TextEditor.shadowRootHost);
         if (shadowRootHost.length > 0) {
             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(selenium_webdriver_1.By.className('monaco-menu-container'))).wait();
+                return new __1.ContextMenu(await shadowRoot.findElement(TextEditor.locators.TextEditor.monacoMenuContainer)).wait();
             }
             else {
                 shadowRoot = (await this.getDriver().executeScript('return arguments[0].shadowRoot', shadowRootHost[0]));
@@ -743,15 +743,13 @@ class FindWidget extends AbstractElement_1.AbstractElement {
      * Click 'Next match'
      */
     async nextMatch() {
-        const name = TextEditor.versionInfo.version < '1.59.0' ? 'Next match' : 'Next Match';
-        await this.clickButton(name, 'find');
+        await this.clickButton(FindWidget.locators.FindWidget.nextMatch, 'find');
     }
     /**
      * Click 'Previous match'
      */
     async previousMatch() {
-        const name = TextEditor.versionInfo.version < '1.59.0' ? 'Previous match' : 'Previous Match';
-        await this.clickButton(name, 'find');
+        await this.clickButton(FindWidget.locators.FindWidget.previousMatch, 'find');
     }
     /**
      * Click 'Replace'. Only works in replace mode.
@@ -769,7 +767,7 @@ class FindWidget extends AbstractElement_1.AbstractElement {
      * Close the widget.
      */
     async close() {
-        const part = TextEditor.versionInfo.version >= '1,80.0' ? 'close' : 'find';
+        const part = TextEditor.versionInfo.version >= '1.80.0' ? 'close' : 'find';
         await this.clickButton('Close', part);
     }
     /**

package/out/components/sidebar/ViewSection.js

@@ -133,14 +133,14 @@ class ViewSection extends AbstractElement_1.AbstractElement {
         const btn = new (class extends ElementWithContextMenu_1.ElementWithContextMenu {
             async openContextMenu() {
                 await this.click();
-                const shadowRootHost = await section.findElements(selenium_webdriver_1.By.className('shadow-root-host'));
+                const shadowRootHost = await section.findElements(ViewSection.locators.ViewSection.shadowRootHost);
                 if (shadowRootHost.length > 0) {
                     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(selenium_webdriver_1.By.className('monaco-menu-container'))).wait();
+                        return new __1.ContextMenu(await shadowRoot.findElement(ViewSection.locators.ViewSection.monacoMenuContainer)).wait();
                     }
                     else {
                         shadowRoot = (await this.getDriver().executeScript('return arguments[0].shadowRoot', shadowRootHost[0]));

package/out/components/sidebar/scm/NewScmView.js

@@ -62,7 +62,7 @@ class SingleScmProvider extends ScmView_1.ScmProvider {
         let names = [];
         const buttons = [];
         if (ScmView_1.ScmProvider.versionInfo.version >= '1.93.0') {
-            const header = await view.findElement(selenium_webdriver_1.By.xpath(`.//div[@aria-label='Source Control Section']`));
+            const header = await view.findElement(ScmView_1.ScmView.locators.ScmView.sourceControlSection);
             actions = await header.findElements(ScmView_1.ScmProvider.locators.ScmView.action);
             names = await Promise.all(actions.map(async (action) => await action.getAttribute(ScmView_1.ScmProvider.locators.ScmView.actionLabel)));
         }

package/out/components/sidebar/scm/ScmView.js

@@ -257,7 +257,7 @@ class MoreAction extends ElementWithContextMenu_1.ElementWithContextMenu {
     }
     async openContextMenu() {
         await this.click();
-        const shadowRootHost = await this.enclosingItem.findElements(selenium_webdriver_1.By.className('shadow-root-host'));
+        const shadowRootHost = await this.enclosingItem.findElements(ScmView.locators.ScmView.shadowRootHost);
         const actions = this.getDriver().actions();
         await actions.clear();
         await actions.sendKeys(selenium_webdriver_1.Key.ESCAPE).perform();
@@ -272,7 +272,7 @@ class MoreAction extends ElementWithContextMenu_1.ElementWithContextMenu {
             const chromiumVersion = webdriverCapabilities.getBrowserVersion();
             if (chromiumVersion && parseInt(chromiumVersion.split('.')[0]) >= 96) {
                 shadowRoot = await shadowRootHost[0].getShadowRoot();
-                return new __1.ContextMenu(await shadowRoot.findElement(selenium_webdriver_1.By.className('monaco-menu-container'))).wait();
+                return new __1.ContextMenu(await shadowRoot.findElement(ScmView.locators.ScmView.monacoMenuContainer)).wait();
             }
             else {
                 shadowRoot = (await this.getDriver().executeScript('return arguments[0].shadowRoot', shadowRootHost[0]));

package/out/components/statusBar/StatusBar.js

@@ -168,7 +168,7 @@ class StatusBar extends AbstractElement_1.AbstractElement {
         }
     }
     async getPartText(locator) {
-        return await this.findElement(locator).findElement(selenium_webdriver_1.By.css('a')).getAttribute('innerHTML');
+        return await this.findElement(locator).findElement(StatusBar.locators.StatusBar.aTag).getAttribute('innerHTML');
     }
 }
 exports.StatusBar = StatusBar;

package/out/components/workbench/input/Input.d.ts

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 import { AbstractElement } from '../../AbstractElement';
+import { WebElement } from 'selenium-webdriver';
 /**
  * Abstract page object for input fields
  */
@@ -125,4 +126,25 @@ export declare class QuickPickItem extends AbstractElement {
      * @returns Promise resolving to true/false.
      */
     isSelected(): Promise<boolean>;
+    /**
+     * Retrieve the actions on QuickPickItem.
+     * @returns Promise resolving to array of QuickInputAction objects.
+     */
+    getActions(): Promise<QuickInputAction[]>;
+    /**
+     * Retrieve the specific action on QuickPickItem.
+     * @param label Name of QuickPickItem.
+     * @returns Promise resolving QuickInputAction if item exists or undefined.
+     */
+    getAction(label: string): Promise<QuickInputAction | undefined>;
+}
+/**
+ * Action bound to a QuickPickItem.
+ */
+export declare class QuickInputAction extends AbstractElement {
+    constructor(element: WebElement, viewPart: QuickPickItem);
+    /**
+     * Get label of the action button.
+     */
+    getLabel(): Promise<string>;
 }

package/out/components/workbench/input/Input.js

@@ -16,7 +16,7 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.QuickPickItem = exports.Input = void 0;
+exports.QuickInputAction = exports.QuickPickItem = exports.Input = void 0;
 const AbstractElement_1 = require("../../AbstractElement");
 const selenium_webdriver_1 = require("selenium-webdriver");
 const __1 = require("../../..");
@@ -264,6 +264,50 @@ class QuickPickItem extends AbstractElement_1.AbstractElement {
         }
         return false;
     }
+    /**
+     * Retrieve the actions on QuickPickItem.
+     * @returns Promise resolving to array of QuickInputAction objects.
+     */
+    async getActions() {
+        const actions = [];
+        const elements = await this.findElements(Input.locators.Input.button);
+        for (const element of elements) {
+            actions.push(await new QuickInputAction(element, this).wait());
+        }
+        return actions;
+    }
+    /**
+     * Retrieve the specific action on QuickPickItem.
+     * @param label Name of QuickPickItem.
+     * @returns Promise resolving QuickInputAction if item exists or undefined.
+     */
+    async getAction(label) {
+        const actions = await this.getActions();
+        for (const action of actions) {
+            if ((await action.getLabel()) === label) {
+                return action;
+            }
+        }
+    }
 }
 exports.QuickPickItem = QuickPickItem;
+/**
+ * Action bound to a QuickPickItem.
+ */
+class QuickInputAction extends AbstractElement_1.AbstractElement {
+    constructor(element, viewPart) {
+        super(element, viewPart);
+    }
+    /**
+     * Get label of the action button.
+     */
+    async getLabel() {
+        const value = await this.getAttribute(Input.locators.ViewSection.buttonLabel);
+        if (value === null) {
+            throw new __1.NullAttributeError(`${this.constructor.name}.getLabel returned null`);
+        }
+        return value;
+    }
+}
+exports.QuickInputAction = QuickInputAction;
 //# sourceMappingURL=Input.js.map

package/out/locators/locators.d.ts

@@ -26,6 +26,7 @@ export interface Locators {
     AbstractElement: {
         enabled: WebElementFunction<WebElement, boolean>;
         selected: WebElementFunction<WebElement, boolean>;
+        tag: By;
     };
     ActivityBar: {
         constructor: By;
@@ -56,6 +57,7 @@ export interface Locators {
         globalActions: By;
         action: (label: string) => By;
         closeAction: By;
+        openTabElement: (title: string) => By;
     };
     BottomBarViews: {
         actionsContainer: (label: string) => By;
@@ -144,6 +146,13 @@ export interface Locators {
         debugHint: By;
         selection: By;
         findWidget: By;
+        shadowRootHost: By;
+        monacoMenuContainer: By;
+        glyphMarginWidget: By;
+        lineElement: (styleTopAttr: string) => By;
+        contentWidgets: By;
+        contentWidgetsElements: By;
+        elementLevelBack: By;
     };
     FindWidget: {
         toggleReplace: By;
@@ -154,6 +163,8 @@ export interface Locators {
         content: By;
         button: (title: string) => By;
         checkbox: (title: string) => By;
+        nextMatch: string;
+        previousMatch: string;
     };
     ContentAssist: {
         constructor: By;
@@ -194,6 +205,7 @@ export interface Locators {
         arraySettingItem: {
             btnConstructor: (label: string) => By;
         };
+        button: By;
     };
     DiffEditor: {
         originalEditor: By;
@@ -226,6 +238,10 @@ export interface Locators {
         moreInfo: By;
         moreInfoElements: By;
     };
+    EditorAction: {
+        shadowRootHost: By;
+        monacoMenuContainer: By;
+    };
     ContextMenu: {
         contextView: By;
         constructor: By;
@@ -279,6 +295,8 @@ export interface Locators {
         level: string;
         index: string;
         welcomeContent: By;
+        shadowRootHost: By;
+        monacoMenuContainer: By;
     };
     TreeItem: {
         actions: By;
@@ -419,6 +437,9 @@ export interface Locators {
         multiProviderItem: By;
         itemLevel: (level: number) => By;
         itemIndex: (index: number) => By;
+        shadowRootHost: By;
+        monacoMenuContainer: By;
+        sourceControlSection: By;
     };
     DebugView: {
         launchCombo: By;
@@ -442,6 +463,7 @@ export interface Locators {
         bell: By;
         item: By;
         itemTitle: string;
+        aTag: By;
     };
     Workbench: {
         constructor: By;
@@ -484,6 +506,8 @@ export interface Locators {
         title: By;
         backButton: By;
         multiSelectIndex: (index: number) => By;
+        button: By;
+        buttonLabel: string;
     };
     InputBox: {
         constructor: By;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redhat-developer/page-objects",
-  "version": "1.7.0",
+  "version": "1.8.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.2.0",
-    "type-fest": "^4.26.1"
+    "type-fest": "^4.27.0"
   },
   "peerDependencies": {
     "selenium-webdriver": ">=4.6.1",
     "typescript": ">=4.6.2"
   },
-  "gitHead": "f45222ba83c369def4e95fefaa1ceba5a96e181e"
+  "gitHead": "6e684d06e92ee59f19e28f96158f8798045114c3"
 }