@procedures/http 0.0.0-stage → 0.2.3

package/dist/address.js

@@ -0,0 +1,214 @@
+/**
+ * IP addresses: the parse, the CIDR ranges and the special-purpose ranges (roadmap R38).
+ *
+ * A public address is an address that the IANA registries of special-purpose addresses do not
+ * name. The HTTP procedures refuse each other address by default: loopback, private, link-local,
+ * shared (CGNAT), multicast, documentation, benchmarking and reserved addresses. An IPv6 address
+ * that holds an IPv4 address (IPv4-mapped, NAT64, 6to4) has the class of the IPv4 address.
+ */
+import { isIP } from "node:net";
+/** The bytes of an IPv4 address in dotted decimal, or undefined. */
+function ipv4Bytes(text) {
+    const parts = text.split(".");
+    if (parts.length !== 4)
+        return undefined;
+    const bytes = new Uint8Array(4);
+    for (let i = 0; i < 4; i++) {
+        const part = parts[i];
+        if (!/^(0|[1-9][0-9]{0,2})$/.test(part))
+            return undefined;
+        const value = Number(part);
+        if (value > 255)
+            return undefined;
+        bytes[i] = value;
+    }
+    return bytes;
+}
+/** The bytes of an IPv6 address, or undefined. A zone (`%eth0`) is removed. */
+function ipv6Bytes(text) {
+    let address = text.startsWith("[") && text.endsWith("]") ? text.slice(1, -1) : text;
+    const zone = address.indexOf("%");
+    if (zone >= 0)
+        address = address.slice(0, zone);
+    if (isIP(address) !== 6)
+        return undefined;
+    // An IPv4 tail: "::ffff:1.2.3.4"
+    const groups = [];
+    const parseGroups = (part) => {
+        if (part === "")
+            return [];
+        const out = [];
+        for (const group of part.split(":")) {
+            if (group.includes(".")) {
+                const v4 = ipv4Bytes(group);
+                if (!v4)
+                    return undefined;
+                out.push((v4[0] << 8) | v4[1], (v4[2] << 8) | v4[3]);
+            }
+            else {
+                if (!/^[0-9a-fA-F]{1,4}$/.test(group))
+                    return undefined;
+                out.push(parseInt(group, 16));
+            }
+        }
+        return out;
+    };
+    const double = address.indexOf("::");
+    if (double >= 0) {
+        const head = parseGroups(address.slice(0, double));
+        const tail = parseGroups(address.slice(double + 2));
+        if (!head || !tail || head.length + tail.length > 7)
+            return undefined;
+        groups.push(...head, ...new Array(8 - head.length - tail.length).fill(0), ...tail);
+    }
+    else {
+        const all = parseGroups(address);
+        if (!all || all.length !== 8)
+            return undefined;
+        groups.push(...all);
+    }
+    const bytes = new Uint8Array(16);
+    groups.forEach((group, index) => {
+        bytes[index * 2] = group >> 8;
+        bytes[index * 2 + 1] = group & 0xff;
+    });
+    return bytes;
+}
+/** The bytes of an IPv4 or IPv6 address (brackets and a zone are allowed), or undefined. */
+export function parseAddress(text) {
+    return ipv4Bytes(text) ?? ipv6Bytes(text);
+}
+/** The text of an address: dotted decimal for IPv4, the compressed form for IPv6. */
+export function formatAddress(bytes) {
+    if (bytes.length === 4)
+        return [...bytes].join(".");
+    const groups = [];
+    for (let i = 0; i < 16; i += 2)
+        groups.push((bytes[i] << 8) | bytes[i + 1]);
+    // The longest run of two or more zero groups becomes "::"
+    let bestStart = -1;
+    let bestLength = 0;
+    for (let i = 0; i < 8;) {
+        if (groups[i] !== 0) {
+            i++;
+            continue;
+        }
+        let j = i;
+        while (j < 8 && groups[j] === 0)
+            j++;
+        if (j - i > bestLength && j - i >= 2) {
+            bestStart = i;
+            bestLength = j - i;
+        }
+        i = j;
+    }
+    const hex = groups.map((group) => group.toString(16));
+    if (bestStart < 0)
+        return hex.join(":");
+    return `${hex.slice(0, bestStart).join(":")}::${hex.slice(bestStart + bestLength).join(":")}`;
+}
+/** A range from CIDR text (`10.0.0.0/8`, `fd00::/8`) or one address. Undefined for bad text. */
+export function parseRange(text) {
+    const slash = text.lastIndexOf("/");
+    const bytes = parseAddress(slash >= 0 ? text.slice(0, slash) : text);
+    if (!bytes)
+        return undefined;
+    const bits = bytes.length * 8;
+    if (slash < 0)
+        return { bytes, prefix: bits };
+    const prefixText = text.slice(slash + 1);
+    if (!/^[0-9]{1,3}$/.test(prefixText))
+        return undefined;
+    const prefix = Number(prefixText);
+    return prefix <= bits ? { bytes, prefix } : undefined;
+}
+/** True when the range has the address. An IPv4 range does not have an IPv6 address. */
+export function rangeHas(range, address) {
+    if (range.bytes.length !== address.length)
+        return false;
+    let bits = range.prefix;
+    for (let i = 0; bits > 0; i++, bits -= 8) {
+        const mask = bits >= 8 ? 0xff : (0xff << (8 - bits)) & 0xff;
+        if ((range.bytes[i] & mask) !== (address[i] & mask))
+            return false;
+    }
+    return true;
+}
+function range(text) {
+    const parsed = parseRange(text);
+    if (!parsed)
+        throw new Error(`Bad range ${text}`);
+    return parsed;
+}
+/** The IPv4 ranges that are not public, with their names (IANA IPv4 Special-Purpose Address Registry). */
+const IPV4_SPECIAL = [
+    [range("0.0.0.0/8"), "this-network"],
+    [range("10.0.0.0/8"), "private"],
+    [range("100.64.0.0/10"), "shared (CGNAT)"],
+    [range("127.0.0.0/8"), "loopback"],
+    [range("169.254.0.0/16"), "link-local"],
+    [range("172.16.0.0/12"), "private"],
+    [range("192.0.0.0/24"), "IETF protocol assignment"],
+    [range("192.0.2.0/24"), "documentation"],
+    [range("192.88.99.0/24"), "6to4 relay"],
+    [range("192.168.0.0/16"), "private"],
+    [range("198.18.0.0/15"), "benchmarking"],
+    [range("198.51.100.0/24"), "documentation"],
+    [range("203.0.113.0/24"), "documentation"],
+    [range("224.0.0.0/4"), "multicast"],
+    [range("240.0.0.0/4"), "reserved"],
+];
+/** The IPv6 ranges in the global unicast range that are not public (IANA IPv6 Special-Purpose Address Registry). */
+const IPV6_SPECIAL = [
+    [range("2001::/23"), "IETF protocol assignment"],
+    [range("2001:db8::/32"), "documentation"],
+    [range("3fff::/20"), "documentation"],
+];
+const GLOBAL_UNICAST = range("2000::/3");
+const IPV4_MAPPED = range("::ffff:0:0/96");
+const NAT64 = range("64:ff9b::/96");
+const SIX_TO_FOUR = range("2002::/16");
+const IPV6_NAMED = [
+    [range("::/128"), "unspecified"],
+    [range("::1/128"), "loopback"],
+    [range("fc00::/7"), "unique local (private)"],
+    [range("fe80::/10"), "link-local"],
+    [range("fec0::/10"), "site-local"],
+    [range("ff00::/8"), "multicast"],
+];
+/**
+ * The class of an address that is not public, or undefined for a public address. The class is a
+ * name for a message: `loopback`, `private`, `link-local` and the others.
+ */
+export function specialClass(address) {
+    if (address.length === 4) {
+        for (const [special, name] of IPV4_SPECIAL)
+            if (rangeHas(special, address))
+                return name;
+        return undefined;
+    }
+    // An IPv6 address that holds an IPv4 address has the class of that address
+    if (rangeHas(IPV4_MAPPED, address) || rangeHas(NAT64, address)) {
+        const inner = specialClass(address.slice(12, 16));
+        return inner === undefined ? undefined : `${inner} (in IPv6)`;
+    }
+    if (rangeHas(SIX_TO_FOUR, address)) {
+        const inner = specialClass(address.slice(2, 6));
+        return inner === undefined ? undefined : `${inner} (in 6to4)`;
+    }
+    for (const [special, name] of IPV6_NAMED)
+        if (rangeHas(special, address))
+            return name;
+    if (!rangeHas(GLOBAL_UNICAST, address))
+        return "reserved";
+    for (const [special, name] of IPV6_SPECIAL)
+        if (rangeHas(special, address))
+            return name;
+    return undefined;
+}
+/** True for a public address: no special-purpose range has it. */
+export function isPublicAddress(address) {
+    const bytes = typeof address === "string" ? parseAddress(address) : address;
+    return bytes !== undefined && specialClass(bytes) === undefined;
+}
+//# sourceMappingURL=address.js.map

