io-anyline-cordova - npm Package Compare versions

Comparing version 3.17.0 to 3.18.0

package.json

 {
   "name": "io-anyline-cordova",
-  "version": "3.17.0",
+  "version": "3.18.0",
   "description": "The cordova plugin for the Anyline SDK",
@@ -5,0 +5,0 @@ "cordova": {

README.md

@@ -1,103 +0,241 @@
-## Anyline SDK Cordova Plugin ##
+	 _____         _ _         
+	|  _  |___ _ _| |_|___ ___ 
+	|     |   | | | | |   | -_|
+	|__|__|_|_|_  |_|_|_|_|___|
+	          |___|            
+	          
+# Anyline React-Native Plugin
 
-Anyline provides an easy-to-use SDK for applications to enable Optical Character Recognition (OCR) on mobile devices.
+[Anyline](https://www.anyline.io) is mobile OCR SDK, which can be configured by yourself to scan all kinds of numbers, characters, text and codes. 
 
-### Available Modules
-- [**Barcode:**](https://documentation.anyline.io/toc/modules/barcode/index.html)  Scan 23 types of international barcode & QR code formats.
-- [**Energy:**](https://documentation.anyline.io/toc/modules/energy/index.html) Scan meter readings of various electric, gas, and water meters.
-- [**License Plate:**](https://documentation.anyline.io/toc/modules/license_plate/index.html)  Reliable scanning of data from passports' and IDs' machine readable zones (MRZ)
-- [**Document:**](https://documentation.anyline.io/toc/modules/document/index.html)  Reliable scanning of data from passports' and IDs' machine readable zones (MRZ)
-- [**MRZ:**](https://documentation.anyline.io/toc/modules/mrz/index.html)  Reliable scanning of data from passports' and IDs' machine readable zones (MRZ)
-- [**Anyline OCR:**](https://documentation.anyline.io/toc/modules/anyline_ocr/index.html) Create a custom use case with LINE or GRID recognition
+The plugin lets you connect to the SDK with React-Native.
+	  
+## Example
 
-### Requirements
+Go to the Example project in the [example folder](https://github.com/Anyline/anyline-ocr-react-native-module/tree/master/example/Anyline).
 
+Check out the examples ResultView.js and config.json to see the implementation.
+	                
+## Quick Start Guide
+
+### 1. Get a License
+Go to [our pricing page](https://www.anyline.io/pricing/) and get your license or sign up for your expiring test license.
+
+### 2. Get the Anyline react-native plugin
+
+Download or Clone the Repo to your node_modules
+```
+project   
+│    android.index.js
+│    ios.index.js
+└─── node_modules
+     └─── anyline-ocr-react-native-module
+```
+
+or just go 
+
+```
+ npm i anyline-ocr-react-native-module
+``` 
+ 
+
+Link the project. Run in root:
+ ```
+react-native link
+ ```
+in the root folder.
+
+### 3. Get the native Dependencies
+
 #### Android
-- Android device with SDK >= 15
-- decent camera functionality (recommended: 720p and adequate auto focus)
 
-#### iOS
-- minimum iOS 8.2
-- minimum iPhone4s
+##### Setup Packages
 
+Package name must match with the bundleID from your Anyline License. 
 
-### Quick Start - Setup
-This is just a simple setup guide to integrate the anylinesdk-plugin in an existing Cordova project.<br/>
-For more information about Cordova, how to use plugins, etc. see <a target="_blank" href="https://cordova.apache.org/">https://cordova.apache.org/</a>.
+##### Add Anyline Package
 
-###### 1. Add the anylinesdk-plugin to your existing cordova project
+Go into the native Android folder of your Project to your MainApplication.
+
+Import the AnylinePackage
 ```
-cordova plugin add io-anyline-cordova
+import com.anyline.reactnative.AnylinePackage;
 ```
+and add the package to your getPackages function
+```
+@Override
+    protected List<ReactPackage> getPackages() {
+      return Arrays.<ReactPackage>asList(
+          new MainReactPackage(),
+            new AnylinePackage()
+      );
+    }
+```
+#### Issues
+Strict mode does not allow function declarations in a lexically nested statement.
+ 
+ http://stackoverflow.com/a/41076153/2157717
 
-Or use plugman. E.g. for android:  
+duplicate files during packaging of APK
+```
+packagingOptions {
+  pickFirst 'lib/armeabi-v7a/libgnustl_shared.so'
+  pickFirst 'lib/x86/libgnustl_shared.so'
+}
+```
+#### iOS 
+Disable bitcode in your project
 
+##### Podfile
+- Copy the [Podfile](https://github.com/Anyline/anyline-ocr-react-native-module/tree/master/example/Anyline/ios/Podfile) 
+from our example Project to your native iOS root folder.
+- Change the target of the Podfile to your project name.
+- ```pod update```
+
+##### Permissions
+Add Camera Permissions to Info.plist
 ```
-plugman install --platform android --project platforms/android --plugin io-anyline-cordova
+Privacy - Camera Usage Description
 ```
+Add also every other permission you want to configure in your config.js (vibrate, sound).
 
-If you'd like to clone the repository you will have to use git-lfs. Use the following commands to install git-lfs.
+##### Anyline License
+Your BundleIdentifier of your app has to match with your bundleID from your Anyline License.
+
+### 4. Import the plugin to your JavaScript file
 ```
-brew install git-lfs
-git lfs install
+import Anyline from 'anyline-ocr-react-native-module';
 ```
-If you prefer downloading a package, use the provided `zip` package on the [releases page](https://github.com/Anyline/anyline-ocr-cordova-module/releases). Be aware that the github download zip button does not work for projects with git-lfs.
+### 5. Import the config file
+```
+import config from './config.js';
+```
+Add and import a JSON file with the proper structure and elements. The JSON config contains: 
 
+1. The license key 
 
+2. Options field with
+-	AnylineSDK config parameter
+-	“segment”: which contains the scanModes for the UI Segment (e.g. switch between Analog and Digital) - optional
+3. OCR field with (Only if you want to use the OCR module)
+-   your custom training data
+-   RegEx Validation
 
+If you want to get detailed information on the config JSON, go to our[`documentation`](https://documentation.anyline.io/toc/view_configuration/index.html).
 
-###### 2. Plugin Usage
+### 6. Call the Anyline component 
 
-```javaScript
-cordova.exec(onResult, onError, "AnylineSDK", scanMode, config);
+#### Callbacks
+
 ```
+AnylineOCR.setupScanViewWithConfigJson(
+        JSON.stringify(config),
+        “ANALOG_METER”,
+        this.onResult,
+        this.onError
+    );
+```
 
-- <b>onResult</b>: a function that is called on a scan result
-- <b>onError</b>: a function that is called on error or when the user canceled the scanning
-- <b>AnylineSDK</b>: add this *string* to make sure the anyline-sdk plugin is called
-- <b>scanMode</b>: "<i>MRZ</i>", "<i>LICENSE_PLATE</i>", "<i>BARCODE</i>", "<i>ANYLINE_OCR</i>", "<i>ELECTRIC_METER</i>" (more Energy modes can be found [here](https://documentation.anyline.io/#energy))
-- <b>config</b>: an array
-    * <b>config[0]</b>: the license key
-    * <b>config[1]</b>: the [view config](https://documentation.anyline.io/#anyline-config)
-    * <b>config[2]</b>: the [ocr config](https://documentation.anyline.io/#anyline-ocr) (only uses with mode ANYLINE_OCR)
+#### Promise
+```
+openAnyline = async () => {
+    ...
+    
+    try {
+        const result = await AnylineOCR.setupScanViewWithConfigJson(JSON.stringify(config), “ANALOG_METER”);
+    } catch(error) {
+        console.error(error);
+    }
+    
+    ...
+}
+```
 
 
-> Example for **config** from MRZ:
+### 7. Add custom TrainData to the OCR Module
+If you want to add you custom traindata, you have to copy it into the native project folder.
 
-```json
-[
-    "YOUR_LICENSE_KEY",
-    {
-        "captureResolution": "1080p",
-        "cutout": {
-            "style": "rect",
-            "maxWidthPercent": "90%",
-            "maxHeightPercent": "90%",
-            "alignment": "top_half",
-            "strokeWidth": 2,
-            "cornerRadius": 4,
-            "strokeColor": "FFFFFF",
-            "outerColor": "000000",
-            "outerAlpha": 0.3
-        },
-        "flash": {
-            "mode": "manual",
-            "alignment": "bottom_right"
-        },
-        "beepOnResult": true,
-        "vibrateOnResult": true,
-        "blinkAnimationOnResult": true,
-        "cancelOnResult": true
-    }
-]
+#### iOS
 ```
+ios   
+└─── trainedData
+     └─── myTrainedData.traineddata
+```
 
+#### Android
+```
+android   
+└─── app
+      └─── src
+            └─── main
+                   └─── assets
+                          └─── traindData
+                                  └─── myTrainedData.traineddata
+```
+Also the OCR Config has to reflect the path.
 
-###### 3. Run your cordova project: Enjoy scanning and have fun :)
 
-Checkout our <a href="https://documentation.anyline.io/">online documentation</a>  for more details.
+## Props
 
+| Key | Type | Default | Description |
+| --- | --- | --- | --- |
+| config | string | \*required | config (JSON String)|
+| scanMode | string |  \*required  | Will set the scanMode/Module of the Plugin. |
+| onResult | function | \*required | The function you pass will be the onResult callback. Use this callback to handle the found scan results. |
+| onError | function |  \*required  | The onError function will be called when the AnylinePlugin encounters an error. Handle the error messages in this method. |
 
+### config
+Stringified JSON with all the configurations, detailed information [here](https://documentation.anyline.io/toc/view_configuration/index.html).
+
+Keep in mind, that you have to add every permission to your project, you add in the config (vibrateOnResult -> vibration permission)
+### scanMode
+Available settings: 
+
+##### Energy Meter
+```
+"AUTO_ANALOG_DIGITAL_METER"
+"ANALOG_METER"
+"DIGITAL_METER"
+"DIAL_METER"
+"HEAT_METER_4"
+"HEAT_METER_5"
+"HEAT_METER_6"
+"SERIAL_NUMBER"
+```
+##### Other ScanModes
+```
+"BARCODE"
+"MRZ"
+"ANYLINE_OCR"
+"DOCUMENT"
+"LICENSE_PLATE"
+```
+Get more information in our [Docu](https://documentation.anyline.io/toc/platforms/react-native/getting_started.html#react-native-set-scan-mode).
+
+### onResult Function
+Callback -> Stringified JSON
+```
+{
+    reading : 'Result of the Scan',
+    imagePath : 'path to cropped image',
+    fullImagePath : 'path to full image',
+    barcode : 'result of the simultaneous barcode scanning',
+    scanMode : 'selected scanMode',
+    meterType : 'meter type'
+}
+```
+More information about the simultaneous barcode scanning [here](https://documentation.anyline.io/toc/modules/overview.html#anyline-modules-simultaneous-barcode-scanning).
+
+### onError Function
+Callback -> String
+- String errorMessage
+
+## Images
+
+Keep in mind, all the images are saved in the cache directory of the app. For performance reasons, we only provide the 
+path as string, so we don't have to transfer the whole image through the bridge. Please be aware,  that you should not 
+use the images in the cache directory for persistent storage, but store the images in a location of your choice for persistence. 
+
 ## License
 
-See LICENSE file.
+See LICENSE file.

src/ios/anyline_sdk/AnylineResources.bundle/module_barcode/barcode_capture_config.json

@@ -6,3 +6,3 @@ {
     "maxWidthPercent": "80%",
-    "alignment": "top_half",
+    "alignment": "center",
     "ratioFromSize": {
@@ -9,0 +9,0 @@ "width": 100,

src/ios/anyline_sdk/AnylineResources.bundle/module_document/document_capture_config.json

@@ -35,3 +35,3 @@ {
     "blinkAnimationOnResult": true,
-    "cancelOnResult": false
+    "cancelOnResult": true
 }

src/ios/anyline_sdk/AnylineResources.bundle/module_energy/analog_digital_capture_config.json

@@ -11,6 +11,2 @@ {
         },
-        "offset": {
-            "x": 0,
-            "y": -30
-        },
         "strokeWidth": 2,
@@ -21,3 +17,7 @@ "strokeColor": "FFFFFF",
         "outerAlpha": 0.5,
-        "feedbackStrokeColor": "0099FF"
+        "feedbackStrokeColor": "0099FF",
+        "offset": {
+              "x": 0,
+              "y": -15
+          }
     },
@@ -24,0 +24,0 @@ "flash" : {

src/ios/anyline_sdk/AnylineResources.bundle/module_energy/analog_meter_capture_config.json

@@ -11,6 +11,2 @@ {
         },
-        "offset": {
-            "x": 0,
-            "y": -30
-        },
         "strokeWidth": 2,
@@ -17,0 +13,0 @@ "strokeColor": "FFFFFF",

src/ios/anyline_sdk/AnylineResources.bundle/module_energy/dial_meter_capture_config.json

@@ -13,14 +13,2 @@ {
         },
-        "offset": {
-            "x": 0,
-            "y": 0
-        },
-        "cropPadding": {
-            "x": 0,
-            "y": 0
-        },
-        "cropOffset": {
-            "x": 0,
-            "y": 0
-        },
         "strokeWidth": 2,
@@ -30,3 +18,8 @@ "cornerRadius": 4,
         "outerColor": "000000",
-        "outerAlpha": 0.3
+        "outerAlpha": 0.3,
+        "offset": {
+              "x": 0,
+              "y": 70
+          },
+
     },
@@ -33,0 +26,0 @@ "flash": {

src/ios/anyline_sdk/AnylineResources.bundle/module_energy/digital_meter_capture_config.json

@@ -11,6 +11,2 @@ {
         },
-        "offset": {
-            "x": 0,
-            "y": -30
-        },
         "strokeWidth": 2,
@@ -21,3 +17,7 @@ "strokeColor": "FFFFFF",
         "outerAlpha": 0.5,
-        "feedbackStrokeColor": "0099FF"
+        "feedbackStrokeColor": "0099FF",
+        "offset": {
+              "x": 0,
+              "y": -15
+          }
     },
@@ -24,0 +24,0 @@ "flash" : {

src/ios/anyline_sdk/AnylineResources.bundle/module_energy/digital_number_capture_config.json

@@ -11,6 +11,2 @@ {
         },
-        "offset": {
-            "x": 0,
-            "y": -30
-        },
         "strokeWidth": 2,
@@ -21,3 +17,7 @@ "strokeColor": "FFFFFF",
         "outerAlpha": 0.5,
-        "feedbackStrokeColor": "0099FF"
+        "feedbackStrokeColor": "0099FF",
+        "offset": {
+              "x": 0,
+              "y": -15
+          }
     },
@@ -24,0 +24,0 @@ "flash" : {

src/ios/anyline_sdk/AnylineResources.bundle/module_energy/gas_meter_capture_config.json

@@ -11,6 +11,2 @@ {
         },
-        "offset": {
-            "x": 0,
-            "y": -30
-        },
         "strokeWidth": 2,
@@ -21,3 +17,7 @@ "strokeColor": "FFFFFF",
         "outerAlpha": 0.5,
-        "feedbackStrokeColor": "0099FF"
+        "feedbackStrokeColor": "0099FF",
+        "offset": {
+              "x": 0,
+              "y": -15
+          }
     },
@@ -24,0 +24,0 @@ "flash" : {

src/ios/anyline_sdk/AnylineResources.bundle/module_energy/heat_meter_capture_config.json

@@ -11,6 +11,2 @@ {
         },
-        "offset": {
-            "x": 0,
-            "y": -30
-        },
         "strokeWidth": 2,
@@ -21,3 +17,7 @@ "strokeColor": "FFFFFF",
         "outerAlpha": 0.5,
-        "feedbackStrokeColor": "0099FF"
+        "feedbackStrokeColor": "0099FF",
+        "offset": {
+              "x": 0,
+              "y": -15
+          }
     },
@@ -24,0 +24,0 @@ "flash" : {

src/ios/anyline_sdk/AnylineResources.bundle/module_energy/power_meter_4_capture_config.json

@@ -11,6 +11,2 @@ {
         },
-        "offset": {
-            "x": 0,
-            "y": -30
-        },
         "strokeWidth": 2,
@@ -21,3 +17,7 @@ "strokeColor": "FFFFFF",
         "outerAlpha": 0.5,
-        "feedbackStrokeColor": "0099FF"
+        "feedbackStrokeColor": "0099FF",
+        "offset": {
+              "x": 0,
+              "y": -15
+          }
     },
@@ -24,0 +24,0 @@ "flash" : {

src/ios/anyline_sdk/AnylineResources.bundle/module_energy/power_meter_capture_config.json

@@ -11,6 +11,2 @@ {
         },
-        "offset": {
-            "x": 0,
-            "y": -30
-        },
         "strokeWidth": 2,
@@ -21,3 +17,7 @@ "strokeColor": "FFFFFF",
         "outerAlpha": 0.5,
-        "feedbackStrokeColor": "0099FF"
+        "feedbackStrokeColor": "0099FF",
+        "offset": {
+              "x": 0,
+              "y": -15
+          }
     },
@@ -24,0 +24,0 @@ "flash" : {

src/ios/anyline_sdk/AnylineResources.bundle/module_energy/serial_number_capture_config.json

@@ -9,8 +9,4 @@ {
             "width": 720,
-            "height": 160
+            "height": 144
         },
-        "offset": {
-            "x": 0,
-            "y": -30
-        },
         "strokeWidth": 2,
@@ -21,3 +17,7 @@ "strokeColor": "FFFFFF",
         "outerAlpha": 0.5,
-        "feedbackStrokeColor": "0099FF"
+        "feedbackStrokeColor": "0099FF",
+        "offset": {
+              "x": 0,
+              "y": -15
+          }
     },
@@ -24,0 +24,0 @@ "flash" : {

src/ios/anyline_sdk/AnylineResources.bundle/module_energy/water_meter_black_background_capture_config.json

@@ -11,6 +11,2 @@ {
         },
-        "offset": {
-            "x": 0,
-            "y": -30
-        },
         "strokeWidth": 2,
@@ -21,3 +17,7 @@ "strokeColor": "FFFFFF",
         "outerAlpha": 0.5,
-        "feedbackStrokeColor": "0099FF"
+        "feedbackStrokeColor": "0099FF",
+        "offset": {
+              "x": 0,
+              "y": -15
+          }
     },
@@ -24,0 +24,0 @@ "flash" : {

src/ios/anyline_sdk/AnylineResources.bundle/module_energy/water_meter_white_background_capture_config.json

@@ -11,6 +11,2 @@ {
         },
-        "offset": {
-            "x": 0,
-            "y": -30
-        },
         "strokeWidth": 2,
@@ -21,3 +17,7 @@ "strokeColor": "FFFFFF",
         "outerAlpha": 0.5,
-        "feedbackStrokeColor": "0099FF"
+        "feedbackStrokeColor": "0099FF",
+        "offset": {
+              "x": 0,
+              "y": -15
+          }
     },
@@ -24,0 +24,0 @@ "flash" : {

src/ios/anyline_sdk/AnylineResources.bundle/module_mrz/mrz_capture_config.json

@@ -8,2 +8,3 @@ {
         "maxHeightPercent": "90%",
+        "alignment": "center",
         "ratioFromSize" : {
@@ -13,3 +14,2 @@ "width": 125,
         },
-        "alignment": "top_half",
         "strokeWidth": 2,
@@ -29,6 +29,12 @@ "cornerRadius": 4,
         },
+        "feedbackStrokeColor": "0099FF"
+        ,
+        "offset": {
+              "x": 0,
+              "y": 30
+          }
     },
     "flash": {
         "mode": "manual",
-        "alignment": "top_left"
+        "alignment": "top_left",
     },
@@ -35,0 +41,0 @@ "beepOnResult": true,

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

259020630

increased by0.28%

Lines of code

2427

increased by0.58%

Number of lines in readme file

241

increased by131.73%

Number of medium supply chain risk alerts

12

decreased by-7.69%

Worsened metrics

Number of package files

172

decreased by-0.58%

No dependency changes