@amboras-dev/money 0.0.0-stage → 0.2.0

package/dist/testing.d.cts

@@ -0,0 +1,125 @@
+import { R as DecimalText, b as FractionDigits, i as Money, x as StorageScale, z as RoundingMode } from "./money-B-3aFjNJ.cjs";
+import { Y as PspId } from "./wire-xjYXv4go.cjs";
+//#region src/testing/check-wire-digits.d.ts
+/**
+ * Mismatch messages (empty when consistent) between `psp`'s encoder and `documented(code)`, the
+ * decimal count the PSP's documentation gives for each currency it takes (undefined: the
+ * documentation does not list it). Gated PSPs are probed under the iso-minor-v2 convention.
+ */
+export declare function checkWireDigits(psp: PspId, documented: (code: string) => FractionDigits | undefined): string[];
+//#endregion
+//#region src/testing/fixtures.d.ts
+/** One currency of a class, with the facts a test should assert about it. */
+interface CurrencyCase {
+  readonly code: string;
+  readonly storageScale: StorageScale;
+  readonly storageDigits: FractionDigits;
+  readonly displayDigits: FractionDigits;
+  readonly historic: boolean;
+  /** Why it is here. */
+  readonly why: string;
+}
+/** One currency per class the storage, display and wire rules distinguish. */
+export declare const CURRENCY_CASES: readonly CurrencyCase[];
+/** A Medusa amount shape with what `readStored(shape, 'USD', lenient)` and `readStoredDecimal(shape, lenient)` give. */
+interface MedusaAmountShape {
+  readonly name: string;
+  readonly value: unknown;
+  /** `readStored(value, 'USD', { mode: 'lenient' })?.amount ?? null`. */
+  readonly stored: number | null;
+  /** `readStoredDecimal(value, { mode: 'lenient' })`. */
+  readonly decimal: string | null;
+}
+/** Every amount shape Medusa hands over, and the two text spellings that must not read as numbers. */
+export declare const MEDUSA_AMOUNT_SHAPES: readonly MedusaAmountShape[];
+/** `decimalRound(input, { scale, rounding })` must give `expected`. */
+interface RoundingVector {
+  readonly input: string;
+  readonly scale: number;
+  readonly rounding: RoundingMode;
+  readonly expected: DecimalText;
+  readonly why: string;
+}
+/** The rounding cases float code got wrong, and the tie rules. */
+export declare const ROUNDING_VECTORS: readonly RoundingVector[];
+/** NBSP and narrow NBSP (ICU puts them in some locales' currency output) as plain spaces. */
+export declare function normalizeIntlSpaces(s: string): string;
+/** A sample amount for previews and email samples: `fromMajor(major, currency, { precision: 'round' })` (KWD 12.5 is 12500 stored). */
+export declare function sampleMoney(currency: string, major: number | string): Money;
+//#endregion
+//#region src/testing/golden-destinations.d.ts
+/** `destinationAmount(dest, money(stored, currency), { as })`: `expected` null means it returns undefined; `error` means it throws that code. */
+interface DestinationAmountVector {
+  readonly dest: string;
+  readonly stored: number;
+  readonly currency: string;
+  readonly as?: 'number' | 'string';
+  readonly expected: {
+    readonly value: number | string;
+    readonly currency: string;
+  } | null;
+  readonly error: 'wire_unsupported' | null;
+}
+/** `feedPrice(money(stored, currency))` or `googleMicros(money(stored, currency))` must give `expected`. */
+interface DestinationTextVector {
+  readonly stored: number;
+  readonly currency: string;
+  readonly expected: string;
+}
+/** Expectations for `destinationAmount`, `feedPrice` and `googleMicros`. */
+export declare const DESTINATION_GOLDEN_VECTORS: {
+  readonly destinationAmount: readonly DestinationAmountVector[];
+  readonly feedPrice: readonly DestinationTextVector[];
+  readonly googleMicros: readonly DestinationTextVector[];
+};
+//#endregion
+//#region src/testing/golden-psp.d.ts
+type GoldenPspId = 'stripe' | 'adyen' | 'razorpay' | 'paystack' | 'momo' | 'vnpay' | 'paypal' | 'mollie' | 'airwallex' | 'iyzico' | 'authorize-net' | 'payoo';
+/**
+ * One encode as Medusa does it today: `wire` for a sent amount, or `error` and `wire: null` for a refusal: the
+ * codec's verbatim message, or, for a positive amount whose wire rounds to 0, a description containing
+ * `' rounds to 0 at '` (`SUB_UNIT_REFUSAL`). That refusal is package policy, not Medusa behaviour: Medusa puts 0
+ * on the wire at initiate for Stripe and Adyen, and for Razorpay, PayPal and Airwallex everywhere; it refuses at
+ * refund and capture for Stripe and Adyen, and in Mollie, iyzico and Authorize.Net.
+ */
+interface GoldenVector {
+  readonly psp: GoldenPspId;
+  readonly currency: string;
+  /** Gated PSPs: the session's convention; null for PSPs without a cutover. */
+  readonly convention: 'iso-minor-v2' | 'pre-cutover' | null;
+  readonly stored: number;
+  readonly wire: number | string | null;
+  readonly error: string | null;
+}
+/** Wire bytes for every PSP x presented currency x storage amount (18900 vectors). */
+export declare const PSP_GOLDEN_VECTORS: readonly GoldenVector[];
+//#endregion
+//#region src/testing/golden-psp-fractional.d.ts
+/**
+ * Where the package departs on purpose from what the codec does with a fractional amount:
+ * `'sub-unit'` a positive amount whose wire is 0 is refused (`error` contains `SUB_UNIT_REFUSAL`);
+ * `'exact-half-up'` a tie at the wire digits that Medusa's float `toFixed` rounded down is rounded
+ * half-up exactly; `'real-amount'` a refusal that named a `toFixed` neighbour of the amount names
+ * the amount as held.
+ */
+type FractionalPolicy = 'sub-unit' | 'exact-half-up' | 'real-amount';
+/**
+ * One encode of a FRACTIONAL storage amount (Medusa keeps unrounded totals): `wire` and `error` are
+ * what encodeWire gives; where it departs from the codec on purpose, `policy` says why and `medusa`
+ * holds the codec's own wire or message.
+ */
+interface FractionalGoldenVector {
+  readonly psp: GoldenPspId;
+  readonly currency: string;
+  readonly convention: GoldenVector['convention'];
+  /** The storage amount as canonical decimal text (`'107.8175'`). */
+  readonly stored: string;
+  readonly wire: number | string | null;
+  readonly error: string | null;
+  readonly policy: FractionalPolicy | null;
+  readonly medusa: number | string | null;
+}
+/** Fractional storage amounts for every PSP x presented currency (10500 vectors). */
+export declare const PSP_FRACTIONAL_GOLDEN_VECTORS: readonly FractionalGoldenVector[];
+//#endregion
+export type { CurrencyCase, DestinationAmountVector, DestinationTextVector, FractionalGoldenVector, FractionalPolicy, GoldenPspId, GoldenVector, MedusaAmountShape, RoundingVector };