package/dist/address.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"address.js","sourceRoot":"","sources":["../src/address.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC;AAKhC,oEAAoE;AACpE,SAAS,SAAS,CAAC,IAAY;IAC7B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC9B,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IACzC,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC;IAChC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QAC3B,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC;QACvB,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,IAAI,CAAC;YAAE,OAAO,SAAS,CAAC;QAC1D,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;QAC3B,IAAI,KAAK,GAAG,GAAG;YAAE,OAAO,SAAS,CAAC;QAClC,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;IACnB,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,+EAA+E;AAC/E,SAAS,SAAS,CAAC,IAAY;IAC7B,IAAI,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACpF,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAClC,IAAI,IAAI,IAAI,CAAC;QAAE,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IAChD,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IAC1C,iCAAiC;IACjC,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,WAAW,GAAG,CAAC,IAAY,EAAwB,EAAE;QACzD,IAAI,IAAI,KAAK,EAAE;YAAE,OAAO,EAAE,CAAC;QAC3B,MAAM,GAAG,GAAa,EAAE,CAAC;QACzB,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;YACpC,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBACxB,MAAM,EAAE,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;gBAC5B,IAAI,CAAC,EAAE;oBAAE,OAAO,SAAS,CAAC;gBAC1B,GAAG,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAE,IAAI,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAE,IAAI,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAE,CAAC,CAAC;YAC3D,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,KAAK,CAAC;oBAAE,OAAO,SAAS,CAAC;gBACxD,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;YAChC,CAAC;QACH,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC,CAAC;IACF,MAAM,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACrC,IAAI,MAAM,IAAI,CAAC,EAAE,CAAC;QAChB,MAAM,IAAI,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;QACnD,MAAM,IAAI,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;QACpD,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC;YAAE,OAAO,SAAS,CAAC;QACtE,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,EAAE,GAAG,IAAI,KAAK,CAAS,CAAC,GAAG,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC;IAC7F,CAAC;SAAM,CAAC;QACN,MAAM,GAAG,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;QACjC,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,SAAS,CAAC;QAC/C,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC;IACtB,CAAC;IACD,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC;IACjC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QAC9B,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC;QAC9B,KAAK,CAAC,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,GAAG,IAAI,CAAC;IACtC,CAAC,CAAC,CAAC;IACH,OAAO,KAAK,CAAC;AACf,CAAC;AAED,4FAA4F;AAC5F,MAAM,UAAU,YAAY,CAAC,IAAY;IACvC,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC;AAC5C,CAAC;AAED,qFAAqF;AACrF,MAAM,UAAU,aAAa,CAAC,KAAmB;IAC/C,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpD,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC;QAAE,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAE,IAAI,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC,CAAE,CAAC,CAAC;IAC9E,0DAA0D;IAC1D,IAAI,SAAS,GAAG,CAAC,CAAC,CAAC;IACnB,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,GAAI,CAAC;QACxB,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;YACpB,CAAC,EAAE,CAAC;YACJ,SAAS;QACX,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,CAAC;QACV,OAAO,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC;YAAE,CAAC,EAAE,CAAC;QACrC,IAAI,CAAC,GAAG,CAAC,GAAG,UAAU,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YACrC,SAAS,GAAG,CAAC,CAAC;YACd,UAAU,GAAG,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC;QACD,CAAC,GAAG,CAAC,CAAC;IACR,CAAC;IACD,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;IACtD,IAAI,SAAS,GAAG,CAAC;QAAE,OAAO,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACxC,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,KAAK,CAAC,SAAS,GAAG,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;AAChG,CAAC;AAQD,gGAAgG;AAChG,MAAM,UAAU,UAAU,CAAC,IAAY;IACrC,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IACpC,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACrE,IAAI,CAAC,KAAK;QAAE,OAAO,SAAS,CAAC;IAC7B,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;IAC9B,IAAI,KAAK,GAAG,CAAC;QAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IAC9C,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;IACzC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC;QAAE,OAAO,SAAS,CAAC;IACvD,MAAM,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;IAClC,OAAO,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;AACxD,CAAC;AAED,wFAAwF;AACxF,MAAM,UAAU,QAAQ,CAAC,KAAmB,EAAE,OAAqB;IACjE,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,KAAK,OAAO,CAAC,MAAM;QAAE,OAAO,KAAK,CAAC;IACxD,IAAI,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC;IACxB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,IAAI,IAAI,CAAC,EAAE,CAAC;QACzC,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC;QAC5D,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAE,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAE,GAAG,IAAI,CAAC;YAAE,OAAO,KAAK,CAAC;IACtE,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,KAAK,CAAC,IAAY;IACzB,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;IAChC,IAAI,CAAC,MAAM;QAAE,MAAM,IAAI,KAAK,CAAC,aAAa,IAAI,EAAE,CAAC,CAAC;IAClD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,0GAA0G;AAC1G,MAAM,YAAY,GAAmD;IACnE,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,cAAc,CAAC;IACpC,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,SAAS,CAAC;IAChC,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE,gBAAgB,CAAC;IAC1C,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,UAAU,CAAC;IAClC,CAAC,KAAK,CAAC,gBAAgB,CAAC,EAAE,YAAY,CAAC;IACvC,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE,SAAS,CAAC;IACnC,CAAC,KAAK,CAAC,cAAc,CAAC,EAAE,0BAA0B,CAAC;IACnD,CAAC,KAAK,CAAC,cAAc,CAAC,EAAE,eAAe,CAAC;IACxC,CAAC,KAAK,CAAC,gBAAgB,CAAC,EAAE,YAAY,CAAC;IACvC,CAAC,KAAK,CAAC,gBAAgB,CAAC,EAAE,SAAS,CAAC;IACpC,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE,cAAc,CAAC;IACxC,CAAC,KAAK,CAAC,iBAAiB,CAAC,EAAE,eAAe,CAAC;IAC3C,CAAC,KAAK,CAAC,gBAAgB,CAAC,EAAE,eAAe,CAAC;IAC1C,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,WAAW,CAAC;IACnC,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,UAAU,CAAC;CACnC,CAAC;AAEF,oHAAoH;AACpH,MAAM,YAAY,GAAmD;IACnE,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,0BAA0B,CAAC;IAChD,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE,eAAe,CAAC;IACzC,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,eAAe,CAAC;CACtC,CAAC;AAEF,MAAM,cAAc,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;AACzC,MAAM,WAAW,GAAG,KAAK,CAAC,eAAe,CAAC,CAAC;AAC3C,MAAM,KAAK,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC;AACpC,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC;AACvC,MAAM,UAAU,GAAmD;IACjE,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC;IAChC,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,UAAU,CAAC;IAC9B,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,wBAAwB,CAAC;IAC7C,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,YAAY,CAAC;IAClC,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,YAAY,CAAC;IAClC,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,WAAW,CAAC;CACjC,CAAC;AAEF;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,OAAqB;IAChD,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,KAAK,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,YAAY;YAAE,IAAI,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;gBAAE,OAAO,IAAI,CAAC;QACxF,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,2EAA2E;IAC3E,IAAI,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC,IAAI,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC;QAC/D,MAAM,KAAK,GAAG,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;QAClD,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,KAAK,YAAY,CAAC;IAChE,CAAC;IACD,IAAI,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC,EAAE,CAAC;QACnC,MAAM,KAAK,GAAG,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAChD,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,KAAK,YAAY,CAAC;IAChE,CAAC;IACD,KAAK,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,UAAU;QAAE,IAAI,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;YAAE,OAAO,IAAI,CAAC;IACtF,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC;QAAE,OAAO,UAAU,CAAC;IAC1D,KAAK,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,YAAY;QAAE,IAAI,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;YAAE,OAAO,IAAI,CAAC;IACxF,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,kEAAkE;AAClE,MAAM,UAAU,eAAe,CAAC,OAA8B;IAC5D,MAAM,KAAK,GAAG,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;IAC5E,OAAO,KAAK,KAAK,SAAS,IAAI,YAAY,CAAC,KAAK,CAAC,KAAK,SAAS,CAAC;AAClE,CAAC"}

