@finclusionaibuild/liveness-sdk 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,174 @@
+import React from 'react';
+import * as _tanstack_react_query from '@tanstack/react-query';
+
+/**
+ * Liveness SDK Types
+ */
+interface LivenessSession {
+    sessionId: string;
+    awsAccessKeyId: string;
+    awsSecretAccessKey: string;
+    awsSessionToken?: string;
+    awsRegion: string;
+}
+interface LivenessConfig {
+    apiBaseUrl: string;
+    getAuthToken: () => string | null;
+    endpoints?: {
+        createSession?: string;
+        verify?: string;
+        compareWithUser?: string;
+    };
+}
+interface LivenessVerificationResponse {
+    confidence: number;
+    image?: string;
+    success?: boolean;
+    message?: string;
+}
+interface FaceMatchResponse {
+    isMatch: boolean;
+    confidence: number;
+    details: string;
+}
+interface LivenessError {
+    state?: string;
+    error?: {
+        message?: string;
+    };
+    response?: {
+        status?: number;
+        data?: {
+            statusCode?: number;
+            message?: string;
+            error?: string;
+        };
+    };
+    message?: string;
+}
+
+interface LivenessDetectorProps {
+    config: LivenessConfig;
+    token?: string | null;
+    gotoNext: () => void;
+    logoUrl?: string;
+    instructionText?: string;
+}
+declare const LivenessDetector: React.FC<LivenessDetectorProps>;
+
+interface ExternalLivenessProps {
+    config: LivenessConfig;
+    token?: string | null;
+    gotoNext: () => void;
+    region?: string;
+    logoUrl?: string;
+    instructionText?: string;
+}
+declare const ExternalLiveness: React.FC<ExternalLivenessProps>;
+
+interface PaymentLivenessProps {
+    config: LivenessConfig;
+    token?: string | null;
+    gotoNext: () => void;
+    handleClose?: () => void;
+    logoUrl?: string;
+    instructionText?: string;
+    onSendOtp?: () => Promise<void>;
+}
+declare const PaymentLiveness: React.FC<PaymentLivenessProps>;
+
+interface FaceMatchResultProps {
+    result: FaceMatchResponse;
+    onNext: () => void;
+    onRetry: () => void;
+}
+declare const FaceMatchResult: React.FC<FaceMatchResultProps>;
+
+interface LoadingSpinnerProps {
+    size?: number;
+    message?: string;
+}
+declare const LoadingSpinner: React.FC<LoadingSpinnerProps>;
+
+interface ErrorCardProps {
+    error: LivenessError | null;
+    retryAnalysis: () => void;
+}
+declare const ErrorCard: React.FC<ErrorCardProps>;
+
+interface ErrorBlockProps {
+    error: LivenessError | null;
+    retryAnalysis: () => void;
+}
+declare const ErrorBlock: React.FC<ErrorBlockProps>;
+
+interface AnalysisResultProps {
+    confidence: number;
+    retryAnalysis: () => void;
+}
+declare const AnalysisResult: React.FC<AnalysisResultProps>;
+
+interface ProcessedImageProps {
+    image: string;
+    confidence: number;
+    gotoNext: () => void;
+    buttonText?: string;
+}
+declare const ProcessedImage: React.FC<ProcessedImageProps>;
+
+/**
+ * API Client for Liveness SDK
+ * Handles all API calls to the liveness endpoints
+ */
+
+declare class ApiError extends Error {
+    statusCode: number;
+    data?: any | undefined;
+    constructor(statusCode: number, message: string, data?: any | undefined);
+}
+declare class LivenessAPIClient {
+    private baseUrl;
+    private getToken;
+    constructor(config: LivenessConfig);
+    private getAuthHeaders;
+    private handleResponse;
+    /**
+     * Create a new liveness session
+     * GET /kyc/liveliness
+     */
+    createSession(endpoint?: string): Promise<LivenessSession>;
+    /**
+     * Verify liveness session and get results
+     * GET /kyc/liveliness/{sessionId}
+     */
+    verify(sessionId: string, endpoint?: string): Promise<LivenessVerificationResponse>;
+    /**
+     * Compare liveness result with user profile
+     * GET /kyc/liveliness/{sessionId}/compare-with-user
+     */
+    compareWithUser(sessionId: string, endpoint?: string): Promise<FaceMatchResponse>;
+}
+
+declare class LivenessService {
+    private apiClient;
+    private config;
+    constructor(config: LivenessConfig);
+    /**
+     * Get API client instance
+     */
+    getApiClient(): LivenessAPIClient;
+    /**
+     * Hook to fetch liveness session
+     * Uses React Query for caching and state management
+     */
+    useLivenessSession(token?: string | null): _tanstack_react_query.UseQueryResult<LivenessSession, Error>;
+}
+
+/**
+ * Default ID Certify logo embedded as URL-encoded data URL
+ * This logo is automatically used by components if no logoUrl prop is provided
+ */
+declare const DEFAULT_ID_CERTIFY_LOGO: string;
+
+export { AnalysisResult, ApiError, DEFAULT_ID_CERTIFY_LOGO, ErrorBlock, ErrorCard, ExternalLiveness, FaceMatchResult, LivenessAPIClient, LivenessDetector, LivenessService, LoadingSpinner, PaymentLiveness, ProcessedImage };
+export type { FaceMatchResponse, LivenessConfig, LivenessError, LivenessSession, LivenessVerificationResponse };