@labdigital/commercetools-mock 2.5.0 → 2.6.0

package/README.md

@@ -3,9 +3,16 @@
 [<img src="https://img.shields.io/npm/v/@labdigital/commercetools-mock">](https://www.npmjs.com/package/@labdigital/commercetools-mock)
 [![codecov](https://codecov.io/gh/labd/commercetools-node-mock/branch/main/graph/badge.svg?token=muKkNunJ95)](https://codecov.io/gh/labd/commercetools-node-mock)
 
-This library mocks the Commercetools rest api to ease testing of your typescript
-codebases interacting with the commercetools api. It uses the same proven approach
-as our testing module in the [commercetools Python SDK](https://github.com/labd/commercetools-python-sdk/tree/main/src/commercetools/testing).
+This library mocks the Commercetools rest API to ease testing of your typescript
+codebases interacting with the commercetools api. It uses the same proven
+approach as our testing module in the
+[commercetools Python SDK](https://github.com/labd/commercetools-python-sdk/tree/main/src/commercetools/testing).
+
+Since version 2 of this library it is based on [msw](https://mswjs.io/) instead
+of nock. It is now therefore als recommended to manage the msw server yourself
+and use the `registerHandlers` method to register the handlers on this server.
+
+This allows you to use the same server for mocking other API's as well.
 
 ## Installation
 
@@ -15,13 +22,15 @@ yarn add --dev @labdigital/commercetools-mock
 
 ## Docker image
 
-This codebase is also available as a docker image where it provides a runnable http server exposing the mocked endpoints. See
-https://github.com/labd/commercetools-mock-server
+This codebase is also available as a docker image where it provides a runnable
+http server exposing the mocked endpoints. See
+https://hub.docker.com/r/labdigital/commercetools-mock-server
 
 ## Example
 
 ```typescript
 import { CommercetoolsMock, getBaseResourceProperties } from '@labdigital/commercetools-mock'
+import { setupServer } from 'msw/node'
 
 const ctMock = new CommercetoolsMock({
   apiHost: 'https://localhost',
@@ -34,7 +43,8 @@ const ctMock = new CommercetoolsMock({
 
 describe('A module', () => {
   beforeAll(() => {
-    ctMock.start()
+    const server = setupServer()
+    ctMock.registerHandlers(server)
 
     ctMock.project().add('type', {
       ...getBaseResourceProperties()
@@ -44,6 +54,7 @@ describe('A module', () => {
   })
 
   afterAll(() => {
+    server.clearHandlers()
     ctMock.stop()
   })
 
@@ -61,7 +72,9 @@ describe('A module', () => {
 })
 ```
 
-## Adding a resource
+## Contributing
+
+### Adding a new service
 
 Implement the following:
 
@@ -71,7 +84,7 @@ Implement the following:
 - Add new service to src/storage.ts InMemoryStorage
 - Adjust src/types.ts RepositoryMap and possibly serviceTypes
 
-## Releasing
+### Releasing
 
 This codebases use [@changesets](https://github.com/changesets/changesets) for release and version management
 

package/dist/index.cjs

@@ -6992,22 +6992,17 @@ var CommercetoolsMock = class {
     });
     return app;
   }
-  startServer() {
-    if (_globalListeners.length > 0) {
-      if (this._mswServer !== void 0) {
-        throw new Error("Server already started");
-      } else {
-        console.warn("Server wasn't stopped properly, clearing");
-        _globalListeners.forEach((listener) => listener.close());
-      }
-    }
-    const server = this.app;
-    this._mswServer = (0, import_node.setupServer)(
+  // registerHandlers is an alternative way to work with commercetools-mock, it
+  // allows you to manage msw server yourself and register the handlers needed
+  // for commercetools-mock to work.
+  registerHandlers(server) {
+    const app = this.app;
+    server.use(
       import_msw.http.post(`${this.options.authHost}/oauth/*`, async ({ request }) => {
         const body = await request.text();
         const url = new URL(request.url);
         const headers = copyHeaders(request.headers);
-        const res = await (0, import_light_my_request.default)(server).post(url.pathname + "?" + url.searchParams.toString()).body(body).headers(headers).end();
+        const res = await (0, import_light_my_request.default)(app).post(url.pathname + "?" + url.searchParams.toString()).body(body).headers(headers).end();
         return new import_msw.HttpResponse(res.body, {
           status: res.statusCode,
           headers: mapHeaderType(res.headers)
@@ -7017,7 +7012,7 @@ var CommercetoolsMock = class {
         const body = await request.text();
         const url = new URL(request.url);
         const headers = copyHeaders(request.headers);
-        const res = await (0, import_light_my_request.default)(server).get(url.pathname + "?" + url.searchParams.toString()).body(body).headers(headers).end();
+        const res = await (0, import_light_my_request.default)(app).get(url.pathname + "?" + url.searchParams.toString()).body(body).headers(headers).end();
         if (res.statusCode === 200) {
           const parsedBody = JSON.parse(res.body);
           const resultCount = "count" in parsedBody ? parsedBody.count : Object.keys(parsedBody).length;
@@ -7035,7 +7030,7 @@ var CommercetoolsMock = class {
         const body = await request.text();
         const url = new URL(request.url);
         const headers = copyHeaders(request.headers);
-        const res = await (0, import_light_my_request.default)(server).get(url.pathname + "?" + url.searchParams.toString()).body(body).headers(headers).end();
+        const res = await (0, import_light_my_request.default)(app).get(url.pathname + "?" + url.searchParams.toString()).body(body).headers(headers).end();
         return new import_msw.HttpResponse(res.body, {
           status: res.statusCode,
           headers: mapHeaderType(res.headers)
@@ -7045,7 +7040,7 @@ var CommercetoolsMock = class {
         const body = await request.text();
         const url = new URL(request.url);
         const headers = copyHeaders(request.headers);
-        const res = await (0, import_light_my_request.default)(server).post(url.pathname + "?" + url.searchParams.toString()).body(body).headers(headers).end();
+        const res = await (0, import_light_my_request.default)(app).post(url.pathname + "?" + url.searchParams.toString()).body(body).headers(headers).end();
         return new import_msw.HttpResponse(res.body, {
           status: res.statusCode,
           headers: mapHeaderType(res.headers)
@@ -7055,14 +7050,26 @@ var CommercetoolsMock = class {
         const body = await request.text();
         const url = new URL(request.url);
         const headers = copyHeaders(request.headers);
-        const res = await (0, import_light_my_request.default)(server).delete(url.pathname + "?" + url.searchParams.toString()).body(body).headers(headers).end();
+        const res = await (0, import_light_my_request.default)(app).delete(url.pathname + "?" + url.searchParams.toString()).body(body).headers(headers).end();
         return new import_msw.HttpResponse(res.body, {
           status: res.statusCode,
           headers: mapHeaderType(res.headers)
         });
       })
     );
-    this._mswServer.listen({
+  }
+  startServer() {
+    if (_globalListeners.length > 0) {
+      if (this._mswServer !== void 0) {
+        throw new Error("Server already started");
+      } else {
+        console.warn("Server wasn't stopped properly, clearing");
+        _globalListeners.forEach((listener) => listener.close());
+      }
+    }
+    const server = (0, import_node.setupServer)();
+    this.registerHandlers(server);
+    server.listen({
       // We need to allow requests done by supertest
       onUnhandledRequest: (request, print) => {
         const url = new URL(request.url);
@@ -7072,7 +7079,8 @@ var CommercetoolsMock = class {
         print.error();
       }
     });
-    _globalListeners.push(this._mswServer);
+    _globalListeners.push(server);
+    this._mswServer = server;
   }
 };
 // Annotate the CommonJS export names for ESM import in node: