@sprucelabs/mercury-utils 60.25.1 → 60.25.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +68 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,3 +1,71 @@
|
|
|
1
1
|
<img src="./docs/images/hero.jpeg" />
|
|
2
2
|
|
|
3
|
+
# Mercury API
|
|
4
|
+
|
|
5
|
+
[](https://regressionproof.ai)
|
|
6
|
+
|
|
7
|
+
The backend API powering the Spruce Experience Platform. A real-time messaging and event coordination system built on Node.js.
|
|
8
|
+
|
|
9
|
+
## Features
|
|
10
|
+
|
|
11
|
+
### Event System
|
|
12
|
+
- Core event emission, listening, and dispatching
|
|
13
|
+
- Event contracts and validation
|
|
14
|
+
- Event-driven architecture with ingress controllers
|
|
15
|
+
|
|
16
|
+
### Real-time Communication
|
|
17
|
+
- Socket.io-based bidirectional communication
|
|
18
|
+
- Live updates between clients and API
|
|
19
|
+
|
|
20
|
+
### Messaging
|
|
21
|
+
- Multi-channel delivery (SMS, push notifications, email)
|
|
22
|
+
- Twilio SMS integration
|
|
23
|
+
- Firebase/APNs push notifications
|
|
24
|
+
- Email via Nodemailer
|
|
25
|
+
- Message queuing and templating
|
|
26
|
+
|
|
27
|
+
### Conversations
|
|
28
|
+
- Conversational state management
|
|
29
|
+
- Topic coordination
|
|
30
|
+
- LLM integration support
|
|
31
|
+
|
|
32
|
+
### Authentication & Authorization
|
|
33
|
+
- Phone-based auth with PIN verification
|
|
34
|
+
- JWT tokens
|
|
35
|
+
- Role-based permissions
|
|
36
|
+
- Organization-level access controls
|
|
37
|
+
|
|
38
|
+
### Data Management
|
|
39
|
+
- Multi-store architecture
|
|
40
|
+
- People, organizations, locations, skills, roles, permissions
|
|
41
|
+
- Message history
|
|
42
|
+
|
|
43
|
+
### Skill Management
|
|
44
|
+
- Register and install third-party skills
|
|
45
|
+
- Skill coordination framework
|
|
46
|
+
|
|
47
|
+
## Architecture
|
|
48
|
+
|
|
3
49
|
<img src="./docs/images/event-arch.jpeg" />
|
|
50
|
+
|
|
51
|
+
- Modular plugin-based system
|
|
52
|
+
- Server factory pattern
|
|
53
|
+
- Store-based data layer with pluggable backends
|
|
54
|
+
- Multi-mode bootstrapping
|
|
55
|
+
|
|
56
|
+
## Development
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
# Install dependencies
|
|
60
|
+
yarn
|
|
61
|
+
|
|
62
|
+
# Build
|
|
63
|
+
yarn build.dev
|
|
64
|
+
|
|
65
|
+
# Run tests
|
|
66
|
+
yarn test
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
## Documentation
|
|
70
|
+
|
|
71
|
+
For comprehensive documentation, visit [developer.spruce.bot](https://developer.spruce.bot).
|