@facesignai/api 1.0.9 → 1.0.28

package/CHANGELOG.md

@@ -0,0 +1,105 @@
+# Changelog
+
+All notable changes to the Facesign API will be documented in this file.
+
+## [Unreleased]
+
+
+## [1.0.16] - 2025-01-29
+
+### Added
+- Two-Factor Authentication node support:
+  - `FSTwoFactorChannel` enum with EMAIL and SMS channel options
+  - `FSTwoFactorContactSource` enum for session_data, module_settings, and recognition_match sources
+  - `FSTwoFactorOutcome` enum with verified, delivery_failed, failed_unverified, cancelled, and error outcomes
+  - `FSTwoFactorNode` interface with comprehensive configuration options including:
+    - Multi-channel delivery (Email via Resend, SMS via Twilio)
+    - Contact source configuration with field mapping
+    - Template system with variable support ({{userName}}, {{code}}, {{companyName}})
+    - Verification settings (OTP length, expiry, max attempts, resend delay)
+  - `FSPhraseAction.START_TWO_FACTOR_VERIFICATION` action for conversation flow integration
+  - `FSClientEvent.TWO_FACTOR_CODE_SPOKEN` event for spoken code verification
+
+## [1.0.15] - 2025-01-28
+
+### Added
+
+- Advanced configuration options for Face Scan node:
+  - `captureDelay` - Configurable countdown before capture (0 for immediate)
+  - `detectionInterval` - How often to check for faces (performance tuning)
+  - `qualityThreshold` - Overall face quality score requirement
+  - `blurThreshold` - Clarity detection threshold (lower = stricter)
+  - `minFaceSize` / `maxFaceSize` - Acceptable face size range in pixels
+  - `enableSound` - Toggle audio feedback
+  - `enableHaptics` - Toggle haptic feedback on mobile
+  - `useWebGL` - Control WebGL acceleration usage
+  - `maxRetries` - Maximum capture attempts allowed
+
+## [1.0.14] - 2025-01-28
+
+### Added
+
+- Localization support for permissions screen text:
+  - `permissionsButtonTextTranslates` - Localized button text per language
+  - `permissionsMainHeadingTranslates` - Localized main heading per language
+  - `permissionsSubheadingTranslates` - Localized subheading per language
+
+### Changed
+
+- Kept original non-localized fields for backward compatibility
+
+## [1.0.13] - 2025-01-28
+
+### Added
+
+- Face Scan mode enum (`FSFaceScanMode`) with CAPTURE and COMPARE modes
+- Enhanced `FSFaceScanNode` interface with mode-based configuration
+- `saveToField` option for capture-only mode to store face image URL
+- `CAPTURED` outcome for capture-only face scan mode
+
+### Changed
+
+- Reorganized `FSFaceScanOutcome` enum to separate capture and compare mode outcomes
+- Updated `FSFaceScanNode` to support both capture-only and capture+compare modes
+
+## [1.0.12] - 2025-01-27
+
+### Added
+
+- Face Scan node type (`FACE_SCAN`) for 1:1 biometric face matching
+- `FSFaceScanOutcome` enum with match outcomes (match, noMatch, noFace, error)
+- `FSFaceScanNode` interface with configuration for reference image sources and matching threshold
+
+## [1.0.11] - 2025-01-27
+
+### Added
+
+- Permissions screen customization options to `SessionSettings`:
+  - `permissionsButtonText` - Custom text for the permissions request button
+  - `permissionsBackgroundType` - Choose between 'avatar' or 'color' background
+  - `permissionsBackgroundColor` - Custom color when using solid color background
+  - `permissionsMainHeading` - Custom main heading text (e.g., "You're about to chat with a digital assistant.")
+  - `permissionsSubheading` - Custom subheading text (e.g., "Allow FaceSign to use your camera and microphone?")
+
+## [1.0.10] - 2024-05-20
+
+### Added
+
+- Document Scanning node type (`DOCUMENT_SCAN`) to support Microblink document scanning integration
+- New `MicroblinkDocumentType` enum with supported document types
+- `FSDocumentScanOutcome` enum for tracking scan outcomes
+- `FSDocumentScanNode` interface with configuration options for document scanning
+
+### Changed
+
+- Updated `FSNode` union type to include the new DocumentScan node type
+
+## [1.0.9] - Previous version
+
+Initial version with support for:
+
+- Start/End nodes
+- Conversation nodes
+- Liveness Detection nodes
+- Email Input nodes
+- Data Validation nodes

package/README.md

