@theokit/gateway-email 0.1.4 → 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.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,45 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.2.0
4
+
5
+ ### Minor Changes
6
+
7
+ - aa2eced: The nodemailer peer range no longer admits only vulnerable versions.
8
+
9
+ `nodemailer ^8.0.0` was declared as a peer, and the whole of `^8` is inside the range an advisory
10
+ names vulnerable (`<=9.0.0`, "Message-level raw option bypasses disableFileAccess/disableUrlAccess").
11
+ A consumer following our range got a vulnerable nodemailer; one who wanted a safe one got a peer
12
+ conflict.
13
+
14
+ The peer is now `^9.0.1`. Nodemailer 9 keeps `createTransport`, `sendMail`, `verify` and `close` —
15
+ the entire surface this adapter uses — and its 95 tests pass against it.
16
+
17
+ The advisory's subject is a message-level `raw` option on send, which this adapter does not use; it
18
+ parses inbound mail. The range moved anyway: one that admits only vulnerable versions is a defect
19
+ whether or not the vulnerable path is reachable.
20
+
21
+ ## 0.1.5
22
+
23
+ ### Patch Changes
24
+
25
+ - Every credential field now says what the platform calls it and where it is issued.
26
+
27
+ Measured: a developer who wires one adapter and carries its field name to the next gets
28
+ `error TS2353: … 'token' does not exist in type 'SlackAdapterOptions'`. That names the wrong field
29
+ and the type, and never the right one — so the answer was always one file away.
30
+
31
+ These docblocks are on published option types, so an editor now shows the answer on hover and
32
+ completion. All 15 credential-bearing fields across the ten packages are covered, including the ones
33
+ beyond each adapter's primary token: Slack's `appToken`, LINE's `channelSecret`, Vonage's
34
+ `apiSecret` and `signatureSecret`, WhatsApp's `appSecret`.
35
+
36
+ **Nothing was renamed.** Six of the ten primary names are the platform's own key, pinned against the
37
+ SDK's own declaration — `channelAccessToken` in `@line/bot-sdk`, `clientSecret` in
38
+ `@microsoft/teams.apps`, `accessToken` in `matrix-js-sdk`, `token` in `grammy` and `discord.js`,
39
+ `authToken` in `twilio`. Where ours diverges, the docblock says so rather than implying otherwise:
40
+ `botToken` (deliberate — the adapter also takes an `appToken`), Mattermost's `accessToken` against
41
+ its client's `token`, and `password` against nodemailer's `pass`.
42
+
3
43
  ## 0.1.4
4
44
 
5
45
  ### Patch Changes
package/dist/index.d.cts CHANGED
@@ -5,7 +5,14 @@ export type { EmailMessageEvent };
5
5
  interface EmailAdapterOptions {
6
6
  /** Email address the bot listens on (also the From: of outbound). */
7
7
  readonly address: string;
8
- /** Password — for Gmail use an App Password (NOT the account password). */
8
+ /**
9
+ * The mailbox password for the email account, or an app-specific password where required.
10
+ *
11
+ * @platform-term IMAP and SMTP both call this a **password**. Note the divergence: `nodemailer`
12
+ * names its field `pass`, and this one is `password` — ours, not theirs.
13
+ * @issued-at The mail provider's account settings; most require an app password rather than the
14
+ * login password when two-factor authentication is on.
15
+ */
9
16
  readonly password: string;
10
17
  /** IMAP server (e.g., "imap.gmail.com"). */
11
18
  readonly imapHost: string;
package/dist/index.d.ts CHANGED
@@ -5,7 +5,14 @@ export type { EmailMessageEvent };
5
5
  interface EmailAdapterOptions {
6
6
  /** Email address the bot listens on (also the From: of outbound). */
7
7
  readonly address: string;
8
- /** Password — for Gmail use an App Password (NOT the account password). */
8
+ /**
9
+ * The mailbox password for the email account, or an app-specific password where required.
10
+ *
11
+ * @platform-term IMAP and SMTP both call this a **password**. Note the divergence: `nodemailer`
12
+ * names its field `pass`, and this one is `password` — ours, not theirs.
13
+ * @issued-at The mail provider's account settings; most require an app password rather than the
14
+ * login password when two-factor authentication is on.
15
+ */
9
16
  readonly password: string;
10
17
  /** IMAP server (e.g., "imap.gmail.com"). */
11
18
  readonly imapHost: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@theokit/gateway-email",
3
- "version": "0.1.4",
3
+ "version": "0.2.0",
4
4
  "description": "Email platform adapter for @theokit/gateway. Community-standard 2026 stack: nodemailer + imapflow + mailparser. ADRs D327-D339.",
5
5
  "license": "Apache-2.0",
6
6
  "repository": {
@@ -38,20 +38,20 @@
38
38
  "@theokit/gateway": ">=0.6.0 <1.0.0",
39
39
  "imapflow": "^1.0.0",
40
40
  "mailparser": "^3.0.0",
41
- "nodemailer": "^8.0.0"
41
+ "nodemailer": "^9.0.1"
42
42
  },
43
43
  "devDependencies": {
44
44
  "@theokit/sdk": "^4.53.1",
45
45
  "@types/mailparser": "^3.4.0",
46
- "@types/nodemailer": "^8.0.0",
47
- "imapflow": "^1.3.0",
46
+ "@types/nodemailer": "^8.0.1",
47
+ "imapflow": "^1.7.6",
48
48
  "mailparser": "^3.9.0",
49
- "nodemailer": "^8.0.0",
49
+ "nodemailer": "^9.0.5",
50
50
  "tsup": "^8.5.0",
51
51
  "typescript": "^5.8.0",
52
52
  "vitest": "^4.1.8",
53
53
  "zod": "^4.0.0",
54
- "@theokit/gateway": "0.7.0"
54
+ "@theokit/gateway": "0.8.0"
55
55
  },
56
56
  "publishConfig": {
57
57
  "access": "public",