How mrgreullr/medusa works
Medusa is a modular commerce platform: a customer or operator interacts with commerce APIs, which expose commerce operations backed by modules and workflow orchestration. The README describes broad use cases and customizable commerce building blocks; sampled source supports specific fulfillment, transaction-storage, and admin-route-generation relationships. Other subsystem connections are left unverified rather than inferred from names or directory structure.
Main entry points: api Commerce API · modules Commerce modules · route.ts Loyalty routes · distributed-transaction.ts Distributed transaction
Components 21
Commerce interfaces
- Commerce API
packages/medusa/src/api - Product routes
packages/medusa/src/api/store/products/route.ts - Search routes
packages/medusa/src/api/store/search/route.ts - Loyalty routes
packages/plugins/loyalty/src/api/admin/gift-cards/route.ts
Commerce capabilities
- Commerce modules
packages/modules - Fulfillment service
packages/modules/fulfillment/src/services/fulfillment-module-service.ts - Fulfillment provider
packages/modules/fulfillment/src/services/fulfillment-provider.ts - Search service
packages/modules/search/src/services/search-module-service.ts - Index storage contract
packages/core/types/src/index-data/storage-provider.ts - OIDC authentication
packages/modules/providers/auth-oidc/src/engine/engine.ts
Workflow runtime
- Gift card workflow
packages/plugins/loyalty/src/workflows/gift-cards/workflows/create-gift-cards.ts - Store credit workflow
packages/plugins/loyalty/src/workflows/store-credit/workflows/create-store-credit-accounts.ts - Transaction orchestrator
packages/core/orchestration/src/transaction/transaction-orchestrator.ts - Distributed transaction
packages/core/orchestration/src/transaction/distributed-transaction.ts - Transaction steps
packages/core/orchestration/src/transaction/transaction-step.ts - Transaction storage
packages/core/orchestration/src/transaction/datastore/abstract-storage.ts - In-memory workflow storage
packages/modules/workflow-engine-inmemory/src/utils/workflow-orchestrator-storage.ts
Admin experience
- Admin dashboard
packages/admin/dashboard/src/app.tsx - Admin route generation
packages/admin/admin-vite-plugin/src/routes/generate-routes.ts - Admin source parser
packages/admin/admin-vite-plugin/src/babel.ts
Other components
- Shopper or operator
Connections 20
- Shopper or operator → Commerce API: sends requests
- Commerce API → Product routes: routes requests
- Commerce API → Search routes: routes requests
- Commerce API → Loyalty routes: exposes extensions
- Commerce API → Commerce modules: uses commerce logic
- Commerce modules → Fulfillment service: includes fulfillment
packages/modules/fulfillment/src/services/fulfillment-module-service.ts - Fulfillment service → Fulfillment provider: calls provider
packages/modules/fulfillment/src/services/fulfillment-module-service.ts - Commerce modules → Search service: includes search
- Search service → Index storage contract: uses storage contract
- Loyalty routes → Gift card workflow: invokes workflow
packages/plugins/loyalty/src/api/admin/gift-cards/route.ts - Loyalty routes → Store credit workflow: invokes workflow
- Commerce modules → Transaction orchestrator: supports workflows
- Transaction orchestrator → Distributed transaction: coordinates execution
packages/core/orchestration/src/transaction/distributed-transaction.ts - Distributed transaction → Transaction steps: executes steps
packages/core/orchestration/src/transaction/distributed-transaction.ts - Distributed transaction → Transaction storage: persists checkpoints
packages/core/orchestration/src/transaction/distributed-transaction.ts - In-memory workflow storage → Transaction storage: implements storage contract
- Commerce modules → OIDC authentication: offers authentication
packages/modules/providers/auth-oidc/src/engine/engine.ts - Shopper or operator → Admin dashboard: manages commerce
- Admin dashboard → Commerce API: manages via API
- Admin route generation → Admin source parser: parses routes
packages/admin/admin-vite-plugin/src/routes/generate-routes.ts