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.
- package/README.md +10 -43
- package/bin/mcp-server.js +263 -500
- package/bin/mcp-server.js.map +27 -28
- package/dist/commonjs/funcs/census-verify-token.d.ts +1 -1
- package/dist/commonjs/funcs/census-verify-token.js +1 -67
- package/dist/commonjs/funcs/census-verify-token.js.map +1 -1
- package/dist/commonjs/funcs/verification-get-status.js +0 -66
- package/dist/commonjs/funcs/verification-get-status.js.map +1 -1
- package/dist/commonjs/lib/config.d.ts +2 -2
- package/dist/commonjs/lib/config.js +2 -2
- package/dist/commonjs/lib/security.d.ts.map +1 -1
- package/dist/commonjs/lib/security.js +0 -77
- package/dist/commonjs/lib/security.js.map +1 -1
- package/dist/commonjs/mcp-server/cli/start/command.d.ts.map +1 -1
- package/dist/commonjs/mcp-server/cli/start/command.js +0 -88
- package/dist/commonjs/mcp-server/cli/start/command.js.map +1 -1
- package/dist/commonjs/mcp-server/cli/start/impl.d.ts +0 -11
- package/dist/commonjs/mcp-server/cli/start/impl.d.ts.map +1 -1
- package/dist/commonjs/mcp-server/cli/start/impl.js +0 -22
- package/dist/commonjs/mcp-server/cli/start/impl.js.map +1 -1
- package/dist/commonjs/mcp-server/mcp-server.js +1 -1
- package/dist/commonjs/mcp-server/server.js +1 -1
- package/dist/commonjs/mcp-server/tools/actions-cancel-action.d.ts.map +1 -1
- package/dist/commonjs/mcp-server/tools/actions-cancel-action.js +1 -17
- package/dist/commonjs/mcp-server/tools/actions-cancel-action.js.map +1 -1
- package/dist/commonjs/mcp-server/tools/actions-check-action-status.d.ts.map +1 -1
- package/dist/commonjs/mcp-server/tools/actions-check-action-status.js +1 -17
- package/dist/commonjs/mcp-server/tools/actions-check-action-status.js.map +1 -1
- package/dist/commonjs/mcp-server/tools/actions-propose-action.d.ts.map +1 -1
- package/dist/commonjs/mcp-server/tools/actions-propose-action.js +1 -17
- package/dist/commonjs/mcp-server/tools/actions-propose-action.js.map +1 -1
- package/dist/commonjs/models/error-body.d.ts +43 -8
- package/dist/commonjs/models/error-body.d.ts.map +1 -1
- package/dist/commonjs/models/error-body.js +51 -1
- package/dist/commonjs/models/error-body.js.map +1 -1
- package/dist/commonjs/models/operations/actions-cancel.d.ts +1 -1
- package/dist/commonjs/models/operations/actions-check-status.d.ts +6 -6
- package/dist/commonjs/models/operations/actions-check-status.d.ts.map +1 -1
- package/dist/commonjs/models/operations/actions-check-status.js +6 -6
- package/dist/commonjs/models/operations/actions-check-status.js.map +1 -1
- package/dist/commonjs/models/operations/actions-propose.d.ts +1 -1
- package/dist/commonjs/models/operations/index.d.ts +0 -1
- package/dist/commonjs/models/operations/index.d.ts.map +1 -1
- package/dist/commonjs/models/operations/index.js +0 -1
- package/dist/commonjs/models/operations/index.js.map +1 -1
- package/dist/commonjs/models/operations/sdk-create-session.d.ts +49 -15
- package/dist/commonjs/models/operations/sdk-create-session.d.ts.map +1 -1
- package/dist/commonjs/models/operations/sdk-create-session.js +37 -16
- package/dist/commonjs/models/operations/sdk-create-session.js.map +1 -1
- package/dist/commonjs/models/operations/sdk-create-verification-link.d.ts +96 -2
- package/dist/commonjs/models/operations/sdk-create-verification-link.d.ts.map +1 -1
- package/dist/commonjs/models/operations/sdk-create-verification-link.js +58 -1
- package/dist/commonjs/models/operations/sdk-create-verification-link.js.map +1 -1
- package/dist/commonjs/models/operations/sdk-logout.d.ts +1 -1
- package/dist/commonjs/models/operations/sdk-revoke-verification.d.ts +14 -4
- package/dist/commonjs/models/operations/sdk-revoke-verification.d.ts.map +1 -1
- package/dist/commonjs/models/operations/sdk-revoke-verification.js +4 -2
- package/dist/commonjs/models/operations/sdk-revoke-verification.js.map +1 -1
- package/dist/commonjs/models/operations/sdk-store-signal.d.ts +1 -1
- package/dist/commonjs/models/operations/sdk-validate-signal.d.ts +6 -6
- package/dist/commonjs/models/operations/sdk-validate-signal.d.ts.map +1 -1
- package/dist/commonjs/models/operations/sdk-validate-signal.js +6 -6
- package/dist/commonjs/models/operations/sdk-validate-signal.js.map +1 -1
- package/dist/commonjs/models/operations/sdk-verify-token.d.ts +78 -23
- package/dist/commonjs/models/operations/sdk-verify-token.d.ts.map +1 -1
- package/dist/commonjs/models/operations/sdk-verify-token.js +51 -23
- package/dist/commonjs/models/operations/sdk-verify-token.js.map +1 -1
- package/dist/commonjs/models/operations/verification-get-status.d.ts +47 -26
- package/dist/commonjs/models/operations/verification-get-status.d.ts.map +1 -1
- package/dist/commonjs/models/operations/verification-get-status.js +30 -24
- package/dist/commonjs/models/operations/verification-get-status.js.map +1 -1
- package/dist/commonjs/models/security.d.ts +0 -22
- package/dist/commonjs/models/security.d.ts.map +1 -1
- package/dist/commonjs/models/security.js +0 -22
- package/dist/commonjs/models/security.js.map +1 -1
- package/dist/commonjs/sdk/census.d.ts +1 -8
- package/dist/commonjs/sdk/census.d.ts.map +1 -1
- package/dist/commonjs/sdk/census.js +1 -11
- package/dist/commonjs/sdk/census.js.map +1 -1
- package/dist/esm/funcs/census-verify-token.d.ts +1 -1
- package/dist/esm/funcs/census-verify-token.js +1 -67
- package/dist/esm/funcs/census-verify-token.js.map +1 -1
- package/dist/esm/funcs/verification-get-status.js +0 -66
- package/dist/esm/funcs/verification-get-status.js.map +1 -1
- package/dist/esm/lib/config.d.ts +2 -2
- package/dist/esm/lib/config.js +2 -2
- package/dist/esm/lib/security.d.ts.map +1 -1
- package/dist/esm/lib/security.js +0 -77
- package/dist/esm/lib/security.js.map +1 -1
- package/dist/esm/mcp-server/cli/start/command.d.ts.map +1 -1
- package/dist/esm/mcp-server/cli/start/command.js +0 -88
- package/dist/esm/mcp-server/cli/start/command.js.map +1 -1
- package/dist/esm/mcp-server/cli/start/impl.d.ts +0 -11
- package/dist/esm/mcp-server/cli/start/impl.d.ts.map +1 -1
- package/dist/esm/mcp-server/cli/start/impl.js +0 -22
- package/dist/esm/mcp-server/cli/start/impl.js.map +1 -1
- package/dist/esm/mcp-server/mcp-server.js +1 -1
- package/dist/esm/mcp-server/server.js +1 -1
- package/dist/esm/mcp-server/tools/actions-cancel-action.d.ts.map +1 -1
- package/dist/esm/mcp-server/tools/actions-cancel-action.js +1 -17
- package/dist/esm/mcp-server/tools/actions-cancel-action.js.map +1 -1
- package/dist/esm/mcp-server/tools/actions-check-action-status.d.ts.map +1 -1
- package/dist/esm/mcp-server/tools/actions-check-action-status.js +1 -17
- package/dist/esm/mcp-server/tools/actions-check-action-status.js.map +1 -1
- package/dist/esm/mcp-server/tools/actions-propose-action.d.ts.map +1 -1
- package/dist/esm/mcp-server/tools/actions-propose-action.js +1 -17
- package/dist/esm/mcp-server/tools/actions-propose-action.js.map +1 -1
- package/dist/esm/models/error-body.d.ts +43 -8
- package/dist/esm/models/error-body.d.ts.map +1 -1
- package/dist/esm/models/error-body.js +48 -0
- package/dist/esm/models/error-body.js.map +1 -1
- package/dist/esm/models/operations/actions-cancel.d.ts +1 -1
- package/dist/esm/models/operations/actions-check-status.d.ts +6 -6
- package/dist/esm/models/operations/actions-check-status.d.ts.map +1 -1
- package/dist/esm/models/operations/actions-check-status.js +5 -5
- package/dist/esm/models/operations/actions-check-status.js.map +1 -1
- package/dist/esm/models/operations/actions-propose.d.ts +1 -1
- package/dist/esm/models/operations/index.d.ts +0 -1
- package/dist/esm/models/operations/index.d.ts.map +1 -1
- package/dist/esm/models/operations/index.js +0 -1
- package/dist/esm/models/operations/index.js.map +1 -1
- package/dist/esm/models/operations/sdk-create-session.d.ts +49 -15
- package/dist/esm/models/operations/sdk-create-session.d.ts.map +1 -1
- package/dist/esm/models/operations/sdk-create-session.js +34 -13
- package/dist/esm/models/operations/sdk-create-session.js.map +1 -1
- package/dist/esm/models/operations/sdk-create-verification-link.d.ts +96 -2
- package/dist/esm/models/operations/sdk-create-verification-link.d.ts.map +1 -1
- package/dist/esm/models/operations/sdk-create-verification-link.js +57 -0
- package/dist/esm/models/operations/sdk-create-verification-link.js.map +1 -1
- package/dist/esm/models/operations/sdk-logout.d.ts +1 -1
- package/dist/esm/models/operations/sdk-revoke-verification.d.ts +14 -4
- package/dist/esm/models/operations/sdk-revoke-verification.d.ts.map +1 -1
- package/dist/esm/models/operations/sdk-revoke-verification.js +4 -2
- package/dist/esm/models/operations/sdk-revoke-verification.js.map +1 -1
- package/dist/esm/models/operations/sdk-store-signal.d.ts +1 -1
- package/dist/esm/models/operations/sdk-validate-signal.d.ts +6 -6
- package/dist/esm/models/operations/sdk-validate-signal.d.ts.map +1 -1
- package/dist/esm/models/operations/sdk-validate-signal.js +5 -5
- package/dist/esm/models/operations/sdk-validate-signal.js.map +1 -1
- package/dist/esm/models/operations/sdk-verify-token.d.ts +78 -23
- package/dist/esm/models/operations/sdk-verify-token.d.ts.map +1 -1
- package/dist/esm/models/operations/sdk-verify-token.js +50 -22
- package/dist/esm/models/operations/sdk-verify-token.js.map +1 -1
- package/dist/esm/models/operations/verification-get-status.d.ts +47 -26
- package/dist/esm/models/operations/verification-get-status.d.ts.map +1 -1
- package/dist/esm/models/operations/verification-get-status.js +29 -23
- package/dist/esm/models/operations/verification-get-status.js.map +1 -1
- package/dist/esm/models/security.d.ts +0 -22
- package/dist/esm/models/security.d.ts.map +1 -1
- package/dist/esm/models/security.js +0 -22
- package/dist/esm/models/security.js.map +1 -1
- package/dist/esm/sdk/census.d.ts +1 -8
- package/dist/esm/sdk/census.d.ts.map +1 -1
- package/dist/esm/sdk/census.js +1 -11
- package/dist/esm/sdk/census.js.map +1 -1
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/funcs/census-verify-token.ts +1 -78
- package/src/funcs/verification-get-status.ts +0 -77
- package/src/lib/config.ts +2 -2
- package/src/lib/security.ts +0 -77
- package/src/mcp-server/cli/start/command.ts +0 -88
- package/src/mcp-server/cli/start/impl.ts +0 -33
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +1 -1
- package/src/mcp-server/tools/actions-cancel-action.ts +1 -17
- package/src/mcp-server/tools/actions-check-action-status.ts +1 -17
- package/src/mcp-server/tools/actions-propose-action.ts +1 -17
- package/src/models/error-body.ts +95 -8
- package/src/models/operations/actions-cancel.ts +1 -1
- package/src/models/operations/actions-check-status.ts +18 -10
- package/src/models/operations/actions-propose.ts +1 -1
- package/src/models/operations/index.ts +0 -1
- package/src/models/operations/sdk-create-session.ts +89 -33
- package/src/models/operations/sdk-create-verification-link.ts +157 -2
- package/src/models/operations/sdk-logout.ts +1 -1
- package/src/models/operations/sdk-revoke-verification.ts +18 -6
- package/src/models/operations/sdk-store-signal.ts +1 -1
- package/src/models/operations/sdk-validate-signal.ts +16 -10
- package/src/models/operations/sdk-verify-token.ts +119 -45
- package/src/models/operations/verification-get-status.ts +73 -48
- package/src/models/security.ts +0 -44
- package/src/sdk/census.ts +1 -21
- package/dist/commonjs/funcs/census-get-partner-config.d.ts +0 -18
- package/dist/commonjs/funcs/census-get-partner-config.d.ts.map +0 -1
- package/dist/commonjs/funcs/census-get-partner-config.js +0 -210
- package/dist/commonjs/funcs/census-get-partner-config.js.map +0 -1
- package/dist/commonjs/models/operations/sdk-get-partner-config.d.ts +0 -152
- package/dist/commonjs/models/operations/sdk-get-partner-config.d.ts.map +0 -1
- package/dist/commonjs/models/operations/sdk-get-partner-config.js +0 -205
- package/dist/commonjs/models/operations/sdk-get-partner-config.js.map +0 -1
- package/dist/esm/funcs/census-get-partner-config.d.ts +0 -18
- package/dist/esm/funcs/census-get-partner-config.d.ts.map +0 -1
- package/dist/esm/funcs/census-get-partner-config.js +0 -174
- package/dist/esm/funcs/census-get-partner-config.js.map +0 -1
- package/dist/esm/models/operations/sdk-get-partner-config.d.ts +0 -152
- package/dist/esm/models/operations/sdk-get-partner-config.d.ts.map +0 -1
- package/dist/esm/models/operations/sdk-get-partner-config.js +0 -157
- package/dist/esm/models/operations/sdk-get-partner-config.js.map +0 -1
- package/src/funcs/census-get-partner-config.ts +0 -287
- 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
|
|
258
|
-
|
|
|
259
|
-
| `agentKeyAuth`
|
|
260
|
-
| `agentKeyAuth1`
|
|
261
|
-
| `agentKeyAuth2`
|
|
262
|
-
| `agentKeyAuth3`
|
|
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
|