# andrewdongminyoo/flutter_receipt_scanner architecture

> Architecture diagram of the GitHub repository andrewdongminyoo/flutter_receipt_scanner, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-09-30). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/andrewdongminyoo/flutter_receipt_scanner
- Repository: https://github.com/andrewdongminyoo/flutter_receipt_scanner

## Overview

This federated Flutter plugin acquires receipt images and returns normalized JPEGs, metadata, and on-device OCR; it does not parse receipt fields or upload results. The main workflow is an app calling scan, which routes through the platform contract to native camera or gallery capture, image processing, and OCR, then applies a Dart OCR-quality gate. Optional camera-page OCR merging and OCR capability queries are separate product features. iOS source excerpts show its orchestration and gallery processing; Android internals and several Dart modules were not sampled, so those relationships rely on README documentation.

Main entry points: [`flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/GalleryPickerDelegate.swift`](https://github.com/andrewdongminyoo/flutter_receipt_scanner/blob/main/flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/GalleryPickerDelegate.swift) (Gallery Capture), [`flutter_receipt_scanner/lib/src/receipt_scanner.dart`](https://github.com/andrewdongminyoo/flutter_receipt_scanner/blob/main/flutter_receipt_scanner/lib/src/receipt_scanner.dart) (Scan API), [`flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/ReceiptScannerApiImpl.swift`](https://github.com/andrewdongminyoo/flutter_receipt_scanner/blob/main/flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/ReceiptScannerApiImpl.swift) (iOS Scan Orchestrator), [`flutter_receipt_scanner_platform_interface/lib/src/flutter_receipt_scanner_platform.dart`](https://github.com/andrewdongminyoo/flutter_receipt_scanner/blob/main/flutter_receipt_scanner_platform_interface/lib/src/flutter_receipt_scanner_platform.dart) (Platform Interface)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_dart["Dart API"]
  node_scanner["Scan API"]
  node_ocr_floor["OCR Floor Gate<br/>[ocr_floor.dart]"]
  node_page_merger["Page OCR Merger"]
end

subgraph group_contract["Platform Contract"]
  node_models["Scan Models"]
  node_platform_api["Platform Interface"]
  node_wire_contract["Pigeon Contract<br/>[messages.g.dart]"]
end

subgraph group_ios["iOS Runtime"]
  node_ios_api["iOS Scan Orchestrator"]
  node_ios_camera["Camera Capture"]
  node_ios_gallery["Gallery Capture"]
  node_ios_quad["Quad Detection<br/>[QuadDetector.swift]"]
  node_ios_crop["Crop Editor"]
  node_ios_image["Image Processing"]
  node_ios_ocr["Vision OCR<br/>[OcrProcessor.swift]"]
  node_ios_geometry["OCR Geometry<br/>[OcrGeometry.swift]"]
  node_ios_origin["Origin Classification"]
  node_ios_plugin["iOS Registration"]
end

subgraph group_android["Android Runtime"]
  node_android_runtime["Android Runtime"]
end

node_app(("Consuming App"))
node_ios_services{{"iOS Scan Services"}}
node_android_services{{"Android Scan Services"}}
node_scan_result["Scan Result"]

node_app -->|"calls"| node_scanner
node_scanner -->|"routes through"| node_platform_api
node_platform_api -->|"uses contract"| node_wire_contract
node_platform_api -->|"exposes models"| node_models
node_wire_contract -->|"dispatches scan"| node_ios_api
node_ios_plugin -->|"registers handler"| node_ios_api
node_ios_api -->|"starts camera"| node_ios_camera
node_ios_api -->|"starts gallery"| node_ios_gallery
node_ios_camera -->|"processes pages"| node_ios_image
node_ios_gallery -->|"detects corners"| node_ios_quad
node_ios_gallery -->|"presents editor"| node_ios_crop
node_ios_gallery -->|"runs OCR"| node_ios_ocr
node_ios_gallery -->|"encodes images"| node_ios_image
node_ios_gallery -->|"classifies origin"| node_ios_origin
node_ios_ocr -->|"uses geometry"| node_ios_geometry
node_ios_ocr -->|"rotates pixels"| node_ios_image
node_ios_services -->|"provides capture"| node_ios_camera
node_ios_services -->|"provides picker"| node_ios_gallery
node_android_services -->|"provides capture"| node_android_runtime
node_platform_api -->|"routes Android"| node_android_runtime
node_ios_api -->|"returns result"| node_scan_result
node_android_runtime -->|"returns result"| node_scan_result
node_scanner -->|"checks OCR floor"| node_ocr_floor
node_scanner -->|"optionally merges"| node_page_merger
node_scanner -->|"returns result"| node_scan_result

click node_scanner "https://github.com/andrewdongminyoo/flutter_receipt_scanner/blob/main/flutter_receipt_scanner/lib/src/receipt_scanner.dart"
click node_ocr_floor "https://github.com/andrewdongminyoo/flutter_receipt_scanner/blob/main/flutter_receipt_scanner/lib/src/ocr_floor.dart"
click node_page_merger "https://github.com/andrewdongminyoo/flutter_receipt_scanner/blob/main/flutter_receipt_scanner/lib/src/ocr_page_merger.dart"
click node_models "https://github.com/andrewdongminyoo/flutter_receipt_scanner/tree/main/flutter_receipt_scanner_platform_interface/lib/src/models"
click node_platform_api "https://github.com/andrewdongminyoo/flutter_receipt_scanner/blob/main/flutter_receipt_scanner_platform_interface/lib/src/flutter_receipt_scanner_platform.dart"
click node_wire_contract "https://github.com/andrewdongminyoo/flutter_receipt_scanner/blob/main/flutter_receipt_scanner_platform_interface/lib/src/messages.g.dart"
click node_ios_api "https://github.com/andrewdongminyoo/flutter_receipt_scanner/blob/main/flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/ReceiptScannerApiImpl.swift"
click node_ios_camera "https://github.com/andrewdongminyoo/flutter_receipt_scanner/blob/main/flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/ReceiptScannerApiImpl.swift"
click node_ios_gallery "https://github.com/andrewdongminyoo/flutter_receipt_scanner/blob/main/flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/GalleryPickerDelegate.swift"
click node_ios_quad "https://github.com/andrewdongminyoo/flutter_receipt_scanner/blob/main/flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/QuadDetector.swift"
click node_ios_crop "https://github.com/andrewdongminyoo/flutter_receipt_scanner/blob/main/flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/CropEditorViewController.swift"
click node_ios_image "https://github.com/andrewdongminyoo/flutter_receipt_scanner/blob/main/flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/ImageProcessor.swift"
click node_ios_ocr "https://github.com/andrewdongminyoo/flutter_receipt_scanner/blob/main/flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/OcrProcessor.swift"
click node_ios_geometry "https://github.com/andrewdongminyoo/flutter_receipt_scanner/blob/main/flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/OcrGeometry.swift"
click node_ios_origin "https://github.com/andrewdongminyoo/flutter_receipt_scanner/blob/main/flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/OriginClassifier.swift"
click node_ios_plugin "https://github.com/andrewdongminyoo/flutter_receipt_scanner/blob/main/flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/FlutterReceiptScannerPlugin.swift"
click node_android_runtime "https://github.com/andrewdongminyoo/flutter_receipt_scanner/tree/main/flutter_receipt_scanner_android/android/src/main/kotlin/com/example/flutter_receipt_scanner_android"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_scanner,node_ocr_floor,node_page_merger toneBlue
class node_models,node_platform_api,node_wire_contract toneAmber
class node_ios_api,node_ios_camera,node_ios_gallery,node_ios_quad,node_ios_crop,node_ios_image,node_ios_ocr,node_ios_geometry,node_ios_origin,node_ios_plugin toneMint
class node_android_runtime toneRose
class node_app,node_ios_services,node_android_services,node_scan_result toneIndigo
```

## Components

### Dart API

- [Scan API](https://github.com/andrewdongminyoo/flutter_receipt_scanner/blob/main/flutter_receipt_scanner/lib/src/receipt_scanner.dart): `flutter_receipt_scanner/lib/src/receipt_scanner.dart`
- [OCR Floor Gate](https://github.com/andrewdongminyoo/flutter_receipt_scanner/blob/main/flutter_receipt_scanner/lib/src/ocr_floor.dart): `flutter_receipt_scanner/lib/src/ocr_floor.dart`
- [Page OCR Merger](https://github.com/andrewdongminyoo/flutter_receipt_scanner/blob/main/flutter_receipt_scanner/lib/src/ocr_page_merger.dart): `flutter_receipt_scanner/lib/src/ocr_page_merger.dart`

### Platform Contract

- [Scan Models](https://github.com/andrewdongminyoo/flutter_receipt_scanner/tree/main/flutter_receipt_scanner_platform_interface/lib/src/models): `flutter_receipt_scanner_platform_interface/lib/src/models`
- [Platform Interface](https://github.com/andrewdongminyoo/flutter_receipt_scanner/blob/main/flutter_receipt_scanner_platform_interface/lib/src/flutter_receipt_scanner_platform.dart): `flutter_receipt_scanner_platform_interface/lib/src/flutter_receipt_scanner_platform.dart`
- [Pigeon Contract](https://github.com/andrewdongminyoo/flutter_receipt_scanner/blob/main/flutter_receipt_scanner_platform_interface/lib/src/messages.g.dart): `flutter_receipt_scanner_platform_interface/lib/src/messages.g.dart`

### iOS Runtime

- [iOS Scan Orchestrator](https://github.com/andrewdongminyoo/flutter_receipt_scanner/blob/main/flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/ReceiptScannerApiImpl.swift): `flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/ReceiptScannerApiImpl.swift`
- [Camera Capture](https://github.com/andrewdongminyoo/flutter_receipt_scanner/blob/main/flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/ReceiptScannerApiImpl.swift): `flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/ReceiptScannerApiImpl.swift`
- [Gallery Capture](https://github.com/andrewdongminyoo/flutter_receipt_scanner/blob/main/flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/GalleryPickerDelegate.swift): `flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/GalleryPickerDelegate.swift`
- [Quad Detection](https://github.com/andrewdongminyoo/flutter_receipt_scanner/blob/main/flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/QuadDetector.swift): `flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/QuadDetector.swift`
- [Crop Editor](https://github.com/andrewdongminyoo/flutter_receipt_scanner/blob/main/flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/CropEditorViewController.swift): `flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/CropEditorViewController.swift`
- [Image Processing](https://github.com/andrewdongminyoo/flutter_receipt_scanner/blob/main/flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/ImageProcessor.swift): `flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/ImageProcessor.swift`
- [Vision OCR](https://github.com/andrewdongminyoo/flutter_receipt_scanner/blob/main/flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/OcrProcessor.swift): `flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/OcrProcessor.swift`
- [OCR Geometry](https://github.com/andrewdongminyoo/flutter_receipt_scanner/blob/main/flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/OcrGeometry.swift): `flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/OcrGeometry.swift`
- [Origin Classification](https://github.com/andrewdongminyoo/flutter_receipt_scanner/blob/main/flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/OriginClassifier.swift): `flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/OriginClassifier.swift`
- [iOS Registration](https://github.com/andrewdongminyoo/flutter_receipt_scanner/blob/main/flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/FlutterReceiptScannerPlugin.swift): `flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/FlutterReceiptScannerPlugin.swift`

### Android Runtime

- [Android Runtime](https://github.com/andrewdongminyoo/flutter_receipt_scanner/tree/main/flutter_receipt_scanner_android/android/src/main/kotlin/com/example/flutter_receipt_scanner_android): `flutter_receipt_scanner_android/android/src/main/kotlin/com/example/flutter_receipt_scanner_android`

### Other components

- **Consuming App**
- **iOS Scan Services**
- **Android Scan Services**
- **Scan Result**

## Connections

- Consuming App → Scan API: calls (evidence: `README.md`)
- Scan API → Platform Interface: routes through (evidence: `README.md`)
- Platform Interface → Pigeon Contract: uses contract (evidence: `README.md`)
- Platform Interface → Scan Models: exposes models (evidence: `README.md`)
- Pigeon Contract → iOS Scan Orchestrator: dispatches scan
- iOS Registration → iOS Scan Orchestrator: registers handler (evidence: `flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/FlutterReceiptScannerPlugin.swift`)
- iOS Scan Orchestrator → Camera Capture: starts camera (evidence: `flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/ReceiptScannerApiImpl.swift`)
- iOS Scan Orchestrator → Gallery Capture: starts gallery (evidence: `flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/ReceiptScannerApiImpl.swift`)
- Camera Capture → Image Processing: processes pages (evidence: `flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/ReceiptScannerApiImpl.swift`)
- Gallery Capture → Quad Detection: detects corners (evidence: `flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/GalleryPickerDelegate.swift`)
- Gallery Capture → Crop Editor: presents editor (evidence: `flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/GalleryPickerDelegate.swift`)
- Gallery Capture → Vision OCR: runs OCR (evidence: `flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/GalleryPickerDelegate.swift`)
- Gallery Capture → Image Processing: encodes images (evidence: `flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/GalleryPickerDelegate.swift`)
- Gallery Capture → Origin Classification: classifies origin (evidence: `flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/GalleryPickerDelegate.swift`)
- Vision OCR → OCR Geometry: uses geometry (evidence: `flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/OcrProcessor.swift`)
- Vision OCR → Image Processing: rotates pixels (evidence: `flutter_receipt_scanner_ios/ios/flutter_receipt_scanner_ios/Sources/flutter_receipt_scanner_ios/OcrProcessor.swift`)
- iOS Scan Services → Camera Capture: provides capture (evidence: `README.md`)
- iOS Scan Services → Gallery Capture: provides picker (evidence: `README.md`)
- Android Scan Services → Android Runtime: provides capture (evidence: `README.md`)
- Platform Interface → Android Runtime: routes Android (evidence: `README.md`)
- iOS Scan Orchestrator → Scan Result: returns result (evidence: `README.md`)
- Android Runtime → Scan Result: returns result (evidence: `README.md`)
- Scan API → OCR Floor Gate: checks OCR floor (evidence: `README.md`)
- Scan API → Page OCR Merger: optionally merges (evidence: `README.md`)
- Scan API → Scan Result: returns result (evidence: `README.md`)
