mailery 0.0.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.
- package/LICENSE +21 -0
- package/README.md +29 -0
- package/dist/admin/static/.gitkeep +0 -0
- package/dist/admin/views/.gitkeep +0 -0
- package/dist/index.cjs +8 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +3 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +6 -0
- package/dist/index.js.map +1 -0
- package/dist/testing.cjs +8 -0
- package/dist/testing.cjs.map +1 -0
- package/dist/testing.d.cts +3 -0
- package/dist/testing.d.ts +3 -0
- package/dist/testing.js +6 -0
- package/dist/testing.js.map +1 -0
- package/package.json +74 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Jeff Jassky
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# mailery
|
|
2
|
+
|
|
3
|
+
> Embedded, MongoDB-backed email automation for Node.js. Triggered flows, broadcasts, tracking, suppression, compliance, and an admin UI you mount inside your Express app.
|
|
4
|
+
|
|
5
|
+
**Status:** design spec only. No code yet. See [`plans/`](./plans/) for the full design.
|
|
6
|
+
|
|
7
|
+
## What it is
|
|
8
|
+
|
|
9
|
+
A self-hosted library you `npm install` into your Express + MongoDB app. Fire events from your code, define flows + templates as documents in MongoDB, mount the admin UI on a route you gate with your existing auth.
|
|
10
|
+
|
|
11
|
+
- **Embedded, not external.** No third-party sync, no per-contact pricing.
|
|
12
|
+
- **Both transactional and marketing in one engine.** Password resets, receipts, drips, newsletters — same pipeline, right defaults per kind.
|
|
13
|
+
- **Provider-agnostic.** SendGrid first; Postmark, SES, Resend pluggable.
|
|
14
|
+
- **BullMQ + Redis** for queue + delayed-job scheduling.
|
|
15
|
+
- **MJML** templates with a WYSIWYG editor (Maily) in the admin UI.
|
|
16
|
+
|
|
17
|
+
## Docs
|
|
18
|
+
|
|
19
|
+
Design spec: [`plans/`](./plans/) — start with [`plans/README.md`](./plans/README.md).
|
|
20
|
+
|
|
21
|
+
Published docs (once shipped): <https://jeffjassky.github.io/mailery/>
|
|
22
|
+
|
|
23
|
+
## Status & roadmap
|
|
24
|
+
|
|
25
|
+
See [`plans/13-roadmap.md`](./plans/13-roadmap.md).
|
|
26
|
+
|
|
27
|
+
## License
|
|
28
|
+
|
|
29
|
+
[MIT](./LICENSE) © Jeff Jassky
|
|
File without changes
|
|
File without changes
|
package/dist/index.cjs
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";;;AAAO,IAAM,OAAA,GAAU","file":"index.cjs","sourcesContent":["export const VERSION = '0.0.0'\n\n// Public API surface lives here once implemented. See plans/10-public-api.md.\n// Phase 0 will export:\n// - Mailer (class)\n// - MongoContactAdapter\n// - SendGridProvider\n// - types: Contact, ContactAdapter, MailProvider, FlowStep, Predicate, SegmentDefinition\n"]}
|
package/dist/index.d.cts
ADDED
package/dist/index.d.ts
ADDED
package/dist/index.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";AAAO,IAAM,OAAA,GAAU","file":"index.js","sourcesContent":["export const VERSION = '0.0.0'\n\n// Public API surface lives here once implemented. See plans/10-public-api.md.\n// Phase 0 will export:\n// - Mailer (class)\n// - MongoContactAdapter\n// - SendGridProvider\n// - types: Contact, ContactAdapter, MailProvider, FlowStep, Predicate, SegmentDefinition\n"]}
|
package/dist/testing.cjs
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/testing/index.ts"],"names":[],"mappings":";;;AAMO,IAAM,mBAAA,GAAsB","file":"testing.cjs","sourcesContent":["// Test helpers — imported by host apps as `mailery/testing`.\n// Phase 0 will export:\n// - createTestMailer({ ... }) → { mailer, db, redis, provider, adapter }\n// - NullProvider\n// - MemoryContactAdapter\n\nexport const TESTING_PLACEHOLDER = true\n"]}
|
package/dist/testing.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/testing/index.ts"],"names":[],"mappings":";AAMO,IAAM,mBAAA,GAAsB","file":"testing.js","sourcesContent":["// Test helpers — imported by host apps as `mailery/testing`.\n// Phase 0 will export:\n// - createTestMailer({ ... }) → { mailer, db, redis, provider, adapter }\n// - NullProvider\n// - MemoryContactAdapter\n\nexport const TESTING_PLACEHOLDER = true\n"]}
|
package/package.json
ADDED
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "mailery",
|
|
3
|
+
"version": "0.0.0",
|
|
4
|
+
"description": "Embedded, MongoDB-backed email automation for Node.js. Triggered flows, broadcasts, tracking, suppression, and an admin UI you mount inside your Express app.",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"author": "Jeff Jassky <jeff@jeffjassky.com>",
|
|
7
|
+
"homepage": "https://jeffjassky.github.io/mailery/",
|
|
8
|
+
"repository": {
|
|
9
|
+
"type": "git",
|
|
10
|
+
"url": "git+https://github.com/JeffJassky/mailery.git"
|
|
11
|
+
},
|
|
12
|
+
"bugs": {
|
|
13
|
+
"url": "https://github.com/JeffJassky/mailery/issues"
|
|
14
|
+
},
|
|
15
|
+
"keywords": [
|
|
16
|
+
"email",
|
|
17
|
+
"automation",
|
|
18
|
+
"drip",
|
|
19
|
+
"newsletter",
|
|
20
|
+
"mongodb",
|
|
21
|
+
"express",
|
|
22
|
+
"self-hosted",
|
|
23
|
+
"transactional",
|
|
24
|
+
"mailerlite-alternative"
|
|
25
|
+
],
|
|
26
|
+
"type": "module",
|
|
27
|
+
"main": "./dist/index.cjs",
|
|
28
|
+
"module": "./dist/index.js",
|
|
29
|
+
"types": "./dist/index.d.ts",
|
|
30
|
+
"exports": {
|
|
31
|
+
".": {
|
|
32
|
+
"types": "./dist/index.d.ts",
|
|
33
|
+
"import": "./dist/index.js",
|
|
34
|
+
"require": "./dist/index.cjs"
|
|
35
|
+
},
|
|
36
|
+
"./testing": {
|
|
37
|
+
"types": "./dist/testing.d.ts",
|
|
38
|
+
"import": "./dist/testing.js",
|
|
39
|
+
"require": "./dist/testing.cjs"
|
|
40
|
+
},
|
|
41
|
+
"./package.json": "./package.json"
|
|
42
|
+
},
|
|
43
|
+
"files": [
|
|
44
|
+
"dist",
|
|
45
|
+
"README.md",
|
|
46
|
+
"LICENSE"
|
|
47
|
+
],
|
|
48
|
+
"engines": {
|
|
49
|
+
"node": ">=20"
|
|
50
|
+
},
|
|
51
|
+
"scripts": {
|
|
52
|
+
"build": "tsup && yarn build:assets",
|
|
53
|
+
"build:assets": "mkdir -p dist/admin && cp -R src/admin/views dist/admin/views && cp -R src/admin/static dist/admin/static",
|
|
54
|
+
"dev": "tsup --watch",
|
|
55
|
+
"test": "vitest run",
|
|
56
|
+
"test:watch": "vitest",
|
|
57
|
+
"typecheck": "tsc --noEmit",
|
|
58
|
+
"clean": "rm -rf dist coverage",
|
|
59
|
+
"prepublishOnly": "yarn clean && yarn typecheck && yarn test && yarn build",
|
|
60
|
+
"docs:dev": "vitepress dev docs",
|
|
61
|
+
"docs:build": "vitepress build docs",
|
|
62
|
+
"docs:preview": "vitepress preview docs"
|
|
63
|
+
},
|
|
64
|
+
"devDependencies": {
|
|
65
|
+
"@types/node": "^22.7.0",
|
|
66
|
+
"tsup": "^8.3.0",
|
|
67
|
+
"typescript": "^5.6.0",
|
|
68
|
+
"vitepress": "^1.4.0",
|
|
69
|
+
"vitest": "^2.1.0"
|
|
70
|
+
},
|
|
71
|
+
"publishConfig": {
|
|
72
|
+
"access": "public"
|
|
73
|
+
}
|
|
74
|
+
}
|