@labdigital/commercetools-mock 2.45.1 → 2.47.0

package/src/services/product.test.ts

@@ -1,7 +1,9 @@
+import assert from "node:assert";
 import type {
 	Category,
 	CategoryDraft,
 	Image,
+	InventoryEntryDraft,
 	PriceDraft,
 	Product,
 	ProductData,
@@ -18,9 +20,15 @@ import type {
 	Type,
 	TypeDraft,
 } 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();
+	});
 });

package/src/services/quote-request.test.ts

@@ -0,0 +1,59 @@
+import supertest from "supertest";
+import { afterEach, describe, expect, it } from "vitest";
+import { customerDraftFactory } from "~src/testing/customer";
+import { CommercetoolsMock } from "../index";
+
+describe("Quote Request Create", () => {
+	const ctMock = new CommercetoolsMock();
+
+	afterEach(() => {
+		ctMock.clear();
+	});
+
+	it("should create a quote request", async () => {
+		const customer = await customerDraftFactory(ctMock).create();
+		let response = await supertest(ctMock.app)
+			.post("/dummy/carts")
+			.send({
+				currency: "EUR",
+				customerId: customer.id,
+				custom: {
+					type: {
+						key: "my-cart",
+					},
+					fields: {
+						description: "example description",
+					},
+				},
+			});
+		expect(response.status).toBe(201);
+		const cart = response.body;
+
+		response = await supertest(ctMock.app)
+			.post("/dummy/quote-requests")
+			.send({
+				cart: {
+					typeId: "cart",
+					id: cart.id,
+				},
+				cartVersion: cart.version,
+			});
+		expect(response.status).toBe(201);
+		const quote = response.body;
+
+		expect(quote.cart).toEqual({
+			typeId: "cart",
+			id: cart.id,
+		});
+
+		response = await supertest(ctMock.app)
+			.get(`/dummy/quote-requests/${quote.id}`)
+			.send();
+
+		const quoteResult = response.body;
+		expect(quoteResult.cart).toEqual({
+			typeId: "cart",
+			id: cart.id,
+		});
+	});
+});

package/src/services/quote-request.ts

@@ -0,0 +1,16 @@
+import type { Router } from "express";
+import type { QuoteRequestRepository } from "~src/repositories/quote-request";
+import AbstractService from "./abstract";
+
+export class QuoteRequestService extends AbstractService {
+	public repository: QuoteRequestRepository;
+
+	constructor(parent: Router, repository: QuoteRequestRepository) {
+		super(parent);
+		this.repository = repository;
+	}
+
+	getBasePath() {
+		return "quote-requests";
+	}
+}

package/src/services/quote-staged.ts

@@ -0,0 +1,16 @@
+import type { Router } from "express";
+import type { StagedQuoteRepository } from "~src/repositories/quote-staged";
+import AbstractService from "./abstract";
+
+export class StagedQuoteService extends AbstractService {
+	public repository: StagedQuoteRepository;
+
+	constructor(parent: Router, repository: StagedQuoteRepository) {
+		super(parent);
+		this.repository = repository;
+	}
+
+	getBasePath() {
+		return "staged-quotes";
+	}
+}

package/src/services/quote.ts

@@ -0,0 +1,16 @@
+import type { Router } from "express";
+import type { QuoteRepository } from "~src/repositories/quote";
+import AbstractService from "./abstract";
+
+export class QuoteService extends AbstractService {
+	public repository: QuoteRepository;
+
+	constructor(parent: Router, repository: QuoteRepository) {
+		super(parent);
+		this.repository = repository;
+	}
+
+	getBasePath() {
+		return "quotes";
+	}
+}

package/src/services/standalone-price.test.ts

