d5-testing-library 1.0.5 → 1.2.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, By, Condition, WebElement } from 'selenium-webdriver';
 
 type DriverType = typeof Browser;
 type BrowserList = DriverType[keyof DriverType];
@@ -16,7 +16,7 @@ type IConfig = {
 declare function config(cfg?: IConfig): IConfig;
 
 declare abstract class AbstractElement {
-    protected driver: WebDriver;
+    driver: WebDriver;
     protected constructor(driver?: WebDriver);
 }
 
@@ -35,6 +35,7 @@ declare class LoginPage extends AbstractPage {
     usernameField: selenium_webdriver.By;
     passwordField: selenium_webdriver.By;
     loginButton: selenium_webdriver.By;
+    locate(): Promise<void>;
     get path(): string;
     enterUsername(username: string): Promise<void>;
     enterPassword(password: string): Promise<void>;
@@ -43,6 +44,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.
  *
@@ -64,6 +66,41 @@ declare const createDriver: (browser?: BrowserList) => Promise<WebDriver>;
 
 declare const elementIsNotPresent: (locator: By) => Condition<boolean>;
 
+interface WaitElementIsVisibleParams {
+    element: WebElement;
+    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>;
+
+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>;
 
 /**
@@ -76,16 +113,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;
@@ -110,44 +146,55 @@ declare abstract class AbstractForm extends AbstractPage {
 }
 
 declare abstract class AbstractElementWithParent extends AbstractElement {
-    protected getParentElement: () => Promise<WebElement>;
-    protected elementBy: By;
-    constructor(getParentElement: () => Promise<WebElement>, driver?: WebDriver);
+    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>;
 }
 
 interface Editor {
     setValue(value: any): Promise<void>;
     getValue(): Promise<any>;
+    remove?(itemText: string): Promise<void>;
+    clear?(): Promise<void>;
 }
 
-declare class AbstractFormElement extends AbstractElementWithParent {
-    constructor(getParentElement: () => Promise<WebElement>, elementBy: By, driver?: WebDriver);
+interface ClearStrategy {
+    clear(editor: AbstractDXEditorWithInput): Promise<void>;
 }
 
-declare abstract class AbstractDXEditorWithInput extends AbstractFormElement implements Editor {
-    protected getInputElement(): Promise<selenium_webdriver.WebElement>;
+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>;
+    clear(): Promise<void>;
     abstract setValue(value: any): Promise<void>;
     abstract getValue(): Promise<any>;
 }
 
 declare class TextEditor extends AbstractDXEditorWithInput {
+    constructor(parentCssSelector: string, elementCssSelector: string, driver?: WebDriver);
     getValue(): Promise<string>;
     setValue(value: string): Promise<void>;
 }
 
 declare class NumberEditor extends AbstractDXEditorWithInput {
+    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);
+    constructor(parentCssSelector: string, formName: string, name: string, driver?: WebDriver);
     private initEditor;
     /**
      * Возвращает значение в поле
@@ -163,6 +210,34 @@ declare class FormField extends AbstractElementWithParent implements Editor {
      * await formEdit.field('TextFld').setValue('TestValue');
      */
     setValue(value: any): Promise<void>;
+    /**
+     * Очищает значение в поле
+     * @example
+     * await formEdit.field('NumberFld').clear();
+     */
+    clear(): Promise<void>;
+    /**
+     * Удаляет тег по переданному тексту
+     * @example
+     * await formEdit.field('TagBox').remove('test');
+     */
+    remove(itemText: string): Promise<void>;
+}
+
+interface Group {
+    isDisplayed(): Promise<boolean>;
+}
+
+declare class FormGroup extends AbstractElementWithParent implements Group {
+    editor: Group;
+    constructor(parentCssSelector: string, formName: string, name: string, driver?: WebDriver);
+    private initEditor;
+    /**
+     * Возвращает булевое значение доступна ли группа
+     * @example
+     * expect(await tableList.group('MainSuperPanel').isDisplayed();
+     */
+    isDisplayed(): Promise<boolean>;
 }
 
 declare abstract class FormEdit extends AbstractForm {
@@ -176,6 +251,22 @@ declare abstract class FormEdit extends AbstractForm {
      * expect(await formEdit.field('Name').getValue()).toBe('test value');
      */
     field(name: string): FormField;
+    /**
+     * Проверяет не отключена ли кнопка Сохранить
+     * @example
+     * const formEdit = new MyForm();
+     * //...
+     * await formEdit.isSaveButtonDisabled();
+     */
+    isSaveButtonDisabled(): Promise<boolean>;
+    /**
+     * Находит группу формы редактирования по имени
+     * @example
+     * const formEdit = new MyForm();
+     * //...
+     * expect(await formEdit.group('Name');
+     */
+    group(name: string): FormGroup;
     /**
      * Нажатие на кнопку Сохранить
      * @example
@@ -187,36 +278,47 @@ declare abstract class FormEdit extends AbstractForm {
 }
 
 declare class TableToolbarButton extends AbstractElementWithParent {
-    constructor(getParentElement: () => WebElementPromise, name: string, driver?: WebDriver);
+    private readonly name;
+    constructor(parentCssSelector: string, name: string, driver?: WebDriver);
     click(): Promise<void>;
     isDisabled(): Promise<boolean>;
 }
 
 declare class Cell extends AbstractElementWithParent {
-    index: number;
-    constructor(rowEl: WebElement, index: number, driver?: WebDriver);
+    private _index;
+    private getCellIndex;
+    constructor(parentCssSelector: string, getCellIndex: () => Promise<number>, index?: number, driver?: WebDriver);
+    private set index(value);
+    getElement(): Promise<WebElement>;
     getValue(): Promise<string>;
     getIndex(): number;
 }
 
 declare class Column extends AbstractElementWithParent {
-    index: number;
-    constructor(getParentElement: () => WebElementPromise, index: number, driver?: WebDriver);
+    private _index;
+    private _caption;
+    constructor(parentCssSelector: string, caption?: string, index?: number, driver?: WebDriver);
+    private set index(value);
+    private get index();
+    getElement(): Promise<WebElement>;
+    private getIndexByCaption;
     caption(): Promise<string>;
-    getIndex(): number;
+    getIndex(): Promise<number>;
 }
 
 declare class Row extends AbstractElementWithParent {
     index: number;
-    protected getColumnByCaption: (caption: string) => Promise<Column>;
-    constructor(getParentElement: () => WebElementPromise, index: number, driver?: WebDriver, getColumnByCaption?: (caption: string) => Promise<Column>);
-    getCellByIndex(index: number): Promise<Cell>;
-    getCell(caption: string): Promise<Cell>;
+    protected getColumnByCaption: (caption: string) => Column;
+    constructor(parentCssSelector: string, index: number, driver?: WebDriver, getColumnByCaption?: (caption: string) => Column);
+    private _getCell;
+    getCellByIndex(index: number): Cell;
+    getCell(caption: string): Cell;
     select(): Promise<void>;
     isSelected(): Promise<boolean>;
     getIndex(): number;
     getCells(): Promise<Cell[]>;
     private clickInlineButton;
+    private checkEditingMode;
     edit(): Promise<void>;
     save(): Promise<void>;
     cancel(): Promise<void>;
@@ -224,13 +326,10 @@ declare class Row extends AbstractElementWithParent {
 
 declare class Table extends AbstractElementWithParent {
     protected formName: string;
-    constructor(getParentElement: () => WebElementPromise, formName: string, driver?: WebDriver);
-    protected getHeaderElement(): Promise<selenium_webdriver.WebElement>;
-    protected getDataGrid(): Promise<selenium_webdriver.WebElement>;
-    protected getTableElement: () => WebElementPromise;
-    getRowByIndex(index: number): Promise<Row>;
-    getColumnByIndex(index: number): Promise<Column>;
-    getColumnByCaption(caption: string): Promise<Column>;
+    constructor(parentCssSelector: string, formName: string, driver?: WebDriver);
+    getRowByIndex(index: number): Row;
+    getColumnByIndex(index: number): Column;
+    getColumnByCaption: (caption: string) => Column;
     selectRowByIndex(index: number): Promise<void>;
     getRows(): Promise<Row[]>;
     getColumns(): Promise<Column[]>;
@@ -255,6 +354,14 @@ declare abstract class ListForm extends AbstractForm {
      * expect(listForm.table());
      */
     table(): Table;
+    /**
+     * Находит группу на лист форме по имени
+     * @example
+     * const formEdit = new MyForm();
+     * //...
+     * expect(await formEdit.group('Name');
+     */
+    group(name: string): FormGroup;
     /**
      * Находит таблицу
      * @example
@@ -262,7 +369,7 @@ declare abstract class ListForm extends AbstractForm {
      * //...
      * expect(listForm.toolbarButton());
      */
-    toolbarButton(name: string): Promise<TableToolbarButton>;
+    toolbarButton(name: string): TableToolbarButton;
 }
 
-export { AbstractPage, Editor, FormEdit, FormField, ListForm, LoginPage, NumberEditor, SubsystemsPanel, TextEditor, byTestId, click, config, createDriver, editorFactory, elementIsNotPresent, signIn };
+export { AbstractPage, Editor, FormEdit, FormField, ListForm, LoginPage, NumberEditor, SubsystemsPanel, TextEditor, byTestId, byTestIdCssSelector, click, config, createDriver, editorFactory, elementIsNotPresent, signIn, wait, waitElementIsVisible };