youverify-liveness-web 0.1.0 → 0.1.1

package/README.md

@@ -41,7 +41,7 @@ This could also be called with an array of tasks. The supplied tasks override th
 
 ```js
 const tasks = [{ id: "complete-the-circle" }];
-yvLiveness.start();
+yvLiveness.start(tasks);
 ```
 
 Full Example:
@@ -129,8 +129,9 @@ The `onSuccess` and `onFailure` callbacks (if supplied) are passed the following
 | Option | Type | Description |
 | --- | --- | --- |
 | `data` | Object | Data passed through callback | 
-| `data.video` | File | Video recording of entire liveness process
-| `data.photo` | File | Face Image of user performing liveness check
+| `data.faceImage` | File | Face Image of user performing liveness check |
+| `data.passed` | Boolean | Indicator on whether liveness check passed or failed |
+| `data.metadata` | Any | Metadata passed in during initialization |
 
 ## Credits
 

package/dist/index.d.ts

@@ -6,11 +6,13 @@ declare interface Branding {
 declare type CompleteTheCircleTask = TaskBase<"complete-the-circle">;
 
 declare interface LivenessData {
-    video: File;
-    photo: File;
+    faceImage: string;
+    passed: boolean;
+    metadata?: Metadata;
 }
 
 declare interface LivenessWebSdkProps {
+    publicKey: string;
     presentation?: Presentation;
     tasks?: Array<Task>;
     user?: User;
@@ -19,8 +21,11 @@ declare interface LivenessWebSdkProps {
     onClose?: () => void;
     onSuccess?: (data: LivenessData) => void;
     onFailure?: (data: LivenessData) => void;
+    metadata?: Metadata;
 }
 
+declare type Metadata = Record<string, any>;
+
 declare interface MotionsTask extends TaskBase<"motions"> {
     maxNods?: number;
     maxBlinks?: number;
@@ -57,6 +62,7 @@ declare class WebSDK {
     constructor(props: LivenessWebSdkProps);
     private addResources;
     private removeResources;
+    private validateOptions;
     start(tasks?: Array<Task>): Promise<void>;
     close(): void;
     terminate(): void;