@amboras-dev/money 0.1.0 → 0.3.0

package/dist/testing.d.cts

@@ -1,14 +1,11 @@
-import { L as DecimalText, R as RoundingMode, b as StorageScale, r as Money, y as FractionDigits } from "./money-CbhsT0fB.cjs";
-import { K as PspId } from "./wire-hWuixv3w.cjs";
-//#region src/testing/check-wire-digits.d.ts
+import { R as DecimalText, b as FractionDigits, i as Money, x as StorageScale, z as RoundingMode } from "./money-BkMeYDEW.cjs";
+import { mt as PspId } from "./wire-CtNJmWVP.cjs";
 /**
  * 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;
@@ -46,8 +43,6 @@ export declare const ROUNDING_VECTORS: readonly RoundingVector[];
 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;
@@ -72,8 +67,6 @@ export declare const DESTINATION_GOLDEN_VECTORS: {
   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
@@ -93,5 +86,47 @@ interface GoldenVector {
 }
 /** Wire bytes for every PSP x presented currency x storage amount (18900 vectors). */
 export declare const PSP_GOLDEN_VECTORS: readonly GoldenVector[];
-//#endregion
-export type { CurrencyCase, DestinationAmountVector, DestinationTextVector, GoldenPspId, GoldenVector, MedusaAmountShape, RoundingVector };
+/**
+ * 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[];
+/**
+ * One amount as Medusa's pre-0.2.0 float codec spelled it, for a PSP it encoded in floating point
+ * (`(stored / storageScale).toFixed(digits)` on a double): `wire` is what the adapter sent (a number
+ * for Airwallex and Payoo), `iso` its `legacyIsoMajorString` (the same at the display digits). At an
+ * exact tie the double can sit below it, so USD `'1072.5'` is `'10.72'` where encodeWire sends
+ * `'10.73'`; `sameWireAmount(..., { acceptLegacyFloatRounding: true })` accepts these spellings.
+ */
+interface LegacyFloatGoldenVector {
+  readonly psp: GoldenPspId;
+  readonly currency: string;
+  /** The storage amount as decimal text (`'1072.5'`). */
+  readonly stored: string;
+  readonly wire: number | string;
+  readonly iso: string;
+}
+/** Medusa's float spellings for every float PSP x presented currency x amount (7589 vectors). */
+export declare const PSP_LEGACY_FLOAT_GOLDEN_VECTORS: readonly LegacyFloatGoldenVector[];
+export type { CurrencyCase, DestinationAmountVector, DestinationTextVector, FractionalGoldenVector, FractionalPolicy, GoldenPspId, GoldenVector, LegacyFloatGoldenVector, MedusaAmountShape, RoundingVector };

package/dist/testing.d.ts

@@ -1,14 +1,11 @@
-import { L as DecimalText, R as RoundingMode, b as StorageScale, r as Money, y as FractionDigits } from "./money-CbhsT0fB.js";
-import { K as PspId } from "./wire-Cd4Q1Jmm.js";
-//#region src/testing/check-wire-digits.d.ts
+import { R as DecimalText, b as FractionDigits, i as Money, x as StorageScale, z as RoundingMode } from "./money-BkMeYDEW.js";
+import { mt as PspId } from "./wire-CVNicirK.js";
 /**
  * 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;
@@ -46,8 +43,6 @@ export declare const ROUNDING_VECTORS: readonly RoundingVector[];
 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;
@@ -72,8 +67,6 @@ export declare const DESTINATION_GOLDEN_VECTORS: {
   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
@@ -93,5 +86,47 @@ interface GoldenVector {
 }
 /** Wire bytes for every PSP x presented currency x storage amount (18900 vectors). */
 export declare const PSP_GOLDEN_VECTORS: readonly GoldenVector[];
-//#endregion
-export type { CurrencyCase, DestinationAmountVector, DestinationTextVector, GoldenPspId, GoldenVector, MedusaAmountShape, RoundingVector };
+/**
+ * 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[];
+/**
+ * One amount as Medusa's pre-0.2.0 float codec spelled it, for a PSP it encoded in floating point
+ * (`(stored / storageScale).toFixed(digits)` on a double): `wire` is what the adapter sent (a number
+ * for Airwallex and Payoo), `iso` its `legacyIsoMajorString` (the same at the display digits). At an
+ * exact tie the double can sit below it, so USD `'1072.5'` is `'10.72'` where encodeWire sends
+ * `'10.73'`; `sameWireAmount(..., { acceptLegacyFloatRounding: true })` accepts these spellings.
+ */
+interface LegacyFloatGoldenVector {
+  readonly psp: GoldenPspId;
+  readonly currency: string;
+  /** The storage amount as decimal text (`'1072.5'`). */
+  readonly stored: string;
+  readonly wire: number | string;
+  readonly iso: string;
+}
+/** Medusa's float spellings for every float PSP x presented currency x amount (7589 vectors). */
+export declare const PSP_LEGACY_FLOAT_GOLDEN_VECTORS: readonly LegacyFloatGoldenVector[];
+export type { CurrencyCase, DestinationAmountVector, DestinationTextVector, FractionalGoldenVector, FractionalPolicy, GoldenPspId, GoldenVector, LegacyFloatGoldenVector, MedusaAmountShape, RoundingVector };