com.onesignal.unity.ios 3.0.0-beta.4 → 3.0.0

package/Editor/BuildPostProcessor.cs

@@ -52,12 +52,8 @@
 #define ADD_APP_GROUP
 
 using System.IO;
-using System;
 using UnityEditor;
 using UnityEditor.iOS.Xcode;
-using System.Collections.Generic;
-using System.Diagnostics;
-using System.Linq;
 using System.Text.RegularExpressions;
 using UnityEditor.Build;
 using UnityEditor.Build.Reporting;
@@ -72,22 +68,15 @@ namespace OneSignalSDK {
     public class BuildPostProcessor : IPostprocessBuildWithReport {
         private const string ServiceExtensionTargetName = "OneSignalNotificationServiceExtension";
         private const string ServiceExtensionFilename = "NotificationService.swift";
+        private const string DependenciesFilename = "OneSignalIOSDependencies.xml";
         private const string PackageName = "com.onesignal.unity.ios";
 
+        private static readonly string EditorFilesPath = Path.Combine("Packages", PackageName, "Editor");
         private static readonly string PluginLibrariesPath = Path.Combine(PackageName, "Runtime", "Plugins", "iOS");
         private static readonly string PluginFilesPath = Path.Combine("Packages", PluginLibrariesPath);
 
-        [Flags] private enum Entitlement {
-            None = 0,
-            ApsEnv = 1 << 0,
-            AppGroups = 1 << 1
-        }
-
-        private static readonly Dictionary<Entitlement, string> EntitlementKeys = new Dictionary<Entitlement, string> {
-            [Entitlement.ApsEnv]    = "aps-environment",
-            [Entitlement.AppGroups] = "com.apple.security.application-groups"
-        };
-
+        private readonly string _appGroupName = $"group.{PlayerSettings.applicationIdentifier}.onesignal";
+        
         private string _outputPath;
         private string _projectPath;
         
@@ -111,29 +100,19 @@ namespace OneSignalSDK {
             _outputPath  = report.summary.outputPath;
             _projectPath = PBXProject.GetPBXProjectPath(_outputPath);
             _project.ReadFromString(File.ReadAllText(_projectPath));
-
-            // Add required entitlements
-            UpdateEntitlements(Entitlement.ApsEnv | Entitlement.AppGroups);
+            
+            // Turn on capabilities required by OneSignal
+            AddProjectCapabilities();
             
             // Add the service extension
             AddNotificationServiceExtension();
 
-            // Reload file after changes from AddNotificationServiceExtension
-            _project.WriteToFile(_projectPath);
-            _project.ReadFromString(File.ReadAllText(_projectPath));
-
-            // Turn on push capabilities
-            AddPushCapability();
-
-            // Ensure the Pods target has been added to the extension
-            ExtensionAddPodsToTarget();
-
             // Save the project back out
             File.WriteAllText(_projectPath, _project.WriteToString());
         }
 
         /// <summary>
-        /// Checks for existing entitlements file or creates a new one and returns the path
+        /// Get existing entitlements file if exists or creates a new file, adds it to the project, and returns the path
         /// </summary>
         private string GetEntitlementsPath(string targetGuid, string targetName) {
             var relativePath = _project.GetBuildPropertyForAnyConfig(targetGuid, "CODE_SIGN_ENTITLEMENTS");
@@ -144,38 +123,12 @@ namespace OneSignalSDK {
                 if (File.Exists(fullPath))
                     return fullPath;
             }
-
-            return Path.Combine(_outputPath, targetName, $"{targetName}.entitlements");
-        }
-
-        /// <summary>
-        /// Add or update the values of necessary entitlements
-        /// </summary>
-        private void UpdateEntitlements(Entitlement entitlements, string targetGuid, string targetName) {
-            var entitlementsPath  = GetEntitlementsPath(targetGuid, targetName);
+            
+            var entitlementsPath = Path.Combine(_outputPath, targetName, $"{targetName}.entitlements");
+            
+            // make new file
             var entitlementsPlist = new PlistDocument();
-
-            var existingEntitlements = File.Exists(entitlementsPath);
-
-            if (existingEntitlements)
-                entitlementsPlist.ReadFromFile(entitlementsPath);
-
-            var groupsKey = EntitlementKeys[Entitlement.AppGroups];
-
-            if ((entitlements & Entitlement.AppGroups) != 0) {
-                var groups = entitlementsPlist.root[groupsKey] == null
-                    ? entitlementsPlist.root.CreateArray(groupsKey)
-                    : entitlementsPlist.root[groupsKey].AsArray();
-
-                var group = $"group.{PlayerSettings.applicationIdentifier}.onesignal";
-                if (groups.values.All(elem => elem.AsString() != group))
-                    groups.AddString(group);
-            }
-
             entitlementsPlist.WriteToFile(entitlementsPath);
-
-            if (existingEntitlements) 
-                return;
             
             // Copy the entitlement file to the xcode project
             var entitlementFileName = Path.GetFileName(entitlementsPath);
@@ -184,25 +137,26 @@ namespace OneSignalSDK {
             // Add the pbx configs to include the entitlements files on the project
             _project.AddFile(relativeDestination, entitlementFileName);
             _project.SetBuildProperty(targetGuid, "CODE_SIGN_ENTITLEMENTS", relativeDestination);
+
+            return entitlementsPath;
         }
         
-        private void UpdateEntitlements(Entitlement entitlements)
-            => UpdateEntitlements(entitlements, _project.GetMainTargetGuid(), _project.GetMainTargetName());
-
-        private void AddPushCapability(string targetGuid, string targetName) {
-            _project.AddCapability(targetGuid, PBXCapabilityType.PushNotifications);
-            _project.AddCapability(targetGuid, PBXCapabilityType.BackgroundModes);
+        /// <summary>
+        /// Add the required capabilities and entitlements for OneSignal
+        /// </summary>
+        private void AddProjectCapabilities() {
+            var targetGuid = _project.GetMainTargetGuid();
+            var targetName = _project.GetMainTargetName();
 
             var entitlementsPath = GetEntitlementsPath(targetGuid, targetName);
-
-            // NOTE: ProjectCapabilityManager's 4th constructor param requires Unity 2019.3+
             var projCapability = new ProjectCapabilityManager(_projectPath, entitlementsPath, targetName);
+
             projCapability.AddBackgroundModes(BackgroundModesOptions.RemoteNotifications);
+            projCapability.AddPushNotifications(false);
+            projCapability.AddAppGroups(new[] { _appGroupName });
+            
             projCapability.WriteToFile();
         }
-
-        private void AddPushCapability() =>
-            AddPushCapability(_project.GetMainTargetGuid(), _project.GetMainTargetName());
         
         /// <summary>
         /// Create and add the notification extension to the project
@@ -212,8 +166,10 @@ namespace OneSignalSDK {
             // If file exists then the below has been completed before from another build
             // The below will not be updated on Append builds
             // Changes would most likely need to be made to support Append builds
-            if (ExtensionCreatePlist(_outputPath))
+            if (ExtensionCreatePlist(_outputPath)) {
+                ExtensionAddPodsToTarget();
                 return;
+            }
 
             var extensionGuid = _project.AddAppExtension(_project.GetMainTargetGuid(),
                 ServiceExtensionTargetName,
@@ -235,7 +191,15 @@ namespace OneSignalSDK {
 
             _project.WriteToFile(_projectPath);
 
-            UpdateEntitlements(Entitlement.AppGroups, extensionGuid, ServiceExtensionTargetName);
+            // add capabilities + entitlements
+            var entitlementsPath = GetEntitlementsPath(extensionGuid, ServiceExtensionTargetName);
+            var projCapability = new ProjectCapabilityManager(_projectPath, entitlementsPath, ServiceExtensionTargetName);
+            
+            projCapability.AddAppGroups(new[] { _appGroupName });
+            
+            projCapability.WriteToFile();
+            
+            ExtensionAddPodsToTarget();
 #endif
         }
 
@@ -290,7 +254,25 @@ namespace OneSignalSDK {
             if (extensionEntryRegex.IsMatch(podfile))
                 return;
 
-            podfile += $"target '{ServiceExtensionTargetName}' do\n  pod 'OneSignalXCFramework', '~> 3.8.1'\nend\n";
+            var versionRegex = new Regex("(?<=<iosPod name=\"OneSignalXCFramework\" version=\").+(?=\" addToAllTargets=\"true\" />)");
+            var dependenciesFilePath = Path.Combine(EditorFilesPath, DependenciesFilename);
+
+            if (!File.Exists(dependenciesFilePath)) {
+                Debug.LogError($"Could not find {DependenciesFilename}");
+                return;
+            }
+            
+            var dependenciesFile = File.ReadAllText(dependenciesFilePath);
+
+            if (!versionRegex.IsMatch(dependenciesFile)) {
+                Debug.LogError($"Could not read current iOS framework dependency version from {DependenciesFilename}");
+                return;
+            }
+
+            var version = versionRegex.Match(dependenciesFile)
+                .ToString();
+            
+            podfile += $"target '{ServiceExtensionTargetName}' do\n  pod 'OneSignalXCFramework', '{version}'\nend\n";
             File.WriteAllText(podfilePath, podfile);
         }
     }

package/Editor/OneSignalIOSDependencies.xml

@@ -1,5 +1,5 @@
 <dependencies>
     <iosPods>
-        <iosPod name="OneSignalXCFramework" version="~> 3.8.1"  addToAllTargets="true" />
+        <iosPod name="OneSignalXCFramework" version="3.10.0" addToAllTargets="true" />
     </iosPods>
 </dependencies>

package/Editor/PBXProjectExtensions.cs

@@ -35,18 +35,12 @@ namespace OneSignalSDK {
 
         public static string GetMainTargetGuid(this PBXProject project)
             => project.GetUnityMainTargetGuid();
-
-        public static string GetFrameworkGuid(this PBXProject project)
-            => project.GetUnityFrameworkTargetGuid();
     #else
         public static string GetMainTargetName(this PBXProject project) 
             => PBXProject.GetUnityTargetName();
          
         public static string GetMainTargetGuid(this PBXProject project)
              => project.TargetGuidByName(PBXProject.GetUnityTargetName());
-
-        public static string GetFrameworkGuid(this PBXProject project)
-             => GetPBXProjectTargetGuid(project);
     #endif
     }
 }

package/Runtime/OneSignalIOS.Callbacks.cs

@@ -48,20 +48,24 @@ namespace OneSignalSDK {
             WaitingProxies[hashCode] = proxy;
             return (proxy, hashCode);
         }
-        
-        [AOT.MonoPInvokeCallback(typeof(BooleanResponseDelegate))]
-        private static void BooleanCallbackProxy(int hashCode, bool response) {
-            if (WaitingProxies[hashCode] is Later<bool> later)
+
+        private static void ResolveCallbackProxy<TResponse>(int hashCode, TResponse response) {
+            if (!WaitingProxies.ContainsKey(hashCode))
+                return;
+            
+            if (WaitingProxies[hashCode] is Later<TResponse> later)
                 later.Complete(response);
+            
             WaitingProxies.Remove(hashCode);
         }
 
+        [AOT.MonoPInvokeCallback(typeof(BooleanResponseDelegate))]
+        private static void BooleanCallbackProxy(int hashCode, bool response)
+            => ResolveCallbackProxy(hashCode, response);
+
         [AOT.MonoPInvokeCallback(typeof(StringResponseDelegate))]
-        private static void StringCallbackProxy(int hashCode, string response) {
-            if (WaitingProxies[hashCode] is Later<string> later)
-                later.Complete(response);
-            WaitingProxies.Remove(hashCode);
-        }
+        private static void StringCallbackProxy(int hashCode, string response)
+            => ResolveCallbackProxy(hashCode, response);
         
         /*
          * Global Callbacks
@@ -134,19 +138,8 @@ namespace OneSignalSDK {
 
         [AOT.MonoPInvokeCallback(typeof(StateListenerDelegate))]
         private static void _onPermissionStateChanged(string current, string previous) {
-            if (!(Json.Deserialize(current) is Dictionary<string, object> currState)) {
-                SDKDebug.Error("Could not deserialize current permission state");
-                return;
-            }
-
-            if (!(Json.Deserialize(previous) is Dictionary<string, object> prevState)) {
-                SDKDebug.Error("Could not deserialize previous permission state");
-                return;
-            }
-            
-            var curr = (NotificationPermission)currState["status"];
-            var prev = (NotificationPermission)prevState["status"];
-            
+            var curr = JsonUtility.FromJson<NotificationPermissionState>(current);
+            var prev = JsonUtility.FromJson<NotificationPermissionState>(previous);
             _instance.NotificationPermissionChanged?.Invoke(curr, prev);
         }
         

package/Runtime/OneSignalIOS.Interface.cs

@@ -28,9 +28,6 @@
 using System.Runtime.InteropServices;
 
 namespace OneSignalSDK {
-    /// <summary>
-    /// 
-    /// </summary>
     public sealed partial class OneSignalIOS : OneSignal {
         /*
          * Global callbacks

package/Runtime/OneSignalIOS.Mappings.cs

@@ -0,0 +1,80 @@
+/*
+ * Modified MIT License
+ *
+ * Copyright 2022 OneSignal
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * 1. The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * 2. All copies of substantial portions of the Software may only be used in connection
+ * with services provided by OneSignal.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+using System;
+
+namespace OneSignalSDK {
+    public sealed partial class OneSignalIOS : OneSignal {
+        [Serializable] private sealed class DeviceState {
+            public long notificationPermissionStatus;
+            
+            public string userId;
+            public string pushToken;
+            public bool isSubscribed;
+            public bool isPushDisabled;
+            
+            public string emailUserId;
+            public string emailAddress;
+            public bool isEmailSubscribed;
+            
+            public string smsUserId;
+            public string smsNumber;
+            public bool isSMSSubscribed;
+
+            public static implicit operator PushSubscriptionState(DeviceState source)
+                => new PushSubscriptionState {
+                    userId = source.userId,
+                    pushToken = source.pushToken,
+                    isSubscribed = source.isSubscribed,
+                    isPushDisabled = source.isPushDisabled,
+                };
+
+            public static implicit operator EmailSubscriptionState(DeviceState source)
+                => new EmailSubscriptionState {
+                    emailUserId = source.emailUserId,
+                    emailAddress = source.emailAddress,
+                    isSubscribed = source.isEmailSubscribed,
+                };
+
+            public static implicit operator SMSSubscriptionState(DeviceState source)
+                => new SMSSubscriptionState {
+                    smsUserId = source.smsUserId,
+                    smsNumber = source.smsNumber,
+                    isSubscribed = source.isSMSSubscribed,
+                };
+        }
+        
+        [Serializable] private sealed class NotificationPermissionState {
+            public long status;
+            public bool provisional;
+            public bool hasPrompted;
+
+            public static implicit operator NotificationPermission(NotificationPermissionState source)
+                => (NotificationPermission)source.status;
+        }
+    }
+}

package/Runtime/OneSignalIOS.Mappings.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 60256e1ba9474730ac255a1e9da4ce74
+timeCreated: 1643996576

package/Runtime/OneSignalIOS.cs

@@ -28,6 +28,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Threading.Tasks;
+using UnityEngine;
 
 namespace OneSignalSDK {
     public sealed partial class OneSignalIOS : OneSignal {
@@ -45,61 +46,19 @@ namespace OneSignalSDK {
         
         public override NotificationPermission NotificationPermission {
             get {
-                if (Json.Deserialize(_getDeviceState()) is Dictionary<string, object> deviceState) {
-                    if (deviceState["notificationPermissionStatus"] is long status)
-                        return (NotificationPermission) status;
-                }
-                
-                SDKDebug.Error("Could not deserialize device state for permissions");
-                return NotificationPermission.NotDetermined;
+                var deviceState = JsonUtility.FromJson<DeviceState>(_getDeviceState());
+                return (NotificationPermission)deviceState.notificationPermissionStatus;
             }
         }
         
-        public override PushSubscriptionState PushSubscriptionState {
-            get {
-                if (Json.Deserialize(_getDeviceState()) is Dictionary<string, object> deviceState) {
-                    return new PushSubscriptionState {
-                        userId         = deviceState["userId"] as string,
-                        pushToken      = deviceState["pushToken"] as string,
-                        isSubscribed   = (bool) deviceState["isSubscribed"],
-                        isPushDisabled = (bool) deviceState["isPushDisabled"],
-                    };
-                }
-
-                SDKDebug.Error("Could not deserialize device state for push");
-                return null;
-            }
-        }
+        public override PushSubscriptionState PushSubscriptionState
+            => JsonUtility.FromJson<DeviceState>(_getDeviceState());
         
-        public override EmailSubscriptionState EmailSubscriptionState {
-            get {
-                if (Json.Deserialize(_getDeviceState()) is Dictionary<string, object> deviceState) {
-                    return new EmailSubscriptionState {
-                        emailUserId  = deviceState["emailUserId"] as string,
-                        emailAddress = deviceState["emailAddress"] as string,
-                        isSubscribed = (bool) deviceState["isEmailSubscribed"],
-                    };
-                }
-
-                SDKDebug.Error("Could not deserialize device state for email");
-                return null;
-            }
-        }
+        public override EmailSubscriptionState EmailSubscriptionState
+            => JsonUtility.FromJson<DeviceState>(_getDeviceState());
         
-        public override SMSSubscriptionState SMSSubscriptionState {
-            get {
-                if (Json.Deserialize(_getDeviceState()) is Dictionary<string, object> deviceState) {
-                    return new SMSSubscriptionState {
-                        smsUserId    = deviceState["smsUserId"] as string,
-                        smsNumber    = deviceState["smsNumber"] as string,
-                        isSubscribed = (bool) deviceState["isSMSSubscribed"],
-                    };
-                }
-
-                SDKDebug.Error("Could not deserialize device state for sms");
-                return null;
-            }
-        }
+        public override SMSSubscriptionState SMSSubscriptionState 
+            => JsonUtility.FromJson<DeviceState>(_getDeviceState());
 
         public override LogLevel LogLevel {
             get => _logLevel;

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "com.onesignal.unity.ios",
   "displayName": "OneSignal Unity SDK - iOS",
-  "version": "3.0.0-beta.4",
+  "version": "3.0.0",
   "unity": "2018.4",
   "description": "OneSignal is the market leader in customer engagement, powering mobile push, web push, email, and in-app messages.",
   "dependencies": {
-    "com.onesignal.unity.core": "3.0.0-beta.4"
+    "com.onesignal.unity.core": "3.0.0"
   },
   "keywords": [
     "push-notifications",