@types/k6 0.44.1 → 0.44.2

k6/experimental/{browser.d.ts → browser/page.d.ts}

@@ -1,7 +1,21 @@
-/**
- * This module provides an experimental implementation that brings browser
- * test automation to the k6 testing platform.
- */
+import {
+    BrowserContext,
+    EvaluationArgument,
+    PageFunction,
+    SelectOptionsObject,
+    KeyboardModifier,
+    MouseButton,
+    ScreenshotOptions,
+    NavigationOptions } from "./";
+import { Touchscreen } from "./touchscreen";
+import { Response } from "./response";
+import { Locator } from "./locator";
+import { JSHandle } from "./js_handle";
+import { Keyboard } from "./keyboard";
+import { Mouse } from "./mouse";
+import { ElementHandle } from "./element_handle";
+import { Frame } from "./frame";
+import { Worker } from "./worker";
 
 /**
  * Page provides methods to interact with a single tab in a running web browser
@@ -82,7 +96,7 @@ export class Page {
      * The mouse button (`left`, `middle` or `right`) to use during the action.
      * Defaults to `left`.
      */
-    button?: "left"|"right"|"middle";
+    button?: MouseButton;
 
     /**
      * The number of times the action is performed. Defaults to `1`.
@@ -105,7 +119,7 @@ export class Page {
      * action. If not specified, currently pressed modifiers are used,
      * otherwise defaults to `null`.
      */
-    modifiers?: Array<"Alt"|"Control"|"Meta"|"Shift">;
+    modifiers?: KeyboardModifier[];
 
     /**
      * If set to `true` and a navigation occurs from performing this action, it
@@ -175,7 +189,7 @@ export class Page {
      * The mouse button (`left`, `middle` or `right`) to use during the action.
      * Defaults to `left`.
      */
-    button?: "left"|"right"|"middle";
+    button?: MouseButton;
 
     /**
      * Milliseconds to wait between `mousedown` and `mouseup`. Defaults to `0`.
@@ -193,7 +207,7 @@ export class Page {
      * action. If not specified, currently pressed modifiers are used,
      * otherwise defaults to `null`.
      */
-    modifiers?: Array<"Alt"|"Control"|"Meta"|"Shift">;
+    modifiers?: KeyboardModifier[];
 
     /**
      * If set to `true` and a navigation occurs from performing this action, it
@@ -438,39 +452,7 @@ export class Page {
    * `https://`.
    * @param options
    */
-  goto(url: string, options?: {
-    /**
-     * Referer header value.
-     */
-    referer?: string;
-
-    /**
-     * Maximum operation time in milliseconds. Defaults to `30` seconds. The
-     * default value can be changed via the
-     * browserContext.setDefaultNavigationTimeout(timeout),
-     * browserContext.setDefaultTimeout(timeout),
-     * page.setDefaultNavigationTimeout(timeout) or
-     * page.setDefaultTimeout(timeout) methods.
-     *
-     * Setting the value to `0` will disable the timeout.
-     *
-     */
-    timeout?: number;
-
-    /**
-     * When to consider operation succeeded, defaults to `load`. Events can be
-     * either:
-     * - `'domcontentloaded'` - consider operation to be finished when the
-     * `DOMContentLoaded` event is fired.
-     * - `'load'` - consider operation to be finished when the `load` event is
-     * fired.
-     * - `'networkidle'` - **DISCOURAGED** consider operation to be finished
-     * when there are no network connections for at least `500` ms. Don't use
-     * this method for testing especially with chatty websites where the event
-     * may never fire, rely on web assertions to assess readiness instead.
-     */
-    waitUntil?: "load"|"domcontentloaded"|"networkidle";
-  }): Promise<null|Response>;
+  goto(url: string, options?: NavigationOptions): Promise<null|Response>;
 
   /**
    * **NOTE** Use locator-based locator.hover([options]) instead.
@@ -493,7 +475,7 @@ export class Page {
      * action. If not specified, currently pressed modifiers are used,
      * otherwise defaults to `null`.
      */
