@purchasely/cordova-plugin-purchasely 4.4.0 → 5.1.0

package/src/ios/CDVPurchasely+UserAttributes.m

@@ -0,0 +1,144 @@
+//
+//  CDVPurchasely+UserAttributes.m
+//  Purchasely Cordova Plugin
+//
+//  Created by Florian HUET on 26/03/2025.
+//
+
+#import <Purchasely/Purchasely-Swift.h>
+#import "CDVPurchasely+UserAttributes.h"
+#import "Purchasely_Hybrid.h"
+
+@implementation CDVPurchasely (UserAttributes)
+
+
+- (void)onUserAttributeSetWithKey:(NSString * _Nonnull)key
+                             type:(enum PLYUserAttributeType)type
+                            value:(id _Nullable)value
+                           source:(enum PLYUserAttributeSource)source {
+    NSDictionary *attributeDic = [self dictionaryFromUserAttributeWithKey:key type:type value:value source:source];
+    
+    CDVPluginResult* pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsDictionary:attributeDic];
+    
+    [pluginResult setKeepCallbackAsBool:YES];
+    [self.commandDelegate sendPluginResult:pluginResult callbackId:self.attributeCommand.callbackId];
+}
+
+- (void)onUserAttributeRemovedWithKey:(NSString * _Nonnull)key
+                               source:(enum PLYUserAttributeSource)source {
+    NSString *sourceString = [PLYUserAttributeSourceHelper stringFromUserAttributeSource:source];
+    
+    NSMutableDictionary<NSString *, id> *attributeDic = [@{
+        @"action": @"remove",
+        @"key": key,
+        @"source": sourceString
+    } mutableCopy];
+    
+    CDVPluginResult* pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsDictionary:attributeDic];
+    
+    [pluginResult setKeepCallbackAsBool:YES];
+    [self.commandDelegate sendPluginResult:pluginResult callbackId:self.attributeCommand.callbackId];
+}
+
+- (NSDictionary<NSString *, id> *)dictionaryFromUserAttributeWithKey:(NSString * _Nonnull)key
+                                                                type:(enum PLYUserAttributeType)type
+                                                               value:(id _Nullable)value
+                                                              source:(enum PLYUserAttributeSource)source {
+    NSString *typeString = [PLYUserAttributeTypeHelper stringFromUserAttributeType:type];
+    NSString *sourceString = [PLYUserAttributeSourceHelper stringFromUserAttributeSource:source];
+
+    NSMutableDictionary<NSString *, id> *attributeDic = [@{
+        @"action": @"add",
+        @"key": key,
+        @"type": typeString,
+        @"source": sourceString
+    } mutableCopy];
+
+    if (value) {
+        switch (type) {
+            case PLYUserAttributeTypeString:
+                if ([value isKindOfClass:[NSString class]]) {
+                    attributeDic[@"value"] = value;
+                }
+                break;
+            case PLYUserAttributeTypeBool:
+                if ([value isKindOfClass:[NSNumber class]]) {
+                    attributeDic[@"value"] = @([(NSNumber *)value boolValue]);
+                }
+                break;
+            case PLYUserAttributeTypeInt:
+                if ([value isKindOfClass:[NSNumber class]]) {
+                    attributeDic[@"value"] = @([(NSNumber *)value intValue]);
+                }
+                break;
+            case PLYUserAttributeTypeDouble:
+                if ([value isKindOfClass:[NSNumber class]]) {
+                    attributeDic[@"value"] = @([(NSNumber *)value doubleValue]);
+                }
+                break;
+            case PLYUserAttributeTypeDate:
+                if ([value isKindOfClass:[NSDate class]]) {
+                    attributeDic[@"value"] = [(NSDate *)value description]; // Convert to string
+                }
+                break;
+            case PLYUserAttributeTypeStringArray:
+                if ([value isKindOfClass:[NSArray class]]) {
+                    attributeDic[@"value"] = value; // Ensure it's an NSArray of NSString
+                }
+                break;
+            case PLYUserAttributeTypeIntArray:
+            case PLYUserAttributeTypeDoubleArray:
+            case PLYUserAttributeTypeBoolArray:
+                if ([value isKindOfClass:[NSArray class]]) {
+                    attributeDic[@"value"] = value; // Ensure it's an NSArray of NSNumber
+                }
+                break;
+            case PLYUserAttributeTypeDictionary:
+                if ([value isKindOfClass:[NSDictionary class]]) {
+                    attributeDic[@"value"] = value; // Ensure it's an NSDictionary
+                }
+                break;
+            default:
+                attributeDic[@"value"] = @"unknown";
+                break;
+        }
+    }
+
+    return [attributeDic copy];
+}
+
+
+@end
+
+@implementation PLYUserAttributeTypeHelper
+
++ (NSString *_Nullable)stringFromUserAttributeType:(PLYUserAttributeType)type {
+    switch (type) {
+        case PLYUserAttributeTypeString: return @"string";
+        case PLYUserAttributeTypeBool: return @"bool";
+        case PLYUserAttributeTypeInt: return @"int";
+        case PLYUserAttributeTypeDouble: return @"double";
+        case PLYUserAttributeTypeDate: return @"date";
+        case PLYUserAttributeTypeStringArray: return @"stringArray";
+        case PLYUserAttributeTypeIntArray: return @"intArray";
+        case PLYUserAttributeTypeDoubleArray: return @"doubleArray";
+        case PLYUserAttributeTypeBoolArray: return @"boolArray";
+        case PLYUserAttributeTypeDictionary: return @"dictionary";
+        case PLYUserAttributeTypeUnknown: return @"unknown";
+        default: return @"invalid";
+    }
+}
+
+@end
+
+@implementation PLYUserAttributeSourceHelper
+
++ (NSString *_Nullable)stringFromUserAttributeSource:(PLYUserAttributeSource)source {
+    switch (source) {
+        case PLYUserAttributeSourcePurchasely: return @"purchasely";
+        case PLYUserAttributeSourceClient: return @"client";
+        default: return @"unknown";
+    }
+}
+
+@end

