@labdigital/commercetools-mock 2.20.0 → 2.20.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@labdigital/commercetools-mock",
-  "version": "2.20.0",
+  "version": "2.20.2",
   "license": "MIT",
   "author": "Michael van Tellingen",
   "type": "module",
@@ -49,7 +49,7 @@
     "@types/uuid": "^9.0.8",
     "@typescript-eslint/eslint-plugin": "^7.0.2",
     "@typescript-eslint/parser": "^7.0.2",
-    "@vitest/coverage-v8": "^1.3.1",
+    "@vitest/coverage-v8": "^1.5.0",
     "esbuild": "^0.20.1",
     "eslint": "^8.57.0",
     "eslint-plugin-sort-class-members": "^1.20.0",
@@ -65,12 +65,11 @@
     "tslib": "^2.6.2",
     "tsup": "^8.0.2",
     "typescript": "^5.3.3",
-    "vitest": "^1.3.1"
+    "vitest": "^1.5.0"
   },
-  "packageManager": "pnpm@8.6.5",
   "engines": {
     "node": ">=18",
-    "pnpm": ">=8.6.5"
+    "pnpm": ">=9.0.2"
   },
   "publishConfig": {
     "access": "public"

package/src/repositories/abstract.ts

@@ -53,7 +53,7 @@ export abstract class AbstractRepository<R extends BaseResource | Project> {
 		resource: R,
 	): void;
 
-	abstract postProcessResource(resource: any): any;
+	abstract postProcessResource(context: RepositoryContext, resource: any): any;
 
 	processUpdateActions(
 		context: RepositoryContext,
@@ -78,7 +78,7 @@ export abstract class AbstractRepository<R extends BaseResource | Project> {
 			this.saveUpdate(context, version, updatedResource);
 		}
 
-		const result = this.postProcessResource(updatedResource);
+		const result = this.postProcessResource(context, updatedResource);
 		if (!result) {
 			throw new Error("invalid post process action");
 		}
@@ -113,7 +113,9 @@ export abstract class AbstractResourceRepository<
 			id,
 			params,
 		);
-		return resource ? this.postProcessResource(resource) : null;
+		return resource
+			? this.postProcessResource(context, resource, params)
+			: null;
 	}
 
 	get(
@@ -127,7 +129,9 @@ export abstract class AbstractResourceRepository<
 			id,
 			params,
 		);
-		return resource ? this.postProcessResource(resource) : null;
+		return resource
+			? this.postProcessResource(context, resource, params)
+			: null;
 	}
 
 	getByKey(
@@ -141,10 +145,16 @@ export abstract class AbstractResourceRepository<
 			key,
 			params,
 		);
-		return resource ? this.postProcessResource(resource) : null;
+		return resource
+			? this.postProcessResource(context, resource, params)
+			: null;
 	}
 
-	postProcessResource(resource: ResourceMap[T]): ResourceMap[T] {
+	postProcessResource(
+		context: RepositoryContext,
+		resource: ResourceMap[T],
+		params?: GetParams,
+	): ResourceMap[T] {
 		return resource;
 	}
 
@@ -153,9 +163,13 @@ export abstract class AbstractResourceRepository<
 			...params,
 		});
 