-    modifiers?: Array<"Alt"|"Control"|"Meta"|"Shift">;
+    modifiers?: KeyboardModifier[];
 
     /**
      * If set to `true` and a navigation occurs from performing this action, it
@@ -942,31 +924,7 @@ export class Page {
      * the currently visible viewport. Defaults to `false`.
      */
     fullPage?: boolean;
-
-    /**
-     * Hides default white background and allows capturing screenshots with
-     * transparency. Not applicable to `jpeg` images. Defaults to `false`.
-     */
-    omitBackground?: boolean;
-
-    /**
-     * The file path to save the image to. The screenshot type will be inferred
-     * from file extension. If `path` is a relative path, then it is resolved
-     * relative to the current working directory. If no path is provided, the
-     * image won't be saved to the disk.
-     */
-    path?: string;
-
-    /**
-     * The quality of the image, between 0-100; `jpeg` only.
-     */
-    quality?: number;
-
-    /**
-     * Specify screenshot type, defaults to `png`.
-     */
-    type?: "png"|"jpeg";
-   }): ArrayBuffer;
+   } & ScreenshotOptions): ArrayBuffer;
 
   /**
    * **NOTE** Use locator-based locator.selectOption(values[, options]) instead.
@@ -1113,7 +1071,7 @@ export class Page {
      * action. If not specified, currently pressed modifiers are used,
      * otherwise defaults to `null`.
      */
-    modifiers?: Array<"Alt"|"Control"|"Meta"|"Shift">;
+    modifiers?: KeyboardModifier[];
 
     /**
      * If set to `true` and a navigation occurs from performing this action, it
@@ -1472,102 +1430,3 @@ export class Page {
    */
   $$(selector: string): ElementHandle[];
 }
-
-/**
- * `BrowserContexts` provide a way to operate multiple independent sessions, with
- * separate pages, cache, and cookies.
- */
-export class BrowserContext {}
-
-/**
- * JSHandle represents an in-page JavaScript object.
- */
-export class JSHandle<T = any> {}
-
-/**
- * Frame represents the frame within a page. A page is made up of hierarchy of frames.
- */
-export class Frame {}
-
-/**
- * Response class represents responses which are received by page.
- */
-export class Response {}
-
-/**
- * Keyboard provides an api for managing a virtual keyboard.
- */
-export class Keyboard {}
-
-/**
- * Mouse provides an api for managing a virtual mouse.
- */
-export class Mouse {}
-
-/**
- * The Locator API makes it easier to work with dynamically changing elements.
- * Some of the benefits of using it over existing ways to locate an element
- * (e.g. Page.$()) include:
- *
- * - Helps with writing robust tests by finding an element even if the
- * underlying frame navigates.
- * - Makes it easier to work with dynamic web pages and SPAs built with Svelte,
- * React, Vue, etc.
- */
-export class Locator {}
-
-/**
- * ElementHandle represents an in-page DOM element.
- */
-export class ElementHandle {}
-
-/**
- * Touchscreen provides an api for interacting with a virtual touchscreen. It
- * in main-frame CSS pixels relative to the top-left corner of the viewport.
- */
-export class Touchscreen {}
-
-/**
- * The Worker class represents a [WebWorker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API).
- */
-export class Worker {}
-
-/**
- * Represents event-specific properties. Refer to the events documentation for
- * the lists of initial properties:
- * - [DragEvent](https://developer.mozilla.org/en-US/docs/Web/API/DragEvent/DragEvent)
- * - [FocusEvent](https://developer.mozilla.org/en-US/docs/Web/API/FocusEvent/FocusEvent)
- * - [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/KeyboardEvent)
- * - [MouseEvent](https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/MouseEvent)
- * - [PointerEvent](https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent/PointerEvent)
- * - [TouchEvent](https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent/TouchEvent)
- * - [Event](https://developer.mozilla.org/en-US/docs/Web/API/Event/Event)
- */
-export type EvaluationArgument = object;
-
-export type PageFunction<Arg, R> = string | ((arg: Unboxed<Arg>) => R);
-
-export type Unboxed<Arg> =
-  Arg extends [infer A0, infer A1] ? [Unboxed<A0>, Unboxed<A1>] :
-  Arg extends [infer A0, infer A1, infer A2] ? [Unboxed<A0>, Unboxed<A1>, Unboxed<A2>] :
-  Arg extends [infer A0, infer A1, infer A2, infer A3] ? [Unboxed<A0>, Unboxed<A1>, Unboxed<A2>, Unboxed<A3>] :
-  Arg extends Array<infer T> ? Array<Unboxed<T>> :
-  Arg extends object ? { [Key in keyof Arg]: Unboxed<Arg[Key]> } :
-  Arg;
-
-  export interface SelectOptionsObject {
-    /**
-     * Matches by `option.value`.
-     */
-    value?: string;
-
-    /**
-     * Matches by `option.label`.
-     */
-    label?: string;
-
-    /**
-     * Matches by the index.
-     */
-    index?: number;
-  }

