@thegrizzlylabs/react-native-genius-scan 6.0.0-beta13 → 6.1.0

package/README.md

@@ -121,10 +121,10 @@ The method `scanWithConfiguration` takes a `configuration` parameter which can t
 
 It returns a promise with `result` object containing:
 
-- `multiPageDocumentUrl`: a document containing all the scanned pages (example: "file://<filepath>.pdf")
+- `multiPageDocumentUrl`: a document containing all the scanned pages (example: "file:///path/to/file.pdf")
 - `scans`: an array of scan objects. Each scan object has:
-    - `originalUrl`: the original file as scanned from the camera. "file://<filepath>.jpeg"
-    - `enhancedUrl`: the cropped and enhanced file, as processed by the SDK. "file://<filepath>.{jpeg|png}"
+    - `originalUrl`: the original file as scanned from the camera. "file:///path/to/file.jpeg"
+    - `enhancedUrl`: the cropped and enhanced file, as processed by the SDK. "file:///path/to/file.{jpeg|png}"
     - `ocrResult`: the result of text recognition for this scan
         - `text`: the raw text that was recognized
         - `hocrTextLayout`: the recognized text in [hOCR](https://en.wikipedia.org/wiki/HOCR) format (with position, style…)
@@ -152,12 +152,12 @@ await RNGeniusScan.generateDocument(document, configuration)
 The `document` parameter is a map containing the following values:
 
 - `pages`: an array of page objects. Each page object has:
-    - `imageUrl`: the URL of the PNG or JPEG image file for this page, e.g. `file://<filepath>.{jpeg|png}`
+    - `imageUrl`: the URL of the PNG or JPEG image file for this page, e.g. `file:///path/to/file.{jpeg|png}`
     - `hocrTextLayout`: the text layout in hOCR format
 
 The `configuration` parameter provides the following options:
 
-- `outputFileUrl`: the URL where the document should be generated, e.g. `file://<filepath>.pdf`
+- `outputFileUrl`: the URL where the document should be generated, e.g. `file:///path/to/file.pdf`
 - `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.
 
 
@@ -198,10 +198,23 @@ RNGeniusScan.scanWithConfiguration({ source: 'image', sourceImageUrl: imageUri }
 Errors are rejected with a structured payload:
 
 - `code`: standardized error code
-- `message`: user-facing message
-- `recovery_message`: recovery suggestion (may be empty)
+- `message`: developer-facing diagnostic message
+- `recovery_message`: developer-facing recovery suggestion (may be empty)
 - `underlying_error`: stringified underlying error (may be empty)
 
+The `code` field is one of:
+
+| Code | Description | Suggested handling |
+| --- | --- | --- |
+| `cancellation_error` | The user canceled the document or barcode scan flow. | Treat as a normal exit; do not show an error. |
+| `configuration_error` | The configuration or input parameters are invalid. | Fix the configuration before retrying. |
+| `licensing_error` | The license key is invalid, expired, or not initialized. | Verify the license key and contact support if needed. |
+| `capture_error` | The camera or capture session failed. | Let the user retry; restart the device if the problem persists. |
+| `storage_space_error` | There is not enough storage space to write generated files. | Ask the user to free up storage space and retry. |
+| `internal_error` | An unexpected SDK error occurred. | Show a generic error and collect `underlying_error` for diagnostics. |
+
+`message` and `recovery_message` are English diagnostics for developers. They are not intended to be displayed directly to end users; use `code` to choose your own localized user-facing message.
+
 Example:
 
 ```javascript

package/android/build.gradle

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

package/index.d.ts

@@ -54,6 +54,21 @@ export interface BarcodeResult {
   barcodes: Barcode[];
 }
 
+export type GeniusScanErrorCode =
+  | 'cancellation_error'
+  | 'configuration_error'
+  | 'licensing_error'
+  | 'capture_error'
+  | 'storage_space_error'
+  | 'internal_error';
+
+export interface GeniusScanError {
+  code: GeniusScanErrorCode;
+  message: string;
+  recovery_message: string;
+  underlying_error: string;
+}
+
 export interface DocumentGeneratorConfiguration {
   outputFileUrl: string;
   pdfFontFileUrl?: string;

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

@@ -10,19 +10,25 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
-/// A GSKCurvatureCorrectionConfiguration defines the behavior of a GSKScanProcessor when applying curvature correction.
+/// A GSKCurvatureCorrectionConfiguration defines the behavior of a GSKScanProcessor when evaluating or applying curvature correction.
 @interface GSKCurvatureCorrectionConfiguration : NSObject
 
-/// The default configuration. This currently doesn't apply the curvature correction configuration, but this can change in future versions
-/// of the SDK.
+/// The default configuration. This doesn't evaluate or apply curvature correction.
 + (instancetype)defaultCurvatureCorrectionConfiguration;
 
-/// No curvature correction
+/// No curvature evaluation or correction.
 + (instancetype)noCurvatureCorrectionConfiguration;
 
-/// Specifies whether or not you want curvature correction
+/// Evaluate curvature distortion without correcting it.
++ (instancetype)evaluationOnlyCurvatureCorrectionConfiguration;
+
+/// Specifies whether or not you want curvature correction. Passing `NO` disables both evaluation and correction.
 + (instancetype)curvatureCorrectionConfigurationWithCurvatureCorrection:(BOOL)curvatureCorrection;
 
+/// Specifies whether or not you want curvature correction, and whether distortion should still be evaluated when correction is disabled.
++ (instancetype)curvatureCorrectionConfigurationWithCurvatureCorrection:(BOOL)curvatureCorrection
+                                                        evaluationOnly:(BOOL)evaluationOnly;
+
 @end
 
 NS_ASSUME_NONNULL_END

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

@@ -0,0 +1,28 @@
+//
+// Genius Scan SDK
+//
+// Copyright 2010-2025 The Grizzly Labs
+//
+// Subject to the Genius Scan SDK Licensing Agreement
+// sdk@thegrizzlylabs.com
+//
+
+#ifndef GSKCurvatureLevel_h
+#define GSKCurvatureLevel_h
+
+/// Enum describing various curvature levels, which estimates distortion caused by non-flat paper surfaces like
+/// book pages or folded sheets.
+typedef NS_CLOSED_ENUM(NSUInteger, GSKCurvatureLevel) {
+    /// Distortion has almost no visible effect
+    GSKCurvatureLevelLowest,
+    /// Distortion is barely visible
+    GSKCurvatureLevelLow,
+    /// Distortion is light but visible
+    GSKCurvatureLevelMedium,
+    /// Distortion has a significant impact on the document
+    GSKCurvatureLevelHigh,
+    /// Distortion has a very strong impact on the document
+    GSKCurvatureLevelHighest,
+};
+
+#endif

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

@@ -0,0 +1,26 @@
+//
+// Genius Scan SDK
+//
+// Copyright 2010-2025 The Grizzly Labs
+//
+// Subject to the Genius Scan SDK Licensing Agreement
+// sdk@thegrizzlylabs.com
+//
+
+#import <Foundation/Foundation.h>
+#import <GSSDK/GSKCurvatureLevel.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+/// Type that encapsulates the result of determining a scan's curvature level.
+@interface GSKCurvatureResult : NSObject
+
+/// The curvature level that was determined for the scan, which indicates how distorted the document is.
+@property (nonatomic, assign, readonly) GSKCurvatureLevel curvatureLevel NS_SWIFT_NAME(level);
+
+- (instancetype)init NS_UNAVAILABLE;
+- (instancetype)initWithCurvatureLevel:(GSKCurvatureLevel)curvatureLevel;
+
+@end
+
+NS_ASSUME_NONNULL_END

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

@@ -10,6 +10,7 @@
 
 #import <GSSDK/GSKRotation.h>
 
+@class GSKCurvatureResult;
 @class GSKQuadrangle;
 @class GSKFilterConfiguration;
 @class GSKReadabilityResult;
@@ -53,6 +54,11 @@ NS_ASSUME_NONNULL_BEGIN
 /// `isReadabilityEnabled` property set to `YES`, always `nil` otherwise.
 @property (nonatomic, strong, nullable, readonly) GSKReadabilityResult *readabilityResult;
 
+/// The result of determining the scan's curvature, which estimates distortion caused by non-flat paper surfaces like book pages or folded sheets.
+/// Only assigned if the `GSKProcessingConfiguration` that was used for processing had curvature evaluation
+/// or correction enabled, always `nil` otherwise.
+@property (nonatomic, strong, nullable, readonly) GSKCurvatureResult *curvatureResult;
+
 @end
 
 NS_ASSUME_NONNULL_END

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

@@ -1,6 +1,6 @@
 #if 0
 #elif defined(__arm64__) && __arm64__
-// Generated by Apple Swift version 6.2.3 effective-5.10 (swiftlang-6.2.3.3.21 clang-1700.6.3.2)
+// Generated by Apple Swift version 6.3.1 effective-5.10 (swiftlang-6.3.1.1.2 clang-2100.0.123.102)
 #ifndef GSSDK_SWIFT_H
 #define GSSDK_SWIFT_H
 #pragma clang diagnostic push
@@ -26,7 +26,7 @@
 #pragma clang diagnostic ignored "-Wauto-import"
 #if defined(__OBJC__)
 #include <Foundation/Foundation.h>
-#endif
+#endif // defined(__OBJC__)
 #if defined(__cplusplus)
 #include <cstdint>
 #include <cstddef>
@@ -195,13 +195,32 @@ typedef unsigned int swift_uint4  __attribute__((__ext_vector_type__(4)));
 # endif
 #endif
 #if !defined(SWIFT_ENUM)
-# define SWIFT_ENUM(_type, _name, _extensibility) enum _name : _type _name; enum SWIFT_ENUM_ATTR(_extensibility) SWIFT_ENUM_EXTRA _name : _type
-# if __has_feature(generalized_swift_name)
-#  define SWIFT_ENUM_NAMED(_type, _name, SWIFT_NAME, _extensibility) enum _name : _type _name SWIFT_COMPILE_NAME(SWIFT_NAME); enum SWIFT_COMPILE_NAME(SWIFT_NAME) SWIFT_ENUM_ATTR(_extensibility) SWIFT_ENUM_EXTRA _name : _type
+# if (defined(__cplusplus) && __cplusplus >= 201103L) ||      (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 202311L) ||      __has_feature(objc_fixed_enum)
+#  define SWIFT_ENUM(_type, _name, _extensibility) enum _name : _type _name; enum SWIFT_ENUM_ATTR(_extensibility) SWIFT_ENUM_EXTRA _name : _type
+#  if __has_feature(generalized_swift_name)
+#   define SWIFT_ENUM_NAMED(_type, _name, SWIFT_NAME, _extensibility) enum _name : _type _name SWIFT_COMPILE_NAME(SWIFT_NAME); enum SWIFT_COMPILE_NAME(SWIFT_NAME) SWIFT_ENUM_ATTR(_extensibility) SWIFT_ENUM_EXTRA _name : _type
+#  else
+#   define SWIFT_ENUM_NAMED(_type, _name, SWIFT_NAME, _extensibility) SWIFT_ENUM(_type, _name, _extensibility)
+#  endif
 # else
+#  define SWIFT_ENUM(_type, _name, _extensibility) _type _name; enum 
 #  define SWIFT_ENUM_NAMED(_type, _name, SWIFT_NAME, _extensibility) SWIFT_ENUM(_type, _name, _extensibility)
 # endif
 #endif
+#if !defined(SWIFT_ENUM_TAG)
+# if (defined(__cplusplus) && __cplusplus >= 201103L) ||      (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 202311L) ||      __has_feature(objc_fixed_enum)
+#  define SWIFT_ENUM_TAG enum
+# else
+#  define SWIFT_ENUM_TAG
+# endif
+#endif
+#if !defined(SWIFT_ENUM_FWD_DECL)
+# if (defined(__cplusplus) && __cplusplus >= 201103L) ||      (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 202311L) ||      __has_feature(objc_fixed_enum)
+#  define SWIFT_ENUM_FWD_DECL(_type, _name) enum _name : _type;
+# else
+#  define SWIFT_ENUM_FWD_DECL(_type, _name) typedef _type _name;
+# endif
+#endif
 #if !defined(SWIFT_UNAVAILABLE)
 # define SWIFT_UNAVAILABLE __attribute__((unavailable))
 #endif
@@ -211,6 +230,9 @@ typedef unsigned int swift_uint4  __attribute__((__ext_vector_type__(4)));
 #if !defined(SWIFT_AVAILABILITY)
 # define SWIFT_AVAILABILITY(plat, ...) __attribute__((availability(plat, __VA_ARGS__)))
 #endif
+#if !defined(SWIFT_AVAILABILITY_DOMAIN)
+# define SWIFT_AVAILABILITY_DOMAIN(dom, ...) __attribute__((availability(domain: dom, __VA_ARGS__)))
+#endif
 #if !defined(SWIFT_WEAK_IMPORT)
 # define SWIFT_WEAK_IMPORT __attribute__((weak_import))
 #endif
@@ -276,6 +298,49 @@ typedef unsigned int swift_uint4  __attribute__((__ext_vector_type__(4)));
 # define SWIFT_IMPORT_STDLIB_SYMBOL 
 #endif
 #endif
+#if !__has_feature(nullability)
+# define _Nonnull
+# define _Nullable
+# define _Null_unspecified
+#elif !defined(__OBJC__)
+# pragma clang diagnostic ignored "-Wnullability-extension"
+#endif
+#if !__has_feature(nullability_nullable_result)
+# define _Nullable_result _Nullable
+#endif
+#if __has_feature(objc_modules)
+#if __has_warning("-Watimport-in-framework-header")
+#pragma clang diagnostic ignored "-Watimport-in-framework-header"
+#endif
+#endif
+
+#pragma clang diagnostic ignored "-Wproperty-attribute-mismatch"
+#pragma clang diagnostic ignored "-Wduplicate-method-arg"
+#if __has_warning("-Wpragma-clang-attribute")
+# pragma clang diagnostic ignored "-Wpragma-clang-attribute"
+#endif
+#pragma clang diagnostic ignored "-Wunknown-pragmas"
+#pragma clang diagnostic ignored "-Wnullability"
+#pragma clang diagnostic ignored "-Wdollar-in-identifier-extension"
+#pragma clang diagnostic ignored "-Wunsafe-buffer-usage"
+
+#if __has_attribute(external_source_symbol)
+# pragma push_macro("any")
+# undef any
+# pragma clang attribute push(__attribute__((external_source_symbol(language="Swift", defined_in="GSSDK",generated_declaration))), apply_to=any(function,enum,objc_interface,objc_category,objc_protocol))
+# pragma pop_macro("any")
+#endif
+
+#if defined(__cplusplus)
+extern "C" {
+#endif
+
+#if defined(__cplusplus)
+} // extern "C"
+#endif
+#if __has_attribute(external_source_symbol)
+# pragma clang attribute pop
+#endif
 #if defined(__OBJC__)
 #if __has_feature(objc_modules)
 #if __has_warning("-Watimport-in-framework-header")
@@ -290,7 +355,7 @@ typedef unsigned int swift_uint4  __attribute__((__ext_vector_type__(4)));
 
 #import <GSSDK/GSSDK.h>
 
-#endif
+#endif // defined(__OBJC__)
 #pragma clang diagnostic ignored "-Wproperty-attribute-mismatch"
 #pragma clang diagnostic ignored "-Wduplicate-method-arg"
 #if __has_warning("-Wpragma-clang-attribute")
@@ -777,7 +842,7 @@ SWIFT_CLASS("_TtC5GSSDK20GSKDocumentGenerator")
 - (BOOL)generate:(GSKPDFDocument * _Nonnull)document configuration:(GSKDocumentGeneratorConfiguration * _Nonnull)configuration error:(NSError * _Nullable * _Nullable)error;
 @end
 
-enum GSKDocumentGeneratorFileFormat : NSInteger;
+SWIFT_ENUM_FWD_DECL(NSInteger, GSKDocumentGeneratorFileFormat)
 @class GSKDocumentGeneratorDebugConfiguration;
 /// A configuration for the document generator.
 SWIFT_CLASS("_TtC5GSSDK33GSKDocumentGeneratorConfiguration")
@@ -1076,7 +1141,7 @@ typedef SWIFT_ENUM(NSInteger, GSKFlashStatus, open) {
   GSKFlashStatusOff = 2,
 };
 
-enum GSKIntegrationFramework : NSInteger;
+SWIFT_ENUM_FWD_DECL(NSInteger, GSKIntegrationFramework)
 SWIFT_CLASS_NAMED("GSKIntegrationContext")
 @interface GSKIntegrationContext : NSObject
 SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly) enum GSKIntegrationFramework currentFramework;)
