react-native-scanbot-barcode-scanner-sdk 3.2.1-beta2 → 3.2.1-beta3

package/android/src/main/java/io/scanbot/barcodesdk/plugin/reactnative/JSONUtils.java

@@ -6,6 +6,7 @@
 package io.scanbot.barcodesdk.plugin.reactnative;
 
 import android.graphics.PointF;
+import android.util.Log;
 
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
@@ -30,6 +31,7 @@ import io.scanbot.sdk.barcode.entity.BarcodeFormat;
 import io.scanbot.sdk.barcode.entity.BarcodeScannerAdditionalConfig;
 import io.scanbot.sdk.barcode.entity.EngineMode;
 import io.scanbot.sdk.barcode.entity.MSIPlesseyChecksumAlgorithm;
+import io.scanbot.sdk.ui.view.barcode.configuration.BarcodeFilter;
 import io.scanbot.sdk.ui.view.barcode.configuration.BarcodeScannerAdditionalConfiguration;
 import io.scanbot.sdk.ui.view.base.configuration.CameraOrientationMode;
 
@@ -214,6 +216,25 @@ public final class JSONUtils {
         ) : null;
     }
 
+    public static BarcodeFilter extractBarcodeFilter(final ReadableMap options) {
+        if (!options.hasKey("barcodeFilter")) {
+            return null;
+        }
+        final String filterType = options.getString("barcodeFilter");
+        try {
+            final ReactBarcodeExtensionsFilter.Type type =
+                    ReactBarcodeExtensionsFilter.Type.valueOf(filterType);
+            return new ReactBarcodeExtensionsFilter(type);
+        }
+        catch (IllegalArgumentException exception) {
+            exception.printStackTrace();
+            final String errMsg = String.format("The value passed in 'barcodeFilter' (%s) does not exist", filterType);
+            Log.e("SCANBOT_SDK", errMsg);
+        }
+
+        return null;
+    }
+
     public static ArrayList<String> getStringArrayListFromMap(final ReadableMap configuration, final String key) {
         ArrayList<String> out = new ArrayList<>();
         if(!configuration.hasKey(key)) {

package/android/src/main/java/io/scanbot/barcodesdk/plugin/reactnative/ObjectMapper.java

@@ -63,7 +63,7 @@ public final class ObjectMapper {
                 continue;
             }
 
-            if ("onlyAcceptCodesWithExtensions".equals(prop)) {
+            if ("barcodeFilter".equals(prop)) {
                 continue;
             }
 

package/android/src/main/java/io/scanbot/barcodesdk/plugin/reactnative/ReactBarcodeExtensionsFilter.java

@@ -0,0 +1,61 @@
+package io.scanbot.barcodesdk.plugin.reactnative;
+
+import androidx.annotation.NonNull;
+
+import java.util.List;
+import java.util.Map;
+
+import io.scanbot.sdk.barcode.entity.BarcodeItem;
+import io.scanbot.sdk.barcode.entity.BarcodeMetadataKey;
+import io.scanbot.sdk.ui.view.barcode.configuration.BarcodeFilter;
+import io.scanbot.sdk.ui.view.barcode.configuration.IBarcodeFilter;
+
+public class ReactBarcodeExtensionsFilter extends BarcodeFilter {
+
+    public enum Type {
+        WithExtension,
+        WithEAN2Extension,
+        WithEAN5Extension
+    }
+
+    private final Type filterType;
+
+    public ReactBarcodeExtensionsFilter(Type filterType) {
+        this.filterType = filterType;
+    }
+
+    @Override
+    public boolean acceptsBarcode(@NonNull BarcodeItem barcodeItem) {
+        if (!super.acceptsBarcode(barcodeItem)) {
+            return false;
+        }
+
+        final String extension = getExtensionOrEmpty(barcodeItem);
+        if(extension.equals("")) {
+            return false;
+        }
+
+        switch(this.filterType) {
+            case WithExtension:
+                return true;
+            case WithEAN2Extension:
+                return extension.trim().length() == 2;
+            case WithEAN5Extension:
+                return extension.trim().length() == 5;
+            default:
+                return false;
+        }
+    }
+
+    private static String getExtensionOrEmpty(final BarcodeItem barcodeItem)
+    {
+        final Map<BarcodeMetadataKey, String> metadata = barcodeItem.getMetadata();
+
+        if (!metadata.containsKey(BarcodeMetadataKey.UpcEanExtension)
+        ) {
+            return "";
+        }
+
+        return metadata.get(BarcodeMetadataKey.UpcEanExtension);
+    }
+}

package/android/src/main/java/io/scanbot/barcodesdk/plugin/reactnative/ScanbotBarcodeSdkModule.java

@@ -47,6 +47,7 @@ import io.scanbot.sdk.ui.barcode_scanner.view.barcode.BarcodeScannerActivity;
 import io.scanbot.sdk.ui.barcode_scanner.view.barcode.batch.BatchBarcodeScannerActivity;
 import io.scanbot.sdk.ui.view.barcode.batch.configuration.BatchBarcodeScannerConfiguration;
 import io.scanbot.sdk.ui.view.barcode.configuration.BarcodeExtensionsFilter;
+import io.scanbot.sdk.ui.view.barcode.configuration.BarcodeFilter;
 import io.scanbot.sdk.ui.view.barcode.configuration.BarcodeScannerAdditionalConfiguration;
 import io.scanbot.sdk.ui.view.barcode.configuration.BarcodeScannerConfiguration;
 import io.scanbot.sdk.ui.view.base.configuration.CameraOrientationMode;
@@ -54,6 +55,7 @@ import kotlin.Unit;
 import kotlin.jvm.functions.Function1;
 
 import android.app.Activity;
+import android.util.Log;
 
 
 public class ScanbotBarcodeSdkModule extends ReactContextBaseJavaModule implements ActivityEventListener {
@@ -308,8 +310,11 @@ public class ScanbotBarcodeSdkModule extends ReactContextBaseJavaModule implemen
             configuration.setCancelButtonIcon(R.drawable.ic_baseline_arrow_back_24);
         }
 
-        if (options.hasKey("onlyAcceptCodesWithExtensions") && options.getBoolean("onlyAcceptCodesWithExtensions")) {
-            configuration.setBarcodeFilter(new BarcodeExtensionsFilter());
+        if (options.hasKey("barcodeFilter")) {
+            final BarcodeFilter barcodeFilter = JSONUtils.extractBarcodeFilter(options);
+            if (barcodeFilter != null) {
+                configuration.setBarcodeFilter(barcodeFilter);
+            }
         }
     }
 

package/ios/ScanbotBarcodeSdk.m

@@ -140,12 +140,12 @@ RCT_EXPORT_METHOD(startBarcodeScanner:(NSDictionary*)configuration
        additionalParameters.enableGS1Decoding = [gs1Decoding boolValue];
     }
     
-    // UPC Extension filter
-    NSNumber* shouldApplyExtensionFilter = [configuration objectForKey:@"onlyAcceptCodesWithExtensions"];
-    if (shouldApplyExtensionFilter != nil && [shouldApplyExtensionFilter boolValue]) {
-        behaviorConfig.barcodeFilter = [[SBSDKUIBarcodeExtensionsFilter alloc] init];
+    // Barcode Filter (at the moment used for UPC Extension filters)
+    SBSDKUIBarcodeFilter* barcodeFilter = extractBarcodeFilter(configuration);
+    if (barcodeFilter != nil) {
+        behaviorConfig.barcodeFilter = barcodeFilter;
     }
-
+    
     additionalParameters.msiPlesseyChecksumAlgorithm = extractPlesseyChecksumAlgorithmFromConfiguration(configuration);
     
     behaviorConfig.additionalParameters = additionalParameters;
@@ -210,10 +210,10 @@ RCT_EXPORT_METHOD(startBatchBarcodeScanner:(NSDictionary*)configuration
        additionalParameters.enableGS1Decoding = [gs1Decoding boolValue];
     }
     
-    // UPC Extension filter
-    NSNumber* shouldApplyExtensionFilter = [configuration objectForKey:@"onlyAcceptCodesWithExtensions"];
-    if (shouldApplyExtensionFilter != nil && [shouldApplyExtensionFilter boolValue]) {
-        behavior.barcodeFilter = [[SBSDKUIBarcodeExtensionsFilter alloc] init];
+    // Barcode Filter (at the moment used for UPC Extension filters)
+    SBSDKUIBarcodeFilter* barcodeFilter = extractBarcodeFilter(configuration);
+    if (barcodeFilter != nil) {
+        behavior.barcodeFilter = barcodeFilter;
     }
 
     additionalParameters.msiPlesseyChecksumAlgorithm = extractPlesseyChecksumAlgorithmFromConfiguration(configuration);

package/ios/Utils/BarcodeMapping.h

@@ -8,6 +8,7 @@
 #define BarcodeMapping_h
 
 #include "ScanbotStorageUtils.h"
+#include "ReactBarcodeExtensionsFilter.h"
 @import ScanbotBarcodeScannerSDK;
 
 static inline SBSDKBarcodeType* barcodeTypeFromString(NSString* string) {
@@ -86,6 +87,23 @@ static inline NSArray<NSDictionary<NSString*, NSObject*>*>* jsonFromMappedBarcod
     return [jsonResults copy];
 }
 
+static inline SBSDKUIBarcodeFilter* extractBarcodeFilter(NSDictionary* configuration) {
+    NSString* jsonFilterType = [configuration objectForKey:@"barcodeFilter"];
+    if (jsonFilterType == nil) {
+        return nil;
+    }
+    
+    if ([jsonFilterType isEqualToString:@"WithExtension"]) {
+        return [[ReactBarcodeExtensionsFilter alloc] init:ReactBarcodeExtensionsFilterWithExtension];
+    } else if ([jsonFilterType isEqualToString:@"WithEAN2Extension"]) {
+        return [[ReactBarcodeExtensionsFilter alloc] init:ReactBarcodeExtensionsFilterWithEAN2Extension];
+    } else if ([jsonFilterType isEqualToString:@"WithEAN5Extension"]) {
+        return [[ReactBarcodeExtensionsFilter alloc] init:ReactBarcodeExtensionsFilterWithEAN5Extension];
+    }
+    
+    return nil;
+}
+
 static inline NSArray* extractBarcodeTypesFromConfiguration(NSDictionary* configuration) {
     NSArray* barcodeFormats = [configuration objectForKey:@"barcodeFormats"];
     if (barcodeFormats && [barcodeFormats indexOfObject:@"ALL_FORMATS"] == NSNotFound) {

package/ios/Utils/ReactBarcodeExtensionsFilter.h

@@ -0,0 +1,22 @@
+//
+//  ReactBarcodeExtensionsFilter.h
+//  RNScanbotBarcodeSDK
+//
+//  Created by Marco Saia on 13.07.22.
+//
+
+#import <Foundation/Foundation.h>
+@import ScanbotBarcodeScannerSDK;
+
+typedef enum BarcodeFilterType : NSUInteger {
+    ReactBarcodeExtensionsFilterWithExtension,
+    ReactBarcodeExtensionsFilterWithEAN2Extension,
+    ReactBarcodeExtensionsFilterWithEAN5Extension
+} BarcodeFilterType;
+
+@interface ReactBarcodeExtensionsFilter : SBSDKUIBarcodeFilter
+
+- (instancetype)init NS_UNAVAILABLE;
+- (id)init:(BarcodeFilterType)filterType;
+
+@end

package/ios/Utils/ReactBarcodeExtensionsFilter.m

@@ -0,0 +1,55 @@
+//
+//  ReactBarcodeExtensionsFilter.m
+//  RNScanbotBarcodeSDK
+//
+//  Created by Marco Saia on 13.07.22.
+//
+
+#import "ReactBarcodeExtensionsFilter.h"
+
+@implementation ReactBarcodeExtensionsFilter {
+    BarcodeFilterType mFilterType;
+}
+
+-(id)init:(BarcodeFilterType)filterType
+{
+    if(self = [super init]) {
+        mFilterType = filterType;
+    }
+
+    return self;
+}
+
+- (BOOL)acceptsBarcode:(nonnull SBSDKBarcodeScannerResult *)barcode {
+    if (![super acceptsBarcode: barcode]) {
+        return false;
+    }
+    
+    NSString* extension = barcode.metadata[SBSDKBarcodeMetadataEANUPCExtensionKey];
+    if (extension == nil || [extension length] == 0) {
+        return false;
+    }
+    
+    switch (mFilterType) {
+        case ReactBarcodeExtensionsFilterWithExtension:
+            return true;
+        case ReactBarcodeExtensionsFilterWithEAN2Extension:
+            return trim(extension).length == 2;
+        case ReactBarcodeExtensionsFilterWithEAN5Extension:
+            return trim(extension).length == 5;
+        default:
+            return false;
+    }
+}
+
+- (BOOL)shouldAdd:(nonnull SBSDKBarcodeScannerResult *)barcode
+       toBarcodes:(nonnull NSArray<SBSDKBarcodeScannerResult *>*)codes
+{
+    return [super shouldAdd:barcode toBarcodes:codes];
+}
+
+static inline NSString* trim(NSString* text) {
+    return [text stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceCharacterSet]];
+}
+
+@end

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "react-native-scanbot-barcode-scanner-sdk",
   "title": "Scanbot Barcode Scanner SDK for React Native",
-  "version": "3.2.1-beta2",
+  "version": "3.2.1-beta3",
   "description": "Scanbot Barcode Scanner SDK React Native Plugin for Android and iOS",
   "main": "index.js",
   "files": [

package/src/configuration.ts

@@ -10,7 +10,8 @@ import {
   BarcodeImageGenerationType,
   UIInterfaceOrientationMask,
   EngineMode,
-  CameraModule
+  CameraModule,
+  BarcodeFilter
 } from "./enum";
 import { MSIPlesseyChecksumAlgorithm } from "./enum";
 
@@ -89,9 +90,9 @@ export interface BarcodeScannerConfiguration {
    */
   minimum1DBarcodesQuietZone?: number
   /** 
-   * If 'true', only barcodes that have an extension will be accepted. Defaults to FALSE.
+   * Use a filter to determine which type of barcode can be detected; see `BarcodeFilter`
    */
-  onlyAcceptCodesWithExtensions?: boolean;
+  barcodeFilter?: BarcodeFilter;
   /**
    * Whether a sound should be played on successful barcode detection.
    */
@@ -301,9 +302,9 @@ export interface BatchBarcodeScannerConfiguration {
    */
   minimum1DBarcodesQuietZone?: number;
   /** 
-   * If 'true', only barcodes that have an extension will be accepted. Defaults to FALSE.
+   * Use a filter to determine which type of barcode can be detected; see `BarcodeFilter`
    */
-  onlyAcceptCodesWithExtensions?: boolean;
+  barcodeFilter?: BarcodeFilter;
   /**
    * The engine mode of the barcode recognizer. Defaults to NEXT_GEN.
    * To use the legacy recognizer, please specify LEGACY.

package/src/enum.ts

@@ -77,3 +77,8 @@ export type MSIPlesseyChecksumAlgorithm =
     ;
 
 export type CameraModule = 'FRONT' | 'BACK';
+
+export type BarcodeFilter = 
+    'WithExtension' |
+    'WithEAN2Extension' |
+    'WithEAN5Extension';

package/android/src/main/java/io/scanbot/barcodesdk/plugin/reactnative/BarcodeExtensionsFilter.java

@@ -1,24 +0,0 @@
-package io.scanbot.barcodesdk.plugin.reactnative;
-
-import androidx.annotation.NonNull;
-
-import java.util.List;
-
-import io.scanbot.sdk.barcode.entity.BarcodeItem;
-import io.scanbot.sdk.barcode.entity.BarcodeMetadataKey;
-import io.scanbot.sdk.ui.view.barcode.configuration.IBarcodeFilter;
-
-public class BarcodeExtensionsFilter implements IBarcodeFilter {
-    @Override
-    public boolean acceptsBarcode(@NonNull BarcodeItem barcodeItem) {
-        return barcodeItem.getMetadata().containsKey(BarcodeMetadataKey.UpcEanExtension);
-    }
-
-    @Override
-    public boolean shouldAdd(@NonNull BarcodeItem barcodeItem, @NonNull List<BarcodeItem> list) {
-        if (this.acceptsBarcode(barcodeItem)) {
-            return !list.contains(barcodeItem);
-        }
-        return false;
-    }
-}