@regulaforensics/idv-capture-web 3.2.253-nightly → 3.2.255-nightly

package/dist/index.d.ts

@@ -215,6 +215,11 @@ declare type FetchState = {
     what?: string;
 };
 
+declare type GeoCoords = {
+    lat: number;
+    lon: number;
+};
+
 declare type GetSessionStateNextStepConditionResult = {
     data?: SessionData;
     error?: BaseWorkflowError;
@@ -242,7 +247,7 @@ declare type IdvBusinessLogicControllerProps = {
     setProcessingTemplate: (workflowSteps: any[]) => void;
     isProcessing: boolean;
     setIsProcessing: (isProcessing: boolean) => void;
-    _pushStep: (stepId: string, data: Record<string, any>) => Promise<{
+    _pushStep: (stepId: string, data: Record<string, any>, type?: PerformType) => Promise<{
         error?: BaseWorkflowError;
     }>;
     _waitingForNextStep: () => Promise<{
@@ -255,7 +260,7 @@ declare type IdvBusinessLogicControllerProps = {
     _stepSocketListenerWhenStepIsRunning: (isStepRunning: boolean) => void;
     _getSessionStateNextStepConditionResult: () => Promise<GetSessionStateNextStepConditionResult>;
     _findStepById: (stepId: string) => WorkflowStep | null;
-    pushStepWaitNextStepAndSet: (data: Record<string, any>) => void;
+    pushStepWaitNextStepAndSet: (data: Record<string, any>, type?: PerformType) => void;
     setNextStep: (workflow: Workflow, properties: SessionPropertiesItem[], nextStepId: string) => void;
     onChangeScreen: (stepId: string | null) => void;
     deinitializationIdv: () => Promise<{
@@ -341,7 +346,12 @@ declare class IdvFetchService {
         };
     } | FetchErrorResult>;
     getConnectionToken(isFromSession: boolean): Promise<string>;
-    startSession(id: string, locale: string, metadata?: Record<string, unknown>): Promise<{
+    startSession({ workflowId, locale, metadata, location, }: {
+        workflowId: string;
+        locale: string;
+        metadata?: Record<string, unknown>;
+        location?: GeoCoords | null;
+    }): Promise<{
         code: FetchResultCode.SUCCESS;
         data: SessionData;
     } | FetchErrorResult>;
@@ -363,7 +373,7 @@ declare class IdvFetchService {
         code: FetchResultCode.SUCCESS;
         data: Workflow;
     } | FetchErrorResult>;
-    pushData(stepId: string, data: any): Promise<{
+    pushData(stepId: string, data: any, type?: PerformType): Promise<{
         code: FetchResultCode.SUCCESS;
         data: Record<string, unknown>;
     } | FetchErrorResult>;
@@ -407,7 +417,12 @@ declare type IdvIntegrationControllerProps = {
     }>;
     getWorkflows: (params?: WorkflowListRequest) => Promise<WorkflowListCompletion>;
     prepareWorkflowAndPrepareUi: (workflowId: string) => Promise<PrepareWorkflowCompletion>;
-    startNewSession: (completion: (data: WorkflowCompletion) => void, locale: string, metadata?: Record<string, unknown>) => Promise<WorkflowCompletion>;
+    startNewSession: (params: {
+        completion: (data: WorkflowCompletion) => void;
+        locale: string;
+        metadata?: Record<string, unknown>;
+        location?: GeoCoords | null;
+    }) => Promise<WorkflowCompletion>;
     playWorkflow: () => void;
     deinitialize: () => Promise<DeinitializeCompletion>;
 };
@@ -441,7 +456,7 @@ export declare type IdvModuleProps<TModuleProps, TModulesConfig> = {
     isProcessing?: (isProcessing: boolean) => void;
     moduleProps: TModuleProps;
     modulesConfig?: TModulesConfig;
-    perform: (data: any) => void;
+    perform: (data: any, type?: PerformType) => void;
     idvEventListener: (module: string, data: any) => void;
 };
 
@@ -523,7 +538,7 @@ export declare class IdvWebComponent extends LitElement {
     constructor();
     _listenerFromModule: (module: string, data: any) => void;
     _isProcessingCallback: (isProcessing: boolean) => void;
-    _performFromModule: (data: any) => void;
+    _performFromModule: (data: any, type?: PerformType) => void;
     _processingScreen(): HTMLElement | TemplateResult<1>;
     private _isTheSameModuleAndScreen;
     _currentScreen(): HTMLElement | typeof nothing;
@@ -560,6 +575,13 @@ declare type LoadedModule = {
 
 export declare type ModuleClass<TModuleProps = unknown, TModulesConfig = unknown> = IdvModuleStaticMethods & (new (...args: any[]) => BaseModule<TModuleProps, TModulesConfig>);
 
+declare type PerformType = (typeof performType)[keyof typeof performType] | undefined;
+
+declare const performType: {
+    readonly FORM: "form";
+    readonly DATA: "data";
+};
+
 export declare type PrepareWorkflowCompletion = {
     workflow?: Workflow;
     error?: BasePrepareWorkflowError;