@redhat-developer/page-objects 1.9.0 → 1.10.0

package/out/components/activityBar/ViewControl.js

@@ -20,6 +20,7 @@ exports.ViewControl = void 0;
 const __1 = require("../..");
 const ElementWithContextMenu_1 = require("../ElementWithContextMenu");
 const NewScmView_1 = require("../sidebar/scm/NewScmView");
+const compare_versions_1 = require("compare-versions");
 /**
  * Page object representing a view container item in the activity bar
  */
@@ -40,7 +41,7 @@ class ViewControl extends ElementWithContextMenu_1.ElementWithContextMenu {
         }
         const view = await new __1.SideBarView().wait();
         if ((await view.findElements(ViewControl.locators.ViewControl.scmId)).length > 0) {
-            if (ViewControl.versionInfo.browser === 'vscode' && ViewControl.versionInfo.version >= '1.47.0') {
+            if (ViewControl.versionInfo.browser === 'vscode' && (0, compare_versions_1.satisfies)(ViewControl.versionInfo.version, '>=1.47.0')) {
                 return new NewScmView_1.NewScmView().wait();
             }
             return new __1.ScmView().wait();

package/out/components/bottomBar/AbstractViews.js

@@ -19,6 +19,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.TextView = exports.ChannelView = void 0;
 const selenium_webdriver_1 = require("selenium-webdriver");
 const ElementWithContextMenu_1 = require("../ElementWithContextMenu");
+const compare_versions_1 = require("compare-versions");
 /**
  * View with channel selector
  */
@@ -45,7 +46,7 @@ class ChannelView extends ElementWithContextMenu_1.ElementWithContextMenu {
      * @deprecated For VS Code 1.88+ this method won't be working any more
      */
     async getCurrentChannel() {
-        if (ChannelView.versionInfo.version >= '1.87.0' && process.platform !== 'darwin') {
+        if ((0, compare_versions_1.compareVersions)(ChannelView.versionInfo.version, '1.87.0') >= 0 && process.platform !== 'darwin') {
             throw Error(`DEPRECATED METHOD! The 'ChannelView.getCurrentChannel' method is broken! Read more information in 'Known Issues > Limitations in testing with VS Code 1.87+' - https://github.com/microsoft/vscode/issues/206897.`);
         }
         const combo = await this.enclosingItem.findElement(ChannelView.locators.BottomBarViews.channelCombo);

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

@@ -57,7 +57,13 @@ export declare class BottomBarPanel extends AbstractElement {
      * @returns Promise resolving when the restore button is pressed
      */
     restore(): Promise<void>;
-    private openTab;
+    /**
+     * Opens (or focuses) a tab in the bottom bar panel by its title.
+     *
+     * @param title The exact name of the tab to be opened or focused.
+     * @returns A promise that resolves when the tab is opened or focused.
+     */
+    openTab(title: string): Promise<void>;
     private resize;
     closePanel(): Promise<void>;
 }

package/out/components/bottomBar/BottomBarPanel.js

@@ -99,6 +99,12 @@ class BottomBarPanel extends AbstractElement_1.AbstractElement {
     async restore() {
         await this.resize(BottomBarPanel.locators.BottomBarPanel.restore);
     }
+    /**
+     * Opens (or focuses) a tab in the bottom bar panel by its title.
+     *
+     * @param title The exact name of the tab to be opened or focused.
+     * @returns A promise that resolves when the tab is opened or focused.
+     */
     async openTab(title) {
         await this.toggle(true);
         const tabContainer = await this.findElement(BottomBarPanel.locators.BottomBarPanel.tabContainer);

package/out/components/editor/SettingsEditor.js

@@ -21,11 +21,12 @@ const Editor_1 = require("./Editor");
 const selenium_webdriver_1 = require("selenium-webdriver");
 const AbstractElement_1 = require("../AbstractElement");
 const __1 = require("../..");
+const compare_versions_1 = require("compare-versions");
 /**
  * Page object representing the internal VS Code settings editor
  */
 class SettingsEditor extends Editor_1.Editor {
-    divider = SettingsEditor.versionInfo.version >= '1.83.0' ? '›' : ' › ';
+    divider = (0, compare_versions_1.satisfies)(SettingsEditor.versionInfo.version, '>=1.83.0') ? '›' : ' › ';
     constructor(view = new __1.EditorView()) {
         super(view);
     }

package/out/components/editor/TextEditor.js

@@ -25,6 +25,7 @@ const Editor_1 = require("./Editor");
 const ElementWithContextMenu_1 = require("../ElementWithContextMenu");
 const AbstractElement_1 = require("../AbstractElement");
 const Breakpoint_1 = require("./Breakpoint");
+const compare_versions_1 = require("compare-versions");
 class BreakpointError extends Error {
 }
 exports.BreakpointError = BreakpointError;
@@ -524,7 +525,9 @@ 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(TextEditor.locators.TextEditor.glyphMarginWidget) : lineOverlay;
+        const breakpointContainer = (0, compare_versions_1.satisfies)(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 +552,9 @@ 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(TextEditor.locators.TextEditor.glyphMarginWidget) : this;
+        const breakpointContainer = (0, compare_versions_1.satisfies)(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;
@@ -559,7 +564,7 @@ class TextEditor extends Editor_1.Editor {
         }
         // get parent
         let lineElement;
-        if (TextEditor.versionInfo.version >= '1.80.0') {
+        if ((0, compare_versions_1.satisfies)(TextEditor.versionInfo.version, '>=1.80.0')) {
             const styleTopAttr = await breakpoints[0].getCssValue('top');
             lineElement = await this.findElement(TextEditor.locators.TextEditor.marginArea).findElement(TextEditor.locators.TextEditor.lineElement(styleTopAttr));
         }
@@ -589,11 +594,13 @@ 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(TextEditor.locators.TextEditor.glyphMarginWidget) : this;
+        const breakpointContainer = (0, compare_versions_1.satisfies)(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') {
+            if ((0, compare_versions_1.satisfies)(TextEditor.versionInfo.version, '>=1.80.0')) {
                 const styleTopAttr = await breakpointSelector.getCssValue('top');
                 lineElement = await this.findElement(TextEditor.locators.TextEditor.marginArea).findElement(TextEditor.locators.TextEditor.lineElement(styleTopAttr));
             }
@@ -767,7 +774,7 @@ class FindWidget extends AbstractElement_1.AbstractElement {
      * Close the widget.
      */
     async close() {
-        const part = TextEditor.versionInfo.version >= '1.80.0' ? 'close' : 'find';
+        const part = (0, compare_versions_1.satisfies)(TextEditor.versionInfo.version, '>=1.80.0') ? 'close' : 'find';
         await this.clickButton('Close', part);
     }
     /**

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

@@ -34,12 +34,12 @@ export declare abstract class ViewSection extends AbstractElement {
      * Expand the section if collapsed
      * @returns Promise resolving when the section is expanded
      */
-    expand(): Promise<void>;
+    expand(timeout?: number): Promise<void>;
     /**
      * Collapse the section if expanded
      * @returns Promise resolving when the section is collapsed
      */
-    collapse(): Promise<void>;
+    collapse(timeout?: number): Promise<void>;
     /**
      * Finds whether the section is expanded
      * @returns Promise resolving to true/false

package/out/components/sidebar/ViewSection.js

@@ -40,28 +40,30 @@ class ViewSection extends AbstractElement_1.AbstractElement {
      * Expand the section if collapsed
      * @returns Promise resolving when the section is expanded
      */
-    async expand() {
+    async expand(timeout = 1_000) {
         if (await this.isHeaderHidden()) {
             return;
         }
         if (!(await this.isExpanded())) {
-            const panel = await this.findElement(ViewSection.locators.ViewSection.header);
-            await panel.click();
-            await this.getDriver().wait((0, __1.waitForAttributeValue)(panel, ViewSection.locators.ViewSection.headerExpanded, 'true'), 1000);
+            const header = await this.findElement(ViewSection.locators.ViewSection.header);
+            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);
         }
     }
     /**
      * Collapse the section if expanded
      * @returns Promise resolving when the section is collapsed
      */
-    async collapse() {
+    async collapse(timeout = 1_000) {
         if (await this.isHeaderHidden()) {
             return;
         }
         if (await this.isExpanded()) {
-            const panel = await this.findElement(ViewSection.locators.ViewSection.header);
-            await panel.click();
-            await this.getDriver().wait((0, __1.waitForAttributeValue)(panel, ViewSection.locators.ViewSection.headerExpanded, 'false'), 1000);
+            const header = await this.findElement(ViewSection.locators.ViewSection.header);
+            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);
         }
     }
     /**

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

@@ -46,13 +46,19 @@ export declare class WelcomeContentButton extends AbstractElement {
 export declare class WelcomeContentSection extends AbstractElement {
     /**
      * @param panel  The panel containing the welcome content.
-     * @param parent  The webelement in which the welcome content is embedded.
+     * @param parent  The webElement in which the welcome content is embedded.
      */
     constructor(panel: WebElement, parent: ViewSection);
     /**
      * Combination of [[getButtons]] and [[getTextSections]]: returns all entries in the welcome view in the order that they appear.
      */
     getContents(): Promise<(WelcomeContentButton | string)[]>;
+    /**
+     * Returns a specific button from the welcome view that matches the given title.
+     * @param title The title of the button to search for.
+     * @returns A `WelcomeContentButton` if found, otherwise `undefined`.
+     */
+    getButton(title: string): Promise<WelcomeContentButton | undefined>;
     /** Finds all buttons in the welcome content */
     getButtons(): Promise<WelcomeContentButton[]>;
     /**

package/out/components/sidebar/WelcomeContent.js

@@ -52,7 +52,7 @@ exports.WelcomeContentButton = WelcomeContentButton;
 class WelcomeContentSection extends AbstractElement_1.AbstractElement {
     /**
      * @param panel  The panel containing the welcome content.
-     * @param parent  The webelement in which the welcome content is embedded.
+     * @param parent  The webElement in which the welcome content is embedded.
      */
     constructor(panel, parent) {
         super(panel, parent);
@@ -72,6 +72,20 @@ class WelcomeContentSection extends AbstractElement_1.AbstractElement {
             }
         }));
     }
+    /**
+     * Returns a specific button from the welcome view that matches the given title.
+     * @param title The title of the button to search for.
+     * @returns A `WelcomeContentButton` if found, otherwise `undefined`.
+     */
+    async getButton(title) {
+        const buttons = await this.getButtons();
+        for (const btn of buttons) {
+            if ((await btn.getTitle()) === title) {
+                return btn;
+            }
+        }
+        return undefined;
+    }
     /** Finds all buttons in the welcome content */
     async getButtons() {
         return (await this.findElements(WelcomeContentSection.locators.WelcomeContent.button)).map((elem) => new WelcomeContentButton(elem, this));

package/out/components/sidebar/debug/DebugView.js

@@ -17,6 +17,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DebugView = void 0;
+const compare_versions_1 = require("compare-versions");
 const SideBarView_1 = require("../SideBarView");
 const DebugBreakpointSection_1 = require("../tree/debug/DebugBreakpointSection");
 const DebugCallStackSection_1 = require("../tree/debug/DebugCallStackSection");
@@ -32,7 +33,7 @@ class DebugView extends SideBarView_1.SideBarView {
      * @deprecated For VS Code 1.88+ this method won't be working any more
      */
     async getLaunchConfiguration() {
-        if (DebugView.versionInfo.version >= '1.87.0' && process.platform !== 'darwin') {
+        if ((0, compare_versions_1.satisfies)(DebugView.versionInfo.version, '>=1.87.0') && process.platform !== 'darwin') {
             throw Error(`DEPRECATED METHOD! The 'DebugView.getLaunchConfiguration' method is broken! Read more information in 'Known Issues > Limitations in testing with VS Code 1.87+' - https://github.com/microsoft/vscode/issues/206897.`);
         }
         const action = await this.getTitlePart().findElement(DebugView.locators.DebugView.launchCombo);

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

@@ -21,6 +21,7 @@ const ScmView_1 = require("./ScmView");
 const selenium_webdriver_1 = require("selenium-webdriver");
 const ElementWithContextMenu_1 = require("../../ElementWithContextMenu");
 const ViewTitlePart_1 = require("../ViewTitlePart");
+const compare_versions_1 = require("compare-versions");
 /**
  * New SCM view for code 1.47 onwards
  */
@@ -61,7 +62,7 @@ class SingleScmProvider extends ScmView_1.ScmProvider {
         let actions = [];
         let names = [];
         const buttons = [];
-        if (ScmView_1.ScmProvider.versionInfo.version >= '1.93.0') {
+        if ((0, compare_versions_1.satisfies)(ScmView_1.ScmProvider.versionInfo.version, '>=1.93.0')) {
             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)));
@@ -77,7 +78,7 @@ class SingleScmProvider extends ScmView_1.ScmProvider {
         }
         const index = names.findIndex((item) => item === title);
         if (index > -1) {
-            if (ScmView_1.ScmProvider.versionInfo.version >= '1.93.0') {
+            if ((0, compare_versions_1.satisfies)(ScmView_1.ScmProvider.versionInfo.version, '>=1.93.0')) {
                 await actions[index].click();
             }
             else {

package/out/components/sidebar/tree/debug/VariableSectionItem.js

@@ -19,6 +19,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.VariableSectionItem = void 0;
 const selenium_webdriver_1 = require("selenium-webdriver");
 const CustomTreeItem_1 = require("../custom/CustomTreeItem");
+const compare_versions_1 = require("compare-versions");
 class VariableSectionItem extends CustomTreeItem_1.CustomTreeItem {
     constructor(element, viewPart) {
         super(element, viewPart);
@@ -45,7 +46,7 @@ class VariableSectionItem extends CustomTreeItem_1.CustomTreeItem {
      * @deprecated For VS Code 1.88+ this method won't be working any more
      */
     async getVariableNameTooltip() {
-        if (VariableSectionItem.versionInfo.version >= '1.88.0') {
+        if ((0, compare_versions_1.satisfies)(VariableSectionItem.versionInfo.version, '>=1.88.0')) {
             throw Error(`DEPRECATED METHOD! For VS Code 1.88+ this method won't be working any more.`);
         }
         const name = await this.findElement(VariableSectionItem.locators.VariableSectionItem.name.constructor);
@@ -57,7 +58,7 @@ class VariableSectionItem extends CustomTreeItem_1.CustomTreeItem {
      * @deprecated For VS Code 1.89+ this method won't be working any more
      */
     async getVariableValueTooltip() {
-        if (VariableSectionItem.versionInfo.version >= '1.89.0') {
+        if ((0, compare_versions_1.satisfies)(VariableSectionItem.versionInfo.version, '>=1.89.0')) {
             throw Error(`DEPRECATED METHOD! For VS Code 1.89+ this method won't be working any more.`);
         }
         const value = await this.findElement(VariableSectionItem.locators.VariableSectionItem.value.constructor);

package/out/components/workbench/Notification.js

@@ -20,6 +20,7 @@ exports.CenterNotification = exports.StandaloneNotification = exports.Notificati
 const ElementWithContextMenu_1 = require("../ElementWithContextMenu");
 const AbstractElement_1 = require("../AbstractElement");
 const selenium_webdriver_1 = require("selenium-webdriver");
+const compare_versions_1 = require("compare-versions");
 /**
  * Available types of notifications
  */
@@ -63,7 +64,7 @@ class Notification extends ElementWithContextMenu_1.ElementWithContextMenu {
      * @deprecated For VS Code 1.88+ this method won't be working any more
      */
     async getSource() {
-        if (Notification.versionInfo.version >= '1.88.0') {
+        if ((0, compare_versions_1.satisfies)(Notification.versionInfo.version, '>=1.88.0')) {
             throw Error(`DEPRECATED METHOD! For VS Code 1.88+ this method won't be working any more.`);
         }
         await this.expand();

package/out/components/workbench/Workbench.js

@@ -29,6 +29,7 @@ const Notification_1 = require("./Notification");
 const QuickOpenBox_1 = require("./input/QuickOpenBox");
 const SettingsEditor_1 = require("../editor/SettingsEditor");
 const InputBox_1 = require("./input/InputBox");
+const compare_versions_1 = require("compare-versions");
 /**
  * Handler for general workbench related actions
  */
@@ -125,7 +126,7 @@ class Workbench extends AbstractElement_1.AbstractElement {
         }
         const driver = this.getDriver();
         await driver.actions().keyDown(Workbench.ctlKey).keyDown(selenium_webdriver_1.Key.SHIFT).sendKeys('p').perform();
-        if (Workbench.versionInfo.version >= '1.44.0') {
+        if ((0, compare_versions_1.satisfies)(Workbench.versionInfo.version, '>=1.44.0')) {
             return await InputBox_1.InputBox.create();
         }
         return await QuickOpenBox_1.QuickOpenBox.create();

package/out/locators/locators.d.ts

@@ -288,6 +288,7 @@ export interface Locators {
         titleText: string;
         header: By;
         headerExpanded: string;
+        headerCollapseExpandButton: By;
         actions: By;
         actionConstructor: (label: string) => By;
         button: By;

package/package.json

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