@labdigital/commercetools-mock 2.61.2 → 2.62.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@labdigital/commercetools-mock",
-  "version": "2.61.2",
+  "version": "2.62.0",
   "license": "MIT",
   "author": "Michael van Tellingen",
   "type": "module",
@@ -13,7 +13,7 @@
   },
   "main": "dist/index.mjs",
   "module": "dist/index.mjs",
-  "typings": "dist/index.d.ts",
+  "typings": "dist/index.d.mts",
   "files": [
     "dist",
     "src"

package/src/repositories/as-associate.test.ts

@@ -1,3 +1,4 @@
+import type { ShoppingListDraft } from "@commercetools/platform-sdk";
 import { describe, expect, test } from "vitest";
 import type { Config } from "#src/config.ts";
 import { InMemoryStorage } from "#src/storage/index.ts";
@@ -5,6 +6,7 @@ import {
 	AsAssociateCartRepository,
 	AsAssociateOrderRepository,
 	AsAssociateQuoteRequestRepository,
+	AsAssociateShoppingListRepository,
 } from "./as-associate.ts";
 import { CustomerRepository } from "./customer/index.ts";
 
@@ -123,4 +125,27 @@ describe("As Associate Repositories", () => {
 		expect(retrieved).toBeDefined();
 		expect(retrieved?.id).toBe(quoteRequest.id);
 	});
+
+	test("AsAssociateShoppingListRepository can create and retrieve shopping lists", () => {
+		const repository = new AsAssociateShoppingListRepository(config);
+		const ctx = { projectKey: "test-project" };
+
+		const shoppingListDraft: ShoppingListDraft = {
+			name: { "en-US": "My Shopping List" },
+		};
+
+		const shoppingList = repository.create(ctx, shoppingListDraft);
+		expect(shoppingList.id).toBeDefined();
+		expect(shoppingList.version).toBe(1);
+
+		// Test query
+		const result = repository.query(ctx);
+		expect(result.count).toBe(1);
+		expect(result.results[0].id).toBe(shoppingList.id);
+
+		// Test get
+		const retrieved = repository.get(ctx, shoppingList.id);
+		expect(retrieved).toBeDefined();
+		expect(retrieved?.id).toBe(shoppingList.id);
+	});
 });

package/src/repositories/as-associate.ts

@@ -1,7 +1,9 @@
 import { CartRepository } from "./cart/index.ts";
 import { OrderRepository } from "./order/index.ts";
 import { QuoteRequestRepository } from "./quote-request/index.ts";
+import { ShoppingListRepository } from "./shopping-list/index.ts";
 
 export class AsAssociateOrderRepository extends OrderRepository {}
 export class AsAssociateCartRepository extends CartRepository {}
 export class AsAssociateQuoteRequestRepository extends QuoteRequestRepository {}
+export class AsAssociateShoppingListRepository extends ShoppingListRepository {}

package/src/repositories/business-unit.ts

