@labdigital/commercetools-mock 2.58.0 → 2.59.1

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);
 	}
 
@@ -219,6 +262,7 @@ export class OrderRepository extends AbstractResourceRepository<"order"> {
 				id: variant.id,
 				sku: variant.sku,
 				price: createPrice(draft.price),
+				attributes: variant.attributes,
 			},
 		};
 
@@ -271,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: [],
+		};
+	}
 }

package/src/services/cart.test.ts

@@ -711,6 +711,176 @@ describe("Cart Update Actions", () => {
 		]);
 	});
 
+	test("setLineItemCustomField", async () => {
+		const product = await supertest(ctMock.app)
+			.post("/dummy/products")
+			.send(productDraft)
+			.then((x) => x.body);
+
+		assert(product, "product not created");
+
+		const type = await supertest(ctMock.app)
+			.post("/dummy/types")
+			.send({
+				key: "my-type",
+				name: {
+					en: "My Type",
+				},
+				description: {
+					en: "My Type Description",
+				},
+				fieldDefinitions: [
+					{
+						name: "foo",
+						label: {
+							en: "foo",
+						},
+						required: false,
+						type: {
+							name: "String",
+						},
+						inputHint: "SingleLine",
+					},
+				],
+			})
+			.then((x) => x.body);
+
+		assert(type, "type not created");
+
+		const myCart = await supertest(ctMock.app)
+			.post("/dummy/carts")
+			.send({
+				currency: "EUR",
+				lineItems: [
+					{
+						sku: product.masterData.current.masterVariant.sku,
+						quantity: 1,
+						custom: {
+							type: {
+								typeId: "type",
+								key: "my-type",
+							},
+							fields: {},
+						},
+					},
+				],
+			})
+			.then((x) => x.body);
+
+		const lineItem = myCart.lineItems[0];
+		assert(lineItem, "lineItem not created");
+
+		const response = await supertest(ctMock.app)
+			.post(`/dummy/carts/${myCart.id}`)
+			.send({
+				version: myCart.version,
+				actions: [
+					{
+						action: "setLineItemCustomField",
+						lineItemId: lineItem.id,
+						name: "foo",
+						value: "bar",
+					},
+				],
+			});
+
+		expect(response.status).toBe(200);
+		expect(response.body.version).toBe(2);
+		expect(response.body.lineItems).toMatchObject([
+			{
+				id: lineItem.id,
+				custom: {
+					fields: {
+						foo: "bar",
+					},
+				},
+			},
+		]);
+	});
+
+	test("setLineItemCustomType", async () => {
+		const product = await supertest(ctMock.app)
+			.post("/dummy/products")
+			.send(productDraft)
+			.then((x) => x.body);
+
+		assert(product, "product not created");
+
+		const type = await supertest(ctMock.app)
+			.post("/dummy/types")
+			.send({
+				key: "my-type",
+				name: {
+					en: "My Type",
+				},
+				description: {
+					en: "My Type Description",
+				},
+				fieldDefinitions: [
+					{
+						name: "foo",
+						label: {
+							en: "foo",
+						},
+						required: false,
+						type: {
+							name: "String",
+						},
+						inputHint: "SingleLine",
+					},
+				],
+			})
+			.then((x) => x.body);
+
+		assert(type, "type not created");
+
+		const myCart = await supertest(ctMock.app)
+			.post("/dummy/carts")
+			.send({
+				currency: "EUR",
+				lineItems: [
+					{
+						sku: product.masterData.current.masterVariant.sku,
+						quantity: 1,
+					},
+				],
+			})
+			.then((x) => x.body);
+
+		const lineItem = myCart.lineItems[0];
+		assert(lineItem, "lineItem not created");
+
+		const response = await supertest(ctMock.app)
+			.post(`/dummy/carts/${myCart.id}`)
+			.send({
+				version: myCart.version,
+				actions: [
+					{
+						action: "setLineItemCustomType",
+						lineItemId: lineItem.id,
+						type: {
+							typeId: "type",
+							key: "my-type",
+						},
+					},
+				],
+			});
+
+		expect(response.status).toBe(200);
+		expect(response.body.version).toBe(2);
+		expect(response.body.lineItems).toMatchObject([
+			{
+				id: lineItem.id,
+				custom: {
+					type: {
+						typeId: "type",
+						id: type.id,
+					},
+				},
+			},
+		]);
+	});
+
 	test("setCustomerEmail", async () => {
 		assert(cart, "cart not created");
 

package/src/services/order.test.ts

@@ -1,5 +1,10 @@
 import assert from "node:assert";
-import type { Order, Payment, State } from "@commercetools/platform-sdk";
+import type {
+	CentPrecisionMoney,
+	Order,
+	Payment,
+	State,
+} from "@commercetools/platform-sdk";
 import supertest from "supertest";
 import { afterEach, beforeEach, describe, expect, test } from "vitest";
 import { generateRandomString } from "~src/helpers";
@@ -611,6 +616,236 @@ describe("Order Update Actions", () => {
 		).toBe("dhl");
 	});
 
+	test("setLineItemCustomField", async () => {
+		const order: Order = {
+			...getBaseResourceProperties(),
+			version: 1,
+			customLineItems: [],
+			directDiscounts: [],
+			discountCodes: [],
+			lineItems: [
+				{
+					id: "d70b14c8-72cf-4cab-82ba-6339cebe1e79",
+					productId: "06028a97-d622-47ac-a194-a3d90baa2b3c",
+					productSlug: { "nl-NL": "test-product" },
+					productType: { typeId: "product-type", id: "some-uuid" },
+					name: { "nl-NL": "test product" },
+					custom: {
+						type: {
+							typeId: "type",
+							id: "a493b7bb-d415-450c-b421-e128a8b26569",
+						},
+						fields: {},
+					},
+					variant: {
+						id: 1,
+						sku: "1337",
+						attributes: [{ name: "test", value: "test" }],
+						prices: [],
+						assets: [],
+						images: [],
+					},
+					price: {
+						id: "2f59a6c9-6a86-48d3-87f9-fabb3b12fd93",
+						value: {
+							type: "centPrecision",
+							centAmount: 14900,
+							currencyCode: "EUR",
+							fractionDigits: 2,
+						},
+					},
+					totalPrice: {
+						type: "centPrecision",
+						currencyCode: "EUR",
+						fractionDigits: 2,
+						centAmount: 14900,
+					},
+					taxedPricePortions: [],
+					perMethodTaxRate: [],
+					quantity: 1,
+					discountedPricePerQuantity: [],
+					lineItemMode: "Standard",
+					priceMode: "Platform",
+					state: [],
+				},
+			],
+			orderState: "Open",
+			origin: "Customer",
+			refusedGifts: [],
+			shipping: [],
+			shippingMode: "Single",
+			syncInfo: [],
+			taxCalculationMode: "LineItemLevel",
+			taxMode: "Platform",
+			taxRoundingMode: "HalfEven",
+			totalPrice: {
+				type: "centPrecision",
+				centAmount: 14900,
+				currencyCode: "EUR",
+				fractionDigits: 0,
+			},
+		};
+
+		ctMock.project("dummy").add("order", order);
+
+		const lineItem = order.lineItems[0];
+		assert(lineItem, "lineItem not created");
+
+		const response = await supertest(ctMock.app)
+			.post(`/dummy/orders/${order.id}`)
+			.send({
+				version: order.version,
+				actions: [
+					{
+						action: "setLineItemCustomField",
+						lineItemId: lineItem.id,
+						name: "foo",
+						value: "bar",
+					},
+				],
+			});
+
+		expect(response.status).toBe(200);
+		expect(response.body.version).toBe(2);
+		expect(response.body.lineItems).toMatchObject([
+			{
+				id: lineItem.id,
+				custom: {
+					fields: {
+						foo: "bar",
+					},
+				},
+			},
+		]);
+	});
+
+	test("setLineItemCustomType", async () => {
+		const order: Order = {
+			...getBaseResourceProperties(),
+			version: 1,
+			customLineItems: [],
+			directDiscounts: [],
+			discountCodes: [],
+			lineItems: [
+				{
+					id: "d70b14c8-72cf-4cab-82ba-6339cebe1e79",
+					productId: "06028a97-d622-47ac-a194-a3d90baa2b3c",
+					productSlug: { "nl-NL": "test-product" },
+					productType: { typeId: "product-type", id: "some-uuid" },
+					name: { "nl-NL": "test product" },
+					variant: {
+						id: 1,
+						sku: "1337",
+						attributes: [{ name: "test", value: "test" }],
+						prices: [],
+						assets: [],
+						images: [],
+					},
+					price: {
+						id: "2f59a6c9-6a86-48d3-87f9-fabb3b12fd93",
+						value: {
+							type: "centPrecision",
+							centAmount: 14900,
+							currencyCode: "EUR",
+							fractionDigits: 2,
+						},
+					},
+					totalPrice: {
+						type: "centPrecision",
+						currencyCode: "EUR",
+						fractionDigits: 2,
+						centAmount: 14900,
+					},
+					taxedPricePortions: [],
+					perMethodTaxRate: [],
+					quantity: 1,
+					discountedPricePerQuantity: [],
+					lineItemMode: "Standard",
+					priceMode: "Platform",
+					state: [],
+				},
+			],
+			orderState: "Open",
+			origin: "Customer",
+			refusedGifts: [],
+			shipping: [],
+			shippingMode: "Single",
+			syncInfo: [],
+			taxCalculationMode: "LineItemLevel",
+			taxMode: "Platform",
+			taxRoundingMode: "HalfEven",
+			totalPrice: {
+				type: "centPrecision",
+				centAmount: 14900,
+				currencyCode: "EUR",
+				fractionDigits: 0,
+			},
+		};
+
+		ctMock.project("dummy").add("order", order);
+
+		const type = await supertest(ctMock.app)
+			.post("/dummy/types")
+			.send({
+				key: "my-type",
+				name: {
+					en: "My Type",
+				},
+				description: {
+					en: "My Type Description",
+				},
+				fieldDefinitions: [
+					{
+						name: "foo",
+						label: {
+							en: "foo",
+						},
+						required: false,
+						type: {
+							name: "String",
+						},
+						inputHint: "SingleLine",
+					},
+				],
+			})
+			.then((x) => x.body);
+
+		assert(type, "type not created");
+
+		const lineItem = order.lineItems[0];
+		assert(lineItem, "lineItem not created");
+
+		const response = await supertest(ctMock.app)
+			.post(`/dummy/orders/${order.id}`)
+			.send({
+				version: order.version,
+				actions: [
+					{
+						action: "setLineItemCustomType",
+						lineItemId: lineItem.id,
+						type: {
+							typeId: "type",
+							id: type.id,
+						},
+					},
+				],
+			});
+
+		expect(response.status).toBe(200);
+		expect(response.body.version).toBe(2);
+		expect(response.body.lineItems).toMatchObject([
+			{
+				id: lineItem.id,
+				custom: {
+					type: {
+						typeId: "type",
+						id: type.id,
+					},
+				},
+			},
+		]);
+	});
+
 	test("setParcelCustomField", async () => {
 		const order: Order = {
 			...getBaseResourceProperties(),