blinkid-flutter/sample_files/scanning_modules_config.dart at master · microblink/blinkid-flutter · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
import 'package:blinkid_flutter/blinkid_flutter.dart';
import 'sample_filter_options.dart';

/// Holds UI-driven scanning configuration for the BlinkID sample app.
class ScanningModulesConfig {
  ScanningMode scanningMode = ScanningMode.automatic;

  /// Milliseconds before a scanning step times out. `0` disables the timeout.
  int stepTimeoutDuration = 60000;

  /// Milliseconds of UI inactivity before timeout. `0` disables the timeout.
  int inactivityTimeoutDuration = 10000;

  /// Shown at the start of the camera scanning flow (performScan only).
  bool showOnboardingDialog = true;

  bool barcodeEnabled = true;
  BarcodeModuleSettings barcode = ScanningModulesConfig.defaultBarcodeModule;

  bool documentCaptureEnabled = true;
  DocumentCaptureModuleSettings documentCapture =
      ScanningModulesConfig.defaultDocumentCaptureModule;

  bool mrzEnabled = true;
  MrzModuleSettings mrz = ScanningModulesConfig.defaultMrzModule;

  bool vizEnabled = true;
  VizModuleSettings viz = ScanningModulesConfig.defaultVizModule;

  bool classFilterEnabled = false;
  List<UiDocumentFilter> classFilterInclude = [];
  List<UiDocumentFilter> classFilterExclude = [];

  bool redactionResolverEnabled = false;
  List<RedactionSettings> redactionResolverEntries = [
    ScanningModulesConfig.defaultRedactionSettings(),
  ];

  /// SDK defaults from [BarcodeModuleSettings] constructor in `types.dart`.
  static BarcodeModuleSettings get defaultBarcodeModule =>
      BarcodeModuleSettings();

  /// SDK defaults from [DocumentCaptureModuleSettings] constructor in `types.dart`.
  static DocumentCaptureModuleSettings get defaultDocumentCaptureModule =>
      DocumentCaptureModuleSettings();

  /// SDK defaults from [MrzModuleSettings] constructor in `types.dart`.
  static MrzModuleSettings get defaultMrzModule => MrzModuleSettings();

  /// SDK defaults from [VizModuleSettings] constructor in `types.dart`.
  static VizModuleSettings get defaultVizModule => VizModuleSettings();

  static RedactionSettings defaultRedactionSettings() {
    return RedactionSettings(
      mode: RedactionMode.fullResult,
      documentNumberRedactionSettings: DocumentNumberRedactionSettings(
        prefixDigitsVisible: 0,
        suffixDigitsVisible: 1,
      ),
      fields: [FieldType.firstName, FieldType.lastName],
      documentFilter: [
        DocumentFilter(
          country: Country.croatia,
          documentType: DocumentType.id,
        ),
      ],
    );
  }

  ClassFilter? toClassFilter() {
    if (!classFilterEnabled) {
      return null;
    }

    final includeDocuments = classFilterInclude
        .where(hasDocumentFilterCriteria)
        .map(uiToDocumentFilter)
        .toList();
    final excludeDocuments = classFilterExclude
        .where(hasDocumentFilterCriteria)
        .map(uiToDocumentFilter)
        .toList();

    if (includeDocuments.isEmpty && excludeDocuments.isEmpty) {
      return null;
    }

    final filter = ClassFilter();
    if (includeDocuments.isNotEmpty) {
      filter.includeDocuments = includeDocuments;
    }
    if (excludeDocuments.isNotEmpty) {
      filter.excludeDocuments = excludeDocuments;
    }
    return filter;
  }

  RedactionSettingsResolver? toRedactionSettingsResolver() {
    if (!redactionResolverEnabled || redactionResolverEntries.isEmpty) {
      return null;
    }
    return RedactionSettingsResolver(redactionResolverEntries);
  }

  BlinkIdScanningSettings toScanningSettings() {
    return BlinkIdScanningSettings(
      barcodeModule: barcodeEnabled ? barcode : null,
      documentCaptureModule:
          documentCaptureEnabled ? documentCapture : null,
      mrzModule: mrzEnabled ? mrz : null,
      vizModule: vizEnabled ? viz : null,
    );
  }

  BlinkIdSessionSettings toSessionSettings() {
    return BlinkIdSessionSettings(
      scanningMode: scanningMode,
      scanningSettings: toScanningSettings(),
      stepTimeoutDuration: stepTimeoutDuration,
      inactivityTimeoutDuration: inactivityTimeoutDuration,
    );
  }

  BlinkIdScanningUxSettings toUxSettings() {
    return BlinkIdScanningUxSettings(
      showHelpButton: true,
      showOnboardingDialog: showOnboardingDialog,
      allowHapticFeedback: true,
      preferredCamera: PreferredCamera.back,
    );
  }

  void resetToDefaults() {
    scanningMode = ScanningMode.automatic;
    stepTimeoutDuration = 60000;
    inactivityTimeoutDuration = 10000;
    showOnboardingDialog = true;
    barcodeEnabled = true;
    barcode = defaultBarcodeModule;

    documentCaptureEnabled = true;
    documentCapture = defaultDocumentCaptureModule;

    mrzEnabled = true;
    mrz = defaultMrzModule;

    vizEnabled = true;
    viz = defaultVizModule;

    classFilterEnabled = false;
    classFilterInclude = [];
    classFilterExclude = [];
    redactionResolverEnabled = false;
    redactionResolverEntries = [defaultRedactionSettings()];
  }
}