@labdigital/commercetools-mock 2.42.1 → 2.43.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@labdigital/commercetools-mock",
-  "version": "2.42.1",
+  "version": "2.43.0",
   "license": "MIT",
   "author": "Michael van Tellingen",
   "type": "module",
@@ -50,7 +50,7 @@
     "@types/uuid": "^9.0.8",
     "@typescript-eslint/eslint-plugin": "^7.0.2",
     "@typescript-eslint/parser": "^7.0.2",
-    "@vitest/coverage-v8": "^1.5.0",
+    "@vitest/coverage-v8": "3.0.2",
     "esbuild": "^0.20.1",
     "eslint": "^8.57.1",
     "eslint-plugin-sort-class-members": "^1.21.0",
@@ -67,7 +67,7 @@
     "tslib": "^2.8.0",
     "tsup": "^8.0.2",
     "typescript": "^5.6.3",
-    "vitest": "^1.5.0"
+    "vitest": "3.0.2"
   },
   "engines": {
     "node": ">=18",

package/src/config.ts

@@ -0,0 +1,6 @@
+import type { AbstractStorage } from "./storage";
+
+export type Config = {
+	strict: boolean;
+	storage: AbstractStorage;
+};

package/src/ctMock.ts

@@ -5,22 +5,20 @@ import morgan from "morgan";
 import { http, HttpResponse } from "msw";
 import type { SetupServer, SetupServerApi } from "msw/node";
 import { setupServer } from "msw/node";
+import type { Config } from "./config";
 import { DEFAULT_API_HOSTNAME, DEFAULT_AUTH_HOSTNAME } from "./constants";
 import { CommercetoolsError } from "./exceptions";
+import { mapHeaderType } from "./helpers";
 import { copyHeaders } from "./lib/proxy";
 import { OAuth2Server } from "./oauth/server";
 import { ProjectAPI } from "./projectAPI";
-import type { AbstractStorage } from "./storage";
-import { InMemoryStorage } from "./storage";
-
-// Services
-import { warnDeprecation } from "./deprecation";
-import { mapHeaderType } from "./helpers";
 import type { RepositoryMap } from "./repositories";
 import { createRepositories } from "./repositories";
 import type { ProjectRepository } from "./repositories/project";
 import { createServices } from "./services";
 import { ProjectService } from "./services/project";
+import type { AbstractStorage } from "./storage";
+import { InMemoryStorage } from "./storage";
 
 export type CommercetoolsMockOptions = {
 	validateCredentials: boolean;
@@ -29,6 +27,7 @@ export type CommercetoolsMockOptions = {
 	apiHost: RegExp | string;
 	authHost: RegExp | string;
 	silent: boolean;
+	strict: boolean;
 };
 
 type AppOptions = { silent?: boolean };
@@ -39,7 +38,8 @@ const DEFAULT_OPTIONS: CommercetoolsMockOptions = {
 	defaultProjectKey: undefined,
 	apiHost: DEFAULT_API_HOSTNAME,
 	authHost: DEFAULT_AUTH_HOSTNAME,
-	silent: false,
+	silent: true,
+	strict: false,
 };
 
 const _globalListeners: SetupServer[] = [];
@@ -74,8 +74,9 @@ export class CommercetoolsMock {
 	}
 
 	start() {
-		warnDeprecation(
-			"The start method is deprecated, use .registerHandlers() to bind to an msw server instead",
+		process.emitWarning(
+			"The start() method is deprecated, use .registerHandlers() to bind to an msw server instead",
+			"DeprecationWarning",
 		);
 
 		// Order is important here when the hostnames match
@@ -84,8 +85,9 @@ export class CommercetoolsMock {
 	}
 
 	stop() {
-		warnDeprecation(
-			"The stop method is deprecated, use .registerHandlers() to bind to an msw server instead",
+		process.emitWarning(
+			"The stop() method is deprecated, use .registerHandlers() to bind to an msw server instead",
+			"DeprecationWarning",
 		);
 		this._mswServer?.close();
 		this._mswServer = undefined;
@@ -104,10 +106,15 @@ export class CommercetoolsMock {
 			throw new Error("repositories not initialized yet");
 		}
 
+		const config: Config = {
+			strict: this.options.strict,
+			storage: this._storage,
+		};
+
 		return new ProjectAPI(
 			projectKey || this.options.defaultProjectKey!,
 			this._repositories,
-			this._storage,
+			config,
 		);
 	}
 
@@ -123,7 +130,11 @@ export class CommercetoolsMock {
 	}
 
 	private createApp(options?: AppOptions): express.Express {
-		this._repositories = createRepositories(this._storage);
+		const config: Config = {
+			strict: this.options.strict,
+			storage: this._storage,
+		};
+		this._repositories = createRepositories(config);
 		this._oauth2.setCustomerRepository(this._repositories.customer);
 
 		const app = express();
@@ -292,7 +303,7 @@ export class CommercetoolsMock {
 			if (this._mswServer !== undefined) {
 				throw new Error("Server already started");
 			} else {
-				console.warn("Server wasn't stopped properly, clearing");
+				process.emitWarning("Server wasn't stopped properly, clearing");
 				_globalListeners.forEach((listener) => listener.close());
 			}
 		}

package/src/index.test.ts

@@ -1,8 +1,19 @@
 import { type InvalidTokenError } from "@commercetools/platform-sdk";
 import got from "got";
-import { expect, test } from "vitest";
+import { setupServer } from "msw/node";
+import { afterEach, beforeAll, expect, test } from "vitest";
 import { CommercetoolsMock } from "./index";
 
+const mswServer = setupServer();
+
+beforeAll(() => {
+	mswServer.listen({ onUnhandledRequest: "error" });
+});
+
+afterEach(() => {
+	mswServer.resetHandlers();
+});
+
 test("node:fetch client", async () => {
 	const ctMock = new CommercetoolsMock({
 		enableAuthentication: true,
@@ -10,7 +21,7 @@ test("node:fetch client", async () => {
 		apiHost: "https://localhost",
 		authHost: "https://localhost:8080",
 	});
-	ctMock.start();
+	ctMock.registerHandlers(mswServer);
 
 	const authHeader = "Basic " + Buffer.from("foo:bar").toString("base64");
 	let response = await fetch("https://localhost:8080/oauth/token", {
@@ -44,7 +55,6 @@ test("node:fetch client", async () => {
 		limit: 20,
 		results: [],
 	});
-	ctMock.stop();
 });
 
 test("got client", async () => {
@@ -54,7 +64,7 @@ test("got client", async () => {
 		apiHost: "https://localhost",
 		authHost: "https://localhost:8080",
 	});
-	ctMock.start();
+	ctMock.registerHandlers(mswServer);
 
 	let response = await got.post<{ access_token: string }>(
 		"https://localhost:8080/oauth/token",
@@ -86,7 +96,6 @@ test("got client", async () => {
 		limit: 20,
 		results: [],
 	});
-	ctMock.stop();
 });
 
 test("Options.validateCredentials: true (error)", async () => {
@@ -94,7 +103,7 @@ test("Options.validateCredentials: true (error)", async () => {
 		enableAuthentication: true,
 		validateCredentials: true,
 	});
-	ctMock.start();
+	ctMock.registerHandlers(mswServer);
 
 	const response = await got.get<InvalidTokenError>(
 		"https://api.europe-west1.gcp.commercetools.com/my-project/orders",
@@ -108,7 +117,6 @@ test("Options.validateCredentials: true (error)", async () => {
 	);
 	expect(response.statusCode).toBe(401);
 	expect(response.body.message).toBe("invalid_token");
-	ctMock.stop();
 });
 
 test("Options.validateCredentials: false", async () => {
@@ -116,7 +124,7 @@ test("Options.validateCredentials: false", async () => {
 		enableAuthentication: true,
 		validateCredentials: false,
 	});
-	ctMock.start();
+	ctMock.registerHandlers(mswServer);
 
 	const response = await got.get(
 		"https://api.europe-west1.gcp.commercetools.com/my-project/orders",
@@ -135,7 +143,6 @@ test("Options.validateCredentials: false", async () => {
 		limit: 20,
 		results: [],
 	});
-	ctMock.stop();
 });
 
 test("Options.enableAuthentication: false", async () => {
@@ -143,7 +150,7 @@ test("Options.enableAuthentication: false", async () => {
 		enableAuthentication: false,
 		validateCredentials: false,
 	});
-	ctMock.start();
+	ctMock.registerHandlers(mswServer);
 
 	const response = await got.get(
 		"https://api.europe-west1.gcp.commercetools.com/my-project/orders",
@@ -159,7 +166,6 @@ test("Options.enableAuthentication: false", async () => {
 		limit: 20,
 		results: [],
 	});
-	ctMock.stop();
 });
 
 test("Options.apiHost: is overridden is set", async () => {
@@ -168,7 +174,7 @@ test("Options.apiHost: is overridden is set", async () => {
 		validateCredentials: false,
 		apiHost: "http://api.localhost",
 	});
-	ctMock.start();
+	ctMock.registerHandlers(mswServer);
 
 	const response = await got.get("http://api.localhost/my-project/orders", {
 		responseType: "json",
@@ -181,7 +187,6 @@ test("Options.apiHost: is overridden is set", async () => {
 		limit: 20,
 		results: [],
 	});
-	ctMock.stop();
 });
 
 test("Options.authHost: is set", async () => {
@@ -190,7 +195,7 @@ test("Options.authHost: is set", async () => {
 		validateCredentials: true,
 		authHost: "http://auth.localhost",
 	});
-	ctMock.start();
+	ctMock.registerHandlers(mswServer);
 
 	const response = await got.post<{ access_token: string }>(
 		"http://auth.localhost/oauth/token",
@@ -216,7 +221,7 @@ test("apiHost mock proxy: querystring", async () => {
 		validateCredentials: false,
 		apiHost: "http://api.localhost",
 	});
-	ctMock.start();
+	ctMock.registerHandlers(mswServer);
 
 	const response = await got.get("http://api.localhost/my-project/orders", {
 		responseType: "json",
@@ -234,5 +239,4 @@ test("apiHost mock proxy: querystring", async () => {
 		limit: 20,
 		results: [],
 	});
-	ctMock.stop();
 });

package/src/oauth/server.test.ts

@@ -1,6 +1,7 @@
 import express from "express";
 import supertest from "supertest";
 import { beforeEach, describe, expect, it } from "vitest";
+import type { Config } from "~src/config";
 import { getBaseResourceProperties } from "../helpers";
 import { hashPassword } from "../lib/password";
 import { CustomerRepository } from "../repositories/customer";
@@ -21,7 +22,8 @@ describe("OAuth2Server", () => {
 		app.use(server.createRouter());
 
 		storage = new InMemoryStorage();
-		customerRepository = new CustomerRepository(storage);
+		const config: Config = { storage, strict: false };
+		customerRepository = new CustomerRepository(config);
 		server.setCustomerRepository(customerRepository);
 	});
 

package/src/product-projection-search.ts

@@ -9,6 +9,7 @@ import type {
 	RangeFacetResult,
 	TermFacetResult,
 } from "@commercetools/platform-sdk";
+import type { Config } from "./config";
 import { CommercetoolsError } from "./exceptions";
 import { nestedLookup } from "./helpers";
 import type {
@@ -51,8 +52,8 @@ export type ProductProjectionSearchParams = {
 export class ProductProjectionSearch {
 	protected _storage: AbstractStorage;
 
-	constructor(storage: AbstractStorage) {
-		this._storage = storage;
+	constructor(config: Config) {
+		this._storage = config.storage;
 	}
 
 	search(

package/src/product-search.ts

@@ -6,6 +6,7 @@ import type {
 	ProductSearchRequest,
 	ProductSearchResult,
 } from "@commercetools/platform-sdk";
+import type { Config } from "./config";
 import { CommercetoolsError } from "./exceptions";
 import { parseSearchQuery } from "./lib/productSearchFilter";
 import { validateSearchQuery } from "./lib/searchQueryTypeChecker";
@@ -15,8 +16,8 @@ import type { AbstractStorage } from "./storage";
 export class ProductSearch {
 	protected _storage: AbstractStorage;
 
-	constructor(storage: AbstractStorage) {
-		this._storage = storage;
+	constructor(config: Config) {
+		this._storage = config.storage;
 	}
 
 	search(

package/src/projectAPI.ts

@@ -1,3 +1,4 @@
+import type { Config } from "./config";
 import { getBaseResourceProperties } from "./helpers";
 import type { RepositoryMap } from "./repositories";
 import type { GetParams } from "./repositories/abstract";
@@ -11,19 +12,30 @@ export class ProjectAPI {
 
 	private _repositories: RepositoryMap;
 
-	constructor(
-		projectKey: string,
-		repositories: RepositoryMap,
-		storage: AbstractStorage,
-	) {
+	private config: Config;
+
+	constructor(projectKey: string, repositories: RepositoryMap, config: Config) {
 		this.projectKey = projectKey;
-		this._storage = storage;
+		this.config = config;
+		this._storage = config.storage;
 		this._repositories = repositories;
 	}
 
 	add<T extends keyof RepositoryMap & keyof ResourceMap>(
 		typeId: T,
 		resource: ResourceMap[T],
+	) {
+		process.emitWarning(
+			"ctMock.add() is deprecated, create resources via regular create endpoints " +
+				"or if you are really sure, use unsafeAdd() (but be aware of potential state issues)",
+			"DeprecationWarning",
+		);
+		this.unsafeAdd(typeId, resource);
+	}
+
+	unsafeAdd<T extends keyof RepositoryMap & keyof ResourceMap>(
+		typeId: T,
+		resource: ResourceMap[T],
 	) {
 		const repository = this._repositories[typeId];
 		if (repository) {

package/src/repositories/abstract.ts

@@ -7,6 +7,7 @@ import type {
 	UpdateAction,
 } from "@commercetools/platform-sdk";
 import deepEqual from "deep-equal";
+import type { Config } from "~src/config";
 import { CommercetoolsError } from "~src/exceptions";
 import { cloneObject } from "../helpers";
 import type { AbstractStorage } from "../storage";
@@ -40,10 +41,13 @@ export type RepositoryContext = {
 export abstract class AbstractRepository<R extends BaseResource | Project> {
 	protected _storage: AbstractStorage;
 
+	protected config: Config;
+
 	protected actions: AbstractUpdateHandler | undefined;
 
-	constructor(storage: AbstractStorage) {
-		this._storage = storage;
+	constructor(config: Config) {
+		this.config = config;
+		this._storage = config.storage;
 	}
 
 	abstract saveNew({ projectKey }: RepositoryContext, resource: R): void;
@@ -92,8 +96,8 @@ export abstract class AbstractResourceRepository<
 > extends AbstractRepository<ResourceMap[T]> {
 	protected _typeId: T;
 
-	constructor(typeId: T, storage: AbstractStorage) {
-		super(storage);
+	constructor(typeId: T, config: Config) {
+		super(config);
 		this._typeId = typeId;
 	}
 

package/src/repositories/associate-role.ts

@@ -10,8 +10,8 @@ import type {
 	AssociateRoleSetPermissionsAction,
 	AssociateRoleUpdateAction,
 } from "@commercetools/platform-sdk";
+import type { Config } from "~src/config";
 import { getBaseResourceProperties } from "../helpers";
-import type { AbstractStorage } from "../storage/abstract";
 import type { Writable } from "../types";
 import type { UpdateHandlerInterface } from "./abstract";
 import {
@@ -22,8 +22,8 @@ import {
 import { createCustomFields } from "./helpers";
 
 export class AssociateRoleRepository extends AbstractResourceRepository<"associate-role"> {
-	constructor(storage: AbstractStorage) {
-		super("associate-role", storage);
+	constructor(config: Config) {
+		super("associate-role", config);
 		this.actions = new AssociateRoleUpdateHandler(this._storage);
 	}
 

package/src/repositories/attribute-group.ts

@@ -7,8 +7,8 @@ import type {
 	AttributeGroupSetKeyAction,
 	AttributeGroupUpdateAction,
 } from "@commercetools/platform-sdk";
+import type { Config } from "~src/config";
 import { getBaseResourceProperties } from "../helpers";
-import type { AbstractStorage } from "../storage/abstract";
 import type { Writable } from "../types";
 import type { UpdateHandlerInterface } from "./abstract";
 import {
@@ -18,8 +18,8 @@ import {
 } from "./abstract";
 
 export class AttributeGroupRepository extends AbstractResourceRepository<"attribute-group"> {
-	constructor(storage: AbstractStorage) {
-		super("attribute-group", storage);
+	constructor(config: Config) {
+		super("attribute-group", config);
 		this.actions = new AttributeGroupUpdateHandler(this._storage);
 	}
 

package/src/repositories/business-unit.ts

@@ -23,7 +23,7 @@ import {
 	type Company,
 	type Division,
 } from "@commercetools/platform-sdk";
-import type { AbstractStorage } from "~src/storage";
+import type { Config } from "~src/config";
 import { generateRandomString, getBaseResourceProperties } from "../helpers";
 import type { Writable } from "../types";
 import type { UpdateHandlerInterface } from "./abstract";
@@ -41,8 +41,8 @@ import {
 } from "./helpers";
 
 export class BusinessUnitRepository extends AbstractResourceRepository<"business-unit"> {
-	constructor(storage: AbstractStorage) {
-		super("business-unit", storage);
+	constructor(config: Config) {
+		super("business-unit", config);
 		this.actions = new BusinessUnitUpdateHandler(this._storage);
 	}
 

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

@@ -1,11 +1,13 @@
 import type { CartDraft, LineItem } from "@commercetools/platform-sdk";
 import { describe, expect, test } from "vitest";
+import type { Config } from "~src/config";
 import { InMemoryStorage } from "~src/storage";
 import { CartRepository } from "./index";
 
 describe("Cart repository", () => {
 	const storage = new InMemoryStorage();
-	const repository = new CartRepository(storage);
+	const config: Config = { storage, strict: false };
+	const repository = new CartRepository(config);
 
 	test("create cart in store", async () => {
 		storage.add("dummy", "product", {

package/src/repositories/cart/index.ts

@@ -8,9 +8,9 @@ import {
 	type ProductPagedQueryResponse,
 } from "@commercetools/platform-sdk";
 import { v4 as uuidv4 } from "uuid";
+import type { Config } from "~src/config";
 import { CommercetoolsError } from "~src/exceptions";
 import { getBaseResourceProperties } from "~src/helpers";
-import type { AbstractStorage } from "~src/storage/abstract";
 import type { Writable } from "~src/types";
 import {
 	AbstractResourceRepository,
@@ -21,8 +21,8 @@ import { CartUpdateHandler } from "./actions";
 import { calculateCartTotalPrice, selectPrice } from "./helpers";
 
 export class CartRepository extends AbstractResourceRepository<"cart"> {
-	constructor(storage: AbstractStorage) {
-		super("cart", storage);
+	constructor(config: Config) {
+		super("cart", config);
 		this.actions = new CartUpdateHandler(this._storage);
 	}
 

package/src/repositories/cart-discount/index.ts

@@ -7,8 +7,8 @@ import type {
 	CartDiscountValueGiftLineItem,
 	CartDiscountValueRelative,
 } from "@commercetools/platform-sdk";
+import type { Config } from "~src/config";
 import { getBaseResourceProperties } from "~src/helpers";
-import type { AbstractStorage } from "~src/storage/abstract";
 import {
 	AbstractResourceRepository,
 	type RepositoryContext,
@@ -21,9 +21,9 @@ import {
 import { CartDiscountUpdateHandler } from "./actions";
 
 export class CartDiscountRepository extends AbstractResourceRepository<"cart-discount"> {
-	constructor(storage: AbstractStorage) {
-		super("cart-discount", storage);
-		this.actions = new CartDiscountUpdateHandler(storage);
+	constructor(config: Config) {
+		super("cart-discount", config);
+		this.actions = new CartDiscountUpdateHandler(config.storage);
 	}
 
 	create(context: RepositoryContext, draft: CartDiscountDraft): CartDiscount {
@@ -80,7 +80,5 @@ export class CartDiscountRepository extends AbstractResourceRepository<"cart-dis
 				} as CartDiscountValueRelative;
 			}
 		}
-
-		return value;
 	}
 }

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

@@ -1,10 +1,12 @@
 import { describe, expect, test } from "vitest";
+import type { Config } from "~src/config";
 import { InMemoryStorage } from "~src/storage";
 import { CategoryRepository } from "./index";
 
 describe("Order repository", () => {
 	const storage = new InMemoryStorage();
-	const repository = new CategoryRepository(storage);
+	const config: Config = { storage, strict: false };
+	const repository = new CategoryRepository(config);
 
 	test("valid ancestors", async () => {
 		const root = repository.create(

package/src/repositories/category/index.ts

@@ -4,9 +4,9 @@ import type {
 	CategoryReference,
 } from "@commercetools/platform-sdk";
 import { v4 as uuidv4 } from "uuid";
+import type { Config } from "~src/config";
 import { getBaseResourceProperties } from "~src/helpers";
 import { parseExpandClause } from "~src/lib/expandParser";
-import type { AbstractStorage } from "~src/storage/abstract";
 import type { Writable } from "~src/types";
 import type { GetParams } from "../abstract";
 import {
@@ -17,8 +17,8 @@ import { createCustomFields } from "../helpers";
 import { CategoryUpdateHandler } from "./actions";
 
 export class CategoryRepository extends AbstractResourceRepository<"category"> {
-	constructor(storage: AbstractStorage) {
-		super("category", storage);
+	constructor(config: Config) {
+		super("category", config);
 		this.actions = new CategoryUpdateHandler(this._storage);
 	}
 

package/src/repositories/channel.ts

@@ -10,8 +10,8 @@ import type {
 	ChannelSetGeoLocationAction,
 	ChannelUpdateAction,
 } from "@commercetools/platform-sdk";
+import type { Config } from "~src/config";
 import { getBaseResourceProperties } from "../helpers";
-import type { AbstractStorage } from "../storage/abstract";
 import type { Writable } from "../types";
 import type { UpdateHandlerInterface } from "./abstract";
 import {
@@ -22,8 +22,8 @@ import {
 import { createAddress, createCustomFields } from "./helpers";
 
 export class ChannelRepository extends AbstractResourceRepository<"channel"> {
-	constructor(storage: AbstractStorage) {
-		super("channel", storage);
+	constructor(config: Config) {
+		super("channel", config);
 		this.actions = new ChannelUpdateHandler(this._storage);
 	}
 

package/src/repositories/custom-object.ts

@@ -3,8 +3,8 @@ import type {
 	CustomObjectDraft,
 	InvalidOperationError,
 } from "@commercetools/platform-sdk";
+import type { Config } from "~src/config";
 import { CommercetoolsError } from "~src/exceptions";
-import type { AbstractStorage } from "~src/storage";
 import { cloneObject, getBaseResourceProperties } from "../helpers";
 import type { Writable } from "../types";
 import type { QueryParams } from "./abstract";
@@ -12,8 +12,8 @@ import { AbstractResourceRepository, type RepositoryContext } from "./abstract";
 import { checkConcurrentModification } from "./errors";
 
 export class CustomObjectRepository extends AbstractResourceRepository<"key-value-document"> {
-	constructor(storage: AbstractStorage) {
-		super("key-value-document", storage);
+	constructor(config: Config) {
+		super("key-value-document", config);
 	}
 
 	create(

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

@@ -1,11 +1,13 @@
 import type { Store } from "@commercetools/platform-sdk";
 import { describe, expect, test } from "vitest";
+import type { Config } from "~src/config";
 import { InMemoryStorage } from "~src/storage";
 import { CustomerRepository } from "./index";
 
 describe("Customer repository", () => {
 	const storage = new InMemoryStorage();
-	const repository = new CustomerRepository(storage);
+	const config: Config = { storage, strict: false };
+	const repository = new CustomerRepository(config);
 
 	test("query by lowercaseEmail", async () => {
 		const customer = repository.create(