@labdigital/commercetools-mock 2.23.1 → 2.26.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@labdigital/commercetools-mock",
-  "version": "2.23.1",
+  "version": "2.26.0",
   "license": "MIT",
   "author": "Michael van Tellingen",
   "type": "module",

package/src/lib/password.ts

@@ -2,6 +2,7 @@ import { Customer } from "@commercetools/platform-sdk";
 import { v4 as uuidv4 } from "uuid";
 
 const PWRESET_SECRET = "pwreset";
+const EMAIL_VERIFY_SECRET = "emailverifysecret";
 
 export const validatePassword = (
 	clearPassword: string,
@@ -16,6 +17,11 @@ export const createPasswordResetToken = (customer: Customer) =>
 		"base64",
 	);
 
+export const createEmailVerifyToken = (customer: Customer) =>
+	Buffer.from(`${customer.id}:${EMAIL_VERIFY_SECRET}:${uuidv4()}`).toString(
+		"base64",
+	);
+
 export const validatePasswordResetToken = (token: string) => {
 	const items = Buffer.from(token, "base64").toString("utf-8").split(":");
 	const [customerId, secret] = items;
@@ -25,3 +31,12 @@ export const validatePasswordResetToken = (token: string) => {
 
 	return customerId;
 };
+export const validateEmailVerifyToken = (token: string) => {
+	const items = Buffer.from(token, "base64").toString("utf-8").split(":");
+	const [customerId, secret] = items;
+	if (secret !== EMAIL_VERIFY_SECRET) {
+		return undefined;
+	}
+
+	return customerId;
+};

package/src/repositories/customer/actions.ts

@@ -6,9 +6,11 @@ import type {
 	CustomerSetCompanyNameAction,
 	CustomerSetCustomFieldAction,
 	CustomerSetCustomerNumberAction,
+	CustomerSetExternalIdAction,
 	CustomerSetFirstNameAction,
 	CustomerSetKeyAction,
 	CustomerSetLastNameAction,
+	CustomerSetLocaleAction,
 	CustomerSetSalutationAction,
 	CustomerSetVatIdAction,
 	CustomerUpdateAction,
@@ -141,6 +143,14 @@ export class CustomerUpdateHandler
 		resource.custom.fields[name] = value;
 	}
 
+	setExternalId(
+		_context: RepositoryContext,
+		resource: Writable<Customer>,
+		{ externalId }: CustomerSetExternalIdAction,
+	) {
+		resource.externalId = externalId;
+	}
+
 	setFirstName(
 		_context: RepositoryContext,
 		resource: Writable<Customer>,
@@ -165,6 +175,14 @@ export class CustomerUpdateHandler
 		resource.lastName = lastName;
 	}
 
+	setLocale(
+		_context: RepositoryContext,
+		resource: Writable<Customer>,
+		{ locale }: CustomerSetLocaleAction,
+	) {
+		resource.locale = locale;
+	}
+
 	setSalutation(
 		_context: RepositoryContext,
 		resource: Writable<Customer>,

package/src/repositories/customer/index.ts

@@ -7,7 +7,11 @@ import type {
 } from "@commercetools/platform-sdk";
 import { CommercetoolsError } from "~src/exceptions";
 import { generateRandomString, getBaseResourceProperties } from "~src/helpers";
-import { createPasswordResetToken, hashPassword } from "~src/lib/password";
+import {
+	createEmailVerifyToken,
+	createPasswordResetToken,
+	hashPassword,
+} from "~src/lib/password";
 import { AbstractStorage } from "~src/storage/abstract";
 import {
 	AbstractResourceRepository,
@@ -110,4 +114,29 @@ export class CustomerRepository extends AbstractResourceRepository<"customer"> {
 			value: token,
 		};
 	}
+
+	verifyEmailToken(context: RepositoryContext, id: string): CustomerToken {
+		const results = this._storage.query(context.projectKey, this.getTypeId(), {
+			where: [`id="${id.toLocaleLowerCase()}"`],
+		});
+		if (results.count === 0) {
+			throw new CommercetoolsError<ResourceNotFoundError>({
+				code: "ResourceNotFound",
+				message: `The Customer with ID '${id}' was not found.`,
+			});
+		}
+		const expiresAt = new Date(Date.now() + 30 * 60);
+		const customer = results.results[0] as Customer;
+		const rest = getBaseResourceProperties();
+
+		const token = createEmailVerifyToken(customer);
+		return {
+			id: rest.id,
+			createdAt: rest.createdAt,
+			lastModifiedAt: rest.lastModifiedAt,
+			customerId: customer.id,
+			expiresAt: expiresAt.toISOString(),
+			value: token,
+		};
+	}
 }

package/src/repositories/my-customer.ts

@@ -2,11 +2,16 @@ import {
 	Customer,
 	InvalidCurrentPasswordError,
 	MyCustomerChangePassword,
+	MyCustomerEmailVerify,
 	ResourceNotFoundError,
 	type MyCustomerResetPassword,
 } from "@commercetools/platform-sdk";
 import { CommercetoolsError } from "~src/exceptions";
-import { hashPassword, validatePasswordResetToken } from "../lib/password";
+import {
+	hashPassword,
+	validateEmailVerifyToken,
+	validatePasswordResetToken,
+} from "../lib/password";
 import { Writable } from "../types";
 import { type RepositoryContext } from "./abstract";
 import { CustomerRepository } from "./customer";
@@ -45,6 +50,41 @@ export class MyCustomerRepository extends CustomerRepository {
 		return customer;
 	}
 
+	confirmEmail(
+		context: RepositoryContext,
+		resetPassword: MyCustomerEmailVerify,
+	) {
+		const { tokenValue } = resetPassword;
+
+		const customerId = validateEmailVerifyToken(tokenValue);
+		if (!customerId) {
+			throw new CommercetoolsError<ResourceNotFoundError>({
+				code: "ResourceNotFound",
+				message: `The Customer with ID 'Token(${tokenValue})' was not found.`,
+			});
+		}
+
+		const customer = this._storage.get(
+			context.projectKey,
+			"customer",
+			customerId,
+		) as Writable<Customer> | undefined;
+
+		if (!customer) {
+			throw new CommercetoolsError<ResourceNotFoundError>({
+				code: "ResourceNotFound",
+				message: `The Customer with ID 'Token(${tokenValue})' was not found.`,
+			});
+		}
+
+		customer.isEmailVerified = true;
+		customer.version += 1;
+
+		// Update storage
+		this._storage.add(context.projectKey, "customer", customer);
+		return customer;
+	}
+
 	deleteMe(context: RepositoryContext): Customer | undefined {
 		// grab the first customer you can find for now. In the future we should
 		// use the customer id from the scope of the token

package/src/services/customer.test.ts

@@ -177,6 +177,26 @@ describe("Customer Update Actions", () => {
 		expect(response.body.custom.fields.isValidCouponCode).toBe(false);
 	});
 
+	test("setExternalId", async () => {
+		assert(customer, "customer not created");
+
+		customer = {
+			...customer,
+			firstName: "John",
+		};
+		ctMock.project("dummy").add("customer", customer);
+
+		const response = await supertest(ctMock.app)
+			.post(`/dummy/customers/${customer.id}`)
+			.send({
+				version: 1,
+				actions: [{ action: "setExternalId", externalId: "123-xx-123" }],
+			});
+		expect(response.status).toBe(200);
+		expect(response.body.version).toBe(2);
+		expect(response.body.externalId).toBe("123-xx-123");
+	});
+
 	test("setFirstName", async () => {
 		assert(customer, "customer not created");
 
@@ -217,6 +237,26 @@ describe("Customer Update Actions", () => {
 		expect(response.body.lastName).toBe("Smith");
 	});
 
+	test("setLocale", async () => {
+		assert(customer, "customer not created");
+
+		customer = {
+			...customer,
+			salutation: "Mr.",
+		};
+		ctMock.project("dummy").add("customer", customer);
+
+		const response = await supertest(ctMock.app)
+			.post(`/dummy/customers/${customer.id}`)
+			.send({
+				version: 1,
+				actions: [{ action: "setLocale", locale: "de-DE" }],
+			});
+		expect(response.status).toBe(200);
+		expect(response.body.version).toBe(2);
+		expect(response.body.locale).toBe("de-DE");
+	});
+
 	test("setSalutation", async () => {
 		assert(customer, "customer not created");
 

package/src/services/customer.ts

@@ -39,5 +39,14 @@ export class CustomerService extends AbstractService {
 			);
 			return response.status(200).send(token);
 		});
+
+		parent.post("/email-token", (request, response) => {
+			const id = request.body.id;
+			const token = this.repository.verifyEmailToken(
+				getRepositoryContext(request),
+				id,
+			);
+			return response.status(200).send(token);
+		});
 	}
 }

package/src/services/my-customer.test.ts

@@ -224,6 +224,53 @@ describe("/me", () => {
 		});
 	});
 
