@types/k6 0.54.0 → 0.54.2

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: Mon, 30 Sep 2024 10:08:47 GMT
+ * Last updated: Thu, 14 Nov 2024 14:35:31 GMT
  * Dependencies: none
 
 # Credits

k6/browser/index.d.ts

@@ -393,19 +393,17 @@ export interface ScreenshotOptions {
  * - `mutation` - use a mutation observer
  * - `interval` - use a polling interval
  */
-export type PollingMethod = "raf" | "mutation" | "interval";
+export type PollingMethod = number | "raf" | "mutation";
 
 export interface PollingOptions {
     /**
-     * Polling method to use.
-     * @default 'raf'
+     * If `polling` is `'raf'`, then `pageFunction` is constantly executed in
+     * `requestAnimationFrame` callback. If the `polling` is `'mutation'` it
+     * will be called when a change is made to the DOM tree. If `polling` is
+     * a number, then it is treated as an interval in milliseconds at which
+     * the function would be executed. Defaults to `raf`.
      */
-    polling?: "raf" | "mutation" | "interval";
-
-    /**
-     * Polling interval in milliseconds if `polling` is set to `interval`.
-     */
-    interval?: number;
+    polling?: PollingMethod;
 }
 
 export interface ElementStateFilter {
@@ -938,6 +936,65 @@ export interface ConsoleMessage {
     type(): string;
 }
 
+/**
+ * {@link MetricMessage} objects are dispatched by page via the
+ * `page.on('metric')` event. For each metric that it measured and emitted for
+ * the page, k6 browser delivers it to the registered handlers.
+ *
+ * ```js
+ * // Listen for all metric messages in the page and call its tag method to
+ * // tag matching URLs with the new tag name.
+ * page.on('metric', (metric) => {
+ *   metric.tag({
+ *     name: 'test',
+ *     matches: [
+ *       {url: /^https:\/\/test\.k6\.io\/\?q=[0-9a-z]+$/, method: 'GET'},
+ *     ]
+ *   });
+ * });
+ * ```
+ */
+export interface MetricMessage {
+    /**
+     * tag will match the given `tagMatch.matches` with the current metric's URL
+     * and name tags. When a match is found it will use `tagMatch.name` to replace
+     * the existing URL and name tag values.
+     *
+     * Doing this helps group metrics with different URL and name tags that, in
+     * fact, reference the same resource, allowing for correlation over time and
+     * reducing the cardinality of the metrics.
+     * @param tagMatch
+     */
+    tag(tagMatch: {
+        /**
+         * The name value that replaces the current metric's URL and name
+         * tag values, if a match is found. Required, and must not be an
+         * empty string.
+         */
+        name: string;
+
+        /**
+         * An array of objects containing the matchers which will be used
+         * to match against the current metric's URL and name tags.
+         * Required.
+         */
+        matches: {
+            /**
+             * The regular expression used to find matches in the current
+             * metric's URL and name tags. Required.
+             */
+            url: RegExp;
+
+            /**
+             * Used to match the metric's method tag. It's optional, and when
+             * it's not set it will group all metrics regardless of the method
+             * tag.
+             */
+            method?: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "OPTIONS" | "HEAD" | "TRACE" | "CONNECT";
+        }[];
+    }): void;
+}
+
 /**
  * {@link Cookie} represents a cookie in a {@link BrowserContext}.
  *
@@ -2954,6 +3011,31 @@ export interface Page {
      */
     on(event: "console", listener: (consoleMessage: ConsoleMessage) => void): void;
 
+    /**
+     * page.on('metric') will register a background handler that will listen out
+     * for metrics that are measured and emitted for the page.
+     *
+     * When a {@link MetricMessage} is received by the handler, it can be used to
+     * group different metrics tagged with URL and name so that a correlation can
+     * be found and to reduce the cardinality of the metrics.
+     *
+     * **Usage**
+     *
+     * ```js
+     * // Listen for all metric messages in the page and call its tag method to
+     * // tag matching URLs with the new tag name.
+     * page.on('metric', (metric) => {
+     *   metric.tag({
+     *     name: 'test',
+     *     matches: [
+     *       {url: /^https:\/\/test\.k6\.io\/\?q=[0-9a-z]+$/, method: 'GET'},
+     *     ]
+     *   });
+     * });
+     * ```
+     */
+    on(event: "metric", listener: (metricMessage: MetricMessage) => void): void;
+
     /**
      * Returns the page that opened the current page. The first page that is
      * navigated to will have a null opener.
@@ -3552,11 +3634,12 @@ export interface Page {
         options?: {
             /**
              * If `polling` is `'raf'`, then `pageFunction` is constantly executed in
-             * `requestAnimationFrame` callback. If `polling` is a number, then it is
-             * treated as an interval in milliseconds at which the function would be
-             * executed. Defaults to `raf`.
+             * `requestAnimationFrame` callback. If the `polling` is `'mutation'` it
+             * will be called when a change is made to the DOM tree. If `polling` is
+             * a number, then it is treated as an interval in milliseconds at which
+             * the function would be executed. Defaults to `raf`.
              */
-            polling?: number | "raf";
+            polling?: PollingMethod;
 
             /**
              * Maximum time in milliseconds. Defaults to `30` seconds. Default is

k6/experimental/webcrypto/index.d.ts

@@ -43,7 +43,7 @@ export interface SubtleCrypto {
      * @returns A promise that resolves with the decrypted data (also known as "plaintext").
      */
     decrypt(
-        algorithm: AesCtrParams | AesCbcParams | AesGcmParams,
+        algorithm: AesCtrParams | AesCbcParams | AesGcmParams | RsaOaepParams,
         key: CryptoKey,
         data: ArrayBuffer | ArrayBufferView | DataView,
     ): Promise<ArrayBuffer>;
@@ -80,7 +80,7 @@ export interface SubtleCrypto {
      * @returns A promise that resolves with the encrypted data (also known as "ciphertext").
      */
     encrypt(
-        algorithm: AesCtrParams | AesCbcParams | AesGcmParams,
+        algorithm: AesCtrParams | AesCbcParams | AesGcmParams | RsaOaepParams,
         key: CryptoKey,
         data: ArrayBuffer | ArrayBufferView | DataView,
     ): Promise<ArrayBuffer>;
@@ -122,12 +122,12 @@ export interface SubtleCrypto {
      * @param extractable indicates whether it will be possible to export the key using `SubtleCrypto.exportKey()` or `SubtleCrypto.wrapKey`.
      * @param keyUsages indicates what can be done with the newly generated key.
      * @throws {SyntaxError} - if the result is a `CryptoKey` of type `secret` or `private` but `keyUsages is empty.
-     * @returns A promise that resolves with the newly generated CryptoKeyPair`.
+     * @returns A promise that resolves with the newly generated `CryptoKeyPair`.
      */
     generateKey(
-        algorithm: EcKeyGenParams,
+        algorithm: EcKeyGenParams | RSAHashedKeyGenParams,
         extractable: boolean,
-        keyUsages: Array<"sign" | "verify" | "deriveKey" | "deriveBits">,
+        keyUsages: Array<"sign" | "verify" | "deriveKey" | "deriveBits" | "encrypt" | "decrypt">,
     ): Promise<CryptoKeyPair>;
 
     /**
@@ -153,7 +153,8 @@ export interface SubtleCrypto {
             | "AES-GCM"
             | Algorithm<"AES-CBC" | "AES-CTR" | "AES-GCM">
             | HmacImportParams
-            | EcKeyImportParams,
+            | EcKeyImportParams
+            | RsaHashedImportParams,
         extractable: boolean,
         keyUsages: Array<"encrypt" | "decrypt" | "sign" | "verify" | "deriveKey" | "deriveBits">,
     ): Promise<CryptoKey>;
@@ -171,7 +172,7 @@ export interface SubtleCrypto {
      * @returns A promise that resolves with the signature.
      */
     sign(
-        algorithm: "HMAC" | Algorithm<"HMAC"> | EcdsaParams,
+        algorithm: "HMAC" | Algorithm<"HMAC"> | EcdsaParams | RsaPssParams,
         key: CryptoKey,
         data: ArrayBuffer | ArrayBufferView | DataView,
     ): Promise<ArrayBuffer>;
@@ -187,7 +188,7 @@ export interface SubtleCrypto {
      * @returns A promise that resolves with a boolean indicating whether the signature is valid.
      */
     verify(
-        algorithm: "HMAC" | Algorithm<"HMAC"> | EcdsaParams,
+        algorithm: "HMAC" | Algorithm<"HMAC"> | EcdsaParams | RsaPssParams,
         key: CryptoKey,
         signature: ArrayBuffer | ArrayBufferView | DataView,
         data: ArrayBuffer | ArrayBufferView | DataView,
@@ -381,6 +382,24 @@ export interface AesGcmParams extends Algorithm<AlgorithmIdentifier> {
     tagLength?: number;
 }
 
+/**
+ * The `RsaOaepParams` dictionary of the Web Crypto API represents the
+ * object that should be passed as the `algorithm` parameter of the
+ * `SubtleCrypto.encrypt()` and `SubtleCrypto.decrypt()` methods when
+ * using the RSA-OAEP algorithm.
+ */
+export interface RsaOaepParams extends Algorithm<AlgorithmIdentifier> {
+    /**
+     * The name of the algorithm to use.
+     */
+    name: "RSA-OAEP";
+
+    /**
+     * The label to use. If not provided, it will default to an empty ArrayBuffer.
+     */
+    label?: ArrayBuffer | ArrayBufferView | DataView;
+}
+
 /**
  * The `HmacKeyGenParams` dictionary of the Web Crypto API represents the
  * object that should be passed as the `algorithm` parameter of the
@@ -426,6 +445,34 @@ export interface EcKeyGenParams extends Algorithm<AlgorithmIdentifier> {
     namedCurve: "P-256" | "P-384" | "P-521";
 }
 
+/**
+ * The RSAHashedKeyGenParams dictionary of the Web Crypto API represents the
+ * object that should be passed as the algorithm parameter into
+ * `SubtleCrypto.generateKey()`, when the algorithm is identified
+ * as either of RSASSA-PKCS1-v1_5, RSA-PSS or RSA-OAEP.
+ */
+export interface RSAHashedKeyGenParams extends Algorithm<AlgorithmIdentifier> {
+    /**
+     * The name of the algorithm to use.
+     */
+    name: "RSASSA-PKCS1-v1_5" | "RSA-PSS" | "RSA-OAEP";
+
+    /**
+     * The modulus length, in bits.
+     */
+    modulusLength: number;
+
+    /**
+     * The public exponent.
+     */
+    publicExponent: Uint8Array;
+
+    /**
+     * The hash algorithm to use.
+     */
+    hash: HashAlgorithmIdentifier;
+}
+
 /**
  * The `HmacImportParams` dictionary of the Web Crypto API represents the
  * object that should be passed as the `algorithm` parameter of the
@@ -471,6 +518,24 @@ export interface EcKeyImportParams extends Algorithm<AlgorithmIdentifier> {
     namedCurve: "P-256" | "P-384" | "P-521";
 }
 
+/**
+ * The `RsaHashedImportParams` dictionary of the Web Crypto API represents
+ * the object that should be passed as the algorithm parameter
+ * into SubtleCrypto.importKey(), when the algorithm is identified
+ * as either of RSASSA-PKCS1-v1_5, RSA-PSS or RSA-OAEP.
+ */
+export interface RsaHashedImportParams extends Algorithm<AlgorithmIdentifier> {
+    /**
+     * The name of the algorithm to use.
+     */
+    name: "RSASSA-PKCS1-v1_5" | "RSA-PSS" | "RSA-OAEP";
+
+    /**
+     * The hash algorithm to use.
+     */
+    hash: HashAlgorithmIdentifier;
+}
+
 /**
  * The `EcdsaParams` dictionary of the Web Crypto API represents
  * the object that should be passed as the algorithm parameter
@@ -489,6 +554,24 @@ export interface EcdsaParams extends Algorithm<AlgorithmIdentifier> {
     hash: "SHA-1" | "SHA-256" | "SHA-384" | "SHA-512";
 }
 
+/**
+ * The `RsaPssParams` dictionary of the Web Crypto API represents
+ * the object that should be passed as the algorithm parameter
+ * into SubtleCrypto.sign() or SubtleCrypto.verify()
+ * when using the RSA-PSS algorithm.
+ */
+export interface RsaPssParams extends Algorithm<AlgorithmIdentifier> {
+    /**
+     * The name of the algorithm to use.
+     */
+    name: "RSA-PSS";
+
+    /**
+     * The length of the salt to use.
+     */
+    saltLength: number;
+}
+
 /**
  * The `EcdhKeyDeriveParams` dictionary of the Web Crypto API represents
  * the object that should be passed as the algorithm parameter

k6/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/k6",
-    "version": "0.54.0",
+    "version": "0.54.2",
     "description": "TypeScript definitions for k6",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/k6",
     "license": "MIT",
@@ -61,6 +61,7 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "117f96c1bd174240bb9f518388a69fc69bbb14dd874730e2db3ea53c0513b9c6",
-    "typeScriptVersion": "4.8"
+    "peerDependencies": {},
+    "typesPublisherContentHash": "aede7a67bee3eb3043ddc67d2a133744bff86187b169592fa2e7dc057aebc948",
+    "typeScriptVersion": "4.9"
 }

k6/experimental/tracing/index.d.ts

@@ -1,208 +0,0 @@
-/**
- * This module provides ways to instrument k6 scripts HTTP calls with tracing information.
- *
- * It most notably exposes an `instrumentHTTP` function that can be used to wrap the `http` module's
- * function calls with tracing information. It also exposes a `Client` class that can be used to
- * instrument HTTP calls in a more fine-grained way.
- *
- * https://grafana.com/docs/k6/latest/javascript-api/k6-experimental/tracing/
- */
-
-import { RefinedParams, RefinedResponse, RequestBody, ResponseType } from "../../http/index.js";
-
-/**
- * The instrumentHTTP function instruments the k6 http module
- * with tracing capabilities. It will transparently replace each
- * of the k6 http module functions with its instrumented
- * counterpart, in place.
- *
- * instrumentHTTP can only be called in the init context of the script.
- *
- * @param options - The options to use when instrumenting the http module.
- */
-export function instrumentHTTP(options: Options): void;
-
-/**
- * Client is an HTTP client class that attaches tracing information
- * to its requests.
- *
- * It lets users include a tracing context in their HTTP requests
- * so that tracing backends (such as Grafana Tempo) can incorporate
- * their results.
- *
- * https://grafana.com/docs/k6/latest/javascript-api/k6-experimental/tracing/client/
- */
-export class Client {
-    protected __brand: never;
-
-    /**
-     * Instantiates a new tracing Client.
-     *
-     * @param options - The options to use for this Client.
-     */
-    constructor(options: Options);
-
-    /**
-     * Performs a DELETE request instrumented with trace context
-     * headers.
-     *
-     * @param url - Request URL.
-     * @param body - Discouraged. Request body. Object form encoded.
-     * @param params - Request parameters.
-     * @returns Resulting response.
-     */
-    del<RT extends ResponseType | undefined>(
-        url: string | HttpURL,
-        body?: RequestBody | null,
-        params?: RefinedParams<RT> | null,
-    ): RefinedResponse<RT>;
-
-    /**
-     * Performs a HEAD request instrumented with trace context headers.
-     *
-     * @param url - Request URL.
-     * @param params - Request parameters.
-     * @returns Resulting response.
-     */
-    head<RT extends ResponseType | undefined>(
-        url: string | HttpURL,
-        params?: RefinedParams<RT> | null,
-    ): RefinedResponse<RT>;
-
-    /**
-     * Performs a GET request instrumented with trace context headers.
-     *
-     * @param url - Request URL.
-     * @param params - Request parameters.
-     * @returns Resulting response.
-     */
-    get<RT extends ResponseType | undefined>(
-        url: string | HttpURL,
-        params?: RefinedParams<RT> | null,
-    ): RefinedResponse<RT>;
-
-    /**
-     * Performs an OPTIONS request instrumented with trace context headers.
-     *
-     * @param url - Request URL.
-     * @param body - Request body. Object form encoded.
-     * @param params - Request parameters.
-     * @returns Resulting response.
-     */
-    options<RT extends ResponseType | undefined>(
-        url: string | HttpURL,
-        body?: RequestBody | null,
-        params?: RefinedParams<RT> | null,
-    ): RefinedResponse<RT>;
-
-    /**
-     * Performs a PATCH request instrumented with trace context headers.
-     *
-     * @param url - Request URL.
-     * @param body - Request body. Object form encoded.
-     * @param params - Request parameters.
-     * @returns Resulting response.
-     */
-    patch<RT extends ResponseType | undefined>(
-        url: string | HttpURL,
-        body?: RequestBody | null,
-        params?: RefinedParams<RT> | null,
-    ): RefinedResponse<RT>;
-
-    /**
-     * Performs a POST request instrumented with trace context headers.
-     *
-     * @param url - Request URL.
-     * @param body - Request body. Object form encoded.
-     * @param params - Request parameters.
-     * @returns Resulting response.
-     */
-    post<RT extends ResponseType | undefined>(
-        url: string | HttpURL,
-        body?: RequestBody | null,
-        params?: RefinedParams<RT> | null,
-    ): RefinedResponse<RT>;
-
-    /**
-     * Performs a PUT request instrumented with trace context headers.
-     *
-     * @param url - Request URL.
-     * @param body - Request body. Object form encoded.
-     * @param params - Request parameters.
-     * @returns Resulting response.
-     */
-    put<RT extends ResponseType | undefined>(
-        url: string | HttpURL,
-        body?: RequestBody | null,
-        params?: RefinedParams<RT> | null,
-    ): RefinedResponse<RT>;
-
-    /**
-     * Performs a HTTP request instrumented with trace context headers.
-     *
-     * @param method - HTTP method.
-     * @param url - Request URL.
-     * @param body - Request body. Object form encoded.
-     * @param params - Request parameters.
-     * @returns Resulting response.
-     */
-    request<RT extends ResponseType | undefined>(
-        method: string,
-        url: string | HttpURL,
-        body?: RequestBody | null,
-        params?: RefinedParams<RT> | null,
-    ): RefinedResponse<RT>;
-
-    /**
-     * The asyncRequest method starts the process of performing a HTTP request
-     * asynchronously, returning a promise which is fulfilled once the response
-     * is available. The performed request is instrumented with trace context
-     * headers.
-     *
-     * @param method - HTTP method.
-     * @param url - Request URL.
-     * @param body - Request body. Object form encoded.
-     * @param params - Request parameters.
-     * @returns Resulting response.
-     */
-    asyncRequest<RT extends ResponseType | undefined>(
-        method: string,
-        url: string | HttpURL,
-        body?: RequestBody | null,
-        params?: RefinedParams<RT> | null,
-    ): Promise<RefinedResponse<RT>>;
-}
-
-/**
- * The Options object allows configuring the tracing instrumentation behavior.
- *
- * https://grafana.com/docs/k6/latest/javascript-api/k6-experimental/tracing/options/
- */
-export interface Options {
-    /**
-     * The trace context propagation format.
-     *
-     * Currently supported: `w3c` and `jaeger`.
-     *
-     * Defaults to `w3c`.
-     */
-    propagator: "w3c" | "jaeger";
-
-    /**
-     * The probability of each request having
-     * its `sampled` flag set to true.
-     * Its value should be within the `0 <= n <= 100` bounds.
-     *
-     * Defaults to `100`.
-     */
-    sampling?: number;
-}
-
-/**
- * Returned value from http.url method.
- */
-export interface HttpURL {
-    __brand: "http-url";
-}
-
-export * as default from "k6/experimental/tracing";