@sdxc/doh 2026.10.6 → 2026.10.10

package/dist/parse-record-data.js

@@ -1,283 +0,0 @@
-import { failure, isFailure, success } from "@sdxc/result";
-import { decodeOctets, readCharacterStrings } from "./character-strings.js";
-import { RecordDataError } from "./errors.js";
-import { canonicalType } from "./record-types.js";
-/**
- * A dotted-quad IPv4 address without leading zeros, which `inet_aton` would read as octal
- * and browsers as decimal, so an address carrying them has no single meaning.
- */
-const IPV4_PATTERN = /^(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}$/;
-/**
- * Reads a record's data into its typed fields. Types without a typed reading come back
- * as `{ type, data }` with the data unchanged. Names are lowercased without the trailing
- * dot, except the root, which stays `"."`.
- *
- * @param type - The record type, as a mnemonic or RFC 3597 `TYPEnnn`.
- * @param data - The RDATA in presentation format.
- * @returns The record's fields, or why the data does not fit the type.
- * @template Type - The record type, which selects the fields returned.
- * @example parseRecordData("MX", "10 mx.example.com.") // success({ type: "MX", preference: 10, exchange: "mx.example.com" })
- */
-export function parseRecordData(type, data) {
-    let canonical = canonicalType(type);
-    let value = data.trim();
-    let parsed = value.startsWith("\\#")
-        ? parseGeneric(canonical, value)
-        : parsePresentation(canonical, value);
-    return parsed;
-}
-/** Fails with the reason a record's data does not fit its type. */
-function invalid(type, data) {
-    return failure(new RecordDataError(`Invalid ${type} record data: ${JSON.stringify(data)}`));
-}
-/** Folds a domain name: lowercased, trailing dot dropped, the root kept as `"."`. */
-function normalizeName(name) {
-    let lower = name.toLowerCase();
-    return lower.length > 1 && lower.endsWith(".") ? lower.slice(0, -1) : lower;
-}
-/** Reads an unsigned decimal field no larger than `max`, or `null`. */
-function readNumber(field, max) {
-    if (field === undefined || !/^\d+$/.test(field))
-        return null;
-    let number = Number(field);
-    return number <= max ? number : null;
-}
-/** An IPv6 literal in RFC 5952 canonical form, or `null` when the text is not one. */
-function canonicalIpv6(value) {
-    if (!value.includes(":"))
-        return null;
-    let url = URL.parse(`http://[${value}]/`);
-    return url ? url.hostname.slice(1, -1) : null;
-}
-/** Reads presentation-format data for the typed record types. */
-function parsePresentation(type, value) {
-    let fields = value.split(/\s+/).filter((field) => field.length > 0);
-    switch (type) {
-        case "A":
-            return IPV4_PATTERN.test(value) ? success({ type, address: value }) : invalid(type, value);
-        case "AAAA": {
-            let address = canonicalIpv6(value);
-            return address ? success({ type, address }) : invalid(type, value);
-        }
-        case "CNAME":
-        case "NS": {
-            if (fields.length !== 1 || fields[0] === undefined)
-                return invalid(type, value);
-            let name = normalizeName(fields[0]);
-            return success(type === "CNAME" ? { type, target: name } : { type, host: name });
-        }
-        case "MX": {
-            let preference = readNumber(fields[0], 0xffff);
-            if (fields.length !== 2 || preference === null || fields[1] === undefined)
-                return invalid(type, value);
-            return success({ type, preference, exchange: normalizeName(fields[1]) });
-        }
-        case "TXT": {
-            let strings = readCharacterStrings(value);
-            if (isFailure(strings))
-                return strings;
-            return success({ type, text: strings.data.join(""), strings: strings.data });
-        }
-        case "CAA": {
-            let match = /^(\d+)\s+([A-Za-z0-9]+)\s+(.+)$/.exec(value);
-            let flags = readNumber(match?.[1], 0xff);
-            if (!match || flags === null || match[2] === undefined || match[3] === undefined)
-                return invalid(type, value);
-            let raw = match[3];
-            let text = raw;
-            if (raw.startsWith('"')) {
-                let strings = readCharacterStrings(raw);
-                if (isFailure(strings))
-                    return strings;
-                text = strings.data.join("");
-            }
-            return success({
-                type,
-                critical: (flags & 0x80) !== 0,
-                tag: match[2].toLowerCase(),
-                value: text,
-            });
-        }
-        case "SRV": {
-            let [priority, weight, port] = fields.slice(0, 3).map((field) => readNumber(field, 0xffff));
-            let target = fields[3];
-            if (fields.length !== 4 ||
-                priority == null ||
-                weight == null ||
-                port == null ||
-                target === undefined) {
-                return invalid(type, value);
-            }
-            return success({ type, priority, weight, port, target: normalizeName(target) });
-        }
-        case "SOA": {
-            let [primary, mailbox] = fields;
-            let numbers = fields.slice(2).map((field) => readNumber(field, 0xffffffff));
-            if (fields.length !== 7 ||
-                primary === undefined ||
-                mailbox === undefined ||
-                numbers.some((n) => n === null)) {
-                return invalid(type, value);
-            }
-            let [serial, refresh, retry, expire, minimum] = numbers;
-            return success({
-                type,
-                primary: normalizeName(primary),
-                mailbox: normalizeName(mailbox),
-                serial,
-                refresh,
-                retry,
-                expire,
-                minimum,
-            });
-        }
-        default:
-            return success({ type, data: value });
-    }
-}
-/** Decodes RFC 3597 generic data (`\# <length> <hex>`) and reads the octets for the type. */
-function parseGeneric(type, value) {
-    let match = /^\\#\s+(\d+)((?:\s*[0-9a-fA-F]+)*)\s*$/.exec(value);
-    if (!match)
-        return invalid(type, value);
-    let hex = (match[2] ?? "").replace(/\s+/g, "");
-    let length = Number(match[1]);
-    if (hex.length !== length * 2)
-        return invalid(type, value);
-    let octets = new Uint8Array(length);
-    for (let index = 0; index < length; index++)
-        octets[index] = Number.parseInt(hex.slice(index * 2, index * 2 + 2), 16);
-    let fields = new WireReader(octets).record(type);
-    if (fields === "unknown")
-        return success({ type, data: value });
-    return fields ? success({ type, ...fields }) : invalid(type, value);
-}
-/**
- * Reads the wire form of RDATA front to back. Every read returns `null` past the end, and a
- * record parses only when it consumes every octet, since trailing bytes mean a wrong type.
- */
-class WireReader {
-    #octets;
-    #offset = 0;
-    /** @param octets - The RDATA octets. */
-    constructor(octets) {
-        this.#octets = octets;
-    }
-    /**
-     * The typed fields for `type`, `null` when the octets do not fit it, or `"unknown"` for a
-     * type without a typed reading.
-     */
-    record(type) {
-        let fields = this.#fields(type);
-        if (fields === null || fields === "unknown")
-            return fields;
-        return this.#offset === this.#octets.length ? fields : null;
-    }
-    /** Reads the type's fields, leaving the offset after the last octet read. */
-    #fields(type) {
-        switch (type) {
-            case "A": {
-                let bytes = this.#bytes(4);
-                return bytes ? { address: Array.from(bytes).join(".") } : null;
-            }
-            case "AAAA": {
-                let bytes = this.#bytes(16);
-                if (!bytes)
-                    return null;
-                let groups = Array.from({ length: 8 }, (_, index) => (((bytes[index * 2] ?? 0) << 8) | (bytes[index * 2 + 1] ?? 0)).toString(16));
-                return { address: canonicalIpv6(groups.join(":")) ?? groups.join(":") };
-            }
-            case "CNAME": {
-                let target = this.#name();
-                return target === null ? null : { target };
-            }
-            case "NS": {
-                let host = this.#name();
-                return host === null ? null : { host };
-            }
-            case "MX": {
-                let preference = this.#uint(2);
-                let exchange = this.#name();
-                return preference === null || exchange === null ? null : { preference, exchange };
-            }
-            case "TXT": {
-                let strings = [];
-                while (this.#offset < this.#octets.length) {
-                    let length = this.#uint(1);
-                    let bytes = length === null ? null : this.#bytes(length);
-                    if (!bytes)
-                        return null;
-                    strings.push(decodeOctets(bytes));
-                }
-                return { text: strings.join(""), strings };
-            }
-            case "CAA": {
-                let flags = this.#uint(1);
-                let tagLength = this.#uint(1);
-                let tag = tagLength === null ? null : this.#bytes(tagLength);
-                if (flags === null || !tag)
-                    return null;
-                let rest = this.#bytes(this.#octets.length - this.#offset) ?? new Uint8Array();
-                return {
-                    critical: (flags & 0x80) !== 0,
-                    tag: decodeOctets(tag).toLowerCase(),
-                    value: decodeOctets(rest),
-                };
-            }
-            case "SRV": {
-                let priority = this.#uint(2);
-                let weight = this.#uint(2);
-                let port = this.#uint(2);
-                let target = this.#name();
-                if (priority === null || weight === null || port === null || target === null)
-                    return null;
-                return { priority, weight, port, target };
-            }
-            case "SOA": {
-                let primary = this.#name();
-                let mailbox = this.#name();
-                let numbers = Array.from({ length: 5 }, () => this.#uint(4));
-                if (primary === null || mailbox === null || numbers.some((n) => n === null))
-                    return null;
-                let [serial, refresh, retry, expire, minimum] = numbers;
-                return { primary, mailbox, serial, refresh, retry, expire, minimum };
-            }
-            default:
-                return "unknown";
-        }
-    }
-    /** The next `length` octets, or `null` past the end. */
-    #bytes(length) {
-        if (this.#offset + length > this.#octets.length)
-            return null;
-        let bytes = this.#octets.subarray(this.#offset, this.#offset + length);
-        this.#offset += length;
-        return bytes;
-    }
-    /** A big-endian unsigned integer of `size` octets. */
-    #uint(size) {
-        let bytes = this.#bytes(size);
-        if (!bytes)
-            return null;
-        return bytes.reduce((total, byte) => total * 256 + byte, 0);
-    }
-    /**
-     * An uncompressed domain name, folded like presentation names. RFC 3597 forbids
-     * compression in generic data, so a compression pointer fails the read.
-     */
-    #name() {
-        let labels = [];
-        while (true) {
-            let length = this.#uint(1);
-            if (length === null || length > 63)
-                return null;
-            if (length === 0)
-                break;
-            let label = this.#bytes(length);
-            if (!label)
-                return null;
-            labels.push(String.fromCharCode(...label));
-        }
-        return labels.length === 0 ? "." : normalizeName(labels.join("."));
-    }
-}