@@ -1,4 +1,6 @@
+import assert from "node:assert";
 import type {
+	Address,
 	Associate,
 	BusinessUnit,
 	BusinessUnitAddAddressAction,
@@ -32,8 +34,10 @@ import type {
 	CompanyDraft,
 	Division,
 	DivisionDraft,
+	InvalidOperationError,
 } from "@commercetools/platform-sdk";
 import type { Config } from "#src/config.ts";
+import { CommercetoolsError } from "#src/exceptions.ts";
 import { generateRandomString, getBaseResourceProperties } from "../helpers.ts";
 import type { Writable } from "../types.ts";
 import type { UpdateHandlerInterface } from "./abstract.ts";
@@ -201,22 +205,23 @@ class BusinessUnitUpdateHandler
 	changeAddress(
 		context: RepositoryContext,
 		resource: Writable<BusinessUnit>,
-		{ addressId, address }: BusinessUnitChangeAddressAction,
+		{ addressId, addressKey, address }: BusinessUnitChangeAddressAction,
 	) {
-		const existingAddressIndex = resource.addresses.findIndex(
-			(addr) => addr.id === addressId,
+		const current = this._findAddress(resource, addressId, addressKey, true);
+		assert(current?.id); // always true since we set required to true
+
+		const oldAddressIndex = resource.addresses.findIndex(
+			(a) => a.id === current.id,
 		);
-		if (existingAddressIndex === -1) {
-			throw new Error(`Address with id ${addressId} not found`);
-		}
 
 		const newAddress = createAddress(
-			{ ...address, id: addressId },
+			{ ...address, id: current.id },
 			context.projectKey,
 			this._storage,
 		);
+
 		if (newAddress) {
-			resource.addresses[existingAddressIndex] = newAddress;
+			resource.addresses[oldAddressIndex] = newAddress;
 		}
 	}
 
@@ -344,35 +349,49 @@ class BusinessUnitUpdateHandler
 	setDefaultShippingAddress(
 		context: RepositoryContext,
 		resource: Writable<BusinessUnit>,
-		{ addressId }: BusinessUnitSetDefaultShippingAddressAction,
+		{ addressId, addressKey }: BusinessUnitSetDefaultShippingAddressAction,
 	) {
-		resource.defaultShippingAddressId = addressId;
+		const address = this._findAddress(resource, addressId, addressKey, true);
+		assert(address?.id); // always true since we set required to true
+
+		resource.defaultShippingAddressId = address.id;
+		if (resource.shippingAddressIds === undefined) {
+			resource.shippingAddressIds = [];
+		}
+		if (!resource.shippingAddressIds.includes(address.id)) {
+			resource.shippingAddressIds.push(address.id);
+		}
 	}
 
 	addShippingAddressId(
 		context: RepositoryContext,
 		resource: Writable<BusinessUnit>,
-		{ addressId }: BusinessUnitAddShippingAddressIdAction,
+		{ addressId, addressKey }: BusinessUnitAddShippingAddressIdAction,
 	) {
-		if (!resource.shippingAddressIds) {
+		const address = this._findAddress(resource, addressId, addressKey, true);
+		assert(address?.id); // always true since we set required to true
+
+		if (resource.shippingAddressIds === undefined) {
 			resource.shippingAddressIds = [];
 		}
-		if (addressId) {
-			resource.shippingAddressIds.push(addressId);
+
+		if (!resource.shippingAddressIds.includes(address.id)) {
+			resource.shippingAddressIds.push(address.id);
 		}
+		return resource;
 	}
 
 	removeShippingAddressId(
 		context: RepositoryContext,
 		resource: Writable<BusinessUnit>,
-		{ addressId }: BusinessUnitRemoveShippingAddressIdAction,
+		{ addressId, addressKey }: BusinessUnitRemoveShippingAddressIdAction,
 	) {
-		if (resource.shippingAddressIds) {
-			resource.shippingAddressIds = resource.shippingAddressIds.filter(
-				(id) => id !== addressId,
-			);
-		}
-		if (resource.defaultShippingAddressId === addressId) {
+		const address = this._findAddress(resource, addressId, addressKey, true);
+		assert(address?.id); // always true since we set required to true
+		resource.shippingAddressIds = resource.shippingAddressIds?.filter(
+			(id) => id !== address.id,
+		);
+		if (resource.defaultShippingAddressId === address.id) {
 			resource.defaultShippingAddressId = undefined;
 		}
 	}
@@ -380,27 +399,31 @@ class BusinessUnitUpdateHandler
 	addBillingAddressId(
 		context: RepositoryContext,
 		resource: Writable<BusinessUnit>,
-		{ addressId }: BusinessUnitAddBillingAddressIdAction,
+		{ addressId, addressKey }: BusinessUnitAddBillingAddressIdAction,
 	) {
-		if (!resource.billingAddressIds) {
+		const address = this._findAddress(resource, addressId, addressKey, true);
+		assert(address?.id); // always true since we set required to true
+
+		if (resource.billingAddressIds === undefined) {
 			resource.billingAddressIds = [];
 		}
-		if (addressId) {
-			resource.billingAddressIds.push(addressId);
+
+		if (!resource.billingAddressIds.includes(address.id)) {
+			resource.billingAddressIds.push(address.id);
 		}
 	}
 
 	removeBillingAddressId(
 		context: RepositoryContext,
 		resource: Writable<BusinessUnit>,
-		{ addressId }: BusinessUnitRemoveBillingAddressIdAction,
+		{ addressId, addressKey }: BusinessUnitRemoveBillingAddressIdAction,
 	) {
-		if (resource.billingAddressIds) {
-			resource.billingAddressIds = resource.billingAddressIds.filter(
-				(id) => id !== addressId,
-			);
-		}
-		if (resource.defaultBillingAddressId === addressId) {
+		const address = this._findAddress(resource, addressId, addressKey, true);
+		assert(address?.id); // always true since we set required to true
+		resource.billingAddressIds = resource.billingAddressIds?.filter(
+			(id) => id !== address.id,
+		);
+		if (resource.defaultBillingAddressId === address.id) {
 			resource.defaultBillingAddressId = undefined;
 		}
 	}
@@ -408,9 +431,18 @@ class BusinessUnitUpdateHandler
 	setDefaultBillingAddress(
 		context: RepositoryContext,
 		resource: Writable<BusinessUnit>,
-		{ addressId }: BusinessUnitSetDefaultBillingAddressAction,
+		{ addressId, addressKey }: BusinessUnitSetDefaultBillingAddressAction,
 	) {
-		resource.defaultBillingAddressId = addressId;
+		const address = this._findAddress(resource, addressId, addressKey, true);
+		assert(address?.id); // always true since we set required to true
+
+		resource.defaultBillingAddressId = address.id;
+		if (resource.billingAddressIds === undefined) {
+			resource.billingAddressIds = [];
+		}
+		if (!resource.billingAddressIds.includes(address.id)) {
+			resource.billingAddressIds.push(address.id);
+		}
 	}
 
 	setCustomField(
@@ -467,28 +499,73 @@ class BusinessUnitUpdateHandler
 	removeAddress(
 		context: RepositoryContext,
 		resource: Writable<BusinessUnit>,
-		{ addressId }: BusinessUnitRemoveAddressAction,
+		{ addressId, addressKey }: BusinessUnitRemoveAddressAction,
 	) {
-		resource.addresses = resource.addresses.filter(
-			(addr) => addr.id !== addressId,
-		);
+		const address = this._findAddress(resource, addressId, addressKey, true);
+		assert(address?.id); // always true since we set required to true
+		resource.addresses = resource.addresses.filter((a) => a.id !== address.id);
 
 		if (resource.shippingAddressIds) {
 			resource.shippingAddressIds = resource.shippingAddressIds.filter(
-				(id) => id !== addressId,
+				(id) => id !== address.id,
 			);
 		}
 		if (resource.billingAddressIds) {
 			resource.billingAddressIds = resource.billingAddressIds.filter(
-				(id) => id !== addressId,
+				(id) => id !== address.id,
 			);
 		}
 
-		if (resource.defaultShippingAddressId === addressId) {
+		if (resource.defaultShippingAddressId === address.id) {
 			resource.defaultShippingAddressId = undefined;
 		}
-		if (resource.defaultBillingAddressId === addressId) {
+		if (resource.defaultBillingAddressId === address.id) {
 			resource.defaultBillingAddressId = undefined;
 		}
 	}
+
+	private _findAddress(
+		resource: Writable<BusinessUnit>,
+		addressId: string | undefined,
+		addressKey: string | undefined,
+		required = false,
+	): Address | undefined {
+		if (addressKey) {
+			const address = resource.addresses.find((a) => a.key === addressKey);
+			if (!address) {
+				throw new CommercetoolsError<InvalidOperationError>(
+					{
+						code: "InvalidOperation",
+						message: `Business Unit does not contain an address with the key ${addressKey}.`,
+					},
+					400,
+				);
+			}
+			return address;
+		}
+
+		if (addressId) {
+			const address = resource.addresses.find((a) => a.id === addressId);
+			if (!address) {
+				throw new CommercetoolsError<InvalidOperationError>(
+					{
+						code: "InvalidOperation",
+						message: `Business Unit does not contain an address with the id ${addressId}.`,
+					},
+					400,
+				);
+			}
+			return address;
+		}
+
+		if (required) {
+			throw new CommercetoolsError<InvalidOperationError>(
+				{
+					code: "InvalidOperation",
+					message: "One of address 'addressId' or 'addressKey' is required.",
+				},
+				400,
+			);
+		}
+	}
 }

package/src/repositories/customer/actions.ts

@@ -149,6 +149,24 @@ export class CustomerUpdateHandler
 		);
 		assert(address?.id); // always true since we set required to true
 		resource.addresses = resource.addresses.filter((a) => a.id !== address.id);
+
+		if (resource.shippingAddressIds) {
+			resource.shippingAddressIds = resource.shippingAddressIds.filter(
+				(id) => id !== address.id,
+			);
+		}
+		if (resource.billingAddressIds) {
+			resource.billingAddressIds = resource.billingAddressIds.filter(
+				(id) => id !== address.id,
+			);
+		}
+
+		if (resource.defaultShippingAddressId === address.id) {
+			resource.defaultShippingAddressId = undefined;
+		}
+		if (resource.defaultBillingAddressId === address.id) {
+			resource.defaultBillingAddressId = undefined;
+		}
 	}
 
 	removeBillingAddressId(

package/src/repositories/index.ts

@@ -4,6 +4,7 @@ import {
 	AsAssociateCartRepository,
 	AsAssociateOrderRepository,
 	AsAssociateQuoteRequestRepository,
+	AsAssociateShoppingListRepository,
 } from "./as-associate.ts";
 import { AssociateRoleRepository } from "./associate-role.ts";
 import { AttributeGroupRepository } from "./attribute-group.ts";
@@ -53,6 +54,7 @@ export const createRepositories = (config: Config) => ({
 		cart: new AsAssociateCartRepository(config),
 		order: new AsAssociateOrderRepository(config),
 		"quote-request": new AsAssociateQuoteRequestRepository(config),
+		"shopping-list": new AsAssociateShoppingListRepository(config),
 	},
 	"associate-role": new AssociateRoleRepository(config),
 	"attribute-group": new AttributeGroupRepository(config),

package/src/services/as-associate-shopping-list.test.ts

@@ -0,0 +1,58 @@
+import supertest from "supertest";
+import { describe, expect, test } from "vitest";
+import { CommercetoolsMock } from "../index.ts";
+
+const ctMock = new CommercetoolsMock();
+const projectKey = "dummy";
+const customerId = "5fac8fca-2484-4b14-a1d1-cfdce2f8d3c4";
+const businessUnitKey = "test-business-unit";
+
+describe("AsAssociateShoppingList", () => {
+	test("Create shopping list", async () => {
+		const draft = {
+			name: { en: "My list" },
+		};
+		const response = await supertest(ctMock.app)
+			.post(
+				`/${projectKey}/as-associate/${customerId}/in-business-unit/key=${businessUnitKey}/shopping-lists`,
+			)
+			.send(draft);
+
+		expect(response.status).toBe(201);
+		expect(response.body.id).toBeDefined();
+	});
+
+	test("Get shopping list", async () => {
+		const createResponse = await supertest(ctMock.app)
+			.post(
+				`/${projectKey}/as-associate/${customerId}/in-business-unit/key=${businessUnitKey}/shopping-lists`,
+			)
+			.send({ name: { en: "Groceries" } });
+
+		expect(createResponse.status).toBe(201);
+
+		const response = await supertest(ctMock.app).get(
+			`/${projectKey}/as-associate/${customerId}/in-business-unit/key=${businessUnitKey}/shopping-lists/${createResponse.body.id}`,
+		);
+
+		expect(response.status).toBe(200);
+		expect(response.body).toEqual(createResponse.body);
+	});
+
+	test("Query shopping lists", async () => {
+		const createResponse = await supertest(ctMock.app)
+			.post(
+				`/${projectKey}/as-associate/${customerId}/in-business-unit/key=${businessUnitKey}/shopping-lists`,
+			)
+			.send({ name: { en: "Errands" } });
+
+		expect(createResponse.status).toBe(201);
+
+		const response = await supertest(ctMock.app).get(
+			`/${projectKey}/as-associate/${customerId}/in-business-unit/key=${businessUnitKey}/shopping-lists`,
+		);
+
+		expect(response.status).toBe(200);
+		expect(response.body.count).toBeGreaterThan(0);
+	});
+});

package/src/services/as-associate-shopping-list.ts

@@ -0,0 +1,33 @@
+import { Router } from "express";
+import type { ShoppingListRepository } from "#src/repositories/shopping-list/index.ts";
+import AbstractService from "./abstract.ts";
+
+export class AsAssociateShoppingListService extends AbstractService {
+	public repository: ShoppingListRepository;
+
+	constructor(parent: Router, repository: ShoppingListRepository) {
+		super(parent);
+		this.repository = repository;
+	}
+
+	getBasePath() {
+		return "shopping-lists";
+	}
+
+	registerRoutes(parent: Router) {
+		const basePath = this.getBasePath();
+		const router = Router({ mergeParams: true });
+
+		this.extraRoutes(router);
+
+		router.get("/", this.get.bind(this));
+		router.get("/:id", this.getWithId.bind(this));
+
+		router.delete("/:id", this.deleteWithId.bind(this));
+
+		router.post("/", this.post.bind(this));
+		router.post("/:id", this.postWithId.bind(this));
+
+		parent.use(`/${basePath}`, router);
+	}
+}

package/src/services/as-associate.ts

@@ -3,15 +3,18 @@ import type {
 	AsAssociateCartRepository,
 	AsAssociateOrderRepository,
 	AsAssociateQuoteRequestRepository,
+	AsAssociateShoppingListRepository,
 } from "#src/repositories/as-associate.ts";
 import { AsAssociateCartService } from "./as-associate-cart.ts";
 import { AsAssociateOrderService } from "./as-associate-order.ts";
 import { AsAssociateQuoteRequestService } from "./as-associate-quote-request.ts";
+import { AsAssociateShoppingListService } from "./as-associate-shopping-list.ts";
 
 type Repositories = {
 	cart: AsAssociateCartRepository;
 	order: AsAssociateOrderRepository;
 	"quote-request": AsAssociateQuoteRequestRepository;
+	"shopping-list": AsAssociateShoppingListRepository;
 };
 
 export class AsAssociateService {
@@ -21,6 +24,7 @@ export class AsAssociateService {
 		cart: AsAssociateCartService;
 		order: AsAssociateOrderService;
 		"quote-request": AsAssociateQuoteRequestService;
+		"shopping-list": AsAssociateShoppingListService;
 	};
 
 	constructor(parent: Router, repositories: Repositories) {
@@ -33,6 +37,10 @@ export class AsAssociateService {
 				this.router,
 				repositories["quote-request"],
 			),
+			"shopping-list": new AsAssociateShoppingListService(
+				this.router,
+				repositories["shopping-list"],
+			),
 		};
 		parent.use(
 			"/as-associate/:associateId/in-business-unit/key=:businessUnitId",