@thegrizzlylabs/react-native-genius-scan 5.0.0-beta8 → 5.0.0

package/android/build.gradle

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

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

@@ -78,11 +78,4 @@ public class RNGeniusScanModule extends ReactContextBaseJavaModule {
     PluginBridge.setLicenseKey(this.reactContext, licenseKey, autoRefresh);
     promise.resolve(null);
   }
-
-  @SuppressWarnings("unused")
-  @ReactMethod
-  public void setLicenceKey(String licenseKey, Promise promise) {
-    PromiseResult promiseResult = PluginBridge.setLicenseKey(this.reactContext, licenseKey);
-    resolvePromiseWithPromiseResult(promise, promiseResult);
-  }
 }

package/index.js

@@ -7,12 +7,5 @@ const { RNGeniusScan } = NativeModules;
 export default {
   scanWithConfiguration: (scanOptions = {}) => RNGeniusScan.scanWithConfiguration(scanOptions),
   generateDocument: RNGeniusScan.generateDocument,
-  /**
-   * @deprecated
-   */
-  setLicenceKey: (key) => {
-    console.warn("setLicenceKey is deprecated. Please use setLicenseKey instead.")
-    RNGeniusScan.setLicenceKey(key)
-  },
   setLicenseKey: RNGeniusScan.setLicenseKey
 };

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

@@ -10,15 +10,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>
 		<dict>
 			<key>BinaryPath</key>
@@ -26,18 +29,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>
 	</array>
 	<key>CFBundlePackageType</key>

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

@@ -16,7 +16,7 @@ NS_ASSUME_NONNULL_BEGIN
 @class GSKPDFGeneratorConfiguration;
 @class GSKTextLayout;
 
-@protocol GSKPDFImageProcessor;
+@protocol GSKDocumentImageProcessor;
 @protocol GSKLogger;
 
 /**
@@ -24,24 +24,7 @@ NS_ASSUME_NONNULL_BEGIN
 */
 @interface GSK : NSObject
 
-/**
- Must be called first with a valid license key to enable the SDK.
-
- This method returns an error if the SDK isn't initialized properly. In addition, all other SDK methods that return errors will report an error if there
- is a problem with the license key, and you must handle them to ensure you provide a good "degraded" experience.
- For instance, you can prompt the user to update the application to use the scanning feature in case they use a version of the application with an expired license key.
-
- This method is deprecated in favor of `setLicenseKey:autoRefresh:`.
-
- @warning *Important* This method must be called before any use of the SDK methods.
-
- @param licenseKey The license key
- @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 YES if the SDK was initialized successfully, NO if an error occured.
- */
-+ (BOOL)initWithLicenseKey:(NSString *)licenseKey error:(NSError * _Nullable *)error __deprecated_msg("-setLicenseKey:autoRefresh: instead.");
+@property (nonatomic, class, strong, readonly) NSString *version;
 
 /// Sets the Genius Scan SDK license key with auto-refresh enabled.
 ///
@@ -66,58 +49,4 @@ NS_ASSUME_NONNULL_BEGIN
 
 @end
 
