Card scanner module - Business layer

Adyen.xcodeproj/project.pbxproj

@@ -494,6 +494,10 @@
 		B6EE0F422BBEBF7600B9810D /* APIClientMock.swift in Sources */ = {isa = PBXBuildFile; fileRef = E757F02525D2ED4C007C813D /* APIClientMock.swift */; };
 		B6EE0F442BBEC94F00B9810D /* AnalyticsProviderMock.swift in Sources */ = {isa = PBXBuildFile; fileRef = C9C0005B280468E100CE2EEC /* AnalyticsProviderMock.swift */; };
 		B6EE0F452BBECBEF00B9810D /* Adyen.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = E2C0E03322097917008616F6 /* Adyen.framework */; platformFilter = ios; };
+		C9037F102D563DCD003A5154 /* CardScannerViewModel.swift in Sources */ = {isa = PBXBuildFile; fileRef = C9037F0F2D563DCD003A5154 /* CardScannerViewModel.swift */; };
+		C9037F122D5A1976003A5154 /* CardScannerOverlayView.swift in Sources */ = {isa = PBXBuildFile; fileRef = C9037F112D5A1976003A5154 /* CardScannerOverlayView.swift */; };
+		C9037F142D5A19BD003A5154 /* ROIView.swift in Sources */ = {isa = PBXBuildFile; fileRef = C9037F132D5A19BD003A5154 /* ROIView.swift */; };
+		C9037F162D5A1AC0003A5154 /* CardScannerViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = C9037F152D5A1AC0003A5154 /* CardScannerViewController.swift */; };
 		C90D26A727565750001A488F /* FormViewController+ViewProtocol.swift in Sources */ = {isa = PBXBuildFile; fileRef = C90D26A627565750001A488F /* FormViewController+ViewProtocol.swift */; };
 		C9126051275A3A2800C03DC4 /* BACSItemsFactoryTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = C9126050275A3A2800C03DC4 /* BACSItemsFactoryTests.swift */; };
 		C92665362C49346200D3D852 /* SubmittableComponent.swift in Sources */ = {isa = PBXBuildFile; fileRef = C92665352C49346200D3D852 /* SubmittableComponent.swift */; };
@@ -1838,6 +1842,10 @@
 		B6C9DA782D0C3F62005D65C7 /* DualBrandView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DualBrandView.swift; sourceTree = "<group>"; };
 		B6C9DA7A2D102C91005D65C7 /* DualBrandViewTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DualBrandViewTests.swift; sourceTree = "<group>"; };
 		B6EE0F432BBEBFD000B9810D /* IntegrationTests.xctestplan */ = {isa = PBXFileReference; lastKnownFileType = text; path = IntegrationTests.xctestplan; sourceTree = "<group>"; };
