@lunora/mail 0.0.0 → 1.0.0-alpha.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.
Files changed (26) hide show
  1. package/LICENSE.md +105 -0
  2. package/README.md +117 -9
  3. package/__assets__/package-og.svg +14 -0
  4. package/dist/inbound/index.d.mts +207 -0
  5. package/dist/inbound/index.d.ts +207 -0
  6. package/dist/inbound/index.mjs +2 -0
  7. package/dist/index.d.mts +126 -0
  8. package/dist/index.d.ts +126 -0
  9. package/dist/index.mjs +7 -0
  10. package/dist/packem_shared/address-fkXxLKza.mjs +62 -0
  11. package/dist/packem_shared/capture-transport.d-ChnhdPO2.d.mts +117 -0
  12. package/dist/packem_shared/capture-transport.d-ChnhdPO2.d.ts +117 -0
  13. package/dist/packem_shared/createCaptureSink-CNhqLMZ1.mjs +61 -0
  14. package/dist/packem_shared/createCaptureTransport-Crz_8822.mjs +11 -0
  15. package/dist/packem_shared/createCloudflareTransport-yHOVEsZv.mjs +26 -0
  16. package/dist/packem_shared/createInboundEmailHandler-Cd8dyzB7.mjs +80 -0
  17. package/dist/packem_shared/createMailer-CMVVTp0F.mjs +77 -0
  18. package/dist/packem_shared/createResendTransport-oNIorpzv.mjs +16 -0
  19. package/dist/packem_shared/parseInboundEmail-Bw9u_1oc.mjs +72 -0
  20. package/dist/packem_shared/provider-transport-C5CVbjRF.mjs +47 -0
  21. package/dist/packem_shared/renderEmail-hyS1bpVP.mjs +8 -0
  22. package/dist/packem_shared/toQueuedPayload-BEKOdaxU.mjs +75 -0
  23. package/dist/testing.d.mts +49 -0
  24. package/dist/testing.d.ts +49 -0
  25. package/dist/testing.mjs +57 -0
  26. package/package.json +58 -17
package/LICENSE.md ADDED
@@ -0,0 +1,105 @@
1
+ # Functional Source License, Version 1.1, Apache 2.0 Future License
2
+
3
+ ## Abbreviation
4
+
5
+ FSL-1.1-Apache-2.0
6
+
7
+ ## Notice
8
+
9
+ Copyright 2026 anolilab and contributors
10
+
11
+ ## Terms and Conditions
12
+
13
+ ### Licensor ("We")
14
+
15
+ The party offering the Software under these Terms and Conditions.
16
+
17
+ ### The Software
18
+
19
+ The "Software" is each version of the software that we make available under
20
+ these Terms and Conditions, as indicated by our inclusion of these Terms and
21
+ Conditions with the Software.
22
+
23
+ ### License Grant
24
+
25
+ Subject to your compliance with this License Grant and the Patents,
26
+ Redistribution and Trademark clauses below, we hereby grant you the right to
27
+ use, copy, modify, create derivative works, publicly perform, publicly display
28
+ and redistribute the Software for any Permitted Purpose identified below.
29
+
30
+ ### Permitted Purpose
31
+
32
+ A Permitted Purpose is any purpose other than a Competing Use. A Competing Use
33
+ means making the Software available to others in a commercial product or service
34
+ that:
35
+
36
+ 1. substitutes for the Software;
37
+
38
+ 2. substitutes for any other product or service we offer using the Software that
39
+ exists as of the date we make the Software available; or
40
+
41
+ 3. offers the same or substantially similar functionality as the Software.
42
+
43
+ Permitted Purposes specifically include using the Software:
44
+
45
+ 1. for your internal use and access;
46
+
47
+ 2. for non-commercial education;
48
+
49
+ 3. for non-commercial research; and
50
+
51
+ 4. in connection with professional services that you provide to a licensee using
52
+ the Software in accordance with these Terms and Conditions.
53
+
54
+ ### Patents
55
+
56
+ To the extent your use for a Permitted Purpose would necessarily infringe our
57
+ patents, the license grant above includes a license under our patents. If you
58
+ make a claim against any party that the Software infringes or contributes to the
59
+ infringement of any patent, then your patent license to the Software ends
60
+ immediately.
61
+
62
+ ### Redistribution
63
+
64
+ The Terms and Conditions apply to all copies, modifications and derivatives of
65
+ the Software.
66
+
67
+ If you redistribute any copies, modifications or derivatives of the Software,
68
+ you must include a copy of or a link to these Terms and Conditions and not
69
+ remove any copyright notices provided in or with the Software.
70
+
71
+ ### Disclaimer
72
+
73
+ THE SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR
74
+ IMPLIED, INCLUDING WITHOUT LIMITATION WARRANTIES OF FITNESS FOR A PARTICULAR
75
+ PURPOSE, MERCHANTABILITY, TITLE OR NON-INFRINGEMENT.
76
+
77
+ IN NO EVENT WILL WE HAVE ANY LIABILITY TO YOU ARISING OUT OF OR RELATED TO THE
78
+ SOFTWARE, INCLUDING INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES, EVEN
79
+ IF WE HAVE BEEN INFORMED OF THEIR POSSIBILITY IN ADVANCE.
80
+
81
+ ### Trademarks
82
+
83
+ Except for displaying the License Details and identifying us as the origin of
84
+ the Software, you have no right under these Terms and Conditions to use our
85
+ trademarks, trade names, service marks or product names.
86
+
87
+ ## Grant of Future License
88
+
89
+ We hereby irrevocably grant you an additional license to use the Software under
90
+ the Apache License, Version 2.0 that is effective on the second anniversary of
91
+ the date we make the Software available. On or after that date, you may use the
92
+ Software under the Apache License, Version 2.0, in which case the following will
93
+ apply:
94
+
95
+ Licensed under the Apache License, Version 2.0 (the "License"); you may not use
96
+ this file except in compliance with the License.
97
+
98
+ You may obtain a copy of the License at
99
+
100
+ http://www.apache.org/licenses/LICENSE-2.0
101
+
102
+ Unless required by applicable law or agreed to in writing, software distributed
103
+ under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
104
+ CONDITIONS OF ANY KIND, either express or implied. See the License for the
105
+ specific language governing permissions and limitations under the License.
package/README.md CHANGED
@@ -1,18 +1,126 @@
1
- # @lunora/mail
1
+ <!-- START_PACKAGE_OG_IMAGE_PLACEHOLDER -->
2
2
 