package/dist/errors.d.ts

@@ -0,0 +1,39 @@
+/**
+ * The errors of the HTTP procedures that are not a refusal or a stop. A server sends them with
+ * the code `HANDLER_ERROR` and the message. `code` tells the kind to a caller in the process.
+ */
+/** The kinds of `HttpError`. */
+export type HttpErrorCode = 
+/** The URL is not an `http:` or `https:` URL. */
+"BAD_URL"
+/** The body of the request is larger than the limit of the module. */
+ | "REQUEST_TOO_LARGE"
+/** The body of the response is larger than `maxResponseBytes`. */
+ | "RESPONSE_TOO_LARGE"
+/** One NDJSON line is larger than `maxLineBytes`. */
+ | "LINE_TOO_LARGE"
+/** One server-sent event is larger than `maxEventBytes`. */
+ | "EVENT_TOO_LARGE"
+/** The redirects are more than `maxRedirects`. */
+ | "TOO_MANY_REDIRECTS"
+/** The response is a redirect, and the input has `redirect: "error"`. */
+ | "REDIRECT"
+/** The status of the response is not in 200 to 299 (`http.json`, `http.ndjson`, `http.sse`). */
+ | "HTTP_STATUS"
+/** The body is not JSON, or a line of NDJSON is not JSON. */
+ | "BAD_JSON"
+/** The content type of an event stream is not `text/event-stream`. */
+ | "BAD_CONTENT_TYPE"
+/** The connection failed: no answer, a reset, a TLS error. */
+ | "CONNECTION";
+/** An error of an HTTP procedure. */
+export declare class HttpError extends Error {
+    readonly code: HttpErrorCode;
+    /** The status of the response, when the server answered. */
+    readonly status?: number | undefined;
+    readonly name = "HttpError";
+    constructor(code: HttpErrorCode, message: string, 
+    /** The status of the response, when the server answered. */
+    status?: number | undefined, options?: ErrorOptions);
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,gCAAgC;AAChC,MAAM,MAAM,aAAa;AACvB,iDAAiD;AAC/C,SAAS;AACX,sEAAsE;GACpE,mBAAmB;AACrB,kEAAkE;GAChE,oBAAoB;AACtB,qDAAqD;GACnD,gBAAgB;AAClB,4DAA4D;GAC1D,iBAAiB;AACnB,kDAAkD;GAChD,oBAAoB;AACtB,yEAAyE;GACvE,UAAU;AACZ,gGAAgG;GAC9F,aAAa;AACf,6DAA6D;GAC3D,UAAU;AACZ,sEAAsE;GACpE,kBAAkB;AACpB,8DAA8D;GAC5D,YAAY,CAAC;AAEjB,qCAAqC;AACrC,qBAAa,SAAU,SAAQ,KAAK;IAIhC,QAAQ,CAAC,IAAI,EAAE,aAAa;IAE5B,4DAA4D;IAC5D,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM;IAN1B,SAAkB,IAAI,eAAe;IAErC,YACW,IAAI,EAAE,aAAa,EAC5B,OAAO,EAAE,MAAM;IACf,4DAA4D;IACnD,MAAM,CAAC,EAAE,MAAM,YAAA,EACxB,OAAO,CAAC,EAAE,YAAY,EAGvB;CACF"}

package/dist/errors.js

@@ -0,0 +1,18 @@
+/**
+ * The errors of the HTTP procedures that are not a refusal or a stop. A server sends them with
+ * the code `HANDLER_ERROR` and the message. `code` tells the kind to a caller in the process.
+ */
+/** An error of an HTTP procedure. */
+export class HttpError extends Error {
+    code;
+    status;
+    name = "HttpError";
+    constructor(code, message, 
+    /** The status of the response, when the server answered. */
+    status, options) {
+        super(message, options);
+        this.code = code;
+        this.status = status;
+    }
+}
+//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA2BH,qCAAqC;AACrC,MAAM,OAAO,SAAU,SAAQ,KAAK;IAIvB,IAAI;IAGJ,MAAM;IANC,IAAI,GAAG,WAAW,CAAC;IAErC,YACW,IAAmB,EAC5B,OAAe;IACf,4DAA4D;IACnD,MAAe,EACxB,OAAsB;QAEtB,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;oBANf,IAAI;sBAGJ,MAAM;IAIjB,CAAC;CACF"}

package/dist/exchange.d.ts

@@ -0,0 +1,102 @@
+/**
+ * One HTTP exchange with the host check, the redirects and the limits (roadmap R38).
+ *
+ * The exchange uses `node:http` and `node:https`, not `fetch`: the connection must use the
+ * addresses that the host check allowed. A `lookup` function gives those addresses to the socket,
+ * so the DNS cannot give another address after the check (DNS rebinding). The exchange follows
+ * each redirect itself and examines each new host. Each request gets its own connection.
+ */
+import { type IncomingHttpHeaders, type IncomingMessage } from "node:http";
+import { type Readable } from "node:stream";
+import type { ProcedurePath } from "@procedures/client";
+import { HttpError } from "./errors.js";
+import { type HostPolicy } from "./policy.js";
+import type { CallScope } from "./scope.js";
+/** One mebibyte. */
+export declare const MIB: number;
+/** The default size limit of a response body and of a request body: 10 MiB. */
+export declare const DEFAULT_MAX_BYTES: number;
+/** The default size limit of one NDJSON line and of one server-sent event: 1 MiB. */
+export declare const DEFAULT_ITEM_BYTES: number;
+/** The default time of `http.request` and `http.json`: 30 seconds. */
+export declare const DEFAULT_TIMEOUT_MS = 30000;
+/** The default number of redirects that a call follows. */
+export declare const DEFAULT_MAX_REDIRECTS = 5;
+/** The settings of a module: the host policy and the size limits of the host. */
+export interface HttpSettings {
+    readonly policy: HostPolicy;
+    /** The largest body of a request, in bytes. */
+    readonly maxRequestBytes: number;
+    /** The largest body of a response, in bytes. An input can set a smaller limit. */
+    readonly maxResponseBytes: number;
+}
+/** The settings of the default module: each public host, and 10 MiB for each body. */
+export declare const DEFAULT_SETTINGS: HttpSettings;
+/** What to do with a redirect. */
+export type RedirectMode = "follow" | "manual" | "error";
+/** A request before the first exchange. */
+export interface PreparedRequest {
+    readonly url: URL;
+    readonly method: string;
+    /** The headers, with names in lowercase. */
+    readonly headers: Record<string, string>;
+    readonly body?: Buffer | undefined;
+    readonly redirect: RedirectMode;
+    readonly maxRedirects: number;
+}
+/** The parts of a request that the procedures share. */
+export interface RequestParts {
+    readonly url: string;
+    readonly method?: string | undefined;
+    readonly headers?: Readonly<Record<string, string>> | undefined;
+    readonly query?: Readonly<Record<string, QueryValue | readonly QueryValue[]>> | undefined;
+    readonly redirect?: RedirectMode | undefined;
+    readonly maxRedirects?: number | undefined;
+}
+/** A value of the query of a URL. */
+export type QueryValue = string | number | boolean;
+/** The response of an exchange. */
+export interface Exchange {
+    readonly response: IncomingMessage;
+    /** The body without its content encoding (gzip, deflate or br). */
+    readonly body: Readable;
+    /** The URL of the response: the last URL after the redirects. */
+    readonly url: string;
+    /** The URLs of the redirects that the exchange followed. */
+    readonly redirects: readonly string[];
+    /** This function closes the connection. */
+    close(): void;
+}
+/** This function parses the URL of an input, and adds the query. Only `http:` and `https:` pass. */
+export declare function urlOf(parts: RequestParts, path: ProcedurePath): URL;
+/** The headers of an input with names in lowercase. A later name of the same header wins. */
+export declare function headersOf(headers: Readonly<Record<string, string>> | undefined, defaults?: Readonly<Record<string, string>>): Record<string, string>;
+/** This function makes a request from the shared parts of an input. */
+export declare function prepare(parts: RequestParts, path: ProcedurePath, settings: HttpSettings, extra?: {
+    headers?: Record<string, string>;
+    body?: Buffer | undefined;
+}): PreparedRequest;
+/** The text of a header value: several values are joined with a comma. */
+export declare function headerText(value: string | string[] | undefined): string | undefined;
+/**
+ * This function sends a request, follows the redirects and gives the response. Each URL goes
+ * through the host check before its connection. A refused host throws `FORBIDDEN` with the
+ * reason `host-not-allowed`.
+ */
+export declare function exchange(request: PreparedRequest, policy: HostPolicy, scope: CallScope): Promise<Exchange>;
+/** This function reads a whole body. More than `maxBytes` bytes throws `RESPONSE_TOO_LARGE`. */
+export declare function readBody(body: Readable, maxBytes: number, scope: CallScope, response: IncomingMessage): Promise<Buffer>;
+/** The headers of a response as JSON: a string, or a list for `set-cookie`. */
+export declare function responseHeaders(headers: IncomingHttpHeaders): Record<string, string | string[]>;
+/** The first characters of a body, for a message. */
+export declare function excerpt(body: Buffer | string, length?: number): string;
+/** True for a status in 200 to 299. */
+export declare function isOk(status: number): boolean;
+/**
+ * The `HTTP_STATUS` error of a response whose status is not in 200 to 299. The message has the
+ * start of the body (at most 4 KiB is read).
+ */
+export declare function statusError(opened: Exchange, scope: CallScope): Promise<HttpError>;
+/** The chunks of a body. Each chunk starts the idle time of the scope again. */
+export declare function touching(body: Readable, scope: CallScope): AsyncGenerator<Uint8Array | string, void, undefined>;
+//# sourceMappingURL=exchange.d.ts.map

package/dist/exchange.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"exchange.d.ts","sourceRoot":"","sources":["../src/exchange.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAA2B,KAAK,mBAAmB,EAAE,KAAK,eAAe,EAAuB,MAAM,WAAW,CAAC;AAGzH,OAAO,EAAyB,KAAK,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEnE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAsD,KAAK,UAAU,EAAE,MAAM,aAAa,CAAC;AAClG,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAE5C,oBAAoB;AACpB,eAAO,MAAM,GAAG,EAAE,MAAoB,CAAC;AAEvC,+EAA+E;AAC/E,eAAO,MAAM,iBAAiB,EAAE,MAAiB,CAAC;AAElD,qFAAqF;AACrF,eAAO,MAAM,kBAAkB,EAAE,MAAY,CAAC;AAE9C,sEAAsE;AACtE,eAAO,MAAM,kBAAkB,QAAS,CAAC;AAEzC,2DAA2D;AAC3D,eAAO,MAAM,qBAAqB,IAAI,CAAC;AAEvC,iFAAiF;AACjF,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;IAC5B,+CAA+C;IAC/C,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,kFAAkF;IAClF,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;CACnC;AAED,sFAAsF;AACtF,eAAO,MAAM,gBAAgB,EAAE,YAI9B,CAAC;AAQF,kCAAkC;AAClC,MAAM,MAAM,YAAY,GAAG,QAAQ,GAAG,QAAQ,GAAG,OAAO,CAAC;AAEzD,2CAA2C;AAC3C,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC;IAClB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,4CAA4C;IAC5C,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,QAAQ,CAAC,QAAQ,EAAE,YAAY,CAAC;IAChC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;CAC/B;AAED,wDAAwD;AACxD,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,SAAS,CAAC;IAChE,QAAQ,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,SAAS,UAAU,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC;IAC1F,QAAQ,CAAC,QAAQ,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IAC7C,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5C;AAED,qCAAqC;AACrC,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAEnD,mCAAmC;AACnC,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAAC;IACnC,mEAAmE;IACnE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IACxB,iEAAiE;IACjE,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,4DAA4D;IAC5D,QAAQ,CAAC,SAAS,EAAE,SAAS,MAAM,EAAE,CAAC;IACtC,2CAA2C;IAC3C,KAAK,IAAI,IAAI,CAAC;CACf;AAKD,oGAAoG;AACpG,wBAAgB,KAAK,CAAC,KAAK,EAAE,YAAY,EAAE,IAAI,EAAE,aAAa,GAAG,GAAG,CAenE;AAED,6FAA6F;AAC7F,wBAAgB,SAAS,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,SAAS,EAAE,QAAQ,GAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAKxJ;AAED,uEAAuE;AACvE,wBAAgB,OAAO,CAAC,KAAK,EAAE,YAAY,EAAE,IAAI,EAAE,aAAa,EAAE,QAAQ,EAAE,YAAY,EAAE,KAAK,GAAE;IAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAAO,GAAG,eAAe,CAoBtL;AAiFD,0EAA0E;AAC1E,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAEnF;AAED;;;;GAIG;AACH,wBAAsB,QAAQ,CAAC,OAAO,EAAE,eAAe,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC,CAyDhH;AAED,gGAAgG;AAChG,wBAAsB,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,CA6B7H;AAED,+EAA+E;AAC/E,wBAAgB,eAAe,CAAC,OAAO,EAAE,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAM/F;AAED,qDAAqD;AACrD,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,MAAM,SAAM,GAAG,MAAM,CAGnE;AAED,uCAAuC;AACvC,wBAAgB,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAE5C;AAED;;;GAGG;AACH,wBAAsB,WAAW,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,CAoBxF;AAED,gFAAgF;AAChF,wBAAuB,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,GAAG,cAAc,CAAC,UAAU,GAAG,MAAM,EAAE,IAAI,EAAE,SAAS,CAAC,CAKtH"}