@types/k6 0.53.1 → 0.53.2

k6/index.d.ts

@@ -17,28 +17,7 @@
  * @packageDocumentation
  */
 
-import "./global"; // Type global environment
-
-// Expose everything to autoimport
-import "./browser";
-import "./crypto";
-import "./data";
-import "./encoding";
-import "./execution";
-import "./html";
-import "./http";
-import "./metrics";
-import "./options";
-import "./experimental/browser";
-import "./experimental/fs";
-import "./experimental/redis";
-import "./experimental/timers";
-import "./experimental/tracing";
-import "./experimental/webcrypto";
-import "./experimental/websockets";
-import "./timers";
-import "./ws";
-import "./net/grpc";
+import "./global.js"; // Type global environment
 
 // === Main ===
 // ------------
@@ -143,3 +122,5 @@ export interface JSONArray extends Array<JSONValue> {}
 export interface JSONObject {
     [key: string]: JSONValue;
 }
+
+export * as default from "k6";

k6/net/grpc/index.d.ts

@@ -0,0 +1,196 @@
+// === Response ===
+// ----------------
+
+/**
+ * gRPC response.
+ */
+export interface Response {
+    status: number;
+
+    message: object;
+
+    headers: object;
+
+    trailers: object;
+
+    error: object;
+}
+
+export interface ConnectParams {
+    /**
+     * If `true` will connect to the gRPC server using plaintext i.e. insecure.
+     */
+    plaintext?: boolean;
+
+    /**
+     * If `true` connection will try to use the gRPC server reflection protocol.
+     * https://github.com/grpc/grpc/blob/master/doc/server-reflection.md
+     */
+    reflect?: boolean;
+
+    /**
+     * Metadata to send with reflection request.
+     */
+    reflectMetadata?: object;
+
+    /**
+     * Connection timeout to use.
+     */
+    timeout?: string | number;
+
+    /**
+     *  Maximum message size in bytes the client can receive.
+     */
+    maxReceiveSize?: number;
+
+    /**
+     * Maximum message size in bytes the client can send.
+     */
+    maxSendSize?: number;
+
+    /**
+     * TLS settings of the connection.
+     */
+    tls?: TLSParams;
+}
+
+export interface TLSParams {
+    /**
+     *  PEM formatted client certificate.
+     */
+    cert: string;
+
+    /**
+     * PEM formatted client private key.
+     */
+    key: string;
+
+    /**
+     * Password for decrypting the client's private key.
+     */
+    password?: string;
+
+    /**
+     * PEM formatted string/strings of the certificate authorities.
+     */
+    cacerts?: string | string[];
+}
+
+export interface Params {
+    /**
+     * @deprecated Use metadata instead.
+     */
+    headers?: object;
+
+    metadata?: object;
+
+    tags?: object;
+
+    timeout?: string | number;
+}
+
+export interface GrpcError {
+    code: number;
+    details: string[] | object[];
+    message: string;
+}
+
+/**
+ * gRPC client to interact with a gRPC server.
+ * https://grafana.com/docs/k6/latest/javascript-api/k6-net-grpc/client/
+ */
+export class Client {
+    protected __brand: never;
+
+    constructor();
+
+    /** Opens a connection to a gRPC server. */
+    connect(address: string, params?: ConnectParams): void;
+
+    /** Loads and parses the protocol buffer descriptors. */
+    load(importPaths: string[], ...protoFiles: string[]): void;
+
+    /** Loads a protoset and parses the protocol buffer descriptors */
+    loadProtoset(protosetPath: string): void;
+
+    /** Invokes an unary RPC request. */
+    invoke(url: string, request: object, params?: Params): Response;
+
+    /** Asynchronously invokes an unary RPC request. */
+    asyncInvoke(url: string, request: object, params?: Params): Promise<Response>;
+
+    /** Close the connection. */
+    close(): void;
+}
+
+/**
+ * StreamEvent describes the possible events that can be emitted
+ * by a gRPC stream.
+ */
+export type StreamEvent =
+    /**
+     * Event fired when data has been received from the server.
+     */
+    | "data"
+    /**
+     * Event fired when a stream has been closed due to an error.
+     */
+    | "error"
+    /**
+     * Event fired when the stream closes.
+     */
+    | "end";
+
+/**
+ * Stream allows you to use streaming RPCs.
+ */
+export class Stream {
+    /**
+     * The gRPC stream constructor, representing a single gRPC stream.
+     *
+     * @param client - the gRPC client to use, it must be connected.
+     * @param url - the RPC method to call.
+     * @param params - the parameters to use for the RPC call.
+     */
+    constructor(client: Client, url: string, params?: Params);
+
+    /**
+     * Set up handler functions for various events on the gRPC stream.
+     *
+     * @param event - the event to listen for
+     * @param listener - the callback to invoke when the event is emitted
+     */
+    on(event: StreamEvent, listener: (data: object | GrpcError | undefined) => void): void;
+
+    /**
+     * Writes a request to the stream.
+     *
+     * @param request - the request (message) to send to the server
+     */
+    write(request: object): void;
+
+    /**
+     * Signals to the server that the client has finished sending messages.
+     */
+    end(): void;
+}
+
+export const StatusOK: number;
+export const StatusCanceled: number;
+export const StatusUnknown: number;
+export const StatusInvalidArgument: number;
+export const StatusDeadlineExceeded: number;
+export const StatusNotFound: number;
+export const StatusAlreadyExists: number;
+export const StatusPermissionDenied: number;
+export const StatusResourceExhausted: number;
+export const StatusFailedPrecondition: number;
+export const StatusAborted: number;
+export const StatusOutOfRange: number;
+export const StatusUnimplemented: number;
+export const StatusInternal: number;
+export const StatusUnavailable: number;
+export const StatusDataLoss: number;
+export const StatusUnauthenticated: number;
+
+export * as default from "k6/net/grpc";

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

