idmission-web-sdk 1.0.104 → 1.0.105

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

@@ -3,6 +3,7 @@ import { ThemeInput } from '../../themes';
 import { LangOption } from '../../lib/locales';
 import { SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { DocumentCaptureWizardClassNames } from '../document_capture/DocumentCaptureWizard';
+import { CameraFeedMode } from '../document_capture/DocumentCaptureScreen';
 export type DocumentCaptureClassNames = DocumentCaptureWizardClassNames;
 export interface DocumentCaptureProps extends PropsWithChildren {
     /** Language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. */
@@ -11,6 +12,8 @@ export interface DocumentCaptureProps extends PropsWithChildren {
     submissionToken: string;
     /** URL to hit with all API requests. Defaults to the value specified in your decoded `submissionToken`. */
     submissionUrl?: string;
+    /** URL to upload captured documents to via Tus. */
+    documentServiceUrl?: string;
     /** Callback function that fires immediately prior to submission, giving the client application an opportunity to specify custom asynchronous logic that mutates the request before it executes. The submission request is passed in as a parameter and a promise resolving to the updated request should be returned. */
     onBeforeSubmit?: (req: SubmissionRequest) => Promise<SubmissionRequest>;
     /** Callback function that fires when the user has completed the flow instead of making a call to IDmission's servers, allowing customers to specify their own submission logic. Arguments: the request payload that would have been dispatched to IDmission's API, which contains the images/documents/video submitted by the user. Note that when this parameter is supplied, `onComplete` will never fire, and the customer will need to implement their own error handling/retry logic. Use at your own risk! */
@@ -22,6 +25,7 @@ export interface DocumentCaptureProps extends PropsWithChildren {
     /** Callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay. */
     onUserCancel?: () => void;
     aspectRatio?: number;
+    cameraFeedMode?: CameraFeedMode;
     instructions?: ReactNode;
     /** Name of an included theme or object containing theme properties. **/
     theme?: ThemeInput;

package/dist/components/document_capture/DocumentCaptureGuideOverlay.d.ts

@@ -7,7 +7,7 @@ export type DocumentCaptureGuideOverlayProps = {
     borderRadius?: number;
     borderColor?: string;
     borderWidth?: number;
-    maskColor?: string;
+    maskColor: string;
     padding?: number;
     classNames?: DocumentCaptureGuideOverlayClassNames;
 };

package/dist/components/document_capture/DocumentCaptureScreen.d.ts

@@ -0,0 +1,15 @@
+import React, { ReactNode } from 'react';
+export type CameraFeedMode = 'snapToGuides' | 'fullscreen';
+export type DocumentCaptureScreenClassNames = {
+    container?: string;
+    cameraFeed?: string;
+};
+export type DocumentCaptureScreenProps = {
+    aspectRatio?: number;
+    cameraFeedMode?: CameraFeedMode;
+    classNames?: DocumentCaptureScreenClassNames;
+    instructions?: ReactNode;
+    onCaptureClicked?: () => void;
+    onSuccess?: (blob: Blob) => void;
+};
+export declare const DocumentCaptureScreen: ({ aspectRatio, cameraFeedMode, classNames, instructions, onCaptureClicked, onSuccess, }: DocumentCaptureScreenProps) => React.JSX.Element;

package/dist/components/document_capture/DocumentCaptureStateProvider.d.ts

@@ -0,0 +1,68 @@
+import React, { Dispatch, ReactNode } from 'react';
+export type DocumentCaptureState = {
+    initialDrawComplete: boolean;
+    redrawing: boolean;
+    rectX: number;
+    rectY: number;
+    rectWidth: number;
+    rectHeight: number;
+    rectOffsetTop: number;
+    capturing: boolean;
+    imageUrl: string;
+    imageBlob: Blob | null;
+    uploadState: 'not_started' | 'in_progress' | 'succeeded' | 'failed';
+};
+export declare const documentCaptureInitialState: {
+    initialDrawComplete: false;
+    redrawing: false;
+    capturing: false;
+    rectX: number;
+    rectY: number;
+    rectWidth: number;
+    rectHeight: number;
+    rectOffsetTop: number;
+    imageUrl: string;
+    imageBlob: null;
+    uploadState: "not_started";
+};
+export declare const DocumentCaptureStateContext: React.Context<DocumentCaptureState>;
+export type DocumentCaptureAction = {
+    type: 'redrawRequested';
+} | {
+    type: 'redrawInProgress';
+} | {
+    type: 'redrawCompleted';
+    payload: {
+        rectX: number;
+        rectY: number;
+        rectWidth: number;
+        rectHeight: number;
+        rectOffsetTop: number;
+    };
+} | {
+    type: 'captureRequested';
+} | {
+    type: 'captureCompleted';
+    payload: {
+        imageUrl: string;
+        imageBlob: Blob;
+    };
+} | {
+    type: 'retryCapture';
+} | {
+    type: 'uploadStarted';
+} | {
+    type: 'uploadCompleted';
+} | {
+    type: 'uploadFailed';
+};
+export type DocumentCaptureDispatch = Dispatch<DocumentCaptureAction>;
+export declare const DocumentCaptureDispatchContext: React.Context<DocumentCaptureDispatch>;
+export declare const documentCaptureStateReducer: (state: DocumentCaptureState, action: DocumentCaptureAction) => DocumentCaptureState;
+export declare const DocumentCaptureStateProvider: ({ children, }: {
+    children: ReactNode;
+}) => React.JSX.Element;
+export declare const useDocumentCaptureState: () => [
+    DocumentCaptureState,
+    DocumentCaptureDispatch
+];

package/dist/components/document_capture/DocumentCaptureWizard.d.ts

@@ -1,14 +1,13 @@
 import React, { ReactNode } from 'react';
-export type DocumentCaptureWizardClassNames = {
-    container?: string;
-    cameraFeed?: string;
-};
+import { CameraFeedMode, DocumentCaptureScreenClassNames } from './DocumentCaptureScreen';
+export type DocumentCaptureWizardClassNames = DocumentCaptureScreenClassNames;
 export type DocumentCaptureWizardProps = {
     onSuccess?: () => void;
     onExitCapture?: () => void;
     onUserCancel?: () => void;
     aspectRatio?: number;
+    cameraFeedMode?: CameraFeedMode;
     instructions?: ReactNode;
     classNames?: DocumentCaptureWizardClassNames;
 };
-export declare const DocumentCaptureWizard: ({ aspectRatio, instructions, classNames, }: DocumentCaptureWizardProps) => React.JSX.Element;
+export declare const DocumentCaptureWizard: ({ onSuccess, aspectRatio, cameraFeedMode, instructions, classNames, }: DocumentCaptureWizardProps) => React.JSX.Element;

package/dist/components/submission/SubmissionProvider.d.ts

@@ -32,6 +32,7 @@ export type SubmissionState = {
     setIdCaptureVideoIdFrontImage: (image: string) => void;
     setIdCaptureVideoIdBackImage: (image: string) => void;
     setAdditionalDocuments: (uploadedDocuments: UploadedDocument[]) => void;
+    uploadDocument: (blob: Blob) => Promise<string>;
     logIdFrontCaptureAttempt: (attempt: CaptureAttemptMetadata) => void;
     logIdBackCaptureAttempt: (attempt: CaptureAttemptMetadata) => void;
     logSelfieCaptureAttempt: (attempt: CaptureAttemptMetadata) => void;
@@ -68,10 +69,11 @@ export type SubmissionProviderProps = {
     webhooksSendProcessedImages?: boolean;
     webhooksFireOnReview?: boolean;
     precapturedDocuments?: CapturedDocuments;
+    documentServiceUrl?: string;
     onSubmit?: (payload: SubmissionRequest) => void;
     onBeforeSubmit?: (req: SubmissionRequest) => Promise<SubmissionRequest>;
     onBeforeLivenessCheck?: (req: LivenessCheckRequest) => Promise<LivenessCheckRequest>;
     onResponseReceived?: (res: SubmissionResponse, req: SubmissionRequest) => void;
     onRequestFailure?: (err: Error) => void;
 };
-export declare const SubmissionProvider: ({ action, children, url, environment, token, companyId, enrollmentId, personalData, cardData, bypassAgeValidation, bypassNameMatching, needImmediateResponse, manualReviewRequired, idBackImageRequired, idImageResolutionCheck, verifyIdWithExternalDatabases, deduplicationEnabled, deduplicationSynchronous, geolocationEnabled, geolocationRequired, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, webhooksSendInputImages, webhooksSendProcessedImages, webhooksFireOnReview, precapturedDocuments, onSubmit, onBeforeSubmit, onBeforeLivenessCheck, onResponseReceived, onRequestFailure, }: SubmissionProviderProps) => ReactElement;
+export declare const SubmissionProvider: ({ action, children, url, environment, token, companyId, enrollmentId, personalData, cardData, bypassAgeValidation, bypassNameMatching, needImmediateResponse, manualReviewRequired, idBackImageRequired, idImageResolutionCheck, verifyIdWithExternalDatabases, deduplicationEnabled, deduplicationSynchronous, geolocationEnabled, geolocationRequired, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, webhooksSendInputImages, webhooksSendProcessedImages, webhooksFireOnReview, precapturedDocuments, documentServiceUrl, onSubmit, onBeforeSubmit, onBeforeLivenessCheck, onResponseReceived, onRequestFailure, }: SubmissionProviderProps) => ReactElement;

package/dist/sdk2.cjs.development.js

@@ -7,6 +7,7 @@ var React = require('react');
 var ReactDOM = require('react-dom/client');
 var styled = require('styled-components');
 var reactI18next = require('react-i18next');
+var tus = require('tus-js-client');
 var useResizeObserver = require('use-resize-observer');
 var tf = require('@tensorflow/tfjs');
 var LanguageDetector = require('i18next-browser-languagedetector');
@@ -40,15 +41,17 @@ var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
 var React__namespace = /*#__PURE__*/_interopNamespace(React);
 var ReactDOM__namespace = /*#__PURE__*/_interopNamespace(ReactDOM);
 var styled__default = /*#__PURE__*/_interopDefaultLegacy(styled);
+var tus__namespace = /*#__PURE__*/_interopNamespace(tus);
 var useResizeObserver__default = /*#__PURE__*/_interopDefaultLegacy(useResizeObserver);
 var tf__namespace = /*#__PURE__*/_interopNamespace(tf);
 var LanguageDetector__default = /*#__PURE__*/_interopDefaultLegacy(LanguageDetector);
 var i18n__default = /*#__PURE__*/_interopDefaultLegacy(i18n);
 var SignatureCanvas__default = /*#__PURE__*/_interopDefaultLegacy(SignatureCanvas);
 
-var webSdkVersion = '1.0.104';
+var webSdkVersion = '1.0.105';
 
 function getPlatform() {
+  if (typeof window === 'undefined') return;
   // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore
   return window.platform;
@@ -149,7 +152,7 @@ function attachMetadataToRequest(request, _a) {
     back: idBackCaptureAttempts,
     isRealIDCheckRequired: 'false',
     sdkVersion: "WebSDK_".concat(webSdkVersion),
-    Resolution: "".concat(window.innerWidth, " x ").concat(window.innerHeight)
+    Resolution: typeof window !== 'undefined' ? "".concat(window.innerWidth, " x ").concat(window.innerHeight) : 'unknown'
   };
   var platform = getPlatform();
   if (platform) {
@@ -193,6 +196,7 @@ var PageContainer = /*#__PURE__*/React.forwardRef(function (_a, ref) {
     dimensionsCalculated = _c[0],
     setDimensionsCalculated = _c[1];
   React.useEffect(function () {
+    if (typeof window === 'undefined') return;
     setDimensionsCalculated(false);
     var calcAppDimensions = function calcAppDimensions() {
       var doc = document.documentElement;
@@ -663,6 +667,7 @@ var SubmissionContext = /*#__PURE__*/React.createContext({
   setAdditionalDocuments: function setAdditionalDocuments() {
     return null;
   },
+  uploadDocument: Promise.resolve,
   logIdFrontCaptureAttempt: function logIdFrontCaptureAttempt() {
     return null;
   },
@@ -729,6 +734,7 @@ var SubmissionProvider = function SubmissionProvider(_a) {
     _t = _a.webhooksFireOnReview,
     webhooksFireOnReview = _t === void 0 ? false : _t,
     precapturedDocuments = _a.precapturedDocuments,
+    documentServiceUrl = _a.documentServiceUrl,
     onSubmit = _a.onSubmit,
     onBeforeSubmit = _a.onBeforeSubmit,
     onBeforeLivenessCheck = _a.onBeforeLivenessCheck,
@@ -1167,6 +1173,7 @@ var SubmissionProvider = function SubmissionProvider(_a) {
     tokenError = _17[0],
     setTokenError = _17[1];
   React.useEffect(function () {
+    if (typeof window === 'undefined') return;
     (function () {
       return tslib.__awaiter(void 0, void 0, void 0, function () {
         var parsed, iss, publicKey, resp, e_3, valid, parts, e_4, exp;
@@ -1239,6 +1246,42 @@ var SubmissionProvider = function SubmissionProvider(_a) {
       });
     })();
   }, [token]);
+  var uploadDocument = React.useCallback(function (blob) {
+    return new Promise(function (resolve, reject) {
+      var upload = new tus__namespace.Upload(blob, {
+        endpoint: documentServiceUrl,
+        retryDelays: [0, 3000, 5000, 10000, 20000],
+        metadata: {
+          filename: 'My File',
+          filetype: 'image/jpeg'
+        },
+        headers: {
+          Authorization: "Bearer ".concat(token)
+        },
+        onProgress: function onProgress(bytesUploaded, bytesTotal) {
+          var percentage = (bytesUploaded / bytesTotal * 100).toFixed(2);
+          console.log(bytesUploaded, bytesTotal, percentage + '%');
+        },
+        onSuccess: function onSuccess() {
+          console.log('Download from %s', upload.url);
+          resolve(upload.url);
+        },
+        onError: function onError(error) {
+          console.log('Failed because: ' + error);
+          reject(error);
+        }
+      });
+      // Check if there are any previous uploads to continue.
+      upload.findPreviousUploads().then(function (previousUploads) {
+        // Found previous uploads so we select the first one.
+        if (previousUploads.length) {
+          upload.resumeFromPreviousUpload(previousUploads[0]);
+        }
+        // Start the upload
+        upload.start();
+      });
+    });
+  }, [token]);
   var value = {
     submit: submit,
     submissionStatus: submissionStatus,
@@ -1266,6 +1309,7 @@ var SubmissionProvider = function SubmissionProvider(_a) {
     setIdCaptureVideoIdFrontImage: setIdCaptureVideoIdFrontImage,
     setIdCaptureVideoIdBackImage: setIdCaptureVideoIdBackImage,
     setAdditionalDocuments: setAdditionalDocuments,
+    uploadDocument: uploadDocument,
     logIdFrontCaptureAttempt: logIdFrontCaptureAttempt,
     logIdBackCaptureAttempt: logIdBackCaptureAttempt,
     logSelfieCaptureAttempt: logSelfieCaptureAttempt,
@@ -1309,6 +1353,7 @@ function str2ab(str) {
   return buf;
 }
 function importRsaKey(pem) {
+  if (typeof window === 'undefined') throw new Error('window cannot be undefined');
   // fetch the part of the PEM string between header and footer
   var pemHeader = '-----BEGIN PUBLIC KEY-----';
   var pemFooter = '-----END PUBLIC KEY-----';
@@ -10539,7 +10584,7 @@ var CameraVideoTag = function CameraVideoTag(_a) {
     "$isRearFacing": (_b = cameraRef.current) === null || _b === void 0 ? void 0 : _b.isRearFacing
   });
 };
-var FullscreenVideoTag = styled__default['default'].video(templateObject_1$h || (templateObject_1$h = tslib.__makeTemplateObject(["\n  transform: ", ";\n  min-width: 100%;\n  min-height: 100%;\n  width: auto;\n  height: auto;\n  object-fit: cover;\n"], ["\n  transform: ", ";\n  min-width: 100%;\n  min-height: 100%;\n  width: auto;\n  height: auto;\n  object-fit: cover;\n"])), function (props) {
+var FullscreenVideoTag = styled__default['default'].video(templateObject_1$h || (templateObject_1$h = tslib.__makeTemplateObject(["\n  transform: ", ";\n  min-width: 100%;\n  min-height: 100%;\n  width: auto;\n  height: auto;\n  object-fit: cover;\n  background: black;\n"], ["\n  transform: ", ";\n  min-width: 100%;\n  min-height: 100%;\n  width: auto;\n  height: auto;\n  object-fit: cover;\n  background: black;\n"])), function (props) {
   return props.$isRearFacing ? '' : 'scaleX(-1)';
 });
 var templateObject_1$h;
@@ -12795,7 +12840,7 @@ var VideoSignatureCapture = function VideoSignatureCapture(_a) {
     var _b = [cameraRef.current.width, cameraRef.current.height],
       w = _b[0],
       h = _b[1];
-    var isPortrait = window.innerWidth < window.innerHeight;
+    var isPortrait = typeof window !== 'undefined' && window.innerWidth < window.innerHeight;
     var cameraIsLandscape = w > h;
     if (isPortrait && cameraIsLandscape) _a = [h, w], w = _a[0], h = _a[1];
     outputCanvas.current.width = w;
@@ -13305,7 +13350,7 @@ var IdVideoCaptureGuides = function IdVideoCaptureGuides(_a) {
     idBackInstructionText: 'Display the back of your ID card...'
   });
   var instructionText = requestedAction === 'SHOW_ID_FRONT' ? verbiage.idFrontInstructionText : verbiage.idBackInstructionText;
-  var idGuideWidth = window.innerWidth > window.innerHeight ? '30%' : '75%';
+  var idGuideWidth = typeof window !== 'undefined' && window.innerWidth > window.innerHeight ? '30%' : '75%';
   return /*#__PURE__*/React__default['default'].createElement(React__default['default'].Fragment, null, /*#__PURE__*/React__default['default'].createElement("div", {
     style: {
       position: 'absolute',
@@ -13450,7 +13495,7 @@ var ReadTextPromptHeading = styled__default['default'].div(templateObject_2$4 ||
   var _a, _b, _c, _d, _e, _f;
   return ((_c = (_b = (_a = props.theme.idVideoCapture) === null || _a === void 0 ? void 0 : _a.readTextPrompt) === null || _b === void 0 ? void 0 : _b.heading) === null || _c === void 0 ? void 0 : _c.borderRadius) ? "border-radius: ".concat((_f = (_e = (_d = props.theme.idVideoCapture) === null || _d === void 0 ? void 0 : _d.readTextPrompt) === null || _e === void 0 ? void 0 : _e.heading) === null || _f === void 0 ? void 0 : _f.borderRadius, ";") : "";
 });
-var ReadTextPromptText = styled__default['default'].div(templateObject_3$4 || (templateObject_3$4 = tslib.__makeTemplateObject(["\n  margin: 0 auto;\n  text-align: center;\n  padding: 50px;\n  font-size: 24px;\n  max-width: ", ";\n\n  ", ";\n  ", ";\n  ", ";\n"], ["\n  margin: 0 auto;\n  text-align: center;\n  padding: 50px;\n  font-size: 24px;\n  max-width: ", ";\n\n  ", ";\n  ", ";\n  ", ";\n"])), window.innerWidth > window.innerHeight ? '40%' : '90%', function (props) {
+var ReadTextPromptText = styled__default['default'].div(templateObject_3$4 || (templateObject_3$4 = tslib.__makeTemplateObject(["\n  margin: 0 auto;\n  text-align: center;\n  padding: 50px;\n  font-size: 24px;\n  max-width: ", ";\n\n  ", ";\n  ", ";\n  ", ";\n"], ["\n  margin: 0 auto;\n  text-align: center;\n  padding: 50px;\n  font-size: 24px;\n  max-width: ", ";\n\n  ", ";\n  ", ";\n  ", ";\n"])), typeof window !== 'undefined' && window.innerWidth > window.innerHeight ? '40%' : '90%', function (props) {
   var _a, _b, _c, _d, _e, _f;
   return ((_c = (_b = (_a = props.theme.idVideoCapture) === null || _a === void 0 ? void 0 : _a.readTextPrompt) === null || _b === void 0 ? void 0 : _b.prompt) === null || _c === void 0 ? void 0 : _c.backgroundColor) ? "background: ".concat((_f = (_e = (_d = props.theme.idVideoCapture) === null || _d === void 0 ? void 0 : _d.readTextPrompt) === null || _e === void 0 ? void 0 : _e.prompt) === null || _f === void 0 ? void 0 : _f.backgroundColor, ";") : "";
 }, function (props) {