Package catalog
The @withpotter/* packages, grouped by the tier band that first
entitles them. Tiers are cumulative: growth includes everything in basic,
and enterprise includes everything.
The authoritative tier → package mapping lives in the control plane’s
tier-manifest.ts. The activation token’s pkgs claim is the
dependency-closed expansion of these leaves. The exhaustive route reference
for any installed package is the engine’s OpenAPI document.
Foundation — every tier
Installed in every box regardless of tier; the shared substrate everything else builds on.
| Package | Purpose |
|---|---|
@withpotter/box-core | Core box runtime primitives and bootstrapping. |
@withpotter/shared | Shared DI port tokens, contracts, and utilities. |
@withpotter/sequelize-adapters | Sequelize integration and base model/repository adapters. |
@withpotter/tenant-core | Tenant model, resolution, and multi-tenant scoping. |
@withpotter/auth-core | Authentication, sessions, and the engine auth guard. |
@withpotter/onboarding | Merchant and box onboarding flows. |
@withpotter/behaviors | Cross-cutting behavior hooks and policies. |
@withpotter/commerce | Shared commerce primitives (money, pricing, common types). |
@withpotter/template | Storefront template definitions and render contracts. |
@withpotter/page | CMS-style page model for storefronts. |
@withpotter/domain | Custom domain management. |
@withpotter/media | Media assets and uploads. |
Basic — and up
The core commerce surface: selling products, taking orders, and getting paid.
| Package | Purpose |
|---|---|
@withpotter/product | Product catalog, variants, and inventory. |
@withpotter/order | Orders and order lifecycle. |
@withpotter/cart | Shopping cart and cart sessions. |
@withpotter/payments | Payment provider port and payment orchestration. |
@withpotter/paystack | Paystack payment provider implementation. |
@withpotter/transaction | Financial transaction ledger. |
@withpotter/settlement | Merchant settlement and payout banking. |
@withpotter/shipping | Shipping methods, rates, and fulfillment. |
@withpotter/discount | Discounts and promotions. |
@withpotter/giftcard | Gift cards. |
@withpotter/gallery | Product and media galleries. |
@withpotter/wishlist | Customer wishlists. |
@withpotter/digital-file | Digital product file delivery. |
@withpotter/members | Storefront member accounts. |
@withpotter/invoice | Invoicing and invoice payments. |
@withpotter/analytics | Storefront and commerce analytics. |
@withpotter/review | Product reviews and ratings. |
@withpotter/booking | Appointment and service booking. |
@withpotter/calendar-sync | External calendar synchronization for bookings. |
Growth — and up
Retention, content, and marketing capabilities layered on top of core commerce.
| Package | Purpose |
|---|---|
@withpotter/membership | Paid membership tiers. |
@withpotter/plan | Subscription and membership plan definitions. |
@withpotter/subscriptions | Recurring subscriptions and billing. |
@withpotter/loyalty | Loyalty points and rewards. |
@withpotter/customer-segment | Customer segmentation. |
@withpotter/content | Rich content management. |
@withpotter/blog | Blog and articles. |
@withpotter/venue | Venue management. |
@withpotter/location | Physical locations and branches. |
@withpotter/waitlist | Product and event waitlists. |
@withpotter/inquiry | Customer inquiries and contact. |
@withpotter/feedback | Customer feedback collection. |
@withpotter/communication | Messaging and notification channels. |
@withpotter/campaign | Marketing campaigns. |
@withpotter/automation | Workflow automation. |
@withpotter/invitations | User and team invitations. |
@withpotter/invite-code | Invite-code redemption. |
@withpotter/bio-page-event | Link-in-bio page events. |
Enterprise & platform infrastructure
Entitled at the top tier (and used by the platform itself).
| Package | Purpose |
|---|---|
@withpotter/team | Staff and team management with roles. |
@withpotter/platform-analytics | Cross-tenant platform analytics. |
@withpotter/device-session | Device and session tracking. |
Exact tier placement for a given package is defined by tier-manifest.ts and
may shift as the manifest evolves. Treat the activation response’s packages
array as the source of truth for what a specific license entitles.