@microblink/blinkid-in-browser-sdk
Version:
A simple ID scanning library for WebAssembly-enabled browsers.
167 lines (166 loc) • 6.74 kB
JavaScript
/**
* Copyright (c) Microblink Ltd. All rights reserved.
*/
import * as BlinkIDSDK from "../../../es/blinkid-sdk";
/**
* Events
*/
export class EventFatalError {
constructor(code, message, details) {
this.code = code;
this.message = message;
if (details) {
this.details = details;
}
}
}
export class EventReady {
constructor(sdk) {
this.sdk = sdk;
}
}
export class EventScanError {
constructor(code, fatal, message, recognizerName) {
this.code = code;
this.fatal = fatal;
this.message = message;
this.recognizerName = recognizerName;
}
}
export class EventScanSuccess {
constructor(recognizer, recognizerName, successFrame) {
this.recognizer = recognizer;
this.recognizerName = recognizerName;
if (successFrame) {
this.successFrame = successFrame;
}
}
}
/**
* Error codes
*/
export var Code;
(function (Code) {
Code["BrowserNotSupported"] = "BROWSER_NOT_SUPPORTED";
Code["EmptyResult"] = "EMPTY_RESULT";
Code["InvalidRecognizers"] = "INVALID_RECOGNIZERS";
Code["InvalidRecognizerOptions"] = "INVALID_RECOGNIZER_OPTIONS";
Code["MissingLicenseKey"] = "MISSING_LICENSE_KEY";
Code["NoImageFileFound"] = "NO_IMAGE_FILE_FOUND";
Code["SdkLoadFailed"] = "SDK_LOAD_FAILED";
Code["GenericScanError"] = "GENERIC_SCAN_ERROR";
Code["CameraNotAllowed"] = "CAMERA_NOT_ALLOWED";
Code["CameraInUse"] = "CAMERA_IN_USE";
Code["CameraGenericError"] = "CAMERA_GENERIC_ERROR";
Code["InternetNotAvailable"] = "INTERNET_NOT_AVAILABLE";
Code["LicenseError"] = "LICENSE_ERROR";
})(Code || (Code = {}));
/**
* Scan structures
*/
export const AvailableRecognizers = {
IdBarcodeRecognizer: 'createIdBarcodeRecognizer',
BlinkIdRecognizer: 'createBlinkIdRecognizer',
BlinkIdCombinedRecognizer: 'createBlinkIdCombinedRecognizer',
};
export var AnonymizationMode;
(function (AnonymizationMode) {
AnonymizationMode[AnonymizationMode["None"] = BlinkIDSDK.AnonymizationMode.None] = "None";
AnonymizationMode[AnonymizationMode["ImageOnly"] = BlinkIDSDK.AnonymizationMode.ImageOnly] = "ImageOnly";
AnonymizationMode[AnonymizationMode["ResultFieldsOnly"] = BlinkIDSDK.AnonymizationMode.ResultFieldsOnly] = "ResultFieldsOnly";
AnonymizationMode[AnonymizationMode["FullResult"] = BlinkIDSDK.AnonymizationMode.FullResult] = "FullResult";
})(AnonymizationMode || (AnonymizationMode = {}));
export const AvailableRecognizerOptions = {
IdBarcodeRecognizer: [],
BlinkIdRecognizer: [
'returnFullDocumentImage',
'returnFaceImage',
'returnSignatureImage',
'classifierCallback',
'scanCroppedDocumentImage'
],
BlinkIdCombinedRecognizer: [
'returnFullDocumentImage',
'returnFaceImage',
'returnSignatureImage',
'classifierCallback',
'allowSignature'
],
};
export var RecognitionStatus;
(function (RecognitionStatus) {
RecognitionStatus["NoImageFileFound"] = "NoImageFileFound";
RecognitionStatus["Preparing"] = "Preparing";
RecognitionStatus["Processing"] = "Processing";
RecognitionStatus["DetectionFailed"] = "DetectionFailed";
RecognitionStatus["EmptyResultState"] = "EmptyResultState";
RecognitionStatus["OnFirstSideResult"] = "OnFirstSideResult";
RecognitionStatus["ScanSuccessful"] = "ScanSuccessful";
RecognitionStatus["DocumentClassified"] = "DocumentClassified";
// Camera states
RecognitionStatus["DetectionStatusChange"] = "DetectionStatusChange";
RecognitionStatus["NoSupportForMediaDevices"] = "NoSupportForMediaDevices";
RecognitionStatus["CameraNotFound"] = "CameraNotFound";
RecognitionStatus["CameraNotAllowed"] = "CameraNotAllowed";
RecognitionStatus["UnableToAccessCamera"] = "UnableToAccessCamera";
RecognitionStatus["CameraInUse"] = "CameraInUse";
RecognitionStatus["CameraGenericError"] = "CameraGenericError";
// Errors
RecognitionStatus["UnknownError"] = "UnknownError";
// BlinkIDSDK.DetectionStatus
RecognitionStatus["DetectionStatusFail"] = "Fail";
RecognitionStatus["DetectionStatusSuccess"] = "Success";
RecognitionStatus["DetectionStatusCameraTooHigh"] = "CameraTooHigh";
RecognitionStatus["DetectionStatusFallbackSuccess"] = "FallbackSuccess";
RecognitionStatus["DetectionStatusPartial"] = "Partial";
RecognitionStatus["DetectionStatusCameraAtAngle"] = "CameraAtAngle";
RecognitionStatus["DetectionStatusCameraTooNear"] = "CameraTooNear";
RecognitionStatus["DetectionStatusDocumentTooCloseToEdge"] = "DocumentTooCloseToEdge";
})(RecognitionStatus || (RecognitionStatus = {}));
export var CameraExperience;
(function (CameraExperience) {
CameraExperience["Barcode"] = "BARCODE";
CameraExperience["CardCombined"] = "CARD_COMBINED";
CameraExperience["CardSingleSide"] = "CARD_SINGLE_SIDE";
CameraExperience["BlinkCard"] = "BLINKCARD";
})(CameraExperience || (CameraExperience = {}));
export var CameraExperienceState;
(function (CameraExperienceState) {
CameraExperienceState["AdjustAngle"] = "AdjustAngle";
CameraExperienceState["Classification"] = "Classification";
CameraExperienceState["Default"] = "Default";
CameraExperienceState["Detection"] = "Detection";
CameraExperienceState["Done"] = "Done";
CameraExperienceState["DoneAll"] = "DoneAll";
CameraExperienceState["Flip"] = "Flip";
CameraExperienceState["MoveCloser"] = "MoveCloser";
CameraExperienceState["MoveFarther"] = "MoveFarther";
})(CameraExperienceState || (CameraExperienceState = {}));
export const CameraExperienceStateDuration = new Map([
[CameraExperienceState.AdjustAngle, 2500],
[CameraExperienceState.Default, 500],
[CameraExperienceState.Done, 300],
[CameraExperienceState.DoneAll, 400],
[CameraExperienceState.Flip, 3500],
[CameraExperienceState.MoveCloser, 2500],
[CameraExperienceState.MoveFarther, 2500]
]);
export var CameraExperienceReticleAnimation;
(function (CameraExperienceReticleAnimation) {
CameraExperienceReticleAnimation[CameraExperienceReticleAnimation["Default"] = 0] = "Default";
CameraExperienceReticleAnimation[CameraExperienceReticleAnimation["Detection"] = 1] = "Detection";
CameraExperienceReticleAnimation[CameraExperienceReticleAnimation["Classification"] = 2] = "Classification";
})(CameraExperienceReticleAnimation || (CameraExperienceReticleAnimation = {}));
/**
* User feedback structures
*/
export var FeedbackCode;
(function (FeedbackCode) {
FeedbackCode["CameraDisabled"] = "CAMERA_DISABLED";
FeedbackCode["CameraGenericError"] = "CAMERA_GENERIC_ERROR";
FeedbackCode["CameraInUse"] = "CAMERA_IN_USE";
FeedbackCode["CameraNotAllowed"] = "CAMERA_NOT_ALLOWED";
FeedbackCode["GenericScanError"] = "GENERIC_SCAN_ERROR";
FeedbackCode["ScanUnsuccessful"] = "SCAN_UNSUCCESSFUL";
FeedbackCode["ScanSuccessful"] = "SCAN_SUCCESSFUL";
})(FeedbackCode || (FeedbackCode = {}));