com.amanotes.gdk 0.2.81-a4 → 0.2.81-alpha.11

package/CHANGELOG.md

@@ -1,14 +1,3 @@
-# Changelog
-
-## [0.2.81-a4] - 2024-11-21
-- [Dev] Add GDKPostBuild for iOS
-- [Dev] Improve GDK editor experience before config asset imported
-- [Dev] Analytics save file in async
-- [Dev] Move GDKFileUtils to a separated file
-- [Dev] Update game ops model
-- [Dev] Add ABLab
-- [Dev] Move imported GDK Adapter from RawData to Modules
-
 ## [0.2.80] - 2024-11-13
 - [Dev] Don't use obsolete functions
 - [Dev] Add CrashlyticHook
@@ -23,7 +12,6 @@
 - [Dev] Track Adapters and Third-party packages used in games
 
 ## [0.2.77] - 2024-11-07
-- [Release] 0.2.76
 - [Dev] Remove GDKAudio
 - [Dev] Handle format exception in RemoteConfig
 - [Dev] Handle exception of FetchConfig

package/Editor/Extra/GDKCIBuildCommand.cs

@@ -17,22 +17,27 @@ namespace Amanotes.Core
         private const string KEY_ALIAS_NAME = "KEY_ALIAS_NAME";
         private const string KEYSTORE = "keystore.keystore";
         private const string BUILD_OPTIONS_ENV_VAR = "BuildOptions";
-        private const string ANDROID_BUNDLE_VERSION_CODE = "VERSION_BUILD_VAR";
         private const string ANDROID_APP_BUNDLE = "BUILD_APP_BUNDLE";
         private const string SCRIPTING_BACKEND_ENV_VAR = "SCRIPTING_BACKEND";
         private const string EXPORT_ANDROID_PROJECT = "EXPORT_ANDROID_PROJECT";
         private const string VERSION_NUMBER_VAR = "VERSION_NUMBER_VAR";
-        private const string VERSION_iOS = "VERSION_BUILD_VAR";
+        private const string VERSION_BUILD_VAR = "VERSION_BUILD_VAR";
         
         public static void InstallPod(EventHandler processExit, string buildPath = null)
         {
             try
             {
-                var arguments = $"-c \"/usr/local/bin/pod install --project-directory={buildPath}\"";
+                string arguments = "";
                 if (Application.isBatchMode && TryGetEnv("CI_SCRIPT_DIR", out string scriptDir))
                 {
                     arguments = $"{scriptDir}/utils.sh pod-install";
                 }
+                else if (!Application.isBatchMode)
+                {
+                    string podPath = "/usr/local/bin/pod";
+                    if (!File.Exists(podPath)) podPath = "/opt/homebrew/bin/pod";
+                    arguments = $"-c \"{podPath} install --project-directory={buildPath}\"";
+                }
                 
                 // Configure process start info
                 var startInfo = new ProcessStartInfo
@@ -57,12 +62,6 @@ namespace Amanotes.Core
                     if (args.Data == null) return; // End of the stream
                     Debug.Log(args.Data);
                 };
-                
-                // proc.ErrorDataReceived += (sender, args) =>
-                // {
-                //     if (args.Data == null) return; // End of the stream
-                //     Debug.LogError(args.Data);
-                // };
 
                 proc.Exited += processExit;
 
@@ -71,9 +70,6 @@ namespace Amanotes.Core
                 proc.BeginOutputReadLine();
                 proc.BeginErrorReadLine();
                 proc.WaitForExit();
-
-                // Log exit code
-                // Debug.LogWarning("Process exited with code: " + proc.ExitCode);
             }
             catch (Exception e)
             {
@@ -245,20 +241,16 @@ namespace Amanotes.Core
             var buildTarget = GetBuildTarget();
 
             Console.WriteLine(":: Performing build");
-            if (TryGetEnv(VERSION_NUMBER_VAR, out var bundleVersionNumber))
+            if (TryGetEnv(VERSION_NUMBER_VAR, out string bundleVersionNumber))
             {
-                if (buildTarget == BuildTarget.iOS)
-                {
-                    bundleVersionNumber = GetIosVersion();
-                }
                 Console.WriteLine($":: Setting bundleVersionNumber to '{bundleVersionNumber}' (Length: {bundleVersionNumber.Length})");
                 PlayerSettings.bundleVersion = bundleVersionNumber;
             }
+            HandleBuildNumber(buildTarget);
 
             if (buildTarget == BuildTarget.Android)
             {
                 HandleAndroidAppBundle();
-                HandleAndroidBundleVersionCode();
                 HandleAndroidKeystore();
                 HandleDebugSymbols();
                 HandleExportAndroidProject();
@@ -276,6 +268,7 @@ namespace Amanotes.Core
             if (buildReport.summary.result != UnityEditor.Build.Reporting.BuildResult.Succeeded)
                 throw new Exception($"Build ended with {buildReport.summary.result} status");
 
+            BuildMetadata.Save(buildPath, buildTarget);
             Console.WriteLine(":: Done with build");
         }
 
@@ -299,18 +292,24 @@ namespace Amanotes.Core
             }
         }
 