3
- > ⚠️ **Placeholder release.** This package name is reserved for the [Lunora](https://lunora.sh) framework. The real `1.0.0-alpha` release is coming soon.
3
+ <a href="https://www.anolilab.com/open-source" align="center">
4
4
 
5
- Email for Lunora: Resend adapter, TSX templates, and queue-backed sends
5
+ <img src="__assets__/package-og.svg" alt="mail" />
6
6
 
7
- Lunora is a type-safe, real-time backend framework for Cloudflare Workers + Durable Objects with a Vite-first developer experience.
7
+ </a>
8
8
 
9
- - Website: https://lunora.sh
10
- - Repository: https://github.com/anolilab/lunora
9
+ <h3 align="center">Email for Lunora: Resend adapter, TSX templates, and queue-backed sends</h3>
11
10
 
12
- ## Status
11
+ <!-- END_PACKAGE_OG_IMAGE_PLACEHOLDER -->
13
12
 
14
- This is a `0.0.0` placeholder to reserve the npm name. Do not depend on it yet — APIs and exports are not published in this version. Watch the repository for the alpha release.
13
+ <br />
14
+
15
+ <div align="center">
16
+
17
+ [![typescript-image][typescript-badge]][typescript-url]
18
+ [![FSL-1.1-Apache-2.0 licence][license-badge]][license]
19
+ [![npm version][npm-version-badge]][npm-version]
20
+ [![npm downloads][npm-downloads-badge]][npm-downloads]
21
+ [![PRs Welcome][prs-welcome-badge]][prs-welcome]
22
+
23
+ </div>
24
+
25
+ ---
26
+
27
+ <div align="center">
28
+ <p>
29
+ <sup>
30
+ Daniel Bannert's open source work is supported by the community on <a href="https://github.com/sponsors/prisis">GitHub Sponsors</a>
31
+ </sup>
32
+ </p>
33
+ </div>
34
+
35
+ ---
36
+
37
+ Transactional email for Lunora. Render TSX templates, send through Cloudflare Email Workers (the default) or the Resend adapter, and offload delivery to a Cloudflare Queue so requests return immediately. In `lunora dev` every send is captured into the studio's Mail inbox instead of hitting a provider.
38
+
39
+ Part of the [Lunora](https://github.com/anolilab/lunora) framework — a type-safe, real-time backend on Cloudflare Workers + Durable Objects with a Vite-first DX.
40
+
41
+ ## Install
42
+
43
+ ```sh
44
+ npm install @lunora/mail
45
+ ```
46
+
47
+ ```sh
48
+ yarn add @lunora/mail
49
+ ```
50
+
51
+ ```sh
52
+ pnpm add @lunora/mail
53
+ ```
54
+
55
+ ## Usage
56
+
57
+ Build a `Mailer` and send. `createMailer` needs `from` plus one transport: the
58
+ default is Cloudflare Email Workers (`cloudflareSend`), with Resend (`apiKey`) as
59
+ a bring-your-own-provider option. Pass a React Email element through `react` and
60
+ it renders to `html` + `text` for you (this file must be `.tsx`):
61
+
62
+ ```tsx
63
+ import { createMailer } from "@lunora/mail";
64
+
65
+ import { WelcomeEmail } from "./emails/Welcome";
66
+
67
+ const mailer = createMailer({
68
+ apiKey: env.RESEND_API_KEY,
69
+ from: "Acme <noreply@acme.test>",
70
+ });
71
+
72
+ await mailer.send({
73
+ to: "alice@example.com",
74
+ subject: "Welcome",
75
+ react: <WelcomeEmail name="Alice" />,
76
+ });
77
+ ```
78
+
79
+ In a Worker, `createMailerFromEnv(env)` is usually what you want: it reads
80
+ `MAIL_FROM`, captures into the studio inbox in dev, and otherwise delivers via
81
+ the `SEND_EMAIL` binding (or `RESEND_API_KEY`).
82
+
83
+ > This README covers the basics. For the full API, options, and guides, see the **[documentation](https://lunora.sh/docs/packages/mail)**.
84
+
85
+ ## Related
86
+
87
+ - [`@lunora/server`](https://www.npmjs.com/package/@lunora/server) — call the mailer from actions.
88
+ - [`@lunora/scheduler`](https://www.npmjs.com/package/@lunora/scheduler) — queue-backed dispatch for deferred sends.
89
+ - [`@lunora/auth`](https://www.npmjs.com/package/@lunora/auth) — send verification and password-reset emails.
90
+
91
+ ## Supported Node.js Versions
92
+
93
+ Libraries in this ecosystem make the best effort to track [Node.js' release schedule](https://github.com/nodejs/release#release-schedule).
94
+ Here's [a post on why we think this is important](https://medium.com/the-node-js-collection/maintainers-should-consider-following-node-js-release-schedule-ab08ed4de71a).
95
+
96
+ ## Contributing
97
+
98
+ If you would like to help take a look at the [list of issues](https://github.com/anolilab/lunora/issues) and check our [Contributing](https://github.com/anolilab/lunora/blob/alpha/.github/CONTRIBUTING.md) guidelines.
99
+
100
+ > **Note:** please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
101
+
102
+ ## Credits
103
+
104
+ - [Daniel Bannert](https://github.com/prisis)
105
+ - [All Contributors](https://github.com/anolilab/lunora/graphs/contributors)
106
+
107
+ ## Made with ❤️ at Anolilab
108
+
109
+ This is an open source project and will always remain free to use. If you think it's cool, please star it 🌟. [Anolilab](https://www.anolilab.com/open-source) is a Development and AI Studio. Contact us at [hello@anolilab.com](mailto:hello@anolilab.com) if you need any help with these technologies or just want to say hi!
15
110
 
16
111
  ## License
17
112
 
18
- FSL-1.1-Apache-2.0
113
+ The Lunora mail package is open-sourced software licensed under the [FSL-1.1-Apache-2.0][license].
114
+
115
+ <!-- badges -->
116
+
117
+ [license-badge]: https://img.shields.io/badge/license-FSL--1.1--Apache--2.0-blue.svg?style=for-the-badge
118
+ [license]: https://github.com/anolilab/lunora/blob/alpha/LICENSE.md
119
+ [npm-version-badge]: https://img.shields.io/npm/v/@lunora/mail?style=for-the-badge
120
+ [npm-version]: https://www.npmjs.com/package/@lunora/mail
121
+ [npm-downloads-badge]: https://img.shields.io/npm/dm/@lunora/mail?style=for-the-badge
122
+ [npm-downloads]: https://www.npmjs.com/package/@lunora/mail
123
+ [prs-welcome-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge
124
+ [prs-welcome]: https://github.com/anolilab/lunora/blob/alpha/.github/CONTRIBUTING.md
125
+ [typescript-badge]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
126
+ [typescript-url]: https://www.typescriptlang.org/