@labdigital/commercetools-mock 2.46.0 → 2.47.1

package/src/services/product-projection.ts

@@ -34,32 +34,30 @@ export class ProductProjectionService extends AbstractService {
 			limit: limit !== undefined ? Number(limit) : undefined,
 			offset: offset !== undefined ? Number(offset) : undefined,
 		});
-		return response.status(200).send(result);
+		response.status(200).send(result);
 	}
 
 	search(request: Request, response: Response) {
 		const query = request.query;
 		const searchParams: ProductProjectionQueryParams = {
-			"filter": queryParamsArray(query.filter),
+			filter: queryParamsArray(query.filter),
 			"filter.query": queryParamsArray(query["filter.query"]),
-			"facet": queryParamsArray(query.facet),
-			"expand": queryParamsArray(query.expand),
-			"staged": queryParamsValue(query.staged) === "true",
-			"localeProjection": queryParamsValue(query.localeProjection),
-			"storeProjection": queryParamsValue(query.storeProjection),
-			"priceChannel": queryParamsValue(query.priceChannel),
-			"priceCountry": queryParamsValue(query.priceCountry),
-			"priceCurrency": queryParamsValue(query.priceCurrency),
-			"priceCustomerGroup": queryParamsValue(query.priceCustomerGroup),
-			"offset": query.offset
-				? Number(queryParamsValue(query.offset))
-				: undefined,
-			"limit": query.limit ? Number(queryParamsValue(query.limit)) : undefined,
+			facet: queryParamsArray(query.facet),
+			expand: queryParamsArray(query.expand),
+			staged: queryParamsValue(query.staged) === "true",
+			localeProjection: queryParamsValue(query.localeProjection),
+			storeProjection: queryParamsValue(query.storeProjection),
+			priceChannel: queryParamsValue(query.priceChannel),
+			priceCountry: queryParamsValue(query.priceCountry),
+			priceCurrency: queryParamsValue(query.priceCurrency),
+			priceCustomerGroup: queryParamsValue(query.priceCustomerGroup),
+			offset: query.offset ? Number(queryParamsValue(query.offset)) : undefined,
+			limit: query.limit ? Number(queryParamsValue(query.limit)) : undefined,
 		};
 		const resource = this.repository.search(
 			getRepositoryContext(request),
 			searchParams,
 		);
-		return response.status(200).send(resource);
+		response.status(200).send(resource);
 	}
 }

package/src/services/product.test.ts

@@ -1,3 +1,4 @@
+import assert from "node:assert";
 import type {
 	Category,
 	CategoryDraft,
@@ -19,7 +20,6 @@ import type {
 	Type,
 	TypeDraft,
 } from "@commercetools/platform-sdk";
-import assert from "assert";
 import supertest from "supertest";
 import {
 	afterAll,

package/src/services/product.ts

@@ -25,6 +25,6 @@ export class ProductService extends AbstractService {
 			getRepositoryContext(request),
 			searchBody,
 		);
-		return response.status(200).send(resource);
+		response.status(200).send(resource);
 	}
 }

package/src/services/project.ts

