Add currentOffering(forPlacement: String) to Offerings

Sources/Identity/CustomerInfoManager.swift

@@ -329,7 +329,7 @@ private extension CustomerInfoManager {
 
  let transactionData = PurchasedTransactionData(
  appUserID: appUserID,
- presentedOfferingID: nil,
+ presentedOfferingContext: nil,
  unsyncedAttributes: [:],
  storefront: await Storefront.currentStorefront,
  source: Self.sourceForUnfinishedTransaction

Sources/Logging/Strings/PurchaseStrings.swift

@@ -82,6 +82,7 @@ enum PurchaseStrings {
  productID: String,
  transactionDate: Date,
  offeringID: String?,
+ placementID: String?,
  paywallSessionID: UUID?)
  case caching_presented_offering_identifier(offeringID: String, productID: String)
  case payment_queue_wrapper_delegate_call_sk1_enabled
@@ -306,14 +307,23 @@ extension PurchaseStrings: LogMessage {
  case let .sk2_transactions_update_received_transaction(productID):
  return "StoreKit.Transaction.updates: received transaction for product '\(productID)'"
 
- case let .transaction_poster_handling_transaction(transactionID, productID, date, offeringID, paywallSessionID):
+ case let .transaction_poster_handling_transaction(transactionID,
+ productID,
+ date,
+ offeringID,
+ placementID,
+ paywallSessionID):
  var message = "TransactionPoster: handling transaction '\(transactionID)' " +
  "for product '\(productID)' (date: \(date))"
 
  if let offeringIdentifier = offeringID {
  message += " in Offering '\(offeringIdentifier)'"
  }
 
+ if let placementIdentifier = placementID {
+ message += " with Placement '\(placementIdentifier)'"
+ }
+
  if let paywallSessionID {
  message += " with paywall session '\(paywallSessionID)'"
  }

Sources/Networking/Operations/PostReceiptDataOperation.swift

@@ -124,6 +124,7 @@ extension PostReceiptDataOperation {
  let isRestore: Bool
  let productData: ProductRequestData?
  let presentedOfferingIdentifier: String?
+ let presentedPlacementIdentifier: String?
  let paywall: Paywall?
  let observerMode: Bool
  let initiationSource: ProductRequestData.InitiationSource
@@ -160,7 +161,8 @@ extension PostReceiptDataOperation.PostData {
  receipt: receipt,
  isRestore: data.source.isRestore,
  productData: productData,
- presentedOfferingIdentifier: data.presentedOfferingID,
+ presentedOfferingIdentifier: data.presentedOfferingContext?.offeringIdentifier,
+ presentedPlacementIdentifier: data.presentedOfferingContext?.placementIdentifier,
  paywall: data.paywall,
  observerMode: observerMode,
  initiationSource: data.source.initiationSource,

Sources/Networking/Responses/OfferingsResponse.swift

@@ -35,10 +35,14 @@ struct OfferingsResponse {
  var metadata: [String: AnyDecodable]
 
  }
-
+ struct Placements {
+ let fallbackOfferingId: String?
+ @DefaultDecodable.EmptyDictionary
+ var offeringIdsByPlacement: [String: String?]
+ }
  let currentOfferingId: String?
  let offerings: [Offering]
-
+ let placements: Placements?
 }
 
 extension OfferingsResponse {
@@ -56,6 +60,7 @@ extension OfferingsResponse {
 
 extension OfferingsResponse.Offering.Package: Codable, Equatable {}
 extension OfferingsResponse.Offering: Codable, Equatable {}
+extension OfferingsResponse.Placements: Codable, Equatable {}
 extension OfferingsResponse: Codable, Equatable {}
 
 extension OfferingsResponse: HTTPResponseBody {}

Sources/Purchasing/Offerings.swift

@@ -28,6 +28,19 @@ import Foundation
  */
 @objc(RCOfferings) public final class Offerings: NSObject {
 
+ internal final class Placements: NSObject {
+ let fallbackOfferingId: String?
+ let offeringIdsByPlacement: [String: String?]
+
+ init(
+ fallbackOfferingId: String?,
+ offeringIdsByPlacement: [String: String?]
+ ) {
+ self.fallbackOfferingId = fallbackOfferingId
+ self.offeringIdsByPlacement = offeringIdsByPlacement
+ }
+ }
+
  /**
  Dictionary of all Offerings (``Offering``) objects keyed by their identifier. This dictionary can also be accessed
  by using an index subscript on ``Offerings``, e.g. `offerings["offering_id"]`. To access the current offering use
@@ -48,19 +61,23 @@ import Foundation
  internal let response: OfferingsResponse
 
  private let currentOfferingID: String?
+ private let placements: Placements?
 
  init(
  offerings: [String: Offering],
  currentOfferingID: String?,
+ placements: Placements?,
  response: OfferingsResponse
  ) {
  self.all = offerings
  self.currentOfferingID = currentOfferingID
  self.response = response
+ self.placements = placements
  }
 
 }
 
+extension Offerings.Placements: Sendable {}
 extension Offerings: Sendable {}
 
 public extension Offerings {
@@ -93,4 +110,50 @@ public extension Offerings {
  return description
  }
 
+ /**
+ Retrieves a current offering for a placement identifier, use this to access offerings defined by targeting
+ placements configured in the RevenueCat dashboard, 
+ e.g. `offerings.currentOffering(forPlacement: "placement_id")`.
+ */
+ @objc(currentOfferingForPlacement:)
+ func currentOffering(forPlacement placementIdentifier: String) -> Offering? {
+ guard let placements = self.placements else {
+ return nil
+ }
+
+ let returnOffering: Offering?
+ if let explicitOfferingId: String? = placements.offeringIdsByPlacement[placementIdentifier] {
+ // Don't use fallback since placement id was explicity set in the dictionary
+ returnOffering = explicitOfferingId.flatMap { self.all[$0] }
+ } else {
+ // Use fallback since the placement didn't exist
+ returnOffering = placements.fallbackOfferingId.flatMap { self.all[$0]}
+ }
+
+ return returnOffering?.copyWith(placementIdentifier: placementIdentifier)
+ }
+}
+
+private extension Offering {
+ func copyWith(placementIdentifier: String?) -> Offering {
+ let updatedPackages = self.availablePackages.map { pkg in
+ let newContext = PresentedOfferingContext(
+ offeringIdentifier: pkg.presentedOfferingContext.offeringIdentifier,
+ placementIdentifier: placementIdentifier
+ )
+
+ return Package(identifier: pkg.identifier,
+ packageType: pkg.packageType,
+ storeProduct: pkg.storeProduct,
+ presentedOfferingContext: newContext
+ )
+ }
+
+ return Offering(identifier: self.identifier,
+ serverDescription: self.serverDescription,
+ metadata: self.metadata,
+ paywall: self.paywall,
+ availablePackages: updatedPackages
+ )
+ }
 }

Sources/Purchasing/OfferingsFactory.swift

@@ -31,6 +31,7 @@ class OfferingsFactory {
 
  return Offerings(offerings: offerings,
  currentOfferingID: data.currentOfferingId,
+ placements: createPlacement(with: data.placements),
  response: data)
  }
 
@@ -68,6 +69,16 @@ class OfferingsFactory {
  offeringIdentifier: offeringIdentifier)
  }
 
+ func createPlacement(
+ with data: OfferingsResponse.Placements?
+ ) -> Offerings.Placements? {
+ guard let data else {
+ return nil
+ }
+
+ return .init(fallbackOfferingId: data.fallbackOfferingId,
+ offeringIdsByPlacement: data.offeringIdsByPlacement)
+ }
 }
 
 // @unchecked because:

Sources/Purchasing/Package.swift

@@ -19,18 +19,31 @@ import Foundation
 ///
 @objc(RCPresentedOfferingContext) public final class PresentedOfferingContext: NSObject {
 
- /// The identifier of the ``Offering`` containing this Package.
+ /// The identifier of the ``Offering`` containing this ``Package``.
  @objc public let offeringIdentifier: String
 
+ /// The placement identifier this ``Package`` was obtained from.
+ @objc public let placementIdentifier: String?
+
  /// Initialize a ``PresentedOfferingContext``.
  @objc
  public init(
- offeringIdentifier: String
+ offeringIdentifier: String,
+ placementIdentifier: String?
  ) {
  self.offeringIdentifier = offeringIdentifier
+ self.placementIdentifier = placementIdentifier
  super.init()
  }
 
+ /// Initialize a ``PresentedOfferingContext``.
+ @objc
+ public convenience init(
+ offeringIdentifier: String
+ ) {
+ self.init(offeringIdentifier: offeringIdentifier, placementIdentifier: nil)
+ }
+
  public override func isEqual(_ object: Any?) -> Bool {
  guard let other = object as? PresentedOfferingContext else { return false }
 
@@ -91,7 +104,8 @@ import Foundation
  identifier: identifier,
  packageType: packageType,
  storeProduct: storeProduct,
- presentedOfferingContext: PresentedOfferingContext(offeringIdentifier: offeringIdentifier)
+ presentedOfferingContext: PresentedOfferingContext(offeringIdentifier: offeringIdentifier,
+ placementIdentifier: nil)
  )
  }
 

Sources/Purchasing/Purchases/PurchasesOrchestrator.swift

@@ -875,12 +875,13 @@ extension PurchasesOrchestrator: StoreKit2TransactionListenerDelegate {
  _ listener: StoreKit2TransactionListenerType,
  updatedTransaction transaction: StoreTransactionType
  ) async throws {
+
  let storefront = await self.storefront(from: transaction)
  let subscriberAttributes = self.unsyncedAttributes
  let adServicesToken = await self.attribution.unsyncedAdServicesToken
  let transactionData: PurchasedTransactionData = .init(
  appUserID: self.appUserID,
- presentedOfferingID: nil,
+ presentedOfferingContext: nil,
  unsyncedAttributes: subscriberAttributes,
  aadAttributionToken: adServicesToken,
  storefront: storefront,
@@ -1060,7 +1061,7 @@ private extension PurchasesOrchestrator {
  self.createProductRequestData(with: receiptData) { productRequestData in
  let transactionData: PurchasedTransactionData = .init(
  appUserID: currentAppUserID,
- presentedOfferingID: nil,
+ presentedOfferingContext: nil,
  unsyncedAttributes: unsyncedAttributes,
  storefront: productRequestData?.storefront,
  source: .init(isRestore: isRestore, initiationSource: initiationSource)
@@ -1107,7 +1108,7 @@ private extension PurchasesOrchestrator {
  self.createProductRequestData(with: transaction.productIdentifier) { productRequestData in
  let transactionData: PurchasedTransactionData = .init(
  appUserID: currentAppUserID,
- presentedOfferingID: nil,
+ presentedOfferingContext: nil,
  unsyncedAttributes: unsyncedAttributes,
  storefront: transaction.storefront,
  source: .init(isRestore: isRestore, initiationSource: initiationSource)
@@ -1170,13 +1171,13 @@ private extension PurchasesOrchestrator {
  func handlePurchasedTransaction(_ purchasedTransaction: StoreTransaction,
  storefront: StorefrontType?,
  restored: Bool) {
- let offeringContext = self.getAndRemovePresentedOfferingIdentifier(for: purchasedTransaction)
+ let offeringContext = self.getAndRemovePresentedOfferingContext(for: purchasedTransaction)
  let paywall = self.getAndRemovePresentedPaywall()
  let unsyncedAttributes = self.unsyncedAttributes
  self.attribution.unsyncedAdServicesToken { adServicesToken in
  let transactionData: PurchasedTransactionData = .init(
  appUserID: self.appUserID,
- presentedOfferingID: offeringContext?.offeringIdentifier,
+ presentedOfferingContext: offeringContext,
  presentedPaywall: paywall,
  unsyncedAttributes: unsyncedAttributes,
  aadAttributionToken: adServicesToken,
@@ -1243,14 +1244,14 @@ private extension PurchasesOrchestrator {
  self.presentedPaywall.value = nil
  }
 
- func getAndRemovePresentedOfferingIdentifier(for productIdentifier: String) -> PresentedOfferingContext? {
+ func getAndRemovePresentedOfferingContext(for productIdentifier: String) -> PresentedOfferingContext? {
  return self.presentedOfferingContextsByProductID.modify {
  $0.removeValue(forKey: productIdentifier)
  }
  }
 
- func getAndRemovePresentedOfferingIdentifier(for transaction: StoreTransaction) -> PresentedOfferingContext? {
- return self.getAndRemovePresentedOfferingIdentifier(for: transaction.productIdentifier)
+ func getAndRemovePresentedOfferingContext(for transaction: StoreTransaction) -> PresentedOfferingContext? {
+ return self.getAndRemovePresentedOfferingContext(for: transaction.productIdentifier)
  }
 
  func getAndRemovePresentedPaywall() -> PaywallEvent? {
@@ -1427,13 +1428,13 @@ extension PurchasesOrchestrator {
  _ initiationSource: ProductRequestData.InitiationSource
  ) async throws -> CustomerInfo {
  let storefront = await Storefront.currentStorefront
- let offeringData = self.getAndRemovePresentedOfferingIdentifier(for: transaction)
+ let offeringContext = self.getAndRemovePresentedOfferingContext(for: transaction)
  let paywall = self.getAndRemovePresentedPaywall()
  let unsyncedAttributes = self.unsyncedAttributes
  let adServicesToken = await self.attribution.unsyncedAdServicesToken
  let transactionData: PurchasedTransactionData = .init(
  appUserID: self.appUserID,
- presentedOfferingID: offeringData?.offeringIdentifier,
+ presentedOfferingContext: offeringContext,
  presentedPaywall: paywall,
  unsyncedAttributes: unsyncedAttributes,
  aadAttributionToken: adServicesToken,

Sources/Purchasing/Purchases/TransactionPoster.swift

@@ -25,7 +25,7 @@ struct PurchaseSource: Equatable {
 struct PurchasedTransactionData {
 
  var appUserID: String
- var presentedOfferingID: String?
+ var presentedOfferingContext: PresentedOfferingContext?
  var presentedPaywall: PaywallEvent?
  var unsyncedAttributes: SubscriberAttribute.Dictionary?
  var aadAttributionToken: String?
@@ -89,7 +89,8 @@ final class TransactionPoster: TransactionPosterType {
  transactionID: transaction.transactionIdentifier,
  productID: transaction.productIdentifier,
  transactionDate: transaction.purchaseDate,
- offeringID: data.presentedOfferingID,
+ offeringID: data.presentedOfferingContext?.offeringIdentifier,
+ placementID: data.presentedOfferingContext?.placementIdentifier,
  paywallSessionID: data.presentedPaywall?.data.sessionIdentifier
  ))
 

Sources/Support/PaywallExtensions.swift

@@ -124,8 +124,18 @@ private extension View {
  Logger.appleWarning(Strings.configure.sk2_required_for_swiftui_paywalls)
  }
 
+ // Find offering context from a matching package.
+ // Packages could have the same product but each product has the same offering
+ // context so that is okay if that happens.
+ let offeringContext = offering.availablePackages.first {
+ $0.storeProduct.productIdentifier == product.id
+ }?.presentedOfferingContext
+
  Purchases.shared.cachePresentedOfferingContext(
- .init(offeringIdentifier: offering.identifier),
+ offeringContext ?? .init(
+ offeringIdentifier: offering.identifier,
+ placementIdentifier: nil
+ ),
  productIdentifier: product.id
  )
  }

Tests/APITesters/CustomEntitlementComputationSwiftAPITester/SwiftAPITester/PresentedOfferingContextAPI.swift

@@ -11,8 +11,10 @@ import StoreKit
 
 func checkPresentedOfferingContextAPI(context: PresentedOfferingContext! = nil) {
  let _: String = context.offeringIdentifier
+ let _: String? = context.placementIdentifier
 }
 
 private func checkCreatePresentedOfferingContextAPI() {
  let _: PresentedOfferingContext = .init(offeringIdentifier: "")
+ let _: PresentedOfferingContext = .init(offeringIdentifier: "", placementIdentifier: "")
 }