@ducatjs/money 0.0.0 → 0.2.0

package/dist/adyen.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Adyen's minor-unit view (https://docs.adyen.com/development-resources/currency-codes, encoded in
+ * data/adyen.json). Adyen's table is authoritative where it differs from ISO 4217: CLP 2 (ISO 0),
+ * ISK 2 (ISO 0), IDR 0 (ISO 2), CVE 0 (ISO 2). The Terminal API uses major units instead.
+ */
+import { ADYEN_EXPONENTS } from './generated/adyen.js';
+import { type CurrencyInput, type Money } from './money.js';
+import type { RoundingMode } from './rounding.js';
+export { ADYEN_EXPONENTS };
+declare function exponent(currency: string): number;
+/** Whether Adyen lists the currency (its table, not ISO 4217). */
+export declare const isAdyenCurrency: (currency: string) => boolean;
+/** The exponent Adyen's API uses for a currency (CLP 2, ISK 2, IDR 0, CVE 0 differ from ISO). */
+export declare const adyenExponent: typeof exponent;
+/** Adyen `amount` object: toAdyen(money('15000', 'IDR')) -> { value: 15000, currency: 'IDR' }. */
+export declare function toAdyen(money: Money, rounding?: RoundingMode): {
+    value: number;
+    currency: string;
+};
+/** Reads an Adyen `amount` object: fromAdyen({ value: 15000, currency: 'IDR' }) is 15000 IDR. */
+export declare function fromAdyen<C extends CurrencyInput>(amount: {
+    value: number | bigint;
+    currency: C;
+}): Money<C>;
+//# sourceMappingURL=adyen.d.ts.map

package/dist/adyen.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"adyen.d.ts","sourceRoot":"","sources":["../src/adyen.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,KAAK,aAAa,EAAE,KAAK,KAAK,EAAE,MAAM,YAAY,CAAC;AAE5D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAElD,OAAO,EAAE,eAAe,EAAE,CAAC;AAE3B,iBAAS,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAQ1C;AAED,kEAAkE;AAClE,eAAO,MAAM,eAAe,GAAI,UAAU,MAAM,KAAG,OACJ,CAAC;AAChD,iGAAiG;AACjG,eAAO,MAAM,aAAa,iBAAW,CAAC;AAEtC,kGAAkG;AAClG,wBAAgB,OAAO,CACrB,KAAK,EAAE,KAAK,EACZ,QAAQ,GAAE,YAA4B,GACrC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAKrC;AAED,iGAAiG;AACjG,wBAAgB,SAAS,CAAC,CAAC,SAAS,aAAa,EAAE,MAAM,EAAE;IACzD,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IACvB,QAAQ,EAAE,CAAC,CAAC;CACb,GAAG,KAAK,CAAC,CAAC,CAAC,CAEX"}

package/dist/adyen.js

@@ -0,0 +1,34 @@
+/**
+ * Adyen's minor-unit view (https://docs.adyen.com/development-resources/currency-codes, encoded in
+ * data/adyen.json). Adyen's table is authoritative where it differs from ISO 4217: CLP 2 (ISO 0),
+ * ISK 2 (ISO 0), IDR 0 (ISO 2), CVE 0 (ISO 2). The Terminal API uses major units instead.
+ */
+import { ADYEN_EXPONENTS } from './generated/adyen.js';
+import {} from './money.js';
+import { fromProcessorAmount, toProcessorAmount } from './processor.js';
+export { ADYEN_EXPONENTS };
+function exponent(currency) {
+    const found = ADYEN_EXPONENTS[currency];
+    // typeof, not !== undefined: the table is a plain object, so 'toString' or 'constructor' would
+    // otherwise find an inherited method instead of failing.
+    if (typeof found !== 'number') {
+        throw new RangeError(`${currency} is not in Adyen's currency table`);
+    }
+    return found;
+}
+/** Whether Adyen lists the currency (its table, not ISO 4217). */
+export const isAdyenCurrency = (currency) => typeof ADYEN_EXPONENTS[currency] === 'number';
+/** The exponent Adyen's API uses for a currency (CLP 2, ISK 2, IDR 0, CVE 0 differ from ISO). */
+export const adyenExponent = exponent;
+/** Adyen `amount` object: toAdyen(money('15000', 'IDR')) -> { value: 15000, currency: 'IDR' }. */
+export function toAdyen(money, rounding = 'unnecessary') {
+    return {
+        value: toProcessorAmount('Adyen', money, exponent(money.currency), 1, rounding),
+        currency: money.currency,
+    };
+}
+/** Reads an Adyen `amount` object: fromAdyen({ value: 15000, currency: 'IDR' }) is 15000 IDR. */
+export function fromAdyen(amount) {
+    return fromProcessorAmount('Adyen', amount.value, amount.currency, exponent(amount.currency));
+}
+//# sourceMappingURL=adyen.js.map

package/dist/adyen.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adyen.js","sourceRoot":"","sources":["../src/adyen.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAkC,MAAM,YAAY,CAAC;AAC5D,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAGxE,OAAO,EAAE,eAAe,EAAE,CAAC;AAE3B,SAAS,QAAQ,CAAC,QAAgB;IAChC,MAAM,KAAK,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAC;IACxC,+FAA+F;IAC/F,yDAAyD;IACzD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,MAAM,IAAI,UAAU,CAAC,GAAG,QAAQ,mCAAmC,CAAC,CAAC;IACvE,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,kEAAkE;AAClE,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,QAAgB,EAAW,EAAE,CAC3D,OAAO,eAAe,CAAC,QAAQ,CAAC,KAAK,QAAQ,CAAC;AAChD,iGAAiG;AACjG,MAAM,CAAC,MAAM,aAAa,GAAG,QAAQ,CAAC;AAEtC,kGAAkG;AAClG,MAAM,UAAU,OAAO,CACrB,KAAY,EACZ,WAAyB,aAAa;IAEtC,OAAO;QACL,KAAK,EAAE,iBAAiB,CAAC,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC;QAC/E,QAAQ,EAAE,KAAK,CAAC,QAAQ;KACzB,CAAC;AACJ,CAAC;AAED,iGAAiG;AACjG,MAAM,UAAU,SAAS,CAA0B,MAGlD;IACC,OAAO,mBAAmB,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;AAChG,CAAC"}

