@labdigital/commercetools-mock 2.45.1 → 2.47.0

package/src/lib/predicateParser.ts

@@ -5,7 +5,7 @@
  * See https://docs.commercetools.com/api/predicates/query
  */
 import { haversineDistance } from "./haversine";
-import { Lexer, Parser, type ITokenPosition } from "./parser";
+import { type ITokenPosition, Lexer, Parser } from "./parser";
 
 export class PredicateError {
 	message: string;
@@ -34,10 +34,9 @@ export const matchesPredicate = (
 			const func = generateMatchFunc(item);
 			return func(target, variables ?? {});
 		});
-	} else {
-		const func = generateMatchFunc(predicate);
-		return func(target, variables ?? {});
 	}
+	const func = generateMatchFunc(predicate);
+	return func(target, variables ?? {});
 };
 
 export const parseQueryExpression = (
@@ -47,9 +46,8 @@ export const parseQueryExpression = (
 		const callbacks = predicate.map((item) => generateMatchFunc(item));
 		return (target: any, variables: VariableMap) =>
 			callbacks.every((callback) => callback(target, variables));
-	} else {
-		return generateMatchFunc(predicate);
 	}
+	return generateMatchFunc(predicate);
 };
 
 type TypeSymbol = {
@@ -124,6 +122,12 @@ const getLexer = (value: string) =>
 		.token("IS", /is(?![-_a-z0-9]+)/i)
 		.token("DEFINED", /defined(?![-_a-z0-9]+)/i)
 
+		// Special case for UUID identifiers,
+		// since they otherwise would get matched as INT, when starting with a digit
+		.token(
+			"IDENTIFIER",
+			/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/,
+		)
 		.token("FLOAT", /\d+\.\d+/)
 		.token("INT", /\d+/)
 		.token("VARIABLE", /:([-_A-Za-z0-9]+)/)
@@ -171,7 +175,7 @@ const generateMatchFunc = (predicate: string): MatchFunc => {
 			(t) =>
 				({
 					type: "boolean",
-					value: t.token.match === "true" ? true : false,
+					value: t.token.match === "true",
 					pos: t.token.strpos(),
 				}) as TypeSymbol,
 		)
@@ -203,7 +207,7 @@ const generateMatchFunc = (predicate: string): MatchFunc => {
 			(t) =>
 				({
 					type: "int",
-					value: parseInt(t.token.match, 10),
+					value: Number.parseInt(t.token.match, 10),
 					pos: t.token.strpos(),
 				}) as TypeSymbol,
 		)
@@ -213,7 +217,7 @@ const generateMatchFunc = (predicate: string): MatchFunc => {
 			(t) =>
 				({
 					type: "float",
-					value: parseFloat(t.token.match),
+					value: Number.parseFloat(t.token.match),
 					pos: t.token.strpos(),
 				}) as TypeSymbol,
 		)
@@ -236,9 +240,8 @@ const generateMatchFunc = (predicate: string): MatchFunc => {
 			const expr: any = parser.parse({ terminals: [bp - 1] });
 			if (Array.isArray(expr)) {
 				return [left, ...expr];
-			} else {
-				return [left, expr];
 			}
+			return [left, expr];
 		})
 		.nud("(", 100, (t) => {
 			const expr: any = parser.parse({ terminals: [")"] });
@@ -256,17 +259,16 @@ const generateMatchFunc = (predicate: string): MatchFunc => {
 						}
 						return false;
 					});
-				} else {
-					const value = resolveValue(obj, left);
-					if (value) {
-						if (Array.isArray(value)) {
-							return value.some((item) => expr(item, vars));
-						}
-
-						return expr(value, vars);
+				}
+				const value = resolveValue(obj, left);
+				if (value) {
+					if (Array.isArray(value)) {
+						return value.some((item) => expr(item, vars));
 					}
-					return false;
+
+					return expr(value, vars);
 				}
+				return false;
 			};
 		})
 		.bp(")", 0)
