@capgo/capacitor-document-scanner 7.0.0

package/CapgoCapacitorDocumentScanner.podspec

@@ -0,0 +1,17 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name = 'CapgoCapacitorDocumentScanner'
+  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/Sources/**/*.{swift,h,m,c,cc,mm,cpp}'
+  s.ios.deployment_target = '14.0'
+  s.dependency 'Capacitor'
+  s.swift_version = '5.1'
+end

package/Package.swift

@@ -0,0 +1,28 @@
+// swift-tools-version: 5.9
+import PackageDescription
+
+let package = Package(
+    name: "CapgoCapacitorDocumentScanner",
+    platforms: [.iOS(.v14)],
+    products: [
+        .library(
+            name: "CapgoCapacitorDocumentScanner",
+            targets: ["DocumentScannerPlugin"])
+    ],
+    dependencies: [
+        .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", from: "7.0.0")
+    ],
+    targets: [
+        .target(
+            name: "DocumentScannerPlugin",
+            dependencies: [
+                .product(name: "Capacitor", package: "capacitor-swift-pm"),
+                .product(name: "Cordova", package: "capacitor-swift-pm")
+            ],
+            path: "ios/Sources/DocumentScannerPlugin"),
+        .testTarget(
+            name: "DocumentScannerPluginTests",
+            dependencies: ["DocumentScannerPlugin"],
+            path: "ios/Tests/DocumentScannerPluginTests")
+    ]
+)

package/README.md

