Update JWT invalidated listener and event API

* Update the API for the listener, add and removal function names, event name
* The listener API is OSUserJwtInvalidatedListener
* The event is OSUserJwtInvalidatedEvent

Author: nan-li

iOS_SDK/OneSignalDevApp/OneSignalDevApp/AppDelegate.h

@@ -31,7 +31,7 @@
 #import <UIKit/UIKit.h>
 #import <OneSignalFramework/OneSignalFramework.h>
 
-@interface AppDelegate : UIResponder <UIApplicationDelegate, OSNotificationPermissionObserver, OSInAppMessageLifecycleListener, OSPushSubscriptionObserver, OSNotificationLifecycleListener, OSInAppMessageClickListener, OSNotificationClickListener, OSUserStateObserver>
+@interface AppDelegate : UIResponder <UIApplicationDelegate, OSNotificationPermissionObserver, OSInAppMessageLifecycleListener, OSPushSubscriptionObserver, OSNotificationLifecycleListener, OSInAppMessageClickListener, OSNotificationClickListener, OSUserStateObserver, OSUserJwtInvalidatedListener>
 
 @property (strong, nonatomic) UIWindow *window;
 

iOS_SDK/OneSignalDevApp/OneSignalDevApp/AppDelegate.m

@@ -76,11 +76,7 @@ - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(
     [OneSignal.User addObserver:self];
     [OneSignal.Notifications addPermissionObserver:self];
     [OneSignal.InAppMessages addClickListener:self];
-
-    
-    [OneSignal.User onJwtInvalidatedWithInvalidatedHandler:^(OSJwtInvalidatedEvent * _Nonnull invalidatedEvent) {
-        NSLog(@"JWT INVALIDATED CALLBACK FOR: %@", invalidatedEvent.externalId);
-    }];
+    [OneSignal addUserJwtInvalidatedListener:self];
 
     NSLog(@"UNUserNotificationCenter.delegate: %@", UNUserNotificationCenter.currentNotificationCenter.delegate);
 
@@ -130,6 +126,10 @@ - (void)onUserStateDidChangeWithState:(OSUserChangedState * _Nonnull)state {
     NSLog(@"Dev App onUserStateDidChangeWithState: %@", [state jsonRepresentation]);
 }
 
+- (void)onUserJwtInvalidatedWithEvent:(OSUserJwtInvalidatedEvent * _Nonnull)event {
+    NSLog(@"Dev App onUserJwtInvalidatedWithEvent: %@", [event jsonRepresentation]);
+}
+
 #pragma mark OSInAppMessageDelegate
 
 - (void)onClickInAppMessage:(OSInAppMessageClickEvent * _Nonnull)event {

iOS_SDK/OneSignalDevApp/OneSignalDevApp/SwiftTest.swift

@@ -28,10 +28,19 @@
 import Foundation
 import OneSignalFramework
 
-class SwiftTest: NSObject {
+class SwiftTest: NSObject, OSUserJwtInvalidatedListener {
+    func onUserJwtInvalidated(event: OSUserJwtInvalidatedEvent) {
+        print("event: \(event.jsonRepresentation())")
+        print("externalId: \(event.externalId)")
+    }
+
     func testSwiftUserModel() {
         let token1 = OneSignal.User.pushSubscription.token
         let token = OneSignal.User.pushSubscription.token
         OneSignal.Debug._dump()
+        OneSignal.login(externalId: "euid", token: "token")
+        OneSignal.updateUserJwt(externalId: "euid", token: "token")
+        OneSignal.addUserJwtInvalidatedListener(self)
+        OneSignal.removeUserJwtInvalidatedListener(self)
     }
 }

iOS_SDK/OneSignalSDK/OneSignal.xcodeproj/project.pbxproj

@@ -351,7 +351,7 @@
 		DE16C14524D3724700670EFA /* OneSignalLifecycleObserver.m in Sources */ = {isa = PBXBuildFile; fileRef = DE16C14324D3724700670EFA /* OneSignalLifecycleObserver.m */; };
 		DE16C14724D3727200670EFA /* OneSignalLifecycleObserver.h in Headers */ = {isa = PBXBuildFile; fileRef = DE16C14624D3727200670EFA /* OneSignalLifecycleObserver.h */; };
 		DE16C17024D3989A00670EFA /* OneSignalLifecycleObserver.m in Sources */ = {isa = PBXBuildFile; fileRef = DE16C14324D3724700670EFA /* OneSignalLifecycleObserver.m */; };
-		DE1DD0602C87D87B00787071 /* OSJwtInvalidatedEvent.swift in Sources */ = {isa = PBXBuildFile; fileRef = DE1DD05F2C87D87B00787071 /* OSJwtInvalidatedEvent.swift */; };
+		DE1DD0602C87D87B00787071 /* OSUserJwtInvalidatedEvent.swift in Sources */ = {isa = PBXBuildFile; fileRef = DE1DD05F2C87D87B00787071 /* OSUserJwtInvalidatedEvent.swift */; };
 		DE20425E24E21C2C00350E4F /* UIApplication+OneSignal.m in Sources */ = {isa = PBXBuildFile; fileRef = DE20425D24E21C2C00350E4F /* UIApplication+OneSignal.m */; };
 		DE20425F24E21C2C00350E4F /* UIApplication+OneSignal.m in Sources */ = {isa = PBXBuildFile; fileRef = DE20425D24E21C2C00350E4F /* UIApplication+OneSignal.m */; };
 		DE20426024E21C2C00350E4F /* UIApplication+OneSignal.m in Sources */ = {isa = PBXBuildFile; fileRef = DE20425D24E21C2C00350E4F /* UIApplication+OneSignal.m */; };
@@ -1521,7 +1521,7 @@
 		CACBAAAB218A662B000ACAA5 /* WebKit.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = WebKit.framework; path = System/Library/Frameworks/WebKit.framework; sourceTree = SDKROOT; };
 		DE16C14324D3724700670EFA /* OneSignalLifecycleObserver.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = OneSignalLifecycleObserver.m; sourceTree = "<group>"; };
 		DE16C14624D3727200670EFA /* OneSignalLifecycleObserver.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = OneSignalLifecycleObserver.h; sourceTree = "<group>"; };
-		DE1DD05F2C87D87B00787071 /* OSJwtInvalidatedEvent.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OSJwtInvalidatedEvent.swift; sourceTree = "<group>"; };
+		DE1DD05F2C87D87B00787071 /* OSUserJwtInvalidatedEvent.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OSUserJwtInvalidatedEvent.swift; sourceTree = "<group>"; };
 		DE20425C24E21C1500350E4F /* UIApplication+OneSignal.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "UIApplication+OneSignal.h"; sourceTree = "<group>"; };
 		DE20425D24E21C2C00350E4F /* UIApplication+OneSignal.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = "UIApplication+OneSignal.m"; sourceTree = "<group>"; };
 		DE3568E92C88F56600AF447C /* PropertyExecutorTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PropertyExecutorTests.swift; sourceTree = "<group>"; };
@@ -2126,7 +2126,7 @@
 				3C3130DF2CA383F800906665 /* OSUser.swift */,
 				3C3130E22CA3858500906665 /* OSPushSubscription.swift */,
 				3C5117162B15C31E00563465 /* OSUserState.swift */,
-				DE1DD05F2C87D87B00787071 /* OSJwtInvalidatedEvent.swift */,
+				DE1DD05F2C87D87B00787071 /* OSUserJwtInvalidatedEvent.swift */,
 			);
 			path = Public;
 			sourceTree = "<group>";
@@ -4330,7 +4330,7 @@
 			files = (
 				3CE795F928DB99B500736BD4 /* OSSubscriptionModelStoreListener.swift in Sources */,
 				DE69E1AC282ED87A0090BB3D /* OneSignalUserManagerImpl.swift in Sources */,
-				DE1DD0602C87D87B00787071 /* OSJwtInvalidatedEvent.swift in Sources */,
+				DE1DD0602C87D87B00787071 /* OSUserJwtInvalidatedEvent.swift in Sources */,
 				3C5929E32CAD9EC50020D6FF /* OneSignalUserManagerImpl+OSLoggable.swift in Sources */,
 				3C9AD6CF2B228B7800BC1540 /* OSRequestAddAliases.swift in Sources */,
 				3C9AD6D32B228BB000BC1540 /* OSRequestUpdateProperties.swift in Sources */,

iOS_SDK/OneSignalSDK/OneSignalUser/Source/OneSignalUserManagerImpl.swift

@@ -73,9 +73,19 @@ public class OneSignalUserManagerImpl: NSObject, OneSignalUserManager {
 
     var hasCalledStart = false
 
-    private var jwtInvalidatedHandler: OSJwtInvalidatedHandler?
     let jwtConfig: OSUserJwtConfig
 
+    private var _userJwtInvalidatedObserver: OSObservable<OSUserJwtInvalidatedListener, OSUserJwtInvalidatedEvent>?
+    var userJwtInvalidatedObserver: OSObservable<OSUserJwtInvalidatedListener, OSUserJwtInvalidatedEvent> {
+        if let observer = _userJwtInvalidatedObserver {
+            return observer
+        }
+        let userJwtInvalidatedObserver = OSObservable<OSUserJwtInvalidatedListener, OSUserJwtInvalidatedEvent>(change: #selector(OSUserJwtInvalidatedListener.onUserJwtInvalidated(event:)))
+        _userJwtInvalidatedObserver = userJwtInvalidatedObserver
+
+        return userJwtInvalidatedObserver
+    }
+
     var user: OSUserInternal {
         guard !OneSignalConfigManager.shouldAwaitAppIdAndLogMissingPrivacyConsent(forMethod: nil) else {
             return _mockUser
@@ -633,6 +643,16 @@ extension OneSignalUserManagerImpl {
 // MARK: - JWT
 
 extension OneSignalUserManagerImpl {
+    @objc
+    public func addUserJwtInvalidatedListener(_ listener: OSUserJwtInvalidatedListener) {
+        self.userJwtInvalidatedObserver.addObserver(listener)
+    }
+
+    @objc
+    public func removeUserJwtInvalidatedListener(_ listener: OSUserJwtInvalidatedListener) {
+        self.userJwtInvalidatedObserver.removeObserver(listener)
+    }
+
     @objc
     public func setRequiresUserAuth(_ required: Bool) {
         jwtConfig.isRequired = required
@@ -664,12 +684,8 @@ extension OneSignalUserManagerImpl {
     }
 
     private func fireJwtExpired(externalId: String) {
-        guard let jwtInvalidatedHandler = self.jwtInvalidatedHandler else {
-            return
-        }
-        let invalidatedEvent = OSJwtInvalidatedEvent(externalId: externalId)
-
-        jwtInvalidatedHandler(invalidatedEvent)
+        let event = OSUserJwtInvalidatedEvent(externalId: externalId)
+        userJwtInvalidatedObserver.notifyChange(event)
     }
 
     private func getMessageFromJwtError(_ error: NSError) -> String {
@@ -683,10 +699,6 @@ extension OneSignalUserManagerImpl {
 }
 
 extension OneSignalUserManagerImpl: OSUser {
-    public func onJwtInvalidated(invalidatedHandler: @escaping OSJwtInvalidatedHandler) {
-        jwtInvalidatedHandler = invalidatedHandler
-    }
-
     public var User: OSUser {
         start()
         return self

iOS_SDK/OneSignalSDK/OneSignalUser/Source/Public/OSUser.swift

@@ -57,7 +57,4 @@
     func removeSms(_ number: String)
     // Language
     func setLanguage(_ language: String)
-    // JWT Token Expire
-    typealias OSJwtInvalidatedHandler =  (_ event: OSJwtInvalidatedEvent) -> Void
-    func onJwtInvalidated(invalidatedHandler: @escaping OSJwtInvalidatedHandler)
 }

iOS_SDK/OneSignalSDK/OneSignalUser/Source/Public/OSJwtInvalidatedEvent.swift renamed to iOS_SDK/OneSignalSDK/OneSignalUser/Source/Public/OSUserJwtInvalidatedEvent.swift

@@ -25,12 +25,20 @@
  THE SOFTWARE.
  */
 
-import Foundation
-
-@objc public class OSJwtInvalidatedEvent: NSObject {
+@objc public class OSUserJwtInvalidatedEvent: NSObject {
     @objc public let externalId: String
 
     init(externalId: String) {
         self.externalId = externalId
     }
+
+    @objc public func jsonRepresentation() -> NSDictionary {
+        return [
+            "externalId": externalId
+        ]
+    }
+}
+
+@objc public protocol OSUserJwtInvalidatedListener {
+    @objc func onUserJwtInvalidated(event: OSUserJwtInvalidatedEvent)
 }

iOS_SDK/OneSignalSDK/Source/OneSignal.m

@@ -208,6 +208,16 @@ + (void)logout {
     [OneSignalUserManagerImpl.sharedInstance logout];
 }
 
++ (void)addUserJwtInvalidatedListener:(id<OSUserJwtInvalidatedListener>)listener {
+    [OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:@"User Jwt Invalidated Listener added successfully"];
+    [OneSignalUserManagerImpl.sharedInstance addUserJwtInvalidatedListener:listener];
+}
+
++ (void)removeUserJwtInvalidatedListener:(id<OSUserJwtInvalidatedListener>)listener {
+    [OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:@"User Jwt Invalidated Listener removed successfully"];
+    [OneSignalUserManagerImpl.sharedInstance removeUserJwtInvalidatedListener:listener];
+}
+
 + (void)updateUserJwt:(NSString * _Nonnull)externalId withToken:(NSString * _Nonnull)token {
     if ([OneSignalConfigManager shouldAwaitAppIdAndLogMissingPrivacyConsentForMethod:@"updateUserJwt"]) {
         return;

iOS_SDK/OneSignalSDK/Source/OneSignalFramework.h

@@ -70,7 +70,10 @@ typedef void (^OSFailureBlock)(NSError* error);
 + (void)login:(NSString * _Nonnull)externalId;
 + (void)login:(NSString * _Nonnull)externalId withToken:(NSString * _Nullable)token
 NS_SWIFT_NAME(login(externalId:token:));
-+ (void)updateUserJwt:(NSString * _Nonnull)externalId withToken:(NSString * _Nonnull)token;
++ (void)addUserJwtInvalidatedListener:(id<OSUserJwtInvalidatedListener> _Nonnull)listener NS_REFINED_FOR_SWIFT;
++ (void)removeUserJwtInvalidatedListener:(id<OSUserJwtInvalidatedListener>_Nonnull)listener NS_REFINED_FOR_SWIFT;
++ (void)updateUserJwt:(NSString * _Nonnull)externalId withToken:(NSString * _Nonnull)token
+NS_SWIFT_NAME(updateUserJwt(externalId:token:));
 + (void)logout;
 
 #pragma mark Notifications

iOS_SDK/OneSignalSDK/Source/OneSignalSwiftInterface.swift

@@ -33,6 +33,14 @@ import OneSignalNotifications
 import OneSignalCore
 
 public extension OneSignal {
+    static func addUserJwtInvalidatedListener(_ listener: OSUserJwtInvalidatedListener) {
+        __add(listener)
+    }
+
+    static func removeUserJwtInvalidatedListener(_ listener: OSUserJwtInvalidatedListener) {
+        __remove(listener)
+    }
+
     static var User: OSUser {
         return __user()
     }