automation_model 1.0.0-amdocs

package/lib/stable_browser.d.ts

@@ -0,0 +1,188 @@
+import type { Browser, Page } from "playwright";
+import { Params } from "./utils.js";
+export declare const Types: {
+    CLICK: string;
+    WAIT_ELEMENT: string;
+    NAVIGATE: 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_PAGE_PATH: string;
+    TYPE_PRESS: string;
+    PRESS: string;
+    HOVER: string;
+    CHECK: string;
+    UNCHECK: string;
+    EXTRACT: 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;
+};
+export declare const apps: {};
+declare class StableBrowser {
+    browser: Browser;
+    page: Page;
+    logger: any;
+    context: any;
+    world?: any;
+    project_path: null;
+    webLogFile: null;
+    networkLogger: null;
+    configuration: null;
+    appName: string;
+    tags: null;
+    isRecording: boolean;
+    initSnapshotTaken: boolean;
+    constructor(browser: Browser, page: Page, logger?: any, context?: any, world?: any);
+    registerEventListeners(context: any): void;
+    switchApp(appName: any): Promise<void>;
+    registerConsoleLogListener(page: Page, context: any): void;
+    registerRequestListener(page: Page, context: any, logFile: string): void;
+    goto(url: string, 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, 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): Promise<void>;
+    closeUnexpectedPopups(info: any, _params: any): Promise<{
+        rerun: boolean;
+    }>;
+    _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): Promise<{
+        foundElements: any[];
+    }>;
+    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<any>;
+    fill(selectors: any, value: any, enter?: boolean, _params?: null, options?: {}, world?: null): Promise<any>;
+    getText(selectors: any, _params?: null, options?: {}, info?: {}, world?: null): Promise<{
+        text: any;
+        screenshotId: any;
+        screenshotPath: any;
+        value: any;
+        element: any;
+    } | {
+        text: any;
+        screenshotId: any;
+        screenshotPath: any;
+        value: any;
+        element?: undefined;
+    }>;
+    _getText(selectors: any, climb: any, _params?: null, options?: {}, info?: {}, world?: null): Promise<{
+        text: any;
+        screenshotId: any;
+        screenshotPath: any;
+        value: any;
+        element: any;
+    } | {
+        text: any;
+        screenshotId: any;
+        screenshotPath: any;
+        value: any;
+        element?: undefined;
+    }>;
+    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>;
+    waitForUserInput(message: any, world?: null): Promise<void>;
+    setTestData(testData: any, world?: null): void;
+    _getDataFilePath(fileName: any): string;
+    _parseCSVSync(filePath: any): Promise<unknown>;
+    loadTestData(type: string, dataSelector: string, world?: null): {
+        username: any;
+        password: string;
+        totp: string | null;
+    };
+    loadTestDataAsync(type: string, dataSelector: string, world?: null): Promise<any>;
+    getTestData(world?: null): {};
+    _screenShot(options?: {}, world?: null, info?: null): Promise<{}>;
+    takeScreenshot(screenshotPath: any): Promise<any>;
+    verifyElementExistInPage(selectors: any, _params?: null, options?: {}, world?: null): Promise<any>;
+    extractAttribute(selectors: any, attribute: any, variable: any, _params?: null, options?: {}, world?: null): Promise<any>;
+    verifyAttribute(selectors: any, attribute: any, value: any, _params?: null, options?: {}, world?: null): Promise<any>;
+    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>;
+    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<{} | undefined>;
+    _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>;
+    beforeStep(world: any, step: any): Promise<void>;
+    getAriaSnapshot(): Promise<string | null>;
+    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;
+export type JsonCommandReport = {
+    type: string;
+    value?: string;
+    text: string;
+    screenshotId?: string;
+    result: JsonCommandResult;
+};
+export { StableBrowser };