opscms-ecommerce-plugin
v1.11.0
Published
Storefront commerce for an OpsCMS platform: catalogue, cart, orders, customers, discounts, checkout and payments settlement, with customer retention.
Maintainers
Readme
opscms-ecommerce-plugin
Storefront commerce for an OpsCMS platform, built with opscms-sdk: what a shop needs behind its storefront.
- Customers with sign-in (register, verify email, forgot and reset password, update), catalogue (
catalogue-categories,catalogue-items), orders, promotions, discounts and their reservations (redeem, release, commit), saved carts and cart events. - Payments settlement. The order, the ledger (
payment-transactions), the payment endpoints (/api/payments/*) and the settlement live here; a payment plugin (Paystack, Monnify, OPay, …) only says how to talk to its service and keeps its own keys in its own table. Install at least one. - Customer retention and consent: five events (Welcome, Cart, Checkout, Win-back, Post-purchase), each on or off per shop; nothing is sent to a customer
who has not agreed, and every message carries a link to stop them (
POST /api/marketing-consent). - Jobs: abandoned-cart recovery, post-delivery review requests, payment reconciliation and the retention sweep.
Social Login extends customers, so it is registered after this plugin.
Install
From the admin: Plugins → Install from npm → opscms-ecommerce-plugin. The platform creates the plugin's tables (its one migration), lists the plugin with its
logo, and restarts to start it. Removing the plugin drops its tables and everything in them: customers, orders, the catalogue. The admin asks which to do.
The platform currently carries this plugin in its own code under the same key; install the package only after that copy has been removed.
Needs
payload ^3 and opscms-sdk ^0.1.9 (the platform provides both). bcryptjs is its own dependency.
Tests
tests/ holds them. They run against a stand-in for the platform (tests/support/fakePlatform.ts) and an in-memory Payload, so no database is needed:
npm install
npm run typecheck && npm test && npm run build && npm pack --dry-run