d5-testing-library 1.1.0 → 1.3.0

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

@@ -1,5 +1,5 @@
 import * as selenium_webdriver from 'selenium-webdriver';
-import { WebDriver, Browser, By, Condition, WebElement, WebElementPromise } from 'selenium-webdriver';
+import { WebDriver, Browser, WebElement, By, Condition } from 'selenium-webdriver';
 
 type DriverType = typeof Browser;
 type BrowserList = DriverType[keyof DriverType];
@@ -17,7 +17,13 @@ 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;
+    getElement(): Promise<WebElement>;
+    getAttribute(attr: string): Promise<string>;
+    getClasses(): Promise<string>;
+    getDataTestId(): Promise<string>;
 }
 
 declare abstract class AbstractPage extends AbstractElement {
@@ -44,6 +50,7 @@ declare class LoginPage extends AbstractPage {
     authorize(): Promise<void>;
 }
 
+declare const byTestIdCssSelector: (testId: string, element?: string) => string;
 /**
  * Returns a By locator object that can be used to locate an element by its test ID.
  *
@@ -83,6 +90,23 @@ interface WaitElementIsVisibleParams {
  */
 declare function waitElementIsVisible({ element, timeout, errorMessage, driver }: WaitElementIsVisibleParams): Promise<void>;
 
+interface WaiteParams {
+    condition: (driver?: WebDriver) => Promise<boolean>;
+    timeout?: number;
+    errorMessage?: string;
+    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 signIn(driver?: WebDriver): Promise<WebDriver>;
 
 /**
@@ -95,16 +119,15 @@ declare function signIn(driver?: WebDriver): Promise<WebDriver>;
 declare const click: (webElement: WebElement, driver?: WebDriver) => Promise<void>;
 
 declare class SubsystemsPanel extends AbstractElement {
-    private panelBy;
     private header;
     constructor(driver?: WebDriver);
-    private panelElement;
     headerTitle(): Promise<string>;
 }
 
 declare abstract class AbstractForm extends AbstractPage {
+    protected containerCssSelector: string;
     protected containerBy: By;
-    protected popupContainerBy: By;
+    protected popupContainerCssSelector: string;
     protected constructor(driver?: WebDriver);
     protected isModal(): Promise<boolean>;
     protected getContainerElement: () => selenium_webdriver.WebElementPromise;
@@ -129,12 +152,9 @@ declare abstract class AbstractForm extends AbstractPage {
 }
 
 declare abstract class AbstractElementWithParent extends AbstractElement {
-    getParentElement: () => Promise<WebElement>;
-    protected elementBy: By;
-    constructor(getParentElement: () => Promise<WebElement>, driver?: WebDriver);
-    getElement(): Promise<WebElement>;
-    getAttribute(attr: string): Promise<string>;
-    getClasses(): Promise<string>;
+    protected parentCssSelector: string;
+    constructor(parentCssSelector: string, elementCssSelector: string, driver?: WebDriver);
+    protected getFullCssSelector(): string;
 }
 
 interface Editor {
@@ -144,17 +164,14 @@ interface Editor {
     clear?(): Promise<void>;
 }
 
-declare class AbstractFormElement extends AbstractElementWithParent {
-    constructor(getParentElement: () => Promise<WebElement>, elementBy: By, driver?: WebDriver);
-}
-
 interface ClearStrategy {
-    clear(editor: AbstractDXEditorWithInput): Promise<void>;
+    clear(editor: Editor): Promise<void>;
 }
 
-declare abstract class AbstractDXEditorWithInput extends AbstractFormElement implements Editor {
+declare abstract class AbstractDXEditorWithInput extends AbstractElementWithParent implements Editor {
     private clearStrategy;
     protected setClearStrategy(strategy: ClearStrategy): void;
+    protected getInputCssSelector(): string;
     getInputElement(): Promise<selenium_webdriver.WebElement>;
     protected getInputValue(): Promise<string>;
     protected setInputValue(value: string): Promise<void>;
@@ -164,23 +181,23 @@ declare abstract class AbstractDXEditorWithInput extends AbstractFormElement imp
 }
 
 declare class TextEditor extends AbstractDXEditorWithInput {
-    constructor(getParentElement: () => Promise<WebElement>, elementBy: By, driver: WebDriver);
+    constructor(parentCssSelector: string, elementCssSelector: string, driver?: WebDriver);
     getValue(): Promise<string>;
     setValue(value: string): Promise<void>;
 }
 
 declare class NumberEditor extends AbstractDXEditorWithInput {
-    constructor(getParentElement: () => Promise<WebElement>, elementBy: By, driver: WebDriver);
+    constructor(parentCssSelector: string, elementCssSelector: string, driver?: WebDriver);
     getValue(): Promise<number | null>;
     setValue(value: any): Promise<void>;
 }
 
-declare const editorFactory: (getParentElement: () => Promise<WebElement>, elementBy: By, driver?: WebDriver) => Promise<Editor>;
+declare const editorFactory: (parentCssSelector: string, elementCssSelector: string, driver: WebDriver) => Promise<Editor>;
 
-declare class FormField extends AbstractElementWithParent implements Editor {
-    editor: Editor;
-    constructor(getParentElement: () => Promise<WebElement>, 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
@@ -209,13 +226,17 @@ declare class FormField extends AbstractElementWithParent implements Editor {
     remove(itemText: string): Promise<void>;
 }
 
+declare class FormField extends AbstractEditor {
+    constructor(parentCssSelector: string, formName: string, name: string, driver?: WebDriver);
+}
+
 interface Group {
     isDisplayed(): Promise<boolean>;
 }
 
 declare class FormGroup extends AbstractElementWithParent implements Group {
     editor: Group;
-    constructor(getParentElement: () => Promise<WebElement>, formName: string, name: string, driver?: WebDriver);
+    constructor(parentCssSelector: string, formName: string, name: string, driver?: WebDriver);
     private initEditor;
     /**
      * Возвращает булевое значение доступна ли группа
@@ -262,33 +283,67 @@ declare abstract class FormEdit extends AbstractForm {
     saveButtonClick(): Promise<void>;
 }
 
-declare class TableToolbarButton extends AbstractElementWithParent {
-    private readonly name;
-    constructor(getParentElement: () => WebElementPromise, name: string, driver?: WebDriver);
+interface Button {
+    click(): Promise<void>;
+    isDisabled(): Promise<boolean>;
+}
+
+declare class ToolbarItem extends AbstractElementWithParent implements Button {
+    private _button;
+    private _itemName;
+    constructor(parentCssSelector: string, formName: string, itemName: string, driver?: WebDriver);
+    private init;
     click(): Promise<void>;
     isDisabled(): Promise<boolean>;
 }
 
 declare class Cell extends AbstractElementWithParent {
-    index: number;
-    constructor(rowEl: WebElement, index: number, driver?: WebDriver);
-    getValue(): Promise<string>;
+    private _index;
+    private getCellIndex;
+    constructor(parentCssSelector: string, getCellIndex: () => Promise<number>, index?: number, driver?: WebDriver);
+    private set index(value);
+    private getBooleanValue;
+    getElement(): Promise<WebElement>;
+    getValue(): Promise<string | 1 | 0>;
     getIndex(): number;
 }
 
+interface ConstructorParams {
+    parentCssSelector: string;
+    name?: string;
+    caption?: string;
+    index?: number;
+    driver?: WebDriver;
+}
 declare class Column extends AbstractElementWithParent {
-    index: number;
-    constructor(getParentElement: () => Promise<WebElement>, index: number, driver?: WebDriver);
+    private _index;
+    private _caption;
+    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(): number;
+    getIndex(): Promise<number>;
 }
 
 declare class Row extends AbstractElementWithParent {
     index: number;
-    protected getColumnByCaption: (caption: string) => Promise<Column>;
-    constructor(getParentElement: () => Promise<WebElement>, index: number, driver?: WebDriver, getColumnByCaption?: (caption: string) => Promise<Column>);
-    getCellByIndex(index: number): Promise<Cell>;
-    getCell(caption: string): Promise<Cell>;
+    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(name: string): Cell;
+    getCellByTitle(title: string): Cell;
     select(): Promise<void>;
     isSelected(): Promise<boolean>;
     getIndex(): number;
@@ -302,17 +357,16 @@ declare class Row extends AbstractElementWithParent {
 
 declare class Table extends AbstractElementWithParent {
     protected formName: string;
-    constructor(getParentElement: () => Promise<WebElement>, formName: string, driver?: WebDriver);
-    private getHeaderCssSelector;
-    protected getDataGrid(): Promise<WebElement>;
-    protected getTableElement: () => Promise<WebElement>;
-    getRowByIndex(index: number): Promise<Row>;
-    getColumnByIndex(index: number): Promise<Column>;
-    getColumnByCaption(caption: string): Promise<Column>;
+    constructor(parentCssSelector: string, formName: string, driver?: WebDriver);
+    private getColumnBy;
+    getRowByIndex(index: number): Row;
+    getColumnByIndex(index: number): Column;
+    getColumnByTitle: (title: string) => Column;
+    getColumnByName: (name: string) => Column;
     selectRowByIndex(index: number): Promise<void>;
     getRows(): Promise<Row[]>;
     getColumns(): Promise<Column[]>;
-    element(): Promise<WebElement>;
+    element(): Promise<selenium_webdriver.WebElement>;
     /**
      * Находит поле когда форма находится в состоянии редактирования
      * @example
@@ -323,6 +377,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);
     /**
@@ -348,7 +480,24 @@ declare abstract class ListForm extends AbstractForm {
      * //...
      * expect(listForm.toolbarButton());
      */
-    toolbarButton(name: string): Promise<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;
 }
 
-export { AbstractPage, Editor, FormEdit, FormField, ListForm, LoginPage, NumberEditor, SubsystemsPanel, TextEditor, byTestId, click, config, createDriver, editorFactory, elementIsNotPresent, signIn, waitElementIsVisible };
+export { AbstractPage, Editor, FilterPanel, FormEdit, FormField, FormFilterField, ListForm, LoginPage, NumberEditor, PanelFilterField, SubsystemsPanel, TextEditor, byTestId, byTestIdCssSelector, click, config, createDriver, editorFactory, elementIsNotPresent, signIn, wait, waitElementIsVisible };