aontu 0.52.1 → 0.54.0

package/dist/val/arith.js

@@ -0,0 +1,173 @@
+"use strict";
+/* Copyright (c) 2025 Richard Rodger, MIT License */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.arith = arith;
+const err_1 = require("../err");
+const IntegerVal_1 = require("./IntegerVal");
+const NumberVal_1 = require("./NumberVal");
+const BigIntegerVal_1 = require("./BigIntegerVal");
+const BigDecimalVal_1 = require("./BigDecimalVal");
+const Decimal_1 = require("./Decimal");
+const numkind_1 = require("./numkind");
+// The three that divide, and therefore the three that can be handed a
+// zero divisor and cannot answer over the decimal leaf.
+function divides(op) {
+    return 'div' === op || 'mod' === op || 'rem' === op;
+}
+const EXACT_RANK = {
+    integer: 1,
+    biginteger: 2,
+    bigdecimal: 3,
+};
+function isBig(k) {
+    return 'biginteger' === k || 'bigdecimal' === k;
+}
+// A pref operand contributes its preferred value, and therefore that
+// value's kind too -- the same rule `+` applies.
+function unpref(v) {
+    while (v?.isPref) {
+        v = v.peg;
+    }
+    return v;
+}
+function arithKind(v) {
+    // Every caller hands a driven Val (an operand past the signature
+    // gate, or a bag member from the aggregate fold), so scalarhood is
+    // the one question -- a container member lands here.
+    if (true !== v?.isScalar) {
+        return undefined;
+    }
+    if (v.isBigInteger) {
+        return 'biginteger';
+    }
+    if (v.isBigDecimal) {
+        return 'bigdecimal';
+    }
+    if (v.isInteger) {
+        return 'integer';
+    }
+    return 'number' === typeof v.peg ? 'float' : undefined;
+}
+// An exact-ladder operand as an exact integer. Only reached for the two
+// integral leaves; an `integer` peg is integral by construction.
+function asInteger(v, k) {
+    return 'biginteger' === k ? v.peg : BigInt(v.peg);
+}
+function asDecimal(v, k) {
+    return 'bigdecimal' === k ? v.peg : new Decimal_1.Decimal(asInteger(v, k), 0);
+}
+// The whole family, in one function, because every rule above is a rule
+// about ARITHMETIC and not about any one operation. `node` is the value
+// the error is located at -- the call, or the `+` op.
+// `attempt` is the name the ERROR reports, which is the operation
+// except when a fold borrows one: `sum` adds, but a bad member is the
+// author's `sum` call and must say so.
+function arith(ctx, op, node, a, b, attempt) {
+    const name = attempt ?? op;
+    const av = unpref(a);
+    const bv = unpref(b);
+    const ak = arithKind(av);
+    const bk = arithKind(bv);
+    // A non-numeric operand is not something to wait for: `resolve` is
+    // only reached once every argument has settled, so a kind, a map, a
+    // string or a boolean here is the author's mistake and is named as
+    // one. (`+` differs, and must: it has answers for strings and
+    // booleans.)
+    if (undefined === ak || undefined === bk) {
+        return (0, err_1.makeNilErr)(ctx, 'invalid-arg', node, undefined, name);
+    }
+    // A big leaf never silently becomes a binary float, in EITHER operand
+    // order. The error names both leaves in operand order.
+    if (('float' === ak && isBig(bk)) || (isBig(ak) && 'float' === bk)) {
+        return (0, err_1.makeNilErr)(ctx, 'exact_float_mix', node, undefined, name, { left: ak, right: bk });
+    }
+    if ('float' === ak || 'float' === bk) {
+        return floatArith(ctx, op, name, node, av.peg, bv.peg);
+    }
+    const rank = EXACT_RANK[bk] < EXACT_RANK[ak] ? EXACT_RANK[ak] : EXACT_RANK[bk];
+    if (EXACT_RANK.bigdecimal === rank) {
+        return decimalArith(ctx, op, name, node, asDecimal(av, ak), asDecimal(bv, bk));
+    }
+    return integerArith(ctx, op, name, node, asInteger(av, ak), asInteger(bv, bk), EXACT_RANK.biginteger === rank);
+}
+// IEEE-754 binary64, with the JSON-superset constraint still biting: an
+// infinite or NaN result is a located error rather than a value, because
+// there is no way to write one down and no JSON that could carry it.
+function floatArith(ctx, op, name, node, x, y) {
+    if (divides(op) && 0 === y) {
+        return (0, err_1.makeNilErr)(ctx, 'divide_by_zero', node, undefined, name);
+    }
+    const out = 'add' === op ? x + y :
+        'sub' === op ? x - y :
+            'mul' === op ? x * y :
+                'div' === op ? x / y :
+                    // Truncated remainder, sign following the DIVIDEND, which is
+                    // what JavaScript's `%` and Go's math.Mod both give...
+                    'rem' === op ? x % y :
+                        // ...and the floored modulus, sign following the DIVISOR,
+                        // built from it. Adding the divisor back moves a remainder
+                        // whose sign disagrees into agreement, and leaves an exact
+                        // zero alone.
+                        flooredMod(x % y, y);
+    return Number.isFinite(out) ?
+        new NumberVal_1.NumberVal({ peg: out }) :
+        (0, err_1.makeNilErr)(ctx, 'float_overflow', node, undefined, name);
+}
+function flooredMod(rem, y) {
+    return 0 !== rem && (rem < 0) !== (y < 0) ? rem + y : rem;
+}
+// The exact integral leaves. Both compute in bigint, so nothing passes
+// through binary64 and nothing rounds; only the storage test at the end
+// differs, because `biginteger` is unbounded and `integer` is not.
+function integerArith(ctx, op, name, node, x, y, big) {
+    if (divides(op) && 0n === y) {
+        return (0, err_1.makeNilErr)(ctx, 'divide_by_zero', node, undefined, name);
+    }
+    const out = 'add' === op ? x + y :
+        'sub' === op ? x - y :
+            'mul' === op ? x * y :
+                // TRUNCATION TOWARD ZERO, stated once here rather than left to
+                // whichever host `/` each port happens to call: div(-7, 2) is
+                // -3, not -4. BigInt division truncates, and so does Go's
+                // big.Int.Quo (its Div floors, which is why the Go twin must
+                // not use it).
+                'div' === op ? x / y :
+                    'rem' === op ? x % y :
+                        flooredModBig(x % y, y);
+    if (big) {
+        // Unbounded and exact: nothing to check, and no demotion to
+        // `integer` however small the result.
+        return new BigIntegerVal_1.BigIntegerVal({ peg: out });
+    }
+    // The result faces the SAME storage contract R1 puts on a literal --
+    // integral, inside the int64 window, and exactly representable in
+    // binary64 -- because Go's int64 holds results TypeScript's double
+    // cannot, and without a shared test a document would resolve in one
+    // port and round in the other.
+    return (0, numkind_1.isIntegerStorable)(out) ?
+        new IntegerVal_1.IntegerVal({ peg: Number(out) }) :
+        (0, err_1.makeNilErr)(ctx, 'inexact_integer_sum', node, undefined, name, { sum: out.toString() });
+}
+function flooredModBig(rem, y) {
+    return 0n !== rem && (rem < 0n) !== (y < 0n) ? rem + y : rem;
+}
+// The decimal leaf. Addition, subtraction and multiplication are exact
+// coefficient arithmetic and land here; division does not, and says so.
+function decimalArith(ctx, op, name, node, x, y) {
+    if (divides(op)) {
+        // EXACT DECIMAL DIVISION IS NOT CLOSED: one third has no finite
+        // decimal form, so a `div` over this leaf either rounds -- the one
+        // thing the leaf exists to refuse -- or refuses. It refuses, and the
+        // hint names both ways out.
+        return (0, err_1.makeNilErr)(ctx, 'inexact_divide', node, undefined, name);
+    }
+    const out = 'add' === op ? x.add(y) :
+        'sub' === op ? x.add(y.negate()) :
+            x.multiply(y);
+    // The budget applies to RESULTS as well as literals: an exact answer
+    // too wide to hold is refused, never rounded to fit.
+    return (0, Decimal_1.decimalOverBudget)(out) ?
+        (0, err_1.makeNilErr)(ctx, 'decimal_budget', node, undefined, name) :
+        new BigDecimalVal_1.BigDecimalVal({ peg: out });
+} /* node:coverage ignore next 9 */
+//# sourceMappingURL=arith.js.map