@@ -0,0 +1,86 @@
+# @capgo/capacitor-document-scanner
+ <a href="https://capgo.app/"><img src='https://raw.githubusercontent.com/Cap-go/capgo/main/assets/capgo_banner.png' alt='Capgo - Instant updates for capacitor'/></a>
+
+<div align="center">
+  <h2><a href="https://capgo.app/?ref=plugin"> ➡️ Get Instant updates for your App with Capgo</a></h2>
+  <h2><a href="https://capgo.app/consulting/?ref=plugin"> Missing a feature? We’ll build the plugin for you 💪</a></h2>
+</div>
+Capacitor plugin to scan document iOS and Android
+
+## Install
+
+```bash
+npm install @capgo/capacitor-document-scanner
+npx cap sync
+```
+
+## API
+
+<docgen-index>
+
+* [`scanDocument(...)`](#scandocument)
+* [Interfaces](#interfaces)
+* [Enums](#enums)
+
+</docgen-index>
+
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+### scanDocument(...)
+
+```typescript
+scanDocument(options?: ScanDocumentOptions | undefined) => Promise<ScanDocumentResponse>
+```
+
+Opens the device camera and starts the document scanning experience.
+
+| Param         | Type                                                                |
+| ------------- | ------------------------------------------------------------------- |
+| **`options`** | <code><a href="#scandocumentoptions">ScanDocumentOptions</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#scandocumentresponse">ScanDocumentResponse</a>&gt;</code>
+
+--------------------
+
+
+### Interfaces
+
+
+#### ScanDocumentResponse
+
+| Prop                | Type                                                                              | Description                                            |
+| ------------------- | --------------------------------------------------------------------------------- | ------------------------------------------------------ |
+| **`scannedImages`** | <code>string[]</code>                                                             | Scanned images in the requested response format.       |
+| **`status`**        | <code><a href="#scandocumentresponsestatus">ScanDocumentResponseStatus</a></code> | Indicates whether the scan completed or was cancelled. |
+
+
+#### ScanDocumentOptions
+
+| Prop                      | Type                                                  | Description                                                                                                            | Default                                 |
+| ------------------------- | ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
+| **`croppedImageQuality`** | <code>number</code>                                   | Android only: quality of the cropped image from 0 - 100 (100 is best).                                                 | <code>100</code>                        |
+| **`letUserAdjustCrop`**   | <code>boolean</code>                                  | Android only: allow the user to adjust the detected crop before saving. Disabling this forces single-document capture. | <code>true</code>                       |
+| **`maxNumDocuments`**     | <code>number</code>                                   | Android only: maximum number of documents the user can scan.                                                           | <code>24</code>                         |
+| **`responseType`**        | <code><a href="#responsetype">ResponseType</a></code> | Format to return scanned images in (file paths or base64 strings).                                                     | <code>ResponseType.ImageFilePath</code> |
+
+
+### Enums
+
+
+#### ScanDocumentResponseStatus
+
+| Members       | Value                  | Description                       |
+| ------------- | ---------------------- | --------------------------------- |
+| **`Success`** | <code>'success'</code> | The scan completed successfully.  |
+| **`Cancel`**  | <code>'cancel'</code>  | The user cancelled the scan flow. |
+
+
+#### ResponseType
+
+| Members             | Value                        | Description                                      |
+| ------------------- | ---------------------------- | ------------------------------------------------ |
+| **`Base64`**        | <code>'base64'</code>        | Return scanned images as base64-encoded strings. |
+| **`ImageFilePath`** | <code>'imageFilePath'</code> | Return scanned images as file paths on disk.     |
+
+</docgen-api>

package/android/build.gradle

@@ -0,0 +1,59 @@
+ext {
+    junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.7.0'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.2.1'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.6.1'
+}
+
+buildscript {
+    repositories {
+        google()
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:8.7.2'
+    }
+}
+
+apply plugin: 'com.android.library'
+
+android {
+    namespace "app.capgo.plugin.documentscanner"
+    compileSdk project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 35
+    defaultConfig {
+        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"
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+    lintOptions {
+        abortOnError false
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_21
+        targetCompatibility JavaVersion.VERSION_21
+    }
+}
+
+repositories {
+    google()
+    mavenCentral()
+}
+
+
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+    implementation project(':capacitor-android')
+    implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
+    implementation "com.google.android.gms:play-services-mlkit-document-scanner:16.0.0"
+    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,2 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+</manifest>

package/android/src/main/java/app/capgo/plugin/document_scanner/DocumentScanner.java

@@ -0,0 +1,11 @@
+package app.capgo.plugin.document_scanner;
+
+import com.getcapacitor.Logger;
+
+public class DocumentScanner {
+
+    public String echo(String value) {
+        Logger.info("Echo", value);
+        return value;
+    }
+}

package/android/src/main/java/app/capgo/plugin/document_scanner/DocumentScannerPlugin.java

@@ -0,0 +1,22 @@
+package app.capgo.plugin.document_scanner;
+
+import com.getcapacitor.JSObject;
+import com.getcapacitor.Plugin;
+import com.getcapacitor.PluginCall;
+import com.getcapacitor.PluginMethod;
+import com.getcapacitor.annotation.CapacitorPlugin;
+
+@CapacitorPlugin(name = "DocumentScanner")
+public class DocumentScannerPlugin extends Plugin {
+
+    private DocumentScanner implementation = new DocumentScanner();
+
+    @PluginMethod
+    public void echo(PluginCall call) {
+        String value = call.getString("value");
+
+        JSObject ret = new JSObject();
+        ret.put("value", implementation.echo(value));
+        call.resolve(ret);
+    }
+}

package/android/src/main/java/app/capgo/plugin/documentscanner/DocumentScannerPlugin.java

@@ -0,0 +1,292 @@
+package app.capgo.plugin.documentscanner;
+
+import android.app.Activity;
+import android.content.Context;
+import android.content.Intent;
+import android.graphics.Bitmap;
+import android.graphics.BitmapFactory;
+import android.net.Uri;
+import android.util.Base64;
+import androidx.activity.result.ActivityResult;
+import androidx.activity.result.ActivityResultLauncher;
+import androidx.activity.result.IntentSenderRequest;
+import androidx.activity.result.contract.ActivityResultContracts;
+import com.getcapacitor.JSArray;
+import com.getcapacitor.JSObject;
+import com.getcapacitor.Logger;
+import com.getcapacitor.Plugin;
+import com.getcapacitor.PluginCall;
+import com.getcapacitor.PluginMethod;
+import com.getcapacitor.annotation.CapacitorPlugin;
+import com.google.mlkit.vision.documentscanner.GmsDocumentScanner;
+import com.google.mlkit.vision.documentscanner.GmsDocumentScannerOptions;
+import com.google.mlkit.vision.documentscanner.GmsDocumentScanning;
+import com.google.mlkit.vision.documentscanner.GmsDocumentScanningResult;
+import com.google.mlkit.vision.documentscanner.GmsDocumentScanningResult.Page;
+import java.io.ByteArrayOutputStream;
+import java.io.File;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Locale;
+
+/**
+ * Bridges Capacitor calls to the ML Kit document scanner.
+ */
+@CapacitorPlugin(name = "DocumentScanner")
+public class DocumentScannerPlugin extends Plugin {
+
+    private static final String RESPONSE_TYPE_BASE64 = "base64";
+    private static final String RESPONSE_TYPE_FILE_PATH = "imageFilePath";
+
+    private ActivityResultLauncher<IntentSenderRequest> scannerLauncher;
+    private PendingScan pendingScan;
+
+    private static class PendingScan {
+
+        private final String callId;
+        private final String responseType;
+        private final int quality;
+
+        PendingScan(String callId, String responseType, int quality) {
+            this.callId = callId;
+            this.responseType = responseType;
+            this.quality = quality;
+        }
+    }
+
+    @Override
+    public void load() {
+        super.load();
+        scannerLauncher = bridge.registerForActivityResult(
+            new ActivityResultContracts.StartIntentSenderForResult(),
+            this::handleScanResult
+        );
+    }
+
+    @PluginMethod
+    public void scanDocument(PluginCall call) {
+        if (scannerLauncher == null) {
+            call.reject("Document scanner is not ready.");
+            return;
+        }
+
+        if (pendingScan != null) {
+            call.reject("Another scan is in progress.");
+            return;
+        }
+
+        Activity activity = getActivity();
+        if (activity == null) {
+            call.reject("Activity reference is unavailable.");
+            return;
+        }
+
+        int quality = clamp(call.getInt("croppedImageQuality", 100), 0, 100);
+        String responseType = normalizeResponseType(call.getString("responseType"));
+        int pageLimit = clamp(call.getInt("maxNumDocuments", 24), 1, 24);
+        boolean allowAdjustCrop = call.getBoolean("letUserAdjustCrop", true);
+
+        GmsDocumentScannerOptions.Builder optionsBuilder = new GmsDocumentScannerOptions.Builder()
+            .setGalleryImportAllowed(false)
+            .setResultFormats(GmsDocumentScannerOptions.RESULT_FORMAT_JPEG)
+            .setPageLimit(pageLimit);
+
+        optionsBuilder.setScannerMode(
+            allowAdjustCrop ? GmsDocumentScannerOptions.SCANNER_MODE_FULL : GmsDocumentScannerOptions.SCANNER_MODE_BASE
+        );
+
+        GmsDocumentScanner scanner = GmsDocumentScanning.getClient(optionsBuilder.build());
+
+        bridge.saveCall(call);
+        pendingScan = new PendingScan(call.getCallbackId(), responseType, quality);
+
+        scanner
+            .getStartScanIntent(activity)
+            .addOnSuccessListener((intentSender) -> {
+                IntentSenderRequest request = new IntentSenderRequest.Builder(intentSender).build();
+                scannerLauncher.launch(request);
+            })
+            .addOnFailureListener((e) -> {
+                Logger.error("DocumentScanner", "Failed to start scanner", e);
+                PluginCall savedCall = getPendingCall();
+                if (savedCall != null) {
+                    savedCall.reject("Unable to start document scanner: " + e.getLocalizedMessage(), e);
+                    releasePendingCall(savedCall);
+                } else {
+                    bridge.releaseCall(call);
+                    pendingScan = null;
+                    call.reject("Unable to start document scanner: " + e.getLocalizedMessage(), e);
+                }
+            });
+    }
+
+    private void handleScanResult(ActivityResult result) {
+        PluginCall call = getPendingCall();
+        if (call == null) {
+            return;
+        }
+
+        if (result.getResultCode() != Activity.RESULT_OK) {
+            JSObject response = new JSObject();
+            response.put("status", "cancel");
+            call.resolve(response);
+            releasePendingCall(call);
+            return;
+        }
+
+        Intent data = result.getData();
+        if (data == null) {
+            call.reject("Document scanner returned no data.");
+            releasePendingCall(call);
+            return;
+        }
+
+        GmsDocumentScanningResult scanningResult = GmsDocumentScanningResult.fromActivityResultIntent(data);
+        if (scanningResult == null) {
+            call.reject("Unable to parse document scan result.");
+            releasePendingCall(call);
+            return;
+        }
+
+        try {
+            List<String> scannedImages = processScanResult(scanningResult);
+            JSObject response = new JSObject();
+            response.put("status", "success");
+            response.put("scannedImages", new JSArray(scannedImages));
+            call.resolve(response);
+        } catch (IOException ioException) {
+            call.reject("Failed to process scanned images: " + ioException.getLocalizedMessage(), ioException);
+        } finally {
+            releasePendingCall(call);
+        }
+    }
+
+    private List<String> processScanResult(GmsDocumentScanningResult scanningResult) throws IOException {
+        List<String> results = new ArrayList<>();
+        List<Page> pages = scanningResult.getPages();
+        if (pages == null || pages.isEmpty()) {
+            return results;
+        }
+
+        for (int index = 0; index < pages.size(); index++) {
+            String processed = handlePage(pages.get(index), index);
+            if (processed != null) {
+                results.add(processed);
+            }
+        }
+        return results;
+    }
+
+    private String handlePage(Page page, int pageIndex) throws IOException {
+        PendingScan scan = pendingScan;
+        if (scan == null) {
+            throw new IOException("No active scan.");
+        }
+
+        Uri imageUri = page.getImageUri();
+        if (imageUri == null) {
+            throw new IOException("Missing image URI for scanned page.");
+        }
+
+        byte[] imageBytes = readBytesFromUri(imageUri);
+        if (scan.quality < 100) {
+            imageBytes = reencodeImage(imageBytes, scan.quality);
+        }
+
+        if (RESPONSE_TYPE_BASE64.equals(scan.responseType)) {
+            return Base64.encodeToString(imageBytes, Base64.NO_WRAP);
+        }
+
+        return writeImageFile(imageBytes, pageIndex);
+    }
+
+    private byte[] readBytesFromUri(Uri uri) throws IOException {
+        Context context = getContext();
+        if (context == null) {
+            throw new IOException("Context unavailable for reading image.");
+        }
+
+        try (InputStream inputStream = context.getContentResolver().openInputStream(uri)) {
+            if (inputStream == null) {
+                throw new IOException("Unable to open image stream.");
+            }
+            ByteArrayOutputStream buffer = new ByteArrayOutputStream();
+            byte[] data = new byte[8192];
+            int nRead;
+            while ((nRead = inputStream.read(data, 0, data.length)) != -1) {
+                buffer.write(data, 0, nRead);
+            }
+            return buffer.toByteArray();
+        }
+    }
+
+    private byte[] reencodeImage(byte[] source, int quality) throws IOException {
+        Bitmap bitmap = BitmapFactory.decodeByteArray(source, 0, source.length);
+        if (bitmap == null) {
+            throw new IOException("Unable to decode scanned image.");
+        }
+        try (ByteArrayOutputStream outputStream = new ByteArrayOutputStream()) {
+            if (!bitmap.compress(Bitmap.CompressFormat.JPEG, quality, outputStream)) {
+                throw new IOException("Unable to compress scanned image.");
+            }
+            return outputStream.toByteArray();
+        } finally {
+            bitmap.recycle();
+        }
+    }
+
+    private String writeImageFile(byte[] imageBytes, int pageIndex) throws IOException {
+        Context context = getContext();
+        if (context == null) {
+            throw new IOException("Context unavailable for writing image.");
+        }
+
+        File directory = new File(context.getCacheDir(), "document_scanner");
+        if (!directory.exists() && !directory.mkdirs()) {
+            throw new IOException("Unable to create cache directory.");
+        }
+
+        String fileName = String.format(Locale.US, "DOCUMENT_SCAN_%d_%d.jpg", pageIndex, System.currentTimeMillis());
+        File outputFile = new File(directory, fileName);
+        try (FileOutputStream outputStream = new FileOutputStream(outputFile)) {
+            outputStream.write(imageBytes);
+        }
+
+        return outputFile.getAbsolutePath();
+    }
+
+    private PluginCall getPendingCall() {
+        if (pendingScan == null) {
+            return null;
+        }
+        return bridge.getSavedCall(pendingScan.callId);
+    }
+
+    private void releasePendingCall(PluginCall call) {
+        if (pendingScan != null) {
+            bridge.releaseCall(call);
+            pendingScan = null;
+        }
+    }
+
+    private int clamp(Integer value, int min, int max) {
+        if (value == null) {
+            return max;
+        }
+        return Math.max(min, Math.min(max, value));
+    }
+
+    private String normalizeResponseType(String value) {
+        if (value == null) {
+            return RESPONSE_TYPE_FILE_PATH;
+        }
+        String normalized = value.toLowerCase(Locale.ROOT);
+        if (RESPONSE_TYPE_BASE64.equals(normalized) || RESPONSE_TYPE_FILE_PATH.equals(normalized)) {
+            return normalized;
+        }
+        return RESPONSE_TYPE_FILE_PATH;
+    }
+}

package/dist/docs.json

@@ -0,0 +1,156 @@
+{
+  "api": {
+    "name": "DocumentScannerPlugin",
+    "slug": "documentscannerplugin",
+    "docs": "",
+    "tags": [],
+    "methods": [
+      {
+        "name": "scanDocument",
+        "signature": "(options?: ScanDocumentOptions | undefined) => Promise<ScanDocumentResponse>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "ScanDocumentOptions | undefined"
+          }
+        ],
+        "returns": "Promise<ScanDocumentResponse>",
+        "tags": [],
+        "docs": "Opens the device camera and starts the document scanning experience.",
+        "complexTypes": [
+          "ScanDocumentResponse",
+          "ScanDocumentOptions"
+        ],
+        "slug": "scandocument"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "ScanDocumentResponse",
+      "slug": "scandocumentresponse",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "scannedImages",
+          "tags": [],
+          "docs": "Scanned images in the requested response format.",
+          "complexTypes": [],
+          "type": "string[] | undefined"
+        },
+        {
+          "name": "status",
+          "tags": [],
+          "docs": "Indicates whether the scan completed or was cancelled.",
+          "complexTypes": [
+            "ScanDocumentResponseStatus"
+          ],
+          "type": "ScanDocumentResponseStatus"
+        }
+      ]
+    },
+    {
+      "name": "ScanDocumentOptions",
+      "slug": "scandocumentoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "croppedImageQuality",
+          "tags": [
+            {
+              "text": "100",
+              "name": "default"
+            }
+          ],
+          "docs": "Android only: quality of the cropped image from 0 - 100 (100 is best).",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "letUserAdjustCrop",
+          "tags": [
+            {
+              "text": "true",
+              "name": "default"
+            }
+          ],
+          "docs": "Android only: allow the user to adjust the detected crop before saving.\nDisabling this forces single-document capture.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "maxNumDocuments",
+          "tags": [
+            {
+              "text": "24",
+              "name": "default"
+            }
+          ],
+          "docs": "Android only: maximum number of documents the user can scan.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "responseType",
+          "tags": [
+            {
+              "text": "ResponseType.ImageFilePath",
+              "name": "default"
+            }
+          ],
+          "docs": "Format to return scanned images in (file paths or base64 strings).",
+          "complexTypes": [
+            "ResponseType"
+          ],
+          "type": "ResponseType"
+        }
+      ]
+    }
+  ],
+  "enums": [
+    {
+      "name": "ScanDocumentResponseStatus",
+      "slug": "scandocumentresponsestatus",
+      "members": [
+        {
+          "name": "Success",
+          "value": "'success'",
+          "tags": [],
+          "docs": "The scan completed successfully."
+        },
+        {
+          "name": "Cancel",
+          "value": "'cancel'",
+          "tags": [],
+          "docs": "The user cancelled the scan flow."
+        }
+      ]
+    },
+    {
+      "name": "ResponseType",
+      "slug": "responsetype",
+      "members": [
+        {
+          "name": "Base64",
+          "value": "'base64'",
+          "tags": [],
+          "docs": "Return scanned images as base64-encoded strings."
+        },
+        {
+          "name": "ImageFilePath",
+          "value": "'imageFilePath'",
+          "tags": [],
+          "docs": "Return scanned images as file paths on disk."
+        }
+      ]
+    }
+  ],
+  "typeAliases": [],
+  "pluginConfigs": []
+}

