@types/k6 0.53.0 → 0.53.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: Tue, 13 Aug 2024 10:38:02 GMT
+ * Last updated: Tue, 17 Sep 2024 08:09:49 GMT
  * Dependencies: none
 
 # Credits

k6/{crypto.d.ts → crypto/index.d.ts}

@@ -215,165 +215,4 @@ export abstract class Hasher {
     digest<OE extends OutputEncoding>(outputEncoding: OE): Output<OE>;
 }
 
-/**
- * This module provides common hashing functionality available in the GoLang crypto package.
- * https://grafana.com/docs/k6/latest/javascript-api/k6-crypto/
- */
-declare namespace crypto {
-    /**
-     * Generate random bytes.
-     * @param size - Number of bytes to generate.
-     * @returns An ArrayBuffer with cryptographically random bytes.
-     * @example
-     * const bytes = crypto.randomBytes(42);
-     * const view = new Uint8Array(bytes);
-     * console.log(view); // 156,71,245,191,56,...
-     */
-    function randomBytes(size: number): ArrayBuffer;
-
-    /**
-     * Produce HMAC.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-crypto/hmac/
-     * @param algorithm - Hash algorithm.
-     * @param secret - Shared secret.
-     * @param input - Input data.
-     * @param outputEncoding - Output encoding.
-     * @returns Produced HMAC.
-     * @example
-     * crypto.hmac('sha256', 'mysecret', 'hello world!', 'hex')
-     */
-    function hmac<OE extends OutputEncoding>(
-        algorithm: Algorithm,
-        secret: string | ArrayBuffer,
-        input: string | ArrayBuffer,
-        outputEncoding: OE,
-    ): Output<OE>;
-
-    /**
-     * Hash with MD4.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-crypto/md4/
-     * @param input - Data to hash.
-     * @param outputEncoding - Output encoding.
-     * @returns MD4 digest.
-     * @example
-     * crypto.md4('hello world!', 'hex')
-     */
-    function md4<OE extends OutputEncoding>(input: string | ArrayBuffer, outputEncoding: OE): Output<OE>;
-
-    /**
-     * Hash with MD5.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-crypto/md5/
-     * @param input - Data to hash.
-     * @param outputEncoding - Output encoding.
-     * @returns MD5 digest.
-     * @example
-     * crypto.md5("hello world!", "hex")
-     */
-    function md5<OE extends OutputEncoding>(input: string | ArrayBuffer, outputEncoding: OE): Output<OE>;
-
-    /**
-     * Hash with SHA-1.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-crypto/sha1/
-     * @param input - Data to hash.
-     * @param outputEncoding - Output encoding.
-     * @returns SHA-1 digest.
-     * @example
-     * crypto.sha1('hello world!', 'hex')
-     */
-    function sha1<OE extends OutputEncoding>(input: string | ArrayBuffer, outputEncoding: OE): Output<OE>;
-
-    /**
-     * Hash with SHA-256.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-crypto/sha256/
-     * @param input - Data to hash.
-     * @param outputEncoding - Output encoding.
-     * @returns SHA-256 digest.
-     * @example
-     * crypto.sha256('hello world!', 'hex')
-     */
-    function sha256<OE extends OutputEncoding>(input: string | ArrayBuffer, outputEncoding: OE): Output<OE>;
-
-    /**
-     * Hash with SHA-384.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-crypto/sha384/
-     * @param input - Data to hash.
-     * @param outputEncoding - Output encoding.
-     * @returns SHA-384 digest.
-     * @example
-     * crypto.sha384('hello world!', 'hex')
-     */
-    function sha384<OE extends OutputEncoding>(input: string | ArrayBuffer, outputEncoding: OE): Output<OE>;
-
-    /**
-     * Hash with SHA-512.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-crypto/sha512/
-     * @param input - Data to hash.
-     * @param outputEncoding - Output encoding.
-     * @returns SHA-512 digest.
-     * @example
-     * crypto.sha512('hello world!', 'hex')
-     */
-    function sha512<OE extends OutputEncoding>(input: string | ArrayBuffer, outputEncoding: OE): Output<OE>;
-
-    /**
-     * Hash with SHA-512/224.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-crypto/sha512_224/
-     * @param input - Data to hash.
-     * @param outputEncoding - Output encoding.
-     * @returns SHA-512/224 digest.
-     * @example
-     * crypto.sha512_224('hello world!', 'hex')
-     */
-    function sha512_224<OE extends OutputEncoding>(input: string | ArrayBuffer, outputEncoding: OE): Output<OE>;
-
-    /**
-     * Hash with SHA-512/256.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-crypto/sha512_256/
-     * @param input - Data to hash.
-     * @param outputEncoding - Output encoding.
-     * @returns SHA-512/256 digest.
-     * @example
-     * crypto.sha512_256('hello world!', 'hex')
-     */
-    function sha512_256<OE extends OutputEncoding>(input: string | ArrayBuffer, outputEncoding: OE): Output<OE>;
-
-    /**
-     * Hash with RIPEMD-160.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-crypto/ripemd160/
-     * @param input - Data to hash.
-     * @param outputEncoding - Output encoding.
-     * @returns RIPEMD-160 digest.
-     * @example
-     * crypto.ripemd160('hello world!', 'hex')
-     */
-    function ripemd160<OE extends OutputEncoding>(input: string | ArrayBuffer, outputEncoding: OE): Output<OE>;
-
-    /**
-     * Create a hashing object.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-crypto/createhash/
-     * @param algorithm - Hash algorithm.
-     * @returns Hashing object.
-     * @example
-     * let hasher = crypto.createHash('sha256');
-     * hasher.update('hello ');
-     * hasher.update('world!');
-     * console.log(hasher.digest('hex'));
-     */
-    function createHash(algorithm: Algorithm): Hasher;
-
-    /**
-     * Create an HMAC hashing object.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-crypto/createhmac/
-     * @param algorithm - Hash algorithm.
-     * @param secret - Shared secret.
-     * @returns HMAC hashing object.
-     * @example
-     * let hasher = crypto.createHMAC('sha256', 'a secret');
-     * hasher.update('hello ');
-     * hasher.update('world!');
-     * console.log(hasher.digest('hex'));
-     */
-    function createHMAC(algorithm: Algorithm, secret: string | ArrayBuffer): Hasher;
-}
-
-export default crypto;
+export * as default from "k6/crypto";

