@thegrizzlylabs/react-native-genius-scan 4.21.0 → 5.0.0-beta2

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

@@ -1,410 +0,0 @@
-//
-//  GSKScanFlow.h
-//  GSSDKScanFlow
-//
-//  Created by Bruno Virlet on 4/26/19.
-//
-
-#import <Foundation/Foundation.h>
-#import <UIKit/UIKit.h>
-
-
-NS_ASSUME_NONNULL_BEGIN
-
-FOUNDATION_EXPORT NSErrorDomain const GSKScanFlowErrorDomain;
-
-typedef NS_ENUM(NSInteger, GSKScanFlowError) {
-    /// User has canceled the scan flow
-    GSKScanFlowUserCancelationError = 999,
-    /// A general error due to a bad input parameter. Verify that your input match the API requirements.
-    GSKScanFlowBadInputError = 1000
-};
-
-/**
- The various formats into which the OCR result can be made available.
-
- This is an option set so you can combine multiple formats.
- */
-typedef NS_OPTIONS(NSUInteger, GSKScanFlowOCROutputFormats) {
-    /// No output formats
-    GSKScanFlowOCROutputFormatsNone = 0,
-    /// Output OCR result as raw text
-    GSKScanFlowOCROutputFormatsRawText = 1 << 0,
-    /// Output OCR result in HOCR format
-    GSKScanFlowOCROutputFormatsHOCR = 1 << 1,
-    /// Add OCR result as a text layer in the generated PDF file (if any)
-    GSKScanFlowOCROutputFormatsTextLayerInPDF = 1 << 2,
-    /// All the output formats
-    GSKScanFlowOCROutputFormatsAll = NSUIntegerMax,
-};
-
-/**
- The types of structured data to extract.
- */
-typedef NS_OPTIONS(NSUInteger, GSKScanFlowStructuredData) {
-    GSKScanFlowStructuredDataNone = 0,
-    /// To scan IBAN and BIC/SWIFT codes
-    GSKScanFlowStructuredDataBankDetails = 1 << 0
-};
-
-/**
- The configuration for text recognition
- */
-@interface GSKScanFlowOCRConfiguration : NSObject
-
-/**
- The path to the trained data *folder* (and not file).
-
- The folder must contain trained data files.
- */
-@property (nonatomic, strong) NSString *trainedDataPath;
-
-/**
- The language to process OCR with.
-
- The corresponding trained data files must be present in the folder specified by trainedDataPath.
- */
-@property (nonatomic, strong) NSArray<NSString *> *languageCodes;
-
-/**
- The formats in which the OCR result is made available in the ScanFlow result
-
- Default is everything.
- */
-@property (nonatomic, assign) GSKScanFlowOCROutputFormats outputFormats;
-
-@end
-
-/**
- The source for a scan flow
- */
-typedef NS_ENUM(NSUInteger, GSKScanFlowSource) {
-    /** Scan from the camera */
-    GSKScanFlowSourceCamera,
-    /** Import a file from an URL */
-    GSKScanFlowSourceImageURL,
-    /** Import a file from the library */
-    GSKScanFlowSourceLibrary,
-};
-
-/**
- The different possible filters for the scanner UI.
-
- The possible values match the GSKFilterType values except "automatic".
- */
-typedef NS_ENUM(NSInteger, GSKScanFlowFilterType) {
-    GSKScanFlowFilterAutomatic = 0,
-    GSKScanFlowFilterNone,
-    GSKScanFlowFilterBlackAndWhite,
-    GSKScanFlowFilterColor,
-    GSKScanFlowFilterPhoto,
-    GSKScanFlowFilterMonochrome,
-};
-
-/**
- The various image processing actions available in the post-processing screen.
-
- This is an option set so you can combine multiple actions.
- */
-typedef NS_OPTIONS(NSUInteger, GSKScanFlowPostProcessingActions) {
-    /// No actions
-    GSKScanFlowPostProcessingActionNone = 0,
-    /// The filter action
-    GSKScanFlowPostProcessingActionEditFilter = 1 << 0,
-    /// The rotate scan action
-    GSKScanFlowPostProcessingActionRotate = 1 << 1,
-    /// The distortion (book curvature) correction
-    GSKScanFlowPostProcessingActionDistortionCorrection = 1 << 2,
-    /// All the actions
-    GSKScanFlowPostProcessingActionAll = NSUIntegerMax,
-};
-
-/**
- The generated PDF paper size.
- */
-typedef NS_ENUM(NSUInteger, GSKScanFlowPDFPageSize) {
-    /// PDF page with a width of 8.27 inch (A4 width) and fitting height.
-    GSKScanFlowPDFPageFit,
-    /// ISO A4 (21cm x 29.7cm)
-    GSKScanFlowPDFPageA4,
-    /// US Letter (8.5in x 11in)
-    GSKScanFlowPDFPageLetter,
-};
-
-/**
- The capture screen flash mode
- */
-typedef NS_ENUM(NSUInteger, GSKScanFlowFlashMode) {
-    /// Let the system determine whether to turn on the flash based on the lighting conditions.
-    GSKScanFlowFlashModeAuto,
-    /// Force the flash on.
-    GSKScanFlowFlashModeOn,
-    /// Force the flash off.
-    GSKScanFlowFlashModeOff,
-};
-
-/**
- The format of the exported document.
- */
-typedef NS_ENUM(NSUInteger, GSKScanFlowMultiPageFormat) {
-    GSKScanFlowNone,
-    GSKScanFlowPDF,
-    GSKScanFlowTIFF,
-};
-
-/**
- Enables configuration of the GSKScanFlow.
-
- Set the desired configuration on an instance of GSKScanFlowConfiguration and pass it to the initializer of GSKScanFlow to build the desired scan flow.
- */
-@interface GSKScanFlowConfiguration : NSObject
-
-/**
- Specifies the source for the scanned documents (eg. the camera, …).
-
- If source is GSKScanFlowSourceImageURL, you must provide the sourceImageURL parameter.
- */
-@property (nonatomic, assign) GSKScanFlowSource source;
-
-/**
- The image URL if source is GSKScanFlowSourceImageURL.
- */
-@property (nonatomic, strong) NSURL *sourceImageURL;
-
-/**
- Multipage mode. Only apply when the source is GSKScanFlowSourceCamera.
-
- When the multipage mode is active, the user will have the opportunity to snap multiple scans in a row and the output document will contain all these pages.
-
- When multipage mode is off, the user will only scan a single page. The output document will always contain a single page.
-
- Defaults to YES.
- */
-@property (nonatomic, assign) BOOL multiPage;
-
-/**
- Force the use of a specific post processing.
-
- Defaults to GSKFilterAutomatic.
- */
-@property (nonatomic, assign) GSKScanFlowFilterType defaultFilter;
-
-/**
- Skips showing the post-processing screen.
-
- We only recommend this option when scanning structured data. Generally, you want the user to visually confirm
- the quality of the scan.
- */
-@property (nonatomic, assign) BOOL skipPostProcessingScreen;
-
-/**
- Select which actions are displayed in the post processing screen
-
- Default is everything.
- */
-@property (nonatomic, assign) GSKScanFlowPostProcessingActions postProcessingActions;
-
-/**
- Determines the size of the pages when generating the PDF.
-
- Default is GSKScanFlowPDFPageFit
- */
-@property (nonatomic, assign) GSKScanFlowPDFPageSize pdfPageSize;
-
-/**
- Determines the visibility of the flash button
- */
-@property (nonatomic, assign) BOOL flashButtonHidden;
-
-/**
- Determines the default flash mode.
-
- Combine with flashButtonHidden if you want to only allow a specific
- flash mode.
-
- Defaults to GSKScanFlowFlashModeAuto
- */
-@property (nonatomic, assign) GSKScanFlowFlashMode defaultFlashMode;
-
-/**
- Determines the document format.
-
- Defaults to GSKScanFlowPdf.
- */
-@property (nonatomic, assign) GSKScanFlowMultiPageFormat multiPageFormat;
-
-/**
- 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.
- */
-@property (nonatomic, strong) NSURL *pdfFontFileURL;
-
-/**
- UI background color.
-
- Default is black.
- */
-@property (nonatomic, copy) UIColor *backgroundColor;
-
-/**
- UI foreground color (text and icons)
-
- Default is white.
- */
-@property (nonatomic, copy) UIColor *foregroundColor;
-
-/**
- UI highlight color (document detection overlay)
-
- Default is dark blue.
- */
-@property (nonatomic, copy) UIColor *highlightColor;
-
-/**
- UI menu color
-
- Default is system's default (eg. blue on iOS)
- */
-@property (nonatomic, copy) UIColor *menuColor;
-
-/**
- JPEG quality used to compress captured images. Between 0 and 100, 100 being the best quality.
- 
- Default is 60
- */
-@property (nonatomic, assign) NSInteger jpegQuality;
-
-/**
- Max scan dimension in pixels when generating the PDF file. All scans included in the PDF file
- will be scaled so that both their height and width are smaller than this value, while keeping
- their aspect ratio.
- 
- Default is 0, which means no scaling is applied.
- */
-@property (nonatomic, assign) NSInteger pdfMaxScanDimension;
-
-/**
- The configuration for Optical Character Recognition.
-
- Default is nil, which means no OCR is performed.
- */
-@property (nonatomic, strong, nullable) GSKScanFlowOCRConfiguration *ocrConfiguration;
-
-/**
- The types of structured data you want to extract from the document.
-
- This is an option set so you can combine multiple values.
- */
-@property (nonatomic, assign) GSKScanFlowStructuredData structuredData;
-
-@end
-
-/**
- The result of the text recognition.
-*/
-@interface GSKScanFlowOCRResult: NSObject
-
-/** The raw text recognized in the document */
-@property (nonatomic, strong, nullable) NSString *text;
-
-/** The text layout of the recognized text */
-@property (nonatomic, strong, nullable) NSString *hocrTextLayout;
-
-@end
-
-@interface GSKScanFlowStructuredDataResultBankDetails: NSObject
-
-/// The IBAN if successfully extracted, otherwise is nil.
-@property (nonatomic, strong, nullable) NSString *iban;
-
-/// The BIC code if successfully extracted, otherwise is nil.
-@property (nonatomic, strong, nullable) NSString *bic;
-
-@end
-
-/**
- The result of a structured data extraction.
- */
-@interface GSKScanFlowStructuredDataResult: NSObject
-
-/// Present if bank details extraction was requested, nil otherwise.
-@property (nonatomic, strong, nullable) GSKScanFlowStructuredDataResultBankDetails *bankDetails;
-
-@end
-
-/**
- A page captured by the scan flow.
-*/
-@interface GSKScanFlowScan : NSObject
-
-/// The original JPEG out of the camera.
-///
-/// Note that this image might be rotated, and needs to be read with its EXIF orientation to be properly displayed.
-/// UIImage's methods will properly take care of that.
-@property (nonatomic, strong) NSString *originalFilePath;
-
-/// The enhanced, processed, image.
-@property (nonatomic, strong) NSString *enhancedFilePath;
-
-/// If OCR was performed, the recognized text.
-@property (nonatomic, strong, nullable) GSKScanFlowOCRResult *ocrResult;
-
-/// If structured data extraction was performed, the structured data.
-@property (nonatomic, strong, nullable) GSKScanFlowStructuredDataResult *structuredDataResult;
-
-@end
-
-/**
- The result of a scan flow
- */
-@interface GSKScanFlowResult : NSObject
-
-/**
- The PDF generated at the end of the scan flow
- */
-@property (nonatomic, strong) NSURL *pdfURL DEPRECATED_MSG_ATTRIBUTE("Use multiPageDocumentURL instead");
-
-/**
- * Document containing the pages that were scanned during the scan flow.
- * The format is specified by `multiPageFormat` property of the used `GSKScanFlowConfiguration`.
- * Is null if no format was specified or if generation failed.
- */
-@property (nonatomic, strong, nullable) NSURL* multiPageDocumentURL;
-
-/**
- The individual scans taken during the scan flow.
-
- Each scan object contains both the original and the enhanced scans.
- */
-@property (nonatomic, strong) NSArray<GSKScanFlowScan *> *scans;
-@end
-
-/**
- A high-level scanner module.
-
- You present it and when the user is done, you obtain a result object containing the scanned documents.
-
- The scan flow can be customized with a GSKScanFlowConfiguration.
- */
-@interface GSKScanFlow : NSObject
-
-/**
- Instantiates a GSKScanFlow with the provided configuration.
-
- @param configuration The provided configuration
- */
-+ (instancetype)scanFlowWithConfiguration:(GSKScanFlowConfiguration *)configuration;
-
-/**
- Present the scan flow.
-
- @param viewController The view controller to present the scan flow from.
- @param completionBlock A completion block that will be called on the main thread upon completion of the scan flow. It received a GSKScanFlowResult object as a parameter. This object gives you access to the scanned documents.
- @param errorBlock A block called upon error
- */
-- (void)startFromViewController:(UIViewController *)viewController onSuccess:(void (^_Nonnull)(GSKScanFlowResult *))completionBlock failure:(void (^_Nonnull)(NSError *))errorBlock;
-
-@end
-
-NS_ASSUME_NONNULL_END

