@gfdelarue/testkit 0.4.4 → 0.5.0

package/dist/engines/k6/runtime/ambient-types/k6/crypto/index.d.ts

@@ -1,218 +0,0 @@
-/**
- * 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,...
- */
-export 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')
- */
-export 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')
- */
-export 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")
- */
-export 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')
- */
-export 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')
- */
-export 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')
- */
-export 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')
- */
-export 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')
- */
-export 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')
- */
-export 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')
- */
-export 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
- */
-export 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
- */
-export function createHMAC(algorithm: Algorithm, secret: string | ArrayBuffer): Hasher;
-
-/**
- * Hash algorithm.
- */
-export type Algorithm =
-    | "md4"
-    | "md5"
-    | "sha1"
-    | "sha256"
-    | "sha384"
-    | "sha512"
-    | "sha512_224"
-    | "sha512_256"
-    | "ripemd160";
-
-/**
- * String output encoding.
- */
-export type StringEncoding = "hex" | "base64" | "base64url" | "base64rawurl";
-
-/**
- * Binary output encoding.
- */
-export type BinaryEncoding = "binary";
-
-/**
- * Output encoding.
- */
-export type OutputEncoding = StringEncoding | BinaryEncoding;
-
-/**
- * Output type. Varies with output encoding.
- * @template OE - Output encoding.
- */
-export type Output<OE extends OutputEncoding> = OE extends StringEncoding ? string
-    : OE extends BinaryEncoding ? ArrayBuffer
-    : never;
-
-/**
- * Hashing object.
- * https://grafana.com/docs/k6/latest/javascript-api/k6-crypto/hasher/
- */
-export abstract class Hasher {
-    protected __brand: never;
-
-    /**
-     * Add more data to the string we want to create a hash of.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-crypto/hasher/
-     * @param input - Data to add.
-     * @example
-     * let hasher = crypto.createHMAC('sha256', 'a secret');
-     * hasher.update('hello ');
-     * hasher.update('world!');
-     * console.log(hasher.digest('hex'));
-     */
-    update(input: string | ArrayBuffer): void;
-
-    /**
-     * Return a digest from the data added so far.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-crypto/hasher/
-     * @param outputEncoding - Output encoding.
-     * @returns Digest of data added so far.
-     * @example
-     * let hasher = crypto.createHMAC('sha256', 'a secret');
-     * hasher.update('hello ');
-     * hasher.update('world!');
-     * console.log(hasher.digest('hex'));
-     */
-    digest<OE extends OutputEncoding>(outputEncoding: OE): Output<OE>;
-}
-
-export * as default from "k6/crypto";

package/dist/engines/k6/runtime/ambient-types/k6/data/index.d.ts

@@ -1,16 +0,0 @@
-/**
- * Given a name and a function that returns an array, the SharedArray constructor returns the same array but sharing the array memory between VUs.
- * https://grafana.com/docs/k6/latest/javascript-api/k6-data/sharedarray/
- */
-export const SharedArray: {
-    /**
-     * Given a name and a function that returns an array, the SharedArray constructor returns the same array but sharing the array memory between VUs.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-data/sharedarray/
-     */
-    new(name: string, callback: () => []): [];
-    /**
-     * Given a name and a function that returns an array, the SharedArray constructor returns the same array but sharing the array memory between VUs.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-data/sharedarray/
-     */
-    new<T>(name: string, callback: () => T[]): T[];
-};

package/dist/engines/k6/runtime/ambient-types/k6/encoding/index.d.ts

