@gfdelarue/testkit 0.4.5 → 0.6.0

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

@@ -1,324 +0,0 @@
-import { ReadableStream } from "../experimental/streams/index.js";
-import { CookieJar } from "../http/index.js";
-
-/**
- * This module provides a WebSocket API for k6.
- *
- * https://grafana.com/docs/k6/latest/javascript-api/k6-websockets/
- */
-
-/**
- * The Websocket object provides the API for creating and managing WebSocket
- * connections as well as for sending and receiving data on the connection.
- */
-export class WebSocket {
-    protected __brand: never;
-
-    /**
-     * The absolute URL to which the Websocket connection is established.
-     */
-    readonly url: string;
-
-    /**
-     * The current state of the Websocket connection.
-     */
-    readonly readyState: ReadyState;
-
-    /**
-     * The number of bytes of data that have been queued using calls to send()
-     * but not yet transmitted to the network.
-     *
-     * This value resets to zero once all queued data has been sent.
-     * This value does not reset to zero when the connection is closed;
-     * if you keep calling send(), this will continue to climb.
-     */
-    readonly bufferedAmount: number;
-
-    /**
-     * The type of binary data being transmitted over the connection.
-     * @default "blob"
-     */
-    binaryType: BinaryType;
-
-    /**
-     * The Websocket constructor returns a newly created WebSocket object.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-websockets/websocket/
-     *
-     * @param url - The URL to which to connect; this should be the URL to which the WebSocket server will respond.
-     * @param protocols - Either a single protocol string or an array of protocol strings. The param is reserved for future use and will be presently ignored.
-     * @param params - Used for setting various WebSocket connection parameters such as headers, cookie jar, compression, etc.
-     */
-    constructor(url: string, protocols?: null, params?: Params | null);
-
-    /**
-     * Enqueues data to be transmitted to the server over the WebSocket connection.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-websockets/websocket/websocket-send/
-     *
-     * @param data - the data to send to the server
-     */
-    send(data: string | ArrayBuffer | Blob | ArrayBufferView): void;
-
-    /**
-     * Bind event names to event handlers to be executed when their
-     * respective event is received by the server.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-websockets/websocket/websocket-addeventlistener/
-     *
-     * @param event - the event to listen for
-     * @param listener - the callback to invoke when the event is emitted
-     */
-    addEventListener(event: EventName, listener: (event: MessageEvent | ErrorEvent) => void): void;
-
-    /**
-     * Closes the WebSocket connection or connection attempt, if any.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-websockets/websocket/websocket-close/
-     *
-     * @param code - An integer WebSocket connection close code value indicating a reason for closure.
-     * @param reason - A human-readable string WebSocket connection close reason. No longer than 123 bytes of UTF-8 text.
-     */
-    close(code?: number, reason?: string): void;
-
-    /**
-     * Sends a ping message over the WebSocket connection.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-websockets/websocket/websocket-ping/
-     */
-    ping(): void;
-
-    /**
-     * Sets an event handler which is invoked when a message event happens.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-websockets/websocket/websocket-onmessage/
-     *
-     * @param event - the message event
-     */
-    onmessage: (event?: MessageEvent) => void;
-
-    /**
-     * Sets an event handler which is invoked when the WebSocket connection's opens.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-websockets/websocket/websocket-onopen/
-     */
-    onopen: () => void;
-
-    /**
-     * Sets an event handler which is invoked when the WebSocket connection's closes.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-websockets/websocket/websocket-onclose/
-     */
-    onclose: () => void;
-
-    /**
-     * Sets an event handler which is invoked when errors occur.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-websockets/websocket/websocket-onerror/
-     *
-     * @param event - the error event
-     */
-    onerror: (event?: ErrorEvent) => void;
-
-    /**
-     * Sets an event handler which is invoked when a ping message is received.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-websockets/websocket/websocket-onping/
-     */
-    onping: () => void;
-
-    /**
-     * Sets an event handler which is invoked when a pong message is received.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-websockets/websocket/websocket-onpong/
-     */
-    onpong: () => void;
-}
-
-export type BlobPart = ArrayBuffer | ArrayBufferView | Blob | string;
-
-export interface BlobOptions {
-    type?: string | undefined;
-}
-
-/**
- * The Blob represents binary data and can be used to interact with it.
- */
-export class Blob {
-    readonly type: string;
-    readonly size: number;
-    constructor(blobParts?: BlobPart[], options?: BlobOptions);
-    arrayBuffer(): Promise<ArrayBuffer>;
-    bytes(): Promise<Uint8Array>;
-    slice(start?: number, end?: number): Blob;
-    stream(): ReadableStream;
-    text(): Promise<string>;
-}
-
-/**
- * k6 specific WebSocket parameters.
- * https://grafana.com/docs/k6/latest/javascript-api/k6-websockets/params/
- */
-export interface Params {
-    /** Request headers. */
-    headers?: Record<string, string>;
-
-    /**
-     * Compression algorithm.
-     * If the option is left unset, it defaults to no compression.
-     */
-    compression?: CompressionAlgorithm;
-
-    /** The custom metric tags. */
-    tags?: Record<string, number | string | boolean>;
-
-    /**
-     * The cookie jar that will be used when making the initial HTTP request to establish the WebSocket connection.
-     * If empty, the default VU cookie jar will be used.
-     */
-    jar?: CookieJar;
-}
-
-/**
- * ReadyState describes the possible states of a WebSocket connection.
- */
-export enum ReadyState {
-    /**
-     * Socket has been created. The connection is not yet open.
-     */
-    Connecting = 0,
-
-    /**
-     * The connection is open and ready to communicate.
-     */
-    Open = 1,
-
-    /**
-     * The connection is in the process of closing.
-     */
-    Closing = 2,
-
-    /**
-     * The connection is closed or couldn't be opened.
-     */
-    Closed = 3,
-}
-
-/**
- * BinaryType describes the possible types of binary data that can be
- * transmitted over a Websocket connection.
- */
-export enum BinaryType {
-    Blob = "blob",
-    ArrayBuffer = "arraybuffer",
-}
-
-/**
- * EventName describes the possible events that can be emitted
- * by a Websocket connection.
- */
-export enum EventName {
-    /**
-     * Event fired when the connection is opened and ready to communicate.
-     */
-    Open = "open",
-
-    /**
-     * Event fired when the connection has been closed.
-     */
-    Close = "close",
-
-    /**
-     * Event fired when a connection has been closed due to an error.
-     */
-    Error = "error",
-
-    /**
-     * Event fired when a message has been received from the server.
-     */
-    Message = "message",
-
-    /**
-     * Event fired when a ping message has been received from the server.
-     */
-    Ping = "ping",
-
-    /**
-     * Event fired when a pong message has been received from the server.
-     */
-    Pong = "pong",
-}
-
-/**
- * MessageEvent is a simple interface that holds the data of a message received from the server.
- */
-export interface MessageEvent {
-    /**
-     * The data sent by the message emitter.
-     */
-    data: string | ArrayBuffer | Blob;
-
-    /**
-     * the type of the event.
-     */
-    type: MessageType;
-
-    /**
-     * The read-only property that returns the time (in milliseconds) at which the event was created.
-     */
-    timestamp: number;
-}
-
-/**
- * WebSocket message types, as defined in RFC 6455, section 11.8.
- */
-export enum MessageType {
-    /**
-     * The message is a text message. The text message payload is
-     * interpreted as UTF-8 encodedtext data.
-     */
-    Text = 1,
-
-    /**
-     * The message is a binary message.
-     */
-    Binary = 2,
-
-    /**
-     * The message is a close control message. The optional message
-     * payload contains a numeric code and a text reason.
-     */
-    Close = 8,
-
-    /**
-     * The message is a ping control message. The optional message
-     * payload is UTF-8 encoded text.
-     */
-    PingMessage = 9,
-
-    /**
-     * The message is a pong control message. The optional message
-     * payload is UTF-8 encoded text.
-     */
-    PongMessage = 10,
-}
-
-/**
- * ErrorEvent is a simple interface that holds the data of an error event.
- */
-export interface ErrorEvent {
-    /**
-     * the type of the event.
-     */
-    type: MessageType;
-
-    /**
-     * The read-only property that returns the error message.
-     */
-    error: string;
-
-    /**
-     * The read-only property that returns the time (in milliseconds) at which the event was created.
-     */
-    timestamp: number;
-}
-
-/**
- * CompressionAlgorithm describes the possible compression algorithms.
- */
-export enum CompressionAlgorithm {
-    /**
-     * Deflate compression algorithm.
-     * k6 supports only this compression algorithm.
-     */
-    Deflate = "deflate",
-}

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

