testcafe 1.13.0 → 1.14.2

package/ts-defs/index.d.ts

@@ -1,7 +1,7 @@
-/// <reference types="node" />
-
-declare module 'testcafe' {
-    global {
+/// <reference types="node" />
+
+declare module 'testcafe' {
+    global {
 
         interface KeyModifiers {
             ctrl?: boolean;
@@ -99,7 +99,7 @@ declare module 'testcafe' {
             scrollTargetY?: number;
         }
 
-        interface MouseActionOptions extends ActionOptions {
+        interface OffsetOptions extends ActionOptions {
             /**
              * Mouse pointer X coordinate that define a point where the action is performed or started.
              * If an offset is a positive integer, coordinates are calculated relative to the top-left corner of the target element.
@@ -114,6 +114,10 @@ declare module 'testcafe' {
              * The default is the center of the target element.
              */
             offsetY?: number;
+        }
+
+        interface MouseActionOptions extends OffsetOptions {
+
             /**
              * Indicate which modifier keys are to be pressed during the mouse action.
              */
@@ -138,6 +142,17 @@ declare module 'testcafe' {
              * and false to insert the current text character by character.
              */
             paste?: boolean;
+            /**
+             * `true` to replace the typed text with a placeholder when sending action logs to a reporter.
+             */
+            confidential?: boolean;
+        }
+
+        interface PressActionOptions extends ActionOptions {
+            /**
+             * `true` to replace the pressed keys with a placeholder when sending action logs to a reporter.
+             */
+            confidential?: boolean;
         }
 
         interface DragToElementOptions extends MouseActionOptions {
@@ -834,7 +849,7 @@ declare module 'testcafe' {
              * @param statusCode - The response status code.
              * @param headers - Custom headers added to the response in the property-value form.
              */
-            respond(body?: object | string | ((req: RequestOptions, res: ResponseMock) => any), statusCode?: number, headers?: Record<string, string>): RequestMock;
+            respond(body?: object | string | ((req: RequestOptions, res: ResponseMock) => Promise<void>), statusCode?: number, headers?: Record<string, string>): RequestMock;
         }
 
         interface RequestMockFactory {
@@ -1690,6 +1705,8 @@ declare module 'testcafe' {
             url: URL;
         }
 
+        type ScrollPosition = 'top' | 'right' | 'bottom' | 'left' | 'topRight' | 'topLeft' | 'bottomRight' | 'bottomLeft' | 'center';
+
         interface TestController {
             /**
              * Dictionary that is shared between test hook functions and test code.
@@ -1703,6 +1720,15 @@ declare module 'testcafe' {
              * Returns an object that contains browser information.
              */
             readonly browser: Browser;
+            /**
+             * Dispatches an event over a specified webpage element.
+             *
+             * @param selector - Identifies the EventTarget element.
+             * @param eventName - The name of the event to be dispatched on the DOM element..
+             * @param options - The options which will be passed to EventConstructor.
+             */
+            dispatchEvent(selector: string | Selector | NodeSnapshot | SelectorPromise | ((...args: any[]) => Node | Node[] | NodeList | HTMLCollection),
+                          eventName: string, options?: object): TestControllerPromise;
             /**
              * Clicks a webpage element.
              *
@@ -1735,6 +1761,68 @@ declare module 'testcafe' {
              */
             hover(selector: string | Selector | NodeSnapshot | SelectorPromise | ((...args: any[]) => Node | Node[] | NodeList | HTMLCollection),
                   options?: MouseActionOptions): TestControllerPromise;
+             /**
+             * Scrolls the document element to the { scrollLeft, scrollTop } position.
+             *
+             * @param scrollLeft - The position along the horizontal axis of the document.
+             * @param scrollTop - The position along the vertical axis of the document.
+             */
+            scroll(posX: number, posY: number): TestControllerPromise;
+
+            /**
+             * Scrolls the document element to the predefined position.
+             *
+             * @param position - The position to scroll the document to. Valid values are topLeft, top, topRight, left, center, right, bottomLeft, bottom, bottomRight
+             */
+            scroll(position: ScrollPosition): TestControllerPromise;
+
+            /**
+             * Scrolls the specified element to the { scrollLeft, scrollTop } position.
+             *
+             * @param selector - Identifies the webpage element being hovered over.
+             * @param scrollLeft - The position along the horizontal axis of the document.
+             * @param scrollTop - The position along the vertical axis of the document.
+             * @param options - A set of options that provide additional parameters for the action.
+             */
+            scroll(selector: string | Selector | NodeSnapshot | SelectorPromise | ((...args: any[]) => Node | Node[] | NodeList | HTMLCollection),
+                 scrollLeft: number, scrollTop: number, options?: OffsetOptions): TestControllerPromise;
+
+            /**
+             * Scrolls the specified element to the predefined position.
+             *
+             * @param selector - Identifies the webpage element being hovered over.
+             * @param position - The position to scroll the document to. Valid values are topLeft, top, topRight, left, center, right, bottomLeft, bottom, bottomRight
+             * @param options - A set of options that provide additional parameters for the action.
+             */
+            scroll(selector: string | Selector | NodeSnapshot | SelectorPromise | ((...args: any[]) => Node | Node[] | NodeList | HTMLCollection),
+                 position: ScrollPosition, options?: OffsetOptions): TestControllerPromise;
+
+            /**
+             * Scrolls the document element by the given offset.
+             *
+             * @param scrollLeft - The horizontal pixel value that you want to scroll by.
+             * @param scrollTop - The vertical pixel value that you want to scroll by.
+             */
+            scrollBy(x: number, y: number): TestControllerPromise;
+
+            /**
+             * Scrolls the specified element by the given offset.
+             * @param selector - Identifies the webpage element being hovered over.
+             * @param scrollLeft - The horizontal pixel value that you want to scroll by.
+             * @param scrollTop - The vertical pixel value that you want to scroll by.
+             * @param options - A set of options that provide additional parameters for the action.
+             */
+            scrollBy(selector: string | Selector | NodeSnapshot | SelectorPromise | ((...args: any[]) => Node | Node[] | NodeList | HTMLCollection),
+                 x: number, y: number, options?: OffsetOptions): TestControllerPromise;
+
+            /**
+             * Scrolls the specified element into view.
+             * @param selector - Identifies the webpage element being hovered over.
+             * @param options - A set of options that provide additional parameters for the action.
+             */
+            scrollIntoView(selector: string | Selector | NodeSnapshot | SelectorPromise | ((...args: any[]) => Node | Node[] | NodeList | HTMLCollection),
+                 options?: OffsetOptions): TestControllerPromise;
+
             /**
              * Drags an element by an offset.
              *
@@ -1811,7 +1899,7 @@ declare module 'testcafe' {
              * @param keys - The sequence of keys and key combinations to be pressed.
              * @param options - A set of options that provide additional parameters for the action.
              */
-            pressKey(keys: string, options?: ActionOptions): TestControllerPromise;
+            pressKey(keys: string, options?: PressActionOptions): TestControllerPromise;
             /**
              * Pauses a test for a specified period of time.
              *
@@ -2309,7 +2397,7 @@ declare module 'testcafe' {
             /**
              * Defines whether to enable the quarantine mode.
              */
-            quarantineMode: boolean;
+            quarantineMode: boolean | Record<string, string>;
             /**
              * Specifies if tests run in the debug mode. If this option is enabled, test execution is paused before the first action or assertion allowing you to invoke the developer tools and debug. In the debug mode, you can execute the test step-by-step to reproduce its incorrect behavior. You can also use the Unlock Page switch in the footer to unlock the tested page and interact with its elements.
              */
@@ -2358,6 +2446,10 @@ declare module 'testcafe' {
              * Specifies the timeout in milliseconds to complete the AJAX requests (XHR or fetch)
              */
             ajaxRequestTimeout: number;
+            /**
+             * Prevents TestCafe from taking screenshots. When this option is specified, screenshots are not taken whenever a test fails or when t.takeScreenshot or t.takeElementScreenshot is executed.
+             */
+            disableScreenshots: boolean;
         }
 
         interface TestCafeFactory {
@@ -2372,8 +2464,8 @@ declare module 'testcafe' {
                 configFile?: string
             ): Promise<TestCafe>;
         }
-    }
-
+    }
+
 
     /**
      * Creates a selector.
@@ -2418,13 +2510,13 @@ declare module 'testcafe' {
      * The test controller used to access test run API.
      */
     export const t: TestController;
-
-    const createTestCafe: TestCafeFactory;
-
-    export default createTestCafe;
-}
-
-
+
+    const createTestCafe: TestCafeFactory;
+
+    export default createTestCafe;
+}
+
+
 
 // 
 

package/ts-defs/selectors.d.ts

@@ -1,5 +1,5 @@
-declare module 'testcafe' {
-    global {
+declare module 'testcafe' {
+    global {
 
         interface KeyModifiers {
             ctrl?: boolean;
@@ -97,7 +97,7 @@ declare module 'testcafe' {
             scrollTargetY?: number;
         }
 
-        interface MouseActionOptions extends ActionOptions {
+        interface OffsetOptions extends ActionOptions {
             /**
              * Mouse pointer X coordinate that define a point where the action is performed or started.
              * If an offset is a positive integer, coordinates are calculated relative to the top-left corner of the target element.
@@ -112,6 +112,10 @@ declare module 'testcafe' {
              * The default is the center of the target element.
              */
             offsetY?: number;
+        }
+
+        interface MouseActionOptions extends OffsetOptions {
+
             /**
              * Indicate which modifier keys are to be pressed during the mouse action.
              */
@@ -136,6 +140,17 @@ declare module 'testcafe' {
              * and false to insert the current text character by character.
              */
             paste?: boolean;
+            /**
+             * `true` to replace the typed text with a placeholder when sending action logs to a reporter.
+             */
+            confidential?: boolean;
+        }
+
+        interface PressActionOptions extends ActionOptions {
+            /**
+             * `true` to replace the pressed keys with a placeholder when sending action logs to a reporter.
+             */
+            confidential?: boolean;
         }
 
         interface DragToElementOptions extends MouseActionOptions {
@@ -832,7 +847,7 @@ declare module 'testcafe' {
              * @param statusCode - The response status code.
              * @param headers - Custom headers added to the response in the property-value form.
              */
-            respond(body?: object | string | ((req: RequestOptions, res: ResponseMock) => any), statusCode?: number, headers?: Record<string, string>): RequestMock;
+            respond(body?: object | string | ((req: RequestOptions, res: ResponseMock) => Promise<void>), statusCode?: number, headers?: Record<string, string>): RequestMock;
         }
 
         interface RequestMockFactory {
@@ -1688,6 +1703,8 @@ declare module 'testcafe' {
             url: URL;
         }
 
+        type ScrollPosition = 'top' | 'right' | 'bottom' | 'left' | 'topRight' | 'topLeft' | 'bottomRight' | 'bottomLeft' | 'center';
+
         interface TestController {
             /**
              * Dictionary that is shared between test hook functions and test code.
@@ -1701,6 +1718,15 @@ declare module 'testcafe' {
              * Returns an object that contains browser information.
              */
             readonly browser: Browser;
+            /**
+             * Dispatches an event over a specified webpage element.
+             *
+             * @param selector - Identifies the EventTarget element.
+             * @param eventName - The name of the event to be dispatched on the DOM element..
+             * @param options - The options which will be passed to EventConstructor.
+             */
+            dispatchEvent(selector: string | Selector | NodeSnapshot | SelectorPromise | ((...args: any[]) => Node | Node[] | NodeList | HTMLCollection),
+                          eventName: string, options?: object): TestControllerPromise;
             /**
              * Clicks a webpage element.
              *
@@ -1733,6 +1759,68 @@ declare module 'testcafe' {
              */
             hover(selector: string | Selector | NodeSnapshot | SelectorPromise | ((...args: any[]) => Node | Node[] | NodeList | HTMLCollection),
                   options?: MouseActionOptions): TestControllerPromise;
+             /**
+             * Scrolls the document element to the { scrollLeft, scrollTop } position.
+             *
+             * @param scrollLeft - The position along the horizontal axis of the document.
+             * @param scrollTop - The position along the vertical axis of the document.
+             */
+            scroll(posX: number, posY: number): TestControllerPromise;
+
+            /**
+             * Scrolls the document element to the predefined position.
+             *
+             * @param position - The position to scroll the document to. Valid values are topLeft, top, topRight, left, center, right, bottomLeft, bottom, bottomRight
+             */
+            scroll(position: ScrollPosition): TestControllerPromise;
+
+            /**
+             * Scrolls the specified element to the { scrollLeft, scrollTop } position.
+             *
+             * @param selector - Identifies the webpage element being hovered over.
+             * @param scrollLeft - The position along the horizontal axis of the document.
+             * @param scrollTop - The position along the vertical axis of the document.
+             * @param options - A set of options that provide additional parameters for the action.
+             */
+            scroll(selector: string | Selector | NodeSnapshot | SelectorPromise | ((...args: any[]) => Node | Node[] | NodeList | HTMLCollection),
+                 scrollLeft: number, scrollTop: number, options?: OffsetOptions): TestControllerPromise;
+
+            /**
+             * Scrolls the specified element to the predefined position.
+             *
+             * @param selector - Identifies the webpage element being hovered over.
+             * @param position - The position to scroll the document to. Valid values are topLeft, top, topRight, left, center, right, bottomLeft, bottom, bottomRight
+             * @param options - A set of options that provide additional parameters for the action.
+             */
+            scroll(selector: string | Selector | NodeSnapshot | SelectorPromise | ((...args: any[]) => Node | Node[] | NodeList | HTMLCollection),
+                 position: ScrollPosition, options?: OffsetOptions): TestControllerPromise;
+
+            /**
+             * Scrolls the document element by the given offset.
+             *
+             * @param scrollLeft - The horizontal pixel value that you want to scroll by.
+             * @param scrollTop - The vertical pixel value that you want to scroll by.
+             */
+            scrollBy(x: number, y: number): TestControllerPromise;
+
+            /**
+             * Scrolls the specified element by the given offset.
+             * @param selector - Identifies the webpage element being hovered over.
+             * @param scrollLeft - The horizontal pixel value that you want to scroll by.
+             * @param scrollTop - The vertical pixel value that you want to scroll by.
+             * @param options - A set of options that provide additional parameters for the action.
+             */
+            scrollBy(selector: string | Selector | NodeSnapshot | SelectorPromise | ((...args: any[]) => Node | Node[] | NodeList | HTMLCollection),
+                 x: number, y: number, options?: OffsetOptions): TestControllerPromise;
+
+            /**
+             * Scrolls the specified element into view.
+             * @param selector - Identifies the webpage element being hovered over.
+             * @param options - A set of options that provide additional parameters for the action.
+             */
+            scrollIntoView(selector: string | Selector | NodeSnapshot | SelectorPromise | ((...args: any[]) => Node | Node[] | NodeList | HTMLCollection),
+                 options?: OffsetOptions): TestControllerPromise;
+
             /**
              * Drags an element by an offset.
              *
@@ -1809,7 +1897,7 @@ declare module 'testcafe' {
              * @param keys - The sequence of keys and key combinations to be pressed.
              * @param options - A set of options that provide additional parameters for the action.
              */
-            pressKey(keys: string, options?: ActionOptions): TestControllerPromise;
+            pressKey(keys: string, options?: PressActionOptions): TestControllerPromise;
             /**
              * Pauses a test for a specified period of time.
              *
@@ -2031,5 +2119,5 @@ declare module 'testcafe' {
          * @param options - Function options.
          */
         export const ClientFunction: ClientFunctionFactory;
-    }
-}
+    }
+}

package/ts-defs/testcafe-scripts.d.ts

@@ -1,5 +1,5 @@
-declare module 'testcafe' {
-    global {
+declare module 'testcafe' {
+    global {
 
         interface KeyModifiers {
             ctrl?: boolean;
@@ -97,7 +97,7 @@ declare module 'testcafe' {
             scrollTargetY?: number;
         }
 
-        interface MouseActionOptions extends ActionOptions {
+        interface OffsetOptions extends ActionOptions {
             /**
              * Mouse pointer X coordinate that define a point where the action is performed or started.
              * If an offset is a positive integer, coordinates are calculated relative to the top-left corner of the target element.
@@ -112,6 +112,10 @@ declare module 'testcafe' {
              * The default is the center of the target element.
              */
             offsetY?: number;
+        }
+
+        interface MouseActionOptions extends OffsetOptions {
+
             /**
              * Indicate which modifier keys are to be pressed during the mouse action.
              */
@@ -136,6 +140,17 @@ declare module 'testcafe' {
              * and false to insert the current text character by character.
              */
             paste?: boolean;
+            /**
+             * `true` to replace the typed text with a placeholder when sending action logs to a reporter.
+             */
+            confidential?: boolean;
+        }
+
+        interface PressActionOptions extends ActionOptions {
+            /**
+             * `true` to replace the pressed keys with a placeholder when sending action logs to a reporter.
+             */
+            confidential?: boolean;
         }
 
         interface DragToElementOptions extends MouseActionOptions {
@@ -832,7 +847,7 @@ declare module 'testcafe' {
              * @param statusCode - The response status code.
              * @param headers - Custom headers added to the response in the property-value form.
              */
-            respond(body?: object | string | ((req: RequestOptions, res: ResponseMock) => any), statusCode?: number, headers?: Record<string, string>): RequestMock;
+            respond(body?: object | string | ((req: RequestOptions, res: ResponseMock) => Promise<void>), statusCode?: number, headers?: Record<string, string>): RequestMock;
         }
 
         interface RequestMockFactory {
@@ -1688,6 +1703,8 @@ declare module 'testcafe' {
             url: URL;
         }
 
+        type ScrollPosition = 'top' | 'right' | 'bottom' | 'left' | 'topRight' | 'topLeft' | 'bottomRight' | 'bottomLeft' | 'center';
+
         interface TestController {
             /**
              * Dictionary that is shared between test hook functions and test code.
@@ -1701,6 +1718,15 @@ declare module 'testcafe' {
              * Returns an object that contains browser information.
              */
             readonly browser: Browser;
+            /**
+             * Dispatches an event over a specified webpage element.
+             *
+             * @param selector - Identifies the EventTarget element.
+             * @param eventName - The name of the event to be dispatched on the DOM element..
+             * @param options - The options which will be passed to EventConstructor.
+             */
+            dispatchEvent(selector: string | Selector | NodeSnapshot | SelectorPromise | ((...args: any[]) => Node | Node[] | NodeList | HTMLCollection),
+                          eventName: string, options?: object): TestControllerPromise;
             /**
              * Clicks a webpage element.
              *
@@ -1733,6 +1759,68 @@ declare module 'testcafe' {
              */
             hover(selector: string | Selector | NodeSnapshot | SelectorPromise | ((...args: any[]) => Node | Node[] | NodeList | HTMLCollection),
                   options?: MouseActionOptions): TestControllerPromise;
+             /**
+             * Scrolls the document element to the { scrollLeft, scrollTop } position.
+             *
+             * @param scrollLeft - The position along the horizontal axis of the document.
+             * @param scrollTop - The position along the vertical axis of the document.
+             */
+            scroll(posX: number, posY: number): TestControllerPromise;
+
+            /**
+             * Scrolls the document element to the predefined position.
+             *
+             * @param position - The position to scroll the document to. Valid values are topLeft, top, topRight, left, center, right, bottomLeft, bottom, bottomRight
+             */
+            scroll(position: ScrollPosition): TestControllerPromise;
+
+            /**
+             * Scrolls the specified element to the { scrollLeft, scrollTop } position.
+             *
+             * @param selector - Identifies the webpage element being hovered over.
+             * @param scrollLeft - The position along the horizontal axis of the document.
+             * @param scrollTop - The position along the vertical axis of the document.
+             * @param options - A set of options that provide additional parameters for the action.
+             */
+            scroll(selector: string | Selector | NodeSnapshot | SelectorPromise | ((...args: any[]) => Node | Node[] | NodeList | HTMLCollection),
+                 scrollLeft: number, scrollTop: number, options?: OffsetOptions): TestControllerPromise;
+
+            /**
+             * Scrolls the specified element to the predefined position.
+             *
+             * @param selector - Identifies the webpage element being hovered over.
+             * @param position - The position to scroll the document to. Valid values are topLeft, top, topRight, left, center, right, bottomLeft, bottom, bottomRight
+             * @param options - A set of options that provide additional parameters for the action.
+             */
+            scroll(selector: string | Selector | NodeSnapshot | SelectorPromise | ((...args: any[]) => Node | Node[] | NodeList | HTMLCollection),
+                 position: ScrollPosition, options?: OffsetOptions): TestControllerPromise;
+
+            /**
+             * Scrolls the document element by the given offset.
+             *
+             * @param scrollLeft - The horizontal pixel value that you want to scroll by.
+             * @param scrollTop - The vertical pixel value that you want to scroll by.
+             */
+            scrollBy(x: number, y: number): TestControllerPromise;
+
+            /**
+             * Scrolls the specified element by the given offset.
+             * @param selector - Identifies the webpage element being hovered over.
+             * @param scrollLeft - The horizontal pixel value that you want to scroll by.
+             * @param scrollTop - The vertical pixel value that you want to scroll by.
+             * @param options - A set of options that provide additional parameters for the action.
+             */
+            scrollBy(selector: string | Selector | NodeSnapshot | SelectorPromise | ((...args: any[]) => Node | Node[] | NodeList | HTMLCollection),
+                 x: number, y: number, options?: OffsetOptions): TestControllerPromise;
+
+            /**
+             * Scrolls the specified element into view.
+             * @param selector - Identifies the webpage element being hovered over.
+             * @param options - A set of options that provide additional parameters for the action.
+             */
+            scrollIntoView(selector: string | Selector | NodeSnapshot | SelectorPromise | ((...args: any[]) => Node | Node[] | NodeList | HTMLCollection),
+                 options?: OffsetOptions): TestControllerPromise;
+
             /**
              * Drags an element by an offset.
              *
@@ -1809,7 +1897,7 @@ declare module 'testcafe' {
              * @param keys - The sequence of keys and key combinations to be pressed.
              * @param options - A set of options that provide additional parameters for the action.
              */
-            pressKey(keys: string, options?: ActionOptions): TestControllerPromise;
+            pressKey(keys: string, options?: PressActionOptions): TestControllerPromise;
             /**
              * Pauses a test for a specified period of time.
              *
@@ -2059,8 +2147,8 @@ declare module 'testcafe' {
          * The test controller used to access test run API.
          */
         export const t: TestController;
-    }
-
+    }
+
 
     /**
      * Creates a selector.
@@ -2105,4 +2193,4 @@ declare module 'testcafe' {
      * The test controller used to access test run API.
      */
     export const t: TestController;
-}
+}