{"analyzedAt":"2022-12-22T03:30:40.879Z","collected":{"metadata":{"name":"blinkid-cordova","scope":"unscoped","version":"5.17.0","description":"A small and powerful ID card scanning library","keywords":["scan","id","scanner","identity","ID","passport","sdk","ocr","USDL","PDF417","MRZ","MRTD","barcode","DL","card","document","microblink","blinkid","ionic","phonegap","ecosystem:cordova","cordova-android","cordova-ios"],"date":"2022-06-30T07:15:22.358Z","author":{"name":"Microblink"},"publisher":{"username":"mgracanin","email":"mijo.gracanin@gmail.com"},"maintainers":[{"username":"ivancuric","email":"ivan.curic@gmail.com"},{"username":"mirzamesic","email":"mesic.mirza07@gmail.com"},{"username":"dodoent","email":"DoDoEntertainment@gmail.com"},{"username":"markosopcic","email":"marko.sopcic@microblink.com"},{"username":"microblinkadmin","email":"info@microblink.com"},{"username":"juraskrlec","email":"jura.skrlec@microblink.com"},{"username":"igrce","email":"ivan.grce@microblink.com"},{"username":"matvidako_micro","email":"matej.vidakovic@microblink.com"},{"username":"stepanic","email":"stepanic@loopus.co"},{"username":"vjekoart","email":"vjekoart@gmail.com"},{"username":"dcubelic-mb","email":"dominik.cubelic@microblink.com"},{"username":"mgracanin","email":"mijo.gracanin@gmail.com"},{"username":"matijakrizanec","email":"matija.krizanec@microblink.com"}],"repository":{"type":"git","url":"git+https://github.com/BlinkID/blinkid-phonegap.git"},"links":{"npm":"https://www.npmjs.com/package/blinkid-cordova","homepage":"https://github.com/BlinkID/blinkid-phonegap#readme","repository":"https://github.com/BlinkID/blinkid-phonegap","bugs":"https://github.com/BlinkID/blinkid-phonegap/issues"},"license":"MIT","releases":[{"from":"2022-11-22T00:00:00.000Z","to":"2022-12-22T00:00:00.000Z","count":1},{"from":"2022-09-23T00:00:00.000Z","to":"2022-12-22T00:00:00.000Z","count":1},{"from":"2022-06-25T00:00:00.000Z","to":"2022-12-22T00:00:00.000Z","count":2},{"from":"2021-12-22T00:00:00.000Z","to":"2022-12-22T00:00:00.000Z","count":4},{"from":"2020-12-22T00:00:00.000Z","to":"2022-12-22T00:00:00.000Z","count":10}],"readme":"# BlinkID SDK wrapper for Cordova\n\nEnhance your Cordova cross-platform apps with an AI-driven mobile ID scanner.\n\nWe made it quick and easy for you to create a sample application or install the plugin into your existing iOS or Android project.\n\nFor a full access to all features and functionalities, it’s best to go with one of our native SDKs (for [iOS](https://github.com/BlinkID/blinkid-ios) or [Android](https://github.com/BlinkID/blinkid-android)).\n\n## Cordova version\nBlinkID Cordova requires Cordova **v7.0.0 or later** and cordova-android plugin **v8.0.0 or later**.\n\n## Ionic version\n\nLatest version has been tested using Ionic **3.19.0** version.\n\n## Adding blinkid-cordova to your application\n\nYou can add blinkid-cordova by cloning the repository and following instructions below or by running\n\n```shell\ncordova plugin add blinkid-cordova\n```\n\n> The shown instructions are for **Cordova**, the instructions for **Ionic** and **PhoneGap** are practically the same, except for some slight command line argument differences.\n\nIn the repository you will find scripts to create sample applications.\n\n## Clone or Download repository\nDownloading a repository just downloads the files from the most recent commit of the default branch but without all the dependencies which are in submodules. We recommend that you clone directory. With a clone option you will get a copy of the history and it’s functional git repository.\n\nTo clone repository:\n\n+ **Copy URL from the `Clone or download` button: https://github.com/BlinkID/blinkid-phonegap.git**\n+ **Open terminal on Mac/Linux or [GitBash](https://git-for-windows.github.io/) on Windows.**\n+ **cd into directory where you want the cloned directory to be made.**\n+ **Type `git clone ` , than past URL**\n+ **Press enter**\n\n## How to get started\n\n### Cordova\n\nSample Cordova app is generated with a script\n\n```shell\n./initCordovaSampleApp.sh\n```\n\nTo run iOS sample application open Xcode project found in `sample/platforms/ios/sample.xcodeproj` and set your signing team.\n\nTo run Android sample application type\n\n```shell\ncordova run android\n```\n\n### Ionic\n\nSample Ionic app is generated with a script\n\n```shell\n./initIonicSampleApp.sh\n```\n\nWhen Ionic asks the following question **Would you like to integrate your new app with Cordova to target native iOS and Android?** answer with **y**.\n\nTo run iOS sample application open Xcode project found in `sample/platforms/ios/sample.xcodeproj` and set your signing team.\n\nTo run Android sample application type\n\n```shell\nionic run android\n```\n\n### Licensing\n\n- A valid license key is required to initialize scanning. You can request a **free trial license key**, after you register, at [Microblink Developer Hub](https://account.microblink.com/signin)\n\n- For production licensing, please [contact sales](https://microblink.com/contact-us) to request a quote.\n\n**Keep in mind:** Versions 5.8.0 and above require an internet connection to work under our new License Management Program.\n\nWe’re only asking you to do this so we can validate your trial license key. Scanning or data extraction of identity documents still happens offline, on the device itself. \n\nOnce the validation is complete, you can continue using the SDK in offline mode (or over a private network) until the next check.\n\n\n## Video tutorial\n\n### Cordova\n\nStep by step guide how to start blinkid-phonegap using Cordova. A tutorial flows from cloning repository via git clone to successfully deployed sample application on Android and iOS device with real-time screen mirroring. Application sample contains simple use of USDL recognizer with Ontario drivers license card.\n\n

\n \n \"Video\n \n Watch on Vimeo Watch on Youtube\n \n \n \n ### Using documentVerificationOverlay and CombinedRecognizer\n\nThis video tutorial describes how to use documentVerificationOverlay with UsdlCombinedRecognizer.\nDocumentVerificationOverlay is overlay for RecognizerRunnerFragment best suited for combined recognizers because it manages scanning of multiple document sides in the single camera opening and guides the user through the scanning process. It can also be used for single side scanning of ID cards, passports, driver’s licenses, etc\n\n

\n \n \"Video\n \n Watch on Vimeo Watch on Youtube\n \n \n\n## Installation\n\nFirst generate a empty project if needed:\n\n```shell\ncordova create \n```\n\n> The shown instructions are for **Cordova**, the instructions for **Ionic** and **PhoneGap** are practically the same, except for some slight command line argument differences.\n\nInitialize the iOS framework:\n\n```shell\ncd BlinkID\n./initIOSFramework.sh\ncd ..\n```\n\nAdd the **BlinkID** plugin to your project:\n\n```shell\ncd \ncordova plugin add # or blinkid-cordova if you don't have blinkid-phonegap locally\n```\n\n**Ionic specific:**\n\nCopy the BlinkID plugin's JavaScript files to your project:\n```shell\ncp -f -r /www/js ./www/\n```\n\n### Android\n\nAdd Android platform support to the project:\n\n cordova platform add android@8\n \n### iOS\n\n> If you want to add iOS as a platform for your application, you will need to install **unzip** and **wget**.\n\nAdd iOS plaform support to the project:\n\n cordova platform add ios\n\n## Sample\n\nHere's a complete example of how to create and build a project for **Android** and **iOS** using **cordova** (you can substitute equivalent commands for **phonegap**):\n\n```shell\n# pull the plugin and sample application from Github\ngit clone https://github.com/BlinkID/blinkid-phonegap.git\n\n# create a empty application\ncordova create testcordova\n\ncd testcordova\n\n# add the blinkID plugin\ncordova plugin add ../blinkid-phonegap/BlinkID # or just 'blinkid-cordova' if you don't have blinkid-phonegap locally\n\n# add android support to the project\ncordova platform add android@8\n\n# build the project, the binary will appear in the bin/ folder\ncordova build android\n\n# add ios support to the project\ncordova platform add ios\n\n# build the project\ncordova build ios\n```\n\nIn **phonegap** CLI instead of `platform add` just request a build for the platform using `build android` or `build ios`. You will have to do the manual steps described above to be able to do a successfull build.\n\nYou can also use provided `initCordovaSampleApp.sh` script that will generate a sample app that uses the plugin:\n\n```shell\n./initCordovaSampleApp.sh\n```\n\nTo run the script, you'll need BASH environment on Windows (Linux and MacOS use BASH by default).\n\n\n## Usage\n\nTo use the plugin you call it in your Javascript code like the [sample application](www/js/index.js).\n\nDocumentation for all features and JS API is available in [blinkIdScanner.js JS API file](BlinkID/www/blinkIdScanner.js).\n\n\n## Changing scanner settings\n\nTo change scanner settings you need to modify Phonegap plugin classes for iOS and Android. Plugin classes are located in `./BlinkID/src`. All necessary settings documentation is located in those source files. \n\nFor platform specific implementation details refer to the [BlinkID-iOS](https://github.com/BlinkID/blinkid-ios) and [BlinkID-android](https://github.com/BlinkID/blinkid-android) documentation."},"npm":{"downloads":[{"from":"2022-12-21T00:00:00.000Z","to":"2022-12-22T00:00:00.000Z","count":0},{"from":"2022-12-15T00:00:00.000Z","to":"2022-12-22T00:00:00.000Z","count":16},{"from":"2022-11-22T00:00:00.000Z","to":"2022-12-22T00:00:00.000Z","count":116},{"from":"2022-09-23T00:00:00.000Z","to":"2022-12-22T00:00:00.000Z","count":586},{"from":"2022-06-25T00:00:00.000Z","to":"2022-12-22T00:00:00.000Z","count":1651},{"from":"2021-12-22T00:00:00.000Z","to":"2022-12-22T00:00:00.000Z","count":3672}],"starsCount":0},"github":{"starsCount":45,"forksCount":31,"subscribersCount":26,"issues":{"count":152,"openCount":13,"distribution":{"3600":61,"10800":8,"32400":8,"97200":11,"291600":7,"874800":6,"2624400":3,"7873200":6,"23619600":13,"70858800":18,"212576400":11},"isDisabled":false},"contributors":[{"username":"i1E","commitsCount":126},{"username":"juraskrlec","commitsCount":63},{"username":"DoDoENT","commitsCount":41},{"username":"Cerovec","commitsCount":27},{"username":"matvidako","commitsCount":18},{"username":"culoi","commitsCount":8},{"username":"mijo-gracanin","commitsCount":5},{"username":"jskrlec","commitsCount":1},{"username":"headdetect","commitsCount":1},{"username":"jkylehumphrey","commitsCount":1},{"username":"dinogustinn","commitsCount":1},{"username":"jcular","commitsCount":1},{"username":"tonikreso","commitsCount":1}],"commits":[{"from":"2022-12-15T00:00:00.000Z","to":"2022-12-22T00:00:00.000Z","count":0},{"from":"2022-11-22T00:00:00.000Z","to":"2022-12-22T00:00:00.000Z","count":0},{"from":"2022-09-23T00:00:00.000Z","to":"2022-12-22T00:00:00.000Z","count":0},{"from":"2022-06-25T00:00:00.000Z","to":"2022-12-22T00:00:00.000Z","count":3},{"from":"2021-12-22T00:00:00.000Z","to":"2022-12-22T00:00:00.000Z","count":15}]},"source":{"files":{"readmeSize":0,"testsSize":0,"hasChangelog":true}}},"evaluation":{"quality":{"carefulness":0.41000000000000003,"tests":0,"health":1,"branding":0},"popularity":{"communityInterest":115,"downloadsCount":195.33333333333334,"downloadsAcceleration":-1.7704147640791477,"dependentsCount":0},"maintenance":{"releasesFrequency":0.8801369863013699,"commitsFrequency":0.3301027397260274,"openIssues":1,"issuesDistribution":0}},"score":{"final":0.39830927430230856,"detail":{"quality":0.4378770290145486,"popularity":0.10343576998608495,"maintenance":0.6592675602937551}}}