feat(GiniCaptureSDK): Add help screen events

- events added: `screen_shown`, `close_tapped`, `helpItemTapped` PP-393
gini · Apr 17, 2024 · d9713f1 · d9713f1
1 parent 1c1b5d1
commit d9713f1
Show file tree

Hide file tree

Showing 7 changed files with 45 additions and 18 deletions.
diff --git a/...DK/Sources/GiniCaptureSDK/Core/Screens/Help/DataSources/HelpMenu/HelpMenuDataSource.swift b/...DK/Sources/GiniCaptureSDK/Core/Screens/Help/DataSources/HelpMenu/HelpMenuDataSource.swift
@@ -9,7 +9,7 @@
 import UIKit
 
 protocol HelpMenuDataSourceDelegate: UIViewController {
-    func didSelectHelpItem(didSelect item: HelpMenuItem)
+    func didSelectHelpItem(at index: Int)
 }
 
 final class HelpMenuDataSource: HelpRoundedCornersDataSource<HelpMenuItem, HelpMenuCell> {
@@ -26,14 +26,17 @@ final class HelpMenuDataSource: HelpRoundedCornersDataSource<HelpMenuItem, HelpM
         return defaultItems
     }()
 
+    var helpItemsAnalyticsValues = [String]()
     weak var delegate: HelpMenuDataSourceDelegate?
 
