feat: enable HighPrecisionMoney

chore: add changeset and refactor

refactor: formatting

refactor: formatting

fix: clear the outdated preciseAmount on required CentPrecisionMoney types

refactor: validate if calculcated amount matches the external price

Author: robertmoelker

.changeset/cold-phones-film.md

@@ -0,0 +1,5 @@
+---
+"@labdigital/commercetools-mock": minor
+---
+
+Add HighPrecisionMoney support

src/repositories/cart/actions.ts

@@ -52,6 +52,7 @@ import type { Writable } from "#src/types.ts";
 import type { UpdateHandlerInterface } from "../abstract.ts";
 import { AbstractUpdateHandler, type RepositoryContext } from "../abstract.ts";
 import {
+	calculateMoneyTotalCentAmount,
 	createAddress,
 	createCentPrecisionMoney,
 	createCustomFields,
@@ -183,6 +184,10 @@ export class CartUpdateHandler
 					`No valid price found for ${productId} for country ${resource.country} and currency ${currency}`,
 				);
 			}
+			const totalPrice = createCentPrecisionMoney({
+				currencyCode: price.value.currencyCode,
+				centAmount: calculateMoneyTotalCentAmount(price.value, quantity),
+			});
 			resource.lineItems.push({
 				id: uuidv4(),
 				key,
@@ -196,11 +201,7 @@ export class CartUpdateHandler
 				price: price,
 				taxedPricePortions: [],
 				perMethodTaxRate: [],
-				totalPrice: {
-					...price.value,
-					type: "centPrecision",
-					centAmount: price.value.centAmount * quantity,
-				},
+				totalPrice,
 				quantity,
 				discountedPricePerQuantity: [],
 				lineItemMode: "Standard",
@@ -427,8 +428,11 @@ export class CartUpdateHandler
 			}
 			customLineItem.quantity = quantity;
 			customLineItem.totalPrice = createCentPrecisionMoney({
-				...customLineItem.money,
-				centAmount: (customLineItem.money.centAmount ?? 0) * quantity,
+				currencyCode: customLineItem.money.currencyCode,
+				centAmount: calculateMoneyTotalCentAmount(
+					customLineItem.money,
+					quantity,
+				),
 			});
 		};
 
@@ -470,8 +474,11 @@ export class CartUpdateHandler
 			}
 			customLineItem.money = createTypedMoney(money);
 			customLineItem.totalPrice = createCentPrecisionMoney({
-				...money,
-				centAmount: (money.centAmount ?? 0) * customLineItem.quantity,
+				currencyCode: money.currencyCode,
+				centAmount: calculateMoneyTotalCentAmount(
+					money,
+					customLineItem.quantity,
+				),
 			});
 		};
 
@@ -608,7 +615,7 @@ export class CartUpdateHandler
 			shippingMethodName,
 			price: createCentPrecisionMoney(shippingRate.price),
 			shippingRate: {
-				price: createTypedMoney(shippingRate.price),
+				price: createCentPrecisionMoney(shippingRate.price),
 				tiers: [],
 			},
 			taxCategory: tax
@@ -798,7 +805,7 @@ export class CartUpdateHandler
 
 		const lineItemTotal = calculateLineItemTotalPrice(lineItem);
 		lineItem.totalPrice = createCentPrecisionMoney({
-			...lineItem.price!.value,
+			currencyCode: lineItem.price!.value.currencyCode,
 			centAmount: lineItemTotal,
 		});
 		resource.totalPrice.centAmount = calculateCartTotalPrice(resource);

src/repositories/cart/helpers.ts

@@ -11,6 +11,7 @@ import { v4 as uuidv4 } from "uuid";
 import { calculateTaxedPrice } from "#src/lib/tax.ts";
 import type { AbstractStorage } from "#src/storage/abstract.ts";
 import {
+	calculateMoneyTotalCentAmount,
 	createCentPrecisionMoney,
 	createCustomFields,
 	createTypedMoney,
@@ -40,8 +41,13 @@ export const selectPrice = ({
 	});
 };
 