@@ -284,14 +286,13 @@ const generateMatchFunc = (predicate: string): MatchFunc => {
 						}
 						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;
 				}
+				const resolvedValue = resolveValue(obj, left);
+				const resolvedSymbol = resolveSymbol(expr, vars);
+				if (Array.isArray(resolvedValue)) {
+					return !!resolvedValue.some((elem) => elem === resolvedSymbol);
+				}
+				return resolvedValue === resolvedSymbol;
 			};
 		})
 		.led("!=", 20, ({ left, bp }) => {
@@ -347,12 +348,11 @@ const generateMatchFunc = (predicate: string): MatchFunc => {
 							const val = resolveValue(obj, left);
 							return val.length === 0;
 						};
-					} else {
-						return (obj: any, vars: VariableMap) => {
-							const val = resolveValue(obj, left);
-							return val.length !== 0;
-						};
 					}
+					return (obj: any, vars: VariableMap) => {
+						const val = resolveValue(obj, left);
+						return val.length !== 0;
+					};
 				}
 				case "defined": {
 					if (!invert) {
@@ -360,12 +360,11 @@ const generateMatchFunc = (predicate: string): MatchFunc => {
 							const val = resolveValue(obj, left);
 							return val !== undefined;
 						};
-					} else {
-						return (obj: any, vars: VariableMap) => {
-							const val = resolveValue(obj, left);
-							return val === undefined;
-						};
 					}
+					return (obj: any, vars: VariableMap) => {
+						const val = resolveValue(obj, left);
+						return val === undefined;
+					};
 				}
 				default: {
 					throw new Error("Unexpected");
@@ -457,9 +456,8 @@ const generateMatchFunc = (predicate: string): MatchFunc => {
 				const array = expr.map((item: TypeSymbol) => resolveSymbol(item, vars));
 				if (keyword.type === "ALL") {
 					return array.every((item: any) => value.includes(item));
-				} else {
-					return array.some((item: any) => value.includes(item));
 				}
+				return array.some((item: any) => value.includes(item));
 			};
 		})
 
@@ -472,9 +470,7 @@ const generateMatchFunc = (predicate: string): MatchFunc => {
 		const column = lines[lines.length - 1].length;
 
 		throw new PredicateError(
-			`Unexpected end of input, expected SphereIdentifierChar, comparison ` +
-				`operator, not, in, contains, is, within or matches` +
-				` (line ${lines.length}, column ${column})`,
+			`Unexpected end of input, expected SphereIdentifierChar, comparison operator, not, in, contains, is, within or matches (line ${lines.length}, column ${column})`,
 		);
 	}
 	return result;

package/src/lib/productSearchFilter.test.ts

@@ -138,6 +138,24 @@ describe("Product search filter", () => {
 				},
 			}).isMatch,
 		).toBeTruthy();