-/**
- GSKPDF encapsulate the generation of a PDF document.
- */
-@interface GSKPDF : NSObject
-
-/**
- Write the given PDF document to the specified file path.
-
- @param document The PDF document.
- @param filePath The file path to write the PDF to.
- @param processor An object to preprocess each image before creating the corresponding page. For instance, you can inject a preprocessor to downsample the images.
- @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 YES if the PDF was generated successfully, NO if an error occured.
-
- This method will take some time, proportionally to the number of pages of the PDF document.
- */
-+ (BOOL)generatePDFDocument:(GSKPDFDocument *)document
-                     toPath:(NSString *)filePath
-          withConfiguration:(GSKPDFGeneratorConfiguration *)configuration
-         withImageProcessor:(_Nullable id<GSKPDFImageProcessor>)processor
-                      error:(NSError * _Nullable *)error NS_SWIFT_NAME(generate(_:toPath:configuration:imageProcessor:)) __deprecated_msg("Use GSKDocumentGenerator instead.");
-
-/**
- A convenience shorthand for the previous method with a processor that doesn't apply any change to the images.
- */
-+ (BOOL)generatePDFDocument:(GSKPDFDocument *)document
-                     toPath:(NSString *)filePath
-                      error:(NSError * _Nullable *)error  __deprecated_msg("Use GSKDocumentGenerator instead.");
-
-@end
-
-/**
- GSKTIFF encapsulate the generation of a TIFF document.
- */
-@interface GSKTIFF : NSObject
-
-/**
- Write the given TIFF document to the specified file path.
-
- @param document The TIFF document.
- @param filePath The file path to write the TIFF to.
- @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 YES if the TIFF was generated successfully, NO if an error occured.
-
- This method will take some time, proportionally to the number of pages of the TIFF document.
- */
-+ (BOOL)generateTIFFDocument:(GSKPDFDocument *)document
-                      toPath:(NSString *)filePath
-                       error:(NSError * _Nullable *)error;
-
-@end
-
 NS_ASSUME_NONNULL_END

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

@@ -0,0 +1,24 @@
+//
+//  GSKLicenseKeyChecker.h
+//  GSSDK
+//
+//  Created by Bruno Virlet on 15/03/2024.
+//  Copyright © 2024 The Grizzly Labs. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface GSKLicenseKeyChecker : NSObject
+
++ (BOOL)checkLicenseWithError:(NSError *__autoreleasing  _Nullable * _Nullable)error;
+
+#if DEBUG
+/// Enables simulating an invalid license in the tests. 
+@property (nonatomic, class, assign) BOOL simulateInvalid;
+#endif
+
+@end
+
+NS_ASSUME_NONNULL_END

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

@@ -320,27 +320,47 @@ typedef SWIFT_ENUM(NSInteger, GSKDocumentFinderImageType, closed) {
 };
 
 @class GSKPDFDocument;
+@protocol GSKDocumentImageProcessor;
 @class GSKDocumentGeneratorConfiguration;
 
 /// This class exposes the capacility to generate a PDF document file.
 SWIFT_CLASS("_TtC5GSSDK20GSKDocumentGenerator")
 @interface GSKDocumentGenerator : NSObject
 /// Generates a document file based on a document model and a generator configuration.
