@labdigital/commercetools-mock 2.59.0 → 2.59.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@labdigital/commercetools-mock",
-  "version": "2.59.0",
+  "version": "2.59.1",
   "license": "MIT",
   "author": "Michael van Tellingen",
   "type": "module",

package/src/repositories/cart/index.ts

@@ -23,19 +23,16 @@ import { v4 as uuidv4 } from "uuid";
 import type { Config } from "~src/config";
 import { CommercetoolsError } from "~src/exceptions";
 import { getBaseResourceProperties } from "~src/helpers";
-import { getShippingMethodsMatchingCart } from "~src/shipping";
+import {
+	createShippingInfoFromMethod,
+	getShippingMethodsMatchingCart,
+} from "~src/shipping";
 import type { Writable } from "~src/types";
 import {
 	AbstractResourceRepository,
 	type RepositoryContext,
 } from "../abstract";
-import {
-	createAddress,
-	createCentPrecisionMoney,
-	createCustomFields,
-	createTypedMoney,
-	roundDecimal,
-} from "../helpers";
+import { createAddress, createCustomFields } from "../helpers";
 import { CartUpdateHandler } from "./actions";
 import {
 	calculateCartTotalPrice,
@@ -284,15 +281,6 @@ export class CartRepository extends AbstractResourceRepository<"cart"> {
 			throw new Error("External tax rate is not supported");
 		}
 
-		const country = resource.shippingAddress?.country;
-
-		if (!country) {
-			throw new CommercetoolsError<InvalidOperationError>({
-				code: "InvalidOperation",
-				message: `The cart with ID '${resource.id}' does not have a shipping address set.`,
-			});
-		}
-
 		// Bit of a hack: calling this checks that the resource identifier is
 		// valid (i.e. id xor key) and that the shipping method exists.
 		this._storage.getByResourceIdentifier<"shipping-method">(
@@ -327,126 +315,12 @@ export class CartRepository extends AbstractResourceRepository<"cart"> {
 			});
 		}
 
-		const taxCategory = this._storage.getByResourceIdentifier<"tax-category">(
-			context.projectKey,
-			method.taxCategory,
-		);
-
-		// TODO: match state in addition to country
-		const taxRate = taxCategory.rates.find((rate) => rate.country === country);
-
-		if (!taxRate) {
-			throw new CommercetoolsError<MissingTaxRateForCountryError>({
-				code: "MissingTaxRateForCountry",
-				message: `Tax category '${taxCategory.id}' is missing a tax rate for country '${country}'.`,
-				taxCategoryId: taxCategory.id,
-			});
-		}
-
-		// There should only be one zone rate matching the address, since
-		// Locations cannot be assigned to more than one zone.
-		// See https://docs.commercetools.com/api/projects/zones#location
-		const zoneRate = method.zoneRates.find((rate) =>
-			rate.zone.obj?.locations.some((loc) => loc.country === country),
+		// Use the shared shipping info creation logic
+		return createShippingInfoFromMethod(
+			context,
+			this._storage,
+			resource,
+			method,
 		);
-
-		if (!zoneRate) {
-			// This shouldn't happen because getShippingMethodsMatchingCart already
-			// filtered out shipping methods without any zones matching the address
-			throw new Error("Zone rate not found");
-		}
-
-		// Shipping rates are defined by currency, and getShippingMethodsMatchingCart
-		// also matches on currency, so there should only be one in the array.
-		// See https://docs.commercetools.com/api/projects/shippingMethods#zonerate
-		const shippingRate = zoneRate.shippingRates[0];
-		if (!shippingRate) {
-			// This shouldn't happen because getShippingMethodsMatchingCart already
-			// filtered out shipping methods without any matching rates
-			throw new Error("Shipping rate not found");
-		}
-
-		const shippingRateTier = shippingRate.tiers.find((tier) => tier.isMatching);
-		if (shippingRateTier && shippingRateTier.type !== "CartValue") {
-			throw new Error("Non-CartValue shipping rate tier is not supported");
-		}
-
-		let shippingPrice = shippingRateTier
-			? createCentPrecisionMoney(shippingRateTier.price)
-			: shippingRate.price;
-
-		// Handle freeAbove: if cart total is above the freeAbove threshold, shipping is free
-		if (
-			shippingRate.freeAbove &&
-			shippingRate.freeAbove.currencyCode ===
-				resource.totalPrice.currencyCode &&
-			resource.totalPrice.centAmount >= shippingRate.freeAbove.centAmount
-		) {
-			shippingPrice = {
-				...shippingPrice,
-				centAmount: 0,
-			};
-		}
-
-		// Calculate tax amounts
-		const totalGross: CentPrecisionMoney = taxRate.includedInPrice
-			? shippingPrice
-			: {
-					...shippingPrice,
-					centAmount: roundDecimal(
-						new Decimal(shippingPrice.centAmount).mul(1 + taxRate.amount),
-						resource.taxRoundingMode,
-					).toNumber(),
-				};
-
-		const totalNet: CentPrecisionMoney = taxRate.includedInPrice
-			? {
-					...shippingPrice,
-					centAmount: roundDecimal(
-						new Decimal(shippingPrice.centAmount).div(1 + taxRate.amount),
-						resource.taxRoundingMode,
-					).toNumber(),
-				}
-			: shippingPrice;
-
-		const taxPortions: TaxPortion[] = [
-			{
-				name: taxRate.name,
-				rate: taxRate.amount,
-				amount: {
-					...shippingPrice,
-					centAmount: totalGross.centAmount - totalNet.centAmount,
-				},
-			},
-		];
-
-		const totalTax: CentPrecisionMoney = {
-			...shippingPrice,
-			centAmount: taxPortions.reduce(
-				(acc, portion) => acc + portion.amount.centAmount,
-				0,
-			),
-		};
-
-		const taxedPrice: TaxedItemPrice = {
-			totalNet,
-			totalGross,
-			taxPortions,
-			totalTax,
-		};
-
-		return {
-			shippingMethod: {
-				typeId: "shipping-method" as const,
-				id: method.id,
-			},
-			shippingMethodName: method.name,
-			price: shippingPrice,
-			shippingRate,
-			taxedPrice,
-			taxRate,
-			taxCategory: method.taxCategory,
-			shippingMethodState: "MatchesCart",
-		};
 	}
 }

