@xbone-3/cordova-plugin-mlkit-barcodescanner 4.0.0

package/CHANGELOG.md

@@ -0,0 +1,51 @@
+# Changelog
+
+All notable changes to this project are documented in this file. The format is
+based on [Keep a Changelog](https://keepachangelog.com/), and this project
+adheres to [Semantic Versioning](https://semver.org/).
+
+## [4.0.0] - 2026-06-13
+
+### Added
+
+- `continuous` option — keep the camera open and stream every newly detected
+  barcode (deduplicated) until the user closes the scanner.
+- `multiple` option — detect every barcode in a frame; the success callback then
+  receives an array of results.
+- `drawDetectionBorder` option (Android) — draw a border around each detected
+  barcode in the preview, tracing its corner points (follows rotated and 2D
+  codes).
+- `confirmation` option (Android) — freeze the preview on detection with the
+  decoded value and Confirm/Retry buttons; the result is returned only on
+  Confirm.
+- TypeScript `types` entry so consumers resolve the bundled `.d.ts` declarations
+  on `import`.
+
+### Changed
+
+- **Breaking:** `detectorSize` is now the fraction of the **screen** that is
+  scanned — a centred rectangle covering that percentage of both the width and
+  the height, where `1` scans the whole screen and draws no focus box.
+  Previously it was a fixed centred square of the smaller dimension that could
+  never cover the full screen.
+
+### Fixed
+
+- Android: corrected the Cordova service name, which caused every scan to fail
+  immediately with a single-character `"C"` message (Cordova's
+  `"Class not found"` error).
+- Android: scans after the first were cancelled before the camera opened, caused
+  by a duplicate `setActivityResultCallback` that aborted the in-flight scan.
+  Each scan now opens and reads correctly.
+- Android: back-press / permission-denied is now reported as a cancellation
+  (`{ cancelled: true }`) instead of being silently swallowed, and no longer
+  risks a crash on a null result intent.
+- Normalised the error callback so Cordova framework errors surface their full
+  message rather than just the first character.
+
+### Chore
+
+- Made the `clean` build script cross-platform (`rimraf`) so the build runs on
+  Windows as well as POSIX shells.
+
+[4.0.0]: https://github.com/XBone-3/cordova-plugin-mlkit-barcodescanner/releases/tag/v4.0.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Dealr, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,260 @@
+# :camera: cordova-plugin-mlkit-barcode-scanner
+
+## Purpose of this Project
+
+The purpose of this project is to provide a barcode scanner utilizing the Google ML Kit Vision library for the Cordova framework on iOS and Android.
+The MLKit library is incredibly performant and fast in comparison to any other barcode reader that I have used that are free.
+
+## Plugin Dependencies
+
+| Dependency                        | Version   | Info                       |
+| --------------------------------- | --------- | -------------------------- |
+| `cordova-android`                 | `>=8.0.0` |                            |
+| `cordova-ios`                     | `>=4.5.0` |                            |
+| `cordova-plugin-androidx`         | ` ^3.0.0` | If cordova-android < 9.0.0 |
+| `cordova-plugin-androidx-adapter` | ` ^1.1.3` |                            |
+
+## Prerequisites
+
+If your `cordova-android` version is below `9.0.0`, you have to install `cordova-plugin-androidx` first before installing this plugin.
+Execute this command in your terminal:
+
+```bash
+npx cordova plugin add cordova-plugin-androidx
+```
+
+## Installation
+
+Run this command in your project root:
+
+```bash
+npx cordova plugin add cordova-plugin-mlkit-barcode-scanner
+```
+
+## Supported Platforms
+
+- Android
+- iOS/iPadOS
+
+## Barcode Support
+
+| 1d formats   | Android | iOS |
+| ------------ | ------- | --- |
+| Codabar      | ✓       | ✓   |
+| Code 39      | ✓       | ✓   |
+| Code 93      | ✓       | ✓   |
+| Code 128     | ✓       | ✓   |
+| EAN-8.       | ✓       | ✓   |
+| EAN-13       | ✓       | ✓   |
+| ITF          | ✓       | ✓   |
+| MSI          | ✗       | ✗   |
+| RSS Expanded | ✗       | ✗   |
+| RSS-14       | ✗       | ✗   |
+| UPC-A        | ✓       | ✓   |
+| UPC-E        | ✓       | ✓   |
+
+| 2d formats  | Android | iOS |
+| ----------- | ------- | --- |
+| Aztec       | ✓       | ✓   |
+| Codablock   | ✗       | ✗   |
+| Data Matrix | ✓       | ✓   |
+| MaxiCode    | ✗       | ✗   |
+| PDF417      | ✓       | ✓   |
+| QR Code     | ✓       | ✓   |
+
+:information_source: Note that this API does not recognize barcodes in these forms:
+
+- 1D Barcodes with only one character
+- Barcodes in ITF format with fewer than six characters
+- Barcodes encoded with FNC2, FNC3 or FNC4
+- QR codes generated in the ECI mode
+
+## Usage
+
+To use the plugin simply call `cordova.plugins.mlkit.barcodeScanner.scan(options, sucessCallback, failureCallback)`. See the sample below.
+
+```javascript
+cordova.plugins.mlkit.barcodeScanner.scan(
+  options,
+  (result) => {
+    // Do something with the data
+    alert(result);
+  },
+  (error) => {
+    // Error handling
+  },
+);
+```
+
+### Plugin Options
+
+The default options are shown below.
+All values are optional.
+
+`detectorSize` is the fraction of the **screen** that is scanned (a value in the
+range `(0, 1]`). It is a centred rectangle covering that percentage of both the
+width and the height, so only barcodes the user sees inside the focus box are
+detected. A value of `1` scans the **whole screen** and draws no focus box.
+Values outside `(0, 1]` fall back to the default. (Android.)
+
+```javascript
+const defaultOptions = {
+  barcodeFormats: {
+    Code128: true,
+    Code39: true,
+    Code93: true,
+    CodaBar: true,
+    DataMatrix: true,
+    EAN13: true,
+    EAN8: true,
+    ITF: true,
+    QRCode: true,
+    UPCA: true,
+    UPCE: true,
+    PDF417: true,
+    Aztec: true,
+  },
+  beepOnSuccess: false,
+  vibrateOnSuccess: false,
+  detectorSize: 0.6,
+  rotateCamera: false,
+  continuous: false,
+  multiple: false,
+  drawDetectionBorder: false,
+  confirmation: false,
+};
+```
+
+#### `continuous`
+
+When `true`, the camera stays open and every newly detected barcode is streamed
+back to the success callback (which may therefore be called many times). Each
+distinct barcode is reported only once. The scanner stays open until the user
+presses back, at which point the error callback is invoked with
+`{ cancelled: true }`. Default: `false` (the camera closes after the first
+result).
+
+#### `multiple`
+
+When `true`, every barcode visible in a frame is detected and the success
+callback receives an **array** of results instead of a single result. Can be
+combined with `continuous`. Default: `false`.
+
+#### `drawDetectionBorder`
+
+When `true`, a border is drawn around each barcode in the camera preview as it
+is detected, tracing the code's corner points (so it follows rotated and 2D
+codes). Default: `false`. (Android only.)
+
+#### `confirmation`
+
+When `true`, a detected barcode is not returned immediately. The preview
+freezes on the detected frame with the decoded value and **Confirm** / **Retry**
+buttons; the result is returned only when the user taps Confirm. Combine with
+`multiple` to confirm a whole frame of codes at once. Ignored in `continuous`
+mode. Default: `false`. (Android only.)
+
+### Output/Return value
+
+With the default options the success callback receives a single result:
+
+```javascript
+result: {
+  text: string;
+  format: string;
+  type: string;
+}
+```
+
+When `multiple: true`, it instead receives an array of such results:
+
+```javascript
+result: Array<{
+  text: string;
+  format: string;
+  type: string;
+}>;
+```
+
+## Known Issues
+
+On some devices the camera may be upside down.
+
+Here is a list of devices with this problem:
+
+- Zebra MC330K (Manufacturer: Zebra Technologies, Model: MC33)
+
+Current Solution:
+if your device has this problem, you can call the plugin with the option `rotateCamera` set to `true`.
+This will rotate the camera stream by 180 degrees.
+
+## Development
+
+### Build Process
+
+This project uses npm scripts for building:
+
+```shell
+# lint the project using eslint
+npm run lint
+
+# removes the generated folders
+npm run clean
+
+# build the project
+# (includes clean and lint)
+npm run build
+
+# publish the project
+# (includes build)
+npm publish
+```
+
+A VS Code task for `build` is also included.
+
+## Run the test app
+
+Install cordova:
+
+```
+npm i -g cordova
+```
+
+Go to test app:
+
+```
+cd test/scan-test-app
+```
+
+Install node modules:
+
+```
+npm i
+```
+
+Prepare Cordova:
+
+```
+cordova prepare && cordova plugin add ../../ --link --force
+```
+
+Build and run the project Android:
+
+```
+cordova build android && cordova run android
+```
+
+and iOS:
+
+```
+cordova build ios && cordova run ios
+```
+
+### Versioning
+
+⚠️ Before incrementing the version in `package.json`, remember to increment the version in `plugin.xml` by hand.
+
+### VS Code Extensions
+
+This project is intended to be used with Visual Studio Code and the recommended extensions can be found in [`.vscode/extensions.json`](.vscode/extensions.json).
+When you open this repository for the first time in Visual Studio Code you should get a prompt asking you to install the recommended extensions.

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@xbone-3/cordova-plugin-mlkit-barcodescanner",
+  "version": "4.0.0",
+  "description": "Google MLKit Vision Barcode Scanner Plugin for Cordova",
+  "cordova": {
+    "id": "@xbone-3/cordova-plugin-mlkit-barcodescanner",
+    "platforms": [
+      "android",
+      "ios"
+    ]
+  },
+  "keywords": [
+    "ecosystem:cordova",
+    "cordova-ios",
+    "cordova-android"
+  ],
+  "author": "XBone-3",
+  "license": "MIT",
+  "main": "www/BarcodeScanner.contract.js",
+  "types": "www/BarcodeScanner.contract.d.ts",
+  "engines": {
+    "node": ">=10.0.0"
+  },
+  "scripts": {
+    "build": "npm run lint && npm run clean && npm run transpile",
+    "clean": "rimraf www",
+    "lint": "eslint . --ext .js,.ts --cache && tsc -p tsconfig.lint.json",
+    "test": "npm run test:android:build",
+    "test:android:deps": "cd test/scan-test-app && npm install",
+    "test:android:prepare": "cd test/scan-test-app && npx cordova prepare android && npx cordova plugin add ../../ --link --force",
+    "test:android:build": "cd test/scan-test-app && npx cordova build android",
+    "test:android:run": "cd test/scan-test-app && npx cordova run android",
+    "test:android": "npm run test:android:deps && npm run test:android:prepare && npm run test:android:build && npm run test:android:run",
+    "transpile": "rollup --config --silent",
+    "prepublishOnly": "npm run build"
+  },
+  "files": [
+    "/src/",
+    "/www/**/*.{js,js.map,d.ts}",
+    "/plugin.xml",
+    "/CHANGELOG.md"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/XBone-3/cordova-plugin-mlkit-barcodescanner.git"
+  },
+  "homepage": "https://github.com/XBone-3/cordova-plugin-mlkit-barcodescanner#readme",
+  "devDependencies": {
+    "@rollup/plugin-node-resolve": "13.0.4",
+    "@rollup/plugin-typescript": "8.3.0",
+    "@typescript-eslint/eslint-plugin": "5.62.0",
+    "@typescript-eslint/parser": "5.62.0",
+    "@types/cordova": "0.0.34",
+    "@types/node": "16.7.1",
+    "eslint": "7.32.0",
+    "rollup": "2.56.3",
+    "typescript": "4.4.4",
+    "tslib": "2.3.1"
+  },
+  "bugs": {
+    "url": "https://github.com/XBone-3/cordova-plugin-mlkit-barcodescanner/issues"
+  },
+  "directories": {
+    "test": "test"
+  },
+  "dependencies": {}
+}

