d5-testing-library 1.8.0-alpha.9 → 1.8.0

package/dist/{d5-testing-library.d.ts → d5-testing-library.d.mts}

@@ -1,5 +1,5 @@
 import * as selenium_webdriver from 'selenium-webdriver';
-import { WebDriver, Browser, WebElement, By, Condition } from 'selenium-webdriver';
+import { Browser, WebDriver, WebElement, By, Condition } from 'selenium-webdriver';
 
 type DriverType = typeof Browser;
 type BrowserList = DriverType[keyof DriverType];
@@ -11,14 +11,14 @@ type IConfig = {
     };
     timeout: number;
     browser: BrowserList;
-    driver?: WebDriver;
+    headless?: 'true' | 'false';
 };
 declare function config(cfg?: IConfig): IConfig;
 
 declare abstract class AbstractElement {
     driver: WebDriver;
     protected elementCssSelector: string;
-    protected constructor(driver?: WebDriver, elementCssSelector?: string);
+    protected constructor(driver: WebDriver, elementCssSelector?: string);
     protected getFullCssSelector(): string;
     protected joinRelativeCssSelectors(selectors: string[]): string;
     getElement(): Promise<WebElement>;
@@ -30,7 +30,7 @@ declare abstract class AbstractElement {
 declare abstract class AbstractPage extends AbstractElement {
     protected url: string;
     protected host: string;
-    constructor(driver?: WebDriver);
+    constructor(driver: WebDriver);
     private prependHash;
     protected goToUrl(url: string): Promise<void>;
     protected get path(): string;
@@ -39,9 +39,9 @@ declare abstract class AbstractPage extends AbstractElement {
 }
 
 declare class LoginPage extends AbstractPage {
-    usernameField: selenium_webdriver.By;
-    passwordField: selenium_webdriver.By;
-    loginButton: selenium_webdriver.By;
+    usernameField: By;
+    passwordField: By;
+    loginButton: By;
     locate(): Promise<void>;
     get path(): string;
     enterUsername(username: string): Promise<void>;
@@ -74,40 +74,45 @@ declare const createDriver: (browser?: BrowserList) => Promise<WebDriver>;
 
 declare const elementIsNotPresent: (locator: By) => Condition<boolean>;
 
-interface WaitElementIsVisibleParams {
+type WithElement$1 = {
     element: WebElement;
+};
+type WithBy$1 = {
+    by: By;
+};
+type Args$1 = {
     timeout?: number;
     errorMessage?: string;
-    driver?: WebDriver;
-}
-/**
- * Waits until a specified web element is visible within a given timeout.
- *
- * @param {WaitElementIsVisibleParams} params - The parameters for the wait function.
- * @param {WebElement} params.element - The web element to wait for visibility.
- * @param {number} [params.timeout] - The maximum time to wait for the element to be visible, in milliseconds. If not provided, the default timeout is used.
- * @param {string} [params.errorMessage] - The error message to display if the wait times out. If not provided, a default error message is used.
- * @param {WebDriver} [params.driver] - The web driver instance to use. If not provided, the default driver from the configuration is used.
- * @returns {Promise<void>} A promise that resolves when the element becomes visible.
- */
-declare function waitElementIsVisible({ element, timeout, errorMessage, driver }: WaitElementIsVisibleParams): Promise<void>;
+    driver: WebDriver;
+};
+type ArgsWithElement$1 = Args$1 & WithElement$1;
+type ArgsWithWithBy$1 = Args$1 & WithBy$1;
+declare function waitElementIsVisible(args: ArgsWithElement$1): Promise<void>;
+declare function waitElementIsVisible(args: ArgsWithWithBy$1): Promise<void>;
+
+type WithElement = {
+    element: WebElement;
+};
+type WithBy = {
+    by: By;
+};
+type Args = {
+    timeout?: number;
+    errorMessage?: string;
+    driver: WebDriver;
+};
+type ArgsWithElement = Args & WithElement;
+type ArgsWithWithBy = Args & WithBy;
+declare function waitElementIsClickable(args: ArgsWithElement): Promise<void>;
+declare function waitElementIsClickable(args: ArgsWithWithBy): Promise<void>;
 
 interface WaiteParams {
-    condition: (driver?: WebDriver) => Promise<boolean>;
+    condition: (driver: WebDriver) => Promise<boolean>;
     timeout?: number;
     errorMessage?: string;
-    driver?: WebDriver;
+    driver: WebDriver;
 }
-/**
- * Waits until a specified web element is visible within a given timeout.
- *
- * @param  condition
- * @param {number} [timeout] - The maximum time to wait for the element to be visible, in milliseconds. If not provided, the default timeout is used.
- * @param {string} [errorMessage] - The error message to display if the wait times out. If not provided, a default error message is used.
- * @param {WebDriver} [driver] - The web driver instance to use. If not provided, the default driver from the configuration is used.
- * @returns {Promise<void>} A promise that resolves when the element becomes visible.
- */
-declare function wait(condition: WaiteParams['condition'], driver?: WebDriver, errorMessage?: string, timeout?: number): Promise<void>;
+declare function safeWait(condition: WaiteParams['condition'], driver: WebDriver, errorMessage?: string, timeout?: number): Promise<void>;
 
 declare function signIn(driver?: WebDriver): Promise<WebDriver>;
 
@@ -118,7 +123,8 @@ declare function signIn(driver?: WebDriver): Promise<WebDriver>;
  * @param {WebDriver} [driver] - The web driver instance to use. If not provided, the default driver from the configuration is used.
  * @returns {Promise<void>} A promise that resolves when the click action is complete.
  */
-declare const click: (webElement: WebElement, driver?: WebDriver) => Promise<void>;
+declare const click: (webElement: WebElement, driver: WebDriver) => Promise<void>;
+declare const contextMenu: (webElement: WebElement, driver: WebDriver) => Promise<void>;
 
 interface Editor {
     setValue(value: any): Promise<void>;
@@ -148,7 +154,7 @@ interface ClearStrategy {
 
 declare abstract class AbstractElementWithParent extends AbstractElement {
     protected parentCssSelector: string;
-    constructor(parentCssSelector: string, elementCssSelector: string, driver?: WebDriver);
+    constructor(parentCssSelector: string, elementCssSelector: string, driver: WebDriver);
     protected getFullCssSelector(): string;
     isReadonly(): Promise<boolean>;
 }
@@ -166,13 +172,13 @@ declare abstract class AbstractDXEditorWithInput extends AbstractElementWithPare
 }
 
 declare class TextEditor extends AbstractDXEditorWithInput {
-    constructor(parentCssSelector: string, elementCssSelector: string, driver?: WebDriver);
-    getValue(): Promise<string>;
+    constructor(parentCssSelector: string, elementCssSelector: string, driver: WebDriver);
+    getValue(): Promise<string | null>;
     setValue(value: string): Promise<void>;
 }
 
 declare class NumberEditor extends AbstractDXEditorWithInput {
-    constructor(parentCssSelector: string, elementCssSelector: string, driver?: WebDriver);
+    constructor(parentCssSelector: string, elementCssSelector: string, driver: WebDriver);
     getValue(): Promise<number | null>;
     setValue(value: any): Promise<void>;
 }
@@ -180,7 +186,7 @@ declare class NumberEditor extends AbstractDXEditorWithInput {
 declare const editorFactory: (parentCssSelector: string, elementCssSelector: string, driver: WebDriver) => Promise<Editor>;
 
 interface ISubsystemItem {
-    driver?: WebDriver;
+    driver: WebDriver;
     bySelector: By;
 }
 declare class SubsystemItem {
@@ -194,7 +200,7 @@ declare class SubsystemItem {
 
 declare class SubsystemsPanel extends AbstractElement {
     private header;
-    constructor(driver?: WebDriver);
+    constructor(driver: WebDriver);
     headerTitle(): Promise<string>;
     protected getSearchComponent(): TextEditor;
     /**
@@ -243,13 +249,15 @@ interface Button {
     click(): Promise<void>;
     isDisabled(): Promise<boolean>;
     isDisplayed(): Promise<boolean>;
+    getTitle(): Promise<string>;
 }
 declare abstract class AbstractButton extends AbstractElementWithParent implements Button {
-    protected constructor(parentCssSelector: string, elementCssSelector: string, driver?: WebDriver);
+    protected constructor(parentCssSelector: string, elementCssSelector: string, driver: WebDriver);
     protected abstract buttonNotDisplayedError(): string;
     click(): Promise<void>;
     isDisabled(): Promise<boolean>;
     isDisplayed(): Promise<boolean>;
+    abstract getTitle(): Promise<string>;
 }
 
 declare abstract class DXButton extends AbstractButton {
@@ -258,8 +266,9 @@ declare abstract class DXButton extends AbstractButton {
 
 declare class FormButton extends DXButton {
     private readonly name;
-    constructor(parentCssSelector: string, formName: string, name: string, driver?: WebDriver);
+    constructor(parentCssSelector: string, formName: string, name: string, driver: WebDriver);
     protected buttonNotDisplayedError(): string;
+    getTitle(): Promise<string>;
 }
 
 interface Group<TItem = unknown> {
@@ -272,7 +281,7 @@ interface Group<TItem = unknown> {
 
 declare class FormGroup extends AbstractElementWithParent implements Group {
     private groupInstance;
-    constructor(parentCssSelector: string, formName: string, name: string, driver?: WebDriver);
+    constructor(parentCssSelector: string, formName: string, name: string, driver: WebDriver);
     private initInstance;
     /**
      * Возвращает булевое значение доступна ли группа
@@ -329,6 +338,9 @@ declare class AbstractForm extends AbstractPage {
     group(name: string): FormGroup;
 }
 
+interface SubFormOptions {
+    isDockPanel?: boolean;
+}
 declare abstract class Form extends AbstractForm {
     protected popupContainerCssSelector: string;
     protected constructor(driver: WebDriver);
@@ -350,12 +362,12 @@ declare abstract class Form extends AbstractForm {
      * //...
      * expect(await form.subForm(name));
      */
-    subForm(name: string): Promise<unknown>;
+    subForm(name: string, options?: SubFormOptions): Promise<unknown>;
 }
 
 declare class EditorButton extends AbstractElementWithParent {
     private readonly name;
-    constructor(parentCssSelector: string, name: string, driver?: WebDriver);
+    constructor(parentCssSelector: string, name: string, driver: WebDriver);
     protected buttonNotDisplayedError(): string;
     click(): Promise<void>;
     isDisplayed(): Promise<boolean>;
@@ -363,7 +375,7 @@ declare class EditorButton extends AbstractElementWithParent {
 
 declare class AbstractEditor extends AbstractElementWithParent implements Editor {
     protected editor: Editor;
-    constructor(parentCssSelector: string, elementCssSelector: string, driver?: WebDriver);
+    constructor(parentCssSelector: string, elementCssSelector: string, driver: WebDriver);
     protected initEditor(): Promise<void>;
     /**
      * Возвращает значение в поле
@@ -398,6 +410,13 @@ declare class AbstractEditor extends AbstractElementWithParent implements Editor
      * expect(await formEdit.field('TextFld').isReadonly()).toBe(false);
      */
     isReadonly(): Promise<boolean>;
+    /**
+     * Возвращает значение true|false в зависимости isDisplayed поле или нет
+     * @example
+     * expect(await formEdit.field('NumberFld').isDisplayed()).toBe(true);
+     * expect(await formEdit.field('TextFld').isDisplayed()).toBe(false);
+     */
+    isDisplayed(): Promise<boolean>;
     /**
      * Находит кнопку на поле по имени
      * @example
@@ -409,7 +428,7 @@ declare class AbstractEditor extends AbstractElementWithParent implements Editor
 }
 
 declare class FormField extends AbstractEditor {
-    constructor(parentCssSelector: string, formName: string, name: string, driver?: WebDriver);
+    constructor(parentCssSelector: string, formName: string, name: string, driver: WebDriver);
 }
 
 declare class FormEdit extends Form {
@@ -451,13 +470,40 @@ declare class FormEdit extends Form {
     closeButtonClick(): Promise<void>;
 }
 
-declare class ToolbarMenu extends AbstractElementWithParent {
-    private readonly _formName;
-    constructor(parentCssSelector: string, formName: string, name: string, driver?: WebDriver);
-    private openDropdownMenu;
-    private getCssSelectorToButton;
-    private buttonNotDisplayedError;
-    private goToButton;
+declare abstract class AbstractDropDownMenuList extends AbstractElementWithParent {
+    protected abstract getButtonNameBy(name: string): By;
+    protected abstract getButtonTitleBy(name: string): By;
+    protected buttonNotDisplayedError(name: string): string;
+    private clickItemBy;
+    private getElementByPath;
+    clickButton(name: string | string[]): Promise<void>;
+    clickButtonByTitle(title: string | string[]): Promise<void>;
+    getMenuItemElementByTitle(title: string | string[]): Promise<WebElement>;
+    getMenuItemElementByName(name: string | string[]): Promise<WebElement>;
+    isVisible(): Promise<boolean>;
+}
+
+declare abstract class AbstractDropDownMenuButton extends AbstractElementWithParent {
+    private readonly _list;
+    protected constructor(parentCssSelector: string, elementCssSelector: string, list: AbstractDropDownMenuList, driver: WebDriver);
+    protected openDropdownMenu(): Promise<void>;
+    clickButton(name: string | string[]): Promise<void>;
+    clickButtonByTitle(title: string | string[]): Promise<void>;
+    getMenuItemElementByTitle(title: string | string[]): Promise<WebElement>;
+    getMenuItemElementByName(name: string | string[]): Promise<WebElement>;
+}
+
+declare class ToolbarMenu extends AbstractDropDownMenuButton {
+    constructor(parentCssSelector: string, formName: string, name: string, driver: WebDriver);
+    private checkNameValue;
+    private checkTitleValue;
+    private buttonByName;
+    private buttonByTitle;
+    buttonIsDisplayed(name: string | string[]): Promise<boolean>;
+    buttonByTitleIsDisplayed(title: string | string[]): Promise<boolean>;
+    buttonTitle(name: string | string[]): Promise<string>;
+    buttonIsDisabled(name: string | string[]): Promise<boolean>;
+    buttonByTitleIsDisabled(title: string | string[]): Promise<boolean>;
     clickButton(name: string | string[]): Promise<void>;
     clickButtonByTitle(title: string | string[]): Promise<void>;
 }
@@ -466,40 +512,43 @@ declare class ToolbarItem extends AbstractElementWithParent implements Button {
     private _button;
     private readonly _formName;
     private readonly _itemName;
-    constructor(parentCssSelector: string, formName: string, itemName: string, driver?: WebDriver);
+    constructor(parentCssSelector: string, formName: string, itemName: string, driver: WebDriver);
     private init;
     click(): Promise<void>;
     isDisabled(): Promise<boolean>;
     isDisplayed(): Promise<boolean>;
+    getTitle(): Promise<string>;
     get menu(): ToolbarMenu;
 }
 
 declare class Cell extends AbstractElementWithParent {
     private _index;
     private getCellIndex;
-    constructor(parentCssSelector: string, getCellIndex: () => Promise<number>, index?: number, driver?: WebDriver);
+    constructor(parentCssSelector: string, getCellIndex: () => Promise<number>, driver: WebDriver, index?: number);
     private set index(value);
     private getBooleanValue;
     private getTagsValue;
+    private getNumberValue;
+    private getDateValue;
     getElement(): Promise<WebElement>;
-    getValue(): Promise<string | 1 | 0 | string[]>;
+    getValue(): Promise<string | number | 1 | 0 | string[] | Date>;
     getIndex(): number;
 }
 
-interface ConstructorParams {
+interface ConstructorParams$1 {
     parentCssSelector: string;
     headerCssSelector?: string;
     name?: string;
     caption?: string;
     index?: number;
-    driver?: WebDriver;
+    driver: WebDriver;
 }
 declare class Column extends AbstractElementWithParent {
     private _index;
     private _caption;
     private _name;
     protected headerCssSelector: string | undefined;
-    constructor({ parentCssSelector, headerCssSelector, name, caption, index, driver }: ConstructorParams);
+    constructor({ parentCssSelector, headerCssSelector, name, caption, index, driver }: ConstructorParams$1);
     private set index(value);
     private get index();
     getElement(): Promise<WebElement>;
@@ -511,13 +560,20 @@ declare class Column extends AbstractElementWithParent {
 }
 
 declare class Row extends AbstractElementWithParent {
-    index: number;
+    private readonly index;
     protected getColumnBy: (_: {
         title?: string;
         name?: string;
     }) => Column;
     protected fixedTableContentCssSelector: string;
-    constructor(parentCssSelector: string, fixedTableContentCssSelector: string, index: number, driver?: WebDriver, getColumnBy?: (_: {
+    /**
+     * @param parentCssSelector
+     * @param fixedTableContentCssSelector
+     * @param index починається з 0 (в getCssRowByIndexSelector додається +1)
+     * @param driver
+     * @param getColumnBy
+     */
+    constructor(parentCssSelector: string, fixedTableContentCssSelector: string, index: number, driver: WebDriver, getColumnBy?: (_: {
         title?: string;
         name?: string;
     }) => Column);
@@ -536,17 +592,59 @@ declare class Row extends AbstractElementWithParent {
     cancel(): Promise<void>;
 }
 
+declare abstract class DXContextMenuList extends AbstractDropDownMenuList {
+    /**
+     * @param parentCssSelector
+     * @param classNames - Список класів. Починається з крапки
+     * @param driver
+     */
+    protected constructor(parentCssSelector: string, classNames: string, driver: WebDriver);
+    protected getButtonTitleBy(title: string): By;
+    isVisible(): Promise<boolean>;
+}
+
+declare class ContextMenu extends DXContextMenuList {
+    private readonly _formName;
+    private _initFn;
+    constructor(cssClass: string, formName: string, driver: WebDriver);
+    setInit(cb: () => Promise<void>): this;
+    protected getButtonNameBy(name: string): By;
+    clickButtonByTitle(title: string | string[]): Promise<void>;
+    clickButton(name: string | string[]): Promise<void>;
+}
+
+interface ConstructorParams {
+    parentCssSelector: string;
+    headerCssSelector: string;
+    fixedTableContentCssSelector: string;
+    contextMenuCssSelector: string;
+    tableContentCssSelector: string;
+    formName: string;
+    driver: WebDriver;
+}
 declare class Table extends AbstractElementWithParent {
     protected formName: string;
     protected headerCssSelector: string;
+    protected contextMenuCssSelector: string;
     protected fixedTableContentCssSelector: string;
     protected tableContentCssSelector: string;
-    constructor(parentCssSelector: string, headerCssSelector: string, tableContentCssSelector: string, fixedTableContentCssSelector: string, formName: string, driver?: WebDriver);
+    constructor({ parentCssSelector, contextMenuCssSelector, tableContentCssSelector, headerCssSelector, fixedTableContentCssSelector, formName, driver }: ConstructorParams);
     private getColumnBy;
+    /**
+     * Отримати рядок по індексу.
+     * @param index починається з 0
+     */
     getRowByIndex(index: number): Row;
+    /**
+     * @param index починається з 0
+     */
     getColumnByIndex(index: number): Column;
     getColumnByTitle: (title: string) => Column;
     getColumnByName: (name: string) => Column;
+    /**
+     * Вибрати рядок по індексу.
+     * @param index починається з 0
+     */
     selectRowByIndex(index: number): Promise<void>;
     getRows(): Promise<Row[]>;
     getColumns(): Promise<Column[]>;
@@ -559,12 +657,34 @@ declare class Table extends AbstractElementWithParent {
      * expect(await form.field('Name').getValue()).toBe('test value');
      */
     field(name: string): FormField;
+    /**
+     * Возвращает список строк которые выделены
+     * @returns Row[]
+     * @example
+     * const form = new MyForm();
+     * //...
+     * await form.getSelectedRows();
+     */
+    getSelectedRows(): Promise<Row[]>;
+    /**
+     * Вызывает контекстное меню в области с данными.
+     * @param fieldName - имя поля
+     * @param [rowIndex] - индекс строки. Если значение не передано, то по умолчанию контекстное меню будет вызвано на первой выделенной строке.
+     * @throws {Error} Если нет выделенных строк, то выбросит исключение.
+     * @example
+     * const form = new MyForm();
+     * //...
+     * await form.contextMenu('FieldName').clickButton('OpenFormButton');
+     * // or
+     * await form.contextMenu('FieldName', 3).clickButton(['Group', 'ButtonInGroup']);
+     */
+    contextMenu(fieldName: string, rowIndex?: number): ContextMenu;
 }
 
 declare class FormFilterField extends AbstractEditor {
     private readonly formName;
     private readonly name;
-    constructor(parentCssSelector: string, formName: string, name: string, driver?: WebDriver);
+    constructor(parentCssSelector: string, formName: string, name: string, driver: WebDriver);
     /**
      * Возвращает значение в поле
      * @example
@@ -625,7 +745,7 @@ declare class FormFilterField extends AbstractEditor {
 declare class PanelFilterField extends AbstractEditor {
     private readonly formName;
     private readonly name;
-    constructor(parentCssSelector: string, formName: string, name: string, driver?: WebDriver);
+    constructor(parentCssSelector: string, formName: string, name: string, driver: WebDriver);
     /**
      * Возвращает значение в поле
      * @example
@@ -687,7 +807,7 @@ declare class FilterPanel extends AbstractElement {
     private readonly _formName;
     private get filterPanelSelector();
     private filterPanelButtons;
-    constructor(formName: string, driver?: WebDriver);
+    constructor(formName: string, driver: WebDriver);
     /**
      * Возвращает фильтр на панели фильтрации
      * @returns {PanelFilterField}
@@ -702,7 +822,7 @@ declare class FilterPanel extends AbstractElement {
 }
 
 declare class HeaderFilterField extends AbstractEditor {
-    constructor(parentCssSelector: string, formName: string, name: string, driver?: WebDriver);
+    constructor(parentCssSelector: string, formName: string, name: string, driver: WebDriver);
     getValue(): Promise<any>;
     setValue(value: any): Promise<void>;
     clear(): Promise<void>;
@@ -712,7 +832,7 @@ declare class HeaderFilterField extends AbstractEditor {
 interface IFilterOperations {
     parentCssSelector: string;
     filterTestID: string;
-    driver?: WebDriver;
+    driver: WebDriver;
 }
 declare class FilterOperation extends AbstractElementWithParent {
     private readonly _testId;
@@ -728,7 +848,7 @@ declare class ColumnFilter extends AbstractElement {
     private readonly _formName;
     private readonly _name;
     private _column;
-    constructor(formName: string, name: string, column: Column, driver?: WebDriver);
+    constructor(formName: string, name: string, column: Column, driver: WebDriver);
     private getApplyButton;
     private getCancelButton;
     protected apply(): Promise<void>;
@@ -795,6 +915,7 @@ declare class ListForm extends Form {
     protected headerCssSelector: string;
     protected fixedTableContentCssSelector: string;
     protected tableContentCssSelector: string;
+    protected contextMenuCssSelector: string;
     constructor(driver: WebDriver);
     /**
      * Находит таблицу
@@ -850,12 +971,13 @@ declare class ReportForm extends FormEdit {
 
 declare class DialogButton extends AbstractButton implements Button {
     private readonly text;
-    constructor(parentCssSelector: string, text: string, driver?: WebDriver);
+    constructor(parentCssSelector: string, text: string, driver: WebDriver);
     getElement(): Promise<WebElement>;
     protected buttonNotDisplayedError(): string;
+    getTitle(): Promise<string>;
 }
 declare class Dialog extends AbstractElement {
-    constructor(driver?: WebDriver);
+    constructor(driver: WebDriver);
     private get titleSelector();
     private get textSelector();
     private get buttonsSelector();
@@ -864,4 +986,4 @@ declare class Dialog extends AbstractElement {
     button(text: string): DialogButton;
 }
 
-export { AbstractPage, ControlClass, Dialog, Editor, FilterPanel, FormEdit, FormField, FormFilterField, ListForm, LoginPage, NumberEditor, PanelFilterField, ReportForm, SubsystemsPanel, TextEditor, TreeView, byTestId, byTestIdCssSelector, click, config, createDriver, editorFactory, elementIsNotPresent, readonlyLocator, signIn, wait, waitElementIsVisible };
+export { AbstractPage, ControlClass, Dialog, type Editor, FilterPanel, FormEdit, FormField, FormFilterField, ListForm, LoginPage, NumberEditor, PanelFilterField, ReportForm, SubsystemsPanel, TextEditor, TreeView, byTestId, byTestIdCssSelector, click, config, contextMenu, createDriver, editorFactory, elementIsNotPresent, readonlyLocator, signIn, safeWait as wait, waitElementIsClickable, waitElementIsVisible };