@ordergroove/offers 2.46.0 → 2.46.1-alpha-PR-1285-2.53

package/src/core/types/reducer.ts

@@ -2,6 +2,7 @@ import { Order, Incentive as ApiIncentive, MerchantSettings, OfferResponse } fro
 import { type Offer } from '../../components/Offer';
 import { ShopifyCart, ShopifyProductEntity } from '../../shopify/types/shopify';
 import reducer from '../reducer';
+import { ProductPlanEntity } from '../../shopify/types/productPlan';
 
 export type State = ReturnType<typeof reducer>;
 
@@ -16,8 +17,16 @@ export type NextUpcomingOrderState = Partial<
 
 export type IncentivesState = Record<string, IncentiveObject>;
 
-type Incentive = ApiIncentive & {
+export type Incentive = ApiIncentive & {
   id: string;
+  /**
+   * undefined when the offer profile is not standardized
+   */
+  criteria?: {
+    node_type: string;
+    premise_value: unknown;
+    standard: string;
+  };
 };
 
 export type IncentiveObject = {
@@ -68,6 +77,10 @@ export type OptedOutState = { id: string }[];
 
 export type AutoshipByDefaultState = Record<string, boolean>;
 
+export type PriceState = { [productId: string]: { value: number } };
+
+export type ProductPlansState = { [productId: string]: ProductPlanEntity[] };
+
 // payload types
 
 export type ReceiveOfferPayload = OfferResponse & {

package/src/shopify/__tests__/productPlan.spec.js

@@ -308,7 +308,7 @@ describe('Shopify productPlan Reducer', () => {
 
       const productPlanCreated = mapSellingPlanToDiscount(allocation, [], 'USD');
 
-      expect(productPlanCreated).toEqual(expectedProductPlan);
+      expect(productPlanCreated).toEqual(jasmine.objectContaining(expectedProductPlan));
     });
 
     it('should create prepaid product plan', () => {
@@ -371,7 +371,7 @@ describe('Shopify productPlan Reducer', () => {
 
       const productPlanCreated = mapSellingPlanToDiscount(allocation, sellingPlans, 'USD');
 
-      expect(productPlanCreated).toEqual(expectedProductPlan);
+      expect(productPlanCreated).toEqual(jasmine.objectContaining(expectedProductPlan));
     });
 
     it('should create prepaid product plan that rounds subscriptionPrice to nearest decimal', () => {
@@ -512,7 +512,7 @@ describe('Shopify productPlan Reducer', () => {
 
       const productPlanCreated = mapSellingPlanToDiscount(allocation, sellingPlans, 'USD');
 
-      expect(productPlanCreated).toEqual(expectedProductPlan);
+      expect(productPlanCreated).toEqual(jasmine.objectContaining(expectedProductPlan));
     });
   });
 

package/src/shopify/__tests__/shopifyMiddleware.spec.js

@@ -7,7 +7,12 @@ import {
   PRODUCT_CHANGE_PREPAID_SHIPMENTS,
   SETUP_CART
 } from '../../core/constants';
-import { synchronizeCartOptin, getTrackingEvent, guessProductHandle } from '../shopifyMiddleware';
+import {
+  synchronizeCartOptin,
+  getTrackingEvent,
+  guessProductHandle,
+  synchronizeSellingPlan
+} from '../shopifyMiddleware';
 import { getOrCreateHidden } from '../../core/utils';
 
 function makeForm(addInput = true) {
@@ -92,7 +97,7 @@ describe('getTrackingEvent', () => {
 });
 
 describe('synchronizeCartOptin', () => {
-  let store, offer, frequency, product;
+  let store, offer, frequency, product, defaultState;
   beforeEach(() => {
     store = {
       dispatch: jasmine.createSpy('dispatch'),
@@ -106,6 +111,23 @@ describe('synchronizeCartOptin', () => {
     frequency = '1234';
     product = { id: '38995975209111:original-hash' };
 
+    defaultState = {
+      optedin: [],
+      offerId: 'offer-id-1234',
+      productPlans: {
+        38995975209111: [
+          {
+            frequency: '688815178030'
+          },
+          {
+            frequency: '1234'
+          }
+        ]
+      }
+    };
+
+    store.getState.and.returnValue(defaultState);
+
     fetchMock.route(
       '/cart.js',
       {
@@ -134,12 +156,64 @@ describe('synchronizeCartOptin', () => {
       { method: 'POST', repeat: 1 }
     );
 
+    fetchMock.route(
+      '/cart/update.js',
+      {
+        attributes: {}
+      },
+      { method: 'POST', repeat: 1 }
+    );
+
     fetchMock.mockGlobal();
+
+    // mock the date so that the tracking key is predictable
+    jasmine.clock().install();
+    jasmine.clock().mockDate(new Date('2025-01-01T00:00:00.000Z'));
   });
 
   afterEach(() => {
     fetchMock.removeRoutes().unmockGlobal();
     offer.remove();
+
+    jasmine.clock().uninstall();
+  });
+
+  it('should update cart attributes', async () => {
+    await synchronizeCartOptin({ type: OPTIN_PRODUCT, payload: { offer, frequency, product } }, store);
+
+    const lastUpdateCall = fetchMock.callHistory.calls('/cart/update.js').at(-1);
+    const body = JSON.parse(lastUpdateCall.options.body);
+
+    expect(body).toEqual({
+      attributes: {
+        og__1735689600: '38995975209111:original-hash,optin_product,,1234,'
+      }
+    });
+  });
+
+  it('should update cart attributes when Shopify Discount Function in use', async () => {
+    store.getState.and.returnValue({
+      ...defaultState,
+      productPlans: {
+        38995975209111: [
+          {
+            frequency: '688815178030',
+            hasPriceAdjustments: false
+          }
+        ]
+      }
+    });
+    await synchronizeCartOptin({ type: OPTIN_PRODUCT, payload: { offer, frequency, product } }, store);
+
+    const lastUpdateCall = fetchMock.callHistory.calls('/cart/update.js').at(-1);
+    const body = JSON.parse(lastUpdateCall.options.body);
+
+    expect(body).toEqual({
+      attributes: {
+        og__1735689600: '38995975209111:original-hash,optin_product,,1234,',
+        __ordergroove_offer_id: 'offer-id-1234'
+      }
+    });
   });
 
   it('should set new has product id', async () => {
@@ -173,7 +247,9 @@ describe('synchronizeCartOptin', () => {
     document.body.appendChild(sectionDiv);
 
     await synchronizeCartOptin({ type: OPTIN_PRODUCT, payload: { offer, frequency, product } }, store);
-    expect(fetchMock.callHistory.lastCall().options.body).toContain('"sections":["123456789__cart-items"]');
+    expect(fetchMock.callHistory.calls('/cart/change.js').at(-1).options.body).toContain(
+      '"sections":["123456789__cart-items"]'
+    );
     sectionDiv.remove();
   });
 
@@ -185,12 +261,15 @@ describe('synchronizeCartOptin', () => {
     document.body.appendChild(sectionDiv);
 
     await synchronizeCartOptin({ type: OPTIN_PRODUCT, payload: { offer, frequency, product } }, store);
-    expect(fetchMock.callHistory.lastCall().options.body).toContain('"sections":["123456789__cart-footer"]');
+    expect(fetchMock.callHistory.calls('/cart/change.js').at(-1).options.body).toContain(
+      '"sections":["123456789__cart-footer"]'
+    );
     sectionDiv.remove();
   });
 
   it('should get the subscribed frequency when no frequency is provided in the action payload', async () => {
     store.getState.and.returnValue({
+      ...defaultState,
       optedin: [
         {
           id: '38995975209111:original-hash',
@@ -223,11 +302,14 @@ describe('synchronizeCartOptin', () => {
       }
     });
 
-    expect(fetchMock.callHistory.lastCall().options.body).toContain('"selling_plan":"688815178030"');
+    expect(fetchMock.callHistory.calls('/cart/change.js').at(-1).options.body).toContain(
+      '"selling_plan":"688815178030"'
+    );
   });
 
   it('should have no selling plan when product is opted out', async () => {
     store.getState.and.returnValue({
+      ...defaultState,
       optedin: []
     });
 
@@ -254,7 +336,7 @@ describe('synchronizeCartOptin', () => {
       }
     });
 
-    expect(fetchMock.callHistory.lastCall().options.body).toContain('"selling_plan":null');
+    expect(fetchMock.callHistory.calls('/cart/change.js').at(-1).options.body).toContain('"selling_plan":null');
   });
 });
 
@@ -291,3 +373,142 @@ describe('guessProductHandle', () => {
     expect(guessProductHandle()).toEqual('some-meta-json');
   });
 });
+
+describe('synchronizeSellingPlan', () => {
+  const testProduct = '123456';
+  const testSellingPlan = '688815178030';
+  const testSessionId = 'session-123';
+  const testOfferId = 'offer-id-1234';
+
+  function makeCartAddForm(productId = testProduct) {
+    const element = document.createElement('form');
+    element.action = '/cart/add';
+    element.innerHTML = `
+      <input value="${productId}" name="id" type="hidden">
+    `;
+    document.body.appendChild(element);
+    return element;
+  }
+
+  function getFormData(formElement) {
+    const data = Object.fromEntries(new FormData(formElement));
+    delete data.id;
+    return data;
+  }
+
+  let store;
+  let offerElement = {
+    isCart: false,
+    shouldEnableOffer: true
+  };
+
+  beforeEach(() => {
+    document.body.innerHTML = '';
+    store = {
+      getState: jasmine.createSpy('getState')
+    };
+    store.getState.and.returnValue({
+      sessionId: testSessionId,
+      optedin: [{ id: testProduct, frequency: testSellingPlan }],
+      productPlans: {},
+      offerId: testOfferId
+    });
+  });
+
+  afterEach(() => {
+    document.body.innerHTML = '';
+  });
+
+  it('should add attributes when product is opted in', () => {
+    const formElement = makeCartAddForm();
+    expect(getFormData(formElement)).toEqual({});
+
+    synchronizeSellingPlan(store, offerElement);
+
+    expect(getFormData(formElement)).toEqual({
+      selling_plan: testSellingPlan,
+      'attributes[og__session]': testSessionId
+    });
+  });
+
+  it('should add attributes when product is opted in and Shopify Discount Function is in use', () => {
+    store.getState.and.returnValue({
+      ...store.getState(),
+      productPlans: {
+        [testProduct]: [
+          {
+            frequency: testSellingPlan,
+            hasPriceAdjustments: false
+          }
+        ]
+      }
+    });
+
+    const formElement = makeCartAddForm();
+    expect(getFormData(formElement)).toEqual({});
+
+    synchronizeSellingPlan(store, offerElement);
+
+    expect(getFormData(formElement)).toEqual({
+      selling_plan: testSellingPlan,
+      'attributes[og__session]': testSessionId,
+      'attributes[__ordergroove_offer_id]': testOfferId
+    });
+  });
+
+  it('should handle multiple forms on the page', () => {
+    const formElement1 = makeCartAddForm(testProduct);
+    const formElement2 = makeCartAddForm(testProduct);
+
+    synchronizeSellingPlan(store, offerElement);
+
+    expect(getFormData(formElement1)).toEqual({
+      selling_plan: testSellingPlan,
+      'attributes[og__session]': testSessionId
+    });
+    expect(getFormData(formElement2)).toEqual({
+      selling_plan: testSellingPlan,
+      'attributes[og__session]': testSessionId
+    });
+  });
+
+  it('should remove selling_plan input when product is not opted in', () => {
+    store.getState.and.returnValue({
+      ...store.getState(),
+      sessionId: testSessionId,
+      optedin: []
+    });
+
+    const formElement = makeCartAddForm();
+    // Add an existing selling_plan input
+    const existingInput = document.createElement('input');
+    existingInput.name = 'selling_plan';
+    existingInput.value = testSellingPlan;
+    existingInput.type = 'hidden';
+    formElement.appendChild(existingInput);
+
+    expect(getFormData(formElement).selling_plan).toEqual(testSellingPlan);
+
+    synchronizeSellingPlan(store, offerElement);
+
+    expect(getFormData(formElement).selling_plan).toEqual(undefined);
+  });
+
+  it('should not run when offerElement.isCart is true', () => {
+    const formElement = makeCartAddForm();
+    const offerElement = { isCart: true, shouldEnableOffer: true };
+
+    synchronizeSellingPlan(store, offerElement);
+
+    expect(getFormData(formElement)).toEqual({});
+  });
+
+  it('should not run when offerElement.shouldEnableOffer is false', () => {
+    const formElement = makeCartAddForm();
+    const offerElement = { isCart: false, shouldEnableOffer: false };
+
+    synchronizeSellingPlan(store, offerElement);
+
+    expect(getFormData(formElement)).toEqual({});
+  });
+});

package/src/shopify/__tests__/shopifyReducer.spec.js

@@ -1,6 +1,5 @@
 import * as constants from '../../core/constants';
-import { autoshipEligible, inStock, offer, optedin, productOffer, productPlans } from '../shopifyReducer';
-import { getObjectStructuredProductPlans } from '../../core/adapters';
+import { autoshipEligible, inStock, offer, optedin, price, productOffer, productPlans } from '../shopifyReducer';
 import { DEFAULT_PAY_AS_YOU_GO_GROUP_NAME } from '../utils';
 
 describe('autoshipEligible', () => {
@@ -1052,6 +1051,65 @@ describe('optedin', () => {
   });
 });
 
+describe('price', () => {
+  it('should return price for each variant given action SETUP_PRODUCT', () => {
+    const actual = price(
+      {},
+      {
+        type: constants.SETUP_PRODUCT,
+        payload: {
+          product: {
+            id: 'yum product id',
+            variants: [
+              {
+                id: 'yum variant id 1',
+                price: 1000
+              },
+              {
+                id: 'yum variant id 2',
+                price: 2500
+              }
+            ]
+          }
+        }
+      }
+    );
+
+    expect(actual).toEqual({
+      'yum variant id 1': { value: 1000 },
+      'yum variant id 2': { value: 2500 }
+    });
+  });
+
+  it('should return unmodified state given action SETUP_PRODUCT with no variants', () => {
+    const actual = price(
+      { 'yum existing key': 'yum existing value' },
+      {
+        type: constants.SETUP_PRODUCT,
+        payload: {
+          product: {
+            id: 'yum product id'
+          }
+        }
+      }
+    );
+
+    expect(actual).toEqual({ 'yum existing key': 'yum existing value' });
+  });
+
+  it('should return unmodified state given unsupported action', () => {
+    const actual = price(
+      { 'yum existing key': 'yum existing value' },
+      {
+        type: 'yum unsupported action',
+        payload: {}
+      }
+    );
+
+    expect(actual).toEqual({ 'yum existing key': 'yum existing value' });
+  });
+});
+
 describe('productOffer', () => {
   it('should return unmodified state', () => {
     const actual = productOffer({ 'yum existing key': 'yum existing value' });
@@ -1399,7 +1457,8 @@ describe('productPlans', () => {
           prepaidShipments: null,
           regularPrice: '$0.50',
           subscriptionPrice: '$0.25',
-          discountRate: '$0.25'
+          discountRate: '$0.25',
+          hasPriceAdjustments: true
         }
       ],
       'yum variant id 2': [
@@ -1408,7 +1467,8 @@ describe('productPlans', () => {
           prepaidShipments: null,
           regularPrice: '$0.10',
           subscriptionPrice: '$0.08',
-          discountRate: '$0.02'
+          discountRate: '$0.02',
+          hasPriceAdjustments: false
         }
       ]
     });
@@ -1424,7 +1484,8 @@ describe('productPlans', () => {
           regularPrice: '$0.50',
           subscriptionPrice: '$0.25',
           discountRate: '$0.25',
-          prepaidShipments: null
+          prepaidShipments: null,
+          hasPriceAdjustments: true
         },
         {
           frequency: 'yum selling plan id prepaid 3 shipments',
@@ -1434,7 +1495,8 @@ describe('productPlans', () => {
           prepaidShipments: 3,
           regularPrepaidPrice: '$1.20',
           prepaidSavingsPerShipment: '$0.10',
-          prepaidSavingsTotal: '$0.30'
+          prepaidSavingsTotal: '$0.30',
+          hasPriceAdjustments: false
         },
         {
           frequency: 'yum selling plan id prepaid 6 shipments',
@@ -1444,7 +1506,8 @@ describe('productPlans', () => {
           prepaidShipments: 6,
           regularPrepaidPrice: '$2.40',
           prepaidSavingsPerShipment: '$0.10',
-          prepaidSavingsTotal: '$0.60'
+          prepaidSavingsTotal: '$0.60',
+          hasPriceAdjustments: false
         },
         {
           frequency: 'yum selling plan id prepaid 12 shipments',
@@ -1454,7 +1517,8 @@ describe('productPlans', () => {
           prepaidShipments: 12,
           regularPrepaidPrice: '$4.80',
           prepaidSavingsPerShipment: '$0.10',
-          prepaidSavingsTotal: '$1.20'
+          prepaidSavingsTotal: '$1.20',
+          hasPriceAdjustments: false
         }
       ],
       'yum variant id 2': [
@@ -1463,7 +1527,8 @@ describe('productPlans', () => {
           regularPrice: '$0.10',
           subscriptionPrice: '$0.08',
           discountRate: '$0.02',
-          prepaidShipments: null
+          prepaidShipments: null,
+          hasPriceAdjustments: false
         }
       ]
     });
@@ -1479,7 +1544,8 @@ describe('productPlans', () => {
           prepaidShipments: null,
           regularPrice: '£0.50',
           subscriptionPrice: '£0.25',
-          discountRate: '£0.25'
+          discountRate: '£0.25',
+          hasPriceAdjustments: true
         }
       ],
       'yum variant id 2': [
@@ -1488,7 +1554,8 @@ describe('productPlans', () => {
           prepaidShipments: null,
           regularPrice: '£0.10',
           subscriptionPrice: '£0.08',
-          discountRate: '£0.02'
+          discountRate: '£0.02',
+          hasPriceAdjustments: false
         }
       ]
     });
@@ -1504,7 +1571,8 @@ describe('productPlans', () => {
           prepaidShipments: null,
           regularPrice: '$0.50',
           subscriptionPrice: '$0.25',
-          discountRate: '$0.25'
+          discountRate: '$0.25',
+          hasPriceAdjustments: true
         }
       ],
       'yum variant key 2': [
@@ -1513,7 +1581,8 @@ describe('productPlans', () => {
           prepaidShipments: null,
           regularPrice: '$0.10',
           subscriptionPrice: '$0.08',
-          discountRate: '$0.02'
+          discountRate: '$0.02',
+          hasPriceAdjustments: false
         }
       ]
     });
@@ -1532,7 +1601,8 @@ describe('productPlans', () => {
           prepaidShipments: 12,
           regularPrepaidPrice: '$4.80',
           prepaidSavingsPerShipment: '$0.10',
-          prepaidSavingsTotal: '$1.20'
+          prepaidSavingsTotal: '$1.20',
+          hasPriceAdjustments: true
         }
       ],
       'yum variant key 2': [
@@ -1541,7 +1611,8 @@ describe('productPlans', () => {
           prepaidShipments: null,
           regularPrice: '$0.10',
           subscriptionPrice: '$0.08',
-          discountRate: '$0.02'
+          discountRate: '$0.02',
+          hasPriceAdjustments: false
         }
       ]
     });
@@ -1557,7 +1628,8 @@ describe('productPlans', () => {
           prepaidShipments: null,
           regularPrice: '£0.50',
           subscriptionPrice: '£0.25',
-          discountRate: '£0.25'
+          discountRate: '£0.25',
+          hasPriceAdjustments: true
         }
       ],
       'yum variant key 2': [
@@ -1566,7 +1638,8 @@ describe('productPlans', () => {
           prepaidShipments: null,
           regularPrice: '£0.10',
           subscriptionPrice: '£0.08',
-          discountRate: '£0.02'
+          discountRate: '£0.02',
+          hasPriceAdjustments: false
         }
       ]
     });

package/src/shopify/reducers/productPlans.ts

@@ -106,7 +106,8 @@ export const mapSellingPlanToDiscount = (
     regularPrice: getAllocationRegularPrice(allocation, currency),
     subscriptionPrice: getAllocationSubscriptionPrice(allocation, currency),
     discountRate: getAllocationDiscountRate(allocation, currency),
-    prepaidShipments: getAllocationNumberOfShipments(allocation)
+    prepaidShipments: getAllocationNumberOfShipments(allocation),
+    hasPriceAdjustments: allocation.price_adjustments?.length > 0
   };
 
   if (isPrepaidAllocation(allocation)) {