-        private static void HandleAndroidBundleVersionCode()
+        private static void HandleBuildNumber(BuildTarget buildTarget)
         {
-            if (TryGetEnv(ANDROID_BUNDLE_VERSION_CODE, out string value))
+            if (!TryGetEnv(VERSION_BUILD_VAR, out string value)) return;
+            if (int.TryParse(value, out int version))
             {
-                if (int.TryParse(value, out int version))
+                if (buildTarget == BuildTarget.Android)
                 {
-                    PlayerSettings.Android.bundleVersionCode = version;
-                    Console.WriteLine($":: {ANDROID_BUNDLE_VERSION_CODE} env var detected, set the bundle version code to {value}.");
+                    PlayerSettings.Android.bundleVersionCode = version;    
                 }
-                else
-                    Console.WriteLine($":: {ANDROID_BUNDLE_VERSION_CODE} env var detected but the version value \"{value}\" is not an integer.");
+                else if (buildTarget == BuildTarget.iOS)
+                {
+                    PlayerSettings.iOS.buildNumber = version.ToString();
+                }
+                    
+                Console.WriteLine($":: {VERSION_BUILD_VAR} env var detected, set the bundle version code to {value}.");
             }
+            else
+                Console.WriteLine($":: {VERSION_BUILD_VAR} env var detected but the version value \"{value}\" is not an integer.");
         }
 
         private static void HandleExportAndroidProject()
@@ -323,22 +322,6 @@ namespace Amanotes.Core
             }
         }
 
-        private static string GetIosVersion()
-        {
-            if (TryGetEnv(VERSION_iOS, out string value))
-            {
-                if (int.TryParse(value, out int version))
-                {
-                    Console.WriteLine($":: {VERSION_iOS} env var detected, set the version to {value}.");
-                    return version.ToString();
-                }
-                else
-                    Console.WriteLine($":: {VERSION_iOS} env var detected but the version value \"{value}\" is not an integer.");
-            }
-
-            throw new ArgumentNullException(nameof(value), $":: Error finding {VERSION_iOS} env var");
-        }
-
         private static void HandleAndroidKeystore()
         {
 #if UNITY_2019_1_OR_NEWER
@@ -394,6 +377,31 @@ namespace Amanotes.Core
         }
     }
     
+    [Serializable]
+    public class BuildMetadata
+    {
+        public string appVersion;
+        public string buildNumber;
+        public string buildTarget; 
+        
+        public static void Save(string buildPath, BuildTarget buildTarget)
+        {
+            string outputFile = Path.Combine(buildPath, "build_info.json");
+
+            var metadata = new BuildMetadata
+            {
+                appVersion = PlayerSettings.bundleVersion,
+                buildNumber = buildTarget == BuildTarget.Android ? PlayerSettings.Android.bundleVersionCode.ToString() : PlayerSettings.iOS.buildNumber,
+                buildTarget = buildTarget.ToString()
+            };
+
+            string json = JsonUtility.ToJson(metadata, prettyPrint: true);
+            File.WriteAllText(outputFile, json);
+
+            Console.WriteLine($":: Build information saved to {outputFile}");
+        }
+    }
+    
     public class GDKPreProcessBuild: IPreprocessBuildWithReport
     {
         public int callbackOrder
@@ -402,20 +410,14 @@ namespace Amanotes.Core
         }
         public void OnPreprocessBuild(BuildReport report)
         {
-            if (report.summary.platform == BuildTarget.Android)
-            {
-                // Change Gradle path when running in headless mode (CI Machine)
-                if (Application.isBatchMode)
-                {   
-                    if (GDKCIBuildCommand.TryGetEnv("GRADLE_PATH", out string envGradlePath))
-                    {
-                        EditorPrefs.SetBool("GradleUseEmbedded", false);
-                        EditorPrefs.SetString("GradlePath", envGradlePath);
-                        Debug.Log("Update gradle path to: " + envGradlePath);
-                    }
-                }
-            }
-            
+            if (report.summary.platform != BuildTarget.Android) return;
+            // Change Gradle path when running in headless mode (CI Machine)
+            if (!Application.isBatchMode) return;
+            if (!GDKCIBuildCommand.TryGetEnv("GRADLE_PATH", out string envGradlePath)) return;
+            EditorPrefs.SetBool("GradleUseEmbedded", false);
+            EditorPrefs.SetString("GradlePath", envGradlePath);
+            Debug.Log("Update gradle path to: " + envGradlePath);
+
         }
     }
 }

