@labdigital/commercetools-mock 2.7.0 → 2.8.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@labdigital/commercetools-mock",
   "author": "Michael van Tellingen",
-  "version": "2.7.0",
+  "version": "2.8.0",
   "license": "MIT",
   "main": "dist/index.cjs",
   "module": "dist/index.js",
@@ -46,7 +46,7 @@
   "devDependencies": {
     "@changesets/changelog-github": "^0.4.8",
     "@changesets/cli": "^2.26.2",
-    "@commercetools/platform-sdk": "4.11.0",
+    "@commercetools/platform-sdk": "6.0.0",
     "@types/basic-auth": "^1.1.3",
     "@types/body-parser": "^1.19.2",
     "@types/deep-equal": "^1.0.1",

package/src/ctMock.ts

@@ -264,6 +264,10 @@ export class CommercetoolsMock {
 		)
 	}
 
+	public mswServer() {
+		return this._mswServer
+	}
+
 	private startServer() {
 		// Check if there are any other servers running
 		if (_globalListeners.length > 0) {

package/src/priceSelector.ts

@@ -21,11 +21,13 @@ export type PriceSelector = {
  */
 export const applyPriceSelector = (
 	products: ProductProjection[],
-	selector: PriceSelector
+	selector: PriceSelector,
+	noScopedPrice: boolean = false
 ) => {
 	validatePriceSelector(selector)
 
 	for (const product of products) {
+		// Get list of all variants (master + variants)
 		const variants: Writable<ProductVariant>[] = [
 			product.masterVariant,
 			...(product.variants ?? []),
@@ -38,10 +40,13 @@ export const applyPriceSelector = (
 			if (scopedPrices.length > 0) {
 				const price = scopedPrices[0]
 
-				variant.scopedPriceDiscounted = false
-				variant.scopedPrice = {
-					...price,
-					currentValue: price.value,
+				variant.price = scopedPrices[0]
+				if (!noScopedPrice) {
+					variant.scopedPriceDiscounted = false
+					variant.scopedPrice = {
+						...price,
+						currentValue: price.value,
+					}
 				}
 			}
 		}

package/src/repositories/customer.ts

@@ -51,6 +51,7 @@ export class CustomerRepository extends AbstractResourceRepository<'customer'> {
 			password: draft.password ? hashPassword(draft.password) : undefined,
 			isEmailVerified: draft.isEmailVerified || false,
 			addresses: [],
+			customerNumber: draft.customerNumber,
 		}
 		this.saveNew(context, resource)
 		return resource

package/src/repositories/helpers.ts

@@ -180,7 +180,7 @@ export const getReferenceFromResourceIdentifier = <T extends Reference>(
 	if (!resource) {
 		const errIdentifier = resourceIdentifier.key
 			? `key '${resourceIdentifier.key}'`
-			: `identifier '${resourceIdentifier.key}'`
+			: `identifier '${resourceIdentifier.id}'`
 
 		throw new CommercetoolsError<ReferencedResourceNotFoundError>(
 			{

package/src/repositories/order.ts

@@ -2,12 +2,15 @@ import type {
 	Cart,
 	CartReference,
 	CustomLineItem,
-	CustomLineItemDraft,
+	CustomLineItemImportDraft,
+	CustomLineItemReturnItem,
 	GeneralError,
 	LineItem,
 	LineItemImportDraft,
+	LineItemReturnItem,
 	Order,
 	OrderAddPaymentAction,
+	OrderAddReturnInfoAction,
 	OrderChangeOrderStateAction,
 	OrderChangePaymentStateAction,
 	OrderFromCartDraft,
@@ -24,6 +27,7 @@ import type {
 	Product,
 	ProductPagedQueryResponse,
 	ProductVariant,
+	ReturnInfo,
 	State,
 	Store,
 } from '@commercetools/platform-sdk'
@@ -227,7 +231,7 @@ export class OrderRepository extends AbstractResourceRepository<'order'> {
 
 	private customLineItemFromImportDraft(
 		context: RepositoryContext,
-		draft: CustomLineItemDraft
+		draft: CustomLineItemImportDraft
 	): CustomLineItem {
 		const lineItem: CustomLineItem = {
 			...getBaseResourceProperties(),
@@ -241,10 +245,11 @@ export class OrderRepository extends AbstractResourceRepository<'order'> {
 			name: draft.name,
 			quantity: draft.quantity ?? 0,
 			perMethodTaxRate: [],
-			priceMode: draft.priceMode,
+			priceMode: draft.priceMode ?? 'Standard',
 			slug: draft.slug,
 			state: [],
 			totalPrice: createCentPrecisionMoney(draft.money),
+			taxedPricePortions: [],
 		}
 
 		return lineItem
@@ -296,6 +301,43 @@ export class OrderRepository extends AbstractResourceRepository<'order'> {
 				id: payment.id!,
 			})
 		},
+		addReturnInfo: (
+			context: RepositoryContext,
+			resource: Writable<Order>,
+			info: OrderAddReturnInfoAction
+		) => {
+			if (!resource.returnInfo) {
+				resource.returnInfo = []
+			}
+
+			const resolved: ReturnInfo = {
+				items: info.items.map((item) => {
+					const common = {
+						...getBaseResourceProperties(),
+						quantity: item.quantity,
+						paymentState: 'Initial',
+						shipmentState: 'Initial',
+						comment: item.comment,
+					}
+					if (item.customLineItemId) {
+						return {
+							...common,
+							type: 'CustomLineItemReturnItem',
+							customLineItemId: item.customLineItemId,
+						} as CustomLineItemReturnItem
+					}
+					return {
+						...common,
+						type: 'LineItemReturnItem',
+						lineItemId: item.customLineItemId || item.lineItemId,
+					} as LineItemReturnItem
+				}),
+				returnTrackingId: info.returnTrackingId,
+				returnDate: info.returnDate,
+			}
+
+			resource.returnInfo.push(resolved)
+		},
 		changeOrderState: (
 			context: RepositoryContext,
 			resource: Writable<Order>,

package/src/repositories/product-projection.ts

@@ -13,6 +13,7 @@ import {
 	GetParams,
 	RepositoryContext,
 } from './abstract.js'
+import { applyPriceSelector } from '../priceSelector.js'
 
 export type ProductProjectionQueryParams = {
 	staged?: boolean
@@ -100,6 +101,20 @@ export class ProductProjectionRepository extends AbstractResourceRepository<'pro
 			}
 		}
 
+		// We do this after the filtering, since the docs mention:
+		// Only available when Price selection is used. Cannot be used in a Query
+		// Predicate.
+		applyPriceSelector(
+			resources,
+			{
+				country: params.priceCountry,
+				channel: params.priceChannel,
+				customerGroup: params.priceCustomerGroup,
+				currency: params.priceCurrency,
+			},
+			true
+		)
+
 		// Expand the resources
 		if (params.expand !== undefined) {
 			resources = resources.map((resource) =>

package/src/repositories/product-selection.ts

@@ -22,7 +22,6 @@ export class ProductSelectionRepository extends AbstractResourceRepository<'prod
 			productCount: 0,
 			key: draft.key,
 			name: draft.name,
-			type: 'individual',
 			mode: 'Individual',
 		}
 		this.saveNew(context, resource)

package/src/repositories/product.ts

@@ -36,6 +36,7 @@ import type {
 	ProductAddToCategoryAction,
 	ProductRemoveFromCategoryAction,
 	ProductTransitionStateAction,
+	ChannelReference,
 } from '@commercetools/platform-sdk'
 import { v4 as uuidv4 } from 'uuid'
 import type { Writable } from '../types.js'
@@ -126,10 +127,10 @@ export class ProductRepository extends AbstractResourceRepository<'product'> {
 			slug: draft.slug,
 			description: draft.description,
 			categories: categoryReferences,
-			masterVariant: variantFromDraft(1, draft.masterVariant),
+			masterVariant: this.variantFromDraft(context, 1, draft.masterVariant),
 			variants:
 				draft.variants?.map((variant, index) =>
-					variantFromDraft(index + 2, variant)
+					this.variantFromDraft(context, index + 2, variant)
 				) ?? [],
 			metaTitle: draft.metaTitle,
 			metaDescription: draft.metaDescription,
@@ -156,6 +157,38 @@ export class ProductRepository extends AbstractResourceRepository<'product'> {
 		return resource
 	}
 
+	private variantFromDraft(
+		context: RepositoryContext,
+		variantId: number,
+		variant: ProductVariantDraft
+	): ProductVariant {
+		return {
+			id: variantId,
+			sku: variant?.sku,
+			key: variant?.key,
+			attributes: variant?.attributes ?? [],
+			prices: variant?.prices?.map((p) => this.priceFromDraft(context, p)),
+			assets: [],
+			images: [],
+		}
+	}
+
+	private priceFromDraft(context: RepositoryContext, draft: PriceDraft): Price {
+		return {
+			id: uuidv4(),
+			key: draft.key,
+			country: draft.country,
+			value: createTypedMoney(draft.value),
+			channel: draft.channel
+				? getReferenceFromResourceIdentifier<ChannelReference>(
+						draft.channel,
+						context.projectKey,
+						this._storage
+				  )
+				: undefined,
+		}
+	}
+
 	actions: Partial<
 		Record<
 			ProductUpdateAction['action'],
@@ -528,7 +561,7 @@ export class ProductRepository extends AbstractResourceRepository<'product'> {
 			}
 
 			// Pre-creating the price object ensures consistency between staged and current versions
-			const priceToAdd = priceFromDraft(price)
+			const priceToAdd = this.priceFromDraft(context, price)
 
 			// If true, only the staged Attribute is set. If false, both current and
 			// staged Attribute is set.  Default is true
@@ -754,7 +787,7 @@ export class ProductRepository extends AbstractResourceRepository<'product'> {
 				(max, element) => (element.id > max ? element.id : max),
 				0
 			)
-			const variant = variantFromDraft(maxId + 1, variantDraft)
+			const variant = this.variantFromDraft(context, maxId + 1, variantDraft)
 			dataStaged.variants.push(variant)
 
 			const onlyStaged = staged !== undefined ? staged : true
@@ -1071,23 +1104,3 @@ const getVariant = (
 				: -1,
 	}
 }
-
-const variantFromDraft = (
-	variantId: number,
-	variant: ProductVariantDraft
-): ProductVariant => ({
-	id: variantId,
-	sku: variant?.sku,
-	key: variant?.key,
-	attributes: variant?.attributes ?? [],
-	prices: variant?.prices?.map(priceFromDraft),
-	assets: [],
-	images: [],
-})
-
-const priceFromDraft = (draft: PriceDraft): Price => ({
-	id: uuidv4(),
-	key: draft.key,
-	country: draft.country,
-	value: createTypedMoney(draft.value),
-})

package/src/repositories/review.ts

@@ -1,11 +1,18 @@
-import type {
-	Review,
-	ReviewDraft,
-	ReviewUpdateAction,
+import {
+	ChannelReference,
+	ProductReference,
+	type Review,
+	type ReviewDraft,
+	type ReviewUpdateAction,
+	type StateReference,
 } from '@commercetools/platform-sdk'
 import { getBaseResourceProperties } from '../helpers.js'
 import type { Writable } from '../types.js'
 import { AbstractResourceRepository, RepositoryContext } from './abstract.js'
+import {
+	createCustomFields,
+	getReferenceFromResourceIdentifier,
+} from './helpers.js'
 
 export class ReviewRepository extends AbstractResourceRepository<'review'> {
 	getTypeId() {
@@ -13,9 +20,34 @@ export class ReviewRepository extends AbstractResourceRepository<'review'> {
 	}
 
 	create(context: RepositoryContext, draft: ReviewDraft): Review {
+		if (!draft.target) throw new Error('Missing target')
 		const resource: Review = {
 			...getBaseResourceProperties(),
+
+			locale: draft.locale,
+			authorName: draft.authorName,
+			title: draft.title,
+			text: draft.text,
+			rating: draft.rating,
+			uniquenessValue: draft.uniquenessValue,
+			state: draft.state
+				? getReferenceFromResourceIdentifier<StateReference>(
+						draft.state,
+						context.projectKey,
+						this._storage
+				  )
+				: undefined,
+			target: draft.target
+				? getReferenceFromResourceIdentifier<
+						ProductReference | ChannelReference
+				  >(draft.target, context.projectKey, this._storage)
+				: undefined,
 			includedInStatistics: false,
+			custom: createCustomFields(
+				draft.custom,
+				context.projectKey,
+				this._storage
+			),
 		}
 		this.saveNew(context, resource)
 		return resource

package/src/services/index.ts

@@ -23,6 +23,7 @@ import { ProductProjectionService } from './product-projection.js'
 import { ProductSelectionService } from './product-selection.js'
 import { ProductTypeService } from './product-type.js'
 import { ProductService } from './product.js'
+import { ReviewService } from './reviews.js'
 import { ShippingMethodService } from './shipping-method.js'
 import { ShoppingListService } from './shopping-list.js'
 import { StandAlonePriceService } from './standalone-price.js'
@@ -84,6 +85,7 @@ export const createServices = (router: any, repos: any) => ({
 		router,
 		repos['product-selection']
 	),
+	reviews: new ReviewService(router, repos['review']),
 	'shopping-list': new ShoppingListService(router, repos['shopping-list']),
 	state: new StateService(router, repos['state']),
 	store: new StoreService(router, repos['store']),

package/src/services/product-selection.test.ts

@@ -29,7 +29,6 @@ describe('product-selection', () => {
 			key: 'foo',
 			version: 1,
 			productCount: 0,
-			type: 'individual',
 			mode: 'Individual',
 		})
 	})

package/src/services/reviews.ts

@@ -0,0 +1,16 @@
+import { Router } from 'express'
+import AbstractService from './abstract.js'
+import { ReviewRepository } from '../repositories/review.js'
+
+export class ReviewService extends AbstractService {
+	public repository: ReviewRepository
+
+	constructor(parent: Router, repository: ReviewRepository) {
+		super(parent)
+		this.repository = repository
+	}
+
+	getBasePath() {
+		return 'reviews'
+	}
+}

package/src/storage/in-memory.ts

@@ -415,12 +415,15 @@ export class InMemoryStorage extends AbstractStorage {
 			reference.typeId !== undefined &&
 			(reference.id !== undefined || reference.key !== undefined)
 		) {
-			// @ts-ignore
-			reference.obj = this.getByResourceIdentifier(projectKey, {
-				typeId: reference.typeId,
-				id: reference.id,
-				key: reference.key,
-			} as ResourceIdentifier)
+			// First check if the object is already resolved. This is the case when
+			// the complete resource is pushed via the .add() method.
+			if (!reference.obj) {
+				reference.obj = this.getByResourceIdentifier(projectKey, {
+					typeId: reference.typeId,
+					id: reference.id,
+					key: reference.key,
+				} as ResourceIdentifier)
+			}
 			if (expand) {
 				this._resolveResource(projectKey, reference.obj, expand)
 			}