@npaw/forge-react-native 9.6.1

package/ios/ForgeApple/Sources/NPAWForgeCore/AdSemantics.swift

@@ -0,0 +1,136 @@
+/**
+ * Copyright (C) NPAW - All Rights Reserved
+ *
+ * This source code is protected under international copyright law. All rights
+ * reserved and protected by the copyright holders.
+ * This file is confidential and only available to authorized individuals with the
+ * permission of the copyright holders. If you encounter this file and do not have
+ * permission, please contact the copyright holders and delete this file.
+ *
+ *
+ * @author: Victor Soto <victor.soto@nicepeopleatwork.com>
+ * @description: Apple ad semantic event and metadata snapshot model.
+ */
+
+import Foundation
+
+public enum AdEvent: String {
+    case manifest = "AD_MANIFEST"
+    case breakStart = "AD_BREAK_START"
+    case adInit = "AD_INIT"
+    case start = "AD_START"
+    case join = "AD_JOIN"
+    case pause = "AD_PAUSE"
+    case resume = "AD_RESUME"
+    case bufferBegin = "AD_BUFFER_BEGIN"
+    case bufferEnd = "AD_BUFFER_END"
+    case quartile = "AD_QUARTILE"
+    case click = "AD_CLICK"
+    case skip = "AD_SKIP"
+    case stop = "AD_STOP"
+    case error = "AD_ERROR"
+    case fatalError = "AD_FATAL_ERROR"
+    case breakStop = "AD_BREAK_STOP"
+}
+
+public enum AdInsertionType: String {
+    case clientSide = "CLIENT_SIDE"
+    case serverSide = "SERVER_SIDE"
+    case unknown = "UNKNOWN"
+}
+
+public enum AdPosition: String {
+    case pre = "PRE"
+    case mid = "MID"
+    case post = "POST"
+    case unknown = "UNKNOWN"
+}
+
+public struct AdViewabilitySample: Equatable {
+    public var maxIntervalMs: Int64?
+    public var viewedDurationMs: Int64?
+
+    public init(maxIntervalMs: Int64? = nil, viewedDurationMs: Int64? = nil) {
+        self.maxIntervalMs = maxIntervalMs
+        self.viewedDurationMs = viewedDurationMs
+    }
+}
+
+public struct AdMetadataSnapshot: Equatable {
+    public var adId: String?
+    public var creativeId: String?
+    public var adUrl: String?
+    public var adTitle: String?
+    public var adDurationMs: Int64?
+    public var adPlayheadMs: Int64?
+    public var adBitrate: Int64?
+    public var position: AdPosition?
+    public var quartile: Int?
+    public var insertionType: AdInsertionType
+    public var viewability: AdViewabilitySample?
+    public var errorCode: String?
+    public var errorMessage: String?
+    public var errorMetadata: String?
+    public var errorLevel: String?
+    /// Additive string-key metadata overlay forwarded to the shared Rust
+    /// core. Keys follow the same contract as the Android ad metadata map
+    /// (for example `adCampaign`, `adProvider`, `__legacyAdDimension.<name>`);
+    /// typed snapshot fields always win over overlay keys.
+    public var extraParams: [String: String]
+
+    public init(
+        adId: String? = nil,
+        creativeId: String? = nil,
+        adUrl: String? = nil,
+        adTitle: String? = nil,
+        adDurationMs: Int64? = nil,
+        adPlayheadMs: Int64? = nil,
+        adBitrate: Int64? = nil,
+        position: AdPosition? = nil,
+        quartile: Int? = nil,
+        insertionType: AdInsertionType = .unknown,
+        viewability: AdViewabilitySample? = nil,
+        errorCode: String? = nil,
+        errorMessage: String? = nil,
+        errorMetadata: String? = nil,
+        errorLevel: String? = nil,
+        extraParams: [String: String] = [:]
+    ) {
+        self.adId = adId
+        self.creativeId = creativeId
+        self.adUrl = adUrl
+        self.adTitle = adTitle
+        self.adDurationMs = adDurationMs
+        self.adPlayheadMs = adPlayheadMs
+        self.adBitrate = adBitrate
+        self.position = position
+        self.quartile = quartile
+        self.insertionType = insertionType
+        self.viewability = viewability
+        self.errorCode = errorCode
+        self.errorMessage = errorMessage
+        self.errorMetadata = errorMetadata
+        self.errorLevel = errorLevel
+        self.extraParams = extraParams
+    }
+}
+
+public struct AdapterDescriptor: Equatable {
+    public enum Category: String {
+        case player
+        case partnerPlayer
+        case ad
+    }
+
+    public var adapterId: String
+    public var category: Category
+    public var playerFamily: String
+    public var version: String
+
+    public init(adapterId: String, category: Category, playerFamily: String, version: String) {
+        self.adapterId = adapterId
+        self.category = category
+        self.playerFamily = playerFamily
+        self.version = version
+    }
+}