@@ -1,283 +0,0 @@
-import { CookieJar } from "k6/http";
-
-/**
- * Open WebSocket connection.
- * https://grafana.com/docs/k6/latest/javascript-api/k6-ws/connect/
- * @param url - Request URL.
- * @param callback - Logic to execute with socket.
- * @returns HTTP response to connection request.
- * @example
- * let res = ws.connect(url, function(socket) {
- *   socket.on('open', function() {
- *     console.log('WebSocket connection established!');
- *     socket.close();
- *   });
- * });
- */
-export function connect(url: string, callback: Executor): Response;
-
-/**
- * Open WebSocket connection.
- * https://grafana.com/docs/k6/latest/javascript-api/k6-ws/connect/
- * @param url - Request URL.
- * @param params - Request parameters.
- * @param callback - Logic to execute with socket.
- * @returns HTTP response to connection request.
- * @example
- * let res = ws.connect(url, { param1: true }, function(socket) {
- *   socket.on('open', function() {
- *     console.log('WebSocket connection established!');
- *     socket.close();
- *   });
- * });
- */
-export function connect(url: string, params: Params | null, callback: Executor): Response;
-
-// === Parameters ===
-// ------------------
-
-/**
- * Request parameters.
- */
-export interface Params {
-    /** Request headers. */
-    headers?: { [name: string]: string };
-
-    /**
-     * Compression algorithm. The only supported algorithm is `deflate`.
-     * If the option is left unset or empty, it defaults to no compression.
-     */
-    compression?: string;
-
-    /** Response time metric tags. */
-    tags?: { [name: string]: string };
-
-    /**
-     * The cookie jar that will be used when making the initial HTTP request to establish the WebSocket connection.
-     * If empty, the default VU cookie jar will be used.
-     */
-    jar?: CookieJar;
-}
-
-/**
- * Socket executor.
- */
-export interface Executor {
-    /** @param socket - The opened socket. */
-    (socket: Socket): void;
-}
-
-// === Response ===
-// ----------------
-
-/**
- * HTTP response to connection request.
- */
-export interface Response {
-    /** Fetched URL. May differ from request URL due to redirects. */
-    url: string;
-
-    /** HTTP status code. */
-    status: number;
-
-    /** Response headers. */
-    headers: { [name: string]: string };
-
-    /** Response body. */
-    body: string;
-
-    /** Non-HTTP error message. */
-    error: string;
-}
-
-// === Socket ===
-// --------------
-
-/**
- * Created socket.
- * https://grafana.com/docs/k6/latest/javascript-api/k6-ws/socket/
- */
-export abstract class Socket {
-    protected __brand: never;
-
-    /**
-     * Close connection.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-ws/socket/socket-close/
-     * @param code - WebSocket status code.
-     * @example
-     * socket.close();
-     */
-    close(code?: number): void;
-
-    /**
-     * Listen to event.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-ws/socket/socket-on/
-     * @param event - Event type.
-     * @param handler - Event handler.
-     * @example
-     * socket.on('message', function(message) {
-     *   console.log(`Received message: ${message}`);
-     * });
-     * socket.on('close', function() {
-     *   console.log('disconnected');
-     * });
-     */
-    on<ET extends EventType>(event: ET, handler: EventHandler<ET>): void;
-
-    /**
-     * Send ping.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-ws/socket/socket-ping/
-     * @example
-     * socket.ping();
-     */
-    ping(): void;
-
-    /**
-     * Send data.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-ws/socket/socket-send/
-     * @param data - Data to send.
-     * @example
-     * socket.send(JSON.stringify({ data: 'hola' }));
-     */
-    send(data: string): void;
-
-    /**
-     * Send data.
-     * @param data - Data to send.
-     * @example
-     * const binFile = open('./file.pdf', 'b');
-     * export default function () {
-     *   ws.connect('http://wshost/', function(socket) {
-     *     socket.on('open', function() {
-     *       socket.sendBinary(binFile);
-     *     });
-     *     socket.on('binaryMessage', function(msg) {
-     *       // msg is an ArrayBuffer, so we can wrap it in a typed array directly.
-     *       new Uint8Array(msg);
-     *     });
-     *   });
-     * }
-     */
-    sendBinary(data: ArrayBuffer): void;
-
-    /**
-     * Call a function repeatedly, while the WebSocket connection is open.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-ws/socket/socket-setinterval/
-     * @param handler - The function to call every `interval` milliseconds.
-     * @param interval - Milliseconds between two calls to `callback`.
-     * @example
-     * socket.setInterval(function timeout() {
-     *  socket.ping();
-     *  console.log('Pinging every 1sec (setInterval test)');
-     * }, 1000);
-     */
-    setInterval(handler: TimerHandler, interval: number): void;
-
-    /**
-     * Call a function at a later time,
-     * if the WebSocket connection is still open then.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-ws/socket/socket-settimeout/
-     * @param handler - The function to call when `delay` has expired.
-     * @param delay - Delay in milliseconds.
-     * @example
-     * socket.setTimeout(function timeout() {
-     *  console.log('Call after 1second');
-     * }, 1000);
-     */
-    setTimeout(handler: TimerHandler, delay: number): void;
-}
-
-/**
- * Event type.
- */
-export type EventType = "close" | "error" | "message" | "open" | "ping" | "pong" | "binaryMessage";
-
-/**
- * Timer handler.
- */
-export interface TimerHandler {
-    (): void;
-}
-
-// === Event handlers ===
-// ----------------------
-
-/**
- * Event handler. Signature varies with event type.
- */
-export type EventHandler<ET extends EventType> = ET extends "close" ? CloseEventHandler
-    : ET extends "error" ? ErrorEventHandler
-    : ET extends "message" ? MessageEventHandler
-    : ET extends "binaryMessage" ? BinaryMessageEventHandler
-    : ET extends "open" ? OpenEventHandler
-    : ET extends "ping" ? PingEventHandler
-    : ET extends "pong" ? PongEventHandler
-    : never;
-
-/**
- * Close event handler.
- */
-export interface CloseEventHandler {
-    /** @param code - WebSocket status code. */
-    (code: number): void;
-}
-
-/**
- * Error event handler.
- */
-export interface ErrorEventHandler {
-    /** @param error - Error object. */
-    (error: WebSocketError): void;
-}
-
-/**
- * Message event handler.
- */
-export interface MessageEventHandler {
-    /** @param message - Message. */
-    (message: string): void;
-}
-
-/**
- * BinaryMessage event handler.
- */
-export interface BinaryMessageEventHandler {
-    /** @param message - Message. */
-    (message: ArrayBuffer): void;
-}
-
-/**
- * Open event handler.
- */
-export interface OpenEventHandler {
-    (): void;
-}
-
-/**
- * Ping event handler.
- */
-export interface PingEventHandler {
-    (): void;
-}
-
-/**
- * Pong event handler.
- */
-export interface PongEventHandler {
-    (): void;
-}
-
-// === Error ===
-// -------------
-
-/**
- * Error.
- */
-export abstract class WebSocketError {
-    protected __brand: never;
-
-    /** Error message. */
-    error(): string;
-}
-
-export * as default from "k6/ws";