@chainfuse/helpers 0.4.1 → 0.6.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/crypto.d.mts

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

@@ -0,0 +1,74 @@
+/**
+ * Supported parameters for Cloudflare's 1.1.1.1 DNS over HTTPS API
+ */
+export interface DohBodyRequest {
+    /** Query name (required) */
+    name: string;
+    /** Query type - either a numeric value or text. Default is 'A' */
+    type?: string | number;
+    /**
+     * DO bit - whether the client wants DNSSEC data.
+     * Either empty or one of `0`, `false`, `1`, or `true`. Default is `false`
+     */
+    do?: string | number | boolean;
+    /**
+     * CD bit - disable validation.
+     * Either empty or one of `0`, `false`, `1`, or `true`. Default is `false`
+     */
+    cd?: string | number | boolean;
+}
+/**
+ * A record structure with name, type, TTL, and data.
+ */
+interface Record {
+    /** The record owner */
+    name: string;
+    /** The type of DNS record. Defined here: https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4 */
+    type: number;
+    /** The number of seconds the answer can be stored in cache before it is considered stale */
+    TTL: number;
+    /** The value of the DNS record for the given name and type. The data will be in text for standardized record types and in hex for unknown types */
+    data: string;
+}
+/**
+ * A successful DNS response from Cloudflare's 1.1.1.1 DNS over HTTPS API
+ */
+export interface DohSuccessfulResponse {
+    /** The Response Code of the DNS Query. Defined here: https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-6 */
+    Status: number;
+    /** True if the truncated bit was set. This happens when the DNS answer is larger than a single UDP or TCP packet */
+    TC: boolean;
+    /** True if the Recursive Desired bit was set. This is always set to true for Cloudflare DNS over HTTPS */
+    RD: boolean;
+    /** True if the Recursion Available bit was set. This is always set to true for Cloudflare DNS over HTTPS */
+    RA: boolean;
+    /** True if every record in the answer was verified with DNSSEC */
+    AD: boolean;
+    /** True if the client asked to disable DNSSEC validation. In this case, Cloudflare will still fetch the DNSSEC-related records, but it will not attempt to validate the records */
+    CD: boolean;
+    /** The record name requested */
+    Question: Record[];
+    /** The answer record */
+    Answer?: Record[];
+    /** The authority record */
+    Authority: Record[];
+    /** The additional record */
+    Additional: Record[];
+    /** List of EDE messages. Refer to Extended DNS error codes for more information */
+    Comment?: string[];
+}
+/**
+ * An error response from Cloudflare's 1.1.1.1 DNS over HTTPS API
+ */
+export interface DohErrorResponse {
+    /** An explanation of the error that occurred */
+    error: string;
+}
+export declare class DnsHelpers {
+    private nameserver_url;
+    constructor(nameserver_url: string | URL);
+    query(qName: string, qType?: string | number, qDo?: string | number | boolean, qCd?: string | number | boolean, timeout?: number): Promise<DohSuccessfulResponse | DohErrorResponse>;
+    private makeGetQuery;
+    private sendDohMsg;
+}
+export {};

package/dist/dns.mjs

@@ -0,0 +1,46 @@
+export class DnsHelpers {
+    nameserver_url;
+    constructor(nameserver_url) {
+        this.nameserver_url = new URL(nameserver_url);
+    }
+    query(qName, qType = 'A', qDo = false, qCd = false, timeout = 10 * 1000) {
+        return new Promise((resolve, reject) => {
+            this.sendDohMsg(timeout, this.makeGetQuery(this.nameserver_url, qName, qType, qDo, qCd))
+                .then((response) => {
+                if (response.ok) {
+                    response.json().then(resolve).catch(reject);
+                }
+                else {
+                    // eslint-disable-next-line @typescript-eslint/prefer-promise-reject-errors
+                    reject(response.status);
+                }
+            })
+                .catch(reject);
+        });
+    }
+    makeGetQuery(url, qName, qType = 'A', qDo = false, qCd = false) {
+        url.searchParams.set('name', qName);
+        url.searchParams.set('type', qType.toString());
+        url.searchParams.set('do', qDo.toString());
+        url.searchParams.set('cd', qCd.toString());
+        return url;
+    }
+    async sendDohMsg(timeout = 10 * 1000, url = this.nameserver_url) {
+        const controller = new AbortController();
+        const timer = setTimeout(() => controller.abort(), timeout);
+        const response = await fetch(url, {
+            method: 'GET',
+            headers: {
+                Accept: 'application/dns-json',
+            },
+            signal: controller.signal,
+        });
+        clearTimeout(timer);
+        if (response.ok || response.status === 304) {
+            return response;
+        }
+        else {
+            throw new Error(`HTTP ${response.status}: ${response.statusText}`);
+        }
+    }
+}

package/dist/index.d.mts

@@ -1,8 +1,17 @@
+import type { Chalk } from 'chalk';
 export * from './buffers.mjs';
 export * from './crypto.mjs';
 export * from './discord.mjs';
+export * from './dns.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 +21,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

@@ -1,8 +1,34 @@
 export * from './buffers.mjs';
 export * from './crypto.mjs';
 export * from './discord.mjs';
+export * from './dns.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 +55,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.1",
+	"version": "0.6.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"
+		"uuid": "^11.0.4"
 	},
 	"devDependencies": {
-		"@chainfuse/types": "^1.3.0",
-		"@types/node": "^22.10.0"
+		"@chainfuse/types": "^1.4.1",
+		"@types/node": "^22.10.5"
 	},
-	"gitHead": "ea93b05607f7e9687526434591370bfad1ad8605"
+	"gitHead": "75406cd04aedccc51d9972a79dfbbd5ce7fe6945"
 }