🤖 Merge PR DefinitelyTyped#72052 [@types/k6] Update k6 for the latest version v1.0.0 by @codebien

Co-authored-by: İnanç Gümüş <[email protected]>
Co-authored-by: Oleg Bespalov <[email protected]>
Co-authored-by: Mihail Stoykov <[email protected]>

Author: 4 people

types/k6/browser/index.d.ts

@@ -3036,6 +3036,36 @@ export interface Page {
      */
     on(event: "metric", listener: (metricMessage: MetricMessage) => void): void;
 
+    /**
+     * Registers a handler function to listen for the network requests that
+     * the page makes. The handler will receive an instance of {@link Request},
+     * which includes information about the request.
+     *
+     * **Usage**
+     *
+     * ```js
+     * page.on('request', request => {
+     *   console.log(request.url());
+     * });
+     * ```
+     */
+    on(event: "request", listener: (request: Request) => void): void;
+
+    /**
+     * Registers a handler function to listen for the network responses that the
+     * page receives. The handler will receive an instance of {@link Response},
+     * which includes information about the response.
+     *
+     * **Usage**
+     *
+     * ```js
+     * page.on('response', response => {
+     *   console.log(response.url());
+     * });
+     * ```
+     */
+    on(event: "response", listener: (response: Response) => void): void;
+
     /**
      * Returns the page that opened the current page. The first page that is
      * navigated to will have a null opener.

types/k6/experimental/webcrypto/index.d.ts

@@ -5,12 +5,20 @@
  * https://grafana.com/docs/k6/latest/javascript-api/k6-experimental/webcrypto/
  */
 
+/**
+ * @deprecated use global crypto instead.
+ */
 export const crypto: Crypto;
 
+/**
+ * @deprecated use global crypto instead.
+ */
 export interface Crypto extends SubtleCrypto {
     /**
      * Returns a SubtleCrypto object providing access to common cryptographic
      * primitives, like hashing, signing, encryption, or decryption.
+     *
+     * @deprecated use global crypto.subtle instead.
      */
     readonly subtle: SubtleCrypto;
 
@@ -20,17 +28,24 @@ export interface Crypto extends SubtleCrypto {
      * @param typedArray - The TypedArray to fill with random values.
      * @throws {QuotaExceededError} - thrown if the `byteLength` of `typedArray` exceeds 65536.
      * @returns The typedArray argument.
+     *
+     * @deprecated use global crypto.getRandomValues crypto instead.
      */
     getRandomValues(typedArray: TypedArray): TypedArray;
 
     /**
      * Returns a 36 character long string containing a cryptographically random UUID v4.
      *
      * @returns A 36 character long string containing a cryptographically random UUID v4.
+     *
+     * @deprecated use global crypto.randomUUID instead.
      */
     randomUUID(): string;
 }
 
+/**
+ * @deprecated use global crypto.subtle instead.
+ */
 export interface SubtleCrypto {
     /**
      * The `decrypt()` method decrypts some encrypted data.
@@ -41,6 +56,7 @@ export interface SubtleCrypto {
      * @throws {InvalidAccessError} - if the provided key cannot be used for the decrypt operation.
      * @throws {OperationError} - if the operation failed for an operation-specific reason.
      * @returns A promise that resolves with the decrypted data (also known as "plaintext").
+     * @deprecated use global crypto.subtle.decrypt instead.
      */
     decrypt(
         algorithm: AesCtrParams | AesCbcParams | AesGcmParams | RsaOaepParams,
@@ -63,6 +79,7 @@ export interface SubtleCrypto {
      * @param algorithm names the algorithm to use.
      * @param data the data to be digested
      * @returns A promise that resolves with the digest value.
+     * @deprecated use global crypto.subtle.digest instead.
      */
     digest(
         algorithm: HashAlgorithmIdentifier | Algorithm<HashAlgorithmIdentifier>,
@@ -78,6 +95,7 @@ export interface SubtleCrypto {
      * @throws {InvalidAccessError} - if the provided key cannot be used for the encrypt operation.
      * @throws {OperationError} - if the operation failed for an operation-specific reason.
      * @returns A promise that resolves with the encrypted data (also known as "ciphertext").
+     * @deprecated use global crypto.subtle.encrypt instead.
      */
     encrypt(
         algorithm: AesCtrParams | AesCbcParams | AesGcmParams | RsaOaepParams,
@@ -97,6 +115,7 @@ export interface SubtleCrypto {
      * @throws {NotSupportedError} - if the format is not supported.
      * @throws {TypeError} - when trying to use an invalid format.
      * @returns A promise that resolves with the exported key.
+     * @deprecated use global crypto.subtle.exportKey instead.
      */
     exportKey(format: "raw" | "jwk" | "spki" | "pkcs8", key: CryptoKey): Promise<ArrayBuffer | JWK>;
 
@@ -108,6 +127,7 @@ export interface SubtleCrypto {
      * @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 `CryptoKey`.
+     * @deprecated use global crypto.subtle.generateKey instead.
      */
     generateKey(
         algorithm: AesKeyGenParams | HmacKeyGenParams,
@@ -123,6 +143,7 @@ export interface SubtleCrypto {
      * @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`.
+     * @deprecated use global crypto.subtle.generateKey instead.
      */
     generateKey(
         algorithm: EcKeyGenParams | RSAHashedKeyGenParams,
@@ -143,6 +164,7 @@ export interface SubtleCrypto {
      * @throws {SyntaxError} - if the result is a `CryptoKey` of type `secret` or `private` but `keyUsages is empty.
      * @throws {TypeError} - when trying to use an invalid format or if the `keyData` is not suited for that format.
      * @returns A promise that resolves with the imported `CryptoKey`.
+     * @deprecated use global crypto.subtle.importKey instead.
      */
     importKey(
         format: "raw" | "jwk" | "spki" | "pkcs8",
@@ -170,6 +192,7 @@ export interface SubtleCrypto {
      * @param data the data to sign.
      * @throws {InvalidAccessError} - if the provided key cannot be used for the sign operation.
      * @returns A promise that resolves with the signature.
+     * @deprecated use global crypto.subtle.sign instead.
      */
     sign(
         algorithm: "HMAC" | Algorithm<"HMAC"> | EcdsaParams | RsaPssParams,
@@ -186,6 +209,7 @@ export interface SubtleCrypto {
      * @param data the data to verify.
      * @throws {InvalidAccessError} - if the provided key cannot be used for the verify operation.
      * @returns A promise that resolves with a boolean indicating whether the signature is valid.
+     * @deprecated use global crypto.subtle.verify instead.
      */
     verify(
         algorithm: "HMAC" | Algorithm<"HMAC"> | EcdsaParams | RsaPssParams,
@@ -200,6 +224,7 @@ export interface SubtleCrypto {
      * @param algorithm defines the derivation algorithm to use.
      * @param baseKey A `CryptoKey` representing the input to the derivation algorithm. Currently, only an ECDH private key is possible.
      * @param length A number representing the number of bits to derive. Currently, the number should be a multiple of 8.
+     * @deprecated use global crypto.subtle.deriveBits instead.
      */
     deriveBits(
         algorithm: EcdhKeyDeriveParams,

types/k6/package.json

@@ -1,7 +1,7 @@
 {
     "private": true,
     "name": "@types/k6",
-    "version": "0.57.9999",
+    "version": "1.0.9999",
     "type": "module",
     "projects": [
         "https://grafana.com/docs/k6/latest/"
@@ -21,6 +21,7 @@
         "./execution": "./execution/index.d.ts",
         "./encoding": "./encoding/index.d.ts",
         "./data": "./data/index.d.ts",
+        "./secrets": "./secrets/index.d.ts",
         "./crypto": "./crypto/index.d.ts",
         "./browser": "./browser/index.d.ts",
         "./experimental/csv": "./experimental/csv/index.d.ts",

types/k6/secrets/index.d.ts

@@ -0,0 +1,36 @@
+/**
+ *  This module provides a way to access secrets provided by secret sources
+ */
+
+declare abstract class SecretSource {
+    /**
+     * get a secret from the default secret source if such is setup
+     *
+     * @param key - the key for the secret
+     * @returns a promise that will resolve to a string.
+     */
+    get(key: string): Promise<string>;
+}
+
+/**
+ * get a secret from the default secret source if such is setup
+ *
+ * @param key - the key for the secret
+ * @returns a promise that will resolve to a string.
+ */
+declare function get(key: string): Promise<string>;
+
+/**
+ * returns a secret source for the provided name
+ *
+ * @param name - the name the secret source set with
+ * @returns a source with the name.
+ */
+declare function source(name: string): SecretSource;
+
+declare const _default: {
+    "get": typeof get,
+    "source": typeof source,
+}
+
+export default _default;

types/k6/test/secrets.ts

@@ -0,0 +1,16 @@
+import secrets from "k6/secrets";
+
+await secrets.get("some") // $ExpectType string
+
+// @ts-expect-error
+secrets.get(3)
+
+// @ts-expect-error
+secrets.get("some", true)
+
+secrets.source("some") // $ExpectType SecretSource
+
+// @ts-expect-error
+secrets.source(3)
+
+await secrets.source("some").get("three") // $ExpectType string

types/k6/tsconfig.json

@@ -29,6 +29,7 @@
         "execution/index.d.ts",
         "encoding/index.d.ts",
         "data/index.d.ts",
+        "secrets/index.d.ts",
         "crypto/index.d.ts",
         "browser/index.d.ts",
 
@@ -57,6 +58,7 @@
         "test/crypto.ts",
         "test/http.ts",
         "test/websockets.ts",
+        "test/secrets.ts",
         "test/redis.ts",
         "test/global.ts"
     ]