@rebilly/risk-data-collector 2.5.0 → 2.5.2

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.
Files changed (3) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +27 -18
  3. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,3 +1,17 @@
1
+ ## [2.5.2](https://github.com/Rebilly/rebilly/compare/risk-data-collector-v2.5.1...risk-data-collector-v2.5.2) (2023-04-20)
2
+
3
+
4
+ ### Bug Fixes
5
+
6
+ * **risk-data-collector:** Use markdown linter and force a new release ([#154](https://github.com/Rebilly/rebilly/issues/154)) ([6cc79f1](https://github.com/Rebilly/rebilly/commit/6cc79f1779afcfbd62c70518dbcffad1ef3ec5f2))
7
+
8
+ ## [2.5.1](https://github.com/Rebilly/rebilly/compare/risk-data-collector-v2.5.0...risk-data-collector-v2.5.1) (2023-04-20)
9
+
10
+
11
+ ### Bug Fixes
12
+
13
+ * **risk-data-collector:** Remove unpkg and recommend our own CDN ([#153](https://github.com/Rebilly/rebilly/issues/153)) ([893aee8](https://github.com/Rebilly/rebilly/commit/893aee8021506fced6dcf04b227fdc77c02b1e97))
14
+
1
15
  ## [2.5.0](https://github.com/Rebilly/rebilly/compare/risk-data-collector-v2.4.0...risk-data-collector-v2.5.0) (2023-04-19)
2
16
 
3
17
 
package/README.md CHANGED
@@ -1,30 +1,34 @@
1
1
  # risk-data-collector
2
+
2
3
  Collect browser data for risk assessment purposes.
3
4
 
4
5
  ## Description
6
+
5
7
  `risk-data-collector` is a client side microlibrary which collects user data required for the risk assessment component of 3DS v2.
6
8
 
7
9
  ## Data collected
8
- ```
9
- colorDepth
10
- javaEnabled
11
- language
12
- screenHeight
13
- screenWidth
14
- timeZoneOffset
15
- deviceFingerprintHash
16
- kountFraudSessionId (optional)
17
- ```
10
+
11
+ - colorDepth
12
+ - javaEnabled
13
+ - language
14
+ - screenHeight
15
+ - screenWidth
16
+ - timeZoneOffset
17
+ - deviceFingerprintHash
18
+ - kountFraudSessionId (optional)
18
19
 
19
20
  ## Usage
21
+
20
22
  `risk-data-collector` is distributed in two ways:
21
- 1. Via a CDN link
23
+
24
+ ### Via a CDN link
25
+
22
26
  The library becomes available under the `RiskDataCollector` global namespace and can be used like so:
23
27
 
24
28
  ```html
25
29
  <html>
26
30
  <head>
27
- <script src="https://unpkg.com/@rebilly/risk-data-collector"></script>
31
+ <script src="https://cdn.rebilly.com/risk-data-collector/@latest/data-collector.js"></script>
28
32
  </head>
29
33
 
30
34
  <body>
@@ -38,16 +42,18 @@ The library becomes available under the `RiskDataCollector` global namespace and
38
42
  <html>
39
43
  ```
40
44
 
41
- <br>
45
+ > Note: You can replace `@latest` with `@<version>` (Example `@1.0.0`). To pin to a specific version.
42
46
 
43
- 2. As an npm package
44
- ```
47
+ ### As an npm package
48
+
49
+ ```bash
45
50
  yarn add @rebilly/risk-data-collector
46
51
 
47
52
  npm install @rebilly/risk-data-collector
48
53
  ```
49
54
 
50
55
  Which can be imported and used like so:
56
+
51
57
  ```js
52
58
  import {collectData} from '@rebilly/risk-data-collector';
53
59
 
@@ -58,14 +64,17 @@ import {collectData} from '@rebilly/risk-data-collector';
58
64
  ```
59
65
 
60
66
  ## Kount
67
+
61
68
  `risk-data-collector` works with [Kount](https://kount.com/) to collect `kountFraudSessionId`.
62
69
 
63
70
  If you already have an account with Kount, you can use it with `risk-data-collector` by providing:
64
- * `env` - `sandbox` or `production`, determines which Kount environment to use (defaults to `sandbox`)
65
- * `kountAccountId` - your Kount account ID
66
- * (optional) `kountSessionId` - 32 character session ID, omit to have Kount generate a session ID for you
71
+
72
+ - `env` - `sandbox` or `production`, determines which Kount environment to use (defaults to `sandbox`)
73
+ - `kountAccountId` - your Kount account ID
74
+ - (optional) `kountSessionId` - 32 character session ID, omit to have Kount generate a session ID for you
67
75
 
68
76
  Example:
77
+
69
78
  ```js
70
79
  import {collectData} from '@rebilly/risk-data-collector';
71
80
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rebilly/risk-data-collector",
3
- "version": "2.5.0",
3
+ "version": "2.5.2",
4
4
  "description": "Microlibrary that collects browser data for risk assessment",
5
5
  "type": "module",
6
6
  "main": "dist/data-collector.js",