package/dist/record-types.d.ts

@@ -1,14 +0,0 @@
-/**
- * Maps record type mnemonics to the IANA codes the JSON API writes in `type`, and back,
- * with RFC 3597's `TYPEnnn` spelling for any code without a mnemonic here.
- *
- * @author [Sergio Xalambrí](https://sergiodxa.com)
- * @copyright Sergio Xalambrí 2026
- */
-/** The mnemonic for a type code, or `TYPEnnn` when it has none here. */
-export declare function typeName(code: number): string;
-/**
- * The spelling of a type as the query's `type` parameter and as a record's `type`: the
- * uppercase mnemonic, and a known mnemonic for `TYPEnnn` when one exists.
- */
-export declare function canonicalType(type: string): string;

package/dist/record-types.js

@@ -1,54 +0,0 @@
-/**
- * Maps record type mnemonics to the IANA codes the JSON API writes in `type`, and back,
- * with RFC 3597's `TYPEnnn` spelling for any code without a mnemonic here.
- *
- * @author [Sergio Xalambrí](https://sergiodxa.com)
- * @copyright Sergio Xalambrí 2026
- */
-/** The IANA codes of the record types a caller is likely to ask for or see in an answer. */
-const TYPE_CODES = {
-    A: 1,
-    NS: 2,
-    CNAME: 5,
-    SOA: 6,
-    PTR: 12,
-    HINFO: 13,
-    MX: 15,
-    TXT: 16,
-    AAAA: 28,
-    LOC: 29,
-    SRV: 33,
-    NAPTR: 35,
-    DNAME: 39,
-    DS: 43,
-    SSHFP: 44,
-    RRSIG: 46,
-    NSEC: 47,
-    DNSKEY: 48,
-    NSEC3: 50,
-    NSEC3PARAM: 51,
-    TLSA: 52,
-    SMIMEA: 53,
-    CDS: 59,
-    CDNSKEY: 60,
-    OPENPGPKEY: 61,
-    SVCB: 64,
-    HTTPS: 65,
-    URI: 256,
-    CAA: 257,
-};
-/** The mnemonic for each code in {@link TYPE_CODES}. */
-const TYPE_NAMES = new Map(Object.entries(TYPE_CODES).map(([name, code]) => [code, name]));
-/** The mnemonic for a type code, or `TYPEnnn` when it has none here. */
-export function typeName(code) {
-    return TYPE_NAMES.get(code) ?? `TYPE${code}`;
-}
-/**
- * The spelling of a type as the query's `type` parameter and as a record's `type`: the
- * uppercase mnemonic, and a known mnemonic for `TYPEnnn` when one exists.
- */
-export function canonicalType(type) {
-    let upper = type.trim().toUpperCase();
-    let generic = /^TYPE(\d+)$/.exec(upper);
-    return generic ? typeName(Number(generic[1])) : upper;
-}