botshield-sdk 2.0.1 → 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/LICENSE +21 -0
- package/README.md +41 -8
- package/bin/mcp-server.js +309 -173
- 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 +13 -1
- package/dist/commonjs/funcs/census-verify-token.js.map +1 -1
- package/dist/commonjs/funcs/verification-get-status.js +12 -0
- 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 +14 -0
- 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 +16 -0
- package/dist/commonjs/mcp-server/cli/start/command.js.map +1 -1
- package/dist/commonjs/mcp-server/cli/start/impl.d.ts +2 -0
- package/dist/commonjs/mcp-server/cli/start/impl.d.ts.map +1 -1
- package/dist/commonjs/mcp-server/cli/start/impl.js +4 -0
- 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.js +1 -1
- package/dist/commonjs/mcp-server/tools/actions-cancel-action.js.map +1 -1
- package/dist/commonjs/mcp-server/tools/actions-check-action-status.js +1 -1
- package/dist/commonjs/mcp-server/tools/actions-check-action-status.js.map +1 -1
- package/dist/commonjs/mcp-server/tools/actions-propose-action.js +1 -1
- 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 +82 -1
- package/dist/commonjs/models/operations/sdk-verify-token.d.ts.map +1 -1
- package/dist/commonjs/models/operations/sdk-verify-token.js +55 -1
- package/dist/commonjs/models/operations/sdk-verify-token.js.map +1 -1
- package/dist/commonjs/models/operations/verification-get-status.d.ts +51 -4
- package/dist/commonjs/models/operations/verification-get-status.d.ts.map +1 -1
- package/dist/commonjs/models/operations/verification-get-status.js +34 -2
- package/dist/commonjs/models/operations/verification-get-status.js.map +1 -1
- package/dist/commonjs/models/security.d.ts +4 -0
- package/dist/commonjs/models/security.d.ts.map +1 -1
- package/dist/commonjs/models/security.js +4 -0
- 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 +13 -1
- package/dist/esm/funcs/census-verify-token.js.map +1 -1
- package/dist/esm/funcs/verification-get-status.js +12 -0
- 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 +14 -0
- 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 +16 -0
- package/dist/esm/mcp-server/cli/start/command.js.map +1 -1
- package/dist/esm/mcp-server/cli/start/impl.d.ts +2 -0
- package/dist/esm/mcp-server/cli/start/impl.d.ts.map +1 -1
- package/dist/esm/mcp-server/cli/start/impl.js +4 -0
- 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.js +1 -1
- package/dist/esm/mcp-server/tools/actions-cancel-action.js.map +1 -1
- package/dist/esm/mcp-server/tools/actions-check-action-status.js +1 -1
- package/dist/esm/mcp-server/tools/actions-check-action-status.js.map +1 -1
- package/dist/esm/mcp-server/tools/actions-propose-action.js +1 -1
- 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 +82 -1
- package/dist/esm/models/operations/sdk-verify-token.d.ts.map +1 -1
- package/dist/esm/models/operations/sdk-verify-token.js +54 -0
- package/dist/esm/models/operations/sdk-verify-token.js.map +1 -1
- package/dist/esm/models/operations/verification-get-status.d.ts +51 -4
- package/dist/esm/models/operations/verification-get-status.d.ts.map +1 -1
- package/dist/esm/models/operations/verification-get-status.js +33 -1
- package/dist/esm/models/operations/verification-get-status.js.map +1 -1
- package/dist/esm/models/security.d.ts +4 -0
- package/dist/esm/models/security.d.ts.map +1 -1
- package/dist/esm/models/security.js +4 -0
- 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 +16 -1
- package/src/funcs/census-verify-token.ts +15 -1
- package/src/funcs/verification-get-status.ts +14 -0
- package/src/lib/config.ts +2 -2
- package/src/lib/security.ts +14 -0
- package/src/mcp-server/cli/start/command.ts +16 -0
- package/src/mcp-server/cli/start/impl.ts +6 -0
- 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 -1
- package/src/mcp-server/tools/actions-check-action-status.ts +1 -1
- package/src/mcp-server/tools/actions-propose-action.ts +1 -1
- 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 +127 -1
- package/src/models/operations/verification-get-status.ts +81 -4
- package/src/models/security.ts +8 -0
- 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 -132
- package/dist/commonjs/funcs/census-get-partner-config.js.map +0 -1
- package/dist/commonjs/models/operations/sdk-get-partner-config.d.ts +0 -126
- 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 -179
- 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 -96
- package/dist/esm/funcs/census-get-partner-config.js.map +0 -1
- package/dist/esm/models/operations/sdk-get-partner-config.d.ts +0 -126
- 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 -131
- package/dist/esm/models/operations/sdk-get-partner-config.js.map +0 -1
- package/src/funcs/census-get-partner-config.ts +0 -196
- package/src/models/operations/sdk-get-partner-config.ts +0 -345
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 BotShield, Inc.
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,13 +1,39 @@
|
|
|
1
1
|
# botshield-sdk
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Official TypeScript SDK for **[BotShield](https://botshield.ai)** — privacy-first human verification. A visitor proves a real person is present with the passkey already on their phone; your site learns only that the check passed. No PII, no CAPTCHA, no birthdates.
|
|
4
4
|
|
|
5
|
+
[](https://www.npmjs.com/package/botshield-sdk)
|
|
6
|
+
[](https://docs.botshield.ai)
|
|
7
|
+
[](./LICENSE)
|
|
5
8
|
[](https://www.speakeasy.com/?utm_source=botshield-sdk&utm_campaign=typescript)
|
|
6
|
-
[](https://opensource.org/licenses/MIT)
|
|
7
9
|
|
|
10
|
+
**Links:** [Website](https://botshield.ai) · [Documentation](https://docs.botshield.ai) · [API reference](https://docs.botshield.ai/api-reference/overview) · [Developer Console](https://console.botshield.ai) (free plan, 1 gate) · [Live demos](https://demo.botshield.ai) · [Feedback & roadmap](https://github.com/Bot-Shield/feedback)
|
|
8
11
|
|
|
9
|
-
|
|
10
|
-
|
|
12
|
+
## Quickstart
|
|
13
|
+
|
|
14
|
+
Most integrations need only the browser widget. Get a site key in the [Console](https://console.botshield.ai), then:
|
|
15
|
+
|
|
16
|
+
```html
|
|
17
|
+
<script src="https://cdn.botshield.ai/sdk.js"></script>
|
|
18
|
+
|
|
19
|
+
<botshield-verify
|
|
20
|
+
site-key="pk_live_…"
|
|
21
|
+
scope="checkout"
|
|
22
|
+
checkout-label="Complete purchase">
|
|
23
|
+
</botshield-verify>
|
|
24
|
+
|
|
25
|
+
<script>
|
|
26
|
+
document.querySelector('botshield-verify')
|
|
27
|
+
.addEventListener('botshield:success', (e) => {
|
|
28
|
+
// e.detail.token — hand it to your server and confirm it there
|
|
29
|
+
});
|
|
30
|
+
</script>
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
On your server, confirm the token with this SDK (`census.verifyToken`) before trusting it. Gates, age checks, Trusted Accounts and Agents Ask are configured in the Console and documented at [docs.botshield.ai](https://docs.botshield.ai): [BotShield Gate](https://docs.botshield.ai/gate/overview) · [Trusted Accounts](https://docs.botshield.ai/trusted-accounts/overview) · [Agents Ask](https://docs.botshield.ai/agents-ask/overview).
|
|
34
|
+
|
|
35
|
+
> [!NOTE]
|
|
36
|
+
> The SDK is generated from the BotShield OpenAPI spec by Speakeasy. Everything below this line is the generated reference.
|
|
11
37
|
|
|
12
38
|
<!-- Start Summary [summary] -->
|
|
13
39
|
## Summary
|
|
@@ -23,12 +49,15 @@ BotShield API: Human presence verification protocol.
|
|
|
23
49
|
**Backend SDK:** install `botshield-sdk` from npm and use `client.census.*`, `client.verification.*`, `client.actions.*`.
|
|
24
50
|
|
|
25
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
|
|
26
54
|
<!-- End Summary [summary] -->
|
|
27
55
|
|
|
28
56
|
<!-- Start Table of Contents [toc] -->
|
|
29
57
|
## Table of Contents
|
|
30
58
|
<!-- $toc-max-depth=2 -->
|
|
31
59
|
* [botshield-sdk](#botshield-sdk)
|
|
60
|
+
* [Quickstart](#quickstart)
|
|
32
61
|
* [SDK Installation](#sdk-installation)
|
|
33
62
|
* [Requirements](#requirements)
|
|
34
63
|
* [SDK Example Usage](#sdk-example-usage)
|
|
@@ -101,7 +130,9 @@ Add the following server definition to your `claude_desktop_config.json` file:
|
|
|
101
130
|
"--",
|
|
102
131
|
"mcp", "start",
|
|
103
132
|
"--agent-key-auth", "...",
|
|
104
|
-
"--agent-key-auth1", "..."
|
|
133
|
+
"--agent-key-auth1", "...",
|
|
134
|
+
"--agent-key-auth2", "...",
|
|
135
|
+
"--agent-key-auth3", "..."
|
|
105
136
|
]
|
|
106
137
|
}
|
|
107
138
|
}
|
|
@@ -125,7 +156,9 @@ Create a `.cursor/mcp.json` file in your project root with the following content
|
|
|
125
156
|
"--",
|
|
126
157
|
"mcp", "start",
|
|
127
158
|
"--agent-key-auth", "...",
|
|
128
|
-
"--agent-key-auth1", "..."
|
|
159
|
+
"--agent-key-auth1", "...",
|
|
160
|
+
"--agent-key-auth2", "...",
|
|
161
|
+
"--agent-key-auth3", "..."
|
|
129
162
|
]
|
|
130
163
|
}
|
|
131
164
|
}
|
|
@@ -205,6 +238,8 @@ This SDK supports the following security schemes globally:
|
|
|
205
238
|
| --------------- | ------ | ------- |
|
|
206
239
|
| `agentKeyAuth` | apiKey | API key |
|
|
207
240
|
| `agentKeyAuth1` | apiKey | API key |
|
|
241
|
+
| `agentKeyAuth2` | apiKey | API key |
|
|
242
|
+
| `agentKeyAuth3` | apiKey | API key |
|
|
208
243
|
|
|
209
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:
|
|
210
245
|
```typescript
|
|
@@ -269,7 +304,6 @@ run();
|
|
|
269
304
|
* [verifyToken](docs/sdks/census/README.md#verifytoken) - Validate a verification token
|
|
270
305
|
* [storeSignal](docs/sdks/census/README.md#storesignal) - Store a Signal Pixel bot score
|
|
271
306
|
* [validateSignal](docs/sdks/census/README.md#validatesignal) - Validate a signal token
|
|
272
|
-
* [getPartnerConfig](docs/sdks/census/README.md#getpartnerconfig) - Get partner configuration
|
|
273
307
|
* [revokeVerification](docs/sdks/census/README.md#revokeverification) - Revoke a pending verification
|
|
274
308
|
* [logout](docs/sdks/census/README.md#logout) - Revoke a grant token
|
|
275
309
|
|
|
@@ -300,7 +334,6 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
300
334
|
- [`actionsProposeAction`](docs/sdks/actions/README.md#proposeaction) - Propose an action for human confirmation
|
|
301
335
|
- [`censusCreateSession`](docs/sdks/census/README.md#createsession) - Create a grant token
|
|
302
336
|
- [`censusCreateVerificationLink`](docs/sdks/census/README.md#createverificationlink) - Create a verification request
|
|
303
|
-
- [`censusGetPartnerConfig`](docs/sdks/census/README.md#getpartnerconfig) - Get partner configuration
|
|
304
337
|
- [`censusLogout`](docs/sdks/census/README.md#logout) - Revoke a grant token
|
|
305
338
|
- [`censusRevokeVerification`](docs/sdks/census/README.md#revokeverification) - Revoke a pending verification
|
|
306
339
|
- [`censusStoreSignal`](docs/sdks/census/README.md#storesignal) - Store a Signal Pixel bot score
|