RefactorUI: Clean API Architecture (#682)

facumenzella · vegaro · web-flow · commit 5833fa692dbe · 2025-10-03T16:32:59.000+02:00
Co-authored-by: Cesar de la Vega &lt;664544+vegaro@users.noreply.github.com&gt;
diff --git a/RevenueCatUI/Scripts/IPaywallPresenter.cs b/RevenueCatUI/Scripts/IPaywallPresenter.cs
@@ -1,6 +1,6 @@
 using System.Threading.Tasks;
 
-namespace RevenueCat.UI
+namespace RevenueCatUI.Internal
 {
     /// <summary>
     /// Internal interface for presenting paywalls.
@@ -13,15 +13,15 @@ internal interface IPaywallPresenter
         /// </summary>
         /// <param name="options">Paywall presentation options</param>
         /// <returns>Result of the paywall presentation</returns>
-        Task<PaywallResult> PresentPaywallAsync(PaywallOptions options);
+        Task<RevenueCatUI.PaywallResult> PresentPaywallAsync(RevenueCatUI.PaywallOptions options);
 
         /// <summary>
         /// Presents a paywall only if the user does not have the specified entitlement.
         /// </summary>
         /// <param name="requiredEntitlementIdentifier">Required entitlement identifier</param>
         /// <param name="options">Paywall presentation options</param>
         /// <returns>Result of the paywall presentation</returns>
-        Task<PaywallResult> PresentPaywallIfNeededAsync(string requiredEntitlementIdentifier, PaywallOptions options);
+        Task<RevenueCatUI.PaywallResult> PresentPaywallIfNeededAsync(string requiredEntitlementIdentifier, RevenueCatUI.PaywallOptions options);
 
         /// <summary>
         /// Whether paywall presentation is supported on this platform.
diff --git a/RevenueCatUI/Scripts/PaywallOptions.cs b/RevenueCatUI/Scripts/PaywallOptions.cs
@@ -1,6 +1,6 @@
 using System;
 
-namespace RevenueCat.UI
+namespace RevenueCatUI
 {
     /// <summary>
     /// Options for configuring paywall presentation.
diff --git a/RevenueCatUI/Scripts/PaywallPresenter.cs b/RevenueCatUI/Scripts/PaywallPresenter.cs
@@ -1,7 +1,7 @@
 using System.Threading.Tasks;
 using UnityEngine;
 
-namespace RevenueCat.UI
+namespace RevenueCatUI.Internal
 {
     /// <summary>
     /// Platform-agnostic factory for paywall presenters.
@@ -43,16 +43,16 @@ private static IPaywallPresenter CreatePlatformPresenter()
     /// </summary>
     internal class UnsupportedPaywallPresenter : IPaywallPresenter
     {
-        public Task<PaywallResult> PresentPaywallAsync(PaywallOptions options)
+        public Task<RevenueCatUI.PaywallResult> PresentPaywallAsync(RevenueCatUI.PaywallOptions options)
         {
             Debug.LogWarning("[RevenueCatUI] Paywall presentation is not supported on this platform.");
-            return Task.FromResult(PaywallResult.Error);
+            return Task.FromResult(RevenueCatUI.PaywallResult.Error);
         }
 
-        public Task<PaywallResult> PresentPaywallIfNeededAsync(string requiredEntitlementIdentifier, PaywallOptions options)
+        public Task<RevenueCatUI.PaywallResult> PresentPaywallIfNeededAsync(string requiredEntitlementIdentifier, RevenueCatUI.PaywallOptions options)
         {
             Debug.LogWarning("[RevenueCatUI] Paywall presentation is not supported on this platform.");
-            return Task.FromResult(PaywallResult.Error);
+            return Task.FromResult(RevenueCatUI.PaywallResult.Error);
         }
 
         public bool IsSupported()
diff --git a/RevenueCatUI/Scripts/PaywallResult.cs b/RevenueCatUI/Scripts/PaywallResult.cs
@@ -1,6 +1,6 @@
 using System;
 
-namespace RevenueCat.UI
+namespace RevenueCatUI
 {
     /// <summary>
     /// Represents the result of a paywall presentation.
diff --git a/RevenueCatUI/Scripts/PaywallsBehaviour.cs b/RevenueCatUI/Scripts/PaywallsBehaviour.cs
@@ -0,0 +1,42 @@
+using System.Threading.Tasks;
+using UnityEngine;
+
+namespace RevenueCatUI
+{
+    /// <summary>
+    /// MonoBehaviour helper that forwards to the static PaywallsPresenter API so paywalls can be driven from scenes.
+    /// </summary>
+    public class PaywallsBehaviour : MonoBehaviour
+    {
+        /// <summary>
+        /// Presents a paywall configured in the RevenueCat dashboard.
+        /// </summary>
+        /// <param name="options">Options for presenting the paywall.</param>
+        /// <returns>A <see cref="PaywallResult"/> describing the outcome.</returns>
+        public async Task<PaywallResult> PresentPaywall(PaywallOptions options = null)
+        {
+            return await PaywallsPresenter.Present(options);
+        }
+
+        /// <summary>
+        /// Presents a paywall only if the user does not have the specified entitlement.
+        /// </summary>
+        /// <param name="requiredEntitlementIdentifier">Entitlement identifier to check before presenting.</param>
+        /// <param name="options">Options for presenting the paywall.</param>
+        /// <returns>A <see cref="PaywallResult"/> describing the outcome.</returns>
+        public async Task<PaywallResult> PresentPaywallIfNeeded(string requiredEntitlementIdentifier, PaywallOptions options = null)
+        {
+            return await PaywallsPresenter.PresentIfNeeded(requiredEntitlementIdentifier, options);
+        }
+
+        /// <summary>
+        /// Checks if the Paywall UI is available on the current platform.
+        /// Returns true on iOS/Android device builds when paywall is supported; otherwise false.
+        /// </summary>
+        /// <returns>True if UI is supported on this platform, otherwise false.</returns>
+        public bool IsSupported()
+        {
+            return PaywallsPresenter.IsSupported();
+        }
+    }
+}
diff --git a/RevenueCatUI/Scripts/PaywallsBehaviour.cs.meta b/RevenueCatUI/Scripts/PaywallsBehaviour.cs.meta
diff --git a/RevenueCatUI/Scripts/Platforms/Android/AndroidPaywallPresenter.cs b/RevenueCatUI/Scripts/Platforms/Android/AndroidPaywallPresenter.cs
@@ -3,8 +3,9 @@
 using System.Threading.Tasks;
 using UnityEngine;
 using UnityEngine.Android;
+using RevenueCatUI.Internal;
 
-namespace RevenueCat.UI.Platforms
+namespace RevenueCatUI.Platforms
 {
     internal class AndroidPaywallPresenter : IPaywallPresenter
     {
diff --git a/RevenueCatUI/Scripts/Platforms/iOS/IOSPaywallPresenter.cs b/RevenueCatUI/Scripts/Platforms/iOS/IOSPaywallPresenter.cs
@@ -2,8 +2,9 @@
 using System;
 using System.Runtime.InteropServices;
 using System.Threading.Tasks;
+using RevenueCatUI.Internal;
 
-namespace RevenueCat.UI.Platforms
+namespace RevenueCatUI.Platforms
 {
     internal class IOSPaywallPresenter : IPaywallPresenter
     {
diff --git a/RevenueCatUI/Scripts/UI.cs b/RevenueCatUI/Scripts/UI.cs
@@ -1,22 +1,23 @@
 using System;
 using System.Threading.Tasks;
 using UnityEngine;
+using RevenueCatUI.Internal;
 
-namespace RevenueCat.UI
+namespace RevenueCatUI
 {
     /// <summary>
-    /// Main interface for RevenueCat UI components.
+    /// Main interface for RevenueCatUI paywall presentation.
     /// Provides static methods to present paywalls.
     /// </summary>
-    public static class RevenueCatUI
+    public static class PaywallsPresenter
     {
         
         /// <summary>
         /// Presents a paywall configured in the RevenueCat dashboard.
         /// </summary>
         /// <param name="options">Options for presenting the paywall</param>
         /// <returns>A PaywallResult indicating what happened during the paywall presentation</returns>
-        public static async Task<PaywallResult> PresentPaywall(PaywallOptions options = null)
+        public static async Task<PaywallResult> Present(PaywallOptions options = null)
         {
             try 
             {
@@ -38,7 +39,7 @@ public static async Task<PaywallResult> PresentPaywall(PaywallOptions options =
         /// <param name="requiredEntitlementIdentifier">Entitlement identifier to check before presenting</param>
         /// <param name="options">Options for presenting the paywall</param>
         /// <returns>A PaywallResult indicating what happened during the paywall presentation</returns>
-        public static async Task<PaywallResult> PresentPaywallIfNeeded(
+        public static async Task<PaywallResult> PresentIfNeeded(
             string requiredEntitlementIdentifier, 
             PaywallOptions options = null)
         {
diff --git a/RevenueCatUI/Scripts/UI.cs.meta b/RevenueCatUI/Scripts/UI.cs.meta
diff --git a/RevenueCatUI/Scripts/revenuecat.purchases-unity-ui.asmdef b/RevenueCatUI/Scripts/revenuecat.purchases-unity-ui.asmdef
@@ -1,6 +1,6 @@
 {
     "name": "revenuecat.purchases-unity-ui",
-    "rootNamespace": "RevenueCat.UI",
+    "rootNamespace": "RevenueCatUI",
     "references": [
         "revenuecat.purchases-unity"
     ],
diff --git a/Subtester/Assets/Scripts/PurchasesListener.cs b/Subtester/Assets/Scripts/PurchasesListener.cs
@@ -5,7 +5,6 @@
 using UnityEngine;
 using UnityEngine.Events;
 using UnityEngine.UI;
-using RevenueCat.UI;
 
 public class PurchasesListener : Purchases.UpdatedCustomerInfoListener
 {
@@ -231,7 +230,7 @@ void PresentPaywallIfNeeded()
 
     private System.Collections.IEnumerator PresentPaywallCoroutine()
     {
-        var task = RevenueCat.UI.RevenueCatUI.PresentPaywall();
+        var task = RevenueCatUI.PaywallsPresenter.Present();
         while (!task.IsCompleted) { yield return null; }
 
         var result = task.Result;
@@ -241,8 +240,8 @@ private System.Collections.IEnumerator PresentPaywallCoroutine()
         {
             string status = GetPaywallResultStatus(result);
 
-            if (result.Result == RevenueCat.UI.PaywallResultType.Purchased || 
-                result.Result == RevenueCat.UI.PaywallResultType.Restored)
+            if (result.Result == RevenueCatUI.PaywallResultType.Purchased || 
+                result.Result == RevenueCatUI.PaywallResultType.Restored)
             {
                 GetComponent<Purchases>().GetCustomerInfo((customerInfo, error) => {
                     if (error != null)
@@ -264,12 +263,12 @@ private System.Collections.IEnumerator PresentPaywallCoroutine()
 
     private System.Collections.IEnumerator PresentPaywallWithOptionsCoroutine()
     {
-        var options = new RevenueCat.UI.PaywallOptions
+        var options = new RevenueCatUI.PaywallOptions
         {
             DisplayCloseButton = false
         };
 
-        var task = RevenueCat.UI.RevenueCatUI.PresentPaywall(options);
+        var task = RevenueCatUI.PaywallsPresenter.Present(options);
         while (!task.IsCompleted) { yield return null; }
 
         var result = task.Result;
@@ -327,15 +326,15 @@ private System.Collections.IEnumerator PresentPaywallForOfferingCoroutine()
         }
 
         // Create options with specific offering
-        var options = new RevenueCat.UI.PaywallOptions
+        var options = new RevenueCatUI.PaywallOptions
         {
             OfferingIdentifier = offeringId,
             DisplayCloseButton = true
         };
 
         Debug.Log($"Subtester: Presenting paywall for offering: {options.OfferingIdentifier}");
 
-        var task = RevenueCat.UI.RevenueCatUI.PresentPaywall(options);
+        var task = RevenueCatUI.PaywallsPresenter.Present(options);
         while (!task.IsCompleted) { yield return null; }
 
         var result = task.Result;
@@ -393,7 +392,7 @@ private System.Collections.IEnumerator PresentPaywallIfNeededCoroutine()
         }
 
         // Create options for the test
-        var options = new RevenueCat.UI.PaywallOptions
+        var options = new RevenueCatUI.PaywallOptions
         {
             OfferingIdentifier = offeringId,
             DisplayCloseButton = true // Test with close button enabled
@@ -404,7 +403,7 @@ private System.Collections.IEnumerator PresentPaywallIfNeededCoroutine()
 
         Debug.Log($"Subtester: Testing presentPaywallIfNeeded for entitlement: {testEntitlement}, offering: {options.OfferingIdentifier}");
 
-        var task = RevenueCat.UI.RevenueCatUI.PresentPaywallIfNeeded(testEntitlement, options);
+        var task = RevenueCatUI.PaywallsPresenter.PresentIfNeeded(testEntitlement, options);
         while (!task.IsCompleted) { yield return null; }
 
         var result = task.Result;
@@ -414,27 +413,27 @@ private System.Collections.IEnumerator PresentPaywallIfNeededCoroutine()
         {
             var status = GetPaywallResultStatus(result);
             var message = $"PaywallIfNeeded for '{testEntitlement}' result: {status}";
-            if (result.Result == RevenueCat.UI.PaywallResultType.NotPresented)
+            if (result.Result == RevenueCatUI.PaywallResultType.NotPresented)
             {
                 message += " (User already has entitlement)";
             }
             infoLabel.text = message;
         }
     }
 
-    private string GetPaywallResultStatus(RevenueCat.UI.PaywallResult result)
+    private string GetPaywallResultStatus(RevenueCatUI.PaywallResult result)
     {
         switch (result.Result)
         {
-            case RevenueCat.UI.PaywallResultType.Purchased:
+            case RevenueCatUI.PaywallResultType.Purchased:
                 return "PURCHASED - User completed a purchase";
-            case RevenueCat.UI.PaywallResultType.Restored:
+            case RevenueCatUI.PaywallResultType.Restored:
                 return "RESTORED - User restored previous purchases";
-            case RevenueCat.UI.PaywallResultType.Cancelled:
+            case RevenueCatUI.PaywallResultType.Cancelled:
                 return "CANCELLED - User dismissed the paywall";
-            case RevenueCat.UI.PaywallResultType.Error:
+            case RevenueCatUI.PaywallResultType.Error:
                 return "ERROR - An error occurred during paywall";
-            case RevenueCat.UI.PaywallResultType.NotPresented:
+            case RevenueCatUI.PaywallResultType.NotPresented:
                 return "NOT PRESENTED - Paywall was not needed";
             default:
                 return $"UNKNOWN - Received: {result}";

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`using System;`
`2`	`2`
`3`		`-namespace RevenueCat.UI`
	`3`	`+namespace RevenueCatUI`
`4`	`4`	`{`
`5`	`5`	`/// <summary>`
`6`	`6`	`/// Options for configuring paywall presentation.`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`using System.Threading.Tasks;`
`2`	`2`	`using UnityEngine;`
`3`	`3`
`4`		`-namespace RevenueCat.UI`
	`4`	`+namespace RevenueCatUI.Internal`
`5`	`5`	`{`
`6`	`6`	`/// <summary>`
`7`	`7`	`/// Platform-agnostic factory for paywall presenters.`
`@@ -43,16 +43,16 @@ private static IPaywallPresenter CreatePlatformPresenter()`
`43`	`43`	`/// </summary>`
`44`	`44`	`internal class UnsupportedPaywallPresenter : IPaywallPresenter`
`45`	`45`	`{`
`46`		`- public Task<PaywallResult> PresentPaywallAsync(PaywallOptions options)`
	`46`	`+ public Task<RevenueCatUI.PaywallResult> PresentPaywallAsync(RevenueCatUI.PaywallOptions options)`
`47`	`47`	`{`
`48`	`48`	`Debug.LogWarning("[RevenueCatUI] Paywall presentation is not supported on this platform.");`
`49`		`- return Task.FromResult(PaywallResult.Error);`
	`49`	`+ return Task.FromResult(RevenueCatUI.PaywallResult.Error);`
`50`	`50`	`}`
`51`	`51`
`52`		`- public Task<PaywallResult> PresentPaywallIfNeededAsync(string requiredEntitlementIdentifier, PaywallOptions options)`
	`52`	`+ public Task<RevenueCatUI.PaywallResult> PresentPaywallIfNeededAsync(string requiredEntitlementIdentifier, RevenueCatUI.PaywallOptions options)`
`53`	`53`	`{`
`54`	`54`	`Debug.LogWarning("[RevenueCatUI] Paywall presentation is not supported on this platform.");`
`55`		`- return Task.FromResult(PaywallResult.Error);`
	`55`	`+ return Task.FromResult(RevenueCatUI.PaywallResult.Error);`
`56`	`56`	`}`
`57`	`57`
`58`	`58`	`public bool IsSupported()`
Original file line number	Diff line number	Diff line change
`@@ -3,8 +3,9 @@`
`3`	`3`	`using System.Threading.Tasks;`
`4`	`4`	`using UnityEngine;`
`5`	`5`	`using UnityEngine.Android;`
	`6`	`+using RevenueCatUI.Internal;`
`6`	`7`
`7`		`-namespace RevenueCat.UI.Platforms`
	`8`	`+namespace RevenueCatUI.Platforms`
`8`	`9`	`{`
`9`	`10`	`internal class AndroidPaywallPresenter : IPaywallPresenter`
`10`	`11`	`{`
Original file line number	Diff line number	Diff line change
`@@ -2,8 +2,9 @@`
`2`	`2`	`using System;`
`3`	`3`	`using System.Runtime.InteropServices;`
`4`	`4`	`using System.Threading.Tasks;`
	`5`	`+using RevenueCatUI.Internal;`
`5`	`6`
`6`		`-namespace RevenueCat.UI.Platforms`
	`7`	`+namespace RevenueCatUI.Platforms`
`7`	`8`	`{`
`8`	`9`	`internal class IOSPaywallPresenter : IPaywallPresenter`
`9`	`10`	`{`