@ordergroove/offers 2.29.0 → 2.29.1-alpha-PR-707-2.113

package/src/core/__tests__/adapters.spec.js

@@ -1,4 +1,4 @@
-import { getProductsForPurchasePost } from '../adapters';
+import { getProductsForPurchasePost, getObjectStructuredProductPlans } from '../adapters';
 
 describe('adapters', () => {
   describe('getProductsForPurchasePost', () => {
@@ -249,4 +249,235 @@ describe('adapters', () => {
       expect(actual).toEqual(expected);
     });
   });
+
+  describe('getObjectStructuredProductPlans', () => {
+    it('Should return empty objects if no variants are present on productPlan', () => {
+      const productPlans = {};
+      const expected = {};
+
+      const actual = getObjectStructuredProductPlans(productPlans);
+      expect(actual).toEqual(expected);
+    });
+
+    it('Should return object structured productPlans if receives array structured variants', () => {
+      const productPlans = {
+        'variant-1': {
+          '1_3': ['$15.00', '10%', '$13.50'],
+          '2_3': ['$15.00', '10%', '$13.50'],
+          '3_3': ['$15.00', '20%', '$12.00']
+        },
+        'variant-2': {
+          '1_3': ['$30.00', '10%', '$27.00'],
+          '2_3': ['$30.00', '10%', '$27.00'],
+          '3_3': ['$30.00', '20%', '$24.00']
+        }
+      };
+
+      const expected = {
+        'variant-1': [
+          {
+            frequency: '1_3',
+            prepaidShipments: null,
+            regularPrice: '$15.00',
+            subscriptionPrice: '$13.50',
+            discountRate: '10%'
+          },
+          {
+            frequency: '2_3',
+            prepaidShipments: null,
+            regularPrice: '$15.00',
+            subscriptionPrice: '$13.50',
+            discountRate: '10%'
+          },
+          {
+            frequency: '3_3',
+            prepaidShipments: null,
+            regularPrice: '$15.00',
+            subscriptionPrice: '$12.00',
+            discountRate: '20%'
+          }
+        ],
+
+        'variant-2': [
+          {
+            frequency: '1_3',
+            prepaidShipments: null,
+            regularPrice: '$30.00',
+            subscriptionPrice: '$27.00',
+            discountRate: '10%'
+          },
+          {
+            frequency: '2_3',
+            prepaidShipments: null,
+            regularPrice: '$30.00',
+            subscriptionPrice: '$27.00',
+            discountRate: '10%'
+          },
+          {
+            frequency: '3_3',
+            prepaidShipments: null,
+            regularPrice: '$30.00',
+            subscriptionPrice: '$24.00',
+            discountRate: '20%'
+          }
+        ]
+      };
+
+      const actual = getObjectStructuredProductPlans(productPlans);
+      expect(actual).toEqual(expected);
+    });
+
+    it('Should return object structured productPlans if receives object structured variants', () => {
+      const productPlans = {
+        'variant-1': [
+          {
+            frequency: '1_3',
+            prepaidShipments: null,
+            regularPrice: '$15.00',
+            subscriptionPrice: '$13.50',
+            discountRate: '10%'
+          },
+          {
+            frequency: '2_3',
+            prepaidShipments: null,
+            regularPrice: '$15.00',
+            subscriptionPrice: '$13.50',
+            discountRate: '10%'
+          },
+          {
+            frequency: '3_3',
+            prepaidShipments: null,
+            regularPrice: '$15.00',
+            subscriptionPrice: '$12.00',
+            discountRate: '20%'
+          },
+          {
+            frequency: '1_3',
+            prepaidShipments: 3,
+            regularPrice: '$15.00',
+            subscriptionPrice: '$12.00',
+            discountRate: '20%'
+          }
+        ],
+        'variant-2': [
+          {
+            frequency: '1_3',
+            prepaidShipments: null,
+            regularPrice: '$30.00',
+            subscriptionPrice: '$27.00',
+            discountRate: '10%'
+          },
+          {
+            frequency: '2_3',
+            prepaidShipments: null,
+            regularPrice: '$30.00',
+            subscriptionPrice: '$27.00',
+            discountRate: '10%'
+          },
+          {
+            frequency: '3_3',
+            prepaidShipments: null,
+            regularPrice: '$30.00',
+            subscriptionPrice: '$24.00',
+            discountRate: '20%'
+          },
+          {
+            frequency: '1_3',
+            prepaidShipments: 6,
+            regularPrice: '$15.00',
+            subscriptionPrice: '$12.00',
+            discountRate: '20%'
+          }
+        ]
+      };
+
+      const actual = getObjectStructuredProductPlans(productPlans);
+      expect(actual).toEqual(productPlans);
+    });
+
+    it('Should return object structured productPlans if receives payload with mixed structures', () => {
+      const productPlans = {
+        'variant-1': {
+          '1_3': ['$15.00', '10%', '$13.50'],
+          '2_3': ['$15.00', '10%', '$13.50'],
+          '3_3': ['$15.00', '20%', '$12.00']
+        },
+        'variant-2': [
+          {
+            frequency: '1_3',
+            prepaidShipments: null,
+            regularPrice: '$30.00',
+            subscriptionPrice: '$27.00',
+            discountRate: '10%'
+          },
+          {
+            frequency: '2_3',
+            prepaidShipments: null,
+            regularPrice: '$30.00',
+            subscriptionPrice: '$27.00',
+            discountRate: '10%'
+          },
+          {
+            frequency: '3_3',
+            prepaidShipments: 3,
+            regularPrice: '$30.00',
+            subscriptionPrice: '$24.00',
+            discountRate: '20%'
+          }
+        ]
+      };
+
+      const expected = {
+        'variant-1': [
+          {
+            frequency: '1_3',
+            prepaidShipments: null,
+            regularPrice: '$15.00',
+            subscriptionPrice: '$13.50',
+            discountRate: '10%'
+          },
+          {
+            frequency: '2_3',
+            prepaidShipments: null,
+            regularPrice: '$15.00',
+            subscriptionPrice: '$13.50',
+            discountRate: '10%'
+          },
+          {
+            frequency: '3_3',
+            prepaidShipments: null,
+            regularPrice: '$15.00',
+            subscriptionPrice: '$12.00',
+            discountRate: '20%'
+          }
+        ],
+        'variant-2': [
+          {
+            frequency: '1_3',
+            prepaidShipments: null,
+            regularPrice: '$30.00',
+            subscriptionPrice: '$27.00',
+            discountRate: '10%'
+          },
+          {
+            frequency: '2_3',
+            prepaidShipments: null,
+            regularPrice: '$30.00',
+            subscriptionPrice: '$27.00',
+            discountRate: '10%'
+          },
+          {
+            frequency: '3_3',
+            prepaidShipments: 3,
+            regularPrice: '$30.00',
+            subscriptionPrice: '$24.00',
+            discountRate: '20%'
+          }
+        ]
+      };
+
+      const actual = getObjectStructuredProductPlans(productPlans);
+      expect(actual).toEqual(expected);
+    });
+  });
 });

