idmission-web-sdk 0.0.16 → 0.0.18

package/README.md

@@ -53,7 +53,6 @@ Render a fullscreen ID capture component that instructs the user to photograph b
 <tr><td><code>captureSignature</code> (optional)</td><td>boolean indicating whether the user should be prompted to sign the screen before submission. Defaults to false.</td></tr>
 <tr><td><code>captureSignatureVideo</code> (optional)</td><td>boolean indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to false.</td></tr>
 <tr><td><code>captureAdditionalDocuments</code> (optional)</td><td>array of additional documents to be captured. Each element includes a name and description.</td></tr>
-<tr><td><code>documentDetectionNonMaxSuppressionEnabled</code> (optional)</td><td>boolean to indicate whether to remove document predictions below the max score.</td></tr>
 <tr><td><code>idAutoCaptureEnabled</code> (optional)</td><td>boolean to indicate whether photos should be captured automatically when guidance conditions are met. Default is `true`.</td></tr>
 <tr><td><code>idCardAutoCaptureScoreThreshold</code> (optional)</td><td>number between 0 and 1 at which document detection guidance score condition is considered to be met for ID cards.</td></tr>
 <tr><td><code>passportAutoCaptureScoreThreshold</code> (optional)</td><td>number between 0 and 1 at which document detection guidance score condition is considered to be met for passports.</td></tr>
@@ -213,7 +212,6 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 <tr><td><code>captureSignatureVideo</code> (optional)</td><td>boolean indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to false.</td></tr>
 <tr><td><code>captureAdditionalDocuments</code> (optional)</td><td>array of additional documents to be captured. Each element includes a name and description.</td></tr>
 <tr><td><code>lang</code> (optional)</td><td>language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto.</td></tr>
-<tr><td><code>documentDetectionNonMaxSuppressionEnabled</code> (optional)</td><td>boolean to indicate whether to remove document predictions below the max score.</td></tr>
 <tr><td><code>idAutoCaptureEnabled</code> (optional)</td><td>boolean to indicate whether photos should be captured automatically when guidance conditions are met. Default is `true`.</td></tr>
 <tr><td><code>idCardAutoCaptureScoreThreshold</code> (optional)</td><td>number between 0 and 1 at which document detection guidance score condition is considered to be met for ID cards.</td></tr>
 <tr><td><code>passportAutoCaptureScoreThreshold</code> (optional)</td><td>number between 0 and 1 at which document detection guidance score condition is considered to be met for passports.</td></tr>
@@ -262,7 +260,6 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 <tr><td><code>captureSignatureVideo</code> (optional)</td><td>boolean indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to false.</td></tr>
 <tr><td><code>captureAdditionalDocuments</code> (optional)</td><td>array of additional documents to be captured. Each element includes a name and description.</td></tr>
 <tr><td><code>lang</code> (optional)</td><td>language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto.</td></tr>
-<tr><td><code>documentDetectionNonMaxSuppressionEnabled</code> (optional)</td><td>boolean to indicate whether to remove document predictions below the max score.</td></tr>
 <tr><td><code>idAutoCaptureEnabled</code> (optional)</td><td>boolean to indicate whether photos should be captured automatically when guidance conditions are met. Default is `true`.</td></tr>
 <tr><td><code>idCardAutoCaptureScoreThreshold</code> (optional)</td><td>number between 0 and 1 at which document detection guidance score condition is considered to be met for ID cards.</td></tr>
 <tr><td><code>passportAutoCaptureScoreThreshold</code> (optional)</td><td>number between 0 and 1 at which document detection guidance score condition is considered to be met for passports.</td></tr>

package/dist/components/customer_flows/CustomerIdAndBiometricsEnrollment.d.ts

