@astralibx/email-rule-engine 12.7.0 → 12.7.1
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 +9 -9
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -103,18 +103,18 @@ The `createEmailRuleEngine(config)` factory accepts an `EmailRuleEngineConfig` o
|
|
|
103
103
|
| `hooks` | No | Callbacks at key execution points |
|
|
104
104
|
| `logger` | No | Logger with `info`, `warn`, `error` methods |
|
|
105
105
|
|
|
106
|
-
See [docs/configuration.md](https://github.com/Hariprakash1997/astralib/blob/main/packages/email
|
|
106
|
+
See [docs/configuration.md](https://github.com/Hariprakash1997/astralib/blob/main/packages/email/rule-engine/docs/configuration.md) for the full reference with examples.
|
|
107
107
|
|
|
108
108
|
## Getting Started Guide
|
|
109
109
|
|
|
110
|
-
1. [Configuration](https://github.com/Hariprakash1997/astralib/blob/main/packages/email
|
|
111
|
-
2. [Adapters](https://github.com/Hariprakash1997/astralib/blob/main/packages/email
|
|
112
|
-
3. [Templates](https://github.com/Hariprakash1997/astralib/blob/main/packages/email
|
|
113
|
-
4. [Rules](https://github.com/Hariprakash1997/astralib/blob/main/packages/email
|
|
114
|
-
5. [Execution Flow](https://github.com/Hariprakash1997/astralib/blob/main/packages/email
|
|
115
|
-
6. [Throttling](https://github.com/Hariprakash1997/astralib/blob/main/packages/email
|
|
110
|
+
1. [Configuration](https://github.com/Hariprakash1997/astralib/blob/main/packages/email/rule-engine/docs/configuration.md) — Set up database, Redis, and options
|
|
111
|
+
2. [Adapters](https://github.com/Hariprakash1997/astralib/blob/main/packages/email/rule-engine/docs/adapters.md) — Implement the 6 required adapter functions
|
|
112
|
+
3. [Templates](https://github.com/Hariprakash1997/astralib/blob/main/packages/email/rule-engine/docs/templates.md) — Create email templates with MJML + Handlebars
|
|
113
|
+
4. [Rules](https://github.com/Hariprakash1997/astralib/blob/main/packages/email/rule-engine/docs/rules.md) — Define targeting rules with conditions or explicit lists
|
|
114
|
+
5. [Execution Flow](https://github.com/Hariprakash1997/astralib/blob/main/packages/email/rule-engine/docs/execution-flow.md) — Understand how the runner processes rules
|
|
115
|
+
6. [Throttling](https://github.com/Hariprakash1997/astralib/blob/main/packages/email/rule-engine/docs/throttling.md) — Configure per-user send limits
|
|
116
116
|
|
|
117
|
-
Reference: [API Routes](https://github.com/Hariprakash1997/astralib/blob/main/packages/email
|
|
117
|
+
Reference: [API Routes](https://github.com/Hariprakash1997/astralib/blob/main/packages/email/rule-engine/docs/api-routes.md) | [Programmatic API](https://github.com/Hariprakash1997/astralib/blob/main/packages/email/rule-engine/docs/programmatic-api.md) | [Types](https://github.com/Hariprakash1997/astralib/blob/main/packages/email/rule-engine/docs/types.md) | [Constants](https://github.com/Hariprakash1997/astralib/blob/main/packages/email/rule-engine/docs/constants.md) | [Error Handling](https://github.com/Hariprakash1997/astralib/blob/main/packages/email/rule-engine/docs/error-handling.md)
|
|
118
118
|
|
|
119
119
|
### Redis Key Prefix (Required for Multi-Project Deployments)
|
|
120
120
|
|
|
@@ -136,7 +136,7 @@ const engine = createEmailRuleEngine({
|
|
|
136
136
|
|
|
137
137
|
**Always set a unique prefix** like `projectname:` when sharing Redis.
|
|
138
138
|
|
|
139
|
-
> **Important:** Configure throttle settings before running rules. Default limits (1/day, 2/week) may be too restrictive. See [Throttling](https://github.com/Hariprakash1997/astralib/blob/main/packages/email
|
|
139
|
+
> **Important:** Configure throttle settings before running rules. Default limits (1/day, 2/week) may be too restrictive. See [Throttling](https://github.com/Hariprakash1997/astralib/blob/main/packages/email/rule-engine/docs/throttling.md).
|
|
140
140
|
|
|
141
141
|
## License
|
|
142
142
|
|
package/package.json
CHANGED