package/src/ios/CDVPurchasely.h

@@ -8,13 +8,14 @@
 #import <Cordova/CDVPlugin.h>
 #import <Purchasely/Purchasely-Swift.h>
 
-@interface CDVPurchasely<PLYEventDelegate> : CDVPlugin {
+@interface CDVPurchasely<PLYEventDelegate, PLYUserAttributeDelegate> : CDVPlugin {
 }
 
 @property (nonatomic, retain) UIViewController* presentedPresentationViewController;
 
 @property CDVInvokedUrlCommand* purchasedCommand;
 @property CDVInvokedUrlCommand* eventCommand;
+@property CDVInvokedUrlCommand* attributeCommand;
 
 @property (nonatomic) NSMutableArray<PLYPresentation *> *presentationsLoaded;
 @property (nonatomic, assign) Boolean shouldReopenPaywall;
@@ -56,17 +57,24 @@
 - (void)hidePresentation:(CDVInvokedUrlCommand*)command;
 - (void)showPresentation:(CDVInvokedUrlCommand*)command;
 - (void)userDidConsumeSubscriptionContent:(CDVInvokedUrlCommand*)command;
+- (void)setUserAttributeWithStringArray:(CDVInvokedUrlCommand*)command;
+- (void)setUserAttributeWithIntArray:(CDVInvokedUrlCommand*)command;
+- (void)setUserAttributeWithDoubleArray:(CDVInvokedUrlCommand*)command;
+- (void)setUserAttributeWithBooleanArray:(CDVInvokedUrlCommand*)command;
 - (void)setUserAttributeWithString:(CDVInvokedUrlCommand*)command;
 - (void)setUserAttributeWithBoolean:(CDVInvokedUrlCommand*)command;
 - (void)setUserAttributeWithInt:(CDVInvokedUrlCommand*)command;
+- (void)setUserAttributeWithDouble:(CDVInvokedUrlCommand*)command;
 - (void)setUserAttributeWithDate:(CDVInvokedUrlCommand*)command;
 - (void)userAttribute:(CDVInvokedUrlCommand*)command;
 - (void)clearUserAttribute:(CDVInvokedUrlCommand*)command;
 - (void)clearUserAttributes:(CDVInvokedUrlCommand*)command;
+- (void)clearBuiltInAttributes:(CDVInvokedUrlCommand*)command;
 - (void)fetchPresentation:(CDVInvokedUrlCommand*)command;
 - (void)presentPresentation:(CDVInvokedUrlCommand*)command;
 - (void)signPromotionalOffer:(CDVInvokedUrlCommand*)command;
 - (void)isEligibleForIntroOffer:(CDVInvokedUrlCommand*)command;
 - (void)setThemeMode:(CDVInvokedUrlCommand*)command;
+- (void)addUserAttributeListener:(CDVInvokedUrlCommand*)command;
 
 @end

package/src/ios/CDVPurchasely.m

@@ -62,7 +62,7 @@
 }
 
 - (void)userLogout:(CDVInvokedUrlCommand*)command {
-    [Purchasely userLogout];
+    [Purchasely userLogout:YES];
 }
 
 - (void)setThemeMode:(CDVInvokedUrlCommand *)command {
@@ -72,9 +72,87 @@
 }
 
 - (void)setAttribute:(CDVInvokedUrlCommand*)command {
-    NSInteger attribute = [[command argumentAtIndex:0] intValue];
+    NSNumber *attributeNumber = [command argumentAtIndex:0];
     NSString *value = [command argumentAtIndex:1];
 
+    if (attributeNumber == nil || value == nil) {
+        return;
+    }
+
+    NSInteger rawAttribute = [attributeNumber integerValue];
+    PLYAttribute *attribute = nil;
+
+    switch (rawAttribute) {
+        case CordovaPLYAttributeFirebaseAppInstanceId:
+            attribute = PLYAttributeFirebaseAppInstanceId;
+            break;
+        case CordovaPLYAttributeAirshipChannelId:
+            attribute = PLYAttributeAirshipChannelId;
+            break;
+        case CordovaPLYAttributeAirshipUserId:
+            attribute = PLYAttributeAirshipUserId;
+            break;
+        case CordovaPLYAttributeBatchInstallationId:
+            attribute = PLYAttributeBatchInstallationId;
+            break;
+        case CordovaPLYAttributeAdjustId:
+            attribute = PLYAttributeAdjustId;
+            break;
+        case CordovaPLYAttributeAppsflyerId:
+            attribute = PLYAttributeAppsflyerId;
+            break;
+        case CordovaPLYAttributeMixpanelDistinctId:
+            attribute = PLYAttributeMixpanelDistinctId;
+            break;
+        case CordovaPLYAttributeCleverTapId:
+            attribute = PLYAttributeClevertapId;
+            break;
+        case CordovaPLYAttributeSendinblueUserEmail:
+            attribute = PLYAttributeSendinblueUserEmail;
+            break;
+        case CordovaPLYAttributeIterableUserEmail:
+            attribute = PLYAttributeIterableUserEmail;
+            break;
+        case CordovaPLYAttributeIterableUserId:
+            attribute = PLYAttributeIterableUserId;
+            break;
+        case CordovaPLYAttributeAtInternetIdClient:
+            attribute = PLYAttributeAtInternetIdClient;
+            break;
+        case CordovaPLYAttributeMParticleUserId:
+            attribute = PLYAttributeMParticleUserId;
+            break;
+        case CordovaPLYAttributeCustomerioUserId:
+            attribute = PLYAttributeCustomerioUserId;
+            break;
+        case CordovaPLYAttributeCustomerioUserEmail:
+            attribute = PLYAttributeCustomerioUserEmail;
+            break;
+        case CordovaPLYAttributeBranchUserDeveloperIdentity:
+            attribute = PLYAttributeBranchUserDeveloperIdentity;
+            break;
+        case CordovaPLYAttributeAmplitudeUserId:
+            attribute = PLYAttributeAmplitudeUserId;
+            break;
+        case CordovaPLYAttributeAmplitudeDeviceId:
+            attribute = PLYAttributeAmplitudeDeviceId;
+            break;
+        case CordovaPLYAttributeMoengageUniqueId:
+            attribute = PLYAttributeMoengageUniqueId;
+            break;
+        case CordovaPLYAttributeOneSignalExternalId:
+            attribute = PLYAttributeOneSignalExternalId;
+            break;
+        case CordovaPLYAttributeBatchCustomUserId:
+            attribute = PLYAttributeBatchCustomUserId;
+            break;
+    }
+
+
+    if (attribute == nil) {
+        return;
+    }
+
     [Purchasely setAttribute:attribute value:value];
 }
 
