@regulaforensics/idv-gui 2.5.192-nightly → 2.5.195

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
@@ -1,35 +1,3 @@
1
- import { JSX as JSX_2 } from 'react/jsx-runtime';
2
-
3
- declare function AgeIcon({ size }: {
4
- size?: number;
5
- color?: string;
6
- }): JSX_2.Element;
7
-
8
- declare function AndroidIcon({ size, color }: {
9
- size?: number;
10
- color?: string;
11
- }): JSX_2.Element;
12
-
13
- declare function ArrowIcon({ size }: {
14
- size?: number;
15
- color?: string;
16
- }): JSX_2.Element;
17
-
18
- declare function BackIcon({ size }: {
19
- size?: number;
20
- color?: string;
21
- }): JSX_2.Element;
22
-
23
- declare abstract class BaseModule<TModuleProps = unknown, TModulesConfig = unknown> extends HTMLElement {
24
- abstract props: IdvModuleProps<TModuleProps, TModulesConfig> | null;
25
- abstract setProps(config: IdvModuleProps<TModuleProps, TModulesConfig>): void;
26
- }
27
-
28
- declare function BiometricIcon({ size }: {
29
- size?: number;
30
- color?: string;
31
- }): JSX_2.Element;
32
-
33
1
  declare const ContentMode: {
34
2
  readonly ASPECT_FILL: "ASPECT_FILL";
35
3
  readonly ASPECT_FIT: "ASPECT_FIT";
@@ -46,42 +14,9 @@ declare const DATA_SOURCE_ANSWER_TYPE: {
46
14
 
47
15
  declare type DATA_SOURCE_ANSWER_TYPE = (typeof DATA_SOURCE_ANSWER_TYPE)[keyof typeof DATA_SOURCE_ANSWER_TYPE];
48
16
 
49
- declare type DropdownControl = {
50
- backgroundColor?: string;
51
- cornerRadius?: number;
52
- borderWidth?: number;
53
- borderColor?: string;
54
- highlightBorderColor?: string;
55
- clearButton?: UIImage;
56
- expandButton?: UIImage;
57
- };
58
-
59
- declare function ErrorIcon({ size, color }: {
60
- size?: number;
61
- color?: string;
62
- }): JSX_2.Element;
63
-
64
- declare class GuiIdv extends BaseModule<GuiModuleProps, GuiModuleConfig> {
65
- private _root;
66
- private _mounted;
67
- props: IdvModuleProps<GuiModuleProps, GuiModuleConfig> | null;
68
- constructor();
69
- static displayName: string;
70
- setProps(props: IdvModuleProps<GuiModuleProps, GuiModuleConfig>): void;
71
- connectedCallback(): void;
72
- private render;
73
- disconnectedCallback(): void;
74
- static isReady(): boolean;
75
- static getSupportedTemplates: () => ("INFO" | "INFO_DETAILS" | "STATUS" | "PROGRESS" | "QUESTIONS")[];
76
- static initialize(modulesConfig: Record<string, unknown>): void;
77
- static deinitialize(): void;
78
- static getIdentifier: () => string;
79
- }
80
- export { GuiIdv }
17
+ declare const GuiIdv: React.FC<IdvModuleProps<GuiModuleProps | GuiModulePropsUnknown, GuiModuleConfig>> & IdvModuleMethods;
81
18
  export default GuiIdv;
82
19
 
83
- export declare const GuiIdvReactComponent: React.FC<IdvModuleProps<GuiModuleProps | GuiModulePropsUnknown, GuiModuleConfig>>;
84
-
85
20
  export declare const GuiIdvSteps: {
86
21
  readonly INFO: "INFO";
87
22
  readonly INFO_DETAILS: "INFO_DETAILS";
@@ -92,10 +27,6 @@ export declare const GuiIdvSteps: {
92
27
 
93
28
  export declare type GuiIdvSteps = (typeof GuiIdvSteps)[keyof typeof GuiIdvSteps];
94
29
 
95
- export declare const GuiIdvStyleInjectionWrapper: React.FC<{
96
- children: React.ReactNode;
97
- }>;
98
-
99
30
  declare type GuiModuleConfig = Record<string, any>;
100
31
 
101
32
  export declare const GuiModuleError: {
@@ -165,82 +96,22 @@ export declare const IDV_UI_ICONS: {
165
96
 
166
97
  export declare type IDV_UI_ICONS = (typeof IDV_UI_ICONS)[keyof typeof IDV_UI_ICONS];
167
98
 
168
- export declare const idvIconComponents: {
169
- warning_icon: typeof WarningIcon;
170
- spinner: ({ indicatorColor }: {
171
- indicatorColor?: string;
172
- }) => JSX_2.Element;
173
- failure: typeof ErrorIcon;
174
- age: typeof AgeIcon;
175
- android: typeof AndroidIcon;
176
- arrow: typeof ArrowIcon;
177
- apple: ({ size, color }: {
178
- size?: number;
179
- color?: string;
180
- }) => JSX_2.Element;
181
- back: typeof BackIcon;
182
- biometricIcon: typeof BiometricIcon;
183
- info: typeof InfoIcon;
184
- toMobile: typeof ToMobileIcon;
185
- underage: typeof UnderageIcon;
186
- cross: ({ size, color }: {
187
- size?: number;
188
- color?: string;
189
- }) => JSX_2.Element;
190
- regulaLogo: ({ size, color }: {
191
- size?: number;
192
- color?: string;
193
- }) => JSX_2.Element;
194
- empty: () => JSX_2.Element;
195
- signature: typeof PoweredByRegula;
196
- success: ({ size, color }: {
197
- size?: number;
198
- color?: string;
199
- }) => JSX_2.Element;
200
- onboardingScanYourId: () => JSX_2.Element;
201
- onboardingReadRfidChip: () => JSX_2.Element;
202
- onboardgTakeASelfie: () => JSX_2.Element;
203
- prepareDocumentStep: () => JSX_2.Element;
204
- prepareLivenessStep: () => JSX_2.Element;
205
- radio_selected: () => JSX_2.Element;
206
- radio_normal: () => JSX_2.Element;
207
- square_selected: () => JSX_2.Element;
208
- square_normal: () => JSX_2.Element;
209
- selected: ({ color }: {
210
- color?: string | undefined;
211
- }) => JSX_2.Element;
212
- chevronDown: ({ color }: {
213
- color?: string | undefined;
214
- }) => JSX_2.Element;
215
- close_icon: ({ size, color }: {
216
- size?: number;
217
- color?: string;
218
- }) => JSX_2.Element;
219
- };
220
-
221
- declare type IdvModuleProps<TModuleProps, TModulesConfig> = {
99
+ declare type IdvModuleMethods = {
100
+ isReady: () => boolean;
101
+ getSupportedTemplates: () => string[];
102
+ getIdentifier: () => string;
103
+ initialize: (modulesConfig: Record<string, any>) => void;
104
+ deinitialize?: () => void;
105
+ };
106
+
107
+ declare type IdvModuleProps<T, R> = {
222
108
  isProcessing?: (isProcessing: boolean) => void;
223
- moduleProps: TModuleProps;
224
- modulesConfig?: TModulesConfig;
109
+ moduleProps: T;
110
+ modulesConfig?: R;
225
111
  perform: (data: any) => void;
226
112
  idvEventListener: (module: string, data: any) => void;
227
113
  };
228
114
 
229
- declare function InfoIcon({ size, color }: {
230
- size?: number;
231
- color?: string;
232
- }): JSX_2.Element;
233
-
234
- declare type JsonArray = JsonValue[];
235
-
236
- declare type JsonObject = {
237
- [key: string]: JsonValue;
238
- };
239
-
240
- declare type JsonValue = string | number | boolean | null | JsonObject | JsonArray;
241
-
242
- declare function PoweredByRegula(): JSX_2.Element;
243
-
244
115
  declare type QuestionDataSource = {
245
116
  id: string | number;
246
117
  placeholder?: string | null;
@@ -323,16 +194,11 @@ declare const TextAlignment: {
323
194
 
324
195
  declare type TextAlignment = (typeof TextAlignment)[keyof typeof TextAlignment];
325
196
 
326
- declare function ToMobileIcon({ size }: {
327
- size?: number;
328
- color?: string;
329
- }): JSX_2.Element;
330
-
331
197
  declare type UIButton = {
332
198
  type?: 'RESPONSE_BODY' | 'FORM';
333
199
  title?: UILabel;
334
200
  image?: UIImage;
335
- responseBody?: JsonObject;
201
+ responseBody?: string | Record<string, any>;
336
202
  backgroundColor?: string;
337
203
  cornerRadius?: number;
338
204
  highlightColor?: string;
@@ -342,13 +208,6 @@ declare type UIButton = {
342
208
 
343
209
  declare type UIButtonOption = UIButton;
344
210
 
345
- declare type UIChip = {
346
- title?: UILabel;
347
- removeImage?: UIImage;
348
- cornerRadius?: number;
349
- backgroundColor?: string;
350
- };
351
-
352
211
  declare type UIDetailsItem = {
353
212
  title?: UILabel;
354
213
  description?: UILabel;
@@ -363,10 +222,6 @@ declare type UIDetailsList = {
363
222
  cornerRadius: number;
364
223
  };
365
224
 
366
- declare type UIDropdownControl = DropdownControl & {
367
- title: UILabel;
368
- };
369
-
370
225
  declare type UIDropdownOption = {
371
226
  title?: UILabel;
372
227
  image?: UIImage;
@@ -375,13 +230,6 @@ declare type UIDropdownOption = {
375
230
  highlightColor?: string;
376
231
  };
377
232
 
378
- declare type UIDropdownPicker = {
379
- backgroundColor?: string;
380
- cornerRadius?: number;
381
- borderWidth?: number;
382
- borderColor?: string;
383
- };
384
-
385
233
  declare type UIImage = {
386
234
  imageURL?: string;
387
235
  base64?: string;
@@ -428,16 +276,10 @@ declare type UILabel = {
428
276
  cornerRadius?: number;
429
277
  };
430
278
 
431
- declare type UIMultiDropdownControl = DropdownControl & {
432
- chip: UIChip;
433
- };
434
-
435
279
  declare type UIMultiSelectorQuestion = QuestionItem & {
436
280
  displayType: typeof QUESTIONS_DISPLAY_TYPES.MULTI_SELECTOR_DROPDOWN;
437
281
  option: UIDropdownOption;
438
282
  optionSelected: UIDropdownOption;
439
- dropdownControl: UIMultiDropdownControl;
440
- dropdownPicker: UIDropdownPicker;
441
283
  };
442
284
 
443
285
  declare type UIProgressScreenClientConfig = {
@@ -483,8 +325,6 @@ declare type UISelectorDropdownQuestion = QuestionItem & {
483
325
  displayType: typeof QUESTIONS_DISPLAY_TYPES.SELECTOR_DROPDOWN;
484
326
  option: UIDropdownOption;
485
327
  optionSelected: UIDropdownOption;
486
- dropdownControl: UIDropdownControl;
487
- dropdownPicker: UIDropdownPicker;
488
328
  };
489
329
 
490
330
  declare type UISelectorOptionsQuestion = QuestionItem & {
@@ -499,7 +339,6 @@ declare type UIStatusScreenClientConfig = {
499
339
  header?: UIInfoHeaderView;
500
340
  image?: UIImage;
501
341
  title?: UILabel;
502
- description: UILabel;
503
342
  buttons?: UIButton[];
504
343
  footer?: UIInfoFooterView;
505
344
  backgroundColor?: string;
@@ -519,11 +358,6 @@ declare type UITextQuestion = QuestionItem & {
519
358
  textField?: UITextField;
520
359
  };
521
360
 
522
- declare function UnderageIcon({ size }: {
523
- size?: number;
524
- color?: string;
525
- }): JSX_2.Element;
526
-
527
361
  declare type Validator = {
528
362
  type: typeof VALIDATOR_TYPE.NOT_EMPTY;
529
363
  message: string;
@@ -540,9 +374,4 @@ declare const VALIDATOR_TYPE: {
540
374
 
541
375
  declare type VALIDATOR_TYPE = (typeof VALIDATOR_TYPE)[keyof typeof VALIDATOR_TYPE];
542
376
 
543
- declare function WarningIcon({ size, color }: {
544
- size?: number;
545
- color?: string;
546
- }): JSX_2.Element;
547
-
548
377
  export { }