package/ios/GSSDK/GSSDKScanFlow.xcframework/ios-arm64/GSSDKScanFlow.framework/Headers/GSKScanFlowConfiguration+Dictionary.h

@@ -1,27 +0,0 @@
-//
-//  GSKScanFlowConfiguration+Dictionary.h
-//  GSSDKScanFlow
-//
-//  Created by Bruno Virlet on 5/9/19.
-//
-
-#import <GSSDKScanFlow/GSSDKScanFlow.h>
-
-NS_ASSUME_NONNULL_BEGIN
-
-@interface GSKScanFlowConfiguration (Dictionary)
-
-/**
- This method creates a configuration from a dictionary.
-
- This is particularly useful for interfacing with React Native but this
- shouldn't be used in native projects.
-
- @param dictionary The configuration dictionary
- @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.
- */
-+ (instancetype _Nullable)configurationWithDictionary:(NSDictionary *)dictionary error:(NSError * _Nullable *)error;
-
-@end
-
-NS_ASSUME_NONNULL_END

package/ios/GSSDK/GSSDKScanFlow.xcframework/ios-arm64/GSSDKScanFlow.framework/Headers/GSKScanFlowResult+Dictionary.h

@@ -1,23 +0,0 @@
-//
-//  GSKScanFlow+Dictionary.h
-//  GSSDKScanFlow
-//
-//  Created by Bruno Virlet on 5/9/19.
-//
-
-#import <GSSDKScanFlow/GSSDKScanFlow.h>
-
-NS_ASSUME_NONNULL_BEGIN
-
-@interface GSKScanFlowResult (Dictionary)
-
-/**
- A dictionary representation of the result.
-
- Convenient for interfacing with React Native, probably no reason to use it with native code.
- */
-@property (nonatomic, strong, readonly) NSDictionary<NSString *, id> *dictionary;
-
-@end
-
-NS_ASSUME_NONNULL_END

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

