feat: declare event logger manager and public APIs (SDKCF-6845)

* feat: declare EventLogger public APIs & manager class (SDKCF-6845)
* improve: introduce separate methods to send event critical & warning events (SDKCF-6845)

CHANGELOG.md

@@ -1,5 +1,10 @@
 # **Changelog**
 
+## Unreleased
+- Features:
+    - Retrieve Meta-data for Event Logger (SDKCF-6846)
+    - Event Logger Public API & Manager Class (SDKCF-6845)
+
 #### 4.1.0 (2024-04-08)
 - Improve:
     - Add Privacy Manifest File (SDKCF-6906)

Sources/REventLogger/REvent.swift

@@ -0,0 +1,43 @@
+import Foundation
+
+struct REvent: Codable {
+    let eventType: EventType
+    let appId: String?
+    let appName: String?
+    let appVersion: String?
+    let osVersion: String
+    let deviceModel: String
+    let deviceBrand: String
+    let deviceName: String
+    let sourceName: String
+    let sourceVersion: String
+    let errorCode: String
+    let errorMessage: String
+    let eventVersion: String = "1.0"
+    let platform: String = "iOS"
+    var occurrenceCount: Int = 0
+    var firstOccurrenceOn: Double // unix time
+    var info: [String: String]?
+
+    init(_ type: EventType,
+         sourceName: String,
+         sourceVersion: String,
+         errorCode: String,
+         errorMessage: String,
+         info: [String: String]? = nil) {
+        appId = BundleInfo.appId
+        appName = BundleInfo.appName
+        appVersion = BundleInfo.appVersion
+        osVersion = DeviceInfo.osVersion
+        deviceModel = DeviceInfo.deviceModel
+        deviceBrand = DeviceInfo.deviceBrand
+        deviceName = DeviceInfo.deviceName
+        firstOccurrenceOn = Date().timeIntervalSince1970
+        eventType = type
+        self.sourceName = sourceName
+        self.sourceVersion = sourceVersion
+        self.errorCode = errorCode
+        self.errorMessage = errorMessage
+        self.info = info
+    }
+}

Sources/REventLogger/REventLogger.swift

@@ -0,0 +1,64 @@
+import Foundation
+
+/// Describe the type of the event
+public enum EventType: Int, Codable {
+    case critical, warning
+}
+
+struct EventLoggerConfiguration {
+    let apiKey: String
+    let apiUrl: String
+}
+
+/// Event Logger that sends the custom events to the Event Logger Service
+public final class REventLogger {
+    /// Singleton shared instance of REventLogger
+    public static let shared = REventLogger()
+    static var configuration: EventLoggerConfiguration?
+
+    private init() { }
+
+    /// Function to configure the Event Logger
+    /// - Parameters:
+    ///   - apiKey: your API Key
+    ///   - apiUrl: a API Endpoint
+    public static func configure(apiKey: String, apiUrl: String) {
+        guard configuration != nil else {
+            return
+        }
+        configuration = EventLoggerConfiguration(apiKey: apiKey, apiUrl: apiUrl)
+    }
+
+    /// Logs the critical event
+    /// This event will be considered as high priority and will be sent immediately
+    /// - Parameters:
+    ///   - sourceName: Source name of the event e.g App name or SDK name
+    ///   - sourceVersion: Version of the source e.g v1.0.0
+    ///   - errorCode: Error code of the event, like custom error code or HTTP response error code
+    ///   - errorMessage: Description of the error message.
+    ///   - info: Any custom information. It's optional.
+    public static func sendCriticalEvent(sourceName: String,
+                                         sourceVersion: String,
+                                         errorCode: String,
+                                         errorMessage: String,
+                                         info: [String: String]? = nil) {
+        // Send the event to server
+        // Save it in the local DB, as warning
+    }
+
+    /// Logs the warning event
+    /// This event will be considered as low priority and will be sent with batch update.
+    /// - Parameters:
+    ///   - sourceName: Source name of the event e.g App name or SDK name
+    ///   - sourceVersion: Version of the source e.g v1.0.0
+    ///   - errorCode: Error code of the event, like custom error code or HTTP response error code
+    ///   - errorMessage: Description of the error message.
+    ///   - info: Any custom information. It's optional.
+    public static func sendWarningEvent(sourceName: String,
+                                        sourceVersion: String,
+                                        errorCode: String,
+                                        errorMessage: String,
+                                        info: [String: String]? = nil) {
+        // Save it in the local DB
+    }
+}

Sources/REventLogger/Utilities/DeviceInfo.swift

@@ -3,23 +3,23 @@ import UIKit
 struct DeviceInfo {
     static var deviceBundle: Deviceable = UIDevice.current
 
-    static var platform: String? {
+    static var platform: String {
         deviceBundle.platform
     }
 
-    static var osVersion: String? {
+    static var osVersion: String {
         deviceBundle.osVersion
     }
 
-    static var deviceModel: String? {
+    static var deviceModel: String {
         deviceBundle.deviceModel
     }
 
-    static var deviceBrand: String? {
+    static var deviceBrand: String {
         deviceBundle.deviceBrand
     }
 
-    static var deviceName: String? {
+    static var deviceName: String {
         deviceBundle.deviceName
     }
 }