@dtect/security-sdk-react 0.0.6 → 0.0.7
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 +15 -21
- package/package.json +2 -2
- package/tsup.config.ts +1 -2
package/README.md
CHANGED
|
@@ -6,32 +6,22 @@ Security API SDK for React by dtect.
|
|
|
6
6
|
<details>
|
|
7
7
|
<summary>Table of Contents</summary>
|
|
8
8
|
<ol>
|
|
9
|
-
|
|
10
|
-
<a href="#about-the-project">About The Project</a>
|
|
11
|
-
</li>
|
|
9
|
+
|
|
12
10
|
<li>
|
|
13
11
|
<a href="#getting-started">Getting Started</a>
|
|
14
12
|
<ul>
|
|
15
|
-
<li><a href="#prerequisites">Prerequisites</a></li>
|
|
16
13
|
<li><a href="#installation">Installation</a></li>
|
|
17
14
|
</ul>
|
|
18
15
|
</li>
|
|
19
|
-
|
|
16
|
+
<li>
|
|
20
17
|
<a href="#implementation">Implementation</a>
|
|
21
18
|
</li>
|
|
22
19
|
<li><a href="#license">License</a></li>
|
|
23
20
|
<li><a href="#contact">Contact</a></li>
|
|
21
|
+
|
|
24
22
|
</ol>
|
|
25
23
|
</details>
|
|
26
24
|
|
|
27
|
-
<!-- ABOUT THE PROJECT -->
|
|
28
|
-
|
|
29
|
-
## About The Project
|
|
30
|
-
|
|
31
|
-
Security API SDK for React.
|
|
32
|
-
|
|
33
|
-
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
34
|
-
|
|
35
25
|
<!-- GETTING STARTED -->
|
|
36
26
|
|
|
37
27
|
## Getting Started
|
|
@@ -39,9 +29,9 @@ Security API SDK for React.
|
|
|
39
29
|
The dtect Security API helps you gather valuable insights about your visitors, enhancing the quality of your survey data.
|
|
40
30
|
This library is responsible for collecting data about the visitor's browser and behavior, send everything to our API and return a Security Result or a Security Token.
|
|
41
31
|
|
|
42
|
-
|
|
32
|
+
_Please refer to [our official documentation](https://docs.dtect.io) to read full documentation on security api_
|
|
43
33
|
|
|
44
|
-
|
|
34
|
+
_**If you want to use our API, please [contact us](https://dtect.io/contact)**_
|
|
45
35
|
|
|
46
36
|
### Installation
|
|
47
37
|
|
|
@@ -63,10 +53,14 @@ yarn add @dtect/security-sdk-react
|
|
|
63
53
|
|
|
64
54
|
## Implementation
|
|
65
55
|
|
|
56
|
+
_Read full documentation about implementation on [our official docs](https://docs.dtect.io/frontend/introduction)_
|
|
57
|
+
|
|
66
58
|
### 1. Wrap your application (or component) with `<SecurityAPIProvider>`.
|
|
67
59
|
|
|
68
|
-
- Set
|
|
69
|
-
- Set
|
|
60
|
+
- Set your public client id as `clientId`
|
|
61
|
+
- Set your public api key as `apiKey`
|
|
62
|
+
|
|
63
|
+
Read more about keys on our [official docs](https://docs.dtect.io/credentials)
|
|
70
64
|
|
|
71
65
|
```jsx
|
|
72
66
|
// index.ts or app.tsx
|
|
@@ -143,6 +137,8 @@ export default Form;
|
|
|
143
137
|
|
|
144
138
|
## Errors
|
|
145
139
|
|
|
140
|
+
_Read full documentation about errors on [our official docs](https://docs.dtect.io/errors)_
|
|
141
|
+
|
|
146
142
|
Access the list of error enums from `SecurityAPIError`
|
|
147
143
|
|
|
148
144
|
### SecurityAPIProvider
|
|
@@ -208,13 +204,11 @@ function Form() {
|
|
|
208
204
|
export default Form;
|
|
209
205
|
```
|
|
210
206
|
|
|
211
|
-
_To see full documentation, please refer to the [Documentation](https://dtect.apidog.com)_
|
|
212
|
-
|
|
213
207
|
<!-- LICENSE -->
|
|
214
208
|
|
|
215
|
-
## License
|
|
209
|
+
<!-- ## License
|
|
216
210
|
|
|
217
|
-
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
211
|
+
<p align="right">(<a href="#readme-top">back to top</a>)</p> -->
|
|
218
212
|
|
|
219
213
|
<!-- CONTACT -->
|
|
220
214
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dtect/security-sdk-react",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.7",
|
|
4
4
|
"main": "dist/index.js",
|
|
5
5
|
"module": "dist/index.mjs",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
"ts:check": "tsc --noEmit"
|
|
10
10
|
},
|
|
11
11
|
"dependencies": {
|
|
12
|
-
"@dtect/security-sdk-js": "^0.0.
|
|
12
|
+
"@dtect/security-sdk-js": "^0.0.7",
|
|
13
13
|
"@tanstack/react-query": "^5.64.1",
|
|
14
14
|
"react": "^19.0.0",
|
|
15
15
|
"react-dom": "^19.0.0"
|