Structure improvements

Author: StefanKScanbot

.gitignore

@@ -64,3 +64,12 @@ yarn-error.log
 
 # testing
 /coverage
+
+
+#YARN v3
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions

.yarn/releases/yarn-3.6.1.cjs

@@ -0,0 +1,3 @@
+nodeLinker: node-modules
+
+yarnPath: .yarn/releases/yarn-3.6.1.cjs

.yarnrc.yml

@@ -19,36 +19,36 @@ import ScanbotSDK, {ScanbotSdkConfiguration} from 'react-native-scanbot-sdk';
 import {DocumentDirectoryPath, ExternalDirectoryPath} from 'react-native-fs';
 import {NavigationContainer} from '@react-navigation/native';
 import {createStackNavigator} from '@react-navigation/stack';
-import {ImageDetailScreen} from './screens/ImageDetailScreen';
-import {MedicalCertificateResultScreen} from './screens/MedicalCertificateResultScreen';
-import {GenericDocumentResultScreen} from './screens/GenericDocumentResultScreen';
-import {CheckRecognizerResultScreen} from './screens/CheckRecognizerResultScreen';
-import {BarcodeFormatsScreen} from './screens/BarcodeFormatsScreen';
-import {BarcodeDocumentFormatsScreen} from './screens/BarcodeDocumentFormatsScreen';
-import {BarcodeCameraViewScreen} from './screens/BarcodeCameraViewScreen';
-import {errorMessageAlert} from './utils/Alerts';
+import {ImageDetailScreen} from './src/screens/ImageDetailScreen';
+import {MedicalCertificateResultScreen} from './src/screens/MedicalCertificateResultScreen';
+import {GenericDocumentResultScreen} from './src/screens/GenericDocumentResultScreen';
+import {CheckRecognizerResultScreen} from './src/screens/CheckRecognizerResultScreen';
+import {BarcodeFormatsScreen} from './src/screens/BarcodeFormatsScreen';
+import {BarcodeDocumentFormatsScreen} from './src/screens/BarcodeDocumentFormatsScreen';
+import {BarcodeCameraViewScreen} from './src/screens/BarcodeCameraViewScreen';
+import {errorMessageAlert} from './src/utils/Alerts';
 import {
   PrimaryRoutesParamList,
   Screens,
   ScreenTitles,
-} from './utils/Navigation';
-import {PageContext, usePages} from './context/usePages';
+} from './src/utils/Navigation';
+import {PageContext, usePages} from './src/context/usePages';
 import {
   BarcodeDocumentFormatContext,
   useBarcodeDocumentFormats,
-} from './context/useBarcodeDocumentFormats';
+} from './src/context/useBarcodeDocumentFormats';
 import {
   BarcodeFormatsContext,
   useBarcodeFormats,
-} from './context/useBarcodeFormats';
-import {COLORS, ScanbotTheme} from './theme/Theme';
-import {ActivityIndicatorContext, useLoading} from './context/useLoading';
-import {HomeScreen} from './screens/HomeScreen';
-import {ImageResultScreen} from './screens/ImageResultScreen';
-import {FILE_ENCRYPTION_ENABLED, IMAGE_FILE_FORMAT} from './utils/SDKUtils';
-import {LoadingIndicator} from './components/LoadingIndicator';
-import {MrzResultScreen} from './screens/MrzResultScreen';
-import {BarcodeResultScreen} from './screens/BarcodeResultScreen';
+} from './src/context/useBarcodeFormats';
+import {COLORS, ScanbotTheme} from './src/theme/Theme';
+import {ActivityIndicatorContext, useLoading} from './src/context/useLoading';
+import {HomeScreen} from './src/screens/HomeScreen';
+import {ImageResultScreen} from './src/screens/ImageResultScreen';
+import {FILE_ENCRYPTION_ENABLED, IMAGE_FILE_FORMAT} from './src/utils/SDKUtils';
+import {LoadingIndicator} from './src/components/LoadingIndicator';
+import {MrzResultScreen} from './src/screens/MrzResultScreen';
+import {BarcodeResultScreen} from './src/screens/BarcodeResultScreen';
 
 const Stack = createStackNavigator<PrimaryRoutesParamList>();
 

src/App.tsx renamed to App.tsx

@@ -3,7 +3,7 @@
  */
 
 import {AppRegistry} from 'react-native';