package/dist/testing.d.ts

@@ -0,0 +1,125 @@
+import { R as DecimalText, b as FractionDigits, i as Money, x as StorageScale, z as RoundingMode } from "./money-B-3aFjNJ.js";
+import { Y as PspId } from "./wire-CaUN9Vf_.js";
+//#region src/testing/check-wire-digits.d.ts
+/**
+ * Mismatch messages (empty when consistent) between `psp`'s encoder and `documented(code)`, the
+ * decimal count the PSP's documentation gives for each currency it takes (undefined: the
+ * documentation does not list it). Gated PSPs are probed under the iso-minor-v2 convention.
+ */
+export declare function checkWireDigits(psp: PspId, documented: (code: string) => FractionDigits | undefined): string[];
+//#endregion
+//#region src/testing/fixtures.d.ts
+/** One currency of a class, with the facts a test should assert about it. */
+interface CurrencyCase {
+  readonly code: string;
+  readonly storageScale: StorageScale;
+  readonly storageDigits: FractionDigits;
+  readonly displayDigits: FractionDigits;
+  readonly historic: boolean;
+  /** Why it is here. */
+  readonly why: string;
+}
+/** One currency per class the storage, display and wire rules distinguish. */
+export declare const CURRENCY_CASES: readonly CurrencyCase[];
+/** A Medusa amount shape with what `readStored(shape, 'USD', lenient)` and `readStoredDecimal(shape, lenient)` give. */
+interface MedusaAmountShape {
+  readonly name: string;
+  readonly value: unknown;
+  /** `readStored(value, 'USD', { mode: 'lenient' })?.amount ?? null`. */
+  readonly stored: number | null;
+  /** `readStoredDecimal(value, { mode: 'lenient' })`. */
+  readonly decimal: string | null;
+}
+/** Every amount shape Medusa hands over, and the two text spellings that must not read as numbers. */
+export declare const MEDUSA_AMOUNT_SHAPES: readonly MedusaAmountShape[];
+/** `decimalRound(input, { scale, rounding })` must give `expected`. */
+interface RoundingVector {
+  readonly input: string;
+  readonly scale: number;
+  readonly rounding: RoundingMode;
+  readonly expected: DecimalText;
+  readonly why: string;
+}
+/** The rounding cases float code got wrong, and the tie rules. */
+export declare const ROUNDING_VECTORS: readonly RoundingVector[];
+/** NBSP and narrow NBSP (ICU puts them in some locales' currency output) as plain spaces. */
+export declare function normalizeIntlSpaces(s: string): string;
+/** A sample amount for previews and email samples: `fromMajor(major, currency, { precision: 'round' })` (KWD 12.5 is 12500 stored). */
+export declare function sampleMoney(currency: string, major: number | string): Money;
+//#endregion
+//#region src/testing/golden-destinations.d.ts
+/** `destinationAmount(dest, money(stored, currency), { as })`: `expected` null means it returns undefined; `error` means it throws that code. */
+interface DestinationAmountVector {
+  readonly dest: string;
+  readonly stored: number;
+  readonly currency: string;
+  readonly as?: 'number' | 'string';
+  readonly expected: {
+    readonly value: number | string;
+    readonly currency: string;
+  } | null;
+  readonly error: 'wire_unsupported' | null;
+}
+/** `feedPrice(money(stored, currency))` or `googleMicros(money(stored, currency))` must give `expected`. */
+interface DestinationTextVector {
+  readonly stored: number;
+  readonly currency: string;
+  readonly expected: string;
+}
+/** Expectations for `destinationAmount`, `feedPrice` and `googleMicros`. */
+export declare const DESTINATION_GOLDEN_VECTORS: {
+  readonly destinationAmount: readonly DestinationAmountVector[];
+  readonly feedPrice: readonly DestinationTextVector[];
+  readonly googleMicros: readonly DestinationTextVector[];
+};
+//#endregion
+//#region src/testing/golden-psp.d.ts
+type GoldenPspId = 'stripe' | 'adyen' | 'razorpay' | 'paystack' | 'momo' | 'vnpay' | 'paypal' | 'mollie' | 'airwallex' | 'iyzico' | 'authorize-net' | 'payoo';
+/**
+ * One encode as Medusa does it today: `wire` for a sent amount, or `error` and `wire: null` for a refusal: the
+ * codec's verbatim message, or, for a positive amount whose wire rounds to 0, a description containing
+ * `' rounds to 0 at '` (`SUB_UNIT_REFUSAL`). That refusal is package policy, not Medusa behaviour: Medusa puts 0
+ * on the wire at initiate for Stripe and Adyen, and for Razorpay, PayPal and Airwallex everywhere; it refuses at
+ * refund and capture for Stripe and Adyen, and in Mollie, iyzico and Authorize.Net.
+ */
+interface GoldenVector {
+  readonly psp: GoldenPspId;
+  readonly currency: string;
+  /** Gated PSPs: the session's convention; null for PSPs without a cutover. */
+  readonly convention: 'iso-minor-v2' | 'pre-cutover' | null;
+  readonly stored: number;
+  readonly wire: number | string | null;
+  readonly error: string | null;
+}
+/** Wire bytes for every PSP x presented currency x storage amount (18900 vectors). */
+export declare const PSP_GOLDEN_VECTORS: readonly GoldenVector[];
+//#endregion
+//#region src/testing/golden-psp-fractional.d.ts
+/**
+ * Where the package departs on purpose from what the codec does with a fractional amount:
+ * `'sub-unit'` a positive amount whose wire is 0 is refused (`error` contains `SUB_UNIT_REFUSAL`);
+ * `'exact-half-up'` a tie at the wire digits that Medusa's float `toFixed` rounded down is rounded
+ * half-up exactly; `'real-amount'` a refusal that named a `toFixed` neighbour of the amount names
+ * the amount as held.
+ */
+type FractionalPolicy = 'sub-unit' | 'exact-half-up' | 'real-amount';
+/**
+ * One encode of a FRACTIONAL storage amount (Medusa keeps unrounded totals): `wire` and `error` are
+ * what encodeWire gives; where it departs from the codec on purpose, `policy` says why and `medusa`
+ * holds the codec's own wire or message.
+ */
+interface FractionalGoldenVector {
+  readonly psp: GoldenPspId;
+  readonly currency: string;
+  readonly convention: GoldenVector['convention'];
+  /** The storage amount as canonical decimal text (`'107.8175'`). */
+  readonly stored: string;
+  readonly wire: number | string | null;
+  readonly error: string | null;
+  readonly policy: FractionalPolicy | null;
+  readonly medusa: number | string | null;
+}
+/** Fractional storage amounts for every PSP x presented currency (10500 vectors). */
+export declare const PSP_FRACTIONAL_GOLDEN_VECTORS: readonly FractionalGoldenVector[];
+//#endregion
+export type { CurrencyCase, DestinationAmountVector, DestinationTextVector, FractionalGoldenVector, FractionalPolicy, GoldenPspId, GoldenVector, MedusaAmountShape, RoundingVector };