idmission-web-sdk 1.0.200 → 1.0.201

package/dist/components/CompositeWizard.d.ts

@@ -1,7 +1,7 @@
 import { ReactElement } from 'react';
 import { IdCaptureWizardProps } from './id_capture/IdCaptureWizard';
 import { FaceLivenessWizardProps } from './face_liveness/FaceLivenessWizard';
-import { SubmissionAction, SubmissionEnvironment, SubmissionResponse } from '../contexts/SubmissionContext';
+import { SubmissionAction, SubmissionResponse } from '../contexts/SubmissionContext';
 import { AdditionalDocumentCaptureWizardProps } from './additional_document_capture/AdditionalDocumentCaptureWizard';
 import { SignatureCaptureProps } from './signature_capture/SignatureCapture';
 import { VideoSignatureWizardProps } from './video_signature_capture/VideoSignatureWizard';
@@ -20,10 +20,10 @@ export type CompositeWizardComponentProps = {
     debugMode?: boolean;
 };
 export type CompositeWizardProps = CompositeWizardComponentProps & {
-    submissionToken: string;
+    sessionId: string;
     submissionAction?: SubmissionAction;
-    submissionEnvironment?: SubmissionEnvironment;
     submissionUrl?: string;
+    authUrl?: string;
     onComplete?: (submissionResponse: SubmissionResponse) => void;
 };
 export declare const CompositeWizard: (props: CompositeWizardProps) => ReactElement;

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