+		C9037F0F2D563DCD003A5154 /* CardScannerViewModel.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CardScannerViewModel.swift; sourceTree = "<group>"; };
+		C9037F112D5A1976003A5154 /* CardScannerOverlayView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CardScannerOverlayView.swift; sourceTree = "<group>"; };
+		C9037F132D5A19BD003A5154 /* ROIView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ROIView.swift; sourceTree = "<group>"; };
+		C9037F152D5A1AC0003A5154 /* CardScannerViewController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CardScannerViewController.swift; sourceTree = "<group>"; };
 		C90D26A627565750001A488F /* FormViewController+ViewProtocol.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "FormViewController+ViewProtocol.swift"; sourceTree = "<group>"; };
 		C90D26B1275900B9001A488F /* BACSInputFormViewProtocolMock.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BACSInputFormViewProtocolMock.swift; sourceTree = "<group>"; };
 		C90D26B32759048C001A488F /* BACSInputPresenterProtocolMock.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BACSInputPresenterProtocolMock.swift; sourceTree = "<group>"; };
@@ -3570,9 +3578,13 @@
 		C99FF2B62D50E872007179C5 /* Sources */ = {
 			isa = PBXGroup;
 			children = (
+				C99FF2B52D50E872007179C5 /* CardImageParser.swift */,
+				C9037F112D5A1976003A5154 /* CardScannerOverlayView.swift */,
+				C9037F152D5A1AC0003A5154 /* CardScannerViewController.swift */,
+				C9037F0F2D563DCD003A5154 /* CardScannerViewModel.swift */,
 				C9EEEFEB2D5516B300B7AFFC /* Formatters */,
 				C99FF2B42D50E872007179C5 /* Models */,
-				C99FF2B52D50E872007179C5 /* CardImageParser.swift */,
+				C9037F132D5A19BD003A5154 /* ROIView.swift */,
 			);
 			path = Sources;
 			sourceTree = "<group>";
@@ -6932,7 +6944,11 @@
 			files = (
 				C99FF2BB2D50E872007179C5 /* CardScannerError.swift in Sources */,
 				C99FF2BC2D50E872007179C5 /* CreditCard.swift in Sources */,
+				C9037F142D5A19BD003A5154 /* ROIView.swift in Sources */,
+				C9037F102D563DCD003A5154 /* CardScannerViewModel.swift in Sources */,
 				C9EEEFEC2D5516B300B7AFFC /* ExpirationDateFormatter.swift in Sources */,
+				C9037F162D5A1AC0003A5154 /* CardScannerViewController.swift in Sources */,
+				C9037F122D5A1976003A5154 /* CardScannerOverlayView.swift in Sources */,
 				C99FF2BD2D50E872007179C5 /* CardImageParser.swift in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;

AdyenCardScanner/Sources/CardScannerOverlayView.swift

@@ -0,0 +1,108 @@
+//
+// Copyright (c) 2025 Adyen N.V.
+//
+// This file is open source and available under the MIT license. See the LICENSE file for more info.
+//
+
+import UIKit
+
+class CardScannerOverlayView: UIView {
+
+    enum Style {
+        static let backgroundColor = UIColor.black.withAlphaComponent(0.4)
+    }
+
+    enum Constants {
+        static let roiAspectRatio: CGFloat = 1.585 // Credit card aspect ratio
+    }
+
+    // MARK: - UI elements
+
+    private let topMask = UIView()
+    private let bottomMask = UIView()
+    private let leftMask = UIView()
+
+    private let rightMask = UIView()
+    private let roiView: ROIView = {
+        let view = ROIView()
+        view.translatesAutoresizingMaskIntoConstraints = false
+        view.backgroundColor = Style.backgroundColor
+        return view
+    }()
+
+    // MARK: - Properties
+
+    @Published private(set) var roiFrame: CGRect = .zero
+
+    // MARK: - Initializers
+
+    override init(frame: CGRect) {
+        super.init(frame: frame)
+        setupMaskViews()
+        setupMasksLayout()
+    }
+
+    required init?(coder: NSCoder) {
+        fatalError("init(coder:) has not been implemented")
+    }
+
+    override func layoutSubviews() {
+        super.layoutSubviews()
+        updateRoiLayout()
+        self.roiFrame = roiView.frame
+    }
+
+    // MARK: - Private
+
+    private func setupMaskViews() {
+        let maskViews = [topMask, bottomMask, leftMask, rightMask]
+        maskViews.forEach {
+            $0.backgroundColor = Style.backgroundColor
+            $0.translatesAutoresizingMaskIntoConstraints = false
+            addSubview($0)
+        }
+
+        addSubview(roiView)
+    }
+
+    private func setupMasksLayout() {
+        NSLayoutConstraint.activate([
+            topMask.topAnchor.constraint(equalTo: topAnchor),
+            topMask.leadingAnchor.constraint(equalTo: leadingAnchor),
+            topMask.trailingAnchor.constraint(equalTo: trailingAnchor),
+            topMask.bottomAnchor.constraint(equalTo: roiView.topAnchor),
+
+            bottomMask.topAnchor.constraint(equalTo: roiView.bottomAnchor),
+            bottomMask.leadingAnchor.constraint(equalTo: leadingAnchor),
+            bottomMask.trailingAnchor.constraint(equalTo: trailingAnchor),
+            bottomMask.bottomAnchor.constraint(equalTo: bottomAnchor),
+
+            leftMask.topAnchor.constraint(equalTo: topMask.bottomAnchor),
+            leftMask.leadingAnchor.constraint(equalTo: leadingAnchor),
+            leftMask.trailingAnchor.constraint(equalTo: roiView.leadingAnchor),
+            leftMask.bottomAnchor.constraint(equalTo: bottomMask.topAnchor),
+
+            rightMask.topAnchor.constraint(equalTo: topMask.bottomAnchor),
+            rightMask.leadingAnchor.constraint(equalTo: roiView.trailingAnchor),
+            rightMask.trailingAnchor.constraint(equalTo: trailingAnchor),
+            rightMask.bottomAnchor.constraint(equalTo: bottomMask.topAnchor),
+        ])
+    }
+
+    private func updateRoiLayout() {
+        // Deactivate old constraints
+        NSLayoutConstraint.deactivate(roiView.constraints)
+
+        let padding: CGFloat = 12
+
+        let roiWidth = min(bounds.width, bounds.height) - (padding * 2)
+        let roiHeightMultiplier = 1.0 / Constants.roiAspectRatio
+
+        NSLayoutConstraint.activate([
+            roiView.centerXAnchor.constraint(equalTo: centerXAnchor),
+            roiView.centerYAnchor.constraint(equalTo: centerYAnchor),
+            roiView.widthAnchor.constraint(equalToConstant: roiWidth),
+            roiView.heightAnchor.constraint(equalTo: roiView.widthAnchor, multiplier: roiHeightMultiplier)
+        ])
+    }
+}

AdyenCardScanner/Sources/CardScannerViewController.swift

@@ -0,0 +1,96 @@
+//
+// Copyright (c) 2025 Adyen N.V.
+//
+// This file is open source and available under the MIT license. See the LICENSE file for more info.
+//
+
+import UIKit
+import Combine
+import AVFoundation
+
+class CardScannerViewController: UIViewController {
+
+    // MARK: - UI elements
+
+    private let previewLayer: AVCaptureVideoPreviewLayer
+
+    private let overlayView: CardScannerOverlayView = {
+        let view = CardScannerOverlayView(frame: .zero)
+        view.translatesAutoresizingMaskIntoConstraints = false
+        view.isUserInteractionEnabled = false
+        return view
+    }()
+
+    // MARK: - Properties
+
+    private let viewModel: CardScannerViewModelProtocol
+    private var cancellables: Set<AnyCancellable> = []
+
+    // MARK: - Initializers
+
+    init(viewModel: CardScannerViewModelProtocol) {
+        self.viewModel = viewModel
+        self.previewLayer = viewModel.videoPreviewLayer
+        super.init(nibName: nil, bundle: nil)
+    }
+
+    required init?(coder: NSCoder) {
+        fatalError("init(coder:) has not been implemented")
+    }
+
+    // MARK: - View lifecycle
+
+    override func viewDidLoad() {
+        super.viewDidLoad()
+        setupPreviewLayer()
+        addOverlayView()
+        observeRoiLayoutChanges()
+
+        viewModel.configureSession()
+    }
+
+    override func viewWillAppear(_ animated: Bool) {
+        super.viewWillAppear(animated)
+        viewModel.startSession()
+    }
+
+    override func viewWillDisappear(_ animated: Bool) {
+        super.viewWillDisappear(animated)
+        viewModel.stopSession()
+    }
+
+    override func viewDidLayoutSubviews() {
+        super.viewDidLayoutSubviews()
+        previewLayer.frame = view.bounds
+        viewModel.updateVideoOrientation()
+    }
+
+    // MARK: - Private
+
+    private func setupPreviewLayer() {
+        previewLayer.videoGravity = .resizeAspectFill
+        view.layer.addSublayer(previewLayer)
+        view.layer.insertSublayer(previewLayer, at: 0)
+    }
+
+    private func addOverlayView() {
+        view.addSubview(overlayView)
+
+        NSLayoutConstraint.activate([
+            overlayView.topAnchor.constraint(equalTo: view.topAnchor),
+            overlayView.leadingAnchor.constraint(equalTo: view.leadingAnchor),
+            overlayView.trailingAnchor.constraint(equalTo: view.trailingAnchor),
+            overlayView.bottomAnchor.constraint(equalTo: view.bottomAnchor)
+        ])
+    }
+
+    private func observeRoiLayoutChanges() {
+        overlayView.$roiFrame.sink { newRoiFrame in
+            self.viewModel.update(
+                previewLayerFrame: self.previewLayer.frame,
+                roiInPreviewLayer: newRoiFrame
+            )
+        }.store(in: &cancellables)
+    }
+}
+