@sig-net/midnight-serde 0.23.0 → 0.24.0-rc.10

package/dist/validate.js

@@ -1,185 +0,0 @@
-// Strict runtime validation of CompactType descriptors. TypeScript checks
-// descriptors at compile time, but descriptors can also arrive from plain JS,
-// JSON, or casts, and Compact is a strict protocol: a malformed descriptor
-// must throw immediately with a path to the offending node, never produce
-// bytes. Every public entry point of this package validates its descriptor
-// through here before doing any work.
-import { MAX_UINT_BITS, MAX_UINT_BOUND } from "./types.js";
-/** The exact keys allowed on each descriptor kind: extra keys are rejected. */
-const KIND_KEYS = {
-    boolean: ["kind"],
-    uint: ["kind", "bits", "bound"],
-    field: ["kind"],
-    bytes: ["kind", "length"],
-    enum: ["kind", "variants"],
-    vector: ["kind", "length", "element"],
-    tuple: ["kind", "elements"],
-    struct: ["kind", "fields"],
-};
-function assertNonNegativeInteger(value, label) {
-    // isSafeInteger, not isInteger: a length like 2^60 passes isInteger but
-    // breaks the Number arithmetic packed sizes are computed with.
-    if (typeof value !== "number" || !Number.isSafeInteger(value) || value < 0) {
-        throw new Error(`${label} must be a non-negative safe integer, got ${String(value)}`);
-    }
-}
-/**
- * Cross-realm-safe Uint8Array check. `instanceof` fails for buffers created
- * in another realm (node:vm context, iframe), which are otherwise perfectly
- * valid inputs, so fall back to the brand check.
- *
- * @param value - The value to test.
- * @returns Whether the value is a Uint8Array from any realm.
- */
-export function isUint8Array(value) {
-    return (value instanceof Uint8Array || Object.prototype.toString.call(value) === "[object Uint8Array]");
-}
-/**
- * Assert that `type` is a structurally valid {@link CompactType}, recursively.
- * Rejects unknown kinds, unexpected extra keys (typo protection), out-of-range
- * widths and lengths, empty or duplicate struct field names, and any
- * non-object node. Error messages carry the path to the offending node.
- *
- * @param type - The candidate descriptor.
- * @param label - Path prefix for error messages.
- * @throws {Error} If the descriptor is malformed at any depth.
- */
-export function assertCompactType(type, label = "type") {
-    if (typeof type !== "object" || type === null || Array.isArray(type)) {
-        throw new Error(`${label}: descriptor must be a plain object`);
-    }
-    const record = type;
-    const kind = record.kind;
-    // Object.hasOwn, not `in`: `in` walks the prototype chain, so kinds like
-    // 'toString' would slip past and die later with a confusing TypeError.
-    const allowedKeys = typeof kind === "string" ? KIND_KEYS[kind] : undefined;
-    if (typeof kind !== "string" || !Object.hasOwn(KIND_KEYS, kind) || allowedKeys === undefined) {
-        throw new Error(`${label}: unknown descriptor kind ${JSON.stringify(kind)} ` +
-            `(expected 'boolean' | 'uint' | 'field' | 'bytes' | 'enum' | 'vector' | 'tuple' | 'struct')`);
-    }
-    for (const key of Object.keys(record)) {
-        if (!allowedKeys.includes(key)) {
-            throw new Error(`${label}: unexpected key '${key}' on a '${kind}' descriptor`);
-        }
-    }
-    switch (kind) {
-        case "boolean":
-        case "field":
-            return;
-        case "uint": {
-            // Own-property reads: a plain `record.bits` would resolve through the
-            // prototype chain, letting `{ __proto__: { bits: 8 }, kind: 'uint' }`
-            // slip past even though Object.keys sees no such key.
-            const bits = Object.hasOwn(record, "bits") ? record.bits : undefined;
-            const bound = Object.hasOwn(record, "bound") ? record.bound : undefined;
-            const hasBits = bits !== undefined;
-            const hasBound = bound !== undefined;
-            if (hasBits === hasBound) {
-                throw new Error(`${label}: a uint descriptor needs exactly one of 'bits' (sized Uint<w>) ` +
-                    `or 'bound' (bounded Uint<0..n>)`);
-            }
-            if (hasBits) {
-                if (typeof bits !== "number" ||
-                    !Number.isInteger(bits) ||
-                    bits < 1 ||
-                    bits > MAX_UINT_BITS) {
-                    throw new Error(`${label}: uint bits must be an integer in 1..${String(MAX_UINT_BITS)}, got ${JSON.stringify(bits)}`);
-                }
-                return;
-            }
-            if (typeof bound === "number" && !Number.isSafeInteger(bound)) {
-                throw new Error(`${label}: a number uint bound must be a safe integer (use a bigint ` +
-                    `beyond 2^53), got ${String(bound)}`);
-            }
-            if (typeof bound !== "number" && typeof bound !== "bigint") {
-                throw new Error(`${label}: uint bound must be a number or bigint, got ${String(bound)}`);
-            }
-            if (BigInt(bound) < 1n || BigInt(bound) > MAX_UINT_BOUND) {
-                throw new Error(`${label}: uint bound must be in 1..2^248 (the bound is EXCLUSIVE, ` +
-                    `matching Uint<0..n>), got ${String(bound)}`);
-            }
-            return;
-        }
-        case "bytes":
-            assertNonNegativeInteger(record.length, `${label}: bytes length`);
-            return;
-        case "enum": {
-            const variants = record.variants;
-            if (typeof variants !== "number" || !Number.isSafeInteger(variants) || variants < 1) {
-                throw new Error(`${label}: enum variants must be a positive integer, got ${String(variants)}`);
-            }
-            return;
-        }
-        case "vector":
-            assertNonNegativeInteger(record.length, `${label}: vector length`);
-            assertCompactType(record.element, `${label}.element`);
-            return;
-        case "tuple": {
-            const elements = record.elements;
-            if (!Array.isArray(elements)) {
-                throw new Error(`${label}: tuple elements must be an array`);
-            }
-            elements.forEach((element, i) => {
-                assertCompactType(element, `${label}.elements[${String(i)}]`);
-            });
-            return;
-        }
-        case "struct": {
-            const fields = record.fields;
-            if (!Array.isArray(fields)) {
-                throw new Error(`${label}: struct fields must be an array`);
-            }
-            const seen = new Set();
-            fields.forEach((field, i) => {
-                const fieldLabel = `${label}.fields[${String(i)}]`;
-                if (typeof field !== "object" || field === null || Array.isArray(field)) {
-                    throw new Error(`${fieldLabel}: field must be a plain object`);
-                }
-                const fieldRecord = field;
-                for (const key of Object.keys(fieldRecord)) {
-                    if (key !== "name" && key !== "type") {
-                        throw new Error(`${fieldLabel}: unexpected key '${key}' on a struct field`);
-                    }
-                }
-                if (typeof fieldRecord.name !== "string" || fieldRecord.name.length === 0) {
-                    throw new Error(`${fieldLabel}: field name must be a non-empty string`);
-                }
-                if (seen.has(fieldRecord.name)) {
-                    throw new Error(`${fieldLabel}: duplicate field name '${fieldRecord.name}'`);
-                }
-                seen.add(fieldRecord.name);
-                assertCompactType(fieldRecord.type, `${fieldLabel}.type`);
-            });
-            return;
-        }
-    }
-}
-/**
- * Boolean form of {@link assertCompactType}.
- *
- * @param type - The candidate descriptor.
- * @returns Whether the descriptor is structurally valid.
- */
-export function isCompactType(type) {
-    try {
-        assertCompactType(type);
-        return true;
-    }
-    catch {
-        return false;
-    }
-}
-/**
- * Exhaustiveness backstop for descriptor switches. Statically `value` is
- * `never` (every kind handled); at runtime it still throws on anything that
- * slipped past validation instead of falling through to undefined behaviour.
- *
- * @param value - The descriptor every branch was meant to have handled.
- * @param label - Caller name, used in the error message.
- * @throws {Error} Always, naming the unhandled kind.
- */
-export function assertUnreachable(value, label) {
-    const kind = value?.kind;
-    throw new Error(`${label}: unhandled descriptor kind ${JSON.stringify(kind)}`);
-}
-//# sourceMappingURL=validate.js.map

