@chainfuse/helpers 0.4.0 → 0.5.0

package/README.md

@@ -1,4 +1,4 @@
-[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/ChainFuse/packages/badge)](https://securityscorecards.dev/viewer/?uri=github.com/ChainFuse/packages)[![Socket Badge](https://socket.dev/api/badge/npm/package/@chainfuse/helpers)](https://socket.dev/npm/package/@chainFuse/helpers)
+[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/ChainFuse/packages/badge)](https://securityscorecards.dev/viewer/?uri=github.com/ChainFuse/packages)[![Socket Badge](https://socket.dev/api/badge/npm/package/@chainfuse/helpers)](https://socket.dev/npm/package/@chainfuse/helpers)
 
 ![NPM Downloads](https://img.shields.io/npm/dw/@chainfuse/helpers)![npm bundle size](https://img.shields.io/bundlephobia/min/@chainfuse/helpers)![NPM Unpacked Size](https://img.shields.io/npm/unpacked-size/@chainfuse/helpers)
 

package/dist/buffers.d.mts

@@ -1,18 +1,18 @@
-import type { UndefinedProperties } from '@chainfuse/types';
-import type { PrefixedUuid, UuidExport } from '@chainfuse/types/d1';
+import type { D1Blob, PrefixedUuid, UndefinedProperties, UuidExport } from '@chainfuse/types';
 export declare class BufferHelpers {
     /**
      * @deprecated
      */
     static bufferFromHex(...args: Parameters<typeof this.hexToBuffer>): ReturnType<typeof this.hexToBuffer>;
     static hexToBuffer(hex: UuidExport['hex']): Promise<UuidExport['blob']>;
-    static bufferToHex(buffer: UuidExport['blob']): Promise<UuidExport['hex']>;
+    static bufferToHex(buffer: UuidExport['blob'] | D1Blob): Promise<UuidExport['hex']>;
     static base64ToBuffer(rawBase64: string, urlSafe: boolean): Promise<UuidExport['blob']>;
-    static bufferToBase64(buffer: UuidExport['blob'], urlSafe: boolean): Promise<string>;
+    static bufferToBase64(buffer: UuidExport['blob'] | D1Blob, urlSafe: boolean): Promise<string>;
     static get generateUuid(): Promise<UuidExport>;
-    static uuidConvert(input: UuidExport['blob']): Promise<UuidExport>;
+    static uuidConvert(input: undefined): Promise<UndefinedProperties<UuidExport>>;
     static uuidConvert(prefixedUtf: PrefixedUuid): Promise<UuidExport>;
     static uuidConvert(input: UuidExport['utf8']): Promise<UuidExport>;
     static uuidConvert(input: UuidExport['hex']): Promise<UuidExport>;
-    static uuidConvert(input: undefined): Promise<UndefinedProperties<UuidExport>>;
+    static uuidConvert(input: UuidExport['blob']): Promise<UuidExport>;
+    static uuidConvert(input: D1Blob): Promise<UuidExport>;
 }

package/dist/buffers.mjs

@@ -19,10 +19,12 @@ export class BufferHelpers {
     }
     static bufferToHex(buffer) {
         return (import('node:buffer')
+            // @ts-expect-error `ArrayBufferLike` or D1Blob is actually accepted and fine
             .then(({ Buffer }) => Buffer.from(buffer).toString('hex'))
             /**
              * @link https://jsbm.dev/AoXo8dEke1GUg
              */
+            // @ts-expect-error `ArrayBufferLike` or D1Blob is actually accepted and fine
             .catch(() => new Uint8Array(buffer).reduce((output, elem) => output + ('0' + elem.toString(16)).slice(-2), '')));
     }
     static base64ToBuffer(rawBase64, urlSafe) {
@@ -44,7 +46,8 @@ export class BufferHelpers {
         });
     }
     static bufferToBase64(buffer, urlSafe) {
-        return import('node:buffer')
+        return (import('node:buffer')
+            // @ts-expect-error `ArrayBufferLike` or D1Blob is actually accepted and fine
             .then(({ Buffer }) => Buffer.from(buffer).toString(urlSafe ? 'base64url' : 'base64'))
             .catch(() => {
             // @ts-expect-error `ArrayBufferLike` is actually accepted and fine
@@ -55,7 +58,7 @@ export class BufferHelpers {
             else {
                 return raw;
             }
-        });
+        }));
     }
     static get generateUuid() {
         return Promise.all([CryptoHelpers.secretBytes(16), import('uuid')]).then(([random, { v7: uuidv7 }]) => {
@@ -94,11 +97,11 @@ export class BufferHelpers {
                 }
             }
             else {
-                const blob = input;
-                return this.bufferToHex(blob).then((hex) => ({
+                return this.bufferToHex(input).then((hex) => ({
                     utf8: `${hex.substring(0, 8)}-${hex.substring(8, 12)}-${hex.substring(12, 16)}-${hex.substring(16, 20)}-${hex.substring(20)}`,
                     hex,
-                    blob,
+                    // @ts-expect-error `ArrayBufferLike` or D1Blob is actually accepted and fine
+                    blob: new Uint8Array(input).buffer,
                 }));
             }
         }

package/dist/crypto.d.mts

@@ -1,13 +1,7 @@
 export declare class CryptoHelpers {
     static secretBytes(byteSize: number): Promise<Uint8Array<ArrayBuffer | SharedArrayBuffer> | Uint8Array<ArrayBuffer>>;
-    /**
-     * @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 base16secret(secretLength: number): Promise<string>;
+    static base62secret(secretLength: 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

@@ -12,20 +12,14 @@ export class CryptoHelpers {
             return randomBytes;
         });
     }
-    /**
-     * @yields secret length = (`byteSize` * Math.log2(16)) / 8
-     */
-    static base16secret(byteSize) {
-        return this.secretBytes(byteSize).then((bytes) => BufferHelpers.bufferToHex(bytes.buffer));
+    static base16secret(secretLength) {
+        return this.secretBytes(secretLength / 2).then((bytes) => BufferHelpers.bufferToHex(bytes.buffer));
     }
-    /**
-     * @yields secret length = (`byteSize` * Math.log2(62)) / 8
-     */
-    static base62secret(byteSize) {
+    static base62secret(secretLength) {
         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(byteSize).then((randomBytes) => {
+        return this.secretBytes(secretLength).then((randomBytes) => {
             /**
              * @link https://jsbm.dev/x1F2ITy7RU8T2
              */

package/dist/index.d.mts

@@ -1,8 +1,16 @@
+import type { Chalk } from 'chalk';
 export * from './buffers.mjs';
 export * from './crypto.mjs';
 export * from './discord.mjs';
 export * from './net.mjs';
 export declare class Helpers {
+    /**
+     * Generates a unique RGB color based unique to the provided string ID. The RGB values are clamped to a range that ensures the resulting color is legible
+     *
+     * @param id - The input string used to generate the unique color.
+     * @returns A tuple containing the RGB values [r, g, b].
+     */
+    static uniqueIdColor(id: string): Parameters<InstanceType<typeof Chalk>['rgb']>;
     static precisionFloat(input: string): number;
     /**
      * A wrapper around `Promise.allSettled()` that filters and returns only the fulfilled results. This method behaves like `Promise.allSettled()` where one promise failing doesn't stop others.
@@ -12,4 +20,5 @@ export declare class Helpers {
      * @returns A promise that resolves to an array of fulfilled values from the input promises.
      */
     static getFulfilledResults<T extends unknown>(promises: PromiseLike<T>[]): Promise<Awaited<T>[]>;
+    static areArraysEqual<T>(array1: T[], array2: T[]): boolean;
 }

package/dist/index.mjs

@@ -3,6 +3,31 @@ export * from './crypto.mjs';
 export * from './discord.mjs';
 export * from './net.mjs';
 export class Helpers {
+    /**
+     * Generates a unique RGB color based unique to the provided string ID. The RGB values are clamped to a range that ensures the resulting color is legible
+     *
+     * @param id - The input string used to generate the unique color.
+     * @returns A tuple containing the RGB values [r, g, b].
+     */
+    static uniqueIdColor(id) {
+        // Hash the string to a numeric value
+        let hash = 0;
+        for (let i = 0; i < id.length; i++) {
+            const char = id.charCodeAt(i);
+            hash = (hash << 5) - hash + char;
+            hash |= 0; // Convert to 32-bit integer
+        }
+        // Convert the hash to RGB components
+        let r = (hash & 0xff0000) >> 16; // Extract red
+        let g = (hash & 0x00ff00) >> 8; // Extract green
+        let b = hash & 0x0000ff; // Extract blue
+        // Clamp RGB values to a more legible range (e.g., 64-200)
+        const clamp = (value) => Math.max(100, Math.min(222, value));
+        r = clamp(r);
+        g = clamp(g);
+        b = clamp(b);
+        return [r, g, b];
+    }
     static precisionFloat(input) {
         if (!input.includes('.')) {
             // No decimal point means it's an integer, just return as a float
@@ -29,4 +54,22 @@ export class Helpers {
     static getFulfilledResults(promises) {
         return Promise.allSettled(promises).then((results) => results.filter((result) => result.status === 'fulfilled').map((result) => result.value));
     }
+    static areArraysEqual(array1, array2) {
+        // Quick length check for early exit
+        if (array1.length !== array2.length) {
+            return false;
+        }
+        // Use Set for efficient comparison if arrays are of primitive types
+        const set1 = new Set(array1);
+        const set2 = new Set(array2);
+        if (set1.size !== set2.size) {
+            return false;
+        }
+        for (const item of set1) {
+            if (!set2.has(item)) {
+                return false;
+            }
+        }
+        return true;
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@chainfuse/helpers",
-	"version": "0.4.0",
+	"version": "0.5.0",
 	"description": "",
 	"author": "ChainFuse",
 	"homepage": "https://github.com/ChainFuse/packages/tree/main/packages/helpers#readme",
@@ -30,8 +30,7 @@
 		"build": "tsc",
 		"build:clean": "npm run build -- --build --clean && npm run build",
 		"pretest": "tsc --project tsconfig.tests.json",
-		"test": "node --enable-source-maps --test --experimental-test-coverage --test-reporter=spec --test-reporter-destination=stdout",
-		"test:local": "npm run test"
+		"test": "node --enable-source-maps --test --experimental-test-coverage --test-reporter=spec --test-reporter-destination=stdout"
 	},
 	"type": "module",
 	"bugs": {
@@ -49,14 +48,14 @@
 	},
 	"prettier": "@demosjarco/prettier-config",
 	"dependencies": {
-		"@discordjs/rest": "^2.4.0",
-		"chalk": "^5.3.0",
+		"@discordjs/rest": "^2.4.2",
+		"chalk": "^5.4.1",
 		"cloudflare": "^3.5.0",
 		"uuid": "^11.0.3"
 	},
 	"devDependencies": {
-		"@chainfuse/types": "^1.2.1",
-		"@types/node": "^22.10.0"
+		"@chainfuse/types": "^1.4.0",
+		"@types/node": "^22.10.5"
 	},
-	"gitHead": "1bdc9ab8d4604ec581e390361a78f5dcc615dbbf"
+	"gitHead": "13881adbb875a4b1680448205ff9e0ac55577f72"
 }