@regulaforensics/idv-capture-web 3.1.231 → 3.2.233-nightly

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -28,7 +28,7 @@ declare class BaseDeinitializationError extends BaseError {
28
28
  });
29
29
  }
30
30
 
31
- declare class BaseError {
31
+ export declare class BaseError {
32
32
  errorCode: number | string;
33
33
  errorCodeKey: string;
34
34
  message?: string;
@@ -68,6 +68,11 @@ declare class BaseInitializationError extends BaseError {
68
68
  });
69
69
  }
70
70
 
71
+ export declare abstract class BaseModule<TModuleProps = unknown, TModulesConfig = unknown> extends HTMLElement {
72
+ abstract props: IdvModuleProps<TModuleProps, TModulesConfig> | null;
73
+ abstract setProps(config: IdvModuleProps<TModuleProps, TModulesConfig>): void;
74
+ }
75
+
71
76
  declare class BasePrepareWorkflowError extends BaseError {
72
77
  private static readonly MODULE;
73
78
  private static readonly ERROR_ENUM_NAME;
@@ -167,6 +172,23 @@ export declare type IdvMessageEvent = {
167
172
  message?: IdvServiceMessages;
168
173
  };
169
174
 
175
+ export declare type IdvModuleProps<TModuleProps, TModulesConfig> = {
176
+ isProcessing?: (isProcessing: boolean) => void;
177
+ moduleProps: TModuleProps;
178
+ modulesConfig?: TModulesConfig;
179
+ perform: (data: any) => void;
180
+ idvEventListener: (module: string, data: any) => void;
181
+ };
182
+
183
+ export declare interface IdvModuleStaticMethods {
184
+ displayName: string;
185
+ isReady(): boolean;
186
+ getSupportedTemplates(): string[];
187
+ initialize(modulesConfig: Record<string, unknown>): void;
188
+ deinitialize(): void;
189
+ getIdentifier(): string;
190
+ }
191
+
170
192
  export declare enum IdvServiceMessages {
171
193
  DID_START_SESSION = "DID_START_SESSION",
172
194
  DID_END_SESSION = "DID_END_SESSION",
@@ -205,6 +227,8 @@ export declare enum InitializeError {
205
227
  INITIALIZATION_IN_PROGRESS = 2
206
228
  }
207
229
 
230
+ export declare type ModuleClass<TModuleProps = unknown, TModulesConfig = unknown> = IdvModuleStaticMethods & (new (...args: any[]) => BaseModule<TModuleProps, TModulesConfig>);
231
+
208
232
  export declare type PrepareWorkflowCompletion = {
209
233
  workflow?: Workflow;
210
234
  error?: BasePrepareWorkflowError;
@@ -218,6 +242,8 @@ export declare enum PrepareWorkflowError {
218
242
  SCENARIO_IN_PROGRESS = 4
219
243
  }
220
244
 
245
+ export declare function registerModule<TModuleProps = unknown, TModulesConfig = unknown>(name: string, ModuleClass: ModuleClass<TModuleProps, TModulesConfig>): void;
246
+
221
247
  export declare enum SessionError {
222
248
  HTTP_ISSUE = 0,
223
249
  PROVIDER_ERROR = 1,