botshield-sdk 2.0.2 → 2.1.0

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.
Files changed (201) hide show
  1. package/README.md +10 -43
  2. package/bin/mcp-server.js +263 -500
  3. package/bin/mcp-server.js.map +27 -28
  4. package/dist/commonjs/funcs/census-verify-token.d.ts +1 -1
  5. package/dist/commonjs/funcs/census-verify-token.js +1 -67
  6. package/dist/commonjs/funcs/census-verify-token.js.map +1 -1
  7. package/dist/commonjs/funcs/verification-get-status.js +0 -66
  8. package/dist/commonjs/funcs/verification-get-status.js.map +1 -1
  9. package/dist/commonjs/lib/config.d.ts +2 -2
  10. package/dist/commonjs/lib/config.js +2 -2
  11. package/dist/commonjs/lib/security.d.ts.map +1 -1
  12. package/dist/commonjs/lib/security.js +0 -77
  13. package/dist/commonjs/lib/security.js.map +1 -1
  14. package/dist/commonjs/mcp-server/cli/start/command.d.ts.map +1 -1
  15. package/dist/commonjs/mcp-server/cli/start/command.js +0 -88
  16. package/dist/commonjs/mcp-server/cli/start/command.js.map +1 -1
  17. package/dist/commonjs/mcp-server/cli/start/impl.d.ts +0 -11
  18. package/dist/commonjs/mcp-server/cli/start/impl.d.ts.map +1 -1
  19. package/dist/commonjs/mcp-server/cli/start/impl.js +0 -22
  20. package/dist/commonjs/mcp-server/cli/start/impl.js.map +1 -1
  21. package/dist/commonjs/mcp-server/mcp-server.js +1 -1
  22. package/dist/commonjs/mcp-server/server.js +1 -1
  23. package/dist/commonjs/mcp-server/tools/actions-cancel-action.d.ts.map +1 -1
  24. package/dist/commonjs/mcp-server/tools/actions-cancel-action.js +1 -17
  25. package/dist/commonjs/mcp-server/tools/actions-cancel-action.js.map +1 -1
  26. package/dist/commonjs/mcp-server/tools/actions-check-action-status.d.ts.map +1 -1
  27. package/dist/commonjs/mcp-server/tools/actions-check-action-status.js +1 -17
  28. package/dist/commonjs/mcp-server/tools/actions-check-action-status.js.map +1 -1
  29. package/dist/commonjs/mcp-server/tools/actions-propose-action.d.ts.map +1 -1
  30. package/dist/commonjs/mcp-server/tools/actions-propose-action.js +1 -17
  31. package/dist/commonjs/mcp-server/tools/actions-propose-action.js.map +1 -1
  32. package/dist/commonjs/models/error-body.d.ts +43 -8
  33. package/dist/commonjs/models/error-body.d.ts.map +1 -1
  34. package/dist/commonjs/models/error-body.js +51 -1
  35. package/dist/commonjs/models/error-body.js.map +1 -1
  36. package/dist/commonjs/models/operations/actions-cancel.d.ts +1 -1
  37. package/dist/commonjs/models/operations/actions-check-status.d.ts +6 -6
  38. package/dist/commonjs/models/operations/actions-check-status.d.ts.map +1 -1
  39. package/dist/commonjs/models/operations/actions-check-status.js +6 -6
  40. package/dist/commonjs/models/operations/actions-check-status.js.map +1 -1
  41. package/dist/commonjs/models/operations/actions-propose.d.ts +1 -1
  42. package/dist/commonjs/models/operations/index.d.ts +0 -1
  43. package/dist/commonjs/models/operations/index.d.ts.map +1 -1
  44. package/dist/commonjs/models/operations/index.js +0 -1
  45. package/dist/commonjs/models/operations/index.js.map +1 -1
  46. package/dist/commonjs/models/operations/sdk-create-session.d.ts +49 -15
  47. package/dist/commonjs/models/operations/sdk-create-session.d.ts.map +1 -1
  48. package/dist/commonjs/models/operations/sdk-create-session.js +37 -16
  49. package/dist/commonjs/models/operations/sdk-create-session.js.map +1 -1
  50. package/dist/commonjs/models/operations/sdk-create-verification-link.d.ts +96 -2
  51. package/dist/commonjs/models/operations/sdk-create-verification-link.d.ts.map +1 -1
  52. package/dist/commonjs/models/operations/sdk-create-verification-link.js +58 -1
  53. package/dist/commonjs/models/operations/sdk-create-verification-link.js.map +1 -1
  54. package/dist/commonjs/models/operations/sdk-logout.d.ts +1 -1
  55. package/dist/commonjs/models/operations/sdk-revoke-verification.d.ts +14 -4
  56. package/dist/commonjs/models/operations/sdk-revoke-verification.d.ts.map +1 -1
  57. package/dist/commonjs/models/operations/sdk-revoke-verification.js +4 -2
  58. package/dist/commonjs/models/operations/sdk-revoke-verification.js.map +1 -1
  59. package/dist/commonjs/models/operations/sdk-store-signal.d.ts +1 -1
  60. package/dist/commonjs/models/operations/sdk-validate-signal.d.ts +6 -6
  61. package/dist/commonjs/models/operations/sdk-validate-signal.d.ts.map +1 -1
  62. package/dist/commonjs/models/operations/sdk-validate-signal.js +6 -6
  63. package/dist/commonjs/models/operations/sdk-validate-signal.js.map +1 -1
  64. package/dist/commonjs/models/operations/sdk-verify-token.d.ts +78 -23
  65. package/dist/commonjs/models/operations/sdk-verify-token.d.ts.map +1 -1
  66. package/dist/commonjs/models/operations/sdk-verify-token.js +51 -23
  67. package/dist/commonjs/models/operations/sdk-verify-token.js.map +1 -1
  68. package/dist/commonjs/models/operations/verification-get-status.d.ts +47 -26
  69. package/dist/commonjs/models/operations/verification-get-status.d.ts.map +1 -1
  70. package/dist/commonjs/models/operations/verification-get-status.js +30 -24
  71. package/dist/commonjs/models/operations/verification-get-status.js.map +1 -1
  72. package/dist/commonjs/models/security.d.ts +0 -22
  73. package/dist/commonjs/models/security.d.ts.map +1 -1
  74. package/dist/commonjs/models/security.js +0 -22
  75. package/dist/commonjs/models/security.js.map +1 -1
  76. package/dist/commonjs/sdk/census.d.ts +1 -8
  77. package/dist/commonjs/sdk/census.d.ts.map +1 -1
  78. package/dist/commonjs/sdk/census.js +1 -11
  79. package/dist/commonjs/sdk/census.js.map +1 -1
  80. package/dist/esm/funcs/census-verify-token.d.ts +1 -1
  81. package/dist/esm/funcs/census-verify-token.js +1 -67
  82. package/dist/esm/funcs/census-verify-token.js.map +1 -1
  83. package/dist/esm/funcs/verification-get-status.js +0 -66
  84. package/dist/esm/funcs/verification-get-status.js.map +1 -1
  85. package/dist/esm/lib/config.d.ts +2 -2
  86. package/dist/esm/lib/config.js +2 -2
  87. package/dist/esm/lib/security.d.ts.map +1 -1
  88. package/dist/esm/lib/security.js +0 -77
  89. package/dist/esm/lib/security.js.map +1 -1
  90. package/dist/esm/mcp-server/cli/start/command.d.ts.map +1 -1
  91. package/dist/esm/mcp-server/cli/start/command.js +0 -88
  92. package/dist/esm/mcp-server/cli/start/command.js.map +1 -1
  93. package/dist/esm/mcp-server/cli/start/impl.d.ts +0 -11
  94. package/dist/esm/mcp-server/cli/start/impl.d.ts.map +1 -1
  95. package/dist/esm/mcp-server/cli/start/impl.js +0 -22
  96. package/dist/esm/mcp-server/cli/start/impl.js.map +1 -1
  97. package/dist/esm/mcp-server/mcp-server.js +1 -1
  98. package/dist/esm/mcp-server/server.js +1 -1
  99. package/dist/esm/mcp-server/tools/actions-cancel-action.d.ts.map +1 -1
  100. package/dist/esm/mcp-server/tools/actions-cancel-action.js +1 -17
  101. package/dist/esm/mcp-server/tools/actions-cancel-action.js.map +1 -1
  102. package/dist/esm/mcp-server/tools/actions-check-action-status.d.ts.map +1 -1
  103. package/dist/esm/mcp-server/tools/actions-check-action-status.js +1 -17
  104. package/dist/esm/mcp-server/tools/actions-check-action-status.js.map +1 -1
  105. package/dist/esm/mcp-server/tools/actions-propose-action.d.ts.map +1 -1
  106. package/dist/esm/mcp-server/tools/actions-propose-action.js +1 -17
  107. package/dist/esm/mcp-server/tools/actions-propose-action.js.map +1 -1
  108. package/dist/esm/models/error-body.d.ts +43 -8
  109. package/dist/esm/models/error-body.d.ts.map +1 -1
  110. package/dist/esm/models/error-body.js +48 -0
  111. package/dist/esm/models/error-body.js.map +1 -1
  112. package/dist/esm/models/operations/actions-cancel.d.ts +1 -1
  113. package/dist/esm/models/operations/actions-check-status.d.ts +6 -6
  114. package/dist/esm/models/operations/actions-check-status.d.ts.map +1 -1
  115. package/dist/esm/models/operations/actions-check-status.js +5 -5
  116. package/dist/esm/models/operations/actions-check-status.js.map +1 -1
  117. package/dist/esm/models/operations/actions-propose.d.ts +1 -1
  118. package/dist/esm/models/operations/index.d.ts +0 -1
  119. package/dist/esm/models/operations/index.d.ts.map +1 -1
  120. package/dist/esm/models/operations/index.js +0 -1
  121. package/dist/esm/models/operations/index.js.map +1 -1
  122. package/dist/esm/models/operations/sdk-create-session.d.ts +49 -15
  123. package/dist/esm/models/operations/sdk-create-session.d.ts.map +1 -1
  124. package/dist/esm/models/operations/sdk-create-session.js +34 -13
  125. package/dist/esm/models/operations/sdk-create-session.js.map +1 -1
  126. package/dist/esm/models/operations/sdk-create-verification-link.d.ts +96 -2
  127. package/dist/esm/models/operations/sdk-create-verification-link.d.ts.map +1 -1
  128. package/dist/esm/models/operations/sdk-create-verification-link.js +57 -0
  129. package/dist/esm/models/operations/sdk-create-verification-link.js.map +1 -1
  130. package/dist/esm/models/operations/sdk-logout.d.ts +1 -1
  131. package/dist/esm/models/operations/sdk-revoke-verification.d.ts +14 -4
  132. package/dist/esm/models/operations/sdk-revoke-verification.d.ts.map +1 -1
  133. package/dist/esm/models/operations/sdk-revoke-verification.js +4 -2
  134. package/dist/esm/models/operations/sdk-revoke-verification.js.map +1 -1
  135. package/dist/esm/models/operations/sdk-store-signal.d.ts +1 -1
  136. package/dist/esm/models/operations/sdk-validate-signal.d.ts +6 -6
  137. package/dist/esm/models/operations/sdk-validate-signal.d.ts.map +1 -1
  138. package/dist/esm/models/operations/sdk-validate-signal.js +5 -5
  139. package/dist/esm/models/operations/sdk-validate-signal.js.map +1 -1
  140. package/dist/esm/models/operations/sdk-verify-token.d.ts +78 -23
  141. package/dist/esm/models/operations/sdk-verify-token.d.ts.map +1 -1
  142. package/dist/esm/models/operations/sdk-verify-token.js +50 -22
  143. package/dist/esm/models/operations/sdk-verify-token.js.map +1 -1
  144. package/dist/esm/models/operations/verification-get-status.d.ts +47 -26
  145. package/dist/esm/models/operations/verification-get-status.d.ts.map +1 -1
  146. package/dist/esm/models/operations/verification-get-status.js +29 -23
  147. package/dist/esm/models/operations/verification-get-status.js.map +1 -1
  148. package/dist/esm/models/security.d.ts +0 -22
  149. package/dist/esm/models/security.d.ts.map +1 -1
  150. package/dist/esm/models/security.js +0 -22
  151. package/dist/esm/models/security.js.map +1 -1
  152. package/dist/esm/sdk/census.d.ts +1 -8
  153. package/dist/esm/sdk/census.d.ts.map +1 -1
  154. package/dist/esm/sdk/census.js +1 -11
  155. package/dist/esm/sdk/census.js.map +1 -1
  156. package/jsr.json +1 -1
  157. package/package.json +1 -1
  158. package/src/funcs/census-verify-token.ts +1 -78
  159. package/src/funcs/verification-get-status.ts +0 -77
  160. package/src/lib/config.ts +2 -2
  161. package/src/lib/security.ts +0 -77
  162. package/src/mcp-server/cli/start/command.ts +0 -88
  163. package/src/mcp-server/cli/start/impl.ts +0 -33
  164. package/src/mcp-server/mcp-server.ts +1 -1
  165. package/src/mcp-server/server.ts +1 -1
  166. package/src/mcp-server/tools/actions-cancel-action.ts +1 -17
  167. package/src/mcp-server/tools/actions-check-action-status.ts +1 -17
  168. package/src/mcp-server/tools/actions-propose-action.ts +1 -17
  169. package/src/models/error-body.ts +95 -8
  170. package/src/models/operations/actions-cancel.ts +1 -1
  171. package/src/models/operations/actions-check-status.ts +18 -10
  172. package/src/models/operations/actions-propose.ts +1 -1
  173. package/src/models/operations/index.ts +0 -1
  174. package/src/models/operations/sdk-create-session.ts +89 -33
  175. package/src/models/operations/sdk-create-verification-link.ts +157 -2
  176. package/src/models/operations/sdk-logout.ts +1 -1
  177. package/src/models/operations/sdk-revoke-verification.ts +18 -6
  178. package/src/models/operations/sdk-store-signal.ts +1 -1
  179. package/src/models/operations/sdk-validate-signal.ts +16 -10
  180. package/src/models/operations/sdk-verify-token.ts +119 -45
  181. package/src/models/operations/verification-get-status.ts +73 -48
  182. package/src/models/security.ts +0 -44
  183. package/src/sdk/census.ts +1 -21
  184. package/dist/commonjs/funcs/census-get-partner-config.d.ts +0 -18
  185. package/dist/commonjs/funcs/census-get-partner-config.d.ts.map +0 -1
  186. package/dist/commonjs/funcs/census-get-partner-config.js +0 -210
  187. package/dist/commonjs/funcs/census-get-partner-config.js.map +0 -1
  188. package/dist/commonjs/models/operations/sdk-get-partner-config.d.ts +0 -152
  189. package/dist/commonjs/models/operations/sdk-get-partner-config.d.ts.map +0 -1
  190. package/dist/commonjs/models/operations/sdk-get-partner-config.js +0 -205
  191. package/dist/commonjs/models/operations/sdk-get-partner-config.js.map +0 -1
  192. package/dist/esm/funcs/census-get-partner-config.d.ts +0 -18
  193. package/dist/esm/funcs/census-get-partner-config.d.ts.map +0 -1
  194. package/dist/esm/funcs/census-get-partner-config.js +0 -174
  195. package/dist/esm/funcs/census-get-partner-config.js.map +0 -1
  196. package/dist/esm/models/operations/sdk-get-partner-config.d.ts +0 -152
  197. package/dist/esm/models/operations/sdk-get-partner-config.d.ts.map +0 -1
  198. package/dist/esm/models/operations/sdk-get-partner-config.js +0 -157
  199. package/dist/esm/models/operations/sdk-get-partner-config.js.map +0 -1
  200. package/src/funcs/census-get-partner-config.ts +0 -287
  201. package/src/models/operations/sdk-get-partner-config.ts +0 -397
package/README.md CHANGED
@@ -49,6 +49,8 @@ BotShield API: Human presence verification protocol.
49
49
  **Backend SDK:** install `botshield-sdk` from npm and use `client.census.*`, `client.verification.*`, `client.actions.*`.
50
50
 
51
51
  **Response envelope:** every operation answers HTTP 200 with `{ data: ... }`. Most carry the result one level deeper (`data.data`); `logout` and `verification/status` carry it directly. Handler errors are also HTTP 200 — `data.error = { message, statusCode }` — so check `data.error` before reading a result. HTTP 400 is reserved for input validation (`InvalidInputError`), 500 for unhandled failures.
52
+
53
+ **Alias window (2026-10-15 → 2027-01-15):** renamed wire symbols are dual-served — old names accepted on input and emitted beside the new until the sunset; any response where an alias was used carries `Deprecation`, `Sunset` and `Link` headers and `data._deprecation`. Changelog: https://docs.botshield.ai/changelog/alias-window
52
54
  <!-- End Summary [summary] -->
53
55
 
54
56
  <!-- Start Table of Contents [toc] -->
@@ -130,18 +132,7 @@ Add the following server definition to your `claude_desktop_config.json` file:
130
132
  "--agent-key-auth", "...",
131
133
  "--agent-key-auth1", "...",
132
134
  "--agent-key-auth2", "...",
133
- "--agent-key-auth3", "...",
134
- "--agent-key-auth4", "...",
135
- "--agent-key-auth5", "...",
136
- "--agent-key-auth6", "...",
137
- "--agent-key-auth7", "...",
138
- "--agent-key-auth8", "...",
139
- "--agent-key-auth9", "...",
140
- "--agent-key-auth10", "...",
141
- "--agent-key-auth11", "...",
142
- "--agent-key-auth12", "...",
143
- "--agent-key-auth13", "...",
144
- "--agent-key-auth14", "..."
135
+ "--agent-key-auth3", "..."
145
136
  ]
146
137
  }
147
138
  }
@@ -167,18 +158,7 @@ Create a `.cursor/mcp.json` file in your project root with the following content
167
158
  "--agent-key-auth", "...",
168
159
  "--agent-key-auth1", "...",
169
160
  "--agent-key-auth2", "...",
170
- "--agent-key-auth3", "...",
171
- "--agent-key-auth4", "...",
172
- "--agent-key-auth5", "...",
173
- "--agent-key-auth6", "...",
174
- "--agent-key-auth7", "...",
175
- "--agent-key-auth8", "...",
176
- "--agent-key-auth9", "...",
177
- "--agent-key-auth10", "...",
178
- "--agent-key-auth11", "...",
179
- "--agent-key-auth12", "...",
180
- "--agent-key-auth13", "...",
181
- "--agent-key-auth14", "..."
161
+ "--agent-key-auth3", "..."
182
162
  ]