k6/encoding/index.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Base64 decode a string.
+ * https://grafana.com/docs/k6/latest/javascript-api/k6-encoding/b64decode/
+ * @param input - The string to base64 decode.
+ * @param encoding - Base64 variant.
+ * @returns The base64 decoded version of the input string in either string or ArrayBuffer format, depending on the `format` parameter.
+ * @example
+ * encoding.b64decode(str)
+ * encoding.b64decode(str, 'rawstd')
+ * const decBuffer = encoding.b64decode(str, 'rawurl')
+ * let decBin = new Uint8Array(decBuffer);
+ */
+export function b64decode(input: string, encoding?: Base64Variant): ArrayBuffer;
+
+/**
+ * Base64 decode a string.
+ * https://grafana.com/docs/k6/latest/javascript-api/k6-encoding/b64decode/
+ * @param input - The string to base64 decode.
+ * @param encoding - Base64 variant.
+ * @param format - If 's' return the data as a string, otherwise an ArrayBuffer object .
+ * @returns The base64 decoded version of the input string in either string or ArrayBuffer format, depending on the `format` parameter.
+ * @example
+ * encoding.b64decode(str)
+ * encoding.b64decode(str, 'rawstd')
+ * const decodedString = encoding.b64decode(str, 'rawurl', 's')
+ */
+export function b64decode(input: string, encoding: Base64Variant, format: "s"): string;
+
+/**
+ * Base64 encode a string.
+ * https://grafana.com/docs/k6/latest/javascript-api/k6-encoding/b64encode/
+ * @param input - String to encode or ArrayBuffer object.
+ * @param encoding - Base64 variant.
+ * @returns Base64 encoded string.
+ * @example
+ * encoding.b64encode(str)
+ * encoding.b64encode(str, 'rawstd')
+ */
+export function b64encode(input: string | ArrayBuffer, encoding?: Base64Variant): string;
+
+/**
+ * Base64 variant.
+ */
+export type Base64Variant = "std" | "rawstd" | "url" | "rawurl";
+
+export * as default from "k6/encoding";

k6/execution/index.d.ts

