react-native-scanbot-barcode-scanner-sdk 4.0.4 → 4.2.0-beta.2

package/ios/Utils/ScanbotStorageUtils.h

@@ -1,25 +0,0 @@
-//
-//  Scanbot Barcode Scanner SDK React Native Plugin
-//
-//  Copyright (c) 2023 Scanbot SDK GmbH. All rights reserved.
-//  https://scanbot.io/sdk
-//
-
-static NSString *const pluginStorageSubDirectory = @"sbsdk-plugin-storage";
-
-@interface ScanbotStorageUtils : NSObject
-
-+ (int) defaultImageQuality;
-
-+ (NSURL *)pluginStorageDirectoryURL;
-+ (NSString *)pluginStorageDirectoryPath;
-+ (BOOL)pluginStorageDirectoryExists;
-+ (NSString *)generateFileName:(NSString *)extension;
-+ (NSString *)generatePluginStorageFilePath:(NSString*)extension;
-+ (NSError *)removeAllFilesFromPluginStorageDirectory;
-
-+ (UIImage *)loadImage:(NSString *)imageFilePath;
-+ (BOOL)saveImage:(NSString *)imageFilePath image:(UIImage *)image quality:(CGFloat)quality;
-+ (BOOL)imageFileExists:(NSString *)imageFileUri;
-
-@end

package/ios/Utils/ScanbotStorageUtils.m

@@ -1,111 +0,0 @@
-//
-//  Scanbot Barcode Scanner SDK React Native Plugin
-//
-//  Copyright (c) 2023 Scanbot SDK GmbH. All rights reserved.
-//  https://scanbot.io/sdk
-//
-
-#import "ScanbotStorageUtils.h"
-#import "LoggingUtils.h"
-
-@implementation ScanbotStorageUtils
-
-+ (int)defaultImageQuality {
-    return 90;
-}
-
-+ (NSURL *)pluginStorageDirectoryURL {
-    return [NSURL fileURLWithPath: [ScanbotStorageUtils pluginStorageDirectoryPath] isDirectory:YES];
-}
-
-+ (NSString *)pluginStorageDirectoryPath {
-    NSString* pluginStorageDirectoryPath;
-
-    NSString* customStorageBaseDirectoryUrl = [SharedConfiguration defaultConfiguration].configuration.storageBaseDirectory;
-    if (customStorageBaseDirectoryUrl) {
-        NSString* customStorageBaseDirectoryPath = [NSURL URLWithString: customStorageBaseDirectoryUrl].path;
-        pluginStorageDirectoryPath = [NSString stringWithFormat:@"%@/%@", customStorageBaseDirectoryPath, pluginStorageSubDirectory];
-    } else {
-        NSString* defaultStorageBaseDirectory = [ScanbotStorageUtils scanbotSDKApplicationSupportFolder].path;
-        pluginStorageDirectoryPath = [NSString stringWithFormat:@"%@/%@", defaultStorageBaseDirectory, pluginStorageSubDirectory];
-    }
-
-    [ScanbotStorageUtils recreateFolderIfNeeded:pluginStorageDirectoryPath];
-    return pluginStorageDirectoryPath;
-}
-
-+ (BOOL)pluginStorageDirectoryExists {
-    return [[NSFileManager defaultManager] fileExistsAtPath:[ScanbotStorageUtils pluginStorageDirectoryPath]];
-}
-
-+ (NSURL *)applicationSupportFolderURL {
-    NSArray *paths = NSSearchPathForDirectoriesInDomains(NSApplicationSupportDirectory, NSUserDomainMask, YES);
-    return [NSURL fileURLWithPath:(NSString *)paths.firstObject isDirectory:YES];
-}
-
-+ (NSURL *)scanbotSDKApplicationSupportFolder {
-    NSURL *url = [ScanbotStorageUtils applicationSupportFolderURL];
-    return [url URLByAppendingPathComponent:@"io.scanbot.sdk" isDirectory:YES];
-}
-
-+ (void)recreateFolderIfNeeded:(NSString *)folderPath {
-    if (![[NSFileManager defaultManager] fileExistsAtPath:folderPath]) {
-        [[NSFileManager defaultManager] createDirectoryAtPath:folderPath
-                                  withIntermediateDirectories:YES
-                                                   attributes:nil
-                                                        error:nil];
-    }
-}
-
-+ (NSString *)generateFileName:(NSString *)extension {
-    NSUUID *UUID = [NSUUID UUID];
-    NSString *stringUUID = [[UUID UUIDString] lowercaseString];
-    return [NSString stringWithFormat:@"%@.%@", stringUUID, extension];
-}
-
-+ (NSString *)generatePluginStorageFilePath:(NSString *)extension {
-    NSString *pluginStoragePath = [ScanbotStorageUtils pluginStorageDirectoryPath];
-    return [NSString stringWithFormat:@"%@/%@", pluginStoragePath, [ScanbotStorageUtils generateFileName:extension]];
-}
-
-+ (UIImage *)loadImage:(NSString *)imageFilePath {
-    NSData *data = [NSData dataWithContentsOfFile:imageFilePath];
-    if (!data) {
-        data = [NSData dataWithContentsOfURL:[NSURL URLWithString:imageFilePath]];
-    }
-    if (data) {
-        return [UIImage imageWithData:data];
-    } else {
-        SBSDKLogger(@"Loading image from path %@ failed.", imageFilePath);
-        return nil;
-    }
-}
-
-+ (BOOL)saveImage:(NSString *)imageFilePath image:(UIImage *)image quality:(CGFloat)quality {
-    NSData *imageData = UIImageJPEGRepresentation(image, quality);
-    return [imageData writeToFile:imageFilePath atomically:YES];
-}
-
-+ (NSError *)removeAllFilesFromPluginStorageDirectory {
-    NSString *pluginStoragePath = [ScanbotStorageUtils pluginStorageDirectoryPath];
-    NSFileManager *fileManager = [NSFileManager new];
-    NSDirectoryEnumerator *enumerator = [fileManager enumeratorAtPath:pluginStoragePath];
-    NSError *err = nil;
-    BOOL result;
-
-    NSString *fileName;
-    while (fileName = [enumerator nextObject]) {
-        result = [fileManager removeItemAtPath:[pluginStoragePath stringByAppendingPathComponent:fileName] error:&err];
-        if (!result && err) {
-            SBSDKLogger(@"Cleanup encountered an error: %@", err);
-            break;
-        }
-    }
-    return err;
-}
-
-+ (BOOL)imageFileExists:(NSString *)imageFileUri {
-    return [[NSFileManager defaultManager] fileExistsAtPath:[NSURL URLWithString:imageFileUri].path];
-}
-
-@end