package/dist/esm/definitions.d.ts

@@ -0,0 +1,59 @@
+export interface DocumentScannerPlugin {
+    /**
+     * Opens the device camera and starts the document scanning experience.
+     */
+    scanDocument(options?: ScanDocumentOptions): Promise<ScanDocumentResponse>;
+}
+export interface ScanDocumentOptions {
+    /**
+     * Android only: quality of the cropped image from 0 - 100 (100 is best).
+     * @default 100
+     */
+    croppedImageQuality?: number;
+    /**
+     * Android only: allow the user to adjust the detected crop before saving.
+     * Disabling this forces single-document capture.
+     * @default true
+     */
+    letUserAdjustCrop?: boolean;
+    /**
+     * Android only: maximum number of documents the user can scan.
+     * @default 24
+     */
+    maxNumDocuments?: number;
+    /**
+     * Format to return scanned images in (file paths or base64 strings).
+     * @default ResponseType.ImageFilePath
+     */
+    responseType?: ResponseType;
+}
+export declare enum ResponseType {
+    /**
+     * Return scanned images as base64-encoded strings.
+     */
+    Base64 = "base64",
+    /**
+     * Return scanned images as file paths on disk.
+     */
+    ImageFilePath = "imageFilePath"
+}
+export interface ScanDocumentResponse {
+    /**
+     * Scanned images in the requested response format.
+     */
+    scannedImages?: string[];
+    /**
+     * Indicates whether the scan completed or was cancelled.
+     */
+    status?: ScanDocumentResponseStatus;
+}
+export declare enum ScanDocumentResponseStatus {
+    /**
+     * The scan completed successfully.
+     */
+    Success = "success",
+    /**
+     * The user cancelled the scan flow.
+     */
+    Cancel = "cancel"
+}