-import App from './src/App';
+import App from './App';
 import {name as appName} from './app.json';
 
 AppRegistry.registerComponent(appName, () => App);

index.js

@@ -439,16 +439,16 @@ PODS:
   - RNGestureHandler (2.14.0):
     - RCT-Folly (= 2021.07.22.00)
     - React-Core
-  - RNScanbotSDK/ALL (4.16.0):
-    - React
-    - ScanbotSDK/ALL (= 4.2.2)
-    - ScanbotSDKNativeWrapper/ALL (= 4.2.2.5)
+  - RNScanbotSDK/ALL (5.1.0-beta.1):
+    - RCT-Folly (= 2021.07.22.00)
+    - React-Core
+    - ScanbotSDKNativeWrapper/ALL (= 5.1.3.0-alpha.0)
   - RNScreens (3.29.0):
     - RCT-Folly (= 2021.07.22.00)
     - React-Core
-  - ScanbotSDK/ALL (4.2.2)
-  - ScanbotSDKNativeWrapper/ALL (4.2.2.5):
-    - ScanbotSDK/ALL (= 4.2.2)
+  - ScanbotSDK/ALL (5.1.3)
+  - ScanbotSDKNativeWrapper/ALL (5.1.3.0-alpha.0):
+    - ScanbotSDK/ALL (= 5.1.3)
   - SocketRocket (0.6.1)
   - Yoga (1.14.0)
 
@@ -655,10 +655,10 @@ SPEC CHECKSUMS:
   RNCAsyncStorage: 618d03a5f52fbccb3d7010076bc54712844c18ef
   RNFS: 4ac0f0ea233904cb798630b3c077808c06931688
   RNGestureHandler: 32a01c29ecc9bb0b5bf7bc0a33547f61b4dc2741
-  RNScanbotSDK: 56571ccfcc330b9035dbd35ac3e82a31c72ce221
+  RNScanbotSDK: c964888f44c53001d7f5f4aac83a9728084dea4c
   RNScreens: 3c5b9f4a9dcde752466854b6109b79c0e205dad3
-  ScanbotSDK: d982d517143b71cfab94792bfd8d4bddc8c4dee8
-  ScanbotSDKNativeWrapper: e438b6733156345c8b6d3cdc9f651c9b9dbff503
+  ScanbotSDK: 7b71bece5862c37078895e92e2e7b4ecef739b6e
+  ScanbotSDKNativeWrapper: 3fe9a5405678ffec148ce9c07fdc9b1237ded00b
   SocketRocket: f32cd54efbe0f095c4d7594881e52619cfe80b17
   Yoga: 3efc43e0d48686ce2e8c60f99d4e6bd349aff981
 

ios/Podfile.lock

@@ -3,15 +3,15 @@
   "version": "0.0.1",
   "private": true,
   "scripts": {
-    "android": "react-native run-android",
-    "ios": "react-native run-ios",
-    "lint": "eslint .",
+    "android": "react-native run-android --terminal ./",
+    "ios": "react-native run-ios --device 'iPhone 14 Pro (16.2)'",
+    "lint": " eslint --fix --ext .ts,.tsx .",
     "start": "react-native start --reset-cache",
     "test": "jest",
     "clean": "npx react-native-clean-project",
-    "reinstall": "rm -rf node_modules/ && rm yarn.lock && yarn",
-    "postinstall": "cd ios && pod install"
+    "reinstall": "rm -rf node_modules/ && yarn"
   },
+  "packageManager": "[email protected]",
   "engines": {
     "node": ">=16"
   },
@@ -26,7 +26,7 @@
     "react-native-gesture-handler": "^2.12.0",
     "react-native-image-picker": "^7.0.0",
     "react-native-safe-area-context": "^4.6.0",
