botshield-sdk 1.2.4 → 1.4.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/CHANGELOG.md +35 -0
- package/README.md +62 -13
- package/client.d.mts +6 -30
- package/client.d.mts.map +1 -1
- package/client.d.ts +6 -30
- package/client.d.ts.map +1 -1
- package/client.js +2 -26
- package/client.js.map +1 -1
- package/client.mjs +2 -26
- package/client.mjs.map +1 -1
- package/package.json +7 -1
- package/resources/index.d.mts +2 -6
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +2 -6
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +1 -9
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +0 -4
- package/resources/index.mjs.map +1 -1
- package/resources/sdk.d.mts +226 -8
- package/resources/sdk.d.mts.map +1 -1
- package/resources/sdk.d.ts +226 -8
- package/resources/sdk.d.ts.map +1 -1
- package/resources/sdk.js +43 -4
- package/resources/sdk.js.map +1 -1
- package/resources/sdk.mjs +43 -4
- package/resources/sdk.mjs.map +1 -1
- package/resources/verification.d.mts +46 -8
- package/resources/verification.d.mts.map +1 -1
- package/resources/verification.d.ts +46 -8
- package/resources/verification.d.ts.map +1 -1
- package/resources/verification.js +8 -7
- package/resources/verification.js.map +1 -1
- package/resources/verification.mjs +8 -7
- package/resources/verification.mjs.map +1 -1
- package/src/client.ts +26 -54
- package/src/resources/index.ts +12 -8
- package/src/resources/sdk.ts +347 -10
- package/src/resources/verification.ts +77 -9
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
- package/resources/devices.d.mts +0 -21
- package/resources/devices.d.mts.map +0 -1
- package/resources/devices.d.ts +0 -21
- package/resources/devices.d.ts.map +0 -1
- package/resources/devices.js +0 -18
- package/resources/devices.js.map +0 -1
- package/resources/devices.mjs +0 -14
- package/resources/devices.mjs.map +0 -1
- package/resources/organizations.d.mts +0 -21
- package/resources/organizations.d.mts.map +0 -1
- package/resources/organizations.d.ts +0 -21
- package/resources/organizations.d.ts.map +0 -1
- package/resources/organizations.js +0 -18
- package/resources/organizations.js.map +0 -1
- package/resources/organizations.mjs +0 -14
- package/resources/organizations.mjs.map +0 -1
- package/resources/pass.d.mts +0 -21
- package/resources/pass.d.mts.map +0 -1
- package/resources/pass.d.ts +0 -21
- package/resources/pass.d.ts.map +0 -1
- package/resources/pass.js +0 -18
- package/resources/pass.js.map +0 -1
- package/resources/pass.mjs +0 -14
- package/resources/pass.mjs.map +0 -1
- package/resources/users.d.mts +0 -21
- package/resources/users.d.mts.map +0 -1
- package/resources/users.d.ts +0 -21
- package/resources/users.d.ts.map +0 -1
- package/resources/users.js +0 -18
- package/resources/users.js.map +0 -1
- package/resources/users.mjs +0 -14
- package/resources/users.mjs.map +0 -1
- package/src/resources/devices.ts +0 -27
- package/src/resources/organizations.ts +0 -33
- package/src/resources/pass.ts +0 -27
- package/src/resources/users.ts +0 -33
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "botshield-sdk",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.4.0",
|
|
4
4
|
"description": "The official TypeScript library for the Bot Shield API",
|
|
5
5
|
"author": "Bot Shield <support@botshield.ai>",
|
|
6
6
|
"types": "./index.d.ts",
|
|
@@ -16,6 +16,12 @@
|
|
|
16
16
|
"access": "public"
|
|
17
17
|
},
|
|
18
18
|
"dependencies": {},
|
|
19
|
+
"overrides": {
|
|
20
|
+
"minimatch": "^9.0.5"
|
|
21
|
+
},
|
|
22
|
+
"resolutions": {
|
|
23
|
+
"minimatch": "^9.0.5"
|
|
24
|
+
},
|
|
19
25
|
"exports": {
|
|
20
26
|
".": {
|
|
21
27
|
"require": {
|
package/resources/index.d.mts
CHANGED
|
@@ -1,7 +1,3 @@
|
|
|
1
|
-
export {
|
|
2
|
-
export {
|
|
3
|
-
export { Pass, type PassCreateResponse, type PassCreateParams } from "./pass.mjs";
|
|
4
|
-
export { SDK, type SDKCreateSessionResponse, type SDKCreateVerificationLinkResponse, type SDKLogoutResponse, type SDKCreateSessionParams, type SDKCreateVerificationLinkParams, type SDKLogoutParams, } from "./sdk.mjs";
|
|
5
|
-
export { Users, type UserUpdateMetadataResponse, type UserUpdateMetadataParams } from "./users.mjs";
|
|
6
|
-
export { Verification, type VerificationGetStatusResponse, type VerificationLookupUserByEmailResponse, } from "./verification.mjs";
|
|
1
|
+
export { SDK, type SDKCreateSessionResponse, type SDKCreateVerificationLinkResponse, type SDKGetPartnerConfigResponse, type SDKLogoutResponse, type SDKRevokeVerificationResponse, type SDKStoreSignalResponse, type SDKValidateSignalResponse, type SDKVerifyTokenResponse, type SDKCreateSessionParams, type SDKCreateVerificationLinkParams, type SDKGetPartnerConfigParams, type SDKLogoutParams, type SDKRevokeVerificationParams, type SDKStoreSignalParams, type SDKValidateSignalParams, type SDKVerifyTokenParams, } from "./sdk.mjs";
|
|
2
|
+
export { Verification, type VerificationGetStatusResponse, type VerificationLookupUserByEmailResponse, type VerificationGetStatusParams, type VerificationLookupUserByEmailParams, } from "./verification.mjs";
|
|
7
3
|
//# sourceMappingURL=index.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"OAEO,
|
|
1
|
+
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"OAEO,EACL,GAAG,EACH,KAAK,wBAAwB,EAC7B,KAAK,iCAAiC,EACtC,KAAK,2BAA2B,EAChC,KAAK,iBAAiB,EACtB,KAAK,6BAA6B,EAClC,KAAK,sBAAsB,EAC3B,KAAK,yBAAyB,EAC9B,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC3B,KAAK,+BAA+B,EACpC,KAAK,yBAAyB,EAC9B,KAAK,eAAe,EACpB,KAAK,2BAA2B,EAChC,KAAK,oBAAoB,EACzB,KAAK,uBAAuB,EAC5B,KAAK,oBAAoB,GAC1B;OACM,EACL,YAAY,EACZ,KAAK,6BAA6B,EAClC,KAAK,qCAAqC,EAC1C,KAAK,2BAA2B,EAChC,KAAK,mCAAmC,GACzC"}
|
package/resources/index.d.ts
CHANGED
|
@@ -1,7 +1,3 @@
|
|
|
1
|
-
export {
|
|
2
|
-
export {
|
|
3
|
-
export { Pass, type PassCreateResponse, type PassCreateParams } from "./pass.js";
|
|
4
|
-
export { SDK, type SDKCreateSessionResponse, type SDKCreateVerificationLinkResponse, type SDKLogoutResponse, type SDKCreateSessionParams, type SDKCreateVerificationLinkParams, type SDKLogoutParams, } from "./sdk.js";
|
|
5
|
-
export { Users, type UserUpdateMetadataResponse, type UserUpdateMetadataParams } from "./users.js";
|
|
6
|
-
export { Verification, type VerificationGetStatusResponse, type VerificationLookupUserByEmailResponse, } from "./verification.js";
|
|
1
|
+
export { SDK, type SDKCreateSessionResponse, type SDKCreateVerificationLinkResponse, type SDKGetPartnerConfigResponse, type SDKLogoutResponse, type SDKRevokeVerificationResponse, type SDKStoreSignalResponse, type SDKValidateSignalResponse, type SDKVerifyTokenResponse, type SDKCreateSessionParams, type SDKCreateVerificationLinkParams, type SDKGetPartnerConfigParams, type SDKLogoutParams, type SDKRevokeVerificationParams, type SDKStoreSignalParams, type SDKValidateSignalParams, type SDKVerifyTokenParams, } from "./sdk.js";
|
|
2
|
+
export { Verification, type VerificationGetStatusResponse, type VerificationLookupUserByEmailResponse, type VerificationGetStatusParams, type VerificationLookupUserByEmailParams, } from "./verification.js";
|
|
7
3
|
//# sourceMappingURL=index.d.ts.map
|
package/resources/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"OAEO,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"OAEO,EACL,GAAG,EACH,KAAK,wBAAwB,EAC7B,KAAK,iCAAiC,EACtC,KAAK,2BAA2B,EAChC,KAAK,iBAAiB,EACtB,KAAK,6BAA6B,EAClC,KAAK,sBAAsB,EAC3B,KAAK,yBAAyB,EAC9B,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC3B,KAAK,+BAA+B,EACpC,KAAK,yBAAyB,EAC9B,KAAK,eAAe,EACpB,KAAK,2BAA2B,EAChC,KAAK,oBAAoB,EACzB,KAAK,uBAAuB,EAC5B,KAAK,oBAAoB,GAC1B;OACM,EACL,YAAY,EACZ,KAAK,6BAA6B,EAClC,KAAK,qCAAqC,EAC1C,KAAK,2BAA2B,EAChC,KAAK,mCAAmC,GACzC"}
|
package/resources/index.js
CHANGED
|
@@ -1,17 +1,9 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
-
exports.Verification = exports.
|
|
5
|
-
var devices_1 = require("./devices.js");
|
|
6
|
-
Object.defineProperty(exports, "Devices", { enumerable: true, get: function () { return devices_1.Devices; } });
|
|
7
|
-
var organizations_1 = require("./organizations.js");
|
|
8
|
-
Object.defineProperty(exports, "Organizations", { enumerable: true, get: function () { return organizations_1.Organizations; } });
|
|
9
|
-
var pass_1 = require("./pass.js");
|
|
10
|
-
Object.defineProperty(exports, "Pass", { enumerable: true, get: function () { return pass_1.Pass; } });
|
|
4
|
+
exports.Verification = exports.SDK = void 0;
|
|
11
5
|
var sdk_1 = require("./sdk.js");
|
|
12
6
|
Object.defineProperty(exports, "SDK", { enumerable: true, get: function () { return sdk_1.SDK; } });
|
|
13
|
-
var users_1 = require("./users.js");
|
|
14
|
-
Object.defineProperty(exports, "Users", { enumerable: true, get: function () { return users_1.Users; } });
|
|
15
7
|
var verification_1 = require("./verification.js");
|
|
16
8
|
Object.defineProperty(exports, "Verification", { enumerable: true, get: function () { return verification_1.Verification; } });
|
|
17
9
|
//# sourceMappingURL=index.js.map
|
package/resources/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gCAkBe;AAjBb,0FAAA,GAAG,OAAA;AAkBL,kDAMwB;AALtB,4GAAA,YAAY,OAAA"}
|
package/resources/index.mjs
CHANGED
|
@@ -1,8 +1,4 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
-
export { Devices } from "./devices.mjs";
|
|
3
|
-
export { Organizations, } from "./organizations.mjs";
|
|
4
|
-
export { Pass } from "./pass.mjs";
|
|
5
2
|
export { SDK, } from "./sdk.mjs";
|
|
6
|
-
export { Users } from "./users.mjs";
|
|
7
3
|
export { Verification, } from "./verification.mjs";
|
|
8
4
|
//# sourceMappingURL=index.mjs.map
|
package/resources/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,
|
|
1
|
+
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,GAAG,GAiBJ;OACM,EACL,YAAY,GAKb"}
|
package/resources/sdk.d.mts
CHANGED
|
@@ -2,38 +2,256 @@ import { APIResource } from "../core/resource.mjs";
|
|
|
2
2
|
import { APIPromise } from "../core/api-promise.mjs";
|
|
3
3
|
import { RequestOptions } from "../internal/request-options.mjs";
|
|
4
4
|
/**
|
|
5
|
-
* SDK
|
|
5
|
+
* Core SDK operations — session management, verification, token validation, and Signal Pixel scoring
|
|
6
6
|
*/
|
|
7
7
|
export declare class SDK extends APIResource {
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* Creates a short-lived anchor grant token (5 minutes) from an API token or site
|
|
10
|
+
* key. Use this to get a token before creating verification links.
|
|
10
11
|
*/
|
|
11
12
|
createSession(body: SDKCreateSessionParams, options?: RequestOptions): APIPromise<SDKCreateSessionResponse>;
|
|
12
13
|
/**
|
|
13
|
-
*
|
|
14
|
+
* Creates a verification request with deep link, web URL, and QR code. Requires an
|
|
15
|
+
* anchor grant token from create-session.
|
|
14
16
|
*/
|
|
15
17
|
createVerificationLink(body: SDKCreateVerificationLinkParams, options?: RequestOptions): APIPromise<SDKCreateVerificationLinkResponse>;
|
|
16
18
|
/**
|
|
17
|
-
*
|
|
19
|
+
* Returns enabled integrations (Turnstile, etc.) for a site key. Public config
|
|
20
|
+
* only — secret keys never exposed.
|
|
21
|
+
*/
|
|
22
|
+
getPartnerConfig(query: SDKGetPartnerConfigParams, options?: RequestOptions): APIPromise<SDKGetPartnerConfigResponse>;
|
|
23
|
+
/**
|
|
24
|
+
* Revoke an Anchor Grant Window token
|
|
18
25
|
*/
|
|
19
26
|
logout(body: SDKLogoutParams, options?: RequestOptions): APIPromise<SDKLogoutResponse>;
|
|
27
|
+
/**
|
|
28
|
+
* Soft-expires a pending verification for a scope and user. Use when
|
|
29
|
+
* create-verification-link returns 409.
|
|
30
|
+
*/
|
|
31
|
+
revokeVerification(body: SDKRevokeVerificationParams, options?: RequestOptions): APIPromise<SDKRevokeVerificationResponse>;
|
|
32
|
+
/**
|
|
33
|
+
* Stores a behavioral fingerprint score server-side and returns an opaque
|
|
34
|
+
* signal*token (bs_sig*...). The client-side score can be spoofed — the
|
|
35
|
+
* signal_token maps to the real score in BotShield's database.
|
|
36
|
+
*/
|
|
37
|
+
storeSignal(body: SDKStoreSignalParams, options?: RequestOptions): APIPromise<SDKStoreSignalResponse>;
|
|
38
|
+
/**
|
|
39
|
+
* Validates a signal_token and returns the real server-side bot score. One-time
|
|
40
|
+
* use, 10-minute expiry. This is the tamper-proof check.
|
|
41
|
+
*/
|
|
42
|
+
validateSignal(body: SDKValidateSignalParams, options?: RequestOptions): APIPromise<SDKValidateSignalResponse>;
|
|
43
|
+
/**
|
|
44
|
+
* Validates a signed JWT verification receipt. This is the primary server-side
|
|
45
|
+
* check. Optionally include signal_token for combined confidence scoring with
|
|
46
|
+
* Signal Pixel + Turnstile + passkey results.
|
|
47
|
+
*/
|
|
48
|
+
verifyToken(body: SDKVerifyTokenParams, options?: RequestOptions): APIPromise<SDKVerifyTokenResponse>;
|
|
20
49
|
}
|
|
21
50
|
export interface SDKCreateSessionResponse {
|
|
22
|
-
data:
|
|
51
|
+
data: SDKCreateSessionResponse.Data;
|
|
52
|
+
}
|
|
53
|
+
export declare namespace SDKCreateSessionResponse {
|
|
54
|
+
interface Data {
|
|
55
|
+
anchor_grant_expires_at: string;
|
|
56
|
+
anchor_grant_expires_in_seconds: number;
|
|
57
|
+
/**
|
|
58
|
+
* Canonical grant token (Bearer bss\_\*)
|
|
59
|
+
*/
|
|
60
|
+
anchor_grant_token: string;
|
|
61
|
+
expires_at: string;
|
|
62
|
+
expires_in_seconds: number;
|
|
63
|
+
organization: Data.Organization;
|
|
64
|
+
/**
|
|
65
|
+
* Legacy alias (backward compatibility)
|
|
66
|
+
*/
|
|
67
|
+
session_token: string;
|
|
68
|
+
}
|
|
69
|
+
namespace Data {
|
|
70
|
+
interface Organization {
|
|
71
|
+
id: string;
|
|
72
|
+
environment: string;
|
|
73
|
+
}
|
|
74
|
+
}
|
|
23
75
|
}
|
|
24
76
|
export interface SDKCreateVerificationLinkResponse {
|
|
25
|
-
data:
|
|
77
|
+
data: SDKCreateVerificationLinkResponse.Data;
|
|
78
|
+
}
|
|
79
|
+
export declare namespace SDKCreateVerificationLinkResponse {
|
|
80
|
+
interface Data {
|
|
81
|
+
deep_link: string;
|
|
82
|
+
expires_at: string;
|
|
83
|
+
qr_code_url: string;
|
|
84
|
+
request_id: string;
|
|
85
|
+
web_url: string;
|
|
86
|
+
auth_mode?: 'linked-account' | 'private';
|
|
87
|
+
organization?: Data.Organization;
|
|
88
|
+
scope?: string;
|
|
89
|
+
sdk_type?: 'signal' | 'presence';
|
|
90
|
+
}
|
|
91
|
+
namespace Data {
|
|
92
|
+
interface Organization {
|
|
93
|
+
id?: string;
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
export interface SDKGetPartnerConfigResponse {
|
|
98
|
+
environment?: 'test' | 'live';
|
|
99
|
+
integrations?: {
|
|
100
|
+
[key: string]: SDKGetPartnerConfigResponse.Integrations;
|
|
101
|
+
};
|
|
102
|
+
}
|
|
103
|
+
export declare namespace SDKGetPartnerConfigResponse {
|
|
104
|
+
interface Integrations {
|
|
105
|
+
config?: unknown;
|
|
106
|
+
enabled?: boolean;
|
|
107
|
+
site_key?: string;
|
|
108
|
+
}
|
|
26
109
|
}
|
|
27
110
|
export interface SDKLogoutResponse {
|
|
28
|
-
|
|
111
|
+
message?: string;
|
|
112
|
+
revoked_at?: string;
|
|
113
|
+
success?: boolean;
|
|
114
|
+
token_found?: boolean;
|
|
115
|
+
}
|
|
116
|
+
export interface SDKRevokeVerificationResponse {
|
|
117
|
+
data: SDKRevokeVerificationResponse.Data;
|
|
118
|
+
}
|
|
119
|
+
export declare namespace SDKRevokeVerificationResponse {
|
|
120
|
+
interface Data {
|
|
121
|
+
message?: string;
|
|
122
|
+
revoked_count?: number;
|
|
123
|
+
success?: boolean;
|
|
124
|
+
}
|
|
125
|
+
}
|
|
126
|
+
export interface SDKStoreSignalResponse {
|
|
127
|
+
expires_at?: string;
|
|
128
|
+
/**
|
|
129
|
+
* Opaque tamper-proof token (bs*sig*...)
|
|
130
|
+
*/
|
|
131
|
+
signal_token?: string;
|
|
132
|
+
}
|
|
133
|
+
export interface SDKValidateSignalResponse {
|
|
134
|
+
client_score?: number;
|
|
135
|
+
country?: string;
|
|
136
|
+
created_at?: string;
|
|
137
|
+
edge_score?: number;
|
|
138
|
+
fp_hash?: string;
|
|
139
|
+
reason?: string;
|
|
140
|
+
score?: number;
|
|
141
|
+
site_key?: string;
|
|
142
|
+
valid?: boolean;
|
|
143
|
+
}
|
|
144
|
+
export interface SDKVerifyTokenResponse {
|
|
145
|
+
claims?: SDKVerifyTokenResponse.Claims;
|
|
146
|
+
/**
|
|
147
|
+
* Combined confidence (passkey + signals + integrations)
|
|
148
|
+
*/
|
|
149
|
+
confidence?: number;
|
|
150
|
+
reason?: string;
|
|
151
|
+
signals?: SDKVerifyTokenResponse.Signals;
|
|
152
|
+
valid?: boolean;
|
|
153
|
+
}
|
|
154
|
+
export declare namespace SDKVerifyTokenResponse {
|
|
155
|
+
interface Claims {
|
|
156
|
+
auth_mode?: 'linked-account' | 'private';
|
|
157
|
+
botshield_user_id?: string;
|
|
158
|
+
expires_at?: number;
|
|
159
|
+
issued_at?: number;
|
|
160
|
+
organization_id?: string;
|
|
161
|
+
partner_user_id?: string;
|
|
162
|
+
request_id?: string;
|
|
163
|
+
timestamp?: string;
|
|
164
|
+
user_email?: string;
|
|
165
|
+
verified?: boolean;
|
|
166
|
+
}
|
|
167
|
+
interface Signals {
|
|
168
|
+
/**
|
|
169
|
+
* Signal Pixel score (0-100)
|
|
170
|
+
*/
|
|
171
|
+
botshield_score?: number;
|
|
172
|
+
passkey?: Signals.Passkey;
|
|
173
|
+
turnstile?: Signals.Turnstile;
|
|
174
|
+
}
|
|
175
|
+
namespace Signals {
|
|
176
|
+
interface Passkey {
|
|
177
|
+
verified?: boolean;
|
|
178
|
+
}
|
|
179
|
+
interface Turnstile {
|
|
180
|
+
success?: boolean;
|
|
181
|
+
}
|
|
182
|
+
}
|
|
29
183
|
}
|
|
30
184
|
export interface SDKCreateSessionParams {
|
|
185
|
+
metadata?: {
|
|
186
|
+
[key: string]: unknown;
|
|
187
|
+
};
|
|
188
|
+
/**
|
|
189
|
+
* Your internal user identifier for correlation
|
|
190
|
+
*/
|
|
191
|
+
partner_user_id?: string;
|
|
31
192
|
}
|
|
32
193
|
export interface SDKCreateVerificationLinkParams {
|
|
194
|
+
/**
|
|
195
|
+
* Returning user ID to skip onboarding
|
|
196
|
+
*/
|
|
197
|
+
botshield_user_id?: string;
|
|
198
|
+
metadata?: {
|
|
199
|
+
[key: string]: unknown;
|
|
200
|
+
};
|
|
201
|
+
/**
|
|
202
|
+
* linked-account = OAuth+passkey, private = direct WebAuthn (no PII)
|
|
203
|
+
*/
|
|
204
|
+
mode?: 'linked-account' | 'private';
|
|
205
|
+
return_url?: string;
|
|
206
|
+
scope?: string;
|
|
207
|
+
sdk_type?: 'signal' | 'presence';
|
|
208
|
+
/**
|
|
209
|
+
* Tamper-proof Signal Pixel token (bs*sig*...) for server-side score correlation
|
|
210
|
+
*/
|
|
211
|
+
signal_token?: string;
|
|
212
|
+
user_email?: string;
|
|
213
|
+
webhook_url?: string;
|
|
214
|
+
}
|
|
215
|
+
export interface SDKGetPartnerConfigParams {
|
|
216
|
+
site_key: string;
|
|
33
217
|
}
|
|
34
218
|
export interface SDKLogoutParams {
|
|
219
|
+
/**
|
|
220
|
+
* The anchor grant token (bss\_\*) to revoke
|
|
221
|
+
*/
|
|
222
|
+
session_token: string;
|
|
223
|
+
}
|
|
224
|
+
export interface SDKRevokeVerificationParams {
|
|
225
|
+
scope: string;
|
|
226
|
+
partner_user_id?: string;
|
|
227
|
+
user_email?: string;
|
|
228
|
+
}
|
|
229
|
+
export interface SDKStoreSignalParams {
|
|
230
|
+
score: number;
|
|
231
|
+
site_key: string;
|
|
232
|
+
client_score?: number;
|
|
233
|
+
country?: string;
|
|
234
|
+
edge_score?: number;
|
|
235
|
+
fp_hash?: string;
|
|
236
|
+
ip_hash?: string;
|
|
237
|
+
signals?: unknown;
|
|
238
|
+
ua_hash?: string;
|
|
239
|
+
}
|
|
240
|
+
export interface SDKValidateSignalParams {
|
|
241
|
+
signal_token: string;
|
|
242
|
+
verification_event_id?: string;
|
|
243
|
+
}
|
|
244
|
+
export interface SDKVerifyTokenParams {
|
|
245
|
+
/**
|
|
246
|
+
* JWT verification receipt
|
|
247
|
+
*/
|
|
248
|
+
token: string;
|
|
249
|
+
/**
|
|
250
|
+
* Optional Signal Pixel token for combined confidence
|
|
251
|
+
*/
|
|
252
|
+
signal_token?: string;
|
|
35
253
|
}
|
|
36
254
|
export declare namespace SDK {
|
|
37
|
-
export { type SDKCreateSessionResponse as SDKCreateSessionResponse, type SDKCreateVerificationLinkResponse as SDKCreateVerificationLinkResponse, type SDKLogoutResponse as SDKLogoutResponse, type SDKCreateSessionParams as SDKCreateSessionParams, type SDKCreateVerificationLinkParams as SDKCreateVerificationLinkParams, type SDKLogoutParams as SDKLogoutParams, };
|
|
255
|
+
export { type SDKCreateSessionResponse as SDKCreateSessionResponse, type SDKCreateVerificationLinkResponse as SDKCreateVerificationLinkResponse, type SDKGetPartnerConfigResponse as SDKGetPartnerConfigResponse, type SDKLogoutResponse as SDKLogoutResponse, type SDKRevokeVerificationResponse as SDKRevokeVerificationResponse, type SDKStoreSignalResponse as SDKStoreSignalResponse, type SDKValidateSignalResponse as SDKValidateSignalResponse, type SDKVerifyTokenResponse as SDKVerifyTokenResponse, type SDKCreateSessionParams as SDKCreateSessionParams, type SDKCreateVerificationLinkParams as SDKCreateVerificationLinkParams, type SDKGetPartnerConfigParams as SDKGetPartnerConfigParams, type SDKLogoutParams as SDKLogoutParams, type SDKRevokeVerificationParams as SDKRevokeVerificationParams, type SDKStoreSignalParams as SDKStoreSignalParams, type SDKValidateSignalParams as SDKValidateSignalParams, type SDKVerifyTokenParams as SDKVerifyTokenParams, };
|
|
38
256
|
}
|
|
39
257
|
//# sourceMappingURL=sdk.d.mts.map
|
package/resources/sdk.d.mts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sdk.d.mts","sourceRoot":"","sources":["../src/resources/sdk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB;;GAEG;AACH,qBAAa,GAAI,SAAQ,WAAW;IAClC
|
|
1
|
+
{"version":3,"file":"sdk.d.mts","sourceRoot":"","sources":["../src/resources/sdk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB;;GAEG;AACH,qBAAa,GAAI,SAAQ,WAAW;IAClC;;;OAGG;IACH,aAAa,CACX,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;IAIvC;;;OAGG;IACH,sBAAsB,CACpB,IAAI,EAAE,+BAA+B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAIhD;;;OAGG;IACH,gBAAgB,CACd,KAAK,EAAE,yBAAyB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAI1C;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAItF;;;OAGG;IACH,kBAAkB,CAChB,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAI5C;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIrG;;;OAGG;IACH,cAAc,CACZ,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGtG;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,wBAAwB,CAAC,IAAI,CAAC;CACrC;AAED,yBAAiB,wBAAwB,CAAC;IACxC,UAAiB,IAAI;QACnB,uBAAuB,EAAE,MAAM,CAAC;QAEhC,+BAA+B,EAAE,MAAM,CAAC;QAExC;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B,UAAU,EAAE,MAAM,CAAC;QAEnB,kBAAkB,EAAE,MAAM,CAAC;QAE3B,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC;QAEhC;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;KACvB;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,YAAY;YAC3B,EAAE,EAAE,MAAM,CAAC;YAEX,WAAW,EAAE,MAAM,CAAC;SACrB;KACF;CACF;AAED,MAAM,WAAW,iCAAiC;IAChD,IAAI,EAAE,iCAAiC,CAAC,IAAI,CAAC;CAC9C;AAED,yBAAiB,iCAAiC,CAAC;IACjD,UAAiB,IAAI;QACnB,SAAS,EAAE,MAAM,CAAC;QAElB,UAAU,EAAE,MAAM,CAAC;QAEnB,WAAW,EAAE,MAAM,CAAC;QAEpB,UAAU,EAAE,MAAM,CAAC;QAEnB,OAAO,EAAE,MAAM,CAAC;QAEhB,SAAS,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;QAEzC,YAAY,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC;QAEjC,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,QAAQ,CAAC,EAAE,QAAQ,GAAG,UAAU,CAAC;KAClC;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,YAAY;YAC3B,EAAE,CAAC,EAAE,MAAM,CAAC;SACb;KACF;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAE9B,YAAY,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,2BAA2B,CAAC,YAAY,CAAA;KAAE,CAAC;CAC5E;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,YAAY;QAC3B,MAAM,CAAC,EAAE,OAAO,CAAC;QAEjB,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,MAAM,WAAW,6BAA6B;IAC5C,IAAI,EAAE,6BAA6B,CAAC,IAAI,CAAC;CAC1C;AAED,yBAAiB,6BAA6B,CAAC;IAC7C,UAAiB,IAAI;QACnB,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,yBAAyB;IACxC,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,sBAAsB;IACrC,MAAM,CAAC,EAAE,sBAAsB,CAAC,MAAM,CAAC;IAEvC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,OAAO,CAAC,EAAE,sBAAsB,CAAC,OAAO,CAAC;IAEzC,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,MAAM;QACrB,SAAS,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;QAEzC,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB;IAED,UAAiB,OAAO;QACtB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC;QAE1B,SAAS,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC;KAC/B;IAED,UAAiB,OAAO,CAAC;QACvB,UAAiB,OAAO;YACtB,QAAQ,CAAC,EAAE,OAAO,CAAC;SACpB;QAED,UAAiB,SAAS;YACxB,OAAO,CAAC,EAAE,OAAO,CAAC;SACnB;KACF;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;OAEG;IACH,IAAI,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;IAEpC,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,QAAQ,CAAC,EAAE,QAAQ,GAAG,UAAU,CAAC;IAEjC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,yBAAyB;IACxC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,2BAA2B;IAC1C,KAAK,EAAE,MAAM,CAAC;IAEd,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,MAAM,CAAC;IAEd,QAAQ,EAAE,MAAM,CAAC;IAEjB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,uBAAuB;IACtC,YAAY,EAAE,MAAM,CAAC;IAErB,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,CAAC,OAAO,WAAW,GAAG,CAAC;IAC3B,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
|
package/resources/sdk.d.ts
CHANGED
|
@@ -2,38 +2,256 @@ import { APIResource } from "../core/resource.js";
|
|
|
2
2
|
import { APIPromise } from "../core/api-promise.js";
|
|
3
3
|
import { RequestOptions } from "../internal/request-options.js";
|
|
4
4
|
/**
|
|
5
|
-
* SDK
|
|
5
|
+
* Core SDK operations — session management, verification, token validation, and Signal Pixel scoring
|
|
6
6
|
*/
|
|
7
7
|
export declare class SDK extends APIResource {
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* Creates a short-lived anchor grant token (5 minutes) from an API token or site
|
|
10
|
+
* key. Use this to get a token before creating verification links.
|
|
10
11
|
*/
|
|
11
12
|
createSession(body: SDKCreateSessionParams, options?: RequestOptions): APIPromise<SDKCreateSessionResponse>;
|
|
12
13
|
/**
|
|
13
|
-
*
|
|
14
|
+
* Creates a verification request with deep link, web URL, and QR code. Requires an
|
|
15
|
+
* anchor grant token from create-session.
|
|
14
16
|
*/
|
|
15
17
|
createVerificationLink(body: SDKCreateVerificationLinkParams, options?: RequestOptions): APIPromise<SDKCreateVerificationLinkResponse>;
|
|
16
18
|
/**
|
|
17
|
-
*
|
|
19
|
+
* Returns enabled integrations (Turnstile, etc.) for a site key. Public config
|
|
20
|
+
* only — secret keys never exposed.
|
|
21
|
+
*/
|
|
22
|
+
getPartnerConfig(query: SDKGetPartnerConfigParams, options?: RequestOptions): APIPromise<SDKGetPartnerConfigResponse>;
|
|
23
|
+
/**
|
|
24
|
+
* Revoke an Anchor Grant Window token
|
|
18
25
|
*/
|
|
19
26
|
logout(body: SDKLogoutParams, options?: RequestOptions): APIPromise<SDKLogoutResponse>;
|
|
27
|
+
/**
|
|
28
|
+
* Soft-expires a pending verification for a scope and user. Use when
|
|
29
|
+
* create-verification-link returns 409.
|
|
30
|
+
*/
|
|
31
|
+
revokeVerification(body: SDKRevokeVerificationParams, options?: RequestOptions): APIPromise<SDKRevokeVerificationResponse>;
|
|
32
|
+
/**
|
|
33
|
+
* Stores a behavioral fingerprint score server-side and returns an opaque
|
|
34
|
+
* signal*token (bs_sig*...). The client-side score can be spoofed — the
|
|
35
|
+
* signal_token maps to the real score in BotShield's database.
|
|
36
|
+
*/
|
|
37
|
+
storeSignal(body: SDKStoreSignalParams, options?: RequestOptions): APIPromise<SDKStoreSignalResponse>;
|
|
38
|
+
/**
|
|
39
|
+
* Validates a signal_token and returns the real server-side bot score. One-time
|
|
40
|
+
* use, 10-minute expiry. This is the tamper-proof check.
|
|
41
|
+
*/
|
|
42
|
+
validateSignal(body: SDKValidateSignalParams, options?: RequestOptions): APIPromise<SDKValidateSignalResponse>;
|
|
43
|
+
/**
|
|
44
|
+
* Validates a signed JWT verification receipt. This is the primary server-side
|
|
45
|
+
* check. Optionally include signal_token for combined confidence scoring with
|
|
46
|
+
* Signal Pixel + Turnstile + passkey results.
|
|
47
|
+
*/
|
|
48
|
+
verifyToken(body: SDKVerifyTokenParams, options?: RequestOptions): APIPromise<SDKVerifyTokenResponse>;
|
|
20
49
|
}
|
|
21
50
|
export interface SDKCreateSessionResponse {
|
|
22
|
-
data:
|
|
51
|
+
data: SDKCreateSessionResponse.Data;
|
|
52
|
+
}
|
|
53
|
+
export declare namespace SDKCreateSessionResponse {
|
|
54
|
+
interface Data {
|
|
55
|
+
anchor_grant_expires_at: string;
|
|
56
|
+
anchor_grant_expires_in_seconds: number;
|
|
57
|
+
/**
|
|
58
|
+
* Canonical grant token (Bearer bss\_\*)
|
|
59
|
+
*/
|
|
60
|
+
anchor_grant_token: string;
|
|
61
|
+
expires_at: string;
|
|
62
|
+
expires_in_seconds: number;
|
|
63
|
+
organization: Data.Organization;
|
|
64
|
+
/**
|
|
65
|
+
* Legacy alias (backward compatibility)
|
|
66
|
+
*/
|
|
67
|
+
session_token: string;
|
|
68
|
+
}
|
|
69
|
+
namespace Data {
|
|
70
|
+
interface Organization {
|
|
71
|
+
id: string;
|
|
72
|
+
environment: string;
|
|
73
|
+
}
|
|
74
|
+
}
|
|
23
75
|
}
|
|
24
76
|
export interface SDKCreateVerificationLinkResponse {
|
|
25
|
-
data:
|
|
77
|
+
data: SDKCreateVerificationLinkResponse.Data;
|
|
78
|
+
}
|
|
79
|
+
export declare namespace SDKCreateVerificationLinkResponse {
|
|
80
|
+
interface Data {
|
|
81
|
+
deep_link: string;
|
|
82
|
+
expires_at: string;
|
|
83
|
+
qr_code_url: string;
|
|
84
|
+
request_id: string;
|
|
85
|
+
web_url: string;
|
|
86
|
+
auth_mode?: 'linked-account' | 'private';
|
|
87
|
+
organization?: Data.Organization;
|
|
88
|
+
scope?: string;
|
|
89
|
+
sdk_type?: 'signal' | 'presence';
|
|
90
|
+
}
|
|
91
|
+
namespace Data {
|
|
92
|
+
interface Organization {
|
|
93
|
+
id?: string;
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
export interface SDKGetPartnerConfigResponse {
|
|
98
|
+
environment?: 'test' | 'live';
|
|
99
|
+
integrations?: {
|
|
100
|
+
[key: string]: SDKGetPartnerConfigResponse.Integrations;
|
|
101
|
+
};
|
|
102
|
+
}
|
|
103
|
+
export declare namespace SDKGetPartnerConfigResponse {
|
|
104
|
+
interface Integrations {
|
|
105
|
+
config?: unknown;
|
|
106
|
+
enabled?: boolean;
|
|
107
|
+
site_key?: string;
|
|
108
|
+
}
|
|
26
109
|
}
|
|
27
110
|
export interface SDKLogoutResponse {
|
|
28
|
-
|
|
111
|
+
message?: string;
|
|
112
|
+
revoked_at?: string;
|
|
113
|
+
success?: boolean;
|
|
114
|
+
token_found?: boolean;
|
|
115
|
+
}
|
|
116
|
+
export interface SDKRevokeVerificationResponse {
|
|
117
|
+
data: SDKRevokeVerificationResponse.Data;
|
|
118
|
+
}
|
|
119
|
+
export declare namespace SDKRevokeVerificationResponse {
|
|
120
|
+
interface Data {
|
|
121
|
+
message?: string;
|
|
122
|
+
revoked_count?: number;
|
|
123
|
+
success?: boolean;
|
|
124
|
+
}
|
|
125
|
+
}
|
|
126
|
+
export interface SDKStoreSignalResponse {
|
|
127
|
+
expires_at?: string;
|
|
128
|
+
/**
|
|
129
|
+
* Opaque tamper-proof token (bs*sig*...)
|
|
130
|
+
*/
|
|
131
|
+
signal_token?: string;
|
|
132
|
+
}
|
|
133
|
+
export interface SDKValidateSignalResponse {
|
|
134
|
+
client_score?: number;
|
|
135
|
+
country?: string;
|
|
136
|
+
created_at?: string;
|
|
137
|
+
edge_score?: number;
|
|
138
|
+
fp_hash?: string;
|
|
139
|
+
reason?: string;
|
|
140
|
+
score?: number;
|
|
141
|
+
site_key?: string;
|
|
142
|
+
valid?: boolean;
|
|
143
|
+
}
|
|
144
|
+
export interface SDKVerifyTokenResponse {
|
|
145
|
+
claims?: SDKVerifyTokenResponse.Claims;
|
|
146
|
+
/**
|
|
147
|
+
* Combined confidence (passkey + signals + integrations)
|
|
148
|
+
*/
|
|
149
|
+
confidence?: number;
|
|
150
|
+
reason?: string;
|
|
151
|
+
signals?: SDKVerifyTokenResponse.Signals;
|
|
152
|
+
valid?: boolean;
|
|
153
|
+
}
|
|
154
|
+
export declare namespace SDKVerifyTokenResponse {
|
|
155
|
+
interface Claims {
|
|
156
|
+
auth_mode?: 'linked-account' | 'private';
|
|
157
|
+
botshield_user_id?: string;
|
|
158
|
+
expires_at?: number;
|
|
159
|
+
issued_at?: number;
|
|
160
|
+
organization_id?: string;
|
|
161
|
+
partner_user_id?: string;
|
|
162
|
+
request_id?: string;
|
|
163
|
+
timestamp?: string;
|
|
164
|
+
user_email?: string;
|
|
165
|
+
verified?: boolean;
|
|
166
|
+
}
|
|
167
|
+
interface Signals {
|
|
168
|
+
/**
|
|
169
|
+
* Signal Pixel score (0-100)
|
|
170
|
+
*/
|
|
171
|
+
botshield_score?: number;
|
|
172
|
+
passkey?: Signals.Passkey;
|
|
173
|
+
turnstile?: Signals.Turnstile;
|
|
174
|
+
}
|
|
175
|
+
namespace Signals {
|
|
176
|
+
interface Passkey {
|
|
177
|
+
verified?: boolean;
|
|
178
|
+
}
|
|
179
|
+
interface Turnstile {
|
|
180
|
+
success?: boolean;
|
|
181
|
+
}
|
|
182
|
+
}
|
|
29
183
|
}
|
|
30
184
|
export interface SDKCreateSessionParams {
|
|
185
|
+
metadata?: {
|
|
186
|
+
[key: string]: unknown;
|
|
187
|
+
};
|
|
188
|
+
/**
|
|
189
|
+
* Your internal user identifier for correlation
|
|
190
|
+
*/
|
|
191
|
+
partner_user_id?: string;
|
|
31
192
|
}
|
|
32
193
|
export interface SDKCreateVerificationLinkParams {
|
|
194
|
+
/**
|
|
195
|
+
* Returning user ID to skip onboarding
|
|
196
|
+
*/
|
|
197
|
+
botshield_user_id?: string;
|
|
198
|
+
metadata?: {
|
|
199
|
+
[key: string]: unknown;
|
|
200
|
+
};
|
|
201
|
+
/**
|
|
202
|
+
* linked-account = OAuth+passkey, private = direct WebAuthn (no PII)
|
|
203
|
+
*/
|
|
204
|
+
mode?: 'linked-account' | 'private';
|
|
205
|
+
return_url?: string;
|
|
206
|
+
scope?: string;
|
|
207
|
+
sdk_type?: 'signal' | 'presence';
|
|
208
|
+
/**
|
|
209
|
+
* Tamper-proof Signal Pixel token (bs*sig*...) for server-side score correlation
|
|
210
|
+
*/
|
|
211
|
+
signal_token?: string;
|
|
212
|
+
user_email?: string;
|
|
213
|
+
webhook_url?: string;
|
|
214
|
+
}
|
|
215
|
+
export interface SDKGetPartnerConfigParams {
|
|
216
|
+
site_key: string;
|
|
33
217
|
}
|
|
34
218
|
export interface SDKLogoutParams {
|
|
219
|
+
/**
|
|
220
|
+
* The anchor grant token (bss\_\*) to revoke
|
|
221
|
+
*/
|
|
222
|
+
session_token: string;
|
|
223
|
+
}
|
|
224
|
+
export interface SDKRevokeVerificationParams {
|
|
225
|
+
scope: string;
|
|
226
|
+
partner_user_id?: string;
|
|
227
|
+
user_email?: string;
|
|
228
|
+
}
|
|
229
|
+
export interface SDKStoreSignalParams {
|
|
230
|
+
score: number;
|
|
231
|
+
site_key: string;
|
|
232
|
+
client_score?: number;
|
|
233
|
+
country?: string;
|
|
234
|
+
edge_score?: number;
|
|
235
|
+
fp_hash?: string;
|
|
236
|
+
ip_hash?: string;
|
|
237
|
+
signals?: unknown;
|
|
238
|
+
ua_hash?: string;
|
|
239
|
+
}
|
|
240
|
+
export interface SDKValidateSignalParams {
|
|
241
|
+
signal_token: string;
|
|
242
|
+
verification_event_id?: string;
|
|
243
|
+
}
|
|
244
|
+
export interface SDKVerifyTokenParams {
|
|
245
|
+
/**
|
|
246
|
+
* JWT verification receipt
|
|
247
|
+
*/
|
|
248
|
+
token: string;
|
|
249
|
+
/**
|
|
250
|
+
* Optional Signal Pixel token for combined confidence
|
|
251
|
+
*/
|
|
252
|
+
signal_token?: string;
|
|
35
253
|
}
|
|
36
254
|
export declare namespace SDK {
|
|
37
|
-
export { type SDKCreateSessionResponse as SDKCreateSessionResponse, type SDKCreateVerificationLinkResponse as SDKCreateVerificationLinkResponse, type SDKLogoutResponse as SDKLogoutResponse, type SDKCreateSessionParams as SDKCreateSessionParams, type SDKCreateVerificationLinkParams as SDKCreateVerificationLinkParams, type SDKLogoutParams as SDKLogoutParams, };
|
|
255
|
+
export { type SDKCreateSessionResponse as SDKCreateSessionResponse, type SDKCreateVerificationLinkResponse as SDKCreateVerificationLinkResponse, type SDKGetPartnerConfigResponse as SDKGetPartnerConfigResponse, type SDKLogoutResponse as SDKLogoutResponse, type SDKRevokeVerificationResponse as SDKRevokeVerificationResponse, type SDKStoreSignalResponse as SDKStoreSignalResponse, type SDKValidateSignalResponse as SDKValidateSignalResponse, type SDKVerifyTokenResponse as SDKVerifyTokenResponse, type SDKCreateSessionParams as SDKCreateSessionParams, type SDKCreateVerificationLinkParams as SDKCreateVerificationLinkParams, type SDKGetPartnerConfigParams as SDKGetPartnerConfigParams, type SDKLogoutParams as SDKLogoutParams, type SDKRevokeVerificationParams as SDKRevokeVerificationParams, type SDKStoreSignalParams as SDKStoreSignalParams, type SDKValidateSignalParams as SDKValidateSignalParams, type SDKVerifyTokenParams as SDKVerifyTokenParams, };
|
|
38
256
|
}
|
|
39
257
|
//# sourceMappingURL=sdk.d.ts.map
|
package/resources/sdk.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sdk.d.ts","sourceRoot":"","sources":["../src/resources/sdk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB;;GAEG;AACH,qBAAa,GAAI,SAAQ,WAAW;IAClC
|
|
1
|
+
{"version":3,"file":"sdk.d.ts","sourceRoot":"","sources":["../src/resources/sdk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB;;GAEG;AACH,qBAAa,GAAI,SAAQ,WAAW;IAClC;;;OAGG;IACH,aAAa,CACX,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;IAIvC;;;OAGG;IACH,sBAAsB,CACpB,IAAI,EAAE,+BAA+B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAIhD;;;OAGG;IACH,gBAAgB,CACd,KAAK,EAAE,yBAAyB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAI1C;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAItF;;;OAGG;IACH,kBAAkB,CAChB,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAI5C;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIrG;;;OAGG;IACH,cAAc,CACZ,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGtG;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,wBAAwB,CAAC,IAAI,CAAC;CACrC;AAED,yBAAiB,wBAAwB,CAAC;IACxC,UAAiB,IAAI;QACnB,uBAAuB,EAAE,MAAM,CAAC;QAEhC,+BAA+B,EAAE,MAAM,CAAC;QAExC;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B,UAAU,EAAE,MAAM,CAAC;QAEnB,kBAAkB,EAAE,MAAM,CAAC;QAE3B,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC;QAEhC;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;KACvB;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,YAAY;YAC3B,EAAE,EAAE,MAAM,CAAC;YAEX,WAAW,EAAE,MAAM,CAAC;SACrB;KACF;CACF;AAED,MAAM,WAAW,iCAAiC;IAChD,IAAI,EAAE,iCAAiC,CAAC,IAAI,CAAC;CAC9C;AAED,yBAAiB,iCAAiC,CAAC;IACjD,UAAiB,IAAI;QACnB,SAAS,EAAE,MAAM,CAAC;QAElB,UAAU,EAAE,MAAM,CAAC;QAEnB,WAAW,EAAE,MAAM,CAAC;QAEpB,UAAU,EAAE,MAAM,CAAC;QAEnB,OAAO,EAAE,MAAM,CAAC;QAEhB,SAAS,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;QAEzC,YAAY,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC;QAEjC,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,QAAQ,CAAC,EAAE,QAAQ,GAAG,UAAU,CAAC;KAClC;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,YAAY;YAC3B,EAAE,CAAC,EAAE,MAAM,CAAC;SACb;KACF;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAE9B,YAAY,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,2BAA2B,CAAC,YAAY,CAAA;KAAE,CAAC;CAC5E;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,YAAY;QAC3B,MAAM,CAAC,EAAE,OAAO,CAAC;QAEjB,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,MAAM,WAAW,6BAA6B;IAC5C,IAAI,EAAE,6BAA6B,CAAC,IAAI,CAAC;CAC1C;AAED,yBAAiB,6BAA6B,CAAC;IAC7C,UAAiB,IAAI;QACnB,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,yBAAyB;IACxC,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,sBAAsB;IACrC,MAAM,CAAC,EAAE,sBAAsB,CAAC,MAAM,CAAC;IAEvC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,OAAO,CAAC,EAAE,sBAAsB,CAAC,OAAO,CAAC;IAEzC,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,MAAM;QACrB,SAAS,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;QAEzC,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB;IAED,UAAiB,OAAO;QACtB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC;QAE1B,SAAS,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC;KAC/B;IAED,UAAiB,OAAO,CAAC;QACvB,UAAiB,OAAO;YACtB,QAAQ,CAAC,EAAE,OAAO,CAAC;SACpB;QAED,UAAiB,SAAS;YACxB,OAAO,CAAC,EAAE,OAAO,CAAC;SACnB;KACF;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;OAEG;IACH,IAAI,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;IAEpC,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,QAAQ,CAAC,EAAE,QAAQ,GAAG,UAAU,CAAC;IAEjC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,yBAAyB;IACxC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,2BAA2B;IAC1C,KAAK,EAAE,MAAM,CAAC;IAEd,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,MAAM,CAAC;IAEd,QAAQ,EAAE,MAAM,CAAC;IAEjB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,uBAAuB;IACtC,YAAY,EAAE,MAAM,CAAC;IAErB,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,CAAC,OAAO,WAAW,GAAG,CAAC;IAC3B,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
|