@labdigital/commercetools-mock 2.14.2 → 2.16.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@labdigital/commercetools-mock",
   "author": "Michael van Tellingen",
-  "version": "2.14.2",
+  "version": "2.16.0",
   "license": "MIT",
   "main": "dist/index.cjs",
   "module": "dist/index.js",

package/src/repositories/customer.ts

@@ -9,6 +9,7 @@ import type {
 	CustomerSetFirstNameAction,
 	CustomerSetLastNameAction,
 	CustomerSetVatIdAction,
+	CustomerSetCustomerNumberAction,
 	DuplicateFieldError,
 	InvalidInputError,
 	InvalidJsonInputError,
@@ -211,5 +212,17 @@ export class CustomerRepository extends AbstractResourceRepository<'customer'> {
 			}
 			resource.custom.fields[name] = value
 		},
+		setCustomerNumber: (
+			_context: RepositoryContext,
+			resource: Writable<Customer>,
+			{ customerNumber }: CustomerSetCustomerNumberAction
+		) => {
+			if (resource.customerNumber) {
+				throw new Error(
+					'A Customer number already exists and cannot be set again.'
+				)
+			}
+			resource.customerNumber = customerNumber
+		},
 	}
 }

package/src/repositories/payment.ts

@@ -1,10 +1,17 @@
 import type {
+	CustomerReference,
 	Payment,
+	PaymentAddInterfaceInteractionAction,
 	PaymentAddTransactionAction,
+	PaymentChangeAmountPlannedAction,
+	PaymentChangeTransactionInteractionIdAction,
 	PaymentChangeTransactionStateAction,
+	PaymentChangeTransactionTimestampAction,
 	PaymentDraft,
+	PaymentSetAnonymousIdAction,
 	PaymentSetCustomFieldAction,
 	PaymentSetCustomTypeAction,
+	PaymentSetCustomerAction,
 	PaymentSetInterfaceIdAction,
 	PaymentSetKeyAction,
 	PaymentSetMethodInfoInterfaceAction,
@@ -12,7 +19,10 @@ import type {
 	PaymentSetMethodInfoNameAction,
 	PaymentSetStatusInterfaceCodeAction,
 	PaymentSetStatusInterfaceTextAction,
+	PaymentSetTransactionCustomFieldAction,
+	PaymentSetTransactionCustomTypeAction,
 	PaymentTransitionStateAction,
+	PaymentUpdateAction,
 	State,
 	StateReference,
 	Transaction,
@@ -79,7 +89,23 @@ export class PaymentRepository extends AbstractResourceRepository<'payment'> {
 		state: draft.state ?? 'Initial', // Documented as default
 	})
 
-	actions = {
+	actions: Record<
+		PaymentUpdateAction['action'],
+		(
+			context: RepositoryContext,
+			resource: Writable<Payment>,
+			action: any
+		) => void
+	> = {
+		addInterfaceInteraction: (
+			context: RepositoryContext,
+			resource: Writable<Payment>,
+			{ type, fields }: PaymentAddInterfaceInteractionAction
+		) => {
+			resource.interfaceInteractions.push(
+				createCustomFields({ type, fields }, context.projectKey, this._storage)!
+			)
+		},
 		addTransaction: (
 			context: RepositoryContext,
 			resource: Writable<Payment>,
@@ -90,6 +116,28 @@ export class PaymentRepository extends AbstractResourceRepository<'payment'> {
 				this.transactionFromTransactionDraft(transaction, context),
 			]
 		},
+		changeAmountPlanned: (
+			_context: RepositoryContext,
+			resource: Writable<Payment>,
+			{ amount }: PaymentChangeAmountPlannedAction
+		) => {
+			resource.amountPlanned = createCentPrecisionMoney(amount)
+		},
+		changeTransactionInteractionId: (
+			_context: RepositoryContext,
+			resource: Writable<Payment>,
+			{
+				transactionId,
+				interactionId,
+			}: PaymentChangeTransactionInteractionIdAction
+		) => {
+			const transaction = resource.transactions.find(
+				(e: Transaction) => e.id === transactionId
+			)
+			if (transaction) {
+				transaction.interactionId = interactionId
+			}
+		},
 		changeTransactionState: (
 			_context: RepositoryContext,
 			resource: Writable<Payment>,
@@ -104,6 +152,18 @@ export class PaymentRepository extends AbstractResourceRepository<'payment'> {
 			}
 			resource.transactions[index] = updatedTransaction
 		},
+		changeTransactionTimestamp: (
+			_context: RepositoryContext,
+			resource: Writable<Payment>,
+			{ transactionId, timestamp }: PaymentChangeTransactionTimestampAction
+		) => {
+			const transaction = resource.transactions.find(
+				(e: Transaction) => e.id === transactionId
+			)
+			if (transaction) {
+				transaction.timestamp = timestamp
+			}
+		},
 		transitionState: (
 			context: RepositoryContext,
 			resource: Writable<Payment>,
@@ -124,6 +184,29 @@ export class PaymentRepository extends AbstractResourceRepository<'payment'> {
 				obj: stateObj,
 			}
 		},
+		setAnonymousId: (
+			_context: RepositoryContext,
+			resource: Writable<Payment>,
+			{ anonymousId }: PaymentSetAnonymousIdAction
+		) => {
+			resource.anonymousId = anonymousId
+			resource.customer = undefined
+		},
+		setCustomer: (
+			_context: RepositoryContext,
+			resource: Writable<Payment>,
+			{ customer }: PaymentSetCustomerAction
+		) => {
+			if (customer) {
+				const c = getReferenceFromResourceIdentifier<CustomerReference>(
+					customer,
+					_context.projectKey,
+					this._storage
+				)
+				resource.customer = c
+				resource.anonymousId = undefined
+			}
+		},
 		setCustomField: (
 			context: RepositoryContext,
 			resource: Payment,
@@ -160,26 +243,26 @@ export class PaymentRepository extends AbstractResourceRepository<'payment'> {
 				}
 			}
 		},
-		setKey: (
+		setInterfaceId: (
 			_context: RepositoryContext,
 			resource: Writable<Payment>,
-			{ key }: PaymentSetKeyAction
+			{ interfaceId }: PaymentSetInterfaceIdAction
 		) => {
-			resource.key = key
+			resource.interfaceId = interfaceId
 		},
-		setStatusInterfaceCode: (
+		setKey: (
 			_context: RepositoryContext,
 			resource: Writable<Payment>,
-			{ interfaceCode }: PaymentSetStatusInterfaceCodeAction
+			{ key }: PaymentSetKeyAction
 		) => {
-			resource.paymentStatus.interfaceCode = interfaceCode
+			resource.key = key
 		},
-		setStatusInterfaceText: (
+		setMethodInfoMethod: (
 			_context: RepositoryContext,
 			resource: Writable<Payment>,
-			{ interfaceText }: PaymentSetStatusInterfaceTextAction
+			{ method }: PaymentSetMethodInfoMethodAction
 		) => {
-			resource.paymentStatus.interfaceText = interfaceText
+			resource.paymentMethodInfo.method = method
 		},
 		setMethodInfoName: (
 			_context: RepositoryContext,
@@ -188,32 +271,72 @@ export class PaymentRepository extends AbstractResourceRepository<'payment'> {
 		) => {
 			resource.paymentMethodInfo.name = name
 		},
-		setMethodInfoMethod: (
+		setMethodInfoInterface: (
 			_context: RepositoryContext,
 			resource: Writable<Payment>,
-			{ method }: PaymentSetMethodInfoMethodAction
+			args: PaymentSetMethodInfoInterfaceAction
 		) => {
-			resource.paymentMethodInfo.method = method
+			resource.paymentMethodInfo.paymentInterface = args.interface
 		},
-		setMethodInfoInterface: (
+		setStatusInterfaceCode: (
 			_context: RepositoryContext,
 			resource: Writable<Payment>,
-			args: PaymentSetMethodInfoInterfaceAction
+			{ interfaceCode }: PaymentSetStatusInterfaceCodeAction
 		) => {
-			resource.paymentMethodInfo.paymentInterface = args.interface
+			resource.paymentStatus.interfaceCode = interfaceCode
 		},
-		setInterfaceId: (
+		setStatusInterfaceText: (
 			_context: RepositoryContext,
 			resource: Writable<Payment>,
-			{ interfaceId }: PaymentSetInterfaceIdAction
+			{ interfaceText }: PaymentSetStatusInterfaceTextAction
 		) => {
-			resource.interfaceId = interfaceId
+			resource.paymentStatus.interfaceText = interfaceText
+		},
+		setTransactionCustomField: (
+			_context: RepositoryContext,
+			resource: Writable<Payment>,
+			{ transactionId, name, value }: PaymentSetTransactionCustomFieldAction
+		) => {
+			const transaction = resource.transactions.find(
+				(e: Transaction) => e.id === transactionId
+			)
+			if (transaction) {
+				if (!transaction.custom) {
+					throw new Error('Transaction has no custom field')
+				}
+
+				transaction.custom.fields[name] = value
+			}
+		},
+		setTransactionCustomType: (
+			context: RepositoryContext,
+			resource: Writable<Payment>,
+			{ transactionId, type, fields }: PaymentSetTransactionCustomTypeAction
+		) => {
+			const transaction = resource.transactions.find(
+				(e: Transaction) => e.id === transactionId
+			)
+			if (transaction) {
+				if (!type) {
+					transaction.custom = undefined
+				} else {
+					const resolvedType = this._storage.getByResourceIdentifier(
+						context.projectKey,
+						type
+					)
+					if (!resolvedType) {
+						throw new Error(`Type ${type} not found`)
+					}
+
+					transaction.custom = {
+						type: {
+							typeId: 'type',
+							id: resolvedType.id,
+						},
+						fields: fields ?? {},
+					}
+				}
+			}
 		},
-		// addInterfaceInteraction: () => {},
-		// changeAmountPlanned: () => {},
-		// changeTransactionInteractionId: () => {},
-		// changeTransactionTimestamp: () => {},
-		// setAnonymousId: () => {},
-		// setCustomer: () => {},
 	}
 }

package/src/repositories/shopping-list.ts

@@ -1,9 +1,30 @@
 import type {
 	CustomerReference,
+	GeneralError,
+	LineItemDraft,
+	Product,
+	ProductPagedQueryResponse,
 	ShoppingList,
+	ShoppingListAddLineItemAction,
+	ShoppingListChangeLineItemQuantityAction,
+	ShoppingListChangeNameAction,
 	ShoppingListDraft,
+	ShoppingListLineItem,
+	ShoppingListRemoveLineItemAction,
+	ShoppingListSetAnonymousIdAction,
+	ShoppingListSetCustomFieldAction,
+	ShoppingListSetCustomTypeAction,
+	ShoppingListSetCustomerAction,
+	ShoppingListSetDeleteDaysAfterLastModificationAction,
+	ShoppingListSetDescriptionAction,
+	ShoppingListSetKeyAction,
+	ShoppingListSetSlugAction,
+	ShoppingListSetStoreAction,
 } from '@commercetools/platform-sdk'
+import { v4 as uuidv4 } from 'uuid'
+import { CommercetoolsError } from '../exceptions.js'
 import { getBaseResourceProperties } from '../helpers.js'
+import { Writable } from '../types.js'
 import { AbstractResourceRepository, RepositoryContext } from './abstract.js'
 import {
 	createCustomFields,
@@ -17,7 +38,10 @@ export class ShoppingListRepository extends AbstractResourceRepository<'shopping
 	}
 
 	create(context: RepositoryContext, draft: ShoppingListDraft): ShoppingList {
-		// const product =
+		const lineItems =
+			draft.lineItems?.map((draftLineItem) =>
+				this.draftLineItemtoLineItem(context.projectKey, draftLineItem)
+			) ?? []
 
 		const resource: ShoppingList = {
 			...getBaseResourceProperties(),
@@ -28,21 +52,7 @@ export class ShoppingListRepository extends AbstractResourceRepository<'shopping
 				this._storage
 			),
 			textLineItems: [],
-			lineItems:
-				draft.lineItems?.map((e) => ({
-					...getBaseResourceProperties(),
-					...e,
-					addedAt: e.addedAt ?? '',
-					productId: e.productId ?? '',
-					name: {},
-					quantity: e.quantity ?? 1,
-					productType: { typeId: 'product-type', id: '' },
-					custom: createCustomFields(
-						e.custom,
-						context.projectKey,
-						this._storage
-					),
-				})) ?? [],
+			lineItems,
 			customer: draft.customer
 				? getReferenceFromResourceIdentifier<CustomerReference>(
 						draft.customer,
@@ -57,4 +67,325 @@ export class ShoppingListRepository extends AbstractResourceRepository<'shopping
 		this.saveNew(context, resource)
 		return resource
 	}
+
+	actions = {
+		setKey: (
+			context: RepositoryContext,
+			resource: Writable<ShoppingList>,
+			{ key }: ShoppingListSetKeyAction
+		) => {
+			resource.key = key
+		},
+		setSlug: (
+			context: RepositoryContext,
+			resource: Writable<ShoppingList>,
+			{ slug }: ShoppingListSetSlugAction
+		) => {
+			resource.slug = slug
+		},
+		changeName: (
+			context: RepositoryContext,
+			resource: Writable<ShoppingList>,
+			{ name }: ShoppingListChangeNameAction
+		) => {
+			resource.name = name
+		},
+		setDescription: (
+			context: RepositoryContext,
+			resource: Writable<ShoppingList>,
+			{ description }: ShoppingListSetDescriptionAction
+		) => {
+			resource.description = description
+		},
+		setCustomer: (
+			context: RepositoryContext,
+			resource: Writable<ShoppingList>,
+			{ customer }: ShoppingListSetCustomerAction
+		) => {
+			if (customer?.key) {
+				throw new Error('set customer on shoppinglist by key not implemented')
+			}
+			if (customer?.id) {
+				resource.customer = { typeId: 'customer', id: customer.id }
+			}
+		},
+		setStore: (
+			context: RepositoryContext,
+			resource: Writable<ShoppingList>,
+			{ store }: ShoppingListSetStoreAction
+		) => {
+			if (store?.key) {
+				resource.store = { typeId: 'store', key: store.key }
+			}
+			if (store?.id) {
+				throw new Error('set store on shoppinglist by id not implemented')
+			}
+		},
+		setAnonymousId: (
+			context: RepositoryContext,
+			resource: Writable<ShoppingList>,
+			{ anonymousId }: ShoppingListSetAnonymousIdAction
+		) => {
+			resource.anonymousId = anonymousId
+		},
+		setCustomType: (
+			context: RepositoryContext,
+			resource: Writable<ShoppingList>,
+			{ type, fields }: ShoppingListSetCustomTypeAction
+		) => {
+			if (!type) {
+				resource.custom = undefined
+			} else {
+				const resolvedType = this._storage.getByResourceIdentifier(
+					context.projectKey,
+					type
+				)
+				if (!resolvedType) {
+					throw new Error(`Type ${type} not found`)
+				}
+
+				resource.custom = {
+					type: {
+						typeId: 'type',
+						id: resolvedType.id,
+					},
+					fields: fields || {},
+				}
+			}
+		},
+		setCustomField: (
+			context: RepositoryContext,
+			resource: ShoppingList,
+			{ name, value }: ShoppingListSetCustomFieldAction
+		) => {
+			if (!resource.custom) {
+				throw new Error('Resource has no custom field')
+			}
+			resource.custom.fields[name] = value
+		},
+		setDeleteDaysAfterLastModification: (
+			context: RepositoryContext,
+			resource: Writable<ShoppingList>,
+			{
+				deleteDaysAfterLastModification,
+			}: ShoppingListSetDeleteDaysAfterLastModificationAction
+		) => {
+			resource.deleteDaysAfterLastModification = deleteDaysAfterLastModification
+		},
+		addLineItem: (
+			context: RepositoryContext,
+			resource: Writable<ShoppingList>,
+			{ productId, variantId, sku, quantity = 1 }: ShoppingListAddLineItemAction
+		) => {
+			let product: Product | null = null
+
+			if (productId) {
+				// Fetch product and variant by ID
+				product = this._storage.get(
+					context.projectKey,
+					'product',
+					productId,
+					{}
+				)
+			} else if (sku) {
+				// Fetch product and variant by SKU
+				const items = this._storage.query(context.projectKey, 'product', {
+					where: [
+						`masterData(current(masterVariant(sku="${sku}"))) or masterData(current(variants(sku="${sku}")))`,
+					],
+				}) as ProductPagedQueryResponse
+
+				if (items.count === 1) {
+					product = items.results[0]
+				}
+			}
+
+			if (!product) {
+				// Check if product is found
+				throw new CommercetoolsError<GeneralError>({
+					code: 'General',
+					message: sku
+						? `A product containing a variant with SKU '${sku}' not found.`
+						: `A product with ID '${productId}' not found.`,
+				})
+			}
+
+			let varId: number | undefined = variantId
+			if (sku) {
+				varId = [
+					product.masterData.current.masterVariant,
+					...product.masterData.current.variants,
+				].find((x) => x.sku === sku)?.id
+			}
+			if (!varId) {
+				varId = product.masterData.current.masterVariant.id
+			}
+
+			const alreadyAdded = resource.lineItems.some(
+				(x) => x.productId === product?.id && x.variantId === varId
+			)
+			if (alreadyAdded) {
+				// increase quantity and update total price
+				resource.lineItems.forEach((x) => {
+					if (x.productId === product?.id && x.variantId === varId) {
+						x.quantity += quantity
+					}
+				})
+			} else {
+				// add line item
+				resource.lineItems.push({
+					addedAt: new Date().toISOString(),
+					id: uuidv4(),
+					productId: product.id,
+					productSlug: product.masterData.current.slug,
+					productType: product.productType,
+					name: product.masterData.current.name,
+					variantId: varId,
+					quantity,
+				})
+			}
+		},
+		removeLineItem: (
+			context: RepositoryContext,
+			resource: Writable<ShoppingList>,
+			{ lineItemId, quantity }: ShoppingListRemoveLineItemAction
+		) => {
+			const lineItem = resource.lineItems.find((x) => x.id === lineItemId)
+			if (!lineItem) {
+				// Check if product is found
+				throw new CommercetoolsError<GeneralError>({
+					code: 'General',
+					message: `A line item with ID '${lineItemId}' not found.`,
+				})
+			}
+
+			const shouldDelete = !quantity || quantity >= lineItem.quantity
+			if (shouldDelete) {
+				// delete line item
+				resource.lineItems = resource.lineItems.filter(
+					(x) => x.id !== lineItemId
+				)
+			} else {
+				// decrease quantity and update total price
+				resource.lineItems.forEach((x) => {
+					if (x.id === lineItemId && quantity) {
+						x.quantity -= quantity
+					}
+				})
+			}
+		},
+		changeLineItemQuantity: (
+			context: RepositoryContext,
+			resource: Writable<ShoppingList>,
+			{
+				lineItemId,
+				lineItemKey,
+				quantity,
+			}: ShoppingListChangeLineItemQuantityAction
+		) => {
+			let lineItem: Writable<ShoppingListLineItem> | undefined
+
+			if (lineItemId) {
+				lineItem = resource.lineItems.find((x) => x.id === lineItemId)
+				if (!lineItem) {
+					throw new CommercetoolsError<GeneralError>({
+						code: 'General',
+						message: `A line item with ID '${lineItemId}' not found.`,
+					})
+				}
+			} else if (lineItemKey) {
+				lineItem = resource.lineItems.find((x) => x.id === lineItemId)
+				if (!lineItem) {
+					throw new CommercetoolsError<GeneralError>({
+						code: 'General',
+						message: `A line item with Key '${lineItemKey}' not found.`,
+					})
+				}
+			} else {
+				throw new CommercetoolsError<GeneralError>({
+					code: 'General',
+					message: `Either lineItemid or lineItemKey needs to be provided.`,
+				})
+			}
+
+			if (quantity === 0) {
+				// delete line item
+				resource.lineItems = resource.lineItems.filter(
+					(x) => x.id !== lineItemId
+				)
+			} else {
+				resource.lineItems.forEach((x) => {
+					if (x.id === lineItemId && quantity) {
+						x.quantity = quantity
+					}
+				})
+			}
+		},
+	}
+
+	draftLineItemtoLineItem = (
+		projectKey: string,
+		draftLineItem: LineItemDraft
+	): ShoppingListLineItem => {
+		const { sku, productId, variantId } = draftLineItem
+
+		const lineItem: Writable<ShoppingListLineItem> = {
+			...getBaseResourceProperties(),
+			...draftLineItem,
+			addedAt: draftLineItem.addedAt ?? '',
+			productId: draftLineItem.productId ?? '',
+			name: {},
+			variantId,
+			quantity: draftLineItem.quantity ?? 1,
+			productType: { typeId: 'product-type', id: '' },
+			custom: createCustomFields(
+				draftLineItem.custom,
+				projectKey,
+				this._storage
+			),
+		}
+
+		if (variantId) {
+			return lineItem
+		}
+
+		if (sku) {
+			const items = this._storage.query(projectKey, 'product', {
+				where: [
+					`masterData(current(masterVariant(sku="${sku}"))) or masterData(current(variants(sku="${sku}")))`,
+				],
+			}) as ProductPagedQueryResponse
+
+			if (items.count === 0) {
+				throw new Error(`Product with sku ${sku} not found`)
+			}
+
+			const product = items.results[0]
+			const allVariants = [
+				product.masterData.current.masterVariant,
+				...product.masterData.current.variants,
+			]
+			const variantId = allVariants.find((e) => e.sku === sku)?.id
+			lineItem.variantId = variantId
+			return lineItem
+		}
+
+		if (productId) {
+			const items = this._storage.query(projectKey, 'product', {
+				where: [`id="${productId}"`],
+			}) as ProductPagedQueryResponse
+
+			if (items.count === 0) {
+				throw new Error(`Product with id ${productId} not found`)
+			}
+
+			const variantId = items.results[0].masterData.current.masterVariant.id
+			lineItem.variantId = variantId
+			return lineItem
+		}
+
+		throw new Error(
+			`must provide either sku, productId or variantId for ShoppingListLineItem`
+		)
+	}
 }

package/src/services/cart.test.ts

@@ -273,7 +273,7 @@ describe('Cart Update Actions', () => {
 	})
 
 	test('addItemShippingAddress', async () => {
-		const product = await supertest(ctMock.app)
+		await supertest(ctMock.app)
 			.post(`/dummy/products`)
 			.send(productDraft)
 			.then((x) => x.body)
@@ -304,7 +304,7 @@ describe('Cart Update Actions', () => {
 	})
 
 	test('recalculate', async () => {
-		const product = await supertest(ctMock.app)
+		await supertest(ctMock.app)
 			.post(`/dummy/products`)
 			.send(productDraft)
 			.then((x) => x.body)