@ordergroove/offers 2.47.2 → 2.48.1-alpha-PR-1357-7.8

package/src/shopify/shopifyReducer.ts

@@ -42,16 +42,18 @@ import type {
 } from '../core/types/reducer';
 
 import { sellingPlanAllocationsReducer, getSellingPlans } from './reducers/productPlans';
-import config from './reducers/config';
+import config, { getPrepaidSellingPlans } from './reducers/config';
 import { experimentsReducer } from '../core/experiments';
 import {
   getPayAsYouGoSellingPlanGroup,
   getPayAsYouGoSellingPlanGroups,
   sellingPlansToEveryPeriod,
   sellingPlansToFrequencies,
-  getPrepaidShipments
+  getPrepaidShipments,
+  getDefaultPrepaidOption
 } from './utils';
 import { EmptyObject } from '../core/types/utility';
+import { ELIGIBILITY_GROUPS } from '../core/constants';
 
 const overrideLineKey = (state, productId, newValue) => {
   const keys = Object.keys(state).filter(it => it.startsWith(productId.toString()));
@@ -116,39 +118,76 @@ export const mapExistingOptinsFromOfferResponse = (
   });
 
 export const reduceNewOptinsFromOfferResponse = (
-  { autoship = {}, autoship_by_default = {}, default_frequencies = {}, in_stock = {} }: ReceiveOfferPayload,
+  {
+    autoship = {},
+    autoship_by_default = {},
+    default_frequencies = {},
+    in_stock = {},
+    eligibility_groups = {}
+  }: ReceiveOfferPayload,
   existingOptins: OptedInState,
   offerEl: OfferElement | EmptyObject,
-  frequencyConfig: ReceiveOfferPayload['frequencyConfig']
+  frequencyConfig: ReceiveOfferPayload['frequencyConfig'],
+  prepaidSellingPlans: ReceiveOfferPayload['prepaidSellingPlans']
 ) =>
   Object.keys(autoship).reduce((acc, id) => {
-    if (!existingOptins.some(it => it.id === id)) {
-      if (!(autoship[id] && autoship_by_default[id] && in_stock[id])) return acc;
-      const { frequencies: sellingPlans, frequenciesEveryPeriod } = frequencyConfig;
-      const { defaultFrequency } = offerEl || {};
-      const psdf = default_frequencies[id];
-      let frequency;
-
-      if (default_frequencies[id] && hasShopifySellingPlans(sellingPlans, frequenciesEveryPeriod)) {
-        frequency =
-          mapFrequencyToSellingPlan(sellingPlans, frequenciesEveryPeriod, `${psdf.every}_${psdf.every_period}`) ||
-          getDefaultSellingPlan(sellingPlans, frequenciesEveryPeriod, defaultFrequency) ||
-          getFirstSellingPlan(sellingPlans);
-      } else if (default_frequencies[id]) {
-        frequency = `${psdf.every}_${psdf.every_period}`;
-      } else {
-        frequency = getDefaultSellingPlan(sellingPlans, frequenciesEveryPeriod, defaultFrequency) || '_'; // Placeholder to be backfilled in SETUP_PRODUCT reducer
+    // if the user is not opted in and the product is set to default to subscription
+    if (!existingOptins.some(it => it.id === id) && autoship_by_default[id] && in_stock[id]) {
+      if (autoship[id]) {
+        return acc.concat({
+          id,
+          frequency: getOptInDefaultFrequency({
+            frequencyConfig,
+            offerEl,
+            default_frequencies,
+            id
+          })
+        });
+      } else if (eligibility_groups[id]?.includes(ELIGIBILITY_GROUPS.PREPAID)) {
+        // if the product is prepaid eligible but not subscription eligible, opt them into a prepaid subscription
+        const prepaidPlan = prepaidSellingPlans ? getDefaultPrepaidOption(prepaidSellingPlans) : null;
+        return acc.concat({
+          id,
+          // we might not have a prepaid plan yet if the Shopify product request hasn't completed (SETUP_PRODUCT)
+          frequency: prepaidPlan?.sellingPlan || PREPAID_PLACEHOLDER,
+          prepaidShipments: prepaidPlan?.numberShipments || null
+        });
       }
-
-      return acc.concat({
-        id,
-        frequency
-      });
     }
 
     return acc;
   }, []);
 
+const getOptInDefaultFrequency = ({
+  frequencyConfig,
+  offerEl,
+  default_frequencies,
+  id
+}: {
+  frequencyConfig: ReceiveOfferPayload['frequencyConfig'];
+  offerEl: OfferElement | EmptyObject;
+  default_frequencies: ReceiveOfferPayload['default_frequencies'];
+  id: string;
+}) => {
+  const { frequencies: sellingPlans, frequenciesEveryPeriod } = frequencyConfig;
+  const { defaultFrequency } = offerEl || {};
+  const psdf = default_frequencies[id];
+  let frequency;
+
+  if (default_frequencies[id] && hasShopifySellingPlans(sellingPlans, frequenciesEveryPeriod)) {
+    frequency =
+      mapFrequencyToSellingPlan(sellingPlans, frequenciesEveryPeriod, `${psdf.every}_${psdf.every_period}`) ||
+      getDefaultSellingPlan(sellingPlans, frequenciesEveryPeriod, defaultFrequency) ||
+      getFirstSellingPlan(sellingPlans);
+  } else if (default_frequencies[id]) {
+    frequency = `${psdf.every}_${psdf.every_period}`;
+  } else {
+    frequency = getDefaultSellingPlan(sellingPlans, frequenciesEveryPeriod, defaultFrequency) || '_'; // Placeholder to be backfilled in SETUP_PRODUCT reducer
+  }
+
+  return frequency;
+};
+
 const productOrVariantInStockReducer = (acc, cur) => ({
   ...overrideLineKey(acc, cur.id, cur.available),
   [cur.id]: cur.available
@@ -234,6 +273,7 @@ function getOptedInItem(cartItem) {
   return item;
 }
 
+const PREPAID_PLACEHOLDER = 'prepaid-replace-me';
 export const optedin = (state: OptedInState = [], action): OptedInState => {
   if (constants.SETUP_CART === action.type) {
     const cart = action.payload;
@@ -244,9 +284,15 @@ export const optedin = (state: OptedInState = [], action): OptedInState => {
 
   if (constants.RECEIVE_OFFER === action.type) {
     const payload = action.payload as ReceiveOfferPayload;
-    const { offer: offerEl = {}, frequencyConfig } = payload;
+    const { offer: offerEl = {}, frequencyConfig, prepaidSellingPlans } = payload;
     const existingOptins = mapExistingOptinsFromOfferResponse(state, offerEl, frequencyConfig);
-    const newOptins = reduceNewOptinsFromOfferResponse(payload, existingOptins, offerEl, frequencyConfig);
+    const newOptins = reduceNewOptinsFromOfferResponse(
+      payload,
+      existingOptins,
+      offerEl,
+      frequencyConfig,
+      prepaidSellingPlans
+    );
 
     return [...existingOptins, ...newOptins];
   }
@@ -254,24 +300,33 @@ export const optedin = (state: OptedInState = [], action): OptedInState => {
   if (constants.SETUP_PRODUCT === action.type) {
     const { product } = action.payload;
     const sellingPlanGroup = getPayAsYouGoSellingPlanGroup(product?.selling_plan_groups);
-    if (!sellingPlanGroup) {
-      return state;
-    }
-    const frequencies = sellingPlansToFrequencies(sellingPlanGroup);
-    const frequenciesEveryPeriod = sellingPlansToEveryPeriod(sellingPlanGroup);
-
-    return state.map(curr => {
-      if (isOgFrequency(curr.frequency)) {
-        return {
-          ...curr,
-          frequency:
-            mapFrequencyToSellingPlan(frequencies, frequenciesEveryPeriod, curr.frequency) ||
-            getFirstSellingPlan(frequencies)
-        };
-      }
+    const prepaidSellingPlans = getPrepaidSellingPlans(product);
+    const frequencies = sellingPlanGroup ? sellingPlansToFrequencies(sellingPlanGroup) : [];
+    const frequenciesEveryPeriod = sellingPlanGroup ? sellingPlansToEveryPeriod(sellingPlanGroup) : [];
 
-      return curr;
-    });
+    return state
+      .map(curr => {
+        const prepaidSellingPlansForVariant = prepaidSellingPlans[curr.id];
+        if (sellingPlanGroup && isOgFrequency(curr.frequency)) {
+          return {
+            ...curr,
+            frequency:
+              mapFrequencyToSellingPlan(frequencies, frequenciesEveryPeriod, curr.frequency) ||
+              getFirstSellingPlan(frequencies)
+          };
+        } else if (curr.frequency === PREPAID_PLACEHOLDER && prepaidSellingPlansForVariant?.length > 0) {
+          // if we opted the user into a prepaid plan on RECEIVE_OFFER and now have the actual selling plan information, update it
+          const { sellingPlan, numberShipments } = getDefaultPrepaidOption(prepaidSellingPlansForVariant);
+          return {
+            ...curr,
+            frequency: sellingPlan,
+            prepaidShipments: numberShipments
+          };
+        }
+
+        return curr;
+      })
+      .filter(i => i.frequency !== PREPAID_PLACEHOLDER); // remove any leftover placeholders
   }
 
   if (constants.PRODUCT_CHANGE_PREPAID_SHIPMENTS === action.type) {

package/src/shopify/utils.ts

@@ -77,3 +77,8 @@ export function getPrepaidShipments(sellingPlan) {
   const shipments = sellingPlan?.options.find(({ name }) => name === 'Shipment amount')?.value.split(' ')[0];
   return shipments ? Number(shipments) : undefined;
 }
+
+export function getDefaultPrepaidOption<T>(options: T[]): T {
+  // prefer the second plan by default, which has more prepaid shipments
+  return options[1] || options[0];
+}