@@ -9,8 +9,8 @@
 ## Installation
 
 ```
-npm install @facesign/api
-yarn add @facesign/api
+npm install @facesignai/api
+yarn add @facesignai/api
 ```
 
 ## Usage
@@ -18,7 +18,7 @@ yarn add @facesign/api
 Import and initialize a client using an **integration token**
 
 ```js
-const { Client } = require('@facesignai/api')
+const { Client } = require("@facesignai/api")
 
 // Initializing a client
 const facesignClient = new Client({

package/build/package.json

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

package/build/src/api-endpoints.d.ts

@@ -1,5 +1,17 @@
-import { Device } from './types/deviceDetails';
-import { Location } from './types/location';
+import { Device } from "./types/deviceDetails";
+import { Location } from "./types/location";
+import { FSNode } from "./types/nodes";
+import { Customization } from "./types/customization";
+import { NodeReport } from "./types/nodeReports";
+import { VideoAIAnalysis } from "./types/videoAIAnalysis";
+export * from "./types/deviceDetails";
+export * from "./types/location";
+export * from "./types/nodes";
+export * from "./types/customization";
+export * from "./types/nodeReports";
+export * from "./types/docScanning";
+export * from "./types/webhooks";
+export * from "./types/videoAIAnalysis";
 export declare enum ILogLevel {
     TRACE = "TRACE",
     DEBUG = " DEBUG",
@@ -38,9 +50,9 @@ export interface Phrase {
     isAvatar: boolean;
 }
 export declare enum SessionStatus {
-    RequiresInput = "requiresInput",
-    Processing = "processing",
-    Canceled = "canceled",
+    Created = "created",
+    InProgress = "inProgress",
+    Incomplete = "incomplete",
     Complete = "complete"
 }
 export interface ClientSecret {
@@ -57,8 +69,8 @@ export type SessionReportAIAnalysisSection = {
 export type SessionReportAIAnalysis = {
     ageMin: number;
     ageMax: number;
-    sex: 'male' | 'female';
-    realPersonOrVirtual: 'real' | 'virtual' | 'noface';
+    sex: "male" | "female";
+    realPersonOrVirtual: "real" | "virtual" | "noface";
     overallSummary: string;
     analysis: SessionReportAIAnalysisSection[];
 };
@@ -67,15 +79,9 @@ export interface SessionReport {
     aiAnalysis?: SessionReportAIAnalysis;
     location?: Location;
     device?: Device;
-    livenessDetected?: boolean;
     lang?: string;
-    extractedData?: Record<string, string>;
-    screenshots?: string[];
-    videos?: {
-        avatarVideoUrl?: string;
-        userVideoUrl?: string;
-    };
-    isVerified?: boolean;
+    nodeReports?: NodeReport[];
+    videoAIAnalysis?: VideoAIAnalysis;
 }
 export interface Session {
     id: string;
@@ -95,64 +101,29 @@ export type Lang = {
     id: string;
     title: string;
 };
-export interface GetLangsResponse {
-    langs: Lang[];
-}
-export type Zone = 'es' | 'eu';
-export declare enum ModuleType {
-    EmailVerification = "emailVerification",
-    SmsVerification = "smsVerification",
-    IdentityVerification = "identityVerification",
-    DocumentAuthentication = "documentAuthentication",
-    AgeEstimation = "ageEstimation",
-    ProofOfIntent = "proofOfIntent",
-    KnowledgeVerify = "knowledgeVerify"
-}
-export type EmailVerification = {
-    type: ModuleType.EmailVerification;
-    name?: string;
-    email?: string;
-    publicRecognitionEnabled?: boolean;
-};
-export type SmsVerification = {
-    type: ModuleType.SmsVerification;
-    phone?: string;
-};
-export type IdentityVerification = {
-    type: ModuleType.IdentityVerification;
-};
-export type DocumentAuthentication = {
-    type: ModuleType.DocumentAuthentication;
-};
-export type AgeEstimation = {
-    type: ModuleType.AgeEstimation;
-    age: number;
-};
-export type ProofOfIntent = {
-    type: ModuleType.ProofOfIntent;
-    requestedData: RequestedData[];
-};
-export type KnowledgeVerify = {
-    type: ModuleType.KnowledgeVerify;
-};
+export type Zone = "us" | "eu";
 export type Avatar = {
     id: string;
     name: string;
-    gender: 'male' | 'female' | 'unknown';
+    gender: "male" | "female" | "unknown";
     imageUrl: string;
 };
-export type Module = EmailVerification | SmsVerification | IdentityVerification | DocumentAuthentication | AgeEstimation | ProofOfIntent | KnowledgeVerify;
+export type ProvidedData = Record<string, string> & {
+    name?: string;
+    email?: string;
+    phone?: string;
+};
 export interface SessionSettings {
-    clientReferenceId: string;
+    clientReferenceId?: string;
     metadata: object;
-    initialPhrase?: string;
-    finalPhrase?: string;
-    providedData?: Record<string, string>;
+    flow: FSNode[];
+    providedData?: ProvidedData;
     avatarId?: string;
     langs?: string[];
     defaultLang?: string;
     zone?: Zone;
-    modules: Module[];
+    customization?: Customization;
+    videoAIAnalysisEnabled?: boolean;
 }
 export interface CreateSessionResponse {
     session: Session;
@@ -162,7 +133,7 @@ export declare const createSessionEndpoint: {
     readonly method: Method.POST;
     readonly pathParams: readonly [];
     readonly queryParams: readonly [];
-    readonly bodyParams: readonly ["clientReferenceId", "metadata", "initialPhrase", "finalPhrase", "providedData", "avatarId", "langs", "defaultLang", "zone", "modules"];
+    readonly bodyParams: readonly ["clientReferenceId", "metadata", "providedData", "avatarId", "langs", "defaultLang", "zone", "flow", "customization", "videoAIAnalysisEnabled"];
     readonly path: () => string;
 };
 type GetSessionPathParameters = {
@@ -175,6 +146,9 @@ export declare const getSessionEndpoint: {
     readonly bodyParams: readonly [];
     readonly path: (p: GetSessionPathParameters) => string;
 };
+export interface GetLangsResponse {
+    langs: Lang[];
+}
 export declare const getLangsEndpoint: {
     readonly method: Method.GET;
     readonly pathParams: readonly [];
@@ -182,6 +156,9 @@ export declare const getLangsEndpoint: {
     readonly bodyParams: readonly [];
     readonly path: () => string;
 };
+export interface GetAvatarsResponse {
+    avatars: Avatar[];
+}
 export declare const getAvatarsEndpoint: {
     readonly method: Method.GET;
     readonly pathParams: readonly [];
@@ -196,5 +173,30 @@ export declare const createClientSecretEndpoint: {
     readonly bodyParams: readonly [];
     readonly path: (p: GetSessionPathParameters) => string;
 };
-export {};
+export interface GetSessionsParameters {
+    limit?: number;
+    cursor?: string;
+    flowId?: string;
+    clientReferenceId?: string;
+    status?: SessionStatus | SessionStatus[];
+    fromDate?: number;
+    toDate?: number;
+    sortBy?: "createdAt" | "status" | "finishedAt";
+    sortOrder?: "asc" | "desc";
+    search?: string;
+    includeTotal?: boolean;
+}
+export interface GetSessionsResponse {
+    sessions: Session[];
+    nextCursor?: string;
+    totalCount?: number;
+    hasMore: boolean;
+}
+export declare const getSessionsEndpoint: {
+    readonly method: Method.GET;
+    readonly pathParams: readonly [];
+    readonly queryParams: readonly ["limit", "cursor", "flowId", "clientReferenceId", "status", "fromDate", "toDate", "sortBy", "sortOrder", "search", "includeTotal"];
+    readonly bodyParams: readonly [];
+    readonly path: () => string;
+};
 //# sourceMappingURL=api-endpoints.d.ts.map

package/build/src/api-endpoints.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api-endpoints.d.ts","sourceRoot":"","sources":["../../src/api-endpoints.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAA;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AAE3C,oBAAY,SAAS;IACnB,KAAK,UAAU;IACf,KAAK,WAAW;IAChB,IAAI,SAAS;IACb,IAAI,SAAS;IACb,KAAK,UAAU;IACf,GAAG,QAAQ;CACZ;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,CAAC,EAAE,SAAS,CAAA;IACpB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,oBAAY,MAAM;IAChB,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,KAAK,UAAU;IACf,KAAK,WAAW;CACjB;AAED,MAAM,WAAW,aAAa;IAC5B,GAAG,EAAE,MAAM,CAAA;IACX,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,4BAA4B;IAC3C,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,OAAO,CAAA;CAClB;AAED,oBAAY,aAAa;IACvB,aAAa,kBAAkB;IAC/B,UAAU,eAAe;IACzB,QAAQ,aAAa;IACrB,QAAQ,aAAa;CACtB;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,GAAG,EAAE,MAAM,CAAA;CACZ;AAED,MAAM,MAAM,8BAA8B,GAAG;IAC3C,KAAK,EAAE,MAAM,CAAA;IACb,gBAAgB,EAAE,MAAM,CAAA;IACxB,eAAe,EAAE,MAAM,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,MAAM,GAAG,QAAQ,CAAA;IACtB,mBAAmB,EAAE,MAAM,GAAG,SAAS,GAAG,QAAQ,CAAA;IAClD,cAAc,EAAE,MAAM,CAAA;IACtB,QAAQ,EAAE,8BAA8B,EAAE,CAAA;CAC3C,CAAA;AACD,MAAM,WAAW,aAAa;IAC5B,UAAU,EAAE,MAAM,EAAE,CAAA;IACpB,UAAU,CAAC,EAAE,uBAAuB,CAAA;IACpC,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACtC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IACtB,MAAM,CAAC,EAAE;QACP,cAAc,CAAC,EAAE,MAAM,CAAA;QACvB,YAAY,CAAC,EAAE,MAAM,CAAA;KACtB,CAAA;IACD,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE,aAAa,CAAA;IACrB,QAAQ,EAAE,eAAe,CAAA;IACzB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,aAAa,CAAA;CACvB;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,OAAO,CAAA;IAChB,YAAY,EAAE,YAAY,CAAA;CAC3B;AAED,MAAM,MAAM,IAAI,GAAG;IACjB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AACD,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,IAAI,EAAE,CAAA;CACd;AAED,MAAM,MAAM,IAAI,GAAG,IAAI,GAAG,IAAI,CAAA;AAE9B,oBAAY,UAAU;IACpB,iBAAiB,sBAAsB;IACvC,eAAe,oBAAoB;IACnC,oBAAoB,yBAAyB;IAC7C,sBAAsB,2BAA2B;IACjD,aAAa,kBAAkB;IAC/B,aAAa,kBAAkB;IAC/B,eAAe,oBAAoB;CACpC;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,UAAU,CAAC,iBAAiB,CAAA;IAClC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,wBAAwB,CAAC,EAAE,OAAO,CAAA;CACnC,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,UAAU,CAAC,eAAe,CAAA;IAChC,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,UAAU,CAAC,oBAAoB,CAAA;CACtC,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,IAAI,EAAE,UAAU,CAAC,sBAAsB,CAAA;CACxC,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,UAAU,CAAC,aAAa,CAAA;IAC9B,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,UAAU,CAAC,aAAa,CAAA;IAC9B,aAAa,EAAE,aAAa,EAAE,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,UAAU,CAAC,eAAe,CAAA;CACjC,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACnB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAA;IACrC,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,MAAM,GACd,iBAAiB,GACjB,eAAe,GACf,oBAAoB,GACpB,sBAAsB,GACtB,aAAa,GACb,aAAa,GACb,eAAe,CAAA;AAEnB,MAAM,WAAW,eAAe;IAC9B,iBAAiB,EAAE,MAAM,CAAA;IACzB,QAAQ,EAAE,MAAM,CAAA;IAChB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACrC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,IAAI,CAAA;IACX,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB;AAED,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,OAAO,CAAA;IAChB,YAAY,EAAE,YAAY,CAAA;CAC3B;AAED,eAAO,MAAM,qBAAqB;;;;;yBAgBtB,MAAM;CACR,CAAA;AAEV,KAAK,wBAAwB,GAAG;IAC9B,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,eAAO,MAAM,kBAAkB;;;;;uBAKnB,wBAAwB,KAAG,MAAM;CACnC,CAAA;AAEV,eAAO,MAAM,gBAAgB;;;;;yBAKjB,MAAM;CACR,CAAA;AAEV,eAAO,MAAM,kBAAkB;;;;;yBAKnB,MAAM;CACR,CAAA;AAEV,eAAO,MAAM,0BAA0B;;;;;uBAK3B,wBAAwB,KAAG,MAAM;CAEnC,CAAA"}
+{"version":3,"file":"api-endpoints.d.ts","sourceRoot":"","sources":["../../src/api-endpoints.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAA;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AACtC,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAA;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AAEzD,cAAc,uBAAuB,CAAA;AACrC,cAAc,kBAAkB,CAAA;AAChC,cAAc,eAAe,CAAA;AAC7B,cAAc,uBAAuB,CAAA;AACrC,cAAc,qBAAqB,CAAA;AACnC,cAAc,qBAAqB,CAAA;AACnC,cAAc,kBAAkB,CAAA;AAChC,cAAc,yBAAyB,CAAA;AAEvC,oBAAY,SAAS;IACnB,KAAK,UAAU;IACf,KAAK,WAAW;IAChB,IAAI,SAAS;IACb,IAAI,SAAS;IACb,KAAK,UAAU;IACf,GAAG,QAAQ;CACZ;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,CAAC,EAAE,SAAS,CAAA;IACpB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,oBAAY,MAAM;IAChB,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,KAAK,UAAU;IACf,KAAK,WAAW;CACjB;AAED,MAAM,WAAW,aAAa;IAC5B,GAAG,EAAE,MAAM,CAAA;IACX,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,4BAA4B;IAC3C,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,OAAO,CAAA;CAClB;AAED,oBAAY,aAAa;IACvB,OAAO,YAAY;IACnB,UAAU,eAAe;IACzB,UAAU,eAAe;IACzB,QAAQ,aAAa;CACtB;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,GAAG,EAAE,MAAM,CAAA;CACZ;AAED,MAAM,MAAM,8BAA8B,GAAG;IAC3C,KAAK,EAAE,MAAM,CAAA;IACb,gBAAgB,EAAE,MAAM,CAAA;IACxB,eAAe,EAAE,MAAM,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,MAAM,GAAG,QAAQ,CAAA;IACtB,mBAAmB,EAAE,MAAM,GAAG,SAAS,GAAG,QAAQ,CAAA;IAClD,cAAc,EAAE,MAAM,CAAA;IACtB,QAAQ,EAAE,8BAA8B,EAAE,CAAA;CAC3C,CAAA;AAED,MAAM,WAAW,aAAa;IAC5B,UAAU,EAAE,MAAM,EAAE,CAAA;IACpB,UAAU,CAAC,EAAE,uBAAuB,CAAA;IACpC,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,UAAU,EAAE,CAAA;IAC1B,eAAe,CAAC,EAAE,eAAe,CAAA;CAClC;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE,aAAa,CAAA;IACrB,QAAQ,EAAE,eAAe,CAAA;IACzB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,aAAa,CAAA;CACvB;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,OAAO,CAAA;IAChB,YAAY,EAAE,YAAY,CAAA;CAC3B;AAED,MAAM,MAAM,IAAI,GAAG;IACjB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,IAAI,GAAG,IAAI,GAAG,IAAI,CAAA;AAE9B,MAAM,MAAM,MAAM,GAAG;IACnB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAA;IACrC,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG;IAClD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,WAAW,eAAe;IAC9B,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,EAAE,CAAA;IACd,YAAY,CAAC,EAAE,YAAY,CAAA;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,IAAI,CAAA;IACX,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B,sBAAsB,CAAC,EAAE,OAAO,CAAA;CACjC;AAED,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,OAAO,CAAA;IAChB,YAAY,EAAE,YAAY,CAAA;CAC3B;AAED,eAAO,MAAM,qBAAqB;;;;;yBAgBtB,MAAM;CACR,CAAA;AAEV,KAAK,wBAAwB,GAAG;IAC9B,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,eAAO,MAAM,kBAAkB;;;;;uBAKnB,wBAAwB,KAAG,MAAM;CACnC,CAAA;AAEV,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,IAAI,EAAE,CAAA;CACd;AAED,eAAO,MAAM,gBAAgB;;;;;yBAKjB,MAAM;CACR,CAAA;AAEV,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB;AAED,eAAO,MAAM,kBAAkB;;;;;yBAKnB,MAAM;CACR,CAAA;AAEV,eAAO,MAAM,0BAA0B;;;;;uBAK3B,wBAAwB,KAAG,MAAM;CAEnC,CAAA;AAGV,MAAM,WAAW,qBAAqB;IAEpC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IAGf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,MAAM,CAAC,EAAE,aAAa,GAAG,aAAa,EAAE,CAAA;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,CAAA;IAGf,MAAM,CAAC,EAAE,WAAW,GAAG,QAAQ,GAAG,YAAY,CAAA;IAC9C,SAAS,CAAC,EAAE,KAAK,GAAG,MAAM,CAAA;IAG1B,MAAM,CAAC,EAAE,MAAM,CAAA;IAGf,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,OAAO,EAAE,CAAA;IACnB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,OAAO,CAAA;CACjB;AAGD,eAAO,MAAM,mBAAmB;;;;;yBAiBpB,MAAM;CACR,CAAA"}

package/build/src/api-endpoints.js

@@ -1,6 +1,28 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createClientSecretEndpoint = exports.getAvatarsEndpoint = exports.getLangsEndpoint = exports.getSessionEndpoint = exports.createSessionEndpoint = exports.ModuleType = exports.SessionStatus = exports.Method = exports.ILogLevel = void 0;
+exports.getSessionsEndpoint = exports.createClientSecretEndpoint = exports.getAvatarsEndpoint = exports.getLangsEndpoint = exports.getSessionEndpoint = exports.createSessionEndpoint = exports.SessionStatus = exports.Method = exports.ILogLevel = void 0;
+__exportStar(require("./types/deviceDetails"), exports);
+__exportStar(require("./types/location"), exports);
+__exportStar(require("./types/nodes"), exports);
+__exportStar(require("./types/customization"), exports);
+__exportStar(require("./types/nodeReports"), exports);
+__exportStar(require("./types/docScanning"), exports);
+__exportStar(require("./types/webhooks"), exports);
+__exportStar(require("./types/videoAIAnalysis"), exports);
 var ILogLevel;
 (function (ILogLevel) {
     ILogLevel["TRACE"] = "TRACE";
@@ -19,42 +41,32 @@ var Method;
 })(Method = exports.Method || (exports.Method = {}));
 var SessionStatus;
 (function (SessionStatus) {
-    SessionStatus["RequiresInput"] = "requiresInput";
-    SessionStatus["Processing"] = "processing";
-    SessionStatus["Canceled"] = "canceled";
+    SessionStatus["Created"] = "created";
+    SessionStatus["InProgress"] = "inProgress";
+    SessionStatus["Incomplete"] = "incomplete";
     SessionStatus["Complete"] = "complete";
 })(SessionStatus = exports.SessionStatus || (exports.SessionStatus = {}));
-var ModuleType;
-(function (ModuleType) {
-    ModuleType["EmailVerification"] = "emailVerification";
-    ModuleType["SmsVerification"] = "smsVerification";
-    ModuleType["IdentityVerification"] = "identityVerification";
-    ModuleType["DocumentAuthentication"] = "documentAuthentication";
-    ModuleType["AgeEstimation"] = "ageEstimation";
-    ModuleType["ProofOfIntent"] = "proofOfIntent";
-    ModuleType["KnowledgeVerify"] = "knowledgeVerify";
-})(ModuleType = exports.ModuleType || (exports.ModuleType = {}));
 exports.createSessionEndpoint = {
     method: Method.POST,
     pathParams: [],
     queryParams: [],
     bodyParams: [
-        'clientReferenceId',
-        'metadata',
-        'initialPhrase',
-        'finalPhrase',
-        'providedData',
-        'avatarId',
-        'langs',
-        'defaultLang',
-        'zone',
-        'modules',
+        "clientReferenceId",
+        "metadata",
+        "providedData",
+        "avatarId",
+        "langs",
+        "defaultLang",
+        "zone",
+        "flow",
+        "customization",
+        "videoAIAnalysisEnabled",
     ],
-    path: () => '/sessions',
+    path: () => "/sessions",
 };
 exports.getSessionEndpoint = {
     method: Method.GET,
-    pathParams: ['sessionId'],
+    pathParams: ["sessionId"],
     queryParams: [],
     bodyParams: [],
     path: (p) => `/sessions/${p.sessionId}`,
@@ -64,19 +76,39 @@ exports.getLangsEndpoint = {
     pathParams: [],
     queryParams: [],
     bodyParams: [],
-    path: () => '/langs',
+    path: () => "/langs",
 };
 exports.getAvatarsEndpoint = {
     method: Method.GET,
     pathParams: [],
     queryParams: [],
     bodyParams: [],
-    path: () => '/avatars',
+    path: () => "/avatars",
 };
 exports.createClientSecretEndpoint = {
     method: Method.GET,
-    pathParams: ['sessionId'],
+    pathParams: ["sessionId"],
     queryParams: [],
     bodyParams: [],
     path: (p) => `/sessions/${p.sessionId}/refresh`,
 };
+// List sessions endpoint
+exports.getSessionsEndpoint = {
+    method: Method.GET,
+    pathParams: [],
+    queryParams: [
+        "limit",
+        "cursor",
+        "flowId",
+        "clientReferenceId",
+        "status",
+        "fromDate",
+        "toDate",
+        "sortBy",
+        "sortOrder",
+        "search",
+        "includeTotal",
+    ],
+    bodyParams: [],
+    path: () => "/sessions",
+};

package/build/src/client.d.ts

@@ -1,5 +1,4 @@
-/// <reference types="node" />
-import { SessionSettings, CreateSessionResponse, Method, ClientOptions, GetSessionParameters, GetSessionResponse, CreateClientSecretParameters, ClientSecret, GetLangsResponse } from './api-endpoints';
+import { SessionSettings, CreateSessionResponse, Method, ClientOptions, GetSessionParameters, GetSessionResponse, CreateClientSecretParameters, ClientSecret, GetLangsResponse, GetAvatarsResponse, GetSessionsParameters, GetSessionsResponse } from './api-endpoints';
 type QueryParams = Record<string, string | number | string[]> | URLSearchParams;
 export interface RequestParameters {
     path: string;
@@ -11,6 +10,7 @@ export interface RequestParameters {
 declare class Client {
     #private;
     constructor(options?: ClientOptions);
+    private getServerUrlFromApiKey;
     private setLogLevel;
     private request;
     readonly session: {
@@ -26,6 +26,10 @@ declare class Client {
          * Generate client secret for the specified session
          */
         createClientSecret: (args: CreateClientSecretParameters) => Promise<ClientSecret>;
+        /**
+         * List sessions with filtering and pagination
+         */
+        list: (args?: GetSessionsParameters) => Promise<GetSessionsResponse>;
         apiVersion: string;
     };
     readonly langs: {
@@ -36,9 +40,9 @@ declare class Client {
     };
     readonly avatars: {
         /**
-         * Retrieve supported langs
+         * Retrieve supported avatars
          */
-        retrieve: () => Promise<GetLangsResponse>;
+        retrieve: () => Promise<GetAvatarsResponse>;
     };
 }
 export default Client;

package/build/src/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":";AAGA,OAAO,EAEL,eAAe,EACf,qBAAqB,EACrB,MAAM,EAEN,aAAa,EACb,oBAAoB,EACpB,kBAAkB,EAClB,4BAA4B,EAE5B,YAAY,EAEZ,gBAAgB,EAGjB,MAAM,iBAAiB,CAAA;AAIxB,KAAK,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,GAAG,eAAe,CAAA;AAE/E,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,WAAW,CAAA;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,cAAM,MAAM;;gBAOU,OAAO,CAAC,EAAE,aAAa;IAe3C,OAAO,CAAC,WAAW;YA6BL,OAAO;IA2ErB,SAAgB,OAAO;QACrB;;WAEG;uBACY,eAAe,KAAG,QAAQ,qBAAqB,CAAC;QAQ/D;;WAEG;yBACc,oBAAoB,KAAG,QAAQ,kBAAkB,CAAC;QAQnE;;WAEG;mCACwB,4BAA4B;;MASxD;IAED,SAAgB,KAAK;QACnB;;WAEG;wBACW,QAAQ,gBAAgB,CAAC;MAQxC;IAED,SAAgB,OAAO;QACrB;;WAEG;wBACW,QAAQ,gBAAgB,CAAC;MAQxC;CACF;AAED,eAAe,MAAM,CAAA"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":"AAGA,OAAO,EAEL,eAAe,EACf,qBAAqB,EACrB,MAAM,EAEN,aAAa,EACb,oBAAoB,EACpB,kBAAkB,EAClB,4BAA4B,EAE5B,YAAY,EAEZ,gBAAgB,EAGhB,kBAAkB,EAClB,qBAAqB,EACrB,mBAAmB,EAEpB,MAAM,iBAAiB,CAAA;AAIxB,KAAK,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,GAAG,eAAe,CAAA;AAE/E,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,WAAW,CAAA;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,cAAM,MAAM;;gBAOS,OAAO,CAAC,EAAE,aAAa;IAiB1C,OAAO,CAAC,sBAAsB;IAY9B,OAAO,CAAC,WAAW;YA6BL,OAAO;IA2ErB,SAAgB,OAAO;QACrB;;WAEG;uBACY,eAAe,KAAG,QAAQ,qBAAqB,CAAC;QAQ/D;;WAEG;yBACc,oBAAoB,KAAG,QAAQ,kBAAkB,CAAC;QAQnE;;WAEG;mCACwB,4BAA4B;QAQvD;;WAEG;sBACW,qBAAqB,KAAG,QAAQ,mBAAmB,CAAC;;MAqBnE;IAED,SAAgB,KAAK;QACnB;;WAEG;wBACW,QAAQ,gBAAgB,CAAC;MAQxC;IAED,SAAgB,OAAO;QACrB;;WAEG;wBACW,QAAQ,kBAAkB,CAAC;MAQ1C;CACF;AAED,eAAe,MAAM,CAAA"}

package/build/src/client.js

@@ -63,6 +63,29 @@ class Client {
                     body: (0, utils_1.pick)(args, api_endpoints_1.createClientSecretEndpoint.bodyParams),
                 });
             },
+            /**
+             * List sessions with filtering and pagination
+             */
+            list: (args) => {
+                return this.request({
+                    path: api_endpoints_1.getSessionsEndpoint.path(),
+                    method: api_endpoints_1.getSessionsEndpoint.method,
+                    query: args ? {
+                        ...(args.limit !== undefined && { limit: args.limit }),
+                        ...(args.cursor && { cursor: args.cursor }),
+                        ...(args.flowId && { flowId: args.flowId }),
+                        ...(args.clientReferenceId && { clientReferenceId: args.clientReferenceId }),
+                        ...(args.status && { status: args.status }),
+                        ...(args.fromDate !== undefined && { fromDate: args.fromDate }),
+                        ...(args.toDate !== undefined && { toDate: args.toDate }),
+                        ...(args.sortBy && { sortBy: args.sortBy }),
+                        ...(args.sortOrder && { sortOrder: args.sortOrder }),
+                        ...(args.search && { search: args.search }),
+                        ...(args.includeTotal !== undefined && { includeTotal: String(args.includeTotal) }),
+                    } : {},
+                    body: {},
+                });
+            },
             apiVersion: package_json_1.default.version,
         };
         this.langs = {
@@ -80,7 +103,7 @@ class Client {
         };
         this.avatars = {
             /**
-             * Retrieve supported langs
+             * Retrieve supported avatars
              */
             retrieve: () => {
                 return this.request({
@@ -96,6 +119,9 @@ class Client {
         if (options === null || options === void 0 ? void 0 : options.serverUrl) {
             __classPrivateFieldSet(this, _Client_serverUrl, options.serverUrl, "f");
         }
+        else if (options === null || options === void 0 ? void 0 : options.auth) {
+            __classPrivateFieldSet(this, _Client_serverUrl, this.getServerUrlFromApiKey(options.auth), "f");
+        }
         if (options && options.logLevel) {
             this.setLogLevel(options.logLevel);
         }
@@ -103,6 +129,17 @@ class Client {
             loglevel_1.default.disableAll();
         }
     }
+    getServerUrlFromApiKey(apiKey) {
+        if (apiKey.startsWith('sk_live_')) {
+            return 'https://api.facesign.ai';
+        }
+        else if (apiKey.startsWith('sk_test_')) {
+            return 'https://api.dev.facesign.ai';
+        }
+        // Default fallback for keys without prefix (backward compatibility)
+        loglevel_1.default.warn('API key does not have a recognized prefix (sk_live_ or sk_test_). Using default production URL.');
+        return 'https://api.facesign.ai';
+    }
     setLogLevel(logLevel) {
         switch (logLevel) {
             case api_endpoints_1.ILogLevel.DEBUG: {

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

@@ -0,0 +1,22 @@
+export declare enum BackgroundType {
+    AVATAR = "AVATAR",
+    COLOR = "COLOR"
+}
+export type PermissionsPageCustomization = {
+    buttonText?: string;
+    backgroundType?: BackgroundType;
+    backgroundColor?: string;
+    mainHeading?: string;
+    subheading?: string;
+    buttonTextTranslates?: Record<string, string>;
+    mainHeadingTranslates?: Record<string, string>;
+    subheadingTranslates?: Record<string, string>;
+};
+export type ControlsCustomization = {
+    showUxControls?: boolean;
+};
+export type Customization = {
+    permissionsPage?: PermissionsPageCustomization;
+    controls?: ControlsCustomization;
+};
+//# sourceMappingURL=customization.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"customization.d.ts","sourceRoot":"","sources":["../../../src/types/customization.ts"],"names":[],"mappings":"AAAA,oBAAY,cAAc;IACxB,MAAM,WAAW;IACjB,KAAK,UAAU;CAChB;AAED,MAAM,MAAM,4BAA4B,GAAG;IACzC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,cAAc,CAAC,EAAE,cAAc,CAAA;IAC/B,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC7C,qBAAqB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC9C,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC9C,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,eAAe,CAAC,EAAE,4BAA4B,CAAA;IAC9C,QAAQ,CAAC,EAAE,qBAAqB,CAAA;CACjC,CAAA"}

package/build/src/types/customization.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BackgroundType = void 0;
+var BackgroundType;
+(function (BackgroundType) {
+    BackgroundType["AVATAR"] = "AVATAR";
+    BackgroundType["COLOR"] = "COLOR";
+})(BackgroundType = exports.BackgroundType || (exports.BackgroundType = {}));