@chainfuse/helpers 0.5.0 → 0.6.0

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

@@ -2,6 +2,7 @@ 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 {
     /**

package/dist/index.mjs

@@ -1,6 +1,7 @@
 export * from './buffers.mjs';
 export * from './crypto.mjs';
 export * from './discord.mjs';
+export * from './dns.mjs';
 export * from './net.mjs';
 export class Helpers {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@chainfuse/helpers",
-	"version": "0.5.0",
+	"version": "0.6.0",
 	"description": "",
 	"author": "ChainFuse",
 	"homepage": "https://github.com/ChainFuse/packages/tree/main/packages/helpers#readme",
@@ -51,11 +51,11 @@
 		"@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.4.0",
+		"@chainfuse/types": "^1.4.1",
 		"@types/node": "^22.10.5"
 	},
-	"gitHead": "13881adbb875a4b1680448205ff9e0ac55577f72"
+	"gitHead": "75406cd04aedccc51d9972a79dfbbd5ce7fe6945"
 }