MyParcel JS Plugin Development Kit
The MyParcel PDK (Plugin Development Kit) is meant for developing entire plugins on E-Commerce platforms. If you're just looking to connect to our API without creating an entire plugin, you should check out our php [SDK].
Requirements
Documentation
For examples, guides and in-depth information, visit our [Plugin Development Kit (PDK) documentation].
Support
Create an issue or contact us via our [Developer Portal contact page].
Contributing
View our [contribution guidelines] for information on how to contribute to the PDK.
Prerequisites
- Node.js 24, version 24.21 or later
- pnpm 12, version 12.11 or later
- Docker
- No Volta on your machine. Its
yarn does not go through corepack, so the packageManager field in package.json
does not stop it.
Targets
The nx targets clean, lint, lint:fix, test, test:coverage, test:run and test:update have one command each,
in targetDefaults in nx.json. A package lists the targets it uses under nx.targets in its package.json. Run a
target from the repository root, for one package or through a root script:
pnpm nx test:run @myparcel-dev/pdk-common
pnpm test:run
The root scripts run a target for every package, except lint and lint:fix. These run only for the packages that
changed (nx affected).
build and typecheck stay as scripts in each package.json, because their command differs per package.
Releases
nx release versions and tags the packages from conventional commits, and the release workflow publishes them with
pnpm -r publish. Packages that share a version form a group under release.groups in nx.json. Add a new published
package to a group, or it is not released.
Packages
This project contains multiple npm packages. Install them with npm, yarn or pnpm.
Backend
@myparcel-pdk/admin
This is the main package for the admin interface. It's able to
@myparcel-pdk/admin-preset-default
This package contains default components for @myparcel-pdk/admin.
@myparcel-pdk/admin-preset-bootstrap4
This package contains components for @myparcel-pdk/admin that use the Bootstrap 4 CSS framework.
@myparcel-pdk/admin-preset-dashicons
This package contains components for @myparcel-pdk/admin that use the Dashicons icon library.
@myparcel-pdk/admin-preset-fontawesome
This package contains components for @myparcel-pdk/admin that use the Font Awesome icon library.
@myparcel-pdk/admin-component-tests
If you're making your own components for @myparcel-pdk/admin, you can use this package to test them.
@myparcel-pdk/app-builder
This is a CLI tool to build an app using @myparcel-pdk/admin.
Frontend
@myparcel-pdk/checkout
This is the main package for the checkout and is meant to work with MyParcel Delivery Options package.
Contributing
See the Developer Guide for contributing to MyParcel repositories.