package/Runtime/Ad/AmaGDK.Ads.cs

@@ -93,7 +93,7 @@ namespace Amanotes.Core
             
             internal void Save()
             {
-                this.SaveJsonToFile(false);
+                this.SaveJsonToFile();
             }
         }
 
@@ -345,6 +345,7 @@ namespace Amanotes.Core.Internal
     {
         protected AdShowContext context => Ads.context;
         protected AdModuleConfig moduleConfig => Config.ad;
+        public Dictionary<string, object> userData => context?.userData;
 
         // APIs
         internal protected abstract AdLogic interstitial { get; }

package/Runtime/AmaGDK.Analytics.cs

@@ -135,7 +135,7 @@ namespace Amanotes.Core
                 
                 if (!localData._dirty) return;
                 localData._dirty = false;
-                localData.SaveJsonToFile(true); // immediately = true
+                localData.SaveJsonToFile();
             }
 
             public static IEventParamsBuilder LogFunnelEvent(string eventName, string signature = "")
@@ -314,7 +314,7 @@ namespace Amanotes.Core
             internal static readonly GDKPool.Pool<EventParams> epPool = new GDKPool.Pool<EventParams>(1);
 
             private static readonly Lazy<AnalyticsData> _localData = new Lazy<AnalyticsData>(
-                () => new AnalyticsData().ReloadDataFromLocal());
+                () => new AnalyticsData().LoadJsonFromFile().BuildCache());
             internal static AnalyticsData localData => _localData.Value;
             
             internal static readonly Dictionary<string, string> reservedPrefixes = new Dictionary<string, string>()
@@ -800,12 +800,6 @@ namespace Amanotes.Core
                     return this;
                 }
                 
-                public AnalyticsData ReloadDataFromLocal()
-                {
-                    this.LoadJsonFromFile().BuildCache();
-                    return this;
-                }
-                
                 internal EventDetail GetEventDetail(string eventName, bool autoNew = false)
                 {
                     if (string.IsNullOrEmpty(eventName)) return null;
@@ -849,7 +843,7 @@ namespace Amanotes.Core
                     if (!Config.analytics.autoFlushEventDetail) return;
                     if (!_dirty) return;
                     _dirty = false;
-                    this.SaveJsonToFile(false);
+                    this.SaveJsonToFile();
                 }
 
                 internal void UpdateMigrationLog()

package/Runtime/AmaGDK.IAP.cs

@@ -306,7 +306,7 @@ namespace Amanotes.Core
                     subscriptionExpiredDate = _subscriptionExpiredDate?.ToString(DATE_FORMAT);
                     _unsubscribedDate = Adapter.GetUnsubscribedDate();
                     unsubscribedDate = _unsubscribedDate?.ToString(DATE_FORMAT);
-                    this.SaveJsonToFile(false);
+                    this.SaveJsonToFile();
                 }
             }
         }

package/Runtime/AmaGDK.UserProfile.cs

@@ -33,14 +33,14 @@ namespace Amanotes.Core
             private bool _dirty = false;
             private void Save()
             {
-                this.SaveJsonToFile(false);
+                this.SaveJsonToFile();
             }
             
             private void SaveIfDirty()
             {
                 if (!_dirty) return;
                 _dirty = false;
-                this.SaveJsonToFile(false);
+                this.SaveJsonToFile();
             }
         }
 

package/Runtime/AmaGDK.cs

