@chainfuse/helpers 0.0.6 → 0.0.8

package/dist/crypto.d.mts

@@ -1,7 +1,13 @@
 export declare class CryptoHelpers {
-    static secretBytes(length: number): Promise<Buffer | Uint8Array>;
-    static base16secret(length: number): Promise<string>;
-    static base62secret(length: number): Promise<string>;
+    static secretBytes(byteSize: number): Promise<Buffer | Uint8Array>;
+    /**
+     * @yields secret length = (`byteSize` * Math.log2(16)) / 8
+     */
+    static base16secret(byteSize: number): Promise<string>;
+    /**
+     * @yields secret length = (`byteSize` * Math.log2(62)) / 8
+     */
+    static base62secret(byteSize: number): Promise<string>;
     static getHash(algorithm: 'SHA-1' | 'SHA-256' | 'SHA-384' | 'SHA-512', input: string | ArrayBufferLike): Promise<string>;
     /**
      * @returns Fully formatted (double quote encapsulated) `ETag` header value

package/dist/crypto.mjs

@@ -1,22 +1,28 @@
 import { BufferHelpers } from './buffers.mjs';
 export class CryptoHelpers {
-    static secretBytes(length) {
+    static secretBytes(byteSize) {
         return import('node:crypto')
-            .then(({ randomBytes }) => randomBytes(length))
+            .then(({ randomBytes }) => randomBytes(byteSize))
             .catch(() => {
-            const randomBytes = new Uint8Array(length);
+            const randomBytes = new Uint8Array(byteSize);
             crypto.getRandomValues(randomBytes);
             return randomBytes;
         });
     }
-    static base16secret(length) {
-        return this.secretBytes(length).then((bytes) => BufferHelpers.bufferToHex(bytes));
+    /**
+     * @yields secret length = (`byteSize` * Math.log2(16)) / 8
+     */
+    static base16secret(byteSize) {
+        return this.secretBytes(byteSize).then((bytes) => BufferHelpers.bufferToHex(bytes));
     }
-    static base62secret(length) {
+    /**
+     * @yields secret length = (`byteSize` * Math.log2(62)) / 8
+     */
+    static base62secret(byteSize) {
         const LOWER_CHAR_SET = 'abcdefghijklmnopqrstuvwxyz';
         const NUMBER_CHAR_SET = '0123456789';
         const CHAR_SET = `${NUMBER_CHAR_SET}${LOWER_CHAR_SET}${LOWER_CHAR_SET.toUpperCase()}`;
-        return this.secretBytes(length).then((randomBytes) => {
+        return this.secretBytes(byteSize).then((randomBytes) => {
             /**
              * @link https://jsbm.dev/x1F2ITy7RU8T2
              */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@chainfuse/helpers",
-	"version": "0.0.6",
+	"version": "0.0.8",
 	"description": "",
 	"author": "ChainFuse",
 	"homepage": "https://github.com/ChainFuse/packages/tree/main/packages/helpers#readme",
@@ -53,9 +53,9 @@
 		"uuid": "^10.0.0"
 	},
 	"devDependencies": {
-		"@chainfuse/types": "^0.0.6",
-		"@types/node": "^20.16.5",
+		"@chainfuse/types": "^0.1.3",
+		"@types/node": "^20.16.9",
 		"@types/uuid": "^10.0.0"
 	},
-	"gitHead": "43cc8eee69201c49d75a9efa5b2b075e9bcbffe8"
+	"gitHead": "28cf77e03b52ff688eac5d0896061f1f04caa663"
 }