@theokit/gateway-matrix 0.1.4 → 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,27 @@
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
+
3
25
  ## 0.1.4
4
26
 
5
27
  ### Patch Changes
package/dist/index.d.cts CHANGED
@@ -9,7 +9,13 @@ import { BasePlatformAdapter, OutboundMessage, SendResult, MessageEvent, Gateway
9
9
  interface MatrixAdapterOptions {
10
10
  /** Homeserver URL (e.g. `https://matrix.org`). No trailing slash. (D414) */
11
11
  readonly homeserverUrl: string;
12
- /** Long-lived access token (`syt_xxx`). Generate via Element → Settings → Help & About → Advanced. */
12
+ /**
13
+ * The Matrix user's access token.
14
+ *
15
+ * @platform-term Matrix calls this an **access token**, and `matrix-js-sdk` names the field
16
+ * `accessToken`, so the name here is theirs.
17
+ * @issued-at A login against the homeserver, or the admin API for an application service.
18
+ */
13
19
  readonly accessToken: string;
14
20
  /** Bot's full Matrix user id (`@bot:matrix.org`). */
15
21
  readonly userId: string;
package/dist/index.d.ts CHANGED
@@ -9,7 +9,13 @@ import { BasePlatformAdapter, OutboundMessage, SendResult, MessageEvent, Gateway
9
9
  interface MatrixAdapterOptions {
10
10
  /** Homeserver URL (e.g. `https://matrix.org`). No trailing slash. (D414) */
11
11
  readonly homeserverUrl: string;
12
- /** Long-lived access token (`syt_xxx`). Generate via Element → Settings → Help & About → Advanced. */
12
+ /**
13
+ * The Matrix user's access token.
14
+ *
15
+ * @platform-term Matrix calls this an **access token**, and `matrix-js-sdk` names the field
16
+ * `accessToken`, so the name here is theirs.
17
+ * @issued-at A login against the homeserver, or the admin API for an application service.
18
+ */
13
19
  readonly accessToken: string;
14
20
  /** Bot's full Matrix user id (`@bot:matrix.org`). */
15
21
  readonly userId: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@theokit/gateway-matrix",
3
- "version": "0.1.4",
3
+ "version": "0.1.5",
4
4
  "description": "Matrix protocol platform adapter for @theokit/gateway. ADRs D413-D421.",
5
5
  "license": "Apache-2.0",
6
6
  "repository": {