@purchasely/cordova-plugin-purchasely 6.0.0-rc.1 → 6.0.0

package/src/ios/CDVPurchasely.m

@@ -110,13 +110,22 @@
 
 - (void)userLogin:(CDVInvokedUrlCommand*)command {
     NSString *userId = [command argumentAtIndex:0];
+    // CDV-W-08: userLoginWith:appUserId: is _Nonnull; align with Android's guard instead of
+    // forwarding nil into the native call.
+    if (![userId isKindOfClass:[NSString class]]) {
+        [self successFor:command resultBool:NO];
+        return;
+    }
     [Purchasely userLoginWith:userId shouldRefresh:^(BOOL refresh) {
         [self successFor:command resultBool:refresh];
     }];
 }
 
 - (void)userLogout:(CDVInvokedUrlCommand*)command {
-    [Purchasely userLogout:YES];
+    // PAR-30: clearUserAttributes defaults to true (matches the JS-side default).
+    NSNumber *clearUserAttributes = [command argumentAtIndex:0];
+    BOOL clear = [clearUserAttributes isKindOfClass:[NSNumber class]] ? clearUserAttributes.boolValue : YES;
+    [Purchasely userLogout:clear];
 }
 
 - (void)setThemeMode:(CDVInvokedUrlCommand *)command {
@@ -201,6 +210,9 @@
         case CordovaPLYAttributeBatchCustomUserId:
             attribute = PLYAttributeBatchCustomUserId;
             break;
+        case CordovaPLYAttributeOneSignalUserId:
+            attribute = PLYAttributeOneSignalUserId;
+            break;
         default:
             attributeFound = NO;
             break;
@@ -219,6 +231,11 @@
     [self successFor:command resultString:anonymousId];
 }
 
+// REC-12 / PAR-04
+- (void)isAnonymous:(CDVInvokedUrlCommand*)command {
+    [self successFor:command resultBool:[Purchasely isAnonymous]];
+}
+
 - (void)allowDeeplink:(CDVInvokedUrlCommand*)command {
     BOOL allow = [[command argumentAtIndex:0] boolValue];
     [Purchasely allowDeeplink: allow];
@@ -276,7 +293,7 @@
         [r setKeepCallbackAsBool:YES];
         [strongSelf.commandDelegate sendPluginResult:r callbackId:callbackId];
     }];
