@facesignai/api 1.0.34 → 1.0.36

package/README.md

@@ -27,3 +27,348 @@ const facesignClient = new Client({
 ```
 
 Make a request to any Facesign API endpoint.
+
+## Flow & Nodes
+
+A flow is a directed graph of nodes that defines a session. Sessions can serve different purposes — identity verification, data collection, authorization, analysis, or any combination. Every flow must start with a **START** node and end with one or more **END** nodes. Nodes connect to each other via **outcomes** — each outcome points to the `id` of the next node. All defined outcomes must be connected to other nodes; no outcome can be left unlinked.
+
+### START Node
+
+The entry point of every flow. Each flow must have exactly one START node. It has a single `outcome` that points to the first node in the flow.
+
+```typescript
+{
+  id: "start",
+  type: "start",
+  outcome: "next-node-id"
+}
+```
+
+### END Node
+
+The terminal node of a flow. A flow can have multiple END nodes (e.g., one for success path, one for failure path). It has no outcomes.
+
+```typescript
+{
+  id: "end-success",
+  type: "end"
+}
+```
+
+### CONVERSATION Node
+
+The avatar speaks to the user using the `prompt` text and routes the flow based on the user's response. The session stays on this node until one of the outcome conditions matches the user's response, so a single conversation node can facilitate a multi-turn dialog with the user until the desired information is gathered.
+
+The `prompt` field supports two modes:
+
+1. **Direct speech** — Tell the avatar exactly what to say:
+   `"Say: Hi, how are you doing?"`
+
+2. **Goal-driven behavior** — Describe what the avatar should achieve during the conversation:
+   `"Chat with the user and find out how well they understand medicine."`
+
+When using goal-driven prompts, always include realistic exit conditions in the outcomes, since the dialog could otherwise continue indefinitely. Examples of exit conditions:
+- User didn't respond after 3 attempts
+- The dialog has reached 6 exchanges and no condition was met
+- User refuses to answer
+
+Uses conditional outcomes — each outcome has a `condition` (a natural language description of what the user's response should match) and a `targetNodeId` pointing to the next node.
+
+Set `doesNotRequireReply: true` for nodes at the end of the flow where the avatar delivers a final message and no user response is needed (e.g., "Thank you for the conversation, goodbye!"). Typically used before an END node.
+
+**Outcomes** use `FSConditionalOutcome`:
+- `id` — unique identifier for the outcome
+- `targetNodeId` — the node to navigate to
+- `condition` — natural language description of the matching criteria
+
+**Direct speech example:**
+```typescript
+{
+  id: "greeting",
+  type: "conversation",
+  prompt: "Say: Hello! What would you like to do today?",
+  outcomes: [
+    { id: "verify", targetNodeId: "liveness-node", condition: "User wants to verify their identity" },
+    { id: "info", targetNodeId: "info-node", condition: "User wants more information" }
+  ]
+}
+```
+
+**Goal-driven example:**
+```typescript
+{
+  id: "medical-assessment",
+  type: "conversation",
+  prompt: "Chat with the user and assess their level of medical knowledge.",
+  outcomes: [
+    { id: "high", targetNodeId: "advanced-path", condition: "User demonstrates strong medical knowledge" },
+    { id: "low", targetNodeId: "basic-path", condition: "User has limited medical knowledge" },
+    { id: "no-response", targetNodeId: "end-fail", condition: "User didn't respond after 3 attempts" },
+    { id: "timeout", targetNodeId: "end-fail", condition: "Dialog reached 6 exchanges with no condition met" },
+    { id: "refused", targetNodeId: "end-fail", condition: "User refuses to answer" }
+  ]
+}
+```
+
+**End-of-flow example:**
+```typescript
+{
+  id: "goodbye",
+  type: "conversation",
+  prompt: "Thank you for the conversation, goodbye!",
+  doesNotRequireReply: true,
+  outcomes: [
+    { id: "done", targetNodeId: "end", condition: "" }
+  ]
+}
+```
+
+### PERMISSIONS Node
+
+Requests camera and/or microphone permissions from the user before proceeding. Use this node when you need to display a custom prompt explaining why permissions are needed, or when you want to handle the denied case with a specific flow path.
+
+If the flow does not contain any PERMISSIONS node, permissions will be requested automatically.
+
+- `permissions.camera` — request camera access
+- `permissions.microphone` — request microphone access
+- `prompt` — optional message the avatar will say (uses direct speech mode, e.g., `"Say: Could you please enable your microphone so I can hear you."`). If the site already has permanent permissions granted, the avatar will not say this phrase and the flow will continue directly via the `permissionsGranted` outcome.
+
+**Outcomes:**
+- `permissionsGranted` — user granted the requested permissions (or they were already granted)
+- `permissionsDenied` — user denied the permissions
+
+```typescript
+{
+  id: "request-permissions",
+  type: "permissions",
+  prompt: "Say: Could you please enable your camera and microphone so we can proceed.",
+  permissions: {
+    camera: true,
+    microphone: true
+  },
+  outcomes: {
+    permissionsGranted: "next-node-id",
+    permissionsDenied: "end-denied"
+  }
+}
+```
+
+### LIVENESS_DETECTION Node
+
+Checks whether the user in front of the camera is a real person or a deepfake. The node analyzes the video feed to perform liveness detection.
+
+**Prerequisites:** The user must have camera access granted before this node. Additionally, liveness detection requires several seconds of video recording for analysis. Do not place this node immediately after a PERMISSIONS node — instead, add a CONVERSATION node in between to give the system time to accumulate video data for analysis.
+
+**Recommended flow order:**
+`PERMISSIONS → CONVERSATION → LIVENESS_DETECTION`
+
+**Outcomes:**
+- `livenessDetected` — the user is a real person
+- `deepfakeDetected` — a deepfake or spoofing attempt was detected
+- `noFace` — no face was detected in the camera feed
+
+```typescript
+{
+  id: "liveness-check",
+  type: "liveness_detection",
+  outcomes: {
+    livenessDetected: "next-node-id",
+    deepfakeDetected: "end-fail",
+    noFace: "end-fail"
+  }
+}
+```
+
+### ENTER_EMAIL Node
+
+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.
+
+**Outcomes:**
+- `emailEntered` — user submitted their email
+- `canceled` — user canceled the email entry
+
+```typescript
+{
+  id: "collect-email",
+  type: "enter_email",
+  outcomes: {
+    emailEntered: "next-node-id",
+    canceled: "end-canceled"
+  }
+}
+```
+
+### DATA_VALIDATION Node
+
+Validates data collected during the session and routes the flow based on the result. Uses a `validation` object to specify which field to check, what action to perform, and an optional expected value.
+
+- `validation.field` — the data field to validate
+- `validation.action` — the validation action to perform
+- `validation.value` — optional expected value for comparison
+
+Uses conditional outcomes (same as CONVERSATION node) to branch the flow based on the validation result.
+
+```typescript
+{
+  id: "check-email-domain",
+  type: "data_validation",
+  validation: {
+    field: "email",
+    action: "contains",
+    value: "@company.com"
+  },
+  outcomes: [
+    { id: "valid", targetNodeId: "next-node-id", condition: "Validation passed" },
+    { id: "invalid", targetNodeId: "end-fail", condition: "Validation failed" }
+  ]
+}
+```
+
+### DOCUMENT_SCAN Node
+
+Opens a document scanning UI powered by Microblink. The user can scan identity documents using their camera. Extracted data (name, date of birth, document number, etc.) becomes available in the session report.
+
+- `scanningMode` — determines how to scan the document:
+  - `"single"` — scan only one side of the document
+  - `"automatic"` — automatically determine how many sides need to be scanned
+- `allowedDocumentTypes` — array of document types the user can scan (e.g., `"passport"`, `"id"`, `"dl"`, `"residence-permit"`, `"visa"`, etc.)
+- `showTorchButton` — show flashlight toggle (default: true)
+- `showCameraSwitch` — show front/back camera toggle (default: true)
+- `showMirrorCameraButton` — show mirror camera button (default: true)
+
+**Outcomes:**
+- `scanSuccess` — document was scanned successfully
+- `userCancelled` — user canceled the scan
+- `scanTimeout` — scan timed out
+
+```typescript
+{
+  id: "scan-id",
+  type: "document_scan",
+  scanningMode: "automatic",
+  allowedDocumentTypes: ["passport", "id", "dl"],
+  outcomes: {
+    scanSuccess: "next-node-id",
+    userCancelled: "end-canceled",
+    scanTimeout: "end-fail"
+  }
+}
+```
+
+### RECOGNITION Node
+
+Performs biometric face recognition to identify the user. Compares the user's face against previously registered faces to determine if they are a known or new user.
+
+**Prerequisites:** Requires camera access. Like LIVENESS_DETECTION, needs several seconds of video for analysis — do not place immediately after a PERMISSIONS node. Add a CONVERSATION node in between to accumulate video data.
+
+**Outcomes:**
+- `recognized` — the user was matched to a known face
+- `newUser` — the user's face was not found in the database (new user)
+- `noFace` — no face was detected in the camera feed
+
+```typescript
+{
+  id: "recognize-user",
+  type: "recognition",
+  outcomes: {
+    recognized: "welcome-back",
+    newUser: "registration-flow",
+    noFace: "end-fail"
+  }
+}
+```
+
+### FACE_SCAN Node
+
+Performs 1:1 biometric face matching. Captures the user's face and compares it against a reference image to verify their identity.
+
+**Prerequisites:** Requires camera access. Like LIVENESS_DETECTION, needs several seconds of video — do not place immediately after a PERMISSIONS node.
+
+- `captureInstructions` — optional text instructions shown to the user during capture
+- `requireLivenessChallenge` — require an active liveness challenge during capture
+- `requireAILivenessCheck` — require AI-based liveness verification
+- `referenceImageKey` — key identifying the reference image to compare against
+- `similarityThreshold` — minimum similarity score (0–1) required for a match
+- `enableSound` — enable audio feedback (default: true)
+- `enableHaptics` — enable haptic feedback (default: true)
+
+**Outcomes:**
+- `passed` — face matched the reference image
+- `notPassed` — face did not match
+- `cancelled` — user canceled the scan
+- `error` — an error occurred during scanning
+
+```typescript
+{
+  id: "face-verify",
+  type: "face_scan",
+  referenceImageKey: "document_photo",
+  similarityThreshold: 0.8,
+  requireAILivenessCheck: true,
+  outcomes: {
+    passed: "next-node-id",
+    notPassed: "end-fail",
+    cancelled: "end-canceled",
+    error: "end-error"
+  }
+}
+```
+
+### TWO_FACTOR_EMAIL Node
+
+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.
+
+- `otpLength` — number of digits in the OTP (4–8, default: 6)
+- `expirySeconds` — how long the OTP is valid (default: 300 / 5 minutes)
+- `maxAttempts` — maximum verification attempts (default: 3)
+- `resendAfterSeconds` — minimum delay before "Resend" button is enabled
+- `showUI` — show on-screen toast notification (default: true)
+- `emailTemplate` — optional custom email template
+
+**Outcomes:**
+- `verified` — user entered the correct OTP
+- `delivery_failed` — OTP could not be delivered
+- `failed_unverified` — user exhausted all attempts without verifying
+- `cancelled` — user canceled the verification
+- `error` — an error occurred
+
+```typescript
+{
+  id: "email-2fa",
+  type: "two_factor_email",
+  otpLength: 6,
+  expirySeconds: 300,
+  maxAttempts: 3,
+  outcomes: {
+    verified: "next-node-id",
+    delivery_failed: "end-fail",
+    failed_unverified: "end-fail",
+    cancelled: "end-canceled",
+    error: "end-error"
+  }
+}
+```
+
+### TWO_FACTOR_SMS Node
+
+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.
+
+- Same configuration options as TWO_FACTOR_EMAIL
+- `smsTemplate` — optional custom SMS template (instead of `emailTemplate`)
+
+```typescript
+{
+  id: "sms-2fa",
+  type: "two_factor_sms",
+  otpLength: 6,
+  expirySeconds: 300,
+  maxAttempts: 3,
+  outcomes: {
+    verified: "next-node-id",
+    delivery_failed: "end-fail",
+    failed_unverified: "end-fail",
+    cancelled: "end-canceled",
+    error: "end-error"
+  }
+}
+```

package/build/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@facesignai/api",
     "package-name": "@facesignai/api",
-    "version": "1.0.34",
+    "version": "1.0.36",
     "description": "Facesign API wrapper",
     "repository": {
         "type": "git",

package/build/src/types/nodeReports.d.ts

@@ -1,4 +1,4 @@
-import { FSNodeType, FSNodeId, FSLivenessDetectionOutcome, FSEnterEmailOutcome, FSDocumentScanOutcome, FSRecognitionOutcome, FSFaceScanOutcome, FSTwoFactorOutcome, FSPermissionsOutcome } from "./nodes";
+import { FSNodeType, FSNodeId, FSLivenessDetectionOutcome, FSEnterEmailOutcome, FSDocumentScanOutcome, FSRecognitionOutcome, FSFaceScanOutcome, FSTwoFactorOutcome, FSPermissionsOutcome, FSFaceCompareOutcome } from "./nodes";
 import { DocumentScanReport } from "./docScanning";
 export type NodeReportBase = {
     type: FSNodeType;
@@ -80,5 +80,17 @@ export type PermissionsNodeReport = NodeReportBase & {
     type: FSNodeType.PERMISSIONS;
     outcome: FSPermissionsOutcome;
 };
-export type NodeReport = ConversationNodeReport | LivenessDetectionNodeReport | EnterEmailNodeReport | DataValidationNodeReport | DocumentScanNodeReport | RecognitionNodeReport | TwoFactorEmailNodeReport | TwoFactorSMSNodeReport | FaceScanNodeReport | PermissionsNodeReport;
+export type FaceCompareReport = {
+    isMatch: boolean;
+    similarity?: number;
+    sourceAImageFound: boolean;
+    sourceBImageFound: boolean;
+    error?: string;
+};
+export type FaceCompareNodeReport = NodeReportBase & {
+    type: FSNodeType.FACE_COMPARE;
+    outcome: FSFaceCompareOutcome;
+    report?: FaceCompareReport;
+};
+export type NodeReport = ConversationNodeReport | LivenessDetectionNodeReport | EnterEmailNodeReport | DataValidationNodeReport | DocumentScanNodeReport | RecognitionNodeReport | TwoFactorEmailNodeReport | TwoFactorSMSNodeReport | FaceScanNodeReport | PermissionsNodeReport | FaceCompareNodeReport;
 //# sourceMappingURL=nodeReports.d.ts.map

package/build/src/types/nodeReports.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"nodeReports.d.ts","sourceRoot":"","sources":["../../../src/types/nodeReports.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,QAAQ,EACR,0BAA0B,EAC1B,mBAAmB,EACnB,qBAAqB,EACrB,oBAAoB,EACpB,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,SAAS,CAAA;AAEhB,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AAElD,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,UAAU,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,eAAe,GACvB;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,KAAK,CAAA;CAAE,GACtC;IAAE,WAAW,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,KAAK,CAAA;CAAE,GACtC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,CAAA;AAE1C,MAAM,MAAM,wBAAwB,GAAG,cAAc,GAAG;IACtD,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAA;IACjC,OAAO,EAAE,kBAAkB,CAAA;IAC3B,MAAM,CAAC,EAAE,eAAe,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG,cAAc,GAAG;IACpD,IAAI,EAAE,UAAU,CAAC,cAAc,CAAA;IAC/B,OAAO,EAAE,kBAAkB,CAAA;IAC3B,MAAM,CAAC,EAAE,eAAe,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,oBAAoB,EAAE,OAAO,CAAA;IAC7B,oBAAoB,EAAE,OAAO,CAAA;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,uBAAuB,CAAC,EAAE,OAAO,CAAA;IACjC,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B,kBAAkB,CAAC,EAAE,kBAAkB,CAAA;CACxC,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG,cAAc,GAAG;IAChD,IAAI,EAAE,UAAU,CAAC,SAAS,CAAA;IAC1B,OAAO,EAAE,iBAAiB,CAAA;IAC1B,MAAM,CAAC,EAAE,cAAc,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG;IACvD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG,cAAc,GAAG;IACnD,IAAI,EAAE,UAAU,CAAC,WAAW,CAAA;IAC5B,OAAO,EAAE,oBAAoB,CAAA;IAC7B,MAAM,CAAC,EAAE,iBAAiB,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG,cAAc,GAAG;IACpD,IAAI,EAAE,UAAU,CAAC,aAAa,CAAA;IAC9B,OAAO,EAAE,qBAAqB,CAAA;IAC9B,MAAM,CAAC,EAAE,kBAAkB,CAAA;CAC5B,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG,cAAc,GAAG;IACtD,IAAI,EAAE,UAAU,CAAC,eAAe,CAAA;IAChC,OAAO,EAAE,QAAQ,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,cAAc,GAAG;IAClD,IAAI,EAAE,UAAU,CAAC,WAAW,CAAA;IAC5B,OAAO,EAAE,mBAAmB,CAAA;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,2BAA2B,GAAG,cAAc,GAAG;IACzD,IAAI,EAAE,UAAU,CAAC,kBAAkB,CAAA;IACnC,OAAO,EAAE,0BAA0B,CAAA;CACpC,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG,cAAc,GAAG;IACpD,IAAI,EAAE,UAAU,CAAC,YAAY,CAAA;IAC7B,OAAO,EAAE,QAAQ,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG,cAAc,GAAG;IACnD,IAAI,EAAE,UAAU,CAAC,WAAW,CAAA;IAC5B,OAAO,EAAE,oBAAoB,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,UAAU,GAClB,sBAAsB,GACtB,2BAA2B,GAC3B,oBAAoB,GACpB,wBAAwB,GACxB,sBAAsB,GACtB,qBAAqB,GACrB,wBAAwB,GACxB,sBAAsB,GACtB,kBAAkB,GAClB,qBAAqB,CAAA"}
+{"version":3,"file":"nodeReports.d.ts","sourceRoot":"","sources":["../../../src/types/nodeReports.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,QAAQ,EACR,0BAA0B,EAC1B,mBAAmB,EACnB,qBAAqB,EACrB,oBAAoB,EACpB,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,oBAAoB,EACrB,MAAM,SAAS,CAAA;AAEhB,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AAElD,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,UAAU,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,eAAe,GACvB;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,KAAK,CAAA;CAAE,GACtC;IAAE,WAAW,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,KAAK,CAAA;CAAE,GACtC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,CAAA;AAE1C,MAAM,MAAM,wBAAwB,GAAG,cAAc,GAAG;IACtD,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAA;IACjC,OAAO,EAAE,kBAAkB,CAAA;IAC3B,MAAM,CAAC,EAAE,eAAe,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG,cAAc,GAAG;IACpD,IAAI,EAAE,UAAU,CAAC,cAAc,CAAA;IAC/B,OAAO,EAAE,kBAAkB,CAAA;IAC3B,MAAM,CAAC,EAAE,eAAe,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,oBAAoB,EAAE,OAAO,CAAA;IAC7B,oBAAoB,EAAE,OAAO,CAAA;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,uBAAuB,CAAC,EAAE,OAAO,CAAA;IACjC,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B,kBAAkB,CAAC,EAAE,kBAAkB,CAAA;CACxC,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG,cAAc,GAAG;IAChD,IAAI,EAAE,UAAU,CAAC,SAAS,CAAA;IAC1B,OAAO,EAAE,iBAAiB,CAAA;IAC1B,MAAM,CAAC,EAAE,cAAc,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG;IACvD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG,cAAc,GAAG;IACnD,IAAI,EAAE,UAAU,CAAC,WAAW,CAAA;IAC5B,OAAO,EAAE,oBAAoB,CAAA;IAC7B,MAAM,CAAC,EAAE,iBAAiB,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG,cAAc,GAAG;IACpD,IAAI,EAAE,UAAU,CAAC,aAAa,CAAA;IAC9B,OAAO,EAAE,qBAAqB,CAAA;IAC9B,MAAM,CAAC,EAAE,kBAAkB,CAAA;CAC5B,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG,cAAc,GAAG;IACtD,IAAI,EAAE,UAAU,CAAC,eAAe,CAAA;IAChC,OAAO,EAAE,QAAQ,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,cAAc,GAAG;IAClD,IAAI,EAAE,UAAU,CAAC,WAAW,CAAA;IAC5B,OAAO,EAAE,mBAAmB,CAAA;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,2BAA2B,GAAG,cAAc,GAAG;IACzD,IAAI,EAAE,UAAU,CAAC,kBAAkB,CAAA;IACnC,OAAO,EAAE,0BAA0B,CAAA;CACpC,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG,cAAc,GAAG;IACpD,IAAI,EAAE,UAAU,CAAC,YAAY,CAAA;IAC7B,OAAO,EAAE,QAAQ,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG,cAAc,GAAG;IACnD,IAAI,EAAE,UAAU,CAAC,WAAW,CAAA;IAC5B,OAAO,EAAE,oBAAoB,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,iBAAiB,EAAE,OAAO,CAAA;IAC1B,iBAAiB,EAAE,OAAO,CAAA;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG,cAAc,GAAG;IACnD,IAAI,EAAE,UAAU,CAAC,YAAY,CAAA;IAC7B,OAAO,EAAE,oBAAoB,CAAA;IAC7B,MAAM,CAAC,EAAE,iBAAiB,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,UAAU,GAClB,sBAAsB,GACtB,2BAA2B,GAC3B,oBAAoB,GACpB,wBAAwB,GACxB,sBAAsB,GACtB,qBAAqB,GACrB,wBAAwB,GACxB,sBAAsB,GACtB,kBAAkB,GAClB,qBAAqB,GACrB,qBAAqB,CAAA"}

package/build/src/types/nodes.d.ts

@@ -12,13 +12,18 @@ export declare enum FSNodeType {
     FACE_SCAN = "face_scan",
     TWO_FACTOR_EMAIL = "two_factor_email",
     TWO_FACTOR_SMS = "two_factor_sms",
-    PERMISSIONS = "permissions"
+    PERMISSIONS = "permissions",
+    FACE_COMPARE = "face_compare"
 }
 export interface FSNodeBase {
     id: string;
     type: FSNodeType;
 }
 export type FSNodeId = string;
+/**
+ * The entry point of every flow. Each flow must have exactly one START node.
+ * It has a single `outcome` that points to the first node in the flow.
+ */
 export interface FSStartNode extends FSNodeBase {
     type: FSNodeType.START;
     outcome: FSNodeId;
@@ -28,6 +33,19 @@ export interface FSConditionalOutcome {
     targetNodeId: string;
     condition: string;
 }
+/**
+ * The avatar speaks to the user using the `prompt` text and routes the flow based on the user's response.
+ * The session stays on this node until one of the outcome conditions matches, enabling multi-turn dialog.
+ *
+ * The `prompt` supports two modes:
+ * - Direct speech: "Say: Hi, how are you doing?"
+ * - Goal-driven behavior: "Chat with the user and assess their medical knowledge."
+ *
+ * When using goal-driven prompts, always include realistic exit conditions in the outcomes
+ * (e.g., user didn't respond after 3 attempts, dialog reached N exchanges, user refuses to answer).
+ *
+ * Set `doesNotRequireReply: true` for final messages before an END node where no user response is needed.
+ */
 export interface FSConversationNode extends FSNodeBase {
     type: FSNodeType.CONVERSATION;
     prompt: string;
@@ -39,6 +57,15 @@ export declare enum FSLivenessDetectionOutcome {
     DEEPFAKE_DETECTED = "deepfakeDetected",
     NO_FACE = "noFace"
 }
+/**
+ * Checks whether the user is a real person or a deepfake by analyzing the video feed.
+ *
+ * Requires camera access. Needs several seconds of video for analysis —
+ * do not place immediately after a PERMISSIONS node. Add a CONVERSATION node
+ * in between to accumulate video data.
+ *
+ * Recommended flow order: PERMISSIONS → CONVERSATION → LIVENESS_DETECTION
+ */
 export interface FSLivenessDetectionNode extends FSNodeBase {
     type: FSNodeType.LIVENESS_DETECTION;
     outcomes: Record<FSLivenessDetectionOutcome, FSNodeId>;
@@ -47,10 +74,19 @@ export declare enum FSEnterEmailOutcome {
     EMAIL_ENTERED = "emailEntered",
     CANCELED = "canceled"
 }
+/**
+ * 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.
+ */
 export interface FSEnterEmailNode extends FSNodeBase {
     type: FSNodeType.ENTER_EMAIL;
     outcomes: Record<FSEnterEmailOutcome, FSNodeId>;
 }
+/**
+ * Validates data collected during the session and routes the flow based on the result.
+ * Uses a `validation` object to specify which field to check, what action to perform,
+ * and an optional expected value. Uses conditional outcomes to branch the flow.
+ */
 export interface FSDataValidationNode extends FSNodeBase {
     type: FSNodeType.DATA_VALIDATION;
     outcomes: NonEmptyArray<FSConditionalOutcome>;
@@ -65,6 +101,13 @@ export declare enum FSRecognitionOutcome {
     NEW_USER = "newUser",
     NO_FACE = "noFace"
 }
+/**
+ * Performs biometric face recognition to identify the user.
+ * Compares the user's face against previously registered faces.
+ *
+ * Requires camera access. Like LIVENESS_DETECTION, needs several seconds of video —
+ * do not place immediately after a PERMISSIONS node. Add a CONVERSATION node in between.
+ */
 export interface FSRecognitionNode extends FSNodeBase {
     type: FSNodeType.RECOGNITION;
     outcomes: Record<FSRecognitionOutcome, FSNodeId>;
@@ -76,6 +119,14 @@ export declare enum FSDocumentScanOutcome {
     TIMEOUT = "scanTimeout"
 }
 export type FSDocumentScanMode = ScanningMode;
+/**
+ * Opens a document scanning UI powered by Microblink. The user can scan identity documents
+ * using their camera. Extracted data becomes available in the session report.
+ *
+ * `scanningMode`:
+ * - "single" — scan only one side of the document
+ * - "automatic" — automatically determine how many sides need to be scanned
+ */
 export interface FSDocumentScanNode extends FSNodeBase {
     type: FSNodeType.DOCUMENT_SCAN;
     scanningMode: FSDocumentScanMode;
@@ -85,6 +136,10 @@ export interface FSDocumentScanNode extends FSNodeBase {
     showCameraSwitch?: boolean;
     showMirrorCameraButton?: boolean;
 }
+/**
+ * The terminal node of a flow. A flow can have multiple END nodes
+ * (e.g., one for success path, one for failure path). It has no outcomes.
+ */
 export interface FSEndNode extends FSNodeBase {
     type: FSNodeType.END;
 }
@@ -94,6 +149,13 @@ export declare enum FSFaceScanOutcome {
     CANCELLED = "cancelled",
     ERROR = "error"
 }
+/**
+ * Performs 1:1 biometric face matching. Captures the user's face and compares it
+ * against a reference image to verify their identity.
+ *
+ * Requires camera access. Like LIVENESS_DETECTION, needs several seconds of video —
+ * do not place immediately after a PERMISSIONS node.
+ */
 export interface FSFaceScanNode extends FSNodeBase {
     type: FSNodeType.FACE_SCAN;
     outcomes: Record<FSFaceScanOutcome, FSNodeId>;
@@ -116,6 +178,12 @@ export declare enum FSTwoFactorOutcome {
     CANCELLED = "cancelled",
     ERROR = "error"
 }
+/**
+ * Base interface for two-factor authentication nodes (email and SMS).
+ * Sends a one-time password (OTP) and verifies the code the user enters.
+ * If the required contact info (email or phone) was not provided via `providedData`
+ * or collected by a previous node, it will be requested automatically during this node.
+ */
 export interface FSTwoFactorNode extends FSNodeBase {
     outcomes: Record<FSTwoFactorOutcome, FSNodeId>;
     otpLength?: number;
@@ -132,6 +200,15 @@ export interface FSTwoFactorNodeSMS extends FSTwoFactorNode {
     type: FSNodeType.TWO_FACTOR_SMS;
     smsTemplate?: string;
 }
+/**
+ * Requests camera and/or microphone permissions from the user.
+ * Use when you need a custom prompt or want to handle the denied case with a specific flow path.
+ * If the flow has no PERMISSIONS node, permissions are requested automatically.
+ *
+ * The `prompt` uses direct speech mode (e.g., "Say: Could you please enable your microphone so I can hear you.").
+ * If the site already has permanent permissions granted, the avatar will not say this phrase
+ * and the flow continues directly via the `permissionsGranted` outcome.
+ */
 export interface FSPermissionsNode extends FSNodeBase {
     prompt?: string;
     type: FSNodeType.PERMISSIONS;
@@ -145,5 +222,45 @@ export declare enum FSPermissionsOutcome {
     PERMISSIONS_GRANTED = "permissionsGranted",
     PERMISSIONS_DENIED = "permissionsDenied"
 }
-export type FSNode = FSStartNode | FSConversationNode | FSEndNode | FSEnterEmailNode | FSLivenessDetectionNode | FSDataValidationNode | FSDocumentScanNode | FSRecognitionNode | FSFaceScanNode | FSTwoFactorNodeEmail | FSTwoFactorNodeSMS;
+export declare enum FSFaceCompareSource {
+    SESSION_VIDEO = "sessionVideo",
+    FACE_SCAN = "faceScan",
+    PROVIDED_DATA = "providedData",
+    DOCUMENT_PHOTO = "documentPhoto"
+}
+export type FSFaceCompareSourceConfig = {
+    source: FSFaceCompareSource.SESSION_VIDEO;
+} | {
+    source: FSFaceCompareSource.FACE_SCAN;
+} | {
+    source: FSFaceCompareSource.PROVIDED_DATA;
+    providedDataKey: string;
+} | {
+    source: FSFaceCompareSource.DOCUMENT_PHOTO;
+};
+export declare enum FSFaceCompareOutcome {
+    MATCH = "match",
+    NO_MATCH = "noMatch",
+    IMAGE_UNAVAILABLE = "imageUnavailable"
+}
+/**
+ * Compares faces from two different sources to verify they belong to the same person.
+ *
+ * Available sources:
+ * - `sessionVideo` — frame captured from the live video feed during the session
+ * - `faceScan` — higher-quality photo from a FACE_SCAN node (oval capture)
+ * - `providedData` — image URL from a `providedData` field (specify the key via `providedDataKey`)
+ * - `documentPhoto` — photo extracted from a scanned document (DOCUMENT_SCAN node)
+ *
+ * For `faceScan` and `documentPhoto`, the photo is taken from the most recent
+ * completed node of that type in the session.
+ */
+export interface FSFaceCompareNode extends FSNodeBase {
+    type: FSNodeType.FACE_COMPARE;
+    sourceA: FSFaceCompareSourceConfig;
+    sourceB: FSFaceCompareSourceConfig;
+    outcomes: Record<FSFaceCompareOutcome, FSNodeId>;
+    similarityThreshold?: number;
+}
+export type FSNode = FSStartNode | FSConversationNode | FSEndNode | FSEnterEmailNode | FSLivenessDetectionNode | FSDataValidationNode | FSDocumentScanNode | FSRecognitionNode | FSFaceScanNode | FSTwoFactorNodeEmail | FSTwoFactorNodeSMS | FSPermissionsNode | FSFaceCompareNode;
 //# sourceMappingURL=nodes.d.ts.map

package/build/src/types/nodes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"nodes.d.ts","sourceRoot":"","sources":["../../../src/types/nodes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAE1D,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;AAE/C,oBAAY,UAAU;IACpB,KAAK,UAAU;IACf,GAAG,QAAQ;IACX,YAAY,iBAAiB;IAC7B,kBAAkB,uBAAuB;IACzC,WAAW,gBAAgB;IAC3B,eAAe,oBAAoB;IACnC,aAAa,kBAAkB;IAC/B,WAAW,gBAAgB;IAC3B,SAAS,cAAc;IACvB,gBAAgB,qBAAqB;IACrC,cAAc,mBAAmB;IACjC,WAAW,gBAAgB;CAC5B;AAED,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,UAAU,CAAA;CACjB;AAED,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAA;AAC7B,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,IAAI,EAAE,UAAU,CAAC,KAAK,CAAA;IACtB,OAAO,EAAE,QAAQ,CAAA;CAClB;AAED,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAA;IACV,YAAY,EAAE,MAAM,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,IAAI,EAAE,UAAU,CAAC,YAAY,CAAA;IAC7B,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAA;IAC7C,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAC9B;AAED,oBAAY,0BAA0B;IACpC,iBAAiB,qBAAqB;IACtC,iBAAiB,qBAAqB;IACtC,OAAO,WAAW;CACnB;AAED,MAAM,WAAW,uBAAwB,SAAQ,UAAU;IACzD,IAAI,EAAE,UAAU,CAAC,kBAAkB,CAAA;IACnC,QAAQ,EAAE,MAAM,CAAC,0BAA0B,EAAE,QAAQ,CAAC,CAAA;CACvD;AAED,oBAAY,mBAAmB;IAC7B,aAAa,iBAAiB;IAC9B,QAAQ,aAAa;CACtB;AACD,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD,IAAI,EAAE,UAAU,CAAC,WAAW,CAAA;IAC5B,QAAQ,EAAE,MAAM,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAAA;CAChD;AAED,MAAM,WAAW,oBAAqB,SAAQ,UAAU;IACtD,IAAI,EAAE,UAAU,CAAC,eAAe,CAAA;IAChC,QAAQ,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAA;IAC7C,UAAU,EAAE;QACV,KAAK,EAAE,MAAM,CAAA;QACb,MAAM,EAAE,MAAM,CAAA;QACd,KAAK,CAAC,EAAE,MAAM,CAAA;KACf,CAAA;CACF;AAED,oBAAY,oBAAoB;IAC9B,UAAU,eAAe;IACzB,QAAQ,YAAY;IACpB,OAAO,WAAW;CACnB;AAED,MAAM,WAAW,iBAAkB,SAAQ,UAAU;IACnD,IAAI,EAAE,UAAU,CAAC,WAAW,CAAA;IAC5B,QAAQ,EAAE,MAAM,CAAC,oBAAoB,EAAE,QAAQ,CAAC,CAAA;CACjD;AAED,MAAM,MAAM,cAAc,GAAG,YAAY,CAAA;AAEzC,oBAAY,qBAAqB;IAC/B,YAAY,gBAAgB;IAE5B,cAAc,kBAAkB;IAChC,OAAO,gBAAgB;CAGxB;AAED,MAAM,MAAM,kBAAkB,GAAG,YAAY,CAAA;AAE7C,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,IAAI,EAAE,UAAU,CAAC,aAAa,CAAA;IAC9B,YAAY,EAAE,kBAAkB,CAAA;IAChC,oBAAoB,EAAE,cAAc,EAAE,CAAA;IAEtC,QAAQ,EAAE,MAAM,CAAC,qBAAqB,EAAE,QAAQ,CAAC,CAAA;IACjD,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,sBAAsB,CAAC,EAAE,OAAO,CAAA;CACjC;AAED,MAAM,WAAW,SAAU,SAAQ,UAAU;IAC3C,IAAI,EAAE,UAAU,CAAC,GAAG,CAAA;CACrB;AAED,oBAAY,iBAAiB;IAC3B,MAAM,WAAW;IACjB,UAAU,cAAc;IACxB,SAAS,cAAc;IACvB,KAAK,UAAU;CAChB;AAED,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD,IAAI,EAAE,UAAU,CAAC,SAAS,CAAA;IAC1B,QAAQ,EAAE,MAAM,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAA;IAG7C,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,wBAAwB,CAAC,EAAE,OAAO,CAAA;IAClC,sBAAsB,CAAC,EAAE,OAAO,CAAA;IAChC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAG5B,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,aAAa,CAAC,EAAE,OAAO,CAAA;CACxB;AAED,oBAAY,kBAAkB;IAC5B,KAAK,UAAU;IACf,GAAG,QAAQ;CACZ;AAED,oBAAY,kBAAkB;IAC5B,QAAQ,aAAa;IACrB,eAAe,oBAAoB;IACnC,iBAAiB,sBAAsB;IACvC,SAAS,cAAc;IACvB,KAAK,UAAU;CAChB;AAED,MAAM,WAAW,eAAgB,SAAQ,UAAU;IACjD,QAAQ,EAAE,MAAM,CAAC,kBAAkB,EAAE,QAAQ,CAAC,CAAA;IAG9C,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAG3B,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB;AAED,MAAM,WAAW,oBAAqB,SAAQ,eAAe;IAC3D,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAA;IACjC,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,kBAAmB,SAAQ,eAAe;IACzD,IAAI,EAAE,UAAU,CAAC,cAAc,CAAA;IAC/B,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,iBAAkB,SAAQ,UAAU;IACnD,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,UAAU,CAAC,WAAW,CAAA;IAC5B,WAAW,EAAE;QACX,MAAM,CAAC,EAAE,OAAO,CAAA;QAChB,UAAU,CAAC,EAAE,OAAO,CAAA;KACrB,CAAA;IACD,QAAQ,EAAE,MAAM,CAAC,oBAAoB,EAAE,QAAQ,CAAC,CAAA;CACjD;AAED,oBAAY,oBAAoB;IAC9B,mBAAmB,uBAAuB;IAC1C,kBAAkB,sBAAsB;CACzC;AAED,MAAM,MAAM,MAAM,GACd,WAAW,GACX,kBAAkB,GAClB,SAAS,GACT,gBAAgB,GAChB,uBAAuB,GACvB,oBAAoB,GACpB,kBAAkB,GAClB,iBAAiB,GACjB,cAAc,GACd,oBAAoB,GACpB,kBAAkB,CAAA"}
+{"version":3,"file":"nodes.d.ts","sourceRoot":"","sources":["../../../src/types/nodes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAE1D,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;AAE/C,oBAAY,UAAU;IACpB,KAAK,UAAU;IACf,GAAG,QAAQ;IACX,YAAY,iBAAiB;IAC7B,kBAAkB,uBAAuB;IACzC,WAAW,gBAAgB;IAC3B,eAAe,oBAAoB;IACnC,aAAa,kBAAkB;IAC/B,WAAW,gBAAgB;IAC3B,SAAS,cAAc;IACvB,gBAAgB,qBAAqB;IACrC,cAAc,mBAAmB;IACjC,WAAW,gBAAgB;IAC3B,YAAY,iBAAiB;CAC9B;AAED,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,UAAU,CAAA;CACjB;AAED,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAA;AAC7B;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,IAAI,EAAE,UAAU,CAAC,KAAK,CAAA;IACtB,OAAO,EAAE,QAAQ,CAAA;CAClB;AAED,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAA;IACV,YAAY,EAAE,MAAM,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,IAAI,EAAE,UAAU,CAAC,YAAY,CAAA;IAC7B,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAA;IAC7C,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAC9B;AAED,oBAAY,0BAA0B;IACpC,iBAAiB,qBAAqB;IACtC,iBAAiB,qBAAqB;IACtC,OAAO,WAAW;CACnB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,uBAAwB,SAAQ,UAAU;IACzD,IAAI,EAAE,UAAU,CAAC,kBAAkB,CAAA;IACnC,QAAQ,EAAE,MAAM,CAAC,0BAA0B,EAAE,QAAQ,CAAC,CAAA;CACvD;AAED,oBAAY,mBAAmB;IAC7B,aAAa,iBAAiB;IAC9B,QAAQ,aAAa;CACtB;AACD;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD,IAAI,EAAE,UAAU,CAAC,WAAW,CAAA;IAC5B,QAAQ,EAAE,MAAM,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAAA;CAChD;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAqB,SAAQ,UAAU;IACtD,IAAI,EAAE,UAAU,CAAC,eAAe,CAAA;IAChC,QAAQ,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAA;IAC7C,UAAU,EAAE;QACV,KAAK,EAAE,MAAM,CAAA;QACb,MAAM,EAAE,MAAM,CAAA;QACd,KAAK,CAAC,EAAE,MAAM,CAAA;KACf,CAAA;CACF;AAED,oBAAY,oBAAoB;IAC9B,UAAU,eAAe;IACzB,QAAQ,YAAY;IACpB,OAAO,WAAW;CACnB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,iBAAkB,SAAQ,UAAU;IACnD,IAAI,EAAE,UAAU,CAAC,WAAW,CAAA;IAC5B,QAAQ,EAAE,MAAM,CAAC,oBAAoB,EAAE,QAAQ,CAAC,CAAA;CACjD;AAED,MAAM,MAAM,cAAc,GAAG,YAAY,CAAA;AAEzC,oBAAY,qBAAqB;IAC/B,YAAY,gBAAgB;IAE5B,cAAc,kBAAkB;IAChC,OAAO,gBAAgB;CAGxB;AAED,MAAM,MAAM,kBAAkB,GAAG,YAAY,CAAA;AAE7C;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,IAAI,EAAE,UAAU,CAAC,aAAa,CAAA;IAC9B,YAAY,EAAE,kBAAkB,CAAA;IAChC,oBAAoB,EAAE,cAAc,EAAE,CAAA;IAEtC,QAAQ,EAAE,MAAM,CAAC,qBAAqB,EAAE,QAAQ,CAAC,CAAA;IACjD,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,sBAAsB,CAAC,EAAE,OAAO,CAAA;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,SAAU,SAAQ,UAAU;IAC3C,IAAI,EAAE,UAAU,CAAC,GAAG,CAAA;CACrB;AAED,oBAAY,iBAAiB;IAC3B,MAAM,WAAW;IACjB,UAAU,cAAc;IACxB,SAAS,cAAc;IACvB,KAAK,UAAU;CAChB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD,IAAI,EAAE,UAAU,CAAC,SAAS,CAAA;IAC1B,QAAQ,EAAE,MAAM,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAA;IAG7C,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,wBAAwB,CAAC,EAAE,OAAO,CAAA;IAClC,sBAAsB,CAAC,EAAE,OAAO,CAAA;IAChC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAG5B,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,aAAa,CAAC,EAAE,OAAO,CAAA;CACxB;AAED,oBAAY,kBAAkB;IAC5B,KAAK,UAAU;IACf,GAAG,QAAQ;CACZ;AAED,oBAAY,kBAAkB;IAC5B,QAAQ,aAAa;IACrB,eAAe,oBAAoB;IACnC,iBAAiB,sBAAsB;IACvC,SAAS,cAAc;IACvB,KAAK,UAAU;CAChB;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAgB,SAAQ,UAAU;IACjD,QAAQ,EAAE,MAAM,CAAC,kBAAkB,EAAE,QAAQ,CAAC,CAAA;IAG9C,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAG3B,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB;AAED,MAAM,WAAW,oBAAqB,SAAQ,eAAe;IAC3D,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAA;IACjC,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,kBAAmB,SAAQ,eAAe;IACzD,IAAI,EAAE,UAAU,CAAC,cAAc,CAAA;IAC/B,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,iBAAkB,SAAQ,UAAU;IACnD,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,UAAU,CAAC,WAAW,CAAA;IAC5B,WAAW,EAAE;QACX,MAAM,CAAC,EAAE,OAAO,CAAA;QAChB,UAAU,CAAC,EAAE,OAAO,CAAA;KACrB,CAAA;IACD,QAAQ,EAAE,MAAM,CAAC,oBAAoB,EAAE,QAAQ,CAAC,CAAA;CACjD;AAED,oBAAY,oBAAoB;IAC9B,mBAAmB,uBAAuB;IAC1C,kBAAkB,sBAAsB;CACzC;AAED,oBAAY,mBAAmB;IAC7B,aAAa,iBAAiB;IAC9B,SAAS,aAAa;IACtB,aAAa,iBAAiB;IAC9B,cAAc,kBAAkB;CACjC;AAED,MAAM,MAAM,yBAAyB,GACjC;IAAE,MAAM,EAAE,mBAAmB,CAAC,aAAa,CAAA;CAAE,GAC7C;IAAE,MAAM,EAAE,mBAAmB,CAAC,SAAS,CAAA;CAAE,GACzC;IAAE,MAAM,EAAE,mBAAmB,CAAC,aAAa,CAAC;IAAC,eAAe,EAAE,MAAM,CAAA;CAAE,GACtE;IAAE,MAAM,EAAE,mBAAmB,CAAC,cAAc,CAAA;CAAE,CAAA;AAElD,oBAAY,oBAAoB;IAC9B,KAAK,UAAU;IACf,QAAQ,YAAY;IACpB,iBAAiB,qBAAqB;CACvC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,iBAAkB,SAAQ,UAAU;IACnD,IAAI,EAAE,UAAU,CAAC,YAAY,CAAA;IAC7B,OAAO,EAAE,yBAAyB,CAAA;IAClC,OAAO,EAAE,yBAAyB,CAAA;IAClC,QAAQ,EAAE,MAAM,CAAC,oBAAoB,EAAE,QAAQ,CAAC,CAAA;IAChD,mBAAmB,CAAC,EAAE,MAAM,CAAA;CAC7B;AAED,MAAM,MAAM,MAAM,GACd,WAAW,GACX,kBAAkB,GAClB,SAAS,GACT,gBAAgB,GAChB,uBAAuB,GACvB,oBAAoB,GACpB,kBAAkB,GAClB,iBAAiB,GACjB,cAAc,GACd,oBAAoB,GACpB,kBAAkB,GAClB,iBAAiB,GACjB,iBAAiB,CAAA"}

package/build/src/types/nodes.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FSPermissionsOutcome = exports.FSTwoFactorOutcome = exports.FSTwoFactorChannel = exports.FSFaceScanOutcome = exports.FSDocumentScanOutcome = exports.FSRecognitionOutcome = exports.FSEnterEmailOutcome = exports.FSLivenessDetectionOutcome = exports.FSNodeType = void 0;
+exports.FSFaceCompareOutcome = exports.FSFaceCompareSource = exports.FSPermissionsOutcome = exports.FSTwoFactorOutcome = exports.FSTwoFactorChannel = exports.FSFaceScanOutcome = exports.FSDocumentScanOutcome = exports.FSRecognitionOutcome = exports.FSEnterEmailOutcome = exports.FSLivenessDetectionOutcome = exports.FSNodeType = void 0;
 var FSNodeType;
 (function (FSNodeType) {
     FSNodeType["START"] = "start";
@@ -15,6 +15,7 @@ var FSNodeType;
     FSNodeType["TWO_FACTOR_EMAIL"] = "two_factor_email";
     FSNodeType["TWO_FACTOR_SMS"] = "two_factor_sms";
     FSNodeType["PERMISSIONS"] = "permissions";
+    FSNodeType["FACE_COMPARE"] = "face_compare";
 })(FSNodeType = exports.FSNodeType || (exports.FSNodeType = {}));
 var FSLivenessDetectionOutcome;
 (function (FSLivenessDetectionOutcome) {
@@ -67,3 +68,16 @@ var FSPermissionsOutcome;
     FSPermissionsOutcome["PERMISSIONS_GRANTED"] = "permissionsGranted";
     FSPermissionsOutcome["PERMISSIONS_DENIED"] = "permissionsDenied";
 })(FSPermissionsOutcome = exports.FSPermissionsOutcome || (exports.FSPermissionsOutcome = {}));
+var FSFaceCompareSource;
+(function (FSFaceCompareSource) {
+    FSFaceCompareSource["SESSION_VIDEO"] = "sessionVideo";
+    FSFaceCompareSource["FACE_SCAN"] = "faceScan";
+    FSFaceCompareSource["PROVIDED_DATA"] = "providedData";
+    FSFaceCompareSource["DOCUMENT_PHOTO"] = "documentPhoto";
+})(FSFaceCompareSource = exports.FSFaceCompareSource || (exports.FSFaceCompareSource = {}));
+var FSFaceCompareOutcome;
+(function (FSFaceCompareOutcome) {
+    FSFaceCompareOutcome["MATCH"] = "match";
+    FSFaceCompareOutcome["NO_MATCH"] = "noMatch";
+    FSFaceCompareOutcome["IMAGE_UNAVAILABLE"] = "imageUnavailable";
+})(FSFaceCompareOutcome = exports.FSFaceCompareOutcome || (exports.FSFaceCompareOutcome = {}));

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@facesignai/api",
   "package-name": "@facesignai/api",
-  "version": "1.0.34",
+  "version": "1.0.36",
   "description": "Facesign API wrapper",
   "repository": {
     "type": "git",