@theokit/gateway-mattermost 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 +22 -0
- package/dist/index.d.cts +8 -1
- package/dist/index.d.ts +8 -1
- package/package.json +1 -1
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
|
@@ -8,7 +8,14 @@ import { BasePlatformAdapter, OutboundMessage, SendResult, MessageEvent, Gateway
|
|
|
8
8
|
interface MattermostAdapterOptions {
|
|
9
9
|
/** Mattermost base URL, e.g. `https://mattermost.acme.com`. No trailing slash. (D400) */
|
|
10
10
|
readonly baseUrl: string;
|
|
11
|
-
/**
|
|
11
|
+
/**
|
|
12
|
+
* The Mattermost bot's personal access token.
|
|
13
|
+
*
|
|
14
|
+
* @platform-term Mattermost calls this a **personal access token**. Note the divergence:
|
|
15
|
+
* `@mattermost/client` names its field `token`, and this one is `accessToken` — ours, not theirs.
|
|
16
|
+
* @issued-at Integrations → Bot Accounts in the Mattermost System Console, with personal access
|
|
17
|
+
* tokens enabled.
|
|
18
|
+
*/
|
|
12
19
|
readonly accessToken: string;
|
|
13
20
|
/**
|
|
14
21
|
* Whether the bot should require an `@mention` in non-DM channels (D403).
|
package/dist/index.d.ts
CHANGED
|
@@ -8,7 +8,14 @@ import { BasePlatformAdapter, OutboundMessage, SendResult, MessageEvent, Gateway
|
|
|
8
8
|
interface MattermostAdapterOptions {
|
|
9
9
|
/** Mattermost base URL, e.g. `https://mattermost.acme.com`. No trailing slash. (D400) */
|
|
10
10
|
readonly baseUrl: string;
|
|
11
|
-
/**
|
|
11
|
+
/**
|
|
12
|
+
* The Mattermost bot's personal access token.
|
|
13
|
+
*
|
|
14
|
+
* @platform-term Mattermost calls this a **personal access token**. Note the divergence:
|
|
15
|
+
* `@mattermost/client` names its field `token`, and this one is `accessToken` — ours, not theirs.
|
|
16
|
+
* @issued-at Integrations → Bot Accounts in the Mattermost System Console, with personal access
|
|
17
|
+
* tokens enabled.
|
|
18
|
+
*/
|
|
12
19
|
readonly accessToken: string;
|
|
13
20
|
/**
|
|
14
21
|
* Whether the bot should require an `@mention` in non-DM channels (D403).
|
package/package.json
CHANGED