package/src/core/__tests__/descriptors.spec.js

@@ -228,3 +228,59 @@ describe('upcomingOrderContainsProduct', () => {
     ).toEqual(false);
   });
 });
+
+describe('prepaidEligible', () => {
+  it('should return false if no eligibilityGroups at all', () => {
+    expect(descriptors.prepaidEligible({}, ownProps)).toBe(false);
+  });
+
+  it('should return true if it has the prepaid group', () => {
+    expect(
+      descriptors.prepaidEligible(
+        {
+          eligibilityGroups: {
+            [productId]: ['prepaid']
+          }
+        },
+        ownProps
+      )
+    ).toBe(true);
+    expect(
+      descriptors.prepaidEligible(
+        {
+          eligibilityGroups: {
+            [productId]: []
+          }
+        },
+        ownProps
+      )
+    ).toBe(false);
+  });
+});
+
+function getPrepaidOptedinState(id, prepaidShipments) {
+  const frequency = '1_3';
+  return {
+    optedin: [
+      {
+        id,
+        frequency,
+        prepaidShipments
+      }
+    ]
+  };
+}
+
+describe('prepaidSubscribed', () => {
+  it('returns false when prepaidShipments is not set', () => {
+    expect(descriptors.prepaidSubscribed(getPrepaidOptedinState(productId, undefined), ownProps)).toBe(false);
+  });
+
+  it('returns true when prepaidShipments is set', () => {
+    expect(descriptors.prepaidSubscribed(getPrepaidOptedinState(productId, 3), ownProps)).toBe(true);
+  });
+
+  it('returns false when prepaidShipments is set for another product', () => {
+    expect(descriptors.prepaidSubscribed(getPrepaidOptedinState('otherProduct', 3), ownProps)).toBe(false);
+  });
+});

