@types/k6 0.49.3 → 0.50.1

k6/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for k6 (https://grafana.com/docs/k6/lates
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/k6.
 
 ### Additional Details
- * Last updated: Tue, 19 Mar 2024 08:35:31 GMT
+ * Last updated: Tue, 23 Apr 2024 12:10:41 GMT
  * Dependencies: none
 
 # Credits

k6/experimental/browser.d.ts

@@ -115,6 +115,23 @@ export interface EventSequenceOptions {
     delay?: number;
 }
 
+export interface File {
+    /**
+     * File name
+     */
+    name: string;
+
+    /**
+     * File type
+     */
+    mimeType: string;
+
+    /**
+     * File content
+     */
+    buffer: ArrayBuffer;
+}
+
 export type ElementHandleOptions = {
     /**
      * Setting this to `true` will bypass the actionability checks (visible,
@@ -626,6 +643,11 @@ export interface Browser {
         options?: NewBrowserContextOptions,
     ): Page;
 
+    /**
+     * Returns the browser application's user agent.
+     */
+    userAgent(): string;
+
     /**
      * Returns the browser application's version.
      */
@@ -637,6 +659,33 @@ export interface Browser {
  * separate pages, cache, and cookies.
  */
 export interface BrowserContext {
+    /**
+     * Adds a script which will be evaluated in one of the following scenarios:
+     * - Whenever a page is created in the browser context or is navigated.
+     * - Whenever a child frame is attached or navigated in any page in the
+     *   browser context. In this case, the script is evaluated in the context
+     *   of the newly attached frame.
+     *
+     * The script is evaluated after the document is created but before any of
+     * its scripts were run. This is useful to amend the JavaScript environment,
+     * e.g. to override `Math.random`.
+     *
+     * **Usage**
+     *
+     * An example of overriding `Math.random` before the page loads:
+     *
+     * ```js
+     * const browserContext = browser.newContext();
+     * browserContext.addInitScript("Math.random = function(){return 0}");
+     *
+     * const page = browserContext.newPage();
+     * await page.goto(url);
+     * ```
+     *
+     * @param script Script to be evaluated in all pages in the browser context.
+     */
+    addInitScript(script: string | { content?: string }): void;
+
     /**
      * Returns the `Browser` instance that this `BrowserContext` belongs to.
      */
@@ -1001,12 +1050,163 @@ export interface ElementHandle extends JSHandle {
      */
     boundingBox(): Rect;
 
+    /**
+     * Checks the checkbox element.
+     * @param options The options to use.
+     */
+    check(options?: ElementClickOptions & StrictnessOptions): void;
+
+    /**
+     * Clicks the element.
+     * @param options The options to use.
+     * @returns A promise that resolves when the element is clicked.
+     */
+    click(
+        options?: {
+            /**
+             * The mouse button (`left`, `middle` or `right`) to use during the action.
+             * Defaults to `left`.
+             */
+            button?: MouseButton;
+
+            /**
+             * The number of times the action is performed. Defaults to `1`.
+             */
+            clickCount?: number;
+
+            /**
+             * Milliseconds to wait between `mousedown` and `mouseup`. Defaults to `0`.
+             */
+            delay?: number;
+
+            /**
+             * Setting this to `true` will bypass the actionability checks (`visible`,
+             * `stable`, `enabled`). Defaults to `false`.
+             */
+            force?: boolean;
+
+            /**
+             * `Alt`, `Control`, `Meta` or `Shift` modifiers keys pressed during the
+             * action. If not specified, currently pressed modifiers are used,
+             * otherwise defaults to `null`.
+             */
+            modifiers?: KeyboardModifier[];
+
+            /**
+             * If set to `true` and a navigation occurs from performing this action, it
+             * will not wait for it to complete. Defaults to `false`.
+             */
+            noWaitAfter?: boolean;
+
+            /**
+             * A point to use relative to the top left corner of the element. If not
+             * supplied, a visible point of the element is used.
+             */
+            position?: {
+                x: number;
+
+                y: number;
+            };
+
+            /**
+             * Maximum time in milliseconds. Defaults to `30` seconds. Default is
+             * overridden by the `setDefaultTimeout` option on `BrowserContext` or
+             * `page` methods.
+             *
+             * Setting the value to `0` will disable the timeout.
+             */
+            timeout?: number;
+
+            /**
+             * Setting this to `true` will perform the actionability checks without
+             * performing the action. Useful to wait until the element is ready for the
+             * action without performing it. Defaults to `false`.
+             */
+            trial?: boolean;
+        },
+    ): Promise<void>;
+
     /**
      * Get the content frame for element handles.
      * @returns The content frame handle of the element handle.
      */
     contentFrame(): Frame;
 
+    /**
+     * Double clicks the element.
+     * @param options The options to use.
+     */
+    dblclick(
+        options?: {
+            /**
+             * The mouse button (`left`, `middle` or `right`) to use during the action.
+             * Defaults to `left`.
+             */
+            button?: MouseButton;
+
+            /**
+             * Milliseconds to wait between `mousedown` and `mouseup`. Defaults to `0`.
+             */
+            delay?: number;
+
+            /**
+             * Setting this to `true` will bypass the actionability checks (`visible`,
+             * `stable`, `enabled`). Defaults to `false`.
+             */
+            force?: boolean;
+
+            /**
+             * `Alt`, `Control`, `Meta` or `Shift` modifiers keys pressed during the
+             * action. If not specified, currently pressed modifiers are used,
+             * otherwise defaults to `null`.
+             */
+            modifiers?: KeyboardModifier[];
+
+            /**
+             * If set to `true` and a navigation occurs from performing this action, it
+             * will not wait for it to complete. Defaults to `false`.
+             */
+            noWaitAfter?: boolean;
+
+            /**
+             * A point to use relative to the top left corner of the element. If not
+             * supplied, a visible point of the element is used.
+             */
+            position?: {
+                x: number;
+
+                y: number;
+            };
+
+            /**
+             * Maximum time in milliseconds. Defaults to `30` seconds. Default is
+             * overridden by the `setDefaultTimeout` option on `BrowserContext` or
+             * `page` methods.
+             *
+             * Setting the value to `0` will disable the timeout.
+             */
+            timeout?: number;
+
+            /**
+             * Setting this to `true` will perform the actionability checks without
+             * performing the action. Useful to wait until the element is ready for the
+             * action without performing it. Defaults to `false`.
+             */
+            trial?: boolean;
+        },
+    ): void;
+
+    /**
+     * Dispatches a DOM event to the element.
+     * @param type DOM event type: `"click"` etc.
+     * @param eventInit Optional event-specific initialization properties.
+     * @param options
+     */
+    dispatchEvent(
+        type: string,
+        eventInit?: EvaluationArgument,
+    ): void;
+
     /**
      * Fill the `input` or `textarea` element with the provided `value`.
      * @param value Value to fill for the `input` or `textarea` element.
@@ -1131,6 +1331,33 @@ export interface ElementHandle extends JSHandle {
      */
     selectText(options?: ElementHandleOptions): void;
 
+    /**
+     * Sets the file input element's value to the specified files.
+     *
+     * To work with local files on the file system, use the experimental
+     * fs module to load and read the file contents.
+     *
+     * The {@link ElementHandle | element handle} must be an [input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input).
+     * @param files
+     * @param options
+     */
+    setInputFiles(files: File | File[], options?: {
+        /**
+         * Maximum time in milliseconds. Pass 0 to disable the timeout. Default
+         * is overridden by the setDefaultTimeout option on {@link BrowserContext} or
+         * {@link Page}.
+         * @default 30000
+         */
+        timeout?: number;
+
+        /**
+         * If set to `true` and a navigation occurs from performing this action, it
+         * does not wait for it to complete.
+         * @default false
+         */
+        noWaitAfter?: boolean;
+    }): void;
+
     /**
      * Scrolls element into view if needed, and then uses `page.tapscreen` to tap in the center of the element
      * or at the specified position.
@@ -1482,6 +1709,36 @@ export interface Frame {
      */
     isVisible(selector: string, options?: StrictnessOptions): boolean;
 
+    /**
+     * Sets the file input element's value to the specified files.
+     *
+     * To work with local files on the file system, use the experimental
+     * fs module to load and read the file contents.
+     *
+     * This method expects a `selector` to point to an
+     * [input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input).
+     * @param selector A selector to search for an element. If there are multiple
+     * elements satisfying the selector, the first will be used.
+     * @param files
+     * @param options
+     */
+    setInputFiles(selector: string, files: File | File[], options?: {
+        /**
+         * Maximum time in milliseconds. Pass 0 to disable the timeout. Default
+         * is overridden by the setDefaultTimeout option on {@link BrowserContext} or
+         * {@link Page}
+         * @default 30000
+         */
+        timeout?: number;
+
+        /**
+         * If set to `true` and a navigation occurs from performing this action, it
+         * will not wait for it to complete.
+         * @default false
+         */
+        noWaitAfter?: boolean;
+    }): void;
+
     /**
      * Wait for the given function to return a truthy value.
      * @param predicate The function to call and wait for.
@@ -1559,7 +1816,7 @@ export interface JSHandle<T = any> {
     evaluateHandle<R, Arg>(pageFunction: PageFunction<Arg, R>, arg?: Arg): JSHandle<R>;
 
     /**
-     * Fethes a map with own property names of of the `JSHandle` with their values as
+     * Fetches a map with own property names of of the `JSHandle` with their values as
      * `JSHandle` instances.
      * @returns A map with property names as keys and `JSHandle` instances for the property values.
      */
@@ -2917,6 +3174,36 @@ export interface Page {
      */
     setExtraHTTPHeaders(headers: { [key: string]: string }): void;
 
+    /**
+     * Sets the file input element's value to the specified files.
+     *
+     * To work with local files on the file system, use the experimental
+     * fs module to load and read the file contents.
+     *
+     * This method expects a `selector` to point to an
+     * [input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input).
+     * @param selector A selector to search for an element. If there are multiple
+     * elements satisfying the selector, the first will be used.
+     * @param files
+     * @param options
+     */
+    setInputFiles(selector: string, files: File | File[], options?: {
+        /**
+         * Maximum time in milliseconds. Pass 0 to disable the timeout. Default
+         * is overridden by the setDefaultTimeout option on {@link BrowserContext} or
+         * {@link Page}
+         * @default 30000
+         */
+        timeout?: number;
+
+        /**
+         * If set to `true` and a navigation occurs from performing this action, it
+         * will not wait for it to complete.
+         * @default false
+         */
+        noWaitAfter?: boolean;
+    }): void;
+
     /**
      * This will update the page's width and height.
      *

k6/experimental/timers.d.ts

@@ -3,7 +3,7 @@
  */
 
 /**
- * Set a timer which execution a function once the timer expires.
+ * Set a timer that executes a function once the timer expires.
  *
  * @param functionRef - The function to be executed.
  * @param delay - The delay in milliseconds.
@@ -13,7 +13,7 @@
 export function setTimeout(functionRef: (...args: any[]) => void, delay: number, ...args: any[]): TimeoutID;
 
 /**
- * Cancels a timeout previously set with setTimeout().
+ * Cancels a timer previously set with setTimeout().
  *
  * @param timeoutID - The timer id to be cancelled.
  */
@@ -30,7 +30,7 @@ export function clearTimeout(timeoutID: TimeoutID): void;
 export function setInterval(functionRef: (...args: any[]) => void, delay: number, ...args: any[]): IntervalID;
 
 /**
- * Cancels a interval previously set with setInterval().
+ * Cancels an interval previously set with setInterval().
  *
  * @param intervalID - The interval id to be cancelled.
  */

k6/experimental/webcrypto.d.ts

@@ -91,14 +91,14 @@ export interface SubtleCrypto {
      *
      * To export a key, the key must have `CryptoKey.extractable` set to `true`.
      *
-     * @param format the format in which to export the key. Currently, only "raw" is supported.
+     * @param format the format in which to export the key. Currently, only "raw" and "jwk" are supported.
      * @param key the key to export.
      * @throws {InvalidAccessError} - if the key is not extractable.
      * @throws {NotSupportedError} - if the format is not supported.
      * @throws {TypeError} - when trying to use an invalid format.
      * @returns A promise that resolves with the exported key.
      */
-    exportKey(format: "raw", key: CryptoKey): Promise<ArrayBuffer>;
+    exportKey(format: "raw" | "jwk", key: CryptoKey): Promise<ArrayBuffer | JWK>;
 
     /**
      * Use the `generateKey()` method to generate a new key (for symmetric
@@ -121,7 +121,7 @@ export interface SubtleCrypto {
      * It takes as input a key in an external, portable format and gives you
      * a `CryptoKey` object that can be used in the Web Crypto API.
      *
-     * @param format the format of the key to import. Currently, only "raw" is supported.
+     * @param format the format of the key to import. Currently, only "raw" and "jwk" are supported.
      * @param keyData the key data to import.
      * @param algorithm defines the algorithm to use and any extra-parameters.
      * @param extractable indicates whether it will be possible to export the key using `SubtleCrypto.exportKey()` or `SubtleCrypto.wrapKey`.
@@ -131,8 +131,8 @@ export interface SubtleCrypto {
      * @returns A promise that resolves with the imported `CryptoKey`.
      */
     importKey(
-        format: "raw",
-        keyData: ArrayBuffer | ArrayBufferView | DataView,
+        format: "raw" | "jwk",
+        keyData: ArrayBuffer | ArrayBufferView | DataView | JWK,
         algorithm: "AES-CBC" | "AES-CTR" | "AES-GCM" | Algorithm<"AES-CBC" | "AES-CTR" | "AES-GCM"> | HmacImportParams,
         extractable: boolean,
         keyUsages: Array<"encrypt" | "decrypt" | "sign" | "verify">,
@@ -395,3 +395,16 @@ export type TypedArray =
     | Uint16Array
     | Int32Array
     | Uint32Array;
+
+/**
+ * JSON Web Key Value.
+ * JWKs are not supported for now, since webcrypto doesn't support exporting key/pairs
+ */
+export type JWKValue = null | boolean | number | string | string[] | JWK;
+
+/**
+ * Object representable with JSON Web Key.
+ */
+export interface JWK {
+    [key: string]: JWKValue;
+}

k6/index.d.ts

@@ -36,6 +36,7 @@ import "./experimental/tracing";
 import "./experimental/webcrypto";
 import "./experimental/websockets";
 import "./experimental/grpc";
+import "./timers";
 import "./ws";
 import "./net/grpc";
 

k6/options.d.ts

@@ -47,6 +47,9 @@ export interface Options {
     /** Third party collector configuration. */
     ext?: { [name: string]: CollectorOptions };
 
+    /** Cloud options */
+    cloud?: CloudOptions;
+
     /** Static hostname mapping. */
     hosts?: { [name: string]: string };
 
@@ -139,6 +142,13 @@ export interface CollectorOptions {
     [name: string]: any;
 }
 
+/**
+ * Options for the cloud.
+ */
+export interface CloudOptions {
+    [name: string]: any;
+}
+
 /**
  * Test stage.
  */

k6/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/k6",
-    "version": "0.49.3",
+    "version": "0.50.1",
     "description": "TypeScript definitions for k6",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/k6",
     "license": "MIT",
@@ -60,6 +60,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "eaa5e69f20d37937316cec29094022e50b7e7e7ebdac94b53e0c32540754bec4",
+    "typesPublisherContentHash": "2a8f07e9cc2b17f1c90d400665135022e7c3b213f384fe82ffa9ae439704d942",
     "typeScriptVersion": "4.7"
 }

k6/timers.d.ts

@@ -0,0 +1,47 @@
+/**
+ *  This module provides setInterval, setTimeout and co.
+ */
+
+/**
+ * Set a timer that executes a function once the timer expires.
+ *
+ * @param functionRef - The function to be executed.
+ * @param delay - The delay in milliseconds.
+ * @param args - The arguments to be passed to the function.
+ * @returns The timer id.
+ */
+export function setTimeout(functionRef: (...args: any[]) => void, delay: number, ...args: any[]): TimeoutID;
+
+/**
+ * Cancels a timer previously set with setTimeout().
+ *
+ * @param timeoutID - The timer id to be cancelled.
+ */
+export function clearTimeout(timeoutID: TimeoutID): void;
+
+/**
+ * Repeatedly execute a function, with a fixed time delay between each call.
+ *
+ * @param functionRef - The function to be executed.
+ * @param delay - The delay in milliseconds.
+ * @param args - The arguments to be passed to the function.
+ * @returns The interval id.
+ */
+export function setInterval(functionRef: (...args: any[]) => void, delay: number, ...args: any[]): IntervalID;
+
+/**
+ * Cancels an interval previously set with setInterval().
+ *
+ * @param intervalID - The interval id to be cancelled.
+ */
+export function clearInterval(intervalID: IntervalID): void;
+
+/**
+ * Type alias for a timer id.
+ */
+export type TimeoutID = number;
+
+/**
+ * Type alias for a interval id.
+ */
+export type IntervalID = number;