youverify-liveness-web 0.1.20 → 0.1.22

package/README.md

@@ -64,6 +64,7 @@ try {
 | Option | Type | Required | Description | Default Value | Possible Values |
 | --- | --- | --- | --- | --- | --- |
 | `presentation` | String | No | Controls how UI is displayed | `modal` | `modal`, `page` |
+| `publicKey` | String | Yes | Your Youverify Public Merchant Key | undefined | Valid Youverify Public Key |
 | `sandboxEnvironment` | Boolean | No | Sets whether session should run in sandbox or live mode | `true` | `true`, `false` |
 | `tasks` | Array | No | Sets tasks that need to be performed for liveness to be confirmed | undefined | See [tasks](#tasks) |
 | `user` | Object | No | Sets details of user for which liveness check is being performed | undefined | See nested options below |
@@ -123,6 +124,19 @@ User passes task by performing random motions in random sequences, which include
 | `maxNods` | Number | No | Maximum amount of nods a user is asked to perform | 5 | Any number
 | `maxBlinks` | Number | No | Maximum amount of nods a user is asked to perform | 5 | Any number |
 
+
+### Blink
+
+User passes task by blinking their eyelids based on number of times set.
+
+#### Options
+| Option | Type | Required | Description | Default Value | Possible Values |
+| --- | --- | --- | --- | --- | --- |
+| `id` | String | Yes | Id of task | - | `blink` |
+| `difficulty` | String | No | Sets difficulty of task | `medium` | `easy`, `medium`, `hard` |
+| `timeout` | Number | No | Sets time in milliseconds after which task automatically fails | undefined | Any number in milliseconds |
+| `maxBlinks` | Number | No | Maximum amount of nods a user is asked to perform | 5 | Any number |
+
 ## Callback Data
 
 The `onSuccess` and `onFailure` callbacks (if supplied) are passed the following data:

package/dist/index.d.ts

@@ -1,3 +1,7 @@
+declare interface BlinkTask extends TaskBase<"blink"> {
+    maxBlinks?: number;
+}
+
 declare interface Branding {
     logo?: string;
     color?: string;
@@ -34,7 +38,7 @@ declare interface MotionsTask extends TaskBase<"motions"> {
 
 declare type Presentation = "modal" | "page";
 
-declare type Task = CompleteTheCircleTask | MotionsTask | YesOrNoTask;
+declare type Task = CompleteTheCircleTask | MotionsTask | YesOrNoTask | BlinkTask;
 
 declare interface TaskBase<T extends TaskId> {
     id: T;
@@ -44,7 +48,7 @@ declare interface TaskBase<T extends TaskId> {
 
 declare type TaskDifficulty = "easy" | "medium" | "hard";
 
-declare type TaskId = "complete-the-circle" | "yes-or-no" | "facial-expressions" | "motions";
+declare type TaskId = "complete-the-circle" | "yes-or-no" | "facial-expressions" | "motions" | "blink";
 
 declare interface User {
     firstName: string;