@theokit/gateway-line 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
@@ -38,9 +38,21 @@ interface LineSdkClient {
38
38
  * @public
39
39
  */
40
40
  interface LineAdapterOptions {
41
- /** From LINE Developers Console → Messaging API → Channel secret. */
41
+ /**
42
+ * The LINE channel secret, used to verify the `x-line-signature` header on inbound webhooks.
43
+ *
44
+ * @platform-term LINE calls this a **channel secret** — its own word, and distinct from the
45
+ * channel access token above: this one signs, that one authenticates.
46
+ * @issued-at The LINE Developers Console, on the channel's Basic settings tab.
47
+ */
42
48
  readonly channelSecret: string;
43
- /** From LINE Developers Console → Messaging API → Channel access token (long-lived). */
49
+ /**
50
+ * The LINE channel's long-lived access token.
51
+ *
52
+ * @platform-term LINE calls this a **channel access token** — the same word `@line/bot-sdk` uses
53
+ * for this field, so the name here is theirs and not ours.
54
+ * @issued-at The LINE Developers Console, under the channel's Messaging API tab.
55
+ */
44
56
  readonly channelAccessToken: string;
45
57
  /**
46
58
  * Bot's own LINE user id (`Uxxx...`). When set + `requireMention: true`,
package/dist/index.d.ts CHANGED
@@ -38,9 +38,21 @@ interface LineSdkClient {
38
38
  * @public
39
39
  */
40
40
  interface LineAdapterOptions {
41
- /** From LINE Developers Console → Messaging API → Channel secret. */
41
+ /**
42
+ * The LINE channel secret, used to verify the `x-line-signature` header on inbound webhooks.
43
+ *
44
+ * @platform-term LINE calls this a **channel secret** — its own word, and distinct from the
45
+ * channel access token above: this one signs, that one authenticates.
46
+ * @issued-at The LINE Developers Console, on the channel's Basic settings tab.
47
+ */
42
48
  readonly channelSecret: string;
43
- /** From LINE Developers Console → Messaging API → Channel access token (long-lived). */
49
+ /**
50
+ * The LINE channel's long-lived access token.
51
+ *
52
+ * @platform-term LINE calls this a **channel access token** — the same word `@line/bot-sdk` uses
53
+ * for this field, so the name here is theirs and not ours.
54
+ * @issued-at The LINE Developers Console, under the channel's Messaging API tab.
55
+ */
44
56
  readonly channelAccessToken: string;
45
57
  /**
46
58
  * Bot's own LINE user id (`Uxxx...`). When set + `requireMention: true`,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@theokit/gateway-line",
3
- "version": "0.1.4",
3
+ "version": "0.1.5",
4
4
  "description": "LINE Messaging API platform adapter for @theokit/gateway. ADRs D405-D412.",
5
5
  "license": "Apache-2.0",
6
6
  "repository": {