Skip to content

WIP: feat: adopt Rokt SDK v5 contract types in public API #678

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
thomson-t wants to merge 2 commits into
base: workstation/9.0-Release
Choose a base branch
from
Draft

WIP: feat: adopt Rokt SDK v5 contract types in public API #678

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7feb6b4
feat: adopt Rokt SDK v5 contract types in public API
thomson-t Mar 23, 2026
de1c299
fix: remove trailing commas in Package.swift
thomson-t Mar 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 10 additions & 23 deletions Example/mParticleExample/ViewController.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ @interface ViewController () <UITableViewDataSource, UITableViewDelegate>
@property (nonatomic, strong) UITableView *tableView;
@property (nonatomic, strong) UITextField *emailField;
@property (nonatomic, strong) UITextField *customerIDField;
@property (nonatomic, strong) MPRoktEmbeddedView *roktView;
@property (nonatomic, strong) RoktEmbeddedView *roktView;

@end

Expand Down Expand Up @@ -58,7 +58,7 @@ - (void)setupUI:(CGFloat)roktHeight {
if (self.roktView) {
self.roktView.frame = roktFrame;
} else {
self.roktView = [[MPRoktEmbeddedView alloc] initWithFrame:roktFrame];
self.roktView = [[RoktEmbeddedView alloc] initWithFrame:roktFrame];
}
[self.view addSubview:_roktView];

Expand Down Expand Up @@ -254,13 +254,12 @@ - (void)selectDarkOverlayPlacement {
@"mobile": @"(555)867-5309"
};

MPRoktConfig *roktConfig = [[MPRoktConfig alloc] init];
roktConfig.colorMode = MPColorModeDark;
RoktConfig *roktConfig = [[[[RoktConfigBuilder alloc] init] colorMode:RoktColorModeDark] build];
[[MParticle sharedInstance].rokt selectPlacements:@"RoktLayout"
attributes:customAttributes
embeddedViews:nil
config:roktConfig
callbacks:nil];
onEvent:nil];
}

- (void)selectEmbeddedPlacement {
Expand All @@ -272,26 +271,14 @@ - (void)selectEmbeddedPlacement {
@"mobile": @"(555)867-5309"
};

MPRoktEventCallback *callbacks = [[MPRoktEventCallback alloc] init];
callbacks.onLoad = ^{
// Optional callback for when the Rokt placement loads
};
callbacks.onUnLoad = ^{
// Optional callback for when the Rokt placement unloads
};
callbacks.onShouldShowLoadingIndicator = ^{
// Optional callback to show a loading indicator
};
callbacks.onShouldHideLoadingIndicator = ^{
// Optional callback to hide a loading indicator
};
callbacks.onEmbeddedSizeChange = ^(NSString *placement, CGFloat size) {
[self setupUI:size];
};

NSDictionary *embeddedViews = @{@"Location1": self.roktView};

[[MParticle sharedInstance].rokt selectPlacements:@"testiOS" attributes:customAttributes embeddedViews:embeddedViews config:nil callbacks:callbacks];
[[MParticle sharedInstance].rokt selectPlacements:@"testiOS" attributes:customAttributes embeddedViews:embeddedViews config:nil onEvent:^(RoktEvent * _Nonnull event) {
if ([event isKindOfClass:[RoktEmbeddedSizeChanged class]]) {
RoktEmbeddedSizeChanged *sizeEvent = (RoktEmbeddedSizeChanged *)event;
[self setupUI:sizeEvent.updatedHeight];
}
}];
}

