idmission-web-sdk 1.0.30 → 1.0.32

package/README.md

@@ -597,6 +597,28 @@ You can also capture this information from the event fired at load time via `e.d
 </script>
 ```
 
+### Preloading the models
+
+If you would like to programmatically issue a command to begin downloading and preparing the models on the client's browser *before* they enter a customer flow, the following method is available:
+```html
+<script type="module">
+    document.addEventListener('idmission-web-sdk.ready', (e) => {
+      IDmissionSDK.preloadModels()
+    })
+</script>
+```
+
+You may specify which models should be loaded and which should be skipped by supplying an object argument, like so:
+```js
+IDmissionSDK.preloadModels({
+  documentDetectionModel: true,
+  focusModel: true,
+  faceDetectionModel: false,
+})
+```
+
+This can be useful if, for example, you know you won't need any flows that depend on face detection.
+
 ### Intercepting (and modifying) API calls to IDmission's backend with `onBeforeSubmit`
 
 Each customer flow documented above includes an optional `onBeforeSubmit` prop, which bears the type signature `(request: SubmissionRequest) => Promise<SubmissionRequest>`. This can be useful if you would like to include some custom functionality that interrupts the WebSDK's outgoing request to IDmission's servers, allowing you a chance to modify the request before it is dispatched.

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