package/dist/esm/definitions.js

@@ -0,0 +1,23 @@
+export var ResponseType;
+(function (ResponseType) {
+    /**
+     * Return scanned images as base64-encoded strings.
+     */
+    ResponseType["Base64"] = "base64";
+    /**
+     * Return scanned images as file paths on disk.
+     */
+    ResponseType["ImageFilePath"] = "imageFilePath";
+})(ResponseType || (ResponseType = {}));
+export var ScanDocumentResponseStatus;
+(function (ScanDocumentResponseStatus) {
+    /**
+     * The scan completed successfully.
+     */
+    ScanDocumentResponseStatus["Success"] = "success";
+    /**
+     * The user cancelled the scan flow.
+     */
+    ScanDocumentResponseStatus["Cancel"] = "cancel";
+})(ScanDocumentResponseStatus || (ScanDocumentResponseStatus = {}));
+//# sourceMappingURL=definitions.js.map

package/dist/esm/definitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAkCA,MAAM,CAAN,IAAY,YAUX;AAVD,WAAY,YAAY;IACtB;;OAEG;IACH,iCAAiB,CAAA;IAEjB;;OAEG;IACH,+CAA+B,CAAA;AACjC,CAAC,EAVW,YAAY,KAAZ,YAAY,QAUvB;AAcD,MAAM,CAAN,IAAY,0BAUX;AAVD,WAAY,0BAA0B;IACpC;;OAEG;IACH,iDAAmB,CAAA;IAEnB;;OAEG;IACH,+CAAiB,CAAA;AACnB,CAAC,EAVW,0BAA0B,KAA1B,0BAA0B,QAUrC","sourcesContent":["export interface DocumentScannerPlugin {\n  /**\n   * Opens the device camera and starts the document scanning experience.\n   */\n  scanDocument(options?: ScanDocumentOptions): Promise<ScanDocumentResponse>;\n}\n\nexport interface ScanDocumentOptions {\n  /**\n   * Android only: quality of the cropped image from 0 - 100 (100 is best).\n   * @default 100\n   */\n  croppedImageQuality?: number;\n\n  /**\n   * Android only: allow the user to adjust the detected crop before saving.\n   * Disabling this forces single-document capture.\n   * @default true\n   */\n  letUserAdjustCrop?: boolean;\n\n  /**\n   * Android only: maximum number of documents the user can scan.\n   * @default 24\n   */\n  maxNumDocuments?: number;\n\n  /**\n   * Format to return scanned images in (file paths or base64 strings).\n   * @default ResponseType.ImageFilePath\n   */\n  responseType?: ResponseType;\n}\n\nexport enum ResponseType {\n  /**\n   * Return scanned images as base64-encoded strings.\n   */\n  Base64 = 'base64',\n\n  /**\n   * Return scanned images as file paths on disk.\n   */\n  ImageFilePath = 'imageFilePath',\n}\n\nexport interface ScanDocumentResponse {\n  /**\n   * Scanned images in the requested response format.\n   */\n  scannedImages?: string[];\n\n  /**\n   * Indicates whether the scan completed or was cancelled.\n   */\n  status?: ScanDocumentResponseStatus;\n}\n\nexport enum ScanDocumentResponseStatus {\n  /**\n   * The scan completed successfully.\n   */\n  Success = 'success',\n\n  /**\n   * The user cancelled the scan flow.\n   */\n  Cancel = 'cancel',\n}\n"]}

