@facesignai/api 1.0.38 → 1.0.39

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 CHANGED
@@ -81,6 +81,8 @@ Set `doesNotRequireReply: true` for nodes at the end of the flow where the avata
81
81
  - `targetNodeId` — the node to navigate to
82
82
  - `condition` — natural language description of the matching criteria
83
83
 
84
+ **Unconditional transition:** When the avatar should say a phrase and move to the next node regardless of the user's response, use a single outcome with an empty `condition` (`""`). This creates an unconditional transition — the avatar delivers the message, and whatever the user replies (or even if they don't), the flow proceeds to `targetNodeId`.
85
+
84
86
  **Direct speech example:**
85
87
  ```typescript
86
88
  {
@@ -181,7 +183,7 @@ Checks whether the user in front of the camera is a real person or a deepfake. T
181
183
 
182
184
  ### ENTER_EMAIL Node
183
185
 
184
- Displays a UI for the user to enter their email address. The collected email can be used later in the flow for two-factor authentication or data collection purposes.
186
+ Displays a UI for the user to enter their email address without any verification or confirmation step. Use this node when you simply need to collect an email from the user as data input. Note: if your goal is to collect AND verify an email via OTP, use TWO_FACTOR_EMAIL instead — it handles email collection internally and does not require a preceding ENTER_EMAIL node.
185
187
 
186
188
  **Outcomes:**
187
189
  - `emailEntered` — user submitted their email
@@ -316,7 +318,7 @@ Performs 1:1 biometric face matching. Captures the user's face and compares it a
316
318
 
317
319
  ### TWO_FACTOR_EMAIL Node
318
320
 
319
- Sends a one-time password (OTP) to the user's email address and verifies the code they enter. If no email was provided via `providedData` or collected by a previous node (e.g., ENTER_EMAIL), the email will be requested automatically during this node.
321
+ Sends a one-time password (OTP) to the user's email address and verifies the code they enter. This node manages its own sub-flow for collecting the email: if no email was provided via `providedData` or found in `publicRecognition`, the node will automatically prompt the user to enter their email. There is no need to add an ENTER_EMAIL node before this one — email collection is handled internally.
320
322
 
321
323
  - `otpLength` — number of digits in the OTP (4–8, default: 6)
322
324
  - `expirySeconds` — how long the OTP is valid (default: 300 / 5 minutes)
@@ -402,7 +404,7 @@ Compares faces from two different sources to verify they belong to the same pers
402
404
 
403
405
  ### TWO_FACTOR_SMS Node
404
406
 
405
- Same as TWO_FACTOR_EMAIL but sends the OTP via SMS. If no phone number was provided via `providedData` or collected by a previous node, the phone number will be requested automatically during this node.
407
+ Same as TWO_FACTOR_EMAIL but sends the OTP via SMS. This node manages its own sub-flow for collecting the phone number: if no phone number was provided via `providedData` or found in `publicRecognition`, the node will automatically prompt the user to enter their phone number. There is no need to add a separate phone collection node before this one.
406
408
 
407
409
  - Same configuration options as TWO_FACTOR_EMAIL
408
410
  - `smsTemplate` — optional custom SMS template (instead of `emailTemplate`)
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@facesignai/api",
3
3
  "package-name": "@facesignai/api",
4
- "version": "1.0.38",
4
+ "version": "1.0.39",
5
5
  "description": "Facesign API wrapper",
6
6
  "repository": {
7
7
  "type": "git",
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@facesignai/api",
3
3
  "package-name": "@facesignai/api",
4
- "version": "1.0.38",
4
+ "version": "1.0.39",
5
5
  "description": "Facesign API wrapper",
6
6
  "repository": {
7
7
  "type": "git",