package/plugin.xml

@@ -0,0 +1,133 @@
+<?xml version='1.0' encoding='utf-8'?>
+<plugin id="@xbone-3/cordova-plugin-mlkit-barcodescanner"
+  version="4.0.0"
+  xmlns="http://apache.org/cordova/ns/plugins/1.0"
+  xmlns:android="http://schemas.android.com/apk/res/android">
+  <name>@xbone-3/cordova-plugin-mlkit-barcodescanner</name>
+  <js-module name="cordova-plugin-mlkit-barcodescanner"
+    src="www/BarcodeScanner.plugin.js">
+    <clobbers target="cordova.plugins.mlkit.barcodeScanner" />
+  </js-module>
+
+  <engines>
+    <engine name="cordova"
+      version=">=7.1.0" />
+    <engine name="cordova-android"
+      version=">=8.0.0" />
+    <engine name="cordova-ios"
+      version=">=4.5.0" />
+  </engines>
+  <platform name="ios">
+    <config-file parent="/*"
+      target="config.xml">
+      <feature name="cordova-plugin-mlkit-barcodescanner">
+        <param name="ios-package"
+          value="CDViOSScanner" />
+      </feature>
+    </config-file>
+    <config-file target="*-Info.plist"
+      parent="CFBundleDevelopmentRegion">
+      <string>de_DE</string>
+    </config-file>
+    <config-file target="*-Info.plist"
+      parent="CFBundleLocalizations">
+      <array>
+        <string>en</string>
+        <string>de</string>
+      </array>
+    </config-file>
+
+    <framework src="Foundation.framework" />
+    <framework src="AVFoundation.framework" />
+    <framework src="UIKit.framework" />
+    <podspec>
+      <config>
+        <source url="https://cdn.cocoapods.org/" />
+      </config>
+      <pods use-frameworks="true">
+        <pod name="GoogleMLKit/BarcodeScanning"
+          spec="~> 2.5.0" />
+      </pods>
+    </podspec>
+    <header-file src="src/ios/CDViOSScanner.h" />
+    <source-file src="src/ios/CDViOSScanner.m" />
+    <header-file src="src/ios/CameraViewController.h" />
+    <source-file src="src/ios/CameraViewController.m" />
+    <resource-file src="src/ios/Sounds/beep.caf" />
+    <resource-file src="src/ios/de.lproj/Localizable.strings"
+      target="de.lproj/Localizable.strings" />
+    <resource-file src="src/ios/en.lproj/Localizable.strings"
+      target="en.lproj/Localizable.strings" />
+  </platform>
+  <platform name="android">
+    <dependency id="cordova-plugin-androidx-adapter"
+      version="^1.1.3" />
+
+    <config-file parent="/*"
+      target="res/xml/config.xml">
+      <feature name="cordova-plugin-mlkit-barcodescanner">
+        <param name="android-package"
+          value="com.mobisys.cordova.plugins.mlkit.barcode.scanner.MLKitBarcodeScanner" />
+      </feature>
+    </config-file>
+
+    <config-file parent="/*"
+      target="AndroidManifest.xml">
+      <uses-permission android:name="android.permission.CAMERA" />
+      <uses-permission android:name="android.permission.VIBRATE" />
+      <uses-feature android:name="android.hardware.camera"
+        android:required="false" />
+    </config-file>
+
+    <config-file parent="application"
+      target="AndroidManifest.xml">
+      <meta-data android:name="com.google.android.gms.version"
+        android:value="@integer/google_play_services_version" />
+      <meta-data android:name="com.google.android.gms.vision.DEPENDENCIES"
+        android:value="barcode" />
+      <activity android:label="Read Barcode"
+        android:name="com.mobisys.cordova.plugins.mlkit.barcode.scanner.CaptureActivity"
+        android:theme="@style/Theme.AppCompat.Light.NoActionBar" />
+    </config-file>
+
+    <source-file src="src/android/src/CaptureActivity.java"
+      target-dir="src/com/mobisys/cordova/plugins/mlkit/barcode/scanner" />
+    <source-file src="src/android/src/MLKitBarcodeScanner.java"
+      target-dir="src/com/mobisys/cordova/plugins/mlkit/barcode/scanner" />
+    <source-file src="src/android/src/utils/BitmapUtils.java"
+      target-dir="src/com/mobisys/cordova/plugins/mlkit/barcode/scanner/utils" />
+    <source-file src="src/android/src/utils/FrameMetadata.java"
+      target-dir="src/com/mobisys/cordova/plugins/mlkit/barcode/scanner/utils" />
+
+    <resource-file src="src/android/res/assets/beep.ogg"
+      target="assets/beep.ogg" />
+    <resource-file src="src/android/res/values/strings-en.xml"
+      target="res/values/strings.xml" />
+    <resource-file src="src/android/res/values/strings-de.xml"
+      target="res/values-de/strings.xml" />
+    <resource-file src="src/android/res/layout/capture_activity.xml"
+      target="res/layout/capture_activity.xml" />
+    <resource-file src="src/android/res/drawable/flashlight.png"
+      target="res/drawable/flashlight.png" />
+    <resource-file src="src/android/res/drawable/torch_active.xml"
+      target="res/drawable/torch_active.xml" />
+    <resource-file src="src/android/res/drawable/torch_inactive.xml"
+      target="res/drawable/torch_inactive.xml" />
+
+    <framework src="com.android.support:support-v4:27.1.0" />
+    <framework src="com.android.support:design:27.1.0" />
+
+    <framework src="com.google.android.gms:play-services-vision:17.0.2" />
+    <framework src="com.google.mlkit:barcode-scanning:16.2.0" />
+
+    <framework src="androidx.camera:camera-core:1.0.0-beta05" />
+    <framework src="androidx.camera:camera-camera2:1.0.0-beta05" />
+    <framework src="androidx.camera:camera-lifecycle:1.0.0-beta05" />
+    <framework src="androidx.camera:camera-view:1.0.0-alpha12" />
+    <framework src="androidx.constraintlayout:constraintlayout:2.0.4" />
+
+    <framework src="src/android/build-extras.gradle"
+      custom="true"
+      type="gradleReference" />
+  </platform>
+</plugin>