-export const calculateLineItemTotalPrice = (lineItem: LineItem): number =>
-	lineItem.price?.value.centAmount * lineItem.quantity;
+export const calculateLineItemTotalPrice = (lineItem: LineItem): number => {
+	if (!lineItem.price?.value) {
+		return 0;
+	}
+
+	return calculateMoneyTotalCentAmount(lineItem.price.value, lineItem.quantity);
+};
 
 export const calculateCartTotalPrice = (cart: Cart): number => {
 	const lineItemsTotal = cart.lineItems.reduce(
@@ -83,8 +89,8 @@ export const createCustomLineItemFromDraft = (
 	}
 
 	const totalPrice = createCentPrecisionMoney({
-		...draft.money,
-		centAmount: (draft.money.centAmount ?? 0) * quantity,
+		currencyCode: draft.money.currencyCode,
+		centAmount: calculateMoneyTotalCentAmount(draft.money, quantity),
 	});
 
 	const taxedPrice = taxCategory

src/repositories/cart/index.ts

@@ -24,7 +24,12 @@ import {
 	AbstractResourceRepository,
 	type RepositoryContext,
 } from "../abstract.ts";
-import { createAddress, createCustomFields } from "../helpers.ts";
+import {
+	calculateMoneyTotalCentAmount,
+	createAddress,
+	createCentPrecisionMoney,
+	createCustomFields,
+} from "../helpers.ts";
 import { CartUpdateHandler } from "./actions.ts";
 import {
 	calculateCartTotalPrice,
@@ -238,6 +243,11 @@ export class CartRepository extends AbstractResourceRepository<"cart"> {
 			);
 		}
 
+		const totalPrice = createCentPrecisionMoney({
+			currencyCode: price.value.currencyCode,
+			centAmount: calculateMoneyTotalCentAmount(price.value, quant),
+		});
+
 		return {
 			id: uuidv4(),
 			productId: product.id,
@@ -247,12 +257,7 @@ export class CartRepository extends AbstractResourceRepository<"cart"> {
 			name: product.masterData.current.name,
 			variant,
 			price: price,
-			totalPrice: {
-				type: "centPrecision",
-				currencyCode: price.value.currencyCode,
-				fractionDigits: price.value.fractionDigits,
-				centAmount: price.value.centAmount * quant,
-			},
+			totalPrice,
 			taxedPricePortions: [],
 			perMethodTaxRate: [],
 			quantity: quant,

src/repositories/helpers.ts

@@ -28,6 +28,7 @@ import type {
 	StoreReference,
 	StoreResourceIdentifier,
 	Type,
+	TypedMoney,
 } from "@commercetools/platform-sdk";
 import { Decimal } from "decimal.js/decimal";
 import type { Request } from "express";
@@ -109,19 +110,17 @@ export const roundDecimal = (decimal: Decimal, roundingMode: RoundingMode) => {
 	}
 };
 
-export const createCentPrecisionMoney = (value: _Money): CentPrecisionMoney => {
+export const getCurrencyFractionDigits = (currencyCode: string): number => {
 	// Taken from https://docs.adyen.com/development-resources/currency-codes
-	let fractionDigits = 2;
-	switch (value.currencyCode.toUpperCase()) {
+	switch (currencyCode.toUpperCase()) {
 		case "BHD":
 		case "IQD":
 		case "JOD":
 		case "KWD":
 		case "LYD":
 		case "OMR":
 		case "TND":
-			fractionDigits = 3;
-			break;
+			return 3;
 		case "CVE":
 		case "DJF":
 		case "GNF":
@@ -137,29 +136,120 @@ export const createCentPrecisionMoney = (value: _Money): CentPrecisionMoney => {
 		case "XAF":
 		case "XOF":
 		case "XPF":
-			fractionDigits = 0;
-			break;
+			return 0;
 		default:
-			fractionDigits = 2;
+			return 2;
 	}
+};
+
+export const calculateCentAmountFromPreciseAmount = (
+	preciseAmount: number,
+	fractionDigits: number,
+	currencyCode: string,
+	roundingMode: RoundingMode = "HalfEven",
+): number => {
+	const centFractionDigits = getCurrencyFractionDigits(currencyCode);
+	const diff = fractionDigits - centFractionDigits;
+	const scale = new Decimal(10).pow(Math.abs(diff));
+	const decimal =
+		diff >= 0
+			? new Decimal(preciseAmount).div(scale)
+			: new Decimal(preciseAmount).mul(scale);
+
+	return roundDecimal(decimal, roundingMode).toNumber();
+};
 
-	if ((value as HighPrecisionMoney & HighPrecisionMoneyDraft).preciseAmount) {
-		throw new Error("HighPrecisionMoney not supported");
+export const createCentPrecisionMoney = (value: _Money): CentPrecisionMoney => {
+	const fractionDigits = getCurrencyFractionDigits(value.currencyCode);
+	const preciseValue = value as HighPrecisionMoney & HighPrecisionMoneyDraft;
+	let centAmount: number;
+
+	centAmount = value.centAmount ?? 0;
+
+	if (
+		preciseValue.preciseAmount !== undefined &&
+		preciseValue.fractionDigits !== undefined
+	) {
+		centAmount = calculateCentAmountFromPreciseAmount(
+			preciseValue.preciseAmount,
+			preciseValue.fractionDigits,
+			value.currencyCode,
+			"HalfEven",
+		);
 	}
 
 	return {
 		type: "centPrecision",
-		// centAmont is only optional on HighPrecisionMoney, so this should never
-		// fallback to 0
-		centAmount: value.centAmount ?? 0,
+		centAmount,
 		currencyCode: value.currencyCode,
-		fractionDigits: fractionDigits,
+		fractionDigits,
 	};
 };
 
-export const createTypedMoney = (value: _Money): CentPrecisionMoney => {
-	const result = createCentPrecisionMoney(value);
-	return result;
+export const createHighPrecisionMoney = (
+	value: HighPrecisionMoney | HighPrecisionMoneyDraft,
+): HighPrecisionMoney => {
+	if (value.preciseAmount === undefined) {
+		throw new Error("HighPrecisionMoney requires preciseAmount");
+	}
+
+	if (value.fractionDigits === undefined) {
+		throw new Error("HighPrecisionMoney requires fractionDigits");
+	}
+
+	const centAmount =
+		value.centAmount ??
+		calculateCentAmountFromPreciseAmount(
+			value.preciseAmount,
+			value.fractionDigits,
+			value.currencyCode,
+			"HalfEven",
+		);
+
+	return {
+		type: "highPrecision",
+		centAmount,
+		currencyCode: value.currencyCode,
+		fractionDigits: value.fractionDigits,
+		preciseAmount: value.preciseAmount,
+	};
+};
+
+export const createTypedMoney = (value: _Money): TypedMoney => {
+	const preciseValue = value as HighPrecisionMoney & HighPrecisionMoneyDraft;
+	if (
+		("type" in value && value.type === "highPrecision") ||
+		preciseValue.preciseAmount !== undefined
+	) {
+		return createHighPrecisionMoney(
+			value as HighPrecisionMoney | HighPrecisionMoneyDraft,
+		);
+	}
+
+	return createCentPrecisionMoney(value);
+};
+
+export const calculateMoneyTotalCentAmount = (
+	money: _Money,
+	quantity: number,
+	roundingMode: RoundingMode = "HalfEven",
+): number => {
+	const preciseValue = money as HighPrecisionMoney & HighPrecisionMoneyDraft;
+
+	if (
+		preciseValue.preciseAmount === undefined ||
+		preciseValue.fractionDigits === undefined
+	) {
+		return (money.centAmount ?? 0) * quantity;
+	}
+
+	const totalPrecise = new Decimal(preciseValue.preciseAmount).mul(quantity);
+	return calculateCentAmountFromPreciseAmount(
+		totalPrecise.toNumber(),
+		preciseValue.fractionDigits,
+		money.currencyCode,
+		roundingMode,
+	);
 };
 
 export const resolveStoreReference = (

src/repositories/order/index.ts

@@ -35,6 +35,7 @@ import type { Writable } from "#src/types.ts";
 import type { RepositoryContext } from "../abstract.ts";
 import { AbstractResourceRepository, type QueryParams } from "../abstract.ts";
 import {
+	calculateMoneyTotalCentAmount,
 	createAddress,
 	createCentPrecisionMoney,
 	createCustomFields,
@@ -260,8 +261,8 @@ export class OrderRepository extends AbstractResourceRepository<"order"> {
 
 		const quantity = draft.quantity ?? 1;
 		const totalPrice = createCentPrecisionMoney({
-			...draft.price.value,
-			centAmount: (draft.price.value.centAmount ?? 0) * quantity,
+			currencyCode: draft.price.value.currencyCode,
+			centAmount: calculateMoneyTotalCentAmount(draft.price.value, quantity),
 		});
 
 		const lineItem: LineItem = {
@@ -306,8 +307,8 @@ export class OrderRepository extends AbstractResourceRepository<"order"> {
 	): CustomLineItem {
 		const quantity = draft.quantity ?? 1;
 		const totalPrice = createCentPrecisionMoney({
-			...draft.money,
-			centAmount: (draft.money.centAmount ?? 0) * quantity,
+			currencyCode: draft.money.currencyCode,
+			centAmount: calculateMoneyTotalCentAmount(draft.money, quantity),
 		});
 
 		const lineItem: CustomLineItem = {

src/repositories/shipping-method/helpers.ts

@@ -2,12 +2,12 @@ import type {
 	ShippingRate,
 	ShippingRateDraft,
 } from "@commercetools/platform-sdk";
-import { createTypedMoney } from "../helpers.ts";
+import { createCentPrecisionMoney } from "../helpers.ts";
 
 export const transformShippingRate = (
 	rate: ShippingRateDraft,
 ): ShippingRate => ({
-	price: createTypedMoney(rate.price),
-	freeAbove: rate.freeAbove && createTypedMoney(rate.freeAbove),
+	price: createCentPrecisionMoney(rate.price),
+	freeAbove: rate.freeAbove && createCentPrecisionMoney(rate.freeAbove),
 	tiers: rate.tiers || [],
 });