@labdigital/commercetools-mock 2.66.0 → 3.0.0-beta.0

package/src/schemas/generated/subscription.ts

@@ -0,0 +1,20 @@
+// This file is auto-generated by scripts/generate-schemas.ts
+// Do not edit manually.
+
+import { z } from "zod";
+import {
+	ChangeSubscriptionSchema,
+	DeliveryFormatSchema,
+	DestinationSchema,
+	EventSubscriptionSchema,
+	MessageSubscriptionSchema,
+} from "./common.ts";
+
+export const SubscriptionDraftSchema = z.object({
+	destination: DestinationSchema,
+	key: z.string().optional(),
+	messages: z.array(MessageSubscriptionSchema).optional(),
+	changes: z.array(ChangeSubscriptionSchema).optional(),
+	events: z.array(EventSubscriptionSchema).optional(),
+	format: DeliveryFormatSchema.optional(),
+});

package/src/schemas/generated/tax-category.ts

@@ -0,0 +1,12 @@
+// This file is auto-generated by scripts/generate-schemas.ts
+// Do not edit manually.
+
+import { z } from "zod";
+import { TaxRateDraftSchema } from "./common.ts";
+
+export const TaxCategoryDraftSchema = z.object({
+	name: z.string(),
+	description: z.string().optional(),
+	rates: z.array(TaxRateDraftSchema).optional(),
+	key: z.string().optional(),
+});

package/src/schemas/generated/type.ts

@@ -0,0 +1,17 @@
+// This file is auto-generated by scripts/generate-schemas.ts
+// Do not edit manually.
+
+import { z } from "zod";
+import {
+	FieldDefinitionSchema,
+	LocalizedStringSchema,
+	ResourceTypeIdSchema,
+} from "./common.ts";
+
+export const TypeDraftSchema = z.object({
+	key: z.string(),
+	name: LocalizedStringSchema,
+	description: LocalizedStringSchema.optional(),
+	resourceTypeIds: z.array(ResourceTypeIdSchema),
+	fieldDefinitions: z.array(FieldDefinitionSchema).optional(),
+});

package/src/schemas/generated/zone.ts

@@ -0,0 +1,12 @@
+// This file is auto-generated by scripts/generate-schemas.ts
+// Do not edit manually.
+
+import { z } from "zod";
+import { LocationSchema } from "./common.ts";
+
+export const ZoneDraftSchema = z.object({
+	key: z.string().optional(),
+	name: z.string(),
+	description: z.string().optional(),
+	locations: z.array(LocationSchema).optional(),
+});

package/src/schemas/update-request.ts

@@ -1,10 +1,8 @@
 import { z } from "zod";
 
