mailery 0.1.1 → 0.2.0

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.
Files changed (21) hide show
  1. package/README.md +4 -4
  2. package/dist/admin/spa/{index-DnPQRmZe.js → index-DlhleV6M.js} +2 -2
  3. package/dist/admin/spa/{index-DnPQRmZe.js.map → index-DlhleV6M.js.map} +1 -1
  4. package/dist/admin/spa/index.html +1 -1
  5. package/dist/admin/spa/{template-editor-DFGyqPn3.js → template-editor-DUZfzI5F.js} +65 -65
  6. package/dist/admin/spa/{template-editor-DFGyqPn3.js.map → template-editor-DUZfzI5F.js.map} +1 -1
  7. package/dist/index.cjs +348 -131
  8. package/dist/index.cjs.map +1 -1
  9. package/dist/index.d.cts +59 -5
  10. package/dist/index.d.ts +59 -5
  11. package/dist/index.js +342 -132
  12. package/dist/index.js.map +1 -1
  13. package/dist/{null-sygex0Ru.d.cts → null-CWw3Gpbl.d.cts} +66 -44
  14. package/dist/{null-sygex0Ru.d.ts → null-CWw3Gpbl.d.ts} +66 -44
  15. package/dist/testing.cjs +346 -136
  16. package/dist/testing.cjs.map +1 -1
  17. package/dist/testing.d.cts +3 -3
  18. package/dist/testing.d.ts +3 -3
  19. package/dist/testing.js +346 -136
  20. package/dist/testing.js.map +1 -1
  21. package/package.json +33 -4
package/README.md CHANGED
@@ -14,7 +14,7 @@ yarn add mailery
14
14
  npm install mailery
15
15
  ```
16
16
 
17
- Peer-dependencies (host-provided): `express ^4 || ^5`. Runtime deps brought in by mailery: `mongodb`, `bullmq`, `ioredis`, `mjml`, `handlebars`, `@sendgrid/mail`, `zod`.
17
+ Peer dependencies (host-provided): `express ^4 || ^5` plus one queue driver — either `bullmq` + `ioredis` (default) or `agenda` + `@agendajs/mongo-backend` + `bottleneck`. Runtime deps brought in by mailery: `mongodb`, `mjml`, `handlebars`, `@sendgrid/mail`, `zod`.
18
18
 
19
19
  ## Quickstart
20
20
 
@@ -44,7 +44,7 @@ const adapter = new MongoContactAdapter({
44
44
  const mailer = await Mailer.init({
45
45
  db,
46
46
  adapter,
47
- redis: { url: process.env.REDIS_URL! },
47
+ queue: { driver: 'bull', redis: { url: process.env.REDIS_URL! } },
48
48
  providers: {
49
49
  sendgrid: new SendGridProvider({
50
50
  apiKey: process.env.SENDGRID_API_KEY!,
@@ -73,7 +73,7 @@ Run a separate worker process for queue jobs:
73
73
 
74
74
  ```ts
75
75
  const mailer = await Mailer.init({ /* same config */ })
76
- await mailer.startWorkers() // BullMQ consumers
76
+ await mailer.startWorkers() // queue consumers (Bull or Agenda, per your queue.driver)
77
77
  ```
78
78
 
79
79
  See [`examples/express-mongo/`](./examples/express-mongo) for a complete working example.
@@ -85,7 +85,7 @@ A self-hosted library you `npm install` into your Express + MongoDB app. Fire ev
85
85
  - **Embedded, not external.** No third-party sync, no per-contact pricing.
86
86
  - **Both transactional and marketing in one engine.** Right defaults per kind (suppression scope, sender identity, circuit-breaker behavior).
87
87
  - **Provider-agnostic.** SendGrid + NullProvider ship; Postmark / SES / Resend pluggable.
88
- - **BullMQ + Redis** for queue + delayed-job scheduling.
88
+ - **Pluggable queue** — BullMQ + Redis (default) or Agenda + Mongo (no Redis required).
89
89
  - **MJML** templates with click + open tracking, plain-text auto-derivation, scope-aware suppression at send time.
90
90
  - **React admin SPA** (Vite-bundled, served as static assets — no build step in your app).
91
91