@labdigital/commercetools-mock 2.17.0 → 2.18.0

package/src/repositories/cart/actions.ts

@@ -0,0 +1,489 @@
+import {
+	CartUpdateAction,
+	type Address,
+	type AddressDraft,
+	type Cart,
+	type CartAddItemShippingAddressAction,
+	type CartAddLineItemAction,
+	type CartChangeLineItemQuantityAction,
+	type CartRemoveDiscountCodeAction,
+	type CartRemoveLineItemAction,
+	type CartSetBillingAddressAction,
+	type CartSetCountryAction,
+	type CartSetCustomFieldAction,
+	type CartSetCustomShippingMethodAction,
+	type CartSetCustomTypeAction,
+	type CartSetCustomerEmailAction,
+	type CartSetDirectDiscountsAction,
+	type CartSetLineItemShippingDetailsAction,
+	type CartSetLocaleAction,
+	type CartSetShippingAddressAction,
+	type CartSetShippingMethodAction,
+	type CustomFields,
+	type GeneralError,
+	type ItemShippingDetails,
+	type LineItem,
+	type Product,
+	type ProductPagedQueryResponse,
+	type ProductVariant,
+} from "@commercetools/platform-sdk";
+import { v4 as uuidv4 } from "uuid";
+import { CommercetoolsError } from "~src/exceptions";
+import type { Writable } from "~src/types";
+import {
+	AbstractUpdateHandler,
+	UpdateHandlerInterface,
+	type RepositoryContext,
+} from "../abstract";
+import {
+	createAddress,
+	createCentPrecisionMoney,
+	createCustomFields,
+	createTypedMoney,
+} from "../helpers";
+import {
+	calculateCartTotalPrice,
+	calculateLineItemTotalPrice,
+	selectPrice,
+} from "./helpers";
+
+export class CartUpdateHandler
+	extends AbstractUpdateHandler
+	implements Partial<UpdateHandlerInterface<Cart, CartUpdateAction>>
+{
+	addItemShippingAddress(
+		context: RepositoryContext,
+		resource: Writable<Cart>,
+		{ action, address }: CartAddItemShippingAddressAction,
+	) {
+		const newAddress = createAddress(
+			address,
+			context.projectKey,
+			this._storage,
+		);
+		if (newAddress) {
+			resource.itemShippingAddresses.push(newAddress);
+		}
+	}
+
+	addLineItem(
+		context: RepositoryContext,
+		resource: Writable<Cart>,
+		{ productId, variantId, sku, quantity = 1 }: CartAddLineItemAction,
+	) {
+		let product: Product | null = null;
+
+		if (productId && variantId) {
+			// Fetch product and variant by ID
+			product = this._storage.get(context.projectKey, "product", productId, {});
+		} else if (sku) {
+			// Fetch product and variant by SKU
+			const items = this._storage.query(context.projectKey, "product", {
+				where: [
+					`masterData(current(masterVariant(sku="${sku}"))) or masterData(current(variants(sku="${sku}")))`,
+				],
+			}) as ProductPagedQueryResponse;
+
+			if (items.count === 1) {
+				product = items.results[0];
+			}
+		}
+
+		if (!product) {
+			// Check if product is found
+			throw new CommercetoolsError<GeneralError>({
+				code: "General",
+				message: sku
+					? `A product containing a variant with SKU '${sku}' not found.`
+					: `A product with ID '${productId}' not found.`,
+			});
+		}
+
+		// Find matching variant
+		const variant: ProductVariant | undefined = [
+			product.masterData.current.masterVariant,
+			...product.masterData.current.variants,
+		].find((x) => {
+			if (sku) return x.sku === sku;
+			if (variantId) return x.id === variantId;
+			return false;
+		});
+
+		if (!variant) {
+			// Check if variant is found
+			throw new CommercetoolsError<GeneralError>({
+				code: "General",
+				message: sku
+					? `A variant with SKU '${sku}' for product '${product.id}' not found.`
+					: `A variant with ID '${variantId}' for product '${product.id}' not found.`,
+			});
+		}
+
+		const alreadyAdded = resource.lineItems.some(
+			(x) => x.productId === product?.id && x.variant.id === variant?.id,
+		);
+		if (alreadyAdded) {
+			// increase quantity and update total price
+			resource.lineItems.forEach((x) => {
+				if (x.productId === product?.id && x.variant.id === variant?.id) {
+					x.quantity += quantity;
+					x.totalPrice.centAmount = calculateLineItemTotalPrice(x);
+				}
+			});
+		} else {
+			// add line item
+			if (!variant.prices?.length) {
+				throw new CommercetoolsError<GeneralError>({
+					code: "General",
+					message: `A product with ID '${productId}' doesn't have any prices.`,
+				});
+			}
+
+			const currency = resource.totalPrice.currencyCode;
+
+			const price = selectPrice({
+				prices: variant.prices,
+				currency,
+				country: resource.country,
+			});
+			if (!price) {
+				throw new Error(
+					`No valid price found for ${productId} for country ${resource.country} and currency ${currency}`,
+				);
+			}
+			resource.lineItems.push({
+				id: uuidv4(),
+				productId: product.id,
+				productKey: product.key,
+				productSlug: product.masterData.current.slug,
+				productType: product.productType,
+				name: product.masterData.current.name,
+				variant,
+				price: price,
+				taxedPricePortions: [],
+				perMethodTaxRate: [],
+				totalPrice: {
+					...price.value,
+					type: "centPrecision",
+					centAmount: price.value.centAmount * quantity,
+				},
+				quantity,
+				discountedPricePerQuantity: [],
+				lineItemMode: "Standard",
+				priceMode: "Platform",
+				state: [],
+			});
+		}
+
+		// Update cart total price
+		resource.totalPrice.centAmount = calculateCartTotalPrice(resource);
+	}
+
+	changeLineItemQuantity(
+		context: RepositoryContext,
+		resource: Writable<Cart>,
+		{ lineItemId, lineItemKey, quantity }: CartChangeLineItemQuantityAction,
+	) {
+		let lineItem: Writable<LineItem> | undefined;
+
+		if (lineItemId) {
+			lineItem = resource.lineItems.find((x) => x.id === lineItemId);
+			if (!lineItem) {
+				throw new CommercetoolsError<GeneralError>({
+					code: "General",
+					message: `A line item with ID '${lineItemId}' not found.`,
+				});
+			}
+		} else if (lineItemKey) {
+			lineItem = resource.lineItems.find((x) => x.id === lineItemId);
+			if (!lineItem) {
+				throw new CommercetoolsError<GeneralError>({
+					code: "General",
+					message: `A line item with Key '${lineItemKey}' not found.`,
+				});
+			}
+		} else {
+			throw new CommercetoolsError<GeneralError>({
+				code: "General",
+				message: `Either lineItemid or lineItemKey needs to be provided.`,
+			});
+		}
+
+		if (quantity === 0) {
+			// delete line item
+			resource.lineItems = resource.lineItems.filter(
+				(x) => x.id !== lineItemId,
+			);
+		} else {
+			resource.lineItems.forEach((x) => {
+				if (x.id === lineItemId && quantity) {
+					x.quantity = quantity;
+					x.totalPrice.centAmount = calculateLineItemTotalPrice(x);
+				}
+			});
+		}
+
+		// Update cart total price
+		resource.totalPrice.centAmount = calculateCartTotalPrice(resource);
+	}
+
+	recalculate() {
+		// Dummy action when triggering a recalculation of the cart
+		//
+		// From commercetools documentation:
+		// This update action does not set any Cart field in particular,
+		// but it triggers several Cart updates to bring prices and discounts to the latest state.
+		// Those can become stale over time when no Cart updates have been performed for a while
+		// and prices on related Products have changed in the meanwhile.
+	}
+
+	removeDiscountCode(
+		context: RepositoryContext,
+		resource: Writable<Cart>,
+		{ discountCode }: CartRemoveDiscountCodeAction,
+	) {
+		resource.discountCodes = resource.discountCodes.filter(
+			(code) => code.discountCode.id !== discountCode.id,
+		);
+	}
+
+	removeLineItem(
+		context: RepositoryContext,
+		resource: Writable<Cart>,
+		{ lineItemId, quantity }: CartRemoveLineItemAction,
+	) {
+		const lineItem = resource.lineItems.find((x) => x.id === lineItemId);
+		if (!lineItem) {
+			// Check if product is found
+			throw new CommercetoolsError<GeneralError>({
+				code: "General",
+				message: `A line item with ID '${lineItemId}' not found.`,
+			});
+		}
+
+		const shouldDelete = !quantity || quantity >= lineItem.quantity;
+		if (shouldDelete) {
+			// delete line item
+			resource.lineItems = resource.lineItems.filter(
+				(x) => x.id !== lineItemId,
+			);
+		} else {
+			// decrease quantity and update total price
+			resource.lineItems.forEach((x) => {
+				if (x.id === lineItemId && quantity) {
+					x.quantity -= quantity;
+					x.totalPrice.centAmount = calculateLineItemTotalPrice(x);
+				}
+			});
+		}
+
+		// Update cart total price
+		resource.totalPrice.centAmount = calculateCartTotalPrice(resource);
+	}
+
+	setBillingAddress(
+		context: RepositoryContext,
+		resource: Writable<Cart>,
+		{ address }: CartSetBillingAddressAction,
+	) {
+		resource.billingAddress = createAddress(
+			address,
+			context.projectKey,
+			this._storage,
+		);
+	}
+
+	setCountry(
+		context: RepositoryContext,
+		resource: Writable<Cart>,
+		{ country }: CartSetCountryAction,
+	) {
+		resource.country = country;
+	}
+
+	setCustomerEmail(
+		context: RepositoryContext,
+		resource: Writable<Cart>,
+		{ email }: CartSetCustomerEmailAction,
+	) {
+		resource.customerEmail = email;
+	}
+
+	setCustomField(
+		context: RepositoryContext,
+		resource: Cart,
+		{ name, value }: CartSetCustomFieldAction,
+	) {
+		if (!resource.custom) {
+			throw new Error("Resource has no custom field");
+		}
+		resource.custom.fields[name] = value;
+	}
+
+	setCustomShippingMethod(
+		context: RepositoryContext,
+		resource: Writable<Cart>,
+		{
+			shippingMethodName,
+			shippingRate,
+			taxCategory,
+			externalTaxRate,
+		}: CartSetCustomShippingMethodAction,
+	) {
+		if (externalTaxRate) {
+			throw new Error("External tax rate is not supported");
+		}
+
+		const tax = taxCategory
+			? this._storage.getByResourceIdentifier<"tax-category">(
+					context.projectKey,
+					taxCategory,
+				)
+			: undefined;
+
+		resource.shippingInfo = {
+			shippingMethodName,
+			price: createCentPrecisionMoney(shippingRate.price),
+			shippingRate: {
+				price: createTypedMoney(shippingRate.price),
+				tiers: [],
+			},
+			taxCategory: tax
+				? {
+						typeId: "tax-category",
+						id: tax?.id,
+					}
+				: undefined,
+			shippingMethodState: "MatchesCart",
+		};
+	}
+
+	setCustomType(
+		context: RepositoryContext,
+		resource: Writable<Cart>,
+		{ type, fields }: CartSetCustomTypeAction,
+	) {
+		if (!type) {
+			resource.custom = undefined;
+		} else {
+			const resolvedType = this._storage.getByResourceIdentifier(
+				context.projectKey,
+				type,
+			);
+			if (!resolvedType) {
+				throw new Error(`Type ${type} not found`);
+			}
+
+			resource.custom = {
+				type: {
+					typeId: "type",
+					id: resolvedType.id,
+				},
+				fields: fields || {},
+			};
+		}
+	}
+
+	setDirectDiscounts(
+		context: RepositoryContext,
+		resource: Writable<Cart>,
+		{ discounts }: CartSetDirectDiscountsAction,
+	) {
+		// Doesn't apply any discounts logic, just sets the directDiscounts field
+		resource.directDiscounts = discounts.map((discount) => ({
+			...discount,
+			id: uuidv4(),
+		}));
+	}
+
+	setLineItemShippingDetails(
+		context: RepositoryContext,
+		resource: Writable<Cart>,
+		{
+			action,
+			shippingDetails,
+			lineItemId,
+			lineItemKey,
+		}: CartSetLineItemShippingDetailsAction,
+	) {
+		const lineItem = resource.lineItems.find(
+			(x) =>
+				(lineItemId && x.id === lineItemId) ||
+				(lineItemKey && x.key === lineItemKey),
+		);
+
+		if (!lineItem) {
+			// Check if line item is found
+			throw new CommercetoolsError<GeneralError>({
+				code: "General",
+				message: lineItemKey
+					? `A line item with key '${lineItemKey}' not found.`
+					: `A line item with ID '${lineItemId}' not found.`,
+			});
+		}
+
+		lineItem.shippingDetails = {
+			...shippingDetails,
+			valid: true,
+		} as ItemShippingDetails;
+	}
+
+	setLocale(
+		context: RepositoryContext,
+		resource: Writable<Cart>,
+		{ locale }: CartSetLocaleAction,
+	) {
+		resource.locale = locale;
+	}
+
+	setShippingAddress(
+		context: RepositoryContext,
+		resource: Writable<Cart>,
+		{ address }: CartSetShippingAddressAction,
+	) {
+		if (!address) {
+			resource.shippingAddress = undefined;
+			return;
+		}
+
+		let custom: CustomFields | undefined = undefined;
+		if ((address as Address & AddressDraft).custom) {
+			custom = createCustomFields(
+				(address as Address & AddressDraft).custom,
+				context.projectKey,
+				this._storage,
+			);
+		}
+
+		resource.shippingAddress = {
+			...address,
+			custom: custom,
+		};
+	}
+
+	setShippingMethod(
+		context: RepositoryContext,
+		resource: Writable<Cart>,
+		{ shippingMethod }: CartSetShippingMethodAction,
+	) {
+		if (shippingMethod) {
+			const method = this._storage.getByResourceIdentifier<"shipping-method">(
+				context.projectKey,
+				shippingMethod,
+			);
+
+			// Based on the address we should select a shipping zone and
+			// use that to define the price.
+			// @ts-ignore
+			resource.shippingInfo = {
+				shippingMethod: {
+					typeId: "shipping-method",
+					id: method.id,
+				},
+				shippingMethodName: method.name,
+			};
+		} else {
+			resource.shippingInfo = undefined;
+		}
+	}
+}