package/src/configuration.ts

@@ -1,328 +0,0 @@
-/*
-  Scanbot Barcode Scanner SDK React Native Plugin
-  Copyright (c) 2023 Scanbot SDK GmbH. All rights reserved.
-  https://scanbot.io/sdk
- */
-import { FinderAspectRatio, SelectionOverlayConfiguration } from "./model";
-import {
-  BarcodeDocumentFormat,
-  BarcodeFormat,
-  BarcodeImageGenerationType,
-  UIInterfaceOrientationMask,
-  EngineMode,
-  CameraModule,
-  BarcodeFilter,
-  CodeDensity,
-  CameraPreviewMode,
-} from "./enum";
-import { MSIPlesseyChecksumAlgorithm } from "./enum";
-
-/**
- * An interface that contains all the Barcode Scanning configurations.
- */
-export interface BarcodeScannerConfiguration extends InternalBarcodeDetectionCommonParameters, BarcodeAdditionalParameters {
-  /**
-   * iOS only: String being displayed on the flash button
-   */
-  flashButtonTitle?: string;
-  /**
-   * Foreground color of the flash button when the flash is off.
-   */
-  flashButtonInactiveColor?: string;
-  /**
-   * Specifies the way a barcode image is generated or disables this generation altogether.
-   * Use if you want to receive a full sized image with barcodes. Defaults to NONE.
-   * 
-   * Note: This property has no effect if overlayConfiguration.overlayEnabled is set to `true`
-   * With the tracking overlay enabled, barcode images cannot be generated.
-   */
-  barcodeImageGenerationType?: BarcodeImageGenerationType;
-  /**
-   * Freezes a preview after a scan for a given amount of seconds. Defaults to 0 secs. Android only. 
-   */
-  delayAfterScan?: number;
-  /*
-  * Sets auto close timer in seconds. 0 = disabled and it is the default value.
-  */
-  autoCancelTimeout?: number;
-}
-
-/**
- * An interface that contains all the Batch Barcode Scanning configurations.
- */
-export interface BatchBarcodeScannerConfiguration extends InternalBarcodeDetectionCommonParameters, BarcodeAdditionalParameters {
-  /**
-   * String used for displaying the numer of scanned barcodes. Use %d for number formatting symbol.
-   */
-  barcodesCountText?: string;
-  /**
-   * Text color of the barcodes count label.
-   */
-  barcodesCountTextColor?: string;
-  /**
-   * String being displayed on the clear button.
-   */
-  clearButtonTitle?: string;
-  /**
-   * String being displayed on the delete button.
-   */
-  deleteButtonTitle?: string;
-  /**
-   * Foreground color of the top bar buttons on the details screen.
-   */
-  detailsActionColor?: string;
-  /**
-   * Background color of the details screen.
-   */
-  detailsBackgroundColor?: string;
-  /**
-   * Text color in the details barcodes list. Also affects image background, separator and progress spinner.
-   */
-  detailsPrimaryColor?: string;
-  /**
-   * String used to show the process of fetching mapped data for barcodes.
-   */
-  fetchingStateText?: string;
-  /**
-   * String to show that no barcodes were scanned yet.
-   */
-  noBarcodesTitle?: string;
-  /**
-   * String being displayed on the submit button.
-   */
-  submitButtonTitle?: string;
-  /**
-   * Foreground color of the flash button when the flash is off.
-   */
-  topBarButtonsInactiveColor?: string;
-}
-
-
-/**
- * An interface that contains parameters for Detection of barcodes from images.
- */
-export interface DetectBarcodesOnImageArguments
-  extends InternalBarcodeDetectionCommonParameters {
-  /**
-   * The input image file URI.
-   */
-  imageFileUri: string;
-}
-
-/**
- * An interface that contains Common parameters for barcodes detection and filtering.
- */
-interface InternalBarcodeDetectionCommonParameters {
-  /**
-   * An optional array of barcode document formats that acts as a detection filter.
-   * By default all supported document formats will be detected.
-   */
-  acceptedDocumentFormats?: BarcodeDocumentFormat[];
-  /**
-   * Allowed orientations for automatic interface rotations.
-   */
-  allowedInterfaceOrientations?: UIInterfaceOrientationMask;
-  /**
-  * Background color of the detection overlay.
-  */
-  cameraOverlayColor?: string;
-  /**
-  * Whether the cancel button is hidden or not.
-  */
-  cancelButtonHidden?: boolean;
-  /**
-   * String being displayed on the cancel button.
-   */
-  cancelButtonTitle?: string;
-  /**
-  * Foreground color of the detection overlay.
-  */
-  finderLineColor?: string;
-  /**
-   * Width of the finder frame border. Default is 2.
-   */
-  finderLineWidth?: number;
-  /**
-   * String being displayed as the description label.
-   */
-  finderTextHint?: string;
-  /**
-   * Foreground color of the description label.
-   */
-  finderTextHintColor?: string;
-  /**
-   * Aspect ratio of the finder frame (width \ height), which is used to build the actual finder frame.
-   * Default is 1 - which is a square frame (good for QR capturing).
-   */
-  finderAspectRatio?: FinderAspectRatio;
-  /**
-  * Whether the flash is toggled on or off.
-  */
-  flashEnabled?: boolean;
-  /** 
-  * Disables auto-focus and locks the lens at the specified focus lock lens position. Default value is false. iOS only. For Android, minFocusDistanceLock can be used. 
-  */
-  focusLockEnabled?: boolean;
-  /**
-   * iOS Only: Whether the flash button should be visible or not in the UI.
-   */
-  flashButtonHidden?: boolean;
-  /**
-   * Accepted barcode formats.
-   */
-  barcodeFormats?: BarcodeFormat[];
-  /** 
-   * Use a filter to determine which type of barcode can be detected; see `BarcodeFilter`
-   */
-  barcodeFilter?: BarcodeFilter;
-  /**
-   * Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE.
-   * Android only.
-   */
-  useButtonsAllCaps?: boolean;
-  /**
-   * The preferred camera module (default: BACK).
-   */
-  cameraModule?: CameraModule;
-  /**
-   * Background color of the top bar.
-   */
-  topBarBackgroundColor?: string;
-  /**
-   * Foreground color of the top bar buttons on the scanning screen.
-   */
-  topBarButtonsColor?: string;
-  /**
-   * The relative initial zoom level of the camera in the range [0,1], where 0 is zoomed out and 1 is zoomed in.
-   * The default value is 0.
-   */
-  cameraZoomFactor?: number;
-  /**
-   * The engine mode of the barcode recognizer. Defaults to NEXT_GEN.
-   * To use the legacy recognizer, please specify LEGACY.
-   */
-  engineMode?: EngineMode;
-  /**
-   * Whether a sound should be played on successful barcode detection.
-   */
-  successBeepEnabled?: boolean;
-  /**
-   * If `true`, replaces the cancel button in the top bar with a back arrow icon
-   * The default is `false`.
-   * Android only.
-   */
-  replaceCancelButtonWithIcon?: boolean;
-  /**
-   * The configuration for barcode overlays.
-   */
-  overlayConfiguration?: SelectionOverlayConfiguration;
-  /**
-   * Set `true` to enable showing the area of interest on camera preview. Enabled by default.
-   */
-  viewFinderEnabled?: boolean
-  /** 
-   * Title of the button that opens the screen where the user can allow the usage of the camera by the app. 
-   * */
-  enableCameraButtonTitle?: string;
-  /** 
-   * Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera. 
-   * */
-  enableCameraExplanationText?: string;
-  /**
-   * The position of the lens. Values can be between 0.0f (minimum focusing distance) and 1.0f (maximum focusing distance). 
-   * The value will be clamped to (0.0f, 1.0f). The default value is 0.0. iOS only. For Android, minFocusDistanceLock can be used.
-   * */
-  focusLockPosition?: number;
-  /*
-  * Lock focus distance withing minimum possible range. Android only.
-  */
-  minFocusDistanceLock?: boolean;
-  /*
-  * Preview mode of the camera. FILL_IN or FIT_IN. Default is FILL_IN. Android only 
-  */
-  cameraPreviewMode?: CameraPreviewMode;
-  /*
-  * The range of valid camera zoom factors.
-  * For iOS it ranges between 1.0 to 12.0. Default value is (1.0; 12.0).
-  * For Android it ranges between 0.0 to 1.0.
-  */
-  cameraZoomRange?: ZoomRange;
-  /*
-  * Scanning delay after scanner appearance in seconds. Defaults to 0 secs. 
-  */
-  initialScanDelay?: number;
-  /*
-  * When this property is set to true, the zoom can be activated by double tapping somewhere in the receivers view. iOS only. 
-  */
-  doubleTapToZoomEnabled?: boolean;
-  /*
-  * When this property is set to true, the zoom can be activated by a pinch gesture somewhere in the receivers view. iOS only. 
-  */
-  pinchToZoomEnabled?: boolean;
-  /*
-  * Defines, if zooming in or out should be animated. iOS only. 
-  */
-  shouldAnimateZooming?: boolean;
-}
-
-/**
- * An interface that contains additional parameters for barcodes detection and filtering.
- */
-export interface BarcodeAdditionalParameters {
-  /**
-  * If `true`, enables the mode which slightly decreases the scanning quality and the energy consumption, thus increasing the scanning speed.
-  * The default is `false`.
-  * Android only.
-  */
-  lowPowerMode?: boolean;
-  /**
-   * Optional minimum required text length of the detected barcode.
-   * The default is 0 (setting is turned off).
-   * NOTE: This feature works on ITF and MSI Plessey barcodes only.
-   */
-  minimumTextLength?: number;
-  /**
-   * Optional maximum required text length of the detected barcode.
-   * The default is 0 (setting is turned off).
-   * NOTE: This feature works on ITF and MSI Plessey barcodes only.
-   */
-  maximumTextLength?: number;
-  /**
-   * Optional minimum required quiet zone on the barcode.
-   * Measured in modules (the size of narrowest bar in the barcode).
-   * The default is 10.
-   * NOTE: This feature works on ITF and MSI Plessey barcodes only.
-   */
-  minimum1DBarcodesQuietZone?: number;
-  /**
-   * With this option enabled, the scanner removes check digits for UPC, EAN and MSI Plessey codes.
-   * Has no effect if both single and double digit MSI Plessey checksums are enabled.
-   * The default is `false`.
-   */
-  stripCheckDigits?: boolean;
-  /**
-   * When set to `true`, the scanner assumes that the barcode can be a GS1 barcode.
-   * Turn it off if you don't want to see decoded FNC1 characters ("]C1" and ASCII char 29).
-   * The default value is `true`.
-   * NOTE: Currently works for CODE128 barcodes only!
-   */
-  gs1DecodingEnabled?: boolean;
-  /**
-   * The checksum algorithm for MSI Plessey barcodes.
-   * The default value is [MSIPlesseyChecksumAlgorithm.Mod10].
-   */
-  msiPlesseyChecksumAlgorithm?: MSIPlesseyChecksumAlgorithm;
-  /**
-   * Low density. Finds up to 6 QR codes in one image or video frame. This is the default value.
-   * High density. Finds up to 24 QR codes in one image or video frame.
-   */
-  codeDensity?: CodeDensity;
-}
-
-/** Defines a range for zooming */
-export interface ZoomRange {
-  /** The minimum zoom scale. Defaults to 1.0. */
-  minZoom: number;
-  /** The maximum zoom scale. Defaults to 3.0. */
-  maxZoom: number;
-}

