@moveris/shared 2.7.0 → 3.0.0

package/dist/index.d.ts

@@ -5,9 +5,18 @@ interface ModelEntry {
     description: string;
     min_frames: number;
     deprecated: boolean;
+    aliases?: string[];
 }
 type ModelsResponse = ModelEntry[];
 type FastCheckModel = '10' | '50' | '250' | 'hybrid-v2-10' | 'hybrid-v2-30' | 'hybrid-v2-50' | 'hybrid-v2-60' | 'hybrid-v2-90' | 'hybrid-v2-100' | 'hybrid-v2-125' | 'hybrid-v2-150' | 'hybrid-v2-250' | 'mixed-10' | 'mixed-30' | 'mixed-60' | 'mixed-90' | 'mixed-120' | 'mixed-150' | 'mixed-250' | 'mixed-10-v2' | 'mixed-30-v2' | 'mixed-60-v2' | 'mixed-90-v2' | 'mixed-120-v2' | (string & object);
+type ModelVersion = 'latest' | 'v2' | 'v1' | 'fast' | 'spatial' | 'hybrid' | (string & object);
+interface DeprecationInfo {
+    deprecated: boolean;
+    resolvedModel: string;
+    deprecatedModel?: string;
+    sunsetDate?: string;
+    suggestedModel?: string;
+}
 type StreamingStatus = 'buffering' | 'complete';
 type FrameSource = 'media' | 'live';
 type JobStatus = 'queued' | 'processing' | 'complete' | 'failed';