@@ -1259,13 +1324,13 @@ SWIFT_CLASS("_TtC5GSSDK11GSKScanFlow")
 - (void)startFromViewController:(UIViewController * _Nonnull)viewController onSuccess:(void (^ _Nonnull)(GSKScanFlowResult * _Nonnull))completionBlock failure:(void (^ _Nonnull)(NSError * _Nonnull))errorBlock;
 @end
 
-enum GSKScanFlowSource : NSUInteger;
+SWIFT_ENUM_FWD_DECL(NSUInteger, GSKScanFlowSource)
 @class NSURL;
-enum GSKScanOrientation : NSInteger;
-enum GSKScanFlowFilterType : NSInteger;
-enum GSKScanFlowPDFPageSize : NSUInteger;
-enum GSKScanFlowFlashMode : NSUInteger;
-enum GSKScanFlowMultiPageFormat : NSUInteger;
+SWIFT_ENUM_FWD_DECL(NSInteger, GSKScanOrientation)
+SWIFT_ENUM_FWD_DECL(NSInteger, GSKScanFlowFilterType)
+SWIFT_ENUM_FWD_DECL(NSUInteger, GSKScanFlowPDFPageSize)
+SWIFT_ENUM_FWD_DECL(NSUInteger, GSKScanFlowFlashMode)
+SWIFT_ENUM_FWD_DECL(NSUInteger, GSKScanFlowMultiPageFormat)
 @class GSKScanFlowOCRConfiguration;
 /// Enables configuration of a <code>GSKScanFlow</code> instance.
 /// Pass an instance of this class to the initializer of <code>GSKScanFlow</code>