package/src/android/build-extras.gradle

@@ -0,0 +1,14 @@
+ext.postBuildExtras = {
+    android {
+        compileOptions {
+            sourceCompatibility JavaVersion.VERSION_1_8
+            targetCompatibility JavaVersion.VERSION_1_8
+        }
+        allprojects {
+            compileOptions {
+                sourceCompatibility = JavaVersion.VERSION_1_8
+                targetCompatibility = JavaVersion.VERSION_1_8
+            }
+        }
+    }
+}

package/src/android/res/drawable/torch_active.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<layer-list xmlns:android="http://schemas.android.com/apk/res/android" >
+    <item>
+        <shape xmlns:android="http://schemas.android.com/apk/res/android" android:shape="oval">
+            <solid android:color="#FFFFFF" />
+        </shape>
+    </item>
+    <item android:drawable="@drawable/flashlight" android:bottom="10dp" android:top="10dp" android:left="10dp" android:right="10dp" >
+
+    </item>
+</layer-list>

package/src/android/res/drawable/torch_inactive.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<layer-list xmlns:android="http://schemas.android.com/apk/res/android" >
+    <item>
+        <shape xmlns:android="http://schemas.android.com/apk/res/android" android:shape="oval">
+            <solid android:color="#40FFFFFF" />
+        </shape>
+    </item>
+    <item android:drawable="@drawable/flashlight" android:bottom="10dp" android:top="10dp" android:left="10dp" android:right="10dp" >
+
+    </item>
+</layer-list>