-		// @ts-ignore
-		result.results = result.results.map(this.postProcessResource);
-		return result;
+		const data = result.results.map((r) =>
+			this.postProcessResource(context, r as ResourceMap[T]),
+		);
+		return {
+			...result,
+			results: data,
+		};
 	}
 
 	saveNew(

package/src/repositories/category/index.test.ts

@@ -0,0 +1,92 @@
+import { describe, expect, test } from "vitest";
+import { InMemoryStorage } from "~src/storage";
+import { CategoryRepository } from "./index";
+
+describe("Order repository", () => {
+	const storage = new InMemoryStorage();
+	const repository = new CategoryRepository(storage);
+
+	test("valid ancestors", async () => {
+		const root = repository.create(
+			{ projectKey: "dummy" },
+			{
+				key: "root",
+				slug: {
+					en: "root",
+				},
+				name: {
+					en: "root",
+				},
+			},
+		);
+
+		const level1 = repository.create(
+			{ projectKey: "dummy" },
+			{
+				key: "level-1",
+				slug: {
+					en: "level-1",
+				},
+				name: {
+					en: "level-1",
+				},
+				parent: {
+					id: root.id,
+					typeId: "category",
+				},
+			},
+		);
+
+		const level2 = repository.create(
+			{ projectKey: "dummy" },
+			{
+				key: "level-2",
+				slug: {
+					en: "level-2",
+				},
+				name: {
+					en: "level-2",
+				},
+				parent: {
+					id: level1.id,
+					typeId: "category",
+				},
+			},
+		);
+
+		const level3 = repository.create(
+			{ projectKey: "dummy" },
+			{
+				key: "level-3",
+				slug: {
+					en: "level-3",
+				},
+				name: {
+					en: "level-3",
+				},
+				parent: {
+					id: level2.id,
+					typeId: "category",
+				},
+			},
+		);
+
+		const result = repository.get({ projectKey: "dummy" }, level3.id);
+		expect(result?.ancestors).toHaveLength(3);
+		expect(result?.ancestors).toEqual([
+			{ id: level2.id, typeId: "category" },
+			{ id: level1.id, typeId: "category" },
+			{ id: root.id, typeId: "category" },
+		]);
+
+		const expandResult = repository.get({ projectKey: "dummy" }, level3.id, {
+			expand: ["ancestors[*]"],
+		});
+		expect(expandResult?.ancestors).toHaveLength(3);
+		expect(expandResult?.ancestors).toEqual([
+			{ id: level2.id, typeId: "category", obj: level2 },
+			{ id: level1.id, typeId: "category", obj: level1 },
+			{ id: root.id, typeId: "category", obj: root },
+		]);
+	});
+});

package/src/repositories/category/index.ts

@@ -1,9 +1,16 @@
-import type { Category, CategoryDraft } from "@commercetools/platform-sdk";
+import type {
+	Category,
+	CategoryDraft,
+	CategoryReference,
+} from "@commercetools/platform-sdk";
 import { v4 as uuidv4 } from "uuid";
 import { getBaseResourceProperties } from "~src/helpers";
+import { parseExpandClause } from "~src/lib/expandParser";
 import { AbstractStorage } from "~src/storage/abstract";
+import { Writable } from "~src/types";
 import {
 	AbstractResourceRepository,
+	GetParams,
 	type RepositoryContext,
 } from "../abstract";
 import { createCustomFields } from "../helpers";
@@ -26,7 +33,7 @@ export class CategoryRepository extends AbstractResourceRepository<"category"> {
 			parent: draft.parent
 				? { typeId: "category", id: draft.parent.id! }
 				: undefined,
-			ancestors: [], // TODO
+			ancestors: [], // Resolved at runtime
 			assets:
 				draft.assets?.map((d) => ({
 					id: uuidv4(),
@@ -49,4 +56,38 @@ export class CategoryRepository extends AbstractResourceRepository<"category"> {
 		};
 		return this.saveNew(context, resource);
 	}
+
+	postProcessResource(
+		context: RepositoryContext,
+		resource: Writable<Category>,
+		params?: GetParams,
+	): Category {
+		let node: Category = resource;
+		const ancestors: CategoryReference[] = [];
+
+		// TODO: The expand clause here is a hack, the current expand architecture
+		// is not able to handle the case for 'dynamic' fields like ancestors which
+		// are resolved at runtime.  We should do the expand resolution post query
+		// execution for all resources
+
+		const expandClauses = params?.expand?.map(parseExpandClause) ?? [];
+		const addExpand = expandClauses?.find(
+			(c) => c.element === "ancestors" && c.index === "*",
+		);
+
+		while (node.parent) {
+			node = this._storage.getByResourceIdentifier<"category">(
+				context.projectKey,
+				node.parent,
+			);
+			ancestors.push({
+				typeId: "category",
+				id: node.id,
+				obj: addExpand ? node : undefined,
+			});
+		}
+
+		resource.ancestors = ancestors;
+		return resource;
+	}
 }

package/src/repositories/extension.ts

@@ -35,7 +35,10 @@ export class ExtensionRepository extends AbstractResourceRepository<"extension">
 		return this.saveNew(context, resource);
 	}
 
-	postProcessResource(resource: Extension): Extension {
+	postProcessResource(
+		context: RepositoryContext,
+		resource: Extension,
+	): Extension {
 		if (resource) {
 			const extension = resource as Extension;
 			if (

package/src/repositories/project.ts

@@ -31,10 +31,10 @@ export class ProjectRepository extends AbstractRepository<Project> {
 
 	get(context: RepositoryContext): Project | null {
 		const resource = this._storage.getProject(context.projectKey);
-		return this.postProcessResource(resource);
+		return this.postProcessResource(context, resource);
 	}
 
-	postProcessResource(resource: Project): Project {
+	postProcessResource(context: RepositoryContext, resource: Project): Project {
 		if (resource) {
 			return maskSecretValue(resource, "externalOAuth.authorizationHeader");
 		}

package/src/services/category.test.ts

@@ -144,6 +144,8 @@ describe("categories changeParent", () => {
 			typeId: "category",
 			id: category1?.id,
 		});
+		expect(changeNameResponse.body.ancestors).toHaveLength(1);
+		expect(changeNameResponse.body.ancestors[0].id).toEqual(category1?.id);
 	});
 });