@@ -0,0 +1,115 @@
+import { Options } from "./../options/index.js";
+
+/**
+ * Information about the current scenario.
+ */
+export const scenario: {
+    /**
+     * The assigned name of the running scenario.
+     */
+    name: string;
+    /**
+     * The name of the running Executor type.
+     */
+    executor: string;
+    /**
+     * The Unix timestamp in milliseconds when the scenario started.
+     */
+    startTime: number;
+    /**
+     * Percentage in a 0 to 1 interval of the scenario progress.
+     */
+    progress: number;
+    /**
+     * The unique and zero-based sequential number of the current iteration in the scenario, across the current instance.
+     */
+    iterationInInstance: number;
+    /**
+     * The unique and zero-based sequential number of the current iteration in the scenario.
+     */
+    iterationInTest: number;
+};
+
+/**
+ * Information about the current load generator instance.
+ */
+export const instance: {
+    /**
+     * The number of prematurely interrupted iterations in the current instance.
+     */
+    iterationsInterrupted: number;
+    /**
+     * The number of completed iterations in the current instance.
+     */
+    iterationsCompleted: number;
+    /**
+     * The number of active VUs.
+     */
+    vusActive: number;
+    /**
+     * The number of currently initialized VUs.
+     */
+    vusInitialized: number;
+    /**
+     * The time passed from the start of the current test run in milliseconds.
+     */
+    currentTestRunDuration: number;
+};
+
+/**
+ * Control the test execution.
+ */
+export const test: {
+    /**
+     * Aborts the test run with the exit code 108.
+     * https://grafana.com/docs/k6/latest/javascript-api/k6-execution/#test
+     * @param input - Aborted message.
+     * @example
+     * import exec from "k6/execution";
+     * exec.test.abort();
+     * exec.test.abort('this is the reason');
+     */
+    abort(input?: string): void;
+
+    options: Options;
+};
+
+/**
+ * Information about the current virtual user.
+ */
+export const vu: {
+    /**
+     * The identifier of the iteration in the current instance.
+     */
+    iterationInInstance: number;
+    /**
+     * The identifier of the iteration in the current scenario.
+     */
+    iterationInScenario: number;
+    /**
+     * The identifier of the VU across the instance.
+     */
+    idInInstance: number;
+    /**
+     * 	The globally unique (across the whole test run) identifier of the VU.
+     */
+    idInTest: number;
+
+    /**
+     * 	Map to set or get VU tags.
+     * 	@deprecated should use `metrics.tags` instead of just `tags`
+     */
+    tags: Record<string, number | string | boolean>;
+    metrics: {
+        /**
+         * 	Map to set or get VU tags.
+         */
+        tags: Record<string, number | string | boolean>;
+        /**
+         * 	Map to set or get VU metadata.
+         */
+        metadata: Record<string, number | string | boolean>;
+    };
+};
+
+export * as default from "k6/execution";

k6/experimental/{fs.d.ts → fs/index.d.ts}

@@ -100,3 +100,5 @@ export enum SeekMode {
     Current = 1, // Seek from the current file position.
     End = 2, // Seek from the end of the file
 }
+
+export * as default from "k6/experimental/fs";

k6/experimental/{redis.d.ts → redis/index.d.ts}

@@ -814,3 +814,8 @@ export interface ClusterOptions {
      */
     nodes: RedisConnectionURL[] | SocketOptions[];
 }
+
+declare let _default: {
+    Client: Client;
+};
+export default _default;

k6/experimental/streams/index.d.ts