k6/experimental/browser/request.d.ts

@@ -0,0 +1,101 @@
+import { ResourceType, ResourceTiming } from "./";
+import { Response } from "./response";
+import { Frame } from "./frame";
+
+/**
+ * Request class represents requests which are sent by a page.
+ */
+export class Request {
+  /**
+   * An object with HTTP headers associated with the request. All header names are
+   * lower-case.
+   * @returns The headers object.
+   */
+  allHeaders(): Record<string, string>;
+
+  /**
+   * @returns the Frame that initiated this request
+   */
+  frame(): Frame;
+
+  /**
+   * An object with HTTP headers associated with the request. All header names are
+   * lower-case.
+   * @returns An object with HTTP headers associated with the request.
+   */
+  headers(): Record<string, string>;
+
+  /**
+   * An array with all the request HTTP headers. Unlike `Request.allHeaders()`,
+   * header names are not lower-cased. Headers with multiple entries, such as
+   * `Set-Cookie`, appear in the array multiple times.
+   * @returns An array of all the request HTTP headers.
+   */
+  headersArray(): Array<{ name: string; value: string }>;
+
+  /**
+   * Retuns the value of the header matching the name. The name is case insensitive.
+   * @param name Header name to retrieve value for.
+   * @returns The value of the header matching the name.
+   */
+  headerValue(name: string): string | null;
+
+  /**
+   * @returns a boolean stating whether the request is for a navigation
+   */
+  isNavigationRequest(): boolean;
+
+  /**
+   * Request's method (GET, POST, etc.)
+   * @returns request's method name
+   */
+  method(): string;
+
+  /**
+   * Contains the request's post body, if any.
+   * @returns request's post body
+   */
+  postData(): string;
+
+  /**
+   * Request's post body in a binary form, if any.
+   * @returns an ArrayBuffer with request's post data
+   */
+  postDataBuffer(): ArrayBuffer | null;
+
+  /**
+   * Contains the request's resource type as it was perceived by the rendering engine.
+   * ResourceType will be one of the following: `document`, `stylesheet`, `image`,
+   * `media`, `font`, `script`, `texttrack`, `xhr`, `fetch`, `eventsource`,
+   * `websocket`, `manifest`, `other`.
+   * @returns resource type name
+   */
+  resourceType(): ResourceType;
+
+  /**
+   * Returns the matching `Response` object, or `null` if the response was not received
+   * due to error.
+   * @returns The `Response` object, or `null` if the response was not received due to error.
+   */
+  response(): Response | null;
+
+  /**
+   * Returns resource size information for given request.
+   * @returns Resource size information for given request.
+   */
+  size(): { body: number; headers: number };
+
+  /**
+   * Returns resource timing information for given request. Most of the timing values
+   * become available upon the response, `responseEnd` becomes available when request
+   * finishes.
+   * @returns Resource timing information for given request.
+   */
+  timing(): ResourceTiming;
+
+  /**
+   * URL of the request.
+   * @returns request URL
+   */
+  url(): string;
+}

k6/experimental/browser/response.d.ts

