@scr2em/capacitor-scanner 6.0.11 → 6.0.18

package/README.md

@@ -22,7 +22,10 @@ npx cap sync
 * [`flipCamera()`](#flipcamera)
 * [`toggleFlash()`](#toggleflash)
 * [`addListener('barcodeScanned', ...)`](#addlistenerbarcodescanned-)
+* [`addListener('rectangleDetected', ...)`](#addlistenerrectangledetected-)
 * [`removeAllListeners()`](#removealllisteners)
+* [`enableObjectDetection(...)`](#enableobjectdetection)
+* [`disableObjectDetection()`](#disableobjectdetection)
 * [Type Aliases](#type-aliases)
 * [Enums](#enums)
 
@@ -34,45 +37,51 @@ npx cap sync
 ### startScanning(...)
 
 ```typescript
-startScanning(options?: ScannerOptions | undefined) => Promise<void>
+startScanning(options?: ScannerOptions | undefined) => any
 ```
 
 | Param         | Type                                                      |
 | ------------- | --------------------------------------------------------- |
 | **`options`** | <code><a href="#scanneroptions">ScannerOptions</a></code> |
 
+**Returns:** <code>any</code>
+
 --------------------
 
 
 ### stopScanning()
 
 ```typescript
-stopScanning() => Promise<void>
+stopScanning() => any
 ```
 
+**Returns:** <code>any</code>
+
 --------------------
 
 
 ### openSettings()
 
 ```typescript
-openSettings() => Promise<void>
+openSettings() => any
 ```
 
+**Returns:** <code>any</code>
+
 --------------------
 
 
 ### capturePhoto(...)
 
 ```typescript
-capturePhoto(options?: CapturePhotoOptions | undefined) => Promise<CapturePhotoResult>
+capturePhoto(options?: CapturePhotoOptions | undefined) => any
 ```
 
 | Param         | Type                                                                |
 | ------------- | ------------------------------------------------------------------- |
 | **`options`** | <code><a href="#capturephotooptions">CapturePhotoOptions</a></code> |
 
-**Returns:** <code>Promise&lt;<a href="#capturephotoresult">CapturePhotoResult</a>&gt;</code>
+**Returns:** <code>any</code>
 
 --------------------
 
@@ -80,10 +89,10 @@ capturePhoto(options?: CapturePhotoOptions | undefined) => Promise<CapturePhotoR
 ### checkPermissions()
 
 ```typescript
-checkPermissions() => Promise<PermissionsResult>
+checkPermissions() => any
 ```
 
-**Returns:** <code>Promise&lt;<a href="#permissionsresult">PermissionsResult</a>&gt;</code>
+**Returns:** <code>any</code>
 
 --------------------
 
@@ -91,10 +100,10 @@ checkPermissions() => Promise<PermissionsResult>
 ### requestPermissions()
 
 ```typescript
-requestPermissions() => Promise<PermissionsResult>
+requestPermissions() => any
 ```
 
-**Returns:** <code>Promise&lt;<a href="#permissionsresult">PermissionsResult</a>&gt;</code>
+**Returns:** <code>any</code>
 
 --------------------
 
@@ -102,19 +111,21 @@ requestPermissions() => Promise<PermissionsResult>
 ### flipCamera()
 
 ```typescript
-flipCamera() => Promise<void>
+flipCamera() => any
 ```
 
+**Returns:** <code>any</code>
+
 --------------------
 
 
 ### toggleFlash()
 
 ```typescript
-toggleFlash() => Promise<FlashResult>
+toggleFlash() => any
 ```
 
-**Returns:** <code>Promise&lt;<a href="#flashresult">FlashResult</a>&gt;</code>
+**Returns:** <code>any</code>
 
 --------------------
 
@@ -122,7 +133,7 @@ toggleFlash() => Promise<FlashResult>
 ### addListener('barcodeScanned', ...)
 
 ```typescript
-addListener(event: 'barcodeScanned', listenerFunc: (result: BarcodeScannedEvent) => void) => Promise<void>
+addListener(event: 'barcodeScanned', listenerFunc: (result: BarcodeScannedEvent) => void) => any
 ```
 
 | Param              | Type                                                                                     |
@@ -130,15 +141,61 @@ addListener(event: 'barcodeScanned', listenerFunc: (result: BarcodeScannedEvent)
 | **`event`**        | <code>'barcodeScanned'</code>                                                            |
 | **`listenerFunc`** | <code>(result: <a href="#barcodescannedevent">BarcodeScannedEvent</a>) =&gt; void</code> |
 
+**Returns:** <code>any</code>
+
+--------------------
+
+
+### addListener('rectangleDetected', ...)
+
+```typescript
+addListener(event: 'rectangleDetected', listenerFunc: (result: RectangleDetectedEvent) => void) => any
+```
+
+| Param              | Type                                                                                           |
+| ------------------ | ---------------------------------------------------------------------------------------------- |
+| **`event`**        | <code>'rectangleDetected'</code>                                                               |
+| **`listenerFunc`** | <code>(result: <a href="#rectangledetectedevent">RectangleDetectedEvent</a>) =&gt; void</code> |
+
+**Returns:** <code>any</code>
+
 --------------------
 
 
 ### removeAllListeners()
 
 ```typescript
-removeAllListeners() => Promise<void>
+removeAllListeners() => any
+```
+
+**Returns:** <code>any</code>
+
+--------------------
+
+
+### enableObjectDetection(...)
+
+```typescript
+enableObjectDetection({ types }: ObjectDetectionOptions) => any
+```
+
+| Param     | Type                                                                      |
+| --------- | ------------------------------------------------------------------------- |
+| **`__0`** | <code><a href="#objectdetectionoptions">ObjectDetectionOptions</a></code> |
+
+**Returns:** <code>any</code>
+
+--------------------
+
+
+### disableObjectDetection()
+
+```typescript
+disableObjectDetection() => any
 ```
 
+**Returns:** <code>any</code>
+
 --------------------
 
 
@@ -150,14 +207,14 @@ removeAllListeners() => Promise<void>
 <code>{ formats?: BarcodeFormat[]; cameraDirection?: 'BACK' | 'FRONT'; debounceTimeInMilli?: number }</code>
 
 
-#### CapturePhotoResult
+#### CapturePhotoOptions
 
-<code>{ imageBase64: string }</code>
+<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>
 
 
-#### CapturePhotoOptions
+#### CapturePhotoResult
 
-<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>
+<code>{ imageBase64: string }</code>
 
 
 #### PermissionsResult
@@ -175,6 +232,16 @@ removeAllListeners() => Promise<void>
 <code>{ scannedCode: string; format: string }</code>
 
 
+#### RectangleDetectedEvent
+
+<code>{ detected: true }</code>
+
+
+#### ObjectDetectionOptions
+
+<code>{ types: ('barcode' | 'businessCard')[], /** * Optional padding ratio to apply around detected rectangles when cropping. * Value must be between 0 and 1, where: * - 0 = no padding * - 1 = 100% padding (not recommended) * Default is 0.01 (1%) if not specified. */ paddingRatio?: number }</code>
+
+
 ### Enums
 
 

package/android/build.gradle

@@ -1,8 +1,16 @@
 ext {
     junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
-    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.6.1'
-    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.1.5'
-    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.5.1'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.7.1'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.3.0'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.7.0'
+    
+    // Rectangle detector variables
+    compile_sdk_version = 35
+    min_sdk_version = 23
+    target_sdk_version = 35
+    version_code = 1
+    version_name = "1.0.0"
+    junit_version = '4.13.2'
 }
 
 buildscript {
@@ -11,7 +19,9 @@ buildscript {
         mavenCentral()
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:8.2.1'
+        classpath 'com.android.tools.build:gradle:8.13.0'
+        classpath 'org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.10'
+        classpath 'org.jetbrains.dokka:dokka-gradle-plugin:2.1.0'
     }
 }
 
@@ -19,10 +29,10 @@ apply plugin: 'com.android.library'
 
 android {
     namespace "com.leadliaion.capacitorscanner"
-    compileSdk project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 34
+    compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 35
     defaultConfig {
-        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 22
-        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 34
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 23
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 35
         versionCode 1
         versionName "1.0"
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
@@ -56,19 +66,20 @@ dependencies {
     androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
     androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
 
-    // CameraX dependencies
-    implementation "androidx.camera:camera-core:1.1.0"
-    implementation "androidx.camera:camera-camera2:1.1.0"
-    implementation "androidx.camera:camera-lifecycle:1.1.0"
-    implementation "androidx.camera:camera-view:1.1.0"
-
     // ML Kit Barcode Scanning
     implementation "com.google.mlkit:barcode-scanning:17.3.0"
 
     // Other dependencies
-    implementation "androidx.lifecycle:lifecycle-common-java8:2.6.1"
-    implementation "com.google.guava:guava:31.1-android" // For ListenableFuture
+    implementation "androidx.lifecycle:lifecycle-common-java8:2.9.4"
+    implementation "com.google.guava:guava:33.5.0-android" // For ListenableFuture
 
-    // implementation 'com.google.zxing:core:3.5.3'
-    // implementation 'com.journeyapps:zxing-android-embedded:4.3.0'
-}
+
+    // Exposed as 'api' so consuming apps get them transitively
+    api 'org.opencv:opencv:4.12.0'
+    implementation files('libs/rectangle-detector-release.aar')
+    api "androidx.camera:camera-core:1.5.1"
+    api "androidx.camera:camera-camera2:1.5.1"
+    api "androidx.camera:camera-lifecycle:1.5.1"
+    api "androidx.camera:camera-view:1.5.1"
+
+}