Release/5.5.0 (#4308)

Co-authored-by: RCGitBot <[email protected]> Co-authored-by: RevenueCat Git Bot <[email protected]>
RevenueCat · Oct 1, 2024 · 4bd1154 · 4bd1154
1 parent 4700d9c
commit 4bd1154
Show file tree

Hide file tree

Showing 11 changed files with 283 additions and 19 deletions.
diff --git a/.version b/.version
@@ -1 +1 @@
-5.5.0-SNAPSHOT
+5.5.0
diff --git a/CHANGELOG.latest.md b/CHANGELOG.latest.md
@@ -1,12 +1,134 @@
-## RevenueCat SDK
-### ✨ New Features
-* Add `kochava` integration (#4274) via Toni Rico (@tonidero)
-
-## RevenueCatUI SDK
-### Customer Center
-#### 🐞 Bugfixes
-* Cleanup of strings in Customer Center (#4294) via Cesar de la Vega (@vegaro)
-
-### 🔄 Other Changes
-* [Diagnostics] Add `apple_purchase_attempt ` event (#4253) via Cesar de la Vega (@vegaro)
-* Temporarily set SWIFT_TREAT_WARNINGS_AS_ERRORS as NO (#4292) via Cesar de la Vega (@vegaro)
+## 🫂 Customer Center Beta 🫂
+
+This release adds public beta support for the new Customer Center on iOS 15.0+.
+
+This central hub is a self-service section that can be added to your app to help your users manage their subscriptions on their own, reducing the support burden on developers 
+like you so you can spend more time building apps and less time dealing with support issues. We are hoping adding this new section to your app can help you reduce customer support 
+interactions, obtain feedback from your users and ultimately reduce churn by retaining them as subscribers, helping you make more money.
+
+See our [Customer Center documentation](https://www.revenuecat.com/docs/tools/customer-center) for more information.
+
+### Features currently available
+* Users can cancel current subscriptions
+* Users can ask for refunds
+* Users can change their subscription plans
+* Users can restore previous purchases and contact your support email if they have trouble restoring
+* Users will be asked to update their app if they are on an older version before being able to contact your support email
+* Developers can ask for reasons for cancellations or refunds, and automatically offer promo offers to retain users
+* Configuration is done in the RevenueCat dashboard, and advanced configuration is available via JSON
+
+### Limitations
+* Only available on iOS 15+
+* Limited visual configuration options in the dashboard. It is possible to configure the Customer Center via JSON.
+* We are exposing a SwiftUI view and a modifier at the moment. We haven't built a UIKit wrapper to help integrating on UIKit apps, but it's in the roadmap.
+
+### How to enable
+You can use the CustomerCenterView view directly:
+
+```swift
+var body: some View {
+    Group {
+        NavigationStack {
+            HomeView()
+                .navigationTitle("Home")
+                .navigationBarTitleDisplayMode(.inline)
+                .toolbar {
+                    ToolbarItem(placement: .topBarLeading) {
+                        Button {
+                        } label: {
+                            Image(systemName: "line.3.horizontal")
+                        }
+                    }
+                    ToolbarItem(placement: .topBarTrailing) {
+                        Button {
+                            self.isCustomerCenterPresented = true
+                        } label: {
+                            Image(systemName: "person.crop.circle")
+                        }
+                    }
+                }
+        }
+    }
+    .foregroundColor(.white)
+    .sheet(isPresented: $isCustomerCenterPresented) {
+        CustomerCenterView()
+    }
+}
+```
+
+Or you can use the modifier:
+
+```swift
+VStack {
+    Button {
+        self.presentingCustomerCenter = true
+    } label: {
+        TemplateLabel(name: "Customer Center", icon: "person.fill")
+    }
+}
+.presentCustomerCenter(isPresented: self.$presentingCustomerCenter) {
+    self.presentingCustomerCenter = false
+}
+```
+
+### Listening to events
+
+You can listen to events in the Customer Center using the `customerCenterActionHandler` closure:
+
+```swift
+CustomerCenterView { customerCenterAction in
+    switch customerCenterAction {
+    case .restoreStarted:
+    case .restoreFailed(_):
+    case .restoreCompleted(_):
+    case .showingManageSubscriptions:
+    case .refundRequestStarted(_):
+    case .refundRequestCompleted(_):
+    }
+}
+```
+
+or if using the modifier:
+
+```swift
+.presentCustomerCenter(
+    isPresented: self.$presentingCustomerCenter,
+    customerCenterActionHandler: { action in
+        switch action {
+        case .restoreCompleted(let customerInfo):
+        case .restoreStarted:
+        case .restoreFailed(let error):
+        case .showingManageSubscriptions:
+        case .refundRequestStarted(let productId):
+        case .refundRequestCompleted(let status):
+        case .feedbackSurveyCompleted(let surveyOptionID):
+        }
+    }
+) {
+    self.presentingCustomerCenter = false
+}
+```
+
+## Release Notes
+
+### RevenueCatUI SDK
+#### Paywall Components
+##### 🐞 Bugfixes
+* Match text, image, and stack properties and behaviors from dashboard (#4261) via Josh Holtz (@joshdholtz)
+#### Customer Center
+##### 🐞 Bugfixes
+* More customer center docs and fix init (#4304) via Cesar de la Vega (@vegaro)
+* Remove background from FeedbackSurveyView (#4300) via Cesar de la Vega (@vegaro)
+
+#### 🔄 Other Changes
+* Fix iOS 15 tests (#4320) via Cesar de la Vega (@vegaro)
+* Generating new test snapshots for `main` - watchos (#4323) via RevenueCat Git Bot (@RCGitBot)
+* Generating new test snapshots for `main` - macos (#4322) via RevenueCat Git Bot (@RCGitBot)
+* Adds an `onDismiss` callback to `ErrorDisplay` (#4312) via JayShortway (@JayShortway)
+* Added previews for text component, image component, and paywall for template 1 (#4306) via Josh Holtz (@joshdholtz)
+* Remove `CUSTOMER_CENTER_ENABLED` (#4305) via Cesar de la Vega (@vegaro)
+* [Diagnostics] Refactor diagnostics track methods to handle background work automatically (#4270) via Toni Rico (@tonidero)
+* [Diagnostics] Add `apple_products_request` event (#4247) via Toni Rico (@tonidero)
+* Bump webrick from 1.7.0 to 1.8.2 in /Tests/InstallationTests/CocoapodsInstallation (#4313) via dependabot[bot] (@dependabot[bot])
+* Bump fastlane from 2.222.0 to 2.223.1 (#4309) via dependabot[bot] (@dependabot[bot])
+* Bump fastlane-plugin-revenuecat_internal from `55a0455` to `5b2e35c` (#4310) via dependabot[bot] (@dependabot[bot])
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,139 @@
+## 5.5.0
+## 🫂 Customer Center Beta 🫂
+
+This release adds public beta support for the new Customer Center on iOS 15.0+.
+
+This central hub is a self-service section that can be added to your app to help your users manage their subscriptions on their own, reducing the support burden on developers 
+like you so you can spend more time building apps and less time dealing with support issues. We are hoping adding this new section to your app can help you reduce customer support 
+interactions, obtain feedback from your users and ultimately reduce churn by retaining them as subscribers, helping you make more money.
+
+See our [Customer Center documentation](https://www.revenuecat.com/docs/tools/customer-center) for more information.
+
+### Features currently available
+* Users can cancel current subscriptions
+* Users can ask for refunds
+* Users can change their subscription plans
+* Users can restore previous purchases and contact your support email if they have trouble restoring
+* Users will be asked to update their app if they are on an older version before being able to contact your support email
+* Developers can ask for reasons for cancellations or refunds, and automatically offer promo offers to retain users
+* Configuration is done in the RevenueCat dashboard, and advanced configuration is available via JSON
+
+### Limitations
+* Only available on iOS 15+
+* Limited visual configuration options in the dashboard. It is possible to configure the Customer Center via JSON.
+* We are exposing a SwiftUI view and a modifier at the moment. We haven't built a UIKit wrapper to help integrating on UIKit apps, but it's in the roadmap.
+
+### How to enable
+You can use the CustomerCenterView view directly:
+
+```swift
+var body: some View {
+    Group {
+        NavigationStack {
+            HomeView()
+                .navigationTitle("Home")
+                .navigationBarTitleDisplayMode(.inline)
+                .toolbar {
+                    ToolbarItem(placement: .topBarLeading) {
+                        Button {
+                        } label: {
+                            Image(systemName: "line.3.horizontal")
+                        }
+                    }
+                    ToolbarItem(placement: .topBarTrailing) {
+                        Button {
+                            self.isCustomerCenterPresented = true
+                        } label: {
+                            Image(systemName: "person.crop.circle")
+                        }
+                    }
+                }
+        }
+    }
+    .foregroundColor(.white)
+    .sheet(isPresented: $isCustomerCenterPresented) {
+        CustomerCenterView()
+    }
+}
+```
+
+Or you can use the modifier:
+
+```swift
+VStack {
+    Button {
+        self.presentingCustomerCenter = true
+    } label: {
+        TemplateLabel(name: "Customer Center", icon: "person.fill")
+    }
+}
+.presentCustomerCenter(isPresented: self.$presentingCustomerCenter) {
+    self.presentingCustomerCenter = false
+}
+```
+
+### Listening to events
+
+You can listen to events in the Customer Center using the `customerCenterActionHandler` closure:
+
+```swift
+CustomerCenterView { customerCenterAction in
+    switch customerCenterAction {
+    case .restoreStarted:
+    case .restoreFailed(_):
+    case .restoreCompleted(_):
+    case .showingManageSubscriptions:
+    case .refundRequestStarted(_):
+    case .refundRequestCompleted(_):
+    }
+}
+```
+
+or if using the modifier:
+
+```swift
+.presentCustomerCenter(
+    isPresented: self.$presentingCustomerCenter,
+    customerCenterActionHandler: { action in
+        switch action {
+        case .restoreCompleted(let customerInfo):
+        case .restoreStarted:
+        case .restoreFailed(let error):
+        case .showingManageSubscriptions:
+        case .refundRequestStarted(let productId):
+        case .refundRequestCompleted(let status):
+        case .feedbackSurveyCompleted(let surveyOptionID):
+        }
+    }
+) {
+    self.presentingCustomerCenter = false
+}
+```
+
+### Release Notes
+
+### RevenueCatUI SDK
+#### Paywall Components
+##### 🐞 Bugfixes
+* Match text, image, and stack properties and behaviors from dashboard (#4261) via Josh Holtz (@joshdholtz)
+#### Customer Center
+##### 🐞 Bugfixes
+* More customer center docs and fix init (#4304) via Cesar de la Vega (@vegaro)
+* Remove background from FeedbackSurveyView (#4300) via Cesar de la Vega (@vegaro)
+
+#### 🔄 Other Changes
+* Fix iOS 15 tests (#4320) via Cesar de la Vega (@vegaro)
+* Generating new test snapshots for `main` - watchos (#4323) via RevenueCat Git Bot (@RCGitBot)
+* Generating new test snapshots for `main` - macos (#4322) via RevenueCat Git Bot (@RCGitBot)
+* Adds an `onDismiss` callback to `ErrorDisplay` (#4312) via JayShortway (@JayShortway)
+* Added previews for text component, image component, and paywall for template 1 (#4306) via Josh Holtz (@joshdholtz)
+* Remove `CUSTOMER_CENTER_ENABLED` (#4305) via Cesar de la Vega (@vegaro)
+* [Diagnostics] Refactor diagnostics track methods to handle background work automatically (#4270) via Toni Rico (@tonidero)
+* [Diagnostics] Add `apple_products_request` event (#4247) via Toni Rico (@tonidero)
+* Bump webrick from 1.7.0 to 1.8.2 in /Tests/InstallationTests/CocoapodsInstallation (#4313) via dependabot[bot] (@dependabot[bot])
+* Bump fastlane from 2.222.0 to 2.223.1 (#4309) via dependabot[bot] (@dependabot[bot])
+* Bump fastlane-plugin-revenuecat_internal from `55a0455` to `5b2e35c` (#4310) via dependabot[bot] (@dependabot[bot])
+
 ## 5.4.0
 ## RevenueCat SDK
 ### ✨ New Features

diff --git a/RevenueCat.podspec b/RevenueCat.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = "RevenueCat"
-  s.version          = "5.5.0-SNAPSHOT"
+  s.version          = "5.5.0"
   s.summary          = "Subscription and in-app-purchase backend service."
 
   s.description      = <<-DESC

diff --git a/RevenueCatUI.podspec b/RevenueCatUI.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = "RevenueCatUI"
-  s.version          = "5.5.0-SNAPSHOT"
+  s.version          = "5.5.0"
   s.summary          = "UI library for RevenueCat paywalls."
 
   s.description      = <<-DESC

diff --git a/RevenueCatUI/CustomerCenter/View+PresentCustomerCenter.swift b/RevenueCatUI/CustomerCenter/View+PresentCustomerCenter.swift
@@ -16,6 +16,8 @@ import SwiftUI
 
 #if os(iOS)
 
+/// Warning: This is currently in beta and subject to change.
+///
 /// Presentation options to use with the [presentCustomerCenter](x-source-tag://presentCustomerCenter) View modifiers.
 public enum CustomerCenterPresentationMode {
 
@@ -43,6 +45,8 @@ extension CustomerCenterPresentationMode {
 #endif
 extension View {
 
+    /// Warning: This is currently in beta and subject to change.
+    ///
     /// Presents the ``CustomerCenter``.
     /// Example:
     /// ```swift

diff --git a/RevenueCatUI/CustomerCenter/Views/CustomerCenterView.swift b/RevenueCatUI/CustomerCenter/Views/CustomerCenterView.swift
@@ -18,6 +18,8 @@ import SwiftUI
 
 #if os(iOS)
 
+/// Warning: This is currently in beta and ubject to change.
+///
 /// A SwiftUI view for displaying a customer support common tasks
 @available(iOS 15.0, *)
 @available(macOS, unavailable)

diff --git a/Sources/Misc/SystemInfo.swift b/Sources/Misc/SystemInfo.swift
@@ -75,7 +75,7 @@ class SystemInfo {
     }
 
     static var frameworkVersion: String {
-        return "5.5.0-SNAPSHOT"
+        return "5.5.0"
     }
 
     static var systemVersion: String {

diff --git a/scripts/docs/index.html b/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/5.4.0/documentation/revenuecat"/>
+    <meta http-equiv="refresh" content="0; url=https://revenuecat.github.io/purchases-ios-docs/5.5.0/documentation/revenuecat"/>
 </head>
 <body>
 </body>

diff --git a/scripts/docs/v4_api_migration_guide.html b/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/5.5.0-SNAPSHOT/documentation/revenuecat/v4_api_migration_guide"/>
+    <meta http-equiv="refresh" content="0; url=https://revenuecat.github.io/purchases-ios-docs/5.5.0/documentation/revenuecat/v4_api_migration_guide"/>
 </head>
 <body>
 </body>

diff --git a/scripts/docs/v5_api_migration_guide.html b/scripts/docs/v5_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/5.5.0-SNAPSHOT/documentation/revenuecat/v5_api_migration_guide"/>
+    <meta http-equiv="refresh" content="0; url=https://revenuecat.github.io/purchases-ios-docs/5.5.0/documentation/revenuecat/v5_api_migration_guide"/>
 </head>
 <body>
 </body>
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,7 +2,7 @@ @@
     <!DOCTYPE html>
     <html>
     <head>
-        <meta http-equiv="refresh" content="0; url=https://revenuecat.github.io/purchases-ios-docs/5.4.0/documentation/revenuecat"/>
+        <meta http-equiv="refresh" content="0; url=https://revenuecat.github.io/purchases-ios-docs/5.5.0/documentation/revenuecat"/>
     </head>
     <body>
     </body>
@@ Expand Down @@