@labdigital/commercetools-mock 2.14.2 → 2.16.0

package/src/services/customer.test.ts

@@ -330,4 +330,44 @@ describe('Customer Update Actions', () => {
 			},
 		])
 	})
+
+	test('setCustomerNumber', async () => {
+		assert(customer, 'customer not created')
+
+		ctMock.project('dummy').add('customer', customer)
+
+		const response = await supertest(ctMock.app)
+			.post(`/dummy/customers/${customer.id}`)
+			.send({
+				version: 1,
+				actions: [
+					{ action: 'setCustomerNumber', customerNumber: 'CUSTOMER-001' },
+				],
+			})
+		expect(response.status).toBe(200)
+		expect(response.body.version).toBe(2)
+		expect(response.body.customerNumber).toBe('CUSTOMER-001')
+	})
+
+	test('setCustomerNumber error when already have a customer number', async () => {
+		assert(customer, 'customer not created')
+
+		ctMock.project('dummy').add('customer', {
+			...customer,
+			customerNumber: 'CUSTOMER-002',
+		})
+
+		const response = await supertest(ctMock.app)
+			.post(`/dummy/customers/${customer.id}`)
+			.send({
+				version: 1,
+				actions: [
+					{ action: 'setCustomerNumber', customerNumber: 'CUSTOMER-001' },
+				],
+			})
+		expect(response.status).toBe(500)
+		expect(response.body.error).toBe(
+			'A Customer number already exists and cannot be set again.'
+		)
+	})
 })

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

@@ -0,0 +1,352 @@
+import {
+	Product,
+	ShoppingList,
+	ShoppingListDraft,
+} from '@commercetools/platform-sdk'
+import supertest from 'supertest'
+import { afterEach, beforeEach, describe, expect, test } from 'vitest'
+import { CommercetoolsMock } from '../ctMock'
+
+const shoppingList: ShoppingList = {
+	id: 'f15b4a80-7def-4381-bf6a-c66cab258a2b',
+	version: 1,
+	lineItems: [
+		{
+			addedAt: '2021-08-03T14:19:29.496Z',
+			productType: { typeId: 'product-type', id: 'product-type-id' },
+			id: '42ea3c57-aced-49ea-ae70-7005a47c7463',
+			productId: '303bf5d8-1201-4fb9-8157-ff6efb8c04b4',
+			name: {},
+			quantity: 1,
+			productSlug: {},
+			variantId: 2,
+		},
+	],
+	textLineItems: [],
+	createdAt: '2021-07-22T12:23:33.472Z',
+	lastModifiedAt: '2021-08-03T14:19:29.496Z',
+	name: {},
+}
+
+export const product: Product = {
+	id: '303bf5d8-1201-4fb9-8157-ff6efb8c04b4',
+	createdAt: '2022-05-30T13:21:26.777Z',
+	lastModifiedAt: '2022-05-30T13:21:26.777Z',
+	version: 1,
+	productType: {
+		typeId: 'product-type',
+		id: '303bf5d8-1201-4fb9-8157-ff6efb8c04b4',
+	},
+	masterData: {
+		staged: {
+			name: {},
+			categories: [],
+			slug: {},
+			masterVariant: {
+				id: 1,
+				sku: '1',
+			},
+			variants: [],
+			searchKeywords: {},
+		},
+		current: {
+			name: {},
+			slug: {},
+			categories: [],
+			masterVariant: {
+				id: 1,
+				availability: {},
+			},
+			variants: [
+				{
+					id: 2,
+					sku: '22241940260',
+				},
+			],
+			searchKeywords: {},
+		},
+		hasStagedChanges: true,
+		published: true,
+	},
+}
+
+describe('Shopping List', () => {
+	const ctMock = new CommercetoolsMock({
+		defaultProjectKey: 'dummy',
+	})
+
+	beforeEach(() => {
+		ctMock.project().add('product', product)
+		ctMock.project().add('shopping-list', shoppingList)
+	})
+
+	test('Adds variant ID on lineItems when creating', async () => {
+		const draft: ShoppingListDraft = {
+			name: {},
+			lineItems: [{ sku: '22241940260' }],
+		}
+		const response = await supertest(ctMock.app)
+			.post('/dummy/shopping-lists')
+			.send(draft)
+
+		expect(response.status).toBe(201)
+		expect(response.body.lineItems[0].variantId).toBe(2)
+	})
+
+	test('Expands variant on lineItems', async () => {
+		const response = await supertest(ctMock.app)
+			.get(`/dummy/shopping-lists/${shoppingList.id}`)
+			.query({ expand: 'lineItems[*].variant' })
+
+		expect(response.status).toBe(200)
+		expect(response.body.lineItems[0].variant).toEqual({
+			id: 2,
+			sku: '22241940260',
+		})
+	})
+})
+
+describe('Shopping List Update Actions', () => {
+	const ctMock = new CommercetoolsMock({
+		defaultProjectKey: 'dummy',
+	})
+
+	beforeEach(() => {
+		ctMock.project().add('product', product)
+		ctMock.project().add('shopping-list', shoppingList)
+	})
+
+	afterEach(() => {
+		ctMock.clear()
+	})
+
+	test('addLineItem by productID & variantID', async () => {
+		ctMock.clear()
+		ctMock.project().add('product', product)
+		ctMock.project().add('shopping-list', { ...shoppingList, lineItems: [] })
+
+		const response = await supertest(ctMock.app)
+			.post(`/dummy/shopping-lists/${shoppingList.id}`)
+			.send({
+				version: 1,
+				actions: [
+					{
+						action: 'addLineItem',
+						productId: product.id,
+						variantId: product.masterData.current.variants[0].id,
+					},
+				],
+			})
+		expect(response.status).toBe(200)
+		expect(response.body.version).toBe(2)
+		expect(response.body.lineItems).toHaveLength(1)
+		expect(response.body.lineItems[0].variantId).toEqual(2)
+	})
+
+	test('addLineItem by productID', async () => {
+		ctMock.clear()
+		ctMock.project().add('product', product)
+		ctMock.project().add('shopping-list', { ...shoppingList, lineItems: [] })
+
+		const response = await supertest(ctMock.app)
+			.post(`/dummy/shopping-lists/${shoppingList.id}`)
+			.send({
+				version: 1,
+				actions: [
+					{
+						action: 'addLineItem',
+						productId: product.id,
+					},
+				],
+			})
+		expect(response.status).toBe(200)
+		expect(response.body.version).toBe(2)
+		expect(response.body.lineItems).toHaveLength(1)
+		expect(response.body.lineItems[0].variantId).toEqual(1)
+	})
+
+	test('addLineItem by sku', async () => {
+		ctMock.clear()
+		ctMock.project().add('product', product)
+		ctMock.project().add('shopping-list', { ...shoppingList, lineItems: [] })
+
+		const response = await supertest(ctMock.app)
+			.post(`/dummy/shopping-lists/${shoppingList.id}`)
+			.send({
+				version: 1,
+				actions: [
+					{
+						action: 'addLineItem',
+						sku: '22241940260',
+					},
+				],
+			})
+		expect(response.status).toBe(200)
+		expect(response.body.version).toBe(2)
+		expect(response.body.lineItems).toHaveLength(1)
+		expect(response.body.lineItems[0].variantId).toEqual(2)
+	})
+
+	test('addLineItem increases quantity', async () => {
+		const response = await supertest(ctMock.app)
+			.post(`/dummy/shopping-lists/${shoppingList.id}`)
+			.send({
+				version: 1,
+				actions: [
+					{
+						action: 'addLineItem',
+						sku: '22241940260',
+					},
+				],
+			})
+		expect(response.status).toBe(200)
+		expect(response.body.version).toBe(2)
+		expect(response.body.lineItems).toHaveLength(1)
+		expect(response.body.lineItems[0].variantId).toEqual(2)
+		expect(response.body.lineItems[0].quantity).toEqual(2)
+	})
+
+	test('addLineItem unknown product', async () => {
+		const response = await supertest(ctMock.app)
+			.post(`/dummy/shopping-lists/${shoppingList.id}`)
+			.send({
+				version: 1,
+				actions: [{ action: 'addLineItem', productId: '123', variantId: 1 }],
+			})
+		expect(response.status).toBe(400)
+		expect(response.body.message).toBe("A product with ID '123' not found.")
+	})
+
+	test('removeLineItem', async () => {
+		const response = await supertest(ctMock.app)
+			.post(`/dummy/shopping-lists/${shoppingList.id}`)
+			.send({
+				version: 1,
+				actions: [
+					{
+						action: 'removeLineItem',
+						lineItemId: shoppingList.lineItems[0].id,
+					},
+				],
+			})
+		expect(response.status).toBe(200)
+		expect(response.body.version).toBe(2)
+		expect(response.body.lineItems).toHaveLength(0)
+	})
+
+	test('removeLineItem decreases quantity', async () => {
+		await supertest(ctMock.app)
+			.post(`/dummy/shopping-lists/${shoppingList.id}`)
+			.send({
+				version: 1,
+				actions: [
+					{
+						action: 'addLineItem',
+						sku: '22241940260',
+					},
+				],
+			})
+
+		const response = await supertest(ctMock.app)
+			.post(`/dummy/shopping-lists/${shoppingList.id}`)
+			.send({
+				version: 2,
+				actions: [
+					{
+						action: 'removeLineItem',
+						lineItemId: shoppingList.lineItems[0].id,
+						quantity: 1,
+					},
+				],
+			})
+		expect(response.status).toBe(200)
+		expect(response.body.version).toBe(3)
+		expect(response.body.lineItems).toHaveLength(1)
+		expect(response.body.lineItems[0].quantity).toBe(1)
+	})
+
+	test('changeLineItemQuantity sets quantity', async () => {
+		const response = await supertest(ctMock.app)
+			.post(`/dummy/shopping-lists/${shoppingList.id}`)
+			.send({
+				version: 1,
+				actions: [
+					{
+						action: 'changeLineItemQuantity',
+						lineItemId: shoppingList.lineItems[0].id,
+						quantity: 2,
+					},
+				],
+			})
+		expect(response.status).toBe(200)
+		expect(response.body.version).toBe(2)
+		expect(response.body.lineItems.length).toBe(1)
+		expect(response.body.lineItems[0].quantity).toBe(2)
+	})
+
+	test('changeLineItemQuantity removes line item if quantity is 0', async () => {
+		const response = await supertest(ctMock.app)
+			.post(`/dummy/shopping-lists/${shoppingList.id}`)
+			.send({
+				version: 1,
+				actions: [
+					{
+						action: 'changeLineItemQuantity',
+						lineItemId: shoppingList.lineItems[0].id,
+						quantity: 0,
+					},
+				],
+			})
+		expect(response.status).toBe(200)
+		expect(response.body.version).toBe(2)
+		expect(response.body.lineItems.length).toBe(0)
+	})
+
+	test('various setters', async () => {
+		const response = await supertest(ctMock.app)
+			.post(`/dummy/shopping-lists/${shoppingList.id}`)
+			.send({
+				version: 1,
+				actions: [
+					{
+						action: 'setKey',
+						key: 'new-key',
+					},
+					{
+						action: 'setSlug',
+						slug: 'new-slug',
+					},
+					{
+						action: 'changeName',
+						name: { en: 'new name' },
+					},
+					{
+						action: 'setDescription',
+						description: { en: 'new description' },
+					},
+					{
+						action: 'setCustomer',
+						customer: { typeId: 'customer', id: 'customer-id' },
+					},
+					{ action: 'setStore', store: { typeId: 'store', key: 'store-key' } },
+					{ action: 'setAnonymousId', anonymousId: 'new-anonymous-id' },
+					{
+						action: 'setDeleteDaysAfterLastModification',
+						deleteDaysAfterLastModification: 1,
+					},
+				],
+			})
+		expect(response.status).toBe(200)
+		expect(response.body.key).toBe('new-key')
+		expect(response.body.slug).toBe('new-slug')
+		expect(response.body.name).toEqual({ en: 'new name' })
+		expect(response.body.description).toEqual({ en: 'new description' })
+		expect(response.body.customer).toEqual({
+			typeId: 'customer',
+			id: 'customer-id',
+		})
+		expect(response.body.store).toEqual({ typeId: 'store', key: 'store-key' })
+		expect(response.body.anonymousId).toEqual('new-anonymous-id')
+		expect(response.body.deleteDaysAfterLastModification).toEqual(1)
+	})
+})

