@finclusionaibuild/liveness-sdk 1.0.0 → 1.0.3
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 +16 -16
- package/package.json +6 -3
package/README.md
CHANGED
|
@@ -4,7 +4,7 @@ A comprehensive Face Liveness Detection SDK for React applications. This SDK pro
|
|
|
4
4
|
|
|
5
5
|
## Features
|
|
6
6
|
|
|
7
|
-
- ✅ **Face Liveness Detection** - Real-time face verification
|
|
7
|
+
- ✅ **Face Liveness Detection** - Real-time face verification.
|
|
8
8
|
- ✅ **Mobile Responsive** - Optimized for mobile, tablet, and desktop devices
|
|
9
9
|
- ✅ **Multiple Components** - `LivenessDetector`, `ExternalLiveness`, `PaymentLiveness`
|
|
10
10
|
- ✅ **TypeScript Support** - Full TypeScript definitions included
|
|
@@ -15,7 +15,7 @@ A comprehensive Face Liveness Detection SDK for React applications. This SDK pro
|
|
|
15
15
|
## Installation
|
|
16
16
|
|
|
17
17
|
```bash
|
|
18
|
-
npm install @
|
|
18
|
+
npm install @finclusionaibuild/liveness-sdk
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
## Peer Dependencies
|
|
@@ -47,7 +47,7 @@ function App() {
|
|
|
47
47
|
2. **CSS Import**: You must import the SDK's stylesheet:
|
|
48
48
|
|
|
49
49
|
```tsx
|
|
50
|
-
import "@
|
|
50
|
+
import "@finclusionaibuild/liveness-sdk/styles.css";
|
|
51
51
|
```
|
|
52
52
|
|
|
53
53
|
## Quick Start (Web)
|
|
@@ -57,8 +57,8 @@ import "@finclusion/liveness-sdk/styles.css";
|
|
|
57
57
|
```tsx
|
|
58
58
|
import React from "react";
|
|
59
59
|
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
|
|
60
|
-
import { LivenessDetector } from "@
|
|
61
|
-
import "@
|
|
60
|
+
import { LivenessDetector } from "@finclusionaibuild/liveness-sdk";
|
|
61
|
+
import "@finclusionaibuild/liveness-sdk/styles.css";
|
|
62
62
|
|
|
63
63
|
const queryClient = new QueryClient();
|
|
64
64
|
|
|
@@ -97,8 +97,8 @@ import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
|
|
|
97
97
|
import {
|
|
98
98
|
LivenessDetector,
|
|
99
99
|
type LivenessConfig,
|
|
100
|
-
} from "@
|
|
101
|
-
import "@
|
|
100
|
+
} from "@finclusionaibuild/liveness-sdk";
|
|
101
|
+
import "@finclusionaibuild/liveness-sdk/styles.css";
|
|
102
102
|
|
|
103
103
|
const queryClient = new QueryClient();
|
|
104
104
|
|
|
@@ -161,7 +161,7 @@ function AdvancedLivenessExample() {
|
|
|
161
161
|
import React, { useState } from "react";
|
|
162
162
|
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
|
|
163
163
|
import { LivenessDetector, type LivenessError } from "@finclusion/liveness-sdk";
|
|
164
|
-
import "@
|
|
164
|
+
import "@finclusionaibuild/liveness-sdk/styles.css";
|
|
165
165
|
|
|
166
166
|
const queryClient = new QueryClient();
|
|
167
167
|
|
|
@@ -266,7 +266,7 @@ interface ExternalLivenessProps {
|
|
|
266
266
|
config: LivenessConfig;
|
|
267
267
|
token?: string | null;
|
|
268
268
|
gotoNext: () => void;
|
|
269
|
-
region?: string; // Optional:
|
|
269
|
+
region?: string; // Optional:
|
|
270
270
|
logoUrl?: string;
|
|
271
271
|
instructionText?: string;
|
|
272
272
|
}
|
|
@@ -661,10 +661,10 @@ The SDK expects your backend to provide these endpoints:
|
|
|
661
661
|
```json
|
|
662
662
|
{
|
|
663
663
|
"sessionId": "string",
|
|
664
|
-
"
|
|
665
|
-
"
|
|
666
|
-
"
|
|
667
|
-
"
|
|
664
|
+
"AccessKeyId": "string",
|
|
665
|
+
"SecretAccessKey": "string",
|
|
666
|
+
"SessionToken": "string",
|
|
667
|
+
"Region": "string"
|
|
668
668
|
}
|
|
669
669
|
```
|
|
670
670
|
|
|
@@ -702,13 +702,13 @@ The SDK expects your backend to provide these endpoints:
|
|
|
702
702
|
The SDK includes all necessary styles bundled. Simply import:
|
|
703
703
|
|
|
704
704
|
```tsx
|
|
705
|
-
import "@
|
|
705
|
+
import "@finclusionaibuild/liveness-sdk/styles.css";
|
|
706
706
|
```
|
|
707
707
|
|
|
708
708
|
The stylesheet includes:
|
|
709
709
|
|
|
710
710
|
- Tailwind CSS utilities (responsive, mobile-optimized)
|
|
711
|
-
-
|
|
711
|
+
- Finclusion UI styles (processed and rebranded)
|
|
712
712
|
- Component-specific styling
|
|
713
713
|
|
|
714
714
|
**Note:** The SDK is mobile-responsive by default. No additional CSS configuration needed.
|
|
@@ -731,7 +731,7 @@ The stylesheet includes:
|
|
|
731
731
|
|
|
732
732
|
### Styles Not Applying
|
|
733
733
|
|
|
734
|
-
- Ensure you've imported the CSS: `import '@
|
|
734
|
+
- Ensure you've imported the CSS: `import '@finclusionaibuild/liveness-sdk/styles.css';`
|
|
735
735
|
- Check that the CSS file is being loaded (inspect network tab)
|
|
736
736
|
- Verify no CSS conflicts with your app's styles
|
|
737
737
|
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@finclusionaibuild/liveness-sdk",
|
|
3
|
-
"version": "1.0.
|
|
4
|
-
"description": "AWS Face Liveness SDK for React applications
|
|
3
|
+
"version": "1.0.3",
|
|
4
|
+
"description": "AWS Face Liveness SDK for React applications.",
|
|
5
5
|
"main": "./dist/index.cjs.js",
|
|
6
6
|
"module": "./dist/index.esm.js",
|
|
7
7
|
"types": "./dist/index.d.ts",
|
|
@@ -25,7 +25,10 @@
|
|
|
25
25
|
"clean": "node -e \"const fs=require('fs');const path='./dist/tailwind-temp.css';if(fs.existsSync(path))fs.unlinkSync(path);\"",
|
|
26
26
|
"dev": "rollup -c -w",
|
|
27
27
|
"type-check": "tsc --noEmit",
|
|
28
|
-
"prepublishOnly": "npm run build && npm run clean"
|
|
28
|
+
"prepublishOnly": "npm run build && npm run clean",
|
|
29
|
+
"release:patch": "npm version patch && npm publish --access public && git push && git push --tags",
|
|
30
|
+
"release:minor": "npm version minor && npm publish && git push && git push --tags",
|
|
31
|
+
"release:major": "npm version major && npm publish && git push && git push --tags"
|
|
29
32
|
},
|
|
30
33
|
"keywords": [
|
|
31
34
|
"liveness",
|