@ordergroove/offers 2.43.0 → 2.44.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ordergroove/offers",
-  "version": "2.43.0",
+  "version": "2.44.0",
   "description": "offer state component",
   "author": "Eugenio Lattanzio <eugenio63@gmail.com>",
   "homepage": "https://github.com/ordergroove/plush-toys#readme",
@@ -49,5 +49,5 @@
     "@ordergroove/offers-templates": "^0.9.7",
     "@types/lodash.memoize": "^4.1.9"
   },
-  "gitHead": "1d7eee6c50a2d2d57db5f8f94dd37f0640560c2c"
+  "gitHead": "6920106790e66edb68d2f452825f9dc4be5911d4"
 }

package/src/core/experiments.js

@@ -1,7 +1,7 @@
 import { READY, RECEIVE_MERCHANT_SETTINGS, REQUEST_OFFER, SET_EXPERIMENT_VARIANT, SETUP_PRODUCT } from './constants';
 import murmur from 'murmurhash-js';
 import { waitFor } from './waitUntilOffersReady';
-import { EXPERIMENT_SHOPIFY_APP_ID_PREFIX } from '../shopify/shopifyReducer';
+import { isExperimentSellingPlanGroup } from '../shopify/utils';
 
 /**
  * Returns the index of a variant based on the provided key and variants.
@@ -77,9 +77,7 @@ function resolveShopifySetupProductWhenExperiment(variant, product, experimentSe
 
   if (experimentSettings.variants.length === 0) return;
 
-  const sellingPlanGroups = product.selling_plan_groups.filter(group =>
-    group.app_id?.startsWith(EXPERIMENT_SHOPIFY_APP_ID_PREFIX)
-  );
+  const sellingPlanGroups = product.selling_plan_groups.filter(isExperimentSellingPlanGroup);
 
   if (sellingPlanGroups.length !== experimentSettings.variants.length) return;
 

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

@@ -6,9 +6,9 @@ import {
   getAllocationDiscountRate,
   addPrepaidPriceAndSavings,
   mapSellingPlanToDiscount,
-  getSellingPlans,
-  DEFAULT_PAY_AS_YOU_GO_GROUP_NAME
+  getSellingPlans
 } from '../reducers/productPlans';
+import { DEFAULT_PAY_AS_YOU_GO_GROUP_NAME } from '../utils';
 
 describe('Shopify productPlan Reducer', () => {
   describe('isPrepaidAllocation', () => {
@@ -329,6 +329,9 @@ describe('Shopify productPlan Reducer', () => {
       const sellingPlans = [
         {
           id: 688412983572,
+          group: {
+            name: 'Prepaid-'
+          },
           name: 'Delivered every 1 month, prepaid for 3 shipments',
           description: null,
           options: [
@@ -410,7 +413,10 @@ describe('Shopify productPlan Reducer', () => {
               value_type: 'price',
               value: 4798
             }
-          ]
+          ],
+          group: {
+            name: 'Prepaid-'
+          }
         }
       ];
 
@@ -462,7 +468,9 @@ describe('Shopify productPlan Reducer', () => {
               value: 4800
             }
           ],
-          group_name: 'Prepaid-'
+          group: {
+            name: 'Prepaid-'
+          }
         },
         {
           id: 688412983573,
@@ -484,7 +492,9 @@ describe('Shopify productPlan Reducer', () => {
               value: 10
             }
           ],
-          group_name: DEFAULT_PAY_AS_YOU_GO_GROUP_NAME
+          group: {
+            name: DEFAULT_PAY_AS_YOU_GO_GROUP_NAME
+          }
         }
       ];
 
@@ -560,7 +570,7 @@ describe('Shopify productPlan Reducer', () => {
 
       const expectedSellingPlans = [
         {
-          group_name: 'Prepaid-',
+          group: product.selling_plan_groups[0],
           id: 688412721428,
           options: [
             {
@@ -576,7 +586,7 @@ describe('Shopify productPlan Reducer', () => {
           ]
         },
         {
-          group_name: DEFAULT_PAY_AS_YOU_GO_GROUP_NAME,
+          group: product.selling_plan_groups[1],
           id: 688412623124,
           options: [
             {
@@ -587,7 +597,7 @@ describe('Shopify productPlan Reducer', () => {
           ]
         },
         {
-          group_name: DEFAULT_PAY_AS_YOU_GO_GROUP_NAME,
+          group: product.selling_plan_groups[1],
           id: 688412655892,
           options: [
             {

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

@@ -10,7 +10,7 @@ import {
   textToFreq
 } from '../shopifyReducer';
 import { getObjectStructuredProductPlans } from '../../core/adapters';
-import { DEFAULT_PAY_AS_YOU_GO_GROUP_NAME } from '../reducers/productPlans';
+import { DEFAULT_PAY_AS_YOU_GO_GROUP_NAME } from '../utils';
 
 describe('autoshipEligible', () => {
   it('should return true for each id given action RECEIVE_PRODUCT_PLANS', () => {
@@ -1760,6 +1760,7 @@ function getSetupProductActionForPrepaidProduct(currency = 'USD') {
         ],
         selling_plan_groups: [
           {
+            name: 'Prepaid-1',
             selling_plans: [
               {
                 id: 'yum selling plan id 1',
@@ -1795,6 +1796,7 @@ function getSetupProductActionForPrepaidProduct(currency = 'USD') {
             ]
           },
           {
+            name: 'Prepaid-2',
             selling_plans: [
               {
                 id: 'yum selling plan id prepaid 3 shipments',

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

@@ -1,4 +1,4 @@
-import { money, percentage } from '../utils';
+import { getPayAsYouGoSellingPlanGroups, money, percentage } from '../utils';
 
 describe('Shopify Utils', () => {
   describe('Money', () => {
@@ -27,3 +27,47 @@ describe('Shopify Utils', () => {
     });
   });
 });
+
+describe('selling plan queries', () => {
+  describe('getPayAsYouGoSellingPlanGroups', () => {
+    it('returns default group with app ID', () => {
+      expect(
+        getPayAsYouGoSellingPlanGroups([{ name: 'Subscribe and Save', app_id: 'ordergroove-subscribe-and-save' }])
+          .length
+      ).toBe(1);
+    });
+
+    it('returns default group without app ID', () => {
+      expect(getPayAsYouGoSellingPlanGroups([{ name: 'Subscribe and Save', app_id: null }]).length).toBe(1);
+    });
+
+    it('returns PSI selling plan groups', () => {
+      expect(
+        getPayAsYouGoSellingPlanGroups([{ name: 'incentive-group', app_id: 'ordergroove-subscribe-and-save' }]).length
+      ).toBe(1);
+    });
+
+    it('does not return prepaid selling plan groups', () => {
+      expect(
+        getPayAsYouGoSellingPlanGroups([{ name: 'Prepaid-1', app_id: 'ordergroove-prepaid-and-save' }]).length
+      ).toBe(0);
+    });
+
+    it('returns PSFL group with app ID', () => {
+      expect(
+        getPayAsYouGoSellingPlanGroups([
+          {
+            // name probably still starts with og_psfl
+            // but changing it so that the app_id branch is hit
+            name: 'changed-psfl-name',
+            app_id: 'ordergroove-product-specific-frequency-list'
+          }
+        ]).length
+      ).toBe(1);
+    });
+
+    it('returns PSFL group without app ID', () => {
+      expect(getPayAsYouGoSellingPlanGroups([{ name: 'og_psfl_1w', app_id: null }]).length).toBe(1);
+    });
+  });
+});

package/src/shopify/reducers/productPlans.ts

@@ -1,4 +1,4 @@
-import { money, percentage } from '../utils';
+import { getPayAsYouGoSellingPlan, money, percentage } from '../utils';
 import { ShopifyProductEntity, ShopifySellingPlanAllocationsEntity, ShopifySellingPlansEntity } from '../types/shopify';
 import { ProductPlanEntity } from '../types/productPlan';
 
@@ -92,8 +92,6 @@ export const addPrepaidPriceAndSavings = (
   return productPlan;
 };
 
-export const DEFAULT_PAY_AS_YOU_GO_GROUP_NAME = 'Subscribe and Save';
-
 export const mapSellingPlanToDiscount = (
   allocation: ShopifySellingPlanAllocationsEntity,
   sellingPlans: ShopifySellingPlansEntity[],
@@ -112,9 +110,7 @@ export const mapSellingPlanToDiscount = (
   };
 
   if (isPrepaidAllocation(allocation)) {
-    const payAsYouGoPlan = sellingPlans.find(
-      plan => plan.group_name === DEFAULT_PAY_AS_YOU_GO_GROUP_NAME && plan.options.length === 1
-    );
+    const payAsYouGoPlan = getPayAsYouGoSellingPlan(sellingPlans);
     return addPrepaidPriceAndSavings(allocation, productPlan, payAsYouGoPlan, currency);
   }
 
@@ -130,9 +126,6 @@ export const sellingPlanAllocationsReducer = (
 
 export const getSellingPlans = (product: ShopifyProductEntity) =>
   product.selling_plan_groups.reduce<ShopifySellingPlansEntity[]>(
-    (allGroups, group) => [
-      ...allGroups,
-      ...group.selling_plans.map(selling_plan => ({ ...selling_plan, group_name: group.name }))
-    ],
+    (allGroups, group) => [...allGroups, ...group.selling_plans.map(selling_plan => ({ ...selling_plan, group }))],
     []
   );

package/src/shopify/shopifyReducer.js

@@ -34,14 +34,13 @@ import {
 
 import { getObjectStructuredProductPlans } from '../core/adapters';
 
-import {
-  sellingPlanAllocationsReducer,
-  getSellingPlans,
-  DEFAULT_PAY_AS_YOU_GO_GROUP_NAME
-} from './reducers/productPlans';
+import { sellingPlanAllocationsReducer, getSellingPlans } from './reducers/productPlans';
 import { experimentsReducer } from '../core/experiments';
-
-export const EXPERIMENT_SHOPIFY_APP_ID_PREFIX = 'ordergroove-subscribe-and-save-';
+import {
+  getPayAsYouGoSellingPlanGroup,
+  getPayAsYouGoSellingPlanGroups,
+  isProductSpecificFrequencySellingPlanGroup
+} from './utils';
 
 const overrideLineKey = (state, productId, newValue) => {
   const keys = Object.keys(state).filter(it => it.startsWith(productId.toString()));
@@ -129,42 +128,6 @@ export const reduceNewOptinsFromOfferResponse = (
     return acc;
   }, []);
 
-const getExperimentSellingPlanGroup = product => {
-  return product?.selling_plan_groups.find(group => group.app_id?.startsWith(EXPERIMENT_SHOPIFY_APP_ID_PREFIX));
-};
-
-const getOGSellingPlanGroup = product => {
-  // retrieve an OG Default or PSFL Selling Plan Group, preferring to return PSFL groups if they exist
-  const productSpecificFrequencySellingPlanGroup = product?.selling_plan_groups.find(
-    isProductSpecificFrequencySellingPlanGroup
-  );
-
-  return (
-    productSpecificFrequencySellingPlanGroup ||
-    getDefaultSubscriptionSellingPlanGroup(product) ||
-    getExperimentSellingPlanGroup(product)
-  );
-};
-
-const getOGSellingPlanGroups = product => {
-  const sellingPlanGroups = (product?.selling_plan_groups || []).filter(
-    group =>
-      isDefaultSellingPlanGroup(group) ||
-      isProductSpecificFrequencySellingPlanGroup(group) ||
-      group.app_id?.startsWith(EXPERIMENT_SHOPIFY_APP_ID_PREFIX)
-  );
-  return sellingPlanGroups;
-};
-
-const getDefaultSubscriptionSellingPlanGroup = product => {
-  // retrieve the OG Default Selling Plan Group
-  return product?.selling_plan_groups.find(isDefaultSellingPlanGroup);
-};
-
-const isDefaultSellingPlanGroup = group => group.name === DEFAULT_PAY_AS_YOU_GO_GROUP_NAME;
-
-const isProductSpecificFrequencySellingPlanGroup = group => group.name.startsWith('og_psfl');
-
 const productOrVariantInStockReducer = (acc, cur) => ({
   ...overrideLineKey(acc, cur.id, cur.available),
   [cur.id]: cur.available
@@ -189,7 +152,7 @@ export const autoshipEligible = (state = {}, action) => {
     const {
       payload: { product }
     } = action;
-    const applicableSellingPlanGroups = getOGSellingPlanGroups(product);
+    const applicableSellingPlanGroups = getPayAsYouGoSellingPlanGroups(product?.selling_plan_groups);
 
     const ogSellingPlanIds = new Set(
       applicableSellingPlanGroups.flatMap(group => group.selling_plans.map(sellingPlan => sellingPlan.id)) ?? []
@@ -281,7 +244,7 @@ export const config = (
     } = action;
     let configToAdd = {};
     // pay as you go selling plans
-    const sellingPlanGroup = getOGSellingPlanGroup(product);
+    const sellingPlanGroup = getPayAsYouGoSellingPlanGroup(product?.selling_plan_groups);
     const frequencies = sellingPlansToFrequencies(sellingPlanGroup);
     if (frequencies?.length) {
       const frequenciesEveryPeriod = sellingPlansToEveryPeriod(sellingPlanGroup);
@@ -430,7 +393,7 @@ export const optedin = (state = [], action) => {
 
   if (constants.SETUP_PRODUCT === action.type) {
     const { product } = action.payload;
-    const sellingPlanGroup = getOGSellingPlanGroup(product);
+    const sellingPlanGroup = getPayAsYouGoSellingPlanGroup(product?.selling_plan_groups);
     if (!sellingPlanGroup) {
       return state;
     }

package/src/shopify/types/shopify.ts

@@ -25,7 +25,7 @@ export interface ShopifySellingPlansEntity {
   options?: ShopifyOptionsEntity[] | null;
   recurring_deliveries: boolean;
   price_adjustments?: ShopifyPriceAdjustmentsEntity[] | null;
-  group_name?: string;
+  group: ShopifySellingPlanGroupsEntity;
 }
 
 export interface ShopifySellingPlanGroupsEntity {

package/src/shopify/utils.ts

@@ -1,3 +1,5 @@
+import { ShopifySellingPlanGroupsEntity, ShopifySellingPlansEntity } from './types/shopify';
+
 export const money = (val: number, currency: string) =>
   val === null
     ? ''
@@ -7,3 +9,46 @@ export const money = (val: number, currency: string) =>
       }).format(val / 100);
 
 export const percentage = val => `${val}%`;
+
+export const DEFAULT_PAY_AS_YOU_GO_GROUP_NAME = 'Subscribe and Save';
+const EXPERIMENT_SHOPIFY_APP_ID_PREFIX = 'ordergroove-subscribe-and-save-';
+
+// returns the non-prepaid OG selling plan to use for displaying frequencies
+export const getPayAsYouGoSellingPlanGroup = (sellingPlanGroups: ShopifySellingPlanGroupsEntity[] = []) => {
+  // retrieve an OG Default or PSFL Selling Plan Group, preferring to return PSFL groups if they exist
+  const productSpecificFrequencySellingPlanGroup = sellingPlanGroups.find(isProductSpecificFrequencySellingPlanGroup);
+
+  return (
+    productSpecificFrequencySellingPlanGroup ||
+    sellingPlanGroups.find(isDefaultSellingPlanGroup) ||
+    sellingPlanGroups.find(isExperimentSellingPlanGroup)
+  );
+};
+
+// returns OG selling plan groups that are not prepaid
+export const getPayAsYouGoSellingPlanGroups = (sellingPlanGroups: ShopifySellingPlanGroupsEntity[] = []) => {
+  return sellingPlanGroups.filter(
+    group =>
+      isDefaultSellingPlanGroup(group) ||
+      isProductSpecificFrequencySellingPlanGroup(group) ||
+      isExperimentSellingPlanGroup(group)
+  );
+};
+
+const isDefaultSellingPlanGroup = (group: ShopifySellingPlanGroupsEntity) =>
+  // we need to check name or app_id - the app_id is newer and not all selling plans have it
+  // the default group name is only applied to the default selling plan group
+  // flex incentives selling plan groups have a different name but the same subscribe-and-save app ID
+  group.name === DEFAULT_PAY_AS_YOU_GO_GROUP_NAME || group.app_id === 'ordergroove-subscribe-and-save';
+
+export const isProductSpecificFrequencySellingPlanGroup = (group: ShopifySellingPlanGroupsEntity) =>
+  group.name.startsWith('og_psfl') || group.app_id === 'ordergroove-product-specific-frequency-list';
+
+export const isExperimentSellingPlanGroup = (group: ShopifySellingPlanGroupsEntity) =>
+  // @ts-expect-error 18047
+  group.app_id?.startsWith(EXPERIMENT_SHOPIFY_APP_ID_PREFIX);
+
+export const getPayAsYouGoSellingPlan = (sellingPlans: ShopifySellingPlansEntity[]) => {
+  const group = getPayAsYouGoSellingPlanGroup(sellingPlans.map(plan => plan.group));
+  return sellingPlans.find(plan => plan.group === group);
+};