@@ -11,7 +11,6 @@ export type CustomerEnrollmentProps = {
     submissionToken: string;
     submissionEnvironment?: SubmissionEnvironment;
     submissionUrl?: string;
-    documentDetectionNonMaxSuppressionEnabled?: boolean;
     idAutoCaptureEnabled?: boolean;
     idCardAutoCaptureScoreThreshold?: number;
     mrzDetectionScoreThreshold?: number;
@@ -35,4 +34,4 @@ export type CustomerEnrollmentProps = {
     geolocationRequired?: boolean;
     debugMode?: boolean;
 };
-export declare const CustomerIdAndBiometricsEnrollment: ({ enrollmentId, lang, submissionToken, submissionEnvironment, submissionUrl, documentDetectionNonMaxSuppressionEnabled, idAutoCaptureEnabled, idCardAutoCaptureScoreThreshold, mrzDetectionScoreThreshold, passportAutoCaptureScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, idCaptureAssets, idCaptureVerbiage, faceLivenessTimeoutDurationMs, faceLivenessAssets, faceLivenessVerbiage, onBeforeSubmit, onComplete, onEnrolled, onDenied, onExitAfterFailure, captureSignature, captureSignatureVideo, captureAdditionalDocuments, geolocationEnabled, geolocationRequired, debugMode, }: CustomerEnrollmentProps) => ReactElement;
+export declare const CustomerIdAndBiometricsEnrollment: ({ enrollmentId, lang, submissionToken, submissionEnvironment, submissionUrl, idAutoCaptureEnabled, idCardAutoCaptureScoreThreshold, mrzDetectionScoreThreshold, passportAutoCaptureScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, idCaptureAssets, idCaptureVerbiage, faceLivenessTimeoutDurationMs, faceLivenessAssets, faceLivenessVerbiage, onBeforeSubmit, onComplete, onEnrolled, onDenied, onExitAfterFailure, captureSignature, captureSignatureVideo, captureAdditionalDocuments, geolocationEnabled, geolocationRequired, debugMode, }: CustomerEnrollmentProps) => ReactElement;

package/dist/components/customer_flows/IdAndFaceValidation.d.ts

@@ -10,7 +10,6 @@ export type IdAndFaceValidationProps = {
     submissionToken: string;
     submissionEnvironment?: SubmissionEnvironment;
     submissionUrl?: string;
-    documentDetectionNonMaxSuppressionEnabled?: boolean;
     idAutoCaptureEnabled?: boolean;
     idCardAutoCaptureScoreThreshold?: number;
     mrzDetectionScoreThreshold?: number;
@@ -34,4 +33,4 @@ export type IdAndFaceValidationProps = {
     geolocationRequired?: boolean;
     debugMode?: boolean;
 };
-export declare const IdAndFaceValidation: ({ lang, submissionToken, submissionEnvironment, submissionUrl, documentDetectionNonMaxSuppressionEnabled, idAutoCaptureEnabled, idCardAutoCaptureScoreThreshold, mrzDetectionScoreThreshold, passportAutoCaptureScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, idCaptureAssets, idCaptureVerbiage, faceLivenessTimeoutDurationMs, faceLivenessAssets, faceLivenessVerbiage, onBeforeSubmit, onComplete, onApproved, onDenied, onExitAfterFailure, captureSignature, captureSignatureVideo, captureAdditionalDocuments, geolocationEnabled, geolocationRequired, debugMode, }: IdAndFaceValidationProps) => ReactElement;
+export declare const IdAndFaceValidation: ({ lang, submissionToken, submissionEnvironment, submissionUrl, idAutoCaptureEnabled, idCardAutoCaptureScoreThreshold, mrzDetectionScoreThreshold, passportAutoCaptureScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, idCaptureAssets, idCaptureVerbiage, faceLivenessTimeoutDurationMs, faceLivenessAssets, faceLivenessVerbiage, onBeforeSubmit, onComplete, onApproved, onDenied, onExitAfterFailure, captureSignature, captureSignatureVideo, captureAdditionalDocuments, geolocationEnabled, geolocationRequired, debugMode, }: IdAndFaceValidationProps) => ReactElement;

package/dist/components/customer_flows/IdValidation.d.ts

@@ -11,7 +11,6 @@ export type IdValidationProps = {
     submissionToken: string;
     submissionEnvironment?: SubmissionEnvironment;
     submissionUrl?: string;
-    documentDetectionNonMaxSuppressionEnabled?: boolean;
     idAutoCaptureEnabled?: boolean;
     idCardAutoCaptureScoreThreshold?: number;
     passportAutoCaptureScoreThreshold?: number;
@@ -30,4 +29,4 @@ export type IdValidationProps = {
     geolocationRequired?: boolean;
     debugMode?: boolean;
 };
-export declare const IdValidation: ({ lang, submissionToken, submissionEnvironment, submissionUrl, documentDetectionNonMaxSuppressionEnabled, idAutoCaptureEnabled, idCardAutoCaptureScoreThreshold, passportAutoCaptureScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, onBeforeSubmit, onComplete, onApproved, onDenied, assets, verbiage, captureSignature, captureSignatureVideo, captureAdditionalDocuments, geolocationEnabled, geolocationRequired, debugMode, }: IdValidationProps) => ReactElement;
+export declare const IdValidation: ({ lang, submissionToken, submissionEnvironment, submissionUrl, idAutoCaptureEnabled, idCardAutoCaptureScoreThreshold, passportAutoCaptureScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, onBeforeSubmit, onComplete, onApproved, onDenied, assets, verbiage, captureSignature, captureSignatureVideo, captureAdditionalDocuments, geolocationEnabled, geolocationRequired, debugMode, }: IdValidationProps) => ReactElement;

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

@@ -22,7 +22,6 @@ export type IdCaptureVerbiage = {
     captureFailedText?: string;
 };
 export type IdCaptureProps = {
-    documentDetectionNonMaxSuppressionEnabled: boolean;
     requiredDocumentType?: DocumentType;
     autoCaptureEnabled?: boolean;
     autoCaptureScoreThreshold?: number;
@@ -43,4 +42,4 @@ export type IdCaptureProps = {
     verbiage?: IdCaptureVerbiage;
     debugMode?: boolean;
 };
-export declare const IdCapture: ({ documentDetectionNonMaxSuppressionEnabled, requiredDocumentType, autoCaptureEnabled, autoCaptureScoreThreshold, autoCaptureGoodFramesRequired, autoCaptureBarcodeRequired, mrzDetectionScoreThreshold, passportPageDetectionThreshold, pdf417DetectionThreshold, focusScoreThreshold, barcodeScanningEnabled, maxBarcodeScanAttempts, onPrediction, onBarcodeScanned, onCapture, processingScreen, processingDelay, assets, verbiage, debugMode, }: IdCaptureProps) => React.ReactElement;
+export declare const IdCapture: ({ requiredDocumentType, autoCaptureEnabled, autoCaptureScoreThreshold, autoCaptureGoodFramesRequired, autoCaptureBarcodeRequired, mrzDetectionScoreThreshold, passportPageDetectionThreshold, pdf417DetectionThreshold, focusScoreThreshold, barcodeScanningEnabled, maxBarcodeScanAttempts, onPrediction, onBarcodeScanned, onCapture, processingScreen, processingDelay, assets, verbiage, debugMode, }: IdCaptureProps) => React.ReactElement;

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

@@ -39,7 +39,6 @@ export type IdCaptureSubmission = {
 };
 export type IdCaptureWizardProps = {
     onSuccess?: (submission: IdCaptureSubmission) => void;
-    documentDetectionNonMaxSuppressionEnabled?: boolean;
     autoCaptureEnabled?: boolean;
     autoCaptureGoodFramesRequired?: number;
     autoCaptureBarcodeRequired?: 'mobile' | boolean;
@@ -53,4 +52,4 @@ export type IdCaptureWizardProps = {
     assets?: IdCaptureAssets;
     debugMode?: boolean;
 };
-export declare const IdCaptureWizard: ({ onSuccess, documentDetectionNonMaxSuppressionEnabled, autoCaptureEnabled, autoCaptureGoodFramesRequired, autoCaptureBarcodeRequired, barcodeScanningEnabled, idCardAutoCaptureScoreThreshold, passportAutoCaptureScoreThreshold, mrzDetectionScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, assets, verbiage, debugMode, }: IdCaptureWizardProps) => ReactElement;
+export declare const IdCaptureWizard: ({ onSuccess, autoCaptureEnabled, autoCaptureGoodFramesRequired, autoCaptureBarcodeRequired, barcodeScanningEnabled, idCardAutoCaptureScoreThreshold, passportAutoCaptureScoreThreshold, mrzDetectionScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, assets, verbiage, debugMode, }: IdCaptureWizardProps) => ReactElement;

package/dist/contexts/IdCaptureModelsContext.d.ts

@@ -7,5 +7,7 @@ export type IdCaptureModelsState = {
     onPredictionMade: (handler: (prediction: Prediction) => void) => void;
     documentDetectionPredictionTime: number;
     focusPredictionTime: number;
+    getBestFrame: () => Promise<Blob | null>;
+    resetBestFrame: () => void;
 };
 export declare const IdCaptureModelsContext: import("react").Context<IdCaptureModelsState>;

package/dist/lib/tfworker/Actions.d.ts

@@ -1,4 +1,4 @@
-import { DocumentDetectionResults } from '../models/DocumentDetection';
+import { DetectedObject } from '../models/DocumentDetection';
 import { FocusPrediction } from '../models/Focus';
 export type Action = {
     type: 'loadModel';
@@ -24,6 +24,7 @@ export type Action = {
 };
 export type Prediction = {
     image: ImageBitmap;
-    documentDetection: DocumentDetectionResults;
+    detectedObjects: DetectedObject[];
+    detectionScore: number;
     focus: FocusPrediction;
 };