@@ -31,10 +31,14 @@ export interface CustomerBiometricsEnrollmentProps extends PropsWithChildren {
     enrollmentId: string;
     /** Language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. */
     lang?: LangOption;
-    /** A token generated with your IDmission credentials. */
-    submissionToken: string;
+    /** A session identifier generated with your IDmission credentials. */
+    sessionId: string | (() => Promise<string>);
     /** URL to hit with all API requests. Defaults to the value specified in your decoded `submissionToken`. */
     submissionUrl?: string;
+    /** URL to validate session against. Defaults to https://portal-api-dev.idmission.com. */
+    authUrl?: string;
+    /** URL to upload captured documents to via Tus. */
+    documentServiceUrl?: string;
     /** Company identifier to include with submission. */
     companyId?: string;
     /** Boolean flag to indicate if validation of the minimum resolution for an ID document image should be triggered. Defaults to true. */

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

@@ -38,10 +38,14 @@ export interface CustomerEnrollmentProps extends PropsWithChildren {
     enrollmentId: string;
     /** Language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. */
     lang?: LangOption;
-    /** A token generated with your IDmission credentials. */
-    submissionToken: string;
+    /** A session identifier generated with your IDmission credentials. */
+    sessionId: string | (() => Promise<string>);
     /** URL to hit with all API requests. Defaults to the value specified in your decoded `submissionToken`. */
     submissionUrl?: string;
+    /** URL to validate session against. Defaults to https://portal-api-dev.idmission.com. */
+    authUrl?: string;
+    /** URL to upload captured documents to via Tus. */
+    documentServiceUrl?: string;
     /** Company identifier to include with submission. */
     companyId?: string;
     /** Boolean flag to indicate if validation of the minimum resolution for an ID document image should be triggered. Defaults to true. */

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

@@ -6,10 +6,14 @@ import { ThemeInput } from '../../themes';
 export interface CustomerIdentificationProps extends PropsWithChildren {
     /** Language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. */
     lang?: LangOption;
-    /** A token generated with your IDmission credentials. */
-    submissionToken: string;
+    /** A session identifier generated with your IDmission credentials. */
+    sessionId: string | (() => Promise<string>);
     /** URL to hit with all API requests. Defaults to the value specified in your decoded `submissionToken`. */
     submissionUrl?: string;
+    /** URL to validate session against. Defaults to https://portal-api-dev.idmission.com. */
+    authUrl?: string;
+    /** URL to upload captured documents to via Tus. */
+    documentServiceUrl?: string;
     /** Company identifier to include with submission. */
     companyId?: string;
     /** Boolean flag to indicate if validation of the minimum resolution for an ID document image should be triggered. Defaults to true. */

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

@@ -8,10 +8,14 @@ export interface CustomerVerificationProps extends PropsWithChildren {
     enrollmentId: string;
     /** Language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. */
     lang?: LangOption;
-    /** A token generated with your IDmission credentials. */
-    submissionToken: string;
+    /** A session identifier generated with your IDmission credentials. */
+    sessionId: string | (() => Promise<string>);
     /** URL to hit with all API requests. Defaults to the value specified in your decoded `submissionToken`. */
     submissionUrl?: string;
+    /** URL to validate session against. Defaults to https://portal-api-dev.idmission.com. */
+    authUrl?: string;
+    /** URL to upload captured documents to via Tus. */
+    documentServiceUrl?: string;
     /** Company identifier to include with submission. */
     companyId?: string;
     /** Boolean flag to indicate if validation of the minimum resolution for an ID document image should be triggered. Defaults to true. */

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

@@ -9,10 +9,12 @@ export type DocumentCaptureVerbiage = DocumentCaptureWizardVerbiage;
 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. */
     lang?: LangOption;
-    /** A token generated with your IDmission credentials. */
-    submissionToken: string;
+    /** A session identifier generated with your IDmission credentials. */
+    sessionId: string | (() => Promise<string>);
     /** URL to hit with all API requests. Defaults to the value specified in your decoded `submissionToken`. */
     submissionUrl?: string;
+    /** URL to validate session against. Defaults to https://portal-api-dev.idmission.com. */
+    authUrl?: 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. */

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

@@ -10,10 +10,14 @@ export type FaceValidationVerbiage = FaceLivenessVerbiage;
 export interface FaceValidationProps extends PropsWithChildren {
     /** Language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. */
     lang?: LangOption;
-    /** A token generated with your IDmission credentials. */
-    submissionToken: string;
+    /** A session identifier generated with your IDmission credentials. */
+    sessionId: string | (() => Promise<string>);
     /** URL to hit with all API requests. Defaults to the value specified in your decoded `submissionToken`. */
     submissionUrl?: string;
+    /** URL to validate session against. Defaults to https://portal-api-dev.idmission.com. */
+    authUrl?: string;
+    /** URL to upload captured documents to via Tus. */
+    documentServiceUrl?: string;
     /** Company identifier to include with submission. */
     companyId?: string;
     /** Boolean flag to indicate if validation of the minimum resolution for an ID document image should be triggered. Defaults to true. */

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

@@ -37,10 +37,14 @@ export type IdAndFaceValidationVerbiage = {
 export interface IdAndFaceValidationProps extends PropsWithChildren {
     /** Language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. */
     lang?: LangOption;
-    /** A token generated with your IDmission credentials. */
-    submissionToken: string;
+    /** A session identifier generated with your IDmission credentials. */
+    sessionId: string | (() => Promise<string>);
     /** URL to hit with all API requests. Defaults to the value specified in your decoded `submissionToken`. */
     submissionUrl?: string;
+    /** URL to validate session against. Defaults to https://portal-api-dev.idmission.com. */
+    authUrl?: string;
+    /** URL to upload captured documents to via Tus. */
+    documentServiceUrl?: string;
     /** Company identifier to include with submission. */
     companyId?: string;
     /** Boolean flag to indicate if validation of the minimum resolution for an ID document image should be triggered. Defaults to true. */

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

@@ -27,10 +27,14 @@ export type IdValidationVerbiage = IdCaptureWizardVerbiage & {
 export interface IdValidationProps extends PropsWithChildren {
     /** Language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. */
     lang?: LangOption;
-    /** A token generated with your IDmission credentials. */
-    submissionToken: string;
+    /** A session identifier generated with your IDmission credentials. */
+    sessionId: string | (() => Promise<string>);
     /** URL to hit with all API requests. Defaults to the value specified in your decoded `submissionToken`. */
     submissionUrl?: string;
+    /** URL to validate session against. Defaults to https://portal-api-dev.idmission.com. */
+    authUrl?: string;
+    /** URL to upload captured documents to via Tus. */
+    documentServiceUrl?: string;
     /** Company identifier to include with submission. */
     companyId?: string;
     /** Boolean flag to indicate if validation of the minimum resolution for an ID document image should be triggered. Defaults to true. */

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

@@ -6,10 +6,14 @@ import { ThemeInput } from '../../themes';
 export interface SignatureKYCProps extends PropsWithChildren {
     /** Language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. */
     lang?: LangOption;
-    /** A token generated with your IDmission credentials. */
-    submissionToken: string;
+    /** A session identifier generated with your IDmission credentials. */
+    sessionId: string | (() => Promise<string>);
     /** URL to hit with all API requests. Defaults to the value specified in your decoded `submissionToken`. */
     submissionUrl?: string;
+    /** URL to validate session against. Defaults to https://portal-api-dev.idmission.com. */
+    authUrl?: 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! */

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

@@ -27,10 +27,14 @@ export type VideoIdValidationVerbiage = VideoIdWizardVerbiage & {
 export interface VideoIdValidationProps extends PropsWithChildren {
     /** Language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. */
     lang?: LangOption;
-    /** A token generated with your IDmission credentials. */
-    submissionToken: string;
+    /** A session identifier generated with your IDmission credentials. */
+    sessionId: string | (() => Promise<string>);
     /** URL to hit with all API requests. Defaults to the value specified in your decoded `submissionToken`. */
     submissionUrl?: string;
+    /** URL to validate session against. Defaults to https://portal-api-dev.idmission.com. */
+    authUrl?: string;
+    /** URL to upload captured documents to via Tus. */
+    documentServiceUrl?: string;
     /** Company identifier to include with submission. */
     companyId?: string;
     /** Boolean flag to indicate if validation of the minimum resolution for an ID document image should be triggered. Defaults to true. */

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

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const AuthUrlNotAllowedOverlay: () => React.JSX.Element;

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

@@ -5,7 +5,7 @@ export declare class SubmissionError extends Error {
 }
 export declare class NetworkError extends Error {
 }
-export declare class TokenPublicKeyError extends Error {
+export declare class SessionValidationFailedError extends Error {
     err: Error;
     host: string;
     constructor(err: Error, host: string);

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

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const SessionIdMissingOverlay: () => React.JSX.Element;

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

@@ -0,0 +1,6 @@
+import React from 'react';
+import { SessionValidationFailedError } from './Errors';
+export declare const SessionValidationErrorOverlay: ({ error, onRetry, }: {
+    error: SessionValidationFailedError | null;
+    onRetry?: (() => void) | undefined;
+}) => React.JSX.Element;

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

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const SessionValidationFailedOverlay: () => React.JSX.Element;

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

@@ -4,7 +4,11 @@ import { UploadedDocument } from '../additional_document_capture/AdditionalDocum
 import { SignatureData } from '../signature_capture/data';
 import { NetworkError, SubmissionError } from './Errors';
 import { CapturedDocuments } from '../id_capture/CapturedDocuments';
-export type TokenState = 'NOT_PARSED' | 'PARSING' | 'GOOD' | 'MISSING' | 'EXPIRED' | 'INVALID_FORMAT' | 'INVALID_SIGNATURE' | 'ISSUER_NOT_ALLOWED' | 'PUBLIC_KEY_LOAD_FAILED';
+export declare const defaultSubmissionUrl = "https://portal-api-dev.idmission.com/swagger";
+type DocumentMetadata = {
+    filename?: string;
+    filetype?: string;
+};
 export type SubmissionState = {
     submit: () => Promise<SubmissionResponse | null>;
     submissionStatus: SubmissionStatus;
@@ -32,7 +36,7 @@ export type SubmissionState = {
     setIdCaptureVideoIdFrontImage: (image: string) => void;
     setIdCaptureVideoIdBackImage: (image: string) => void;
     setAdditionalDocuments: (uploadedDocuments: UploadedDocument[]) => void;
-    uploadDocument: (blob: Blob) => Promise<string>;
+    uploadDocument: (blob: Blob, metadata?: DocumentMetadata) => Promise<string>;
     logIdFrontCaptureAttempt: (attempt: CaptureAttemptMetadata) => void;
     logIdBackCaptureAttempt: (attempt: CaptureAttemptMetadata) => void;
     logSelfieCaptureAttempt: (attempt: CaptureAttemptMetadata) => void;
@@ -44,8 +48,7 @@ export declare const SubmissionContext: React.Context<SubmissionState>;
 export type SubmissionProviderProps = {
     action: SubmissionAction;
     children: ReactElement;
-    token: string;
-    url?: string;
+    submissionUrl?: string;
     environment?: SubmissionEnvironment;
     companyId?: string;
     enrollmentId?: string;
@@ -76,4 +79,5 @@ export type SubmissionProviderProps = {
     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, documentServiceUrl, onSubmit, onBeforeSubmit, onBeforeLivenessCheck, onResponseReceived, onRequestFailure, }: SubmissionProviderProps) => ReactElement;
+export declare const SubmissionProvider: ({ action, children, submissionUrl, environment, 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;
+export {};

package/dist/contexts/AuthStateContext.d.ts

@@ -0,0 +1,33 @@
+import React, { Dispatch, ReactNode } from 'react';
+import { SessionValidationFailedError } from '../components/submission/Errors';
+export declare const defaultAuthUrl = "https://portal-api-dev.idmission.com";
+export declare const allowedAuthUrls: string[];
+export type SessionCheckState = 'READY' | 'RUNNING' | 'PASSED' | 'FAILED' | 'MISSING' | 'AUTH_URL_NOT_ALLOWED' | 'ERROR';
+export type AuthState = {
+    authUrl: string;
+    sessionCheckState: SessionCheckState;
+    sessionId?: string;
+    authError?: SessionValidationFailedError;
+};
+export declare const AuthStateContext: React.Context<AuthState>;
+export type AuthAction = {
+    type: 'setSessionId';
+    payload: string;
+} | {
+    type: 'setCheckState';
+    payload: SessionCheckState;
+} | {
+    type: 'setError';
+    payload: SessionValidationFailedError;
+} | {
+    type: 'retry';
+};
+export type AuthDispatch = Dispatch<AuthAction>;
+export declare const AuthDispatchContext: React.Context<AuthDispatch>;
+export declare function useAuthReducer(authUrl?: string, sessionId?: string | (() => Promise<string>)): [AuthState, AuthDispatch];
+export declare function useAuthContext(): [AuthState, AuthDispatch];
+export declare function AuthProvider({ authUrl, sessionId, children, }: {
+    authUrl?: string;
+    sessionId: string | (() => Promise<string>);
+    children: ReactNode;
+}): React.JSX.Element;

package/dist/contexts/SubmissionContext.d.ts

@@ -156,9 +156,9 @@ export type LiveCheckResponse = {
 };
 export declare function parseJwt(token: string): Record<string, unknown>;
 export declare function determineSubmissionHost(environment: SubmissionEnvironment, token?: string): string;
-export declare function determineSubmissionEndpoint(action: SubmissionAction, hasId: boolean, hasSelfie: boolean, hasToken: boolean): string;
-export declare function liveCheckEndpoint(hasToken: boolean): string;
-export declare function apiHeaders(token?: string): HeadersInit;
+export declare function determineSubmissionEndpoint(action: SubmissionAction, hasId: boolean, hasSelfie: boolean): string;
+export declare function liveCheckEndpoint(): string;
+export declare function apiHeaders(sessionId?: string): HeadersInit;
 export declare function attachMetadataToRequest(request: SubmissionRequest | LivenessCheckRequest, { selfieCaptureAttempts, idFrontCaptureAttempts, idBackCaptureAttempts, geolocationResult, }: {
     selfieCaptureAttempts: CaptureAttemptMetadata[];
     idFrontCaptureAttempts: CaptureAttemptMetadata[];

package/dist/index.d.ts

@@ -12,6 +12,8 @@ import { Theme, themes } from './themes';
 import { SubmissionRequest, SubmissionResponse } from './contexts/SubmissionContext';
 import { DocumentCapture, DocumentCaptureProps } from './components/customer_flows/DocumentCapture';
 import { CapturedDocumentImg } from './components/common/CapturedDocumentImg';
+import { defaultSubmissionUrl } from './components/submission/SubmissionProvider';
+import { defaultAuthUrl, allowedAuthUrls } from './contexts/AuthStateContext';
 type TargetElement = Element | DocumentFragment | string | undefined;
 export declare const renderIdValidation: (optionsOrTargetElement: TargetElement | IdValidationProps, options?: IdValidationProps) => Element | DocumentFragment;
 export declare const renderFaceValidation: (optionsOrTargetElement: TargetElement | FaceValidationProps, options?: FaceValidationProps) => Element | DocumentFragment;
@@ -38,8 +40,12 @@ export type IDmissionSDK = {
     themes: typeof themes;
     version: string;
     ready: boolean;
+    authMode?: 'session';
+    allowedAuthUrls?: string[];
+    defaultAuthUrl?: string;
+    defaultSubmissionUrl?: string;
 };
 declare global {
     var IDmissionSDK: IDmissionSDK;
 }
-export { preloadModels, themes, Theme, IdValidation, FaceValidation, IdAndFaceValidation, CustomerIdAndBiometricsEnrollment, CustomerBiometricsEnrollment, CustomerVerification, CustomerIdentification, SignatureKYC, VideoIdValidation, DocumentCapture, SubmissionRequest, SubmissionResponse, CapturedDocumentImg, };
+export { preloadModels, themes, Theme, IdValidation, FaceValidation, IdAndFaceValidation, CustomerIdAndBiometricsEnrollment, CustomerBiometricsEnrollment, CustomerVerification, CustomerIdentification, SignatureKYC, VideoIdValidation, DocumentCapture, SubmissionRequest, SubmissionResponse, CapturedDocumentImg, allowedAuthUrls, defaultAuthUrl, defaultSubmissionUrl, };

package/dist/lib/utils/dataUrlToBase64.d.ts

@@ -1,3 +1,4 @@
 export declare function dataUrlToBase64(url: string): Promise<string>;
 export declare function dataUrlToBase64Sync(url: string): string;
 export declare function contentDispositionFromDataUrl(url: string): string;
+export declare function b64toBlob(b64Data: string, contentType?: string, sliceSize?: number): Blob;