- (void)selectOverlayPlacementAutoClose {
Expand Down
2 changes: 1 addition & 1 deletion Kits/rokt/rokt/Package.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ let package = Package(
),
.package(
url: "https://github.com/ROKT/rokt-sdk-ios",
branch: "workstation/5.0.0"
branch: "feat/shoppable-ads-payment-orchestration"
),
.package(
url: "https://github.com/erikdoe/ocmock",
Expand Down
5 changes: 2 additions & 3 deletions Kits/rokt/rokt/Sources/mParticle-Rokt-Swift/MPRoktLayout.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,8 @@ public class MPRoktLayout {
onEvent: ((RoktEvent) -> Void)? = nil
) {
// Capture the timestamp when the SwiftUI component is rendered
let options = PlacementOptions(
jointSdkSelectPlacements: Int64(Date().timeIntervalSince1970 * 1000),
dynamicPerformanceMarkers: [:]
let options = RoktPlacementOptions(
timestamp: Int64(Date().timeIntervalSince1970 * 1000)
)

MPRoktLayout
Expand Down
214 changes: 20 additions & 194 deletions Kits/rokt/rokt/Sources/mParticle-Rokt/MPKitRokt.m
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
#import "MPKitRokt.h"
@import Rokt_Widget;
@import RoktContracts;

// Kit version
static NSString * const kMPRoktKitVersion = @"8.3.3";
Expand All @@ -20,7 +21,7 @@
static NSString * const MPKitRoktErrorMessageKey = @"mParticle-Rokt Error";
static NSString * const kMPRoktPlacementAttributesMapping = @"placementAttributesMapping";
static NSString * const kMPRoktHashedEmailUserIdentityType = @"hashedEmailUserIdentityType";
static NSString * const kMPRoktEmbeddedViewClassName = @"MPRoktEmbeddedView";

static NSString * const kMPEventNameSelectPlacements = @"selectPlacements";
static NSString * const kMPRoktIdentityTypeEmailSha256 = @"emailsha256";
static NSString * const kMPRoktIdentityTypeMpid = @"mpid";
Expand Down Expand Up @@ -76,8 +77,8 @@ - (MPKitExecStatus *)didFinishLaunchingWithConfiguration:(NSDictionary *)configu

// Subscribe to global events to receive InitComplete
[Rokt globalEventsOnEvent:^(RoktEvent * _Nonnull event) {
if ([event isKindOfClass:[InitComplete class]]) {
InitComplete *initComplete = (InitComplete *)event;
if ([event isKindOfClass:[RoktInitComplete class]]) {
RoktInitComplete *initComplete = (RoktInitComplete *)event;
if (initComplete.success) {
[self start];
[MPKitRokt MPLog:@"Rokt Init Complete"];
Expand Down Expand Up @@ -122,37 +123,27 @@ - (void)start {
/// @return MPKitExecStatus indicating success or failure of the operation
- (MPKitExecStatus *)executeWithIdentifier:(NSString * _Nullable)identifier
attributes:(NSDictionary<NSString *, NSString *> * _Nonnull)attributes
embeddedViews:(NSDictionary<NSString *, MPRoktEmbeddedView *> * _Nullable)embeddedViews
config:(MPRoktConfig * _Nullable)mpRoktConfig
onEvent:(void (^ _Nullable)(MPRoktEvent * _Nonnull))onEvent
embeddedViews:(NSDictionary<NSString *, RoktEmbeddedView *> * _Nullable)embeddedViews
config:(RoktConfig * _Nullable)config
onEvent:(void (^ _Nullable)(RoktEvent * _Nonnull))onEvent
filteredUser:(FilteredMParticleUser * _Nonnull)filteredUser
options:(MPRoktPlacementOptions * _Nullable)options {
[MPKitRokt MPLog:[NSString stringWithFormat:@"Rokt Kit recieved `executeWithIdentifier` method with the following arguments: \n identifier: %@ \n attributes: %@ \n embeddedViews: %@ \n config: %@ \n onEvent: %@ \n filteredUser identities: %@ \n options: %@", identifier, attributes, embeddedViews, mpRoktConfig, onEvent, filteredUser.userIdentities, options]];
options:(RoktPlacementOptions * _Nullable)options {
[MPKitRokt MPLog:[NSString stringWithFormat:@"Rokt Kit recieved `executeWithIdentifier` method with the following arguments: \n identifier: %@ \n attributes: %@ \n embeddedViews: %@ \n config: %@ \n onEvent: %@ \n filteredUser identities: %@ \n options: %@", identifier, attributes, embeddedViews, config, onEvent, filteredUser.userIdentities, options]];
NSDictionary<NSString *, NSString *> *finalAtt = [MPKitRokt prepareAttributes:attributes filteredUser:filteredUser performMapping:NO];

// Log custom event for selectPlacements call
[MPKitRokt logSelectPlacementEvent:finalAtt];

//Convert MPRoktConfig to RoktConfig
RoktConfig *roktConfig = [MPKitRokt convertMPRoktConfig:mpRoktConfig];
NSDictionary<NSString *, RoktEmbeddedView *> *confirmedViews = [self confirmEmbeddedViews:embeddedViews];

PlacementOptions *placementOptions = [[PlacementOptions alloc] initWithJointSdkSelectPlacements:0 dynamicPerformanceMarkers:@{}];
if (options) {
placementOptions = [[PlacementOptions alloc] initWithJointSdkSelectPlacements:options.jointSdkSelectPlacements dynamicPerformanceMarkers:@{}];
}
RoktPlacementOptions *placementOptions = options ?: [[RoktPlacementOptions alloc] initWithTimestamp:0];

[Rokt selectPlacementsWithIdentifier:identifier
attributes:finalAtt
placements:confirmedViews
config:roktConfig
placements:embeddedViews ?: @{}
config:config
placementOptions:placementOptions
onEvent:^(RoktEvent * _Nonnull event) {
if (onEvent) {
MPRoktEvent *mpEvent = [MPKitRokt mapEvent:event];
if (mpEvent) {
onEvent(mpEvent);
}
onEvent(event);
}
}];

Expand Down Expand Up @@ -182,44 +173,6 @@ - (RoktFrameworkType)mapMPWrapperSdkToRoktFrameworkType:(MPWrapperSdk)wrapperSdk
}
}

- (NSDictionary<NSString *, RoktEmbeddedView *> * _Nullable) confirmEmbeddedViews:(NSDictionary<NSString *, MPRoktEmbeddedView *> * _Nullable)embeddedViews {
if (!embeddedViews || embeddedViews.count == 0) {
return [NSMutableDictionary dictionary];
}

NSMutableDictionary <NSString *, RoktEmbeddedView *> *safePlacements = [NSMutableDictionary dictionary];

for (NSString* key in embeddedViews) {
MPRoktEmbeddedView *mpView = [embeddedViews objectForKey:key];

BOOL isUIView = [mpView isKindOfClass:[UIView class]];

if (!isUIView) {
[MPKitRokt MPLog:[NSString stringWithFormat:@"Rokt embedded view is incorrect type. Found: %@ but required: UIView", NSStringFromClass([mpView class])]];
continue;
}

Class runtimeClass = NSClassFromString(kMPRoktEmbeddedViewClassName);

// Use runtime class for type checking instead of compile-time reference
// This handles cases where the class is defined in multiple frameworks
BOOL isProperType = runtimeClass && [mpView isKindOfClass:runtimeClass];

if (isProperType) {
// Create a new RoktEmbeddedView instance
RoktEmbeddedView *roktView = [[RoktEmbeddedView alloc] initWithFrame:mpView.bounds];
// Add the RoktEmbeddedView as a child view of MPRoktEmbeddedView
[mpView addSubview:roktView];
// Add the RoktEmbeddedView to our safe placements dictionary
[safePlacements setObject:roktView forKey:key];
} else {
[MPKitRokt MPLog:[NSString stringWithFormat:@"Rokt embedded view is incorrect type. Found: %@ but required: %@", NSStringFromClass([mpView class]), kMPRoktEmbeddedViewClassName]];
}
}

return safePlacements;
}

/// Ensures the "sandbox" attribute is present in the attributes dictionary.
/// If not already set by the caller, the sandbox value is automatically determined based on the current mParticle environment
/// (MPEnvironmentDevelopment → "true", production → "false"). This tells Rokt whether to show test or production ads.
Expand Down Expand Up @@ -408,24 +361,6 @@ + (void)handleHashedEmail:(NSMutableDictionary<NSString *, NSString *> * _Nullab
}
}

+ (RoktConfig *)convertMPRoktConfig:(MPRoktConfig *)mpRoktConfig {
if (mpRoktConfig != nil) {
Builder *builder = [[Builder alloc] init];

if (mpRoktConfig.cacheDuration != nil) {
CacheConfig *cacheConfig = [[CacheConfig alloc] initWithCacheDuration:mpRoktConfig.cacheDuration.doubleValue cacheAttributes:mpRoktConfig.cacheAttributes];
builder = [builder cacheConfig:cacheConfig];
}

builder = [builder colorMode:(ColorMode)mpRoktConfig.colorMode];

RoktConfig *config = [builder build];

return config;
}

return nil;
}

+ (NSString *)stringForIdentityType:(MPIdentity)identityType {
NSNumber *hashedEmailIdentity = [MPKitRokt getRoktHashedEmailUserIdentityType];
Expand Down Expand Up @@ -538,21 +473,19 @@ - (MPKitExecStatus *)purchaseFinalized:(NSString *)identifier catalogItemId:(NSS
return [[MPKitExecStatus alloc] initWithSDKCode:[[self class] kitCode] returnCode:MPKitReturnCodeFail];
}

- (MPKitExecStatus *)events:(NSString *)identifier onEvent:(void (^)(MPRoktEvent * _Nonnull))onEvent {
- (MPKitExecStatus *)events:(NSString *)identifier onEvent:(void (^)(RoktEvent * _Nonnull))onEvent {
[Rokt eventsWithIdentifier:identifier onEvent:^(RoktEvent * _Nonnull event) {
MPRoktEvent *mpEvent = [MPKitRokt mapEvent:event];
if (mpEvent) {
onEvent(mpEvent);
if (onEvent) {
onEvent(event);
}
}];
return [[MPKitExecStatus alloc] initWithSDKCode:[[self class] kitCode] returnCode:MPKitReturnCodeSuccess];
}

- (MPKitExecStatus *)globalEvents:(void (^)(MPRoktEvent * _Nonnull))onEvent {
- (MPKitExecStatus *)globalEvents:(void (^)(RoktEvent * _Nonnull))onEvent {
[Rokt globalEventsOnEvent:^(RoktEvent * _Nonnull event) {
MPRoktEvent *mpEvent = [MPKitRokt mapEvent:event];
if (mpEvent) {
onEvent(mpEvent);
if (onEvent) {
onEvent(event);
}
}];
return [[MPKitExecStatus alloc] initWithSDKCode:[[self class] kitCode] returnCode:MPKitReturnCodeSuccess];
Expand Down Expand Up @@ -895,111 +828,4 @@ + (void)logSelectPlacementEvent:(NSDictionary<NSString *, NSString *> * _Nonnull
}


+ (MPRoktEvent * _Nullable)mapEvent:(RoktEvent *)event {
if (!event) {
return nil;
}

// Check for RoktEvent.InitComplete
if ([event isKindOfClass:[InitComplete class]]) {
InitComplete *initComplete = (InitComplete *)event;
return [[MPRoktInitComplete alloc] initWithSuccess:initComplete.success];
}

// Check for RoktEvent.ShowLoadingIndicator
if ([event isKindOfClass:[ShowLoadingIndicator class]]) {
return [[MPRoktShowLoadingIndicator alloc] init];
}

// Check for RoktEvent.HideLoadingIndicator
if ([event isKindOfClass:[HideLoadingIndicator class]]) {
return [[MPRoktHideLoadingIndicator alloc] init];

}

// Check for RoktEvent.PlacementInteractive
if ([event isKindOfClass:[PlacementInteractive class]]) {
PlacementInteractive *placementInteractive = (PlacementInteractive *)event;
return [[MPRoktPlacementInteractive alloc] initWithPlacementId:placementInteractive.identifier];
}

// Check for RoktEvent.PlacementReady
if ([event isKindOfClass:[PlacementReady class]]) {
PlacementReady *placementReady = (PlacementReady *)event;
return [[MPRoktPlacementReady alloc] initWithPlacementId:placementReady.identifier];
}

// Check for RoktEvent.OfferEngagement
if ([event isKindOfClass:[OfferEngagement class]]) {
OfferEngagement *offerEngagement = (OfferEngagement *)event;
return [[MPRoktOfferEngagement alloc] initWithPlacementId:offerEngagement.identifier];
}

// Check for RoktEvent.OpenUrl
if ([event isKindOfClass:[OpenUrl class]]) {
OpenUrl *openUrl = (OpenUrl *)event;
return [[MPRoktOpenUrl alloc] initWithPlacementId:openUrl.identifier url:openUrl.url];
}

// Check for RoktEvent.PositiveEngagement
if ([event isKindOfClass:[PositiveEngagement class]]) {
PositiveEngagement *positiveEngagement = (PositiveEngagement *)event;
return [[MPRoktPositiveEngagement alloc] initWithPlacementId:positiveEngagement.identifier];
}

// Check for RoktEvent.PlacementClosed
if ([event isKindOfClass:[PlacementClosed class]]) {
PlacementClosed *placementClosed = (PlacementClosed *)event;
return [[MPRoktPlacementClosed alloc] initWithPlacementId:placementClosed.identifier];
}

// Check for RoktEvent.PlacementCompleted
if ([event isKindOfClass:[PlacementCompleted class]]) {
PlacementCompleted *placementCompleted = (PlacementCompleted *)event;
return [[MPRoktPlacementCompleted alloc] initWithPlacementId:placementCompleted.identifier];
}

// Check for RoktEvent.PlacementFailure
if ([event isKindOfClass:[PlacementFailure class]]) {
PlacementFailure *placementFailure = (PlacementFailure *)event;
return [[MPRoktPlacementFailure alloc] initWithPlacementId:placementFailure.identifier];
}

// Check for RoktEvent.FirstPositiveEngagement
if ([event isKindOfClass:[FirstPositiveEngagement class]]) {
FirstPositiveEngagement *firstPositiveEngagement = (FirstPositiveEngagement *)event;
return [[MPRoktFirstPositiveEngagement alloc] initWithPlacementId:firstPositiveEngagement.identifier];
}

// Check for RoktEvent.EmbeddedSizeChanged
if ([event isKindOfClass:[EmbeddedSizeChanged class]]) {
EmbeddedSizeChanged *embeddedSizeChanged = (EmbeddedSizeChanged *)event;
return [[MPRoktEmbeddedSizeChanged alloc] initWithPlacementId:embeddedSizeChanged.identifier
updatedHeight:embeddedSizeChanged.updatedHeight];
}

// Check for RoktEvent.CartItemInstantPurchase
if ([event isKindOfClass:[CartItemInstantPurchase class]]) {
CartItemInstantPurchase *cartItemInstantPurchase = (CartItemInstantPurchase *)event;

// Handle nil coalescing for name field
NSString *name = cartItemInstantPurchase.name ?: @"";

return [[MPRoktCartItemInstantPurchase alloc] initWithPlacementId:cartItemInstantPurchase.identifier
name:name
cartItemId:cartItemInstantPurchase.cartItemId
catalogItemId:cartItemInstantPurchase.catalogItemId
currency:cartItemInstantPurchase.currency
description:cartItemInstantPurchase.description
linkedProductId:cartItemInstantPurchase.linkedProductId
providerData:cartItemInstantPurchase.providerData
quantity:cartItemInstantPurchase.quantity
totalPrice:cartItemInstantPurchase.totalPrice
unitPrice:cartItemInstantPurchase.unitPrice];
}

// Default case - return nil if no matching event type found
return nil;
}

@end
Loading
Loading