-const UpdateActionSchema = z
-	.object({
-		action: z.string(),
-	})
-	.passthrough();
+const UpdateActionSchema = z.looseObject({
+	action: z.string(),
+});
 
 export const updateRequestSchema = z.object({
 	version: z.number(),

package/src/server.ts

@@ -1,16 +1,44 @@
+import pino from "pino";
 import { CommercetoolsMock } from "./index.ts";
+import { SQLiteStorage } from "./storage/sqlite.ts";
+
+const storage = new SQLiteStorage();
 
 process.on("SIGINT", () => {
+	storage.close();
 	process.exit();
 });
 
-const instance = new CommercetoolsMock();
+const enableLogging = process.env.ENABLE_LOGGING === "true";
+
+const logger = enableLogging
+	? pino({ transport: { target: "pino-pretty" } })
+	: undefined;
+
+const instance = new CommercetoolsMock({
+	strict: true,
+	silent: !enableLogging,
+	logger,
+	storage,
+	// enableAuthentication: true,
+	// validateCredentials: true,
+});
 
 let port = 3000;
 
 if (process.env.HTTP_SERVER_PORT)
 	port = Number.parseInt(process.env.HTTP_SERVER_PORT, 10);
 
-// biome-ignore lint: lint/correctness/noConsoleLog
-console.info("Starting commercetools-mock on http://localhost:" + port);
-instance.runServer(port);
+instance.app.log.info(
+	`Starting commercetools-mock on http://localhost:${port}`,
+);
+
+async function main() {
+	await instance.runServer(port);
+}
+
+main().catch((error) => {
+	// biome-ignore lint/suspicious/noConsole: Fatal startup error must always be visible regardless of logger config
+	console.error("Failed to start commercetools-mock server:", error);
+	process.exitCode = 1;
+});

package/src/services/abstract.ts

@@ -1,8 +1,12 @@
-import type { Update } from "@commercetools/platform-sdk";
-import { type Request, type Response, Router } from "express";
+import type {
+	ResourceNotFoundError,
+	Update,
+} from "@commercetools/platform-sdk";
+import type { FastifyInstance, FastifyReply, FastifyRequest } from "fastify";
 import type { ParsedQs } from "qs";
+import { CommercetoolsError } from "#src/exceptions.ts";
 import { updateRequestSchema } from "#src/schemas/update-request.ts";
-import { validateData } from "#src/validate.ts";
+import { validateData, validateDraft } from "#src/validate.ts";
 import { queryParamsArray } from "../helpers.ts";
 import type {
 	AbstractResourceRepository,
@@ -15,207 +19,309 @@ export default abstract class AbstractService {
 
 	createStatusCode = 201;
 
-	constructor(parent: Router) {
+	constructor(parent: FastifyInstance) {
 		this.registerRoutes(parent);
 	}
 
 	protected abstract getBasePath(): string;
 
-	extraRoutes(router: Router) {}
+	extraRoutes(instance: FastifyInstance) {}
 
-	registerRoutes(parent: Router) {
+	registerRoutes(parent: FastifyInstance) {
 		const basePath = this.getBasePath();
-		const router = Router({ mergeParams: true });
-
-		// Bind this first since the `/:id` routes are currently a bit to greedy
-		this.extraRoutes(router);
+		parent.register(
+			(instance, opts, done) => {
+				this.extraRoutes(instance);
 
-		router.get("/", this.get.bind(this));
-		router.get("/key=:key", this.getWithKey.bind(this)); // same thing goes for the key routes
-		router.get("/:id", this.getWithId.bind(this));
+				instance.get("/", this.get.bind(this));
+				instance.get("/key=:key", this.getWithKey.bind(this));
+				instance.get("/:id", this.getWithId.bind(this));
 
-		router.delete("/key=:key", this.deleteWithKey.bind(this));
-		router.delete("/:id", this.deleteWithId.bind(this));
+				instance.delete("/key=:key", this.deleteWithKey.bind(this));
+				instance.delete("/:id", this.deleteWithId.bind(this));
 
-		router.post("/", this.post.bind(this));
-		router.post("/key=:key", this.postWithKey.bind(this));
-		router.post("/:id", this.postWithId.bind(this));
+				instance.post("/", this.post.bind(this));
+				instance.post("/key=:key", this.postWithKey.bind(this));
+				instance.post("/:id", this.postWithId.bind(this));
 
-		parent.use(`/${basePath}`, router);
+				done();
+			},
+			{ prefix: `/${basePath}` },
+		);
 	}
 
-	get(request: Request, response: Response) {
-		const limit = this._parseParam(request.query.limit);
-		const offset = this._parseParam(request.query.offset);
+	async get(
+		request: FastifyRequest<{
+			Params: Record<string, string>;
+			Querystring: Record<string, any>;
+		}>,
+		reply: FastifyReply,
+	) {
+		const query = request.query;
+		const limit = this._parseParam(query.limit);
+		const offset = this._parseParam(query.offset);
 		const params: QueryParams = {
-			expand: this._parseParam(request.query.expand),
-			where: this._parseParam(request.query.where),
+			expand: this._parseParam(query.expand),
+			where: this._parseParam(query.where),
 			limit: limit !== undefined ? Number(limit) : undefined,
 			offset: offset !== undefined ? Number(offset) : undefined,
 		};
 
-		for (const key in request.query) {
+		for (const key in query) {
 			if (key.startsWith("var.")) {
-				const items = this._parseParam(request.query[key]);
+				const items = this._parseParam(query[key]);
 				if (items) {
 					params[key] = items.length === 1 ? items[0] : items;
 				}
 			}
 		}
 
-		const result = this.repository.query(getRepositoryContext(request), params);
-		response.status(200).send(result);
-		return;
+		const result = await this.repository.query(
+			getRepositoryContext(request),
+			params,
+		);
+		return reply.status(200).send(result);
 	}
 
-	getWithId(request: Request, response: Response) {
-		const result = this._expandWithId(request, request.params.id);
+	async getWithId(
+		request: FastifyRequest<{
+			Params: Record<string, string>;
+			Querystring: Record<string, any>;
+		}>,
+		reply: FastifyReply,
+	) {
+		const params = request.params;
+		const result = await this._expandWithId(request, params.id);
 		if (!result) {
-			response.status(404).send({
-				statusCode: 404,
-				message: `The Resource with ID '${request.params.id} was not found.`,
-				errors: [
-					{
-						code: "ResourceNotFound",
-						message: `The Resource with ID '${request.params.id} was not found.`,
-					},
-				],
-			});
-			return;
+			throw new CommercetoolsError<ResourceNotFoundError>(
+				{
+					code: "ResourceNotFound",
+					message: `The Resource with ID '${params.id}' was not found.`,
+				},
+				404,
+			);
 		}
-		response.status(200).send(result);
+		return reply.status(200).send(result);
 	}
 
-	getWithKey(request: Request, response: Response) {
-		const result = this.repository.getByKey(
+	async getWithKey(
+		request: FastifyRequest<{
+			Params: Record<string, string>;
+			Querystring: Record<string, any>;
+		}>,
+		reply: FastifyReply,
+	) {
+		const params = request.params;
+		const query = request.query;
+		const result = await this.repository.getByKey(
 			getRepositoryContext(request),
-			request.params.key,
+			params.key,
 			{
-				expand: this._parseParam(request.query.expand),
+				expand: this._parseParam(query.expand),
 			},
 		);
 		if (!result) {
-			response.status(404).send({
-				statusCode: 404,
-				message: `The Resource with key '${request.params.id} was not found.`,
-				errors: [
-					{
-						code: "ResourceNotFound",
-						message: `The Resource with key '${request.params.id} was not found.`,
-					},
-				],
-			});
-			return;
+			throw new CommercetoolsError<ResourceNotFoundError>(
+				{
+					code: "ResourceNotFound",
+					message: `The Resource with key '${params.key}' was not found.`,
+				},
+				404,
+			);
 		}
-		response.status(200).send(result);
+		return reply.status(200).send(result);
 	}
 
-	deleteWithId(request: Request, response: Response) {
-		const result = this.repository.delete(
+	async deleteWithId(
+		request: FastifyRequest<{
+			Params: Record<string, string>;
+			Querystring: Record<string, any>;
+		}>,
+		reply: FastifyReply,
+	) {
+		const params = request.params;
+		const query = request.query;
+		const result = await this.repository.delete(
 			getRepositoryContext(request),
-			request.params.id,
+			params.id,
 			{
-				expand: this._parseParam(request.query.expand),
+				expand: this._parseParam(query.expand),
 			},
 		);
 		if (!result) {
-			response.status(404).send({ statusCode: 404 });
-			return;
+			throw new CommercetoolsError<ResourceNotFoundError>(
+				{
+					code: "ResourceNotFound",
+					message: `The Resource with ID '${params.id}' was not found.`,
+				},
+				404,
+			);
 		}
-		response.status(200).send(result);
+		return reply.status(200).send(result);
 	}
 
-	deleteWithKey(request: Request, response: Response) {
-		const resource = this.repository.getByKey(
+	async deleteWithKey(
+		request: FastifyRequest<{
+			Params: Record<string, string>;
+			Querystring: Record<string, any>;
+		}>,
+		reply: FastifyReply,
+	) {
+		const params = request.params;
+		const query = request.query;
+		const resource = await this.repository.getByKey(
 			getRepositoryContext(request),
-			request.params.key,
+			params.key,
 		);
 		if (!resource) {
-			response.status(404).send({ statusCode: 404 });
-			return;
+			throw new CommercetoolsError<ResourceNotFoundError>(
+				{
+					code: "ResourceNotFound",
+					message: `The Resource with key '${params.key}' was not found.`,
+				},
+				404,
+			);
 		}
 
-		const result = this.repository.delete(
+		const result = await this.repository.delete(
 			getRepositoryContext(request),
 			resource.id,
 			{
-				expand: this._parseParam(request.query.expand),
+				expand: this._parseParam(query.expand),
 			},
 		);
 		if (!result) {
-			response.status(404).send({ statusCode: 404 });
-			return;
+			throw new CommercetoolsError<ResourceNotFoundError>(
+				{
+					code: "ResourceNotFound",
+					message: `The Resource with ID '${resource.id}' was not found.`,
+				},
+				404,
+			);
 		}
-		response.status(200).send(result);
+		return reply.status(200).send(result);
 	}
 
-	post(request: Request, response: Response) {
-		const draft = request.body;
-		const resource = this.repository.create(
+	async post(
+		request: FastifyRequest<{
+			Params: Record<string, string>;
+			Querystring: Record<string, any>;
+		}>,
+		reply: FastifyReply,
+	) {
+		// Validate the draft against the schema when strict mode is enabled
+		if (this.repository.strict && this.repository.draftSchema) {
+			validateDraft(request.body, this.repository.draftSchema);
+		}
+
+		const resource = await this.repository.create(
 			getRepositoryContext(request),
-			draft,
+			request.body,
+		);
+
+		const query = request.query;
+		const expand = this._parseParam(query.expand);
+
+		// Apply expand on the already-created resource and post-process it
+		// instead of re-fetching from storage via _expandWithId.
+		const context = getRepositoryContext(request);
+		const expanded = await this.repository.expand(context, resource, expand);
+		const result = await this.repository.postProcessResource(
+			context,
+			expanded,
+			{ expand },
 		);
-		const result = this._expandWithId(request, resource.id);
-		response.status(this.createStatusCode).send(result);
+		return reply.status(this.createStatusCode).send(result);
 	}
 
-	postWithId(request: Request, response: Response) {
+	async postWithId(
+		request: FastifyRequest<{
+			Params: Record<string, string>;
+			Querystring: Record<string, any>;
+		}>,
+		reply: FastifyReply,
+	) {
+		const params = request.params;
 		const updateRequest = validateData<Update>(
 			request.body,
 			updateRequestSchema,
 		);
-		const resource = this.repository.get(
+		const resource = await this.repository.get(
 			getRepositoryContext(request),
-			request.params.id,
+			params.id,
 		);
 		if (!resource) {
-			response.status(404).send({ statusCode: 404 });
-			return;
+			throw new CommercetoolsError<ResourceNotFoundError>(
+				{
+					code: "ResourceNotFound",
+					message: `The Resource with ID '${params.id}' was not found.`,
+				},
+				404,
+			);
 		}
 
-		const updatedResource = this.repository.processUpdateActions(
+		const updatedResource = await this.repository.processUpdateActions(
 			getRepositoryContext(request),
 			resource,
 			updateRequest.version,
 			updateRequest.actions,
 		);
 
-		const result = this._expandWithId(request, updatedResource.id);
-		response.status(200).send(result);
+		const result = await this._expandWithId(request, updatedResource.id);
+		return reply.status(200).send(result);
 	}
 
-	postWithKey(request: Request, response: Response) {
+	async postWithKey(
+		request: FastifyRequest<{
+			Params: Record<string, string>;
+			Querystring: Record<string, any>;
+		}>,
+		reply: FastifyReply,
+	) {
+		const params = request.params;
 		const updateRequest = validateData<Update>(
 			request.body,
 			updateRequestSchema,
 		);
 
-		const resource = this.repository.getByKey(
+		const resource = await this.repository.getByKey(
 			getRepositoryContext(request),
-			request.params.key,
+			params.key,
 		);
 		if (!resource) {
-			response.status(404).send({ statusCode: 404 });
-			return;
+			throw new CommercetoolsError<ResourceNotFoundError>(
+				{
+					code: "ResourceNotFound",
+					message: `The Resource with key '${params.key}' was not found.`,
+				},
+				404,
+			);
 		}
 
-		const updatedResource = this.repository.processUpdateActions(
+		const updatedResource = await this.repository.processUpdateActions(
 			getRepositoryContext(request),
 			resource,
 			updateRequest.version,
 			updateRequest.actions,
 		);
 
-		const result = this._expandWithId(request, updatedResource.id);
-		response.status(200).send(result);
+		const result = await this._expandWithId(request, updatedResource.id);
+		return reply.status(200).send(result);
 	}
 
-	protected _expandWithId(request: Request, resourceId: string) {
-		const result = this.repository.get(
+	protected async _expandWithId(
+		request: FastifyRequest<{
+			Params: Record<string, string>;
+			Querystring: Record<string, any>;
+		}>,
+		resourceId: string,
+	) {
+		const query = request.query;
+		const result = await this.repository.get(
 			getRepositoryContext(request),
 			resourceId,
 			{
-				expand: this._parseParam(request.query.expand),
+				expand: this._parseParam(query.expand),
 			},
 		);
 		return result;

package/src/services/as-associate-cart.test.ts

@@ -1,5 +1,5 @@
-import supertest from "supertest";
 import { describe, expect, test } from "vitest";
+import { cartDraftFactory } from "#src/testing/index.ts";
 import { CommercetoolsMock } from "../index.ts";
 
 const ctMock = new CommercetoolsMock();
@@ -8,51 +8,43 @@ const customerId = "5fac8fca-2484-4b14-a1d1-cfdce2f8d3c4";
 const businessUnitKey = "test-business-unit";
 
 describe("AsAssociateCart", () => {
+	const factory = cartDraftFactory(ctMock);
+
 	test("Create cart", async () => {
-		const draft = {
-			currency: "EUR",
-		};
-		const response = await supertest(ctMock.app)
-			.post(
-				`/${projectKey}/as-associate/${customerId}/in-business-unit/key=${businessUnitKey}/carts`,
-			)
-			.send(draft);
-
-		expect(response.status).toBe(201);
-		expect(response.body.id).toBeDefined();
+		const draft = factory.build({ currency: "EUR" });
+
+		const response = await ctMock.app.inject({
+			method: "POST",
+			url: `/${projectKey}/as-associate/${customerId}/in-business-unit/key=${businessUnitKey}/carts`,
+			payload: draft,
+		});
+
+		expect(response.statusCode).toBe(201);
+		const cart = response.json();
+		expect(cart.id).toBeDefined();
 	});
 
 	test("Get cart", async () => {
-		const createResponse = await supertest(ctMock.app)
-			.post(
-				`/${projectKey}/as-associate/${customerId}/in-business-unit/key=${businessUnitKey}/carts`,
-			)
-			.send({ currency: "USD" });
+		const cart = await factory.create({ currency: "USD" });
 
-		expect(createResponse.status).toBe(201);
+		const response = await ctMock.app.inject({
+			method: "GET",
+			url: `/${projectKey}/as-associate/${customerId}/in-business-unit/key=${businessUnitKey}/carts/${cart.id}`,
+		});
 
-		const response = await supertest(ctMock.app).get(
-			`/${projectKey}/as-associate/${customerId}/in-business-unit/key=${businessUnitKey}/carts/${createResponse.body.id}`,
-		);
-
-		expect(response.status).toBe(200);
-		expect(response.body).toEqual(createResponse.body);
+		expect(response.statusCode).toBe(200);
+		expect(response.json()).toEqual(cart);
 	});
 
 	test("Query carts", async () => {
-		const createResponse = await supertest(ctMock.app)
-			.post(
-				`/${projectKey}/as-associate/${customerId}/in-business-unit/key=${businessUnitKey}/carts`,
-			)
-			.send({ currency: "GBP" });
-
-		expect(createResponse.status).toBe(201);
+		await factory.create({ currency: "GBP" });
 
-		const response = await supertest(ctMock.app).get(
-			`/${projectKey}/as-associate/${customerId}/in-business-unit/key=${businessUnitKey}/carts`,
-		);
+		const response = await ctMock.app.inject({
+			method: "GET",
+			url: `/${projectKey}/as-associate/${customerId}/in-business-unit/key=${businessUnitKey}/carts`,
+		});
 
-		expect(response.status).toBe(200);
-		expect(response.body.count).toBeGreaterThan(0);
+		expect(response.statusCode).toBe(200);
+		expect(response.json().count).toBeGreaterThan(0);
 	});
 });