@simprints/simface-sdk 0.1.0 → 0.2.1
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 +7 -19
- package/package.json +7 -27
package/README.md
CHANGED
|
@@ -14,7 +14,7 @@ In standard browsers, the SDK uses an in-page camera flow powered by `getUserMed
|
|
|
14
14
|
|
|
15
15
|
### 1. Include the SDK
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
**Option A — npm:**
|
|
18
18
|
```bash
|
|
19
19
|
npm install @simprints/simface-sdk
|
|
20
20
|
```
|
|
@@ -22,28 +22,16 @@ npm install @simprints/simface-sdk
|
|
|
22
22
|
import { enroll, verify } from '@simprints/simface-sdk';
|
|
23
23
|
```
|
|
24
24
|
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
1. Open the latest GitHub release for this repository.
|
|
28
|
-
2. Download the `simface-sdk-<version>-dist.tgz` asset.
|
|
29
|
-
3. Extract the archive and copy `dist/simface-sdk.js` into your app's static assets, for example `public/vendor/simface-sdk.js`.
|
|
30
|
-
4. Reference the copied file from your page:
|
|
25
|
+
**Option B — direct script include:**
|
|
31
26
|
|
|
27
|
+
Download the SDK files from the [latest GitHub Release](../../releases/latest) and include them directly:
|
|
32
28
|
```html
|
|
33
|
-
<script type="module" src="
|
|
29
|
+
<script type="module" src="simface-sdk.js"></script>
|
|
34
30
|
```
|
|
35
31
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
npm run build
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
Then publish or serve the generated files from `dist/`.
|
|
43
|
-
The generated library files are:
|
|
44
|
-
|
|
45
|
-
- `dist/simface-sdk.js` (ES module)
|
|
46
|
-
- `dist/simface-sdk.umd.cjs` (UMD/CommonJS build)
|
|
32
|
+
The release contains two builds:
|
|
33
|
+
- `simface-sdk.js` (ES module)
|
|
34
|
+
- `simface-sdk.umd.cjs` (UMD/CommonJS build)
|
|
47
35
|
|
|
48
36
|
### 2. Configure
|
|
49
37
|
|
package/package.json
CHANGED
|
@@ -1,22 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@simprints/simface-sdk",
|
|
3
|
-
"version": "0.1
|
|
3
|
+
"version": "0.2.1",
|
|
4
|
+
"simprints:releaseMajorVersion": "0",
|
|
4
5
|
"description": "SimFace facial recognition SDK for web-based KYC workflows",
|
|
5
|
-
"keywords": [
|
|
6
|
-
"biometrics",
|
|
7
|
-
"simprints"
|
|
8
|
-
],
|
|
9
|
-
"homepage": "https://github.com/Simprints/LegoDay-Simprints-IDV-Frontend#readme",
|
|
10
|
-
"bugs": {
|
|
11
|
-
"url": "https://github.com/Simprints/LegoDay-Simprints-IDV-Frontend/issues"
|
|
12
|
-
},
|
|
13
|
-
"repository": {
|
|
14
|
-
"type": "git",
|
|
15
|
-
"url": "git+https://github.com/Simprints/LegoDay-Simprints-IDV-Frontend.git"
|
|
16
|
-
},
|
|
17
|
-
"license": "ISC",
|
|
18
|
-
"author": "simprints",
|
|
19
6
|
"type": "module",
|
|
7
|
+
"main": "dist/simface-sdk.umd.cjs",
|
|
8
|
+
"module": "dist/simface-sdk.js",
|
|
9
|
+
"types": "dist/index.d.ts",
|
|
20
10
|
"exports": {
|
|
21
11
|
".": {
|
|
22
12
|
"types": "./dist/index.d.ts",
|
|
@@ -24,11 +14,6 @@
|
|
|
24
14
|
"require": "./dist/simface-sdk.umd.cjs"
|
|
25
15
|
}
|
|
26
16
|
},
|
|
27
|
-
"main": "dist/simface-sdk.umd.cjs",
|
|
28
|
-
"types": "dist/index.d.ts",
|
|
29
|
-
"directories": {
|
|
30
|
-
"doc": "docs"
|
|
31
|
-
},
|
|
32
17
|
"files": [
|
|
33
18
|
"dist"
|
|
34
19
|
],
|
|
@@ -50,12 +35,7 @@
|
|
|
50
35
|
"eslint": "^9.0.0",
|
|
51
36
|
"typescript": "^5.6.0",
|
|
52
37
|
"vite": "^6.0.0",
|
|
53
|
-
"vitest": "^
|
|
38
|
+
"vitest": "^4.0.0",
|
|
54
39
|
"jsdom": "^25.0.0"
|
|
55
|
-
}
|
|
56
|
-
"publishConfig": {
|
|
57
|
-
"access": "public",
|
|
58
|
-
"registry": "https://registry.npmjs.org/"
|
|
59
|
-
},
|
|
60
|
-
"module": "dist/simface-sdk.js"
|
|
40
|
+
}
|
|
61
41
|
}
|