-    builder = [builder onClose:^{
+    builder = [builder onCloseRequested:^{
         CDVPurchasely *strongSelf = weakSelf; if (strongSelf == nil) return;
         CDVPluginResult *r = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsDictionary:@{@"event": @"closeRequested"}];
         [r setKeepCallbackAsBool:YES];
@@ -408,6 +425,11 @@
 
 - (void)purchasedSubscription:(CDVInvokedUrlCommand*)command {
     self.purchasedCommand = command;
+    // CDV-W-14: a repeat JS call (re-subscribe/hot reload) must not stack observers, or a
+    // single purchase/restoration fires reloadContent: once per accumulated registration.
+    [[NSNotificationCenter defaultCenter] removeObserver:self
+                                                     name: @"ply_purchasedSubscription"
+                                                   object:nil];
     [[NSNotificationCenter defaultCenter] addObserver:self
                                              selector:@selector(reloadContent:)
                                                  name: @"ply_purchasedSubscription"
@@ -455,7 +477,10 @@
 }
 
 - (void)userSubscriptions:(CDVInvokedUrlCommand*)command {
-    [Purchasely userSubscriptions:false
+    // PAR-29: invalidateCache defaults to false.
+    NSNumber *invalidateCache = [command argumentAtIndex:0];
+    BOOL invalidate = [invalidateCache isKindOfClass:[NSNumber class]] ? invalidateCache.boolValue : NO;
+    [Purchasely userSubscriptions:invalidate
                           success:^(NSArray<PLYSubscription *> * _Nullable subscriptions) {
         NSMutableArray *result = [NSMutableArray new];
         for (PLYSubscription *subscription in subscriptions) {
@@ -469,7 +494,10 @@
 }
 
 - (void)userSubscriptionsHistory:(CDVInvokedUrlCommand*)command {
-    [Purchasely userSubscriptionsHistory:false
+    // PAR-29: invalidateCache defaults to false.
+    NSNumber *invalidateCache = [command argumentAtIndex:0];
+    BOOL invalidate = [invalidateCache isKindOfClass:[NSNumber class]] ? invalidateCache.boolValue : NO;
+    [Purchasely userSubscriptionsHistory:invalidate
                           success:^(NSArray<PLYSubscription *> * _Nullable subscriptions) {
         NSMutableArray *result = [NSMutableArray new];
         for (PLYSubscription *subscription in subscriptions) {
@@ -530,7 +558,10 @@
         if (@available(iOS 12.2, *)) {
             [Purchasely signPromotionalOfferWithStoreProductId:storeProductId storeOfferId:storeOfferId success:^(PLYOfferSignature * _Nonnull signature) {
                 NSDictionary* result = [self resultSignatureForSignPromoOffer:signature];
-                [self successFor:command resultBool:result];
+                // CDV-W-02: was resultBool: (an NSDictionary implicitly truncated to a bare
+                // BOOL), discarding the whole signature payload. resultDict: is the matching
+                // overload (declared below) for this NSDictionary result.
+                [self successFor:command resultDict:result];
             } failure:^(NSError * _Nullable error) {
                 [self failureFor:command resultString:error.localizedDescription];
             }];
@@ -553,15 +584,62 @@
     }];
 }
 
+// PAR-05: Dynamic Offerings. Payload keys (reference/planVendorId/offerVendorId) match the
+// Cordova JS↔native contract (not the native SDK's own planId/offerId property names).
+- (void)setDynamicOffering:(CDVInvokedUrlCommand*)command {
+    NSString *reference = [command argumentAtIndex:0];
+    NSString *planVendorId = [command argumentAtIndex:1];
+    NSString *offerVendorId = [command argumentAtIndex:2];
+    if (![offerVendorId isKindOfClass:[NSString class]]) {
+        offerVendorId = nil;
+    }
+    // iOS 26.4+ Apple commitment billing plan type (0 unspecified / 1 upFront / 2 monthly);
+    // JS defaults it to unspecified when omitted (see Purchasely.BillingPlanType).
+    PLYBillingPlanType billingPlanType = [[command argumentAtIndex:3 withDefault:@(PLYBillingPlanTypeUnspecified)] integerValue];
+
+    [Purchasely setDynamicOfferingWithReference:reference
+                                    planVendorId:planVendorId
+                                   offerVendorId:offerVendorId
+                                 billingPlanType:billingPlanType
+                                      completion:^(BOOL success) {
+        [self successFor:command resultBool:success];
+    }];
+}
+
+- (void)getDynamicOfferings:(CDVInvokedUrlCommand*)command {
+    [Purchasely getDynamicOfferingsWithCompletion:^(NSArray<PLYOffering *> * _Nonnull offerings) {
+        NSMutableArray *result = [NSMutableArray new];
+        for (PLYOffering *offering in offerings) {
+            NSMutableDictionary<NSString *, id> *dict = [NSMutableDictionary new];
+            dict[@"reference"] = offering.reference;
+            dict[@"planVendorId"] = offering.planId;
+            dict[@"offerVendorId"] = offering.offerId ?: [NSNull null];
+            [result addObject:dict];
+        }
+        [self successFor:command resultArray:result];
+    }];
+}
+
+- (void)removeDynamicOffering:(CDVInvokedUrlCommand*)command {
+    NSString *reference = [command argumentAtIndex:0];
+    if ([reference isKindOfClass:[NSString class]]) {
+        [Purchasely removeDynamicOfferingWithReference:reference];
+    }
+}
+
+- (void)clearDynamicOfferings:(CDVInvokedUrlCommand*)command {
+    [Purchasely clearDynamicOfferings];
+}
+
 // Helpers
 
-// v6: builds a PLYDisplayMode from the JS transition object (see normalizeTransition):
+// v6: builds a PLYTransition from the JS transition object (see normalizeTransition):
 //   { type, dismissible?, height?: { type: 'pixel'|'percentage', value }, backgroundColor? }
 // (a bare mode string is also tolerated). Objective-C only exposes percentage height for
 // drawer/popin (pixel height and popin width are Swift-only in the SDK), so those honor a
 // percentage height + dismissible + background colors; other dimensions are ignored.
 // Returns nil for an unknown/absent value so the backend-defined default is honored.
-- (PLYDisplayMode * _Nullable) displayModeFromTransition:(id) transition {
+- (PLYTransition * _Nullable) displayModeFromTransition:(id) transition {
     NSDictionary *map = [transition isKindOfClass:[NSDictionary class]] ? transition : nil;
     NSString *type = map != nil ? map[@"type"] : ([transition isKindOfClass:[NSString class]] ? transition : nil);
     if (![type isKindOfClass:[NSString class]]) {
@@ -593,17 +671,17 @@
     }
 
     if ([type isEqualToString:@"fullScreen"]) {
-        return [PLYDisplayMode fullScreen];
+        return [PLYTransition fullScreen];
     } else if ([type isEqualToString:@"modal"]) {
-        return [PLYDisplayMode modalWithDismissible:dismissible];
+        return [PLYTransition modalWithDismissible:dismissible];
     } else if ([type isEqualToString:@"push"]) {
-        return [PLYDisplayMode push];
+        return [PLYTransition push];
     } else if ([type isEqualToString:@"inlinePaywall"]) {
-        return [PLYDisplayMode inlinePaywall];
+        return [PLYTransition inlinePaywall];
     } else if ([type isEqualToString:@"drawer"]) {
-        return [[PLYDisplayMode alloc] initWithType:PLYDisplayModeTypeDrawer heightPercentage:heightPercentage backgroundColors:backgroundColors dismissible:dismissible];
+        return [[PLYTransition alloc] initWithType:PLYTransitionTypeDrawer heightPercentage:heightPercentage backgroundColors:backgroundColors dismissible:dismissible];
     } else if ([type isEqualToString:@"popin"]) {
-        return [[PLYDisplayMode alloc] initWithType:PLYDisplayModeTypePopin heightPercentage:heightPercentage backgroundColors:backgroundColors dismissible:dismissible];
+        return [[PLYTransition alloc] initWithType:PLYTransitionTypePopin heightPercentage:heightPercentage backgroundColors:backgroundColors dismissible:dismissible];
     }
     return nil;
 }
@@ -736,8 +814,8 @@
         }
         id<PLYPresentation> presentation = info.presentation;
         if (presentation != nil) {
-            if (presentation.id != nil) {
-                [infosResult setObject:presentation.id forKey:@"presentationId"];
+            if (presentation.screenId != nil) {
+                [infosResult setObject:presentation.screenId forKey:@"presentationId"];
             }
             if (presentation.placementId != nil) {
                 [infosResult setObject:presentation.placementId forKey:@"placementId"];
@@ -890,6 +968,9 @@ static BOOL PLYPresentationActionFromString(NSString *kind, PLYPresentationActio
     completion(result);
 }
 
+// PAR-19: closeAllScreens is the canonical native action; closePresentation is kept as a
+// separate (deprecated, fire-and-forget) action since existing native `close` behavior is
+// preserved as-is, while closeAllScreens additionally reports success/error to JS.
 - (void)closePresentation:(CDVInvokedUrlCommand*)command {
     dispatch_async(dispatch_get_main_queue(), ^{
         [Purchasely closeAllScreens];
@@ -897,6 +978,14 @@ static BOOL PLYPresentationActionFromString(NSString *kind, PLYPresentationActio
     });
 }
 
+- (void)closeAllScreens:(CDVInvokedUrlCommand*)command {
+    dispatch_async(dispatch_get_main_queue(), ^{
+        [Purchasely closeAllScreens];
+        self.currentPresentation = nil;
+        [self successFor:command];
+    });
+}
+
 - (void)backPresentation:(CDVInvokedUrlCommand*)command {
     dispatch_async(dispatch_get_main_queue(), ^{
         if (self.currentPresentation != nil) {
@@ -1070,6 +1159,34 @@ static BOOL PLYPresentationActionFromString(NSString *kind, PLYPresentationActio
     }
 }
 
+// REC-12 / PAR-03: bulk read, same per-value conversion as the single-key read above.
+- (void)userAttributes:(CDVInvokedUrlCommand*)command {
+    NSMutableDictionary<NSString *, id> *result = [NSMutableDictionary new];
+    NSDictionary<NSString *, id> *attributes = [Purchasely userAttributes];
+    for (NSString *key in attributes) {
+        id value = [self getUserAttributeValueForCordova:attributes[key]];
+        if (value != nil) {
+            result[key] = value;
+        }
+    }
+    [self successFor:command resultDict:result];
+}
+
+// REC-12 / PAR-02
+- (void)incrementUserAttribute:(CDVInvokedUrlCommand*)command {
+    NSString *key = [command argumentAtIndex:0];
+    NSNumber *valueNumber = [command argumentAtIndex:1];
+    NSInteger value = [valueNumber isKindOfClass:[NSNumber class]] ? valueNumber.integerValue : 1;
+    [Purchasely incrementUserAttributeWithKey:key value:value];
+}
+
+- (void)decrementUserAttribute:(CDVInvokedUrlCommand*)command {
+    NSString *key = [command argumentAtIndex:0];
+    NSNumber *valueNumber = [command argumentAtIndex:1];
+    NSInteger value = [valueNumber isKindOfClass:[NSNumber class]] ? valueNumber.integerValue : 1;
+    [Purchasely decrementUserAttributeWithKey:key value:value];
+}
+
 - (id _Nullable) getUserAttributeValueForCordova:(id _Nullable) value {
     if ([value isKindOfClass:[NSDate class]]) {
         NSDateFormatter * dateFormatter = [NSDateFormatter new];
@@ -1095,6 +1212,31 @@ static BOOL PLYPresentationActionFromString(NSString *kind, PLYPresentationActio
     [Purchasely clearBuiltInAttributes];
 }
 
+// PAR-07
+- (void)getBuiltInAttributes:(CDVInvokedUrlCommand*)command {
+    NSMutableDictionary<NSString *, id> *result = [NSMutableDictionary new];
+    NSDictionary<NSString *, id> *attributes = [Purchasely getBuiltInAttributes];
+    for (NSString *key in attributes) {
+        id value = [self getUserAttributeValueForCordova:attributes[key]];
+        if (value != nil) {
+            result[key] = value;
+        }
+    }
+    [self successFor:command resultDict:result];
+}
+
+- (void)getBuiltInAttribute:(CDVInvokedUrlCommand*)command {
+    NSString *key = [command argumentAtIndex:0];
+    id _Nullable result = [self getUserAttributeValueForCordova:[Purchasely getBuiltInAttributeWith:key]];
+    if (result != nil) {
+        [self successFor:command resultDict:result];
+    } else {
+        // No attribute for this key: resolve success with no value (undefined in JS),
+        // matching Android's nullable Any? return.
+        [self successFor:command];
+    }
+}
+
 - (void)fetchPresentation:(CDVInvokedUrlCommand*)command {
     NSString *placementId = [command argumentAtIndex:0];
     NSString *presentationId = [command argumentAtIndex:1];
@@ -1176,7 +1318,7 @@ static BOOL PLYPresentationActionFromString(NSString *kind, PLYPresentationActio
             [r setKeepCallbackAsBool:YES];
             [strongSelf.commandDelegate sendPluginResult:r callbackId:callbackId];
         };
-        presentationLoaded.onClose = ^{
+        presentationLoaded.onCloseRequested = ^{
             CDVPurchasely *strongSelf = weakSelf; if (strongSelf == nil) return;
             CDVPluginResult *r = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsDictionary:@{@"event": @"closeRequested"}];
             [r setKeepCallbackAsBool:YES];
@@ -1224,7 +1366,7 @@ static BOOL PLYPresentationActionFromString(NSString *kind, PLYPresentationActio
 
 - (id<PLYPresentation>) findPresentationLoadedFor:(NSString * _Nullable) presentationId {
     for (id<PLYPresentation> presentationLoaded in self.presentationsLoaded) {
-        if ([presentationLoaded.id isEqualToString: presentationId]) {
+        if ([presentationLoaded.screenId isEqualToString: presentationId]) {
             return presentationLoaded;
         }
     }
@@ -1234,7 +1376,7 @@ static BOOL PLYPresentationActionFromString(NSString *kind, PLYPresentationActio
 - (NSInteger) findIndexPresentationLoadedFor:(NSString * _Nullable) presentationId {
     NSInteger index = 0;
     for (id<PLYPresentation> presentationLoaded in self.presentationsLoaded) {
-        if ([presentationLoaded.id isEqualToString: presentationId]) {
+        if ([presentationLoaded.screenId isEqualToString: presentationId]) {
             return index;
         }
         index++;
@@ -1269,8 +1411,16 @@ static BOOL PLYPresentationActionFromString(NSString *kind, PLYPresentationActio
 
     if (presentation != nil) {
 
-        if (presentation.id != nil) {
-            [presentationResult setObject:presentation.id forKey:@"id"];
+        if (presentation.screenId != nil) {
+            // `screenId` is the sole authoritative, public presentation identifier (matches
+            // Android's presentationToMap() key, so shared JS reads either platform the same
+            // way). `id` is kept ONLY as a private/internal re-display lookup key --
+            // findPresentationLoadedFor:/findIndexPresentationLoadedFor: key off it, and on
+            // this platform it always equals screenId (iOS has no separate synthetic fetch
+            // handle, unlike Android's `fetchId`) -- it is NOT a documented public field; the
+            // JS bridge normalizes with `screenId ?? id` tolerance and never surfaces `id`.
+            [presentationResult setObject:presentation.screenId forKey:@"id"];
+            [presentationResult setObject:presentation.screenId forKey:@"screenId"];
         }
 
         if (presentation.placementId != nil) {
@@ -1411,7 +1561,8 @@ static BOOL PLYPresentationActionFromString(NSString *kind, PLYPresentationActio
 }
 
 
-// WARNING: This enum must be strictly identical to the one in the JS side (Purchasely.js).
+// WARNING: This enum must be strictly identical (same declaration order) to the one in
+// the JS side (Purchasely.js) and Android's CordovaPLYAttribute enum class.
 typedef NS_ENUM(NSInteger, CordovaPLYAttribute) {
     CordovaPLYAttributeFirebaseAppInstanceId,
     CordovaPLYAttributeAirshipChannelId,
@@ -1433,7 +1584,8 @@ typedef NS_ENUM(NSInteger, CordovaPLYAttribute) {
     CordovaPLYAttributeAmplitudeDeviceId,
     CordovaPLYAttributeMoengageUniqueId,
     CordovaPLYAttributeOneSignalExternalId,
-    CordovaPLYAttributeBatchCustomUserId
+    CordovaPLYAttributeBatchCustomUserId,
+    CordovaPLYAttributeOneSignalUserId
 };
 
 @end

package/src/ios/Hybrid/PLYPlan+Hybrid.m

@@ -79,6 +79,25 @@
 		[dict setObject:introPeriod forKey:@"introPeriod"];
 	}
 
+	// Commitment installment details (iOS 26.4+ multi-period commitments, e.g. "monthly
+	// subscription with 12-month commitment"). Apple-only: the array is empty for every other
+	// plan, so the key is omitted then. Mirrors PLYPlan.commitmentInfo: [PLYCommitmentInfo].
+	NSArray<PLYCommitmentInfo *> *commitmentInfo = self.commitmentInfo;
+	if (commitmentInfo.count > 0) {
+		NSMutableArray<NSDictionary *> *commitmentArray = [NSMutableArray new];
+		for (PLYCommitmentInfo *info in commitmentInfo) {
+			[commitmentArray addObject:@{
+				@"billingPlanType": @(info.billingPlanType),
+				@"billingPrice":    info.billingPrice,
+				@"billingPeriod":   info.billingPeriod,
+				@"totalPrice":      info.totalPrice,
+				@"totalPeriod":     info.totalPeriod,
+				@"totalDuration":   @(info.totalDuration)
+			}];
+		}
+		[dict setObject:commitmentArray forKey:@"commitmentInfo"];
+	}
+
 	return dict;
 }
 

package/src/ios/Hybrid/PLYSubscription+Hybrid.m

@@ -28,6 +28,19 @@
 		[dict setObject:[dateFormat stringFromDate:self.cancelledDate] forKey:@"cancelledDate"];
 	}
 
+	// Commitment progress (iOS 26.4+ monthly commitment, e.g. billing period 3 of 12).
+	// Apple-only and nil for every non-committed subscription, so the key is omitted then.
+	// Mirrors PLYSubscription.commitmentProgress: PLYCommitmentProgress?
+	PLYCommitmentProgress *commitmentProgress = self.commitmentProgress;
+	if (commitmentProgress != nil) {
+		[dict setObject:@{
+			@"billingPeriodNumber":   @(commitmentProgress.billingPeriodNumber),
+			@"totalBillingPeriods":   @(commitmentProgress.totalBillingPeriods),
+			@"commitmentExpiresDate": [dateFormat stringFromDate:commitmentProgress.commitmentExpiresDate],
+			@"commitmentPrice":       commitmentProgress.commitmentPrice
+		} forKey:@"commitmentProgress"];
+	}
+
 	return dict;
 }