@@ -370,6 +448,16 @@
     self.eventCommand = nil;
 }
 
+- (void)removeUserAttributeListener:(CDVInvokedUrlCommand*)command {
+    [Purchasely setUserAttributeDelegate:nil];
+    self.attributeCommand = nil;
+}
+
+- (void)addUserAttributeListener:(CDVInvokedUrlCommand*)command {
+    [Purchasely setUserAttributeDelegate:self];
+    self.attributeCommand = command;
+}
+
 - (void)isDeeplinkHandled:(CDVInvokedUrlCommand*)command {
     NSString *deeplinkString = [command argumentAtIndex:0];
     NSURL *deeplink = [NSURL URLWithString:deeplinkString];
@@ -579,6 +667,48 @@
     [Purchasely userDidConsumeSubscriptionContent];
 }
 
+- (void)setUserAttributeWithStringArray:(CDVInvokedUrlCommand*)command {
+    NSString *key = [command argumentAtIndex:0];
+    NSArray<NSString *> *array = [command argumentAtIndex:1];
+    [Purchasely setUserAttributeWithStringArray:array forKey:key];
+}
+
+- (void)setUserAttributeWithBooleanArray:(CDVInvokedUrlCommand*)command {
+    NSString *key = [command argumentAtIndex:0];
+    NSArray *values = [command argumentAtIndex:1];
+
+    NSMutableArray<NSNumber *> *boolArray = [NSMutableArray array];
+    for (id value in values) {
+        [boolArray addObject:@([value boolValue])];
+    }
+
+    [Purchasely setUserAttributeWithBoolArray:boolArray forKey:key];
+}
+
+- (void)setUserAttributeWithIntArray:(CDVInvokedUrlCommand*)command {
+    NSString *key = [command argumentAtIndex:0];
+    NSArray *values = [command argumentAtIndex:1];
+
+    NSMutableArray<NSNumber *> *intArray = [NSMutableArray array];
+    for (id val in values) {
+        [intArray addObject:@([val intValue])];
+    }
+
+    [Purchasely setUserAttributeWithIntArray:intArray forKey:key];
+}
+
+- (void)setUserAttributeWithDoubleArray:(CDVInvokedUrlCommand*)command {
+    NSString *key = [command argumentAtIndex:0];
+    NSArray *values = [command argumentAtIndex:1];
+
+    NSMutableArray<NSNumber *> *doubleArray = [NSMutableArray array];
+    for (id val in values) {
+        [doubleArray addObject:@([val doubleValue])];
+    }
+
+    [Purchasely setUserAttributeWithDoubleArray:doubleArray forKey:key];
+}
+
 - (void)setUserAttributeWithString:(CDVInvokedUrlCommand*)command {
     NSString *key = [command argumentAtIndex:0];
     NSString *value = [command argumentAtIndex:1];
@@ -650,6 +780,10 @@
     [Purchasely clearUserAttributes];
 }
 