package/dist/allocate.d.ts

@@ -0,0 +1,72 @@
+import { type Money } from './money.js';
+/**
+ * Where the indivisible remainder (always fewer minor units than there are non-zero buckets for
+ * the spreading strategies) goes:
+ * - 'largest'  largest-remainder (Hamilton) method: units go to the buckets with the biggest
+ *              fractional part, ties to the earlier bucket. The default; minimises error per bucket.
+ * - 'first'    one unit each to the first buckets (with non-zero weight)
+ * - 'last'     one unit each to the last buckets
+ * - 'toFirst'  the whole remainder to the first bucket
+ * - 'toLast'   the whole remainder to the last bucket
+ */
+export type Remainder = 'largest' | 'first' | 'last' | 'toFirst' | 'toLast';
+/** Options for `allocate` and `split`: where the indivisible remainder goes. */
+export interface AllocateOptions {
+    readonly remainder?: Remainder;
+}
+/** A ratio weight: a non-negative integer, bigint or decimal string ('33.3'). */
+export type Weight = number | bigint | string;
+/**
+ * Splits `m` into parts proportional to `weights`. Exact: the parts always sum to `m`, and zero
+ * weights get zero. With 'largest' each part is less than one minor unit from its exact share; with
+ * 'first' and 'last', at most one unit. Negative amounts are allocated as the negation of the
+ * positive allocation. These properties are proved for a Lean model of this function
+ * (proofs/Ducat/Allocate.lean), and test/allocate.oracle.test.ts checks this code against that
+ * model.
+ *
+ *     allocate(money('100', 'EUR'), [1, 1, 1])        // 33.34, 33.33, 33.33
+ *     allocate(money('0.05', 'EUR'), ['70', '30'])    // 0.04, 0.01
+ */
+export declare function allocate<C extends string>(money: Money<C>, weights: readonly Weight[], options?: AllocateOptions): Money<C>[];
+/** Splits into `count` equal parts; the remainder goes per `remainder` (default 'first'). */
+export declare function split<C extends string>(money: Money<C>, count: number, options?: AllocateOptions): Money<C>[];
+/**
+ * Options for `instalments`: where the remainder goes, and an optional unit every regular
+ * instalment is a multiple of.
+ */
+export interface InstalmentOptions<C extends string> {
+    /** Where the remainder goes: default 'toFirst' (first instalment absorbs it). */
+    readonly remainder?: Exclude<Remainder, 'largest'>;
+    /** Make every regular instalment a multiple of this (e.g. money('1', 'EUR') for whole euros). */
+    readonly unit?: Money<C>;
+}
+/**
+ * Instalment plan: `count` equal payments, one of which absorbs the remainder.
+ *
+ *     instalments(money('100', 'EUR'), 3)                                   // 33.34, 33.33, 33.33
+ *     instalments(money('100', 'EUR'), 3, { remainder: 'toLast' })          // 33.33, 33.33, 33.34
+ *     instalments(money('100', 'EUR'), 3, { unit: money('1', 'EUR') })      // 34.00, 33.00, 33.00
+ */
+export declare function instalments<C extends string>(total: Money<C>, count: number, options?: InstalmentOptions<NoInfer<C>>): Money<C>[];
+/** One tranche of a `schedule`: a fixed amount, a (capped) percentage, or the rest. */
+export type Tranche<C extends string> = {
+    readonly amount: Money<C>;
+} | {
+    readonly percent: Weight;
+    readonly cap?: Money<C>;
+} | {
+    readonly rest: true;
+};
+/**
+ * A payment schedule mixing fixed amounts, percentages of the total (optionally capped) and one
+ * `rest` tranche that receives whatever is left. Percent tranches are computed together with
+ * largest-remainder allocation, so no rounding mode is needed and the schedule is exact.
+ * Throws if the tranches cannot add up to exactly `total`.
+ *
+ *     schedule(money('1000', 'EUR'), [{ percent: 30 }, { amount: money('200', 'EUR') }, { rest: true }])
+ *     // 300.00, 200.00, 500.00
+ */
+export declare function schedule<C extends string>(total: Money<C>, tranches: readonly Tranche<NoInfer<C>>[]): Money<C>[];
+/** Splits into tranches of at most `max` each: chunk(EUR 1000, EUR 300) -> 300, 300, 300, 100. */
+export declare function chunk<C extends string>(total: Money<C>, max: Money<NoInfer<C>>): Money<C>[];
+//# sourceMappingURL=allocate.d.ts.map