@@ -20,7 +20,7 @@ export class ProjectService {
 
 	get(request: Request, response: Response) {
 		const project = this.repository.get(getRepositoryContext(request));
-		return response.status(200).send(project);
+		response.status(200).send(project);
 	}
 
 	post(request: Request, response: Response) {
@@ -31,7 +31,8 @@ export class ProjectService {
 		const project = this.repository.get(getRepositoryContext(request));
 
 		if (!project) {
-			return response.status(404).send({});
+			response.status(404).send({});
+			return;
 		}
 
 		const updatedResource = this.repository.processUpdateActions(
@@ -41,6 +42,6 @@ export class ProjectService {
 			updateRequest.actions,
 		);
 
-		return response.status(200).send(updatedResource);
+		response.status(200).send(updatedResource);
 	}
 }

package/src/services/quote-request.test.ts

@@ -0,0 +1,59 @@
+import supertest from "supertest";
+import { afterEach, describe, expect, it } from "vitest";
+import { customerDraftFactory } from "~src/testing/customer";
+import { CommercetoolsMock } from "../index";
+
+describe("Quote Request Create", () => {
+	const ctMock = new CommercetoolsMock();
+
+	afterEach(() => {
+		ctMock.clear();
+	});
+
+	it("should create a quote request", async () => {
+		const customer = await customerDraftFactory(ctMock).create();
+		let response = await supertest(ctMock.app)
+			.post("/dummy/carts")
+			.send({
+				currency: "EUR",
+				customerId: customer.id,
+				custom: {
+					type: {
+						key: "my-cart",
+					},
+					fields: {
+						description: "example description",
+					},
+				},
+			});
+		expect(response.status).toBe(201);
+		const cart = response.body;
+
+		response = await supertest(ctMock.app)
+			.post("/dummy/quote-requests")
+			.send({
+				cart: {
+					typeId: "cart",
+					id: cart.id,
+				},
+				cartVersion: cart.version,
+			});
+		expect(response.status).toBe(201);
+		const quote = response.body;
+
+		expect(quote.cart).toEqual({
+			typeId: "cart",
+			id: cart.id,
+		});
+
+		response = await supertest(ctMock.app)
+			.get(`/dummy/quote-requests/${quote.id}`)
+			.send();
+
+		const quoteResult = response.body;
+		expect(quoteResult.cart).toEqual({
+			typeId: "cart",
+			id: cart.id,
+		});
+	});
+});

package/src/services/quote-request.ts

@@ -0,0 +1,16 @@
+import type { Router } from "express";
+import type { QuoteRequestRepository } from "~src/repositories/quote-request";
+import AbstractService from "./abstract";
+
+export class QuoteRequestService extends AbstractService {
+	public repository: QuoteRequestRepository;
+
+	constructor(parent: Router, repository: QuoteRequestRepository) {
+		super(parent);
+		this.repository = repository;
+	}
+
+	getBasePath() {
+		return "quote-requests";
+	}
+}

package/src/services/quote-staged.ts

@@ -0,0 +1,16 @@
+import type { Router } from "express";
+import type { StagedQuoteRepository } from "~src/repositories/quote-staged";
+import AbstractService from "./abstract";
+
+export class StagedQuoteService extends AbstractService {
+	public repository: StagedQuoteRepository;
+
+	constructor(parent: Router, repository: StagedQuoteRepository) {
+		super(parent);
+		this.repository = repository;
+	}
+
+	getBasePath() {
+		return "staged-quotes";
+	}
+}

package/src/services/quote.ts

@@ -0,0 +1,16 @@
+import type { Router } from "express";
+import type { QuoteRepository } from "~src/repositories/quote";
+import AbstractService from "./abstract";
+
+export class QuoteService extends AbstractService {
+	public repository: QuoteRepository;
+
+	constructor(parent: Router, repository: QuoteRepository) {
+		super(parent);
+		this.repository = repository;
+	}
+
+	getBasePath() {
+		return "quotes";
+	}
+}

package/src/services/shipping-method.ts

@@ -24,7 +24,8 @@ export class ShippingMethodService extends AbstractService {
 	matchingCart(request: Request, response: Response) {
 		const cartId = queryParamsValue(request.query.cartId);
 		if (!cartId) {
-			return response.status(400).send();
+			response.status(400).send();
+			return;
 		}
 		const result = this.repository.matchingCart(
 			getRepositoryContext(request),
@@ -33,6 +34,7 @@ export class ShippingMethodService extends AbstractService {
 				expand: this._parseParam(request.query.expand),
 			},
 		);
-		return response.status(200).send(result);
+		response.status(200).send(result);
+		return;
 	}
 }

package/src/services/standalone-price.test.ts

@@ -120,7 +120,7 @@ describe("Standalone price Actions", () => {
 
 	test("changeValue", async () => {
 		const response = await supertest(ctMock.app)
-			.post("/dummy/standalone-prices/" + id)
+			.post(`/dummy/standalone-prices/${id}`)
 			.send({
 				version: 1,
 				actions: [
@@ -159,7 +159,7 @@ describe("Standalone price Actions", () => {
 
 	test("setActive", async () => {
 		const response = await supertest(ctMock.app)
-			.post("/dummy/standalone-prices/" + id)
+			.post(`/dummy/standalone-prices/${id}`)
 			.send({
 				version: 1,
 				actions: [
@@ -195,7 +195,7 @@ describe("Standalone price Actions", () => {
 
 	test("setDiscounted", async () => {
 		const response = await supertest(ctMock.app)
-			.post("/dummy/standalone-prices/" + id)
+			.post(`/dummy/standalone-prices/${id}`)
 			.send({
 				version: 1,
 				actions: [
@@ -250,7 +250,7 @@ describe("Standalone price Actions", () => {
 		});
 
 		const response2 = await supertest(ctMock.app)
-			.post("/dummy/standalone-prices/" + id)
+			.post(`/dummy/standalone-prices/${id}`)
 			.send({
 				version: 2,
 				actions: [

package/src/services/state.test.ts

@@ -1,4 +1,4 @@
-import { type StateDraft } from "@commercetools/platform-sdk";
+import type { StateDraft } from "@commercetools/platform-sdk";
 import supertest from "supertest";
 import { describe, expect, test } from "vitest";
 import { CommercetoolsMock } from "../index";

package/src/services/store.test.ts

@@ -21,7 +21,7 @@ describe("Store", () => {
 		});
 
 		const response = await supertest(ctMock.app).get(
-			`/dummy/stores/key=STOREKEY`,
+			"/dummy/stores/key=STOREKEY",
 		);
 
 		expect(response.status).toBe(200);
@@ -54,7 +54,7 @@ describe("Store", () => {
 		});
 
 		const response = await supertest(ctMock.app).get(
-			`/dummy/stores/key=DOESNOTEXIST`,
+			"/dummy/stores/key=DOESNOTEXIST",
 		);
 
 		expect(response.status).toBe(404);

package/src/services/tax-category.test.ts

@@ -65,7 +65,7 @@ describe("Tax Category", () => {
 		expect(createResponse.status).toBe(201);
 
 		const response = await supertest(ctMock.app)
-			.get(`/dummy/tax-categories/`)
+			.get("/dummy/tax-categories/")
 			.query({ where: `key="${createResponse.body.key}"` });
 
 		expect(response.status).toBe(200);

package/src/shipping.ts

@@ -106,12 +106,12 @@ export const getShippingMethodsMatchingCart = (
 		context.projectKey,
 		"shipping-method",
 		{
-			"where": [
-				`zoneRates(zone(id in (:zoneIds)))`,
+			where: [
+				"zoneRates(zone(id in (:zoneIds)))",
 				`zoneRates(shippingRates(price(currencyCode="${cart.totalPrice.currencyCode}")))`,
 			],
 			"var.zoneIds": zoneIds,
-			"expand": params.expand,
+			expand: params.expand,
 		},
 	);
 

package/src/storage/in-memory.ts

@@ -1,47 +1,47 @@
+import assert from "node:assert";
 import type {
 	InvalidJsonInputError,
 	ReferencedResourceNotFoundError,
 	ShoppingListLineItem,
 } from "@commercetools/platform-sdk";
-import {
-	type AssociateRole,
-	type AttributeGroup,
-	type BusinessUnit,
-	type Cart,
-	type CartDiscount,
-	type Category,
-	type Channel,
-	type CustomObject,
-	type Customer,
-	type CustomerGroup,
-	type DiscountCode,
-	type Extension,
-	type InvalidInputError,
-	type InventoryEntry,
-	type Order,
-	type PagedQueryResponse,
-	type Payment,
-	type Product,
-	type ProductDiscount,
-	type ProductProjection,
-	type ProductTailoring,
-	type ProductType,
-	type Project,
-	type Quote,
-	type QuoteRequest,
-	type Reference,
-	type ResourceIdentifier,
-	type ShippingMethod,
-	type ShoppingList,
-	type StagedQuote,
-	type State,
-	type Store,
-	type Subscription,
-	type TaxCategory,
-	type Type,
-	type Zone,
+import type {
+	AssociateRole,
+	AttributeGroup,
+	BusinessUnit,
+	Cart,
+	CartDiscount,
+	Category,
+	Channel,
+	CustomObject,
+	Customer,
+	CustomerGroup,
+	DiscountCode,
+	Extension,
+	InvalidInputError,
+	InventoryEntry,
+	Order,
+	PagedQueryResponse,
+	Payment,
+	Product,
+	ProductDiscount,
+	ProductProjection,
+	ProductTailoring,
+	ProductType,
+	Project,
+	Quote,
+	QuoteRequest,
+	Reference,
+	ResourceIdentifier,
+	ShippingMethod,
+	ShoppingList,
+	StagedQuote,
+	State,
+	Store,
+	Subscription,
+	TaxCategory,
+	Type,
+	Zone,
 } from "@commercetools/platform-sdk";
-import assert from "assert";
 import { CommercetoolsError } from "~src/exceptions";
 import { cloneObject } from "../helpers";
 import { parseExpandClause } from "../lib/expandParser";
@@ -174,38 +174,38 @@ export class InMemoryStorage extends AbstractStorage {
 				"associate-role": new Map<string, AssociateRole>(),
 				"attribute-group": new Map<string, AttributeGroup>(),
 				"business-unit": new Map<string, BusinessUnit>(),
-				"cart": new Map<string, Cart>(),
+				cart: new Map<string, Cart>(),
 				"cart-discount": new Map<string, CartDiscount>(),
-				"category": new Map<string, Category>(),
-				"channel": new Map<string, Channel>(),
-				"customer": new Map<string, Customer>(),
+				category: new Map<string, Category>(),
+				channel: new Map<string, Channel>(),
+				customer: new Map<string, Customer>(),
 				"customer-group": new Map<string, CustomerGroup>(),
 				"discount-code": new Map<string, DiscountCode>(),
-				"extension": new Map<string, Extension>(),
+				extension: new Map<string, Extension>(),
 				"inventory-entry": new Map<string, InventoryEntry>(),
 				"key-value-document": new Map<string, CustomObject>(),
-				"order": new Map<string, Order>(),
+				order: new Map<string, Order>(),
 				"order-edit": new Map<string, any>(),
-				"payment": new Map<string, Payment>(),
-				"product": new Map<string, Product>(),
-				"quote": new Map<string, Quote>(),
+				payment: new Map<string, Payment>(),
+				product: new Map<string, Product>(),
+				quote: new Map<string, Quote>(),
 				"quote-request": new Map<string, QuoteRequest>(),
 				"product-discount": new Map<string, ProductDiscount>(),
 				"product-selection": new Map<string, any>(),
 				"product-type": new Map<string, ProductType>(),
 				"product-projection": new Map<string, ProductProjection>(),
 				"product-tailoring": new Map<string, ProductTailoring>(),
-				"review": new Map<string, any>(),
+				review: new Map<string, any>(),
 				"shipping-method": new Map<string, ShippingMethod>(),
 				"staged-quote": new Map<string, StagedQuote>(),
-				"state": new Map<string, State>(),
-				"store": new Map<string, Store>(),
+				state: new Map<string, State>(),
+				store: new Map<string, Store>(),
 				"shopping-list": new Map<string, ShoppingList>(),
 				"standalone-price": new Map<string, any>(),
-				"subscription": new Map<string, Subscription>(),
+				subscription: new Map<string, Subscription>(),
 				"tax-category": new Map<string, TaxCategory>(),
-				"type": new Map<string, Type>(),
-				"zone": new Map<string, Zone>(),
+				type: new Map<string, Type>(),
+				zone: new Map<string, Zone>(),
 			};
 		}
 		return projectStorage;
@@ -416,11 +416,7 @@ export class InMemoryStorage extends AbstractStorage {
 
 			throw new CommercetoolsError<ReferencedResourceNotFoundError>({
 				code: "ReferencedResourceNotFound",
-				message:
-					`The referenced object of type '${identifier.typeId}' with id ` +
-					`'${identifier.id}' was not found. It either doesn't exist, or it ` +
-					`can't be accessed from this endpoint (e.g., if the endpoint ` +
-					`filters by store or customer account).`,
+				message: `The referenced object of type '${identifier.typeId}' with id '${identifier.id}' was not found. It either doesn't exist, or it can't be accessed from this endpoint (e.g., if the endpoint filters by store or customer account).`,
 				typeId: identifier.typeId,
 				id: identifier.id,
 			});
@@ -438,11 +434,7 @@ export class InMemoryStorage extends AbstractStorage {
 
 			throw new CommercetoolsError<ReferencedResourceNotFoundError>({
 				code: "ReferencedResourceNotFound",
-				message:
-					`The referenced object of type '${identifier.typeId}' with key ` +
-					`'${identifier.key}' was not found. It either doesn't exist, or it ` +
-					`can't be accessed from this endpoint (e.g., if the endpoint ` +
-					`filters by store or customer account).`,
+				message: `The referenced object of type '${identifier.typeId}' with key '${identifier.key}' was not found. It either doesn't exist, or it can't be accessed from this endpoint (e.g., if the endpoint filters by store or customer account).`,
 				typeId: identifier.typeId,
 				key: identifier.key,
 			});

package/src/testing/customer.ts

@@ -7,7 +7,7 @@ export const customerDraftFactory = (m: CommercetoolsMock) =>
 	Factory.define<CustomerDraft, CustomerDraft, Customer>(({ onCreate }) => {
 		onCreate(async (draft) => {
 			const response = await supertest(m.app)
-				.post(`/dummy/customers`)
+				.post("/dummy/customers")
 				.send(draft);
 
 			return response.body.customer;

package/src/types.ts

@@ -3,7 +3,27 @@ import type { RepositoryMap } from "./repositories";
 
 export const isType = <T>(x: T) => x;
 
-export type Writable<T> = { -readonly [P in keyof T]: Writable<T[P]> };
+type Builtin =
+	| string
+	| number
+	| boolean
+	| undefined
+	| null
+	| symbol
+	| bigint
+	| Date
+	| RegExp;
+
+export type Writable<T> = T extends Builtin
+	? T
+	: T extends ReadonlyArray<infer U>
+		? WritableArray<U>
+		: T extends object
+			? { -readonly [P in keyof T]: Writable<T[P]> }
+			: T;
+
+export interface WritableArray<T> extends Array<Writable<T>> {}
+
 export type ShallowWritable<T> = { -readonly [P in keyof T]: T[P] };
 
 export type ServiceTypes =
@@ -23,40 +43,40 @@ export type ResourceMap = {
 	"associate-role": ctp.AssociateRole;
 	"business-unit": ctp.BusinessUnit;
 	"cart-discount": ctp.CartDiscount;
-	"cart": ctp.Cart;
-	"category": ctp.Category;
-	"channel": ctp.Channel;
+	cart: ctp.Cart;
+	category: ctp.Category;
+	channel: ctp.Channel;
 	"customer-email-token": never;
 	"customer-group": ctp.CustomerGroup;
 	"customer-password-token": never;
-	"customer": ctp.Customer;
+	customer: ctp.Customer;
 	"discount-code": ctp.DiscountCode;
-	"extension": ctp.Extension;
+	extension: ctp.Extension;
 	"inventory-entry": ctp.InventoryEntry;
 	"key-value-document": ctp.CustomObject;
 	"order-edit": ctp.OrderEdit;
-	"order": ctp.Order;
-	"payment": ctp.Payment;
+	order: ctp.Order;
+	payment: ctp.Payment;
 	"product-discount": ctp.ProductDiscount;
 	"product-price": ctp.StandalonePrice;
 	"product-projection": ctp.ProductProjection;
 	"product-selection": ctp.ProductSelection;
 	"product-tailoring": ctp.ProductTailoring;
 	"product-type": ctp.ProductType;
-	"product": ctp.Product;
+	product: ctp.Product;
 	"quote-request": ctp.QuoteRequest;
-	"quote": ctp.Quote;
-	"review": ctp.Review;
+	quote: ctp.Quote;
+	review: ctp.Review;
 	"shipping-method": ctp.ShippingMethod;
 	"shopping-list": ctp.ShoppingList;
 	"staged-quote": ctp.StagedQuote;
 	"standalone-price": ctp.StandalonePrice;
-	"state": ctp.State;
-	"store": ctp.Store;
-	"subscription": ctp.Subscription;
+	state: ctp.State;
+	store: ctp.Store;
+	subscription: ctp.Subscription;
 	"tax-category": ctp.TaxCategory;
-	"type": ctp.Type;
-	"zone": ctp.Zone;
+	type: ctp.Type;
+	zone: ctp.Zone;
 };
 
 export type PagedQueryResponseMap = {
@@ -64,38 +84,38 @@ export type PagedQueryResponseMap = {
 	"associate-role": ctp.AssociateRolePagedQueryResponse;
 	"business-unit": ctp.BusinessUnitPagedQueryResponse;
 	"cart-discount": ctp.CartDiscountPagedQueryResponse;
-	"cart": ctp.CartPagedQueryResponse;
-	"category": ctp.CategoryPagedQueryResponse;
-	"channel": ctp.ChannelPagedQueryResponse;
+	cart: ctp.CartPagedQueryResponse;
+	category: ctp.CategoryPagedQueryResponse;
+	channel: ctp.ChannelPagedQueryResponse;
 	"customer-email-token": never;
 	"customer-group": ctp.CustomerGroupPagedQueryResponse;
 	"customer-password-token": never;
-	"customer": ctp.CustomerPagedQueryResponse;
+	customer: ctp.CustomerPagedQueryResponse;
 	"discount-code": ctp.DiscountCodePagedQueryResponse;
-	"extension": ctp.ExtensionPagedQueryResponse;
+	extension: ctp.ExtensionPagedQueryResponse;
 	"inventory-entry": ctp.InventoryPagedQueryResponse;
 	"key-value-document": ctp.CustomObjectPagedQueryResponse;
 	"order-edit": ctp.OrderEditPagedQueryResponse;
-	"order": ctp.OrderPagedQueryResponse;
-	"payment": ctp.PaymentPagedQueryResponse;
+	order: ctp.OrderPagedQueryResponse;
+	payment: ctp.PaymentPagedQueryResponse;
 	"product-discount": ctp.ProductDiscountPagedQueryResponse;
 	"product-price": ctp.StandalonePricePagedQueryResponse;
 	"product-projection": ctp.ProductProjectionPagedQueryResponse;
 	"product-selection": ctp.ProductSelectionPagedQueryResponse;
 	"product-tailoring": ctp.ProductTailoringPagedQueryResponse;
 	"product-type": ctp.ProductTypePagedQueryResponse;
-	"product": ctp.ProductPagedQueryResponse;
+	product: ctp.ProductPagedQueryResponse;
 	"quote-request": ctp.QuoteRequestPagedQueryResponse;
-	"quote": ctp.QuotePagedQueryResponse;
-	"review": ctp.ReviewPagedQueryResponse;
+	quote: ctp.QuotePagedQueryResponse;
+	review: ctp.ReviewPagedQueryResponse;
 	"shipping-method": ctp.ShippingMethodPagedQueryResponse;
 	"shopping-list": ctp.ShoppingListPagedQueryResponse;
 	"staged-quote": ctp.StagedQuotePagedQueryResponse;
 	"standalone-price": ctp.StandalonePricePagedQueryResponse;
-	"state": ctp.StatePagedQueryResponse;
-	"store": ctp.StorePagedQueryResponse;
-	"subscription": ctp.SubscriptionPagedQueryResponse;
+	state: ctp.StatePagedQueryResponse;
+	store: ctp.StorePagedQueryResponse;
+	subscription: ctp.SubscriptionPagedQueryResponse;
 	"tax-category": ctp.TaxCategoryPagedQueryResponse;
-	"type": ctp.TypePagedQueryResponse;
-	"zone": ctp.ZonePagedQueryResponse;
+	type: ctp.TypePagedQueryResponse;
+	zone: ctp.ZonePagedQueryResponse;
 };

package/src/repositories/quote-request.ts

@@ -1,17 +0,0 @@
-import type {
-	QuoteRequest,
-	QuoteRequestDraft,
-} from "@commercetools/platform-sdk";
-import type { Config } from "~src/config";
-import type { RepositoryContext } from "./abstract";
-import { AbstractResourceRepository } from "./abstract";
-
-export class QuoteRequestRepository extends AbstractResourceRepository<"quote-request"> {
-	constructor(config: Config) {
-		super("quote-request", config);
-	}
-
-	create(context: RepositoryContext, draft: QuoteRequestDraft): QuoteRequest {
-		throw new Error("not implemented");
-	}
-}

package/src/repositories/quote.ts

@@ -1,14 +0,0 @@
-import type { Quote, QuoteDraft } from "@commercetools/platform-sdk";
-import type { Config } from "~src/config";
-import type { RepositoryContext } from "./abstract";
-import { AbstractResourceRepository } from "./abstract";
-
-export class QuoteRepository extends AbstractResourceRepository<"quote"> {
-	constructor(config: Config) {
-		super("quote", config);
-	}
-
-	create(context: RepositoryContext, draft: QuoteDraft): Quote {
-		throw new Error("not implemented");
-	}
-}