d5-testing-library 1.0.4 → 1.1.0

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

@@ -1,5 +1,5 @@
 import * as selenium_webdriver from 'selenium-webdriver';
-import { WebDriver, Browser, By, Condition, WebElementPromise } from 'selenium-webdriver';
+import { WebDriver, Browser, By, Condition, WebElement, WebElementPromise } 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>;
@@ -64,8 +65,35 @@ 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>;
+
 declare function signIn(driver?: WebDriver): Promise<WebDriver>;
 
+/**
+ * Clicks on a specified web element.
+ *
+ * @param {WebElement} webElement - The web element to click on.
+ * @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 class SubsystemsPanel extends AbstractElement {
     private panelBy;
     private header;
@@ -101,44 +129,57 @@ declare abstract class AbstractForm extends AbstractPage {
 }
 
 declare abstract class AbstractElementWithParent extends AbstractElement {
-    protected getParentElement: () => WebElementPromise;
+    getParentElement: () => Promise<WebElement>;
     protected elementBy: By;
-    constructor(getParentElement: () => WebElementPromise, driver?: WebDriver);
-    getElement(): Promise<selenium_webdriver.WebElement>;
+    constructor(getParentElement: () => Promise<WebElement>, driver?: WebDriver);
+    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: () => WebElementPromise, elementBy: By, driver?: WebDriver);
+    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>;
+    private clearStrategy;
+    protected setClearStrategy(strategy: ClearStrategy): void;
+    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(getParentElement: () => Promise<WebElement>, elementBy: By, driver: WebDriver);
     getValue(): Promise<string>;
     setValue(value: string): Promise<void>;
 }
 
 declare class NumberEditor extends AbstractDXEditorWithInput {
+    constructor(getParentElement: () => Promise<WebElement>, elementBy: By, driver: WebDriver);
     getValue(): Promise<number | null>;
     setValue(value: any): Promise<void>;
 }
 
-declare const editorFactory: (getParentElement: () => WebElementPromise, elementBy: By, driver?: WebDriver) => Promise<Editor>;
+declare const editorFactory: (getParentElement: () => Promise<WebElement>, elementBy: By, driver?: WebDriver) => Promise<Editor>;
 
 declare class FormField extends AbstractElementWithParent implements Editor {
     editor: Editor;
-    constructor(getParentElement: () => WebElementPromise, formName: string, name: string, driver?: WebDriver);
+    constructor(getParentElement: () => Promise<WebElement>, formName: string, name: string, driver?: WebDriver);
     private initEditor;
     /**
      * Возвращает значение в поле
@@ -154,6 +195,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(getParentElement: () => Promise<WebElement>, formName: string, name: string, driver?: WebDriver);
+    private initEditor;
+    /**
+     * Возвращает булевое значение доступна ли группа
+     * @example
+     * expect(await tableList.group('MainSuperPanel').isDisplayed();
+     */
+    isDisplayed(): Promise<boolean>;
 }
 
 declare abstract class FormEdit extends AbstractForm {
@@ -167,6 +236,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
@@ -178,6 +263,7 @@ declare abstract class FormEdit extends AbstractForm {
 }
 
 declare class TableToolbarButton extends AbstractElementWithParent {
+    private readonly name;
     constructor(getParentElement: () => WebElementPromise, name: string, driver?: WebDriver);
     click(): Promise<void>;
     isDisabled(): Promise<boolean>;
@@ -185,14 +271,14 @@ declare class TableToolbarButton extends AbstractElementWithParent {
 
 declare class Cell extends AbstractElementWithParent {
     index: number;
-    constructor(getParentElement: () => WebElementPromise, index: number, driver?: WebDriver);
+    constructor(rowEl: WebElement, index: number, driver?: WebDriver);
     getValue(): Promise<string>;
     getIndex(): number;
 }
 
 declare class Column extends AbstractElementWithParent {
     index: number;
-    constructor(getParentElement: () => WebElementPromise, index: number, driver?: WebDriver);
+    constructor(getParentElement: () => Promise<WebElement>, index: number, driver?: WebDriver);
     caption(): Promise<string>;
     getIndex(): number;
 }
@@ -200,8 +286,7 @@ declare class Column extends AbstractElementWithParent {
 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>);
-    protected getRowElement: () => WebElementPromise;
+    constructor(getParentElement: () => Promise<WebElement>, index: number, driver?: WebDriver, getColumnByCaption?: (caption: string) => Promise<Column>);
     getCellByIndex(index: number): Promise<Cell>;
     getCell(caption: string): Promise<Cell>;
     select(): Promise<void>;
@@ -209,23 +294,33 @@ declare class Row extends AbstractElementWithParent {
     getIndex(): number;
     getCells(): Promise<Cell[]>;
     private clickInlineButton;
+    private checkEditingMode;
     edit(): Promise<void>;
     save(): Promise<void>;
     cancel(): Promise<void>;
 }
 
 declare class Table extends AbstractElementWithParent {
-    constructor(getParentElement: () => WebElementPromise, formName: string, driver?: WebDriver);
-    protected getHeaderElement(): Promise<selenium_webdriver.WebElement>;
-    protected getDataGrid(): Promise<selenium_webdriver.WebElement>;
-    protected getTableElement: () => WebElementPromise;
+    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>;
     selectRowByIndex(index: number): Promise<void>;
     getRows(): Promise<Row[]>;
     getColumns(): Promise<Column[]>;
-    element(): Promise<selenium_webdriver.WebElement>;
+    element(): Promise<WebElement>;
+    /**
+     * Находит поле когда форма находится в состоянии редактирования
+     * @example
+     * const form = new MyForm();
+     * //...
+     * expect(await form.field('Name').getValue()).toBe('test value');
+     */
+    field(name: string): FormField;
 }
 
 declare abstract class ListForm extends AbstractForm {
@@ -238,6 +333,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
@@ -248,4 +351,4 @@ declare abstract class ListForm extends AbstractForm {
     toolbarButton(name: string): Promise<TableToolbarButton>;
 }
 
-export { AbstractPage, Editor, FormEdit, FormField, ListForm, LoginPage, NumberEditor, SubsystemsPanel, TextEditor, byTestId, config, createDriver, editorFactory, elementIsNotPresent, signIn };
+export { AbstractPage, Editor, FormEdit, FormField, ListForm, LoginPage, NumberEditor, SubsystemsPanel, TextEditor, byTestId, click, config, createDriver, editorFactory, elementIsNotPresent, signIn, waitElementIsVisible };