package/dist/val/arith.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"arith.js","sourceRoot":"","sources":["../../src/val/arith.ts"],"names":[],"mappings":";AAAA,oDAAoD;;QA6TlD,KAAK;AAhQP,gCAAmC;AAEnC,6CAAyC;AACzC,2CAAuC;AACvC,mDAA+C;AAC/C,mDAA+C;AAC/C,uCAAsD;AACtD,uCAA6C;AAK7C,sEAAsE;AACtE,wDAAwD;AACxD,SAAS,OAAO,CAAC,EAAW;IAC1B,OAAO,KAAK,KAAK,EAAE,IAAI,KAAK,KAAK,EAAE,IAAI,KAAK,KAAK,EAAE,CAAA;AACrD,CAAC;AAOD,MAAM,UAAU,GAA2B;IACzC,OAAO,EAAE,CAAC;IACV,UAAU,EAAE,CAAC;IACb,UAAU,EAAE,CAAC;CACd,CAAA;AAGD,SAAS,KAAK,CAAC,CAAY;IACzB,OAAO,YAAY,KAAK,CAAC,IAAI,YAAY,KAAK,CAAC,CAAA;AACjD,CAAC;AAGD,qEAAqE;AACrE,iDAAiD;AACjD,SAAS,MAAM,CAAC,CAAM;IACpB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;QACjB,CAAC,GAAG,CAAC,CAAC,GAAG,CAAA;IACX,CAAC;IACD,OAAO,CAAC,CAAA;AACV,CAAC;AAGD,SAAS,SAAS,CAAC,CAAM;IACvB,iEAAiE;IACjE,mEAAmE;IACnE,qDAAqD;IACrD,IAAI,IAAI,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAC;QACzB,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,IAAI,CAAC,CAAC,YAAY,EAAE,CAAC;QACnB,OAAO,YAAY,CAAA;IACrB,CAAC;IACD,IAAI,CAAC,CAAC,YAAY,EAAE,CAAC;QACnB,OAAO,YAAY,CAAA;IACrB,CAAC;IACD,IAAI,CAAC,CAAC,SAAS,EAAE,CAAC;QAChB,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,OAAO,QAAQ,KAAK,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAA;AACxD,CAAC;AAGD,wEAAwE;AACxE,iEAAiE;AACjE,SAAS,SAAS,CAAC,CAAM,EAAE,CAAY;IACrC,OAAO,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;AACnD,CAAC;AAGD,SAAS,SAAS,CAAC,CAAM,EAAE,CAAY;IACrC,OAAO,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,iBAAO,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;AACrE,CAAC;AAGD,wEAAwE;AACxE,wEAAwE;AACxE,sDAAsD;AACtD,kEAAkE;AAClE,sEAAsE;AACtE,uCAAuC;AACvC,SAAS,KAAK,CACZ,GAA6B,EAC7B,EAAW,EACX,IAAS,EACT,CAAM,EACN,CAAM,EACN,OAAgB;IAEhB,MAAM,IAAI,GAAG,OAAO,IAAI,EAAE,CAAA;IAC1B,MAAM,EAAE,GAAQ,MAAM,CAAC,CAAC,CAAC,CAAA;IACzB,MAAM,EAAE,GAAQ,MAAM,CAAC,CAAC,CAAC,CAAA;IACzB,MAAM,EAAE,GAAG,SAAS,CAAC,EAAE,CAAC,CAAA;IACxB,MAAM,EAAE,GAAG,SAAS,CAAC,EAAE,CAAC,CAAA;IAExB,mEAAmE;IACnE,oEAAoE;IACpE,mEAAmE;IACnE,8DAA8D;IAC9D,aAAa;IACb,IAAI,SAAS,KAAK,EAAE,IAAI,SAAS,KAAK,EAAE,EAAE,CAAC;QACzC,OAAO,IAAA,gBAAU,EAAC,GAAG,EAAE,aAAa,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,CAAA;IAC9D,CAAC;IAED,sEAAsE;IACtE,uDAAuD;IACvD,IAAI,CAAC,OAAO,KAAK,EAAE,IAAI,KAAK,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,OAAO,KAAK,EAAE,CAAC,EAAE,CAAC;QACnE,OAAO,IAAA,gBAAU,EAAC,GAAG,EAAE,iBAAiB,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAC7D,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAA;IAC5B,CAAC;IAED,IAAI,OAAO,KAAK,EAAE,IAAI,OAAO,KAAK,EAAE,EAAE,CAAC;QACrC,OAAO,UAAU,CAAC,GAAG,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,CAAA;IACxD,CAAC;IAED,MAAM,IAAI,GAAG,UAAU,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,CAAC,CAAA;IAE9E,IAAI,UAAU,CAAC,UAAU,KAAK,IAAI,EAAE,CAAC;QACnC,OAAO,YAAY,CAAC,GAAG,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAA;IAChF,CAAC;IAED,OAAO,YAAY,CAAC,GAAG,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,EACxD,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,UAAU,CAAC,UAAU,KAAK,IAAI,CAAC,CAAA;AACtD,CAAC;AAGD,wEAAwE;AACxE,yEAAyE;AACzE,qEAAqE;AACrE,SAAS,UAAU,CACjB,GAA6B,EAC7B,EAAW,EACX,IAAY,EACZ,IAAS,EACT,CAAS,EACT,CAAS;IAET,IAAI,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3B,OAAO,IAAA,gBAAU,EAAC,GAAG,EAAE,gBAAgB,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,CAAA;IACjE,CAAC;IAED,MAAM,GAAG,GACP,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QACpB,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YACpB,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;gBACpB,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;oBACpB,6DAA6D;oBAC7D,uDAAuD;oBACvD,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;wBACpB,0DAA0D;wBAC1D,2DAA2D;wBAC3D,2DAA2D;wBAC3D,cAAc;wBACd,UAAU,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAA;IAEhC,OAAO,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;QAC3B,IAAI,qBAAS,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;QAC7B,IAAA,gBAAU,EAAC,GAAG,EAAE,gBAAgB,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,CAAA;AAC5D,CAAC;AAGD,SAAS,UAAU,CAAC,GAAW,EAAE,CAAS;IACxC,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAA;AAC3D,CAAC;AAGD,uEAAuE;AACvE,wEAAwE;AACxE,mEAAmE;AACnE,SAAS,YAAY,CACnB,GAA6B,EAC7B,EAAW,EACX,IAAY,EACZ,IAAS,EACT,CAAS,EACT,CAAS,EACT,GAAY;IAEZ,IAAI,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC;QAC5B,OAAO,IAAA,gBAAU,EAAC,GAAG,EAAE,gBAAgB,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,CAAA;IACjE,CAAC;IAED,MAAM,GAAG,GACP,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QACpB,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YACpB,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;gBACpB,+DAA+D;gBAC/D,8DAA8D;gBAC9D,0DAA0D;gBAC1D,6DAA6D;gBAC7D,eAAe;gBACf,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;oBACpB,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;wBACpB,aAAa,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAA;IAEnC,IAAI,GAAG,EAAE,CAAC;QACR,4DAA4D;QAC5D,sCAAsC;QACtC,OAAO,IAAI,6BAAa,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAA;IACxC,CAAC;IAED,qEAAqE;IACrE,kEAAkE;IAClE,mEAAmE;IACnE,oEAAoE;IACpE,+BAA+B;IAC/B,OAAO,IAAA,2BAAiB,EAAC,GAAG,CAAC,CAAC,CAAC;QAC7B,IAAI,uBAAU,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;QACtC,IAAA,gBAAU,EAAC,GAAG,EAAE,qBAAqB,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAC1D,EAAE,GAAG,EAAE,GAAG,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAA;AAC9B,CAAC;AAGD,SAAS,aAAa,CAAC,GAAW,EAAE,CAAS;IAC3C,OAAO,EAAE,KAAK,GAAG,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAA;AAC9D,CAAC;AAGD,uEAAuE;AACvE,wEAAwE;AACxE,SAAS,YAAY,CACnB,GAA6B,EAC7B,EAAW,EACX,IAAY,EACZ,IAAS,EACT,CAAU,EACV,CAAU;IAEV,IAAI,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC;QAChB,gEAAgE;QAChE,mEAAmE;QACnE,qEAAqE;QACrE,4BAA4B;QAC5B,OAAO,IAAA,gBAAU,EAAC,GAAG,EAAE,gBAAgB,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,CAAA;IACjE,CAAC;IAED,MAAM,GAAG,GACP,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACvB,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;YAChC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;IAEnB,qEAAqE;IACrE,qDAAqD;IACrD,OAAO,IAAA,2BAAiB,EAAC,GAAG,CAAC,CAAC,CAAC;QAC7B,IAAA,gBAAU,EAAC,GAAG,EAAE,gBAAgB,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;QAC1D,IAAI,6BAAa,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAA;AACnC,CAAC,CAAC,iCAAiC"}

