From 3280b14a79cb5be1a4ebd5f39d30ceac554ccf1c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Dan=20Michael=20O=2E=20Hegg=C3=B8?=
 <dan.michael.heggo@bibsent.no>
Date: Thu, 23 Jan 2025 23:51:29 +0100
Subject: [PATCH] Fix TypeScript types

---
 scrypt.d.ts | 112 +++++++++++++++++++++++++++++-----------------------
 1 file changed, 63 insertions(+), 49 deletions(-)

diff --git a/scrypt.d.ts b/scrypt.d.ts
index 407f820..38f20fd 100644
--- a/scrypt.d.ts
+++ b/scrypt.d.ts
@@ -23,55 +23,69 @@ interface ScryptParamsKdf {
  */
 export type ScryptParams = Required<ScryptParamsKdf>;
 
-/**
- * Produce derived key using scrypt as a key derivation function.
- *
- * @param passphrase Secret value such as a password from which key is to be derived.
- * @param params Scrypt parameters.
- * @returns Derived key (base-64 encoded).
- *
- * @example
- *   const key = await Scrypt.kdf('my secret password', { logN: 15 });
- */
-export declare function kdf(passphrase: string|Uint8Array|Buffer, params: Readonly<ScryptParamsKdf>): Promise<Buffer>;
+declare class Scrypt {
+  /**
+   * Produce derived key using scrypt as a key derivation function.
+   *
+   * @param passphrase Secret value such as a password from which key is to be derived.
+   * @param params Scrypt parameters.
+   * @returns Derived key (base-64 encoded).
+   *
+   * @example
+   *   const key = await Scrypt.kdf('my secret password', { logN: 15 });
+   */
+  static kdf(
+    passphrase: string | Uint8Array | Buffer,
+    params: Readonly<ScryptParamsKdf>
+  ): Promise<Buffer>;
 
-/**
- * Check whether key was generated from passphrase.
- *
- * @param key Derived base64 key obtained from Scrypt.kdf().
- * @param passphrase Passphrase originally used to generate key.
- * @returns True if key was generated from passphrase.
- *
- * @example
- *   const ok = await Scrypt.verify(key, 'my secret password');
- */
-export declare function verify(key: string|Uint8Array|Buffer, passphrase: string|Uint8Array|Buffer): Promise<boolean>;
+  /**
+   * Check whether key was generated from passphrase.
+   *
+   * @param key Derived base64 key obtained from Scrypt.kdf().
+   * @param passphrase Passphrase originally used to generate key.
+   * @returns True if key was generated from passphrase.
+   *
+   * @example
+   *   const ok = await Scrypt.verify(key, 'my secret password');
+   */
+  static verify(
+    key: string | Uint8Array | Buffer,
+    passphrase: string | Uint8Array | Buffer
+  ): Promise<boolean>;
 
-/**
- * View scrypt parameters which were used to derive key.
- *
- * @param key Derived base64 key obtained from Scrypt.kdf().
- * @returns Scrypt parameters logN, r, p.
- *
- * @example
- *   const key = await Scrypt.kdf('my secret password', { logN: 15 } );
- *   const params = Scrypt.viewParams(key); // => { logN: 15, r: 8, p: 1 }
- */
-export declare function viewParams(key: string|Uint8Array|Buffer): ScryptParams;
+  /**
+   * View scrypt parameters which were used to derive key.
+   *
+   * @param key Derived base64 key obtained from Scrypt.kdf().
+   * @returns Scrypt parameters logN, r, p.
+   *
+   * @example
+   *   const key = await Scrypt.kdf('my secret password', { logN: 15 } );
+   *   const params = Scrypt.viewParams(key); // => { logN: 15, r: 8, p: 1 }
+   */
+  static viewParams(key: string | Uint8Array | Buffer): ScryptParams;
 
-/**
- * Calculate scrypt parameters from maxtime, maxmem, maxmemfrac values.
- *
- * Adapted from Colin Percival's code: see github.com/Tarsnap/scrypt/tree/master/lib.
- *
- * Returned parameters may vary depending on computer specs & current loading.
- *
- * @param maxtime Maximum time in seconds scrypt will spend computing the derived key.
- * @param maxmem Maximum bytes of RAM used when computing the derived encryption key.
- * @param maxmemfrac Fraction of the available RAM used when computing the derived key.
- * @returns Scrypt parameters logN, r, p.
- *
- * @example
- *   const params = Scrypt.pickParams(0.1); // => e.g. { logN: 15, r: 8, p: 1 }
- */
-export declare function pickParams(maxtime: number, maxmem?: number, maxmemfrac?: number): ScryptParams;
+  /**
+   * Calculate scrypt parameters from maxtime, maxmem, maxmemfrac values.
+   *
+   * Adapted from Colin Percival's code: see github.com/Tarsnap/scrypt/tree/master/lib.
+   *
+   * Returned parameters may vary depending on computer specs & current loading.
+   *
+   * @param maxtime Maximum time in seconds scrypt will spend computing the derived key.
+   * @param maxmem Maximum bytes of RAM used when computing the derived encryption key.
+   * @param maxmemfrac Fraction of the available RAM used when computing the derived key.
+   * @returns Scrypt parameters logN, r, p.
+   *
+   * @example
+   *   const params = Scrypt.pickParams(0.1); // => e.g. { logN: 15, r: 8, p: 1 }
+   */
+  static pickParams(
+    maxtime: number,
+    maxmem?: number,
+    maxmemfrac?: number
+  ): ScryptParams;
+}
+
+export default Scrypt;