-    required init(
-        configuration: GiniConfiguration
-    ) {
+    required init(configuration: GiniConfiguration) {
         super.init()
         self.items.append(contentsOf: defaultItems)
         self.items.append(contentsOf: configuration.customMenuItems)
+
+        items.forEach { item in
+            helpItemsAnalyticsValues.append(item.title)
+        }
     }
 
     override func configureCell(cell: HelpMenuCell, indexPath: IndexPath) {
@@ -63,8 +66,7 @@ final class HelpMenuDataSource: HelpRoundedCornersDataSource<HelpMenuItem, HelpM
 
     // MARK: - UITableViewDelegate
     override func tableView(_ tableView: UITableView, didSelectRowAt indexPath: IndexPath) {
-        let item = items[indexPath.row]
-        self.delegate?.didSelectHelpItem(didSelect: item)
+        self.delegate?.didSelectHelpItem(at: indexPath.row)
     }
 
     override func tableView(_ tableView: UITableView, heightForHeaderInSection section: Int) -> CGFloat {

diff --git a/...SDK/Sources/GiniCaptureSDK/Core/Screens/Help/ViewControllers/HelpMenuViewController.swift b/...SDK/Sources/GiniCaptureSDK/Core/Screens/Help/ViewControllers/HelpMenuViewController.swift
@@ -58,6 +58,20 @@ final class HelpMenuViewController: UIViewController, HelpBottomBarEnabledViewCo
         setupView()
     }
 
+    override func viewDidAppear(_ animated: Bool) {
+        super.viewDidAppear(animated)
+
+        var eventProperties = [AnalyticsProperty(key: .hasCustomItems,
+                                                 value: giniConfiguration.customMenuItems.isNotEmpty)]
+
+        if dataSource.helpItemsAnalyticsValues.isNotEmpty {
+            eventProperties.append(AnalyticsProperty(key: .helpItems, 
+                                                     value: dataSource.helpItemsAnalyticsValues))
+        }
+        AnalyticsManager.trackScreenShown(screenName: .help,
+                                          properties: eventProperties)
+    }
+
     private func setupView() {
         configureMainView()
         configureTableView()
@@ -135,7 +149,12 @@ final class HelpMenuViewController: UIViewController, HelpBottomBarEnabledViewCo
 // MARK: - HelpMenuDataSourceDelegate
 
 extension HelpMenuViewController: HelpMenuDataSourceDelegate {
-    func didSelectHelpItem(didSelect item: HelpMenuItem) {
+    func didSelectHelpItem(at index: Int) {
+        let item = dataSource.items[index]
+        AnalyticsManager.track(event: .helpItemTapped,
+                               screenName: .help,
+                               properties: [AnalyticsProperty(key: .itemTapped,
+                                                             value: item.title)])
         delegate?.help(self, didSelect: item)
     }
 }
diff --git a/...iniCaptureSDK/Core/Screens/Screen API Coordinator/GiniScreenAPICoordinator+Analysis.swift b/...iniCaptureSDK/Core/Screens/Screen API Coordinator/GiniScreenAPICoordinator+Analysis.swift
@@ -140,8 +140,7 @@ extension GiniScreenAPICoordinator: AnalysisDelegate {
         let viewController = ErrorScreenViewController(giniConfiguration: giniConfiguration,
                                                        type: errorType,
                                                        documentType: pages.type ?? .pdf,
-                                                       viewModel: viewModel, 
-                                                       errorAnalytics: ErrorAnalytics(type: ""))
+                                                       viewModel: viewModel)
 
         screenAPINavigationController.pushViewController(viewController, animated: animated)
     }

diff --git a/...Sources/GiniCaptureSDK/Core/Screens/Screen API Coordinator/GiniScreenAPICoordinator.swift b/...Sources/GiniCaptureSDK/Core/Screens/Screen API Coordinator/GiniScreenAPICoordinator.swift
@@ -249,7 +249,7 @@ extension GiniScreenAPICoordinator {
         let backButtonTitle = NSLocalizedStringPreferredFormat("ginicapture.navigationbar.help.backToCamera",
                                                                comment: "Camera")
         let barButton = GiniBarButton(ofType: .back(title: backButtonTitle))
-        barButton.addAction(self, #selector(back))
+        barButton.addAction(self, #selector(backToCameraTapped))
         helpMenuViewController.navigationItem.leftBarButtonItem = barButton.barButton
 
         // In case of 1 menu item it's better to show the item immediately without any selection
@@ -264,6 +264,11 @@ extension GiniScreenAPICoordinator {
         }
     }
 
+    @objc func backToCameraTapped() {
+        AnalyticsManager.track(event: .closeTapped, screenName: .help)
+        back()
+    }
+
     @objc func showAnalysisScreen() {
         if screenAPINavigationController.topViewController is ReviewViewController {
             trackingDelegate?.onReviewScreenEvent(event: Event(type: .next))

diff --git a/CaptureSDK/GiniCaptureSDK/Sources/GiniCaptureSDK/Core/Tracking/AnalyticsEvent.swift b/CaptureSDK/GiniCaptureSDK/Sources/GiniCaptureSDK/Core/Tracking/AnalyticsEvent.swift
@@ -32,4 +32,7 @@ enum AnalyticsEvent: String {
     case enterManuallyTapped = "enter_manually_tapped"
     case retakeImagesTapped = "retake_images_tapped"
     case backToCameraTapped = "back_to_camera_tapped"
+
+    // MARK: - Help
+    case helpItemTapped = "help_item_tapped"
 }
diff --git a/CaptureSDK/GiniCaptureSDK/Sources/GiniCaptureSDK/Core/Tracking/AnalyticsProperties.swift b/CaptureSDK/GiniCaptureSDK/Sources/GiniCaptureSDK/Core/Tracking/AnalyticsProperties.swift
@@ -27,20 +27,14 @@ extension Int: AnalyticsPropertyValue {
     }
 }
 
-extension UInt: AnalyticsPropertyValue {
-    func analyticsPropertyValue() -> UInt {
-        return self
-    }
-}
-
 extension Bool: AnalyticsPropertyValue {
     func analyticsPropertyValue() -> Bool {
         return self
     }
 }
 
-extension Double: AnalyticsPropertyValue {
-    func analyticsPropertyValue() -> Double {
+extension Array: AnalyticsPropertyValue where Element == String {
+    func analyticsPropertyValue() -> [String] {
         return self
     }
 }
@@ -57,4 +51,8 @@ enum AnalyticsPropertyKey: String {
     case documentType = "document_type"
     case errorCode = "error_code"
     case errorType = "error_type"
+
+    case hasCustomItems = "has_custom_items"
+    case helpItems = "help_items"
+    case itemTapped = "item_tapped"
 }
diff --git a/CaptureSDK/GiniCaptureSDK/Sources/GiniCaptureSDK/Core/Tracking/AnalyticsScreen.swift b/CaptureSDK/GiniCaptureSDK/Sources/GiniCaptureSDK/Core/Tracking/AnalyticsScreen.swift
@@ -13,4 +13,5 @@ enum AnalyticsScreen: String {
     case analysis
     case noResults = "no_results"
     case error
+    case help
 }