idmission-web-sdk 1.0.367 → 1.0.369

package/dist/components/common/debug.d.ts

@@ -1,6 +1,6 @@
 import React, { ReactElement, ReactNode } from 'react';
 import { DetectedObject } from '../../lib/models/DocumentDetection';
-import { Face, FaceKeypoint } from '../selfie_capture/HighPerformanceSelfieGuidanceModelsProvider';
+import { Face, FaceKeypoint } from '../../lib/models/FaceDetection';
 export declare const DebugStatsPane: import("styled-components").IStyledComponent<"web", {
     ref?: React.LegacyRef<HTMLSpanElement> | undefined;
     key?: React.Key | null | undefined;
@@ -313,7 +313,7 @@ export type DetectedObjectDebugBoxProps = {
     flipX?: boolean;
     color?: string;
 };
-export declare function IdCaptureDetectedObjectDebugBox({ obj, flipX, color, }: DetectedObjectDebugBoxProps): ReactElement;
+export declare function IdCaptureDetectedObjectDebugBox({ obj, flipX, color, scaling, }: DetectedObjectDebugBoxProps): ReactElement;
 export type SelfieCaptureFaceDebugBoxProps = {
     face: Face;
     scaling: DebugScalingDetails;

package/dist/components/id_capture/CapturedDocuments.d.ts

@@ -1,8 +1,9 @@
+import { DetectedObjectBox } from '../../lib/models/DocumentDetection';
 export type CapturedDocument = {
     imageData: string;
     width: number;
     height: number;
-    boundingBox?: number[];
+    boundingBox?: DetectedObjectBox;
 };
 export declare const CapturedDocumentTypeValues: readonly ["idCardFront", "idCardBack", "passport", "selfie"];
 export type CapturedDocumentType = (typeof CapturedDocumentTypeValues)[number];

package/dist/components/id_capture/DocumentDetectionModelProvider.d.ts

@@ -0,0 +1,55 @@
+import * as React from 'react';
+import { MutableRefObject, ReactElement, ReactNode } from 'react';
+import { DetectedObject, DocumentType } from '../../lib/models/DocumentDetection';
+type PredictionHandler = (prediction: DocumentDetectionPrediction) => Promise<void>;
+type DocumentDetectionModelState = {
+    documentDetectionModelReady: boolean;
+    startDocumentDetection: () => void;
+    stopDocumentDetection: () => void;
+    onDocumentDetected: (handler: PredictionHandler) => void;
+    detectionTime: number;
+    documentDetectionThresholds: DocumentDetectionThresholds;
+    setDocumentDetectionThresholds: (value: DocumentDetectionThresholds) => void;
+    documentDetectionLastPredictionCanvas: MutableRefObject<HTMLCanvasElement | null>;
+    documentDetectionModelDownloadProgress: number;
+    documentDetectionModelError: Error | null;
+};
+export declare const DocumentDetectionModelContext: React.Context<DocumentDetectionModelState>;
+export type DocumentDetectionModelProviderProps = {
+    autoStart?: boolean;
+    children: ReactNode;
+    throttleMs?: number;
+    documentDetectionModelPath?: string;
+    documentDetectionModelDelegate?: 'CPU' | 'GPU';
+    documentDetectionModelScoreThreshold?: number;
+    documentDetectionModelLoadTimeoutMs?: number;
+};
+export declare function DocumentDetectionModelProvider({ autoStart, children, throttleMs, documentDetectionModelPath, documentDetectionModelDelegate, documentDetectionModelScoreThreshold, documentDetectionModelLoadTimeoutMs, }: DocumentDetectionModelProviderProps): ReactElement;
+export type DocumentDetectionThresholds = {
+    document?: number;
+    passport?: number;
+    mrz?: number;
+    pdf417?: number;
+};
+export type DocumentDetectionPrediction = {
+    detectedObjects: DetectedObject[];
+    detectionTime: number;
+    detectionScore: number;
+    detectionThresholdMet: boolean;
+    detectedDocumentType: DocumentType;
+    passportDetectionScore: number;
+    passportDetectionThresholdMet: boolean;
+    mrzDetectionScore: number;
+    mrzDetectionThresholdMet: boolean;
+    pdf417DetectionScore: number;
+    pdf417DetectionThresholdMet: boolean;
+    bestDocumentOrPassport: DetectedObject | undefined;
+    bestMrz: DetectedObject | undefined;
+    bestPdf417: DetectedObject | undefined;
+    documentInBounds: boolean;
+    documentTooClose: boolean;
+    frameWidth: number;
+    frameHeight: number;
+    allZero: boolean;
+};
+export {};

package/dist/components/id_capture/FocusModelProvider.d.ts

@@ -0,0 +1,23 @@
+import React, { ReactNode } from 'react';
+import { Frame } from '../../lib/utils/getFrameDimensions';
+import { FocusPrediction, FocusThresholds } from '../../lib/models/Focus';
+import { DetectedObjectBox } from '../../lib/models/DocumentDetection';
+type FocusModelState = {
+    focusModelReady: boolean;
+    focusModelDownloadProgress: number;
+    focusModelError: Error | null;
+    focusThresholds: FocusThresholds;
+    setFocusThresholds: (value: FocusThresholds) => void;
+    makeFocusPrediction: (image: Frame, box?: DetectedObjectBox) => Promise<FocusPrediction | null>;
+    focusPredictionTime: number;
+};
+export declare const FocusModelContext: React.Context<FocusModelState>;
+export type FocusModelProviderProps = {
+    children: ReactNode;
+    focusModelPath?: string;
+    focusModelLoadTimeoutMs?: number;
+    focusModelDelegate?: 'CPU' | 'GPU';
+    onFocusModelError?: (error: Error) => void;
+};
+export declare function FocusModelProvider({ children, focusModelPath, focusModelLoadTimeoutMs, focusModelDelegate, onFocusModelError, }: FocusModelProviderProps): React.JSX.Element;
+export {};

package/dist/components/id_capture/IdCapture.d.ts

@@ -60,4 +60,4 @@ export type IdCaptureProps = {
     verbiage?: IdCaptureVerbiage;
     debugMode?: boolean;
 };
-export declare const IdCapture: ({ requiredDocumentType, autoCaptureEnabled, autoCaptureScoreThreshold, autoCaptureGoodFramesRequired, autoCaptureBarcodeRequired, mrzDetectionScoreThreshold, passportPageDetectionThreshold, pdf417DetectionThreshold, focusScoreThreshold, barcodeScanningEnabled, maxBarcodeScanAttempts, guidanceMessage, guidanceSatisfied, onPrediction, onBarcodeScanned, onCapture, assets, classNames, colors, verbiage: rawVerbiage, debugMode, }: IdCaptureProps) => React.ReactElement;
+export declare const IdCapture: ({ requiredDocumentType, autoCaptureEnabled, autoCaptureScoreThreshold, autoCaptureGoodFramesRequired, autoCaptureBarcodeRequired, mrzDetectionScoreThreshold, passportPageDetectionThreshold, pdf417DetectionThreshold, focusScoreThreshold, barcodeScanningEnabled, maxBarcodeScanAttempts, guidanceMessage, guidanceSatisfied, onPrediction, onCapture, assets, classNames, colors, verbiage: rawVerbiage, debugMode, }: IdCaptureProps) => React.ReactElement;

package/dist/components/id_capture/IdCaptureModelsProvider.d.ts

@@ -1,7 +1,8 @@
-import React, { MutableRefObject, ReactElement, ReactNode } from 'react';
-import { DetectedObject, DocumentType } from '../../lib/models/DocumentDetection';
-import { FocusPrediction } from '../../lib/models/Focus';
-import { Frame } from '../../lib/utils/getFrameDimensions';
+import React, { ReactElement, ReactNode } from 'react';
+import { DetectedObject, DetectedObjectBox, DocumentType } from '../../lib/models/DocumentDetection';
+import { DocumentDetectionModelProviderProps, DocumentDetectionThresholds } from './DocumentDetectionModelProvider';
+import { FocusModelProviderProps } from './FocusModelProvider';
+import { FocusThresholds } from '../../lib/models/Focus';
 export type IdCapturePrediction = {
     detectedObjects: DetectedObject[];
     detectionTime: number;
@@ -26,30 +27,23 @@ export type IdCapturePrediction = {
     frameHeight: number;
     allZero: boolean;
 };
-export type IdCaptureThresholds = {
-    document?: number;
-    passport?: number;
-    mrz?: number;
-    pdf417?: number;
-    focus?: {
-        desktop?: number;
-        mobile?: number;
-    };
+export type IdCaptureThresholds = DocumentDetectionThresholds & {
+    focus?: FocusThresholds;
 };
 export type BestFrame = {
     canvas: HTMLCanvasElement;
-    boundingBox?: number[];
+    boundingBox?: DetectedObjectBox;
     detectionScore: number;
     focusScore: number;
 };
 export type IdCaptureModelsState = {
     ready: boolean;
+    start: () => void;
+    stop: () => void;
     modelDownloadProgress: number;
-    working: MutableRefObject<boolean>;
     idModelError: Error | null;
     thresholds: IdCaptureThresholds;
     setThresholds: (value: IdCaptureThresholds) => void;
-    makePrediction: (frame: Frame) => void;
     onPredictionMade: (handler: (prediction: IdCapturePrediction) => void) => void;
     detectionTime: number;
     focusPredictionTime: number;
@@ -63,18 +57,8 @@ export type IdCaptureModelsProviderProps = {
     children: ReactNode;
     documentDetectionModelUrl?: string | undefined;
     focusModelUrl?: string | undefined;
-    logPredictions?: boolean;
     onModelError?: (error: Error) => void;
     modelLoadTimeoutMs?: number;
 };
-export declare const defaultDocumentDetectionModelUrl: string;
-export declare const defaultFocusModelUrl: string;
-export declare const defaultIdCaptureModelLoadTimeoutMs = 45000;
-export declare const IdCaptureModelsProvider: ({ children, documentDetectionModelUrl, focusModelUrl, logPredictions, onModelError, modelLoadTimeoutMs, }: IdCaptureModelsProviderProps) => ReactElement;
-type Canvases = {
-    lastPredictionCanvas: HTMLCanvasElement;
-    cropCanvas: HTMLCanvasElement;
-    rotateCanvas: HTMLCanvasElement;
-};
-export declare function makeFocusPrediction(imageData: Frame, canvases: Canvases, bbox?: number[], logPredictions?: boolean): Promise<[FocusPrediction, number]>;
-export {};
+export declare function IdCaptureModelsProviderInner({ children, onModelError, }: IdCaptureModelsProviderProps): ReactElement;
+export declare function IdCaptureModelsProvider({ children, ...props }: IdCaptureModelsProviderProps & DocumentDetectionModelProviderProps & FocusModelProviderProps): React.JSX.Element;

package/dist/components/selfie_capture/SelfieCapture.d.ts

@@ -1,8 +1,8 @@
 import { ReactElement } from 'react';
 import { FaceCaptureGuideOverlayClassNames } from '../face_liveness/FaceCaptureGuideOverlay';
-import { Face } from './HighPerformanceSelfieGuidanceModelsProvider';
 import { CustomerSuppliedVerbiage } from '../../lib/locales';
 import { SelfieCaptureFallbackClassNames } from '../fallback_flows/SelfieCapture';
+import { Face } from '../../lib/models/FaceDetection';
 export type SelfieCaptureClassNames = {
     container?: string;
     cameraFeed?: string;

package/dist/components/selfie_capture/SelfieGuidanceModelsProvider.d.ts

@@ -1,5 +1,23 @@
-import { ReactElement } from 'react';
+import * as React from 'react';
+import { MutableRefObject, ReactElement, ReactNode } from 'react';
+import { Face } from '../../lib/models/FaceDetection';
+type PredictionHandler = (prediction: Face[]) => void;
+type SelfieGuidanceModelsState = {
+    start: () => void;
+    stop: () => void;
+    onPredictionMade: (handler: PredictionHandler) => void;
+    canvasRef: MutableRefObject<HTMLCanvasElement | null>;
+    ready: boolean;
+    error: Error | null;
+    modelDownloadProgress: number;
+};
+export declare const SelfieGuidanceModelsContext: React.Context<SelfieGuidanceModelsState>;
 export type SelfieGuidanceModelsProviderProps = {
-    children: ReactElement;
+    autoStart?: boolean;
+    children: ReactNode;
+    throttleMs?: number;
+    onModelError?: (error: Error) => void;
+    modelLoadTimeoutMs?: number;
 };
-export declare const SelfieGuidanceModelsProvider: ({ children, }: SelfieGuidanceModelsProviderProps) => ReactElement;
+export declare function SelfieGuidanceModelsProvider({ autoStart, children, throttleMs, onModelError, modelLoadTimeoutMs, }: SelfieGuidanceModelsProviderProps): ReactElement;
+export {};

package/dist/contexts/SubmissionContext.d.ts

@@ -1,4 +1,5 @@
 import { UploadedDocument } from '../components/additional_document_capture/AdditionalDocumentCapture';
+import { DetectedObjectBox } from '../lib/models/DocumentDetection';
 export declare enum SubmissionAction {
     NONE = "NONE",
     ENROLL = "ENROLL",
@@ -80,7 +81,7 @@ export type CaptureAttemptMetadata = {
     operationTime?: number;
     bestDetectionScore?: number;
     bestFocusScore?: number;
-    boundingBox?: number[];
+    boundingBox?: DetectedObjectBox;
 };
 export type PersonalData = {
     uniqueNumber?: string;

package/dist/lib/barcode/Scan.d.ts

@@ -1,3 +1,4 @@
 import { PDF417DetectionResult } from './Native';
+import { DetectedObjectBox } from '../models/DocumentDetection';
 export declare function supportsNativeBarcodeScanning(): boolean;
-export declare function scanBarcode(blob: Blob, bbox?: number[]): Promise<PDF417DetectionResult | null>;
+export declare function scanBarcode(blob: Blob, box?: DetectedObjectBox): Promise<PDF417DetectionResult | null>;

package/dist/lib/models/CapabilityProbing.d.ts

@@ -0,0 +1,11 @@
+type ProbeState = 'notProbed' | 'probing' | 'probed';
+type ModelCapabilities = {
+    probeState: ProbeState;
+    delegate: 'GPU' | 'CPU' | 'NONE';
+    networkSpeed: number;
+    networkTier: 'untested' | 'slow' | 'medium' | 'fast';
+};
+export declare const defaultImageSegmenterModelPath = "https://websdk-cdn-dev.idmission.com/assets/models/selfiesegmenter20240524/selfie_segmenter.tflite";
+export declare const modelCapabilities: ModelCapabilities;
+export declare function probeModelCapabilities(): Promise<void>;
+export {};

package/dist/lib/models/DocumentDetection.d.ts

@@ -1,30 +1,19 @@
-import * as tf from '@tensorflow/tfjs';
+import { ObjectDetector } from '@mediapipe/tasks-vision';
+export declare const defaultDocumentDetectorModelPath = "https://websdk-cdn-dev.idmission.com/assets/models/docdetectmp20240530/model_fp16.tflite";
+export declare const defaultDocumentDetectionModelLoadTimeoutMs = 45000;
 export type DocumentType = 'none' | 'idCard' | 'passport';
-export interface DocumentDetectionModel extends tf.GraphModel {
-    outputPositions: {
-        boxes: number;
-        scores: number;
-        labels: number;
-    };
-}
-export declare let documentDetectionModel: DocumentDetectionModel | null;
-export declare function loadDocumentDetectionModel(url: string): Promise<DocumentDetectionModel>;
-export declare function unloadDocumentDetectionModel(): void;
-export type RawEdgeDetectionResult = tf.Tensor<tf.Rank>[];
-export declare function makeDocumentDetectionPredictions(model: tf.GraphModel, image: ImageBitmap | ImageData | HTMLImageElement): Promise<[RawEdgeDetectionResult, () => void]>;
-export type DocumentDetectionResults = {
-    boxes: number[][];
-    scores: number[];
-    labels: number[];
-};
-export declare const labelMap: {
-    [id: number]: Label;
-};
 export type Label = 'Document' | 'MRZ' | 'PDF417' | 'Primary face' | 'Secondary face' | 'Glare' | 'Punch Hole' | 'Passport Page';
-export declare function runDocumentDetection(model: tf.GraphModel, image: ImageBitmap | ImageData | HTMLImageElement): Promise<DocumentDetectionResults>;
+export type DetectedObjectBox = {
+    xMin: number;
+    xMax: number;
+    yMin: number;
+    yMax: number;
+    width: number;
+    height: number;
+};
 export type DetectedObject = {
-    score: number;
-    bbox: number[];
+    box: DetectedObjectBox;
     label: Label;
+    score: number;
 };
-export declare function bboxToDetectedObjectUnscaled(box: number[], score: number, label: number): DetectedObject;
+export declare function loadDocumentDetector(modelAssetPath: string, scoreThreshold?: number): Promise<ObjectDetector>;

package/dist/lib/models/FaceDetection.d.ts

@@ -1,6 +1,21 @@
-import * as faceDetection from '@tensorflow-models/face-detection';
 import '@mediapipe/face_detection';
-import { Frame } from '../utils/getFrameDimensions';
-export type FaceDetectionModel = faceDetection.FaceDetector;
-export declare function loadFaceDetectionModel(): Promise<FaceDetectionModel>;
-export declare function makeFaceDetectionPrediction(model: FaceDetectionModel, imageData: Frame): Promise<[faceDetection.Face[], number]>;
+import { FaceDetector } from '@mediapipe/tasks-vision';
+export declare const defaultFaceDetectorModelPath = "https://websdk-cdn-dev.idmission.com/assets/models/blazeface20240207/blaze_face_short_range.tflite";
+export declare const defaultSelfieCaptureModelLoadTimeoutMs = 45000;
+export type FaceKeypoint = {
+    x: number;
+    y: number;
+    name: string;
+};
+export type Face = {
+    keypoints: FaceKeypoint[];
+    box: {
+        xMin: number;
+        xMax: number;
+        yMin: number;
+        yMax: number;
+        width: number;
+        height: number;
+    };
+};
+export declare function loadFaceDetector(): Promise<FaceDetector>;

package/dist/lib/models/Focus.d.ts

@@ -1,9 +1,12 @@
-import * as tf from '@tensorflow/tfjs';
-export declare let focusModel: tf.LayersModel | null;
-export declare function loadFocusModel(url: string): Promise<tf.LayersModel>;
-export declare function unloadFocusModel(): void;
-type BlurScore = number;
-type FocusScore = number;
-export type FocusPrediction = [BlurScore, FocusScore];
-export declare function makeFocusPrediction(model: tf.LayersModel, imageData: ImageBitmap | ImageData): Promise<[FocusPrediction, () => void]>;
-export {};
+import { ImageClassifier } from '@mediapipe/tasks-vision';
+export declare const defaultFocusModelPath = "https://websdk-cdn-dev.idmission.com/assets/models/focusmp20240523/model_float16.tflite";
+export declare const defaultFocusModelLoadTimeoutMs = 45000;
+export type FocusPrediction = {
+    score: number;
+    predictionTime: number;
+};
+export type FocusThresholds = {
+    desktop?: number;
+    mobile?: number;
+};
+export declare function loadFocusModel(modelAssetPath: string, delegate?: 'CPU' | 'GPU'): Promise<ImageClassifier>;

package/dist/lib/models/VisionRuntime.d.ts

@@ -0,0 +1,2 @@
+export declare const visionTasksBasePath = "https://cdn.jsdelivr.net/npm/@mediapipe/tasks-vision@0.10.7/wasm";
+export declare function preloadVisionRuntime(): Promise<void>;

package/dist/lib/models/preloadModels.d.ts

@@ -7,8 +7,15 @@ export type PreloadProgress = {
     loaded: number;
     total: number;
 };
+export declare const progressByUseCase: {
+    visionRuntime: PreloadProgress;
+    documentDetection: PreloadProgress;
+    focus: PreloadProgress;
+    faceDetection: PreloadProgress;
+};
 export declare function preloadDependency(url: string): Promise<unknown>;
-export declare function preloadIdCaptureDependencies(): Promise<void>;
+export declare function preloadDocumentDetectorDependencies(): Promise<void>;
+export declare function preloadFocusModelDependencies(): Promise<void>;
 export declare function preloadFaceDetectorDependencies(): Promise<void>;
-export declare function getTfjsModelDependencies(url: string): Promise<string[]>;
 export declare function progressToPercentage(progress: PreloadProgress): number;
+export declare function sumUpProgressForDependencies(dependencies: string[]): PreloadProgress;

package/dist/lib/utils/cropping.d.ts

@@ -1,4 +1,5 @@
-import { Face } from '@tensorflow-models/face-detection';
 import { Frame } from './getFrameDimensions';
+import { DetectedObjectBox } from '../models/DocumentDetection';
+import { Face } from '../models/FaceDetection';
 export declare function cropToShoulders(rawCanvas: HTMLCanvasElement | null, cropCanvas: HTMLCanvasElement | null, frame: ImageData, face: Face): string;
-export declare function cropToBoundingBox(frame: Frame, bbox: number[], canvas?: HTMLCanvasElement): HTMLCanvasElement;
+export declare function cropToDetectedObjectBox(frame: Frame, box: DetectedObjectBox, canvas?: HTMLCanvasElement): HTMLCanvasElement;

package/dist/lib/utils/isMobile.d.ts

@@ -0,0 +1 @@
+export declare function isMobile(nav?: Navigator): any;

package/dist/lib/utils/logger.d.ts

@@ -11,4 +11,6 @@ export declare function debug(...parts: unknown[]): void;
 export declare function log(...parts: unknown[]): void;
 export declare function warn(...parts: unknown[]): void;
 export declare function error(...parts: unknown[]): void;
+export declare function time(label?: string): void;
+export declare function timeEnd(label?: string): void;
 export default log;