@ducatjs/money 0.0.0 → 0.2.0

package/dist/bag.js

@@ -0,0 +1,122 @@
+// Mixed-currency amounts: a bag of per-currency totals, converted and rounded once when a single
+// total is needed, and a cross-currency comparator through one base currency (a total preorder, so
+// sorting is well defined).
+import { exact, sumExact } from './exact.js';
+import { add } from './money.js';
+import { rateOf } from './provider.js';
+function queryFor(asOf) {
+    if (asOf === undefined) {
+        return undefined;
+    }
+    return { asOf };
+}
+/** Per-currency totals of `items`, in first-seen order. */
+export function sumByCurrency(items) {
+    const totals = new Map();
+    for (const money of items) {
+        const previous = totals.get(money.currency);
+        if (previous === undefined) {
+            totals.set(money.currency, money);
+        }
+        else {
+            totals.set(money.currency, add(previous, money));
+        }
+    }
+    return totals;
+}
+/** An immutable set of per-currency totals: `bag(eur10, usd5, eur2).get('EUR')` is EUR 12. */
+export class MoneyBag {
+    #totals;
+    /** @internal use bag() */
+    constructor(totals) {
+        // Copied, so a caller who keeps the Map can't change an immutable bag.
+        this.#totals = new Map(totals);
+    }
+    /** A new bag with `items` added. */
+    add(...items) {
+        return new MoneyBag(sumByCurrency([...this.#totals.values(), ...items]));
+    }
+    /** The total in `currency`, or undefined when the bag has none. */
+    get(currency) {
+        return this.#totals.get(currency);
+    }
+    /** The currencies held, in first-seen order. */
+    currencies() {
+        return [...this.#totals.keys()];
+    }
+    /** The per-currency totals, in first-seen order. */
+    values() {
+        return [...this.#totals.values()];
+    }
+    /** Every entry converted exactly into `to` and summed. Nothing is rounded. */
+    exactTotal(to, provider, options) {
+        const query = queryFor(options?.asOf);
+        const parts = [];
+        for (const money of this.#totals.values()) {
+            if (money.currency === to) {
+                parts.push(exact(money));
+            }
+            else {
+                const rate = rateOf(provider, money.currency, to, query);
+                parts.push(exact(money).convert(rate));
+            }
+        }
+        return sumExact(parts, to);
+    }
+    /** The total in `to`, rounded once: `bag.total('EUR', fx, 'halfEven')`. */
+    total(to, provider, rounding, options) {
+        return this.exactTotal(to, provider, options).round(rounding, options?.scale);
+    }
+    /** The totals as a list of Money JSON values. */
+    toJSON() {
+        return this.values().map((money) => money.toJSON());
+    }
+}
+/** A bag of the per-currency totals of `items`. */
+export function bag(...items) {
+    return new MoneyBag(sumByCurrency(items));
+}
+/** Converts amounts exactly into `options.base`, looking each currency's rate up once. */
+function baseConverter(provider, options) {
+    const base = options.base;
+    const query = queryFor(options.asOf);
+    const ratesToBase = new Map();
+    return (money) => {
+        if (money.currency === base) {
+            return exact(money);
+        }
+        let rate = ratesToBase.get(money.currency);
+        if (rate === undefined) {
+            rate = rateOf(provider, money.currency, base, query);
+            ratesToBase.set(money.currency, rate);
+        }
+        return exact(money).convert(rate);
+    };
+}
+/**
+ * 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 function comparator(provider, options) {
+    const inBase = baseConverter(provider, options);
+    return (money, other) => inBase(money).compare(inBase(other));
+}
+/**
+ * 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 function sortByValue(items, provider, options) {
+    const inBase = baseConverter(provider, options);
+    const keyed = Array.from(items, (item) => ({ item, value: inBase(item) }));
+    // Array#sort is stable, so equal values keep their input order.
+    keyed.sort((first, second) => first.value.compare(second.value));
+    return keyed.map((entry) => entry.item);
+}
+//# sourceMappingURL=bag.js.map

package/dist/bag.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bag.js","sourceRoot":"","sources":["../src/bag.ts"],"names":[],"mappings":"AAAA,iGAAiG;AACjG,mGAAmG;AACnG,4BAA4B;AAC5B,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAmB,MAAM,YAAY,CAAC;AAC9D,OAAO,EAAE,GAAG,EAAc,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,MAAM,EAAqC,MAAM,eAAe,CAAC;AAW1E,SAAS,QAAQ,CAAC,IAA+B;IAC/C,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,CAAC;AAClB,CAAC;AAED,2DAA2D;AAC3D,MAAM,UAAU,aAAa,CAAC,KAAsB;IAClD,MAAM,MAAM,GAAG,IAAI,GAAG,EAAiB,CAAC;IACxC,KAAK,MAAM,KAAK,IAAI,KAAK,EAAE,CAAC;QAC1B,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC5C,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QACpC,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,8FAA8F;AAC9F,MAAM,OAAO,QAAQ;IACV,OAAO,CAA6B;IAE7C,0BAA0B;IAC1B,YAAY,MAAkC;QAC5C,uEAAuE;QACvE,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAED,oCAAoC;IACpC,GAAG,CAAC,GAAG,KAAc;QACnB,OAAO,IAAI,QAAQ,CAAC,aAAa,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAC3E,CAAC;IAED,mEAAmE;IACnE,GAAG,CAAmB,QAAW;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAyB,CAAC;IAC5D,CAAC;IAED,gDAAgD;IAChD,UAAU;QACR,OAAO,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IAClC,CAAC;IAED,oDAAoD;IACpD,MAAM;QACJ,OAAO,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IACpC,CAAC;IAED,8EAA8E;IAC9E,UAAU,CACR,EAAM,EACN,QAAsB,EACtB,OAAoC;QAEpC,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACtC,MAAM,KAAK,GAAqB,EAAE,CAAC;QACnC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;YAC1C,IAAI,KAAK,CAAC,QAAQ,KAAK,EAAE,EAAE,CAAC;gBAC1B,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAkB,CAAC,CAAC,CAAC;YACxC,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;gBACzD,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;YACzC,CAAC;QACH,CAAC;QACD,OAAO,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAC7B,CAAC;IAED,2EAA2E;IAC3E,KAAK,CACH,EAAM,EACN,QAAsB,EACtB,QAAsB,EACtB,OAAsB;QAEtB,OAAO,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;IAChF,CAAC;IAED,iDAAiD;IACjD,MAAM;QACJ,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;IACtD,CAAC;CACF;AAED,mDAAmD;AACnD,MAAM,UAAU,GAAG,CAAC,GAAG,KAAc;IACnC,OAAO,IAAI,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;AAC5C,CAAC;AASD,0FAA0F;AAC1F,SAAS,aAAa,CACpB,QAAsB,EACtB,OAA0B;IAE1B,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAC1B,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACrC,MAAM,WAAW,GAAG,IAAI,GAAG,EAAgB,CAAC;IAE5C,OAAO,CAAC,KAAK,EAAE,EAAE;QACf,IAAI,KAAK,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;YAC5B,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC;QACtB,CAAC;QACD,IAAI,IAAI,GAAG,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC3C,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,IAAI,GAAG,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;YACrD,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACxC,CAAC;QACD,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,UAAU,CACxB,QAAsB,EACtB,OAA0B;IAE1B,MAAM,MAAM,GAAG,aAAa,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAChD,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;AAChE,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CACzB,KAAqB,EACrB,QAAsB,EACtB,OAA0B;IAE1B,MAAM,MAAM,GAAG,aAAa,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAChD,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3E,gEAAgE;IAChE,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACjE,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AAC1C,CAAC"}

package/dist/boc.d.ts

@@ -0,0 +1,31 @@
+import type { RateTable } from './provider.js';
+/** Options for parseBankOfCanadaJson. */
+export interface BankOfCanadaOptions {
+    /**
+     * When each day's rates were published, or false for none. Default: 16:30 Toronto time that day,
+     * when the Bank says it publishes them.
+     */
+    readonly availableAt?: false | ((day: string) => string | Date);
+}
+/**
+ * Parses the Bank of Canada's daily exchange rates from the Valet API's JSON (the
+ * `FX_RATES_DAILY` group, or single `FX…CAD` series) into one CAD-based table per business day,
+ * newest first. The Bank quotes CAD per unit of each currency (FXUSDCAD 1.3748), so each table
+ * holds the exact inverse, CAD → currency, and keeps the published quote: `rate.inverse()` prints
+ * '1.3748' again. Rates have `source: 'BoC'`, `type: 'average'` (an average of a day's quotes, not
+ * a market rate) and `availableAt` 16:30 Toronto time, when the Bank says it publishes them (a late
+ * rate can come later; pass `availableAt` to change it). Valet leaves a series out of a day
+ * without a value, so a series listed in `seriesDetail` but absent on a day, an empty value or a
+ * null one, is in that day's `missing`. Anything but daily `FX…CAD` series (monthly or annual
+ * groups, other data) throws SyntaxError, as do two different values for one series on one day.
+ *
+ * Precision: the Bank quotes four decimals, up to six for small rates, so a small rate has only
+ * about four significant digits (JPY 0.008760, KRW 0.000929, and IDR 0.000082 with two). Its
+ * inverse is exact, but only as precise as that. For such currencies, prefer a source that quotes
+ * them the other way round.
+ *
+ *     const tables = parseBankOfCanadaJson(await (await fetch(url)).text());
+ *     tables[0].rate('CAD', 'USD')?.inverse().toString(); // '1.3748'
+ */
+export declare function parseBankOfCanadaJson(json: string, options?: BankOfCanadaOptions): RateTable[];
+//# sourceMappingURL=boc.d.ts.map

package/dist/boc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"boc.d.ts","sourceRoot":"","sources":["../src/boc.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AA+B/C,yCAAyC;AACzC,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,KAAK,GAAG,CAAC,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,GAAG,IAAI,CAAC,CAAC;CACjE;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,SAAS,EAAE,CAuE9F"}

package/dist/boc.js

@@ -0,0 +1,114 @@
+// `@ducatjs/money/convert/boc`: an offline parser for the Bank of Canada's daily exchange rates
+// (the Valet API). No I/O: fetch the JSON yourself, or use fetchBankOfCanada from
+// @ducatjs/money/convert/fetch. Rates are kept exactly as published.
+import { quotedTable } from './history.js';
+import { addDayRate, isCalendarDay, newestFirst, readRateCell } from './rate-text.js';
+const SERIES = /^FX([A-Z]{3})CAD$/;
+const ZERO = /^0+(?:\.0+)?$/;
+// The Bank publishes "once each business day by 16:30 (ET)". One formatter for the zone, built on
+// first use, gives the Toronto offset on any day, summer time included.
+let torontoFormatter;
+/** 16:30 in Toronto on `day`, as a UTC instant. */
+function publishedBy(day) {
+    torontoFormatter ??= new Intl.DateTimeFormat('en-US', {
+        timeZone: 'America/Toronto',
+        timeZoneName: 'shortOffset',
+    });
+    // Noon UTC is 07:00 or 08:00 in Toronto, after any clock change that day (they happen at 02:00).
+    const noon = new Date(`${day}T12:00:00Z`);
+    const zone = torontoFormatter.formatToParts(noon).find((part) => part.type === 'timeZoneName');
+    const offset = /^GMT([+-]\d+)$/.exec(zone?.value ?? '');
+    if (offset === null) {
+        throw new RangeError(`Can't tell Toronto's UTC offset on ${day} (${zone?.value})`);
+    }
+    const utcMs = Date.parse(`${day}T16:30:00Z`) - Number(offset[1]) * 3_600_000;
+    return new Date(utcMs).toISOString();
+}
+function notValet(why) {
+    throw new SyntaxError(`Not a Bank of Canada Valet daily FX file: ${why}`);
+}
+/**
+ * Parses the Bank of Canada's daily exchange rates from the Valet API's JSON (the
+ * `FX_RATES_DAILY` group, or single `FX…CAD` series) into one CAD-based table per business day,
+ * newest first. The Bank quotes CAD per unit of each currency (FXUSDCAD 1.3748), so each table
+ * holds the exact inverse, CAD → currency, and keeps the published quote: `rate.inverse()` prints
+ * '1.3748' again. Rates have `source: 'BoC'`, `type: 'average'` (an average of a day's quotes, not
+ * a market rate) and `availableAt` 16:30 Toronto time, when the Bank says it publishes them (a late
+ * rate can come later; pass `availableAt` to change it). Valet leaves a series out of a day
+ * without a value, so a series listed in `seriesDetail` but absent on a day, an empty value or a
+ * null one, is in that day's `missing`. Anything but daily `FX…CAD` series (monthly or annual
+ * groups, other data) throws SyntaxError, as do two different values for one series on one day.
+ *
+ * Precision: the Bank quotes four decimals, up to six for small rates, so a small rate has only
+ * about four significant digits (JPY 0.008760, KRW 0.000929, and IDR 0.000082 with two). Its
+ * inverse is exact, but only as precise as that. For such currencies, prefer a source that quotes
+ * them the other way round.
+ *
+ *     const tables = parseBankOfCanadaJson(await (await fetch(url)).text());
+ *     tables[0].rate('CAD', 'USD')?.inverse().toString(); // '1.3748'
+ */
+export function parseBankOfCanadaJson(json, options) {
+    const parsed = JSON.parse(json);
+    const observations = parsed?.observations;
+    if (!Array.isArray(observations)) {
+        notValet('no observations');
+    }
+    // The series the file says it has; each must be a daily FX…CAD series.
+    const expected = new Set();
+    for (const series of Object.keys(parsed?.seriesDetail ?? {})) {
+        if (!SERIES.test(series)) {
+            notValet(`series ${series} isn't a daily FX…CAD rate`);
+        }
+        expected.add(series);
+    }
+    const days = new Map();
+    for (const observation of observations) {
+        const day = observation?.['d'];
+        if (typeof day !== 'string' || !isCalendarDay(day)) {
+            notValet(`bad date ${JSON.stringify(day)}`);
+        }
+        for (const [series, cell] of Object.entries(observation)) {
+            if (series === 'd') {
+                continue;
+            }
+            const currency = SERIES.exec(series)?.[1];
+            if (currency === undefined) {
+                notValet(`series ${series} isn't a daily FX…CAD rate`);
+            }
+            const where = `${series} on ${day}`;
+            const value = cell?.v;
+            if (value !== null && typeof value !== 'string') {
+                throw new SyntaxError(`Malformed Valet value for ${where}`);
+            }
+            const rate = value === null ? null : readRateCell(value, where);
+            if (rate !== null && ZERO.test(rate)) {
+                throw new SyntaxError(`A zero rate for ${where}`);
+            }
+            addDayRate(days, day, currency, rate);
+        }
+        // Valet leaves out a series without a value that day.
+        for (const series of expected) {
+            const currency = SERIES.exec(series)[1];
+            if (days.get(day)?.[currency] === undefined) {
+                addDayRate(days, day, currency, null);
+            }
+        }
+    }
+    const tables = [];
+    for (const [day, rates] of days) {
+        if (!Object.values(rates).some((rate) => rate !== null)) {
+            continue;
+        }
+        let availableAt;
+        if (options?.availableAt === undefined) {
+            availableAt = publishedBy(day);
+        }
+        else if (options.availableAt !== false) {
+            availableAt = options.availableAt(day);
+        }
+        const info = { base: 'CAD', inverted: true, source: 'BoC', type: 'average', asOf: day };
+        tables.push(quotedTable({ ...info, ...(availableAt === undefined ? {} : { availableAt }), rates }));
+    }
+    return newestFirst(tables);
+}
+//# sourceMappingURL=boc.js.map

package/dist/boc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"boc.js","sourceRoot":"","sources":["../src/boc.ts"],"names":[],"mappings":"AAAA,gGAAgG;AAChG,kFAAkF;AAClF,qEAAqE;AACrE,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAE3C,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEtF,MAAM,MAAM,GAAG,mBAAmB,CAAC;AACnC,MAAM,IAAI,GAAG,eAAe,CAAC;AAE7B,kGAAkG;AAClG,wEAAwE;AACxE,IAAI,gBAAiD,CAAC;AAEtD,mDAAmD;AACnD,SAAS,WAAW,CAAC,GAAW;IAC9B,gBAAgB,KAAK,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE;QACpD,QAAQ,EAAE,iBAAiB;QAC3B,YAAY,EAAE,aAAa;KAC5B,CAAC,CAAC;IACH,iGAAiG;IACjG,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,GAAG,GAAG,YAAY,CAAC,CAAC;IAC1C,MAAM,IAAI,GAAG,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,CAAC;IAC/F,MAAM,MAAM,GAAG,gBAAgB,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC;IACxD,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QACpB,MAAM,IAAI,UAAU,CAAC,sCAAsC,GAAG,KAAK,IAAI,EAAE,KAAK,GAAG,CAAC,CAAC;IACrF,CAAC;IACD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,YAAY,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;IAC7E,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;AACvC,CAAC;AAED,SAAS,QAAQ,CAAC,GAAW;IAC3B,MAAM,IAAI,WAAW,CAAC,6CAA6C,GAAG,EAAE,CAAC,CAAC;AAC5E,CAAC;AAWD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,qBAAqB,CAAC,IAAY,EAAE,OAA6B;IAC/E,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAGtB,CAAC;IACT,MAAM,YAAY,GAAG,MAAM,EAAE,YAAY,CAAC;IAC1C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;QACjC,QAAQ,CAAC,iBAAiB,CAAC,CAAC;IAC9B,CAAC;IAED,uEAAuE;IACvE,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;IACnC,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,IAAI,EAAE,CAAC,EAAE,CAAC;QAC7D,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YACzB,QAAQ,CAAC,UAAU,MAAM,4BAA4B,CAAC,CAAC;QACzD,CAAC;QACD,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACvB,CAAC;IAED,MAAM,IAAI,GAAG,IAAI,GAAG,EAAyC,CAAC;IAC9D,KAAK,MAAM,WAAW,IAAI,YAAkD,EAAE,CAAC;QAC7E,MAAM,GAAG,GAAG,WAAW,EAAE,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;YACnD,QAAQ,CAAC,YAAY,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC9C,CAAC;QAED,KAAK,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;YACzD,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;gBACnB,SAAS;YACX,CAAC;YACD,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YAC1C,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;gBAC3B,QAAQ,CAAC,UAAU,MAAM,4BAA4B,CAAC,CAAC;YACzD,CAAC;YACD,MAAM,KAAK,GAAG,GAAG,MAAM,OAAO,GAAG,EAAE,CAAC;YACpC,MAAM,KAAK,GAAI,IAA+B,EAAE,CAAC,CAAC;YAClD,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAChD,MAAM,IAAI,WAAW,CAAC,6BAA6B,KAAK,EAAE,CAAC,CAAC;YAC9D,CAAC;YACD,MAAM,IAAI,GAAG,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;YAChE,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBACrC,MAAM,IAAI,WAAW,CAAC,mBAAmB,KAAK,EAAE,CAAC,CAAC;YACpD,CAAC;YACD,UAAU,CAAC,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;QACxC,CAAC;QACD,sDAAsD;QACtD,KAAK,MAAM,MAAM,IAAI,QAAQ,EAAE,CAAC;YAC9B,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAE,CAAC,CAAC,CAAE,CAAC;YAC1C,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,QAAQ,CAAC,KAAK,SAAS,EAAE,CAAC;gBAC5C,UAAU,CAAC,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;YACxC,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,MAAM,GAAgB,EAAE,CAAC;IAC/B,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC;QAChC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;YACxD,SAAS;QACX,CAAC;QACD,IAAI,WAAsC,CAAC;QAC3C,IAAI,OAAO,EAAE,WAAW,KAAK,SAAS,EAAE,CAAC;YACvC,WAAW,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;QACjC,CAAC;aAAM,IAAI,OAAO,CAAC,WAAW,KAAK,KAAK,EAAE,CAAC;YACzC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACzC,CAAC;QACD,MAAM,IAAI,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;QACxF,MAAM,CAAC,IAAI,CACT,WAAW,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,CACvF,CAAC;IACJ,CAAC;IACD,OAAO,WAAW,CAAC,MAAM,CAAC,CAAC;AAC7B,CAAC"}

package/dist/boe.d.ts

@@ -0,0 +1,33 @@
+import type { RateTable } from './provider.js';
+/** Options for parseBankOfEnglandCsv. */
+export interface BankOfEnglandOptions {
+    /**
+     * The decimals the Bank publishes, rebuilt because its CSV strips trailing zeros ('1.35' for
+     * 1.3500). Default 4, as its database shows every spot series.
+     */
+    readonly decimals?: number;
+}
+/**
+ * Parses the Bank of England database's CSV of daily spot rates against sterling (series XUDL…,
+ * downloaded with codes as column titles: `DATE,XUDLUSS,XUDLERS,…` and dates like `22 Dec 2025`)
+ * into one GBP-based table per day, newest first. Rates are currency units per £1, with `source:
+ * 'BoE'` and `type: 'spot'`. The CSV strips trailing zeros, so they are rebuilt to `decimals`
+ * (default 4). Holidays have no row; an empty cell (before a series starts, or after it ends, as
+ * for BGN) is a missing value. An unknown series code, a bad date, two different values for a day
+ * or any other unreadable cell throws SyntaxError. No `availableAt` is set: the Bank says only
+ * that daily rates are updated "no more than two working days after the date to which they
+ * relate".
+ *
+ * **Licensing: you must check the licence of every Bank of England series you load.** The database
+ * is under the Open Government Licence,
+ * but the Bank's legal page says "selected exchange rate data and series are excluded from this
+ * licence" and "reproduced by the Bank under licence from third parties", and its spot rates
+ * page says LSEG and Bloomberg BFIX may be sources, with LSEG content not to be redistributed
+ * without LSEG's consent. No series is named either way, so ducat ships no Bank of England data
+ * and no fetcher. Parse only files you have downloaded and are allowed to use, and get the Bank's
+ * (or LSEG's) permission before you republish any of it. The Bank also says these "are not
+ * official rates". For a licensed UK source, see HMRC's monthly rates
+ * (@ducatjs/money/convert/hmrc).
+ */
+export declare function parseBankOfEnglandCsv(csv: string, options?: BankOfEnglandOptions): RateTable[];
+//# sourceMappingURL=boe.d.ts.map

package/dist/boe.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"boe.d.ts","sourceRoot":"","sources":["../src/boe.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAkD/C,yCAAyC;AACzC,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,SAAS,EAAE,CA8C9F"}

package/dist/boe.js

@@ -0,0 +1,114 @@
+// `@ducatjs/money/convert/boe`: an offline parser for the Bank of England's daily spot exchange
+// rates against sterling. Parser only: see parseBankOfEnglandCsv on licensing.
+import { quotedTable } from './history.js';
+import { addDayRate, csvRows, isCalendarDay, newestFirst, readRateCell } from './rate-text.js';
+// The Bank's daily spot series against sterling, by code (currency units per £1).
+const BOE_SERIES = {
+    XUDLADS: 'AUD',
+    XUDLZOS3: 'BGN',
+    XUDLCDS: 'CAD',
+    XUDLBK89: 'CNY',
+    XUDLBK25: 'CZK',
+    XUDLDKS: 'DKK',
+    XUDLERS: 'EUR',
+    XUDLHDS: 'HKD',
+    XUDLBK33: 'HUF',
+    XUDLBK97: 'INR',
+    XUDLBK78: 'ILS',
+    XUDLJYS: 'JPY',
+    XUDLBK83: 'MYR',
+    XUDLNDS: 'NZD',
+    XUDLNKS: 'NOK',
+    XUDLBK47: 'PLN',
+    XUDLZOS4: 'RON',
+    XUDLSRS: 'SAR',
+    XUDLSGS: 'SGD',
+    XUDLZRS: 'ZAR',
+    XUDLBK93: 'KRW',
+    XUDLSKS: 'SEK',
+    XUDLSFS: 'CHF',
+    XUDLTWS: 'TWD',
+    XUDLBK87: 'THB',
+    XUDLBK95: 'TRY',
+    XUDLUSS: 'USD',
+};
+const MONTHS = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'];
+function notBoe(why) {
+    throw new SyntaxError(`Not a Bank of England spot rates CSV file: ${why}`);
+}
+/** '22 Dec 2025' as an ISO date, or SyntaxError. */
+function isoDate(text) {
+    const match = /^(\d\d) ([A-Z][a-z]{2}) (\d{4})$/.exec(text.trim());
+    const month = match === null ? 0 : MONTHS.indexOf(match[2]) + 1;
+    const day = match === null ? '' : `${match[3]}-${String(month).padStart(2, '0')}-${match[1]}`;
+    if (month === 0 || !isCalendarDay(day)) {
+        notBoe(`bad date ${JSON.stringify(text)}`);
+    }
+    return day;
+}
+/**
+ * Parses the Bank of England database's CSV of daily spot rates against sterling (series XUDL…,
+ * downloaded with codes as column titles: `DATE,XUDLUSS,XUDLERS,…` and dates like `22 Dec 2025`)
+ * into one GBP-based table per day, newest first. Rates are currency units per £1, with `source:
+ * 'BoE'` and `type: 'spot'`. The CSV strips trailing zeros, so they are rebuilt to `decimals`
+ * (default 4). Holidays have no row; an empty cell (before a series starts, or after it ends, as
+ * for BGN) is a missing value. An unknown series code, a bad date, two different values for a day
+ * or any other unreadable cell throws SyntaxError. No `availableAt` is set: the Bank says only
+ * that daily rates are updated "no more than two working days after the date to which they
+ * relate".
+ *
+ * **Licensing: you must check the licence of every Bank of England series you load.** The database
+ * is under the Open Government Licence,
+ * but the Bank's legal page says "selected exchange rate data and series are excluded from this
+ * licence" and "reproduced by the Bank under licence from third parties", and its spot rates
+ * page says LSEG and Bloomberg BFIX may be sources, with LSEG content not to be redistributed
+ * without LSEG's consent. No series is named either way, so ducat ships no Bank of England data
+ * and no fetcher. Parse only files you have downloaded and are allowed to use, and get the Bank's
+ * (or LSEG's) permission before you republish any of it. The Bank also says these "are not
+ * official rates". For a licensed UK source, see HMRC's monthly rates
+ * (@ducatjs/money/convert/hmrc).
+ */
+export function parseBankOfEnglandCsv(csv, options) {
+    const decimals = options?.decimals ?? 4;
+    const [header, ...rows] = csvRows(csv.charCodeAt(0) === 0xfeff ? csv.slice(1) : csv);
+    if (header === undefined || header[0]?.trim() !== 'DATE' || header.length < 2) {
+        notBoe('no DATE column');
+    }
+    const currencies = header.slice(1).map((code) => {
+        const currency = BOE_SERIES[code.trim()];
+        if (currency === undefined) {
+            notBoe(`unknown series ${code} (use the daily spot series against sterling, XUDL…)`);
+        }
+        return currency;
+    });
+    if (new Set(currencies).size !== currencies.length) {
+        notBoe('a series appears twice');
+    }
+    // A download always has a row per business day, so none at all is a cut-off file, not a range
+    // of holidays.
+    if (rows.length === 0) {
+        notBoe('no observations');
+    }
+    const days = new Map();
+    for (const cells of rows) {
+        if (cells.length !== header.length) {
+            notBoe(`a row has ${cells.length} cells, the header ${header.length}`);
+        }
+        const day = isoDate(cells[0]);
+        currencies.forEach((currency, i) => {
+            addDayRate(days, day, currency, readRateCell(cells[i + 1], `${currency} on ${day}`));
+        });
+    }
+    const tables = [];
+    for (const [day, rates] of days) {
+        if (Object.values(rates).some((rate) => rate !== null)) {
+            tables.push(quotedTable({ base: 'GBP', source: 'BoE', type: 'spot', asOf: day, decimals, rates }));
+        }
+    }
+    // A download only has rows for business days, so rows without a single rate aren't data.
+    if (tables.length === 0) {
+        notBoe('no rates in any row');
+    }
+    return newestFirst(tables);
+}
+//# sourceMappingURL=boe.js.map

package/dist/boe.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"boe.js","sourceRoot":"","sources":["../src/boe.ts"],"names":[],"mappings":"AAAA,gGAAgG;AAChG,+EAA+E;AAC/E,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAE3C,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE/F,kFAAkF;AAClF,MAAM,UAAU,GAAqC;IACnD,OAAO,EAAE,KAAK;IACd,QAAQ,EAAE,KAAK;IACf,OAAO,EAAE,KAAK;IACd,QAAQ,EAAE,KAAK;IACf,QAAQ,EAAE,KAAK;IACf,OAAO,EAAE,KAAK;IACd,OAAO,EAAE,KAAK;IACd,OAAO,EAAE,KAAK;IACd,QAAQ,EAAE,KAAK;IACf,QAAQ,EAAE,KAAK;IACf,QAAQ,EAAE,KAAK;IACf,OAAO,EAAE,KAAK;IACd,QAAQ,EAAE,KAAK;IACf,OAAO,EAAE,KAAK;IACd,OAAO,EAAE,KAAK;IACd,QAAQ,EAAE,KAAK;IACf,QAAQ,EAAE,KAAK;IACf,OAAO,EAAE,KAAK;IACd,OAAO,EAAE,KAAK;IACd,OAAO,EAAE,KAAK;IACd,QAAQ,EAAE,KAAK;IACf,OAAO,EAAE,KAAK;IACd,OAAO,EAAE,KAAK;IACd,OAAO,EAAE,KAAK;IACd,QAAQ,EAAE,KAAK;IACf,QAAQ,EAAE,KAAK;IACf,OAAO,EAAE,KAAK;CACf,CAAC;AACF,MAAM,MAAM,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;AAEpG,SAAS,MAAM,CAAC,GAAW;IACzB,MAAM,IAAI,WAAW,CAAC,8CAA8C,GAAG,EAAE,CAAC,CAAC;AAC7E,CAAC;AAED,oDAAoD;AACpD,SAAS,OAAO,CAAC,IAAY;IAC3B,MAAM,KAAK,GAAG,kCAAkC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;IACnE,MAAM,KAAK,GAAG,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,GAAG,CAAC,CAAC;IACjE,MAAM,GAAG,GAAG,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9F,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;QACvC,MAAM,CAAC,YAAY,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAWD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,qBAAqB,CAAC,GAAW,EAAE,OAA8B;IAC/E,MAAM,QAAQ,GAAG,OAAO,EAAE,QAAQ,IAAI,CAAC,CAAC;IACxC,MAAM,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IACrF,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,MAAM,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC9E,MAAM,CAAC,gBAAgB,CAAC,CAAC;IAC3B,CAAC;IACD,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QAC9C,MAAM,QAAQ,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;QACzC,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,MAAM,CAAC,kBAAkB,IAAI,sDAAsD,CAAC,CAAC;QACvF,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC,CAAC,CAAC;IACH,IAAI,IAAI,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,KAAK,UAAU,CAAC,MAAM,EAAE,CAAC;QACnD,MAAM,CAAC,wBAAwB,CAAC,CAAC;IACnC,CAAC;IAED,8FAA8F;IAC9F,eAAe;IACf,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,MAAM,CAAC,iBAAiB,CAAC,CAAC;IAC5B,CAAC;IACD,MAAM,IAAI,GAAG,IAAI,GAAG,EAAyC,CAAC;IAC9D,KAAK,MAAM,KAAK,IAAI,IAAI,EAAE,CAAC;QACzB,IAAI,KAAK,CAAC,MAAM,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC;YACnC,MAAM,CAAC,aAAa,KAAK,CAAC,MAAM,sBAAsB,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;QACzE,CAAC;QACD,MAAM,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,CAAC;QAC/B,UAAU,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE;YACjC,UAAU,CAAC,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAE,EAAE,GAAG,QAAQ,OAAO,GAAG,EAAE,CAAC,CAAC,CAAC;QACxF,CAAC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,MAAM,GAAgB,EAAE,CAAC;IAC/B,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC;QAChC,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;YACvD,MAAM,CAAC,IAAI,CACT,WAAW,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CACtF,CAAC;QACJ,CAAC;IACH,CAAC;IACD,yFAAyF;IACzF,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,MAAM,CAAC,qBAAqB,CAAC,CAAC;IAChC,CAAC;IACD,OAAO,WAAW,CAAC,MAAM,CAAC,CAAC;AAC7B,CAAC"}

package/dist/braintree.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Braintree's amount view (https://developer.paypal.com/braintree/docs/reference/general/currencies,
+ * encoded in data/braintree.json). `amount` is a decimal string in major units, "formatted like
+ * '10' or '10.00'":
+ * - zero-decimal currencies can't include decimals: BIF CLP DJF GNF ISK JPY KMF KRW LAK PYG RWF UGX
+ *   VND VUV XAF XOF XPF (LAK has 2 in ISO 4217);
+ * - the others take their ISO decimals ("10.00"). No three-decimal currency is listed.
+ * Amounts must be greater than zero, refunds and credits included.
+ */
+import { BRAINTREE_EXPONENTS } from './generated/braintree.js';
+import { type CurrencyInput, type Money } from './money.js';
+import type { RoundingMode } from './rounding.js';
+export { BRAINTREE_EXPONENTS };
+/** The number of decimals Braintree takes for a currency (JPY 0, LAK 0, USD 2). */
+export declare function braintreeExponent(currency: string): number;
+/** Whether Braintree lists the currency (case-insensitive). */
+export declare function isBraintreeCurrency(currency: string): boolean;
+/** Options for the Braintree amount: how to round when Braintree needs a coarser amount. */
+export interface BraintreeAmountOptions {
+    /**
+     * How to round when Braintree needs fewer decimals than the value has (default 'unnecessary':
+     * throw).
+     */
+    readonly rounding?: RoundingMode;
+}
+/**
+ * The exact `amount` string: toBraintree(money('10', 'USD')) === '10.00', JPY 100 -> '100'.
+ * Braintree has no currency field on a transaction: the merchant account sets it.
+ * Throws a RangeError for zero or negative amounts.
+ */
+export declare function toBraintree(money: Money, options?: BraintreeAmountOptions): string;
+/** Reads a Braintree amount string exactly: fromBraintree('10.00', 'USD'). */
+export declare function fromBraintree<C extends CurrencyInput>(amount: string, currency: C): Money<Uppercase<C>>;
+//# sourceMappingURL=braintree.d.ts.map

package/dist/braintree.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"braintree.d.ts","sourceRoot":"","sources":["../src/braintree.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,KAAK,aAAa,EAAE,KAAK,KAAK,EAAE,MAAM,YAAY,CAAC;AAE5D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAElD,OAAO,EAAE,mBAAmB,EAAE,CAAC;AAK/B,mFAAmF;AACnF,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAM1D;AAED,+DAA+D;AAC/D,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAE7D;AAED,4FAA4F;AAC5F,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,YAAY,CAAC;CAClC;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,sBAAsB,GAAG,MAAM,CAWlF;AAED,8EAA8E;AAC9E,wBAAgB,aAAa,CAAC,CAAC,SAAS,aAAa,EACnD,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,CAAC,GACV,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAMrB"}

package/dist/braintree.js

@@ -0,0 +1,45 @@
+/**
+ * Braintree's amount view (https://developer.paypal.com/braintree/docs/reference/general/currencies,
+ * encoded in data/braintree.json). `amount` is a decimal string in major units, "formatted like
+ * '10' or '10.00'":
+ * - zero-decimal currencies can't include decimals: BIF CLP DJF GNF ISK JPY KMF KRW LAK PYG RWF UGX
+ *   VND VUV XAF XOF XPF (LAK has 2 in ISO 4217);
+ * - the others take their ISO decimals ("10.00"). No three-decimal currency is listed.
+ * Amounts must be greater than zero, refunds and credits included.
+ */
+import { BRAINTREE_EXPONENTS } from './generated/braintree.js';
+import {} from './money.js';
+import { fromProcessorDecimal, toProcessorDecimal } from './processor.js';
+export { BRAINTREE_EXPONENTS };
+/** "Can only contain numbers and one decimal point (e.g. x.xx)". */
+const AMOUNT_PATTERN = /^[0-9]+(\.[0-9]+)?$/;
+/** The number of decimals Braintree takes for a currency (JPY 0, LAK 0, USD 2). */
+export function braintreeExponent(currency) {
+    const exponent = BRAINTREE_EXPONENTS[currency.toUpperCase()];
+    if (exponent === undefined) {
+        throw new RangeError(`${currency} is not a Braintree currency`);
+    }
+    return exponent;
+}
+/** Whether Braintree lists the currency (case-insensitive). */
+export function isBraintreeCurrency(currency) {
+    return BRAINTREE_EXPONENTS[currency.toUpperCase()] !== undefined;
+}
+/**
+ * The exact `amount` string: toBraintree(money('10', 'USD')) === '10.00', JPY 100 -> '100'.
+ * Braintree has no currency field on a transaction: the merchant account sets it.
+ * Throws a RangeError for zero or negative amounts.
+ */
+export function toBraintree(money, options) {
+    const rounding = options?.rounding ?? 'unnecessary';
+    // 81531 "Amount must be greater than zero"; 81501: credits are positive too ("x.xx, not -x.xx").
+    return toProcessorDecimal('Braintree', money, braintreeExponent(money.currency), rounding, 'positive');
+}
+/** Reads a Braintree amount string exactly: fromBraintree('10.00', 'USD'). */
+export function fromBraintree(amount, currency) {
+    const code = currency.toUpperCase();
+    // Validates the currency before parsing, so an unlisted currency is the error reported.
+    braintreeExponent(code);
+    return fromProcessorDecimal('Braintree', amount, code, AMOUNT_PATTERN);
+}
+//# sourceMappingURL=braintree.js.map

package/dist/braintree.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"braintree.js","sourceRoot":"","sources":["../src/braintree.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAkC,MAAM,YAAY,CAAC;AAC5D,OAAO,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAG1E,OAAO,EAAE,mBAAmB,EAAE,CAAC;AAE/B,oEAAoE;AACpE,MAAM,cAAc,GAAG,qBAAqB,CAAC;AAE7C,mFAAmF;AACnF,MAAM,UAAU,iBAAiB,CAAC,QAAgB;IAChD,MAAM,QAAQ,GAAG,mBAAmB,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;IAC7D,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,MAAM,IAAI,UAAU,CAAC,GAAG,QAAQ,8BAA8B,CAAC,CAAC;IAClE,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,+DAA+D;AAC/D,MAAM,UAAU,mBAAmB,CAAC,QAAgB;IAClD,OAAO,mBAAmB,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,KAAK,SAAS,CAAC;AACnE,CAAC;AAWD;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,KAAY,EAAE,OAAgC;IACxE,MAAM,QAAQ,GAAG,OAAO,EAAE,QAAQ,IAAI,aAAa,CAAC;IAEpD,iGAAiG;IACjG,OAAO,kBAAkB,CACvB,WAAW,EACX,KAAK,EACL,iBAAiB,CAAC,KAAK,CAAC,QAAQ,CAAC,EACjC,QAAQ,EACR,UAAU,CACX,CAAC;AACJ,CAAC;AAED,8EAA8E;AAC9E,MAAM,UAAU,aAAa,CAC3B,MAAc,EACd,QAAW;IAEX,MAAM,IAAI,GAAG,QAAQ,CAAC,WAAW,EAAkB,CAAC;IAEpD,wFAAwF;IACxF,iBAAiB,CAAC,IAAI,CAAC,CAAC;IACxB,OAAO,oBAAoB,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC;AACzE,CAAC"}

package/dist/cash.d.ts

@@ -0,0 +1,64 @@
+import { CASH_RULES, type CashRule } from './generated/cash.js';
+import { type Money, type RoundingPolicy } from './money.js';
+import { type RoundingMode } from './rounding.js';
+/**
+ * Rounds to a multiple of `increment` (same currency): roundToIncrement(CHF 10.03, CHF 0.05) = CHF
+ * 10.05. Default rounding 'halfExpand' (nearest, ties away from zero), which is what the statutory
+ * cash-rounding rules (SE, NO, DK, HU, CZ, FI, BE ...) prescribe.
+ */
+export declare function roundToIncrement<C extends string>(money: Money<C>, increment: Money<NoInfer<C>>, rounding?: RoundingMode): Money<C>;
+/**
+ * The cash-rounding rule for a currency, optionally narrowed by country (ISO 3166 alpha-2).
+ * EUR has no euro-wide rule: pass the country (BE, NL, FI, IE, IT, SK, EE, LT).
+ */
+export declare function cashRule(currency: string, country?: string): CashRule | undefined;
+/**
+ * Options for `cashRound`: the country (needed for EUR), the rounding mode, and whether to use
+ * unverified rules.
+ */
+export interface CashRoundOptions {
+    readonly country?: string;
+    readonly rounding?: RoundingMode;
+    /**
+     * Apply rules that are only backed by secondary sources (default true; see
+     * data/cash-rounding.json).
+     */
+    readonly includeUnverified?: boolean;
+}
+/**
+ * Rounds a cash total to the smallest legal/practical cash step (CHF 0.05, SEK 1, DKK 0.50, CAD
+ * 0.05, HUF 5, EUR 0.05 in BE/NL/FI/IE/...). Card and other electronic payments are NOT rounded:
+ * only call this for cash tenders. Returns m unchanged when no rule applies.
+ */
+export declare function cashRound<C extends string>(money: Money<C>, options?: CashRoundOptions): Money<C>;
+/**
+ * The cash-rounding rule for a currency as a `RoundingPolicy`, to pass wherever a rounding mode
+ * goes: `m.multiply('1.075', cashPolicy('CHF'))` rounds once, straight to CHF 0.05. The policy only
+ * accepts amounts in `currency`. Throws a RangeError when no rule applies (EUR needs a country);
+ * use `isoPolicy` for currencies without cash rounding.
+ */
+export declare function cashPolicy(currency: string, options?: CashRoundOptions): RoundingPolicy;
+/** Options for `currencyDigits`. */
+export interface CurrencyDigitsOptions {
+    /** 'standard' (the default): the ISO 4217 exponent. 'cash': the decimals of a cash amount. */
+    readonly usage?: 'standard' | 'cash';
+    /** For cash: the country (ISO 3166 alpha-2), which EUR needs. */
+    readonly country?: string;
+    /** For cash: whether to use rules backed only by secondary sources (default true). */
+    readonly includeUnverified?: boolean;
+}
+/**
+ * The number of decimals a currency's amounts are shown with: its ISO 4217 exponent, or with
+ * `{ usage: 'cash' }`, the decimals of a cash amount (what CLDR calls `cashDigits`): none when cash
+ * is rounded to whole units, the exponent otherwise.
+ *
+ *     currencyDigits('SEK')                       // 2
+ *     currencyDigits('SEK', { usage: 'cash' })    // 0: cash is rounded to whole kronor
+ *     currencyDigits('CHF', { usage: 'cash' })    // 2: CHF 0.05 still needs two decimals
+ *
+ * A currency without a cash rule (or EUR without a country that has one) takes its exponent.
+ * Throws for unknown codes, like `currencyExponent`.
+ */
+export declare function currencyDigits(currency: string, options?: CurrencyDigitsOptions): number;
+export { CASH_RULES, type CashRule };
+//# sourceMappingURL=cash.d.ts.map

package/dist/cash.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cash.d.ts","sourceRoot":"","sources":["../src/cash.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,KAAK,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAKL,KAAK,KAAK,EACV,KAAK,cAAc,EACpB,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAwC,KAAK,YAAY,EAAE,MAAM,eAAe,CAAC;AAGxF;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,MAAM,EAC/C,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EACf,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAC5B,QAAQ,GAAE,YAA2B,GACpC,KAAK,CAAC,CAAC,CAAC,CAyBV;AAED;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAkBjF;AAuBD;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,QAAQ,CAAC,EAAE,YAAY,CAAC;IACjC;;;OAGG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,OAAO,CAAC;CACtC;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,KAAK,CAAC,CAAC,CAAC,CAOjG;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,cAAc,CAYvF;AAED,oCAAoC;AACpC,MAAM,WAAW,qBAAqB;IACpC,8FAA8F;IAC9F,QAAQ,CAAC,KAAK,CAAC,EAAE,UAAU,GAAG,MAAM,CAAC;IACrC,iEAAiE;IACjE,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,sFAAsF;IACtF,QAAQ,CAAC,iBAAiB,CAAC,EAAE,OAAO,CAAC;CACtC;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,MAAM,CAgBxF;AAED,OAAO,EAAE,UAAU,EAAE,KAAK,QAAQ,EAAE,CAAC"}