Installation

Install the package

Install the mock as a dev dependency — it is a testing tool and should not ship in your production bundle.

pnpm

pnpm add -D @labdigital/commercetools-mock

npm

npm install --save-dev @labdigital/commercetools-mock

yarn

yarn add --dev @labdigital/commercetools-mock

Peer dependencies

The package declares two peer dependencies that you install alongside it:

Package	Version	Why
msw	^2.14.6	Intercepts the HTTP requests your code makes.
@commercetools/platform-sdk	>= 8.25.0	Provides the resource type definitions the mock is typed against.

pnpm

pnpm add -D msw @commercetools/platform-sdk

npm

npm install --save-dev msw @commercetools/platform-sdk

yarn

yarn add --dev msw @commercetools/platform-sdk

Already using the SDK?

If your application already depends on @commercetools/platform-sdk you don’t need to install it again — the mock will use the version already present.

Requirements

• Node.js ≥ 22. The library is published as ESM ("type": "module") and uses modern Node APIs (the optional SQLite backend relies on the built-in node:sqlite module).
• A test runner such as Vitest or Jest — the examples in these docs use Vitest.

Entry points

The package exposes two entry points:

// Main entry — the mock, storage and helpers
import { CommercetoolsMock } from '@labdigital/commercetools-mock'

// Optional SQLite storage backend
import { SQLiteStorage } from '@labdigital/commercetools-mock/sqlite'

Next: build a working test in the Quick start.