@@ -1,63 +0,0 @@
-//
-//  Scan.h
-//  GSSDKDemo
-//
-//  Created by Bruno Virlet on 6/2/16.
-//  Copyright © 2016 The Grizzly Labs. All rights reserved.
-//
-
-#import <Foundation/Foundation.h>
-
-#import <GSSDKCore/GSSDKCore.h>
-
-NS_ASSUME_NONNULL_BEGIN
-
-@class GSKOCRResult;
-
-/**
- The output result from the scan flow.
- */
-@interface GSKScanFlowScanInternal : NSObject
-
-- (instancetype)init NS_UNAVAILABLE;
-- (instancetype)initWithOriginalFilePath:(NSString *)originalFilePath;
-
-/// The original JPEG out of the camera.
-///
-/// Note that this image might be rotated, and needs to be read with its EXIF orientation to be properly displayed.
-/// UIImage's methods will properly take care of that.
-@property (nonatomic, copy, readonly) NSString *originalFilePath;
-
-/// The enhanced, processed, image.
-@property (nonatomic, strong) NSString *enhancedFilePath;
-
-/// Convenient way to access the original image as an UIImage
-- (UIImage *)originalImage;
-
-/// Convenient way to access the processed image as an UIImage
-- (UIImage *)enhancedImage;
-
-/// The quadrangle that was applied during the scan flow
-@property (nonatomic, strong) GSKQuadrangle *appliedQuadrangle;
-
-/// The filter that was applied during the scan flow
-@property (nonatomic, assign) GSKFilterType appliedFilter;
-
-/// The rotation that was applied during the scan flow
-@property (nonatomic, assign) GSKRotation appliedRotation;
-
-/// If OCR was performed, the recognized text.
-@property (nonatomic, strong, nullable) GSKOCRResult *ocrResult;
-
-/// If bank details extraction was performed and successful, the extracted IBAN, otherwise nil.
-@property (nonatomic, strong, nullable) NSString *structuredDataIBAN;
-/// If bank details extraction was performed and successful, the extracted BIC, otherwise nil.
-@property (nonatomic, strong, nullable) NSString *structuredDataBIC;
-
-/// Deletes all the files related to this scan. Convenient to clean up after you copied
-/// what you needed.
-- (void)delete;
-
-@end
-
-NS_ASSUME_NONNULL_END