@labdigital/commercetools-mock 2.7.0 → 2.9.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@labdigital/commercetools-mock",
   "author": "Michael van Tellingen",
-  "version": "2.7.0",
+  "version": "2.9.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/lib/predicateParser.test.ts

@@ -16,7 +16,67 @@ describe('Predicate filter', () => {
 				stringProperty: 'foobar',
 				booleanProperty: true,
 			},
+			array: [
+				{
+					numberProperty: 1234,
+					stringProperty: 'foo',
+					objectProperty: {
+						stringProperty: 'foo',
+						booleanProperty: true,
+					},
+				},
+				{
+					numberProperty: 2345,
+					stringProperty: 'bar',
+					objectProperty: {
+						stringProperty: 'bar',
+						booleanProperty: false,
+					},
+				},
+			],
 		},
+		array: [
+			{
+				nestedArray: [
+					{
+						stringProperty: 'foo',
+						nested: [
+							{
+								stringProperty: 'foo',
+							},
+						],
+					},
+					{
+						stringProperty: 'bar',
+						nested: [
+							{
+								stringProperty: 'bar',
+							},
+						],
+					},
+				],
+			},
+			{
+				nestedArray: [
+					{
+						stringProperty: 'foo-2',
+						nested: [
+							{
+								stringProperty: 'foo-2',
+							},
+						],
+					},
+					{
+						stringProperty: 'bar-2',
+						nested: [
+							{
+								stringProperty: 'bar-2',
+							},
+						],
+					},
+				],
+			},
+		],
 
 		// Longitude, latitude
 		geoLocation: [5.110230209615395, 52.06969591642097],
@@ -115,6 +175,30 @@ describe('Predicate filter', () => {
 		).toBeTruthy()
 	})
 
