d5-testing-library 1.2.0 → 1.3.1

package/dist/d5-testing-library.d.ts

@@ -1,5 +1,5 @@
 import * as selenium_webdriver from 'selenium-webdriver';
-import { WebDriver, Browser, By, Condition, WebElement } from 'selenium-webdriver';
+import { WebDriver, Browser, WebElement, By, Condition } from 'selenium-webdriver';
 
 type DriverType = typeof Browser;
 type BrowserList = DriverType[keyof DriverType];
@@ -17,7 +17,14 @@ declare function config(cfg?: IConfig): IConfig;
 
 declare abstract class AbstractElement {
     driver: WebDriver;
-    protected constructor(driver?: WebDriver);
+    protected elementCssSelector: string;
+    protected constructor(driver?: WebDriver, elementCssSelector?: string);
+    protected getFullCssSelector(): string;
+    protected joinRelativeCssSelectors(selectors: string[]): string;
+    getElement(): Promise<WebElement>;
+    getAttribute(attr: string): Promise<string>;
+    getClasses(): Promise<string>;
+    getDataTestId(): Promise<string>;
 }
 
 declare abstract class AbstractPage extends AbstractElement {
@@ -53,6 +60,7 @@ declare const byTestIdCssSelector: (testId: string, element?: string) => string;
  * @returns {By} - The By locator object.
  */
 declare const byTestId: (testId: string, element?: string) => By;
+declare const readonlyLocator = "readonly";
 
 /**
  * Creates a WebDriver instance for the specified browser.
@@ -146,13 +154,10 @@ declare abstract class AbstractForm extends AbstractPage {
 }
 
 declare abstract class AbstractElementWithParent extends AbstractElement {
-    protected elementCssSelector: string;
     protected parentCssSelector: string;
     constructor(parentCssSelector: string, elementCssSelector: string, driver?: WebDriver);
     protected getFullCssSelector(): string;
-    getElement(): Promise<WebElement>;
-    getAttribute(attr: string): Promise<string>;
-    getClasses(): Promise<string>;
+    isReadonly(): Promise<boolean>;
 }
 
 interface Editor {
@@ -160,10 +165,11 @@ interface Editor {
     getValue(): Promise<any>;
     remove?(itemText: string): Promise<void>;
     clear?(): Promise<void>;
+    isReadonly?(): Promise<boolean>;
 }
 
 interface ClearStrategy {
-    clear(editor: AbstractDXEditorWithInput): Promise<void>;
+    clear(editor: Editor): Promise<void>;
 }
 
 declare abstract class AbstractDXEditorWithInput extends AbstractElementWithParent implements Editor {
@@ -192,10 +198,10 @@ declare class NumberEditor extends AbstractDXEditorWithInput {
 
 declare const editorFactory: (parentCssSelector: string, elementCssSelector: string, driver: WebDriver) => Promise<Editor>;
 
-declare class FormField extends AbstractElementWithParent implements Editor {
-    editor: Editor;
-    constructor(parentCssSelector: string, formName: string, name: string, driver?: WebDriver);
-    private initEditor;
+declare class AbstractEditor extends AbstractElementWithParent implements Editor {
+    protected editor: Editor;
+    constructor(parentCssSelector: string, elementCssSelector: string, driver?: WebDriver);
+    protected initEditor(): Promise<void>;
     /**
      * Возвращает значение в поле
      * @example
@@ -222,6 +228,17 @@ declare class FormField extends AbstractElementWithParent implements Editor {
      * await formEdit.field('TagBox').remove('test');
      */
     remove(itemText: string): Promise<void>;
+    /**
+     * Возвращает значение true|false в зависимости readOnly поле или нет
+     * @example
+     * expect(await formEdit.field('NumberFld').isReadonly()).toBe(true);
+     * expect(await formEdit.field('TextFld').isReadonly()).toBe(false);
+     */
+    isReadonly(): Promise<boolean>;
+}
+
+declare class FormField extends AbstractEditor {
+    constructor(parentCssSelector: string, formName: string, name: string, driver?: WebDriver);
 }
 
 interface Group {
@@ -242,6 +259,7 @@ declare class FormGroup extends AbstractElementWithParent implements Group {
 
 declare abstract class FormEdit extends AbstractForm {
     saveButtonBy: By;
+    closeButtonBy: By;
     protected constructor(driver?: WebDriver);
     /**
      * Находит поле формы редактирования по имени
@@ -275,13 +293,47 @@ declare abstract class FormEdit extends AbstractForm {
      * await formEdit.saveButtonClick();
      */
     saveButtonClick(): Promise<void>;
+    /**
+     * Нажатие на кнопку Закрить
+     * @example
+     * const formEdit = new MyForm();
+     * //...
+     * await formEdit.closeButtonClick();
+     */
+    closeButtonClick(): Promise<void>;
+}
+
+interface Button {
+    click(): Promise<void>;
+    isDisabled(): Promise<boolean>;
+}
+declare abstract class AbstractButton extends AbstractElementWithParent implements Button {
+    protected constructor(parentCssSelector: string, elementCssSelector: string, driver?: WebDriver);
+    protected abstract buttonNotDisplayedError(): string;
+    click(): Promise<void>;
+    isDisabled(): Promise<boolean>;
 }
 
-declare class TableToolbarButton extends AbstractElementWithParent {
-    private readonly name;
-    constructor(parentCssSelector: string, name: string, driver?: WebDriver);
+declare class ToolbarMenu extends AbstractElementWithParent {
+    private readonly _formName;
+    constructor(parentCssSelector: string, formName: string, name: string, driver?: WebDriver);
+    protected toggle(): Promise<void>;
+    protected getCssSelectorToButton(name: string): By;
+    protected buttonNotDisplayedError(name: string): string;
+    protected goToButton(name: string, selector: By): Promise<void>;
+    clickButton(name: string | string[]): Promise<void>;
+    clickButtonByTitle(title: string | string[]): Promise<void>;
+}
+
+declare class ToolbarItem extends AbstractElementWithParent implements Button {
+    private _button;
+    private readonly _formName;
+    private readonly _itemName;
+    constructor(parentCssSelector: string, formName: string, itemName: string, driver?: WebDriver);
+    private init;
     click(): Promise<void>;
     isDisabled(): Promise<boolean>;
+    get menu(): ToolbarMenu;
 }
 
 declare class Cell extends AbstractElementWithParent {
@@ -289,30 +341,48 @@ declare class Cell extends AbstractElementWithParent {
     private getCellIndex;
     constructor(parentCssSelector: string, getCellIndex: () => Promise<number>, index?: number, driver?: WebDriver);
     private set index(value);
+    private getBooleanValue;
     getElement(): Promise<WebElement>;
-    getValue(): Promise<string>;
+    getValue(): Promise<string | 1 | 0>;
     getIndex(): number;
 }
 
+interface ConstructorParams {
+    parentCssSelector: string;
+    name?: string;
+    caption?: string;
+    index?: number;
+    driver?: WebDriver;
+}
 declare class Column extends AbstractElementWithParent {
     private _index;
     private _caption;
-    constructor(parentCssSelector: string, caption?: string, index?: number, driver?: WebDriver);
+    private _name;
+    constructor({ parentCssSelector, name, caption, index, driver }: ConstructorParams);
     private set index(value);
     private get index();
     getElement(): Promise<WebElement>;
+    private getColumnHeaderIndexBy;
     private getIndexByCaption;
+    private getIndexByName;
     caption(): Promise<string>;
     getIndex(): Promise<number>;
 }
 
 declare class Row extends AbstractElementWithParent {
     index: number;
-    protected getColumnByCaption: (caption: string) => Column;
-    constructor(parentCssSelector: string, index: number, driver?: WebDriver, getColumnByCaption?: (caption: string) => Column);
+    protected getColumnBy: (_: {
+        title?: string;
+        name?: string;
+    }) => Column;
+    constructor(parentCssSelector: string, index: number, driver?: WebDriver, getColumnBy?: (_: {
+        title?: string;
+        name?: string;
+    }) => Column);
     private _getCell;
     getCellByIndex(index: number): Cell;
-    getCell(caption: string): Cell;
+    getCell(name: string): Cell;
+    getCellByTitle(title: string): Cell;
     select(): Promise<void>;
     isSelected(): Promise<boolean>;
     getIndex(): number;
@@ -327,9 +397,11 @@ declare class Row extends AbstractElementWithParent {
 declare class Table extends AbstractElementWithParent {
     protected formName: string;
     constructor(parentCssSelector: string, formName: string, driver?: WebDriver);
+    private getColumnBy;
     getRowByIndex(index: number): Row;
     getColumnByIndex(index: number): Column;
-    getColumnByCaption: (caption: string) => Column;
+    getColumnByTitle: (title: string) => Column;
+    getColumnByName: (name: string) => Column;
     selectRowByIndex(index: number): Promise<void>;
     getRows(): Promise<Row[]>;
     getColumns(): Promise<Column[]>;
@@ -344,6 +416,84 @@ declare class Table extends AbstractElementWithParent {
     field(name: string): FormField;
 }
 
+declare class FormFilterField extends AbstractEditor {
+    constructor(parentCssSelector: string, formName: string, name: string, driver?: WebDriver);
+    /**
+     * Возвращает значение в поле
+     * @example
+     * expect(await form.formFilter('NumberFld').getValue()).toBe(10);
+     * expect(await form.formFilter('TextFld').getValue()).toBe('TestValue');
+     */
+    getValue(): Promise<any>;
+    /**
+     * Устанавливает значение в поле
+     * @example
+     * await form.formFilter('NumberFld').setValue(123);
+     * await form.formFilter('TextFld').setValue('TestValue');
+     */
+    setValue(value: any): Promise<void>;
+    /**
+     * Очищает значение в поле
+     * @example
+     * await form.formFilter('NumberFld').clear();
+     */
+    clear(): Promise<void>;
+    /**
+     * Удаляет тег по переданному тексту
+     * @example
+     * await form.formFilter('TagBox').remove('test');
+     */
+    remove(itemText: string): Promise<void>;
+}
+
+declare class PanelFilterField extends AbstractEditor {
+    constructor(parentCssSelector: string, formName: string, name: string, driver?: WebDriver);
+    /**
+     * Возвращает значение в поле
+     * @example
+     * expect(await form.filterPanel.filterField('NumberFld').getValue()).toBe(10);
+     * expect(await form.filterPanel.filterField('TextFld').getValue()).toBe('TestValue');
+     */
+    getValue(): Promise<any>;
+    /**
+     * Устанавливает значение в поле
+     * @example
+     * await form.filterPanel.filterField('NumberFld').setValue(123);
+     * await form.filterPanel.filterField('TextFld').setValue('TestValue');
+     */
+    setValue(value: any): Promise<void>;
+    /**
+     * Очищает значение в поле
+     * @example
+     * await form.filterPanel.filterField('NumberFld').clear();
+     */
+    clear(): Promise<void>;
+    /**
+     * Удаляет тег по переданному тексту
+     * @example
+     * await form.filterPanel.filterField('TagBox').remove('test');
+     */
+    remove(itemText: string): Promise<void>;
+}
+
+declare class FilterPanel extends AbstractElement {
+    private _formName;
+    private get filterPanelSelector();
+    private filterPanelButtons;
+    constructor(formName: string, driver?: WebDriver);
+    /**
+     * Возвращает фильтр на панели фильтрации
+     * @returns {PanelFilterField}
+     * @example
+     * await form.filterPanel.filterField('NumberFld');
+     */
+    filterField(name: string): PanelFilterField;
+    apply(): Promise<void>;
+    private findButtonByTitle;
+    clearAll(): Promise<void>;
+    close(): Promise<void>;
+}
+
 declare abstract class ListForm extends AbstractForm {
     protected constructor(driver?: WebDriver);
     /**
@@ -369,7 +519,40 @@ declare abstract class ListForm extends AbstractForm {
      * //...
      * expect(listForm.toolbarButton());
      */
-    toolbarButton(name: string): TableToolbarButton;
+    toolbarButton(name: string): ToolbarItem;
+    /**
+     * Фильтр который расположен на форме
+     * @example
+     * const listForm = new MyForm();
+     * //...
+     * expect(listForm.formFilter());
+     */
+    formFilter(name: string): FormFilterField;
+    /**
+     * Модель панели фильтрации
+     * @returns {FilterPanel}
+     * @example
+     * const listForm = new MyForm();
+     * //...
+     * expect(listForm.filterPanel());
+     */
+    get filterPanel(): FilterPanel;
+}
+
+declare class DialogButton extends AbstractButton implements Button {
+    private readonly text;
+    constructor(parentCssSelector: string, text: string, driver?: WebDriver);
+    getElement(): Promise<WebElement>;
+    protected buttonNotDisplayedError(): string;
+}
+declare class Dialog extends AbstractElement {
+    constructor(driver?: WebDriver);
+    private get titleSelector();
+    private get textSelector();
+    private get buttonsSelector();
+    title(): Promise<string>;
+    text(): Promise<string>;
+    button(text: string): DialogButton;
 }
 
-export { AbstractPage, Editor, FormEdit, FormField, ListForm, LoginPage, NumberEditor, SubsystemsPanel, TextEditor, byTestId, byTestIdCssSelector, click, config, createDriver, editorFactory, elementIsNotPresent, signIn, wait, waitElementIsVisible };
+export { AbstractPage, Dialog, Editor, FilterPanel, FormEdit, FormField, FormFilterField, ListForm, LoginPage, NumberEditor, PanelFilterField, SubsystemsPanel, TextEditor, byTestId, byTestIdCssSelector, click, config, createDriver, editorFactory, elementIsNotPresent, readonlyLocator, signIn, wait, waitElementIsVisible };