idmission-web-sdk 0.0.35 → 0.0.37

package/README.md

@@ -452,3 +452,33 @@ Render a fullscreen capture component that analyzes frames from the user's front
 ```js
 IDmissionSDK.renderCustomerIdentification('#target-element', { submissionToken: 'my-idmission-token' });
 ```
+
+## Other Functionality
+
+### 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.
+
+To delay the submission until some async condition has been met by your application:
+
+```js
+onBeforeSubmit: () => new Promise((resolve) => {
+  // do whatever you want in here, websdk will delay submission until you call:
+  resolve()
+})
+```
+
+Calling `resolve()` without an argument as shown above will result in no modification being made to the request that will be sent to IDmission's servers.
+
+To alter the submission request before it goes out:
+
+```js
+onBeforeSubmit: (req) => new Promise((resolve) => {
+  req.myRandomExtraThing = '123'
+  resolve(req)
+})
+```
+
+Note that you will receive the request as a parameter to `onBeforeSubmit`, and must `resolve` with the altered version in order for your changes to be committed.
+
+If the promise is rejected or an error is thrown, that rejection value or error will be printed to the logs and the request will be sent without any modifications committed.

package/dist/sdk2.cjs.development.js

@@ -395,7 +395,7 @@ var SubmissionProvider = function SubmissionProvider(_a) {
   }, []);
   var submit = React.useCallback(function () {
     return tslib.__awaiter(void 0, void 0, void 0, function () {
-      var submissionResponse_1, submissionRequest_1, metadata, platform, onBeforeSubmitResult, host, endpoint, response, submissionResponse_2, e_1;
+      var submissionResponse_1, submissionRequest_1, metadata, platform, onBeforeSubmitResult, e_1, host, endpoint, response, submissionResponse_2, e_2;
       var _a;
       return tslib.__generator(this, function (_b) {
         switch (_b.label) {
@@ -414,7 +414,7 @@ var SubmissionProvider = function SubmissionProvider(_a) {
             setSubmissionStatus(SubmissionStatus.SUBMITTING);
             _b.label = 1;
           case 1:
-            _b.trys.push([1, 6,, 7]);
+            _b.trys.push([1, 8,, 9]);
             submissionRequest_1 = {
               securityData: {
                 userName: '',
@@ -515,13 +515,20 @@ var SubmissionProvider = function SubmissionProvider(_a) {
               metadata.GeoLocation = JSON.stringify(geolocationResult);
             }
             submissionRequest_1.additionalData.metadata = JSON.stringify(metadata);
-            if (!onBeforeSubmit) return [3, 3];
-            return [4, onBeforeSubmit(submissionRequest_1)];
+            if (!onBeforeSubmit) return [3, 5];
+            _b.label = 2;
           case 2:
+            _b.trys.push([2, 4,, 5]);
+            return [4, onBeforeSubmit(submissionRequest_1)];
+          case 3:
             onBeforeSubmitResult = _b.sent();
             if (onBeforeSubmitResult) submissionRequest_1 = onBeforeSubmitResult;
-            _b.label = 3;
-          case 3:
+            return [3, 5];
+          case 4:
+            e_1 = _b.sent();
+            console.error('onBeforeSubmit was rejected with', e_1);
+            return [3, 5];
+          case 5:
             host = url || determineSubmissionHost(environment, token);
             endpoint = determineSubmissionEndpoint(action, !!(idFrontImage || idBackImage || passportImage), !!selfieImage, !!token);
             return [4, fetch(host + endpoint, {
@@ -529,22 +536,22 @@ var SubmissionProvider = function SubmissionProvider(_a) {
               headers: apiHeaders(token),
               body: JSON.stringify(submissionRequest_1)
             })];
-          case 4:
+          case 6:
             response = _b.sent();
             return [4, response.json()];
-          case 5:
+          case 7:
             submissionResponse_2 = _b.sent();
             setSubmissionRequest(submissionRequest_1);
             setSubmissionResponse(submissionResponse_2);
             setSubmissionStatus(SubmissionStatus.SUBMITTED);
             onResponseReceived === null || onResponseReceived === void 0 ? void 0 : onResponseReceived(submissionResponse_2);
             return [2, submissionResponse_2];
-          case 6:
-            e_1 = _b.sent();
+          case 8:
+            e_2 = _b.sent();
             setSubmissionStatus(SubmissionStatus.FAILED);
-            onRequestFailure === null || onRequestFailure === void 0 ? void 0 : onRequestFailure(e_1);
+            onRequestFailure === null || onRequestFailure === void 0 ? void 0 : onRequestFailure(e_2);
             return [2, null];
-          case 7:
+          case 9:
             return [2];
         }
       });