package/src/android/res/layout/capture_activity.xml

@@ -0,0 +1,97 @@
+<?xml version="1.0" encoding="utf-8"?>
+<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:app="http://schemas.android.com/apk/res-auto"
+    xmlns:tools="http://schemas.android.com/tools"
+    android:id="@+id/topLayout"
+    android:layout_width="match_parent"
+    android:layout_height="match_parent">
+
+    <SurfaceView
+        android:id="@+id/overlay"
+        android:layout_width="0dp"
+        android:layout_height="0dp"
+        app:layout_constraintBottom_toBottomOf="parent"
+        app:layout_constraintEnd_toEndOf="parent"
+        app:layout_constraintStart_toStartOf="parent"
+        app:layout_constraintTop_toTopOf="parent" />
+
+    <androidx.camera.view.PreviewView
+        android:id="@+id/previewView"
+        android:layout_width="0dp"
+        android:layout_height="0dp"
+        app:layout_constraintBottom_toBottomOf="parent"
+        app:layout_constraintEnd_toEndOf="parent"
+        app:layout_constraintHorizontal_bias="0.0"
+        app:layout_constraintStart_toStartOf="parent"
+        app:layout_constraintTop_toTopOf="@+id/overlay"
+        app:layout_constraintVertical_bias="0.0">
+
+    </androidx.camera.view.PreviewView>
+
+    <!-- Frozen camera frame shown while awaiting scan confirmation. -->
+    <ImageView
+        android:id="@+id/freeze_frame"
+        android:layout_width="0dp"
+        android:layout_height="0dp"
+        android:visibility="gone"
+        android:scaleType="fitCenter"
+        app:layout_constraintBottom_toBottomOf="parent"
+        app:layout_constraintEnd_toEndOf="parent"
+        app:layout_constraintStart_toStartOf="parent"
+        app:layout_constraintTop_toTopOf="parent" />
+
+    <ImageButton
+        android:id="@+id/torch_button"
+        android:layout_width="50dp"
+        android:layout_height="50dp"
+        app:layout_constraintBottom_toBottomOf="parent"
+        app:layout_constraintEnd_toEndOf="parent"
+        android:layout_margin="20dp"
+        android:background="@drawable/torch_inactive"
+        />
+
+    <!-- Confirmation prompt shown on detection when `confirmation` is enabled. -->
+    <LinearLayout
+        android:id="@+id/confirm_panel"
+        android:layout_width="0dp"
+        android:layout_height="wrap_content"
+        android:orientation="vertical"
+        android:padding="16dp"
+        android:background="#CC000000"
+        android:visibility="gone"
+        app:layout_constraintBottom_toBottomOf="parent"
+        app:layout_constraintEnd_toEndOf="parent"
+        app:layout_constraintStart_toStartOf="parent">
+
+        <TextView
+            android:id="@+id/confirm_text"
+            android:layout_width="match_parent"
+            android:layout_height="wrap_content"
+            android:textColor="#FFFFFF"
+            android:textSize="16sp"
+            android:maxLines="3"
+            android:ellipsize="end"
+            android:paddingBottom="12dp" />
+
+        <LinearLayout
+            android:layout_width="match_parent"
+            android:layout_height="wrap_content"
+            android:orientation="horizontal"
+            android:gravity="end">
+
+            <Button
+                android:id="@+id/retry_button"
+                android:layout_width="wrap_content"
+                android:layout_height="wrap_content"
+                android:layout_marginEnd="12dp" />
+
+            <Button
+                android:id="@+id/confirm_button"
+                android:layout_width="wrap_content"
+                android:layout_height="wrap_content" />
+
+        </LinearLayout>
+
+    </LinearLayout>
+
+</androidx.constraintlayout.widget.ConstraintLayout>