package/src/enum.ts

@@ -1,106 +0,0 @@
-/*
-  Scanbot Barcode Scanner SDK React Native Plugin
-  Copyright (c) 2023 Scanbot SDK GmbH. All rights reserved.
-  https://scanbot.io/sdk
- */
-
-export type Status = "OK" | "CANCELED";
-
-/** The SDK license status */
-export type LicenseStatus =
-  /** License is valid and accepted. */
-  | 'Okay'
-  /** No license set yet. The SDK is in trial mode. */
-  | 'Trial'
-  /** No license set yet. The SDKs trial mode is over. */
-  | 'Expired'
-  /** No license active. The set license does not cover the current operating system. */
-  | 'WrongOS'
-  /** No license active. The set license was unreadable or has an invalid format. */
-  | 'Corrupted'
-  /** No license active. The set licenses does not cover the current apps bundle identifier. */
-  | 'AppIDMismatch'
-  /** No license set yet. The SDKs trial mode is over. */
-  | 'NotSet'
-  /** License status is unknown. */
-  | 'Unknown';
-
-export type CameraImageFormat = "JPG" | "PNG";
-export type DocumentDetectorMode = "EDGE_BASED" | "ML_BASED";
-export type FileEncryptionMode = "AES128" | "AES256";
-
-export type UIInterfaceOrientationMask =
-      "ALL" | 
-      "PORTRAIT" |
-      "LANDSCAPE";
-    
-export type BarcodeImageGenerationType =
-    "NONE" |
-    "VIDEO_FRAME" |
-    "CAPTURED_IMAGE";
-
-export type BarcodeDocumentFormat =
-    "AAMVA" |
-    "BOARDING_PASS" |
-    "DE_MEDICAL_PLAN" |
-    "MEDICAL_CERTIFICATE" |
-    "ID_CARD_PDF_417" |
-    "SEPA" |
-    "SWISS_QR" |
-    "VCARD" |
-    "GS1" ;
-
-export type BarcodeFormat =
-    "AZTEC" |
-    "CODABAR" |
-    "CODE_39" |
-    "CODE_93" |
-    "CODE_128" |
-    "DATA_MATRIX" |
-    "EAN_8" |
-    "EAN_13" |
-    "ITF" |
-    "PDF_417" |
-    "QR_CODE" |
-    "RSS_14" |
-    "RSS_EXPANDED" |
-    "UPC_A" |
-    "UPC_E" |
-    "UNKNOWN" |
-    "IATA_2_OF_5" |
-    "INDUSTRIAL_2_OF_5" |
-    "MSI_PLESSEY" |
-    "CODE_25" |
-    "MICRO_QR_CODE";
-
-export type EngineMode = "LEGACY" | "NEXT_GEN";
-
-export type MSIPlesseyChecksumAlgorithm =
-    "None" |
-    "Mod10" |
-    "Mod11IBM" |
-    "Mod11NCR" |
-    "Mod1010" |
-    "Mod1110IBM" |
-    "Mod1110NCR";
-
-export type CameraModule = 'FRONT' | 'BACK';
-
-export type BarcodeFilter = 
-    'WithExtension' |
-    'WithEAN2Extension' |
-    'WithEAN5Extension';
-
-export type CodeDensity = 'LOW' | 'HIGH';
-
-export type BarcodeOverlayFormat =  'NONE' |
-                                    'CODE' |
-                                    'CODE_AND_TYPE';
-
-/** Represents camera preview modes */
-export type CameraPreviewMode =
-/** In this mode camera preview frames will be downscaled to the layout view size - full preview frame content will be visible, but unused edges could be appeared in the preview layout. */
-'FIT_IN' |
-/** In this mode camera preview frames fill the layout view - the preview frames may contain additional content on the edges that was not visible in the preview layout. */
-'FILL_IN';
-