package/dist/validate.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"validate.js","sourceRoot":"","sources":["../src/validate.ts"],"names":[],"mappings":"AAAA,0EAA0E;AAC1E,8EAA8E;AAC9E,2EAA2E;AAC3E,0EAA0E;AAC1E,2EAA2E;AAC3E,sCAAsC;AAGtC,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE3D,+EAA+E;AAC/E,MAAM,SAAS,GAAsC;IACnD,OAAO,EAAE,CAAC,MAAM,CAAC;IACjB,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC;IAC/B,KAAK,EAAE,CAAC,MAAM,CAAC;IACf,KAAK,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC;IACzB,IAAI,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC;IAC1B,MAAM,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC;IACrC,KAAK,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC;IAC3B,MAAM,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC;CAC3B,CAAC;AAEF,SAAS,wBAAwB,CAAC,KAAc,EAAE,KAAa;IAC7D,wEAAwE;IACxE,+DAA+D;IAC/D,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;QAC3E,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,6CAA6C,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACxF,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAAC,KAAc;IACzC,OAAO,CACL,KAAK,YAAY,UAAU,IAAI,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,qBAAqB,CAC/F,CAAC;AACJ,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,iBAAiB,CAAC,IAAa,EAAE,KAAK,GAAG,MAAM;IAC7D,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACrE,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,qCAAqC,CAAC,CAAC;IACjE,CAAC;IACD,MAAM,MAAM,GAAG,IAA+B,CAAC;IAC/C,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;IACzB,yEAAyE;IACzE,uEAAuE;IACvE,MAAM,WAAW,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3E,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;QAC7F,MAAM,IAAI,KAAK,CACb,GAAG,KAAK,6BAA6B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG;YAC1D,4FAA4F,CAC/F,CAAC;IACJ,CAAC;IACD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACtC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,qBAAqB,GAAG,WAAW,IAAI,cAAc,CAAC,CAAC;QACjF,CAAC;IACH,CAAC;IAED,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,SAAS,CAAC;QACf,KAAK,OAAO;YACV,OAAO;QAET,KAAK,MAAM,EAAE,CAAC;YACZ,sEAAsE;YACtE,sEAAsE;YACtE,sDAAsD;YACtD,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACrE,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;YACxE,MAAM,OAAO,GAAG,IAAI,KAAK,SAAS,CAAC;YACnC,MAAM,QAAQ,GAAG,KAAK,KAAK,SAAS,CAAC;YACrC,IAAI,OAAO,KAAK,QAAQ,EAAE,CAAC;gBACzB,MAAM,IAAI,KAAK,CACb,GAAG,KAAK,kEAAkE;oBACxE,iCAAiC,CACpC,CAAC;YACJ,CAAC;YACD,IAAI,OAAO,EAAE,CAAC;gBACZ,IACE,OAAO,IAAI,KAAK,QAAQ;oBACxB,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC;oBACvB,IAAI,GAAG,CAAC;oBACR,IAAI,GAAG,aAAa,EACpB,CAAC;oBACD,MAAM,IAAI,KAAK,CACb,GAAG,KAAK,wCAAwC,MAAM,CAAC,aAAa,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CACrG,CAAC;gBACJ,CAAC;gBACD,OAAO;YACT,CAAC;YACD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC9D,MAAM,IAAI,KAAK,CACb,GAAG,KAAK,6DAA6D;oBACnE,qBAAqB,MAAM,CAAC,KAAK,CAAC,EAAE,CACvC,CAAC;YACJ,CAAC;YACD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC3D,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,gDAAgD,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YAC3F,CAAC;YACD,IAAI,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,MAAM,CAAC,KAAK,CAAC,GAAG,cAAc,EAAE,CAAC;gBACzD,MAAM,IAAI,KAAK,CACb,GAAG,KAAK,4DAA4D;oBAClE,6BAA6B,MAAM,CAAC,KAAK,CAAC,EAAE,CAC/C,CAAC;YACJ,CAAC;YACD,OAAO;QACT,CAAC;QAED,KAAK,OAAO;YACV,wBAAwB,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,KAAK,gBAAgB,CAAC,CAAC;YAClE,OAAO;QAET,KAAK,MAAM,EAAE,CAAC;YACZ,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;YACjC,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,QAAQ,GAAG,CAAC,EAAE,CAAC;gBACpF,MAAM,IAAI,KAAK,CACb,GAAG,KAAK,mDAAmD,MAAM,CAAC,QAAQ,CAAC,EAAE,CAC9E,CAAC;YACJ,CAAC;YACD,OAAO;QACT,CAAC;QAED,KAAK,QAAQ;YACX,wBAAwB,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,KAAK,iBAAiB,CAAC,CAAC;YACnE,iBAAiB,CAAC,MAAM,CAAC,OAAO,EAAE,GAAG,KAAK,UAAU,CAAC,CAAC;YACtD,OAAO;QAET,KAAK,OAAO,EAAE,CAAC;YACb,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;YACjC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC7B,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,mCAAmC,CAAC,CAAC;YAC/D,CAAC;YACD,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAgB,EAAE,CAAC,EAAE,EAAE;gBACvC,iBAAiB,CAAC,OAAO,EAAE,GAAG,KAAK,aAAa,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;YAChE,CAAC,CAAC,CAAC;YACH,OAAO;QACT,CAAC;QAED,KAAK,QAAQ,EAAE,CAAC;YACd,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;YAC7B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC3B,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,kCAAkC,CAAC,CAAC;YAC9D,CAAC;YACD,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;YAC/B,MAAM,CAAC,OAAO,CAAC,CAAC,KAAc,EAAE,CAAC,EAAE,EAAE;gBACnC,MAAM,UAAU,GAAG,GAAG,KAAK,WAAW,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC;gBACnD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBACxE,MAAM,IAAI,KAAK,CAAC,GAAG,UAAU,gCAAgC,CAAC,CAAC;gBACjE,CAAC;gBACD,MAAM,WAAW,GAAG,KAAgC,CAAC;gBACrD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;oBAC3C,IAAI,GAAG,KAAK,MAAM,IAAI,GAAG,KAAK,MAAM,EAAE,CAAC;wBACrC,MAAM,IAAI,KAAK,CAAC,GAAG,UAAU,qBAAqB,GAAG,qBAAqB,CAAC,CAAC;oBAC9E,CAAC;gBACH,CAAC;gBACD,IAAI,OAAO,WAAW,CAAC,IAAI,KAAK,QAAQ,IAAI,WAAW,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBAC1E,MAAM,IAAI,KAAK,CAAC,GAAG,UAAU,yCAAyC,CAAC,CAAC;gBAC1E,CAAC;gBACD,IAAI,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC/B,MAAM,IAAI,KAAK,CAAC,GAAG,UAAU,2BAA2B,WAAW,CAAC,IAAI,GAAG,CAAC,CAAC;gBAC/E,CAAC;gBACD,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;gBAC3B,iBAAiB,CAAC,WAAW,CAAC,IAAI,EAAE,GAAG,UAAU,OAAO,CAAC,CAAC;YAC5D,CAAC,CAAC,CAAC;YACH,OAAO;QACT,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,IAAa;IACzC,IAAI,CAAC;QACH,iBAAiB,CAAC,IAAI,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAAY,EAAE,KAAa;IAC3D,MAAM,IAAI,GAAI,KAAmC,EAAE,IAAI,CAAC;IACxD,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,+BAA+B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACjF,CAAC"}