@labdigital/commercetools-mock 2.28.0 → 2.29.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@labdigital/commercetools-mock",
-  "version": "2.28.0",
+  "version": "2.29.0",
   "license": "MIT",
   "author": "Michael van Tellingen",
   "type": "module",

package/src/repositories/order/actions.ts

@@ -11,6 +11,7 @@ import type {
 	OrderSetCustomTypeAction,
 	OrderSetCustomerEmailAction,
 	OrderSetCustomerIdAction,
+	OrderSetDeliveryCustomFieldAction,
 	OrderSetLocaleAction,
 	OrderSetOrderNumberAction,
 	OrderSetShippingAddressAction,
@@ -23,6 +24,7 @@ import type {
 	Store,
 	SyncInfo,
 } from "@commercetools/platform-sdk";
+import assert from "assert";
 import { getBaseResourceProperties } from "~src/helpers";
 import type { Writable } from "~src/types";
 import {
@@ -180,6 +182,26 @@ export class OrderUpdateHandler
 		}
 	}
 
+	setDeliveryCustomField(
+		context: RepositoryContext,
+		resource: Writable<Order>,
+		{ deliveryId, name, value }: OrderSetDeliveryCustomFieldAction,
+	) {
+		assert(resource.shippingInfo, "shippingInfo is not defined");
+
+		if (Array.isArray(resource.shippingInfo.deliveries)) {
+			resource.shippingInfo.deliveries.map((delivery) => {
+				if (delivery.id !== deliveryId) throw "No matching delivery id found";
+				if (delivery.custom) {
+					const update = delivery.custom.fields;
+					update[name] = value;
+					Object.assign(delivery.custom.fields, update);
+				}
+				return delivery;
+			});
+		}
+	}
+
 	setLocale(
 		context: RepositoryContext,
 		resource: Writable<Order>,

package/src/repositories/product/actions.ts

@@ -26,6 +26,8 @@ import type {
 	ProductSetMetaDescriptionAction,
 	ProductSetMetaKeywordsAction,
 	ProductSetMetaTitleAction,
+	ProductSetProductPriceCustomFieldAction,
+	ProductSetProductPriceCustomTypeAction,
 	ProductSetTaxCategoryAction,
 	ProductTransitionStateAction,
 	ProductUpdateAction,
@@ -35,8 +37,11 @@ import type {
 } from "@commercetools/platform-sdk";
 import { CommercetoolsError } from "~src/exceptions";
 import type { Writable } from "~src/types";
-import { AbstractUpdateHandler, RepositoryContext } from "../abstract";
-import { getReferenceFromResourceIdentifier } from "../helpers";
+import { AbstractUpdateHandler, type RepositoryContext } from "../abstract";
+import {
+	createCustomFields,
+	getReferenceFromResourceIdentifier,
+} from "../helpers";
 import {
 	checkForStagedChanges,
 	getVariant,
@@ -853,6 +858,87 @@ export class ProductUpdateHandler
 		return resource;
 	}
 
+	setProductPriceCustomField(
+		context: RepositoryContext,
+		resource: Writable<Product>,
+		{ name, value, staged, priceId }: ProductSetProductPriceCustomFieldAction,
+	) {
+		const updatePriceCustomFields = (data: Writable<ProductData>) => {
+			const price = [data.masterVariant, ...(data.variants ?? [])]
+				.flatMap((variant) => variant.prices ?? [])
+				.find((price) => price.id === priceId);
+
+			if (!price) {
+				throw new Error(
+					`Price with id ${priceId} not found on product ${resource.id}`,
+				);
+			}
+			if (price.custom) {
+				if (value === null) {
+					delete price.custom.fields[name];
+				} else {
+					price.custom.fields[name] = value;
+				}
+			}
+			return data;
+		};
+
+		resource.masterData.staged = updatePriceCustomFields(
+			resource.masterData.staged,
+		);
+
+		const onlyStaged = staged !== undefined ? staged : true;
+		if (!onlyStaged) {
+			resource.masterData.current = updatePriceCustomFields(
+				resource.masterData.current,
+			);
+		}
+		checkForStagedChanges(resource);
+		return resource;
+	}
+
+	setProductPriceCustomType(
+		context: RepositoryContext,
+		resource: Writable<Product>,
+		{ type, fields, staged, priceId }: ProductSetProductPriceCustomTypeAction,
+	) {
+		const updatePriceCustomType = (data: Writable<ProductData>) => {
+			const price = [data.masterVariant, ...(data.variants ?? [])]
+				.flatMap((variant) => variant.prices ?? [])
+				.find((price) => price.id === priceId);
+
+			if (price) {
+				if (type) {
+					price.custom = createCustomFields(
+						{ type, fields },
+						context.projectKey,
+						this._storage,
+					);
+				} else {
+					price.custom = undefined;
+				}
+			} else {
+				throw new Error(
+					`Price with id ${priceId} not found on product ${resource.id}`,
+				);
+			}
+			return data;
+		};
+
+		resource.masterData.staged = updatePriceCustomType(
+			resource.masterData.staged,
+		);
+
+		const onlyStaged = staged !== undefined ? staged : true;
+		if (!onlyStaged) {
+			resource.masterData.current = updatePriceCustomType(
+				resource.masterData.current,
+			);
+		}
+		checkForStagedChanges(resource);
+		return resource;
+	}
+
 	setTaxCategory(
 		context: RepositoryContext,
 		resource: Writable<Product>,
@@ -919,8 +1005,6 @@ export class ProductUpdateHandler
 	}
 
 	// 'setPrices': () => {},
-	// 'setProductPriceCustomType': () => {},
-	// 'setProductPriceCustomField': () => {},
 	// 'setDiscountedPrice': () => {},
 	// 'setAttributeInAllVariants': () => {},
 	// 'setCategoryOrderHint': () => {},

package/src/services/order.test.ts

@@ -2,6 +2,7 @@ import type { Order, Payment, State } from "@commercetools/platform-sdk";
 import assert from "assert";
 import supertest from "supertest";
 import { afterEach, beforeEach, describe, expect, test } from "vitest";
+import { generateRandomString } from "~src/helpers";
 import { CommercetoolsMock, getBaseResourceProperties } from "../index";
 
 describe("Order Query", () => {
@@ -402,6 +403,166 @@ describe("Order Update Actions", () => {
 		expect(response.body.paymentState).toBe("Failed");
 	});
 
+	test("setDeliveryCustomField", async () => {
+		const order: Order = {
+			...getBaseResourceProperties(),
+			customLineItems: [],
+			lastMessageSequenceNumber: 0,
+			lineItems: [],
+			orderNumber: "1389",
+			orderState: "Open",
+			origin: "Customer",
+			paymentInfo: {
+				payments: [
+					{
+						typeId: "payment",
+						id: generateRandomString(10),
+					},
+				],
+			},
+			refusedGifts: [],
+			shippingInfo: {
+				shippingMethodName: "Home delivery (package)",
+				price: {
+					type: "centPrecision",
+					currencyCode: "EUR",
+					centAmount: 999,
+					fractionDigits: 2,
+				},
+				shippingRate: {
+					price: {
+						type: "centPrecision",
+						currencyCode: "EUR",
+						centAmount: 999,
+						fractionDigits: 2,
+					},
+					tiers: [
+						{
+							type: "CartScore",
+							score: 24,
+							price: {
+								type: "centPrecision",
+								currencyCode: "EUR",
+								centAmount: 1998,
+								fractionDigits: 2,
+							},
+						},
+						{
+							type: "CartScore",
+							score: 47,
+							price: {
+								type: "centPrecision",
+								currencyCode: "EUR",
+								centAmount: 2997,
+								fractionDigits: 2,
+							},
+						},
+						{
+							type: "CartScore",
+							score: 70,
+							price: {
+								type: "centPrecision",
+								currencyCode: "EUR",
+								centAmount: 3996,
+								fractionDigits: 2,
+							},
+						},
+						{
+							type: "CartScore",
+							score: 93,
+							price: {
+								type: "centPrecision",
+								currencyCode: "EUR",
+								centAmount: 4995,
+								fractionDigits: 2,
+							},
+						},
+					],
+				},
+				deliveries: [
+					{
+						id: "6a458cad-dd46-4f5f-8b73-debOede6a17d",
+						key: "CT-Z243002",
+						createdAt: "2024-07-29T13:37:48.047Z",
+						items: [
+							{
+								id: "5d209544-2892-45c9-bef0-dde4e250188e",
+								quantity: 1,
+							},
+						],
+						parcels: [],
+						custom: {
+							type: {
+								typeId: "type",
+								id: "c493b7bb-d415-450c-b421-e128a8b26569",
+							},
+							fields: {
+								location: "test",
+								status: "created",
+								carrier: "test_carrier",
+							},
+						},
+					},
+				],
+				shippingMethodState: "MatchesCart",
+			},
+			shipping: [],
+			shippingMode: "Single",
+			syncInfo: [],
+			totalPrice: {
+				type: "centPrecision",
+				fractionDigits: 2,
+				centAmount: 2000,
+				currencyCode: "EUR",
+			},
+		};
+		ctMock.project("dummy").add("order", order);
+
+		const response = await supertest(ctMock.app).get(
+			`/dummy/orders/order-number=${order.orderNumber}`,
+		);
+
+		// check if status is set
+		const _updateResponse = await supertest(ctMock.app)
+			.post(`/dummy/orders/${response.body.id}`)
+			.send({
+				version: 0,
+				actions: [
+					{
+						action: "setDeliveryCustomField",
+						deliveryId: "6a458cad-dd46-4f5f-8b73-debOede6a17d",
+						name: "status",
+						value: "delayed",
+					},
+				],
+			});
+		expect(_updateResponse.status).toBe(200);
+		expect(_updateResponse.body.version).toBe(1);
+		expect(
+			_updateResponse.body.shippingInfo.deliveries[0].custom.fields.status,
+		).toBe("delayed");
+
+		// check if other field can be set
+		const _updateResponse2 = await supertest(ctMock.app)
+			.post(`/dummy/orders/${response.body.id}`)
+			.send({
+				version: 1,
+				actions: [
+					{
+						action: "setDeliveryCustomField",
+						deliveryId: "6a458cad-dd46-4f5f-8b73-debOede6a17d",
+						name: "carrier",
+						value: "dhl",
+					},
+				],
+			});
+		expect(_updateResponse2.status).toBe(200);
+		expect(_updateResponse2.body.version).toBe(2);
+		expect(
+			_updateResponse2.body.shippingInfo.deliveries[0].custom.fields.carrier,
+		).toBe("dhl");
+	});
+
 	test("updateSyncInfo", async () => {
 		assert(order, "order not created");
 

package/src/services/product.test.ts

@@ -12,6 +12,8 @@ import type {
 	StateDraft,
 	TaxCategory,
 	TaxCategoryDraft,
+	Type,
+	TypeDraft,
 } from "@commercetools/platform-sdk";
 import assert from "assert";
 import supertest from "supertest";
@@ -78,6 +80,30 @@ const productState2Draft: StateDraft = {
 	},
 };
 
+const productPriceTypeDraft: TypeDraft = {
+	key: "product-price",
+	name: {
+		en: "ProductPriceType",
+	},
+	description: {
+		en: "Product Price Type",
+	},
+	resourceTypeIds: ["product-price"],
+	fieldDefinitions: [
+		{
+			name: "lastModifiedAt",
+			label: {
+				en: "Last modified at",
+			},
+			required: false,
+			type: {
+				name: "DateTime",
+			},
+			inputHint: "SingleLine",
+		},
+	],
+};
+
 const publishedProductDraft: ProductDraft = {
 	name: {
 		"nl-NL": "test published product",
@@ -250,6 +276,7 @@ let taxCategory1: TaxCategory;
 let taxCategory2: TaxCategory;
 let productState1: State;
 let productState2: State;
+let productPriceType: Type;
 
 async function beforeAllProductTests(mock: CommercetoolsMock) {
 	let response;
@@ -308,6 +335,12 @@ async function beforeAllProductTests(mock: CommercetoolsMock) {
 
 	expect(response.status).toBe(201);
 	productState2 = response.body;
+
+	response = await supertest(mock.app)
+		.post("/dummy/types")
+		.send(productPriceTypeDraft);
+	expect(response.status).toBe(201);
+	productPriceType = response.body;
 }
 
 describe("Product", () => {
@@ -1418,4 +1451,38 @@ describe("Product update actions", () => {
 			id: productState2.id,
 		});
 	});
+
+	test("setProductPriceCustomField", async () => {
+		assert(productPublished, "product not created");
+		const priceId =
+			productPublished?.masterData.current.masterVariant.prices?.[0].id;
+		assert(priceId);
+
+		const response = await supertest(ctMock.app)
+			.post(`/dummy/products/${productPublished.id}`)
+			.send({
+				version: 1,
+				actions: [
+					{
+						action: "setProductPriceCustomType",
+						priceId,
+						type: {
+							typeId: "type",
+							key: productPriceType.key,
+						},
+					},
+					{
+						action: "setProductPriceCustomField",
+						name: "myCustomField",
+						value: "MyRandomValue",
+						priceId,
+					},
+				],
+			});
+		expect(response.status).toBe(200);
+		expect(
+			response.body.masterData.staged.masterVariant.prices?.[0].custom.fields
+				?.myCustomField,
+		).toBe("MyRandomValue");
+	});
 });