+- (void)clearBuiltInAttributes:(CDVInvokedUrlCommand*)command {
+    [Purchasely clearBuiltInAttributes];
+}
+
 - (void)fetchPresentation:(CDVInvokedUrlCommand*)command {
     NSString *placementId = [command argumentAtIndex:0];
     NSString *presentationId = [command argumentAtIndex:1];
@@ -668,7 +802,7 @@
                    if (self.purchaseResolve != nil){
                        [self successFor:self.purchaseResolve resultDict:[self resultDictionaryForPresentationController:result plan:plan]];
                    }
-               }];
+               } loadedCompletion:nil];
            } else {
                [Purchasely fetchPresentationWith:presentationId contentId: contentId fetchCompletion:^(PLYPresentation * _Nullable presentation, NSError * _Nullable error) {
                    if (error != nil) {
@@ -681,7 +815,7 @@
                    if (self.purchaseResolve != nil) {
                        [self successFor:self.purchaseResolve resultDict:[self resultDictionaryForPresentationController:result plan:plan]];
                    }
-               }];
+               } loadedCompletion:nil];
            }
        });
 }
@@ -911,4 +1045,29 @@
 }
 
 
+// WARNING: This enum must be strictly identical to the one in the JS side (Purchasely.js).
+typedef NS_ENUM(NSInteger, CordovaPLYAttribute) {
+    CordovaPLYAttributeFirebaseAppInstanceId,
+    CordovaPLYAttributeAirshipChannelId,
+    CordovaPLYAttributeAirshipUserId,
+    CordovaPLYAttributeBatchInstallationId,
+    CordovaPLYAttributeAdjustId,
+    CordovaPLYAttributeAppsflyerId,
+    CordovaPLYAttributeMixpanelDistinctId,
+    CordovaPLYAttributeCleverTapId,
+    CordovaPLYAttributeSendinblueUserEmail,
+    CordovaPLYAttributeIterableUserEmail,
+    CordovaPLYAttributeIterableUserId,
+    CordovaPLYAttributeAtInternetIdClient,
+    CordovaPLYAttributeMParticleUserId,
+    CordovaPLYAttributeCustomerioUserId,
+    CordovaPLYAttributeCustomerioUserEmail,
+    CordovaPLYAttributeBranchUserDeveloperIdentity,
+    CordovaPLYAttributeAmplitudeUserId,
+    CordovaPLYAttributeAmplitudeDeviceId,
+    CordovaPLYAttributeMoengageUniqueId,
+    CordovaPLYAttributeOneSignalExternalId,
+    CordovaPLYAttributeBatchCustomUserId
+};
+
 @end

