@theokit/gateway-whatsapp 0.3.1 → 0.3.2
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.cjs.map +1 -1
- package/dist/index.d.cts +21 -2
- package/dist/index.d.ts +21 -2
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -166,11 +166,30 @@ interface WhatsAppBackend {
|
|
|
166
166
|
|
|
167
167
|
/** Cloud (Meta WhatsApp Business Cloud API) backend config (ADR D304). */
|
|
168
168
|
interface WhatsAppCloudConfig {
|
|
169
|
-
/**
|
|
169
|
+
/**
|
|
170
|
+
* The Meta system user's access token for the WhatsApp Business account.
|
|
171
|
+
*
|
|
172
|
+
* @platform-term Meta calls this an **access token**. Unlike the other adapters' terms, this one
|
|
173
|
+
* is NOT pinned to a package under `node_modules` — the Cloud backend calls the Graph API with
|
|
174
|
+
* `fetch`, so there is no Meta SDK in the dependency graph to check against. It rests on Meta's
|
|
175
|
+
* own documentation, and our client sends it as `authorization: Bearer …`, never as an
|
|
176
|
+
* `access_token` parameter.
|
|
177
|
+
* @issued-at Meta Business Manager, under System Users → Generate token, scoped to the WhatsApp
|
|
178
|
+
* Business account.
|
|
179
|
+
*/
|
|
170
180
|
readonly accessToken: string;
|
|
171
181
|
/** Meta-issued phone-number-id (NOT the user-facing phone). */
|
|
172
182
|
readonly phoneNumberId: string;
|
|
173
|
-
/**
|
|
183
|
+
/**
|
|
184
|
+
* The Meta app secret, used to verify `X-Hub-Signature-256` on inbound WhatsApp webhooks.
|
|
185
|
+
*
|
|
186
|
+
* @platform-term Meta calls this an **app secret** — note it belongs to the Meta app, not to the
|
|
187
|
+
* WhatsApp Business account, which is why it is issued somewhere different from the access token
|
|
188
|
+
* above. It signs inbound payloads and never
|
|
189
|
+
* authenticates outbound calls, which is why it is optional: an adapter that only sends does
|
|
190
|
+
* not need it.
|
|
191
|
+
* @issued-at Meta for Developers, under the app's Settings → Basic.
|
|
192
|
+
*/
|
|
174
193
|
readonly appSecret: string;
|
|
175
194
|
/** Graph API version. Defaults to `v18.0`. */
|
|
176
195
|
readonly apiVersion?: string;
|
package/dist/index.d.ts
CHANGED
|
@@ -166,11 +166,30 @@ interface WhatsAppBackend {
|
|
|
166
166
|
|
|
167
167
|
/** Cloud (Meta WhatsApp Business Cloud API) backend config (ADR D304). */
|
|
168
168
|
interface WhatsAppCloudConfig {
|
|
169
|
-
/**
|
|
169
|
+
/**
|
|
170
|
+
* The Meta system user's access token for the WhatsApp Business account.
|
|
171
|
+
*
|
|
172
|
+
* @platform-term Meta calls this an **access token**. Unlike the other adapters' terms, this one
|
|
173
|
+
* is NOT pinned to a package under `node_modules` — the Cloud backend calls the Graph API with
|
|
174
|
+
* `fetch`, so there is no Meta SDK in the dependency graph to check against. It rests on Meta's
|
|
175
|
+
* own documentation, and our client sends it as `authorization: Bearer …`, never as an
|
|
176
|
+
* `access_token` parameter.
|
|
177
|
+
* @issued-at Meta Business Manager, under System Users → Generate token, scoped to the WhatsApp
|
|
178
|
+
* Business account.
|
|
179
|
+
*/
|
|
170
180
|
readonly accessToken: string;
|
|
171
181
|
/** Meta-issued phone-number-id (NOT the user-facing phone). */
|
|
172
182
|
readonly phoneNumberId: string;
|
|
173
|
-
/**
|
|
183
|
+
/**
|
|
184
|
+
* The Meta app secret, used to verify `X-Hub-Signature-256` on inbound WhatsApp webhooks.
|
|
185
|
+
*
|
|
186
|
+
* @platform-term Meta calls this an **app secret** — note it belongs to the Meta app, not to the
|
|
187
|
+
* WhatsApp Business account, which is why it is issued somewhere different from the access token
|
|
188
|
+
* above. It signs inbound payloads and never
|
|
189
|
+
* authenticates outbound calls, which is why it is optional: an adapter that only sends does
|
|
190
|
+
* not need it.
|
|
191
|
+
* @issued-at Meta for Developers, under the app's Settings → Basic.
|
|
192
|
+
*/
|
|
174
193
|
readonly appSecret: string;
|
|
175
194
|
/** Graph API version. Defaults to `v18.0`. */
|
|
176
195
|
readonly apiVersion?: string;
|