[feat]: add new added events

zaikorea · Dec 19, 2024 · feee1ce · feee1ce
1 parent 3852cf1
commit feee1ce
Show file tree

Hide file tree

Showing 15 changed files with 345 additions and 68 deletions.
diff --git a/BluxClient/Classes/BluxClient.swift b/BluxClient/Classes/BluxClient.swift
@@ -287,15 +287,14 @@ struct PropertiesWrapper<T: Codable>: Codable {
         }
     }
 
-    public static func sendRequestData(_ data: [Event]) {
-        EventService.sendRequest(data)
-        InappService.handleInappEvent(data)
+    public static func sendRequestData(_ events: [Event]) {
+        EventService.sendRequest(events)
+        InappService.handleInappEvent(events)
     }
 
     /// Send Request
-    public static func sendRequest(_ request: EventRequest) {
-        let requestData = request.getPayload()
-        sendRequestData(requestData)
+    public static func sendRequest(_ eventRequest: EventRequest) {
+        sendRequestData(eventRequest.getPayload())
     }
 
     /// Set the handler when notification is clicked

diff --git a/BluxClient/Classes/WebViewController.swift b/BluxClient/Classes/WebViewController.swift
@@ -5,7 +5,7 @@
 //  Created by Tommy on 6/4/24.
 //
 import UIKit
-import WebKit
+@preconcurrency import WebKit
 
 @available(iOSApplicationExtension, unavailable)
 final class WebViewController: UIViewController, WKNavigationDelegate,

diff --git a/BluxClient/Classes/request/events/AddCartaddEvent.swift b/BluxClient/Classes/request/events/AddCartaddEvent.swift
@@ -5,17 +5,18 @@ public class AddCartaddEvent: EventRequest {
 
     init(builder: Builder) throws {
         super.init()
-        self.events.append(
-            try Event(eventType: builder.eventType)
+        try self.events.append(
+            Event(eventType: builder.eventType)
                 .setItemId(builder.itemId)
                 .setCustomEventProperties(builder.customEventProperties)
         )
     }
 
     public class Builder {
-        var itemId: String
-        var eventType: String = AddCartaddEvent.DEFAULT_EVENT_TYPE
-        var customEventProperties: [String: String]? = nil
+        fileprivate let eventType: String = AddCartaddEvent.DEFAULT_EVENT_TYPE
+
+        fileprivate var itemId: String
+        fileprivate var customEventProperties: [String: String]? = nil
 
         public init(itemId: String) {
             self.itemId = itemId
@@ -31,4 +32,3 @@ public class AddCartaddEvent: EventRequest {
         }
     }
 }
-
diff --git a/BluxClient/Classes/request/events/AddCustomEvent.swift b/BluxClient/Classes/request/events/AddCustomEvent.swift
@@ -11,14 +11,20 @@ public class AddCustomEvent: EventRequest {
     }
 
     public class Builder {
-        var itemId: String?
-        var eventType: String
-        var customEventProperties: [String: String]? = nil
+        fileprivate let eventType: String
+
+        fileprivate var itemId: String?
+        fileprivate var customEventProperties: [String: String]? = nil
 
         public init(eventType: String) {
             self.eventType = eventType
         }
 
+        public func itemId(_ itemId: String) -> Builder {
+            self.itemId = itemId
+            return self
+        }
+
         public func customEventProperties(
             _ customEventProperties: [String: String]
         ) -> Builder {

diff --git a/BluxClient/Classes/request/events/AddInstantImpression.swift b/BluxClient/Classes/request/events/AddInstantImpression.swift
@@ -0,0 +1,50 @@
+import Foundation
+
+public class AddInstantImpressionEvent: EventRequest {
+    private static let DEFAULT_EVENT_TYPE = "instant_impression"
+
+    init(builder: Builder) throws {
+        super.init()
+        try self.events.append(
+            Event(eventType: builder.eventType)
+                .setItemId(builder.itemId)
+                .setPage(builder.page)
+                .setSection(builder.section)
+                .setPosition(builder.position)
+                .setRecommendationId(builder.recommendationId ?? "")
+                .setCustomEventProperties(builder.customEventProperties ?? [:])
+        )
+    }
+
+    public class Builder {
+        fileprivate let eventType: String = DEFAULT_EVENT_TYPE
+        fileprivate let itemId: String
+        fileprivate let page: String
+        fileprivate let section: String
+        fileprivate let position: Double
+
+        fileprivate var recommendationId: String? = nil
+        fileprivate var customEventProperties: [String: String]? = nil
+
+        public init(itemId: String, page: String, section: String, position: Double) {
+            self.itemId = itemId
+            self.page = page
+            self.section = section
+            self.position = position
+        }
+
+        public func recommendationId(_ recommendationId: String) -> Builder {
+            self.recommendationId = recommendationId
+            return self
+        }
+
+        public func customEventProperties(_ customEventProperties: [String: String]) -> Builder {
+            self.customEventProperties = customEventProperties
+            return self
+        }
+
+        public func build() throws -> AddInstantImpressionEvent {
+            return try AddInstantImpressionEvent(builder: self)
+        }
+    }
+}
diff --git a/BluxClient/Classes/request/events/AddLikeEvent.swift b/BluxClient/Classes/request/events/AddLikeEvent.swift
@@ -5,17 +5,18 @@ public class AddLikeEvent: EventRequest {
 
     init(builder: Builder) throws {
         super.init()
-        self.events.append(
-            try Event(eventType: builder.eventType)
+        try self.events.append(
+            Event(eventType: builder.eventType)
                 .setItemId(builder.itemId)
                 .setCustomEventProperties(builder.customEventProperties)
         )
     }
 
     public class Builder {
-        var itemId: String
-        var eventType: String = AddLikeEvent.DEFAULT_EVENT_TYPE
-        var customEventProperties: [String: String]? = nil
+        fileprivate let eventType: String = DEFAULT_EVENT_TYPE
+        fileprivate let itemId: String
+
+        fileprivate var customEventProperties: [String: String]? = nil
 
         public init(itemId: String) {
             self.itemId = itemId
@@ -31,4 +32,3 @@ public class AddLikeEvent: EventRequest {
         }
     }
 }
-
diff --git a/BluxClient/Classes/request/events/AddPageViewEvent.swift b/BluxClient/Classes/request/events/AddPageViewEvent.swift
@@ -5,23 +5,23 @@ public class AddPageViewEvent: EventRequest {
 
     init(builder: Builder) throws {
         super.init()
-        self.events.append(
-            try Event(eventType: builder.eventType)
-                    .setPage(builder.page)
-                    .setCustomEventProperties(builder.customEventProperties)
+        try self.events.append(
+            Event(eventType: builder.eventType)
+                .setPage(builder.page)
+                .setCustomEventProperties(builder.customEventProperties)
         )
     }
 
     public class Builder {
-        var eventType: String = AddPageViewEvent.DEFAULT_EVENT_TYPE
-        var page: String
-        var customEventProperties: [String: String]? = nil
+        fileprivate let eventType: String = DEFAULT_EVENT_TYPE
+        fileprivate let page: String
+
+        fileprivate var customEventProperties: [String: String]? = nil
 
         public init(page: String) {
             self.page = page
         }
 
-
         public func customEventProperties(_ customEventProperties: [String: String]) -> Builder {
             self.customEventProperties = customEventProperties
             return self
@@ -32,4 +32,3 @@ public class AddPageViewEvent: EventRequest {
         }
     }
 }
-
diff --git a/BluxClient/Classes/request/events/AddPageVisitEvent.swift b/BluxClient/Classes/request/events/AddPageVisitEvent.swift
@@ -0,0 +1,30 @@
+import Foundation
+
+public class AddPageVisitEvent: EventRequest {
+    private static let DEFAULT_EVENT_TYPE: String = "page_visit"
+
+    init(builder: Builder) throws {
+        super.init()
+        self.events.append(
+            Event(eventType: builder.eventType)
+                .setCustomEventProperties(builder.customEventProperties)
+        )
+    }
+
+    public class Builder {
+        fileprivate let eventType: String = DEFAULT_EVENT_TYPE
+
+        fileprivate var customEventProperties: [String: String]? = nil
+
+        public init() {}
+
+        public func customEventProperties(_ customEventProperties: [String: String]) -> Builder {
+            self.customEventProperties = customEventProperties
+            return self
+        }
+
+        public func build() throws -> AddPageVisitEvent {
+            return try AddPageVisitEvent(builder: self)
+        }
+    }
+}
diff --git a/BluxClient/Classes/request/events/AddPersistentImpression.swift b/BluxClient/Classes/request/events/AddPersistentImpression.swift
@@ -0,0 +1,50 @@
+import Foundation
+
+public class AddPersistentImpressionEvent: EventRequest {
+    private static let DEFAULT_EVENT_TYPE = "persistent_impression"
+
+    init(builder: Builder) throws {
+        super.init()
+        try self.events.append(
+            Event(eventType: builder.eventType)
+                .setItemId(builder.itemId)
+                .setPage(builder.page)
+                .setSection(builder.section)
+                .setPosition(builder.position)
+                .setRecommendationId(builder.recommendationId ?? "")
+                .setCustomEventProperties(builder.customEventProperties ?? [:])
+        )
+    }
+
+    public class Builder {
+        fileprivate let eventType: String = DEFAULT_EVENT_TYPE
+        fileprivate let itemId: String
+        fileprivate let page: String
+        fileprivate let section: String
+        fileprivate let position: Double
+
+        fileprivate var recommendationId: String? = nil
+        fileprivate var customEventProperties: [String: String]? = nil
+
+        public init(itemId: String, page: String, section: String, position: Double) {
+            self.itemId = itemId
+            self.page = page
+            self.section = section
+            self.position = position
+        }
+
+        public func recommendationId(_ recommendationId: String) -> Builder {
+            self.recommendationId = recommendationId
+            return self
+        }
+
+        public func customEventProperties(_ customEventProperties: [String: String]) -> Builder {
+            self.customEventProperties = customEventProperties
+            return self
+        }
+
+        public func build() throws -> AddPersistentImpressionEvent {
+            return try AddPersistentImpressionEvent(builder: self)
+        }
+    }
+}
diff --git a/BluxClient/Classes/request/events/AddProductDetailViewEvent.swift b/BluxClient/Classes/request/events/AddProductDetailViewEvent.swift
@@ -5,22 +5,44 @@ public class AddProductDetailViewEvent: EventRequest {
 
     init(builder: Builder) throws {
         super.init()
-        self.events.append(
-            try Event(eventType: builder.eventType)
-                    .setItemId(builder.itemId)
-                    .setCustomEventProperties(builder.customEventProperties)
+        try self.events.append(
+            Event(eventType: builder.eventType)
+                .setItemId(builder.itemId)
+                .setPrevPage(builder.prevPage)
+                .setPrevSection(builder.prevSection)
+                .setRecommendationId(builder.recommendationId)
+                .setCustomEventProperties(builder.customEventProperties)
         )
     }
 
     public class Builder {
-        var itemId: String
-        var eventType: String = AddProductDetailViewEvent.DEFAULT_EVENT_TYPE
-        var customEventProperties: [String: String]? = nil
+        fileprivate let eventType: String = AddProductDetailViewEvent.DEFAULT_EVENT_TYPE
+        fileprivate let itemId: String
+
+        fileprivate var prevPage: String? = nil
+        fileprivate var prevSection: String? = nil
+        fileprivate var recommendationId: String? = nil
+        fileprivate var customEventProperties: [String: String]? = nil
 
         public init(itemId: String) {
             self.itemId = itemId
         }
 
+        public func prevPage(_ prevPage: String) -> Builder {
+            self.prevPage = prevPage
+            return self
+        }
+
+        public func prevSection(_ prevSection: String) -> Builder {
+            self.prevSection = prevSection
+            return self
+        }
+
+        public func recommendationId(_ recommendationId: String) -> Builder {
+            self.recommendationId = recommendationId
+            return self
+        }
+
         public func customEventProperties(_ customEventProperties: [String: String]) -> Builder {
             self.customEventProperties = customEventProperties
             return self
@@ -31,4 +53,3 @@ public class AddProductDetailViewEvent: EventRequest {
         }
     }
 }
-
diff --git a/BluxClient/Classes/request/events/AddPurchaseEvent.swift b/BluxClient/Classes/request/events/AddPurchaseEvent.swift
@@ -9,25 +9,22 @@ public class AddPurchaseEvent: EventRequest {
     }
 
     public class Builder {
-        var events: [Event] = []
-        var eventType: String = AddPurchaseEvent.DEFAULT_EVENT_TYPE
-        var customEventProperties: [String: String]? = nil
+        fileprivate var events: [Event] = []
 
-        public init() {
-
-        }
+        public init() {}
 
-        public func addPurchase(itemId: String, price: Double, quantity: Int, customEventProperties: [String: String]? = nil) throws -> Builder {
-            guard (quantity > 0) else {
+        public func addPurchase(itemId: String, price: Double, quantity: Int, orderId: String? = nil, customEventProperties: [String: String]? = nil) throws -> Builder {
+            guard quantity > 0 else {
                 throw BluxError.InvalidQuantity
             }
 
             var customEventPropertiesWithQuantity = customEventProperties ?? [:]
             customEventPropertiesWithQuantity["quantity"] = "\(quantity)"
 
-            let event = try Event(eventType: eventType)
+            let event = try Event(eventType: DEFAULT_EVENT_TYPE)
                 .setItemId(itemId)
                 .setPrice(price * Double(quantity))
+                .setOrderId(orderId)
                 .setCustomEventProperties(customEventPropertiesWithQuantity)
 
             self.events.append(event)
@@ -39,4 +36,3 @@ public class AddPurchaseEvent: EventRequest {
         }
     }
 }
-