+
+		expect(
+			match({
+				exact: {
+					field: "variants.sku",
+					values: ["MYSKU", "OTHER"],
+				},
+			}).isMatch,
+		).toBeTruthy();
+
+		expect(
+			match({
+				exact: {
+					field: "variants.sku",
+					values: ["OTHER"],
+				},
+			}).isMatch,
+		).toBeFalsy();
 	});
 
 	test("by attribute value", async () => {

package/src/lib/productSearchFilter.ts

@@ -98,6 +98,13 @@ export const parseSearchQuery = (
 	}
 
 	if (isSearchExactExpression(searchQuery)) {
+		if (Array.isArray(searchQuery.exact.values)) {
+			return generateFieldMatchFunc(
+				(value: any) => (searchQuery.exact.values ?? []).includes(value),
+				searchQuery.exact,
+			);
+		}
+
 		return generateFieldMatchFunc(
 			(value: any) => value === searchQuery.exact.value,
 			searchQuery.exact,

package/src/lib/projectionSearchFilter.test.ts

@@ -68,8 +68,8 @@ describe("Search filter", () => {
 	};
 
 	test("by product key", async () => {
-		expect(match(`key:exists`).isMatch).toBeTruthy();
-		expect(match(`key:missing`).isMatch).toBeFalsy();
+		expect(match("key:exists").isMatch).toBeTruthy();
+		expect(match("key:missing").isMatch).toBeFalsy();
 		expect(match(`key:"test-product"`).isMatch).toBeTruthy();
 	});
 
@@ -80,29 +80,29 @@ describe("Search filter", () => {
 	});
 
 	test("by SKU", async () => {
-		expect(match(`variants.sku:exists`).isMatch).toBeTruthy();
-		expect(match(`variants.sku:missing`).isMatch).toBeFalsy();
+		expect(match("variants.sku:exists").isMatch).toBeTruthy();
+		expect(match("variants.sku:missing").isMatch).toBeFalsy();
 		expect(match(`variants.sku:"MYSKU"`).isMatch).toBeTruthy();
 	});
 
 	test("by attribute value", async () => {
-		expect(match(`variants.attributes.number:4`).isMatch).toBeTruthy();
-		expect(match(`variants.attributes.number:3,4`).isMatch).toBeTruthy();
-		expect(match(`variants.attributes.number:3,4,5`).isMatch).toBeTruthy();
-		expect(match(`variants.attributes.number:1,2,3,5`).isMatch).toBeFalsy();
+		expect(match("variants.attributes.number:4").isMatch).toBeTruthy();
+		expect(match("variants.attributes.number:3,4").isMatch).toBeTruthy();
+		expect(match("variants.attributes.number:3,4,5").isMatch).toBeTruthy();
+		expect(match("variants.attributes.number:1,2,3,5").isMatch).toBeFalsy();
 	});
 
 	test("by attribute range", async () => {
 		expect(
-			match(`variants.attributes.number:range (0 TO 5)`).isMatch,
+			match("variants.attributes.number:range (0 TO 5)").isMatch,
 		).toBeTruthy();
 
 		expect(
-			match(`variants.attributes.number:range (* TO 5)`).isMatch,
+			match("variants.attributes.number:range (* TO 5)").isMatch,
 		).toBeTruthy();
 
 		expect(
-			match(`variants.attributes.number:range (* TO *)`).isMatch,
+			match("variants.attributes.number:range (* TO *)").isMatch,
 		).toBeTruthy();
 	});
 
@@ -118,14 +118,14 @@ describe("Search filter", () => {
 
 	test("by price range", async () => {
 		expect(
-			match(`variants.price.centAmount:range (1500 TO 2000)`).isMatch,
+			match("variants.price.centAmount:range (1500 TO 2000)").isMatch,
 		).toBeTruthy();
 	});
 
 	test("by price range - or", async () => {
 		expect(
 			match(
-				`variants.price.centAmount:range (2 TO 1500 ), (1500 TO 3000), (3000 TO 6000)`,
+				"variants.price.centAmount:range (2 TO 1500 ), (1500 TO 3000), (3000 TO 6000)",
 			).isMatch,
 		).toBeTruthy();
 	});
@@ -136,7 +136,7 @@ describe("Search filter", () => {
 
 		// No currency given
 		result = match(
-			`variants.scopedPrice.value.centAmount:range (1500 TO 2000)`,
+			"variants.scopedPrice.value.centAmount:range (1500 TO 2000)",
 		);
 		expect(result.isMatch).toBeFalsy();
 
@@ -145,7 +145,7 @@ describe("Search filter", () => {
 		applyPriceSelector(products, { currency: "EUR" });
 
 		result = match(
-			`variants.scopedPrice.value.centAmount:range (1500 TO 2000)`,
+			"variants.scopedPrice.value.centAmount:range (1500 TO 2000)",
 			products[0],
 		);
 		expect(result.isMatch).toBeTruthy();
@@ -161,7 +161,7 @@ describe("Search filter", () => {
 		applyPriceSelector(products, { currency: "USD" });
 
 		result = match(
-			`variants.scopedPrice.value.centAmount:range (1500 TO 2000)`,
+			"variants.scopedPrice.value.centAmount:range (1500 TO 2000)",
 			products[0],
 		);
 		expect(result.isMatch).toBeFalsy();
@@ -170,7 +170,7 @@ describe("Search filter", () => {
 		products = [cloneObject(exampleProduct)];
 		applyPriceSelector(products, { currency: "EUR", country: "NL" });
 		result = match(
-			`variants.scopedPrice.value.centAmount:range (1500 TO 2000)`,
+			"variants.scopedPrice.value.centAmount:range (1500 TO 2000)",
 			products[0],
 		);
 		expect(result.isMatch).toBeFalsy();

package/src/lib/projectionSearchFilter.ts

@@ -154,7 +154,7 @@ const parseFilter = (filter: string): ExpressionSet => {
 				({
 					type: "Symbol",
 					kind: "int",
-					value: parseInt(t.token.match, 10),
+					value: Number.parseInt(t.token.match, 10),
 				}) as TypeSymbol,
 		)
 		.nud("STAR", 5, (_) => ({
@@ -184,9 +184,8 @@ const parseFilter = (filter: string): ExpressionSet => {
 			const expr: any = parser.parse({ terminals: [bp - 1] });
 			if (Array.isArray(expr)) {
 				return [left, ...expr];
-			} else {
-				return [left, expr];
 			}
+			return [left, expr];
 		})
 		.nud("(", 100, (t) => {
 			const expr: any = parser.parse({ terminals: [")"] });

package/src/oauth/server.test.ts

@@ -55,7 +55,7 @@ describe("OAuth2Server", () => {
 
 		it("should refresh a token", async () => {
 			const createResponse = await supertest(app)
-				.post(`/my-project/anonymous/token`)
+				.post("/my-project/anonymous/token")
 				.auth("validClientId", "validClientSecret")
 				.query({ grant_type: "client_credentials" })
 				.send();

package/src/oauth/server.ts

@@ -180,7 +180,8 @@ export class OAuth2Server {
 				request.query.scope?.toString(),
 			);
 			return response.status(200).send(token);
-		} else if (grantType === "refresh_token") {
+		}
+		if (grantType === "refresh_token") {
 			const refreshToken =
 				request.query.refresh_token?.toString() || request.body.refresh_token;
 			if (!refreshToken) {
@@ -214,17 +215,16 @@ export class OAuth2Server {
 				);
 			}
 			return response.status(200).send(token);
-		} else {
-			return next(
-				new CommercetoolsError<UnsupportedGrantType>(
-					{
-						code: "unsupported_grant_type",
-						message: `Invalid parameter: grant_type: Invalid grant type: ${grantType}`,
-					},
-					400,
-				),
-			);
 		}
+		return next(
+			new CommercetoolsError<UnsupportedGrantType>(
+				{
+					code: "unsupported_grant_type",
+					message: `Invalid parameter: grant_type: Invalid grant type: ${grantType}`,
+				},
+				400,
+			),
+		);
 	}
 
 	async customerTokenHandler(

package/src/priceSelector.ts

@@ -22,7 +22,7 @@ export type PriceSelector = {
 export const applyPriceSelector = (
 	products: ProductProjection[],
 	selector: PriceSelector,
-	noScopedPrice: boolean = false,
+	noScopedPrice = false,
 ) => {
 	validatePriceSelector(selector);
 

package/src/product-projection-search.ts

@@ -27,25 +27,25 @@ import type { AbstractStorage } from "./storage";
 import type { Writable } from "./types";
 
 export type ProductProjectionSearchParams = {
-	"fuzzy"?: boolean;
-	"fuzzyLevel"?: number;
-	"markMatchingVariants"?: boolean;
-	"staged"?: boolean;
-	"filter"?: string[];
+	fuzzy?: boolean;
+	fuzzyLevel?: number;
+	markMatchingVariants?: boolean;
+	staged?: boolean;
+	filter?: string[];
 	"filter.facets"?: string[];
 	"filter.query"?: string[];
-	"facet"?: string | string[];
-	"sort"?: string | string[];
-	"limit"?: number;
-	"offset"?: number;
-	"withTotal"?: boolean;
-	"priceCurrency"?: string;
-	"priceCountry"?: string;
-	"priceCustomerGroup"?: string;
-	"priceChannel"?: string;
-	"localeProjection"?: string;
-	"storeProjection"?: string;
-	"expand"?: string | string[];
+	facet?: string | string[];
+	sort?: string | string[];
+	limit?: number;
+	offset?: number;
+	withTotal?: boolean;
+	priceCurrency?: string;
+	priceCountry?: string;
+	priceCustomerGroup?: string;
+	priceChannel?: string;
+	localeProjection?: string;
+	storeProjection?: string;
+	expand?: string | string[];
 	[key: string]: QueryParam;
 };
 
@@ -342,9 +342,8 @@ export class ProductProjectionSearch {
 						max: numValues > 0 ? Math.max(...values) : 0,
 						mean: numValues > 0 ? mean(values) : 0,
 					};
-				} else {
-					throw new Error("not supported");
 				}
+				throw new Error("not supported");
 			}) || [];
 		const data: RangeFacetResult = {
 			type: "range",

package/src/product-search.ts

@@ -13,6 +13,12 @@ import { validateSearchQuery } from "./lib/searchQueryTypeChecker";
 import { applyPriceSelector } from "./priceSelector";
 import type { AbstractStorage } from "./storage";
 
+interface ProductSearchVariantAvailability {
+	isOnStock: boolean;
+	availableQuantity: number;
+	isOnStockForChannel: string | undefined;
+}
+
 export class ProductSearch {
 	protected _storage: AbstractStorage;
 
@@ -24,10 +30,32 @@ export class ProductSearch {
 		projectKey: string,
 		params: ProductSearchRequest,
 	): ProductPagedSearchResponse {
-		let resources = this._storage
+		const availabilityBySku = this._storage
+			.all(projectKey, "inventory-entry")
+			.reduce((acc, entry) => {
+				const existingEntry = acc.get(entry.sku);
+
+				acc.set(entry.sku, {
+					isOnStock: existingEntry?.isOnStock || entry.quantityOnStock > 0,
+					availableQuantity:
+						existingEntry?.availableQuantity ?? 0 + entry.quantityOnStock,
+					// NOTE: This doesn't handle inventory entries for multiple channels,
+					// so it doesn't exactly replicate the behavior of the commercetools api.
+					isOnStockForChannel:
+						existingEntry?.isOnStockForChannel ?? entry.supplyChannel?.id,
+				});
+
+				return acc;
+			}, new Map<string, ProductSearchVariantAvailability>());
+
+		let productResources = this._storage
 			.all(projectKey, "product")
 			.map((r) =>
-				this.transform(r, params.productProjectionParameters?.staged ?? false),
+				this.transformProduct(
+					r,
+					params.productProjectionParameters?.staged ?? false,
+					availabilityBySku,
+				),
 			)
 			.filter((p) => {
 				if (!(params.productProjectionParameters?.staged ?? false)) {
@@ -46,7 +74,7 @@ export class ProductSearch {
 				const matchFunc = parseSearchQuery(params.query);
 
 				// Filters can modify the output. So clone the resources first.
-				resources = resources.filter((resource) =>
+				productResources = productResources.filter((resource) =>
 					matchFunc(resource, markMatchingVariant),
 				);
 			} catch (err) {
@@ -63,7 +91,7 @@ export class ProductSearch {
 
 		// Apply the priceSelector
 		if (params.productProjectionParameters) {
-			applyPriceSelector(resources, {
+			applyPriceSelector(productResources, {
 				country: params.productProjectionParameters.priceCountry,
 				channel: params.productProjectionParameters.priceChannel,
 				customerGroup: params.productProjectionParameters.priceCustomerGroup,
@@ -76,7 +104,10 @@ export class ProductSearch {
 
 		const offset = params.offset || 0;
 		const limit = params.limit || 20;
-		const productProjectionsResult = resources.slice(offset, offset + limit);
+		const productProjectionsResult = productResources.slice(
+			offset,
+			offset + limit,
+		);
 
 		/**
 		 * Do not supply productProjection if productProjectionParameters are not given
@@ -100,7 +131,7 @@ export class ProductSearch {
 		);
 
 		return {
-			total: resources.length,
+			total: productResources.length,
 			offset: offset,
 			limit: limit,
 			results: results,
@@ -108,7 +139,11 @@ export class ProductSearch {
 		};
 	}
 
-	transform(product: Product, staged: boolean): ProductProjection {
+	transformProduct(
+		product: Product,
+		staged: boolean,
+		availabilityBySku: Map<string, ProductSearchVariantAvailability>,
+	): ProductProjection {
 		const obj = !staged
 			? product.masterData.current
 			: product.masterData.staged;
@@ -125,7 +160,12 @@ export class ProductSearch {
 			slug: obj.slug,
 			categories: obj.categories,
 			masterVariant: obj.masterVariant,
-			variants: obj.variants,
+			variants: obj.variants.map((variant) => ({
+				...variant,
+				availability: variant.sku
+					? availabilityBySku.get(variant.sku)
+					: { isOnStock: false, availableQuantity: 0, isOnStockForChannel: [] },
+			})),
 			productType: product.productType,
 			hasStagedChanges: product.masterData.hasStagedChanges,
 			published: product.masterData.published,

package/src/repositories/business-unit.ts

@@ -7,21 +7,21 @@ import type {
 	CompanyDraft,
 	DivisionDraft,
 } from "@commercetools/platform-sdk";
-import {
-	type Associate,
-	type BusinessUnit,
-	type BusinessUnitAddAddressAction,
-	type BusinessUnitAddAssociateAction,
-	type BusinessUnitAddStoreAction,
-	type BusinessUnitChangeAddressAction,
-	type BusinessUnitChangeNameAction,
-	type BusinessUnitChangeParentUnitAction,
-	type BusinessUnitDraft,
-	type BusinessUnitSetAssociatesAction,
-	type BusinessUnitSetContactEmailAction,
-	type BusinessUnitSetStoreModeAction,
-	type Company,
-	type Division,
+import type {
+	Associate,
+	BusinessUnit,
+	BusinessUnitAddAddressAction,
+	BusinessUnitAddAssociateAction,
+	BusinessUnitAddStoreAction,
+	BusinessUnitChangeAddressAction,
+	BusinessUnitChangeNameAction,
+	BusinessUnitChangeParentUnitAction,
+	BusinessUnitDraft,
+	BusinessUnitSetAssociatesAction,
+	BusinessUnitSetContactEmailAction,
+	BusinessUnitSetStoreModeAction,
+	Company,
+	Division,
 } from "@commercetools/platform-sdk";
 import type { Config } from "~src/config";
 import { generateRandomString, getBaseResourceProperties } from "../helpers";
@@ -110,7 +110,8 @@ export class BusinessUnitRepository extends AbstractResourceRepository<"business
 
 			this.saveNew(context, division);
 			return division;
-		} else if (this._isCompanyDraft(draft)) {
+		}
+		if (this._isCompanyDraft(draft)) {
 			const company = resource as Company;
 
 			this.saveNew(context, company);