vishwam-react-ent-sdk 1.0.7 → 1.0.8

package/README.md

@@ -1 +1,148 @@
-# vishwam-react-sdk
+# vishwam-react-ent-sdk
+
+React components for **ENT photo liveness** (`CheckLiveness`): in-browser face capture, on-device face detection, and backend liveness verification.
+
+**Peer dependency:** React `^17.0.1`
+
+---
+
+## Install
+
+```bash
+npm install vishwam-react-ent-sdk
+# or
+yarn add vishwam-react-ent-sdk
+```
+
+---
+
+## Quick start
+
+Integration values (`url`, `appId`, and related props) are issued for your deployment. Do not use example credentials in production.
+
+```jsx
+import React from 'react'
+import { CheckLiveness } from 'vishwam-react-ent-sdk'
+
+function App() {
+  function onLiveness(response) {
+    // response.livenessImage — base64 (no data: prefix)
+    // response.livenessImageType — e.g. image/jpeg or image/png
+  }
+
+  return (
+    <CheckLiveness
+      url={apiBaseUrl}
+      appId={appId}
+      userId={userId}
+      referenceId={referenceId}
+      captureType={captureType}
+      eyesCheck={eyesCheck}
+      storeId={storeId}
+      whiteBackground={whiteBackground}
+      expiryIn={expiryIn}
+      getLivenessResponse={onLiveness}
+    />
+  )
+}
+```
+
+---
+
+## Exports
+
+| Export | Description |
+|--------|-------------|
+| `CheckLiveness` | Photo liveness UI + API call |
+| `ReadDocument` | Document capture flow |
+| `Init` | Face detector preparation helper |
+| `faceMatch` | Face match API helper |
+
+---
+
+## `CheckLiveness` props
+
+| Prop | Type | Description |
+|------|------|-------------|
+| `url` | string | API base URL for your environment |
+| `appId` | string | Application id |
+| `userId` | string \| number | User id |
+| `referenceId` | string | Reference / transaction id |
+| `captureType` | string | Capture type sent to API |
+| `eyesCheck` | string | Eyes-open check flag for API |
+| `storeId` | string | Store id |
+| `whiteBackground` | string | White background flag |
+| `expiryIn` | string | Token expiry (e.g. `1h`) |
+| `getLivenessResponse` | function | Callback with API response (see below) |
+
+---
+
+## Capture and images
+
+On capture the SDK:
+
+1. Reads a frame from the camera (desktop: webcam screenshot; mobile: canvas snapshot).
+2. Builds two square images from the same frame:
+   - **450×450** — sent as the second image field in the liveness API request.
+   - **224×224** — sent as the first image field in the liveness API request.
+3. Calls the liveness endpoint with both images (after obtaining an auth token).
+
+On-device face detection models are loaded by the SDK at runtime.
+
+---
+
+## `getLivenessResponse` callback
+
+The SDK merges the API JSON with local image fields before calling your handler:
+
+| Field | Description |
+|-------|-------------|
+| `status` | API status (e.g. `success` / `failed`) |
+| `livenessImage` | Base64-encoded face image (**no** `data:` prefix) |
+| `livenessImageType` | MIME type for decoding (typically `image/jpeg` on desktop, `image/png` on mobile) |
+| … | Other fields returned by the liveness API |
+
+**Display example:**
+
+```javascript
+const src = `data:${response.livenessImageType};base64,${response.livenessImage}`
+```
+
+Decode with `Image` / `naturalWidth` × `naturalHeight` if you need pixel dimensions.
+
+---
+
+## Changelog
+
+### 1.0.8
+
+**Callback image quality**
+
+- **`livenessImage` is now the 450×450 capture** (same asset previously sent only as the high-resolution API upload).
+- In **1.0.7**, `livenessImage` was the **224×224** image. Integrators that assumed 224×224 in the callback should update display/storage logic; API upload sizes are unchanged.
+
+**Desktop bug fix**
+
+- On **desktop**, startup now runs the full face-detection initialization path (models, UI ready state, detection loop) instead of loading models only, which could leave laptop browsers stuck on “face detector is initializing”.
+- **Mobile** flow is unchanged.
+
+### 1.0.7
+
+- Updated on-device model loading for face detection.
+
+---
+
+## Build (maintainers)
+
+```bash
+npm install
+npm run build
+```
+
+Published tarball includes `dist/` (`prepare` runs build on `npm publish`).
+
+---
+
+## License
+
+MIT

package/dist/index.js

@@ -631,7 +631,7 @@ function CheckLiveness(_ref) {
           var img2 = imgStr.split(',')[1];
           clearInterval(interval);
           return Promise.resolve(callLiveness(url, appId, userId, referenceId, captureType, eyesCheck, storeId, whiteBackground, expiryIn, img, img2, mimeString)).then(function (response) {
-            response.livenessImage = img2;
+            response.livenessImage = img;
             response.livenessImageType = mimeString;
             getLivenessResponse(response);
             setLoading(false);
@@ -659,20 +659,10 @@ function CheckLiveness(_ref) {
   }, []);
   React.useEffect(function () {
     setTimeout(function () {
-      var initModels = function initModels() {
-        try {
-          return Promise.resolve(faceapi.nets.tinyFaceDetector.loadFromUri('https://skyc-cdn-prod.vishwamcorp.com/apis/models/')).then(function () {
-            return Promise.resolve(faceapi.nets.faceLandmark68TinyNet.loadFromUri('https://skyc-cdn-prod.vishwamcorp.com/apis/models/')).then(function () {});
-          });
-        } catch (e) {
-          return Promise.reject(e);
-        }
-      };
-
       if (reactDeviceDetect.isMobile) {
         startCamera();
       } else {
-        initModels();
+        init();
       }
     }, 500);
   }, []);