@@ -27,7 +27,7 @@ namespace Amanotes.Core
 {
     public partial class AmaGDK : MonoBehaviour
     {
-        public const string VERSION = "0.2.81-a4";
+        public const string VERSION = "v0.2.81-alpha.11";
         
         internal static Status _status = Status.None;
         internal static ConfigAsset _config = null;

package/Runtime/Consent/AmaGDK.Consent.cs

@@ -0,0 +1,224 @@
+using System;
+using Amanotes.Core.Internal;
+using UnityEngine;
+using static Amanotes.Core.GDKDebug;
+
+namespace Amanotes.Core
+{
+    public partial class AmaGDK //Consent
+    {
+        public static partial class Consent //Public
+        {
+            private static readonly GDKTaskTracker _allConsentTaskTracker = new GDKTaskTracker();
+            public static void RequestAllConsents(Action onComplete)
+            {
+                _allConsentTaskTracker.RegisterOnCompleteCallback(onComplete);
+                if (_allConsentTaskTracker.HasStarted) return;
+                
+                _allConsentTaskTracker.MarkStarted();
+                
+                void CompleteRequestAllConsents()
+                {
+                    _allConsentTaskTracker.MarkCompleted();
+                }
+                void ShowConsentIfRequired()
+                {
+                    CMP.ShowConsentFormIfRequired(
+                        _ => CompleteRequestAllConsents(),
+                        _ => CompleteRequestAllConsents());    
+                }
+#if UNITY_IOS
+                ATT.Request(
+                    allow =>
+                    {
+                        if (allow)
+                        {
+                            ShowConsentIfRequired();
+                            return;
+                        }
+                        CompleteRequestAllConsents();
+                    });
+#else
+                ShowConsentIfRequired();
+#endif
+            }
+        }
+        
+        public static partial class Consent //ATT
+        {
+            public static class ATT
+            {
+                public static bool IsAllowed
+                {
+                    get
+                    {
+                        if (checkedATT) return allowedATT;
+                        LogWarning("[Consent] ATT has not completed yet");
+                        return false;
+                    }
+                }
+            
+                public static void Request(Action<bool> onComplete)
+                {
+                    if (checkedATT)
+                    {
+                        Log("[Consent] ATT has already completed");
+                        onComplete?.Invoke(allowedATT);
+                        return;
+                    }
+                    if (ConsentHook.ATTRequest == null)
+                    {
+                        LogWarning("[Consent] ConsentHook.ATTRequest is not implemented");
+                        onComplete?.Invoke(false);
+                        return;
+                    }
+
+                    ConsentHook.ATTRequest(isAllowed =>
+                    {
+                        data.att = isAllowed ? Status.Allowed : Status.NotAllowed;
+                        data.SaveJsonToFile();
+                        onComplete?.Invoke(allowedATT);
+                    });
+                }
+            }
+            
+        }
+        
+        public static partial class Consent //CMP
+        {
+            public static class CMP
+            {
+                /// <summary>
+                /// Determines if a consent popup should be shown to the user and displays it if required.
+                /// The consent popup will be shown only once in the lifecycle of the app if this function is used.
+                /// </summary>
+                /// <remarks>
+                /// The consent popup is required in the European Economic Area (EEA) and
+                /// other countries that have implemented the General Data Protection Regulation (GDPR).
+                /// </remarks>
+                /// <param name="onComplete">Callback invoked with a boolean indicating the
+                /// ConsentInformation.CanRequestAds() result
+                /// </param>
+                /// <param name="onError">Callback invoked with an error message if the consent
+                /// form could not be loaded or shown.</param>
+                public static void ShowConsentFormIfRequired(Action<bool> onComplete, Action<string> onError)
+                {
+                    if (ConsentHook.ShowConsentFormIfRequired == null)
+                    {
+                        LogWarning("[Consent] ConsentHook.ShowConsentFormIfRequired is not implemented");
+                        onError?.Invoke("ShowPrivacyForm is not implemented");
+                        return;
+                    }
+                    if (data.consentAlreadyShown)
+                    {
+                        Log("[Consent] Consent form has already been shown");
+                        onComplete?.Invoke(data.canShowAds);
+                        return;
+                    }
+                    ConsentHook.ShowConsentFormIfRequired(canShowAd =>
+                    {
+                        data.canShowAds = canShowAd;
+                        data.consentAlreadyShown = true;
+                        data.SaveJsonToFile();
+                        onComplete?.Invoke(canShowAd);
+                    }, onError);
+                }
+                
+                /// <summary>
+                /// Forces the consent popup to be shown to the user, regardless of previous
+                /// consent status.
+                /// </summary>
+                /// <param name="onComplete">Callback invoked with a boolean indicating the
+                /// ConsentInformation.CanRequestAds() result
+                /// </param>
+                /// <param name="onError">Callback invoked with an error message if the consent
+                /// form could not be loaded or shown.</param>
+                public static void ShowPrivacyForm(Action<bool> onComplete, Action<string> onError)
+                {
+                    if (ConsentHook.CheckPrivacyOptionsRequired == null)
+                    {
+                        LogWarning("[Consent] ConsentHook.ShowPrivacyForm is not implemented");
+                        onError?.Invoke("ShowPrivacyForm is not implemented");
+                        return;
+                    }
+                    ConsentHook.ShowPrivacyForm(onComplete, onError);
+                }
+
+                /// <summary>
+                /// Determines whether privacy options are required for the current user.
+                /// Updates the consent information before returning the result.
+                /// </summary>
+                /// <param name="onComplete">Callback invoked with `true` if privacy options are required, otherwise `false`.</param>
+                public static void CheckPrivacyOptionsRequired(Action<bool> onComplete)
+                {
+                    if (ConsentHook.CheckPrivacyOptionsRequired == null)
+                    {
+                        LogWarning("[Consent] ConsentHook.CheckPrivacyOptionsRequired is not implemented");
+                        onComplete?.Invoke(false);
+                        return;
+                    }
+                    ConsentHook.CheckPrivacyOptionsRequired(onComplete);
+                }
+
+                [Obsolete("Use ShowPrivacyForm instead")]
+                public static void ForceShowPopup(Action<bool> onComplete)
+                {
+                    ShowPrivacyForm(onComplete, s => onComplete?.Invoke(false));
+                }
+            }
+        }
+
+        public static partial class Consent //Internal
+        {
+            private static readonly Lazy<ConsentData> _data = new Lazy<ConsentData>(() => new ConsentData().LoadJsonFromFile());
+            private static ConsentData data => _data.Value;
+            private static Action _onConsentComplete;
+            
+            internal static bool checkedATT => data.att >= Status.Allowed;
+            internal static bool allowedATT => data.att == Status.Allowed;
+            
+            internal enum Status
+            {
+                None,
+                NotRequired,
+                Allowed,
+                NotAllowed
+            }
+
+            internal static bool InitModule()
+            {
+                if (_config.autoGetConsent)
+                {
+                    RequestAllConsents(null);
+                }
+                return true;
+            }
+        }
+    }
+    
+    [Serializable]
+    public class ConsentData : IJsonFile
+    {
+        [SerializeField] internal AmaGDK.Consent.Status att;
+        [SerializeField] internal bool consentAlreadyShown;
+        [SerializeField] internal bool canShowAds;
+    }
+
+    public static class ConsentHook
+    {
+        public static Action<Action<bool>, Action<string>> ShowConsentFormIfRequired;
+        public static Action<Action<bool>, Action<string>> ShowPrivacyForm;
+        public static Action<Action<bool>> CheckPrivacyOptionsRequired;
+        public static Action<Action<bool>> ATTRequest;
+    }
+}
+
+namespace Amanotes.Core.Internal
+{
+    public partial class ConfigAsset
+    {
+        [SerializeField]
+        [Tooltip("Auto pop-up ATT and CMP form")]
+        public bool autoGetConsent = true;
+    }
+}

package/Runtime/Consent/GDKPrivacyButton.cs

@@ -0,0 +1,25 @@
+using System;
+using UnityEngine;
+using UnityEngine.UI;
+namespace Amanotes.Core
+{
+    public class GDKPrivacyButton: MonoBehaviour
+    {
+        public Button button;
+        private void Start()
+        {
+            gameObject.SetActive(false);
+            UpdateUI();
+        }
+        
+        public void OnButtonClick()
+        {
+            AmaGDK.Consent.CMP.ShowPrivacyForm(canShowAd => UpdateUI(), GDKDebug.LogWarning);
+        }
+
+        private void UpdateUI()
+        {
+            AmaGDK.Consent.CMP.CheckPrivacyOptionsRequired(required => button.interactable = required);   
+        }
+    }
+}

package/Runtime/Consent/GDKPrivacyButton.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 23184a9779a949419e702ce599a0dcc5
+timeCreated: 1733448516