-    "react-native-scanbot-sdk": "4.16.0",
+    "react-native-scanbot-sdk": "file:../scanbot-sdk-react-native",
     "react-native-screens": "^3.24.0"
   },
   "devDependencies": {

package.json

@@ -1,9 +1,9 @@
 import {Modal, StyleSheet, Text, View} from 'react-native';
 import React, {useCallback} from 'react';
 import {COLORS} from '../theme/Theme';
-import {useSavePDF} from '../hooks/examples/useSavePDF';
-import {usePerformOCR} from '../hooks/examples/usePerformOCR';
-import {useWriteTIFF} from '../hooks/examples/useWriteTIFF';
+import {useSavePDF} from '../hooks/Operations/useSavePDF';
+import {usePerformOCR} from '../hooks/Operations/usePerformOCR';
+import {useWriteTIFF} from '../hooks/Operations/useWriteTIFF';
 
 export function SavePagesModal({
   isVisible,

src/components/SavePagesModal.tsx

@@ -1,28 +1,28 @@
 import {FeatureId} from '../utils/Examples';
-import {useDocumentScanner} from './examples/useDocumentScanner';
+import {useDocumentScanner} from './RTUUI/useDocumentScanner';
 import {useNavigation} from '@react-navigation/native';
 import {PrimaryRouteNavigationProp, Screens} from '../utils/Navigation';
-import {useDetectDocumentFromPage} from './examples/useDetectDocumentFromPage';
-import {useDetectDocumentFromImage} from './examples/useDetectDocumentFromImage';
-import {useExtractPagesFromPDF} from './examples/useExtractPagesFromPDF';
-import {useExtractImagesFromPDF} from './examples/useExtractImagesFromPDF';
-import {useBarcodeScanner} from './examples/useBarcodeScanner';
-import {useBatchBarcodesScanner} from './examples/useBatchBarcodesScanner';
-import {useDetectBarcodesOnStillImage} from './examples/useDetectBarcodesOnStillImage';
-import {useDetectBarcodesOnStillImages} from './examples/useDetectBarcodesOnStillImages';
-import {useMRZScanner} from './examples/useMRZScanner';
-import {useMedicalCertificateScanner} from './examples/useMedicalCertificateScanner';
-import {useGenericDocumentScanner} from './examples/useGenericDocumentScanner';
-import {useEHICScanner} from './examples/useEHICScanner';
-import {useLicenseInfo} from './examples/useLicenseInfo';
-import {useOCRConfigs} from './examples/useOCRConfigs';
-import {useLicensePlateScanner} from './examples/useLicensePlateScanner';
-import {useTextDataScanner} from './examples/useTextDataScanner';
-import {useCheckRecognizer} from './examples/useCheckRecognizer';
-import {useRecognizeCheckOnImage} from './examples/useRecognizeCheckOnImage';
+import {useBarcodeScanner} from './RTUUI/useBarcodeScanner';
+import {useBatchBarcodesScanner} from './RTUUI/useBatchBarcodesScanner';
+import {useMRZScanner} from './RTUUI/useMRZScanner';
+import {useMedicalCertificateScanner} from './RTUUI/useMedicalCertificateScanner';
+import {useGenericDocumentScanner} from './RTUUI/useGenericDocumentScanner';
+import {useEHICScanner} from './RTUUI/useEHICScanner';
+import {useLicensePlateScanner} from './RTUUI/useLicensePlateScanner';
+import {useTextDataScanner} from './RTUUI/useTextDataScanner';
+import {useCheckRecognizer} from './RTUUI/useCheckRecognizer';
 import {useLicenseValidityCheckWrapper} from './useLicenseValidityCheck';
-import {useFinderDocumentScanner} from './examples/useFinderDocumentScanner';
-import {useVinScanner} from './examples/useVinScanner';
+import {useFinderDocumentScanner} from './RTUUI/useFinderDocumentScanner';
+import {useVinScanner} from './RTUUI/useVinScanner';
+import {useDetectDocumentFromPage} from './Operations/useDetectDocumentFromPage';
+import {useDetectDocumentFromImage} from './Operations/useDetectDocumentFromImage';
+import {useExtractPagesFromPDF} from './Operations/useExtractPagesFromPDF';
+import {useExtractImagesFromPDF} from './Operations/useExtractImagesFromPDF';
+import {useDetectBarcodesOnStillImage} from './Operations/useDetectBarcodesOnStillImage';
+import {useDetectBarcodesOnStillImages} from './Operations/useDetectBarcodesOnStillImages';
+import {useLicenseInfo} from './Operations/useLicenseInfo';
+import {useOCRConfigs} from './Operations/useOCRConfigs';
+import {useRecognizeCheckOnImage} from './Operations/useRecognizeCheckOnImage';
 
 export function useOnExamplePress() {
   const navigation = useNavigation<PrimaryRouteNavigationProp>();

src/hooks/examples/useApplyImageFilterOnPage.ts renamed to src/hooks/Operations/useApplyImageFilterOnPage.ts

@@ -21,7 +21,7 @@ import {
   HomeScreenSectionItem,
 } from '../components/HomeScreenSectionComponents';
 import {PageContext} from '../context/usePages';
-import {useImportImageAndApplyFilter} from '../hooks/examples/useImportImageAndApplyFilter';
+import {useImportImageAndApplyFilter} from '../hooks/Operations/useImportImageAndApplyFilter';
 import {ImageFilterModal} from '../components/ImageFilterModal';
 import {selectImagesFromLibrary} from '../utils/ImageUtils';
 import {ImageFilterType} from 'react-native-scanbot-sdk';

src/hooks/examples/useDetectBarcodesOnStillImage.ts renamed to src/hooks/Operations/useDetectBarcodesOnStillImage.ts

@@ -11,8 +11,8 @@ import {PageContext} from '../context/usePages';
 import {ImageFilterModal} from '../components/ImageFilterModal';
 import {PreviewImage} from '../components/PreviewImage';
 import {deleteAllConfirmationAlert} from '../utils/Alerts';
-import {useCroppingScreen} from '../hooks/examples/useCroppingScreen';
-import {useApplyImageFilterOnPage} from '../hooks/examples/useApplyImageFilterOnPage';
+import {useCroppingScreen} from '../hooks/RTUUI/useCroppingScreen';
+import {useApplyImageFilterOnPage} from '../hooks/Operations/useApplyImageFilterOnPage';
 
 export function ImageDetailScreen() {
   const route = useRoute<ImageDetailScreenRouteProp>();

src/hooks/examples/useDetectBarcodesOnStillImages.ts renamed to src/hooks/Operations/useDetectBarcodesOnStillImages.ts

@@ -10,7 +10,7 @@ import {ScrollView} from 'react-native-gesture-handler';
 import {PageContext} from '../context/usePages';
 import {PrimaryRouteNavigationProp, Screens} from '../utils/Navigation';
 import {BottomActionBar} from '../components/BottomActionBar';
-import {useDocumentScanner} from '../hooks/examples/useDocumentScanner';
+import {useDocumentScanner} from '../hooks/RTUUI/useDocumentScanner';
 import {
   deleteAllConfirmationAlert,
   errorMessageAlert,

src/hooks/examples/useDetectDocumentFromImage.ts renamed to src/hooks/Operations/useDetectDocumentFromImage.ts

@@ -1,45 +1,21 @@
-import {Field, GenericDocumentWrapper} from 'react-native-scanbot-sdk';
+import {Field, GenericDocument} from 'react-native-scanbot-sdk';
 
-function isGenericDocumentField(field: any): field is Field {
-  return (
-    (field as Field).validationStatus !== undefined ||
-    (field as Field).value?.text !== undefined ||
-    (field as Field).value?.confidence !== undefined
-  );
-}
-
-function sectionValueItem(key: string, value: string) {
-  return {key, value};
-}
+function extractGenericDocumentFields(document: GenericDocument): Field[] {
+  let fields: Field[] = [];
 
-function sectionImageItem(key: string, image?: string) {
-  return {key, image};
-}
+  if (document.fields.length > 0) {
+    fields = fields.concat(document.fields);
+  }
 
-function sectionFieldItem(key: string, field: Field) {
-  return {key, field};
-}
-
-function gdrCommonFields(document: GenericDocumentWrapper): Array<{
-  key: string;
-  value?: string;
-}> {
-  return [
-    sectionValueItem('Type', document.type.name),
-    sectionValueItem('Confidence', document.confidence.toString()),
-  ];
-}
+  if (document.children.length > 0) {
+    document.children.forEach(child => {
+      fields = fields.concat(extractGenericDocumentFields(child));
+    });
+  }
 
-function gdrFields(document: GenericDocumentWrapper) {
-  return Object.entries(document)
-    .filter(([_, value]) => isGenericDocumentField(value))
-    .map(([key, value]) => sectionFieldItem(key, value));
+  return fields;
 }
 
 export const GenericDocumentUtils = {
-  gdrCommonFields,
-  gdrFields,
-  sectionValueItem,
-  sectionImageItem,
-  sectionFieldItem,
+  extractGenericDocumentFields,
 };