@thegrizzlylabs/react-native-genius-scan 6.1.0 → 6.3.0

package/README.md

@@ -86,24 +86,26 @@ RNGeniusScan.setLicenseKey(licenseKey, /* autoRefresh = */ true)
 ### Start the scanner module
 
 ```javascript
-val result = await RNGeniusScan.scanWithConfiguration(configuration)
+const result = await RNGeniusScan.scanWithConfiguration(configuration)
 ```
 
 The method `scanWithConfiguration` takes a `configuration` parameter which can take the following options:
 
 - `source`: `camera`, `image` or `library` (defaults to camera)
-- `sourceImageUrl`: an absolute image url, required if `source` is `image`. Example: `file:///var/…/image.png`
+- `sourceImageUrl`: an absolute image url, required if `source` is `image`. Example: `file:///path/to/image.png`
 - `multiPage`: boolean (defaults to true). If true, after a page is scanned, a prompt to scan another page will be displayed. If false, a single page will be scanned.
 - `multiPageFormat`: `pdf`, `tiff`, `none` (defaults to `pdf`)
 - `defaultFilter`: the filter that will be applied by default to enhance scans, or `none` if no enhancement should be performed by default. Possible values are listed in the [Available filters section](#available-filters). Default value is `automatic`.
 - `availableFilters`: an array of filters that the user can select when they tap on the edit filter button. Defaults to [`none`, `automatic`, `automaticMonochrome`, `automaticBlackAndWhite`, `automaticColor`, `photo`].
 - `pdfPageSize`: `fit`, `a4`, `letter`, defaults to fit.
+- `pdfPassword`: Optional password used to protect generated PDF documents. Empty passwords are treated as no password. This only applies when `multiPageFormat` is `pdf`.
 - `pdfMaxScanDimension`: max dimension in pixels when images are scaled before PDF generation, for example 2000 to fit both height and width within 2000px. Defaults to 0, which means no scaling is performed.
 - `pdfFontFileUrl`: Custom font file used during the PDF generation to embed an invisible text layer. If null, a default font is used, which only supports Latin languages.
 - `jpegQuality`: JPEG quality used to compress captured images. Between 0 and 100, 100 being the best quality. Default is 60.
 - `skipPostProcessingScreen`: Whether to skip showing the post-processing screen. We only recommend enabling this option when scanning structured data. Generally, you want the user to visually confirm the quality of each scan.
 - `postProcessingActions`: an array with the desired actions to display during the post processing screen (defaults to all actions). Possible actions are `rotate`, `editFilter` and `correctDistortion`.
 - `defaultCurvatureCorrection`: `enabled` or `disabled` whether a curvature correction should be applied by default. Disabled by default.
+- `showCropValidation`: `never`, `always`, or `{ whenConfidenceBelowOrEqual: 'highest' | 'high' | 'medium' | 'low' | 'lowest' }` to automatically show crop validation after capture.
 - `defaultScanOrientation`: `automatic` to rotate scan automatically after capture or `original` to keep original scan orientation (defaults to `automatic`).
 - `photoLibraryButtonHidden`: boolean specifying whether the button allowing the user to pick an image on the Camera screen should be hidden (default to false).
 - `flashButtonHidden`: boolean (default to false)
@@ -111,13 +113,14 @@ The method `scanWithConfiguration` takes a `configuration` parameter which can t
 - `foregroundColor`: string representing a color, must start with a `#`. The color of the icons, text (defaults to '#ffffff').
 - `backgroundColor`: string representing a color, must start with a `#`. The color of the toolbar, screen background (defaults to black)
 - `highlightColor`: string representing a color, must start with a `#`. The color of the image overlays (default to blue)
-- `menuColor`: string representing a color, must start with a `#`. The color of the menus (defaults to system defaults.)
+- `menuColor`: string representing a color, must start with a `#`. The color of the menus (iOS only, defaults to system defaults).
 - `ocrConfiguration`: text recognition options. Text recognition will run on a background thread for every captured image. No text recognition will be applied if this parameter is not present.
     - `languages`: list of the BCP 47 language codes (eg `["en-US"]`) for which to run text recognition. Note that text recognition will take longer if multiple languages are specified.
     - `outputFormats`: an array with the formats in which the OCR result is made available in the ScanFlow result (defaults to all formats). Possible formats are `rawText`, `hOCR` and `textLayerInPDF`.
 - `structuredData`: an array of the structured data you want to extract. E.g.: `['receipt', 'businessCard']`. Possible values are `receipt`, `barcode`, `bankDetails` (iOS only), `businessCard` (iOS only).
-- `structuredDataBarcodeTypes`: an array of the barcode types to extract, e.g. `['qr', 'code39']`. Possible values are `aztec`, `code39`, `code93`, `code128`, `dataMatrix`, `ean8`, `ean13`, `itf`, `pdf417`, `qr`, `upca` (Android only), `upce`, `codabar` (iOS 15+ only), `gs1DataBar` (iOS 15+ only), `microPDF417` (iOS 15+ only), `microQR` (iOS 15+ only), `msiPlessey` (iOS 15+ only).
+- `structuredDataBarcodeTypes`: an array of the barcode types to extract, e.g. `['qr', 'code39']`. Possible values are `aztec`, `code39`, `code93`, `code128`, `dataMatrix`, `ean8`, `ean13`, `itf`, `pdf417`, `qr`, `upca` (Android only), `upce`, `codabar` (iOS 15+ only), `gs1DataBar` (iOS 15+ only), `microPDF417` (iOS 15+ only), `microQR` (iOS 15+ only), `msiPlessey` (iOS 17+ only).
 - `requiredReadabilityLevel`: the required readability level below which a warning will be displayed to the user. Possible values are `lowest`, `low`, `medium`, `high`, `highest` (default to `lowest`, which means the warning will never be displayed).
+- `showFinalReview`: boolean specifying whether the final review screen should be displayed before submission (default to false).
 
 It returns a promise with `result` object containing:
 

package/android/build.gradle

@@ -42,5 +42,5 @@ rootProject.allprojects {
 
 dependencies {
     implementation 'com.facebook.react:react-native:+'
-    implementation 'com.geniusscansdk:gssdk:6.1.0'
+    implementation 'com.geniusscansdk:gssdk:6.3.0'
 }

package/index.d.ts

@@ -1,3 +1,18 @@
+export type ScanOrientation = 'automatic' | 'original';
+
+export type CurvatureCorrectionMode = 'enabled' | 'disabled';
+
+export type ReadabilityLevel = 'lowest' | 'low' | 'medium' | 'high' | 'highest';
+
+export type CropConfidenceLevel = 'lowest' | 'low' | 'medium' | 'high' | 'highest';
+
+export type CropValidation =
+  | 'never'
+  | 'always'
+  | {
+      whenConfidenceBelowOrEqual: CropConfidenceLevel;
+    };
+
 export interface ScanOptions {
   source?: 'camera' | 'library' | 'image';
   sourceImageUrl?: string;
@@ -5,7 +20,11 @@ export interface ScanOptions {
   defaultFilter?: string;
   availableFilters?: string[];
   pdfPageSize?: 'fit' | 'a4' | 'letter';
+  skipPostProcessingScreen?: boolean;
   postProcessingActions?: string[];
+  defaultCurvatureCorrection?: CurvatureCorrectionMode;
+  defaultScanOrientation?: ScanOrientation;
+  photoLibraryButtonHidden?: boolean;
   flashButtonHidden?: boolean;
   defaultFlashMode?: 'auto' | 'on' | 'off';
   backgroundColor?: string;
@@ -18,10 +37,14 @@ export interface ScanOptions {
   };
   structuredData?: string[];
   structuredDataBarcodeTypes?: string[];
+  requiredReadabilityLevel?: ReadabilityLevel;
+  showCropValidation?: CropValidation;
   jpegQuality?: number;
   pdfMaxScanDimension?: number;
   multiPageFormat?: 'none' | 'pdf' | 'tiff';
+  pdfPassword?: string;
   pdfFontFileUrl?: string;
+  showFinalReview?: boolean;
 }
 
 export interface BarcodeConfiguration {
@@ -40,7 +63,6 @@ export interface Scan {
 }
 
 export interface ScanResult {
-  pdfURL?: string;
   multiPageDocumentUrl?: string;
   scans: Scan[];
 }

package/ios/GSSDK/GSSDK.xcframework/Info.plist

@@ -7,37 +7,33 @@
 		<dict>
 			<key>BinaryPath</key>
 			<string>GSSDK.framework/GSSDK</string>
-			<key>DebugSymbolsPath</key>
-			<string>dSYMs</string>
 			<key>LibraryIdentifier</key>
-			<string>ios-arm64_x86_64-simulator</string>
+			<string>ios-arm64</string>
 			<key>LibraryPath</key>
 			<string>GSSDK.framework</string>
 			<key>SupportedArchitectures</key>
 			<array>
 				<string>arm64</string>
-				<string>x86_64</string>
 			</array>
 			<key>SupportedPlatform</key>
 			<string>ios</string>
-			<key>SupportedPlatformVariant</key>
-			<string>simulator</string>
 		</dict>
 		<dict>
 			<key>BinaryPath</key>
 			<string>GSSDK.framework/GSSDK</string>
-			<key>DebugSymbolsPath</key>
-			<string>dSYMs</string>
 			<key>LibraryIdentifier</key>
-			<string>ios-arm64</string>
+			<string>ios-arm64_x86_64-simulator</string>
 			<key>LibraryPath</key>
 			<string>GSSDK.framework</string>
 			<key>SupportedArchitectures</key>
 			<array>
 				<string>arm64</string>
+				<string>x86_64</string>
 			</array>
 			<key>SupportedPlatform</key>
 			<string>ios</string>
+			<key>SupportedPlatformVariant</key>
+			<string>simulator</string>
 		</dict>
 	</array>
 	<key>CFBundlePackageType</key>

package/ios/GSSDK/GSSDK.xcframework/ios-arm64/GSSDK.framework/Headers/GSKDocumentDetector.h

@@ -18,6 +18,14 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+typedef NS_CLOSED_ENUM(NSInteger, GSKQuadrangleConfidenceLevel) {
+    GSKQuadrangleConfidenceLevelLowest,
+    GSKQuadrangleConfidenceLevelLow,
+    GSKQuadrangleConfidenceLevelMedium,
+    GSKQuadrangleConfidenceLevelHigh,
+    GSKQuadrangleConfidenceLevelHighest,
+};
+
 /**
  A configuration for the document detector.
  */
@@ -43,12 +51,25 @@ NS_ASSUME_NONNULL_BEGIN
 @interface GSKDocumentDetectionResult: NSObject
 
 - (instancetype)initWithQuadrangle:(GSKQuadrangle *)quadrangle;
+- (instancetype)initWithQuadrangle:(GSKQuadrangle *)quadrangle
+               quadrangleConfidence:(GSKQuadrangleConfidenceLevel)quadrangleConfidence
+        hasQuadrangleConfidence:(BOOL)hasQuadrangleConfidence;
 
 /**
  The detected quadrangle or an empty quadrangle if no document has been detected
  */
 @property (nonatomic, strong, readonly) GSKQuadrangle *quadrangle;
 
+/**
+ The confidence associated with the detected quadrangle when available.
+ */
+@property (nonatomic, assign, readonly) GSKQuadrangleConfidenceLevel quadrangleConfidence;
+
+/**
+ Indicates whether a confidence is available for the detected quadrangle.
+ */
+@property (nonatomic, assign, readonly) BOOL hasQuadrangleConfidence;
+
 @end
 
 /**

package/ios/GSSDK/GSSDK.xcframework/ios-arm64/GSSDK.framework/Headers/GSSDK-Swift.h

@@ -765,7 +765,7 @@ SWIFT_PROTOCOL("_TtP5GSSDK31GSKCameraViewControllerDelegate_")
 /// \param cameraViewController The camera view controller
 ///
 - (void)cameraViewControllerFailedToFindDocument:(GSKCameraViewController * _Nonnull)cameraViewController;
-/// The camera view controller real-time document detection will soon take the photo of a quadrangle, but if the document
+/// The camera view controller real-time document detection will soon capture a detected document, but if the document
 /// detection is not stable enough, the process can still be
 /// cancelled.
 /// It’s a good time to tell the user to remain stable.
@@ -773,18 +773,36 @@ SWIFT_PROTOCOL("_TtP5GSSDK31GSKCameraViewControllerDelegate_")
 /// \param cameraViewController The camera view controller
 ///
 - (void)cameraViewControllerPhotoStabilizationDidStart:(GSKCameraViewController * _Nonnull)cameraViewController;
-/// The camera view controller is about to decide whether to automatically take a photo because the detection was stable enough.
+/// The camera view controller is about to decide whether to automatically capture a detected document because the detection was stable enough.
 /// This is an override point where you can return <code>false</code> to stop that automatic process from proceeding.
 /// \param cameraViewController The camera view controller
 ///
 - (BOOL)cameraViewControllerShouldSnapPhoto:(GSKCameraViewController * _Nonnull)cameraViewController SWIFT_WARN_UNUSED_RESULT;
-/// The camera view controller is going to automatically take a photo because the detection was stable enough.
-/// The photo taking is underway and cannot be interrupted at this stage.
+/// The camera view controller is going to capture a photo, whether the capture was triggered manually or automatically.
+/// When the capture is automatic, this is called after <code>cameraViewController:willAutoCaptureDocumentWithQuadrangle:</code>.
 /// \param cameraViewController The camera view controller
 ///
-/// \param quadrangle The quadrangle of the document that will be photographed.
+- (void)cameraViewControllerWillCapturePhoto:(GSKCameraViewController * _Nonnull)cameraViewController;
+/// The camera view controller is going to automatically capture a detected document because the detection was stable enough.
+/// The automatic capture is about to start and cannot be interrupted at this stage.
+/// <ul>
+///   <li>
+///     Deprecated: Use <code>cameraViewController(_:willAutoCaptureDocumentWithQuadrangle:)</code> for automatic document captures
+///     or <code>cameraViewControllerWillCapturePhoto(_:)</code> for any capture.
+///   </li>
+/// </ul>
+/// \param cameraViewController The camera view controller
+///
+/// \param quadrangle The quadrangle of the document that will be captured.
 ///
 - (void)cameraViewController:(GSKCameraViewController * _Nonnull)cameraViewController willSnapPhotoWithQuadrangle:(GSKQuadrangle * _Nonnull)quadrangle;
+/// The camera view controller is going to automatically capture a detected document because the detection was stable enough.
+/// The automatic capture is about to start and cannot be interrupted at this stage.
+/// \param cameraViewController The camera view controller
+///
+/// \param quadrangle The quadrangle of the document that will be captured.
+///
+- (void)cameraViewController:(GSKCameraViewController * _Nonnull)cameraViewController willAutoCaptureDocumentWithQuadrangle:(GSKQuadrangle * _Nonnull)quadrangle;
 /// The camera view controller just took a photo, but it hasn’t been post-processed it yet
 /// \param cameraViewController The camera view controller
 ///
@@ -1224,7 +1242,8 @@ SWIFT_CLASS("_TtC5GSSDK14GSKPDFDocument")
 @property (nonatomic, readonly, copy) NSString * _Nullable title;
 /// If provided, this password will be used to protect the PDF document.
 /// It will need to be entered to view or edit the document.
-/// RC4 encryption algorithm is used with a 128-bit key.
+/// AES-256 encryption is used.
+/// An empty password is treated as no password.
 @property (nonatomic, readonly, copy) NSString * _Nullable password;
 /// If provided, the keywords will be included in the PDF document properties
 @property (nonatomic, readonly, copy) NSString * _Nullable keywords;
@@ -1349,6 +1368,11 @@ SWIFT_CLASS("_TtC5GSSDK24GSKScanFlowConfiguration")
 /// will only scan a single page. The output document will always contain
 /// a single page. Defaults to <code>true</code>.
 @property (nonatomic) BOOL multiPage;
+/// Whether the user should be presented with a screen that lets them review all
+/// captured scans at the end of the scan flow, where they’ll be able to edit each
+/// scan once more before finally submitting the captured scans for processing.
+/// Defaults to <code>false</code>.
+@property (nonatomic) BOOL showFinalReview;
 /// What orientation that a scan should be rotated to after it’s been captured.
 /// Defaults to <code>automatic</code>. See <code>GSKScanOrientation</code> for more information.
 @property (nonatomic) enum GSKScanOrientation defaultScanOrientation;
@@ -1372,10 +1396,14 @@ SWIFT_CLASS("_TtC5GSSDK24GSKScanFlowConfiguration")
 /// Whether the photo library button should be hidden during camera-based scan flows. Defaults to <code>false</code>.
 @property (nonatomic) BOOL photoLibraryButtonHidden;
 /// Determines the default flash mode. Combine this with <code>flashButtonHidden</code>
-/// if you want to only allow a specific flash mode. Defaults to <code>.auto</code>.
+/// if you want to only allow a specific flash mode. Defaults to <code>.off</code>.
 @property (nonatomic) enum GSKScanFlowFlashMode defaultFlashMode;
 /// Determines the document format. Defaults to <code>.PDF</code>.
 @property (nonatomic) enum GSKScanFlowMultiPageFormat multiPageFormat;
+/// Optional password used to protect generated PDF documents.
+/// An empty password is treated as no password.
+/// This only applies when <code>multiPageFormat</code> is <code>.pdf</code>.
+@property (nonatomic, copy) NSString * _Nullable pdfPassword;
 /// Custom font file used during PDF generation to embed an invisible text
 /// layer. If <code>nil</code>, a default font is used, which only supports Latin languages.
 @property (nonatomic, copy) NSURL * _Nullable pdfFontFileURL;