@labdigital/commercetools-mock 2.37.0 → 2.38.0

package/src/services/customer.test.ts

@@ -1,9 +1,10 @@
-import {
+import type {
 	Customer,
 	CustomerDraft,
 	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";
@@ -11,12 +12,67 @@ 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 response = await supertest(ctMock.app)
+			.post(`/dummy/customers`)
+			.send(draft);
+
+		const customer = response.body.customer as Customer;
+		expect(response.status, JSON.stringify(customer)).toBe(201);
+		expect(customer.version).toBe(1);
+		expect(customer.defaultBillingAddressId).toBeUndefined();
+		expect(customer.defaultShippingAddressId).toBeUndefined();
+		expect(customer.billingAddressIds).toHaveLength(0);
+		expect(customer.shippingAddressIds).toHaveLength(0);
+	});
+
+	test("create new customer with default billing & shipping address", async () => {
 		const draft: CustomerDraft = {
 			email: "new-user@example.com",
 			password: "supersecret",
@@ -33,8 +89,8 @@ describe("Customer create", () => {
 					country: "DE",
 				},
 			],
-			billingAddresses: [0],
-			shippingAddresses: [0],
+			defaultBillingAddress: 0,
+			defaultShippingAddress: 0,
 		};
 
 		const response = await supertest(ctMock.app)
@@ -44,14 +100,373 @@ describe("Customer create", () => {
 		const customer = response.body.customer as Customer;
 		expect(response.status, JSON.stringify(customer)).toBe(201);
 		expect(customer.version).toBe(1);
-		expect(customer.defaultBillingAddressId).toBeUndefined();
-		expect(customer.defaultShippingAddressId).toBeUndefined();
+		expect(customer.defaultBillingAddressId).toBeDefined();
+		expect(customer.defaultShippingAddressId).toBeDefined();
+		expect(customer.billingAddressIds).toHaveLength(0);
+		expect(customer.shippingAddressIds).toHaveLength(0);
+	});
+});
+
+describe("Customer Update Actions", () => {
+	test("addAddress", async () => {
+		const customer = await customerDraftFactory.create();
+		const response = await supertest(ctMock.app)
+			.post(`/dummy/customers/${customer.id}`)
+			.send({
+				version: 1,
+				actions: [
+					{
+						action: "addAddress",
+						address: {
+							firstName: "Foo",
+							lastName: "Bar",
+							streetName: "Baz Street",
+							streetNumber: "99",
+							postalCode: "12ab",
+							country: "NL",
+						},
+					},
+				],
+			});
+		expect(response.status).toBe(200);
+		expect(response.body.version).toBe(2);
+		expect(response.body.addresses).toHaveLength(2);
+	});
+
+	test("removeAddress by ID", async () => {
+		const customer = await customerDraftFactory.create({
+			addresses: [
+				{
+					key: "address-key",
+					firstName: "John",
+					lastName: "Doe",
+					streetName: "Main Street",
+					streetNumber: "1",
+					postalCode: "12345",
+					country: "DE",
+				},
+			],
+		});
+
+		const response = await supertest(ctMock.app)
+			.post(`/dummy/customers/${customer.id}`)
+			.send({
+				version: 1,
+				actions: [
+					{
+						action: "removeAddress",
+						addressId: customer.addresses[0].id,
+					},
+				],
+			});
+		expect(response.status, JSON.stringify(response.body)).toBe(200);
+		expect(response.body.version).toBe(2);
+		expect(response.body.addresses).toHaveLength(0);
+	});
+
+	test("removeAddress by Key", async () => {
+		const customer = await customerDraftFactory.create({
+			addresses: [
+				{
+					key: "address-key",
+					firstName: "John",
+					lastName: "Doe",
+					streetName: "Main Street",
+					streetNumber: "1",
+					postalCode: "12345",
+					country: "DE",
+				},
+			],
+		});
+
+		const response = await supertest(ctMock.app)
+			.post(`/dummy/customers/${customer.id}`)
+			.send({
+				version: 1,
+				actions: [
+					{
+						action: "removeAddress",
+						addressKey: customer.addresses[0].key,
+					},
+				],
+			});
+		expect(response.status, JSON.stringify(response.body)).toBe(200);
+		expect(response.body.version).toBe(2);
+		expect(response.body.addresses).toHaveLength(0);
+	});
+
+	test("changeAddress by ID", async () => {
+		const customer = await customerDraftFactory.create({
+			addresses: [
+				{
+					key: "address-key",
+					firstName: "John",
+					lastName: "Doe",
+					streetName: "Main Street",
+					streetNumber: "1",
+					postalCode: "12345",
+					country: "DE",
+				},
+			],
+		});
+		const addressId = customer.addresses[0].id;
+
+		const response = await supertest(ctMock.app)
+			.post(`/dummy/customers/${customer.id}`)
+			.send({
+				version: 1,
+				actions: [
+					{
+						action: "changeAddress",
+						addressId: addressId,
+						address: {
+							firstName: "Foo",
+							lastName: "Bar",
+							streetName: "Baz Street",
+							streetNumber: "99",
+							postalCode: "12ab",
+							country: "NL",
+						},
+					},
+				],
+			});
+		expect(response.status, JSON.stringify(response.body)).toBe(200);
+		const result = response.body as Customer;
+		expect(result.version).toBe(2);
+		expect(result.addresses).toHaveLength(1);
+		expect(result.addresses).toStrictEqual([
+			{
+				id: addressId,
+				firstName: "Foo",
+				lastName: "Bar",
+				streetName: "Baz Street",
+				streetNumber: "99",
+				postalCode: "12ab",
+				country: "NL",
+			},
+		]);
+	});
+
+	test("addBillingAddressId", async () => {
+		const customer = await customerDraftFactory.create({
+			addresses: [
+				{
+					key: "address-key",
+					firstName: "John",
+					lastName: "Doe",
+					streetName: "Main Street",
+					streetNumber: "1",
+					postalCode: "12345",
+					country: "DE",
+				},
+			],
+		});
+
+		const response = await supertest(ctMock.app)
+			.post(`/dummy/customers/${customer.id}`)
+			.send({
+				version: 1,
+				actions: [
+					{
+						action: "addBillingAddressId",
+						addressId: customer.addresses[0].id,
+					},
+				],
+			});
+		expect(response.status).toBe(200);
+		expect(response.body.version).toBe(2);
+		expect(response.body.shippingAddressIds).toHaveLength(0);
+		expect(response.body.billingAddressIds).toHaveLength(1);
+	});
+
+	test("removeBillingAddressId", async () => {
+		const customer = await customerDraftFactory.create({
+			addresses: [
+				{
+					key: "address-key",
+					firstName: "John",
+					lastName: "Doe",
+					streetName: "Main Street",
+					streetNumber: "1",
+					postalCode: "12345",
+					country: "DE",
+				},
+			],
+			billingAddresses: [0],
+			defaultBillingAddress: 0,
+		});
 		expect(customer.billingAddressIds).toHaveLength(1);
+		expect(customer.defaultBillingAddressId).toBeDefined();
+
+		const addressId = customer.addresses[0].id;
+		const response = await supertest(ctMock.app)
+			.post(`/dummy/customers/${customer.id}`)
+			.send({
+				version: 1,
+				actions: [
+					{
+						action: "removeBillingAddressId",
+						addressId: addressId,
+					},
+				],
+			});
+		expect(response.status).toBe(200);
+		const result = response.body as Customer;
+		expect(result.version).toBe(2);
+		expect(result.billingAddressIds).toHaveLength(0);
+		expect(result.defaultBillingAddressId).toBeUndefined();
+	});
+
+	test("setDefaultBillingAddress by ID", async () => {
+		const customer = await customerDraftFactory.create({
+			defaultBillingAddress: undefined,
+			defaultShippingAddress: undefined,
+			addresses: [
+				{
+					key: "address-key",
+					firstName: "John",
+					lastName: "Doe",
+					streetName: "Main Street",
+					streetNumber: "1",
+					postalCode: "12345",
+					country: "DE",
+				},
+			],
+			shippingAddresses: [],
+			billingAddresses: [],
+		});
+		const addressId = customer.addresses[0].id;
+
+		const response = await supertest(ctMock.app)
+			.post(`/dummy/customers/${customer.id}`)
+			.send({
+				version: customer.version,
+				actions: [
+					{
+						action: "setDefaultBillingAddress",
+						addressId: addressId,
+					},
+				],
+			});
+		expect(response.status, JSON.stringify(response.body)).toBe(200);
+		expect(response.body.version).toBe(2);
+		expect(response.body.defaultBillingAddressId).toBe(addressId);
+		expect(response.body.addresses).toHaveLength(1);
+		expect(response.body.billingAddressIds).toContain(addressId);
+	});
+
+	test("addShippingAddressId", async () => {
+		const customer = await customerDraftFactory.create({
+			addresses: [
+				{
+					key: "address-key",
+					firstName: "John",
+					lastName: "Doe",
+					streetName: "Main Street",
+					streetNumber: "1",
+					postalCode: "12345",
+					country: "DE",
+				},
+			],
+		});
+
+		const response = await supertest(ctMock.app)
+			.post(`/dummy/customers/${customer.id}`)
+			.send({
+				version: 1,
+				actions: [
+					{
+						action: "addShippingAddressId",
+						addressId: customer.addresses[0].id,
+					},
+				],
+			});
+		expect(response.status).toBe(200);
+		expect(response.body.version).toBe(2);
+		expect(response.body.shippingAddressIds).toHaveLength(1);
+	});
+
+	test("removeShippingAddressId", async () => {
+		const customer = await customerDraftFactory.create({
+			addresses: [
+				{
+					key: "address-key",
+					firstName: "John",
+					lastName: "Doe",
+					streetName: "Main Street",
+					streetNumber: "1",
+					postalCode: "12345",
+					country: "DE",
+				},
+			],
+			shippingAddresses: [0],
+			defaultShippingAddress: 0,
+		});
 		expect(customer.shippingAddressIds).toHaveLength(1);
+		expect(customer.defaultShippingAddressId).toBeDefined();
+
+		const addressId = customer.addresses[0].id;
+		const response = await supertest(ctMock.app)
+			.post(`/dummy/customers/${customer.id}`)
+			.send({
+				version: 1,
+				actions: [
+					{
+						action: "removeShippingAddressId",
+						addressId: addressId,
+					},
+				],
+			});
+		expect(response.status).toBe(200);
+		const result = response.body as Customer;
+		expect(result.version).toBe(2);
+		expect(result.shippingAddressIds).toHaveLength(0);
+		expect(result.defaultShippingAddressId).toBeUndefined();
+	});
+
+	test("setDefaultShippingAddress by ID", async () => {
+		const customer = await customerDraftFactory.create({
+			defaultBillingAddress: undefined,
+			defaultShippingAddress: undefined,
+			addresses: [
+				{
+					key: "address-key",
+					firstName: "John",
+					lastName: "Doe",
+					streetName: "Main Street",
+					streetNumber: "1",
+					postalCode: "12345",
+					country: "DE",
+				},
+			],
+			shippingAddresses: [],
+			billingAddresses: [],
+		});
+		const addressId = customer.addresses[0].id;
+
+		const response = await supertest(ctMock.app)
+			.post(`/dummy/customers/${customer.id}`)
+			.send({
+				version: customer.version,
+				actions: [
+					{
+						action: "setDefaultShippingAddress",
+						addressId: addressId,
+					},
+				],
+			});
+		expect(response.status, JSON.stringify(response.body)).toBe(200);
+		const result = response.body as Customer;
+		expect(result.version).toBe(2);
+		expect(result.defaultShippingAddressId).toBe(addressId);
+		expect(result.addresses).toHaveLength(1);
+		expect(result.shippingAddressIds).toContain(addressId);
 	});
 });
 
