@labdigital/commercetools-mock 2.46.0 → 2.47.0

package/src/repositories/index.ts

@@ -30,10 +30,10 @@ import { ProductTypeRepository } from "./product-type";
 import { ProjectRepository } from "./project";
 import { QuoteRepository } from "./quote";
 import { QuoteRequestRepository } from "./quote-request";
+import { StagedQuoteRepository } from "./quote-staged";
 import { ReviewRepository } from "./review";
 import { ShippingMethodRepository } from "./shipping-method";
 import { ShoppingListRepository } from "./shopping-list";
-import { StagedQuoteRepository } from "./staged-quote";
 import { StandAlonePriceRepository } from "./standalone-price";
 import { StateRepository } from "./state";
 import { StoreRepository } from "./store";
@@ -52,42 +52,42 @@ export const createRepositories = (config: Config) => ({
 	"associate-role": new AssociateRoleRepository(config),
 	"attribute-group": new AttributeGroupRepository(config),
 	"business-unit": new BusinessUnitRepository(config),
-	"category": new CategoryRepository(config),
-	"cart": new CartRepository(config),
+	category: new CategoryRepository(config),
+	cart: new CartRepository(config),
 	"cart-discount": new CartDiscountRepository(config),
-	"customer": new CustomerRepository(config),
-	"channel": new ChannelRepository(config),
+	customer: new CustomerRepository(config),
+	channel: new ChannelRepository(config),
 	"customer-group": new CustomerGroupRepository(config),
 	"discount-code": new DiscountCodeRepository(config),
-	"extension": new ExtensionRepository(config),
+	extension: new ExtensionRepository(config),
 	"inventory-entry": new InventoryEntryRepository(config),
 	"key-value-document": new CustomObjectRepository(config),
-	"order": new OrderRepository(config),
+	order: new OrderRepository(config),
 	"order-edit": new OrderEditRepository(config),
-	"payment": new PaymentRepository(config),
+	payment: new PaymentRepository(config),
 	"my-cart": new CartRepository(config),
 	"my-order": new MyOrderRepository(config),
 	"my-customer": new MyCustomerRepository(config),
 	"my-payment": new PaymentRepository(config),
 	"my-shopping-list": new ShoppingListRepository(config),
-	"product": new ProductRepository(config),
+	product: new ProductRepository(config),
 	"product-type": new ProductTypeRepository(config),
 	"product-discount": new ProductDiscountRepository(config),
 	"product-projection": new ProductProjectionRepository(config),
 	"product-selection": new ProductSelectionRepository(config),
 	"product-tailoring": new ProductTailoringRepository(config),
-	"project": new ProjectRepository(config),
-	"review": new ReviewRepository(config),
-	"quote": new QuoteRepository(config),
+	project: new ProjectRepository(config),
+	review: new ReviewRepository(config),
+	quote: new QuoteRepository(config),
 	"quote-request": new QuoteRequestRepository(config),
 	"shipping-method": new ShippingMethodRepository(config),
 	"shopping-list": new ShoppingListRepository(config),
 	"staged-quote": new StagedQuoteRepository(config),
 	"standalone-price": new StandAlonePriceRepository(config),
-	"state": new StateRepository(config),
-	"store": new StoreRepository(config),
-	"subscription": new SubscriptionRepository(config),
+	state: new StateRepository(config),
+	store: new StoreRepository(config),
+	subscription: new SubscriptionRepository(config),
 	"tax-category": new TaxCategoryRepository(config),
-	"type": new TypeRepository(config),
-	"zone": new ZoneRepository(config),
+	type: new TypeRepository(config),
+	zone: new ZoneRepository(config),
 });

package/src/repositories/my-customer.ts

