valantic / spartacus-mock

This project offers you the possibility, to mock the OCC Endpoints of your Composable Storefront (Spartacus). It uses the Mock Service Worker to mock the API calls.

SpartacusMock

This project offers you the possibility, to mock the API (OCC) Endpoints of your Composable-Storefront (Spartacus). It uses the Mock Service Worker (MSW) library to mock the API calls.

Developer Documentation

The developer documentation can be found here.

GitHub issues

If you encounter a problem with this library or if you have a new feature you'd like to see in this project, please create a new issue.

Contribution Guidelines

The contribution guidelines can be found here.

spartacus-mock's Issues

Enhance docs to show how url path / get params can be defined in routes and read in handlers

Add option to use it with an existing Project

For existing Projects, it would be good, if only certain Endpoints could be mocked and the rest will be taken from a local hybris / dev endpoint.

Add logic and enhance docs for that case

Update faker.js to 8.x

Improve config around whitelist mode / example data

Add unit tests for mock-server

New Features with MSW 2.0

Check the following new features with MSW 2.0:

1. worker.start option quiet: true to disable all logging, https://mswjs.io/docs/api/setup-worker/start#quiet => #62
2. scenarios to test success & error case, https://mswjs.io/docs/best-practices/dynamic-mock-scenarios
3. check if network behavior overrides can / should be used, https://mswjs.io/docs/best-practices/network-behavior-overrides
4. check if mock sync methods should be used, https://mswjs.io/docs/recipes/keeping-mocks-in-sync
5. check if conditional import can be improved, https://mswjs.io/docs/integrations/browser#conditionally-enable-mocking => done

Update Node Version to 18.x and Spartacus to 6.4 and MSW to 1.3.1

Add Handling for Translations (without needing to override the handler)

Publish initial Version to NPM

Enhance docs with hint, that prettierignore should contain src/mockServiceWorker.js

Add typings for default routes

blocked by SAP/spartacus#17442

Make Add To Cart work (again)

Add remaing open Cart Mock Functionality

Remaining open cart functions:

• Save Cart for Later
• Export Cart
• Import Products
• Quick Order

Enhance docs to show all existing createXxx methods

Update to Angular 17 and Spartacus 2211.19

Enhance docs for the "non SSR" rendering case of the main.ts

Enhance docs with all usable default routes contained in spartacus-mock

Create Spartacus Ticket to export the defaultOccConfigs

done, see SAP/spartacus#17442

Add compatibility for Angular 15 / Spartacus 6.1

Add Mock Data for Search / Category Pages

Finalize initial usage documentation

Improve Usage Workflow

Try to improve the usage workflow by

• Not needing to install msw in the actual spartacus Project
• Not needing to call mws save initially
• Add enhancements to angular.json automatically
• Add enhancements to main.ts automatically

Enhance docs to show a list of all ootb mocked features

Add Mock Data for Checkout Pages

Add quiet option

Not really a issue but more of a question.

Hi guys, I'm working in a project now using the Sparatacus, I found this library and I thought was promising but I was not able to get working yet, following the documentation but when I add the library to the project but not all the files listed that would change after that did not change I got the angular.json modified and the mockServiceworker.js only is that ok ? One more question is when I want to use one of the handles and mock data OOTB made by you guys, there is a service class or something to me point to in my feature to know that rather make the original request to the server then call the mock. The last thing I noticed even after added MockConfig on my main.ts I still not getting the [MSW] Mocking enabled when I'm running the spartacus project. Thank you so much.

Add HTTP Error Case Overring Possibility via In Browser Admin Panel (from Michael)

Add Mock Data for Storefinder

Add unit-tests for schematics

Adjust docs structure to be prepared to use a documentation tool

Enhance docs to show how to use it with HTTPS

Check if default slots can be overridden

Enhance docs to describe the options of the mock server

Add Mock Data for Product Detail Page

Improve installation docs, add boilerplate schematics

Update MSW to Version 2.x

Add Mock Data for My Account Pages

Add Mock Data for Wishlist / Save Cart / Import & Export Cart

Find a solution to improve the Dev Workflow (changes to the lib require npm link again)

Add Mock Handler for Order Return Feature

Create a "per Handler" / "per Route" Fallback to the Default Data when using custom Data

ToDo:

• Check if it's enough to define the custom handlers before the default handlers for a certain route
• Brainstorm and define the logic / process for dev's to define custom handlers for the existing default routes
• Enhance the docs to explain how it works
• Adjust the code if needed