@labdigital/commercetools-mock 2.5.0 → 2.7.0

package/package.json

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

package/src/ctMock.ts

@@ -78,7 +78,6 @@ export class CommercetoolsMock {
 	}
 
 	clear() {
-		this._mswServer?.resetHandlers()
 		this._storage.clear()
 	}
 
@@ -165,25 +164,18 @@ export class CommercetoolsMock {
 		return app
 	}
 
-	private startServer() {
-		// Check if there are any other servers running
-		if (_globalListeners.length > 0) {
-			if (this._mswServer !== undefined) {
-				throw new Error('Server already started')
-			} else {
-				console.warn("Server wasn't stopped properly, clearing")
-				_globalListeners.forEach((listener) => listener.close())
-			}
-		}
-
-		const server = this.app
-		this._mswServer = setupServer(
+	// registerHandlers is an alternative way to work with commercetools-mock, it
+	// allows you to manage msw server yourself and register the handlers needed
+	// for commercetools-mock to work.
+	public registerHandlers(server: SetupServer) {
+		const app = this.app
+		server.use(
 			http.post(`${this.options.authHost}/oauth/*`, async ({ request }) => {
 				const body = await request.text()
 				const url = new URL(request.url)
 				const headers = copyHeaders(request.headers)
 
-				const res = await inject(server)
+				const res = await inject(app)
 					.post(url.pathname + '?' + url.searchParams.toString())
 					.body(body)
 					.headers(headers)
@@ -198,7 +190,7 @@ export class CommercetoolsMock {
 				const url = new URL(request.url)
 				const headers = copyHeaders(request.headers)
 
-				const res = await inject(server)
+				const res = await inject(app)
 					.get(url.pathname + '?' + url.searchParams.toString())
 					.body(body)
 					.headers(headers)
@@ -229,7 +221,7 @@ export class CommercetoolsMock {
 				const url = new URL(request.url)
 				const headers = copyHeaders(request.headers)
 
-				const res = await inject(server)
+				const res = await inject(app)
 					.get(url.pathname + '?' + url.searchParams.toString())
 					.body(body)
 					.headers(headers)
@@ -244,7 +236,7 @@ export class CommercetoolsMock {
 				const url = new URL(request.url)
 				const headers = copyHeaders(request.headers)
 
-				const res = await inject(server)
+				const res = await inject(app)
 					.post(url.pathname + '?' + url.searchParams.toString())
 					.body(body)
 					.headers(headers)
@@ -259,7 +251,7 @@ export class CommercetoolsMock {
 				const url = new URL(request.url)
 				const headers = copyHeaders(request.headers)
 
-				const res = await inject(server)
+				const res = await inject(app)
 					.delete(url.pathname + '?' + url.searchParams.toString())
 					.body(body)
 					.headers(headers)
@@ -270,7 +262,22 @@ export class CommercetoolsMock {
 				})
 			})
 		)
-		this._mswServer.listen({
+	}
+
+	private startServer() {
+		// Check if there are any other servers running
+		if (_globalListeners.length > 0) {
+			if (this._mswServer !== undefined) {
+				throw new Error('Server already started')
+			} else {
+				console.warn("Server wasn't stopped properly, clearing")
+				_globalListeners.forEach((listener) => listener.close())
+			}
+		}
+
+		const server = setupServer()
+		this.registerHandlers(server)
+		server.listen({
 			// We need to allow requests done by supertest
 			onUnhandledRequest: (request, print) => {
 				const url = new URL(request.url)
@@ -280,7 +287,7 @@ export class CommercetoolsMock {
 				print.error()
 			},
 		})
-
-		_globalListeners.push(this._mswServer)
+		_globalListeners.push(server)
+		this._mswServer = server
 	}
 }

package/src/repositories/index.ts

@@ -59,6 +59,7 @@ export const createRepositories = (storage: AbstractStorage) => ({
 	'my-order': new MyOrderRepository(storage),
 	'my-customer': new CustomerRepository(storage),
 	'my-payment': new PaymentRepository(storage),
+	'my-shopping-list': new ShoppingListRepository(storage),
 	product: new ProductRepository(storage),
 	'product-type': new ProductTypeRepository(storage),
 	'product-discount': new ProductDiscountRepository(storage),

package/src/services/index.ts

@@ -15,6 +15,7 @@ import { MyCartService } from './my-cart.js'
 import { MyCustomerService } from './my-customer.js'
 import { MyOrderService } from './my-order.js'
 import { MyPaymentService } from './my-payment.js'
+import { MyShoppingListService } from './my-shopping-list.js'
 import { OrderService } from './order.js'
 import { PaymentService } from './payment.js'
 import { ProductDiscountService } from './product-discount.js'
@@ -61,6 +62,10 @@ export const createServices = (router: any, repos: any) => ({
 	'my-order': new MyOrderService(router, repos['my-order']),
 	'my-customer': new MyCustomerService(router, repos['my-customer']),
 	'my-payment': new MyPaymentService(router, repos['my-payment']),
+	'my-shopping-list': new MyShoppingListService(
+		router,
+		repos['my-shopping-list']
+	),
 	'shipping-method': new ShippingMethodService(
 		router,
 		repos['shipping-method']

package/src/services/my-customer.test.ts

@@ -1,6 +1,6 @@
 import type { MyCustomerDraft } from '@commercetools/platform-sdk'
 import supertest from 'supertest'
-import { afterEach, describe, expect, test } from 'vitest'
+import { afterEach, beforeEach, describe, expect, test } from 'vitest'
 import { CommercetoolsMock } from '../index.js'
 
 const ctMock = new CommercetoolsMock()
@@ -51,3 +51,58 @@ describe('Me', () => {
 		expect(response.body).toEqual(createResponse.body.customer)
 	})
 })
+
+describe('/me', () => {
+	afterEach(() => {
+		ctMock.clear()
+	})
+
+	beforeEach(() => {
+		ctMock.project('dummy').add('customer', {
+			id: '123',
+			createdAt: '2021-03-18T14:00:00.000Z',
+			version: 2,
+			lastModifiedAt: '2021-03-18T14:00:00.000Z',
+			email: 'foo@example.org',
+			addresses: [],
+			isEmailVerified: true,
+			authenticationMode: 'password',
+			custom: { type: { typeId: 'type', id: '' }, fields: {} },
+		})
+	})
+
+	test('Get me', async () => {
+		const response = await supertest(ctMock.app).get('/dummy/me')
+
+		expect(response.status).toBe(200)
+		expect(response.body).toEqual({
+			id: '123',
+			createdAt: '2021-03-18T14:00:00.000Z',
+			version: 2,
+			lastModifiedAt: '2021-03-18T14:00:00.000Z',
+			email: 'foo@example.org',
+			addresses: [],
+			isEmailVerified: true,
+			authenticationMode: 'password',
+			custom: {
+				fields: {},
+				type: {
+					id: '',
+					typeId: 'type',
+				},
+			},
+		})
+	})
+
+	test('setCustomField', async () => {
+		const response = await supertest(ctMock.app)
+			.post(`/dummy/me`)
+			.send({
+				version: 2,
+				actions: [{ action: 'setCustomField', name: 'foobar', value: true }],
+			})
+		expect(response.status).toBe(200)
+		expect(response.body.version).toBe(3)
+		expect(response.body.custom.fields.foobar).toBe(true)
+	})
+})

package/src/services/my-customer.ts

@@ -3,6 +3,7 @@ import { CustomerRepository } from '../repositories/customer.js'
 import { getRepositoryContext } from '../repositories/helpers.js'
 import AbstractService from './abstract.js'
 import { hashPassword } from '../lib/password.js'
+import { Update } from '@commercetools/platform-sdk'
 
 export class MyCustomerService extends AbstractService {
 	public repository: CustomerRepository
@@ -24,6 +25,7 @@ export class MyCustomerService extends AbstractService {
 		this.extraRoutes(router)
 
 		router.get('', this.getMe.bind(this))
+		router.post('', this.updateMe.bind(this))
 
 		router.post('/signup', this.signUp.bind(this))
 
@@ -40,6 +42,24 @@ export class MyCustomerService extends AbstractService {
 		return response.status(200).send(resource)
 	}
 
+	updateMe(request: Request, response: Response) {
+		const resource = this.repository.getMe(getRepositoryContext(request))
+
+		if (!resource) {
+			return response.status(404).send('Not found')
+		}
+		const updateRequest: Update = request.body
+		const updatedResource = this.repository.processUpdateActions(
+			getRepositoryContext(request),
+			resource,
+			updateRequest.version,
+			updateRequest.actions
+		)
+
+		const result = this._expandWithId(request, updatedResource.id)
+		return response.status(200).send(result)
+	}
+
 	signUp(request: Request, response: Response) {
 		const draft = request.body
 		const resource = this.repository.create(

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

@@ -0,0 +1,16 @@
+import { Router } from 'express'
+import { ShoppingListRepository } from '../repositories/shopping-list.js'
+import AbstractService from './abstract.js'
+
+export class MyShoppingListService extends AbstractService {
+	public repository: ShoppingListRepository
+
+	constructor(parent: Router, repository: ShoppingListRepository) {
+		super(parent)
+		this.repository = repository
+	}
+
+	getBasePath() {
+		return 'me/shopping-lists'
+	}
+}