@@ -1357,6 +1422,15 @@ SWIFT_CLASS("_TtC5GSSDK24GSKScanFlowConfiguration")
 @end
 
 /// Enum that defines various numeric error codes that can occur during a scan flow.
+/// Cross-platform plugins expose the matching string code as the <code>code</code> field in their structured error payloads.
+/// | String code | Description | Suggested handling |
+/// | — | — | — |
+/// | <code>cancellation_error</code> | The user canceled the document or barcode scan flow. | Treat as a normal exit; do not show an error. |
+/// | <code>configuration_error</code> | The configuration or input parameters are invalid. | Fix the configuration before retrying. |
+/// | <code>licensing_error</code> | The license key is invalid, expired, or not initialized. | Verify the license key and contact support if needed. |
+/// | <code>capture_error</code> | The camera or capture session failed. | Let the user retry; restart the device if the problem persists. |
+/// | <code>storage_space_error</code> | There is not enough storage space to write generated files. | Ask the user to free up storage space and retry. |
+/// | <code>internal_error</code> | An unexpected SDK error occurred. | Show a generic error and collect the underlying error for diagnostics. |
 typedef SWIFT_ENUM(NSInteger, GSKScanFlowErrorCode, open) {
 /// User has canceled the scan flow
   GSKScanFlowCancellationErrorCode SWIFT_COMPILE_NAME("cancellation") = 999,
@@ -1713,7 +1787,7 @@ SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) NSBundle * _
 @property (nonatomic, readonly) UIInterfaceOrientationMask gsk_supportedInterfaceOrientations;
 @end
 
-#endif
+#endif // defined(__OBJC__)
 #if __has_attribute(external_source_symbol)
 # pragma clang attribute pop
 #endif

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

@@ -13,6 +13,8 @@ FOUNDATION_EXPORT const unsigned char GSSDKVersionString[];
 
 #import <GSSDK/GSKBackgroundKind.h>
 #import <GSSDK/GSKCurvatureCorrectionConfiguration.h>
+#import <GSSDK/GSKCurvatureLevel.h>
+#import <GSSDK/GSKCurvatureResult.h>
 #import <GSSDK/GSKDefaultLogLevel.h>
 #import <GSSDK/GSKDefaultLogger.h>
 #import <GSSDK/GSKDocumentComposition.h>