@labdigital/commercetools-mock 2.34.3 → 2.36.0

package/src/services/cart.test.ts

@@ -3,6 +3,12 @@ import type {
 	Cart,
 	CentPrecisionMoney,
 	ProductDraft,
+	ShippingMethod,
+	ShippingMethodDraft,
+	ShippingMethodResourceIdentifier,
+	TaxCategory,
+	TaxCategoryDraft,
+	Zone,
 } from "@commercetools/platform-sdk";
 import assert from "assert";
 import supertest from "supertest";
@@ -89,6 +95,41 @@ describe("Cart Update Actions", () => {
 		cart = response.body;
 	};
 
+	const createZone = async (country: string): Promise<Zone> => {
+		const response = await supertest(ctMock.app)
+			.post("/dummy/zones")
+			.send({
+				name: country,
+				locations: [
+					{
+						country,
+					},
+				],
+			});
+		expect(response.status).toBe(201);
+		return response.body;
+	};
+
+	const createTaxCategory = async (
+		draft: TaxCategoryDraft,
+	): Promise<TaxCategory> => {
+		const response = await supertest(ctMock.app)
+			.post("/dummy/tax-categories")
+			.send(draft);
+		expect(response.status).toBe(201);
+		return response.body;
+	};
+
+	const createShippingMethod = async (
+		draft: ShippingMethodDraft,
+	): Promise<ShippingMethod> => {
+		const response = await supertest(ctMock.app)
+			.post("/dummy/shipping-methods")
+			.send(draft);
+		expect(response.status).toBe(201);
+		return response.body;
+	};
+
 	const productDraft: ProductDraft = {
 		name: {
 			"nl-NL": "test product",
@@ -672,6 +713,7 @@ describe("Cart Update Actions", () => {
 			},
 		});
 	});
+
 	test("setShippingAddressCustomType", async () => {
 		assert(cart, "cart not created");
 
@@ -739,6 +781,381 @@ describe("Cart Update Actions", () => {
 			},
 		});
 	});