package/dist/esm/index.d.ts

@@ -0,0 +1,4 @@
+import type { DocumentScannerPlugin } from './definitions';
+declare const DocumentScanner: DocumentScannerPlugin;
+export * from './definitions';
+export { DocumentScanner };

package/dist/esm/index.js

@@ -0,0 +1,7 @@
+import { registerPlugin } from '@capacitor/core';
+const DocumentScanner = registerPlugin('DocumentScanner', {
+    web: () => import('./web').then((m) => new m.DocumentScannerWeb()),
+});
+export * from './definitions';
+export { DocumentScanner };
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,eAAe,GAAG,cAAc,CAAwB,iBAAiB,EAAE;IAC/E,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,kBAAkB,EAAE,CAAC;CACnE,CAAC,CAAC;AAEH,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,eAAe,EAAE,CAAC","sourcesContent":["import { registerPlugin } from '@capacitor/core';\n\nimport type { DocumentScannerPlugin } from './definitions';\n\nconst DocumentScanner = registerPlugin<DocumentScannerPlugin>('DocumentScanner', {\n  web: () => import('./web').then((m) => new m.DocumentScannerWeb()),\n});\n\nexport * from './definitions';\nexport { DocumentScanner };\n"]}

package/dist/esm/web.d.ts

@@ -0,0 +1,5 @@
+import { WebPlugin } from '@capacitor/core';
+import type { DocumentScannerPlugin, ScanDocumentOptions, ScanDocumentResponse } from './definitions';
+export declare class DocumentScannerWeb extends WebPlugin implements DocumentScannerPlugin {
+    scanDocument(_options?: ScanDocumentOptions): Promise<ScanDocumentResponse>;
+}

package/dist/esm/web.js

@@ -0,0 +1,7 @@
+import { WebPlugin } from '@capacitor/core';
+export class DocumentScannerWeb extends WebPlugin {
+    async scanDocument(_options) {
+        throw this.unimplemented('Document scanning is not supported on the web.');
+    }
+}
+//# sourceMappingURL=web.js.map

package/dist/esm/web.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web.js","sourceRoot":"","sources":["../../src/web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAI5C,MAAM,OAAO,kBAAmB,SAAQ,SAAS;IAC/C,KAAK,CAAC,YAAY,CAAC,QAA8B;QAC/C,MAAM,IAAI,CAAC,aAAa,CAAC,gDAAgD,CAAC,CAAC;IAC7E,CAAC;CACF","sourcesContent":["import { WebPlugin } from '@capacitor/core';\n\nimport type { DocumentScannerPlugin, ScanDocumentOptions, ScanDocumentResponse } from './definitions';\n\nexport class DocumentScannerWeb extends WebPlugin implements DocumentScannerPlugin {\n  async scanDocument(_options?: ScanDocumentOptions): Promise<ScanDocumentResponse> {\n    throw this.unimplemented('Document scanning is not supported on the web.');\n  }\n}\n"]}

package/dist/plugin.cjs.js

@@ -0,0 +1,44 @@
+'use strict';
+
+var core = require('@capacitor/core');
+
+exports.ResponseType = void 0;
+(function (ResponseType) {
+    /**
+     * Return scanned images as base64-encoded strings.
+     */
+    ResponseType["Base64"] = "base64";
+    /**
+     * Return scanned images as file paths on disk.
+     */
+    ResponseType["ImageFilePath"] = "imageFilePath";
+})(exports.ResponseType || (exports.ResponseType = {}));
+exports.ScanDocumentResponseStatus = void 0;
+(function (ScanDocumentResponseStatus) {
+    /**
+     * The scan completed successfully.
+     */
+    ScanDocumentResponseStatus["Success"] = "success";
+    /**
+     * The user cancelled the scan flow.
+     */
+    ScanDocumentResponseStatus["Cancel"] = "cancel";
+})(exports.ScanDocumentResponseStatus || (exports.ScanDocumentResponseStatus = {}));
+
+const DocumentScanner = core.registerPlugin('DocumentScanner', {
+    web: () => Promise.resolve().then(function () { return web; }).then((m) => new m.DocumentScannerWeb()),
+});
+
+class DocumentScannerWeb extends core.WebPlugin {
+    async scanDocument(_options) {
+        throw this.unimplemented('Document scanning is not supported on the web.');
+    }
+}
+
+var web = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    DocumentScannerWeb: DocumentScannerWeb
+});
+
+exports.DocumentScanner = DocumentScanner;
+//# sourceMappingURL=plugin.cjs.js.map

