@labdigital/commercetools-mock 2.45.1 → 2.46.0

package/package.json

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

package/src/lib/predicateParser.test.ts

@@ -13,8 +13,12 @@ describe("Predicate filter", () => {
 		nested: {
 			numberProperty: 1234,
 			objectProperty: {
-				stringProperty: "foobar",
-				booleanProperty: true,
+				"stringProperty": "foobar",
+				"booleanProperty": true,
+				"45c652f2-76e8-48fd-ab64-d11ad99d6631": {
+					stringProperty: "foobar",
+					uuidProperty: "3a57cc78-db08-4cd3-b778-d59b3326c435",
+				},
 			},
 			array: [
 				{
@@ -331,6 +335,33 @@ describe("Predicate filter", () => {
 		);
 		expect(() => match(`stringProperty`)).toThrow(PredicateError);
 	});
+
+	test("uuid as field name", async () => {
+		expect(
+			match(
+				`nested(objectProperty(45c652f2-76e8-48fd-ab64-d11ad99d6631(stringProperty = "foobar")))`,
+			),
+		).toBeTruthy();
+
+		expect(
+			match(
+				`nested(objectProperty(3a57cc78-db08-4cd3-b778-d59b3326c435(stringProperty = "foobar")))`,
+			),
+		).toBeFalsy();
+	});
+
+	test("uuid as value", async () => {
+		expect(
+			match(
+				`nested(objectProperty(45c652f2-76e8-48fd-ab64-d11ad99d6631(uuidProperty = "3a57cc78-db08-4cd3-b778-d59b3326c435")))`,
+			),
+		).toBeTruthy();
+		expect(
+			match(
+				`nested(objectProperty(45c652f2-76e8-48fd-ab64-d11ad99d6631(uuidProperty = "45c652f2-76e8-48fd-ab64-d11ad99d6631")))`,
+			),
+		).toBeFalsy();
+	});
 });
 
 describe("Report parse errors", () => {

package/src/lib/predicateParser.ts

@@ -124,6 +124,12 @@ const getLexer = (value: string) =>
 		.token("IS", /is(?![-_a-z0-9]+)/i)
 		.token("DEFINED", /defined(?![-_a-z0-9]+)/i)
 
+		// Special case for UUID identifiers,
+		// since they otherwise would get matched as INT, when starting with a digit
+		.token(
+			"IDENTIFIER",
+			/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/,
+		)
 		.token("FLOAT", /\d+\.\d+/)
 		.token("INT", /\d+/)
 		.token("VARIABLE", /:([-_A-Za-z0-9]+)/)

package/src/product-search.ts

@@ -13,6 +13,12 @@ import { validateSearchQuery } from "./lib/searchQueryTypeChecker";
 import { applyPriceSelector } from "./priceSelector";
 import type { AbstractStorage } from "./storage";
 
+interface ProductSearchVariantAvailability {
+	isOnStock: boolean;
+	availableQuantity: number;
+	isOnStockForChannel: string | undefined;
+}
+
 export class ProductSearch {
 	protected _storage: AbstractStorage;
 
@@ -24,10 +30,32 @@ export class ProductSearch {
 		projectKey: string,
 		params: ProductSearchRequest,
 	): ProductPagedSearchResponse {
-		let resources = this._storage
+		const availabilityBySku = this._storage
+			.all(projectKey, "inventory-entry")
+			.reduce((acc, entry) => {
+				const existingEntry = acc.get(entry.sku);
+
+				acc.set(entry.sku, {
+					isOnStock: existingEntry?.isOnStock || entry.quantityOnStock > 0,
+					availableQuantity:
+						existingEntry?.availableQuantity ?? 0 + entry.quantityOnStock,
+					// NOTE: This doesn't handle inventory entries for multiple channels,
+					// so it doesn't exactly replicate the behavior of the commercetools api.
+					isOnStockForChannel:
+						existingEntry?.isOnStockForChannel ?? entry.supplyChannel?.id,
+				});
+
+				return acc;
+			}, new Map<string, ProductSearchVariantAvailability>());
+
+		let productResources = this._storage
 			.all(projectKey, "product")
 			.map((r) =>
-				this.transform(r, params.productProjectionParameters?.staged ?? false),
+				this.transformProduct(
+					r,
+					params.productProjectionParameters?.staged ?? false,
+					availabilityBySku,
+				),
 			)
 			.filter((p) => {
 				if (!(params.productProjectionParameters?.staged ?? false)) {
@@ -46,7 +74,7 @@ export class ProductSearch {
 				const matchFunc = parseSearchQuery(params.query);
 
 				// Filters can modify the output. So clone the resources first.
-				resources = resources.filter((resource) =>
+				productResources = productResources.filter((resource) =>
 					matchFunc(resource, markMatchingVariant),
 				);
 			} catch (err) {
@@ -63,7 +91,7 @@ export class ProductSearch {
 
 		// Apply the priceSelector
 		if (params.productProjectionParameters) {
-			applyPriceSelector(resources, {
+			applyPriceSelector(productResources, {
 				country: params.productProjectionParameters.priceCountry,
 				channel: params.productProjectionParameters.priceChannel,
 				customerGroup: params.productProjectionParameters.priceCustomerGroup,
@@ -76,7 +104,10 @@ export class ProductSearch {
 
 		const offset = params.offset || 0;
 		const limit = params.limit || 20;
-		const productProjectionsResult = resources.slice(offset, offset + limit);
+		const productProjectionsResult = productResources.slice(
+			offset,
+			offset + limit,
+		);
 
 		/**
 		 * Do not supply productProjection if productProjectionParameters are not given
@@ -100,7 +131,7 @@ export class ProductSearch {
 		);
 
 		return {
-			total: resources.length,
+			total: productResources.length,
 			offset: offset,
 			limit: limit,
 			results: results,
@@ -108,7 +139,11 @@ export class ProductSearch {
 		};
 	}
 
-	transform(product: Product, staged: boolean): ProductProjection {
+	transformProduct(
+		product: Product,
+		staged: boolean,
+		availabilityBySku: Map<string, ProductSearchVariantAvailability>,
+	): ProductProjection {
 		const obj = !staged
 			? product.masterData.current
 			: product.masterData.staged;
@@ -125,7 +160,12 @@ export class ProductSearch {
 			slug: obj.slug,
 			categories: obj.categories,
 			masterVariant: obj.masterVariant,
-			variants: obj.variants,
+			variants: obj.variants.map((variant) => ({
+				...variant,
+				availability: variant.sku
+					? availabilityBySku.get(variant.sku)
+					: { isOnStock: false, availableQuantity: 0, isOnStockForChannel: [] },
+			})),
 			productType: product.productType,
 			hasStagedChanges: product.masterData.hasStagedChanges,
 			published: product.masterData.published,

package/src/repositories/cart/index.ts

@@ -1,3 +1,4 @@
+import type { InvalidOperationError } from "@commercetools/platform-sdk";
 import {
 	type Cart,
 	type CartDraft,
@@ -27,6 +28,21 @@ export class CartRepository extends AbstractResourceRepository<"cart"> {
 	}
 
 	create(context: RepositoryContext, draft: CartDraft): Cart {
+		if (draft.anonymousId && draft.customerId) {
+			throw new CommercetoolsError<InvalidOperationError>({
+				code: "InvalidOperation",
+				message: "Can set only one of customer OR anonymousId",
+			});
+		}
+
+		// Validate that the customer exists
+		if (draft.customerId) {
+			this._storage.getByResourceIdentifier(context.projectKey, {
+				typeId: "customer",
+				id: draft.customerId,
+			});
+		}
+
 		const lineItems =
 			draft.lineItems?.map((draftLineItem) =>
 				this.draftLineItemtoLineItem(
@@ -45,6 +61,7 @@ export class CartRepository extends AbstractResourceRepository<"cart"> {
 				: undefined,
 			cartState: "Active",
 			country: draft.country,
+			customerId: draft.customerId,
 			customerEmail: draft.customerEmail,
 			customLineItems: [],
 			directDiscounts: [],

package/src/services/cart.test.ts

@@ -13,6 +13,7 @@ import type {
 import assert from "assert";
 import supertest from "supertest";
 import { afterEach, beforeEach, describe, expect, test } from "vitest";
+import { customerDraftFactory } from "~src/testing/customer";
 import { CommercetoolsMock } from "../index";
 
 describe("Carts Query", () => {
@@ -81,6 +82,30 @@ describe("Carts Query", () => {
 		expect(myCart.custom?.type.id).toBe(myCart.custom?.type.obj?.id);
 		expect(myCart.custom?.type.obj?.description?.en).toBe("Test Type");
 	});
+
+	test("throw error when anonymousId and customerId are given", async () => {
+		const customerId = "400be09e-bfe8-4925-a307-4ef6280b063e";
+		const anonymousId = "a99f27d1-7e7e-4592-8d5a-aa5da1adfe24";
+		const response = await supertest(ctMock.app).post("/dummy/carts").send({
+			currency: "EUR",
+			anonymousId,
+			customerId,
+		});
+		expect(response.status).toBe(400);
+		expect(response.body.message).toBe(
+			"Can set only one of customer OR anonymousId",
+		);
+	});
+
+	test("create cart with existing customer", async () => {
+		const customer = await customerDraftFactory(ctMock).create();
+		const response = await supertest(ctMock.app).post("/dummy/carts").send({
+			currency: "EUR",
+			customerId: customer.id,
+		});
+		expect(response.status).toBe(201);
+		expect(response.body.customerId).toBe(customer.id);
+	});
 });
 
 describe("Cart Update Actions", () => {

package/src/services/customer.test.ts

@@ -4,60 +4,21 @@ import type {
 	CustomerToken,
 } from "@commercetools/platform-sdk";
 import assert from "assert";
-import { Factory } from "fishery";
 import supertest from "supertest";
 import { afterEach, beforeEach, describe, expect, test } from "vitest";
 import { hashPassword } from "~src/lib/password";
+import { customerDraftFactory } from "~src/testing/customer";
 import { CommercetoolsMock, getBaseResourceProperties } from "../index";
 
 const ctMock = new CommercetoolsMock();
 
-const customerDraftFactory = Factory.define<
-	CustomerDraft,
-	CustomerDraft,
-	Customer
->(({ onCreate }) => {
-	onCreate(async (draft) => {
-		const response = await supertest(ctMock.app)
-			.post(`/dummy/customers`)
-			.send(draft);
-
-		return response.body.customer;
-	});
-
-	return {
-		email: "customer@example.com",
-		firstName: "John",
-		lastName: "Doe",
-		locale: "nl-NL",
-		password: "my-secret-pw",
-		addresses: [
-			{
-				firstName: "John",
-				lastName: "Doe",
-				streetName: "Street name",
-				streetNumber: "42",
-				postalCode: "1234 AB",
-				city: "Utrecht",
-				country: "NL",
-				company: "Lab Digital",
-				phone: "+31612345678",
-				email: "customer@example.com",
-			},
-		],
-		isEmailVerified: false,
-		stores: [],
-		authenticationMode: "Password",
-	};
-});
-
 afterEach(() => {
 	ctMock.clear();
 });
 
 describe("Customer create", () => {
 	test("create new customer", async () => {
-		const draft = customerDraftFactory.build();
+		const draft = customerDraftFactory(ctMock).build();
 
 		const response = await supertest(ctMock.app)
 			.post(`/dummy/customers`)
@@ -109,7 +70,7 @@ describe("Customer create", () => {
 
 describe("Customer Update Actions", () => {
 	test("addAddress", async () => {
-		const customer = await customerDraftFactory.create();
+		const customer = await customerDraftFactory(ctMock).create();
 		const response = await supertest(ctMock.app)
 			.post(`/dummy/customers/${customer.id}`)
 			.send({
@@ -134,7 +95,7 @@ describe("Customer Update Actions", () => {
 	});
 
 	test("removeAddress by ID", async () => {
-		const customer = await customerDraftFactory.create({
+		const customer = await customerDraftFactory(ctMock).create({
 			addresses: [
 				{
 					key: "address-key",
@@ -165,7 +126,7 @@ describe("Customer Update Actions", () => {
 	});
 
 	test("removeAddress by Key", async () => {
-		const customer = await customerDraftFactory.create({
+		const customer = await customerDraftFactory(ctMock).create({
 			addresses: [
 				{
 					key: "address-key",
@@ -196,7 +157,7 @@ describe("Customer Update Actions", () => {
 	});
 
 	test("changeAddress by ID", async () => {
-		const customer = await customerDraftFactory.create({
+		const customer = await customerDraftFactory(ctMock).create({
 			addresses: [
 				{
 					key: "address-key",
@@ -248,7 +209,7 @@ describe("Customer Update Actions", () => {
 	});
 
 	test("addBillingAddressId", async () => {
-		const customer = await customerDraftFactory.create({
+		const customer = await customerDraftFactory(ctMock).create({
 			addresses: [
 				{
 					key: "address-key",
@@ -280,7 +241,7 @@ describe("Customer Update Actions", () => {
 	});
 
 	test("removeBillingAddressId", async () => {
-		const customer = await customerDraftFactory.create({
+		const customer = await customerDraftFactory(ctMock).create({
 			addresses: [
 				{
 					key: "address-key",
@@ -318,7 +279,7 @@ describe("Customer Update Actions", () => {
 	});
 
 	test("setDefaultBillingAddress by ID", async () => {
-		const customer = await customerDraftFactory.create({
+		const customer = await customerDraftFactory(ctMock).create({
 			defaultBillingAddress: undefined,
 			defaultShippingAddress: undefined,
 			addresses: [
@@ -356,7 +317,7 @@ describe("Customer Update Actions", () => {
 	});
 
 	test("addShippingAddressId", async () => {
-		const customer = await customerDraftFactory.create({
+		const customer = await customerDraftFactory(ctMock).create({
 			addresses: [
 				{
 					key: "address-key",
@@ -387,7 +348,7 @@ describe("Customer Update Actions", () => {
 	});
 
 	test("removeShippingAddressId", async () => {
-		const customer = await customerDraftFactory.create({
+		const customer = await customerDraftFactory(ctMock).create({
 			addresses: [
 				{
 					key: "address-key",
@@ -425,7 +386,7 @@ describe("Customer Update Actions", () => {
 	});
 
 	test("setDefaultShippingAddress by ID", async () => {
-		const customer = await customerDraftFactory.create({
+		const customer = await customerDraftFactory(ctMock).create({
 			defaultBillingAddress: undefined,
 			defaultShippingAddress: undefined,
 			addresses: [

package/src/services/product.test.ts

@@ -2,6 +2,7 @@ import type {
 	Category,
 	CategoryDraft,
 	Image,
+	InventoryEntryDraft,
 	PriceDraft,
 	Product,
 	ProductData,
@@ -20,7 +21,14 @@ import type {
 } from "@commercetools/platform-sdk";
 import assert from "assert";
 import supertest from "supertest";
-import { beforeAll, beforeEach, describe, expect, test } from "vitest";
+import {
+	afterAll,
+	beforeAll,
+	beforeEach,
+	describe,
+	expect,
+	test,
+} from "vitest";
 import { CommercetoolsMock } from "../index";
 
 const productTypeDraft: ProductTypeDraft = {
@@ -492,6 +500,10 @@ describe("Product update actions", () => {
 		expect(response.status).toBe(201);
 	});
 
+	afterAll(async () => {
+		ctMock.clear();
+	});
+
 	test("setAttribute masterVariant (staged)", async () => {
 		assert(productPublished, "product not created");
 
@@ -1488,76 +1500,148 @@ describe("Product update actions", () => {
 				?.myCustomField,
 		).toBe("MyRandomValue");
 	});
+});
 
-	// Test the general product search implementation
-	describe("Product Search - Generic", () => {
-		test("Pagination", async () => {
-			{
-				const body: ProductSearchRequest = {
-					productProjectionParameters: {
-						storeProjection: "dummy-store",
-						localeProjection: ["en-US"],
-						priceCurrency: "EUR",
-						priceChannel: "dummy-channel",
-						expand: ["categories[*]", "categories[*].ancestors[*]"],
-					},
-					limit: 24,
-				};
-				const response = await supertest(ctMock.app)
-					.post("/dummy/products/search")
-					.send(body);
-
-				const pagedSearchResponse: ProductPagedSearchResponse = response.body;
-				expect(pagedSearchResponse.limit).toBe(24);
-				expect(pagedSearchResponse.offset).toBe(0);
-				expect(pagedSearchResponse.total).toBeGreaterThan(0);
-
-				// Deliberately not supported fow now
-				expect(pagedSearchResponse.facets).toEqual([]);
-
-				const results: ProductSearchResult[] = pagedSearchResponse.results;
-				expect(results).toBeDefined();
-				expect(results.length).toBeGreaterThan(0);
-
-				// Find product with sku "1337" to be part of the search results
-				const productFound = results.find(
-					(result) => result?.productProjection?.masterVariant?.sku === "1337",
-				);
-				expect(productFound).toBeDefined();
-
-				const priceCurrencyMatch = results.find((result) =>
-					result?.productProjection?.masterVariant?.prices?.find(
-						(price) => price?.value?.currencyCode === "EUR",
-					),
-				);
-				expect(priceCurrencyMatch).toBeDefined();
-			}
-			{
-				const body: ProductSearchRequest = {
-					limit: 88,
-					offset: 88,
-				};
-
-				const response = await supertest(ctMock.app)
-					.post("/dummy/products/search")
-					.send(body);
-
-				const pagedSearchResponse: ProductPagedSearchResponse = response.body;
-				expect(pagedSearchResponse.limit).toBe(88);
-				expect(pagedSearchResponse.offset).toBe(88);
-				expect(pagedSearchResponse.total).toBeGreaterThan(0);
-
-				// No results, since we start at offset 88
-				const results: ProductSearchResult[] = pagedSearchResponse.results;
-				expect(results).toBeDefined();
-				expect(results.length).toBe(0);
-
-				// Product with sku "1337" should not be part of the results
-				const productFound = results.find(
-					(result) => result?.productProjection?.masterVariant?.sku === "1337",
-				);
-				expect(productFound).toBeUndefined();
-			}
+// Test the general product search implementation
+describe("Product Search - Generic", () => {
+	const ctMock = new CommercetoolsMock();
+
+	async function addInventoryEntry(sku: string, quantity: number) {
+		const inventoryEntryDraft: InventoryEntryDraft = {
+			key: `${sku}_stock`,
+			sku,
+			quantityOnStock: quantity,
+			supplyChannel: {
+				typeId: "channel",
+				id: "dummy-inventory-channel",
+			},
+		};
+
+		await supertest(ctMock.app)
+			.post("/dummy/inventory")
+			.send(inventoryEntryDraft);
+	}
+
+	beforeAll(async () => {
+		await beforeAllProductTests(ctMock);
+
+		new Array(24).fill(null).forEach(async () => {
+			const response = await supertest(ctMock.app)
+				.post("/dummy/products")
+				.send(publishedProductDraft);
+
+			expect(response.status).toBe(201);
 		});
 	});
+
+	test("Pagination", async () => {
+		{
+			const body: ProductSearchRequest = {
+				productProjectionParameters: {
+					storeProjection: "dummy-store",
+					localeProjection: ["en-US"],
+					priceCurrency: "EUR",
+					priceChannel: "dummy-channel",
+					expand: ["categories[*]", "categories[*].ancestors[*]"],
+				},
+				limit: 24,
+			};
+			const response = await supertest(ctMock.app)
+				.post("/dummy/products/search")
+				.send(body);
+
+			const pagedSearchResponse: ProductPagedSearchResponse = response.body;
+			expect(pagedSearchResponse.limit).toBe(24);
+			expect(pagedSearchResponse.offset).toBe(0);
+			expect(pagedSearchResponse.total).toBeGreaterThan(0);
+
+			// Deliberately not supported fow now
+			expect(pagedSearchResponse.facets).toEqual([]);
+
+			const results: ProductSearchResult[] = pagedSearchResponse.results;
+			expect(results).toBeDefined();
+			expect(results.length).toBeGreaterThan(0);
+
+			// Find product with sku "1337" to be part of the search results
+			const productFound = results.find(
+				(result) => result?.productProjection?.masterVariant?.sku === "1337",
+			);
+			expect(productFound).toBeDefined();
+
+			const priceCurrencyMatch = results.find((result) =>
+				result?.productProjection?.masterVariant?.prices?.find(
+					(price) => price?.value?.currencyCode === "EUR",
+				),
+			);
+			expect(priceCurrencyMatch).toBeDefined();
+		}
+		{
+			const body: ProductSearchRequest = {
+				limit: 88,
+				offset: 88,
+			};
+
+			const response = await supertest(ctMock.app)
+				.post("/dummy/products/search")
+				.send(body);
+
+			const pagedSearchResponse: ProductPagedSearchResponse = response.body;
+			expect(pagedSearchResponse.limit).toBe(88);
+			expect(pagedSearchResponse.offset).toBe(88);
+			expect(pagedSearchResponse.total).toBeGreaterThan(0);
+
+			// No results, since we start at offset 88
+			const results: ProductSearchResult[] = pagedSearchResponse.results;
+			expect(results).toBeDefined();
+			expect(results.length).toBe(0);
+
+			// Product with sku "1337" should not be part of the results
+			const productFound = results.find(
+				(result) => result?.productProjection?.masterVariant?.sku === "1337",
+			);
+			expect(productFound).toBeUndefined();
+		}
+	});
+
+	test("Filter on inventory", async () => {
+		const body: ProductSearchRequest = {
+			query: {
+				exact: {
+					field: "variants.availability.isOnStockForChannel",
+					value: "dummy-inventory-channel",
+				},
+			},
+			productProjectionParameters: {
+				storeProjection: "dummy-store",
+				localeProjection: ["en-US"],
+				priceCurrency: "EUR",
+				priceChannel: "dummy-channel",
+			},
+			limit: 1,
+		};
+
+		const response1 = await supertest(ctMock.app)
+			.post("/dummy/products/search")
+			.send(body);
+
+		const pagedSearchResponse1: ProductPagedSearchResponse = response1.body;
+
+		expect(pagedSearchResponse1.results.length).toBe(0);
+
+		await addInventoryEntry(
+			publishedProductDraft.variants?.[0]?.sku as string,
+			10,
+		);
+
+		const response2 = await supertest(ctMock.app)
+			.post("/dummy/products/search")
+			.send(body);
+
+		const pagedSearchResponse2: ProductPagedSearchResponse = response2.body;
+
+		const productFound = pagedSearchResponse2.results.find(
+			(result) => result?.productProjection?.masterVariant?.sku === "1337",
+		);
+		expect(productFound).toBeDefined();
+	});
 });