183
163
  }
184
164
  }
@@ -254,23 +234,12 @@ run();
254
234
 
255
235
  This SDK supports the following security schemes globally:
256
236
 
257
- | Name | Type | Scheme |
258
- | ---------------- | ------ | ------- |
259
- | `agentKeyAuth` | apiKey | API key |
260
- | `agentKeyAuth1` | apiKey | API key |
261
- | `agentKeyAuth2` | apiKey | API key |
262
- | `agentKeyAuth3` | apiKey | API key |
263
- | `agentKeyAuth4` | apiKey | API key |
264
- | `agentKeyAuth5` | apiKey | API key |
265
- | `agentKeyAuth6` | apiKey | API key |
266
- | `agentKeyAuth7` | apiKey | API key |
267
- | `agentKeyAuth8` | apiKey | API key |
268
- | `agentKeyAuth9` | apiKey | API key |
269
- | `agentKeyAuth10` | apiKey | API key |
270
- | `agentKeyAuth11` | apiKey | API key |
271
- | `agentKeyAuth12` | apiKey | API key |
272
- | `agentKeyAuth13` | apiKey | API key |
273
- | `agentKeyAuth14` | apiKey | API key |
237
+ | Name | Type | Scheme |
238
+ | --------------- | ------ | ------- |
239
+ | `agentKeyAuth` | apiKey | API key |
240
+ | `agentKeyAuth1` | apiKey | API key |
241
+ | `agentKeyAuth2` | apiKey | API key |
242
+ | `agentKeyAuth3` | apiKey | API key |
274
243
 