@@ -0,0 +1,198 @@
+/**
+ * This module provides an experimental implementation of the Streams API
+ * for k6.
+ *
+ * https://grafana.com/docs/k6/latest/javascript-api/k6-experimental/streams/
+ */
+
+/**
+ * The ReadableStream object provides the API for creating and managing readable
+ * streams of raw data, bit by bit, as soon as it is available, without needing to generate a buffer, string, or blob.
+ */
+export class ReadableStream {
+    /**
+     * The ReadableStream constructor returns a newly created ReadableStream object.
+     * https://grafana.com/docs/k6/latest/javascript-api/k6-experimental/streams/readablestream/
+     *
+     * @param underlyingSource - defines the source of data for the stream.
+     * @param queuingStrategy - defines the queuing strategy to adopt for the stream.
+     */
+    constructor(underlyingSource?: UnderlyingSource, queuingStrategy?: QueuingStrategy);
+
+    /**
+     * Closes the stream and signals a reason for the closure.
+     * https://grafana.com/docs/k6/latest/javascript-api/k6-experimental/streams/readablestream/cancel/
+     *
+     * Used when you’ve completely finished with the stream and don’t need any more data from it,
+     * even if chunks are enqueued waiting to be read.
+     *
+     * That data is lost after cancel is called, and the stream is not readable anymore.
+     * To close the stream without getting rid of enqueued chunks, use `ReadableStreamDefaultController.close()`.
+     *
+     * It returns a promise that is resolved with `undefined` when the stream is canceled.
+     *
+     * @param reason - the reason for canceling the stream.
+     */
+    cancel(reason: any): Promise<void>;
+
+    /**
+     * Creates a reader and locks the stream to it.
+     * While the stream is locked, no other reader can be acquired until this one is released.
+     * https://grafana.com/docs/k6/latest/javascript-api/k6-experimental/streams/readablestream/getreader/
+     */
+    getReader(): ReadableStreamDefaultReader;
+}
+
+/**
+ * The object that defines the source of data for the stream.
+ */
+export interface UnderlyingSource {
+    /**
+     * Called when the stream is created.
+     * It can be used to perform any setup tasks.
+     * The content of this method is to be defined by the user.
+     */
+    start?: (controller: ReadableStreamDefaultController) => void | Promise<void>;
+
+    /**
+     * Called repeatedly to fetch and queue data into the stream,
+     * until it reaches its high watermark.
+     * If `pull()` returns a promise, it won’t be called again until the promise is resolved.
+     */
+    pull?: (controller: ReadableStreamDefaultController) => void | Promise<void>;
+
+    /**
+     * Called when the stream is canceled.
+     * It can be used to release access to the stream source and perform any cleanup tasks.
+     * The reason parameter passed to this method is an optional human-readable value
+     * that represents the reason for canceling the stream.
+     */
+    cancel?: (reason?: any) => void | Promise<void>;
+
+    /**
+     * Specifies the type of the underlying source.
+     * It can currently only receive the value 'default' which is its default value.
+     */
+    type?: "default";
+}
+
+/**
+ * The object that allows the user to control a ReadableStream’s state and internal queue.
+ * https://grafana.com/docs/k6/latest/javascript-api/k6-experimental/streams/readablestreamdefaultcontroller/
+ */
+export interface ReadableStreamDefaultController {
+    /**
+     * Closes the associated stream.
+     * Readers can still read any previously enqueued chunks from the stream.
+     * Once those chunks are read, the stream closes, and no more data is available.
+     */
+    close: () => void;
+
+    /**
+     * Enqueues a chunk of data into the associated stream.
+     */
+    enqueue: (chunk: any) => void;
+
+    /**
+     * Makes any future interactions with the associated stream to error.
+     */
+    error: (reason: any) => void;
+}
+
+/**
+ * The object that defines the queuing strategy to adopt for the stream.
+ *
+ * Although the user can define a custom queueing strategy, the default behavior and recommended way
+ * to use the `ReadableStream` is to use a `CountQueuingStrategy` object.
+ */
+export interface QueuingStrategy {
+    /**
+     * Represents the maximum number of chunks that the stream can hold in its internal queue.
+     * The default value is 1.
+     */
+    highWaterMark?: number;
+
+    /**
+     * Returns the size of the chunk passed as an argument.
+     * The default value is a function that returns 1.
+     */
+    size?(chunk: any): number;
+}
+
+/**
+ * The CountQueuingStrategy object is the default QueuingStrategy for ReadableStream.
+ * It counts the number of chunks in the queue.
+ */
+export class CountQueuingStrategy {
+    /**
+     * The CountQueuingStrategy constructor returns a newly created CountQueuingStrategy object.
+     * https://grafana.com/docs/k6/latest/javascript-api/k6-experimental/streams/readablestream/countqueuingstrategy/
+     *
+     * @param options - an object with optional property `highWaterMark` that determines
+     * the maximum number of chunks that the queue can contain.
+     */
+    constructor(options?: { highWaterMark?: number });
+
+    /**
+     * Represents the maximum number of chunks that the stream can hold in its internal queue.
+     * The default value is 1.
+     */
+    readonly highWaterMark: number;
+
+    /**
+     * Returns the size of the chunk passed as an argument.
+     * The default value is a function that returns 1.
+     */
+    size(chunk: any): number;
+}
+
+/**
+ * The object used to read stream data.
+ * https://grafana.com/docs/k6/latest/javascript-api/k6-experimental/streams/readablestreamdefaultreader/
+ */
+export class ReadableStreamDefaultReader {
+    /**
+     * The ReadableStreamDefaultReader constructor returns a newly created ReadableStreamDefaultReader object.
+     * https://grafana.com/docs/k6/latest/javascript-api/k6-experimental/streams/readablestreamdefaultreader/
+     *
+     * @param stream - defines the stream the reader will own.
+     */
+    constructor(stream: ReadableStream);
+
+    /**
+     * Closes the reader and signals a reason for the closure.
+     * https://grafana.com/docs/k6/latest/javascript-api/k6-experimental/streams/readablestreamdefaultreader/cancel/
+     *
+     * Used when you’ve completely finished with the stream and don’t need any more data from it,
+     * even if chunks are enqueued waiting to be read.
+     * That data is lost after cancel is called, and the stream is not readable anymore.
+     * To close the stream without getting rid of enqueued chunks, use `ReadableStreamDefaultController.close()`.
+     *
+     * It returns a promise that is resolved with `undefined` when the stream is canceled.
+     *
+     * @param reason - the reason for canceling the stream.
+     */
+    cancel(reason: any): Promise<void>;
+
+    /**
+     * Returns a promise providing access to the next chunk in the stream’s internal queue.
+     * https://grafana.com/docs/k6/latest/javascript-api/k6-experimental/streams/readablestreamdefaultreader/read/
+     *
+     * - If the stream is closed and no more data is available, the promise resolves with an object of the form:
+     *   `{ done: true, value: undefined }`.
+     * - If the stream is errored, the promise rejects with the error that caused the stream to error.
+     */
+    read(): Promise<{ done: false; value: any } | { done: true; value: undefined }>;
+
+    /**
+     * Releases the reader’s lock on the stream.
+     * https://grafana.com/docs/k6/latest/javascript-api/k6-experimental/streams/readablestreamdefaultreader/releaselock/
+     *
+     * If the associated stream is errored as the lock is released, the reader will be errored as well.
+     * This method is useful when done with the stream and want to release the lock on it.
+     *
+     * If the reader’s lock is released as pending read operations are still in progress,
+     * the reader’s `ReadableStreamDefaultReader.read()` calls are immediately rejected with a `TypeError`.
+     */
+    readonly releaseLock: () => void;
+}

