automation_model 1.0.641-dev → 1.0.641-stage

package/lib/stable_browser.d.ts

@@ -17,6 +17,7 @@ export declare const Types: {
     ANALYZE_TABLE: string;
     SELECT: string;
     VERIFY_PAGE_PATH: string;
+    VERIFY_PAGE_TITLE: string;
     TYPE_PRESS: string;
     PRESS: string;
     HOVER: string;
@@ -33,6 +34,12 @@ export declare const Types: {
     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;
 };
 export declare const apps: {};
 declare class StableBrowser {
@@ -52,6 +59,7 @@ declare class StableBrowser {
     constructor(browser: Browser, page: Page, logger?: any, context?: any, world?: any);
     registerEventListeners(context: any): void;
     switchApp(appName: any): Promise<void>;
+    switchTab(tabTitleOrIndex: number | string): Promise<void>;
     registerConsoleLogListener(page: Page, context: any): void;
     registerRequestListener(page: Page, context: any, logFile: string): void;
     goto(url: string, world?: null): Promise<void>;
@@ -61,7 +69,7 @@ declare class StableBrowser {
         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>;
+    _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;
     }>;
@@ -69,7 +77,7 @@ declare class StableBrowser {
     _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<{
+    _scanLocatorsGroup(locatorsGroup: any, scope: any, _params: any, info: any, visibleOnly: any, allowDisabled?: boolean | undefined, element_name: any, logErrors?: boolean | undefined): Promise<{
         foundElements: any[];
     }>;
     simpleClick(elementDescription: any, _params?: Params, options?: {}, world?: null): Promise<void>;
@@ -84,6 +92,7 @@ declare class StableBrowser {
     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>;
+    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;
@@ -112,8 +121,10 @@ declare class StableBrowser {
     }>;
     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): {
@@ -133,14 +144,38 @@ declare class StableBrowser {
         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): 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>;
@@ -157,28 +192,20 @@ declare class StableBrowser {
     setViewportSize(width: number, hight: number, options?: {}, world?: null): Promise<void>;
     reloadPage(options?: {}, world?: null): Promise<void>;
     scrollIfNeeded(element: any, info: any): Promise<void>;
+    beforeScenario(world: any, scenario: any): Promise<void>;
+    afterScenario(world: any, scenario: any): Promise<void>;
     beforeStep(world: any, step: any): Promise<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;
-export type JsonCommandReport = {
-    type: string;
-    value?: string;
-    text: string;
-    screenshotId?: string;
-    result: JsonCommandResult;
-};
 export { StableBrowser };