@@ -29,6 +38,7 @@ interface FastCheckRequest {
     model?: FastCheckModel;
     source?: FrameSource;
     frames: FrameData[];
+    frame_count?: number;
     warnings?: string[];
 }
 interface FastCheckCropsRequest {
@@ -36,6 +46,7 @@ interface FastCheckCropsRequest {
     model?: FastCheckModel;
     source?: FrameSource;
     crops: CropData[];
+    frame_count?: number;
 }
 interface VerifyRequest {
     session_id: string;
@@ -65,6 +76,7 @@ interface FastCheckStreamRequest {
     model?: FastCheckModel;
     source?: FrameSource;
     frame: FrameData;
+    frame_count?: number;
     warnings?: string[];
 }
 interface FastCheckResponse {
@@ -162,12 +174,14 @@ interface LivenessResult {
     processingMs: number;
     framesProcessed: number;
     warnings?: string[];
+    deprecation?: DeprecationInfo;
 }
 type LivenessState = 'idle' | 'capturing' | 'uploading' | 'processing' | 'complete' | 'error';
 interface LivenessConfig {
     baseUrl: string;
     apiKey: string;
     model?: FastCheckModel;
+    modelVersion?: ModelVersion;
     source?: FrameSource;
     fps?: number;
     frameCount?: number;
@@ -180,12 +194,16 @@ interface CapturedFrame {
 }
 
 type ModelType = FastCheckModel;
+declare const VALID_FRAME_COUNTS: readonly [10, 30, 60, 90, 120];
 interface ModelConfig {
     type: FastCheckModel;
     minFrames: number;
     recommendedFrames: number;
     description: string;
     deprecated: boolean;
+    aliases?: string[];
+    sunsetDate?: string;
+    replacement?: string;
 }
 declare const MODEL_CONFIGS: Record<FastCheckModel, ModelConfig>;
 interface HybridModelConfig {
@@ -301,7 +319,7 @@ interface FrameQualityResult {
     alignment?: FaceAlignmentResult;
     rejectionReason?: 'blur' | 'backlit' | 'low_light' | 'partial_face' | 'no_face' | 'too_close' | 'too_far' | 'misaligned';
 }
-declare const DEFAULT_BLUR_THRESHOLD = 100;
+declare const DEFAULT_BLUR_THRESHOLD = 110;
 declare const BLUR_THRESHOLD_MOBILE = 60;
 declare const BACKLIT_RATIO_THRESHOLD = 0.6;
 declare const LOW_LIGHT_THRESHOLD = 50;
@@ -353,6 +371,14 @@ interface FaceRollResult {
 }
 declare const MAX_FACE_ROLL_DEGREES = 15;
 declare function detectFaceRoll(landmarks: FaceLandmarkPoint[]): FaceRollResult;
+interface CameraAngleResult {
+    ratio: number;
+    cameraAbove: boolean;
+    cameraBelow: boolean;
+}
+declare const CAMERA_ANGLE_HIGH_RATIO = 1.35;
+declare const CAMERA_ANGLE_LOW_RATIO = 0.75;
+declare function detectCameraAngle(landmarks: FaceLandmarkPoint[]): CameraAngleResult;
 declare class BaseFrameCollector {
     protected frames: CapturedFrame[];
     protected maxFrames: number;
@@ -446,6 +472,7 @@ declare const DEFAULT_STABILIZER_CONFIG: StabilizerConfig;
 interface LivenessClientConfig {
     baseUrl?: string;
     apiKey: string;
+    modelVersion?: ModelVersion;
     timeout?: number;
     enableRetry?: boolean;
     customFetch?: typeof fetch;
@@ -465,34 +492,46 @@ declare function generateSessionId(): string;
 declare class LivenessClient {
     private readonly baseUrl;
     private readonly apiKey;
+    private readonly modelVersion;
     private readonly timeout;
     private readonly enableRetry;
     private readonly fetchFn;
     constructor(config: LivenessClientConfig);
     private request;
+    private requestRaw;
     private parseErrorResponse;
     private static unwrapErrorCode;
     private static unwrapErrorMessage;
     private static extractCodeFromText;
+    private static parseDeprecationHeaders;
+    private buildModelVersionHeaders;
     private requestWithRetry;
+    private requestWithRetryRaw;
     health(): Promise<HealthResponse>;
     getModels(): Promise<ModelEntry[]>;
     queueStats(): Promise<QueueStatsResponse>;
     fastCheck(frames: CapturedFrame[], options?: {
         sessionId?: string;
         model?: FastCheckModel;
+        modelVersion?: ModelVersion;
+        frameCount?: number;
         source?: FrameSource;
         warnings?: string[];
     }): Promise<LivenessResult>;
     fastCheckCrops(crops: CropData[], options?: {
         sessionId?: string;
         model?: FastCheckModel;
+        modelVersion?: ModelVersion;
+        frameCount?: number;
         source?: FrameSource;
         warnings?: string[];
+        bgSegmentation?: boolean;
     }): Promise<LivenessResult>;
     streamFrame(frame: CapturedFrame, options: {
         sessionId: string;
         model?: FastCheckModel;
+        modelVersion?: ModelVersion;
+        frameCount?: number;
         source?: FrameSource;
         warnings?: string[];
     }): Promise<FastCheckStreamResponse>;
@@ -500,6 +539,8 @@ declare class LivenessClient {
     fastCheckStream(frames: CapturedFrame[], options?: {
         sessionId?: string;
         model?: FastCheckModel;
+        modelVersion?: ModelVersion;
+        frameCount?: number;
         source?: FrameSource;
         warnings?: string[];
     }, callbacks?: {
@@ -509,6 +550,8 @@ declare class LivenessClient {
     fastCheckStreamSequential(frames: CapturedFrame[], options?: {
         sessionId?: string;
         model?: FastCheckModel;
+        modelVersion?: ModelVersion;
+        frameCount?: number;
         source?: FrameSource;
         warnings?: string[];
     }, callbacks?: {
@@ -602,6 +645,7 @@ declare const FRAME_BUFFER_CONFIG: {
 declare const AUTH_CONFIG: {
     readonly timeout: 30000;
     readonly apiKeyHeader: "X-API-Key";
+    readonly modelVersionHeader: "X-Model-Version";
 };
 declare const FRAME_CONFIG: {
     readonly targetFPS: 30;
@@ -704,8 +748,9 @@ declare const FEEDBACK_MESSAGES: {
     readonly poor_lighting: "Improve lighting";
     readonly too_dark: "Low lighting - move to a brighter area";
     readonly backlit: "Backlit - try facing the light source";
-    readonly phone_angle_low: "Raise your phone to eye level";
-    readonly phone_tilted: "Hold your phone level";
+    readonly camera_angle_low: "Raise camera to eye level";
+    readonly camera_angle_high: "Lower camera to eye level";
+    readonly camera_tilted: "Hold camera level";
     readonly hand_detected: "Remove hand from face";
     readonly eyes_not_visible: "Eyes not clearly visible";
     readonly eyes_shadowed: "Eyes are in shadow - improve lighting";
@@ -738,8 +783,9 @@ interface CaptureQualityState {
     targetFrames: number;
     tooFarFromIdeal?: boolean;
     tooCloseToIdeal?: boolean;
-    phoneAngled?: boolean;
-    phoneTilted?: boolean;
+    cameraAngleLow?: boolean;
+    cameraAngleHigh?: boolean;
+    cameraTilted?: boolean;
 }
 declare function getCaptureQualityFeedback(state: CaptureQualityState): string;
 declare function canCaptureFrame(state: Omit<CaptureQualityState, 'framesCaptured' | 'targetFrames' | 'isCapturing'>): boolean;
@@ -790,4 +836,4 @@ declare function analyzeEyeRegionContrast(pixels: Uint8Array | Uint8ClampedArray
 declare function detectSpecularHighlights(pixels: Uint8Array | Uint8ClampedArray, relativeFactor?: number, meanBrightness?: number): number;
 declare function checkEyeRegionQuality(pixels: Uint8Array | Uint8ClampedArray, thresholds?: EyeQualityThresholds): EyeRegionQuality;
 
-export { ALIGNMENT_THRESHOLD_CAPTURE, ALIGNMENT_THRESHOLD_GOOD, ALIGNMENT_THRESHOLD_PERFECT, ALIGNMENT_THRESHOLD_POOR, API_ENDPOINTS, API_ERROR_CODES, API_PATHS, AUTH_CONFIG, type ApiErrorCode, BACKLIT_RATIO_THRESHOLD, BLUR_THRESHOLD_MOBILE, BaseFrameCollector, type BlurAnalysis, type CaptureQualityState, type CapturedFrame, type CropData, DEFAULT_BLUR_THRESHOLD, DEFAULT_ENDPOINT, DEFAULT_FACE_DETECTION_TIERS, DEFAULT_GAZE_THRESHOLDS, DEFAULT_HAND_OCCLUSION_CONFIG, DEFAULT_LIVENESS_CONFIG, DEFAULT_LOCALE, DEFAULT_OVAL_REGION, DEFAULT_STABILIZER_CONFIG, DEFAULT_STATUS_MESSAGES, type DetectionResult, type DetectionSummary, type DetectorConfig, ERROR_MESSAGES, ERROR_MESSAGES_ES, ES_LOCALE, EYE_LANDMARK_INDICES, EYE_QUALITY_THRESHOLDS, type ErrorResponse, type EyeQualityThresholds, type EyeRegionBounds, type EyeRegionQuality, type EyeRegionsBounds, FACE_CENTER_VERTICAL_OFFSET, FACE_CROP_OUTPUT_SIZE, FEEDBACK_MESSAGES, FRAME_BUFFER_CONFIG, FRAME_CONFIG, type FaceAlignmentResult, type FaceBoundingBox, type FaceDetectionTiers, type FaceInOvalResult, type FaceLandmarkPoint, type FaceRollResult, type FaceVisibilityResult, type FastCheckCropsRequest, type FastCheckModel, type FastCheckRequest, type FastCheckResponse, type FastCheckStreamRequest, type FastCheckStreamResponse, type FeedbackLocale, type FeedbackMessageKey, type Frame, FrameBuffer, type FrameData, type FrameQualityResult, FrameQueue, type FrameSource, GOOD_ALIGNMENT, type GazeThresholds, HIGH_ALIGNMENT, HYBRID_MODEL_CONFIGS, type HandOcclusionConfig, type HeadPose, type HealthResponse, type Hybrid150CheckRequest, type Hybrid50CheckRequest, type HybridCheckRequest, type HybridCheckResponse, type HybridFrameData, type HybridModelConfig, IDEAL_CROP_MULTIPLIER, type JobStatus, type JobStatusResponse, LANDMARK_INDEX, LANDMARK_MAX_BOUND, LANDMARK_MIN_BOUND, LOW_LIGHT_THRESHOLD, type LandmarkValidationResult, type LightingAnalysis, LivenessApiError, type LivenessCallbacks, LivenessClient, type LivenessClientConfig, type LivenessConfig, type LivenessResult, type LivenessState, MAX_CROP_MULTIPLIER, MAX_FACE_PERCENTAGE_IN_CROP, MAX_FACE_RATIO, MAX_FACE_ROLL_DEGREES, MAX_IDEAL_FACE_RATIO, MIN_CAPTURE_ALIGNMENT, MIN_CROP_MULTIPLIER, MIN_FACE_BOTTOM_MARGIN, MIN_FACE_RATIO, MIN_FACE_SIDE_MARGIN, MIN_FACE_TOP_MARGIN, MIN_IDEAL_FACE_RATIO, MIN_LANDMARK_COUNT, MODEL_CONFIGS, type ModelConfig, type ModelEntry, type ModelType, type ModelsResponse, OVAL_GUIDE_COLORS, OVAL_GUIDE_STYLES, OVAL_REGION_DESKTOP, OVAL_REGION_MOBILE, type OnErrorCallback, type OnFrameCapturedCallback, type OnProgressCallback, type OnResultCallback, type OnStateChangeCallback, type OvalGuideState, type OvalRegion, type QueueStatsResponse, RETRY_CONFIG, type RetryOptions, type StabilizationProgress, type StabilizationResult, type StabilizerConfig, type StatusMessageKey, type StreamingStatus, TARGET_FACE_PERCENTAGE_IN_CROP, type Verdict, type VerifyRequest, type VerifyResponse, type VideoFrameMetadata, analyzeBlur, analyzeEyeRegionBrightness, analyzeEyeRegionContrast, analyzeLighting, calculateAdaptiveCropMultiplier, calculateBrightness, calculateFaceAlignment, calculateFaceCropRegion, canCaptureFrame, checkEyeRegionQuality, checkFrameQuality, decodeBase64, detectFaceRoll, detectSpecularHighlights, encodeBase64, generateSessionId, getActiveModels, getApiErrorMessage, getCaptureQualityFeedback, getEyeRegionBounds, getFeedbackMessage, getMinFramesForModel, getOvalGuideState, getStatusMessage, hasEnoughFrames, isDeprecatedModel, isFaceCropFullyInFrame, isFaceFullyVisible, isFaceInOval, isRetryableError, retryWithBackoff, rgbaToGrayscale, sleep, toFrameData, toHybridFrameData, toLivenessResult, toLivenessResultFromStream, validateApiKey, validateFaceLandmarks, validateFrameCount, validateFrameData, validateFrameIndex, validateTimestamp, validateUUID, validateUrl };
+export { ALIGNMENT_THRESHOLD_CAPTURE, ALIGNMENT_THRESHOLD_GOOD, ALIGNMENT_THRESHOLD_PERFECT, ALIGNMENT_THRESHOLD_POOR, API_ENDPOINTS, API_ERROR_CODES, API_PATHS, AUTH_CONFIG, type ApiErrorCode, BACKLIT_RATIO_THRESHOLD, BLUR_THRESHOLD_MOBILE, BaseFrameCollector, type BlurAnalysis, CAMERA_ANGLE_HIGH_RATIO, CAMERA_ANGLE_LOW_RATIO, type CameraAngleResult, type CaptureQualityState, type CapturedFrame, type CropData, DEFAULT_BLUR_THRESHOLD, DEFAULT_ENDPOINT, DEFAULT_FACE_DETECTION_TIERS, DEFAULT_GAZE_THRESHOLDS, DEFAULT_HAND_OCCLUSION_CONFIG, DEFAULT_LIVENESS_CONFIG, DEFAULT_LOCALE, DEFAULT_OVAL_REGION, DEFAULT_STABILIZER_CONFIG, DEFAULT_STATUS_MESSAGES, type DeprecationInfo, type DetectionResult, type DetectionSummary, type DetectorConfig, ERROR_MESSAGES, ERROR_MESSAGES_ES, ES_LOCALE, EYE_LANDMARK_INDICES, EYE_QUALITY_THRESHOLDS, type ErrorResponse, type EyeQualityThresholds, type EyeRegionBounds, type EyeRegionQuality, type EyeRegionsBounds, FACE_CENTER_VERTICAL_OFFSET, FACE_CROP_OUTPUT_SIZE, FEEDBACK_MESSAGES, FRAME_BUFFER_CONFIG, FRAME_CONFIG, type FaceAlignmentResult, type FaceBoundingBox, type FaceDetectionTiers, type FaceInOvalResult, type FaceLandmarkPoint, type FaceRollResult, type FaceVisibilityResult, type FastCheckCropsRequest, type FastCheckModel, type FastCheckRequest, type FastCheckResponse, type FastCheckStreamRequest, type FastCheckStreamResponse, type FeedbackLocale, type FeedbackMessageKey, type Frame, FrameBuffer, type FrameData, type FrameQualityResult, FrameQueue, type FrameSource, GOOD_ALIGNMENT, type GazeThresholds, HIGH_ALIGNMENT, HYBRID_MODEL_CONFIGS, type HandOcclusionConfig, type HeadPose, type HealthResponse, type Hybrid150CheckRequest, type Hybrid50CheckRequest, type HybridCheckRequest, type HybridCheckResponse, type HybridFrameData, type HybridModelConfig, IDEAL_CROP_MULTIPLIER, type JobStatus, type JobStatusResponse, LANDMARK_INDEX, LANDMARK_MAX_BOUND, LANDMARK_MIN_BOUND, LOW_LIGHT_THRESHOLD, type LandmarkValidationResult, type LightingAnalysis, LivenessApiError, type LivenessCallbacks, LivenessClient, type LivenessClientConfig, type LivenessConfig, type LivenessResult, type LivenessState, MAX_CROP_MULTIPLIER, MAX_FACE_PERCENTAGE_IN_CROP, MAX_FACE_RATIO, MAX_FACE_ROLL_DEGREES, MAX_IDEAL_FACE_RATIO, MIN_CAPTURE_ALIGNMENT, MIN_CROP_MULTIPLIER, MIN_FACE_BOTTOM_MARGIN, MIN_FACE_RATIO, MIN_FACE_SIDE_MARGIN, MIN_FACE_TOP_MARGIN, MIN_IDEAL_FACE_RATIO, MIN_LANDMARK_COUNT, MODEL_CONFIGS, type ModelConfig, type ModelEntry, type ModelType, type ModelVersion, type ModelsResponse, OVAL_GUIDE_COLORS, OVAL_GUIDE_STYLES, OVAL_REGION_DESKTOP, OVAL_REGION_MOBILE, type OnErrorCallback, type OnFrameCapturedCallback, type OnProgressCallback, type OnResultCallback, type OnStateChangeCallback, type OvalGuideState, type OvalRegion, type QueueStatsResponse, RETRY_CONFIG, type RetryOptions, type StabilizationProgress, type StabilizationResult, type StabilizerConfig, type StatusMessageKey, type StreamingStatus, TARGET_FACE_PERCENTAGE_IN_CROP, VALID_FRAME_COUNTS, type Verdict, type VerifyRequest, type VerifyResponse, type VideoFrameMetadata, analyzeBlur, analyzeEyeRegionBrightness, analyzeEyeRegionContrast, analyzeLighting, calculateAdaptiveCropMultiplier, calculateBrightness, calculateFaceAlignment, calculateFaceCropRegion, canCaptureFrame, checkEyeRegionQuality, checkFrameQuality, decodeBase64, detectCameraAngle, detectFaceRoll, detectSpecularHighlights, encodeBase64, generateSessionId, getActiveModels, getApiErrorMessage, getCaptureQualityFeedback, getEyeRegionBounds, getFeedbackMessage, getMinFramesForModel, getOvalGuideState, getStatusMessage, hasEnoughFrames, isDeprecatedModel, isFaceCropFullyInFrame, isFaceFullyVisible, isFaceInOval, isRetryableError, retryWithBackoff, rgbaToGrayscale, sleep, toFrameData, toHybridFrameData, toLivenessResult, toLivenessResultFromStream, validateApiKey, validateFaceLandmarks, validateFrameCount, validateFrameData, validateFrameIndex, validateTimestamp, validateUUID, validateUrl };