+	test("verify email flow", async () => {
+		const customer = {
+			...getBaseResourceProperties(),
+			id: "customer-uuid",
+			email: "user@example.com",
+			password: hashPassword("p4ssw0rd"),
+			addresses: [],
+			isEmailVerified: false,
+			authenticationMode: "Password", //default in Commercetools
+			version: 1,
+		};
+		ctMock.project("dummy").add("customer", customer);
+
+		const token = await supertest(ctMock.app)
+			.post("/dummy/customers/email-token")
+			.send({
+				id: "customer-uuid",
+			})
+			.then((response) => response.body as CustomerToken);
+
+		const response = await supertest(ctMock.app)
+			.post("/dummy/me/email/confirm")
+			.send({
+				tokenValue: token.value,
+			});
+		expect(response.status).toBe(200);
+	});
+
+	test("fail verify email flow", async () => {
+		const response = await supertest(ctMock.app)
+			.post("/dummy/me/email/confirm")
+			.send({
+				tokenValue: "invalid-token",
+			});
+		expect(response.status).toBe(400);
+		expect(response.body).toEqual({
+			message: `The Customer with ID 'Token(invalid-token)' was not found.`,
+			statusCode: 400,
+			errors: [
+				{
+					code: "ResourceNotFound",
+					message: `The Customer with ID 'Token(invalid-token)' was not found.`,
+				},
+			],
+		});
+	});
+
 	test("setCustomField", async () => {
 		const response = await supertest(ctMock.app)
 			.post(`/dummy/me`)

package/src/services/my-customer.ts

@@ -35,6 +35,7 @@ export class MyCustomerService extends AbstractService {
 		router.post("/login", this.signIn.bind(this));
 		router.post("/password", this.changePassword.bind(this));
 		router.post("/password/reset", this.resetPassword.bind(this));
+		router.post("/email/confirm", this.emailConfirm.bind(this));
 
 		parent.use(`/${basePath}`, router);
 	}
@@ -105,6 +106,15 @@ export class MyCustomerService extends AbstractService {
 		return response.status(200).send(customer);
 	}
 
+	emailConfirm(request: Request, response: Response) {
+		const customer = this.repository.confirmEmail(
+			getRepositoryContext(request),
+			request.body,
+		);
+
+		return response.status(200).send(customer);
+	}
+
 	signIn(request: Request, response: Response) {
 		const { email, password } = request.body;
 		const encodedPassword = hashPassword(password);