feat: add new platform api package #357
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a new SDK package dedicated to the Spree platform api.
Platform SDK docs.
The monorepo directory structure (packages/) looks like this:
The npm packages names look like this:
sdk-core
The platform sdk in huge part uses the same helper functions, error handlers and interfaces as the storefront sdk. In order to avoid code redundancy, all the common parts have been extracted to the sdk-core package. It is configured as a local dependency that doesn't have to be published to npm meaning that storefront and platform sdks include it in their build bundles.
Example
Before:
With the sdk-core package:
sdk-platform
Below is a checklist of completed endpoints: