ButtonComponent can dismiss the paywall

RevenueCat.xcodeproj/project.pbxproj

@@ -670,6 +670,9 @@
 		57FFD2522922DBED00A9A878 /* MockStoreTransaction.swift in Sources */ = {isa = PBXBuildFile; fileRef = 57FFD2502922DBED00A9A878 /* MockStoreTransaction.swift */; };
 		6E38843A0CAFD551013D0A3F /* StoreProduct.swift in Sources */ = {isa = PBXBuildFile; fileRef = FECF627761D375C8431EB866 /* StoreProduct.swift */; };
 		7706ED3E2C6E374D0004B9F9 /* ButtonStyles.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7706ED3D2C6E374D0004B9F9 /* ButtonStyles.swift */; };
+		7707A94C2CAD93AC006E0313 /* PaywallButtonComponent.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7707A94B2CAD93AC006E0313 /* PaywallButtonComponent.swift */; };
+		7707A94E2CAD94D2006E0313 /* ButtonComponentViewModel.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7707A94D2CAD94D2006E0313 /* ButtonComponentViewModel.swift */; };
+		7707A9502CAD9775006E0313 /* ButtonComponentView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7707A94F2CAD9775006E0313 /* ButtonComponentView.swift */; };
 		77372D992C6F8C7B008E59D3 /* AppUpdateWarningView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 77372D982C6F8C7B008E59D3 /* AppUpdateWarningView.swift */; };
 		77791ECF2C6B852000BCEF03 /* SemanticVersion.swift in Sources */ = {isa = PBXBuildFile; fileRef = 77791ECE2C6B851F00BCEF03 /* SemanticVersion.swift */; };
 		777FB4882C661C0600CD4749 /* SemanticVersionTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 777FB4872C661C0600CD4749 /* SemanticVersionTests.swift */; };
