@theokit/gateway-email 0.1.3 → 0.1.5

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,41 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.1.5
4
+
5
+ ### Patch Changes
6
+
7
+ - Every credential field now says what the platform calls it and where it is issued.
8
+
9
+ Measured: a developer who wires one adapter and carries its field name to the next gets
10
+ `error TS2353: … 'token' does not exist in type 'SlackAdapterOptions'`. That names the wrong field
11
+ and the type, and never the right one — so the answer was always one file away.
12
+
13
+ These docblocks are on published option types, so an editor now shows the answer on hover and
14
+ completion. All 15 credential-bearing fields across the ten packages are covered, including the ones
15
+ beyond each adapter's primary token: Slack's `appToken`, LINE's `channelSecret`, Vonage's
16
+ `apiSecret` and `signatureSecret`, WhatsApp's `appSecret`.
17
+
18
+ **Nothing was renamed.** Six of the ten primary names are the platform's own key, pinned against the
19
+ SDK's own declaration — `channelAccessToken` in `@line/bot-sdk`, `clientSecret` in
20
+ `@microsoft/teams.apps`, `accessToken` in `matrix-js-sdk`, `token` in `grammy` and `discord.js`,
21
+ `authToken` in `twilio`. Where ours diverges, the docblock says so rather than implying otherwise:
22
+ `botToken` (deliberate — the adapter also takes an `appToken`), Mattermost's `accessToken` against
23
+ its client's `token`, and `password` against nodemailer's `pass`.
24
+
25
+ ## 0.1.4
26
+
27
+ ### Patch Changes
28
+
29
+ - Drop the unused `@theokit/sdk` peer dependency, so a TheoKit app can install an adapter.
30
+
31
+ Every adapter declared `peer @theokit/sdk@^2.18.0` and imported the SDK in **zero** source files.
32
+ The framework ships `@theokit/sdk@4.x`, so `npm install @theokit/gateway-line` into a TheoKit app
33
+ failed outright with `ERESOLVE`.
34
+
35
+ The core's range was widened in `@theokit/gateway@0.7.0`, which was not enough on its own: an
36
+ adapter's own manifest still carried the pin, so installing one still failed even against the fixed
37
+ core. Measured in a real app before and after.
38
+
3
39
  ## 0.1.3
4
40
 
5
41
  ### 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.3",
3
+ "version": "0.1.5",
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": {
@@ -36,13 +36,12 @@
36
36
  ],
37
37
  "peerDependencies": {
38
38
  "@theokit/gateway": ">=0.6.0 <1.0.0",
39
- "@theokit/sdk": "^2.18.0",
40
39
  "imapflow": "^1.0.0",
41
40
  "mailparser": "^3.0.0",
42
41
  "nodemailer": "^8.0.0"
43
42
  },
44
43
  "devDependencies": {
45
- "@theokit/sdk": "^2.18.0",
44
+ "@theokit/sdk": "^4.53.1",
46
45
  "@types/mailparser": "^3.4.0",
47
46
  "@types/nodemailer": "^8.0.0",
48
47
  "imapflow": "^1.3.0",
@@ -52,7 +51,7 @@
52
51
  "typescript": "^5.8.0",
53
52
  "vitest": "^4.1.8",
54
53
  "zod": "^4.0.0",
55
- "@theokit/gateway": "0.6.0"
54
+ "@theokit/gateway": "0.7.0"
56
55
  },
57
56
  "publishConfig": {
58
57
  "access": "public",