@sprucelabs/mercury-utils
v60.25.9
Published
Support for working with Mercury. 📈
Downloads
10,809
Readme
Mercury API
The backend API powering the Spruce Experience Platform. A real-time messaging and event coordination system built on Node.js.
Features
Event System
- Core event emission, listening, and dispatching
- Event contracts and validation
- Event-driven architecture with ingress controllers
Real-time Communication
- Socket.io-based bidirectional communication
- Live updates between clients and API
Messaging
- Multi-channel delivery (SMS, push notifications, email)
- Twilio SMS integration
- Firebase/APNs push notifications
- Email via Nodemailer
- Message queuing and templating
Conversations
- Conversational state management
- Topic coordination
- LLM integration support
Authentication & Authorization
- Phone-based auth with PIN verification
- JWT tokens
- Role-based permissions
- Organization-level access controls
Data Management
- Multi-store architecture
- People, organizations, locations, skills, roles, permissions
- Message history
Skill Management
- Register and install third-party skills
- Skill coordination framework
Architecture
- Modular plugin-based system
- Server factory pattern
- Store-based data layer with pluggable backends
- Multi-mode bootstrapping
Development
# Install dependencies
yarn
# Build
yarn build.dev
# Run tests
yarn testDocumentation
For comprehensive documentation, visit developer.spruce.bot.