@@ -3,7 +3,7 @@
  * https://grafana.com/docs/k6/latest/using-k6/k6-options/
  */
 
-import { CipherSuite } from "./http";
+import { CipherSuite } from "k6/http";
 
 /**
  * Program options.

k6/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/k6",
-    "version": "0.53.1",
+    "version": "0.53.2",
     "description": "TypeScript definitions for k6",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/k6",
     "license": "MIT",
@@ -51,6 +51,7 @@
             "url": "https://github.com/joanlopez"
         }
     ],
+    "type": "module",
     "main": "",
     "types": "index.d.ts",
     "repository": {
@@ -60,6 +61,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "51f2f592838cc27d3b1784aa8140db6d7c0e256577c0d8f960419afa871ee531",
+    "typesPublisherContentHash": "157d18815426920cc271f8668e306138a0c10336ba1266c5cacd6af2b8bff05b",
     "typeScriptVersion": "4.8"
 }

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

@@ -1,4 +1,4 @@
-import { CookieJar } from "./http";
+import { CookieJar } from "k6/http";
 
 /**
  * Open WebSocket connection.
@@ -280,43 +280,4 @@ export abstract class WebSocketError {
     error(): string;
 }
 
-/**
- * This module provides a WebSocket client implementing the WebSocket protocol.
- * https://grafana.com/docs/k6/latest/javascript-api/k6-ws/
- */
-declare namespace ws {
-    /**
-     * 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();
-     *   });
-     * });
-     */
-    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();
-     *   });
-     * });
-     */
-    function connect(url: string, params: Params | null, callback: Executor): Response;
-}
-
-export default ws;
+export * as default from "k6/ws";

k6/encoding.d.ts

@@ -1,90 +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";
-
-/**
- * The encoding module provides base64 encoding/decoding.
- * https://grafana.com/docs/k6/latest/javascript-api/k6-encoding/
- */
-declare namespace encoding {
-    /**
-     * 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);
-     */
-    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')
-     */
-    function b64decode(input: string, encoding: Base64Variant, format: "s"): string;
-    /**
-     * Base64 decode a string.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-encoding/b64decode/
-     * @param input - Base64 encoded string or ArrayBuffer object.
-     * @param encoding - Base64 variant.
-     * @returns Decoded string.
-     * @example
-     * encoding.b64encode(str)
-     * encoding.b64encode(str, 'rawstd')
-     */
-    function b64encode(input: string | ArrayBuffer, encoding?: Base64Variant): string;
-}
-
-export default encoding;

k6/execution.d.ts

@@ -1,121 +0,0 @@
-import { Options } from "./options";
-
-/*
- * The execution module provides information about the current test execution state.
- * https://grafana.com/docs/k6/latest/javascript-api/k6-execution/
- */
-declare namespace execution {
-    /**
-     * Information about the current scenario.
-     */
-    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.
-     */
-    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.
-     */
-    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.
-     */
-    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 default execution;