Optimize: add APIs for displayed and generateDisplayInteractionXdm for multiple offers (adobe#491)

* add support for multiple display proposition in Optimize

* android api call fix

* update api usage, tests, docs

* fix UTs

* add support for generate display interaction xdm for multiple offers

* preserve proposition weak reference

* address PR comments

* add constants in android

Author: ishita-gambhir-adobe

apps/AEPSampleAppNewArchEnabled/app/OptimizeView.tsx

@@ -84,14 +84,14 @@ export default () => {
 
   const updatePropositions = () => {
     Optimize.updatePropositions(decisionScopes);
-    console.log('Updated Propositions');
+    console.log('Updated Proposition for decisionScopes:', decisionScopes);
   };
 
   const getPropositions = async () => {
     const propositions: Map<string, Proposition> =
       await Optimize.getPropositions(decisionScopes);
-    console.log(propositions);
     if (propositions) {
+      console.log("get propositions", JSON.stringify(Object.fromEntries(propositions), null, 2));
       setTextProposition(propositions.get(decisionScopeText.getName()));
       setImageProposition(propositions.get(decisionScopeImage.getName()));
       setHtmlProposition(propositions.get(decisionScopeHtml.getName()));
@@ -118,6 +118,54 @@ export default () => {
       },
     });
 
+  const multipleOffersDisplayed = async () => {
+    const propositionsMap: Map<string, Proposition> = await Optimize.getPropositions(decisionScopes);
+    const offerPairs: Array<{proposition: Proposition, offerId: string}> = [];
+    
+    propositionsMap.forEach((proposition: Proposition) => {
+      if (proposition && proposition.items) {
+        proposition.items.forEach((offer) => {
+          offerPairs.push({
+            proposition: proposition,
+            offerId: offer.id
+          });
+        });
+      }
+    });
+    
+    console.log('Extracted offer pairs:', offerPairs);
+    
+    if (offerPairs.length > 0) {
+      Optimize.displayed(offerPairs);
+      console.log(`Called multipleOffersDisplayed with ${offerPairs.length} offers`);
+    } else {
+      console.log('No offers found to display');
+    }
+  };
+
+  const generateDisplayInteractionXdmForMultipleOffers = async () => {
+    const propositionsMap: Map<string, Proposition> = await Optimize.getPropositions(decisionScopes);
+    const offerPairs: Array<{proposition: Proposition, offerId: string}> = [];
+
+    propositionsMap.forEach((proposition: Proposition) => {
+      if (proposition && proposition.items) {
+        proposition.items.forEach((offer) => {
+          offerPairs.push({
+            proposition: proposition,
+            offerId: offer.id
+          });
+        });
+      }
+    });
+
+    const xdm = await Optimize.generateDisplayInteractionXdm(offerPairs);
+    if (xdm) {
+      console.log('Generated Display Interaction XDM for Multiple Offers:', JSON.stringify(xdm, null, 2));
+    } else {
+      console.log('Error in generating Display interaction XDM for multiple offers.');
+    }
+  };
+
   const renderTargetOffer = () => {
     if (targetProposition?.items) {
       if (targetProposition.items[0].format === TARGET_OFFER_TYPE_JSON) {
@@ -338,6 +386,18 @@ export default () => {
           onPress={clearCachedProposition}
         />
       </View>
+      <View style={{margin: 5}}>
+        <Button
+          title="Multiple Offers Displayed"
+          onPress={multipleOffersDisplayed}
+        />
+      </View>
+      <View style={{margin: 5}}>
+        <Button
+          title="Generate Display Interaction XDM for Multiple Offers"
+          onPress={generateDisplayInteractionXdmForMultipleOffers}
+        />
+      </View>
       <View style={{margin: 5}}>
         <Button
           title="Subscribe to Proposition Update"

packages/optimize/README.md

@@ -163,6 +163,68 @@ const decisionScopes = [
 Optimize.updatePropositions(decisionScopes, null, null);
 ```
 
+### Batching multiple display propositions track events:
+
+The Optimize SDK now provides enhanced support for batching multiple display propositions track events. The following APIs are available:
+
+#### displayed
+
+**Syntax**
+
+```typescript
+displayed(offerPairs: Array<{ proposition: Proposition; offerId: string }>)
+```
+
+**Example**
+
+```typescript
+const propositions: Map<string, Proposition> = await Optimize.getPropositions(decisionScopes);
+const offerPairs: Array<{ proposition: Proposition; offerId: string }> = [];
+
+propositions.forEach((proposition: Proposition) => {
+  if (proposition && proposition.items) {
+    proposition.items.forEach((offer) => {
+      offerPairs.push({
+        proposition,
+        offerId: offer.id,
+      });
+    });
+  }
+});
+
+Optimize.displayed(offerPairs);
+```
+
+#### generateDisplayInteractionXdm
+
+**Syntax**
+
+```typescript
+generateDisplayInteractionXdm(offerPairs: Array<{ proposition: Proposition; offerId: string }>): Promise<Map<string, any>>
+```
+
+**Example**
+
+```typescript
+const propositions: Map<string, Proposition> = await Optimize.getPropositions(decisionScopes);
+const offerPairs: Array<{ proposition: Proposition; offerId: string }> = [];
+
+propositions.forEach((proposition: Proposition) => {
+  if (proposition && proposition.items) {
+    proposition.items.forEach((offer) => {
+      offerPairs.push({
+        proposition,
+        offerId: offer.id,
+      });
+    });
+  }
+});
+
+const xdmData = await Optimize.generateDisplayInteractionXdm(offerPairs);
+// use xdmData as needed
+
+```
+
 ---
 
 ## Public classes

packages/optimize/__tests__/OptimizeTests.ts

@@ -174,4 +174,50 @@ describe('Optimize', () => {
       'eyJhY3Rpdml0eUlkIjoieGNvcmU6b2ZmZXItYWN0aXZpdHk6MTExMTExMTExMTExMTExMSIsInBsYWNlbWVudElkIjoieGNvcmU6b2ZmZXItcGxhY2VtZW50OjExMTExMTExMTExMTExMTEiLCJpdGVtQ291bnQiOjEwfQ=='
     );
   });
+
+  it('Test Optimize.displayed', async () => {
+    const spy = jest.spyOn(NativeModules.AEPOptimize, 'multipleOffersDisplayed');
+    const proposition = new Proposition(propositionJson as any);
+    const offer = proposition.items[0];
+    const offerPairs = [{
+      proposition,
+      offerId: offer.id
+    }];
+
+    // Clean the proposition as your implementation does
+    const entries = Object.entries(proposition).filter(
+      ([_, value]) => typeof value !== 'function'
+    );
+    const cleanedProposition = Object.fromEntries(entries);
+    const cleanedPairs = [{
+      proposition: cleanedProposition,
+      offerId: offer.id
+    }];
+
+    await Optimize.displayed(offerPairs);
+    expect(spy).toHaveBeenCalledWith(cleanedPairs);
+  });
+
+  it('Test Optimize.generateDisplayInteractionXdm', async () => {
+    const spy = jest.spyOn(NativeModules.AEPOptimize, 'generateDisplayInteractionXdmForMultipleOffers');
+    const proposition = new Proposition(propositionJson as any);
+    const offer = proposition.items[0];
+    const offerPairs = [{
+      proposition,
+      offerId: offer.id
+    }];
+  
+    // Clean the proposition as your implementation does
+    const entries = Object.entries(proposition).filter(
+      ([_, value]) => typeof value !== 'function'
+    );
+    const cleanedProposition = Object.fromEntries(entries);
+    const cleanedPairs = [{
+      proposition: cleanedProposition,
+      offerId: offer.id
+    }];
+  
+    await Optimize.generateDisplayInteractionXdm(offerPairs);
+    expect(spy).toHaveBeenCalledWith(cleanedPairs);
+  });
 });

packages/optimize/android/src/main/java/com/adobe/marketing/mobile/reactnative/optimize/RCTAEPOptimizeConstants.java

@@ -0,0 +1,17 @@
+/*
+    Copyright 2025 Adobe. All rights reserved.
+    This file is licensed to you under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License. You may obtain a copy
+    of the License at http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software distributed under
+    the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+    OF ANY KIND, either express or implied. See the License for the specific language
+    governing permissions and limitations under the License.
+ */
+
+ package com.adobe.marketing.mobile.reactnative.optimize;
+
+ class RCTAEPOptimizeConstants {
+    static final String PROPOSITION_KEY = "proposition";
+    static final String OFFER_ID_KEY = "offerId";
+ }

packages/optimize/android/src/main/java/com/adobe/marketing/mobile/reactnative/optimize/RCTAEPOptimizeModule.java

@@ -18,6 +18,7 @@
 import com.adobe.marketing.mobile.optimize.DecisionScope;
 import com.adobe.marketing.mobile.optimize.Offer;
 import com.adobe.marketing.mobile.optimize.OfferType;
+import com.adobe.marketing.mobile.optimize.OfferUtils;
 import com.adobe.marketing.mobile.optimize.Optimize;
 import com.adobe.marketing.mobile.optimize.OptimizeProposition;
 import com.facebook.react.bridge.Promise;
@@ -30,6 +31,7 @@
 import com.facebook.react.bridge.WritableNativeMap;
 import com.facebook.react.modules.core.DeviceEventManagerModule;
 
+import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
@@ -61,6 +63,43 @@ public void offerDisplayed(final String offerId, final ReadableMap propositionMa
         }
     }
 
+    @ReactMethod
+    public void multipleOffersDisplayed(final ReadableArray propositionOfferPairs) {
+        if (propositionOfferPairs == null || propositionOfferPairs.size() == 0) {
+            return;
+        }
+
+        List<Offer> nativeOffers = new ArrayList<>();
+        
+        for (int i = 0; i < propositionOfferPairs.size(); i++) {
+            ReadableMap propositionOfferPairMap = propositionOfferPairs.getMap(i);
+            if (propositionOfferPairMap == null) {
+                continue;
+            }
+
+            ReadableMap propositionMap = propositionOfferPairMap.getMap(RCTAEPOptimizeConstants.PROPOSITION_KEY);
+            String offerId = propositionOfferPairMap.getString(RCTAEPOptimizeConstants.OFFER_ID_KEY);
+            if (propositionMap == null || offerId == null) {
+                continue;
+            }
+
+            Map<String, Object> propositionEventData = RCTAEPOptimizeUtil.convertReadableMapToMap(propositionMap);
+            OptimizeProposition proposition = OptimizeProposition.fromEventData(propositionEventData);
+            if (proposition != null) {
+                for (Offer offer : proposition.getOffers()) {
+                    if (offer.getId().equalsIgnoreCase(offerId)) {
+                        nativeOffers.add(offer);
+                        break;
+                    }
+                }
+            }
+        }
+        
+        if (!nativeOffers.isEmpty()) {
+            OfferUtils.displayed(nativeOffers);
+        }
+    }
+
     @ReactMethod
     public void extensionVersion(final Promise promise) {
         promise.resolve(Optimize.extensionVersion());
@@ -144,6 +183,42 @@ public void generateDisplayInteractionXdm(final String offerId, final ReadableMa
         }
     }
 
+    @ReactMethod
+    public void generateDisplayInteractionXdmForMultipleOffers(final ReadableArray propositionOfferPairs, final Promise promise) {
+        final List<Offer> nativeOffers = new ArrayList<>();
+        
+        for (int i = 0; i < propositionOfferPairs.size(); i++) {
+            ReadableMap propositionOfferPairMap = propositionOfferPairs.getMap(i);
+            if (propositionOfferPairMap == null) {
+                continue;   
+            }
+
+            ReadableMap propositionMap = propositionOfferPairMap.getMap(RCTAEPOptimizeConstants.PROPOSITION_KEY);
+            String offerId = propositionOfferPairMap.getString(RCTAEPOptimizeConstants.OFFER_ID_KEY);
+            if (propositionMap == null || offerId == null) {
+                continue;       
+            }
+
+            Map<String, Object> propositionEventData = RCTAEPOptimizeUtil.convertReadableMapToMap(propositionMap);
+            OptimizeProposition proposition = OptimizeProposition.fromEventData(propositionEventData);
+
+            for (Offer offer : proposition.getOffers()) {
+                if (offer.getId().equalsIgnoreCase(offerId)) {
+                    nativeOffers.add(offer);
+                    break;
+                }
+            }
+        }
+
+        if (nativeOffers.size() > 0) {
+            final Map<String, Object> interactionXdm = OfferUtils.generateDisplayInteractionXdm(nativeOffers);
+            final WritableMap writableMap = RCTAEPOptimizeUtil.convertMapToWritableMap(interactionXdm);
+            promise.resolve(writableMap);
+        } else {
+            promise.reject("generateDisplayInteractionXdmForMultipleOffers", "Error in generating Display interaction XDM for multiple offers.");
+        }
+    }
+
     @ReactMethod
     public void generateTapInteractionXdm(final String offerId, final ReadableMap propositionMap, final Promise promise) {
         final Map<String, Object> eventData = RCTAEPOptimizeUtil.convertReadableMapToMap(propositionMap);