@@ -8,7 +8,7 @@ import type {
 import { CommercetoolsError } from "~src/exceptions";
 import { hashPassword, validateEmailVerifyToken } from "../lib/password";
 import type { Writable } from "../types";
-import { type RepositoryContext } from "./abstract";
+import type { RepositoryContext } from "./abstract";
 import { CustomerRepository } from "./customer";
 
 export class MyCustomerRepository extends CustomerRepository {

package/src/repositories/my-order.ts

@@ -1,10 +1,10 @@
+import assert from "node:assert";
 import type {
 	CartReference,
 	MyOrderFromCartDraft,
 	Order,
 } from "@commercetools/platform-sdk";
-import assert from "assert";
-import { type RepositoryContext } from "./abstract";
+import type { RepositoryContext } from "./abstract";
 import { OrderRepository } from "./order";
 
 export class MyOrderRepository extends OrderRepository {

package/src/repositories/order/index.ts

@@ -1,3 +1,4 @@
+import assert from "node:assert";
 import type {
 	Cart,
 	CartReference,
@@ -13,7 +14,6 @@ import type {
 	ProductPagedQueryResponse,
 	ProductVariant,
 } from "@commercetools/platform-sdk";
-import assert from "assert";
 import type { Config } from "~src/config";
 import { CommercetoolsError } from "~src/exceptions";
 import { generateRandomString, getBaseResourceProperties } from "~src/helpers";

package/src/repositories/product/actions.ts

@@ -420,7 +420,7 @@ export class ProductUpdateHandler
 
 			if (position >= variantImages.length) {
 				throw new Error(
-					`Invalid position given. Position in images where the image should be moved. Must be between 0 and the total number of images minus 1.`,
+					"Invalid position given. Position in images where the image should be moved. Must be between 0 and the total number of images minus 1.",
 				);
 			}
 

package/src/repositories/quote/actions.ts

@@ -0,0 +1,83 @@
+import type {
+	InvalidJsonInputError,
+	Quote,
+	QuoteSetCustomFieldAction,
+	QuoteSetCustomTypeAction,
+	QuoteTransitionStateAction,
+	QuoteUpdateAction,
+	StateReference,
+} from "@commercetools/platform-sdk";
+import { CommercetoolsError } from "~src/exceptions";
+import type { Writable } from "~src/types";
+import type { RepositoryContext, UpdateHandlerInterface } from "../abstract";
+import { AbstractUpdateHandler } from "../abstract";
+import { getReferenceFromResourceIdentifier } from "../helpers";
+
+export class QuoteUpdateHandler
+	extends AbstractUpdateHandler
+	implements Partial<UpdateHandlerInterface<Quote, QuoteUpdateAction>>
+{
+	setCustomField(
+		context: RepositoryContext,
+		resource: Quote,
+		{ name, value }: QuoteSetCustomFieldAction,
+	) {
+		if (!resource.custom) {
+			throw new Error("Resource has no custom field");
+		}
+		resource.custom.fields[name] = value;
+	}
+
+	setCustomType(
+		context: RepositoryContext,
+		resource: Writable<Quote>,
+		{ type, fields }: QuoteSetCustomTypeAction,
+	) {
+		if (!type) {
+			resource.custom = undefined;
+		} else {
+			const resolvedType = this._storage.getByResourceIdentifier(
+				context.projectKey,
+				type,
+			);
+			if (!resolvedType) {
+				throw new Error(`Type ${type} not found`);
+			}
+
+			resource.custom = {
+				type: {
+					typeId: "type",
+					id: resolvedType.id,
+				},
+				fields: fields || {},
+			};
+		}
+	}
+
+	transitionState(
+		context: RepositoryContext,
+		resource: Writable<Quote>,
+		{ state, force }: QuoteTransitionStateAction,
+	) {
+		let stateReference: StateReference | undefined = undefined;
+		if (state) {
+			stateReference = getReferenceFromResourceIdentifier<StateReference>(
+				state,
+				context.projectKey,
+				this._storage,
+			);
+			resource.state = stateReference;
+		} else {
+			throw new CommercetoolsError<InvalidJsonInputError>(
+				{
+					code: "InvalidJsonInput",
+					message: "Request body does not contain valid JSON.",
+					detailedErrorMessage: "actions -> state: Missing required value",
+				},
+				400,
+			);
+		}
+
+		return resource;
+	}
+}

package/src/repositories/quote/index.ts

@@ -0,0 +1,54 @@
+import type { Quote, QuoteDraft } from "@commercetools/platform-sdk";
+import type { Config } from "~src/config";
+import { getBaseResourceProperties } from "~src/helpers";
+import type { RepositoryContext } from "../abstract";
+import { AbstractResourceRepository } from "../abstract";
+import { QuoteUpdateHandler } from "./actions";
+
+export class QuoteRepository extends AbstractResourceRepository<"quote"> {
+	constructor(config: Config) {
+		super("quote", config);
+		this.actions = new QuoteUpdateHandler(config.storage);
+	}
+
+	create(context: RepositoryContext, draft: QuoteDraft): Quote {
+		const staged = this._storage.getByResourceIdentifier<"staged-quote">(
+			context.projectKey,
+			draft.stagedQuote,
+		);
+
+		const cart = this._storage.getByResourceIdentifier<"cart">(
+			context.projectKey,
+			staged.quotationCart,
+		);
+
+		if (!cart.customerId) {
+			throw new Error("Cart does not have a customer");
+		}
+
+		const resource: Quote = {
+			...getBaseResourceProperties(),
+			quoteState: "Accepted",
+			quoteRequest: staged.quoteRequest,
+			lineItems: cart.lineItems,
+			customLineItems: cart.customLineItems,
+			customer: {
+				typeId: "customer",
+				id: cart.customerId,
+			},
+			stagedQuote: {
+				typeId: "staged-quote",
+				id: staged.id,
+			},
+			totalPrice: cart.totalPrice,
+			taxedPrice: cart.taxedPrice,
+			taxMode: cart.taxMode,
+			taxRoundingMode: cart.taxRoundingMode,
+			taxCalculationMode: cart.taxCalculationMode,
+			billingAddress: cart.billingAddress,
+			shippingAddress: cart.shippingAddress,
+		};
+
+		return resource;
+	}
+}

package/src/repositories/quote-request/actions.ts

@@ -0,0 +1,84 @@
+import type {
+	InvalidJsonInputError,
+	QuoteRequest,
+	QuoteRequestSetCustomFieldAction,
+	QuoteRequestSetCustomTypeAction,
+	QuoteRequestTransitionStateAction,
+	QuoteRequestUpdateAction,
+	StateReference,
+} from "@commercetools/platform-sdk";
+import { CommercetoolsError } from "~src/exceptions";
+import type { Writable } from "~src/types";
+import type { RepositoryContext, UpdateHandlerInterface } from "../abstract";
+import { AbstractUpdateHandler } from "../abstract";
+import { getReferenceFromResourceIdentifier } from "../helpers";
+
+export class QuoteRequestUpdateHandler
+	extends AbstractUpdateHandler
+	implements
+		Partial<UpdateHandlerInterface<QuoteRequest, QuoteRequestUpdateAction>>
+{
+	setCustomField(
+		context: RepositoryContext,
+		resource: QuoteRequest,
+		{ name, value }: QuoteRequestSetCustomFieldAction,
+	) {
+		if (!resource.custom) {
+			throw new Error("Resource has no custom field");
+		}
+		resource.custom.fields[name] = value;
+	}
+
+	setCustomType(
+		context: RepositoryContext,
+		resource: Writable<QuoteRequest>,
+		{ type, fields }: QuoteRequestSetCustomTypeAction,
+	) {
+		if (!type) {
+			resource.custom = undefined;
+		} else {
+			const resolvedType = this._storage.getByResourceIdentifier(
+				context.projectKey,
+				type,
+			);
+			if (!resolvedType) {
+				throw new Error(`Type ${type} not found`);
+			}
+
+			resource.custom = {
+				type: {
+					typeId: "type",
+					id: resolvedType.id,
+				},
+				fields: fields || {},
+			};
+		}
+	}
+
+	transitionState(
+		context: RepositoryContext,
+		resource: Writable<QuoteRequest>,
+		{ state, force }: QuoteRequestTransitionStateAction,
+	) {
+		let stateReference: StateReference | undefined = undefined;
+		if (state) {
+			stateReference = getReferenceFromResourceIdentifier<StateReference>(
+				state,
+				context.projectKey,
+				this._storage,
+			);
+			resource.state = stateReference;
+		} else {
+			throw new CommercetoolsError<InvalidJsonInputError>(
+				{
+					code: "InvalidJsonInput",
+					message: "Request body does not contain valid JSON.",
+					detailedErrorMessage: "actions -> state: Missing required value",
+				},
+				400,
+			);
+		}
+
+		return resource;
+	}
+}

package/src/repositories/quote-request/index.test.ts

@@ -0,0 +1,167 @@
+import type { Cart, LineItem } from "@commercetools/platform-sdk";
+import { describe, expect, test } from "vitest";
+import type { Config } from "~src/config";
+import { InMemoryStorage } from "~src/storage";
+import { QuoteRequestRepository } from ".";
+
+describe("QuoteRequest repository", () => {
+	const storage = new InMemoryStorage();
+	const config: Config = {
+		storage,
+		strict: false,
+	};
+	const repository = new QuoteRequestRepository(config);
+
+	test("create from cart", async () => {
+		const cart: Cart = {
+			id: "b3875a58-4ab2-4aaa-b399-184ce7561c27",
+			version: 1,
+			createdAt: "2021-09-02T12:23:30.036Z",
+			lastModifiedAt: "2021-09-02T12:23:30.546Z",
+			discountCodes: [],
+			directDiscounts: [],
+			inventoryMode: "None",
+			itemShippingAddresses: [],
+			lineItems: [
+				{
+					id: "15fc56ba-a74e-4cf8-b4b0-bada5c101541",
+					productId: "PRODUCTID",
+					variantId: 1,
+					quantity: 1,
+				} as unknown as LineItem,
+			],
+			customLineItems: [],
+			totalPrice: {
+				type: "centPrecision",
+				currencyCode: "EUR",
+				centAmount: 10000,
+				fractionDigits: 2,
+			},
+			cartState: "Active",
+			shippingMode: "Single",
+			shipping: [],
+			taxMode: "Platform",
+			taxRoundingMode: "HalfEven",
+			taxCalculationMode: "UnitPriceLevel",
+			refusedGifts: [],
+			origin: "Customer",
+			anonymousId: "1234567890",
+			billingAddress: {
+				id: "1234567890",
+				country: "NL",
+				firstName: "John",
+				lastName: "Doe",
+				streetName: "Main Street",
+				streetNumber: "123",
+				postalCode: "123456",
+			},
+			customerEmail: "john.doe@example.com",
+			customerGroup: {
+				id: "1234567890",
+				typeId: "customer-group",
+			},
+			customerId: "1234567890",
+			custom: {
+				type: {
+					typeId: "type",
+					id: "1234567890",
+				},
+				fields: {
+					description: "example description",
+				},
+			},
+
+			shippingAddress: {
+				id: "1234567890",
+				country: "NL",
+				firstName: "John",
+				lastName: "Doe",
+				streetName: "Main Street",
+				streetNumber: "123",
+				postalCode: "123456",
+			},
+			shippingInfo: {
+				shippingMethodName: "Standard Shipping",
+				price: {
+					type: "centPrecision",
+					currencyCode: "EUR",
+					centAmount: 1000,
+					fractionDigits: 2,
+				},
+				shippingRate: {
+					price: {
+						type: "centPrecision",
+						currencyCode: "EUR",
+						centAmount: 1000,
+						fractionDigits: 2,
+					},
+					tiers: [],
+				},
+				shippingMethodState: "Shipped",
+			},
+			taxedPrice: {
+				totalNet: {
+					type: "centPrecision",
+					currencyCode: "EUR",
+					centAmount: 1000,
+					fractionDigits: 2,
+				},
+				taxPortions: [],
+				totalGross: {
+					type: "centPrecision",
+					currencyCode: "EUR",
+					centAmount: 1210,
+					fractionDigits: 2,
+				},
+			},
+			taxedShippingPrice: {
+				totalNet: {
+					type: "centPrecision",
+					currencyCode: "EUR",
+					centAmount: 100,
+					fractionDigits: 2,
+				},
+				taxPortions: [],
+				totalGross: {
+					type: "centPrecision",
+					currencyCode: "EUR",
+					centAmount: 121,
+					fractionDigits: 2,
+				},
+			},
+		};
+
+		storage.add("dummy", "cart", cart);
+		const ctx = { projectKey: "dummy" };
+
+		const result = repository.create(ctx, {
+			cart: {
+				id: cart.id,
+				typeId: "cart",
+			},
+			cartVersion: cart.version,
+		});
+		expect(result.cart?.id).toBe(cart.id);
+
+		const items = repository.query(ctx);
+		expect(items.count).toBe(1);
+
+		expect(result.billingAddress).toEqual(cart.billingAddress);
+		expect(result.cart?.id).toEqual(cart.id);
+		expect(result.country).toEqual(cart.country);
+		expect(result.custom).toEqual(cart.custom);
+		expect(result.customerGroup).toEqual(cart.customerGroup);
+		expect(result.customer.id).toEqual(cart.customerId);
+		expect(result.customLineItems).toEqual(cart.customLineItems);
+		expect(result.directDiscounts).toEqual(cart.directDiscounts);
+		expect(result.lineItems).toEqual(cart.lineItems);
+		expect(result.paymentInfo).toEqual(cart.paymentInfo);
+		expect(result.shippingAddress).toEqual(cart.shippingAddress);
+		expect(result.taxCalculationMode).toEqual(cart.taxCalculationMode);
+		expect(result.taxedPrice).toEqual(cart.taxedPrice);
+		expect(result.taxMode).toEqual(cart.taxMode);
+		expect(result.taxRoundingMode).toEqual(cart.taxRoundingMode);
+		expect(result.totalPrice).toEqual(cart.totalPrice);
+		expect(result.store).toEqual(cart.store);
+	});
+});

package/src/repositories/quote-request/index.ts

@@ -0,0 +1,67 @@
+import assert from "node:assert";
+import type {
+	Cart,
+	CartReference,
+	QuoteRequest,
+	QuoteRequestDraft,
+} from "@commercetools/platform-sdk";
+import type { Config } from "~src/config";
+import { getBaseResourceProperties } from "~src/helpers";
+import type { RepositoryContext } from "../abstract";
+import { AbstractResourceRepository } from "../abstract";
+import { QuoteRequestUpdateHandler } from "./actions";
+
+export class QuoteRequestRepository extends AbstractResourceRepository<"quote-request"> {
+	constructor(config: Config) {
+		super("quote-request", config);
+		this.actions = new QuoteRequestUpdateHandler(config.storage);
+	}
+
+	create(context: RepositoryContext, draft: QuoteRequestDraft): QuoteRequest {
+		assert(draft.cart, "draft.cart is missing");
+		return this.createFromCart(context, {
+			id: draft.cart.id!,
+			typeId: "cart",
+		});
+	}
+
+	createFromCart(context: RepositoryContext, cartReference: CartReference) {
+		const cart = this._storage.getByResourceIdentifier(
+			context.projectKey,
+			cartReference,
+		) as Cart | null;
+		if (!cart) {
+			throw new Error("Cannot find cart");
+		}
+
+		if (!cart.customerId) {
+			throw new Error("Cart does not have a customer");
+		}
+
+		const resource: QuoteRequest = {
+			...getBaseResourceProperties(),
+			billingAddress: cart.billingAddress,
+			cart: cartReference,
+			country: cart.country,
+			custom: cart.custom,
+			customer: {
+				typeId: "customer",
+				id: cart.customerId,
+			},
+			customerGroup: cart.customerGroup,
+			customLineItems: [],
+			directDiscounts: cart.directDiscounts,
+			lineItems: cart.lineItems,
+			paymentInfo: cart.paymentInfo,
+			quoteRequestState: "Submitted",
+			shippingAddress: cart.shippingAddress,
+			taxCalculationMode: cart.taxCalculationMode,
+			taxedPrice: cart.taxedPrice,
+			taxMode: cart.taxMode,
+			taxRoundingMode: cart.taxRoundingMode,
+			totalPrice: cart.totalPrice,
+			store: cart.store,
+		};
+		return this.saveNew(context, resource);
+	}
+}

package/src/repositories/quote-staged/actions.ts

@@ -0,0 +1,84 @@
+import type {
+	InvalidJsonInputError,
+	StagedQuote,
+	StagedQuoteSetCustomFieldAction,
+	StagedQuoteSetCustomTypeAction,
+	StagedQuoteTransitionStateAction,
+	StagedQuoteUpdateAction,
+	StateReference,
+} from "@commercetools/platform-sdk";
+import { CommercetoolsError } from "~src/exceptions";
+import type { Writable } from "~src/types";
+import type { RepositoryContext, UpdateHandlerInterface } from "../abstract";
+import { AbstractUpdateHandler } from "../abstract";
+import { getReferenceFromResourceIdentifier } from "../helpers";
+
+export class StagedQuoteUpdateHandler
+	extends AbstractUpdateHandler
+	implements
+		Partial<UpdateHandlerInterface<StagedQuote, StagedQuoteUpdateAction>>
+{
+	setCustomField(
+		context: RepositoryContext,
+		resource: StagedQuote,
+		{ name, value }: StagedQuoteSetCustomFieldAction,
+	) {
+		if (!resource.custom) {
+			throw new Error("Resource has no custom field");
+		}
+		resource.custom.fields[name] = value;
+	}
+
+	setCustomType(
+		context: RepositoryContext,
+		resource: Writable<StagedQuote>,
+		{ type, fields }: StagedQuoteSetCustomTypeAction,
+	) {
+		if (!type) {
+			resource.custom = undefined;
+		} else {
+			const resolvedType = this._storage.getByResourceIdentifier(
+				context.projectKey,
+				type,
+			);
+			if (!resolvedType) {
+				throw new Error(`Type ${type} not found`);
+			}
+
+			resource.custom = {
+				type: {
+					typeId: "type",
+					id: resolvedType.id,
+				},
+				fields: fields || {},
+			};
+		}
+	}
+
+	transitionState(
+		context: RepositoryContext,
+		resource: Writable<StagedQuote>,
+		{ state, force }: StagedQuoteTransitionStateAction,
+	) {
+		let stateReference: StateReference | undefined = undefined;
+		if (state) {
+			stateReference = getReferenceFromResourceIdentifier<StateReference>(
+				state,
+				context.projectKey,
+				this._storage,
+			);
+			resource.state = stateReference;
+		} else {
+			throw new CommercetoolsError<InvalidJsonInputError>(
+				{
+					code: "InvalidJsonInput",
+					message: "Request body does not contain valid JSON.",
+					detailedErrorMessage: "actions -> state: Missing required value",
+				},
+				400,
+			);
+		}
+
+		return resource;
+	}
+}