package/src/model.ts

@@ -1,104 +0,0 @@
-import { BarcodeOverlayFormat, CameraImageFormat, LicenseStatus } from "./enum";
-
-export interface InitializationOptions {
-    /**
-    * The Scanbot SDK License Key
-    */
-    licenseKey: string;
-    /**
-    * If 'true' it enables logging.
-    * Consider switching logging OFF in production builds for security and performance reasons!
-    */
-    loggingEnabled?: boolean;
-    /**
-    * Enables Scanbot SDK Core native logging (default is false; Android only)
-    */
-    enableNativeLogging?: boolean;
-    /**
-    * The quality of stored images, from (1 to 100). Defaults to 80.
-    */
-    storageImageQuality?: number;
-    /**
-    * The preferred format for stored images.
-    */
-    storageImageFormat?: CameraImageFormat;
-    /**
-    * Optional custom storage path.
-    */
-    storageBaseDirectory?: string;
-    /**
-    * If set to `false`, GPU Acceleration will be disabled for Barcode Scanner, 
-    * Document Scanner and Generic Document Recognizer (Android Only).
-    * Default is `true`.
-    */
-    allowGpuAcceleration?: boolean;
-    /**
-    * If set to `true`, Camera X will be used for the RTU-UI components (Android Only)
-    * Default is `false`.
-     */
-    useCameraX?: boolean;
-    /**
-     * Enables/disables XNNPACK acceleration for TensorFlow ML models, which provides
-     * highly optimized implementations of floating-point neural network operators (Android only)
-     * Default is `true`.
-     */
-    allowXnnpackAcceleration?: boolean;
-}
-
-export interface LicenseInfo {
-    isLicenseValid: boolean;
-    licenseStatus: LicenseStatus;
-    licenseExpirationDate?: number;
-}
-
-export interface FinderAspectRatio {
-    width: number;
-    height: number;
-}
-
-/**
- * The Selection Overlay configuration interface for setting overlay over the barcode while ongoing detection.
- */
-export interface SelectionOverlayConfiguration {
-    /**
-     * Displays an augmented reality view that draws the frames, content and type text 
-     * of the found barcodes when it finds them. Defaults to NO.
-     */
-    overlayEnabled: boolean;
-    /**
-     * The text format for the results overlays. 
-     * The default text format on iOS is 'CODE' and on Android is 'CODE_AND_TYPE'
-     */
-    overlayTextFormat?: BarcodeOverlayFormat;
-    /**
-     * The color for the results overlays polygons.
-     */
-    polygonColor: string;
-    /**
-     * The text color for the results overlays.
-     */
-    textColor: string;
-    /**
-     * The text background color for the results overlays.
-     */
-    textContainerColor: string;
-    /**
-     * The highlighted color for the results overlays polygons.
-     */
-    highlightedPolygonColor?: string;
-    /**
-     * The highlighted color for the results overlays polygons.
-     */
-    highlightedTextColor?: string;
-    /**
-     * The highlighted color for the results overlays polygons.
-     */
-    highlightedTextContainerColor?: string;
-    /**
-     * If enabled, newly detected barcodes will be automatically selected.
-     * Otherwise the user has to tap on a barcode on the selection overlay to select it.
-     * Has no effect with disabled overlay.
-     * Defaults to false.
-     */
-    automaticSelectionEnabled?: boolean;
-}