package/dist/allocate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"allocate.d.ts","sourceRoot":"","sources":["../src/allocate.ts"],"names":[],"mappings":"AACA,OAAO,EAQL,KAAK,KAAK,EACX,MAAM,YAAY,CAAC;AAIpB;;;;;;;;;GASG;AACH,MAAM,MAAM,SAAS,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,GAAG,QAAQ,CAAC;AAE5E,gFAAgF;AAChF,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;CAChC;AAED,iFAAiF;AACjF,MAAM,MAAM,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;AAyF9C;;;;;;;;;;GAUG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,MAAM,EACvC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EACf,OAAO,EAAE,SAAS,MAAM,EAAE,EAC1B,OAAO,CAAC,EAAE,eAAe,GACxB,KAAK,CAAC,CAAC,CAAC,EAAE,CA4FZ;AAED,6FAA6F;AAC7F,wBAAgB,KAAK,CAAC,CAAC,SAAS,MAAM,EACpC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EACf,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,eAAe,GACxB,KAAK,CAAC,CAAC,CAAC,EAAE,CAMZ;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB,CAAC,CAAC,SAAS,MAAM;IACjD,iFAAiF;IACjF,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IACnD,iGAAiG;IACjG,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;CAC1B;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,EAC1C,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EACf,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GACtC,KAAK,CAAC,CAAC,CAAC,EAAE,CA+BZ;AAED,uFAAuF;AACvF,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,MAAM,IAChC;IAAE,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAA;CAAE,GAC7B;IAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAA;CAAE,GACrD;IAAE,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAA;CAAE,CAAC;AAE5B;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,MAAM,EACvC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EACf,QAAQ,EAAE,SAAS,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,GACvC,KAAK,CAAC,CAAC,CAAC,EAAE,CAwDZ;AAED,kGAAkG;AAClG,wBAAgB,KAAK,CAAC,CAAC,SAAS,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE,CAiB3F"}

package/dist/allocate.js

