botshield-sdk 2.1.0 → 2.2.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 +14 -9
- package/bin/mcp-server.js +433 -68
- package/bin/mcp-server.js.map +22 -18
- package/dist/commonjs/funcs/actions-propose-action.d.ts +1 -1
- package/dist/commonjs/funcs/actions-propose-action.js +1 -1
- package/dist/commonjs/funcs/census-get-partner-config.d.ts +18 -0
- package/dist/commonjs/funcs/census-get-partner-config.d.ts.map +1 -0
- package/dist/commonjs/funcs/census-get-partner-config.js +134 -0
- package/dist/commonjs/funcs/census-get-partner-config.js.map +1 -0
- package/dist/commonjs/funcs/census-verify-token.js +0 -12
- package/dist/commonjs/funcs/census-verify-token.js.map +1 -1
- package/dist/commonjs/funcs/secured-accounts-get-status.d.ts +18 -0
- package/dist/commonjs/funcs/secured-accounts-get-status.d.ts.map +1 -0
- package/dist/commonjs/funcs/secured-accounts-get-status.js +126 -0
- package/dist/commonjs/funcs/secured-accounts-get-status.js.map +1 -0
- package/dist/commonjs/funcs/secured-accounts-list.d.ts +18 -0
- package/dist/commonjs/funcs/secured-accounts-list.d.ts.map +1 -0
- package/dist/commonjs/funcs/secured-accounts-list.js +129 -0
- package/dist/commonjs/funcs/secured-accounts-list.js.map +1 -0
- package/dist/commonjs/funcs/secured-accounts-revoke.d.ts +18 -0
- package/dist/commonjs/funcs/secured-accounts-revoke.d.ts.map +1 -0
- package/dist/commonjs/funcs/secured-accounts-revoke.js +123 -0
- package/dist/commonjs/funcs/secured-accounts-revoke.js.map +1 -0
- package/dist/commonjs/funcs/verification-get-status.js +0 -12
- 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 -14
- 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 -16
- package/dist/commonjs/mcp-server/cli/start/command.js.map +1 -1
- package/dist/commonjs/mcp-server/cli/start/impl.d.ts +0 -2
- package/dist/commonjs/mcp-server/cli/start/impl.d.ts.map +1 -1
- package/dist/commonjs/mcp-server/cli/start/impl.js +0 -4
- 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/operations/index.d.ts +4 -0
- package/dist/commonjs/models/operations/index.d.ts.map +1 -1
- package/dist/commonjs/models/operations/index.js +4 -0
- package/dist/commonjs/models/operations/index.js.map +1 -1
- package/dist/commonjs/models/operations/sdk-create-session.d.ts +5 -5
- package/dist/commonjs/models/operations/sdk-create-session.d.ts.map +1 -1
- package/dist/commonjs/models/operations/sdk-create-session.js +6 -6
- package/dist/commonjs/models/operations/sdk-create-session.js.map +1 -1
- package/dist/commonjs/models/operations/sdk-get-partner-config.d.ts +148 -0
- package/dist/commonjs/models/operations/sdk-get-partner-config.d.ts.map +1 -0
- package/dist/commonjs/models/operations/sdk-get-partner-config.js +197 -0
- package/dist/commonjs/models/operations/sdk-get-partner-config.js.map +1 -0
- package/dist/commonjs/models/operations/sdk-verify-token.d.ts +0 -4
- package/dist/commonjs/models/operations/sdk-verify-token.d.ts.map +1 -1
- package/dist/commonjs/models/operations/sdk-verify-token.js +0 -4
- package/dist/commonjs/models/operations/sdk-verify-token.js.map +1 -1
- package/dist/commonjs/models/operations/secured-accounts-list.d.ts +212 -0
- package/dist/commonjs/models/operations/secured-accounts-list.d.ts.map +1 -0
- package/dist/commonjs/models/operations/secured-accounts-list.js +254 -0
- package/dist/commonjs/models/operations/secured-accounts-list.js.map +1 -0
- package/dist/commonjs/models/operations/secured-accounts-revoke.d.ts +130 -0
- package/dist/commonjs/models/operations/secured-accounts-revoke.d.ts.map +1 -0
- package/dist/commonjs/models/operations/secured-accounts-revoke.js +185 -0
- package/dist/commonjs/models/operations/secured-accounts-revoke.js.map +1 -0
- package/dist/commonjs/models/operations/secured-accounts-status.d.ts +97 -0
- package/dist/commonjs/models/operations/secured-accounts-status.d.ts.map +1 -0
- package/dist/commonjs/models/operations/secured-accounts-status.js +163 -0
- package/dist/commonjs/models/operations/secured-accounts-status.js.map +1 -0
- package/dist/commonjs/models/operations/verification-get-status.d.ts +0 -4
- package/dist/commonjs/models/operations/verification-get-status.d.ts.map +1 -1
- package/dist/commonjs/models/operations/verification-get-status.js +0 -4
- package/dist/commonjs/models/operations/verification-get-status.js.map +1 -1
- package/dist/commonjs/models/security.d.ts +0 -4
- package/dist/commonjs/models/security.d.ts.map +1 -1
- package/dist/commonjs/models/security.js +0 -4
- package/dist/commonjs/models/security.js.map +1 -1
- package/dist/commonjs/sdk/actions.d.ts +1 -1
- package/dist/commonjs/sdk/actions.js +1 -1
- package/dist/commonjs/sdk/census.d.ts +7 -0
- package/dist/commonjs/sdk/census.d.ts.map +1 -1
- package/dist/commonjs/sdk/census.js +10 -0
- package/dist/commonjs/sdk/census.js.map +1 -1
- package/dist/commonjs/sdk/sdk.d.ts +3 -0
- package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
- package/dist/commonjs/sdk/sdk.js +5 -0
- package/dist/commonjs/sdk/sdk.js.map +1 -1
- package/dist/commonjs/sdk/secured-accounts.d.ts +26 -0
- package/dist/commonjs/sdk/secured-accounts.d.ts.map +1 -0
- package/dist/commonjs/sdk/secured-accounts.js +42 -0
- package/dist/commonjs/sdk/secured-accounts.js.map +1 -0
- package/dist/esm/funcs/actions-propose-action.d.ts +1 -1
- package/dist/esm/funcs/actions-propose-action.js +1 -1
- package/dist/esm/funcs/census-get-partner-config.d.ts +18 -0
- package/dist/esm/funcs/census-get-partner-config.d.ts.map +1 -0
- package/dist/esm/funcs/census-get-partner-config.js +98 -0
- package/dist/esm/funcs/census-get-partner-config.js.map +1 -0
- package/dist/esm/funcs/census-verify-token.js +0 -12
- package/dist/esm/funcs/census-verify-token.js.map +1 -1
- package/dist/esm/funcs/secured-accounts-get-status.d.ts +18 -0
- package/dist/esm/funcs/secured-accounts-get-status.d.ts.map +1 -0
- package/dist/esm/funcs/secured-accounts-get-status.js +90 -0
- package/dist/esm/funcs/secured-accounts-get-status.js.map +1 -0
- package/dist/esm/funcs/secured-accounts-list.d.ts +18 -0
- package/dist/esm/funcs/secured-accounts-list.d.ts.map +1 -0
- package/dist/esm/funcs/secured-accounts-list.js +93 -0
- package/dist/esm/funcs/secured-accounts-list.js.map +1 -0
- package/dist/esm/funcs/secured-accounts-revoke.d.ts +18 -0
- package/dist/esm/funcs/secured-accounts-revoke.d.ts.map +1 -0
- package/dist/esm/funcs/secured-accounts-revoke.js +87 -0
- package/dist/esm/funcs/secured-accounts-revoke.js.map +1 -0
- package/dist/esm/funcs/verification-get-status.js +0 -12
- 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 -14
- 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 -16
- package/dist/esm/mcp-server/cli/start/command.js.map +1 -1
- package/dist/esm/mcp-server/cli/start/impl.d.ts +0 -2
- package/dist/esm/mcp-server/cli/start/impl.d.ts.map +1 -1
- package/dist/esm/mcp-server/cli/start/impl.js +0 -4
- 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/operations/index.d.ts +4 -0
- package/dist/esm/models/operations/index.d.ts.map +1 -1
- package/dist/esm/models/operations/index.js +4 -0
- package/dist/esm/models/operations/index.js.map +1 -1
- package/dist/esm/models/operations/sdk-create-session.d.ts +5 -5
- package/dist/esm/models/operations/sdk-create-session.d.ts.map +1 -1
- package/dist/esm/models/operations/sdk-create-session.js +5 -5
- package/dist/esm/models/operations/sdk-create-session.js.map +1 -1
- package/dist/esm/models/operations/sdk-get-partner-config.d.ts +148 -0
- package/dist/esm/models/operations/sdk-get-partner-config.d.ts.map +1 -0
- package/dist/esm/models/operations/sdk-get-partner-config.js +149 -0
- package/dist/esm/models/operations/sdk-get-partner-config.js.map +1 -0
- package/dist/esm/models/operations/sdk-verify-token.d.ts +0 -4
- package/dist/esm/models/operations/sdk-verify-token.d.ts.map +1 -1
- package/dist/esm/models/operations/sdk-verify-token.js +0 -4
- package/dist/esm/models/operations/sdk-verify-token.js.map +1 -1
- package/dist/esm/models/operations/secured-accounts-list.d.ts +212 -0
- package/dist/esm/models/operations/secured-accounts-list.d.ts.map +1 -0
- package/dist/esm/models/operations/secured-accounts-list.js +206 -0
- package/dist/esm/models/operations/secured-accounts-list.js.map +1 -0
- package/dist/esm/models/operations/secured-accounts-revoke.d.ts +130 -0
- package/dist/esm/models/operations/secured-accounts-revoke.d.ts.map +1 -0
- package/dist/esm/models/operations/secured-accounts-revoke.js +139 -0
- package/dist/esm/models/operations/secured-accounts-revoke.js.map +1 -0
- package/dist/esm/models/operations/secured-accounts-status.d.ts +97 -0
- package/dist/esm/models/operations/secured-accounts-status.d.ts.map +1 -0
- package/dist/esm/models/operations/secured-accounts-status.js +117 -0
- package/dist/esm/models/operations/secured-accounts-status.js.map +1 -0
- package/dist/esm/models/operations/verification-get-status.d.ts +0 -4
- package/dist/esm/models/operations/verification-get-status.d.ts.map +1 -1
- package/dist/esm/models/operations/verification-get-status.js +0 -4
- package/dist/esm/models/operations/verification-get-status.js.map +1 -1
- package/dist/esm/models/security.d.ts +0 -4
- package/dist/esm/models/security.d.ts.map +1 -1
- package/dist/esm/models/security.js +0 -4
- package/dist/esm/models/security.js.map +1 -1
- package/dist/esm/sdk/actions.d.ts +1 -1
- package/dist/esm/sdk/actions.js +1 -1
- package/dist/esm/sdk/census.d.ts +7 -0
- package/dist/esm/sdk/census.d.ts.map +1 -1
- package/dist/esm/sdk/census.js +10 -0
- package/dist/esm/sdk/census.js.map +1 -1
- package/dist/esm/sdk/sdk.d.ts +3 -0
- package/dist/esm/sdk/sdk.d.ts.map +1 -1
- package/dist/esm/sdk/sdk.js +5 -0
- package/dist/esm/sdk/sdk.js.map +1 -1
- package/dist/esm/sdk/secured-accounts.d.ts +26 -0
- package/dist/esm/sdk/secured-accounts.d.ts.map +1 -0
- package/dist/esm/sdk/secured-accounts.js +38 -0
- package/dist/esm/sdk/secured-accounts.js.map +1 -0
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/funcs/actions-propose-action.ts +1 -1
- package/src/funcs/census-get-partner-config.ts +198 -0
- package/src/funcs/census-verify-token.ts +0 -14
- package/src/funcs/secured-accounts-get-status.ts +189 -0
- package/src/funcs/secured-accounts-list.ts +194 -0
- package/src/funcs/secured-accounts-revoke.ts +185 -0
- package/src/funcs/verification-get-status.ts +0 -14
- package/src/lib/config.ts +2 -2
- package/src/lib/security.ts +0 -14
- package/src/mcp-server/cli/start/command.ts +0 -16
- package/src/mcp-server/cli/start/impl.ts +0 -6
- 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/operations/index.ts +4 -0
- package/src/models/operations/sdk-create-session.ts +13 -11
- package/src/models/operations/sdk-get-partner-config.ts +385 -0
- package/src/models/operations/sdk-verify-token.ts +0 -8
- package/src/models/operations/secured-accounts-list.ts +507 -0
- package/src/models/operations/secured-accounts-revoke.ts +359 -0
- package/src/models/operations/secured-accounts-status.ts +296 -0
- package/src/models/operations/verification-get-status.ts +0 -8
- package/src/models/security.ts +0 -8
- package/src/sdk/actions.ts +1 -1
- package/src/sdk/census.ts +20 -0
- package/src/sdk/sdk.ts +6 -0
- package/src/sdk/secured-accounts.ts +69 -0
package/README.md
CHANGED
|
@@ -40,7 +40,7 @@ On your server, confirm the token with this SDK (`census.verifyToken`) before tr
|
|
|
40
40
|
|
|
41
41
|
BotShield API: Human presence verification protocol.
|
|
42
42
|
|
|
43
|
-
**BotShield Human Verification** — a BotShield Gate (checkout, sign-up, any action moment) asks whether a live human is present. The client pre-check returns the two-result-state contract `result_state: human_verified | unavailable`; when presence is required the person confirms with
|
|
43
|
+
**BotShield Human Verification** — a BotShield Gate (checkout, sign-up, any action moment) asks whether a live human is present. The client pre-check returns the two-result-state contract `result_state: human_verified | unavailable`; when presence is required the person confirms with their passkey in the BotShield app and the gate receives an ES256 attestation JWT, verifiable against the public JWKS at /.well-known/jwks.json. No identity crosses the boundary.
|
|
44
44
|
|
|
45
45
|
**Agents Ask** — an agent proposes an action; the human confirms in the BotShield app and BotShield signs a Proof of Resolution JWT.
|
|
46
46
|
|
|
@@ -130,9 +130,7 @@ Add the following server definition to your `claude_desktop_config.json` file:
|
|
|
130
130
|
"--",
|
|
131
131
|
"mcp", "start",
|
|
132
132
|
"--agent-key-auth", "...",
|
|
133
|
-
"--agent-key-auth1", "..."
|
|
134
|
-
"--agent-key-auth2", "...",
|
|
135
|
-
"--agent-key-auth3", "..."
|
|
133
|
+
"--agent-key-auth1", "..."
|
|
136
134
|
]
|
|
137
135
|
}
|
|
138
136
|
}
|
|
@@ -156,9 +154,7 @@ Create a `.cursor/mcp.json` file in your project root with the following content
|
|
|
156
154
|
"--",
|
|
157
155
|
"mcp", "start",
|
|
158
156
|
"--agent-key-auth", "...",
|
|
159
|
-
"--agent-key-auth1", "..."
|
|
160
|
-
"--agent-key-auth2", "...",
|
|
161
|
-
"--agent-key-auth3", "..."
|
|
157
|
+
"--agent-key-auth1", "..."
|
|
162
158
|
]
|
|
163
159
|
}
|
|
164
160
|
}
|
|
@@ -238,8 +234,6 @@ This SDK supports the following security schemes globally:
|
|
|
238
234
|
| --------------- | ------ | ------- |
|
|
239
235
|
| `agentKeyAuth` | apiKey | API key |
|
|
240
236
|
| `agentKeyAuth1` | apiKey | API key |
|
|
241
|
-
| `agentKeyAuth2` | apiKey | API key |
|
|
242
|
-
| `agentKeyAuth3` | apiKey | API key |
|
|
243
237
|
|
|
244
238
|
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:
|
|
245
239
|
```typescript
|
|
@@ -304,9 +298,16 @@ run();
|
|
|
304
298
|
* [verifyToken](docs/sdks/census/README.md#verifytoken) - Validate a verification token
|
|
305
299
|
* [storeSignal](docs/sdks/census/README.md#storesignal) - Store a Signal Pixel bot score
|
|
306
300
|
* [validateSignal](docs/sdks/census/README.md#validatesignal) - Validate a signal token
|
|
301
|
+
* [getPartnerConfig](docs/sdks/census/README.md#getpartnerconfig) - Get partner configuration
|
|
307
302
|
* [revokeVerification](docs/sdks/census/README.md#revokeverification) - Revoke a pending verification
|
|
308
303
|
* [logout](docs/sdks/census/README.md#logout) - Revoke a grant token
|
|
309
304
|
|
|
305
|
+
### [SecuredAccounts](docs/sdks/securedaccounts/README.md)
|
|
306
|
+
|
|
307
|
+
* [list](docs/sdks/securedaccounts/README.md#list) - List Secured Accounts
|
|
308
|
+
* [revoke](docs/sdks/securedaccounts/README.md#revoke) - Revoke a Secured Account
|
|
309
|
+
* [getStatus](docs/sdks/securedaccounts/README.md#getstatus) - Get Secured Account status
|
|
310
|
+
|
|
310
311
|
### [Verification](docs/sdks/verification/README.md)
|
|
311
312
|
|
|
312
313
|
* [getStatus](docs/sdks/verification/README.md#getstatus) - Check verification status
|
|
@@ -334,11 +335,15 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
334
335
|
- [`actionsProposeAction`](docs/sdks/actions/README.md#proposeaction) - Propose an action for human confirmation
|
|
335
336
|
- [`censusCreateSession`](docs/sdks/census/README.md#createsession) - Create a grant token
|
|
336
337
|
- [`censusCreateVerificationLink`](docs/sdks/census/README.md#createverificationlink) - Create a verification request
|
|
338
|
+
- [`censusGetPartnerConfig`](docs/sdks/census/README.md#getpartnerconfig) - Get partner configuration
|
|
337
339
|
- [`censusLogout`](docs/sdks/census/README.md#logout) - Revoke a grant token
|
|
338
340
|
- [`censusRevokeVerification`](docs/sdks/census/README.md#revokeverification) - Revoke a pending verification
|
|
339
341
|
- [`censusStoreSignal`](docs/sdks/census/README.md#storesignal) - Store a Signal Pixel bot score
|
|
340
342
|
- [`censusValidateSignal`](docs/sdks/census/README.md#validatesignal) - Validate a signal token
|
|
341
343
|
- [`censusVerifyToken`](docs/sdks/census/README.md#verifytoken) - Validate a verification token
|
|
344
|
+
- [`securedAccountsGetStatus`](docs/sdks/securedaccounts/README.md#getstatus) - Get Secured Account status
|
|
345
|
+
- [`securedAccountsList`](docs/sdks/securedaccounts/README.md#list) - List Secured Accounts
|
|
346
|
+
- [`securedAccountsRevoke`](docs/sdks/securedaccounts/README.md#revoke) - Revoke a Secured Account
|
|
342
347
|
- [`verificationGetStatus`](docs/sdks/verification/README.md#getstatus) - Check verification status
|
|
343
348
|
|
|
344
349
|
</details>
|