@@ -1820,6 +1823,9 @@
 		57FFD2502922DBED00A9A878 /* MockStoreTransaction.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MockStoreTransaction.swift; sourceTree = "<group>"; };
 		7706ED3D2C6E374D0004B9F9 /* ButtonStyles.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ButtonStyles.swift; sourceTree = "<group>"; };
 		7707A93B2CAD8AA2006E0313 /* Local.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = Local.xcconfig; sourceTree = "<group>"; };
+		7707A94B2CAD93AC006E0313 /* PaywallButtonComponent.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PaywallButtonComponent.swift; sourceTree = "<group>"; };
+		7707A94D2CAD94D2006E0313 /* ButtonComponentViewModel.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ButtonComponentViewModel.swift; sourceTree = "<group>"; };
+		7707A94F2CAD9775006E0313 /* ButtonComponentView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ButtonComponentView.swift; sourceTree = "<group>"; };
 		77372D982C6F8C7B008E59D3 /* AppUpdateWarningView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AppUpdateWarningView.swift; sourceTree = "<group>"; };
 		77607FD72CAD87D60066C23C /* Global.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = Global.xcconfig; sourceTree = "<group>"; };
 		77791ECE2C6B851F00BCEF03 /* SemanticVersion.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SemanticVersion.swift; sourceTree = "<group>"; };
@@ -3914,6 +3920,15 @@
 			path = Security;
 			sourceTree = "<group>";
 		};
+		7707A94A2CAD936A006E0313 /* Button */ = {
+			isa = PBXGroup;
+			children = (
+				7707A94D2CAD94D2006E0313 /* ButtonComponentViewModel.swift */,
+				7707A94F2CAD9775006E0313 /* ButtonComponentView.swift */,
+			);
+			path = Button;
+			sourceTree = "<group>";
+		};
 		887A5FBB2C1D036200E1A461 /* RevenueCatUIDev */ = {
 			isa = PBXGroup;
 			children = (
@@ -4270,6 +4285,7 @@
 			isa = PBXGroup;
 			children = (
 				88AD01012C740CF400AA1F2B /* PaywallComponentBase.swift */,
+				7707A94B2CAD93AC006E0313 /* PaywallButtonComponent.swift */,
 				88EA80EE2C87D68F003E6675 /* PaywallComponentLocalization.swift */,
 				88B1BAD72C812D72001B7EE5 /* PaywallComponentPropertyTypes.swift */,
 				88AD01032C740CF400AA1F2B /* PaywallImageComponent.swift */,
@@ -4284,6 +4300,7 @@
 		88AD01352C74196600AA1F2B /* Components */ = {
 			isa = PBXGroup;
 			children = (
+				7707A94A2CAD936A006E0313 /* Button */,
 				2C2AEB0D2CA64DA900A50F38 /* Previews */,
 				88B1BAE62C813A3C001B7EE5 /* Image */,
 				88B1BAE22C813A3C001B7EE5 /* LinkButton */,
@@ -5512,6 +5529,7 @@
 				B32B74FF26868AEB005647BF /* Package.swift in Sources */,
 				353756522C382BC700A1B8D6 /* PreferredLocalesProvider.swift in Sources */,
 				35D159CF2BC43B89004D8061 /* DiagnosticsSynchronizer.swift in Sources */,
+				7707A94C2CAD93AC006E0313 /* PaywallButtonComponent.swift in Sources */,
 				578DAA482948EEAD001700FD /* Clock.swift in Sources */,
 				2DDF41B324F6F387005BC22D /* InAppPurchaseBuilder.swift in Sources */,
 				4F4FF3E12A3B731A0028018C /* ETagStrings.swift in Sources */,
@@ -5975,6 +5993,7 @@
 				887A60702C1D037000E1A461 /* PaywallTemplate.swift in Sources */,
 				887A60882C1D037000E1A461 /* MockPurchases.swift in Sources */,
 				887A60BC2C1D037000E1A461 /* Template5View.swift in Sources */,
+				7707A9502CAD9775006E0313 /* ButtonComponentView.swift in Sources */,
 				887A60BE2C1D037000E1A461 /* PaywallFooterViewController.swift in Sources */,
 				887A608A2C1D037000E1A461 /* PurchaseHandler.swift in Sources */,
 				2D2AFE8D2C6A834D00D1B0B4 /* TestData.swift in Sources */,
@@ -6065,6 +6084,7 @@
 				887A60BF2C1D037000E1A461 /* PaywallViewController.swift in Sources */,
 				887A60772C1D037000E1A461 /* TemplateViewConfiguration+Images.swift in Sources */,
 				3537566A2C382C2800A1B8D6 /* ManageSubscriptionsViewModel.swift in Sources */,
+				7707A94E2CAD94D2006E0313 /* ButtonComponentViewModel.swift in Sources */,
 				887A60842C1D037000E1A461 /* ConsistentPackageContentView.swift in Sources */,
 				887A60C42C1D037000E1A461 /* IconView.swift in Sources */,
 				887A60732C1D037000E1A461 /* ProcessedLocalizedConfiguration.swift in Sources */,

RevenueCatUI/Data/Strings.swift

@@ -55,6 +55,7 @@ enum Strings {
     case paywall_view_model_construction_failed(Error)
     case paywall_contains_no_localization_data
     case paywall_could_not_find_localization(String)
+    case paywall_invalid_url(String)
 
     // Customer Center
     case could_not_find_subscription_information
@@ -165,6 +166,9 @@ extension Strings: CustomStringConvertible {
         case .paywall_contains_no_localization_data:
             return "Paywall contains no localization data."
 
+        case .paywall_invalid_url(let urlLid):
+            return "No valid URL is configured for \(urlLid)"
+
         case .invalid_color_string(let colorString):
             return "Invalid hex color string: \(colorString)"
 

RevenueCatUI/PaywallView.swift

@@ -242,7 +242,17 @@ public struct PaywallView: View {
 
         #if PAYWALL_COMPONENTS
         if let componentData = offering.paywallComponentsData {
-            TemplateComponentsView(paywallComponentsData: componentData, offering: offering)
+            TemplateComponentsView(
+                paywallComponentsData: componentData,
+                offering: offering,
+                onDismiss: {
+                    guard let onRequestedDismissal = self.onRequestedDismissal else {
+                        self.dismiss()
+                        return
+                    }
+                    onRequestedDismissal()
+                }
+            )
         } else {
 
             let (paywall, displayedLocale, template, error) = offering.validatedPaywall(locale: self.locale)

RevenueCatUI/Templates/Components/Button/ButtonComponentView.swift

@@ -0,0 +1,149 @@
+//
+//  Copyright RevenueCat Inc. All Rights Reserved.
+//
+//  Licensed under the MIT License (the "License");
+//  you may not use this file except in compliance with the License.
+//  You may obtain a copy of the License at
+//
+//      https://opensource.org/licenses/MIT
+//
+//  ButtonComponentView.swift
+//
+//  Created by Jay Shortway on 02/10/2024.
+
+import Foundation
+import RevenueCat
+#if canImport(SafariServices)
+import SafariServices
+#endif
+import SwiftUI
+
+#if PAYWALL_COMPONENTS
+
+@available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, *)
+struct ButtonComponentView: View {
+    @Environment(\.openURL) var openURL
+    @State private var inAppBrowserURL: URL?
+
+    private let viewModel: ButtonComponentViewModel
+    private let onDismiss: () -> Void
+
+    internal init(viewModel: ButtonComponentViewModel, onDismiss: @escaping () -> Void) {
+        self.viewModel = viewModel
+        self.onDismiss = onDismiss
+    }
+
+    var body: some View {
+        Button(
+            action: { onClick() },
+            label: { StackComponentView(viewModel: viewModel.stackViewModel, onDismiss: self.onDismiss) }
+        ).sheet(isPresented: .isNotNil($inAppBrowserURL)) {
+            SafariView(url: inAppBrowserURL!)
+        }
+    }
+
+    private func onClick() {
+        switch viewModel.component.action {
+        case .restorePurchases:
+            // swiftlint:disable:next todo
+            // TODO handle restoring purchases
+            break
+        case .navigateTo(let destination):
+            navigateTo(destination: destination)
+        case .navigateBack:
+            onDismiss()
+        }
+    }
+
+    private func navigateTo(destination: PaywallComponent.ButtonComponent.Destination) {
+        switch destination {
+        case .customerCenter:
+            // swiftlint:disable:next todo
+            // TODO handle navigating to customer center
+            break
+        case .URL(let urlLid, let method),
+                .privacyPolicy(let urlLid, let method),
+                .terms(let urlLid, let method):
+            navigateToUrl(urlLid: urlLid, method: method)
+        }
+    }
+
+    private func navigateToUrl(urlLid: String, method: PaywallComponent.ButtonComponent.URLMethod) {
+        guard let urlString = try? viewModel.localizedStrings.string(key: urlLid),
+        let url = URL(string: urlString) else {
+            Logger.error(Strings.paywall_invalid_url(urlLid))
+            return
+        }
+
+        switch method {
+        case .inAppBrowser:
+#if os(tvOS)
+            // There's no SafariServices on tvOS, so we're falling back to opening in an external browser.
+            openURL(url)
+#else
+            inAppBrowserURL = url
+#endif
+        case .externalBrowser,
+                .deepLink:
+            openURL(url)
+        }
+    }
+
+}
+
+private struct SafariView: UIViewControllerRepresentable {
+    let url: URL
+
+    func makeUIViewController(context: UIViewControllerRepresentableContext<SafariView>) -> SFSafariViewController {
+        SFSafariViewController(url: url)
+    }
+
+    func updateUIViewController(
+        _ uiViewController: SFSafariViewController,
+        context: UIViewControllerRepresentableContext<SafariView>
+    ) {
+        // No updates needed
+    }
+}
+
+#if DEBUG
+
+@available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, *)
+struct ButtonComponentView_Previews: PreviewProvider {
+
+    static var previews: some View {
+        VStack {
+            ButtonComponentView(
+                // swiftlint:disable:next force_try
+                viewModel: try! .init(
+                    component: .init(
+                        action: .navigateBack,
+                        stack: .init(
+                            components: [
+                                PaywallComponent.text(
+                                    PaywallComponent.TextComponent(
+                                        textLid: "buttonText",
+                                        color: .init(light: "#000000")
+                                    )
+                                )
+                            ],
+                            backgroundColor: nil
+                        )
+                    ),
+                    locale: Locale(identifier: "en_US"),
+                    localizedStrings: [
+                        "buttonText": PaywallComponentsData.LocalizationData.string("Do something")
+                    ],
+                    offering: Offering(identifier: "", serverDescription: "", availablePackages: [])
+                ),
+                onDismiss: { }
+            )
+        }
+        .previewLayout(.fixed(width: 400, height: 400))
+        .previewDisplayName("Default")
+    }
+}
+
+#endif
+
+#endif

RevenueCatUI/Templates/Components/Button/ButtonComponentViewModel.swift

@@ -0,0 +1,46 @@
+//
+//  Copyright RevenueCat Inc. All Rights Reserved.
+//
+//  Licensed under the MIT License (the "License");
+//  you may not use this file except in compliance with the License.
+//  You may obtain a copy of the License at
+//
+//      https://opensource.org/licenses/MIT
+//
+//  ButtonComponentViewModel.swift
+//
+//  Created by Jay Shortway on 02/10/2024.
+//
+// swiftlint:disable missing_docs
+
+import Foundation
+import RevenueCat
+
+#if PAYWALL_COMPONENTS
+
+@available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, *)
+public class ButtonComponentViewModel {
+
+    internal let component: PaywallComponent.ButtonComponent
+    internal let localizedStrings: PaywallComponent.LocalizationDictionary
+    let stackViewModel: StackComponentViewModel
+
+    init(
+        component: PaywallComponent.ButtonComponent,
+        locale: Locale,
+        localizedStrings: PaywallComponent.LocalizationDictionary,
+        offering: Offering
+    ) throws {
+        self.component = component
+        self.localizedStrings = localizedStrings
+        self.stackViewModel = try StackComponentViewModel(
+            locale: locale,
+            component: component.stack,
+            localizedStrings: localizedStrings,
+            offering: offering
+        )
+    }
+
+}
+
+#endif

RevenueCatUI/Templates/Components/PaywallComponentViewModel.swift

@@ -19,6 +19,7 @@ enum PaywallComponentViewModel {
     case spacer(SpacerComponentViewModel)
     case stack(StackComponentViewModel)
     case linkButton(LinkButtonComponentViewModel)
+    case button(ButtonComponentViewModel)
 
 }
 
@@ -55,6 +56,15 @@ extension PaywallComponent {
                 try LinkButtonComponentViewModel(component: component,
                                                  localizedStrings: localizedStrings)
             )
+        case .button(let component):
+            return .button(
+                try ButtonComponentViewModel(
+                    component: component,
+                    locale: locale,
+                    localizedStrings: localizedStrings,
+                    offering: offering
+                )
+            )
         }
     }
 

RevenueCatUI/Templates/Components/Previews/Template1Preview.swift

@@ -111,7 +111,8 @@ struct Template1Preview_Previews: PreviewProvider {
             paywallComponentsData: Template1Preview.data,
             offering: .init(identifier: "",
                             serverDescription: "",
-                            availablePackages: [])
+                            availablePackages: []),
+            onDismiss: { }
         )
         .previewLayout(.fixed(width: 400, height: 800))
         .previewDisplayName("Template 1")

RevenueCatUI/Templates/Components/Stack/StackComponentView.swift

@@ -20,6 +20,7 @@ import SwiftUI
 struct StackComponentView: View {
 
     let viewModel: StackComponentViewModel
+    let onDismiss: () -> Void
 
     var body: some View {
         Group {
@@ -28,17 +29,17 @@ struct StackComponentView: View {
                 // LazyVStack needed for performance when loading
                 LazyVStack(spacing: viewModel.spacing) {
                     Group {
-                        ComponentsView(componentViewModels: self.viewModel.viewModels)
+                        ComponentsView(componentViewModels: self.viewModel.viewModels, onDismiss: self.onDismiss)
                     }
                     .frame(maxWidth: .infinity, alignment: horizontalAlignment.stackAlignment)
                 }
             case .horizontal(let verticalAlignment):
                 HStack(alignment: verticalAlignment.stackAlignment, spacing: viewModel.spacing) {
-                    ComponentsView(componentViewModels: self.viewModel.viewModels)
+                    ComponentsView(componentViewModels: self.viewModel.viewModels, onDismiss: self.onDismiss)
                 }
             case .zlayer(let alignment):
                 ZStack(alignment: alignment.stackAlignment) {
-                    ComponentsView(componentViewModels: self.viewModel.viewModels)
+                    ComponentsView(componentViewModels: self.viewModel.viewModels, onDismiss: self.onDismiss)
                 }
             }
         }