@@ -0,0 +1,314 @@
+import { parseDecimal, pow10n, normalizeMinor } from './decimal.js';
+import { CurrencyMismatchError, compare, make, negate, scaleUp, subtract, toScale, } from './money.js';
+const MAX_SAFE_MINOR = Number.MAX_SAFE_INTEGER;
+function weightsToBig(ws) {
+    return weightsScaled(ws).ws;
+}
+function weightsScaled(ws) {
+    let scale = 0;
+    const parsed = ws.map((weight) => {
+        if (typeof weight === 'bigint') {
+            return { digits: weight, scale: 0 };
+        }
+        if (typeof weight === 'number' && Number.isSafeInteger(weight)) {
+            return { digits: BigInt(weight), scale: 0 };
+        }
+        const item = parseDecimal(String(weight));
+        return item;
+    });
+    for (const item of parsed) {
+        if (item.digits < 0n) {
+            throw new RangeError('Allocation weights must not be negative');
+        }
+        if (item.scale > scale) {
+            scale = item.scale;
+        }
+    }
+    return { ws: parsed.map((item) => item.digits * pow10n(scale - item.scale)), scale };
+}
+/**
+ * Distributes `rem` extra units among the buckets; `frac` are the per-bucket remainders (for
+ * 'largest').
+ */
+function distribute(shares, rem, weights, frac, mode, one) {
+    if (rem === 0) {
+        return;
+    }
+    const count = shares.length;
+    const eligible = [];
+    for (let i = 0; i < count; i++) {
+        if (weights[i] > 0) {
+            eligible.push(i);
+        }
+    }
+    const plus = (i, k) => {
+        shares[i] = (typeof one === 'number' ? shares[i] + k : shares[i] + BigInt(k));
+    };
+    switch (mode) {
+        case 'toFirst':
+            return plus(eligible[0], rem);
+        case 'toLast':
+            return plus(eligible[eligible.length - 1], rem);
+        case 'first':
+            for (let k = 0; k < rem; k++) {
+                plus(eligible[k], 1);
+            }
+            return;
+        case 'last':
+            for (let k = 0; k < rem; k++) {
+                plus(eligible[eligible.length - 1 - k], 1);
+            }
+            return;
+        case 'largest': {
+            const remainders = frac;
+            // Largest remainder first; equal remainders keep bucket order.
+            eligible.sort((left, right) => {
+                if (remainders[left] !== remainders[right]) {
+                    return remainders[left] > remainders[right] ? -1 : 1;
+                }
+                return left - right;
+            });
+            for (let k = 0; k < rem; k++) {
+                plus(eligible[k], 1);
+            }
+            return;
+        }
+    }
+    throw new RangeError(`Unknown remainder strategy "${String(mode)}"`);
+}
+/**
+ * Splits `m` into parts proportional to `weights`. Exact: the parts always sum to `m`, and zero
+ * weights get zero. With 'largest' each part is less than one minor unit from its exact share; with
+ * 'first' and 'last', at most one unit. Negative amounts are allocated as the negation of the
+ * positive allocation. These properties are proved for a Lean model of this function
+ * (proofs/Ducat/Allocate.lean), and test/allocate.oracle.test.ts checks this code against that
+ * model.
+ *
+ *     allocate(money('100', 'EUR'), [1, 1, 1])        // 33.34, 33.33, 33.33
+ *     allocate(money('0.05', 'EUR'), ['70', '30'])    // 0.04, 0.01
+ */
+export function allocate(money, weights, options) {
+    const count = weights.length;
+    if (count === 0) {
+        throw new RangeError('allocate() needs at least one weight');
+    }
+    const mode = options?.remainder ?? 'largest';
+    if (money.minor < 0) {
+        return allocate(negate(money), weights, options).map(negate);
+    }
+    const minor = money.minor;
+    // fast path: integer weights whose products with the amount fit exactly in a double
+    if (typeof minor === 'number') {
+        let total = 0;
+        let maxWeight = 0;
+        let ok = true;
+        for (let i = 0; i < count; i++) {
+            const weight = weights[i];
+            if (typeof weight !== 'number' || !(weight >= 0) || !Number.isSafeInteger(weight)) {
+                ok = false;
+                break;
+            }
+            total += weight;
+            if (weight > maxWeight) {
+                maxWeight = weight;
+            }
+        }
+        if (ok && total > 0 && total <= MAX_SAFE_MINOR && minor * maxWeight <= MAX_SAFE_MINOR - total) {
+            const ws = weights;
+            const shares = new Array(count);
+            const frac = new Array(count);
+            let rem = minor;
+            for (let i = 0; i < count; i++) {
+                const product = minor * ws[i];
+                let quotient = Math.floor(product / total);
+                let remainder = product - quotient * total;
+                if (remainder < 0) {
+                    quotient -= 1;
+                    remainder += total;
+                }
+                else if (remainder >= total) {
+                    quotient += 1;
+                    remainder -= total;
+                } // float-quotient fix-up
+                shares[i] = quotient;
+                frac[i] = remainder;
+                rem -= quotient;
+            }
+            if (rem > 0) {
+                if (mode === 'largest' && count <= 32) {
+                    // selection instead of sort: rem < number of non-zero weights, n small
+                    for (; rem > 0; rem--) {
+                        let best = -1;
+                        for (let i = 0; i < count; i++) {
+                            if (ws[i] > 0 && frac[i] >= 0 && (best < 0 || frac[i] > frac[best])) {
+                                best = i;
+                            }
+                        }
+                        shares[best] += 1;
+                        frac[best] = -1;
+                    }
+                }
+                else {
+                    distribute(shares, rem, ws, frac, mode, 1);
+                }
+            }
+            const out = new Array(count);
+            for (let i = 0; i < count; i++) {
+                out[i] = make(money.currency, shares[i], money.scale);
+            }
+            return out;
+        }
+    }
+    const ws = weightsToBig(weights);
+    let total = 0n;
+    for (const weight of ws) {
+        total += weight;
+    }
+    if (total === 0n) {
+        throw new RangeError('Allocation weights must not all be zero');
+    }
+    const xb = BigInt(minor);
+    const shares = new Array(count);
+    const frac = new Array(count);
+    let assigned = 0n;
+    for (let i = 0; i < count; i++) {
+        const product = xb * ws[i];
+        shares[i] = product / total;
+        frac[i] = product % total;
+        assigned += shares[i];
+    }
+    distribute(shares, Number(xb - assigned), ws, frac, mode, 1n);
+    return shares.map((share) => make(money.currency, share, money.scale));
+}
+/** Splits into `count` equal parts; the remainder goes per `remainder` (default 'first'). */
+export function split(money, count, options) {
+    if (!Number.isSafeInteger(count) || count < 1) {
+        throw new RangeError(`Invalid count ${count}`);
+    }
+    const weights = new Array(count).fill(1);
+    return allocate(money, weights, { remainder: options?.remainder ?? 'first' });
+}
+/**
+ * Instalment plan: `count` equal payments, one of which absorbs the remainder.
+ *
+ *     instalments(money('100', 'EUR'), 3)                                   // 33.34, 33.33, 33.33
+ *     instalments(money('100', 'EUR'), 3, { remainder: 'toLast' })          // 33.33, 33.33, 33.34
+ *     instalments(money('100', 'EUR'), 3, { unit: money('1', 'EUR') })      // 34.00, 33.00, 33.00
+ */
+export function instalments(total, count, options) {
+    if (!Number.isSafeInteger(count) || count < 1) {
+        throw new RangeError(`Invalid count ${count}`);
+    }
+    const mode = options?.remainder ?? 'toFirst';
+    const unit = options?.unit;
+    if (!unit) {
+        return allocate(total, new Array(count).fill(1), { remainder: mode });
+    }
+    if (unit.currency !== total.currency) {
+        throw new CurrencyMismatchError(total.currency, unit.currency);
+    }
+    if (!(unit.minor > 0)) {
+        throw new RangeError('unit must be positive');
+    }
+    const scale = Math.max(total.scale, unit.scale);
+    const scaledTotal = toScale(total, scale);
+    const unitMinor = BigInt(scaleUp(unit.minor, scale - unit.scale));
+    const neg = scaledTotal.minor < 0;
+    const tv = BigInt(scaledTotal.minor) * (neg ? -1n : 1n);
+    const per = (tv / (unitMinor * BigInt(count))) * unitMinor;
+    const parts = new Array(count).fill(per);
+    let left = tv - per * BigInt(count);
+    // spread whole units first (for 'first'/'last'), then the sub-unit leftover
+    if (mode === 'first' || mode === 'last') {
+        for (let k = 0; left >= unitMinor; k++, left -= unitMinor) {
+            parts[mode === 'first' ? k : count - 1 - k] += unitMinor;
+        }
+    }
+    parts[mode === 'toLast' || mode === 'last' ? count - 1 : 0] += left;
+    return parts.map((part) => make(total.currency, neg ? -part : part, scale));
+}
+/**
+ * A payment schedule mixing fixed amounts, percentages of the total (optionally capped) and one
+ * `rest` tranche that receives whatever is left. Percent tranches are computed together with
+ * largest-remainder allocation, so no rounding mode is needed and the schedule is exact.
+ * Throws if the tranches cannot add up to exactly `total`.
+ *
+ *     schedule(money('1000', 'EUR'), [{ percent: 30 }, { amount: money('200', 'EUR') }, { rest: true }])
+ *     // 300.00, 200.00, 500.00
+ */
+export function schedule(total, tranches) {
+    const pctIdx = [];
+    const pcts = [];
+    let restIdx = -1;
+    tranches.forEach((tranche, i) => {
+        if ('percent' in tranche) {
+            pctIdx.push(i);
+            pcts.push(tranche.percent);
+        }
+        else if ('rest' in tranche) {
+            if (restIdx >= 0) {
+                throw new RangeError('schedule() allows only one rest tranche');
+            }
+            restIdx = i;
+        }
+    });
+    const out = new Array(tranches.length);
+    let left = total;
+    if (pcts.length) {
+        const { ws, scale } = weightsScaled(pcts);
+        let sum = 0n;
+        for (const weight of ws) {
+            sum += weight;
+        }
+        const hundred = 100n * pow10n(scale);
+        if (sum > hundred) {
+            throw new RangeError('schedule() percentages exceed 100');
+        }
+        const parts = allocate(total, [...ws, hundred - sum].map((weight) => normalizeMinor(weight)));
+        pctIdx.forEach((trancheIndex, k) => {
+            let part = parts[k];
+            const cap = tranches[trancheIndex].cap;
+            if (cap && compare(part, cap) > 0) {
+                part = cap;
+            }
+            out[trancheIndex] = part;
+            left = subtract(left, part);
+        });
+    }
+    tranches.forEach((tranche, i) => {
+        if ('amount' in tranche) {
+            out[i] = tranche.amount;
+            left = subtract(left, tranche.amount);
+        }
+    });
+    if (left.minor < 0) {
+        throw new RangeError(`schedule() tranches exceed the total by ${negate(left)}`);
+    }
+    if (restIdx >= 0) {
+        out[restIdx] = left;
+    }
+    else if (left.minor != 0) {
+        throw new RangeError(`schedule() leaves ${left} unassigned; add { rest: true }`);
+    }
+    return out;
+}
+/** Splits into tranches of at most `max` each: chunk(EUR 1000, EUR 300) -> 300, 300, 300, 100. */
+export function chunk(total, max) {
+    if (!(max.minor > 0)) {
+        throw new RangeError('chunk() max must be positive');
+    }
+    if (total.minor < 0) {
+        throw new RangeError('chunk() total must not be negative');
+    }
+    const out = [];
+    let left = total;
+    while (compare(left, max) > 0) {
+        out.push(max);
+        left = subtract(left, max);
+    }
+    if (left.minor > 0 || out.length === 0) {
+        out.push(left);
+    }
+    return out;
+}
+//# sourceMappingURL=allocate.js.map