package/src/storage/in-memory.ts

@@ -1,5 +1,7 @@
 import {
+	InvalidJsonInputError,
 	ReferencedResourceNotFoundError,
+	ShoppingListLineItem,
 	type AssociateRole,
 	type AttributeGroup,
 	type BusinessUnit,
@@ -7,9 +9,9 @@ import {
 	type CartDiscount,
 	type Category,
 	type Channel,
+	type CustomObject,
 	type Customer,
 	type CustomerGroup,
-	type CustomObject,
 	type DiscountCode,
 	type Extension,
 	type InvalidInputError,
@@ -35,7 +37,6 @@ import {
 	type TaxCategory,
 	type Type,
 	type Zone,
-	InvalidJsonInputError,
 } from '@commercetools/platform-sdk'
 import assert from 'assert'
 import { CommercetoolsError } from '../exceptions.js'
@@ -408,6 +409,23 @@ export class InMemoryStorage extends AbstractStorage {
 	private _resolveResource = (projectKey: string, obj: any, expand: string) => {
 		const params = parseExpandClause(expand)
 
+		// 'lineItems[*].variant' on ShoppingList is an exception, these variants are not references
+		if (params.index === '*') {
+			const reference = obj[params.element]
+			if (
+				params.element === 'lineItems' &&
+				params.rest?.startsWith('variant') &&
+				reference.every(
+					(item: any) =>
+						item.variant === undefined && item.variantId !== undefined
+				)
+			) {
+				reference.forEach((item: ShoppingListLineItem) => {
+					this._resolveShoppingListLineItemVariant(projectKey, item)
+				})
+			}
+		}
+
 		if (!params.index) {
 			const reference = obj[params.element]
 			if (reference === undefined) {
@@ -456,4 +474,24 @@ export class InMemoryStorage extends AbstractStorage {
 			}
 		}
 	}
+	private _resolveShoppingListLineItemVariant(
+		projectKey: string,
+		lineItem: ShoppingListLineItem
+	) {
+		const product = this.getByResourceIdentifier(projectKey, {
+			typeId: 'product',
+			id: lineItem.productId,
+		}) as Product | undefined
+
+		if (!product) {
+			return
+		}
+
+		const variant = [
+			product.masterData.current.masterVariant,
+			...product.masterData.current.variants,
+		].find((e) => e.id === lineItem.variantId)
+		// @ts-ignore
+		lineItem.variant = variant
+	}
 }