package/src/repositories/order/index.test.ts

@@ -2,6 +2,7 @@ import { beforeEach } from "node:test";
 import type {
 	Cart,
 	LineItem,
+	Order,
 	OrderImportDraft,
 } from "@commercetools/platform-sdk";
 import { describe, expect, test } from "vitest";
@@ -187,6 +188,8 @@ describe("Order repository", () => {
 		expect(result.taxRoundingMode).toEqual(cart.taxRoundingMode);
 		expect(result.totalPrice).toEqual(cart.totalPrice);
 		expect(result.store).toEqual(cart.store);
+		// Test that shippingInfo is copied from cart to order
+		expect(result.shippingInfo).toEqual(cart.shippingInfo);
 	});
 
 	test("create order in store", async () => {
@@ -510,4 +513,308 @@ describe("Order repository", () => {
 	repository.import('dummy', draft)
   })
   */
+
+	describe("shippingInfo functionality", () => {
+		test("createShippingInfo creates basic shipping info", () => {
+			// Create a zone for Netherlands
+			const zone = {
+				...getBaseResourceProperties(),
+				id: "zone-nl",
+				name: "Netherlands Zone",
+				locations: [
+					{
+						country: "NL",
+					},
+				],
+			};
+
+			// Create a shipping method first
+			const shippingMethod = {
+				...getBaseResourceProperties(),
+				id: "shipping-method-123",
+				name: "Express Shipping",
+				active: true,
+				isDefault: false,
+				taxCategory: {
+					typeId: "tax-category" as const,
+					id: "tax-category-123",
+				},
+				zoneRates: [
+					{
+						zone: {
+							typeId: "zone" as const,
+							id: "zone-nl",
+							obj: zone,
+						},
+						shippingRates: [
+							{
+								price: {
+									type: "centPrecision" as const,
+									currencyCode: "EUR",
+									centAmount: 500,
+									fractionDigits: 2,
+								},
+								tiers: [],
+							},
+						],
+					},
+				],
+			};
+
+			const taxCategory = {
+				...getBaseResourceProperties(),
+				id: "tax-category-123",
+				name: "Standard Tax",
+				rates: [
+					{
+						name: "Standard VAT",
+						amount: 0.21,
+						country: "NL",
+						includedInPrice: true,
+					},
+				],
+			};
+
+			storage.add("dummy", "zone", zone);
+			storage.add("dummy", "shipping-method", shippingMethod);
+			storage.add("dummy", "tax-category", taxCategory);
+
+			const order: Order = {
+				...getBaseResourceProperties(),
+				orderNumber: "order-123",
+				orderState: "Open",
+				origin: "Customer",
+				customLineItems: [],
+				lineItems: [],
+				totalPrice: {
+					type: "centPrecision",
+					currencyCode: "EUR",
+					centAmount: 1000,
+					fractionDigits: 2,
+				},
+				lastMessageSequenceNumber: 0,
+				refusedGifts: [],
+				shipping: [],
+				shippingMode: "Single",
+				shippingAddress: {
+					id: "address-123",
+					country: "NL",
+					firstName: "John",
+					lastName: "Doe",
+					streetName: "Main Street",
+					streetNumber: "123",
+					postalCode: "1234AB",
+					city: "Amsterdam",
+				},
+				syncInfo: [],
+				taxCalculationMode: "UnitPriceLevel",
+				taxMode: "Platform",
+				taxRoundingMode: "HalfEven",
+			};
+
+			const ctx = { projectKey: "dummy" };
+			const result = repository.createShippingInfo(ctx, order, {
+				typeId: "shipping-method",
+				id: "shipping-method-123",
+			});
+
+			expect(result).toBeDefined();
+			expect(result.shippingMethod?.id).toBe("shipping-method-123");
+			expect(result.shippingMethodName).toBe("Express Shipping");
+			expect(result.price.currencyCode).toBe("EUR");
+			expect(result.price.centAmount).toBe(500);
+			expect(result.shippingMethodState).toBe("MatchesCart");
+			expect(result.deliveries).toEqual([]);
+			expect(result.taxCategory?.id).toBe("tax-category-123");
+		});
+
+		test("import order with shippingInfo", () => {
+			// Create required resources
+			const zone = {
+				...getBaseResourceProperties(),
+				id: "zone-de",
+				name: "Germany Zone",
+				locations: [
+					{
+						country: "DE",
+					},
+				],
+			};
+
+			const shippingMethod = {
+				...getBaseResourceProperties(),
+				id: "shipping-method-456",
+				name: "Standard Shipping",
+				active: true,
+				isDefault: false,
+				taxCategory: {
+					typeId: "tax-category" as const,
+					id: "tax-category-456",
+				},
+				zoneRates: [
+					{
+						zone: {
+							typeId: "zone" as const,
+							id: "zone-de",
+							obj: zone,
+						},
+						shippingRates: [
+							{
+								price: {
+									type: "centPrecision" as const,
+									currencyCode: "EUR",
+									centAmount: 500,
+									fractionDigits: 2,
+								},
+								tiers: [],
+							},
+						],
+					},
+				],
+			};
+
+			const taxCategory = {
+				...getBaseResourceProperties(),
+				id: "tax-category-456",
+				name: "Standard Tax",
+				rates: [
+					{
+						name: "Standard VAT",
+						amount: 0.19,
+						country: "DE",
+						includedInPrice: true,
+					},
+				],
+			};
+
+			storage.add("dummy", "zone", zone);
+			storage.add("dummy", "shipping-method", shippingMethod);
+			storage.add("dummy", "tax-category", taxCategory);
+
+			const draft: OrderImportDraft = {
+				orderNumber: "imported-order-123",
+				totalPrice: {
+					currencyCode: "EUR",
+					centAmount: 2000,
+				},
+				shippingAddress: {
+					country: "DE",
+					firstName: "Max",
+					lastName: "Mustermann",
+					streetName: "Hauptstraße",
+					streetNumber: "1",
+					postalCode: "10115",
+					city: "Berlin",
+				},
+				shippingInfo: {
+					shippingMethodName: "Standard Shipping",
+					price: {
+						currencyCode: "EUR",
+						centAmount: 500,
+					},
+					shippingRate: {
+						price: {
+							currencyCode: "EUR",
+							centAmount: 500,
+						},
+						tiers: [],
+					},
+					shippingMethod: {
+						typeId: "shipping-method",
+						id: "shipping-method-456",
+					},
+					taxCategory: {
+						typeId: "tax-category",
+						id: "tax-category-456",
+					},
+					taxRate: {
+						name: "Standard VAT",
+						amount: 0.19,
+						country: "DE",
+						includedInPrice: true,
+					},
+					shippingMethodState: "MatchesCart",
+					deliveries: [
+						{
+							key: "delivery-1",
+							items: [],
+							parcels: [
+								{
+									key: "parcel-1",
+									measurements: {
+										heightInMillimeter: 100,
+										lengthInMillimeter: 200,
+										widthInMillimeter: 150,
+										weightInGram: 500,
+									},
+									items: [],
+								},
+							],
+						},
+					],
+				},
+			};
+
+			const ctx = { projectKey: "dummy" };
+			const result = repository.import(ctx, draft);
+
+			expect(result.shippingInfo).toBeDefined();
+			expect(result.shippingInfo?.shippingMethodName).toBe("Standard Shipping");
+			expect(result.shippingInfo?.price.centAmount).toBe(500);
+			expect(result.shippingInfo?.shippingMethod?.id).toBe(
+				"shipping-method-456",
+			);
+			expect(result.shippingInfo?.taxCategory?.id).toBe("tax-category-456");
+			expect(result.shippingInfo?.taxRate?.amount).toBe(0.19);
+			// Note: deliveries from import drafts are not currently supported in native implementation
+			expect(result.shippingInfo?.deliveries).toEqual([]);
+		});
+
+		test("createShippingInfo throws error for non-existent shipping method", () => {
+			const order: Order = {
+				...getBaseResourceProperties(),
+				orderNumber: "order-456",
+				orderState: "Open",
+				origin: "Customer",
+				customLineItems: [],
+				lineItems: [],
+				totalPrice: {
+					type: "centPrecision",
+					currencyCode: "USD",
+					centAmount: 1500,
+					fractionDigits: 2,
+				},
+				lastMessageSequenceNumber: 0,
+				refusedGifts: [],
+				shipping: [],
+				shippingMode: "Single",
+				shippingAddress: {
+					id: "address-456",
+					country: "US",
+					firstName: "Jane",
+					lastName: "Smith",
+					streetName: "Broadway",
+					streetNumber: "456",
+					postalCode: "10001",
+					city: "New York",
+					state: "NY",
+				},
+				syncInfo: [],
+				taxCalculationMode: "UnitPriceLevel",
+				taxMode: "Platform",
+				taxRoundingMode: "HalfEven",
+			};
+
+			const ctx = { projectKey: "dummy" };
+
+			expect(() => {
+				repository.createShippingInfo(ctx, order, {
+					typeId: "shipping-method",
+					id: "non-existent-shipping-method",
+				});
+			}).toThrow(
+				/The shipping method with ID 'non-existent-shipping-method' is not allowed/,
+			);
+		});
+	});
 });