package/src/core/__tests__/reducer.spec.js

@@ -9,9 +9,12 @@ import {
   nextUpcomingOrder,
   productOffer,
   eligibilityGroups,
-  defaultFrequencies
+  defaultFrequencies,
+  productPlans,
+  prepaidShipmentsSelected
 } from '../reducer';
 import * as constants from '../constants';
+import { getObjectStructuredProductPlans } from '../adapters';
 
 describe('reducers', () => {
   function testMergeReducerWithActionAndPayload(reducerFn, actionType, payload) {
@@ -60,6 +63,85 @@ describe('reducers', () => {
         expect(actual).toEqual([{ id: 'product 3', frequency: '1_2' }]);
       });
 
+      it('should remove existing prepaidShipments given action PRODUCT_CHANGE_FREQUENCY', () => {
+        const actual = optedin(
+          [
+            {
+              id: productToTest.id,
+              frequency: '1_3',
+              prepaidShipments: 2
+            }
+          ],
+          {
+            type: constants.PRODUCT_CHANGE_FREQUENCY,
+            payload: {
+              product: productToTest,
+              frequency: '1_2'
+            }
+          }
+        );
+        expect(actual).toEqual([{ id: 'product 3', frequency: '1_2' }]);
+      });
+
+      it('should remove existing prepaidShipments given action OPTIN_PRODUCT', () => {
+        const actual = optedin(
+          [
+            {
+              id: productToTest.id,
+              frequency: '1_3',
+              prepaidShipments: 2
+            }
+          ],
+          {
+            type: constants.OPTIN_PRODUCT,
+            payload: {
+              product: productToTest,
+              frequency: '1_2'
+            }
+          }
+        );
+        expect(actual).toEqual([{ id: 'product 3', frequency: '1_2' }]);
+      });
+
+      it('should set prepaidShipments given action PRODUCT_CHANGE_PREPAID_SHIPMENTS', () => {
+        const actual = optedin(
+          [
+            {
+              id: productToTest.id,
+              frequency: '1_3'
+            }
+          ],
+          {
+            type: constants.PRODUCT_CHANGE_PREPAID_SHIPMENTS,
+            payload: {
+              product: productToTest,
+              prepaidShipments: 3
+            }
+          }
+        );
+        expect(actual).toEqual([{ id: 'product 3', frequency: '1_3', prepaidShipments: 3 }]);
+      });
+
+      it('should remove prepaidShipments given action PRODUCT_CHANGE_PREPAID_SHIPMENTS with null', () => {
+        const actual = optedin(
+          [
+            {
+              id: productToTest.id,
+              frequency: '1_3',
+              prepaidShipments: 3
+            }
+          ],
+          {
+            type: constants.PRODUCT_CHANGE_PREPAID_SHIPMENTS,
+            payload: {
+              product: productToTest,
+              prepaidShipments: null
+            }
+          }
+        );
+        expect(actual).toEqual([{ id: 'product 3', frequency: '1_3' }]);
+      });
+
       it('should return empty array given OPTOUT_PRODUCT', () => {
         const actual = optedin([], {
           type: constants.OPTOUT_PRODUCT,
@@ -829,4 +911,74 @@ describe('reducers', () => {
       ).toEqual({ foo: '1_w', bar: '2_w' });
     });
   });
+
+  describe('productPlans', () => {
+    it('should return object structure payload given action RECEIVE_PRODUCT_PLANS using getObjectStructuredProductPlans', () => {
+      const payload = {
+        'variant-1': {
+          '1_3': ['$15.00', '10%', '$13.50'],
+          '2_3': ['$15.00', '10%', '$13.50'],
+          '3_3': ['$15.00', '20%', '$12.00']
+        },
+        'variant-2': [
+          {
+            frequency: '1_3',
+            prepaidShipments: null,
+            regularPrice: '$30.00',
+            subscriptionPrice: '$27.00',
+            discountRate: '10%'
+          },
+          {
+            frequency: '2_3',
+            prepaidShipments: null,
+            regularPrice: '$30.00',
+            subscriptionPrice: '$27.00',
+            discountRate: '10%'
+          },
+          {
+            frequency: '3_3',
+            prepaidShipments: 3,
+            regularPrice: '$30.00',
+            subscriptionPrice: '$24.00',
+            discountRate: '20%'
+          }
+        ]
+      };
+
+      const actual = productPlans(
+        {},
+        {
+          type: constants.RECEIVE_PRODUCT_PLANS,
+          payload: payload
+        }
+      );
+
+      expect(actual).toEqual(getObjectStructuredProductPlans(payload));
+    });
+  });
+
+  describe('prepaidShipmentsSelected', () => {
+    const productToTest = {
+      id: 'product 3'
+    };
+
+    it('should set prepaidShipmentsSelected for product given action PRODUCT_CHANGE_PREPAID_SHIPMENTS', () => {
+      const actual = prepaidShipmentsSelected(
+        {
+          'other-product-id': 3
+        },
+        {
+          type: constants.PRODUCT_CHANGE_PREPAID_SHIPMENTS,
+          payload: {
+            product: productToTest,
+            prepaidShipments: 6
+          }
+        }
+      );
+      expect(actual).toEqual({
+        'other-product-id': 3,
+        [productToTest.id]: 6
+      });
+    });
+  });
 });

package/src/core/__tests__/selectors.spec.js

@@ -3,7 +3,8 @@ import {
   makeOptedinSelector,
   isSameProduct,
   templatesSelector,
-  makeProductDefaultFrequencySelector
+  makeProductDefaultFrequencySelector,
+  makeProductPrepaidShipmentOptionsSelector
 } from '../selectors';
 import { stringifyFrequency } from '../api';
 
@@ -85,3 +86,35 @@ describe('makeProductDefaultFrequencySelector', () => {
     );
   });
 });