275
244
  You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:
276
245
  ```typescript
@@ -335,7 +304,6 @@ run();
335
304
  * [verifyToken](docs/sdks/census/README.md#verifytoken) - Validate a verification token
336
305
  * [storeSignal](docs/sdks/census/README.md#storesignal) - Store a Signal Pixel bot score
337
306
  * [validateSignal](docs/sdks/census/README.md#validatesignal) - Validate a signal token
338
- * [getPartnerConfig](docs/sdks/census/README.md#getpartnerconfig) - Get partner configuration
339
307
  * [revokeVerification](docs/sdks/census/README.md#revokeverification) - Revoke a pending verification
340
308
  * [logout](docs/sdks/census/README.md#logout) - Revoke a grant token
341
309
 
@@ -366,7 +334,6 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
366
334
  - [`actionsProposeAction`](docs/sdks/actions/README.md#proposeaction) - Propose an action for human confirmation
367
335
  - [`censusCreateSession`](docs/sdks/census/README.md#createsession) - Create a grant token
368
336
  - [`censusCreateVerificationLink`](docs/sdks/census/README.md#createverificationlink) - Create a verification request
369
- - [`censusGetPartnerConfig`](docs/sdks/census/README.md#getpartnerconfig) - Get partner configuration
370
337
  - [`censusLogout`](docs/sdks/census/README.md#logout) - Revoke a grant token
371
338
  - [`censusRevokeVerification`](docs/sdks/census/README.md#revokeverification) - Revoke a pending verification
372
339
  - [`censusStoreSignal`](docs/sdks/census/README.md#storesignal) - Store a Signal Pixel bot score