k6/experimental/{tracing.d.ts → tracing/index.d.ts}

@@ -8,7 +8,7 @@
  * https://grafana.com/docs/k6/latest/javascript-api/k6-experimental/tracing/
  */
 
-import { RefinedParams, RefinedResponse, RequestBody, ResponseType } from "../http";
+import { RefinedParams, RefinedResponse, RequestBody, ResponseType } from "../../http/index.js";
 
 /**
  * The instrumentHTTP function instruments the k6 http module
@@ -204,3 +204,5 @@ export interface Options {
 export interface HttpURL {
     __brand: "http-url";
 }
+
+export * as default from "k6/experimental/tracing";

k6/experimental/{websockets.d.ts → websockets/index.d.ts}

@@ -1,4 +1,5 @@
-import { CookieJar } from "../http";
+import { CookieJar } from "../../http/index.js";
+import { ReadableStream } from "../streams/index.js";
 
 /**
  * This module provides an experimental implementation of the WebSocket API
@@ -139,6 +140,7 @@ export class Blob {
     arrayBuffer(): Promise<ArrayBuffer>;
     bytes(): Promise<Uint8Array>;
     slice(start?: number, end?: number): Blob;
+    stream(): ReadableStream;
     text(): Promise<string>;
 }
 

k6/global.d.ts

@@ -56,7 +56,7 @@ declare global {
      * Environment variables.
      * https://grafana.com/docs/k6/latest/using-k6/environment-variables/
      */
-    const __ENV: { [name: string]: string };
+    var __ENV: { [name: string]: string };
 
     // === VU logic only ===
     // ---------------------
@@ -65,11 +65,19 @@ declare global {
      * Current VU number.
      * https://grafana.com/docs/k6/latest/using-k6/execution-context-variables/
      */
-    const __VU: number;
+    var __VU: number;
 
     /**
      * Current iteration number.
      * https://grafana.com/docs/k6/latest/using-k6/execution-context-variables/
      */
-    const __ITER: number;
+    var __ITER: number;
+
+    interface ImportMeta {
+        /**
+         * Resolve a path to a URL string in the same way an import statement does.
+         * https://grafana.com/docs/k6/latest/javascript-api/import.meta/resolve/
+         */
+        resolve(specifier: string): string;
+    }
 }