-- (BOOL)generate:(GSKPDFDocument * _Nonnull)document configuration:(GSKDocumentGeneratorConfiguration * _Nonnull)configuration error:(NSError * _Nullable * _Nullable)error;
+/// \param document The source document to generate as PDF.
+///
+/// \param imageProcessor An object used to process each source document’s image before inserting it in the resulting document.
+/// Only used when generating a PDF document
+///
+/// \param configuration The configuration for the document generation.
+///
+- (BOOL)generate:(GSKPDFDocument * _Nonnull)document imageProcessor:(id <GSKDocumentImageProcessor> _Nonnull)imageProcessor configuration:(GSKDocumentGeneratorConfiguration * _Nonnull)configuration error:(NSError * _Nullable * _Nullable)error;
 - (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
 @end
 
+enum GSKDocumentGeneratorFileFormat : NSInteger;
 @class NSString;
+@class GSKDocumentGeneratorDebugConfiguration;
 
 /// A configuration for the document generator.
 SWIFT_CLASS("_TtC5GSSDK33GSKDocumentGeneratorConfiguration")
 @interface GSKDocumentGeneratorConfiguration : NSObject
-/// The path where the generated document will be written
+/// The output file format of the document generator. Must be .pdf or .tif.
+@property (nonatomic, readonly) enum GSKDocumentGeneratorFileFormat outputFileFormat;
+/// The path where the generated document will be written. The extension will not be validated.
 @property (nonatomic, readonly, copy) NSString * _Nonnull outputFilePath;
 /// Custom font file used during the PDF generation to embed an invisible text layer.
 /// If nil, a default font is used, which only supports Latin languages.
+/// Only used when <code>outputFileFormat</code> is <code>.pdf</code>.
 @property (nonatomic, readonly, copy) NSString * _Nullable pdfFontFilePath;
-- (nonnull instancetype)initWithOutputFilePath:(NSString * _Nonnull)outputFilePath pdfFontFilePath:(NSString * _Nullable)pdfFontFilePath OBJC_DESIGNATED_INITIALIZER;
+/// Generate a PDF/A document
+@property (nonatomic, readonly) BOOL shouldGeneratePDFA;
+/// An optional debug configuration to help debug PDF generation problems.
+/// Don’t use this in production. Default is nil.
+@property (nonatomic, readonly, strong) GSKDocumentGeneratorDebugConfiguration * _Nullable debugConfiguration;
+- (nonnull instancetype)initWithOutputFileFormat:(enum GSKDocumentGeneratorFileFormat)outputFileFormat outputFilePath:(NSString * _Nonnull)outputFilePath pdfFontFilePath:(NSString * _Nullable)pdfFontFilePath shouldGeneratePDFA:(BOOL)shouldGeneratePDFA debugConfiguration:(GSKDocumentGeneratorDebugConfiguration * _Nullable)debugConfiguration OBJC_DESIGNATED_INITIALIZER;
++ (GSKDocumentGeneratorConfiguration * _Nonnull)pdfConfigurationWithOutputFilePath:(NSString * _Nonnull)outputFilePath SWIFT_WARN_UNUSED_RESULT;
++ (GSKDocumentGeneratorConfiguration * _Nonnull)tiffConfigurationWithOutputFilePath:(NSString * _Nonnull)outputFilePath SWIFT_WARN_UNUSED_RESULT;
 - (nonnull instancetype)init SWIFT_UNAVAILABLE;
 + (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
 @end
@@ -351,6 +371,55 @@ SWIFT_CLASS("_TtC5GSSDK33GSKDocumentGeneratorConfiguration")
 @end
 
 
+SWIFT_CLASS("_TtC5GSSDK38GSKDocumentGeneratorDebugConfiguration")
+@interface GSKDocumentGeneratorDebugConfiguration : NSObject
+/// If true, OCR’ed text will visible on the PDF.
+/// Defaults to false. Use this for debug only
+@property (nonatomic, readonly) BOOL isOCRTextShownOnPDF;
+- (nonnull instancetype)initWithIsOCRTextShownOnPDF:(BOOL)isOCRTextShownOnPDF OBJC_DESIGNATED_INITIALIZER;
+- (nonnull instancetype)init SWIFT_UNAVAILABLE;
++ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
+@end
+
+/// Error raised while generating a multi-page document
+typedef SWIFT_ENUM(NSInteger, GSKDocumentGeneratorError, open) {
+/// An internal error. Look at logs or contact us for more details.
+  GSKDocumentGeneratorErrorInternal SWIFT_COMPILE_NAME("internal") = 0,
+/// A provided file wasn’t found.
+  GSKDocumentGeneratorErrorFileNotFound SWIFT_COMPILE_NAME("fileNotFound") = 1,
+/// The provided password is invalid for use in a PDF file.
+  GSKDocumentGeneratorErrorInvalidPassword SWIFT_COMPILE_NAME("invalidPassword") = 2,
+/// The provided page size is unsupported for a PDF file.
+  GSKDocumentGeneratorErrorInvalidPageSize SWIFT_COMPILE_NAME("invalidPageSize") = 3,
+/// There was an error processing the image associated to a document page.
+  GSKDocumentGeneratorErrorProcessorError SWIFT_COMPILE_NAME("processorError") = 4,
+/// An input to the document generator is invalid.
+  GSKDocumentGeneratorErrorInvalidInput SWIFT_COMPILE_NAME("invalidInput") = 5,
+};
+static NSString * _Nonnull const GSKDocumentGeneratorErrorDomain = @"GSSDK.GSKDocumentGeneratorError";
+
+typedef SWIFT_ENUM(NSInteger, GSKDocumentGeneratorFileFormat, open) {
+  GSKDocumentGeneratorFileFormatPDF SWIFT_COMPILE_NAME("pdf") = 0,
+  GSKDocumentGeneratorFileFormatTIFF SWIFT_COMPILE_NAME("tiff") = 1,
+};
+
+
+/// Used to preprocess pages of the PDF generation.
+/// When you generate a PDF document from images, you may want to apply some preprocessing to each image
+/// before inserting them in the document (for instance resizing them, including a watermark, etc.) You can
+/// implement your own PDF_image_processor and pass it when generating a PDF document.
+/// to achieve this.
+SWIFT_PROTOCOL("_TtP5GSSDK25GSKDocumentImageProcessor_")
+@protocol GSKDocumentImageProcessor
+/// Process the image and return a file path to the
+/// updated image. The PDF processor will delete this temporary
+/// image afterwards (only if it’s different from inputFilePath)
+/// @return nil if there is an error
+- (NSString * _Nullable)process:(NSString * _Nonnull)inputFilePath SWIFT_WARN_UNUSED_RESULT;
+@end
+
+
+
 /// Internal use.
 SWIFT_CLASS("_TtC5GSSDK22GSKLicenseKeyRefresher")
 @interface GSKLicenseKeyRefresher : NSObject
@@ -359,7 +428,7 @@ SWIFT_CLASS("_TtC5GSSDK22GSKLicenseKeyRefresher")
 /// \param baseLicenseKey the license key provided to the customer. This license key must be a valid license key but
 /// may be expired. It will be used to retrieve a fresh license key if needed.
 ///
-- (nonnull instancetype)initWithBaseLicenseKey:(NSString * _Nonnull)baseLicenseKey;
+- (nonnull instancetype)initWithBaseLicenseKey:(NSString * _Nonnull)baseLicenseKey sdkVersion:(NSString * _Nonnull)sdkVersion;
 /// Refreshes the license key.
 /// The updated license key is passed in the <code>onSuccess</code> closure. It may be the same key as the provided key.
 /// In case of failure, the <code>onFailure</code> closure is called.
@@ -373,6 +442,14 @@ SWIFT_CLASS("_TtC5GSSDK22GSKLicenseKeyRefresher")
 
 
 
+
+/// A document image processor that performs no operation and returns the input file as an output
+SWIFT_CLASS("_TtC5GSSDK29GSKNoopDocumentImageProcessor")
+@interface GSKNoopDocumentImageProcessor : NSObject <GSKDocumentImageProcessor>
+- (NSString * _Nullable)process:(NSString * _Nonnull)inputFilePath SWIFT_WARN_UNUSED_RESULT;
+- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
+@end
+
 @protocol GSKLogger;
 @class GSKOCRConfiguration;
 @class GSKOCRResult;
@@ -456,48 +533,6 @@ SWIFT_CLASS("_TtC5GSSDK14GSKPDFDocument")
 - (nullable instancetype)initWithDictionary:(NSDictionary<NSString *, id> * _Nonnull)dictionary error:(NSError * _Nullable * _Nullable)error;
 @end
 
-
-SWIFT_CLASS("_TtC5GSSDK28GSKPDFGeneratorConfiguration")
-@interface GSKPDFGeneratorConfiguration : NSObject
-@property (nonatomic, readonly, copy) NSString * _Nullable fontPath;
-/// An ICC profile file that will be configured on the
-/// PDF file. This is needed to have PDF/A compliance.
-/// It’s a RGB profile so that it supports any RGB or Grayscale
-/// image.
-@property (nonatomic, readonly, copy) NSString * _Nullable iccProfilePath;
-/// If true, OCR’ed text will visible on the PDF.
-/// Defaults to false
-@property (nonatomic, readonly) BOOL debug;
-- (nonnull instancetype)initWithFontPath:(NSString * _Nullable)fontPath iccProfilePath:(NSString * _Nullable)iccProfilePath;
-/// A configuration with the specified font path. This configuration will generate a PDF/A-1 with a default ICC profile.
-/// If you don’t want a PDF/A-1, use <code>initWithFontPath:iccProfilePath:</code> and pass <code>nil</code> for the ICC profile path.
-- (nonnull instancetype)initWithFontPath:(NSString * _Nullable)fontPath;
-- (nonnull instancetype)init SWIFT_UNAVAILABLE;
-+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
-@end
-
-
-/// Used to preprocess pages of the PDF generation.
-/// When you generate a PDF document from images, you may want to apply some preprocessing to each image
-/// before inserting them in the document (for instance resizing them, including a watermark, etc.) You can
-/// implement your own PDF_image_processor and pass it when generating a PDF document.
-/// to achieve this.
-SWIFT_PROTOCOL("_TtP5GSSDK20GSKPDFImageProcessor_")
-@protocol GSKPDFImageProcessor
-/// Process the image and return a file path to the
-/// updated image. The PDF processor will delete this temporary
-/// image afterwards (only if it’s different from inputFilePath)
-/// @return nil if there is an error
-- (NSString * _Nullable)process:(NSString * _Nonnull)inputFilePath SWIFT_WARN_UNUSED_RESULT;
-@end
-
-
-SWIFT_CLASS("_TtC5GSSDK24GSKPDFNoopImageProcessor")
-@interface GSKPDFNoopImageProcessor : NSObject <GSKPDFImageProcessor>
-- (NSString * _Nullable)process:(NSString * _Nonnull)inputFilePath SWIFT_WARN_UNUSED_RESULT;
-- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
-@end
-
 @class GSKPDFSize;
 
 /// Describes a page of a PDF document for the PDF generator.
@@ -642,7 +677,6 @@ SWIFT_CLASS("_TtC5GSSDK24GSKScanFlowConfiguration")
 @end
 
 
-
 @interface GSKScanFlowConfiguration (SWIFT_EXTENSION(GSSDK))
 /// Create a configuration from a dictionary.
 /// This is particularly useful for interfacing with React Native but shouldn’t
@@ -651,6 +685,7 @@ SWIFT_CLASS("_TtC5GSSDK24GSKScanFlowConfiguration")
 @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
@@ -744,7 +779,6 @@ SWIFT_CLASS("_TtC5GSSDK17GSKScanFlowResult")
 
 
 @interface GSKScanFlowResult (SWIFT_EXTENSION(GSSDK))
-@property (nonatomic, readonly, copy) NSURL * _Nullable pdfURL SWIFT_DEPRECATED_MSG("Use multiPageDocumentURL instead");
 /// A dictionary representation of the result.
 /// Convenient for interfacing with React Native, probably no reason to
 /// use it with native code.

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

@@ -19,6 +19,7 @@ FOUNDATION_EXPORT const unsigned char GSSDKVersionString[];
 #import <GSSDK/GSKLog.h>
 #import <GSSDK/GSKLoggerSeverity.h>
 #import <GSSDK/GSKDefaultLogger.h>
+#import <GSSDK/GSKLicenseKeyChecker.h>
 
 // UI
 #import <GSSDK/GSKCameraSession.h>
@@ -39,4 +40,3 @@ FOUNDATION_EXPORT const unsigned char GSSDKVersionString[];
 #import <GSSDK/GSKScanFlowStructuredData.h>
 #import <GSSDK/GSKScanFlowOCROutputFormats.h>
 #import <GSSDK/GSKScanFlowErrorDomain.h>
-#import <GSSDK/GSKPDFGeneratorError.h>