feat(cart,order): add support for custom types and fields (#341)

mikedebock · web-flow · commit bde20b217f48 · 2025-09-22T08:42:59.000+02:00
- Add support for missing line-item custom field and type actions:
  - `setLineItemCustomField` on cart
  - `setLineItemCustomType` on cart
  - `setLineItemCustomField` on order
  - `setLineItemCustomType` on order
- Fix: copy line item variant attributes on OrderImport
diff --git a/.changeset/brave-flies-try.md b/.changeset/brave-flies-try.md
@@ -0,0 +1,5 @@
+---
+"@labdigital/commercetools-mock": minor
+---
+
+feat: implement support for set line-item custom types and fields on carts and orders
diff --git a/src/repositories/cart/actions.ts b/src/repositories/cart/actions.ts
@@ -26,6 +26,8 @@ import type {
 	CartSetCustomTypeAction,
 	CartSetCustomerEmailAction,
 	CartSetDirectDiscountsAction,
+	CartSetLineItemCustomFieldAction,
+	CartSetLineItemCustomTypeAction,
 	CartSetLineItemShippingDetailsAction,
 	CartSetLocaleAction,
 	CartSetShippingAddressAction,
@@ -662,6 +664,82 @@ export class CartUpdateHandler
 		);
 	}
 
+	setLineItemCustomField(
+		context: RepositoryContext,
+		resource: Writable<Cart>,
+		{
+			lineItemId,
+			lineItemKey,
+			name,
+			value,
+			action,
+		}: CartSetLineItemCustomFieldAction,
+	) {
+		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.`,
+			});
+		}
+
+		if (!lineItem.custom) {
+			throw new Error("Resource has no custom field");
+		}
+
+		lineItem.custom.fields[name] = value;
+	}
+
+	setLineItemCustomType(
+		context: RepositoryContext,
+		resource: Writable<Cart>,
+		{ lineItemId, lineItemKey, type, fields }: CartSetLineItemCustomTypeAction,
+	) {
+		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.`,
+			});
+		}
+
+		if (!type) {
+			lineItem.custom = undefined;
+		} else {
+			const resolvedType = this._storage.getByResourceIdentifier(
+				context.projectKey,
+				type,
+			);
+			if (!resolvedType) {
+				throw new Error(`Type ${type} not found`);
+			}
+
+			lineItem.custom = {
+				type: {
+					typeId: "type",
+					id: resolvedType.id,
+				},
+				fields: fields || {},
+			};
+		}
+	}
+
 	setLineItemShippingDetails(
 		context: RepositoryContext,
 		resource: Writable<Cart>,
diff --git a/src/repositories/order/actions.ts b/src/repositories/order/actions.ts
@@ -1,5 +1,6 @@
 import type {
 	CustomLineItemReturnItem,
+	GeneralError,
 	LineItemReturnItem,
 	Order,
 	OrderAddPaymentAction,
@@ -9,10 +10,13 @@ import type {
 	OrderChangeShipmentStateAction,
 	OrderSetBillingAddressAction,
 	OrderSetCustomFieldAction,
+	OrderSetCustomLineItemCustomTypeAction,
 	OrderSetCustomTypeAction,
 	OrderSetCustomerEmailAction,
 	OrderSetCustomerIdAction,
 	OrderSetDeliveryCustomFieldAction,
+	OrderSetLineItemCustomFieldAction,
+	OrderSetLineItemCustomTypeAction,
 	OrderSetLocaleAction,
 	OrderSetOrderNumberAction,
 	OrderSetParcelCustomFieldAction,
@@ -27,6 +31,7 @@ import type {
 	Store,
 	SyncInfo,
 } from "@commercetools/platform-sdk";
+import { CommercetoolsError } from "~src/exceptions";
 import { getBaseResourceProperties } from "~src/helpers";
 import type { Writable } from "~src/types";
 import type { RepositoryContext, UpdateHandlerInterface } from "../abstract";
@@ -205,6 +210,82 @@ export class OrderUpdateHandler
 		}
 	}
 
+	setLineItemCustomField(
+		context: RepositoryContext,
+		resource: Order,
+		{
+			lineItemId,
+			lineItemKey,
+			name,
+			value,
+			action,
+		}: OrderSetLineItemCustomFieldAction,
+	) {
+		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.`,
+			});
+		}
+
+		if (!lineItem.custom) {
+			throw new Error("Resource has no custom field");
+		}
+
+		lineItem.custom.fields[name] = value;
+	}
+
+	setLineItemCustomType(
+		context: RepositoryContext,
+		resource: Writable<Order>,
+		{ lineItemId, lineItemKey, type, fields }: OrderSetLineItemCustomTypeAction,
+	) {
+		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.`,
+			});
+		}
+
+		if (!type) {
+			lineItem.custom = undefined;
+		} else {
+			const resolvedType = this._storage.getByResourceIdentifier(
+				context.projectKey,
+				type,
+			);
+			if (!resolvedType) {
+				throw new Error(`Type ${type} not found`);
+			}
+
+			lineItem.custom = {
+				type: {
+					typeId: "type",
+					id: resolvedType.id,
+				},
+				fields: fields || {},
+			};
+		}
+	}
+
 	setLocale(
 		context: RepositoryContext,
 		resource: Writable<Order>,
diff --git a/src/repositories/order/index.ts b/src/repositories/order/index.ts
@@ -219,6 +219,7 @@ export class OrderRepository extends AbstractResourceRepository<"order"> {
 				id: variant.id,
 				sku: variant.sku,
 				price: createPrice(draft.price),
+				attributes: variant.attributes,
 			},
 		};
 
diff --git a/src/services/cart.test.ts b/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");
 
diff --git a/src/services/order.test.ts b/src/services/order.test.ts

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@labdigital/commercetools-mock": minor
 +---
++
 +feat: implement support for set line-item custom types and fields on carts and orders