package/src/repositories/cart/helpers.ts

@@ -0,0 +1,30 @@
+import { Cart, LineItem, Price } from "@commercetools/platform-sdk";
+
+export const selectPrice = ({
+	prices,
+	currency,
+	country,
+}: {
+	prices: Price[] | undefined;
+	currency: string;
+	country: string | undefined;
+}): Price | undefined => {
+	if (!prices) {
+		return undefined;
+	}
+
+	// Quick-and-dirty way of selecting price based on the given currency and country.
+	// Can be improved later to give more priority to exact matches over
+	// 'all country' matches, and include customer groups in the mix as well
+	return prices.find((price) => {
+		const countryMatch = !price.country || price.country === country;
+		const currencyMatch = price.value.currencyCode === currency;
+		return countryMatch && currencyMatch;
+	});
+};
+
+export const calculateLineItemTotalPrice = (lineItem: LineItem): number =>
+	lineItem.price!.value.centAmount * lineItem.quantity;
+
+export const calculateCartTotalPrice = (cart: Cart): number =>
+	cart.lineItems.reduce((cur, item) => cur + item.totalPrice.centAmount, 0);

package/src/repositories/cart/index.ts

@@ -0,0 +1,180 @@
+import {
+	type Cart,
+	type CartDraft,
+	type GeneralError,
+	type LineItem,
+	type LineItemDraft,
+	type Product,
+	type ProductPagedQueryResponse,
+} from "@commercetools/platform-sdk";
+import { v4 as uuidv4 } from "uuid";
+import { CommercetoolsError } from "~src/exceptions";
+import { getBaseResourceProperties } from "~src/helpers";
+import { AbstractStorage } from "~src/storage/abstract";
+import type { Writable } from "~src/types";
+import {
+	AbstractResourceRepository,
+	type RepositoryContext,
+} from "../abstract";
+import { createAddress, createCustomFields } from "../helpers";
+import { CartUpdateHandler } from "./actions";
+import { calculateCartTotalPrice, selectPrice } from "./helpers";
+
+export class CartRepository extends AbstractResourceRepository<"cart"> {
+	constructor(storage: AbstractStorage) {
+		super("cart", storage);
+		this.actions = new CartUpdateHandler(this._storage);
+	}
+
+	create(context: RepositoryContext, draft: CartDraft): Cart {
+		const lineItems =
+			draft.lineItems?.map((draftLineItem) =>
+				this.draftLineItemtoLineItem(
+					context.projectKey,
+					draftLineItem,
+					draft.currency,
+					draft.country,
+				),
+			) ?? [];
+
+		const resource: Writable<Cart> = {
+			...getBaseResourceProperties(),
+			cartState: "Active",
+			country: draft.country,
+			customLineItems: [],
+			directDiscounts: [],
+			discountCodes: [],
+			inventoryMode: "None",
+			itemShippingAddresses: [],
+			lineItems,
+			locale: draft.locale,
+			taxCalculationMode: draft.taxCalculationMode ?? "LineItemLevel",
+			taxMode: draft.taxMode ?? "Platform",
+			taxRoundingMode: draft.taxRoundingMode ?? "HalfEven",
+			totalPrice: {
+				type: "centPrecision",
+				centAmount: 0,
+				currencyCode: draft.currency,
+				fractionDigits: 0,
+			},
+			shippingMode: "Single",
+			shippingAddress: createAddress(
+				draft.shippingAddress,
+				context.projectKey,
+				this._storage,
+			),
+			shipping: [],
+			origin: draft.origin ?? "Customer",
+			refusedGifts: [],
+			custom: createCustomFields(
+				draft.custom,
+				context.projectKey,
+				this._storage,
+			),
+		};
+		resource.totalPrice.centAmount = calculateCartTotalPrice(resource);
+
+		return this.saveNew(context, resource);
+	}
+
+	getActiveCart(projectKey: string): Cart | undefined {
+		// Get first active cart
+		const results = this._storage.query(projectKey, this.getTypeId(), {
+			where: [`cartState="Active"`],
+		});
+		if (results.count > 0) {
+			return results.results[0] as Cart;
+		}
+
+		return;
+	}
+
+	draftLineItemtoLineItem = (
+		projectKey: string,
+		draftLineItem: LineItemDraft,
+		currency: string,
+		country: string | undefined,
+	): LineItem => {
+		const { productId, quantity, variantId, sku } = draftLineItem;
+
+		let product: Product | null = null;
+
+		if (productId && variantId) {
+			// Fetch product and variant by ID
+			product = this._storage.get(projectKey, "product", productId, {});
+		} else if (sku) {
+			// Fetch product and variant by SKU
+			const items = this._storage.query(projectKey, "product", {
+				where: [
+					`masterData(current(masterVariant(sku="${sku}"))) or masterData(current(variants(sku="${sku}")))`,
+				],
+			}) as ProductPagedQueryResponse;
+
+			if (items.count === 1) {
+				product = items.results[0];
+			}
+		}
+
+		if (!product) {
+			// Check if product is found
+			throw new CommercetoolsError<GeneralError>({
+				code: "General",
+				message: sku
+					? `A product containing a variant with SKU '${sku}' not found.`
+					: `A product with ID '${productId}' not found.`,
+			});
+		}
+
+		// Find matching variant
+		const variant = [
+			product.masterData.current.masterVariant,
+			...product.masterData.current.variants,
+		].find((x) => {
+			if (sku) return x.sku === sku;
+			if (variantId) return x.id === variantId;
+			return false;
+		});
+
+		if (!variant) {
+			// Check if variant is found
+			throw new Error(
+				sku
+					? `A variant with SKU '${sku}' for product '${product.id}' not found.`
+					: `A variant with ID '${variantId}' for product '${product.id}' not found.`,
+			);
+		}
+
+		const quant = quantity ?? 1;
+
+		const price = selectPrice({ prices: variant.prices, currency, country });
+		if (!price) {
+			throw new Error(
+				`No valid price found for ${productId} for country ${country} and currency ${currency}`,
+			);
+		}
+
+		return {
+			id: uuidv4(),
+			productId: product.id,
+			productKey: product.key,
+			productSlug: product.masterData.current.slug,
+			productType: product.productType,
+			name: product.masterData.current.name,
+			variant,
+			price: price,
+			totalPrice: {
+				type: "centPrecision",
+				currencyCode: price.value.currencyCode,
+				fractionDigits: price.value.fractionDigits,
+				centAmount: price.value.centAmount * quant,
+			},
+			taxedPricePortions: [],
+			perMethodTaxRate: [],
+			quantity: quant,
+			discountedPricePerQuantity: [],
+			lineItemMode: "Standard",
+			priceMode: "Platform",
+			state: [],
+		};
+	};
+}