@@ -17,6 +17,10 @@ export interface VideoIdValidationProps extends PropsWithChildren {
     onExitAfterFailure?: (submissionResponse: SubmissionResponse | null) => void;
     idCaptureProps?: IdCaptureWizardProps;
     faceLivenessProps?: FaceLivenessWizardProps;
+    idCardFrontDetectionThreshold?: number;
+    idCardFrontFocusThreshold?: number;
+    goodIdCardFrontFramesThreshold?: number;
+    showIdCardBackDurationMs?: number;
     readTextPrompt?: CustomerSuppliedVerbiage;
     readTextTimeoutDurationMs?: number;
     skipSuccessScreen?: boolean | (() => Promise<boolean>);

package/dist/components/video_id/IdVideoCaptureWizard.d.ts

@@ -26,6 +26,10 @@ export type VideoIdWizardProps = {
     idCaptureProps?: IdCaptureWizardProps;
     faceLivenessProps?: FaceLivenessWizardProps;
     onExitAfterFailure?: (submissionResponse: SubmissionResponse | null) => void;
+    idCardFrontDetectionThreshold?: number;
+    idCardFrontFocusThreshold?: number;
+    goodIdCardFrontFramesThreshold?: number;
+    showIdCardBackDurationMs?: number;
     readTextPrompt?: CustomerSuppliedVerbiage;
     readTextTimeoutDurationMs?: number;
     skipSuccessScreen?: boolean | (() => Promise<boolean>);
@@ -34,4 +38,4 @@ export type VideoIdWizardProps = {
     verbiage?: VideoIdWizardVerbiage;
     debugMode?: boolean;
 };
-export declare const VideoIdWizard: ({ idCaptureProps, faceLivenessProps, onExitAfterFailure, readTextPrompt, readTextTimeoutDurationMs, assets, colors, verbiage, debugMode, }: VideoIdWizardProps) => ReactElement;
+export declare const VideoIdWizard: ({ idCaptureProps, faceLivenessProps, onExitAfterFailure, idCardFrontDetectionThreshold, idCardFrontFocusThreshold, goodIdCardFrontFramesThreshold, showIdCardBackDurationMs, readTextPrompt, readTextTimeoutDurationMs, assets, colors, verbiage, debugMode, }: VideoIdWizardProps) => ReactElement;

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

@@ -1,5 +1,5 @@
-export declare const preloadModels: ({ documentDetectionModel, focusModel, skipFaceDetectionModel, }: {
-    documentDetectionModel?: string | false | undefined;
-    focusModel?: string | false | undefined;
-    skipFaceDetectionModel?: boolean | undefined;
+export declare const preloadModels: ({ documentDetectionModel, focusModel, faceDetectionModel, }: {
+    documentDetectionModel?: string | boolean | undefined;
+    focusModel?: string | boolean | undefined;
+    faceDetectionModel?: boolean | undefined;
 }) => Promise<void>;

package/dist/sdk2.cjs.development.js

@@ -50,7 +50,7 @@ var tf__namespace = /*#__PURE__*/_interopNamespace(tf);
 var useResizeObserver__default = /*#__PURE__*/_interopDefaultLegacy(useResizeObserver);
 var SignatureCanvas__default = /*#__PURE__*/_interopDefaultLegacy(SignatureCanvas);
 
-var webSdkVersion = '1.0.30';
+var webSdkVersion = '1.0.32';
 
 function getPlatform() {
   return window.platform;
@@ -14434,7 +14434,7 @@ var IdVideoCapture = function IdVideoCapture(_a) {
     _k = _a.goodIdCardFrontFramesThreshold,
     goodIdCardFrontFramesThreshold = _k === void 0 ? 3 : _k,
     _l = _a.showIdCardBackDurationMs,
-    showIdCardBackDurationMs = _l === void 0 ? 3000 : _l,
+    showIdCardBackDurationMs = _l === void 0 ? 5000 : _l,
     readTextPrompt = _a.readTextPrompt,
     _m = _a.readTextTimeoutDurationMs,
     readTextTimeoutDurationMs = _m === void 0 ? 15000 : _m,
@@ -14713,6 +14713,10 @@ var VideoIdWizard = function VideoIdWizard(_a) {
     _g = _a.faceLivenessProps,
     faceLivenessProps = _g === void 0 ? {} : _g,
     onExitAfterFailure = _a.onExitAfterFailure,
+    idCardFrontDetectionThreshold = _a.idCardFrontDetectionThreshold,
+    idCardFrontFocusThreshold = _a.idCardFrontFocusThreshold,
+    goodIdCardFrontFramesThreshold = _a.goodIdCardFrontFramesThreshold,
+    showIdCardBackDurationMs = _a.showIdCardBackDurationMs,
     readTextPrompt = _a.readTextPrompt,
     readTextTimeoutDurationMs = _a.readTextTimeoutDurationMs,
     _h = _a.assets,
@@ -14823,6 +14827,10 @@ var VideoIdWizard = function VideoIdWizard(_a) {
           key: "id-video-capture-".concat(attempt),
           onComplete: onVideoCaptureComplete,
           onFaceNotDetected: onVideoCaptureFaceNotDetected,
+          idCardFrontDetectionThreshold: idCardFrontDetectionThreshold,
+          idCardFrontFocusThreshold: idCardFrontFocusThreshold,
+          goodIdCardFrontFramesThreshold: goodIdCardFrontFramesThreshold,
+          showIdCardBackDurationMs: showIdCardBackDurationMs,
           readTextPrompt: readTextPrompt,
           readTextTimeoutDurationMs: readTextTimeoutDurationMs,
           assets: assets.idVideoCapture,
@@ -14855,6 +14863,10 @@ var VideoIdValidation = function VideoIdValidation(_a) {
     onExitAfterFailure = _a.onExitAfterFailure,
     idCaptureProps = _a.idCaptureProps,
     faceLivenessProps = _a.faceLivenessProps,
+    idCardFrontDetectionThreshold = _a.idCardFrontDetectionThreshold,
+    idCardFrontFocusThreshold = _a.idCardFrontFocusThreshold,
+    goodIdCardFrontFramesThreshold = _a.goodIdCardFrontFramesThreshold,
+    showIdCardBackDurationMs = _a.showIdCardBackDurationMs,
     readTextPrompt = _a.readTextPrompt,
     readTextTimeoutDurationMs = _a.readTextTimeoutDurationMs,
     _c = _a.skipSuccessScreen,
@@ -14876,6 +14888,10 @@ var VideoIdValidation = function VideoIdValidation(_a) {
   }, /*#__PURE__*/React__default['default'].createElement(VideoIdWizard, {
     idCaptureProps: idCaptureProps,
     faceLivenessProps: faceLivenessProps,
+    idCardFrontDetectionThreshold: idCardFrontDetectionThreshold,
+    idCardFrontFocusThreshold: idCardFrontFocusThreshold,
+    goodIdCardFrontFramesThreshold: goodIdCardFrontFramesThreshold,
+    showIdCardBackDurationMs: showIdCardBackDurationMs,
     readTextPrompt: readTextPrompt,
     readTextTimeoutDurationMs: readTextTimeoutDurationMs,
     onExitAfterFailure: onExitAfterFailure,
@@ -14886,28 +14902,30 @@ var VideoIdValidation = function VideoIdValidation(_a) {
 
 var preloadModels = function preloadModels(_a) {
   var _b = _a.documentDetectionModel,
-    documentDetectionModel = _b === void 0 ? "".concat(DEFAULT_CDN_URL, "/models/documentdetection448/model.json") : _b,
+    documentDetectionModel = _b === void 0 ? true : _b,
     _c = _a.focusModel,
-    focusModel = _c === void 0 ? "".concat(DEFAULT_CDN_URL, "/models/focus/model.json") : _c,
-    _d = _a.skipFaceDetectionModel,
-    skipFaceDetectionModel = _d === void 0 ? false : _d;
+    focusModel = _c === void 0 ? true : _c,
+    _d = _a.faceDetectionModel,
+    faceDetectionModel = _d === void 0 ? true : _d;
   return tslib.__awaiter(void 0, void 0, void 0, function () {
     return tslib.__generator(this, function (_e) {
       switch (_e.label) {
         case 0:
           if (!documentDetectionModel) return [3, 2];
+          if (documentDetectionModel === true) documentDetectionModel = "".concat(DEFAULT_CDN_URL, "/models/documentdetection448/model.json");
           return [4, loadDocumentDetectionModel(documentDetectionModel)];
         case 1:
           _e.sent();
           _e.label = 2;
         case 2:
           if (!focusModel) return [3, 4];
+          if (focusModel === true) focusModel = "".concat(DEFAULT_CDN_URL, "/models/focus/model.json");
           return [4, loadFocusModel(focusModel)];
         case 3:
           _e.sent();
           _e.label = 4;
         case 4:
-          if (!!skipFaceDetectionModel) return [3, 6];
+          if (!faceDetectionModel) return [3, 6];
           return [4, loadHighPerformanceFaceDetector()];
         case 5:
           _e.sent();