@capacitor/barcode-scanner 1.0.0-alpha.1

package/CapacitorBarcodeScanner.podspec

@@ -0,0 +1,18 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name = 'CapacitorBarcodeScanner'
+  s.version = package['version']
+  s.summary = package['description']
+  s.license = package['license']
+  s.homepage = package['repository']['url']
+  s.author = package['author']
+  s.source = { :git => package['repository']['url'], :tag => s.version.to_s }
+  s.source_files = 'ios/Plugin/**/*.{swift,h,m,c,cc,mm,cpp}'
+  s.ios.deployment_target  = '13.0'
+  s.dependency 'Capacitor'
+  s.dependency 'OSBarcodeLib', '~> 1.1.0'
+  s.swift_version = '5.1'
+end

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 OutSystems
+
+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,153 @@
+# @capacitor/barcode-scanner
+
+Capacitor plugin using Outsystems Barcode libs
+
+## Install
+
+```bash
+npm install @capacitor/barcode-scanner
+npx cap sync
+```
+
+#### Android
+
+You will need to modify the `allprojects > repositories` section in your `android/build.gradle` file to include the Outsystems repository. Your `android/build.gradle` file should look similar to this after adding the repository.
+
+```gradle
+allprojects {
+    repositories {
+        google()
+        mavenCentral()
+        maven {
+            url 'https://pkgs.dev.azure.com/OutSystemsRD/9e79bc5b-69b2-4476-9ca5-d67594972a52/_packaging/PublicArtifactRepository/maven/v1'
+            name 'Azure'
+            credentials {
+                username = "optional"
+                password = ""
+            }
+            content {
+                includeGroup "com.github.outsystems"
+            }
+        }
+    }
+}
+```
+
+---
+
+## API
+
+<docgen-index>
+
+* [`scanBarcode(...)`](#scanbarcode)
+* [Type Aliases](#type-aliases)
+* [Enums](#enums)
+
+</docgen-index>
+
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+Interface defining the contract for a plugin capable of scanning barcodes.
+Requires implementation of the scanBarcode method, which initiates a barcode scan with given options.
+
+### scanBarcode(...)
+
+```typescript
+scanBarcode(options: CapacitorBarcodeScannerOptions) => Promise<CapacitorBarcodeScannerScanResult>
+```
+
+| Param         | Type                                                                                      |
+| ------------- | ----------------------------------------------------------------------------------------- |
+| **`options`** | <code><a href="#capacitorbarcodescanneroptions">CapacitorBarcodeScannerOptions</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#capacitorbarcodescannerscanresult">CapacitorBarcodeScannerScanResult</a>&gt;</code>
+
+--------------------
+
+
+### Type Aliases
+
+
+#### CapacitorBarcodeScannerScanResult
+
+Defines the structure of the result returned from a barcode scan.
+
+<code>{ ScanResult: string }</code>
+
+
+#### CapacitorBarcodeScannerOptions
+
+Defines the options for configuring a barcode scan.
+
+<code>{ hint: <a href="#capacitorbarcodescannertypehint">CapacitorBarcodeScannerTypeHint</a>; scanInstructions?: string; scanButton?: boolean; scanText?: string; cameraDirection?: <a href="#capacitorbarcodescannercameradirection">CapacitorBarcodeScannerCameraDirection</a>; scanOrientation?: <a href="#capacitorbarcodescannerscanorientation">CapacitorBarcodeScannerScanOrientation</a>; android?: { scanningLibrary?: <a href="#capacitorbarcodescannerandroidscanninglibrary">CapacitorBarcodeScannerAndroidScanningLibrary</a>; }; web?: { showCameraSelection?: boolean; scannerFPS?: number; }; }</code>
+
+
+#### CapacitorBarcodeScannerTypeHint
+
+Extends supported formats from Html5Qrcode with a special 'ALL' option,
+indicating support for all barcode types.
+Type definition combining <a href="#html5qrcodesupportedformats">Html5QrcodeSupportedFormats</a> and OSBarcodeTypeHintALLOption
+to represent the hint for the type of barcode to be scanned.
+
+<code><a href="#html5qrcodesupportedformats">Html5QrcodeSupportedFormats</a> | <a href="#capacitorbarcodescannertypehintalloption">CapacitorBarcodeScannerTypeHintALLOption</a></code>
+
+
+### Enums
+
+
+#### Html5QrcodeSupportedFormats
+
+| Members                 | Value           |
+| ----------------------- | --------------- |
+| **`QR_CODE`**           | <code>0</code>  |
+| **`AZTEC`**             | <code>1</code>  |
+| **`CODABAR`**           | <code>2</code>  |
+| **`CODE_39`**           | <code>3</code>  |
+| **`CODE_93`**           | <code>4</code>  |
+| **`CODE_128`**          | <code>5</code>  |
+| **`DATA_MATRIX`**       | <code>6</code>  |
+| **`MAXICODE`**          | <code>7</code>  |
+| **`ITF`**               | <code>8</code>  |
+| **`EAN_13`**            | <code>9</code>  |
+| **`EAN_8`**             | <code>10</code> |
+| **`PDF_417`**           | <code>11</code> |
+| **`RSS_14`**            | <code>12</code> |
+| **`RSS_EXPANDED`**      | <code>13</code> |
+| **`UPC_A`**             | <code>14</code> |
+| **`UPC_E`**             | <code>15</code> |
+| **`UPC_EAN_EXTENSION`** | <code>16</code> |
+
+
+#### CapacitorBarcodeScannerTypeHintALLOption
+
+| Members   | Value           |
+| --------- | --------------- |
+| **`ALL`** | <code>17</code> |
+
+
+#### CapacitorBarcodeScannerCameraDirection
+
+| Members     | Value          |
+| ----------- | -------------- |
+| **`BACK`**  | <code>1</code> |
+| **`FRONT`** | <code>2</code> |
+
+
+#### CapacitorBarcodeScannerScanOrientation
+
+| Members         | Value          |
+| --------------- | -------------- |
+| **`PORTRAIT`**  | <code>1</code> |
+| **`LANDSCAPE`** | <code>2</code> |
+| **`ADAPTIVE`**  | <code>3</code> |
+
+
+#### CapacitorBarcodeScannerAndroidScanningLibrary
+
+| Members     | Value                |
+| ----------- | -------------------- |
+| **`ZXING`** | <code>'zxing'</code> |
+| **`MLKIT`** | <code>'mlkit'</code> |
+
+</docgen-api>

package/android/build.gradle

@@ -0,0 +1,97 @@
+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'
+}
+
+buildscript {
+    ext.kotlin_version = project.hasProperty("kotlin_version") ? rootProject.ext.kotlin_version : '1.9.22'
+    repositories {
+        maven {
+            url 'https://pkgs.dev.azure.com/OutSystemsRD/9e79bc5b-69b2-4476-9ca5-d67594972a52/_packaging/PublicArtifactRepository/maven/v1'
+            name 'Azure'
+            credentials {
+                username = "optional"
+                password = ""
+            }
+            content {
+                includeGroup "com.github.outsystems"
+            }
+        }
+        google()
+        mavenCentral()
+        flatDir {
+            dirs 'libs'
+        }
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:8.2.2'
+        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
+    }
+}
+
+apply plugin: 'com.android.library'
+apply plugin: 'kotlin-android'
+
+android {
+    namespace "com.capacitorjs.barcodescanner"
+    compileSdk project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 34
+    defaultConfig {
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 26
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 34
+        versionCode 1
+        versionName "1.0"
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+    lintOptions {
+        abortOnError false
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_17
+        targetCompatibility JavaVersion.VERSION_17
+    }
+}
+
+repositories {
+    maven {
+        url 'https://pkgs.dev.azure.com/OutSystemsRD/9e79bc5b-69b2-4476-9ca5-d67594972a52/_packaging/PublicArtifactRepository/maven/v1'
+        name 'Azure'
+        credentials {
+            username = "optional"
+            password = ""
+        }
+        content {
+            includeGroup "com.github.outsystems"
+        }
+    }
+    google()
+    mavenCentral()
+}
+
+dependencies {
+    // implementation fileTree(dir: 'libs', include: ['*.aar', '*.jar'])
+    implementation "com.github.outsystems:osbarcode-android:[1.0.1, 2.0.0[@aar"
+    implementation project(':capacitor-android')
+    implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
+    implementation 'androidx.activity:activity-ktx:1.8.2'
+    implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm:1.6.4'
+    implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.6.4'
+    implementation 'com.google.zxing:core:3.4.1'
+    implementation 'com.google.mlkit:barcode-scanning:17.2.0'
+    implementation 'androidx.camera:camera-camera2:1.3.1'
+    implementation 'androidx.camera:camera-lifecycle:1.3.1'
+    implementation 'androidx.camera:camera-view:1.3.1'
+    implementation 'androidx.activity:activity-compose:1.8.2'
+    implementation 'androidx.compose.material3:material3:1.1.2'
+    implementation 'androidx.compose.material3:material3-window-size-class:1.1.2'
+    testImplementation "junit:junit:$junitVersion"
+    androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
+    androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1 @@
+<manifest />

package/android/src/main/java/com/capacitorjs/barcodescanner/OSBarcodePlugin.kt

@@ -0,0 +1,76 @@
+package com.capacitorjs.barcodescanner
+
+import android.content.Intent
+import androidx.activity.result.ActivityResult
+import com.getcapacitor.JSObject
+import com.getcapacitor.Plugin
+import com.getcapacitor.PluginCall
+import com.getcapacitor.PluginMethod
+import com.getcapacitor.annotation.ActivityCallback
+import com.getcapacitor.annotation.CapacitorPlugin
+import com.outsystems.plugins.barcode.controller.OSBARCController
+import com.outsystems.plugins.barcode.model.OSBARCScanParameters
+import com.outsystems.plugins.barcode.view.OSBARCScannerActivity
+
+@CapacitorPlugin(name = "CapacitorBarcodeScanner")
+class CapacitorBarcodeScannerPlugin : Plugin() {
+    companion object {
+        private const val ERROR_FORMAT_PREFIX = "OS-PLUG-BARC-"
+        private const val SCAN_REQUEST_CODE = 112
+    }
+
+    private lateinit var barcodeController: OSBARCController
+
+    override fun load() {
+        super.load()
+        barcodeController = OSBARCController()
+    }
+
+    @PluginMethod
+    fun scanBarcode(call: PluginCall) {
+        val hint = call.getInt("hint")
+        val scanInstructions = call.getString("scanInstructions")
+        val scanButton = call.getBoolean("scanButton", false)
+        val scanText = call.getString("scanText", "")
+        val cameraDirection = call.getInt("cameraDirection")
+
+        val nativeOptions = call.getObject("native")
+
+        val scanOrientation = nativeOptions?.getInteger("scanOrientation")
+        val androidScanningLibrary = nativeOptions?.getJSObject("android")?.getString("scanningLibrary")
+
+        val parameters = OSBARCScanParameters(
+                scanInstructions = scanInstructions,
+                cameraDirection = cameraDirection,
+                scanOrientation = scanOrientation,
+                scanButton = scanButton!!,
+                scanText = scanText!!,
+                hint = hint,
+                androidScanningLibrary = androidScanningLibrary
+        )
+
+        val scanIntent = Intent(activity, OSBARCScannerActivity::class.java)
+                .putExtra("SCAN_PARAMETERS", parameters)
+
+        startActivityForResult(call, scanIntent, "handleScanResult")
+    }
+
+    @ActivityCallback
+    fun handleScanResult(call: PluginCall, result: ActivityResult) {
+        barcodeController.handleActivityResult(
+                SCAN_REQUEST_CODE, result.resultCode, result.data,
+                onSuccess = { scanResult ->
+                    val ret = JSObject()
+                    ret.put("ScanResult", scanResult)
+                    call.resolve(ret)
+                },
+                onError = { error ->
+                    call.reject(error.description, formatErrorCode(error.code))
+                }
+        )
+    }
+
+    private fun formatErrorCode(code: Int): String {
+        return ERROR_FORMAT_PREFIX + code.toString().padStart(4, '0')
+    }
+}

package/dist/docs.json

@@ -0,0 +1,262 @@
+{
+  "api": {
+    "name": "CapacitorBarcodeScannerPlugin",
+    "slug": "capacitorbarcodescannerplugin",
+    "docs": "Interface defining the contract for a plugin capable of scanning barcodes.\nRequires implementation of the scanBarcode method, which initiates a barcode scan with given options.",
+    "tags": [],
+    "methods": [
+      {
+        "name": "scanBarcode",
+        "signature": "(options: CapacitorBarcodeScannerOptions) => Promise<CapacitorBarcodeScannerScanResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "CapacitorBarcodeScannerOptions"
+          }
+        ],
+        "returns": "Promise<CapacitorBarcodeScannerScanResult>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "CapacitorBarcodeScannerScanResult",
+          "CapacitorBarcodeScannerOptions"
+        ],
+        "slug": "scanbarcode"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [],
+  "enums": [
+    {
+      "name": "Html5QrcodeSupportedFormats",
+      "slug": "html5qrcodesupportedformats",
+      "members": [
+        {
+          "name": "QR_CODE",
+          "value": "0",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "AZTEC",
+          "value": "1",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "CODABAR",
+          "value": "2",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "CODE_39",
+          "value": "3",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "CODE_93",
+          "value": "4",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "CODE_128",
+          "value": "5",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "DATA_MATRIX",
+          "value": "6",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "MAXICODE",
+          "value": "7",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "ITF",
+          "value": "8",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "EAN_13",
+          "value": "9",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "EAN_8",
+          "value": "10",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "PDF_417",
+          "value": "11",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "RSS_14",
+          "value": "12",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "RSS_EXPANDED",
+          "value": "13",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "UPC_A",
+          "value": "14",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "UPC_E",
+          "value": "15",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "UPC_EAN_EXTENSION",
+          "value": "16",
+          "tags": [],
+          "docs": ""
+        }
+      ]
+    },
+    {
+      "name": "CapacitorBarcodeScannerTypeHintALLOption",
+      "slug": "capacitorbarcodescannertypehintalloption",
+      "members": [
+        {
+          "name": "ALL",
+          "value": "17",
+          "tags": [],
+          "docs": ""
+        }
+      ]
+    },
+    {
+      "name": "CapacitorBarcodeScannerCameraDirection",
+      "slug": "capacitorbarcodescannercameradirection",
+      "members": [
+        {
+          "name": "BACK",
+          "value": "1",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "FRONT",
+          "value": "2",
+          "tags": [],
+          "docs": ""
+        }
+      ]
+    },
+    {
+      "name": "CapacitorBarcodeScannerScanOrientation",
+      "slug": "capacitorbarcodescannerscanorientation",
+      "members": [
+        {
+          "name": "PORTRAIT",
+          "value": "1",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "LANDSCAPE",
+          "value": "2",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "ADAPTIVE",
+          "value": "3",
+          "tags": [],
+          "docs": ""
+        }
+      ]
+    },
+    {
+      "name": "CapacitorBarcodeScannerAndroidScanningLibrary",
+      "slug": "capacitorbarcodescannerandroidscanninglibrary",
+      "members": [
+        {
+          "name": "ZXING",
+          "value": "'zxing'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "MLKIT",
+          "value": "'mlkit'",
+          "tags": [],
+          "docs": ""
+        }
+      ]
+    }
+  ],
+  "typeAliases": [
+    {
+      "name": "CapacitorBarcodeScannerScanResult",
+      "slug": "capacitorbarcodescannerscanresult",
+      "docs": "Defines the structure of the result returned from a barcode scan.",
+      "types": [
+        {
+          "text": "{ ScanResult: string }",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "CapacitorBarcodeScannerOptions",
+      "slug": "capacitorbarcodescanneroptions",
+      "docs": "Defines the options for configuring a barcode scan.",
+      "types": [
+        {
+          "text": "{\n  hint: CapacitorBarcodeScannerTypeHint;\n  scanInstructions?: string;\n  scanButton?: boolean;\n  scanText?: string;\n  cameraDirection?: CapacitorBarcodeScannerCameraDirection;\n  scanOrientation?: CapacitorBarcodeScannerScanOrientation;\n  android?: {\n    scanningLibrary?: CapacitorBarcodeScannerAndroidScanningLibrary;\n  };\n  web?: {\n    showCameraSelection?: boolean;\n    scannerFPS?: number;\n  };\n}",
+          "complexTypes": [
+            "CapacitorBarcodeScannerTypeHint",
+            "CapacitorBarcodeScannerCameraDirection",
+            "CapacitorBarcodeScannerScanOrientation",
+            "CapacitorBarcodeScannerAndroidScanningLibrary"
+          ]
+        }
+      ]
+    },
+    {
+      "name": "CapacitorBarcodeScannerTypeHint",
+      "slug": "capacitorbarcodescannertypehint",
+      "docs": "Extends supported formats from Html5Qrcode with a special 'ALL' option,\nindicating support for all barcode types.\nType definition combining Html5QrcodeSupportedFormats and OSBarcodeTypeHintALLOption\nto represent the hint for the type of barcode to be scanned.",
+      "types": [
+        {
+          "text": "Html5QrcodeSupportedFormats",
+          "complexTypes": [
+            "Html5QrcodeSupportedFormats"
+          ]
+        },
+        {
+          "text": "CapacitorBarcodeScannerTypeHintALLOption",
+          "complexTypes": [
+            "CapacitorBarcodeScannerTypeHintALLOption"
+          ]
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": []
+}