@quatrain/messaging 1.0.9 → 1.0.11
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 +28 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# @quatrain/messaging
|
|
2
|
+
|
|
3
|
+
The unified messaging and notification abstraction for the Quatrain framework. This package provides an interface for sending transactional emails, SMS, push notifications, and in-app messages.
|
|
4
|
+
|
|
5
|
+
## Introduction
|
|
6
|
+
|
|
7
|
+
Modern applications need to reach users across various channels. The `@quatrain/messaging` package abstracts away the specific provider logic (Firebase Cloud Messaging, SendGrid, Twilio, etc.) behind a clean, unified API, allowing you to easily swap providers without rewriting your business logic.
|
|
8
|
+
|
|
9
|
+
## Key Concepts
|
|
10
|
+
|
|
11
|
+
- **`Messaging`**: The static registry where you configure messaging adapters.
|
|
12
|
+
- **`AbstractMessagingAdapter`**: The base class for defining channel-specific messaging implementations.
|
|
13
|
+
|
|
14
|
+
## Installation
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npm install @quatrain/messaging
|
|
18
|
+
# You will also need an adapter, e.g.:
|
|
19
|
+
npm install @quatrain/messaging-firebase
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Architecture
|
|
23
|
+
|
|
24
|
+
Just like other Quatrain abstractions, you register adapters for different messaging channels (e.g., 'email', 'push', 'sms') to the central registry.
|
|
25
|
+
|
|
26
|
+
## License
|
|
27
|
+
|
|
28
|
+
AGPL-3.0-only
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@quatrain/messaging",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.11",
|
|
4
4
|
"license": "AGPL-3.0-only",
|
|
5
5
|
"description": "Messaging adapters commons",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
],
|
|
15
15
|
"author": "Quatrain Développement SAS <developers@quatrain.com>",
|
|
16
16
|
"dependencies": {
|
|
17
|
-
"@quatrain/core": "^1.1.
|
|
17
|
+
"@quatrain/core": "^1.1.49",
|
|
18
18
|
"mustache": "^4.2.0"
|
|
19
19
|
},
|
|
20
20
|
"devDependencies": {
|