@scr2em/capacitor-scanner 6.0.7 → 6.0.8

package/README.md

@@ -16,7 +16,7 @@ npx cap sync
 * [`startScanning(...)`](#startscanning)
 * [`stopScanning()`](#stopscanning)
 * [`openSettings()`](#opensettings)
-* [`capturePhoto()`](#capturephoto)
+* [`capturePhoto(...)`](#capturephoto)
 * [`checkPermissions()`](#checkpermissions)
 * [`requestPermissions()`](#requestpermissions)
 * [`flipCamera()`](#flipcamera)
@@ -62,12 +62,16 @@ openSettings() => Promise<void>
 --------------------
 
 
-### capturePhoto()
+### capturePhoto(...)
 
 ```typescript
-capturePhoto() => Promise<CapturePhotoResult>
+capturePhoto(options?: CapturePhotoOptions | undefined) => Promise<CapturePhotoResult>
 ```
 
+| Param         | Type                                                                |
+| ------------- | ------------------------------------------------------------------- |
+| **`options`** | <code><a href="#capturephotooptions">CapturePhotoOptions</a></code> |
+
 **Returns:** <code>Promise&lt;<a href="#capturephotoresult">CapturePhotoResult</a>&gt;</code>
 
 --------------------
@@ -151,6 +155,11 @@ removeAllListeners() => Promise<void>
 <code>{ imageBase64: string }</code>
 
 
+#### CapturePhotoOptions
+
+<code>{ /** * The desired quality of the captured image, expressed as a value between 0.0 (lowest quality, smallest file size) * and 1.0 (highest quality, largest file size). Defaults to 1.0. * This parameter directly influences the compression level of the resulting JPEG image. */ qualityRatio?: number; }</code>
+
+
 #### PermissionsResult
 
 <code>{ camera: 'prompt' | 'denied' | 'granted' }</code>

package/android/src/main/java/com/leadliaion/capacitorscanner/CapacitorScannerPlugin.java

@@ -3,6 +3,8 @@ package com.leadliaion.capacitorscanner;
 import android.Manifest;
 import android.content.Intent;
 import android.content.pm.PackageManager;
+import android.graphics.Bitmap;
+import android.graphics.BitmapFactory;
 import android.graphics.Color;
 import android.net.Uri;
 import android.provider.Settings;
@@ -390,6 +392,12 @@ public class CapacitorScannerPlugin extends Plugin {
             return;
         }
 
+        // Ratio must be between 0 and 1, where 0 or 1 means no reduction.
+        Double qualityRatioObj = call.getDouble("qualityRatio", 1.0);
+        double qualityRatio = qualityRatioObj != null ? qualityRatioObj : 1.0;
+
+
+        // Temporary stream to receive the captured image data.
         ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
 
         ImageCapture.OutputFileOptions outputOptions =
@@ -400,13 +408,45 @@ public class CapacitorScannerPlugin extends Plugin {
                     @Override
                     public void onImageSaved(@NonNull ImageCapture.OutputFileResults outputFileResults) {
                         try {
-                            byte[] bytes = outputStream.toByteArray();
+                            // Get the original image bytes.
+                            byte[] originalBytes = outputStream.toByteArray();
+                            int originalSize = originalBytes.length; // in bytes
+
+                            // If qualityRatio is between 0 and 1 exclusively, perform quality reduction.
+                            if (qualityRatio > 0 && qualityRatio < 1) {
+                                // Calculate the target size in bytes.
+                                int targetSize = (int) (originalSize * qualityRatio);
+
+                                // Decode the captured image into a Bitmap.
+                                Bitmap originalBitmap = BitmapFactory.decodeByteArray(originalBytes, 0, originalSize);
+                                if (originalBitmap == null) {
+                                    call.reject("Failed to decode captured image.");
+                                    return;
+                                }
 
-                            String base64 = Base64.encodeToString(bytes, Base64.NO_WRAP);
+                                // Prepare a stream to hold the compressed bitmap.
+                                ByteArrayOutputStream compressedStream = new ByteArrayOutputStream();
+                                int quality = 100;  // start with maximum quality (100)
 
+                                // Iteratively compress the bitmap until it reaches the target file size.
+                                do {
+                                    compressedStream.reset();
+                                    originalBitmap.compress(Bitmap.CompressFormat.JPEG, quality, compressedStream);
+                                    quality -= 5; // Lower the quality step by step.
+                                } while (compressedStream.toByteArray().length > targetSize && quality > 10);
+
+                                // Use the compressed image bytes.
+                                originalBytes = compressedStream.toByteArray();
+
+                                // Cleanup: recycle the bitmap and close the compressed stream.
+                                originalBitmap.recycle();
+                                compressedStream.close();
+                            }
+
+                            // Convert the final image bytes to a Base64 string.
+                            String base64 = Base64.encodeToString(originalBytes, Base64.NO_WRAP);
                             JSObject ret = new JSObject();
                             ret.put("imageBase64", "data:image/jpeg;base64," + base64);
-
                             call.resolve(ret);
                         } catch (Exception e) {
                             call.reject("Failed to process image: " + e.getMessage());
@@ -426,13 +466,17 @@ public class CapacitorScannerPlugin extends Plugin {
                         try {
                             outputStream.close();
                         } catch (IOException e) {
-                           echo("Failed to close output stream: " + e.getMessage());
+                            echo("Failed to close output stream: " + e.getMessage());
                         }
                     }
                 });
     }
 
 
+
+
+
+
     @PluginMethod
     public void checkPermissions(PluginCall call) {
         PermissionState cameraPermState = getPermissionState("camera");

package/dist/docs.json

@@ -45,13 +45,20 @@
       },
       {
         "name": "capturePhoto",
-        "signature": "() => Promise<CapturePhotoResult>",
-        "parameters": [],
+        "signature": "(options?: CapturePhotoOptions | undefined) => Promise<CapturePhotoResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "CapturePhotoOptions | undefined"
+          }
+        ],
         "returns": "Promise<CapturePhotoResult>",
         "tags": [],
         "docs": "",
         "complexTypes": [
-          "CapturePhotoResult"
+          "CapturePhotoResult",
+          "CapturePhotoOptions"
         ],
         "slug": "capturephoto"
       },
@@ -237,6 +244,17 @@
         }
       ]
     },
+    {
+      "name": "CapturePhotoOptions",
+      "slug": "capturephotooptions",
+      "docs": "",
+      "types": [
+        {
+          "text": "{\n  /**\n   * The desired quality of the captured image, expressed as a value between 0.0 (lowest quality, smallest file size)\n   * and 1.0 (highest quality, largest file size). Defaults to 1.0.\n   * This parameter directly influences the compression level of the resulting JPEG image.\n   */\n  qualityRatio?: number;\n}",
+          "complexTypes": []
+        }
+      ]
+    },
     {
       "name": "PermissionsResult",
       "slug": "permissionsresult",

package/dist/esm/definitions.d.ts

@@ -2,7 +2,7 @@ export interface CapacitorScannerPlugin {
     startScanning(options?: ScannerOptions): Promise<void>;
     stopScanning(): Promise<void>;
     openSettings(): Promise<void>;
-    capturePhoto(): Promise<CapturePhotoResult>;
+    capturePhoto(options?: CapturePhotoOptions): Promise<CapturePhotoResult>;
     checkPermissions(): Promise<PermissionsResult>;
     requestPermissions(): Promise<PermissionsResult>;
     flipCamera(): Promise<void>;
@@ -19,6 +19,14 @@ export declare type BarcodeScannedEvent = {
     scannedCode: string;
     format: string;
 };
+export declare type CapturePhotoOptions = {
+    /**
+     * The desired quality of the captured image, expressed as a value between 0.0 (lowest quality, smallest file size)
+     * and 1.0 (highest quality, largest file size). Defaults to 1.0.
+     * This parameter directly influences the compression level of the resulting JPEG image.
+     */
+    qualityRatio?: number;
+};
 export declare type PermissionsResult = {
     camera: 'prompt' | 'denied' | 'granted';
 };

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AA2BA,MAAM,CAAN,IAAY,aAYX;AAZD,WAAY,aAAa;IACvB,gCAAe,CAAA;IACf,mCAAkB,CAAA;IAClB,mCAAkB,CAAA;IAClB,qCAAoB,CAAA;IACpB,2CAA0B,CAAA;IAC1B,+BAAc,CAAA;IACd,iCAAgB,CAAA;IAChB,gCAAe,CAAA;IACf,mCAAkB,CAAA;IAClB,mCAAkB,CAAA;IAClB,+BAAc,CAAA;AAChB,CAAC,EAZW,aAAa,KAAb,aAAa,QAYxB","sourcesContent":["export interface CapacitorScannerPlugin {\n  startScanning(options?: ScannerOptions): Promise<void>;\n  stopScanning(): Promise<void>;\n  openSettings(): Promise<void>;\n  capturePhoto(): Promise<CapturePhotoResult>;\n  checkPermissions(): Promise<PermissionsResult>;\n  requestPermissions(): Promise<PermissionsResult>;\n  flipCamera(): Promise<void>;\n  toggleFlash(): Promise<FlashResult>;\n  addListener(event: 'barcodeScanned', listenerFunc: (result: BarcodeScannedEvent) => void): Promise<void>;\n  removeAllListeners(): Promise<void>;\n}\n\nexport type ScannerOptions = {\n  formats?: BarcodeFormat[];\n  cameraDirection?: 'BACK' | 'FRONT';\n  debounceTimeInMilli?: number\n};\n\nexport type BarcodeScannedEvent = { scannedCode: string; format: string };\n\nexport type PermissionsResult = { camera: 'prompt' | 'denied' | 'granted' };\n\nexport type CapturePhotoResult = { imageBase64: string };\n\nexport type FlashResult = { enabled: boolean };\n\nexport enum BarcodeFormat {\n  Aztec = 'AZTEC',\n  Code39 = 'CODE_39',\n  Code93 = 'CODE_93',\n  Code128 = 'CODE_128',\n  DataMatrix = 'DATA_MATRIX',\n  Ean8 = 'EAN_8',\n  Ean13 = 'EAN_13',\n  Itf14 = 'ITF14',\n  Pdf417 = 'PDF_417',\n  QrCode = 'QR_CODE',\n  UpcE = 'UPC_E',\n}\n\ndeclare global {\n  interface PluginRegistry {\n    QRScanner: CapacitorScannerPlugin;\n  }\n}"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAoCA,MAAM,CAAN,IAAY,aAYX;AAZD,WAAY,aAAa;IACvB,gCAAe,CAAA;IACf,mCAAkB,CAAA;IAClB,mCAAkB,CAAA;IAClB,qCAAoB,CAAA;IACpB,2CAA0B,CAAA;IAC1B,+BAAc,CAAA;IACd,iCAAgB,CAAA;IAChB,gCAAe,CAAA;IACf,mCAAkB,CAAA;IAClB,mCAAkB,CAAA;IAClB,+BAAc,CAAA;AAChB,CAAC,EAZW,aAAa,KAAb,aAAa,QAYxB","sourcesContent":["export interface CapacitorScannerPlugin {\n  startScanning(options?: ScannerOptions): Promise<void>;\n  stopScanning(): Promise<void>;\n  openSettings(): Promise<void>;\n  capturePhoto(options?: CapturePhotoOptions): Promise<CapturePhotoResult>;\n  checkPermissions(): Promise<PermissionsResult>;\n  requestPermissions(): Promise<PermissionsResult>;\n  flipCamera(): Promise<void>;\n  toggleFlash(): Promise<FlashResult>;\n  addListener(event: 'barcodeScanned', listenerFunc: (result: BarcodeScannedEvent) => void): Promise<void>;\n  removeAllListeners(): Promise<void>;\n}\n\nexport type ScannerOptions = {\n  formats?: BarcodeFormat[];\n  cameraDirection?: 'BACK' | 'FRONT';\n  debounceTimeInMilli?: number\n};\n\nexport type BarcodeScannedEvent = { scannedCode: string; format: string };\n\nexport type CapturePhotoOptions = {\n  /**\n   * The desired quality of the captured image, expressed as a value between 0.0 (lowest quality, smallest file size)\n   * and 1.0 (highest quality, largest file size). Defaults to 1.0.\n   * This parameter directly influences the compression level of the resulting JPEG image.\n   */\n  qualityRatio?: number;\n};\n\nexport type PermissionsResult = { camera: 'prompt' | 'denied' | 'granted' };\n\nexport type CapturePhotoResult = { imageBase64: string };\n\nexport type FlashResult = { enabled: boolean };\n\nexport enum BarcodeFormat {\n  Aztec = 'AZTEC',\n  Code39 = 'CODE_39',\n  Code93 = 'CODE_93',\n  Code128 = 'CODE_128',\n  DataMatrix = 'DATA_MATRIX',\n  Ean8 = 'EAN_8',\n  Ean13 = 'EAN_13',\n  Itf14 = 'ITF14',\n  Pdf417 = 'PDF_417',\n  QrCode = 'QR_CODE',\n  UpcE = 'UPC_E',\n}\n\ndeclare global {\n  interface PluginRegistry {\n    QRScanner: CapacitorScannerPlugin;\n  }\n}"]}

package/ios/Sources/CapacitorScannerPlugin/CapacitorScannerPlugin.swift

@@ -56,7 +56,24 @@ public class CapacitorScannerPlugin: CAPPlugin, CAPBridgedPlugin, AVCaptureMetad
 			return
 		}
 
-		let photoSettings = AVCapturePhotoSettings()
+		// Get quality ratio from options, default to 1.0, clamp between 0.0 and 1.0
+		let quality = call.getFloat("qualityRatio", 1.0)
+		let clampedQuality = max(0.0, min(1.0, quality))
+		let qualityNumber = NSNumber(value: clampedQuality) // Convert to NSNumber
+
+		var photoSettings = AVCapturePhotoSettings() // Initialize with default settings
+
+		// Check if JPEG is supported and apply compression settings if it is
+		if photoOutput.supportedPhotoCodecTypes(for: .jpg).contains(.jpeg) {
+			// Create settings specific for JPEG with quality
+			photoSettings = AVCapturePhotoSettings(format: [AVVideoCodecKey: AVVideoCodecType.jpeg, // Use the type directly
+			                                                AVVideoCompressionPropertiesKey: [AVVideoQualityKey: qualityNumber]])
+			photoSettings.photoQualityPrioritization = .quality // Prioritize quality
+		} else {
+			print("JPEG codec not supported for photo capture. Using default settings.")
+			// photoSettings remains the default initialized one
+		}
+
 		self.capturePhotoCall = call
 		photoOutput.capturePhoto(with: photoSettings, delegate: self)
 	}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scr2em/capacitor-scanner",
-  "version": "6.0.7",
+  "version": "6.0.8",
   "description": "scan codes",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",