@mxraven/mail 0.1.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 +201 -0
- package/README.md +215 -0
- package/dist/feedback/index.cjs +246 -0
- package/dist/feedback/index.cjs.map +1 -0
- package/dist/feedback/index.d.cts +149 -0
- package/dist/feedback/index.d.cts.map +1 -0
- package/dist/feedback/index.d.ts +149 -0
- package/dist/feedback/index.d.ts.map +1 -0
- package/dist/feedback/index.js +243 -0
- package/dist/feedback/index.js.map +1 -0
- package/dist/index.cjs +2708 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +323 -0
- package/dist/index.d.cts.map +1 -0
- package/dist/index.d.ts +323 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +2703 -0
- package/dist/index.js.map +1 -0
- package/dist/webhook/index.cjs +417 -0
- package/dist/webhook/index.cjs.map +1 -0
- package/dist/webhook/index.d.cts +411 -0
- package/dist/webhook/index.d.cts.map +1 -0
- package/dist/webhook/index.d.ts +411 -0
- package/dist/webhook/index.d.ts.map +1 -0
- package/dist/webhook/index.js +409 -0
- package/dist/webhook/index.js.map +1 -0
- package/package.json +101 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2026 SynqronLabs Private Limited
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,215 @@
|
|
|
1
|
+
# mxRaven Mail SDK (TypeScript)
|
|
2
|
+
|
|
3
|
+
A TypeScript SDK for the mxRaven mail-facing runtime surfaces: SMTP submission,
|
|
4
|
+
webhook verification and decoding, and recipient feedback.
|
|
5
|
+
|
|
6
|
+
It is the TypeScript counterpart of the Go SDK at
|
|
7
|
+
[`github.com/synqronlabs/mxraven-go/mail`](https://github.com/synqronlabs/mxraven-go/tree/main/mail)
|
|
8
|
+
and exposes the same capabilities behind an idiomatic TypeScript API.
|
|
9
|
+
|
|
10
|
+
> **Status:** early development. The public API is not yet stable.
|
|
11
|
+
|
|
12
|
+
## Install
|
|
13
|
+
|
|
14
|
+
```sh
|
|
15
|
+
pnpm add @mxraven/mail
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Quick start
|
|
19
|
+
|
|
20
|
+
```ts
|
|
21
|
+
import { Client, Message } from "@mxraven/mail";
|
|
22
|
+
|
|
23
|
+
const secret = process.env.MXRAVEN_SECRET;
|
|
24
|
+
if (secret === undefined || secret === "") {
|
|
25
|
+
throw new Error("MXRAVEN_SECRET is required");
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
const client = new Client({
|
|
29
|
+
host: "smtp.mxraven.com",
|
|
30
|
+
username: "mxr_tx_ab12cd34ef56",
|
|
31
|
+
secret,
|
|
32
|
+
});
|
|
33
|
+
|
|
34
|
+
const result = await client.send(
|
|
35
|
+
new Message()
|
|
36
|
+
.from("Acme <noreply@acme.example>")
|
|
37
|
+
.to("customer@example.com")
|
|
38
|
+
.subject("Your receipt")
|
|
39
|
+
.text("Thanks for your order.")
|
|
40
|
+
.html("<p>Thanks for your order.</p>"),
|
|
41
|
+
);
|
|
42
|
+
|
|
43
|
+
console.log("accepted as", result.messageRef);
|
|
44
|
+
await client.close();
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
The submission service requires STARTTLS and SMTP AUTH, so both are always
|
|
48
|
+
used. The SDK does not read environment variables itself; the example validates
|
|
49
|
+
the variable before constructing the client. Load secrets from a secret manager
|
|
50
|
+
in production. Setting both a plain-text and an HTML body produces a
|
|
51
|
+
`multipart/alternative` message; `attachFile` and `attachInline` add
|
|
52
|
+
`multipart/mixed` attachments.
|
|
53
|
+
|
|
54
|
+
### Sending raw messages
|
|
55
|
+
|
|
56
|
+
Use `sendRaw` to stream an already serialized RFC 5322 message with an explicit
|
|
57
|
+
envelope. The caller is responsible for RFC 5322 correctness.
|
|
58
|
+
|
|
59
|
+
```ts
|
|
60
|
+
await client.sendRaw(
|
|
61
|
+
{ from: "bounce@acme.example", to: ["customer@example.com"] },
|
|
62
|
+
rawMessageBytes,
|
|
63
|
+
);
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
### Errors
|
|
67
|
+
|
|
68
|
+
Rejected commands throw `SMTPError`; when every recipient is rejected,
|
|
69
|
+
`SMTPTransactionError` is thrown with the per-recipient `result`.
|
|
70
|
+
|
|
71
|
+
```ts
|
|
72
|
+
import { SMTPError } from "@mxraven/mail";
|
|
73
|
+
|
|
74
|
+
try {
|
|
75
|
+
await client.send(message);
|
|
76
|
+
} catch (error) {
|
|
77
|
+
if (error instanceof SMTPError && error.permanent) {
|
|
78
|
+
// 5xx: do not retry the same message.
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
## Webhooks
|
|
84
|
+
|
|
85
|
+
Verification and decoding live in a separate entry point that uses the webhook
|
|
86
|
+
signing secret, not the submission API key.
|
|
87
|
+
|
|
88
|
+
```ts
|
|
89
|
+
import { Verifier, eventType, fetchRawEmail } from "@mxraven/mail/webhook";
|
|
90
|
+
|
|
91
|
+
const signingSecret = process.env.MXRAVEN_WEBHOOK_SECRET;
|
|
92
|
+
if (signingSecret === undefined || signingSecret === "") {
|
|
93
|
+
throw new Error("MXRAVEN_WEBHOOK_SECRET is required");
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
const verifier = new Verifier({ secret: signingSecret });
|
|
97
|
+
const event = await verifier.verifyAndDecode(request);
|
|
98
|
+
|
|
99
|
+
if (event.type === eventType.inboundEmail) {
|
|
100
|
+
const raw = await fetchRawEmail(event.inboundEmail.raw_email);
|
|
101
|
+
}
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
The signing secret is used as literal key bytes; do not base64-decode it. Pass
|
|
105
|
+
per-key secrets to `Verifier` with `keys` for rotation. The raw-email
|
|
106
|
+
`access_token` is a secret; do not log it.
|
|
107
|
+
|
|
108
|
+
### Framework support
|
|
109
|
+
|
|
110
|
+
`Verifier` accepts a WHATWG [`Request`](https://developer.mozilla.org/docs/Web/API/Request).
|
|
111
|
+
Runtimes and frameworks that provide one work directly: Cloudflare Workers,
|
|
112
|
+
Deno, Bun, Next.js (App Router), Remix, SvelteKit, Astro, Hono (`c.req.raw`),
|
|
113
|
+
and `@whatwg-node/server`.
|
|
114
|
+
|
|
115
|
+
Node frameworks expose their own request objects — `IncomingMessage` in
|
|
116
|
+
Express, `FastifyRequest` in Fastify, `ctx` in Koa. Bridge them by constructing
|
|
117
|
+
a `Request`, keeping two things in mind:
|
|
118
|
+
|
|
119
|
+
- The signature covers the **exact raw body**, so preserve the raw bytes; do
|
|
120
|
+
not let a JSON body parser consume them first.
|
|
121
|
+
- The signature covers the **public URL**, so reconstruct the scheme and host
|
|
122
|
+
the caller actually used. Behind a proxy that is usually
|
|
123
|
+
`X-Forwarded-Proto`/`X-Forwarded-Host`, not `Host`.
|
|
124
|
+
|
|
125
|
+
```ts
|
|
126
|
+
import express from "express";
|
|
127
|
+
|
|
128
|
+
const app = express();
|
|
129
|
+
|
|
130
|
+
app.post(
|
|
131
|
+
"/mxraven/webhook",
|
|
132
|
+
express.raw({ type: "*/*" }), // keeps the exact bytes on req.body
|
|
133
|
+
async (req, res) => {
|
|
134
|
+
const request = new Request(`https://${req.headers.host}${req.originalUrl}`, {
|
|
135
|
+
method: req.method,
|
|
136
|
+
headers: req.headers as HeadersInit,
|
|
137
|
+
body: req.body,
|
|
138
|
+
});
|
|
139
|
+
const event = await verifier.verifyAndDecode(request);
|
|
140
|
+
res.sendStatus(204);
|
|
141
|
+
},
|
|
142
|
+
);
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
In Fastify, capture the raw buffer in an `addContentTypeParser` hook, then build
|
|
146
|
+
the `Request` from `request.method`, `request.url`, and `request.headers`.
|
|
147
|
+
`decode` operates on bytes alone, so it can be used without any request object.
|
|
148
|
+
|
|
149
|
+
The runtime surfaces are published as separate entry points so the root import
|
|
150
|
+
stays free of webhook and feedback code:
|
|
151
|
+
|
|
152
|
+
- `@mxraven/mail/webhook` — HMAC-SHA256 verification, payload decoding, and raw
|
|
153
|
+
message download.
|
|
154
|
+
- `@mxraven/mail/feedback` — tenant spam/ham training and RFC 8058 one-click
|
|
155
|
+
unsubscribes.
|
|
156
|
+
|
|
157
|
+
### Feedback
|
|
158
|
+
|
|
159
|
+
Teach the spam filter with the exact raw message bytes mxRaven processed, or
|
|
160
|
+
perform a one-click unsubscribe. Learning uses the same submission API key as
|
|
161
|
+
SMTP submission, over HTTP Basic auth.
|
|
162
|
+
|
|
163
|
+
```ts
|
|
164
|
+
import { Client } from "@mxraven/mail/feedback";
|
|
165
|
+
|
|
166
|
+
const secret = process.env.MXRAVEN_SECRET;
|
|
167
|
+
if (secret === undefined || secret === "") {
|
|
168
|
+
throw new Error("MXRAVEN_SECRET is required");
|
|
169
|
+
}
|
|
170
|
+
|
|
171
|
+
const feedback = new Client({
|
|
172
|
+
baseUrl: "https://feedback.mxraven.com",
|
|
173
|
+
username: "mxr_tx_ab12cd34ef56",
|
|
174
|
+
secret,
|
|
175
|
+
});
|
|
176
|
+
|
|
177
|
+
await feedback.learnSpam(rawMessageBytes);
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
## Development
|
|
181
|
+
|
|
182
|
+
Requires Node.js 20.19 or later and pnpm.
|
|
183
|
+
|
|
184
|
+
```sh
|
|
185
|
+
pnpm install # install dependencies
|
|
186
|
+
pnpm run build # dual ESM + CJS build with declarations (tsdown)
|
|
187
|
+
pnpm run test # vitest
|
|
188
|
+
pnpm run lint # oxlint (includes TSDoc validation)
|
|
189
|
+
pnpm run format # oxfmt
|
|
190
|
+
pnpm run docs # typedoc (Markdown) into docs/
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
`pnpm run check` runs formatting, lint, typecheck, test, and build in sequence.
|
|
194
|
+
|
|
195
|
+
## Toolchain
|
|
196
|
+
|
|
197
|
+
| Concern | Tool |
|
|
198
|
+
| ---------------------- | --------------------------------------------------------------------------------------------------------------------- |
|
|
199
|
+
| Language / typecheck | TypeScript (`tsc --noEmit`), NodeNext, strict |
|
|
200
|
+
| Build (dual ESM + CJS) | [tsdown](https://tsdown.dev) (Rolldown) with declarations and source maps |
|
|
201
|
+
| Testing | [Vitest](https://vitest.dev) |
|
|
202
|
+
| Lint / format | [oxlint](https://oxc.rs) + [oxfmt](https://oxc.rs) |
|
|
203
|
+
| TSDoc validation | `eslint-plugin-tsdoc` loaded as an oxlint JS plugin |
|
|
204
|
+
| API docs | [TypeDoc](https://typedoc.org) + `typedoc-plugin-markdown` |
|
|
205
|
+
| Versioning / release | [Changesets](https://github.com/changesets/changesets), published from GitHub Actions with `npm publish --provenance` |
|
|
206
|
+
|
|
207
|
+
## Releases
|
|
208
|
+
|
|
209
|
+
Releases are managed with Changesets. Add a changeset with `pnpm run changeset`;
|
|
210
|
+
merging the generated release pull request bumps versions and publishes to npm
|
|
211
|
+
with provenance.
|
|
212
|
+
|
|
213
|
+
## License
|
|
214
|
+
|
|
215
|
+
Apache-2.0. See [LICENSE](./LICENSE) and [NOTICE](./NOTICE).
|
|
@@ -0,0 +1,246 @@
|
|
|
1
|
+
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
2
|
+
let node_buffer = require("node:buffer");
|
|
3
|
+
//#region src/feedback/errors.ts
|
|
4
|
+
/**
|
|
5
|
+
* A non-success response from the feedback service.
|
|
6
|
+
*
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
var FeedbackError = class extends Error {
|
|
10
|
+
/** The HTTP response status. */
|
|
11
|
+
statusCode;
|
|
12
|
+
/**
|
|
13
|
+
* The service's error message when one was returned, otherwise the HTTP
|
|
14
|
+
* status text.
|
|
15
|
+
*/
|
|
16
|
+
detail;
|
|
17
|
+
/**
|
|
18
|
+
* @param options - The response status and service error message.
|
|
19
|
+
*/
|
|
20
|
+
constructor(options) {
|
|
21
|
+
super(options.detail === "" ? `feedback: request failed with status ${options.statusCode}` : `feedback: request failed with status ${options.statusCode}: ${options.detail}`);
|
|
22
|
+
this.name = "FeedbackError";
|
|
23
|
+
this.statusCode = options.statusCode;
|
|
24
|
+
this.detail = options.detail;
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Reports whether the request may succeed if retried later.
|
|
28
|
+
*
|
|
29
|
+
* Rate limits (429) and server-side failures (5xx) are retryable.
|
|
30
|
+
*/
|
|
31
|
+
get retryable() {
|
|
32
|
+
return this.statusCode === 429 || this.statusCode >= 500;
|
|
33
|
+
}
|
|
34
|
+
};
|
|
35
|
+
//#endregion
|
|
36
|
+
//#region src/feedback/client.ts
|
|
37
|
+
/**
|
|
38
|
+
* The mxRaven feedback and one-click unsubscribe client.
|
|
39
|
+
*/
|
|
40
|
+
/** The training label for a message. */
|
|
41
|
+
const disposition = {
|
|
42
|
+
/** Marks the message as spam. */
|
|
43
|
+
spam: "spam",
|
|
44
|
+
/** Marks the message as not spam. */
|
|
45
|
+
ham: "ham"
|
|
46
|
+
};
|
|
47
|
+
const DEFAULT_TIMEOUT = 3e4;
|
|
48
|
+
const MAX_ERROR_BODY = 4096;
|
|
49
|
+
const MAX_RESULT_BODY = 65536;
|
|
50
|
+
/**
|
|
51
|
+
* Calls the mxRaven feedback service.
|
|
52
|
+
*
|
|
53
|
+
* Learning requests authenticate with the same submission API key used for SMTP
|
|
54
|
+
* submission, over HTTP Basic auth. A client is safe for concurrent use.
|
|
55
|
+
*
|
|
56
|
+
* @example
|
|
57
|
+
* ```ts
|
|
58
|
+
* const secret = process.env.MXRAVEN_SECRET;
|
|
59
|
+
* if (secret === undefined || secret === "") {
|
|
60
|
+
* throw new Error("MXRAVEN_SECRET is required");
|
|
61
|
+
* }
|
|
62
|
+
*
|
|
63
|
+
* const client = new Client({
|
|
64
|
+
* baseUrl: "https://feedback.mxraven.com",
|
|
65
|
+
* username: "mxr_tx_ab12cd34ef56",
|
|
66
|
+
* secret,
|
|
67
|
+
* });
|
|
68
|
+
* const result = await client.learnSpam(rawMessageBytes);
|
|
69
|
+
* ```
|
|
70
|
+
*
|
|
71
|
+
* @public
|
|
72
|
+
*/
|
|
73
|
+
var Client = class {
|
|
74
|
+
baseUrl;
|
|
75
|
+
credentials;
|
|
76
|
+
fetchImpl;
|
|
77
|
+
timeout;
|
|
78
|
+
/**
|
|
79
|
+
* @param options - The base URL, credentials, and transport options.
|
|
80
|
+
* @throws `Error` When the base URL is missing or an option is invalid.
|
|
81
|
+
*/
|
|
82
|
+
constructor(options) {
|
|
83
|
+
const baseUrl = options.baseUrl.trim();
|
|
84
|
+
if (baseUrl === "") throw new Error("feedback: base URL is required");
|
|
85
|
+
const username = (options.username ?? "").trim();
|
|
86
|
+
const secret = options.secret ?? "";
|
|
87
|
+
if (username === "" !== (secret === "")) throw new Error("feedback: username and secret must both be provided");
|
|
88
|
+
const timeout = options.timeout ?? DEFAULT_TIMEOUT;
|
|
89
|
+
if (!Number.isFinite(timeout) || timeout <= 0) throw new Error(`feedback: invalid timeout ${timeout}`);
|
|
90
|
+
this.baseUrl = baseUrl.replace(/\/+$/, "");
|
|
91
|
+
this.credentials = username === "" ? void 0 : {
|
|
92
|
+
username,
|
|
93
|
+
secret
|
|
94
|
+
};
|
|
95
|
+
this.fetchImpl = options.fetch ?? globalThis.fetch;
|
|
96
|
+
this.timeout = timeout;
|
|
97
|
+
}
|
|
98
|
+
/**
|
|
99
|
+
* Submits one training example.
|
|
100
|
+
*
|
|
101
|
+
* `rawMime` must be the exact raw RFC 822 bytes that mxRaven processed; the
|
|
102
|
+
* service matches them against stored evidence by SHA-256. A message with no
|
|
103
|
+
* matching evidence fails with a {@link FeedbackError} whose `statusCode` is
|
|
104
|
+
* 404.
|
|
105
|
+
*
|
|
106
|
+
* @param label - The training label to apply.
|
|
107
|
+
* @param rawMime - The exact raw message bytes.
|
|
108
|
+
* @param options - An optional cancellation signal.
|
|
109
|
+
* @returns The service's learning result.
|
|
110
|
+
* @throws {@link FeedbackError} When the service returns a non-success status.
|
|
111
|
+
*
|
|
112
|
+
* @public
|
|
113
|
+
*/
|
|
114
|
+
async learn(label, rawMime, options = {}) {
|
|
115
|
+
if (label !== disposition.spam && label !== disposition.ham) throw new Error(`feedback: invalid disposition ${JSON.stringify(label)}`);
|
|
116
|
+
const credentials = this.credentials;
|
|
117
|
+
if (credentials === void 0) throw new Error("feedback: credentials are required for learning");
|
|
118
|
+
const endpoint = `${this.baseUrl}/v1/feedback/learn/${label}`;
|
|
119
|
+
const response = await this.perform(endpoint, {
|
|
120
|
+
"Content-Type": "message/rfc822",
|
|
121
|
+
Authorization: `Basic ${encodeBasicAuth(credentials)}`
|
|
122
|
+
}, rawMime, "submit learning request", options);
|
|
123
|
+
if (!response.ok) throw await this.toError(response);
|
|
124
|
+
return parseLearningResult(await readBounded(response, MAX_RESULT_BODY, "learning response"));
|
|
125
|
+
}
|
|
126
|
+
/** Teaches the spam filter that `rawMime` is spam. */
|
|
127
|
+
learnSpam(rawMime, options = {}) {
|
|
128
|
+
return this.learn(disposition.spam, rawMime, options);
|
|
129
|
+
}
|
|
130
|
+
/** Teaches the spam filter that `rawMime` is not spam. */
|
|
131
|
+
learnHam(rawMime, options = {}) {
|
|
132
|
+
return this.learn(disposition.ham, rawMime, options);
|
|
133
|
+
}
|
|
134
|
+
/**
|
|
135
|
+
* Performs an RFC 8058 one-click unsubscribe for a token.
|
|
136
|
+
*
|
|
137
|
+
* This is the operation a recipient mail client performs against the
|
|
138
|
+
* `List-Unsubscribe` URL; applications rarely call it directly. It is
|
|
139
|
+
* unauthenticated.
|
|
140
|
+
*
|
|
141
|
+
* @param token - The signed unsubscribe token.
|
|
142
|
+
* @param options - An optional cancellation signal.
|
|
143
|
+
* @throws {@link FeedbackError} When the service returns a non-success status.
|
|
144
|
+
*
|
|
145
|
+
* @public
|
|
146
|
+
*/
|
|
147
|
+
async unsubscribe(token, options = {}) {
|
|
148
|
+
const value = token.trim();
|
|
149
|
+
if (value === "") throw new Error("feedback: unsubscribe token is empty");
|
|
150
|
+
const endpoint = `${this.baseUrl}/v1/feedback/unsubscribe/${encodeURIComponent(value)}`;
|
|
151
|
+
const response = await this.perform(endpoint, { "Content-Type": "application/x-www-form-urlencoded" }, "List-Unsubscribe=One-Click", "submit unsubscribe request", options);
|
|
152
|
+
if (!response.ok) throw await this.toError(response);
|
|
153
|
+
}
|
|
154
|
+
async perform(endpoint, headers, body, label, options) {
|
|
155
|
+
const controller = new AbortController();
|
|
156
|
+
const timer = setTimeout(() => controller.abort(/* @__PURE__ */ new Error("feedback: request timed out")), this.timeout);
|
|
157
|
+
timer.unref();
|
|
158
|
+
const signal = options.signal;
|
|
159
|
+
const onAbort = () => controller.abort(signal?.reason);
|
|
160
|
+
signal?.addEventListener("abort", onAbort, { once: true });
|
|
161
|
+
try {
|
|
162
|
+
return await this.fetchImpl(endpoint, {
|
|
163
|
+
method: "POST",
|
|
164
|
+
headers,
|
|
165
|
+
body,
|
|
166
|
+
signal: controller.signal
|
|
167
|
+
});
|
|
168
|
+
} catch (error) {
|
|
169
|
+
throw new Error(`feedback: ${label}`, { cause: error });
|
|
170
|
+
} finally {
|
|
171
|
+
clearTimeout(timer);
|
|
172
|
+
signal?.removeEventListener("abort", onAbort);
|
|
173
|
+
}
|
|
174
|
+
}
|
|
175
|
+
async toError(response) {
|
|
176
|
+
let detail = `${response.status} ${response.statusText}`.trim();
|
|
177
|
+
try {
|
|
178
|
+
const body = await readBounded(response, MAX_ERROR_BODY, "error response");
|
|
179
|
+
const parsed = JSON.parse(new TextDecoder().decode(body));
|
|
180
|
+
if (typeof parsed.error === "string" && parsed.error.trim() !== "") detail = parsed.error.trim();
|
|
181
|
+
} catch {}
|
|
182
|
+
return new FeedbackError({
|
|
183
|
+
statusCode: response.status,
|
|
184
|
+
detail
|
|
185
|
+
});
|
|
186
|
+
}
|
|
187
|
+
};
|
|
188
|
+
/** Encodes HTTP Basic credentials. */
|
|
189
|
+
function encodeBasicAuth(credentials) {
|
|
190
|
+
return node_buffer.Buffer.from(`${credentials.username}:${credentials.secret}`, "utf8").toString("base64");
|
|
191
|
+
}
|
|
192
|
+
/** Parses a learning response into its public shape. */
|
|
193
|
+
function parseLearningResult(body) {
|
|
194
|
+
let parsed;
|
|
195
|
+
try {
|
|
196
|
+
parsed = JSON.parse(new TextDecoder().decode(body));
|
|
197
|
+
} catch (error) {
|
|
198
|
+
throw new Error("feedback: decode learning response", { cause: error });
|
|
199
|
+
}
|
|
200
|
+
if (parsed === null || typeof parsed !== "object") throw new Error("feedback: decode learning response");
|
|
201
|
+
const wire = parsed;
|
|
202
|
+
return {
|
|
203
|
+
status: typeof wire.status === "string" ? wire.status : "",
|
|
204
|
+
disposition: wire.disposition === disposition.ham ? disposition.ham : disposition.spam,
|
|
205
|
+
tenantId: typeof wire.tenant_id === "string" ? wire.tenant_id : "",
|
|
206
|
+
listenerId: typeof wire.listener_id === "string" ? wire.listener_id : "",
|
|
207
|
+
matchedHashKind: typeof wire.matched_hash_kind === "string" ? wire.matched_hash_kind : ""
|
|
208
|
+
};
|
|
209
|
+
}
|
|
210
|
+
/** Reads a response body, rejecting when it exceeds a byte limit. */
|
|
211
|
+
async function readBounded(response, limit, label) {
|
|
212
|
+
const stream = response.body;
|
|
213
|
+
if (stream === null) return /* @__PURE__ */ new Uint8Array();
|
|
214
|
+
const reader = stream.getReader();
|
|
215
|
+
const chunks = [];
|
|
216
|
+
let total = 0;
|
|
217
|
+
try {
|
|
218
|
+
for (;;) {
|
|
219
|
+
const { done, value } = await reader.read();
|
|
220
|
+
if (done) break;
|
|
221
|
+
if (value !== void 0) {
|
|
222
|
+
total += value.byteLength;
|
|
223
|
+
if (total > limit) {
|
|
224
|
+
reader.cancel().catch(() => void 0);
|
|
225
|
+
throw new Error(`feedback: ${label} exceeds ${limit} bytes`);
|
|
226
|
+
}
|
|
227
|
+
chunks.push(value);
|
|
228
|
+
}
|
|
229
|
+
}
|
|
230
|
+
} finally {
|
|
231
|
+
reader.releaseLock();
|
|
232
|
+
}
|
|
233
|
+
const result = new Uint8Array(total);
|
|
234
|
+
let offset = 0;
|
|
235
|
+
for (const chunk of chunks) {
|
|
236
|
+
result.set(chunk, offset);
|
|
237
|
+
offset += chunk.byteLength;
|
|
238
|
+
}
|
|
239
|
+
return result;
|
|
240
|
+
}
|
|
241
|
+
//#endregion
|
|
242
|
+
exports.Client = Client;
|
|
243
|
+
exports.FeedbackError = FeedbackError;
|
|
244
|
+
exports.disposition = disposition;
|
|
245
|
+
|
|
246
|
+
//# sourceMappingURL=index.cjs.map
|