[AUTOMATIC] Release/4.28.0 (#3299)

.version

@@ -1 +1 @@
-4.28.0-SNAPSHOT
+4.28.0

CHANGELOG.latest.md

@@ -1,8 +1,14 @@
+### New Features
+* `Purchases`: new `cachedCustomerInfo` and `cachedOfferings` (#3274) via NachoSoto (@NachoSoto)
+* Expose `productPlanIdentifier` in `EntitlementInfo` (#3290) via Toni Rico (@tonidero)
 ### RevenueCatUI
-* `Paywalls`: improved purchase-in-progress UI (#3279) via NachoSoto (@NachoSoto)
+* `Paywalls`: localize default template (#3295) via NachoSoto (@NachoSoto)
+* `Paywalls`: created `ConsistentPackageContentView` to improve package change transitions (#3246) via NachoSoto (@NachoSoto)
+* `Paywalls`: `visionOS` support (#3293) via NachoSoto (@NachoSoto)
+* `Paywalls`: avoid flickering when displaying paywalls with available cache (#3283) via NachoSoto (@NachoSoto)
 ### Bugfixes
-* `SK2StoreProduct.priceFormatter`: use locale from `StoreKit.Product` (#3278) via NachoSoto (@NachoSoto)
-### Performance Improvements
-* `AAAttribution.attributionToken`: avoid using on main thread (#3281) via NachoSoto (@NachoSoto)
+* `PaywallEventStore`: changed container to use `URL.applicationSupportDirectory` (#3289) via NachoSoto (@NachoSoto)
 ### Other Changes
-* `Paywalls Tester`: group live paywalls by template (#3276) via NachoSoto (@NachoSoto)
+* `CI`: change `visionOS` build to environment with `xrOS` SDK (#3294) via NachoSoto (@NachoSoto)
+* `Paywalls`: extracted common `TemplateViewType` method for previews (#3292) via NachoSoto (@NachoSoto)
+* `Tests`: improved flaky test (#3282) via NachoSoto (@NachoSoto)

CHANGELOG.md

@@ -1,3 +1,19 @@
+## 4.28.0
+### New Features
+* `Purchases`: new `cachedCustomerInfo` and `cachedOfferings` (#3274) via NachoSoto (@NachoSoto)
+* Expose `productPlanIdentifier` in `EntitlementInfo` (#3290) via Toni Rico (@tonidero)
+### RevenueCatUI
+* `Paywalls`: localize default template (#3295) via NachoSoto (@NachoSoto)
+* `Paywalls`: created `ConsistentPackageContentView` to improve package change transitions (#3246) via NachoSoto (@NachoSoto)
+* `Paywalls`: `visionOS` support (#3293) via NachoSoto (@NachoSoto)
+* `Paywalls`: avoid flickering when displaying paywalls with available cache (#3283) via NachoSoto (@NachoSoto)
+### Bugfixes
+* `PaywallEventStore`: changed container to use `URL.applicationSupportDirectory` (#3289) via NachoSoto (@NachoSoto)
+### Other Changes
+* `CI`: change `visionOS` build to environment with `xrOS` SDK (#3294) via NachoSoto (@NachoSoto)
+* `Paywalls`: extracted common `TemplateViewType` method for previews (#3292) via NachoSoto (@NachoSoto)
+* `Tests`: improved flaky test (#3282) via NachoSoto (@NachoSoto)
+
 ## 4.27.2
 ### RevenueCatUI
 * `Paywalls`: improved purchase-in-progress UI (#3279) via NachoSoto (@NachoSoto)

RevenueCat.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = "RevenueCat"
-  s.version          = "4.28.0-SNAPSHOT"
+  s.version          = "4.28.0"
   s.summary          = "Subscription and in-app-purchase backend service."
 
   s.description      = <<-DESC

Sources/Misc/SystemInfo.swift

@@ -54,7 +54,7 @@ class SystemInfo {
     }
 
     static var frameworkVersion: String {
-        return "4.28.0-SNAPSHOT"
+        return "4.28.0"
     }
 
     static var systemVersion: String {

Tests/InstallationTests/CommonFiles/RevenueCat-Swift.h

@@ -1000,7 +1000,7 @@ SWIFT_CLASS_NAMED("EntitlementInfo")
 @property (nonatomic, readonly) enum RCStore store;
 /// The product identifier that unlocked this entitlement
 @property (nonatomic, readonly, copy) NSString * _Nonnull productIdentifier;
-/// The product plan identifier that unlocked this entitlement (usually for a Google Play purchase)
+/// The product plan identifier that unlocked this entitlement (for a Google Play subscription purchase)
 @property (nonatomic, readonly, copy) NSString * _Nullable productPlanIdentifier;
 /// False if this entitlement is unlocked via a production purchase
 @property (nonatomic, readonly) BOOL isSandbox;
@@ -1895,6 +1895,11 @@ SWIFT_PROTOCOL_NAMED("PurchasesType")
 /// \param fetchPolicy The behavior for what to do regarding caching.
 ///
 - (void)customerInfoWithFetchPolicy:(enum RCCacheFetchPolicy)fetchPolicy completionHandler:(void (^ _Nonnull)(RCCustomerInfo * _Nullable, NSError * _Nullable))completionHandler SWIFT_AVAILABILITY(watchos,introduced=6.2) SWIFT_AVAILABILITY(tvos,introduced=13.0) SWIFT_AVAILABILITY(macos,introduced=10.15) SWIFT_AVAILABILITY(ios,introduced=13.0);
+/// The currently cached <code>CustomerInfo</code> if one is available.
+/// This is synchronous, and therefore useful for contexts where an app needs a <code>CustomerInfo</code>
+/// right away without waiting for a callback, like a SwiftUI view.
+/// This allows initializing state to ensure that UI can be loaded from the very first frame.
+@property (nonatomic, readonly, strong) RCCustomerInfo * _Nullable cachedCustomerInfo;
 /// Fetch the configured <code>Offerings</code> for this user.
 /// <code>Offerings</code> allows you to configure your in-app products
 /// via RevenueCat and greatly simplifies management.
@@ -1922,6 +1927,11 @@ SWIFT_PROTOCOL_NAMED("PurchasesType")
 ///   </li>
 /// </ul>
 - (void)offeringsWithCompletionHandler:(void (^ _Nonnull)(RCOfferings * _Nullable, NSError * _Nullable))completionHandler SWIFT_AVAILABILITY(watchos,introduced=6.2) SWIFT_AVAILABILITY(tvos,introduced=13.0) SWIFT_AVAILABILITY(macos,introduced=10.15) SWIFT_AVAILABILITY(ios,introduced=13.0);
+/// The currently cached <code>Offerings</code> if available.
+/// This is synchronous, and therefore useful for contexts where an app needs an instance of <code>Offerings</code>
+/// right away without waiting for a callback, like a SwiftUI view.
+/// This allows initializing state to ensure that UI can be loaded from the very first frame.
+@property (nonatomic, readonly, strong) RCOfferings * _Nullable cachedOfferings;
 /// Fetches the <code>StoreProduct</code>s for your IAPs for given <code>productIdentifiers</code>.
 /// Use this method if you aren’t using <code>Purchases/getOfferings(completion:)</code>.
 /// You should use <code>Purchases/getOfferings(completion:)</code> though.
@@ -2569,6 +2579,34 @@ SWIFT_CLASS_NAMED("PlatformInfo")
 @end
 
 
+@interface RCPurchases (SWIFT_EXTENSION(RevenueCat))
+/// Enable debug logging. Useful for debugging issues with the lovely team @RevenueCat.
+SWIFT_CLASS_PROPERTY(@property (nonatomic, class) BOOL debugLogsEnabled SWIFT_DEPRECATED_MSG("use Purchases.logLevel instead");)
++ (BOOL)debugLogsEnabled SWIFT_WARN_UNUSED_RESULT;
++ (void)setDebugLogsEnabled:(BOOL)newValue;
+/// Deprecated
+@property (nonatomic) BOOL allowSharingAppStoreAccount SWIFT_DEPRECATED_MSG("Configure behavior through the RevenueCat dashboard instead");
+/// Deprecated
++ (void)addAttributionData:(NSDictionary<NSString *, id> * _Nonnull)data fromNetwork:(enum RCAttributionNetwork)network SWIFT_DEPRECATED_MSG("Use the set<NetworkId> functions instead");
+/// Send your attribution data to RevenueCat so you can track the revenue generated by your different campaigns.
+/// <h4>Related articles</h4>
+/// <ul>
+///   <li>
+///     <a href="https://docs.revenuecat.com/docs/attribution">Attribution</a>
+///   </li>
+/// </ul>
+/// \param data Dictionary provided by the network.
+///
+/// \param network Enum for the network the data is coming from, see <code>AttributionNetwork</code> for supported
+/// networks.
+///
+/// \param networkUserId User Id that should be sent to the network. Default is the current App User Id.
+///
++ (void)addAttributionData:(NSDictionary<NSString *, id> * _Nonnull)data fromNetwork:(enum RCAttributionNetwork)network forNetworkUserId:(NSString * _Nullable)networkUserId SWIFT_DEPRECATED_MSG("Use the set<NetworkId> functions instead");
+@end
+
+
+
 @interface RCPurchases (SWIFT_EXTENSION(RevenueCat))
 /// Configures an instance of the Purchases SDK with a specified <code>Configuration</code>.
 /// The instance will be set as a singleton.
@@ -2663,31 +2701,14 @@ SWIFT_CLASS_NAMED("PlatformInfo")
 @end
 
 
-
 @interface RCPurchases (SWIFT_EXTENSION(RevenueCat))
-/// Enable debug logging. Useful for debugging issues with the lovely team @RevenueCat.
-SWIFT_CLASS_PROPERTY(@property (nonatomic, class) BOOL debugLogsEnabled SWIFT_DEPRECATED_MSG("use Purchases.logLevel instead");)
-+ (BOOL)debugLogsEnabled SWIFT_WARN_UNUSED_RESULT;
-+ (void)setDebugLogsEnabled:(BOOL)newValue;
-/// Deprecated
-@property (nonatomic) BOOL allowSharingAppStoreAccount SWIFT_DEPRECATED_MSG("Configure behavior through the RevenueCat dashboard instead");
-/// Deprecated
-+ (void)addAttributionData:(NSDictionary<NSString *, id> * _Nonnull)data fromNetwork:(enum RCAttributionNetwork)network SWIFT_DEPRECATED_MSG("Use the set<NetworkId> functions instead");
-/// Send your attribution data to RevenueCat so you can track the revenue generated by your different campaigns.
-/// <h4>Related articles</h4>
-/// <ul>
-///   <li>
-///     <a href="https://docs.revenuecat.com/docs/attribution">Attribution</a>
-///   </li>
-/// </ul>
-/// \param data Dictionary provided by the network.
-///
-/// \param network Enum for the network the data is coming from, see <code>AttributionNetwork</code> for supported
-/// networks.
-///
-/// \param networkUserId User Id that should be sent to the network. Default is the current App User Id.
-///
-+ (void)addAttributionData:(NSDictionary<NSString *, id> * _Nonnull)data fromNetwork:(enum RCAttributionNetwork)network forNetworkUserId:(NSString * _Nullable)networkUserId SWIFT_DEPRECATED_MSG("Use the set<NetworkId> functions instead");
++ (RCPurchases * _Nonnull)configureWithAPIKey:(NSString * _Nonnull)apiKey appUserID:(NSString * _Nullable)appUserID observerMode:(BOOL)observerMode userDefaults:(NSUserDefaults * _Nullable)userDefaults SWIFT_AVAILABILITY(maccatalyst,deprecated=1,message="'configure' has been renamed to 'configure(with:)'") SWIFT_AVAILABILITY(macos,deprecated=1,message="'configure' has been renamed to 'configure(with:)'") SWIFT_AVAILABILITY(watchos,deprecated=1,message="'configure' has been renamed to 'configure(with:)'") SWIFT_AVAILABILITY(tvos,deprecated=1,message="'configure' has been renamed to 'configure(with:)'") SWIFT_AVAILABILITY(ios,deprecated=1,message="'configure' has been renamed to 'configure(with:)'");
++ (RCPurchases * _Nonnull)configureWithAPIKey:(NSString * _Nonnull)apiKey appUserID:(NSString * _Nullable)appUserID observerMode:(BOOL)observerMode userDefaults:(NSUserDefaults * _Nullable)userDefaults useStoreKit2IfAvailable:(BOOL)useStoreKit2IfAvailable SWIFT_AVAILABILITY(maccatalyst,deprecated=1,message="'configure' has been renamed to 'configure(with:)'") SWIFT_AVAILABILITY(macos,deprecated=1,message="'configure' has been renamed to 'configure(with:)'") SWIFT_AVAILABILITY(watchos,deprecated=1,message="'configure' has been renamed to 'configure(with:)'") SWIFT_AVAILABILITY(tvos,deprecated=1,message="'configure' has been renamed to 'configure(with:)'") SWIFT_AVAILABILITY(ios,deprecated=1,message="'configure' has been renamed to 'configure(with:)'");
++ (RCPurchases * _Nonnull)configureWithAPIKey:(NSString * _Nonnull)apiKey appUserID:(NSString * _Nullable)appUserID observerMode:(BOOL)observerMode userDefaults:(NSUserDefaults * _Nullable)userDefaults useStoreKit2IfAvailable:(BOOL)useStoreKit2IfAvailable dangerousSettings:(RCDangerousSettings * _Nullable)dangerousSettings SWIFT_AVAILABILITY(maccatalyst,deprecated=1,message="'configure' has been renamed to 'configure(with:)'") SWIFT_AVAILABILITY(macos,deprecated=1,message="'configure' has been renamed to 'configure(with:)'") SWIFT_AVAILABILITY(watchos,deprecated=1,message="'configure' has been renamed to 'configure(with:)'") SWIFT_AVAILABILITY(tvos,deprecated=1,message="'configure' has been renamed to 'configure(with:)'") SWIFT_AVAILABILITY(ios,deprecated=1,message="'configure' has been renamed to 'configure(with:)'");
+/// Enable automatic collection of Apple Search Ads attribution. Defaults to <code>false</code>.
+SWIFT_CLASS_PROPERTY(@property (nonatomic, class) BOOL automaticAppleSearchAdsAttributionCollection SWIFT_DEPRECATED_MSG("Use Purchases.shared.attribution.enableAdServicesAttributionTokenCollection() instead");)
++ (BOOL)automaticAppleSearchAdsAttributionCollection SWIFT_WARN_UNUSED_RESULT;
++ (void)setAutomaticAppleSearchAdsAttributionCollection:(BOOL)value;
 @end
 
 
@@ -2696,17 +2717,7 @@ SWIFT_CLASS_PROPERTY(@property (nonatomic, class) BOOL debugLogsEnabled SWIFT_DE
 @property (nonatomic, readonly) BOOL isAnonymous;
 - (void)getOfferingsWithCompletion:(void (^ _Nonnull)(RCOfferings * _Nullable, NSError * _Nullable))completion;
 - (void)offeringsWithCompletionHandler:(void (^ _Nonnull)(RCOfferings * _Nullable, NSError * _Nullable))completionHandler SWIFT_AVAILABILITY(watchos,introduced=6.2) SWIFT_AVAILABILITY(tvos,introduced=13.0) SWIFT_AVAILABILITY(macos,introduced=10.15) SWIFT_AVAILABILITY(ios,introduced=13.0);
-@end
-
-
-@interface RCPurchases (SWIFT_EXTENSION(RevenueCat))
-+ (RCPurchases * _Nonnull)configureWithAPIKey:(NSString * _Nonnull)apiKey appUserID:(NSString * _Nullable)appUserID observerMode:(BOOL)observerMode userDefaults:(NSUserDefaults * _Nullable)userDefaults SWIFT_AVAILABILITY(maccatalyst,deprecated=1,message="'configure' has been renamed to 'configure(with:)'") SWIFT_AVAILABILITY(macos,deprecated=1,message="'configure' has been renamed to 'configure(with:)'") SWIFT_AVAILABILITY(watchos,deprecated=1,message="'configure' has been renamed to 'configure(with:)'") SWIFT_AVAILABILITY(tvos,deprecated=1,message="'configure' has been renamed to 'configure(with:)'") SWIFT_AVAILABILITY(ios,deprecated=1,message="'configure' has been renamed to 'configure(with:)'");
-+ (RCPurchases * _Nonnull)configureWithAPIKey:(NSString * _Nonnull)apiKey appUserID:(NSString * _Nullable)appUserID observerMode:(BOOL)observerMode userDefaults:(NSUserDefaults * _Nullable)userDefaults useStoreKit2IfAvailable:(BOOL)useStoreKit2IfAvailable SWIFT_AVAILABILITY(maccatalyst,deprecated=1,message="'configure' has been renamed to 'configure(with:)'") SWIFT_AVAILABILITY(macos,deprecated=1,message="'configure' has been renamed to 'configure(with:)'") SWIFT_AVAILABILITY(watchos,deprecated=1,message="'configure' has been renamed to 'configure(with:)'") SWIFT_AVAILABILITY(tvos,deprecated=1,message="'configure' has been renamed to 'configure(with:)'") SWIFT_AVAILABILITY(ios,deprecated=1,message="'configure' has been renamed to 'configure(with:)'");
-+ (RCPurchases * _Nonnull)configureWithAPIKey:(NSString * _Nonnull)apiKey appUserID:(NSString * _Nullable)appUserID observerMode:(BOOL)observerMode userDefaults:(NSUserDefaults * _Nullable)userDefaults useStoreKit2IfAvailable:(BOOL)useStoreKit2IfAvailable dangerousSettings:(RCDangerousSettings * _Nullable)dangerousSettings SWIFT_AVAILABILITY(maccatalyst,deprecated=1,message="'configure' has been renamed to 'configure(with:)'") SWIFT_AVAILABILITY(macos,deprecated=1,message="'configure' has been renamed to 'configure(with:)'") SWIFT_AVAILABILITY(watchos,deprecated=1,message="'configure' has been renamed to 'configure(with:)'") SWIFT_AVAILABILITY(tvos,deprecated=1,message="'configure' has been renamed to 'configure(with:)'") SWIFT_AVAILABILITY(ios,deprecated=1,message="'configure' has been renamed to 'configure(with:)'");
-/// Enable automatic collection of Apple Search Ads attribution. Defaults to <code>false</code>.
-SWIFT_CLASS_PROPERTY(@property (nonatomic, class) BOOL automaticAppleSearchAdsAttributionCollection SWIFT_DEPRECATED_MSG("Use Purchases.shared.attribution.enableAdServicesAttributionTokenCollection() instead");)
-+ (BOOL)automaticAppleSearchAdsAttributionCollection SWIFT_WARN_UNUSED_RESULT;
-+ (void)setAutomaticAppleSearchAdsAttributionCollection:(BOOL)value;
+@property (nonatomic, readonly, strong) RCOfferings * _Nullable cachedOfferings;
 @end
 
 
@@ -2908,6 +2919,7 @@ SWIFT_CLASS_PROPERTY(@property (nonatomic, class) BOOL automaticAppleSearchAdsAt
 - (void)getCustomerInfoWithFetchPolicy:(enum RCCacheFetchPolicy)fetchPolicy completion:(void (^ _Nonnull)(RCCustomerInfo * _Nullable, NSError * _Nullable))completion;
 - (void)customerInfoWithCompletionHandler:(void (^ _Nonnull)(RCCustomerInfo * _Nullable, NSError * _Nullable))completionHandler SWIFT_AVAILABILITY(watchos,introduced=6.2) SWIFT_AVAILABILITY(tvos,introduced=13.0) SWIFT_AVAILABILITY(macos,introduced=10.15) SWIFT_AVAILABILITY(ios,introduced=13.0);
 - (void)customerInfoWithFetchPolicy:(enum RCCacheFetchPolicy)fetchPolicy completionHandler:(void (^ _Nonnull)(RCCustomerInfo * _Nullable, NSError * _Nullable))completionHandler SWIFT_AVAILABILITY(watchos,introduced=6.2) SWIFT_AVAILABILITY(tvos,introduced=13.0) SWIFT_AVAILABILITY(macos,introduced=10.15) SWIFT_AVAILABILITY(ios,introduced=13.0);
+@property (nonatomic, readonly, strong) RCCustomerInfo * _Nullable cachedCustomerInfo;
 - (void)getProductsWithIdentifiers:(NSArray<NSString *> * _Nonnull)productIdentifiers completion:(void (^ _Nonnull)(NSArray<RCStoreProduct *> * _Nonnull))completion;
 - (void)products:(NSArray<NSString *> * _Nonnull)productIdentifiers completionHandler:(void (^ _Nonnull)(NSArray<RCStoreProduct *> * _Nonnull))completionHandler SWIFT_AVAILABILITY(watchos,introduced=6.2) SWIFT_AVAILABILITY(tvos,introduced=13.0) SWIFT_AVAILABILITY(macos,introduced=10.15) SWIFT_AVAILABILITY(ios,introduced=13.0);
 - (void)purchaseProduct:(RCStoreProduct * _Nonnull)product withCompletion:(void (^ _Nonnull)(RCStoreTransaction * _Nullable, RCCustomerInfo * _Nullable, NSError * _Nullable, BOOL))completion;

scripts/docs/index.html

@@ -2,7 +2,7 @@
 <!DOCTYPE html>
 <html>
 <head>
-    <meta http-equiv="refresh" content="0; url=https://revenuecat.github.io/purchases-ios-docs/4.28.0-SNAPSHOT/documentation/revenuecat"/>
+    <meta http-equiv="refresh" content="0; url=https://revenuecat.github.io/purchases-ios-docs/4.28.0/documentation/revenuecat"/>
 </head>
 <body>
 </body>

scripts/docs/v4_api_migration_guide.html

@@ -2,7 +2,7 @@
 <!DOCTYPE html>
 <html>
 <head>
-    <meta http-equiv="refresh" content="0; url=https://revenuecat.github.io/purchases-ios-docs/4.28.0-SNAPSHOT/documentation/revenuecat/v4_api_migration_guide"/>
+    <meta http-equiv="refresh" content="0; url=https://revenuecat.github.io/purchases-ios-docs/4.28.0/documentation/revenuecat/v4_api_migration_guide"/>
 </head>
 <body>
 </body>