@@ -0,0 +1,115 @@
+import { SecurityDetailsObject } from './';
+import { Request } from "./request";
+import { Frame } from "./frame";
+
+/**
+ * Response class represents responses which are received by page.
+ */
+export class Response {
+  /**
+   * An object with HTTP headers associated with the response. All header names are
+   * lower-case.
+   * @returns The headers object.
+   */
+  allHeaders(): Record<string, string>;
+
+  /**
+   * Returns the response body.
+   * @returns A buffer with response body.
+   */
+  body(): ArrayBuffer;
+
+  /**
+   * @returns the Frame that initiated this response
+   */
+  frame(): Frame;
+
+  /**
+   * An object with HTTP headers associated with the response. All header names are
+   * lower-case.
+   * @returns The headers object.
+   */
+  headers(): Record<string, string>;
+
+  /**
+   * An array with all the request HTTP response headers. Unlike `Response.headers()`, header
+   * names are not lower-cased. Headers with multiple entries, such as `Set-Cookie`,
+   * appear in the array multiple times.
+   * @returns An array of all the request HTTP headers.
+   */
+  headersArray(): Array<{ name: string, value: string }>;
+
+  /**
+   * Returns the value of the header matching the name. The name is case insensitive.
+   * If multiple headers have the same name (except `Set-Cookie`), they are returned
+   * as a list separated by ``,``. For `Set-Cookie`, the `\n` separator is used. If
+   * no headers are found, `null` is returned.
+   * @param name Header name to retrieve value for.
+   * @returns The header value for the given name.
+   */
+  headerValue(name: string): string|null;
+
+  /**
+   * Returns all values of the headers matching the name, for example `set-cookie`.
+   * The name is case insensitive.
+   * @param name Header name to retrieve values for.
+   * @returns An array of header values for the given name.
+   */
+  headerValues(name: string): string[];
+
+  /**
+   * Returns the JSON representation of response body. Throws if response body is not
+   * parsable via `JSON.parse`.
+   * @returns JSON representation of response body.
+   */
+  json(): any;
+
+  /**
+   * Contains a boolean stating whether the response was successful (status in the
+   * range 200-299) or not.
+   * @returns a boolean stating whether the response was successful
+   */
+  ok(): boolean;
+
+  /**
+   * The request that was used to produce the response.
+   * @returns the matching `Request` object
+   */
+  request(): Request;
+
+  /**
+   * Security details associated with this response.
+   * @returns A matching `SecurityDetailsObject`
+   */
+  securityDetails(): SecurityDetailsObject|null;
+
+  /**
+   * Returns the IP address and port of the server for this response.
+   * @returns The IP address and port of the server
+   */
+  serverAddr(): { ipAddress: string; port: number }|null;
+
+  /**
+   * Contains the status code of the response (e.g., 200 for a success).
+   * @returns the status code of the response
+   */
+  status(): number;
+
+  /**
+   * Contains the status text of the response (e.g. usually an "OK" for a success).
+   * @returns the status text of the response
+   */
+  statusText(): string;
+
+  /**
+   * The size of the response body and the headers.
+   * @returns The size of the response body and the headers.
+   */
+  size(): { body: number; headers: number };
+
+  /**
+   * Contains the URL of the response.
+   * @returns the URL of the response
+   */
+  url(): string;
+}

k6/experimental/browser/touchscreen.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Touchscreen provides an api for interacting with a virtual touchscreen. It
+ * operates in main-frame CSS pixels relative to the top-left corner of the
+ * viewport.
+ */
+export class Touchscreen {
+  /**
+   * Taps on the specified position (`x`,`y`), which internally dispatches a `touchstart` and `touchend` event.
+   * @param x The x position.
+   * @param y The y position.
+   */
+  tap(x: number, y: number): void;
+}

k6/experimental/browser/worker.d.ts

@@ -0,0 +1,13 @@
+import { PageFunction } from ".";
+import { JSHandle } from "./js_handle";
+
+/**
+ * The Worker class represents a [WebWorker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API).
+ */
+export class Worker {
+  /**
+   * Get the URL of the web worker.
+   * @return The URL of the web worker.
+   */
+  url(): string;
+}

k6/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/k6",
-    "version": "0.44.1",
+    "version": "0.44.2",
     "description": "TypeScript definitions for k6",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/k6",
     "license": "MIT",
@@ -60,6 +60,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "682e46b4410e1338c96b7b05df4cb618809adceb3857d43f06b155bfbd799e21",
+    "typesPublisherContentHash": "195015b205e4b6aaf08d145b291e14fb39ef2fb1ca71b6d3b1cfb305b81593fb",
     "typeScriptVersion": "4.3"
 }