idmission-web-sdk 1.0.31 → 1.0.34

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/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.31';
+var webSdkVersion = '1.0.34';
 
 function getPlatform() {
   return window.platform;
@@ -14902,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();