automation_model 1.0.463-dev → 1.0.463

package/lib/stable_browser.d.ts

@@ -1,5 +1,52 @@
 import type { Browser, Page } from "playwright";
-type Params = Record<string, string>;
+import { Params } from "./utils.js";
+export declare const Types: {
+    CLICK: string;
+    WAIT_ELEMENT: string;
+    NAVIGATE: string;
+    GO_BACK: string;
+    GO_FORWARD: string;
+    FILL: string;
+    EXECUTE: string;
+    OPEN: string;
+    COMPLETE: string;
+    ASK: string;
+    GET_PAGE_STATUS: string;
+    CLICK_ROW_ACTION: string;
+    VERIFY_ELEMENT_CONTAINS_TEXT: string;
+    VERIFY_PAGE_CONTAINS_TEXT: string;
+    VERIFY_PAGE_CONTAINS_NO_TEXT: string;
+    ANALYZE_TABLE: string;
+    SELECT: string;
+    VERIFY_PROPERTY: string;
+    VERIFY_PAGE_PATH: string;
+    VERIFY_PAGE_TITLE: string;
+    TYPE_PRESS: string;
+    PRESS: string;
+    HOVER: string;
+    CHECK: string;
+    UNCHECK: string;
+    EXTRACT: string;
+    EXTRACT_PROPERTY: string;
+    CLOSE_PAGE: string;
+    TABLE_OPERATION: string;
+    SET_DATE_TIME: string;
+    SET_VIEWPORT: string;
+    VERIFY_VISUAL: string;
+    LOAD_DATA: string;
+    SET_INPUT: string;
+    WAIT_FOR_TEXT_TO_DISAPPEAR: string;
+    VERIFY_ATTRIBUTE: string;
+    VERIFY_TEXT_WITH_RELATION: string;
+    BRUNO: string;
+    VERIFY_FILE_EXISTS: string;
+    SET_INPUT_FILES: string;
+    SNAPSHOT_VALIDATION: string;
+    REPORT_COMMAND: string;
+    STEP_COMPLETE: string;
+    SLEEP: string;
+    CONDITIONAL_WAIT: string;
+};
 export declare const apps: {};
 declare class StableBrowser {
     browser: Browser;
@@ -7,45 +54,58 @@ declare class StableBrowser {
     logger: any;
     context: any;
     world?: any;
+    fastMode: boolean;
+    stepTags: string[];
     project_path: null;
     webLogFile: null;
     networkLogger: null;
     configuration: null;
     appName: string;
-    constructor(browser: Browser, page: Page, logger?: any, context?: any, world?: any);
+    tags: null;
+    isRecording: boolean;
+    initSnapshotTaken: boolean;
+    onlyFailuresScreenshot: boolean;
+    constructor(browser: Browser, page: Page, logger?: any, context?: any, world?: any, fastMode?: boolean, stepTags?: string[]);
     registerEventListeners(context: any): void;
     switchApp(appName: any): Promise<void>;
-    _copyContext(from: any, to: any): void;
-    getWebLogFile(logFolder: string): string;
+    switchTab(tabTitleOrIndex: number | string): Promise<void>;
     registerConsoleLogListener(page: Page, context: any): void;
     registerRequestListener(page: Page, context: any, logFile: string): void;
-    goto(url: string): Promise<void>;
-    _validateSelectors(selectors: any): void;
-    _fixUsingParams(text: any, _params: Params): any;
-    _fixLocatorUsingParams(locator: any, _params: Params): any;
-    _isObject(value: any): any;
-    scanAndManipulate(currentObj: any, _params: Params): void;
-    _getLocator(locator: any, scope: any, _params: any): any;
+    goto(url: string, world?: null): Promise<void>;
+    goBack(options: any, world?: null): Promise<void>;
+    goForward(options: any, world?: null): Promise<void>;
+    _getLocator(locator: any, scope: any, _params: any): Promise<any>;
     _locateElmentByTextClimbCss(scope: any, text: any, climb: any, css: any, _params: Params): Promise<string | undefined>;
-    _locateElementByText(scope: any, text1: any, tag1: any, regex1: boolean | undefined, partial1: any, _params: Params): Promise<any>;
-    _collectLocatorInformation(selectorHierarchy: any, index: number | undefined, scope: any, foundLocators: any, _params: Params, info: any, visibleOnly?: boolean): Promise<void>;
+    _locateElementByText(scope: any, text1: any, tag1: any, regex1: boolean | undefined, partial1: any, ignoreCase: boolean | undefined, _params: Params): Promise<{
+        elementCount: number;
+        randomToken: string;
+    }>;
+    _collectLocatorInformation(selectorHierarchy: any, index: number | undefined, scope: any, foundLocators: any, _params: Params, info: any, visibleOnly?: boolean, allowDisabled?: boolean | undefined, element_name?: null, logErrors?: boolean | undefined): Promise<void>;
     closeUnexpectedPopups(info: any, _params: any): Promise<{
         rerun: boolean;
     }>;
-    _locate(selectors: any, info: any, _params?: Params, timeout?: number): Promise<any>;
-    _locate_internal(selectors: any, info: any, _params?: Params, timeout?: number): Promise<any>;
-    _scanLocatorsGroup(locatorsGroup: any, scope: any, _params: any, info: any, visibleOnly: any): Promise<{
+    getFilePath(): string | null;
+    getFullElementLocators(selectors: any, filePath: any): any;
+    _locate(selectors: any, info: any, _params?: Params, timeout: any, allowDisabled?: boolean | undefined): Promise<any>;
+    _findFrameScope(selectors: any, timeout: number | undefined, info: any): Promise<any>;
+    _getDocumentBody(selectors: any, timeout: number | undefined, info: any): Promise<any>;
+    _locate_internal(selectors: any, info: any, _params?: Params, timeout?: number, allowDisabled?: boolean | undefined): Promise<any>;
+    _scanLocatorsGroup(locatorsGroup: any, scope: any, _params: any, info: any, visibleOnly: any, allowDisabled?: boolean | undefined, element_name: any, logErrors?: boolean | undefined): Promise<{
         foundElements: any[];
     }>;
-    click(selectors: any, _params?: Params, options?: {}, world?: null): Promise<{}>;
-    setCheck(selectors: any, checked?: boolean, _params?: Params, options?: {}, world?: null): Promise<{}>;
-    hover(selectors: any, _params?: Params, options?: {}, world?: null): Promise<{}>;
-    selectOption(selectors: any, values: any, _params?: null, options?: {}, world?: null): Promise<{}>;
-    type(_value: any, _params?: null, options?: {}, world?: null): Promise<{}>;
+    simpleClick(elementDescription: any, _params?: Params, options?: {}, world?: null): Promise<void>;
+    simpleClickType(elementDescription: any, value: any, _params?: Params, options?: {}, world?: null): Promise<void>;
+    click(selectors: any, _params?: Params, options?: {}, world?: null): Promise<any>;
+    waitForElement(selectors: any, _params?: Params, options?: {}, world?: null): Promise<boolean>;
+    setCheck(selectors: any, checked?: boolean, _params?: Params, options?: {}, world?: null): Promise<any>;
+    hover(selectors: any, _params?: Params, options?: {}, world?: null): Promise<any>;
+    selectOption(selectors: any, values: any, _params?: null, options?: {}, world?: null): Promise<any>;
+    type(_value: any, _params?: null, options?: {}, world?: null): Promise<any>;
     setInputValue(selectors: any, value: any, _params?: null, options?: {}, world?: null): Promise<void>;
     setDateTime(selectors: any, value: any, format?: null, enter?: boolean, _params?: null, options?: {}, world?: null): Promise<void>;
-    clickType(selectors: any, _value: any, enter?: boolean, _params?: null, options?: {}, world?: null): Promise<{}>;
-    fill(selectors: any, value: any, enter?: boolean, _params?: null, options?: {}, world?: null): Promise<{}>;
+    clickType(selectors: any, _value: any, enter?: boolean, _params?: null, options?: {}, world?: null): Promise<any>;
+    fill(selectors: any, value: any, enter?: boolean, _params?: null, options?: {}, world?: null): Promise<any>;
+    setInputFiles(selectors: any, files: any, _params?: null, options?: {}, world?: null): Promise<any>;
     getText(selectors: any, _params?: null, options?: {}, info?: {}, world?: null): Promise<{
         text: any;
         screenshotId: any;
@@ -72,11 +132,12 @@ declare class StableBrowser {
         value: any;
         element?: undefined;
     }>;
-    containsPattern(selectors: any, pattern: any, text: any, _params?: null, options?: {}, world?: null): Promise<{}>;
-    containsText(selectors: any, text: any, climb: any, _params?: null, options?: {}, world?: null): Promise<{}>;
-    _getDataFile(world?: null): string;
+    containsPattern(selectors: any, pattern: any, text: any, _params?: null, options?: {}, world?: null): Promise<any>;
+    containsText(selectors: any, text: any, climb: any, _params?: null, options?: {}, world?: null): Promise<any>;
+    snapshotValidation(frameSelectors: any, referanceSnapshot: any, _params?: null, options?: {}, world?: null): Promise<any>;
     waitForUserInput(message: any, world?: null): Promise<void>;
     setTestData(testData: any, world?: null): void;
+    overwriteTestData(testData: any, world?: null): void;
     _getDataFilePath(fileName: any): string;
     _parseCSVSync(filePath: any): Promise<unknown>;
     loadTestData(type: string, dataSelector: string, world?: null): {
@@ -88,47 +149,88 @@ declare class StableBrowser {
     getTestData(world?: null): {};
     _screenShot(options?: {}, world?: null, info?: null): Promise<{}>;
     takeScreenshot(screenshotPath: any): Promise<any>;
-    verifyElementExistInPage(selectors: any, _params?: null, options?: {}, world?: null): Promise<{}>;
-    extractAttribute(selectors: any, attribute: any, variable: any, _params?: null, options?: {}, world?: null): Promise<{}>;
+    verifyElementExistInPage(selectors: any, _params?: null, options?: {}, world?: null): Promise<any>;
+    extractAttribute(selectors: any, attribute: any, variable: any, _params?: null, options?: {}, world?: null): Promise<any>;
+    extractProperty(selectors: any, property: any, variable: any, _params?: null, options?: {}, world?: null): Promise<any>;
+    verifyAttribute(selectors: any, attribute: any, value: any, _params?: null, options?: {}, world?: null): Promise<any>;
+    verifyProperty(selectors: any, property: any, value: any, _params?: null, options?: {}, world?: null): Promise<any>;
+    conditionalWait(selectors: any, condition: any, timeout?: number, _params?: null, options?: {}, world?: null): Promise<{}>;
     extractEmailData(emailAddress: any, options: any, world: any): Promise<{
         emailUrl: any;
         emailCode: any;
     }>;
     _highlightElements(scope: any, css: any): Promise<void>;
-    verifyPagePath(pathPart: any, options?: {}, world?: null): Promise<{} | undefined>;
-    verifyTextExistInPage(text: any, options?: {}, world?: null): Promise<{}>;
-    _getServerUrl(): string;
-    visualVerification(text: any, options?: {}, world?: null): Promise<{}>;
+    _matcher(text: any): {
+        matcher: any;
+        queryText: any;
+    };
+    _getDomain(url: string): string;
+    /**
+     * Verify the page path matches the given path.
+     * @param {string} pathPart - The path to verify.
+     * @param {object} options - Options for verification.
+     * @param {object} world - The world context.
+     * @returns {Promise<object>} - The state info after verification.
+     */
+    verifyPagePath(pathPart: string, options?: object, world?: object): Promise<object>;
+    /**
+     * Verify the page title matches the given title.
+     * @param {string} title - The title to verify.
+     * @param {object} options - Options for verification.
+     * @param {object} world - The world context.
+     * @returns {Promise<object>} - The state info after verification.
+     */
+    verifyPageTitle(title: string, options?: object, world?: object): Promise<object>;
+    findTextInAllFrames(dateAlternatives: any, numberAlternatives: any, text: any, state: any, partial?: boolean, ignoreCase?: boolean): Promise<{
+        elementCount: number;
+        randomToken: string;
+    }[]>;
+    verifyTextExistInPage(text: any, options?: {}, world?: null): Promise<any>;
+    waitForTextToDisappear(text: any, options?: {}, world?: null): Promise<any>;
+    verifyTextRelatedToText(textAnchor: string, climb: number, textToVerify: string, options?: {}, world?: any): Promise<any>;
+    findRelatedTextInAllFrames(textAnchor: string, climb: number, textToVerify: string, params?: Params, options?: {}, world?: any): Promise<{
+        elementCount: number;
+        randomToken: string;
+    }[]>;
+    visualVerification(text: any, options?: {}, world?: null): Promise<{} | undefined>;
     verifyTableData(selectors: any, data: any, _params?: null, options?: {}, world?: null): Promise<void>;
     getTableData(selectors: any, _params?: null, options?: {}, world?: null): Promise<any>;
-    analyzeTable(selectors: any, query: any, operator: any, value: any, _params?: null, options?: {}, world?: null): Promise<{}>;
-    _replaceWithLocalData(value: any, world: any, _decrypt?: boolean, totpWait?: boolean): Promise<any>;
+    analyzeTable(selectors: any, query: any, operator: any, value: any, _params?: null, options?: {}, world?: null): Promise<{} | undefined>;
+    /**
+     * Explicit wait/sleep function that pauses execution for a specified duration
+     * @param duration - Duration to sleep in milliseconds (default: 1000ms)
+     * @param options - Optional configuration object
+     * @param world - Optional world context
+     * @returns Promise that resolves after the specified duration
+     */
+    sleep(duration?: number, options?: {}, world?: null): Promise<any>;
+    _replaceWithLocalData(value: any, world: any, _decrypt?: boolean, totpWait?: boolean): Promise<string>;
     _getLoadTimeout(options: any): number;
+    _getFindElementTimeout(options: any): any;
+    saveStoreState(path?: string | null, world?: any): Promise<void>;
+    restoreSaveState(path?: string | null, world?: any): Promise<void>;
     waitForPageLoad(options?: {}, world?: null): Promise<void>;
     closePage(options?: {}, world?: null): Promise<void>;
+    tableCellOperation(headerText: string, rowText: string, options: any, _params: Params, world?: null): Promise<void>;
+    saveTestDataAsGlobal(options: any, world: any): void;
     setViewportSize(width: number, hight: number, options?: {}, world?: null): Promise<void>;
     reloadPage(options?: {}, world?: null): Promise<void>;
     scrollIfNeeded(element: any, info: any): Promise<void>;
-    _reportToWorld(world: any, properties: JsonCommandReport): void;
+    beforeScenario(world: any, scenario: any): Promise<void>;
+    afterScenario(world: any, scenario: any): Promise<void>;
+    beforeStep(world: any, step: any): Promise<void>;
+    setStepTags(tags: string[]): void;
+    getAriaSnapshot(): Promise<string | null>;
+    /**
+     * Sends command with custom payload to report.
+     * @param commandText - Title of the command to be shown in the report.
+     * @param commandStatus - Status of the command (e.g. "PASSED", "FAILED").
+     * @param content - Content of the command to be shown in the report.
+     * @param options - Options for the command. Example: { type: "json", screenshot: true }
+     * @param world - Optional world context.
+     * @public
+     */
+    addCommandToReport(commandText: string, commandStatus: "PASSED" | "FAILED", content: string, options?: any, world?: any): Promise<void>;
+    afterStep(world: any, step: any): Promise<void>;
 }
-type JsonTimestamp = number;
-type JsonResultPassed = {
-    status: "PASSED";
-    startTime: JsonTimestamp;
-    endTime: JsonTimestamp;
-};
-type JsonResultFailed = {
-    status: "FAILED";
-    startTime: JsonTimestamp;
-    endTime: JsonTimestamp;
-    message?: string;
-};
-type JsonCommandResult = JsonResultPassed | JsonResultFailed;
-type JsonCommandReport = {
-    type: string;
-    value?: string;
-    text: string;
-    screenshotId?: string;
-    result: JsonCommandResult;
-};
 export { StableBrowser };