+
+describe('makeProductPrepaidShipmentOptionsSelector', () => {
+  it('should retrieve product prepaid shipment options', () => {
+    const selector = makeProductPrepaidShipmentOptionsSelector(123);
+    expect(
+      selector({
+        config: {
+          prepaidSellingPlans: {
+            123: [
+              {
+                numberShipments: 3
+              },
+              {
+                numberShipments: 6
+              }
+            ]
+          }
+        }
+      })
+    ).toEqual([3, 6]);
+  });
+
+  it('should handle missing prepaidSellingPlans', () => {
+    const selector = makeProductPrepaidShipmentOptionsSelector(123);
+    expect(selector({ config: {} })).toEqual([]);
+  });
+
+  it('should handle missing product', () => {
+    const selector = makeProductPrepaidShipmentOptionsSelector(123);
+    expect(selector({ config: { prepaidSellingPlans: { 456: [{ numberShipments: 3 }] } } })).toEqual([]);
+  });
+});

package/src/core/actions.js

@@ -23,6 +23,11 @@ export const productChangeFrequency = (product, frequency, offer) => ({
   payload: { product, frequency, offer }
 });
 
+export const productChangePrepaidShipments = (product, prepaidShipments, offer) => ({
+  type: constants.PRODUCT_CHANGE_PREPAID_SHIPMENTS,
+  payload: { product, prepaidShipments, offer }
+});
+
 export const concludeUpsell = product => ({
   type: constants.CONCLUDE_UPSELL,
   payload: { product }

package/src/core/adapters.js

@@ -2,7 +2,7 @@
 import { parseFrequency } from './api';
 
 /**
- * Converst the current redux state to purchase
+ * Convert the current redux state to purchase
  * post compatible json
  */
 export const getProductsForPurchasePost = (state = {}, productIds = []) =>
@@ -29,4 +29,50 @@ export const getProductsForPurchasePost = (state = {}, productIds = []) =>
     .filter(optin => optin.tracking_override.offer)
     .filter(optin => (productIds.length ? productIds.includes(optin.product) : optin));
 
-export default { getProductsForPurchasePost };
+/**
+ * Convert the old redux state from productPlans that was array structured:
+ * {
+ *    '1_2': ['$15.00', '10%', '$13.50'],
+ *    '2_2': ['$15.00', '10%', '$13.50']
+ * }
+ * to a object structured one that can hold more information with keys:
+ * [
+ *   {
+ *     frequency: '1_2',
+ *     prepaidShipments: '3' or null,
+ *     regularPrice: '$15.00',
+ *     subscriptionPrice: '$13.50',
+ *     discountRate: '10%'
+ *   },
+ * ]
+ */
+export const getObjectStructuredProductPlans = (productPlans = {}) => {
+  const adaptedProductPlans = {};
+
+  Object.entries(productPlans).forEach(([productVariant, productPlanOnArrayStructure]) => {
+    Object.entries(productPlanOnArrayStructure).forEach(([frequencyAsKey, arrayPrices]) => {
+      let newProductPlanStructure = {};
+      if (arrayPrices && !Array.isArray(arrayPrices)) {
+        newProductPlanStructure = arrayPrices;
+      } else {
+        newProductPlanStructure = {
+          frequency: frequencyAsKey,
+          prepaidShipments: null,
+          regularPrice: arrayPrices[0],
+          subscriptionPrice: arrayPrices[2],
+          discountRate: arrayPrices[1]
+        };
+      }
+
+      if (adaptedProductPlans[productVariant]) {
+        adaptedProductPlans[productVariant].push(newProductPlanStructure);
+      } else {
+        adaptedProductPlans[productVariant] = [newProductPlanStructure];
+      }
+    });
+  });
+
+  return adaptedProductPlans;
+};
+
+export default { getProductsForPurchasePost, getObjectStructuredProductPlans };

package/src/core/constants.js

@@ -1,6 +1,7 @@
 export const OPTIN_PRODUCT = 'OPTIN_PRODUCT';
 export const OPTOUT_PRODUCT = 'OPTOUT_PRODUCT';
 export const PRODUCT_CHANGE_FREQUENCY = 'PRODUCT_CHANGE_FREQUENCY';
+export const PRODUCT_CHANGE_PREPAID_SHIPMENTS = 'PRODUCT_CHANGE_PREPAID_SHIPMENTS';
 export const SET_MERCHANT_ID = 'SET_MERCHANT_ID';
 export const REQUEST_OFFER = 'REQUEST_OFFER';
 export const RECEIVE_OFFER = 'RECEIVE_OFFER';

package/src/core/descriptors.js

@@ -1,4 +1,4 @@
-import { makeSubscribedSelector, makeOptedoutSelector } from './selectors';
+import { makeSubscribedSelector, makeOptedoutSelector, makePrepaidSubscribedSelector } from './selectors';
 
 export const inStock = (state, ownProps) => (state.inStock || {})[(ownProps.product || {}).id];
 export const eligible = (state, ownProps) => (state.autoshipEligible || {})[(ownProps.product || {}).id] || false;
@@ -15,8 +15,14 @@ export const hasUpsellGroup = (state, ownProps) => {
   return groups === null || !!groups.find(it => it === 'upsell' || it === 'impulse_upsell');
 };
 
+export const prepaidEligible = (state, ownProps) => {
+  const groups = eligibilityGroups(state, ownProps);
+  return groups?.some(it => it === 'prepaid') || false;
+};
+
 export const subscribed = (state, ownProps) => makeSubscribedSelector(ownProps.product)(state);
 export const optedout = (state, ownProps) => makeOptedoutSelector(ownProps.product)(state);
+export const prepaidSubscribed = (state, ownProps) => makePrepaidSubscribedSelector(ownProps.product)(state);
 
 export const hasUpcomingOrder = state => !!(state.nextUpcomingOrder && state.nextUpcomingOrder.public_id);