+	test('nestedArray filters on property', async () => {
+		expect(match(`nested(array(stringProperty="foo"))`)).toBeTruthy()
+		expect(match(`nested(array(stringProperty="bar"))`)).toBeTruthy()
+		expect(match(`nested(array(stringProperty="foobar"))`)).toBeFalsy()
+
+		// One level deeper
+		expect(
+			match(`nested(array(objectProperty(stringProperty="foo")))`)
+		).toBeTruthy()
+		expect(
+			match(`nested(array(objectProperty(stringProperty="bar")))`)
+		).toBeTruthy()
+		expect(
+			match(`nested(array(objectProperty(stringProperty="foobar")))`)
+		).toBeFalsy()
+	})
+
+	test('array filters on property', async () => {
+		expect(match(`array(nestedArray(stringProperty="foo")))`)).toBeTruthy()
+		expect(
+			match(`array(nestedArray(nested(stringProperty="foo"))))`)
+		).toBeTruthy()
+	})
+
 	test('geolocation within circle (...)', async () => {
 		expect(
 			match(
@@ -185,17 +269,18 @@ describe('Predicate filter', () => {
 		).toBeTruthy()
 	})
 
-	test('lexer confusion', async () => {
-		expect(() => match(`orSomething="foobar"`)).toThrow(PredicateError)
-		expect(() => match(`orSomething="foobar"`)).toThrow(
-			"The field 'orSomething' does not exist."
-		)
-
-		expect(() => match(`andSomething="foobar"`)).toThrow(PredicateError)
-		expect(() => match(`andSomething="foobar"`)).toThrow(
-			"The field 'andSomething' does not exist."
-		)
-	})
+	// TODO: disabled for now, see remark in predicateParser.ts in resolveValue
+	// test('lexer confusion', async () => {
+	// 	expect(() => match(`orSomething="foobar"`)).toThrow(PredicateError)
+	// 	expect(() => match(`orSomething="foobar"`)).toThrow(
+	// 		"The field 'orSomething' does not exist."
+	// 	)
+
+	// 	expect(() => match(`andSomething="foobar"`)).toThrow(PredicateError)
+	// 	expect(() => match(`andSomething="foobar"`)).toThrow(
+	// 		"The field 'andSomething' does not exist."
+	// 	)
+	// })
 
 	test('invalid predicate', async () => {
 		expect(() => match(`stringProperty=nomatch`)).toThrow(PredicateError)

package/src/lib/predicateParser.ts

@@ -96,7 +96,12 @@ const resolveValue = (obj: any, val: TypeSymbol): any => {
 				.filter((v) => val.value in v)
 				.map((v) => v[val.value])
 		}
-		throw new PredicateError(`The field '${val.value}' does not exist.`)
+
+		// TODO: We don't really validate the shape of the object here. To actually
+		// match commercetools behaviour we should throw an error if the requested
+		// field doesn't exist (unless it's a map)
+		// throw new PredicateError(`The field '${val.value}' does not exist.`)
+		return undefined
 	}
 
 	return obj[val.value]
@@ -243,11 +248,21 @@ const generateMatchFunc = (predicate: string): MatchFunc => {
 			const expr = parser.parse()
 			lexer.expect(')')
 			return (obj: any, vars: object) => {
-				const value = resolveValue(obj, left)
-				if (value) {
-					return expr(value, vars)
+				if (Array.isArray(obj)) {
+					return obj.some((item) => {
+						const value = resolveValue(item, left)
+						if (value) {
+							return expr(value, vars)
+						}
+						return false
+					})
+				} else {
+					const value = resolveValue(obj, left)
+					if (value) {
+						return expr(value, vars)
+					}
+					return false
 				}
-				return false
 			}
 		})
 		.bp(')', 0)
@@ -256,12 +271,23 @@ const generateMatchFunc = (predicate: string): MatchFunc => {
 			validateSymbol(expr)
 
 			return (obj: any, vars: VariableMap) => {
-				const resolvedValue = resolveValue(obj, left)
-				const resolvedSymbol = resolveSymbol(expr, vars)
-				if (Array.isArray(resolvedValue)) {
-					return !!resolvedValue.some((elem) => elem === resolvedSymbol)
+				if (Array.isArray(obj)) {
+					return obj.some((item) => {
+						const value = resolveValue(item, left)
+						const other = resolveSymbol(expr, vars)
+						if (Array.isArray(value)) {
+							return !!value.some((elem) => elem === other)
+						}
+						return value === other
+					})
+				} else {
+					const resolvedValue = resolveValue(obj, left)
+					const resolvedSymbol = resolveSymbol(expr, vars)
+					if (Array.isArray(resolvedValue)) {
+						return !!resolvedValue.some((elem) => elem === resolvedSymbol)
+					}
+					return resolvedValue === resolvedSymbol
 				}
-				return resolvedValue === resolvedSymbol
 			}
 		})
 		.led('!=', 20, ({ left, bp }) => {
@@ -350,10 +376,15 @@ const generateMatchFunc = (predicate: string): MatchFunc => {
 					symbols = [expr]
 				}
 
-				const inValues = symbols.map((item: TypeSymbol) =>
+				// The expression can be a list of variables, like
+				// :value_1, :value_2, but it can also be one variable
+				// containing a list, like :values.
+				// So to support both we just flatten the list.
+				const inValues = symbols.flatMap((item: TypeSymbol) =>
 					resolveSymbol(item, vars)
 				)
-				return inValues.includes(resolveValue(obj, left))
+				const value = resolveValue(obj, left)
+				return inValues.includes(value)
 			}
 		})
 		.led('MATCHES_IGNORE_CASE', 20, ({ left, bp }) => {

package/src/oauth/server.ts

@@ -24,7 +24,7 @@ export class OAuth2Server {
 	store: OAuth2Store
 	private customerRepository: CustomerRepository
 
-	constructor(options: { enabled: boolean; validate: boolean }) {
+	constructor(private options: { enabled: boolean; validate: boolean }) {
 		this.store = new OAuth2Store(options.validate)
 	}
 
@@ -53,6 +53,16 @@ export class OAuth2Server {
 	}
 
 	createMiddleware() {
+		if (!this.options.validate) {
+			return async (
+				request: Request,
+				response: Response,
+				next: NextFunction
+			) => {
+				next()
+			}
+		}
+
 		return async (request: Request, response: Response, next: NextFunction) => {
 			const token = getBearerToken(request)
 			if (!token) {

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/abstract.ts

@@ -1,6 +1,7 @@
 import type {
 	BaseResource,
 	Project,
+	QueryParam,
 	ResourceNotFoundError,
 	UpdateAction,
 } from '@commercetools/platform-sdk'
@@ -16,6 +17,9 @@ export type QueryParams = {
 	where?: string[]
 	offset?: number
 	limit?: number
+
+	// Predicate var values. Should always start with `var.`
+	[key: string]: QueryParam
 }
 
 export type GetParams = {
@@ -118,10 +122,7 @@ export abstract class AbstractResourceRepository<
 
 	query(context: RepositoryContext, params: QueryParams = {}) {
 		const result = this._storage.query(context.projectKey, this.getTypeId(), {
-			expand: params.expand,
-			where: params.where,
-			offset: params.offset,
-			limit: params.limit,
+			...params,
 		})
 
 		// @ts-ignore

package/src/repositories/cart.ts

@@ -1,31 +1,32 @@
-import type {
-	Address,
-	AddressDraft,
-	Cart,
-	CartAddLineItemAction,
-	CartChangeLineItemQuantityAction,
-	CartAddItemShippingAddressAction,
-	CartSetLineItemShippingDetailsAction,
-	CartDraft,
-	CartRemoveLineItemAction,
-	CartSetBillingAddressAction,
-	CartSetCountryAction,
-	CartSetCustomerEmailAction,
-	CartSetCustomFieldAction,
-	CartSetCustomTypeAction,
-	CartSetLocaleAction,
-	CartSetShippingAddressAction,
-	CartSetShippingMethodAction,
-	CustomFields,
-	GeneralError,
-	LineItem,
-	LineItemDraft,
-	ItemShippingDetails,
-	Price,
-	Product,
-	ProductPagedQueryResponse,
-	CartRemoveDiscountCodeAction,
-	ProductVariant,
+import {
+	type Address,
+	type AddressDraft,
+	type Cart,
+	type CartAddLineItemAction,
+	type CartChangeLineItemQuantityAction,
+	type CartAddItemShippingAddressAction,
+	type CartSetLineItemShippingDetailsAction,
+	type CartDraft,
+	type CartRemoveLineItemAction,
+	type CartSetBillingAddressAction,
+	type CartSetCountryAction,
+	type CartSetCustomerEmailAction,
+	type CartSetCustomFieldAction,
+	type CartSetCustomTypeAction,
+	type CartSetLocaleAction,
+	type CartSetShippingAddressAction,
+	type CartSetShippingMethodAction,
+	type CustomFields,
+	type GeneralError,
+	type LineItem,
+	type LineItemDraft,
+	type ItemShippingDetails,
+	type Price,
+	type Product,
+	type ProductPagedQueryResponse,
+	type CartRemoveDiscountCodeAction,
+	type ProductVariant,
+	type CartSetCustomShippingMethodAction,
 } from '@commercetools/platform-sdk'
 import { v4 as uuidv4 } from 'uuid'
 import { CommercetoolsError } from '../exceptions.js'
@@ -35,7 +36,12 @@ import {
 	AbstractResourceRepository,
 	type RepositoryContext,
 } from './abstract.js'
-import { createAddress, createCustomFields } from './helpers.js'
+import {
+	createAddress,
+	createCentPrecisionMoney,
+	createCustomFields,
+	createTypedMoney,
+} from './helpers.js'
 
 export class CartRepository extends AbstractResourceRepository<'cart'> {
 	getTypeId() {
@@ -74,6 +80,11 @@ export class CartRepository extends AbstractResourceRepository<'cart'> {
 				fractionDigits: 0,
 			},
 			shippingMode: 'Single',
+			shippingAddress: createAddress(
+				draft.shippingAddress,
+				context.projectKey,
+				this._storage
+			),
 			shipping: [],
 			origin: draft.origin ?? 'Customer',
 			refusedGifts: [],
@@ -335,10 +346,6 @@ export class CartRepository extends AbstractResourceRepository<'cart'> {
 					shippingMethod
 				)
 
-				if (!method) {
-					throw new Error(`Type ${shippingMethod} not found`)
-				}
-
 				// Based on the address we should select a shipping zone and
 				// use that to define the price.
 				// @ts-ignore
@@ -377,6 +384,43 @@ export class CartRepository extends AbstractResourceRepository<'cart'> {
 			}
 			resource.custom.fields[name] = value
 		},
+		setCustomShippingMethod: (
+			context: RepositoryContext,
+			resource: Writable<Cart>,
+			{
+				shippingMethodName,
+				shippingRate,
+				taxCategory,
+				externalTaxRate,
+			}: CartSetCustomShippingMethodAction
+		) => {
+			if (externalTaxRate) {
+				throw new Error('External tax rate is not supported')
+			}
+
+			const tax = taxCategory
+				? this._storage.getByResourceIdentifier<'tax-category'>(
+						context.projectKey,
+						taxCategory
+				  )
+				: undefined
+
+			resource.shippingInfo = {
+				shippingMethodName,
+				price: createCentPrecisionMoney(shippingRate.price),
+				shippingRate: {
+					price: createTypedMoney(shippingRate.price),
+					tiers: [],
+				},
+				taxCategory: tax
+					? {
+							typeId: 'tax-category',
+							id: tax?.id,
+					  }
+					: undefined,
+				shippingMethodState: 'MatchesCart',
+			}
+		},
 		setCustomType: (
 			context: RepositoryContext,
 			resource: Writable<Cart>,

package/src/repositories/custom-object.ts

@@ -8,6 +8,7 @@ import { cloneObject, getBaseResourceProperties } from '../helpers.js'
 import type { Writable } from '../types.js'
 import {
 	AbstractResourceRepository,
+	QueryParams,
 	type RepositoryContext,
 } from './abstract.js'
 import { checkConcurrentModification } from './errors.js'
@@ -67,6 +68,23 @@ export class CustomObjectRepository extends AbstractResourceRepository<'key-valu
 		}
 	}
 
+	queryWithContainer(
+		context: RepositoryContext,
+		container: string,
+		params: QueryParams = {}
+	) {
+		const whereClause = params.where || []
+		whereClause.push(`container="${container}"`)
+		const result = this._storage.query(context.projectKey, this.getTypeId(), {
+			...params,
+			where: whereClause,
+		})
+
+		// @ts-ignore
+		result.results = result.results.map(this.postProcessResource)
+		return result
+	}
+
 	getWithContainerAndKey(
 		context: RepositoryContext,
 		container: string,

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)