package/src/repositories/order/index.ts

@@ -2,21 +2,35 @@ import assert from "node:assert";
 import type {
 	Cart,
 	CartReference,
+	CentPrecisionMoney,
 	CustomLineItem,
 	CustomLineItemImportDraft,
 	GeneralError,
+	InvalidOperationError,
 	LineItem,
 	LineItemImportDraft,
+	MissingTaxRateForCountryError,
 	Order,
 	OrderFromCartDraft,
 	OrderImportDraft,
 	Product,
 	ProductPagedQueryResponse,
 	ProductVariant,
+	ShippingInfo,
+	ShippingMethodDoesNotMatchCartError,
+	ShippingMethodReference,
+	TaxPortion,
+	TaxedItemPrice,
 } from "@commercetools/platform-sdk";
+import { Decimal } from "decimal.js/decimal";
 import type { Config } from "~src/config";
 import { CommercetoolsError } from "~src/exceptions";
 import { generateRandomString, getBaseResourceProperties } from "~src/helpers";
+import {
+	createShippingInfoFromMethod,
+	getShippingMethodsMatchingCart,
+} from "~src/shipping";
+import type { Writable } from "~src/types";
 import type { RepositoryContext } from "../abstract";
 import { AbstractResourceRepository, type QueryParams } from "../abstract";
 import {
@@ -26,6 +40,7 @@ import {
 	createPrice,
 	createTypedMoney,
 	resolveStoreReference,
+	roundDecimal,
 } from "../helpers";
 import { OrderUpdateHandler } from "./actions";
 
@@ -84,6 +99,7 @@ export class OrderRepository extends AbstractResourceRepository<"order"> {
 			refusedGifts: [],
 			shipping: cart.shipping,
 			shippingAddress: cart.shippingAddress,
+			shippingInfo: cart.shippingInfo,
 			shippingMode: cart.shippingMode,
 			syncInfo: [],
 			taxCalculationMode: cart.taxCalculationMode,
@@ -100,7 +116,7 @@ export class OrderRepository extends AbstractResourceRepository<"order"> {
 	import(context: RepositoryContext, draft: OrderImportDraft): Order {
 		// TODO: Check if order with given orderNumber already exists
 		assert(this, "OrderRepository not valid");
-		const resource: Order = {
+		const resource: Writable<Order> = {
 			...getBaseResourceProperties(),
 
 			billingAddress: createAddress(
@@ -132,7 +148,7 @@ export class OrderRepository extends AbstractResourceRepository<"order"> {
 			refusedGifts: [],
 			shippingMode: "Single",
 			shipping: [],
-
+			shippingInfo: undefined,
 			store: resolveStoreReference(
 				draft.store,
 				context.projectKey,
@@ -151,6 +167,33 @@ export class OrderRepository extends AbstractResourceRepository<"order"> {
 
 			totalPrice: createCentPrecisionMoney(draft.totalPrice),
 		};
+
+		// Set shipping info after resource is created
+		if (draft.shippingInfo?.shippingMethod) {
+			const { ...shippingMethodRef } = draft.shippingInfo.shippingMethod;
+
+			// get id when reference is by key only
+			if (shippingMethodRef.key && !shippingMethodRef.id) {
+				const shippingMethod =
+					this._storage.getByResourceIdentifier<"shipping-method">(
+						context.projectKey,
+						shippingMethodRef,
+					);
+				if (!shippingMethod) {
+					throw new CommercetoolsError<GeneralError>({
+						code: "General",
+						message: `A shipping method with key '${shippingMethodRef.key}' does not exist.`,
+					});
+				}
+				shippingMethodRef.id = shippingMethod.id;
+			}
+
+			resource.shippingInfo = this.createShippingInfo(context, resource, {
+				typeId: "shipping-method",
+				id: shippingMethodRef.id as string,
+			});
+		}
+
 		return this.saveNew(context, resource);
 	}
 
@@ -272,4 +315,56 @@ export class OrderRepository extends AbstractResourceRepository<"order"> {
 
 		return;
 	}
+
+	createShippingInfo(
+		context: RepositoryContext,
+		resource: Writable<Order>,
+		shippingMethodRef: ShippingMethodReference,
+	): ShippingInfo {
+		const cartLikeForMatching: Writable<Cart> = {
+			...resource,
+			cartState: "Active" as const,
+			inventoryMode: "None" as const,
+			itemShippingAddresses: [],
+			priceRoundingMode: resource.taxRoundingMode || "HalfEven",
+			taxMode: resource.taxMode || "Platform",
+			taxCalculationMode: resource.taxCalculationMode || "LineItemLevel",
+			taxRoundingMode: resource.taxRoundingMode || "HalfEven",
+			discountCodes: resource.discountCodes || [],
+			directDiscounts: resource.directDiscounts || [],
+			shippingInfo: undefined,
+		};
+
+		const shippingMethods = getShippingMethodsMatchingCart(
+			context,
+			this._storage,
+			cartLikeForMatching,
+			{
+				expand: ["zoneRates[*].zone"],
+			},
+		);
+
+		const method = shippingMethods.results.find(
+			(candidate) => candidate.id === shippingMethodRef.id,
+		);
+
+		if (!method) {
+			throw new CommercetoolsError<ShippingMethodDoesNotMatchCartError>({
+				code: "ShippingMethodDoesNotMatchCart",
+				message: `The shipping method with ID '${shippingMethodRef.id}' is not allowed for the order with ID '${resource.id}'.`,
+			});
+		}
+
+		const baseShippingInfo = createShippingInfoFromMethod(
+			context,
+			this._storage,
+			resource,
+			method,
+		);
+
+		return {
+			...baseShippingInfo,
+			deliveries: [],
+		};
+	}
 }