package/dist/allocate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"allocate.js","sourceRoot":"","sources":["../src/allocate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACpE,OAAO,EACL,qBAAqB,EACrB,OAAO,EACP,IAAI,EACJ,MAAM,EACN,OAAO,EACP,QAAQ,EACR,OAAO,GAER,MAAM,YAAY,CAAC;AAEpB,MAAM,cAAc,GAAG,MAAM,CAAC,gBAAgB,CAAC;AAsB/C,SAAS,YAAY,CAAC,EAAqB;IACzC,OAAO,aAAa,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;AAC9B,CAAC;AAED,SAAS,aAAa,CAAC,EAAqB;IAC1C,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,MAAM,MAAM,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;QAC/B,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC/B,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;QACtC,CAAC;QACD,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;YAC/D,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;QAC9C,CAAC;QACD,MAAM,IAAI,GAAG,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;IACH,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;QAC1B,IAAI,IAAI,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;YACrB,MAAM,IAAI,UAAU,CAAC,yCAAyC,CAAC,CAAC;QAClE,CAAC;QACD,IAAI,IAAI,CAAC,KAAK,GAAG,KAAK,EAAE,CAAC;YACvB,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QACrB,CAAC;IACH,CAAC;IACD,OAAO,EAAE,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC;AACvF,CAAC;AAED;;;GAGG;AACH,SAAS,UAAU,CACjB,MAAW,EACX,GAAW,EACX,OAAqC,EACrC,IAAyC,EACzC,IAAe,EACf,GAAM;IAEN,IAAI,GAAG,KAAK,CAAC,EAAE,CAAC;QACd,OAAO;IACT,CAAC;IACD,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC;IAC5B,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;QAC/B,IAAI,OAAO,CAAC,CAAC,CAAE,GAAG,CAAC,EAAE,CAAC;YACpB,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACnB,CAAC;IACH,CAAC;IACD,MAAM,IAAI,GAAG,CAAC,CAAS,EAAE,CAAS,EAAE,EAAE;QACpC,MAAM,CAAC,CAAC,CAAC,GAAG,CACV,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAE,MAAM,CAAC,CAAC,CAAY,GAAG,CAAC,CAAC,CAAC,CAAE,MAAM,CAAC,CAAC,CAAY,GAAG,MAAM,CAAC,CAAC,CAAC,CACnF,CAAC;IACT,CAAC,CAAC;IACF,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,SAAS;YACZ,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAE,EAAE,GAAG,CAAC,CAAC;QACjC,KAAK,QAAQ;YACX,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAE,EAAE,GAAG,CAAC,CAAC;QACnD,KAAK,OAAO;YACV,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC7B,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAE,EAAE,CAAC,CAAC,CAAC;YACxB,CAAC;YACD,OAAO;QACT,KAAK,MAAM;YACT,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC7B,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,GAAG,CAAC,CAAE,EAAE,CAAC,CAAC,CAAC;YAC9C,CAAC;YACD,OAAO;QACT,KAAK,SAAS,CAAC,CAAC,CAAC;YACf,MAAM,UAAU,GAAG,IAAK,CAAC;YACzB,+DAA+D;YAC/D,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;gBAC5B,IAAI,UAAU,CAAC,IAAI,CAAE,KAAK,UAAU,CAAC,KAAK,CAAE,EAAE,CAAC;oBAC7C,OAAO,UAAU,CAAC,IAAI,CAAE,GAAG,UAAU,CAAC,KAAK,CAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACzD,CAAC;gBACD,OAAO,IAAI,GAAG,KAAK,CAAC;YACtB,CAAC,CAAC,CAAC;YACH,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC7B,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAE,EAAE,CAAC,CAAC,CAAC;YACxB,CAAC;YACD,OAAO;QACT,CAAC;IACH,CAAC;IACD,MAAM,IAAI,UAAU,CAAC,+BAA+B,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACvE,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,QAAQ,CACtB,KAAe,EACf,OAA0B,EAC1B,OAAyB;IAEzB,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC;IAC7B,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;QAChB,MAAM,IAAI,UAAU,CAAC,sCAAsC,CAAC,CAAC;IAC/D,CAAC;IACD,MAAM,IAAI,GAAG,OAAO,EAAE,SAAS,IAAI,SAAS,CAAC;IAC7C,IAAI,KAAK,CAAC,KAAK,GAAG,CAAC,EAAE,CAAC;QACpB,OAAO,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC/D,CAAC;IACD,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;IAE1B,oFAAoF;IACpF,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,IAAI,SAAS,GAAG,CAAC,CAAC;QAClB,IAAI,EAAE,GAAG,IAAI,CAAC;QACd,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;YAC/B,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;YAC1B,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;gBAClF,EAAE,GAAG,KAAK,CAAC;gBACX,MAAM;YACR,CAAC;YACD,KAAK,IAAI,MAAM,CAAC;YAChB,IAAI,MAAM,GAAG,SAAS,EAAE,CAAC;gBACvB,SAAS,GAAG,MAAM,CAAC;YACrB,CAAC;QACH,CAAC;QACD,IAAI,EAAE,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,IAAI,cAAc,IAAI,KAAK,GAAG,SAAS,IAAI,cAAc,GAAG,KAAK,EAAE,CAAC;YAC9F,MAAM,EAAE,GAAG,OAA4B,CAAC;YACxC,MAAM,MAAM,GAAG,IAAI,KAAK,CAAS,KAAK,CAAC,CAAC;YACxC,MAAM,IAAI,GAAG,IAAI,KAAK,CAAS,KAAK,CAAC,CAAC;YACtC,IAAI,GAAG,GAAG,KAAK,CAAC;YAChB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC/B,MAAM,OAAO,GAAG,KAAK,GAAG,EAAE,CAAC,CAAC,CAAE,CAAC;gBAC/B,IAAI,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC,CAAC;gBAC3C,IAAI,SAAS,GAAG,OAAO,GAAG,QAAQ,GAAG,KAAK,CAAC;gBAC3C,IAAI,SAAS,GAAG,CAAC,EAAE,CAAC;oBAClB,QAAQ,IAAI,CAAC,CAAC;oBACd,SAAS,IAAI,KAAK,CAAC;gBACrB,CAAC;qBAAM,IAAI,SAAS,IAAI,KAAK,EAAE,CAAC;oBAC9B,QAAQ,IAAI,CAAC,CAAC;oBACd,SAAS,IAAI,KAAK,CAAC;gBACrB,CAAC,CAAC,wBAAwB;gBAC1B,MAAM,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC;gBACrB,IAAI,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;gBACpB,GAAG,IAAI,QAAQ,CAAC;YAClB,CAAC;YACD,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC;gBACZ,IAAI,IAAI,KAAK,SAAS,IAAI,KAAK,IAAI,EAAE,EAAE,CAAC;oBACtC,uEAAuE;oBACvE,OAAO,GAAG,GAAG,CAAC,EAAE,GAAG,EAAE,EAAE,CAAC;wBACtB,IAAI,IAAI,GAAG,CAAC,CAAC,CAAC;wBACd,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;4BAC/B,IAAI,EAAE,CAAC,CAAC,CAAE,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,CAAE,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,CAAE,GAAG,IAAI,CAAC,IAAI,CAAE,CAAC,EAAE,CAAC;gCACxE,IAAI,GAAG,CAAC,CAAC;4BACX,CAAC;wBACH,CAAC;wBACD,MAAM,CAAC,IAAI,CAAE,IAAI,CAAC,CAAC;wBACnB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;oBAClB,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,UAAU,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;gBAC7C,CAAC;YACH,CAAC;YACD,MAAM,GAAG,GAAG,IAAI,KAAK,CAAW,KAAK,CAAC,CAAC;YACvC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC/B,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAE,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;YACzD,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC;IACH,CAAC;IAED,MAAM,EAAE,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IACjC,IAAI,KAAK,GAAG,EAAE,CAAC;IACf,KAAK,MAAM,MAAM,IAAI,EAAE,EAAE,CAAC;QACxB,KAAK,IAAI,MAAM,CAAC;IAClB,CAAC;IACD,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;QACjB,MAAM,IAAI,UAAU,CAAC,yCAAyC,CAAC,CAAC;IAClE,CAAC;IACD,MAAM,EAAE,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IACzB,MAAM,MAAM,GAAa,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC;IAC1C,MAAM,IAAI,GAAa,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC;IACxC,IAAI,QAAQ,GAAG,EAAE,CAAC;IAClB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;QAC/B,MAAM,OAAO,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,CAAE,CAAC;QAC5B,MAAM,CAAC,CAAC,CAAC,GAAG,OAAO,GAAG,KAAK,CAAC;QAC5B,IAAI,CAAC,CAAC,CAAC,GAAG,OAAO,GAAG,KAAK,CAAC;QAC1B,QAAQ,IAAI,MAAM,CAAC,CAAC,CAAE,CAAC;IACzB,CAAC;IACD,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,QAAQ,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;IAC9D,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;AACzE,CAAC;AAED,6FAA6F;AAC7F,MAAM,UAAU,KAAK,CACnB,KAAe,EACf,KAAa,EACb,OAAyB;IAEzB,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;QAC9C,MAAM,IAAI,UAAU,CAAC,iBAAiB,KAAK,EAAE,CAAC,CAAC;IACjD,CAAC;IACD,MAAM,OAAO,GAAG,IAAI,KAAK,CAAS,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACjD,OAAO,QAAQ,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,OAAO,EAAE,CAAC,CAAC;AAChF,CAAC;AAaD;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CACzB,KAAe,EACf,KAAa,EACb,OAAuC;IAEvC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;QAC9C,MAAM,IAAI,UAAU,CAAC,iBAAiB,KAAK,EAAE,CAAC,CAAC;IACjD,CAAC;IACD,MAAM,IAAI,GAAG,OAAO,EAAE,SAAS,IAAI,SAAS,CAAC;IAC7C,MAAM,IAAI,GAAG,OAAO,EAAE,IAAI,CAAC;IAC3B,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,QAAQ,CAAC,KAAK,EAAE,IAAI,KAAK,CAAS,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAChF,CAAC;IACD,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,EAAE,CAAC;QACrC,MAAM,IAAI,qBAAqB,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IACjE,CAAC;IACD,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,UAAU,CAAC,uBAAuB,CAAC,CAAC;IAChD,CAAC;IACD,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;IAChD,MAAM,WAAW,GAAG,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAC1C,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAClE,MAAM,GAAG,GAAG,WAAW,CAAC,KAAK,GAAG,CAAC,CAAC;IAClC,MAAM,EAAE,GAAG,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IACxD,MAAM,GAAG,GAAG,CAAC,EAAE,GAAG,CAAC,SAAS,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;IAC3D,MAAM,KAAK,GAAG,IAAI,KAAK,CAAS,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACjD,IAAI,IAAI,GAAG,EAAE,GAAG,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IACpC,4EAA4E;IAC5E,IAAI,IAAI,KAAK,OAAO,IAAI,IAAI,KAAK,MAAM,EAAE,CAAC;QACxC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,IAAI,SAAS,EAAE,CAAC,EAAE,EAAE,IAAI,IAAI,SAAS,EAAE,CAAC;YAC1D,KAAK,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,GAAG,CAAC,CAAE,IAAI,SAAS,CAAC;QAC5D,CAAC;IACH,CAAC;IACD,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,IAAI,IAAI,CAAC;IACrE,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;AAC9E,CAAC;AAQD;;;;;;;;GAQG;AACH,MAAM,UAAU,QAAQ,CACtB,KAAe,EACf,QAAwC;IAExC,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,IAAI,GAAa,EAAE,CAAC;IAC1B,IAAI,OAAO,GAAG,CAAC,CAAC,CAAC;IACjB,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,CAAC,EAAE,EAAE;QAC9B,IAAI,SAAS,IAAI,OAAO,EAAE,CAAC;YACzB,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACf,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC7B,CAAC;aAAM,IAAI,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,IAAI,OAAO,IAAI,CAAC,EAAE,CAAC;gBACjB,MAAM,IAAI,UAAU,CAAC,yCAAyC,CAAC,CAAC;YAClE,CAAC;YACD,OAAO,GAAG,CAAC,CAAC;QACd,CAAC;IACH,CAAC,CAAC,CAAC;IACH,MAAM,GAAG,GAA6B,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IACjE,IAAI,IAAI,GAAG,KAAK,CAAC;IACjB,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QAChB,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,GAAG,GAAG,EAAE,CAAC;QACb,KAAK,MAAM,MAAM,IAAI,EAAE,EAAE,CAAC;YACxB,GAAG,IAAI,MAAM,CAAC;QAChB,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;QACrC,IAAI,GAAG,GAAG,OAAO,EAAE,CAAC;YAClB,MAAM,IAAI,UAAU,CAAC,mCAAmC,CAAC,CAAC;QAC5D,CAAC;QACD,MAAM,KAAK,GAAG,QAAQ,CACpB,KAAK,EACL,CAAC,GAAG,EAAE,EAAE,OAAO,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAC/D,CAAC;QACF,MAAM,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,CAAC,EAAE,EAAE;YACjC,IAAI,IAAI,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC;YACrB,MAAM,GAAG,GAAI,QAAQ,CAAC,YAAY,CAAwB,CAAC,GAAG,CAAC;YAC/D,IAAI,GAAG,IAAI,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBAClC,IAAI,GAAG,GAAG,CAAC;YACb,CAAC;YACD,GAAG,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;YACzB,IAAI,GAAG,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC;IACD,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,CAAC,EAAE,EAAE;QAC9B,IAAI,QAAQ,IAAI,OAAO,EAAE,CAAC;YACxB,GAAG,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;YACxB,IAAI,GAAG,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QACxC,CAAC;IACH,CAAC,CAAC,CAAC;IACH,IAAI,IAAI,CAAC,KAAK,GAAG,CAAC,EAAE,CAAC;QACnB,MAAM,IAAI,UAAU,CAAC,2CAA2C,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAClF,CAAC;IACD,IAAI,OAAO,IAAI,CAAC,EAAE,CAAC;QACjB,GAAG,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;IACtB,CAAC;SAAM,IAAI,IAAI,CAAC,KAAK,IAAI,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,UAAU,CAAC,qBAAqB,IAAI,iCAAiC,CAAC,CAAC;IACnF,CAAC;IACD,OAAO,GAAiB,CAAC;AAC3B,CAAC;AAED,kGAAkG;AAClG,MAAM,UAAU,KAAK,CAAmB,KAAe,EAAE,GAAsB;IAC7E,IAAI,CAAC,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC;QACrB,MAAM,IAAI,UAAU,CAAC,8BAA8B,CAAC,CAAC;IACvD,CAAC;IACD,IAAI,KAAK,CAAC,KAAK,GAAG,CAAC,EAAE,CAAC;QACpB,MAAM,IAAI,UAAU,CAAC,oCAAoC,CAAC,CAAC;IAC7D,CAAC;IACD,MAAM,GAAG,GAAe,EAAE,CAAC;IAC3B,IAAI,IAAI,GAAG,KAAK,CAAC;IACjB,OAAO,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;QAC9B,GAAG,CAAC,IAAI,CAAC,GAAe,CAAC,CAAC;QAC1B,IAAI,GAAG,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAC7B,CAAC;IACD,IAAI,IAAI,CAAC,KAAK,GAAG,CAAC,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/bag.d.ts

@@ -0,0 +1,58 @@
+import { type ExactMoney } from './exact.js';
+import { type Money } from './money.js';
+import { type RateProvider } from './provider.js';
+import type { RoundingMode } from './rounding.js';
+/** Options for MoneyBag#total. */
+export interface TotalOptions {
+    readonly asOf?: string | Date;
+    /** Result scale (default: the target currency's exponent). */
+    readonly scale?: number;
+}
+/** Per-currency totals of `items`, in first-seen order. */
+export declare function sumByCurrency(items: Iterable<Money>): Map<string, Money>;
+/** An immutable set of per-currency totals: `bag(eur10, usd5, eur2).get('EUR')` is EUR 12. */
+export declare class MoneyBag {
+    #private;
+    /** @internal use bag() */
+    constructor(totals: ReadonlyMap<string, Money>);
+    /** A new bag with `items` added. */
+    add(...items: Money[]): MoneyBag;
+    /** The total in `currency`, or undefined when the bag has none. */
+    get<C extends string>(currency: C): Money<C> | undefined;
+    /** The currencies held, in first-seen order. */
+    currencies(): string[];
+    /** The per-currency totals, in first-seen order. */
+    values(): Money[];
+    /** Every entry converted exactly into `to` and summed. Nothing is rounded. */
+    exactTotal<To extends string>(to: To, provider: RateProvider, options?: Pick<TotalOptions, 'asOf'>): ExactMoney<To>;
+    /** The total in `to`, rounded once: `bag.total('EUR', fx, 'halfEven')`. */
+    total<To extends string>(to: To, provider: RateProvider, rounding: RoundingMode, options?: TotalOptions): Money<To>;
+    /** The totals as a list of Money JSON values. */
+    toJSON(): unknown[];
+}
+/** A bag of the per-currency totals of `items`. */
+export declare function bag(...items: Money[]): MoneyBag;
+/** Options for comparator(). */
+export interface ComparatorOptions {
+    /** Every amount is compared as its exact value in this currency. */
+    readonly base: string;
+    readonly asOf?: string | Date;
+}
+/**
+ * Compares amounts in any currencies through one base currency, exactly (no rounding, so rounding
+ * makes no ties). One rate per currency makes it a total preorder, so `list.sort(comparator(fx, {
+ * base: 'USD' }))` is consistent. Pairwise conversion with bid/ask or slightly inconsistent mids is
+ * not, and Array#sort's result then differs between engines. Rates are looked up once per currency,
+ * lazily: a missing rate throws from inside `sort`, after the list may already be partly reordered.
+ * `sortByValue` looks every rate up first.
+ */
+export declare function comparator(provider: RateProvider, options: ComparatorOptions): (money: Money, other: Money) => -1 | 0 | 1;
+/**
+ * A new array of `items` in ascending order of their value in `options.base`, as `comparator`
+ * orders them. Every amount is converted before sorting, so a missing rate throws
+ * RateUnavailableError before anything is reordered, and each amount is converted only once.
+ *
+ *     sortByValue([jpy100, gbp1, usd1], fx, { base: 'EUR' })   // [jpy100, usd1, gbp1]
+ */
+export declare function sortByValue<Item extends Money>(items: Iterable<Item>, provider: RateProvider, options: ComparatorOptions): Item[];
+//# sourceMappingURL=bag.d.ts.map

package/dist/bag.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bag.d.ts","sourceRoot":"","sources":["../src/bag.ts"],"names":[],"mappings":"AAGA,OAAO,EAAmB,KAAK,UAAU,EAAE,MAAM,YAAY,CAAC;AAC9D,OAAO,EAAO,KAAK,KAAK,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAU,KAAK,YAAY,EAAkB,MAAM,eAAe,CAAC;AAE1E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAElD,kCAAkC;AAClC,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,8DAA8D;IAC9D,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;CACzB;AASD,2DAA2D;AAC3D,wBAAgB,aAAa,CAAC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,CAWxE;AAED,8FAA8F;AAC9F,qBAAa,QAAQ;;IAGnB,0BAA0B;gBACd,MAAM,EAAE,WAAW,CAAC,MAAM,EAAE,KAAK,CAAC;IAK9C,oCAAoC;IACpC,GAAG,CAAC,GAAG,KAAK,EAAE,KAAK,EAAE,GAAG,QAAQ;IAIhC,mEAAmE;IACnE,GAAG,CAAC,CAAC,SAAS,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,SAAS;IAIxD,gDAAgD;IAChD,UAAU,IAAI,MAAM,EAAE;IAItB,oDAAoD;IACpD,MAAM,IAAI,KAAK,EAAE;IAIjB,8EAA8E;IAC9E,UAAU,CAAC,EAAE,SAAS,MAAM,EAC1B,EAAE,EAAE,EAAE,EACN,QAAQ,EAAE,YAAY,EACtB,OAAO,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,GACnC,UAAU,CAAC,EAAE,CAAC;IAcjB,2EAA2E;IAC3E,KAAK,CAAC,EAAE,SAAS,MAAM,EACrB,EAAE,EAAE,EAAE,EACN,QAAQ,EAAE,YAAY,EACtB,QAAQ,EAAE,YAAY,EACtB,OAAO,CAAC,EAAE,YAAY,GACrB,KAAK,CAAC,EAAE,CAAC;IAIZ,iDAAiD;IACjD,MAAM,IAAI,OAAO,EAAE;CAGpB;AAED,mDAAmD;AACnD,wBAAgB,GAAG,CAAC,GAAG,KAAK,EAAE,KAAK,EAAE,GAAG,QAAQ,CAE/C;AAED,gCAAgC;AAChC,MAAM,WAAW,iBAAiB;IAChC,oEAAoE;IACpE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAwBD;;;;;;;GAOG;AACH,wBAAgB,UAAU,CACxB,QAAQ,EAAE,YAAY,EACtB,OAAO,EAAE,iBAAiB,GACzB,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,KAAK,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAG5C;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,IAAI,SAAS,KAAK,EAC5C,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,EACrB,QAAQ,EAAE,YAAY,EACtB,OAAO,EAAE,iBAAiB,GACzB,IAAI,EAAE,CAMR"}