@thegrizzlylabs/react-native-genius-scan 5.17.3 → 6.0.0-beta02

package/README.md

@@ -20,10 +20,10 @@ You can try the "demo" version for free without a license key, the only limitati
 You need to [set a license key](#set-the-license-key) for unlimited demo time, or for production.
 
 To buy a license:
-1. [Sign up](https://sdk.geniusscan.com/apps) to our developer console
+1. [Sign up](https://portal.geniusscansdk.com/apps) to our developer console
 2. Submit a quote request for each application
 
-You can learn more about [licensing](https://geniusscansdk.com/license/licensing) in our website and contact us at sdk@geniusscan.com for further questions.
+You can learn more about [licensing](https://geniusscansdk.com/license/licensing) in our website and contact us at sales@geniusscansdk.com for further questions.
 
 ## Demo application
 
@@ -115,8 +115,8 @@ The method `scanWithConfiguration` takes a `configuration` parameter which can t
 - `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`, `readableCode`, `bankDetails` (iOS only), `businessCard` (iOS only).
-- `structuredDataReadableCodeTypes`: an array of the readable code 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).
+- `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).
 - `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).
 
 It returns a promise with `result` object containing:

package/android/build.gradle

@@ -16,7 +16,7 @@ android {
     compileSdkVersion 36
 
     defaultConfig {
-        minSdkVersion 21
+        minSdkVersion 23
         targetSdkVersion 36
         versionCode 1
         versionName "1.0"
@@ -42,5 +42,5 @@ rootProject.allprojects {
 
 dependencies {
     implementation 'com.facebook.react:react-native:+'
-    implementation 'com.geniusscansdk:gssdk:5.17.3'
+    implementation 'com.geniusscansdk:gssdk:6.0.0-beta02'
 }

package/android/src/main/java/com/geniusscansdk/reactnative/RNGeniusScanModule.java

@@ -15,15 +15,17 @@ import com.facebook.react.bridge.ReactMethod;
 import com.facebook.react.bridge.ReadableMap;
 import com.facebook.react.bridge.WritableMap;
 import com.facebook.react.bridge.WritableNativeMap;
+import com.geniusscansdk.barcodeflow.BarcodeScanFlow;
 import com.geniusscansdk.scanflow.PluginBridge;
 import com.geniusscansdk.scanflow.PromiseResult;
+import com.geniusscansdk.scanflow.ScanFlow;
 
 import java.util.Map;
 
 public class RNGeniusScanModule extends ReactContextBaseJavaModule {
   private final ReactApplicationContext reactContext;
   private Promise mScanPromise;
-  private Promise mReadableCodeScanPromise;
+  private Promise mBarcodeScanPromise;
 
   public RNGeniusScanModule(ReactApplicationContext reactContext) {
     super(reactContext);
@@ -55,12 +57,12 @@ public class RNGeniusScanModule extends ReactContextBaseJavaModule {
       PromiseResult promiseResult = PluginBridge.getPromiseResultFromActivityResult(requestCode, resultCode, intent);
       if (promiseResult != null) {
         Promise promise = null;
-        if (requestCode == com.geniusscansdk.scanflow.ScanFlow.SCAN_REQUEST) {
+        if (requestCode == ScanFlow.REQUEST_CODE) {
           promise = mScanPromise;
           mScanPromise = null;
-        } else if (requestCode == com.geniusscansdk.readablecodeflow.ReadableCodeFlow.REQUEST_CODE) {
-          promise = mReadableCodeScanPromise;
-          mReadableCodeScanPromise = null;
+        } else if (requestCode == BarcodeScanFlow.REQUEST_CODE) {
+          promise = mBarcodeScanPromise;
+          mBarcodeScanPromise = null;
         }
         if (promise != null) {
           resolvePromiseWithPromiseResult(promise, promiseResult);
@@ -97,13 +99,13 @@ public class RNGeniusScanModule extends ReactContextBaseJavaModule {
 
   @SuppressWarnings("unused")
   @ReactMethod
-  public void scanReadableCodesWithConfiguration(ReadableMap configuration, Promise promise) {
-    if (mReadableCodeScanPromise != null) {
-        Log.w(getName(), "Ignoring scanReadableCodesWithConfiguration call as a readable code scan flow is already in progress");
+  public void scanBarcodesWithConfiguration(ReadableMap configuration, Promise promise) {
+    if (mBarcodeScanPromise != null) {
+        Log.w(getName(), "Ignoring scanBarcodesWithConfiguration call as a barcode scan flow is already in progress");
         return;
     }
 
-    mReadableCodeScanPromise = promise;
-    PluginBridge.scanReadableCodesWithConfiguration(getCurrentActivity(), configuration.toHashMap());
+    mBarcodeScanPromise = promise;
+    PluginBridge.scanBarcodesWithConfiguration(getCurrentActivity(), configuration.toHashMap());
   }
 }

package/index.d.ts

@@ -17,14 +17,14 @@ export interface ScanOptions {
     outputFormats?: string[];
   };
   structuredData?: string[];
-  structuredDataReadableCodeTypes?: string[];
+  structuredDataBarcodeTypes?: string[];
   jpegQuality?: number;
   pdfMaxScanDimension?: number;
   multiPageFormat?: 'none' | 'pdf' | 'tiff';
   pdfFontFileUrl?: string;
 }
 
-export interface ReadableCodeConfiguration {
+export interface BarcodeConfiguration {
   isBatchModeEnabled?: boolean;
   supportedCodeTypes?: string[];
 }
@@ -45,13 +45,13 @@ export interface ScanResult {
   scans: Scan[];
 }
 
-export interface ReadableCode {
+export interface Barcode {
   value: string;
   type: string;
 }
 
-export interface ReadableCodeResult {
-  readableCodes: ReadableCode[];
+export interface BarcodeResult {
+  barcodes: Barcode[];
 }
 
 export interface DocumentGeneratorConfiguration {
@@ -70,9 +70,9 @@ export interface PDFDocument {
 
 declare const GeniusScan: {
   scanWithConfiguration(options?: ScanOptions): Promise<ScanResult>;
-  scanReadableCodesWithConfiguration(configuration?: ReadableCodeConfiguration): Promise<ReadableCodeResult>;
+  scanBarcodesWithConfiguration(configuration?: BarcodeConfiguration): Promise<BarcodeResult>;
   generateDocument(document: PDFDocument, configuration: DocumentGeneratorConfiguration): Promise<void>;
   setLicenseKey(licenseKey: string, autoRefresh: boolean): Promise<void>;
 };
 
-export default GeniusScan;
+export default GeniusScan;

package/index.js

@@ -6,7 +6,7 @@ const { RNGeniusScan } = NativeModules;
 // Mapping to make options optional
 export default {
   scanWithConfiguration: (scanOptions = {}) => RNGeniusScan.scanWithConfiguration(scanOptions),
-  scanReadableCodesWithConfiguration: (configuration = {}) => RNGeniusScan.scanReadableCodesWithConfiguration(configuration),
+  scanBarcodesWithConfiguration: (configuration = {}) => RNGeniusScan.scanBarcodesWithConfiguration(configuration),
   generateDocument: RNGeniusScan.generateDocument,
   setLicenseKey: RNGeniusScan.setLicenseKey
 };

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

@@ -10,18 +10,15 @@
 			<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>
@@ -29,15 +26,18 @@
 			<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/DeviceGuru_DeviceGuru.bundle/PrivacyInfo.xcprivacy

@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+    <key>NSPrivacyCollectedDataTypes</key>
+    <array>
+        <dict>
+            <key>NSPrivacyCollectedDataType</key>
+            <string>NSPrivacyCollectedDataTypeOtherDataTypes</string>
+            <key>NSPrivacyCollectedDataTypeLinked</key>
+            <false/>
+            <key>NSPrivacyCollectedDataTypeTracking</key>
+            <false/>
+            <key>NSPrivacyCollectedDataTypePurposes</key>
+            <array>
+                <string>NSPrivacyCollectedDataTypePurposeAppFunctionality</string>
+            </array>
+        </dict>
+    </array>
+	<key>NSPrivacyTracking</key>
+	<false/>
+	<key>NSPrivacyAccessedAPITypes</key>
+	<array>
+		<dict>
+			<key>NSPrivacyAccessedAPIType</key>
+			<string>NSPrivacyAccessedAPICategoryUserDefaults</string>
+			<key>NSPrivacyAccessedAPITypeReasons</key>
+			<array>
+				<string>CA92.1</string>
+			</array>
+		</dict>
+	</array>
+</dict>
+</plist>

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

@@ -6,7 +6,7 @@
 //  Copyright © 2024 The Grizzly Labs. All rights reserved.
 //
 
-#import "GSKLoggerSeverity.h"
+#import <GSSDK/GSKLoggerSeverity.h>
 
 #ifndef GSKDefaultLogLevel_h
 #define GSKDefaultLogLevel_h

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

@@ -52,6 +52,8 @@ NS_ASSUME_NONNULL_BEGIN
 @end
 
 /**
+ Detects the frame of a document in an image.
+
  - Performance:
     A document detector can be expensive to create: it's recommended to keep a reference to it if it's needed several times in a row.
  */
@@ -61,12 +63,12 @@ NS_ASSUME_NONNULL_BEGIN
 - (instancetype)init;
 
 /**
- Detects the quadrangle corresponding to the edges of a document in video frame
+ Detects the quadrangle corresponding to the edges of a document in a video frame
 
  @param sampleBuffer a YCbCr sample buffer of a video frame. Make sure the video output generating these frames is configured with the pixel format kCVPixelFormatType_420YpCbCr8BiPlanarFullRange
  @param error On input, a pointer to an error object. If an error occurs, this pointer is set to an actual error object containing the error information. You may specify nil for this parameter if you do not want the error information.
 
- @return The detected quadrangle or nil if an error occured.
+ @return The detected quadrangle or nil if an error occurred.
  */
 - (GSKDocumentDetectionResult * _Nullable)detectDocumentInSampleBuffer:(CMSampleBufferRef)sampleBuffer error:(NSError * _Nullable *)error;
 
@@ -76,7 +78,7 @@ NS_ASSUME_NONNULL_BEGIN
  @param image The photo to detect a document in
  @param error On input, a pointer to an error object. If an error occurs, this pointer is set to an actual error object containing the error information. You may specify nil for this parameter if you do not want the error information.
 
- @return The detected quadrangle or nil if an error occured.
+ @return The detected quadrangle or nil if an error occurred.
  */
 - (GSKDocumentDetectionResult * _Nullable)detectDocumentInImage:(UIImage *)image error:(NSError * _Nullable *)error;
 

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

@@ -9,7 +9,6 @@
 #import <Foundation/Foundation.h>
 #import <GSSDK/GSKFilterColorPalette.h>
 #import <GSSDK/GSKFilterStyle.h>
-#import <GSSDK/GSKFilterType.h>
 
 @class GSKFilterConfiguration;
 
@@ -34,13 +33,6 @@ NS_ASSUME_NONNULL_BEGIN
  */
 + (instancetype)automaticEnhancementConfigurationWithColorPalette:(GSKFilterColorPalette)colorPalette NS_SWIFT_NAME(automatic(colorPalette:));
 
-/**
- An enhancement configuration that will result in using the specified legacy filter.
-
- Deprecated.
- */
-+ (instancetype)enhancementConfigurationWithFilter:(GSKFilterType)filter DEPRECATED_MSG_ATTRIBUTE("Use `filterConfiguration` instead.");
-
 /**
  An enhancement configuration that will result in using the specified filter.
  */

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

@@ -4,7 +4,7 @@
 // Copyright 2010-2020 The Grizzly Labs
 //
 // Subject to the Genius Scan SDK Licensing Agreement
-// sdk@thegrizzlylabs.com
+// sales@geniusscansdk.com
 //
 
 #ifndef GSKError_h
@@ -17,7 +17,7 @@ FOUNDATION_EXPORT NSString * const GSKErrorDomain;
 typedef NS_ENUM(NSInteger, GSKError) {
     /// An license key related error.
     GSKLicenseError = 1000,
-    /// An internal error. Please report it to sdk@geniusscan.com with output logs.
+    /// An internal error. Please report it to support@geniusscansdk.com with output logs.
     GSKInternalError = 1001,
     /// An image processing error
     GSKProcessingError = 1002,
@@ -26,9 +26,13 @@ typedef NS_ENUM(NSInteger, GSKError) {
     /// A file not found error
     GSKFileNotFound = 1004,
     /// A memory (not storage) error
-    GSKMemoryError = 1005
+    GSKMemoryError = 1005,
+    /// A capture session error
+    GSKCaptureError = 1006
 };
 
 FOUNDATION_EXPORT NSString * const GSKPDFErrorDomain;
 
+FOUNDATION_EXPORT NSError *GSKErrorToNSError(GSKError code, NSString *description);
+
 #endif /* GSKError_h */

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

@@ -5,7 +5,7 @@
 
 #import <Foundation/Foundation.h>
 
-#import "GSKLogger.h"
+#import <GSSDK/GSKLogger.h>
 
 NS_ASSUME_NONNULL_BEGIN
 

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

@@ -6,7 +6,7 @@
 //  Copyright © 2024 The Grizzly Labs. All rights reserved.
 //
 
-#import "GSKLoggerSeverity.h"
+#import <GSSDK/GSKLoggerSeverity.h>
 
 #ifndef GSKLogger_h
 #define GSKLogger_h

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

@@ -8,7 +8,6 @@
 
 #import <Foundation/Foundation.h>
 
-#import <GSSDK/GSKFilterType.h>
 #import <GSSDK/GSKRotation.h>
 
 @class GSKQuadrangle;
@@ -25,9 +24,6 @@ NS_ASSUME_NONNULL_BEGIN
 /// The quadrangle that was used for perspective correction
 @property (nonatomic, strong, readonly) GSKQuadrangle *appliedQuadrangle;
 
-/// The filter that was applied during the enhancement phase
-@property (nonatomic, assign, readonly) GSKFilterType appliedFilter __deprecated_msg("Use appliedFilterConfiguration instead.");
-
 /// The filter that was applied during the enhancement phase
 @property (nonatomic, strong, readonly) GSKFilterConfiguration *appliedFilterConfiguration;
 

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

@@ -9,14 +9,8 @@
 
 #import <Foundation/Foundation.h>
 #import <CoreGraphics/CoreGraphics.h>
-
+#import <GSSDK/GSKRotation.h>
 #import <UIKit/UIKit.h>
-#import "GSKRotation.h"
-
-extern const CGPoint GSKQuadrangleTopRightPoint;
-extern const CGPoint GSKQuadrangleTopLeftPoint;
-extern const CGPoint GSKQuadrangleBottomLeftPoint;
-extern const CGPoint GSKQuadrangleBottomRightPoint;
 
 NS_ASSUME_NONNULL_BEGIN
 

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

@@ -8,7 +8,7 @@
 //
 
 #import <Foundation/Foundation.h>
-#import "GSKReadabilityLevel.h"
+#import <GSSDK/GSKReadabilityLevel.h>
 
 NS_ASSUME_NONNULL_BEGIN
 

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

@@ -13,9 +13,13 @@
 
 /// Defines an image rotation by increment of 90 degrees.
 typedef NS_ENUM(NSInteger, GSKRotation) {
+    /// No rotation
     GSKRotationNone = 0,
+    /// Clockwise rotation, or rotation to the right
     GSKRotationClockwise = 1,
-    GSKRotation180 = 2,
+    // 180 degree rotation
+    GSKRotationUpsideDown = 2,
+    // Counter-clockwise rotation, or rotation to the left
     GSKRotationCounterClockwise = 3
 };
 

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

@@ -12,8 +12,8 @@ typedef NS_OPTIONS(NSUInteger, GSKScanFlowStructuredData) {
     GSKScanFlowStructuredDataBusinessCard = 1 << 1,
     /// To scan receipt/invoice information
     GSKScanFlowStructuredDataReceipt = 1 << 2,
-    /// To scan barcodes and QR codes. The SDK can detect multiple readable codes on a single page.
-    GSKScanFlowStructuredDataReadableCode = 1 << 3,
+    /// To scan barcodes and QR codes. The SDK can detect multiple barcodes on a single page.
+    GSKScanFlowStructuredDataBarcode = 1 << 3,
 };
 
 #endif

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

@@ -11,7 +11,6 @@
 #import <Foundation/Foundation.h>
 #import <UIKit/UIKit.h>
 
-#import <GSSDK/GSKFilterType.h>
 #import <GSSDK/GSKRotation.h>
 
 NS_ASSUME_NONNULL_BEGIN
@@ -33,9 +32,11 @@ NS_ASSUME_NONNULL_BEGIN
   The document processor is the central class of the GSSDK's image processing algorithms.
 
   With the document processor, you can correct the distortion in your documents, as well as improve their legibility.
-  If you are only interested in the detecting a document in an image, please refer to GSKDocumentDetector.
+  The scan processor can also analyze the scan and evaluate its readability.
 
-  Warning: `GSKScanProcessor` is not thread-safe; you shouldn't reuse the same instance accross threads.
+  If you are only interested in detecting a document in an image, please refer to ``GSKDocumentDetector``. If you are looking to detect whether an image contains a document, use ``GSKDocumentFinder`` instead.
+
+  Warning: `GSKScanProcessor` is not thread-safe; you shouldn't reuse the same instance across threads.
 */
 @interface GSKScanProcessor : NSObject
 
@@ -45,8 +46,8 @@ NS_ASSUME_NONNULL_BEGIN
 
  @param configuration The configuration of the different steps of the processing.
 
- @returns The result of the processing, nil if there is an error. The results includes the parameters that have been selected for the different processing steps,
- as well as the temporary path were the output was written. The output is written in a temporary folder. The caller can take ownership of this file.
+ @returns The result of the processing, nil if there is an error. The result includes the parameters that have been selected for the different processing steps,
+ as well as the temporary path where the output was written. The output is written in a temporary folder. The caller can take ownership of this file.
  By default, the best output format will be chosen by this method. For instance, if the monochrome enhancement was selected, the output will not
  be saved as JPEG but as a 1-bit PNG image. The result's processedImagePath file extension will reflect this.
  */