@@ -1,46 +0,0 @@
-/**
- * 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";

package/dist/engines/k6/runtime/ambient-types/k6/execution/index.d.ts

@@ -1,127 +0,0 @@
-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-abort
-     * @param input - Aborted message.
-     * @example
-     * import exec from "k6/execution";
-     * exec.test.abort();
-     * exec.test.abort('this is the reason');
-     */
-    abort(input?: string): void;
-
-    /**
-     * Marks the test as failed with the exit code 110, without interrupting execution.
-     * This allows all iterations to complete while reporting the run as failed.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-execution/#test-fail
-     * @param message - Failure reason.
-     * @example
-     * import exec from "k6/execution";
-     * exec.test.fail();
-     * exec.test.fail('this is the reason');
-     */
-    fail(message?: 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";

package/dist/engines/k6/runtime/ambient-types/k6/experimental/csv/index.d.ts

@@ -1,96 +0,0 @@
-/**
- * The `k6-experimental/csv` module provides efficient ways to handle CSV files in k6, offering faster parsing and lower memory
- * usage compared to traditional JavaScript-based libraries.
- *
- * This module includes functionalities for both full-file parsing and streaming, allowing users to choose between
- * performance and memory optimization.
- */
-
-import type { SharedArray } from "k6/data";
-import * as fs from "k6/experimental/fs";
-
-/**
- * The parse function parses an entire CSV file at once and returns a promise
- * that resolves to a `SharedArray` instance.
- *
- * This function uses Go-based processing, which results in faster parsing and
- * lower memory usage compared to JavaScript alternatives.
- *
- * It's ideal for scenarios where performance is a priority, and the entire CSV
- * file can be loaded into memory.
- *
- * @param {fs.File} file - The file path as a `fs.File` instance. Relative paths are resolved relative to the k6 script.
- * @param {Partial<Options>} [options] - An optional configuration object for the parsing operation.
- */
-export function parse(file: fs.File, options?: Partial<Options>): Promise<typeof SharedArray>;
-
-/**
- * The `csv.Parser` class provides a streaming parser that reads CSV files
- * line-by-line, offering fine-grained control over the parsing process and
- * minimizing memory consumption.
- *
- * It's well-suited for scenarios where memory efficiency is crucial or when
- * you need to process large CSV files without loading the entire file into memory.
- */
-export class Parser {
-    /**
-     * Constructs a new Parser instance.
-     *
-     * @param {fs.File} file - A csv file to parse, provided as a `fs.File` instance.
-     * @param {Partial<Options>} [options] - An optional configuration object for the parser.
-     */
-    constructor(file: fs.File, options?: Partial<Options>);
-
-    /**
-     * Parses the next record from the CSV file.
-     *
-     * @returns {Promise<{done: boolean, value: string[]}>} - A promise that
-     * resolves to an object with the `done` property set to `true` if the end of the file
-     * is reached, and the `value` property set to an array of strings representing the record.
-     */
-    next(): Promise<{ done: boolean; value: string[] }>;
-}
-
-/**
- * The Options object describes the configuration available for the operation of parsing CSV
- * files using the `parse` function and the `Parser` class.
- */
-export interface Options {
-    /**
-     * The delimiter character used in the CSV file. Default is ','.
-     */
-    delimiter: string;
-
-    /**
-     * Whether to skip the first line of the CSV file. Default is false.
-     */
-    skipFirstLine: boolean;
-
-    /**
-     * The line number the parsing should start from. Default is 0.
-     */
-    fromLine: number;
-
-    /**
-     * The line number the parsing should stop at. Default is undefined.
-     */
-    toLine?: number;
-
-    /**
-     * AsObjects indicates that the CSV rows should be returned as objects, where
-     * the keys are the header column names, and values are the corresponding
-     * row values.
-     *
-     * When this option is enabled, the first line of the CSV file is treated as the header.
-     *
-     * If the option is set and no header line is present, this should be considered an error
-     * case.
-     *
-     * This option is incompatible with the `skipFirstLine` option, and if both are set, an error
-     * should be returned. Same thing applies if the `fromLine` option is set to a value greater
-     * than 0.
-     */
-    asObjects?: boolean;
-}
-
-export * as default from "k6/experimental/csv";

package/dist/engines/k6/runtime/ambient-types/k6/experimental/fs/index.d.ts

@@ -1,104 +0,0 @@
-/**
- * The k6 experimental filesystem module provides an API for handling file operations
- * in your k6 tests. It allows you to read files within your test scripts.
- */
-
-/**
- * Opens a file and returns a promise that resolves to an instance of the `File` class.
- *
- * Note: As the k6 init context doesn't support 'await', use the following pattern:
- *
- * Example:
- * ```
- * let fileHandle;
- * (async function() {
- *   fileHandle = await open("example.txt");
- * }());
- * ```
- *
- * @param path - The file path as a string. Relative paths are resolved relative to the k6 script.
- * @returns Promise<File> - A promise that resolves to a `File` instance.
- */
-export function open(path: string): Promise<File>;
-
-/**
- * Represents a file and provides methods to interact with file data.
- * This class offers read-only access to file contents.
- */
-export class File {
-    /**
-     * The absolute path of the file.
-     *
-     * This is resolved relative to the k6 script.
-     */
-    path: string;
-
-    /**
-     * Reads the file into a specified buffer type and returns the number of bytes read.
-     * Resolves to `null` if there's nothing to read (EOF or empty file).
-     *
-     * Example:
-     * ```
-     * const buffer = new Uint8Array(100);
-     * const bytesRead = await file.read(buffer);
-     * console.log(`Read ${bytesRead} bytes`);
-     * ```
-     *
-     * @param p - A Uint8Array buffer to read the file into.
-     * @returns Promise<number> - Number of bytes read or `null`.
-     */
-    read(p: Uint8Array): Promise<number>;
-
-    /**
-     * Moves the file pointer to a new location, based on `offset` and `whence`.
-     * Resolves to the new position within the file (in bytes).
-     *
-     * When using `SeekMode.Start`, the offset must be greater than or equal to zero.
-     * When using `SeekMode.Current`, the offset can be positive or negative.
-     * When using `SeekMode.End`, the offset must be less than or equal to zero.
-     *
-     * Example:
-     * ```
-     * const newOffset = await file.seek(10, SeekMode.Start);
-     * console.log(`Pointer moved to position ${newOffset}`);
-     * ```
-     *
-     * @param offset - The offset to seek to.
-     * @param whence - The position from where offset is added (Start, Current, or End).
-     * @returns Promise<number> - The new position in the file.
-     */
-    seek(offset: number, whence: SeekMode): Promise<number>;
-
-    /**
-     * Retrieves information about the file.
-     * Resolves to a `FileInfo` object describing the file.
-     *
-     * Example:
-     * ```
-     * const fileInfo = await file.stat();
-     * console.log(`File size: ${fileInfo.size} bytes`);
-     * ```
-     *
-     * @returns Promise<FileInfo> - Information about the file.
-     */
-    stat(): Promise<FileInfo>;
-}
-
-/**
- * Contains information about a file, including its name and size.
- */
-export interface FileInfo {
-    name: string; // The name of the file
-    size: number; // The size of the file in bytes
-}
-
-/**
- * Enumeration for file seek modes.
- */
-export enum SeekMode {
-    Start = 0, // Seek from the start of the file
-    Current = 1, // Seek from the current file position.
-    End = 2, // Seek from the end of the file
-}
-
-export * as default from "k6/experimental/fs";