🤖 Merge PR DefinitelyTyped#45259 [k6] Update documentation. Add namepaces by @ppcano

* [k6] Update documentation. Add namepaces

Fix tests and lint errors

* Avoid disabling `no-redundant-jsdoc-2` and fix lint errors

Author: Pepe Cano

types/k6/crypto.d.ts

@@ -1,27 +1,20 @@
-/*
- * Cryptography utilities.
- * https://docs.k6.io/docs/k6crypto
- */
-
 import { bytes } from '.';
 
 /**
  * Generate random bytes.
  * @param size - Number of bytes to generate.
  * @returns Random bytes.
- * @public
  */
 export function randomBytes(size: number): bytes;
 
 /**
  * Produce HMAC.
- * https://docs.k6.io/docs/hmac-algorithm-secret-data-outputencoding
+ * https://k6.io/docs/javascript-api/k6-crypto/hmac-algorithm-secret-data-outputencoding
  * @param algorithm - Hash algorithm.
  * @param secret - Shared secret.
  * @param data - Input data.
  * @param outputEncoding - Output encoding.
  * @returns Produced HMAC.
- * @public
  */
 export function hmac<OE extends OutputEncoding>(
     algorithm: Algorithm,
@@ -32,11 +25,10 @@ export function hmac<OE extends OutputEncoding>(
 
 /**
  * Hash with MD4.
- * https://docs.k6.io/docs/md4-input-outputencoding
+ * https://k6.io/docs/javascript-api/k6-crypto/md4-input-outputencoding
  * @param input - Data to hash.
  * @param outputEncoding - Output encoding.
  * @returns MD4 digest.
- * @public
  */
 export function md4<OE extends OutputEncoding>(
     input: string,
@@ -45,11 +37,10 @@ export function md4<OE extends OutputEncoding>(
 
 /**
  * Hash with MD5.
- * https://docs.k6.io/docs/md5-input-outputencoding
+ * https://k6.io/docs/javascript-api/k6-crypto/md5-input-outputencoding
  * @param input - Data to hash.
  * @param outputEncoding - Output encoding.
  * @returns MD5 digest.
- * @public
  */
 export function md5<OE extends OutputEncoding>(
     input: string,
@@ -58,11 +49,10 @@ export function md5<OE extends OutputEncoding>(
 
 /**
  * Hash with SHA-1.
- * https://docs.k6.io/docs/sha1-input-outputencoding
+ * https://k6.io/docs/javascript-api/k6-crypto/sha1-input-outputencoding
  * @param input - Data to hash.
  * @param outputEncoding - Output encoding.
  * @returns SHA-1 digest.
- * @public
  */
 export function sha1<OE extends OutputEncoding>(
     input: string,
@@ -71,11 +61,10 @@ export function sha1<OE extends OutputEncoding>(
 
 /**
  * Hash with SHA-256.
- * https://docs.k6.io/docs/sha256-input-outputencoding
+ * https://k6.io/docs/javascript-api/k6-crypto/sha256-input-outputencoding
  * @param input - Data to hash.
  * @param outputEncoding - Output encoding.
  * @returns SHA-256 digest.
- * @public
  */
 export function sha256<OE extends OutputEncoding>(
     input: string,
@@ -84,11 +73,10 @@ export function sha256<OE extends OutputEncoding>(
 
 /**
  * Hash with SHA-384.
- * https://docs.k6.io/docs/sha384-input-outputencoding
+ * https://k6.io/docs/javascript-api/k6-crypto/sha384-input-outputencoding
  * @param input - Data to hash.
  * @param outputEncoding - Output encoding.
  * @returns SHA-384 digest.
- * @public
  */
 export function sha384<OE extends OutputEncoding>(
     input: string,
@@ -97,11 +85,10 @@ export function sha384<OE extends OutputEncoding>(
 
 /**
  * Hash with SHA-512.
- * https://docs.k6.io/docs/sha512-input-outputencoding
+ * https://k6.io/docs/javascript-api/k6-crypto/sha512-input-outputencoding
  * @param input - Data to hash.
  * @param outputEncoding - Output encoding.
  * @returns SHA-512 digest.
- * @public
  */
 export function sha512<OE extends OutputEncoding>(
     input: string,
@@ -110,11 +97,10 @@ export function sha512<OE extends OutputEncoding>(
 
 /**
  * Hash with SHA-512/224.
- * https://docs.k6.io/docs/sha512_224-input-outputencoding
+ * https://k6.io/docs/javascript-api/k6-crypto/sha512_224-input-outputencoding
  * @param input - Data to hash.
  * @param outputEncoding - Output encoding.
  * @returns SHA-512/224 digest.
- * @public
  */
 export function sha512_224<OE extends OutputEncoding>(
     input: string,
@@ -123,11 +109,10 @@ export function sha512_224<OE extends OutputEncoding>(
 
 /**
  * Hash with SHA-512/256.
- * https://docs.k6.io/docs/sha512_256-input-outputencoding
+ * https://k6.io/docs/javascript-api/k6-crypto/sha512_256-input-outputencoding
  * @param input - Data to hash.
  * @param outputEncoding - Output encoding.
  * @returns SHA-512/256 digest.
- * @public
  */
 export function sha512_256<OE extends OutputEncoding>(
     input: string,
@@ -136,11 +121,10 @@ export function sha512_256<OE extends OutputEncoding>(
 
 /**
  * Hash with RIPEMD-160.
- * https://docs.k6.io/docs/ripemd160-input-outputencoding
+ * https://k6.io/docs/javascript-api/k6-crypto/ripemd160-input-outputencoding
  * @param input - Data to hash.
  * @param outputEncoding - Output encoding.
  * @returns RIPEMD-160 digest.
- * @public
  */
 export function ripemd160<OE extends OutputEncoding>(
     input: string,
@@ -149,26 +133,23 @@ export function ripemd160<OE extends OutputEncoding>(
 
 /**
  * Create a hashing object.
- * https://docs.k6.io/docs/createhash-algorithm
+ * https://k6.io/docs/javascript-api/k6-crypto/createhash-algorithm
  * @param algorithm - Hash algorithm.
  * @returns Hashing object.
- * @public
  */
 export function createHash(algorithm: Algorithm): Hasher;
 
 /**
  * Create an HMAC hashing object.
- * https://docs.k6.io/docs/createhmacalgorithm-secret
+ * https://k6.io/docs/javascript-api/k6-crypto/createhmac-algorithm-secret
  * @param algorithm - Hash algorithm.
  * @param secret - Shared secret.
  * @returns HMAC hashing object.
- * @public
  */
 export function createHMAC(algorithm: Algorithm, secret: string): Hasher;
 
 /**
  * Hash algorithm.
- * @public
  */
 export type Algorithm =
     | 'md4'
@@ -183,26 +164,22 @@ export type Algorithm =
 
 /**
  * String output encoding.
- * @public
  */
 export type StringEncoding = 'hex' | 'base64' | 'base64url' | 'base64rawurl';
 
 /**
  * Binary output encoding.
- * @public
  */
 export type BinaryEncoding = 'binary';
 
 /**
  * Output encoding.
- * @public
  */
 export type OutputEncoding = StringEncoding | BinaryEncoding;
 
 /**
  * Output type. Varies with output encoding.
  * @typeParam OE - Output encoding.
- * @public
  */
 export type Output<OE extends OutputEncoding> = OE extends StringEncoding
     ? string
@@ -213,21 +190,169 @@ export type Output<OE extends OutputEncoding> = OE extends StringEncoding
 /**
  * Hashing object.
  * https://docs.k6.io/docs/hasher-k6crypto
- * @public
  */
 export abstract class Hasher {
-           protected __brand: never;
-
-           /**
-            * Add more data to the string we want to create a hash of.
-            * @param input - Data to add.
-            */
-           update(input: string): void;
-
-           /**
-            * Return a digest from the data added so far.
-            * @param outputEncoding - Output encoding.
-            * @returns Digest of data added so far.
-            */
-           digest<OE extends OutputEncoding>(outputEncoding: OE): Output<OE>;
-       }
+    protected __brand: never;
+
+    /**
+     * Add more data to the string we want to create a hash of.
+     * @param input - Data to add.
+     */
+    update(input: string): void;
+
+    /**
+     * Return a digest from the data added so far.
+     * @param outputEncoding - Output encoding.
+     * @returns Digest of data added so far.
+     */
+    digest<OE extends OutputEncoding>(outputEncoding: OE): Output<OE>;
+}
+
+/**
+ * This module provides common hashing functionality available in the GoLang crypto package.
+ * https://k6.io/docs/javascript-api/k6-crypto
+ */
+declare namespace crypto {
+    /**
+     * Produce HMAC.
+     * https://k6.io/docs/javascript-api/k6-crypto/hmac-algorithm-secret-data-outputencoding
+     * @param algorithm - Hash algorithm.
+     * @param secret - Shared secret.
+     * @param data - Input data.
+     * @param outputEncoding - Output encoding.
+     * @returns Produced HMAC.
+     */
+    function hmac<OE extends OutputEncoding>(
+        algorithm: Algorithm,
+        secret: string,
+        data: string,
+        outputEncoding: OE
+    ): Output<OE>;
+
+    /**
+     * Hash with MD4.
+     * https://k6.io/docs/javascript-api/k6-crypto/md4-input-outputencoding
+     * @param input - Data to hash.
+     * @param outputEncoding - Output encoding.
+     * @returns MD4 digest.
+     */
+    function md4<OE extends OutputEncoding>(
+        input: string,
+        outputEncoding: OE
+    ): Output<OE>;
+
+    /**
+     * Hash with MD5.
+     * https://k6.io/docs/javascript-api/k6-crypto/md5-input-outputencoding
+     * @param input - Data to hash.
+     * @param outputEncoding - Output encoding.
+     * @returns MD5 digest.
+     */
+    function md5<OE extends OutputEncoding>(
+        input: string,
+        outputEncoding: OE
+    ): Output<OE>;
+
+    /**
+     * Hash with SHA-1.
+     * https://k6.io/docs/javascript-api/k6-crypto/sha1-input-outputencoding
+     * @param input - Data to hash.
+     * @param outputEncoding - Output encoding.
+     * @returns SHA-1 digest.
+     */
+    function sha1<OE extends OutputEncoding>(
+        input: string,
+        outputEncoding: OE
+    ): Output<OE>;
+
+    /**
+     * Hash with SHA-256.
+     * https://k6.io/docs/javascript-api/k6-crypto/sha256-input-outputencoding
+     * @param input - Data to hash.
+     * @param outputEncoding - Output encoding.
+     * @returns SHA-256 digest.
+     */
+    function sha256<OE extends OutputEncoding>(
+        input: string,
+        outputEncoding: OE
+    ): Output<OE>;
+
+    /**
+     * Hash with SHA-384.
+     * https://k6.io/docs/javascript-api/k6-crypto/sha384-input-outputencoding
+     * @param input - Data to hash.
+     * @param outputEncoding - Output encoding.
+     * @returns SHA-384 digest.
+     */
+    function sha384<OE extends OutputEncoding>(
+        input: string,
+        outputEncoding: OE
+    ): Output<OE>;
+
+    /**
+     * Hash with SHA-512.
+     * https://k6.io/docs/javascript-api/k6-crypto/sha512-input-outputencoding
+     * @param input - Data to hash.
+     * @param outputEncoding - Output encoding.
+     * @returns SHA-512 digest.
+     */
+    function sha512<OE extends OutputEncoding>(
+        input: string,
+        outputEncoding: OE
+    ): Output<OE>;
+
+    /**
+     * Hash with SHA-512/224.
+     * https://k6.io/docs/javascript-api/k6-crypto/sha512_224-input-outputencoding
+     * @param input - Data to hash.
+     * @param outputEncoding - Output encoding.
+     * @returns SHA-512/224 digest.
+     */
+    function sha512_224<OE extends OutputEncoding>(
+        input: string,
+        outputEncoding: OE
+    ): Output<OE>;
+
+    /**
+     * Hash with SHA-512/256.
+     * https://k6.io/docs/javascript-api/k6-crypto/sha512_256-input-outputencoding
+     * @param input - Data to hash.
+     * @param outputEncoding - Output encoding.
+     * @returns SHA-512/256 digest.
+     */
+    function sha512_256<OE extends OutputEncoding>(
+        input: string,
+        outputEncoding: OE
+    ): Output<OE>;
+
+    /**
+     * Hash with RIPEMD-160.
+     * https://k6.io/docs/javascript-api/k6-crypto/ripemd160-input-outputencoding
+     * @param input - Data to hash.
+     * @param outputEncoding - Output encoding.
+     * @returns RIPEMD-160 digest.
+     */
+    function ripemd160<OE extends OutputEncoding>(
+        input: string,
+        outputEncoding: OE
+    ): Output<OE>;
+
+    /**
+     * Create a hashing object.
+     * https://k6.io/docs/javascript-api/k6-crypto/createhash-algorithm
+     * @param algorithm - Hash algorithm.
+     * @returns Hashing object.
+     */
+    function createHash(algorithm: Algorithm): Hasher;
+
+    /**
+     * Create an HMAC hashing object.
+     * https://k6.io/docs/javascript-api/k6-crypto/createhmac-algorithm-secret
+     * @param algorithm - Hash algorithm.
+     * @param secret - Shared secret.
+     * @returns HMAC hashing object.
+     */
+    function createHMAC(algorithm: Algorithm, secret: string): Hasher;
+}
+
+export default crypto;