@molecule/api-emails-inbound-ses 1.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 ADDED
@@ -0,0 +1,115 @@
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
+
39
+ "Derivative Works" shall mean any work, whether in Source or Object
40
+ form, that is based on (or derived from) the Work and for which the
41
+ editorial revisions, annotations, elaborations, or other modifications
42
+ represent, as a whole, an original work of authorship.
43
+
44
+ "Contribution" shall mean any work of authorship, including the
45
+ original version of the Work and any modifications or additions
46
+ to that Work, that is intentionally submitted to the Licensor for
47
+ inclusion in the Work by the copyright owner or by an individual or
48
+ Legal Entity authorized to submit on behalf of the copyright owner.
49
+
50
+ "Contributor" shall mean Licensor and any individual or Legal Entity
51
+ on behalf of whom a Contribution has been received by the Licensor and
52
+ subsequently incorporated within the Work.
53
+
54
+ 2. Grant of Copyright License. Subject to the terms and conditions of
55
+ this License, each Contributor hereby grants to You a perpetual,
56
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
57
+ copyright license to reproduce, prepare Derivative Works of,
58
+ publicly display, publicly perform, sublicense, and distribute the
59
+ Work and such Derivative Works in Source or Object form.
60
+
61
+ 3. Grant of Patent License. Subject to the terms and conditions of
62
+ this License, each Contributor hereby grants to You a perpetual,
63
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
64
+ patent license to make, have made, use, offer to sell, sell, import,
65
+ and otherwise transfer the Work.
66
+
67
+ 4. Redistribution. You may reproduce and distribute copies of the
68
+ Work or Derivative Works thereof in any medium, with or without
69
+ modifications, and in Source or Object form, provided that You
70
+ meet the following conditions:
71
+
72
+ (a) You must give any other recipients of the Work or
73
+ Derivative Works a copy of this License; and
74
+
75
+ (b) You must cause any modified files to carry prominent notices
76
+ stating that You changed the files; and
77
+
78
+ (c) You must retain, in the Source form of any Derivative Works
79
+ that You distribute, all copyright, patent, trademark, and
80
+ attribution notices from the Source form of the Work,
81
+ excluding those notices that do not pertain to any part of
82
+ the Derivative Works; and
83
+
84
+ (d) If the Work includes a "NOTICE" text file as part of its
85
+ distribution, then any Derivative Works that You distribute must
86
+ include a readable copy of the attribution notices contained
87
+ within such NOTICE file.
88
+
89
+ 5. Submission of Contributions.
90
+
91
+ 6. Trademarks. This License does not grant permission to use the trade
92
+ names, trademarks, service marks, or product names of the Licensor.
93
+
94
+ 7. Disclaimer of Warranty. Unless required by applicable law or
95
+ agreed to in writing, Licensor provides the Work on an "AS IS" BASIS,
96
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND.
97
+
98
+ 8. Limitation of Liability. In no event and under no legal theory shall
99
+ any Contributor be liable to You for damages.
100
+
101
+ 9. Accepting Warranty or Additional Liability.
102
+
103
+ Copyright 2026 Molecule Dev, Inc.
104
+
105
+ Licensed under the Apache License, Version 2.0 (the "License");
106
+ you may not use this file except in compliance with the License.
107
+ You may obtain a copy of the License at
108
+
109
+ http://www.apache.org/licenses/LICENSE-2.0
110
+
111
+ Unless required by applicable law or agreed to in writing, software
112
+ distributed under the License is distributed on an "AS IS" BASIS,
113
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
114
+ See the License for the specific language governing permissions and
115
+ limitations under the License.
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=browser-guard.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"browser-guard.d.ts","sourceRoot":"","sources":["../src/browser-guard.ts"],"names":[],"mappings":"AAuBA,OAAO,EAAE,CAAA"}
@@ -0,0 +1,19 @@
1
+ /**
2
+ * Browser guard — `@molecule/api-emails-inbound-ses` is SERVER-ONLY.
3
+ *
4
+ * Generated by scripts/gen-browser-guards.mjs (workspace root) — edit THAT, not this.
5
+ * Evaluating a server package in a browser bundle is always an import-graph mistake
6
+ * (node APIs, secrets); without this guard it surfaces as a cryptic downstream crash
7
+ * ("Buffer is not defined") far from the culprit. Throwing here names the package and
8
+ * the fix at the exact moment the client bundle evaluates it. jsdom tests and SSR are
9
+ * unaffected: the throw requires browser globals AND the absence of a node runtime.
10
+ */
11
+ const g = globalThis;
12
+ if (g.window !== undefined && g.document !== undefined && !g.process?.versions?.node) {
13
+ throw new Error('@molecule/api-emails-inbound-ses is SERVER-ONLY: it was bundled into browser/client code. Import it only ' +
14
+ 'from server code (a server route/function or your API), or dynamic-import it inside ' +
15
+ 'the server handler — never from components or shared client modules, and never ' +
16
+ 'polyfill Buffer/process to silence this.');
17
+ }
18
+ export {};
19
+ //# sourceMappingURL=browser-guard.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"browser-guard.js","sourceRoot":"","sources":["../src/browser-guard.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,MAAM,CAAC,GAAG,UAIT,CAAA;AACD,IAAI,CAAC,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,CAAC,QAAQ,KAAK,SAAS,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;IACrF,MAAM,IAAI,KAAK,CACb,2GAA2G;QACzG,sFAAsF;QACtF,iFAAiF;QACjF,0CAA0C,CAC7C,CAAA;AACH,CAAC"}
@@ -0,0 +1,37 @@
1
+ /**
2
+ * AWS SES inbound-email provider for molecule.dev.
3
+ *
4
+ * Implements `@molecule/api-emails-inbound`'s `InboundEmailProvider`
5
+ * interface against AWS SES Inbound's SNS-delivery format. Validates SNS
6
+ * notification signatures by fetching the publisher cert from a
7
+ * `*.amazonaws.com`-allowlisted URL, parses the SES `mail` + `content`
8
+ * fields, and decodes the embedded RFC 822 message via `mailparser`.
9
+ *
10
+ * Outbound replies compose onto the bonded `@molecule/api-emails`
11
+ * transport (typically `@molecule/api-emails-ses`) — this package does not
12
+ * reimplement SMTP / SES SendEmail.
13
+ *
14
+ * @remarks
15
+ * The (uncached) signing-certificate fetch is bounded to a 5 second
16
+ * timeout — a hanging/slow `SigningCertURL` endpoint fails fast into a
17
+ * `false` verification result instead of stalling the webhook handler for
18
+ * `fetch`'s much longer default. Once a cert is fetched it is cached
19
+ * in-process, so this only affects the first verification against a given
20
+ * `SigningCertURL`.
21
+ *
22
+ * @example
23
+ * ```typescript
24
+ * import { setProvider } from '@molecule/api-emails-inbound'
25
+ * import { provider as sesInbound } from '@molecule/api-emails-inbound-ses'
26
+ *
27
+ * setProvider(sesInbound)
28
+ * ```
29
+ *
30
+ * @module
31
+ */
32
+ export * from './browser-guard.js';
33
+ export * from './provider.js';
34
+ export * from './secrets.js';
35
+ export * from './types.js';
36
+ export * from './utilities.js';
37
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AAEH,cAAc,oBAAoB,CAAA;AAClC,cAAc,eAAe,CAAA;AAC7B,cAAc,cAAc,CAAA;AAC5B,cAAc,YAAY,CAAA;AAC1B,cAAc,gBAAgB,CAAA"}
package/dist/index.js ADDED
@@ -0,0 +1,37 @@
1
+ /**
2
+ * AWS SES inbound-email provider for molecule.dev.
3
+ *
4
+ * Implements `@molecule/api-emails-inbound`'s `InboundEmailProvider`
5
+ * interface against AWS SES Inbound's SNS-delivery format. Validates SNS
6
+ * notification signatures by fetching the publisher cert from a
7
+ * `*.amazonaws.com`-allowlisted URL, parses the SES `mail` + `content`
8
+ * fields, and decodes the embedded RFC 822 message via `mailparser`.
9
+ *
10
+ * Outbound replies compose onto the bonded `@molecule/api-emails`
11
+ * transport (typically `@molecule/api-emails-ses`) — this package does not
12
+ * reimplement SMTP / SES SendEmail.
13
+ *
14
+ * @remarks
15
+ * The (uncached) signing-certificate fetch is bounded to a 5 second
16
+ * timeout — a hanging/slow `SigningCertURL` endpoint fails fast into a
17
+ * `false` verification result instead of stalling the webhook handler for
18
+ * `fetch`'s much longer default. Once a cert is fetched it is cached
19
+ * in-process, so this only affects the first verification against a given
20
+ * `SigningCertURL`.
21
+ *
22
+ * @example
23
+ * ```typescript
24
+ * import { setProvider } from '@molecule/api-emails-inbound'
25
+ * import { provider as sesInbound } from '@molecule/api-emails-inbound-ses'
26
+ *
27
+ * setProvider(sesInbound)
28
+ * ```
29
+ *
30
+ * @module
31
+ */
32
+ export * from './browser-guard.js';
33
+ export * from './provider.js';
34
+ export * from './secrets.js';
35
+ export * from './types.js';
36
+ export * from './utilities.js';
37
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AAEH,cAAc,oBAAoB,CAAA;AAClC,cAAc,eAAe,CAAA;AAC7B,cAAc,cAAc,CAAA;AAC5B,cAAc,YAAY,CAAA;AAC1B,cAAc,gBAAgB,CAAA"}
@@ -0,0 +1,92 @@
1
+ /**
2
+ * AWS SES inbound-email provider implementation.
3
+ *
4
+ * SES Inbound parses received mail upstream and either delivers the message
5
+ * to S3 or publishes a notification (with the parsed `mail` metadata and
6
+ * optional base64-encoded raw RFC 822 `content`) to an SNS topic. This
7
+ * bond handles the SNS-notification path: an HTTPS endpoint subscribed to
8
+ * the topic receives JSON, validates the SNS signature, and parses the
9
+ * embedded `content` (RFC 822) into a normalized `InboundEmail`.
10
+ *
11
+ * Outbound replies compose onto the bonded `@molecule/api-emails`
12
+ * transport (typically `@molecule/api-emails-ses`); we never reimplement
13
+ * SMTP / SES SendEmail here.
14
+ *
15
+ * @see https://docs.aws.amazon.com/ses/latest/dg/receiving-email-notifications.html
16
+ * @see https://docs.aws.amazon.com/sns/latest/dg/sns-verify-signature-of-message.html
17
+ *
18
+ * @module
19
+ */
20
+ import { Buffer } from 'node:buffer';
21
+ import './secrets.js';
22
+ import type { InboundEmail, InboundEmailProvider, InboundEmailReply, InboundEmailReplyResult } from '@molecule/api-emails-inbound';
23
+ /**
24
+ * Resets the cached signing certificates. Exposed for tests.
25
+ */
26
+ export declare const _resetSigningCertCache: () => void;
27
+ /**
28
+ * Verifies the signature of an SNS notification payload. Implements the
29
+ * AWS SNS signature-verification flow:
30
+ *
31
+ * 1. Parse the JSON body.
32
+ * 2. Reject if `SigningCertURL` is not from an allowlisted host.
33
+ * 3. Fetch the X.509 certificate from `SigningCertURL`.
34
+ * 4. Build the canonical string per AWS docs (field order varies by
35
+ * `Type`).
36
+ * 5. Verify the base64-decoded `Signature` against the canonical string
37
+ * using SHA1 (`SignatureVersion === '1'`) or SHA256
38
+ * (`SignatureVersion === '2'`).
39
+ * 6. When `AWS_SES_INBOUND_TOPIC_ARN` is set, also verify the payload's
40
+ * `TopicArn` matches.
41
+ *
42
+ * Errors NEVER leak signing material; failures simply return `false`.
43
+ *
44
+ * @param _headers - HTTP headers (unused — SNS signs the body).
45
+ * @param body - Raw HTTP request body (JSON).
46
+ * @returns `true` when the signature is valid, `false` otherwise.
47
+ */
48
+ export declare const verifySignature: (_headers: Record<string, string | string[] | undefined>, body: Buffer | string) => Promise<boolean>;
49
+ /**
50
+ * Parses an SNS notification carrying an SES inbound-email payload into a
51
+ * normalized {@link InboundEmail}.
52
+ *
53
+ * When the SES `Message.content` field is present, it is base64-decoded
54
+ * and parsed as RFC 822 via `mailparser`. When `content` is absent
55
+ * (header-only notifications), we synthesize an `InboundEmail` from the
56
+ * SES `mail` metadata so the caller can still log/dedupe the message.
57
+ *
58
+ * SubscriptionConfirmation messages are returned as a synthetic
59
+ * `InboundEmail` whose `subject` is `'__sns:SubscriptionConfirmation'` and
60
+ * whose `headers['x-sns-subscribe-url']` carries the confirmation URL —
61
+ * applications inspect this so they can subscribe out-of-band.
62
+ *
63
+ * @param _headers - HTTP headers (unused).
64
+ * @param body - Raw HTTP body (SNS JSON).
65
+ * @returns The normalized inbound email.
66
+ */
67
+ export declare const parseWebhookPayload: (_headers: Record<string, string | string[] | undefined>, body: Buffer | string | Record<string, unknown>) => Promise<InboundEmail>;
68
+ /**
69
+ * Dispatches an outbound reply through the bonded `@molecule/api-emails`
70
+ * transport. The reply's `In-Reply-To` and `References` headers are
71
+ * populated from the original message when present.
72
+ *
73
+ * @param email - The original inbound email being replied to.
74
+ * @param reply - The reply payload.
75
+ * @returns The reply dispatch result.
76
+ */
77
+ export declare const replyTo: (email: InboundEmail, reply: InboundEmailReply) => Promise<InboundEmailReplyResult>;
78
+ /**
79
+ * Indicates that this provider supports outbound reply dispatch via
80
+ * {@link replyTo}. The reply path requires the outbound
81
+ * `@molecule/api-emails` bond to be wired with a transport — typically
82
+ * `@molecule/api-emails-ses`.
83
+ *
84
+ * @returns Always `true`.
85
+ */
86
+ export declare const supportsReply: () => boolean;
87
+ /**
88
+ * The AWS SES inbound-email provider implementing the
89
+ * {@link InboundEmailProvider} interface.
90
+ */
91
+ export declare const provider: InboundEmailProvider;
92
+ //# sourceMappingURL=provider.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAMpC,OAAO,cAAc,CAAA;AAGrB,OAAO,KAAK,EACV,YAAY,EAEZ,oBAAoB,EACpB,iBAAiB,EACjB,uBAAuB,EACxB,MAAM,8BAA8B,CAAA;AA+BrC;;GAEG;AACH,eAAO,MAAM,sBAAsB,QAAO,IAEzC,CAAA;AAqDD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,eAAe,GAC1B,UAAU,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,EACvD,MAAM,MAAM,GAAG,MAAM,KACpB,OAAO,CAAC,OAAO,CAqDjB,CAAA;AAuCD;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,mBAAmB,GAC9B,UAAU,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,EACvD,MAAM,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAC9C,OAAO,CAAC,YAAY,CA6EtB,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,OAAO,GAClB,OAAO,YAAY,EACnB,OAAO,iBAAiB,KACvB,OAAO,CAAC,uBAAuB,CA+CjC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa,QAAO,OAAe,CAAA;AAEhD;;;GAGG;AACH,eAAO,MAAM,QAAQ,EAAE,oBAKtB,CAAA"}