package/dist/vet.d.ts

@@ -0,0 +1,45 @@
+import type { TrustOptions, Val } from './type';
+export type VetVerdict = 'valid' | 'invalid' | 'incomplete' | 'error';
+export type VetRole = 'data' | 'schema';
+export type VetSite = {
+    file: string;
+    row: number;
+    col: number;
+    len: number;
+    role: VetRole;
+    src?: string;
+    value?: string;
+};
+export type VetFinding = {
+    code: string;
+    class: string;
+    severity: 'error' | 'warning' | 'info';
+    path: string;
+    message: string;
+    hint?: string;
+    sites: VetSite[];
+    expected?: string;
+    actual?: string;
+    note?: string;
+};
+export type VetReport = {
+    verdict: VetVerdict;
+    truncated: boolean;
+    findings: VetFinding[];
+};
+export type VetOptions = {
+    at?: string;
+    closed?: boolean;
+    partial?: boolean;
+    maxErrors?: number;
+    schemaUrl?: string;
+    dataUrl?: string;
+    schemaPath?: string;
+    dataPath?: string;
+    trust?: TrustOptions;
+};
+export declare const VET_MAX_ERRORS = 20;
+export declare function displayFile(url: string, label: string, path?: string): string;
+export declare function failureFinding(ctx: any, url?: string, failed?: any): VetFinding;
+export declare function anchorAt(root: any, at: string): Val | undefined;
+export declare function vet(schemaSrc: string, dataSrc: string, opts?: VetOptions): VetReport;