package/www/Purchasely.js

@@ -5,7 +5,7 @@ var defaultError = (e) => { console.log(e); }
 exports.start = function (apiKey, stores, storekit1, userId, logLevel, runningMode, success, error) {
     var cordovaSdkVersion = cordova.define.moduleMap['cordova/plugin_list'].exports['metadata']['cordova-plugin-purchasely']
     if(!cordovaSdkVersion) {
-        cordovaSdkVersion = "4.4.0";
+        cordovaSdkVersion = "5.1.0";
     }
     exec(success, error, 'Purchasely', 'start', [apiKey, stores, storekit1, userId, logLevel, runningMode, cordovaSdkVersion]);
 };
@@ -14,6 +14,14 @@ exports.addEventsListener = function (success, error) {
     exec(success, error, 'Purchasely', 'addEventsListener', []);
 };
 
+exports.addUserAttributeListener = function(success, error) {
+    exec(success, error, 'Purchasely', 'addUserAttributeListener', []);
+};
+
+exports.removeUserAttributeListener = function () {
+    exec(() => {}, defaultError, 'Purchasely', 'removeUserAttributeListener', []);
+};
+
 exports.removeEventsListener = function () {
     exec(() => {}, defaultError, 'Purchasely', 'removeEventsListener', []);
 };