-describe("Customer Update Actions", () => {
+// These tests use ctMock.project().add(), which we want to move away from.
+// Please add new test to the previous section.
+describe("Customer Update Actions (old-style)", () => {
 	let customer: Customer | undefined;
 
 	beforeEach(async () => {
@@ -142,7 +557,7 @@ describe("Customer Update Actions", () => {
 	test("setAuthenticationMode error when setting current authMode", async () => {
 		assert(customer, "customer not created");
 		assert(
-			customer.authenticationMode == "Password",
+			customer.authenticationMode === "Password",
 			"customer not in default state",
 		);
 
@@ -360,131 +775,6 @@ describe("Customer Update Actions", () => {
 		expect(response.body.vatId).toBe("ABCD");
 	});
 
-	test("addAddress", async () => {
-		assert(customer, "customer not created");
-
-		customer = {
-			...customer,
-			addresses: [
-				{
-					...getBaseResourceProperties(),
-					id: "address-uuid",
-					firstName: "John",
-					lastName: "Doe",
-					streetName: "Main Street",
-					streetNumber: "1",
-					postalCode: "12345",
-					country: "DE",
-				},
-			],
-			defaultBillingAddressId: "address-uuid",
-		};
-		ctMock.project("dummy").add("customer", customer);
-
-		const response = await supertest(ctMock.app)
-			.post(`/dummy/customers/${customer.id}`)
-			.send({
-				version: 1,
-				actions: [
-					{
-						action: "addAddress",
-						address: {
-							firstName: "Foo",
-							lastName: "Bar",
-							streetName: "Baz Street",
-							streetNumber: "99",
-							postalCode: "12ab",
-							country: "NL",
-						},
-					},
-				],
-			});
-		expect(response.status).toBe(200);
-		expect(response.body.version).toBe(2);
-		expect(response.body.addresses).toMatchObject([
-			{
-				id: "address-uuid",
-				firstName: "John",
-				lastName: "Doe",
-				streetName: "Main Street",
-				streetNumber: "1",
-				postalCode: "12345",
-				country: "DE",
-			},
-			{
-				id: expect.any(String),
-				firstName: "Foo",
-				lastName: "Bar",
-				streetName: "Baz Street",
-				streetNumber: "99",
-				postalCode: "12ab",
-				country: "NL",
-			},
-		]);
-	});
-
-	test("addBillingAddressId", async () => {
-		assert(customer, "customer not created");
-
-		customer = {
-			...customer,
-			addresses: [
-				{
-					key: "address-key",
-					firstName: "John",
-					lastName: "Doe",
-					streetName: "Main Street",
-					streetNumber: "1",
-					postalCode: "12345",
-					country: "DE",
-				},
-			],
-		};
-		ctMock.project("dummy").add("customer", customer);
-
-		const response = await supertest(ctMock.app)
-			.post(`/dummy/customers/${customer.id}`)
-			.send({
-				version: 1,
-				actions: [{ action: "addBillingAddressId", addressKey: "address-key" }],
-			});
-		expect(response.status).toBe(200);
-		expect(response.body.version).toBe(2);
-		expect(response.body.billingAddressIds).toHaveLength(1);
-	});
-
-	test("addShippingAddressId", async () => {
-		assert(customer, "customer not created");
-
-		customer = {
-			...customer,
-			addresses: [
-				{
-					key: "address-key",
-					firstName: "John",
-					lastName: "Doe",
-					streetName: "Main Street",
-					streetNumber: "1",
-					postalCode: "12345",
-					country: "DE",
-				},
-			],
-		};
-		ctMock.project("dummy").add("customer", customer);
-
-		const response = await supertest(ctMock.app)
-			.post(`/dummy/customers/${customer.id}`)
-			.send({
-				version: 1,
-				actions: [
-					{ action: "addShippingAddressId", addressKey: "address-key" },
-				],
-			});
-		expect(response.status).toBe(200);
-		expect(response.body.version).toBe(2);
-		expect(response.body.shippingAddressIds).toHaveLength(1);
-	});
-
 	test("changeAddress", async () => {
 		assert(customer, "customer not created");
 

package/src/services/customer.ts

@@ -1,6 +1,7 @@
-import { CustomerSignInResult } from "@commercetools/platform-sdk";
-import { Router, type Request, type Response } from "express";
-import { CustomerRepository } from "../repositories/customer";
+import type { CustomerSignInResult } from "@commercetools/platform-sdk";
+import type { Router } from "express";
+import { type Request, type Response } from "express";
+import type { CustomerRepository } from "../repositories/customer";
 import { getRepositoryContext } from "../repositories/helpers";
 import AbstractService from "./abstract";
 

package/src/services/discount-code.ts

@@ -1,5 +1,5 @@
-import { Router } from "express";
-import { DiscountCodeRepository } from "../repositories/discount-code/index";
+import type { Router } from "express";
+import type { DiscountCodeRepository } from "../repositories/discount-code/index";
 import AbstractService from "./abstract";
 
 export class DiscountCodeService extends AbstractService {

package/src/services/extension.ts

@@ -1,5 +1,5 @@
-import { Router } from "express";
-import { ExtensionRepository } from "../repositories/extension";
+import type { Router } from "express";
+import type { ExtensionRepository } from "../repositories/extension";
 import AbstractService from "./abstract";
 
 export class ExtensionServices extends AbstractService {

package/src/services/index.ts

@@ -1,4 +1,4 @@
-import { createRepositories } from "../repositories";
+import type { createRepositories } from "../repositories";
 import { AssociateRoleServices } from "./associate-roles";
 import { AttributeGroupService } from "./attribute-group";
 import { BusinessUnitServices } from "./business-units";

package/src/services/inventory-entry.ts

@@ -1,5 +1,5 @@
-import { Router } from "express";
-import { InventoryEntryRepository } from "../repositories/inventory-entry";
+import type { Router } from "express";
+import type { InventoryEntryRepository } from "../repositories/inventory-entry";
 import AbstractService from "./abstract";
 
 export class InventoryEntryService extends AbstractService {

package/src/services/my-business-unit.ts

@@ -1,5 +1,5 @@
 import { Router } from "express";
-import { BusinessUnitRepository } from "~src/repositories/business-unit";
+import type { BusinessUnitRepository } from "~src/repositories/business-unit";
 import AbstractService from "./abstract";
 
 export class MyBusinessUnitService extends AbstractService {

package/src/services/my-cart.ts

@@ -1,5 +1,6 @@
-import { Request, Response, Router } from "express";
-import { CartRepository } from "../repositories/cart";
+import type { Request, Response } from "express";
+import { Router } from "express";
+import type { CartRepository } from "../repositories/cart";
 import AbstractService from "./abstract";
 
 export class MyCartService extends AbstractService {

package/src/services/my-customer.ts

@@ -1,10 +1,11 @@
-import { Update } from "@commercetools/platform-sdk";
-import { Request, Response, Router } from "express";
+import type { Update } from "@commercetools/platform-sdk";
+import type { Request, Response } from "express";
+import { Router } from "express";
 import { updateRequestSchema } from "~src/schemas/update-request";
 import { validateData } from "~src/validate";
 import { hashPassword } from "../lib/password";
 import { getRepositoryContext } from "../repositories/helpers";
-import { MyCustomerRepository } from "../repositories/my-customer";
+import type { MyCustomerRepository } from "../repositories/my-customer";
 import AbstractService from "./abstract";
 
 export class MyCustomerService extends AbstractService {

package/src/services/my-order.ts

@@ -1,5 +1,5 @@
 import { Router } from "express";
-import { MyOrderRepository } from "../repositories/my-order";
+import type { MyOrderRepository } from "../repositories/my-order";
 import AbstractService from "./abstract";
 
 export class MyOrderService extends AbstractService {

package/src/services/my-payment.ts

@@ -1,5 +1,5 @@
-import { Router } from "express";
-import { PaymentRepository } from "../repositories/payment";
+import type { Router } from "express";
+import type { PaymentRepository } from "../repositories/payment";
 import AbstractService from "./abstract";
 
 export class MyPaymentService extends AbstractService {