@thegrizzlylabs/react-native-genius-scan 5.11.1 → 5.13.0

package/README.md

@@ -101,6 +101,7 @@ The method `scanWithConfiguration` takes a `configuration` parameter which can t
 - `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.
 - `defaultScanOrientation`: `automatic` to rotate scan automatically after capture or `original` to keep original scan orientation (defaults to `automatic`).

package/android/build.gradle

@@ -41,5 +41,5 @@ rootProject.allprojects {
 
 dependencies {
     implementation 'com.facebook.react:react-native:+'
-    implementation 'com.geniusscansdk:gssdk:5.11.1'
+    implementation 'com.geniusscansdk:gssdk:5.13.0'
 }

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

@@ -48,6 +48,11 @@ NS_ASSUME_NONNULL_BEGIN
  */
 - (void)resumePreview;
 
+/**
+ Returns the metadata output rect converted to the preview layer's coordinates.
+ */
+- (CGRect)layerRectConvertedFromMetadataOutputRect:(CGRect)rect;
+
 @property (nonatomic, readonly) UIView *previewView;
 
 /**

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

@@ -372,11 +372,12 @@ SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly) NSTimeInterval minDu
 /// The flash mode. Default is .auto.
 @property (nonatomic) enum GSKCameraSessionFlashStatus flashStatus;
 /// Returns the current status of the document detection.
-/// While you can configure the desired mode when setting up the session, the current value can change: for instance, the
-/// active document detection is <code>.none</code> while taking the photo, or when the session is paused, even if the requested
-/// detection is <code>.highlightAndTrigger</code>.
+/// This is a computed property that maps to the new activeDetectionMode property for backward compatibility.
 /// Observable.
-@property (nonatomic) enum GSKCameraSessionDocumentDetection activeDocumentDetection;
+/// important:
+/// This property is deprecated. Use <code>activeDetectionMode</code> instead, which supports both document and readable
+/// code detection modes.
+@property (nonatomic) enum GSKCameraSessionDocumentDetection activeDocumentDetection SWIFT_DEPRECATED_MSG("Use activeDetectionMode instead");
 /// True for the duration of taking the photo and processing it. Observable.
 @property (nonatomic, readonly) BOOL isTakingPhoto;
 /// Returns false if flash isn’t supported on this device configuration.
@@ -391,6 +392,14 @@ SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly) NSTimeInterval minDu
 + (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
 @end
 
+@class AVCaptureMetadataOutput;
+@class AVMetadataObject;
+@class AVCaptureConnection;
+
+@interface GSKCameraSession (SWIFT_EXTENSION(GSSDK)) <AVCaptureMetadataOutputObjectsDelegate>
+- (void)captureOutput:(AVCaptureMetadataOutput * _Nonnull)output didOutputMetadataObjects:(NSArray<AVMetadataObject *> * _Nonnull)metadataObjects fromConnection:(AVCaptureConnection * _Nonnull)connection;
+@end
+
 
 
 
@@ -425,10 +434,12 @@ SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly) NSTimeInterval minDu
 /// The configuration for a camera session.
 SWIFT_CLASS("_TtC5GSSDK29GSKCameraSessionConfiguration")
 @interface GSKCameraSessionConfiguration : NSObject
+/// note:
+/// Deprecated in favor of <code>init(detectionMode:)</code> which allows for more flexible detection modes.
 /// \param documentDetection The type of real-time document detection to apply.
 ///
-- (nonnull instancetype)initWithDocumentDetection:(enum GSKCameraSessionDocumentDetection)documentDetection OBJC_DESIGNATED_INITIALIZER;
-/// A session configuration where the document detection is <code>.highlightAndTrigger</code>
+- (nonnull instancetype)initWithDocumentDetection:(enum GSKCameraSessionDocumentDetection)documentDetection OBJC_DESIGNATED_INITIALIZER SWIFT_DEPRECATED_MSG("Use init(detectionMode:) instead");
+/// A session configuration where the document detection is <code>.highlightAndAutoCapture</code>
 - (nonnull instancetype)init;
 @end
 
@@ -488,12 +499,12 @@ SWIFT_CLASS("_TtC5GSSDK23GSKCameraViewController")
 @end
 
 
-
 @interface GSKCameraViewController (SWIFT_EXTENSION(GSSDK))
 /// Snap the photo
 - (void)takePhoto;
 @end
 
+
 @class GSKScan;
 @class GSKQuadrangle;
 
@@ -931,6 +942,188 @@ SWIFT_CLASS("_TtC5GSSDK10GSKPDFSize")
 + (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
 @end
 
+@class GSKReadableCodeFlowConfiguration;
+@class GSKReadableCodeFlowResult;
+
+/// A flow for scanning readable codes (barcodes, QR codes, etc.)
+SWIFT_CLASS("_TtC5GSSDK19GSKReadableCodeFlow")
+@interface GSKReadableCodeFlow : NSObject
+/// Initializes a new readable code flow
+/// \param configuration Configuration for the readable code scanning
+///
+- (nonnull instancetype)initWithConfiguration:(GSKReadableCodeFlowConfiguration * _Nonnull)configuration OBJC_DESIGNATED_INITIALIZER;
+/// Starts the readable code scanning flow by presenting a full-screen camera interface.
+/// This method presents a camera view controller that continuously scans for barcodes and QR codes.
+/// The scanning process respects the code types specified in the flow’s configuration.
+/// The method uses Swift’s async/await pattern, suspending until either:
+/// <ul>
+///   <li>
+///     A readable code is successfully detected (except in batch mode)
+///   </li>
+///   <li>
+///     The user taps the done button (batch mode)
+///   </li>
+///   <li>
+///     The user cancels the operation
+///   </li>
+///   <li>
+///     An error occurs during setup or scanning
+///   </li>
+/// </ul>
+/// The behavior varies based on the configuration’s isBatchModeEnabled:
+/// <ul>
+///   <li>
+///     <code>false</code>: Returns immediately after detecting one or more codes in a single frame
+///   </li>
+///   <li>
+///     <code>true</code>: Collects unique codes over time until the user taps the done button
+///   </li>
+/// </ul>
+/// Example usage:
+/// \code
+/// let flow = GSKReadableCodeFlow()
+/// do {
+///     let result = try await flow.resultByStarting(fromViewController: self)
+///     print("Scanned codes: \(result.readableCodes.map { $0.value })")
+/// } catch GSKReadableCodeFlowError.userCancellation {
+///     print("User canceled scanning")
+/// } catch {
+///     print("Scanning failed: \(error)")
+/// }
+///
+/// \endcodeimportant:
+/// This method requires camera permissions. Ensure your app’s Info.plist includes
+/// the <code>NSCameraUsageDescription</code> key with an appropriate description.
+/// note:
+/// The camera interface is presented with <code>modalPresentationStyle</code> set to <code>.fullScreen</code>
+/// for an immersive scanning experience.
+/// \param viewController The view controller from which to present the camera interface.
+/// This should typically be the currently visible view controller.
+///
+///
+/// throws:
+///
+/// <ul>
+///   <li>
+///     Typically throws a <code>GSKReadableCodeFlowError</code>
+///   </li>
+/// </ul>
+///
+/// returns:
+/// A <code>GSKReadableCodeFlowResult</code> containing the detected readable codes with their
+/// decoded values and format types.
+- (void)resultByStartingFromViewController:(UIViewController * _Nonnull)viewController completionHandler:(void (^ _Nonnull)(GSKReadableCodeFlowResult * _Nullable, NSError * _Nullable))completionHandler;
+- (nonnull instancetype)init SWIFT_UNAVAILABLE;
++ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
+@end
+
+@class NSError;
+
+@interface GSKReadableCodeFlow (SWIFT_EXTENSION(GSSDK))
+/// Instantiates a <code>GSKReadableCodeFlow</code> instance with the provided configuration.
+/// This initializer is only available from Objective-C.
++ (nonnull instancetype)readableCodeFlowWithConfiguration:(GSKReadableCodeFlowConfiguration * _Nonnull)configuration SWIFT_WARN_UNUSED_RESULT;
+/// Starts the readable code scanning flow.
+/// @param viewController The view controller to present the readable code scanning interface from.
+/// @param successBlock A completion block/closure that will be called on the main
+/// thread upon successful completion of the scan flow. It receives a <code>GSKReadableCodeFlowResult</code> object as
+/// a parameter. This object gives you access to the scanned codes.
+/// @param failureBlock A block/closure called if an error was encountered.
+/// This method is only available from Objective-C.
+- (void)startFromViewController:(UIViewController * _Nonnull)viewController success:(void (^ _Nonnull)(GSKReadableCodeFlowResult * _Nonnull))successBlock failure:(void (^ _Nonnull)(NSError * _Nonnull))failureBlock;
+@end
+
+@class UIColor;
+
+/// Configuration for the UI readable code scanning flow
+/// This class allows customization of which barcode and QR code formats should be detected
+/// during the scanning process. By default, all supported formats are enabled.
+SWIFT_CLASS("_TtC5GSSDK32GSKReadableCodeFlowConfiguration")
+@interface GSKReadableCodeFlowConfiguration : NSObject
+/// Whether batch mode is enabled for code detection.
+/// This setting controls how codes are detected and when they are returned:
+/// <ul>
+///   <li>
+///     <code>false</code>: Detect multiple codes simultaneously in a single frame and return immediately (default)
+///   </li>
+///   <li>
+///     <code>true</code>: Collect multiple codes over time before returning when user taps Done
+///   </li>
+/// </ul>
+/// Example:
+/// \code
+/// // Standard mode - return codes immediately (default)
+/// let standardConfig = GSKReadableCodeFlowConfiguration(isBatchModeEnabled: false)
+///
+/// // Batch mode - collect codes over time
+/// let batchConfig = GSKReadableCodeFlowConfiguration(isBatchModeEnabled: true)
+///
+/// \endcode
+@property (nonatomic) BOOL isBatchModeEnabled;
+/// The highlight color used for the UI (overlay). Defaults
+/// to <code>.green</code>. For good constrast, we recommend using a bright color.
+@property (nonatomic, strong) UIColor * _Nonnull highlightColor;
+/// The menu color used for the UI. Defaults to <code>nil</code>, meaning that the system
+/// default color will be used (blue on iOS, for example).
+@property (nonatomic, strong) UIColor * _Nullable menuColor;
+/// Creates a new readable code flow configuration with default values
+- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
+@end
+
+
+@interface GSKReadableCodeFlowConfiguration (SWIFT_EXTENSION(GSSDK))
+/// Create a configuration from a dictionary.
+/// This is used for interfacing with cross-platform plugins but shouldn’t
+/// be used in native projects.
++ (GSKReadableCodeFlowConfiguration * _Nullable)configurationWithDictionary:(NSDictionary * _Nonnull)dictionary error:(NSError * _Nullable * _Nullable)error SWIFT_WARN_UNUSED_RESULT;
+@end
+
+
+
+
+/// Enum that defines various errors that can occur during a readable code flow.
+typedef SWIFT_ENUM(NSInteger, GSKReadableCodeFlowError, open) {
+/// User has canceled the readable code flow
+  GSKReadableCodeFlowUserCancelationError SWIFT_COMPILE_NAME("userCancellation") = 0,
+/// A general error due to a bad configuration parameter
+  GSKReadableCodeFlowConfigurationError SWIFT_COMPILE_NAME("configuration") = 1,
+/// Camera permission was denied
+  GSKReadableCodeFlowPermissionDeniedError SWIFT_COMPILE_NAME("permissionDenied") = 2,
+/// Failed to initialize the barcode detector
+  GSKReadableCodeFlowDetectorError SWIFT_COMPILE_NAME("detectorError") = 3,
+};
+static NSString * _Nonnull const GSKReadableCodeFlowErrorDomain = @"GSSDK.GSKReadableCodeFlowError";
+
+
+/// The result of a readable code scanning flow
+/// This class encapsulates the successful outcome of a readable code scanning session,
+/// containing the detected barcode or QR code data.
+SWIFT_CLASS("_TtC5GSSDK25GSKReadableCodeFlowResult")
+@interface GSKReadableCodeFlowResult : NSObject
+- (nonnull instancetype)init SWIFT_UNAVAILABLE;
++ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
+@end
+
+
+@interface GSKReadableCodeFlowResult (SWIFT_EXTENSION(GSSDK))
+/// Returns a dictionary representation of the result
+/// The dictionary contains:
+/// <ul>
+///   <li>
+///     readableCodes: An array of code dictionaries, each containing:
+///     <ul>
+///       <li>
+///         value: The decoded string value
+///       </li>
+///       <li>
+///         type: The code type as a string (e.g., “qr”, “code128”)
+///       </li>
+///     </ul>
+///   </li>
+/// </ul>
+@property (nonatomic, readonly, copy) NSDictionary<NSString *, id> * _Nonnull dictionary;
+@end
+
 typedef SWIFT_ENUM(NSInteger, GSKReceiptCategory, open) {
   GSKReceiptCategoryGas = 0,
   GSKReceiptCategoryTransportation = 1,
@@ -984,7 +1177,6 @@ enum GSKScanFlowFilterType : NSInteger;
 enum GSKScanFlowPDFPageSize : NSUInteger;
 enum GSKScanFlowFlashMode : NSUInteger;
 enum GSKScanFlowMultiPageFormat : NSUInteger;
-@class UIColor;
 @class GSKScanFlowOCRConfiguration;
 
 /// Enables configuration of a <code>GSKScanFlow</code> instance.
@@ -1062,20 +1254,20 @@ SWIFT_CLASS("_TtC5GSSDK24GSKScanFlowConfiguration")
 @end
 
 
+@interface GSKScanFlowConfiguration (SWIFT_EXTENSION(GSSDK))
+- (BOOL)validate:(NSError * _Nullable * _Nullable)error;
+@end
+
 
 @interface GSKScanFlowConfiguration (SWIFT_EXTENSION(GSSDK))
 /// Create a configuration from a dictionary.
-/// This is particularly useful for interfacing with React Native but shouldn’t
+/// This is used for interfacing with cross-platform plugins but shouldn’t
 /// be used in native projects.
 + (nullable instancetype)configurationWithDictionary:(NSDictionary * _Nonnull)dictionary error:(NSError * _Nullable * _Nullable)error SWIFT_WARN_UNUSED_RESULT;
 @end
 
 
 
-@interface GSKScanFlowConfiguration (SWIFT_EXTENSION(GSSDK))
-- (BOOL)validate:(NSError * _Nullable * _Nullable)error;
-@end
-
 /// Enum that defines various errors that can occur during a scan flow.
 typedef SWIFT_ENUM(NSInteger, GSKScanFlowError, open) {
 /// User has canceled the scan flow
@@ -1451,6 +1643,7 @@ SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) NSBundle * _
 
 
 
+
 @interface UIViewController (SWIFT_EXTENSION(GSSDK))
 /// Return a status bar style appropriate for this view controller
 /// based on the contrast between the status bar’s contents and the