@@ -170,6 +178,22 @@ exports.setUserAttributeWithDate = function (key, value) {
     exec(() => {}, defaultError, 'Purchasely', 'setUserAttributeWithDate', [key, value]);
 };
 
+exports.setUserAttributeWithStringArray = function (key, value) {
+    exec(() => {}, defaultError, 'Purchasely', 'setUserAttributeWithStringArray', [key, value]);
+}
+
+exports.setUserAttributeWithIntArray = function (key, value) {
+    exec(() => {}, defaultError, 'Purchasely', 'setUserAttributeWithIntArray', [key, value]);
+}
+
+exports.setUserAttributeWithDoubleArray = function (key, value) {
+    exec(() => {}, defaultError, 'Purchasely', 'setUserAttributeWithDoubleArray', [key, value]);
+}
+
+exports.setUserAttributeWithBooleanArray = function (key, value) {
+    exec(() => {}, defaultError, 'Purchasely', 'setUserAttributeWithBooleanArray', [key, value]);
+}
+
 exports.userAttribute = function (key, success, error) {
     exec(success, error, 'Purchasely', 'userAttribute', [key]);
 };
@@ -182,6 +206,10 @@ exports.clearUserAttributes = function () {
     exec(() => {}, defaultError, 'Purchasely', 'clearUserAttributes', []);
 };
 
+exports.clearBuiltInAttributes = function () {
+    exec(() => {}, defaultError, 'Purchasely', 'clearBuiltInAttributes', []);
+}
+
 exports.isEligibleForIntroOffer = function (planId, success, error) {
     exec(success, error, 'Purchasely', 'isEligibleForIntroOffer', [planId]);
 };
@@ -208,22 +236,21 @@ exports.Attribute = {
   BATCH_INSTALLATION_ID: 3,
   ADJUST_ID: 4,
   APPSFLYER_ID: 5,
-  ONESIGNAL_PLAYER_ID: 6,
-  MIXPANEL_DISTINCT_ID: 7,
-  CLEVER_TAP_ID: 8,
-  SENDINBLUE_USER_EMAIL: 9,
-  ITERABLE_USER_EMAIL: 10,
-  ITERABLE_USER_ID: 11,
-  AT_INTERNET_ID_CLIENT: 12,
-  MPARTICLE_USER_ID: 13,
-  CUSTOMERIO_USER_ID: 14,
-  CUSTOMERIO_USER_EMAIL: 15,
-  BRANCH_USER_DEVELOPER_IDENTITY: 16,
-  AMPLITUDE_USER_ID: 17,
-  AMPLITUDE_DEVICE_ID: 18,
-  MOENGAGE_UNIQUE_ID: 19,
-  ONESIGNAL_EXTERNAL_ID: 20,
-  BATCH_CUSTOM_USER_ID: 21,
+  MIXPANEL_DISTINCT_ID: 6,
+  CLEVER_TAP_ID: 7,
+  SENDINBLUE_USER_EMAIL: 8,
+  ITERABLE_USER_EMAIL: 9,
+  ITERABLE_USER_ID: 10,
+  AT_INTERNET_ID_CLIENT: 11,
+  MPARTICLE_USER_ID: 12,
+  CUSTOMERIO_USER_ID: 13,
+  CUSTOMERIO_USER_EMAIL: 14,
+  BRANCH_USER_DEVELOPER_IDENTITY: 15,
+  AMPLITUDE_USER_ID: 16,
+  AMPLITUDE_DEVICE_ID: 17,
+  MOENGAGE_UNIQUE_ID: 18,
+  ONESIGNAL_EXTERNAL_ID: 19,
+  BATCH_CUSTOM_USER_ID: 20,
 }
 
 exports.PurchaseResult = {
@@ -270,3 +297,8 @@ exports.ThemeMode = {
 	dark: 1,
 	system: 2
 }
+
+exports.UserAttributeAction = {
+    ADD: 'add',
+    REMOVE: 'remove'
+}