@regulaforensics/idv-gui 4.0.658-nightly → 4.0.659-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
@@ -12,6 +12,23 @@ declare const CLIENT_VALIDATOR_TYPE: {
12
12
 
13
13
  declare type CLIENT_VALIDATOR_TYPE = (typeof CLIENT_VALIDATOR_TYPE)[keyof typeof CLIENT_VALIDATOR_TYPE];
14
14
 
15
+ declare const CodeFieldInputType: {
16
+ readonly NUMERIC: "NUMERIC";
17
+ readonly ALPHA_NUMERIC: "ALPHA_NUMERIC";
18
+ };
19
+
20
+ declare type CodeFieldInputType = (typeof CodeFieldInputType)[keyof typeof CodeFieldInputType];
21
+
22
+ declare type CodeInputDataItem = {
23
+ id: string | number;
24
+ text: string;
25
+ required: boolean | null;
26
+ property: {
27
+ id: string;
28
+ };
29
+ validators: Array<Validator>;
30
+ };
31
+
15
32
  declare const ContentMode: {
16
33
  readonly ASPECT_FILL: "ASPECT_FILL";
17
34
  readonly ASPECT_FIT: "ASPECT_FIT";
@@ -28,6 +45,27 @@ declare const DATA_SOURCE_ANSWER_TYPE: {
28
45
 
29
46
  declare type DATA_SOURCE_ANSWER_TYPE = (typeof DATA_SOURCE_ANSWER_TYPE)[keyof typeof DATA_SOURCE_ANSWER_TYPE];
30
47
 
48
+ declare type DataItem = {
49
+ type: typeof ListElementTypes.GENERIC_COLUMN;
50
+ uiComponentId: string;
51
+ } | {
52
+ type: typeof ListElementTypes.QUESTION;
53
+ uiComponentId: string;
54
+ content: QuestionDataItem;
55
+ } | {
56
+ type: typeof ListElementTypes.SECTION;
57
+ uiComponentId: string;
58
+ content: SectionDataItem;
59
+ } | {
60
+ type: typeof ListElementTypes.CODE_INPUT;
61
+ uiComponentId: string;
62
+ content: CodeInputDataItem;
63
+ } | {
64
+ type: typeof ListElementTypes.TEXT_INPUT;
65
+ uiComponentId: string;
66
+ content: TextInputDataItem;
67
+ };
68
+
31
69
  declare type DropdownControl = {
32
70
  backgroundColor?: string;
33
71
  cornerRadius?: number;
@@ -45,6 +83,10 @@ declare const FontWeight: {
45
83
 
46
84
  declare type FontWeight = (typeof FontWeight)[keyof typeof FontWeight];
47
85
 
86
+ declare type GenericListDataSource = {
87
+ dataItems: DataItem[];
88
+ };
89
+
48
90
  declare type GenericPopup = {
49
91
  rootElement: UIRootElement;
50
92
  reason: string;
@@ -67,7 +109,7 @@ export declare class GuiIdv extends BaseModule<GuiModuleProps, GuiModuleConfig>
67
109
  private render;
68
110
  disconnectedCallback(): void;
69
111
  static isReady(): boolean;
70
- static getSupportedTemplates: () => ("INFO" | "INFO_DETAILS" | "STATUS" | "PROGRESS" | "QUESTIONS" | "CAMERA" | "GALLERY" | "GEOLOCATION" | "DEVICE_TRANSFER" | "GENERIC" | "GENERIC_LOCATION" | "GENERIC_PROGRESS" | "UPLOAD_FILES")[];
112
+ static getSupportedTemplates: () => ("INFO" | "INFO_DETAILS" | "STATUS" | "PROGRESS" | "QUESTIONS" | "CAMERA" | "GALLERY" | "GEOLOCATION" | "DEVICE_TRANSFER" | "GENERIC" | "GENERIC_LIST" | "GENERIC_LOCATION" | "GENERIC_PROGRESS" | "UPLOAD_FILES")[];
71
113
  static initialize(_modulesConfig: Record<string, unknown>): void;
72
114
  static deinitialize(): void;
73
115
  static getIdentifier: () => string;
@@ -88,6 +130,7 @@ export declare const GuiIdvSteps: {
88
130
  readonly GEOLOCATION: "GEOLOCATION";
89
131
  readonly DEVICE_TRANSFER: "DEVICE_TRANSFER";
90
132
  readonly GENERIC: "GENERIC";
133
+ readonly GENERIC_LIST: "GENERIC_LIST";
91
134
  readonly GENERIC_LOCATION: "GENERIC_LOCATION";
92
135
  readonly GENERIC_PROGRESS: "GENERIC_PROGRESS";
93
136
  readonly UPLOAD_FILES: "UPLOAD_FILES";
@@ -168,6 +211,11 @@ export declare type GuiModuleProps = {
168
211
  } | {
169
212
  templateId: typeof GuiIdvSteps.GENERIC;
170
213
  templateLayout: UIGenericScreenClientConfig;
214
+ } | {
215
+ templateId: typeof GuiIdvSteps.GENERIC_LIST;
216
+ templateLayout: UIGenericListScreenClientConfig;
217
+ dataSource?: GenericListDataSource | null;
218
+ properties?: SessionPropertiesItem[];
171
219
  } | {
172
220
  templateId: typeof GuiIdvSteps.GENERIC_PROGRESS;
173
221
  templateLayout: UIGenericProgressScreenClientConfig;
@@ -227,6 +275,18 @@ declare type JsonObject = {
227
275
 
228
276
  declare type JsonValue = string | number | boolean | null | JsonObject | JsonArray;
229
277
 
278
+ declare const ListElementTypes: {
279
+ readonly GENERIC_COLUMN: "genericColumn";
280
+ readonly QUESTION: "question";
281
+ readonly SECTION: "section";
282
+ readonly CODE_INPUT: "codeInput";
283
+ readonly TEXT_INPUT: "textInput";
284
+ };
285
+
286
+ declare const ListRootElementTypes: {
287
+ readonly LIST_SCAFFOLD: "listScaffold";
288
+ };
289
+
230
290
  declare enum LocationAccuracy {
231
291
  HIGH = "HIGH",
232
292
  BALANCED = "BALANCED",
@@ -256,6 +316,8 @@ export declare const PopupReason: {
256
316
 
257
317
  export declare type PopupReason = (typeof PopupReason)[keyof typeof PopupReason];
258
318
 
319
+ declare type QuestionDataItem = QuestionDataSource;
320
+
259
321
  declare type QuestionDataSource = {
260
322
  id: string | number;
261
323
  placeholder?: string | null;
@@ -307,6 +369,10 @@ declare const RootElementTypes: {
307
369
  readonly SCAFFOLD: "scaffold";
308
370
  };
309
371
 
372
+ declare type SectionDataItem = {
373
+ dataItems: DataItem[];
374
+ };
375
+
310
376
  declare type SessionPropertiesItem = {
311
377
  id: string;
312
378
  createdAt: string;
@@ -344,6 +410,24 @@ declare const TextAlignment: {
344
410
 
345
411
  declare type TextAlignment = (typeof TextAlignment)[keyof typeof TextAlignment];
346
412
 
413
+ declare const TextFieldInputType: {
414
+ readonly EMAIL: "EMAIL";
415
+ readonly PHONE: "PHONE";
416
+ };
417
+
418
+ declare type TextFieldInputType = (typeof TextFieldInputType)[keyof typeof TextFieldInputType];
419
+
420
+ declare type TextInputDataItem = {
421
+ id: string | number;
422
+ text: string;
423
+ placeholder?: string | null;
424
+ required: boolean | null;
425
+ property: {
426
+ id: string;
427
+ };
428
+ validators: Array<Validator>;
429
+ };
430
+
347
431
  declare type UIButton = {
348
432
  actionId?: string;
349
433
  type?: 'RESPONSE_BODY' | 'FORM' | 'URL';
@@ -378,6 +462,36 @@ declare type UIChip = {
378
462
  backgroundColor?: string;
379
463
  };
380
464
 
465
+ declare type UICodeField = {
466
+ codeLength?: number;
467
+ inputType?: CodeFieldInputType;
468
+ fontName?: string;
469
+ fontColor?: string;
470
+ fontSize?: number;
471
+ fontWeight?: FontWeight;
472
+ interSlotSpacing?: number;
473
+ slot: UICodeFieldSlot;
474
+ };
475
+
476
+ declare type UICodeFieldSlot = {
477
+ width?: number;
478
+ height?: number;
479
+ backgroundColor?: string;
480
+ cornerRadius?: number;
481
+ borderWidth?: number;
482
+ borderColor?: string;
483
+ focusedBorderWidth?: number;
484
+ focusedBorderColor?: string;
485
+ errorBorderWidth?: number;
486
+ errorBorderColor?: string;
487
+ };
488
+
489
+ declare type UICodeInput = {
490
+ titleLabel?: UILabel;
491
+ codeField: UICodeField;
492
+ descriptionLabel?: UILabel;
493
+ };
494
+
381
495
  declare type UIColumn = {
382
496
  elements?: UIElement[];
383
497
  horizontalAlignment?: UIHorizontalAlignment;
@@ -387,6 +501,28 @@ declare type UIColumn = {
387
501
  paddings?: UIPaddings;
388
502
  };
389
503
 
504
+ declare type UiComponent = {
505
+ id: string;
506
+ type: typeof ListElementTypes.GENERIC_COLUMN;
507
+ content: UIColumn;
508
+ } | {
509
+ id: string;
510
+ type: typeof ListElementTypes.QUESTION;
511
+ content: QuestionsItem;
512
+ } | {
513
+ id: string;
514
+ type: typeof ListElementTypes.SECTION;
515
+ content: UISection;
516
+ } | {
517
+ id: string;
518
+ type: typeof ListElementTypes.CODE_INPUT;
519
+ content: UICodeInput;
520
+ } | {
521
+ id: string;
522
+ type: typeof ListElementTypes.TEXT_INPUT;
523
+ content: UITextInput;
524
+ };
525
+
390
526
  declare type UIDetailsItem = {
391
527
  title?: UILabel;
392
528
  description?: UILabel;
@@ -488,6 +624,11 @@ declare type UIGalleryScreenClientConfig = {
488
624
  selectionLimit?: number;
489
625
  };
490
626
 
627
+ declare type UIGenericListScreenClientConfig = {
628
+ rootElement: UIListRootElement;
629
+ dataSource: GenericListDataSource;
630
+ };
631
+
491
632
  declare type UIGenericLocationScreenClientConfig = {
492
633
  rootElement: UIRootElement;
493
634
  popups: GenericPopup[];
@@ -590,6 +731,28 @@ declare type UILabel = {
590
731
  fontWeight?: FontWeight;
591
732
  };
592
733
 
734
+ declare type UIListColumn = {
735
+ uiComponents: UiComponent[];
736
+ verticalAlignment?: UIVerticalAlignment;
737
+ backgroundColor?: string;
738
+ cornerRadius?: number;
739
+ paddings?: UIPaddings;
740
+ };
741
+
742
+ declare type UIListRootElement = {
743
+ type: typeof ListRootElementTypes.LIST_SCAFFOLD;
744
+ content: UIListScaffoldContainer;
745
+ };
746
+
747
+ declare type UIListScaffoldContainer = {
748
+ topColumn: UIColumn;
749
+ mainListColumn: UIListColumn;
750
+ bottomColumn: UIColumn;
751
+ backgroundColor: string;
752
+ backgroundImage?: UIImage;
753
+ cornerRadius?: number;
754
+ };
755
+
593
756
  declare type UIMultiDropdownControl = DropdownControl & {
594
757
  chip: UIChip;
595
758
  };
@@ -689,6 +852,12 @@ declare type UIScaffoldContainer = {
689
852
  cornerRadius?: number;
690
853
  };
691
854
 
855
+ declare type UISection = {
856
+ backgroundColor?: string;
857
+ cornerRadius?: number;
858
+ paddings?: UIPaddings;
859
+ };
860
+
692
861
  declare type UISelectorButtonsQuestion = QuestionItem & {
693
862
  displayType: typeof QUESTIONS_DISPLAY_TYPES.SELECTOR_BUTTONS;
694
863
  option: UIButtonOption;
@@ -727,18 +896,39 @@ declare type UIStatusScreenClientConfig = {
727
896
  backgroundImage?: UIImage;
728
897
  };
729
898
 
730
- declare type UITextField = UILabel & {
899
+ declare type UITextField = {
900
+ inputType?: TextFieldInputType;
901
+ fontName: string;
902
+ fontColor: string;
903
+ fontSize: number;
904
+ fontWeight: FontWeight;
731
905
  placeholder?: UILabel;
732
- inputType?: TEXT_INPUT_TYPES;
733
906
  backgroundColor?: string;
734
907
  cornerRadius?: number;
735
908
  borderWidth?: number;
736
909
  borderColor?: string;
910
+ focusedBorderWidth?: number;
911
+ focusedBorderColor?: string;
912
+ errorBorderWidth?: number;
913
+ errorBorderColor?: string;
914
+ };
915
+
916
+ declare type UITextInput = {
917
+ titleLabel?: UILabel;
918
+ textField: UITextField;
919
+ descriptionLabel?: UILabel;
737
920
  };
738
921
 
739
922
  declare type UITextQuestion = QuestionItem & {
740
923
  displayType: typeof QUESTIONS_DISPLAY_TYPES.TEXT_EXPANDABLE | typeof QUESTIONS_DISPLAY_TYPES.TEXT_SINGLE_LINE;
741
- textField?: UITextField;
924
+ textField?: UILabel & {
925
+ placeholder?: UILabel;
926
+ inputType?: TEXT_INPUT_TYPES;
927
+ backgroundColor?: string;
928
+ cornerRadius?: number;
929
+ borderWidth?: number;
930
+ borderColor?: string;
931
+ };
742
932
  };
743
933
 
744
934
  declare type UIUploadFilesScreenClientConfig = {