package/dist/plugin.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.cjs.js","sources":["esm/definitions.js","esm/index.js","esm/web.js"],"sourcesContent":["export var ResponseType;\n(function (ResponseType) {\n    /**\n     * Return scanned images as base64-encoded strings.\n     */\n    ResponseType[\"Base64\"] = \"base64\";\n    /**\n     * Return scanned images as file paths on disk.\n     */\n    ResponseType[\"ImageFilePath\"] = \"imageFilePath\";\n})(ResponseType || (ResponseType = {}));\nexport var ScanDocumentResponseStatus;\n(function (ScanDocumentResponseStatus) {\n    /**\n     * The scan completed successfully.\n     */\n    ScanDocumentResponseStatus[\"Success\"] = \"success\";\n    /**\n     * The user cancelled the scan flow.\n     */\n    ScanDocumentResponseStatus[\"Cancel\"] = \"cancel\";\n})(ScanDocumentResponseStatus || (ScanDocumentResponseStatus = {}));\n//# sourceMappingURL=definitions.js.map","import { registerPlugin } from '@capacitor/core';\nconst DocumentScanner = registerPlugin('DocumentScanner', {\n    web: () => import('./web').then((m) => new m.DocumentScannerWeb()),\n});\nexport * from './definitions';\nexport { DocumentScanner };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class DocumentScannerWeb extends WebPlugin {\n    async scanDocument(_options) {\n        throw this.unimplemented('Document scanning is not supported on the web.');\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["ResponseType","ScanDocumentResponseStatus","registerPlugin","WebPlugin"],"mappings":";;;;AAAWA;AACX,CAAC,UAAU,YAAY,EAAE;AACzB;AACA;AACA;AACA,IAAI,YAAY,CAAC,QAAQ,CAAC,GAAG,QAAQ;AACrC;AACA;AACA;AACA,IAAI,YAAY,CAAC,eAAe,CAAC,GAAG,eAAe;AACnD,CAAC,EAAEA,oBAAY,KAAKA,oBAAY,GAAG,EAAE,CAAC,CAAC;AAC5BC;AACX,CAAC,UAAU,0BAA0B,EAAE;AACvC;AACA;AACA;AACA,IAAI,0BAA0B,CAAC,SAAS,CAAC,GAAG,SAAS;AACrD;AACA;AACA;AACA,IAAI,0BAA0B,CAAC,QAAQ,CAAC,GAAG,QAAQ;AACnD,CAAC,EAAEA,kCAA0B,KAAKA,kCAA0B,GAAG,EAAE,CAAC,CAAC;;ACpB9D,MAAC,eAAe,GAAGC,mBAAc,CAAC,iBAAiB,EAAE;AAC1D,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,kBAAkB,EAAE,CAAC;AACtE,CAAC;;ACFM,MAAM,kBAAkB,SAASC,cAAS,CAAC;AAClD,IAAI,MAAM,YAAY,CAAC,QAAQ,EAAE;AACjC,QAAQ,MAAM,IAAI,CAAC,aAAa,CAAC,gDAAgD,CAAC;AAClF,IAAI;AACJ;;;;;;;;;"}

package/dist/plugin.js

@@ -0,0 +1,47 @@
+var capacitorDocumentScanner = (function (exports, core) {
+    'use strict';
+
+    exports.ResponseType = void 0;
+    (function (ResponseType) {
+        /**
+         * Return scanned images as base64-encoded strings.
+         */
+        ResponseType["Base64"] = "base64";
+        /**
+         * Return scanned images as file paths on disk.
+         */
+        ResponseType["ImageFilePath"] = "imageFilePath";
+    })(exports.ResponseType || (exports.ResponseType = {}));
+    exports.ScanDocumentResponseStatus = void 0;
+    (function (ScanDocumentResponseStatus) {
+        /**
+         * The scan completed successfully.
+         */
+        ScanDocumentResponseStatus["Success"] = "success";
+        /**
+         * The user cancelled the scan flow.
+         */
+        ScanDocumentResponseStatus["Cancel"] = "cancel";
+    })(exports.ScanDocumentResponseStatus || (exports.ScanDocumentResponseStatus = {}));
+
+    const DocumentScanner = core.registerPlugin('DocumentScanner', {
+        web: () => Promise.resolve().then(function () { return web; }).then((m) => new m.DocumentScannerWeb()),
+    });
+
+    class DocumentScannerWeb extends core.WebPlugin {
+        async scanDocument(_options) {
+            throw this.unimplemented('Document scanning is not supported on the web.');
+        }
+    }
+
+    var web = /*#__PURE__*/Object.freeze({
+        __proto__: null,
+        DocumentScannerWeb: DocumentScannerWeb
+    });
+
+    exports.DocumentScanner = DocumentScanner;
+
+    return exports;
+
+})({}, capacitorExports);
+//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sources":["esm/definitions.js","esm/index.js","esm/web.js"],"sourcesContent":["export var ResponseType;\n(function (ResponseType) {\n    /**\n     * Return scanned images as base64-encoded strings.\n     */\n    ResponseType[\"Base64\"] = \"base64\";\n    /**\n     * Return scanned images as file paths on disk.\n     */\n    ResponseType[\"ImageFilePath\"] = \"imageFilePath\";\n})(ResponseType || (ResponseType = {}));\nexport var ScanDocumentResponseStatus;\n(function (ScanDocumentResponseStatus) {\n    /**\n     * The scan completed successfully.\n     */\n    ScanDocumentResponseStatus[\"Success\"] = \"success\";\n    /**\n     * The user cancelled the scan flow.\n     */\n    ScanDocumentResponseStatus[\"Cancel\"] = \"cancel\";\n})(ScanDocumentResponseStatus || (ScanDocumentResponseStatus = {}));\n//# sourceMappingURL=definitions.js.map","import { registerPlugin } from '@capacitor/core';\nconst DocumentScanner = registerPlugin('DocumentScanner', {\n    web: () => import('./web').then((m) => new m.DocumentScannerWeb()),\n});\nexport * from './definitions';\nexport { DocumentScanner };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class DocumentScannerWeb extends WebPlugin {\n    async scanDocument(_options) {\n        throw this.unimplemented('Document scanning is not supported on the web.');\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["ResponseType","ScanDocumentResponseStatus","registerPlugin","WebPlugin"],"mappings":";;;AAAWA;IACX,CAAC,UAAU,YAAY,EAAE;IACzB;IACA;IACA;IACA,IAAI,YAAY,CAAC,QAAQ,CAAC,GAAG,QAAQ;IACrC;IACA;IACA;IACA,IAAI,YAAY,CAAC,eAAe,CAAC,GAAG,eAAe;IACnD,CAAC,EAAEA,oBAAY,KAAKA,oBAAY,GAAG,EAAE,CAAC,CAAC;AAC5BC;IACX,CAAC,UAAU,0BAA0B,EAAE;IACvC;IACA;IACA;IACA,IAAI,0BAA0B,CAAC,SAAS,CAAC,GAAG,SAAS;IACrD;IACA;IACA;IACA,IAAI,0BAA0B,CAAC,QAAQ,CAAC,GAAG,QAAQ;IACnD,CAAC,EAAEA,kCAA0B,KAAKA,kCAA0B,GAAG,EAAE,CAAC,CAAC;;ACpB9D,UAAC,eAAe,GAAGC,mBAAc,CAAC,iBAAiB,EAAE;IAC1D,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,kBAAkB,EAAE,CAAC;IACtE,CAAC;;ICFM,MAAM,kBAAkB,SAASC,cAAS,CAAC;IAClD,IAAI,MAAM,YAAY,CAAC,QAAQ,EAAE;IACjC,QAAQ,MAAM,IAAI,CAAC,aAAa,CAAC,gDAAgD,CAAC;IAClF,IAAI;IACJ;;;;;;;;;;;;;;;"}

package/ios/Sources/DocumentScannerPlugin/DocScanner.swift

@@ -0,0 +1,126 @@
+import UIKit
+import VisionKit
+
+/**
+ Handles presenting the VisionKit document scanner and returning results.
+ */
+@available(iOS 13.0, *)
+class DocScanner: NSObject, VNDocumentCameraViewControllerDelegate {
+    private weak var viewController: UIViewController?
+    private var successHandler: ([String]) -> Void
+    private var errorHandler: (String) -> Void
+    private var cancelHandler: () -> Void
+    private var responseType: String
+    private var croppedImageQuality: Int
+
+    init(
+        _ viewController: UIViewController? = nil,
+        successHandler: @escaping ([String]) -> Void = { _ in },
+        errorHandler: @escaping (String) -> Void = { _ in },
+        cancelHandler: @escaping () -> Void = {},
+        responseType: String = ResponseType.imageFilePath,
+        croppedImageQuality: Int = 100
+    ) {
+        self.viewController = viewController
+        self.successHandler = successHandler
+        self.errorHandler = errorHandler
+        self.cancelHandler = cancelHandler
+        self.responseType = responseType
+        self.croppedImageQuality = croppedImageQuality
+    }
+
+    override convenience init() {
+        self.init(nil)
+    }
+
+    func startScan() {
+        guard VNDocumentCameraViewController.isSupported else {
+            errorHandler("Document scanning is not supported on this device.")
+            return
+        }
+
+        DispatchQueue.main.async {
+            let documentCameraViewController = VNDocumentCameraViewController()
+            documentCameraViewController.delegate = self
+            self.viewController?.present(documentCameraViewController, animated: true)
+        }
+    }
+
+    func startScan(
+        _ viewController: UIViewController? = nil,
+        successHandler: @escaping ([String]) -> Void = { _ in },
+        errorHandler: @escaping (String) -> Void = { _ in },
+        cancelHandler: @escaping () -> Void = {},
+        responseType: String? = ResponseType.imageFilePath,
+        croppedImageQuality: Int? = 100
+    ) {
+        self.viewController = viewController
+        self.successHandler = successHandler
+        self.errorHandler = errorHandler
+        self.cancelHandler = cancelHandler
+        self.responseType = responseType ?? ResponseType.imageFilePath
+        self.croppedImageQuality = croppedImageQuality ?? 100
+
+        startScan()
+    }
+
+    func documentCameraViewController(
+        _ controller: VNDocumentCameraViewController,
+        didFinishWith scan: VNDocumentCameraScan
+    ) {
+        var results: [String] = []
+
+        for pageNumber in 0 ..< scan.pageCount {
+            guard
+                let scannedImageData = scan.imageOfPage(at: pageNumber)
+                    .jpegData(compressionQuality: CGFloat(croppedImageQuality) / CGFloat(100))
+            else {
+                goBackToPreviousView(controller)
+                errorHandler("Unable to get scanned document in jpeg format.")
+                return
+            }
+
+            switch responseType {
+            case ResponseType.base64:
+                results.append(scannedImageData.base64EncodedString())
+            case ResponseType.imageFilePath:
+                do {
+                    let imagePath = FileUtil().createImageFile(pageNumber)
+                    try scannedImageData.write(to: imagePath)
+                    results.append(imagePath.absoluteString)
+                } catch {
+                    goBackToPreviousView(controller)
+                    errorHandler("Unable to save scanned image: \(error.localizedDescription)")
+                    return
+                }
+            default:
+                errorHandler(
+                    "responseType must be \(ResponseType.base64) or \(ResponseType.imageFilePath)"
+                )
+                return
+            }
+        }
+
+        goBackToPreviousView(controller)
+        successHandler(results)
+    }
+
+    func documentCameraViewControllerDidCancel(_ controller: VNDocumentCameraViewController) {
+        goBackToPreviousView(controller)
+        cancelHandler()
+    }
+
+    func documentCameraViewController(
+        _ controller: VNDocumentCameraViewController,
+        didFailWithError error: Error
+    ) {
+        goBackToPreviousView(controller)
+        errorHandler(error.localizedDescription)
+    }
+
+    private func goBackToPreviousView(_ controller: VNDocumentCameraViewController) {
+        DispatchQueue.main.async {
+            controller.dismiss(animated: true)
+        }
+    }
+}

package/ios/Sources/DocumentScannerPlugin/DocumentScannerPlugin.swift

@@ -0,0 +1,51 @@
+import Capacitor
+import Foundation
+
+@available(iOS 13.0, *)
+@objc(DocumentScannerPlugin)
+public class DocumentScannerPlugin: CAPPlugin, CAPBridgedPlugin {
+    public let identifier = "DocumentScannerPlugin"
+    public let jsName = "DocumentScanner"
+    public let pluginMethods: [CAPPluginMethod] = [
+        CAPPluginMethod(name: "scanDocument", returnType: CAPPluginReturnPromise)
+    ]
+
+    private var documentScanner: DocScanner?
+
+    @objc func scanDocument(_ call: CAPPluginCall) {
+        guard let bridgeViewController = bridge?.viewController else {
+            call.reject("Bridge view controller unavailable.")
+            return
+        }
+
+        documentScanner = DocScanner(
+            bridgeViewController,
+            successHandler: { [weak self] scannedImages in
+                call.resolve([
+                    "status": "success",
+                    "scannedImages": scannedImages
+                ])
+                self?.documentScanner = nil
+            },
+            errorHandler: { [weak self] errorMessage in
+                call.reject(errorMessage)
+                self?.documentScanner = nil
+            },
+            cancelHandler: { [weak self] in
+                call.resolve([
+                    "status": "cancel"
+                ])
+                self?.documentScanner = nil
+            },
+            responseType: call.getString("responseType") ?? ResponseType.imageFilePath,
+            croppedImageQuality: clampQuality(call.getInt("croppedImageQuality"))
+        )
+
+        documentScanner?.startScan()
+    }
+
+    private func clampQuality(_ value: Int?) -> Int {
+        let quality = value ?? 100
+        return max(0, min(100, quality))
+    }
+}

package/ios/Sources/DocumentScannerPlugin/Errors.swift

@@ -0,0 +1,6 @@
+/**
+ Allows throwing runtime errors with a custom message.
+ */
+enum RuntimeError: Error {
+    case message(String)
+}

package/ios/Sources/DocumentScannerPlugin/FileUtil.swift

@@ -0,0 +1,42 @@
+import Foundation
+
+/**
+ Utilities for creating and managing scanned image files.
+ */
+class FileUtil {
+    func createImageFile(_ pageNumber: Int) -> URL {
+        let documentsDirectory = FileManager.default.urls(
+            for: .documentDirectory,
+            in: .userDomainMask
+        )[0]
+
+        return documentsDirectory.appendingPathComponent(
+            "DOCUMENT_SCAN_\(pageNumber)_\(currentTimestamp()).jpg"
+        )
+    }
+
+    func getBase64Image(imageFilePath: String) throws -> String {
+        let imageUrl = try imageURL(imageFilePath)
+        guard let imageData = try? Data(contentsOf: imageUrl) else {
+            throw RuntimeError.message("Unable to get image from file")
+        }
+        return imageData.base64EncodedString()
+    }
+
+    func deleteImage(imageFilePath: String) throws {
+        try FileManager.default.removeItem(at: imageURL(imageFilePath))
+    }
+
+    private func imageURL(_ imageFilePath: String) throws -> URL {
+        guard let imageUrl = URL(string: imageFilePath) else {
+            throw RuntimeError.message("Unable to get image from file")
+        }
+        return imageUrl
+    }
+
+    private func currentTimestamp() -> String {
+        let dateFormatter = DateFormatter()
+        dateFormatter.dateFormat = "yyyyMMdd_HHmmss"
+        return dateFormatter.string(from: Date())
+    }
+}

package/ios/Sources/DocumentScannerPlugin/ResponseType.swift

@@ -0,0 +1,7 @@
+/**
+ Enumerates the supported response types for scanned images.
+ */
+enum ResponseType {
+    static let base64 = "base64"
+    static let imageFilePath = "imageFilePath"
+}

package/ios/Tests/DocumentScannerPluginTests/DocumentScannerPluginTests.swift

@@ -0,0 +1,9 @@
+import XCTest
+@testable import DocumentScannerPlugin
+
+final class DocumentScannerTests: XCTestCase {
+    func testResponseTypeValues() {
+        XCTAssertEqual(ResponseType.base64, "base64")
+        XCTAssertEqual(ResponseType.imageFilePath, "imageFilePath")
+    }
+}

package/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "@capgo/capacitor-document-scanner",
+  "version": "7.0.0",
+  "description": "Capacitor plugin to scan document iOS and Android",
+  "main": "dist/plugin.cjs.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
+  "unpkg": "dist/plugin.js",
+  "files": [
+    "android/src/main/",
+    "android/build.gradle",
+    "dist/",
+    "ios/Sources",
+    "ios/Tests",
+    "Package.swift",
+    "CapgoCapacitorDocumentScanner.podspec"
+  ],
+  "author": "Martin Donadieu <martin@capgo.app>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Cap-go/capacitor-document-scanner.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Cap-go/capacitor-document-scanner/issues"
+  },
+  "keywords": [
+    "capacitor",
+    "plugin",
+    "native"
+  ],
+  "scripts": {
+    "verify": "npm run verify:ios && npm run verify:android && npm run verify:web",
+    "verify:ios": "xcodebuild -scheme CapgoCapacitorDocumentScanner -destination generic/platform=iOS",
+    "verify:android": "cd android && ./gradlew clean build test && cd ..",
+    "verify:web": "npm run build",
+    "lint": "npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint",
+    "fmt": "npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format",
+    "eslint": "eslint . --ext ts",
+    "prettier": "prettier \"**/*.{css,html,ts,js,java}\" --plugin=prettier-plugin-java",
+    "swiftlint": "node-swiftlint",
+    "docgen": "docgen --api DocumentScannerPlugin --output-readme README.md --output-json dist/docs.json",
+    "build": "npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs",
+    "clean": "rimraf ./dist",
+    "watch": "tsc --watch",
+    "prepublishOnly": "npm run build"
+  },
+  "devDependencies": {
+    "@capacitor/android": "^7.0.0",
+    "@capacitor/core": "^7.0.0",
+    "@capacitor/docgen": "^0.3.0",
+    "@capacitor/ios": "^7.0.0",
+    "@ionic/eslint-config": "^0.4.0",
+    "@ionic/prettier-config": "^4.0.0",
+    "@ionic/swiftlint-config": "^2.0.0",
+    "eslint": "^8.57.0",
+    "prettier": "^3.4.2",
+    "prettier-plugin-java": "^2.6.6",
+    "rimraf": "^6.0.1",
+    "rollup": "^4.30.1",
+    "swiftlint": "^2.0.0",
+    "typescript": "~4.1.5"
+  },
+  "peerDependencies": {
+    "@capacitor/core": ">=7.0.0"
+  },
+  "prettier": "@ionic/prettier-config",
+  "swiftlint": "@ionic/swiftlint-config",
+  "eslintConfig": {
+    "extends": "@ionic/eslint-config/recommended"
+  },
+  "capacitor": {
+    "ios": {
+      "src": "ios"
+    },
+    "android": {
+      "src": "android"
+    }
+  }
+}