@@ -120,7 +120,7 @@ describe("Standalone price Actions", () => {
 
 	test("changeValue", async () => {
 		const response = await supertest(ctMock.app)
-			.post("/dummy/standalone-prices/" + id)
+			.post(`/dummy/standalone-prices/${id}`)
 			.send({
 				version: 1,
 				actions: [
@@ -159,7 +159,7 @@ describe("Standalone price Actions", () => {
 
 	test("setActive", async () => {
 		const response = await supertest(ctMock.app)
-			.post("/dummy/standalone-prices/" + id)
+			.post(`/dummy/standalone-prices/${id}`)
 			.send({
 				version: 1,
 				actions: [
@@ -195,7 +195,7 @@ describe("Standalone price Actions", () => {
 
 	test("setDiscounted", async () => {
 		const response = await supertest(ctMock.app)
-			.post("/dummy/standalone-prices/" + id)
+			.post(`/dummy/standalone-prices/${id}`)
 			.send({
 				version: 1,
 				actions: [
@@ -250,7 +250,7 @@ describe("Standalone price Actions", () => {
 		});
 
 		const response2 = await supertest(ctMock.app)
-			.post("/dummy/standalone-prices/" + id)
+			.post(`/dummy/standalone-prices/${id}`)
 			.send({
 				version: 2,
 				actions: [

package/src/services/state.test.ts

@@ -1,4 +1,4 @@
-import { type StateDraft } from "@commercetools/platform-sdk";
+import type { StateDraft } from "@commercetools/platform-sdk";
 import supertest from "supertest";
 import { describe, expect, test } from "vitest";
 import { CommercetoolsMock } from "../index";

package/src/services/store.test.ts

@@ -21,7 +21,7 @@ describe("Store", () => {
 		});
 
 		const response = await supertest(ctMock.app).get(
-			`/dummy/stores/key=STOREKEY`,
+			"/dummy/stores/key=STOREKEY",
 		);
 
 		expect(response.status).toBe(200);
@@ -54,7 +54,7 @@ describe("Store", () => {
 		});
 
 		const response = await supertest(ctMock.app).get(
-			`/dummy/stores/key=DOESNOTEXIST`,
+			"/dummy/stores/key=DOESNOTEXIST",
 		);
 
 		expect(response.status).toBe(404);

package/src/services/tax-category.test.ts

@@ -65,7 +65,7 @@ describe("Tax Category", () => {
 		expect(createResponse.status).toBe(201);
 
 		const response = await supertest(ctMock.app)
-			.get(`/dummy/tax-categories/`)
+			.get("/dummy/tax-categories/")
 			.query({ where: `key="${createResponse.body.key}"` });
 
 		expect(response.status).toBe(200);

package/src/shipping.ts

@@ -106,12 +106,12 @@ export const getShippingMethodsMatchingCart = (
 		context.projectKey,
 		"shipping-method",
 		{
-			"where": [
-				`zoneRates(zone(id in (:zoneIds)))`,
+			where: [
+				"zoneRates(zone(id in (:zoneIds)))",
 				`zoneRates(shippingRates(price(currencyCode="${cart.totalPrice.currencyCode}")))`,
 			],
 			"var.zoneIds": zoneIds,
-			"expand": params.expand,
+			expand: params.expand,
 		},
 	);
 

package/src/storage/in-memory.ts

@@ -1,47 +1,47 @@
+import assert from "node:assert";
 import type {
 	InvalidJsonInputError,
 	ReferencedResourceNotFoundError,
 	ShoppingListLineItem,
 } from "@commercetools/platform-sdk";
-import {
-	type AssociateRole,
-	type AttributeGroup,
-	type BusinessUnit,
-	type Cart,
-	type CartDiscount,
-	type Category,
-	type Channel,
-	type CustomObject,
-	type Customer,
-	type CustomerGroup,
-	type DiscountCode,
-	type Extension,
-	type InvalidInputError,
-	type InventoryEntry,
-	type Order,
-	type PagedQueryResponse,
-	type Payment,
-	type Product,
-	type ProductDiscount,
-	type ProductProjection,
-	type ProductTailoring,
-	type ProductType,
-	type Project,
-	type Quote,
-	type QuoteRequest,
-	type Reference,
-	type ResourceIdentifier,
-	type ShippingMethod,
-	type ShoppingList,
-	type StagedQuote,
-	type State,
-	type Store,
-	type Subscription,
-	type TaxCategory,
-	type Type,
-	type Zone,
+import type {
+	AssociateRole,
+	AttributeGroup,
+	BusinessUnit,
+	Cart,
+	CartDiscount,
+	Category,
+	Channel,
+	CustomObject,
+	Customer,
+	CustomerGroup,
+	DiscountCode,
+	Extension,
+	InvalidInputError,
+	InventoryEntry,
+	Order,
+	PagedQueryResponse,
+	Payment,
+	Product,
+	ProductDiscount,
+	ProductProjection,
+	ProductTailoring,
+	ProductType,
+	Project,
+	Quote,
+	QuoteRequest,
+	Reference,
+	ResourceIdentifier,
+	ShippingMethod,
+	ShoppingList,
+	StagedQuote,
+	State,
+	Store,
+	Subscription,
+	TaxCategory,
+	Type,
+	Zone,
 } from "@commercetools/platform-sdk";
-import assert from "assert";
 import { CommercetoolsError } from "~src/exceptions";
 import { cloneObject } from "../helpers";
 import { parseExpandClause } from "../lib/expandParser";
@@ -174,38 +174,38 @@ export class InMemoryStorage extends AbstractStorage {
 				"associate-role": new Map<string, AssociateRole>(),
 				"attribute-group": new Map<string, AttributeGroup>(),
 				"business-unit": new Map<string, BusinessUnit>(),
-				"cart": new Map<string, Cart>(),
+				cart: new Map<string, Cart>(),
 				"cart-discount": new Map<string, CartDiscount>(),
-				"category": new Map<string, Category>(),
-				"channel": new Map<string, Channel>(),
-				"customer": new Map<string, Customer>(),
+				category: new Map<string, Category>(),
+				channel: new Map<string, Channel>(),
+				customer: new Map<string, Customer>(),
 				"customer-group": new Map<string, CustomerGroup>(),
 				"discount-code": new Map<string, DiscountCode>(),
-				"extension": new Map<string, Extension>(),
+				extension: new Map<string, Extension>(),
 				"inventory-entry": new Map<string, InventoryEntry>(),
 				"key-value-document": new Map<string, CustomObject>(),
-				"order": new Map<string, Order>(),
+				order: new Map<string, Order>(),
 				"order-edit": new Map<string, any>(),
-				"payment": new Map<string, Payment>(),
-				"product": new Map<string, Product>(),
-				"quote": new Map<string, Quote>(),
+				payment: new Map<string, Payment>(),
+				product: new Map<string, Product>(),
+				quote: new Map<string, Quote>(),
 				"quote-request": new Map<string, QuoteRequest>(),
 				"product-discount": new Map<string, ProductDiscount>(),
 				"product-selection": new Map<string, any>(),
 				"product-type": new Map<string, ProductType>(),
 				"product-projection": new Map<string, ProductProjection>(),
 				"product-tailoring": new Map<string, ProductTailoring>(),
-				"review": new Map<string, any>(),
+				review: new Map<string, any>(),
 				"shipping-method": new Map<string, ShippingMethod>(),
 				"staged-quote": new Map<string, StagedQuote>(),
-				"state": new Map<string, State>(),
-				"store": new Map<string, Store>(),
+				state: new Map<string, State>(),
+				store: new Map<string, Store>(),
 				"shopping-list": new Map<string, ShoppingList>(),
 				"standalone-price": new Map<string, any>(),
-				"subscription": new Map<string, Subscription>(),
+				subscription: new Map<string, Subscription>(),
 				"tax-category": new Map<string, TaxCategory>(),
-				"type": new Map<string, Type>(),
-				"zone": new Map<string, Zone>(),
+				type: new Map<string, Type>(),
+				zone: new Map<string, Zone>(),
 			};
 		}
 		return projectStorage;
@@ -416,11 +416,7 @@ export class InMemoryStorage extends AbstractStorage {
 
 			throw new CommercetoolsError<ReferencedResourceNotFoundError>({
 				code: "ReferencedResourceNotFound",
-				message:
-					`The referenced object of type '${identifier.typeId}' with id ` +
-					`'${identifier.id}' was not found. It either doesn't exist, or it ` +
-					`can't be accessed from this endpoint (e.g., if the endpoint ` +
-					`filters by store or customer account).`,
+				message: `The referenced object of type '${identifier.typeId}' with id '${identifier.id}' was not found. It either doesn't exist, or it can't be accessed from this endpoint (e.g., if the endpoint filters by store or customer account).`,
 				typeId: identifier.typeId,
 				id: identifier.id,
 			});
@@ -438,11 +434,7 @@ export class InMemoryStorage extends AbstractStorage {
 
 			throw new CommercetoolsError<ReferencedResourceNotFoundError>({
 				code: "ReferencedResourceNotFound",
-				message:
-					`The referenced object of type '${identifier.typeId}' with key ` +
-					`'${identifier.key}' was not found. It either doesn't exist, or it ` +
-					`can't be accessed from this endpoint (e.g., if the endpoint ` +
-					`filters by store or customer account).`,
+				message: `The referenced object of type '${identifier.typeId}' with key '${identifier.key}' was not found. It either doesn't exist, or it can't be accessed from this endpoint (e.g., if the endpoint filters by store or customer account).`,
 				typeId: identifier.typeId,
 				key: identifier.key,
 			});

package/src/testing/customer.ts

@@ -0,0 +1,40 @@
+import type { Customer, CustomerDraft } from "@commercetools/platform-sdk";
+import { Factory } from "fishery";
+import supertest from "supertest";
+import type { CommercetoolsMock } from "~src/ctMock";
+
+export const customerDraftFactory = (m: CommercetoolsMock) =>
+	Factory.define<CustomerDraft, CustomerDraft, Customer>(({ onCreate }) => {
+		onCreate(async (draft) => {
+			const response = await supertest(m.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",
+		};
+	});