@labdigital/commercetools-mock 2.65.1 → 3.0.0-beta.0

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

@@ -1,4 +1,5 @@
 import type { CartDraft, LineItem } from "@commercetools/platform-sdk";
+import type { CartAddDiscountCodeAction } from "@commercetools/platform-sdk/dist/declarations/src/generated/models/cart";
 import { beforeEach, describe, expect, test } from "vitest";
 import type { Config } from "#src/config.ts";
 import { getBaseResourceProperties } from "#src/helpers.ts";
@@ -20,7 +21,7 @@ describe("Cart repository", () => {
 	});
 
 	test("create cart in store", async () => {
-		storage.add("dummy", "product", {
+		await storage.add("dummy", "product", {
 			createdAt: "",
 			lastModifiedAt: "",
 			productType: {
@@ -83,7 +84,7 @@ describe("Cart repository", () => {
 			},
 		});
 
-		storage.add("dummy", "tax-category", {
+		await storage.add("dummy", "tax-category", {
 			...getBaseResourceProperties(),
 			id: "tax-category-id",
 			key: "standard-tax",
@@ -99,7 +100,7 @@ describe("Cart repository", () => {
 			],
 		});
 
-		storage.add("dummy", "zone", {
+		await storage.add("dummy", "zone", {
 			...getBaseResourceProperties(),
 			id: "nl-zone-id",
 			key: "nl-zone",
@@ -111,7 +112,7 @@ describe("Cart repository", () => {
 			],
 		});
 
-		storage.add("dummy", "shipping-method", {
+		await storage.add("dummy", "shipping-method", {
 			...getBaseResourceProperties(),
 			id: "shipping-method-id",
 			key: "standard-shipping",
@@ -239,10 +240,10 @@ describe("Cart repository", () => {
 
 		const ctx = { projectKey: "dummy", storeKey: "dummyStore" };
 
-		const result = repository.create(ctx, cart);
+		const result = await repository.create(ctx, cart);
 		expect(result.id).toBeDefined();
 
-		const items = repository.query(ctx);
+		const items = await repository.query(ctx);
 		expect(items.count).toBe(1);
 
 		expect(result.anonymousId).toEqual(cart.anonymousId);
@@ -281,18 +282,18 @@ describe("Cart repository", () => {
 		expect(result.shippingInfo?.taxRate?.name).toBe("Standard VAT");
 	});
 
-	test("create start with store from draft", () => {
+	test("create start with store from draft", async () => {
 		const ctx = { projectKey: "dummy" };
 		const draft: CartDraft = {
 			currency: "USD",
 			store: { key: "draftStore", typeId: "store" },
 		};
-		const result = repository.create(ctx, draft);
+		const result = await repository.create(ctx, draft);
 		expect(result.store).toEqual({ typeId: "store", key: "draftStore" });
 	});
 
 	test("create cart with business unit", async () => {
-		storage.add("dummy", "business-unit", {
+		await storage.add("dummy", "business-unit", {
 			...getBaseResourceProperties(),
 			unitType: "Company",
 			key: "business-unit-key",
@@ -307,6 +308,8 @@ describe("Cart repository", () => {
 				key: "business-unit-key",
 			},
 			approvalRuleMode: "Explicit",
+			shippingAddressIds: [],
+			billingAddressIds: [],
 		});
 
 		const cart: CartDraft = {
@@ -320,7 +323,7 @@ describe("Cart repository", () => {
 
 		const ctx = { projectKey: "dummy", storeKey: "dummyStore" };
 
-		const result = repository.create(ctx, cart);
+		const result = await repository.create(ctx, cart);
 		expect(result.id).toBeDefined();
 
 		expect(result.businessUnit).toEqual({
@@ -329,8 +332,8 @@ describe("Cart repository", () => {
 		});
 	});
 
-	test("should calculate taxed price for custom line items with tax category", () => {
-		storage.add("dummy", "tax-category", {
+	test("should calculate taxed price for custom line items with tax category", async () => {
+		await storage.add("dummy", "tax-category", {
 			...getBaseResourceProperties(),
 			id: "tax-category-with-rate",
 			key: "vat-tax",
@@ -367,7 +370,7 @@ describe("Cart repository", () => {
 		};
 
 		const ctx = { projectKey: "dummy", storeKey: "dummyStore" };
-		const result = repository.create(ctx, cart);
+		const result = await repository.create(ctx, cart);
 
 		expect(result.customLineItems).toHaveLength(1);
 		const customLineItem = result.customLineItems[0];
@@ -385,8 +388,8 @@ describe("Cart repository", () => {
 		expect(customLineItem.taxRate?.country).toBe("NL");
 	});
 
-	test("should calculate taxed price for the cart", () => {
-		storage.add("dummy", "tax-category", {
+	test("should calculate taxed price for the cart", async () => {
+		await storage.add("dummy", "tax-category", {
 			...getBaseResourceProperties(),
 			id: "cart-tax-category",
 			key: "cart-vat-tax",
@@ -423,7 +426,7 @@ describe("Cart repository", () => {
 		};
 
 		const ctx = { projectKey: "dummy", storeKey: "dummyStore" };
-		const result = repository.create(ctx, cart);
+		const result = await repository.create(ctx, cart);
 
 		expect(result.taxedPrice).toBeDefined();
 		expect(result.taxedPrice?.totalNet.centAmount).toBe(1000);
@@ -439,8 +442,8 @@ describe("createShippingInfo", () => {
 	const config: Config = { storage, strict: false };
 	const repository = new CartRepository(config);
 
-	beforeEach(() => {
-		storage.add("dummy", "tax-category", {
+	beforeEach(async () => {
+		await storage.add("dummy", "tax-category", {
 			...getBaseResourceProperties(),
 			id: "shipping-tax-category-id",
 			key: "shipping-tax",
@@ -456,7 +459,7 @@ describe("createShippingInfo", () => {
 			],
 		});
 
-		storage.add("dummy", "zone", {
+		await storage.add("dummy", "zone", {
 			...getBaseResourceProperties(),
 			id: "test-zone-id",
 			name: "Test Zone",
@@ -468,8 +471,8 @@ describe("createShippingInfo", () => {
 		});
 	});
 
-	test("should calculate shipping info", () => {
-		storage.add("dummy", "shipping-method", {
+	test("should calculate shipping info", async () => {
+		await storage.add("dummy", "shipping-method", {
 			...getBaseResourceProperties(),
 			id: "basic-shipping-id",
 			name: "Standard Shipping",
@@ -533,7 +536,7 @@ describe("createShippingInfo", () => {
 			id: "basic-shipping-id",
 		};
 
-		const result = repository.createShippingInfo(
+		const result = await repository.createShippingInfo(
 			context,
 			cart,
 			shippingMethodRef,
@@ -547,8 +550,8 @@ describe("createShippingInfo", () => {
 		expect(result.taxedPrice!.totalGross.centAmount).toBe(720);
 	});
 
-	test("should apply free shipping when cart total is above freeAbove threshold", () => {
-		storage.add("dummy", "shipping-method", {
+	test("should apply free shipping when cart total is above freeAbove threshold", async () => {
+		await storage.add("dummy", "shipping-method", {
 			...getBaseResourceProperties(),
 			id: "free-above-shipping-id",
 			key: "free-above-shipping",
@@ -620,7 +623,7 @@ describe("createShippingInfo", () => {
 			id: "free-above-shipping-id",
 		};
 
-		const result = repository.createShippingInfo(
+		const result = await repository.createShippingInfo(
 			context,
 			cart,
 			shippingMethodRef,
@@ -632,8 +635,8 @@ describe("createShippingInfo", () => {
 		expect(result.taxedPrice!.totalNet.centAmount).toBe(0);
 	});
 
-	test("should charge normal shipping when cart total is below freeAbove threshold", () => {
-		storage.add("dummy", "shipping-method", {
+	test("should charge normal shipping when cart total is below freeAbove threshold", async () => {
+		await storage.add("dummy", "shipping-method", {
 			...getBaseResourceProperties(),
 			id: "free-above-shipping-id-2",
 			key: "free-above-shipping-2",
@@ -705,7 +708,7 @@ describe("createShippingInfo", () => {
 			id: "free-above-shipping-id-2",
 		};
 
-		const result = repository.createShippingInfo(
+		const result = await repository.createShippingInfo(
 			context,
 			cart,
 			shippingMethodRef,
@@ -718,7 +721,7 @@ describe("createShippingInfo", () => {
 	});
 
 	test("create cart with discount code", async () => {
-		const code = storage.add("dummy", "discount-code", {
+		const code = await storage.add("dummy", "discount-code", {
 			...getBaseResourceProperties(),
 			code: "test-1234",
 			cartDiscounts: [],
@@ -735,7 +738,7 @@ describe("createShippingInfo", () => {
 
 		const ctx = { projectKey: "dummy", storeKey: "dummyStore" };
 
-		const result = repository.create(ctx, cart);
+		const result = await repository.create(ctx, cart);
 		expect(result.id).toBeDefined();
 
 		expect(result.discountCodes).toEqual([
@@ -748,4 +751,107 @@ describe("createShippingInfo", () => {
 			},
 		]);
 	});
+
+	test("create cart with non-existent discount code throws error", async () => {
+		const cart: CartDraft = {
+			country: "NL",
+			currency: "EUR",
+			discountCodes: ["non-existent-code"],
+		};
+
+		const ctx = { projectKey: "dummy", storeKey: "dummyStore" };
+
+		await expect(repository.create(ctx, cart)).rejects.toThrow(
+			"The discount code 'non-existent-code' was not found.",
+		);
+	});
+
+	test("create cart with duplicate discount codes deduplicates them", async () => {
+		const code = await storage.add("dummy", "discount-code", {
+			...getBaseResourceProperties(),
+			code: "duplicate-test",
+			cartDiscounts: [],
+			isActive: true,
+			references: [],
+			groups: [],
+		});
+
+		const cart: CartDraft = {
+			country: "NL",
+			currency: "EUR",
+			discountCodes: ["duplicate-test", "duplicate-test"],
+		};
+
+		const ctx = { projectKey: "dummy", storeKey: "dummyStore" };
+
+		const result = await repository.create(ctx, cart);
+		expect(result.discountCodes).toHaveLength(1);
+		expect(result.discountCodes).toEqual([
+			{
+				discountCode: {
+					typeId: "discount-code",
+					id: code.id,
+				},
+				state: "MatchesCart",
+			},
+		]);
+	});
+
+	test("addDiscountCode action adds discount code to cart", async () => {
+		const code = await storage.add("dummy", "discount-code", {
+			...getBaseResourceProperties(),
+			code: "action-test-code",
+			cartDiscounts: [],
+			isActive: true,
+			references: [],
+			groups: [],
+		});
+
+		const cart: CartDraft = {
+			country: "NL",
+			currency: "EUR",
+		};
+
+		const ctx = { projectKey: "dummy", storeKey: "dummyStore" };
+
+		const createdCart = await repository.create(ctx, cart);
+		expect(createdCart.discountCodes).toHaveLength(0);
+
+		const updatedCart = await repository.processUpdateActions(
+			ctx,
+			createdCart,
+			createdCart.version,
+			[
+				{
+					action: "addDiscountCode",
+					code: "action-test-code",
+				} as CartAddDiscountCodeAction,
+			],
+		);
+
+		expect(updatedCart.discountCodes).toEqual([
+			{
+				discountCode: {
+					typeId: "discount-code",
+					id: code.id,
+				},
+				state: "MatchesCart",
+			},
+		]);
+
+		// Adding the same discount code again should not create a duplicate
+		const updatedCart2 = await repository.processUpdateActions(
+			ctx,
+			updatedCart,
+			updatedCart.version,
+			[
+				{
+					action: "addDiscountCode",
+					code: "action-test-code",
+				} as CartAddDiscountCodeAction,
+			],
+		);
+
+		expect(updatedCart2.discountCodes).toHaveLength(1);
+	});
 });

package/src/repositories/cart/index.ts

@@ -8,14 +8,15 @@ import type {
 	LineItem,
 	LineItemDraft,
 	Product,
-	ProductPagedQueryResponse,
 	ShippingMethodDoesNotMatchCartError,
 } from "@commercetools/platform-sdk";
+
 import { v4 as uuidv4 } from "uuid";
 import type { Config } from "#src/config.ts";
 import { CommercetoolsError } from "#src/exceptions.ts";
 import { getBaseResourceProperties } from "#src/helpers.ts";
 import { calculateTaxTotals } from "#src/lib/tax.ts";
+import { CartDraftSchema } from "#src/schemas/generated/cart.ts";
 import {
 	createShippingInfoFromMethod,
 	getShippingMethodsMatchingCart,
@@ -43,9 +44,10 @@ export class CartRepository extends AbstractResourceRepository<"cart"> {
 	constructor(config: Config) {
 		super("cart", config);
 		this.actions = new CartUpdateHandler(this._storage, this);
+		this.draftSchema = CartDraftSchema;
 	}
 
-	create(context: RepositoryContext, draft: CartDraft): Cart {
+	async create(context: RepositoryContext, draft: CartDraft): Promise<Cart> {
 		if (draft.anonymousId && draft.customerId) {
 			throw new CommercetoolsError<InvalidOperationError>({
 				code: "InvalidOperation",
@@ -55,7 +57,7 @@ export class CartRepository extends AbstractResourceRepository<"cart"> {
 
 		// Validate that the customer exists
 		if (draft.customerId) {
-			this._storage.getByResourceIdentifier(context.projectKey, {
+			await this._storage.getByResourceIdentifier(context.projectKey, {
 				typeId: "customer",
 				id: draft.customerId,
 			});
@@ -64,7 +66,7 @@ export class CartRepository extends AbstractResourceRepository<"cart"> {
 		let storedBusinessUnit: BusinessUnit | undefined;
 		if (draft.businessUnit?.id || draft.businessUnit?.key) {
 			storedBusinessUnit =
-				this._storage.getByResourceIdentifier<"business-unit">(
+				await this._storage.getByResourceIdentifier<"business-unit">(
 					context.projectKey,
 					{
 						typeId: "business-unit",
@@ -74,42 +76,51 @@ export class CartRepository extends AbstractResourceRepository<"cart"> {
 				);
 		}
 
-		const lineItems =
-			draft.lineItems?.map((draftLineItem) =>
-				this.draftLineItemtoLineItem(
-					context.projectKey,
-					draftLineItem,
-					draft.currency,
-					draft.country,
-				),
-			) ?? [];
+		const lineItems = draft.lineItems
+			? await Promise.all(
+					draft.lineItems.map((draftLineItem) =>
+						this.draftLineItemtoLineItem(
+							context.projectKey,
+							draftLineItem,
+							draft.currency,
+							draft.country,
+						),
+					),
+				)
+			: [];
 
-		const customLineItems =
-			draft.customLineItems?.map((draftCustomLineItem) =>
-				createCustomLineItemFromDraft(
-					context.projectKey,
-					draftCustomLineItem,
-					this._storage,
-					draft.shippingAddress?.country ?? draft.country,
-				),
-			) ?? [];
+		const customLineItems = draft.customLineItems
+			? await Promise.all(
+					draft.customLineItems.map((draftCustomLineItem) =>
+						createCustomLineItemFromDraft(
+							context.projectKey,
+							draftCustomLineItem,
+							this._storage,
+							draft.shippingAddress?.country ?? draft.country,
+						),
+					),
+				)
+			: [];
 
-		// Validate that discount codes exist
+		// Validate that discount codes exist and deduplicate
 		const discountCodeInfo: DiscountCodeInfo[] = [];
 		if (draft.discountCodes?.length) {
-			draft.discountCodes.forEach((code) => {
-				discountCodeInfo.push(
-					createDiscountCodeInfoFromCode(
-						context.projectKey,
-						this._storage,
-						code,
-					),
+			const seen = new Set<string>();
+			for (const code of draft.discountCodes) {
+				const info = await createDiscountCodeInfoFromCode(
+					context.projectKey,
+					this._storage,
+					code,
 				);
-			});
+				if (!seen.has(info.discountCode.id)) {
+					seen.add(info.discountCode.id);
+					discountCodeInfo.push(info);
+				}
+			}
 		}
 
 		const resource: Writable<Cart> = {
-			...getBaseResourceProperties(),
+			...getBaseResourceProperties(context.clientId),
 			anonymousId: draft.anonymousId,
 			businessUnit:
 				storedBusinessUnit && draft.businessUnit
@@ -154,7 +165,7 @@ export class CartRepository extends AbstractResourceRepository<"cart"> {
 			shippingInfo: undefined,
 			origin: draft.origin ?? "Customer",
 			refusedGifts: [],
-			custom: createCustomFields(
+			custom: await createCustomFields(
 				draft.custom,
 				context.projectKey,
 				this._storage,
@@ -169,7 +180,7 @@ export class CartRepository extends AbstractResourceRepository<"cart"> {
 
 		// Set shipping info after resource is created
 		if (draft.shippingMethod) {
-			resource.shippingInfo = this.createShippingInfo(
+			resource.shippingInfo = await this.createShippingInfo(
 				context,
 				resource,
 				draft.shippingMethod,
@@ -180,12 +191,12 @@ export class CartRepository extends AbstractResourceRepository<"cart"> {
 		resource.taxedPrice = taxedPrice;
 		resource.taxedShippingPrice = taxedShippingPrice;
 
-		return this.saveNew(context, resource);
+		return await this.saveNew(context, resource);
 	}
 
-	getActiveCart(projectKey: string): Cart | undefined {
+	async getActiveCart(projectKey: string): Promise<Cart | undefined> {
 		// Get first active cart
-		const results = this._storage.query(projectKey, this.getTypeId(), {
+		const results = await this._storage.query(projectKey, this.getTypeId(), {
 			where: [`cartState="Active"`],
 		});
 		if (results.count > 0) {
@@ -195,26 +206,26 @@ export class CartRepository extends AbstractResourceRepository<"cart"> {
 		return;
 	}
 
-	draftLineItemtoLineItem = (
+	draftLineItemtoLineItem = async (
 		projectKey: string,
 		draftLineItem: LineItemDraft,
 		currency: string,
 		country: string | undefined,
-	): LineItem => {
+	): Promise<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, {});
+			product = await this._storage.get(projectKey, "product", productId, {});
 		} else if (sku) {
 			// Fetch product and variant by SKU
-			const items = this._storage.query(projectKey, "product", {
+			const items = await 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];
@@ -243,20 +254,22 @@ export class CartRepository extends AbstractResourceRepository<"cart"> {
 
 		if (!variant) {
 			// Check if variant is found
-			throw new Error(
-				sku
+			throw new CommercetoolsError<InvalidOperationError>({
+				code: "InvalidOperation",
+				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 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}`,
-			);
+			throw new CommercetoolsError<InvalidOperationError>({
+				code: "InvalidOperation",
+				message: `No valid price found for ${productId} for country ${country} and currency ${currency}`,
+			});
 		}
 
 		const totalPrice = createCentPrecisionMoney({
@@ -281,7 +294,7 @@ export class CartRepository extends AbstractResourceRepository<"cart"> {
 			lineItemMode: "Standard",
 			priceMode: "Platform",
 			state: [],
-			custom: createCustomFields(
+			custom: await createCustomFields(
 				draftLineItem.custom,
 				projectKey,
 				this._storage,
@@ -289,25 +302,28 @@ export class CartRepository extends AbstractResourceRepository<"cart"> {
 		};
 	};
 
-	createShippingInfo(
+	async createShippingInfo(
 		context: RepositoryContext,
 		resource: Writable<Cart>,
 		shippingMethodRef: NonNullable<CartDraft["shippingMethod"]>,
-	): NonNullable<Cart["shippingInfo"]> {
+	): Promise<NonNullable<Cart["shippingInfo"]>> {
 		if (resource.taxMode === "External") {
-			throw new Error("External tax rate is not supported");
+			throw new CommercetoolsError<InvalidOperationError>({
+				code: "InvalidOperation",
+				message: "External tax rate is not supported",
+			});
 		}
 
 		// 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">(
+		await this._storage.getByResourceIdentifier<"shipping-method">(
 			context.projectKey,
 			shippingMethodRef,
 		);
 
 		// getShippingMethodsMatchingCart does the work of determining whether the
 		// shipping method is allowed for the cart, and which shipping rate to use
-		const shippingMethods = getShippingMethodsMatchingCart(
+		const shippingMethods = await getShippingMethodsMatchingCart(
 			context,
 			this._storage,
 			resource,
@@ -316,10 +332,11 @@ export class CartRepository extends AbstractResourceRepository<"cart"> {
 			},
 		);
 
-		const method = shippingMethods.results.find((candidate) =>
-			shippingMethodRef.id
-				? candidate.id === shippingMethodRef.id
-				: candidate.key === shippingMethodRef.key,
+		const method = shippingMethods.results.find(
+			(candidate: { id: string; key?: string }) =>
+				shippingMethodRef.id
+					? candidate.id === shippingMethodRef.id
+					: candidate.key === shippingMethodRef.key,
 		);
 
 		// Not finding the method in the results means it's not allowed, since
@@ -333,7 +350,7 @@ export class CartRepository extends AbstractResourceRepository<"cart"> {
 		}
 
 		// Use the shared shipping info creation logic
-		return createShippingInfoFromMethod(
+		return await createShippingInfoFromMethod(
 			context,
 			this._storage,
 			resource,