+
+	describe("setShippingMethod", () => {
+		let standardShippingMethod: ShippingMethod;
+		let standardExcludedShippingMethod: ShippingMethod;
+		beforeEach(async () => {
+			assert(cart, "cart not created");
+			const nlZone = await createZone("NL");
+			const frZone = await createZone("FR");
+			const standardTax = await createTaxCategory({
+				name: "Standard tax category",
+				key: "standard",
+				rates: [
+					{
+						name: "FR standard tax rate",
+						amount: 0.2,
+						includedInPrice: true,
+						country: "FR",
+					},
+					{
+						name: "NL standard tax rate",
+						amount: 0.21,
+						includedInPrice: true,
+						country: "NL",
+					},
+				],
+			});
+			await createTaxCategory({
+				name: "Reduced tax category",
+				key: "reduced",
+				rates: [
+					{
+						name: "FR reduced tax rate",
+						amount: 0.1,
+						includedInPrice: true,
+						country: "FR",
+					},
+					{
+						name: "NL reduced tax rate",
+						amount: 0.09,
+						includedInPrice: true,
+						country: "NL",
+					},
+				],
+			});
+			const standardExcludedTax = await createTaxCategory({
+				name: "Tax category that is excluded from price",
+				key: "standard-excluded",
+				rates: [
+					{
+						name: "FR standard-excluded tax rate",
+						amount: 0.2,
+						includedInPrice: false,
+						country: "FR",
+					},
+					{
+						name: "NL standard-excluded tax rate",
+						amount: 0.21,
+						includedInPrice: false,
+						country: "NL",
+					},
+				],
+			});
+			standardShippingMethod = await createShippingMethod({
+				isDefault: false,
+				key: "standard",
+				name: "Standard shipping",
+				taxCategory: {
+					typeId: "tax-category",
+					id: standardTax.id,
+				},
+				zoneRates: [
+					{
+						zone: {
+							typeId: "zone",
+							id: nlZone.id,
+						},
+						shippingRates: [
+							{
+								price: {
+									type: "centPrecision",
+									currencyCode: "EUR",
+									centAmount: 499,
+									fractionDigits: 2,
+								},
+							},
+						],
+					},
+					{
+						zone: {
+							typeId: "zone",
+							id: frZone.id,
+						},
+						shippingRates: [
+							{
+								price: {
+									type: "centPrecision",
+									currencyCode: "EUR",
+									centAmount: 699,
+									fractionDigits: 2,
+								},
+							},
+						],
+					},
+				],
+			});
+
+			standardExcludedShippingMethod = await createShippingMethod({
+				isDefault: false,
+				key: "standard-excluded",
+				name: "Standard shipping with tax excluded from price",
+				taxCategory: {
+					typeId: "tax-category",
+					id: standardExcludedTax.id,
+				},
+				zoneRates: [
+					{
+						zone: {
+							typeId: "zone",
+							id: nlZone.id,
+						},
+						shippingRates: [
+							{
+								price: {
+									type: "centPrecision",
+									currencyCode: "EUR",
+									centAmount: 499,
+									fractionDigits: 2,
+								},
+							},
+						],
+					},
+					{
+						zone: {
+							typeId: "zone",
+							id: frZone.id,
+						},
+						shippingRates: [
+							{
+								price: {
+									type: "centPrecision",
+									currencyCode: "EUR",
+									centAmount: 699,
+									fractionDigits: 2,
+								},
+							},
+						],
+					},
+				],
+			});
+			await createShippingMethod({
+				isDefault: false,
+				key: "express",
+				name: "Express shipping",
+				taxCategory: {
+					typeId: "tax-category",
+					id: standardTax.id,
+				},
+				zoneRates: [
+					{
+						zone: {
+							typeId: "zone",
+							id: nlZone.id,
+						},
+						shippingRates: [
+							{
+								price: {
+									type: "centPrecision",
+									currencyCode: "EUR",
+									centAmount: 899,
+									fractionDigits: 2,
+								},
+							},
+						],
+					},
+					{
+						zone: {
+							typeId: "zone",
+							id: frZone.id,
+						},
+						shippingRates: [
+							{
+								price: {
+									type: "centPrecision",
+									currencyCode: "EUR",
+									centAmount: 1099,
+									fractionDigits: 2,
+								},
+							},
+						],
+					},
+				],
+			});
+
+			expect(
+				(
+					await supertest(ctMock.app)
+						.post(`/dummy/carts/${cart.id}`)
+						.send({
+							version: 1,
+							actions: [
+								{
+									action: "setShippingAddress",
+									address: {
+										streetName: "Street name",
+										city: "Utrecht",
+										country: "NL",
+									},
+								},
+							],
+						})
+				).status,
+			).toBe(200);
+		});
+
+		test("correctly sets shipping method", async () => {
+			assert(cart, "cart not created");
+
+			const shippingMethod: ShippingMethodResourceIdentifier = {
+				typeId: "shipping-method",
+				id: standardShippingMethod.id,
+			};
+
+			const response = await supertest(ctMock.app)
+				.post(`/dummy/carts/${cart.id}`)
+				.send({
+					version: 2,
+					actions: [{ action: "setShippingMethod", shippingMethod }],
+				});
+			expect(response.status).toBe(200);
+			expect(response.body.version).toBe(3);
+			expect(response.body.shippingInfo.shippingMethod.id).toEqual(
+				standardShippingMethod.id,
+			);
+		});
+
+		test("correctly sets shippingInfo rates + tax when includedInPrice: true", async () => {
+			assert(cart, "cart not created");
+			assert(standardShippingMethod, "shipping method not created");
+
+			const shippingMethod: ShippingMethodResourceIdentifier = {
+				typeId: "shipping-method",
+				id: standardShippingMethod.id,
+			};
+
+			const response = await supertest(ctMock.app)
+				.post(`/dummy/carts/${cart.id}`)
+				.send({
+					version: 2,
+					actions: [{ action: "setShippingMethod", shippingMethod }],
+				});
+			expect(response.status).toBe(200);
+			expect(response.body.version).toBe(3);
+			expect(response.body.shippingInfo.shippingRate.price).toMatchObject({
+				centAmount: 499,
+				currencyCode: "EUR",
+				fractionDigits: 2,
+				type: "centPrecision",
+			});
+			expect(response.body.shippingInfo.price).toMatchObject({
+				centAmount: 499,
+				currencyCode: "EUR",
+				fractionDigits: 2,
+				type: "centPrecision",
+			});
+			expect(response.body.shippingInfo.taxRate).toMatchObject({
+				name: "NL standard tax rate",
+				amount: 0.21,
+				includedInPrice: true,
+				country: "NL",
+			});
+			expect(response.body.shippingInfo.taxedPrice).toMatchObject({
+				totalNet: {
+					type: "centPrecision",
+					centAmount: 412,
+					currencyCode: "EUR",
+					fractionDigits: 2,
+				},
+				totalGross: {
+					type: "centPrecision",
+					centAmount: 499,
+					currencyCode: "EUR",
+					fractionDigits: 2,
+				},
+				taxPortions: [
+					{
+						name: "NL standard tax rate",
+						rate: 0.21,
+						amount: {
+							type: "centPrecision",
+							centAmount: 87,
+							currencyCode: "EUR",
+							fractionDigits: 2,
+						},
+					},
+				],
+				totalTax: {
+					type: "centPrecision",
+					centAmount: 87,
+					currencyCode: "EUR",
+					fractionDigits: 2,
+				},
+			});
+		});
+
+		test("correctly sets shippingInfo rates + tax when includedInPrice: false", async () => {
+			assert(cart, "cart not created");
+			assert(standardExcludedShippingMethod, "shipping method not created");
+
+			const shippingMethod: ShippingMethodResourceIdentifier = {
+				typeId: "shipping-method",
+				id: standardExcludedShippingMethod.id,
+			};
+
+			const response = await supertest(ctMock.app)
+				.post(`/dummy/carts/${cart.id}`)
+				.send({
+					version: 2,
+					actions: [{ action: "setShippingMethod", shippingMethod }],
+				});
+			expect(response.status).toBe(200);
+			expect(response.body.version).toBe(3);
+			expect(response.body.shippingInfo.shippingRate.price).toMatchObject({
+				centAmount: 499,
+				currencyCode: "EUR",
+				fractionDigits: 2,
+				type: "centPrecision",
+			});
+			// TODO: should this be gross or net? docs unclear (currently always just returns the shipping rate (tier) price)
+			expect(response.body.shippingInfo.price).toMatchObject({
+				centAmount: 499,
+				currencyCode: "EUR",
+				fractionDigits: 2,
+				type: "centPrecision",
+			});
+			expect(response.body.shippingInfo.taxRate).toMatchObject({
+				name: "NL standard-excluded tax rate",
+				amount: 0.21,
+				includedInPrice: false,
+				country: "NL",
+			});
+			expect(response.body.shippingInfo.taxedPrice).toMatchObject({
+				totalNet: {
+					type: "centPrecision",
+					centAmount: 499,
+					currencyCode: "EUR",
+					fractionDigits: 2,
+				},
+				totalGross: {
+					type: "centPrecision",
+					centAmount: 604,
+					currencyCode: "EUR",
+					fractionDigits: 2,
+				},
+				taxPortions: [
+					{
+						name: "NL standard-excluded tax rate",
+						rate: 0.21,
+						amount: {
+							type: "centPrecision",
+							centAmount: 105,
+							currencyCode: "EUR",
+							fractionDigits: 2,
+						},
+					},
+				],
+				totalTax: {
+					type: "centPrecision",
+					centAmount: 105,
+					currencyCode: "EUR",
+					fractionDigits: 2,
+				},
+			});
+		});
+	});
+
 	test("setLineItemShippingDetails", async () => {
 		const product = await supertest(ctMock.app)
 			.post(`/dummy/products`)

package/src/services/customer.test.ts

@@ -1,4 +1,8 @@
-import { Customer, CustomerToken } from "@commercetools/platform-sdk";
+import {
+	Customer,
+	CustomerDraft,
+	CustomerToken,
+} from "@commercetools/platform-sdk";
 import assert from "assert";
 import supertest from "supertest";
 import { afterEach, beforeEach, describe, expect, test } from "vitest";
@@ -7,6 +11,46 @@ import { CommercetoolsMock, getBaseResourceProperties } from "../index";
 
 const ctMock = new CommercetoolsMock();
 
+afterEach(() => {
+	ctMock.clear();
+});
+
+describe("Customer create", () => {
+	test("create new customer", async () => {
+		const draft: CustomerDraft = {
+			email: "new-user@example.com",
+			password: "supersecret",
+			authenticationMode: "Password",
+			stores: [],
+			addresses: [
+				{
+					key: "address-key",
+					firstName: "John",
+					lastName: "Doe",
+					streetName: "Main Street",
+					streetNumber: "1",
+					postalCode: "12345",
+					country: "DE",
+				},
+			],
+			billingAddresses: [0],
+			shippingAddresses: [0],
+		};
+
+		const response = await supertest(ctMock.app)
+			.post(`/dummy/customers`)
+			.send(draft);
+
+		const customer = response.body.customer as Customer;
+		expect(response.status, JSON.stringify(customer)).toBe(201);
+		expect(customer.version).toBe(1);
+		expect(customer.defaultBillingAddressId).toBeUndefined();
+		expect(customer.defaultShippingAddressId).toBeUndefined();
+		expect(customer.billingAddressIds).toHaveLength(1);
+		expect(customer.shippingAddressIds).toHaveLength(1);
+	});
+});
+
 describe("Customer Update Actions", () => {
 	let customer: Customer | undefined;
 
@@ -25,10 +69,6 @@ describe("Customer Update Actions", () => {
 		ctMock.project("dummy").add("customer", customer);
 	});
 
-	afterEach(() => {
-		ctMock.clear();
-	});
-
 	test("exists", async () => {
 		assert(customer, "customer not created");
 

package/src/services/index.ts

@@ -12,6 +12,7 @@ import { CustomerGroupService } from "./customer-group";
 import { DiscountCodeService } from "./discount-code";
 import { ExtensionServices } from "./extension";
 import { InventoryEntryService } from "./inventory-entry";
+import { MyBusinessUnitService } from "./my-business-unit";
 import { MyCartService } from "./my-cart";
 import { MyCustomerService } from "./my-customer";
 import { MyOrderService } from "./my-order";
@@ -66,6 +67,7 @@ export const createServices = (
 	"my-cart": new MyCartService(router, repos["my-cart"]),
 	"my-order": new MyOrderService(router, repos["my-order"]),
 	"my-customer": new MyCustomerService(router, repos["my-customer"]),
+	"my-business-unit": new MyBusinessUnitService(router, repos["business-unit"]),
 	"my-payment": new MyPaymentService(router, repos["my-payment"]),
 	"my-shopping-list": new MyShoppingListService(
 		router,

package/src/services/my-business-unit.ts

@@ -0,0 +1,28 @@
+import { Router } from "express";
+import { BusinessUnitRepository } from "~src/repositories/business-unit";
+import AbstractService from "./abstract";
+
+export class MyBusinessUnitService extends AbstractService {
+	public repository: BusinessUnitRepository;
+
+	constructor(parent: Router, repository: BusinessUnitRepository) {
+		super(parent);
+		this.repository = repository;
+	}
+
+	getBasePath() {
+		return "me";
+	}
+
+	registerRoutes(parent: Router) {
+		// Overwrite this function to be able to handle /me/business-units path.
+		const basePath = this.getBasePath();
+		const router = Router({ mergeParams: true });
+
+		this.extraRoutes(router);
+
+		router.get("/business-units/", this.get.bind(this));
+
+		parent.use(`/${basePath}`, router);
+	}
+}

package/src/services/my-customer.test.ts

@@ -35,6 +35,8 @@ describe("Me", () => {
 				version: 1,
 				isEmailVerified: false,
 				addresses: [],
+				billingAddressIds: [],
+				shippingAddressIds: [],
 				id: expect.anything(),
 				createdAt: expect.anything(),
 				lastModifiedAt: expect.anything(),

package/src/{shippingCalculator.test.ts → shipping.test.ts}

@@ -7,7 +7,7 @@ import { describe, expect, it } from "vitest";
 import {
 	markMatchingShippingRate,
 	markMatchingShippingRatePriceTiers,
-} from "./shippingCalculator";
+} from "./shipping";
 
 // describe('markMatchingShippingMethods', () => {
 // 	const zones: Record<string, Zone> = {