@ordergroove/offers 2.47.2-alpha-PR-1356-3.33 → 2.47.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ordergroove/offers",
-  "version": "2.47.2-alpha-PR-1356-3.33+ee810ebfe",
+  "version": "2.47.2",
   "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.10.0",
     "@types/lodash.memoize": "^4.1.9"
   },
-  "gitHead": "ee810ebfe69c9a4aae3d7dbf2624cf4ef49324e6"
+  "gitHead": "b039a0b5286ac8736eb4501b4763512f27e58953"
 }

package/src/components/IncentiveText.js

@@ -109,6 +109,9 @@ export class IncentiveText extends withProduct(LitElement) {
         // we only have criteria if the incentive is standardized
         incentive.criteria &&
         incentive.criteria.node_type === 'PREMISE' &&
+        // prefer to show non-threshold discounts
+        // we don't currently evaluate thresholds, so we don't know if they apply or not (especially if it's order-level)
+        !incentive.threshold_field &&
         preferredIncentiveStandards.includes(incentive.criteria.standard)
     );
 

package/src/components/PrepaidStatus.js

@@ -7,7 +7,6 @@ import {
 } from '../core/selectors';
 import { productChangePrepaidShipments } from '../core/actions';
 import { withProduct } from '../core/resolveProperties';
-import { getDefaultPrepaidOption } from '../shopify/utils';
 
 export class PrepaidStatus extends withProduct(LitElement) {
   static get properties() {
@@ -30,7 +29,7 @@ export class PrepaidStatus extends withProduct(LitElement) {
   getDefaultPrepaidShipments() {
     return this.options.includes(this.defaultPrepaidShipments)
       ? this.defaultPrepaidShipments
-      : getDefaultPrepaidOption(this.options);
+      : this.options[1] || this.options[0];
   }
 
   handleSelect({ target: { value } }) {

package/src/components/__tests__/IncentiveText.spec.js

@@ -208,6 +208,42 @@ describe('IncentiveText', () => {
       expect(el.innerText.trim()).toEqual('33%');
     });
 
+    it('prefers non-threshold incentives', async () => {
+      const el = new IncentiveText();
+      el.from = 'DiscountPercent';
+      el.incentives = {
+        initial: [],
+        ongoing: [
+          {
+            field: 'total_price',
+            object: 'item',
+            type: 'Discount Percent',
+            value: 25,
+            threshold_field: 'order',
+            threshold_value: '10.00',
+            criteria: {
+              node_type: 'PREMISE',
+              standard: 'PROGRAM_WIDE'
+            }
+          },
+          {
+            field: 'total_price',
+            object: 'item',
+            type: 'Discount Percent',
+            value: 10,
+            threshold_field: null,
+            threshold_value: null,
+            criteria: {
+              node_type: 'PREMISE',
+              standard: 'PROGRAM_WIDE'
+            }
+          }
+        ]
+      };
+      await appendToBody(el);
+      expect(el.innerText.trim()).toEqual('10%');
+    });
+
     it('returns other matching incentives if no preferred incentives available', async () => {
       const el = new IncentiveText();
       el.from = 'DiscountPercent';

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

@@ -1072,6 +1072,21 @@ describe('reducers', () => {
     it('should consider incentives_display_enhanced if present', () => {
       const enhancedOfferResponse = {
         ...offerResponse,
+        incentives: {
+          44198332104980: {
+            ongoing: ['8285f16f826e4cf29b49f073e45e32ab', 'threshold-id', '10205e185a5c4ccf83de75459241623a'],
+            initial: ['0f98a321d29e47d2a17fe3a8a7522d26']
+          }
+        },
+        incentives_display: {
+          ...offerResponse.incentives_display,
+          'threshold-id': {
+            object: 'order',
+            field: 'sub_total',
+            type: 'Discount Percent',
+            value: 20.0
+          }
+        },
         incentives_display_enhanced: {
           '8285f16f826e4cf29b49f073e45e32ab': {
             incentive_target: 'order',
@@ -1081,6 +1096,14 @@ describe('reducers', () => {
             threshold_field: null,
             threshold_value: null
           },
+          'threshold-id': {
+            incentive_target: 'order',
+            incentive_type: 'discount_percent',
+            incentive_value: '20.00',
+            // no criteria, since this is program-wide
+            threshold_field: 'order',
+            threshold_value: '10.00'
+          },
           '10205e185a5c4ccf83de75459241623a': {
             incentive_target: 'item',
             incentive_type: 'discount_percent',
@@ -1117,6 +1140,22 @@ describe('reducers', () => {
               type: 'Discount Percent',
               value: 10.0,
               id: '8285f16f826e4cf29b49f073e45e32ab',
+              threshold_field: null,
+              threshold_value: null,
+              criteria: {
+                node_type: 'PREMISE',
+                standard: 'PROGRAM_WIDE',
+                premise_value: null
+              }
+            },
+            {
+              object: 'order',
+              field: 'sub_total',
+              type: 'Discount Percent',
+              value: 20.0,
+              id: 'threshold-id',
+              threshold_field: 'order',
+              threshold_value: '10.00',
               criteria: {
                 node_type: 'PREMISE',
                 standard: 'PROGRAM_WIDE',
@@ -1129,6 +1168,8 @@ describe('reducers', () => {
               type: 'Discount Amount',
               value: 5.0,
               id: '10205e185a5c4ccf83de75459241623a',
+              threshold_field: null,
+              threshold_value: null,
               criteria: {
                 node_type: 'PREMISE',
                 standard: 'PREPAID_ORDERS_PER_BILLING',
@@ -1143,6 +1184,8 @@ describe('reducers', () => {
               type: 'Discount Percent',
               value: 11.0,
               id: '0f98a321d29e47d2a17fe3a8a7522d26',
+              threshold_field: null,
+              threshold_value: null,
               criteria: {
                 node_type: 'PREMISE',
                 standard: 'PSI',

package/src/core/actions.js

@@ -2,11 +2,7 @@ import { resolveAuth } from '@ordergroove/auth';
 import * as constants from './constants';
 import { api } from './api';
 import { safeOgFrequency } from './utils';
-import {
-  makeFrequencyForPrepaidShipmentsSelector,
-  makePrepaidSellingPlansSelector,
-  makeProductFrequenciesSelector
-} from './selectors';
+import { makeFrequencyForPrepaidShipmentsSelector, makeProductFrequenciesSelector } from './selectors';
 
 export const optinProduct = (product, frequency, offer) => ({
   type: constants.OPTIN_PRODUCT,
@@ -194,12 +190,10 @@ export const requestSessionId = () => (dispatch, getState) => {
 
 export const receiveOffer = (response, offer, productId) => (dispatch, getState) => {
   // this is a thunk so that we access the state for the selector
-  const state = getState();
-  const frequencyConfig = makeProductFrequenciesSelector(productId)(state);
-  const prepaidSellingPlans = makePrepaidSellingPlansSelector(productId)(state);
+  const frequencyConfig = makeProductFrequenciesSelector(productId)(getState());
   dispatch({
     type: constants.RECEIVE_OFFER,
-    payload: { ...response, offer, frequencyConfig, prepaidSellingPlans }
+    payload: { ...response, offer, frequencyConfig }
   });
 };
 

package/src/core/constants.js

@@ -61,10 +61,6 @@ export const INCENTIVE_STANDARD_TYPES = {
   PROGRAM_WIDE: 'PROGRAM_WIDE'
 };
 
-export const ELIGIBILITY_GROUPS = {
-  PREPAID: 'prepaid'
-};
-
 /**
  * @event
  * Events that fires once optin/optout occurs on a cart offer

package/src/core/descriptors.js

@@ -1,4 +1,3 @@
-import { ELIGIBILITY_GROUPS } from './constants';
 import {
   makeSubscribedSelector,
   makeOptedoutSelector,
@@ -26,7 +25,7 @@ export const hasUpsellGroup = (state, ownProps) => {
 
 export const prepaidEligible = (state, ownProps) => {
   const groups = eligibilityGroups(state, ownProps);
-  return groups?.some(it => it === ELIGIBILITY_GROUPS.PREPAID) || false;
+  return groups?.some(it => it === 'prepaid') || false;
 };
 
 export const subscribed = (state, ownProps) => makeSubscribedSelector(ownProps.product)(state);

package/src/core/reducer.ts

@@ -180,7 +180,13 @@ const mapIncentive = (
               ? enhanced.criteria
               : // when there is no criteria in the enhanced incentive, it means it's a program wide incentive
                 // for ease-of-use, we set use a "PROGRAM_WIDE" pseudo-standard here
-                { node_type: 'PREMISE', standard: constants.INCENTIVE_STANDARD_TYPES.PROGRAM_WIDE, premise_value: null }
+                {
+                  node_type: 'PREMISE',
+                  standard: constants.INCENTIVE_STANDARD_TYPES.PROGRAM_WIDE,
+                  premise_value: null
+                },
+            threshold_field: enhanced.threshold_field,
+            threshold_value: enhanced.threshold_value
           }
         : {}),
       id: [i][0]

package/src/core/selectors.ts

@@ -232,12 +232,6 @@ export const makeFrequencyForPrepaidShipmentsSelector = (product: BaseProduct, p
     }
   );
 
-export const makePrepaidSellingPlansSelector = (product: string) =>
-  createSelector(prepaidSellingPlansSelector, prepaidSellingPlans => {
-    const productId = safeProductId(product);
-    return prepaidSellingPlans[productId] || [];
-  });
-
 /** Determine the discounted price of the product, based on the incentives returned from the Offers endpoint. This assumes a pay-as-you-go subscription. */
 export const makeDiscountedProductPriceSelector = memoize((productId: string) =>
   createSelector(

package/src/core/types/reducer.ts

@@ -20,8 +20,10 @@ export type IncentivesState = Record<string, IncentiveObject>;
 export type Incentive = ApiIncentive & {
   id: string;
   /**
-   * undefined when the offer profile is not standardized
+   * all these fields are undefined when the offer profile is not standardized
    */
+  threshold_field?: string | null;
+  threshold_value?: string | null;
   criteria?: {
     node_type: string;
     premise_value: unknown;
@@ -53,13 +55,11 @@ export type ConfigState = Partial<{
    * @deprecated use productFrequencies instead
    */
   frequenciesText: string[];
-  prepaidSellingPlans: Record<string, PrepaidSellingPlan[]>;
+  prepaidSellingPlans: Record<string, { numberShipments: number; sellingPlan: string }[]>;
   storeCurrency: string;
   productFrequencies: Record<string, ProductFrequencyConfig>;
 }>;
 
-export type PrepaidSellingPlan = { numberShipments: number; sellingPlan: string };
-
 export type ProductFrequencyConfig = {
   frequencies?: string[];
   frequenciesEveryPeriod?: string[];
@@ -92,7 +92,6 @@ export type ReceiveOfferPayload = OfferResponse & {
     frequenciesEveryPeriod?: string[];
     frequenciesText?: string[];
   };
-  prepaidSellingPlans: PrepaidSellingPlan[];
 };
 
 export type OfferElement = InstanceType<typeof Offer> & { config: ConfigState };

package/src/shopify/__tests__/reducers/optedin.spec.js

@@ -2,45 +2,6 @@ import * as constants from '../../../core/constants';
 import { optedin } from '../../shopifyReducer';
 import { DEFAULT_PAY_AS_YOU_GO_GROUP_NAME } from '../../utils';
 
-const PREPAID_PRODUCT_ID = '43017264201944';
-const BOTH_ELIGIBLE_PRODUCT_ID = '43017264201946';
-
-const PREPAID_PLAN_3_SHIPMENTS = 'prepaid-plan-3-shipments';
-const PREPAID_PLAN_6_SHIPMENTS = 'prepaid-plan-6-shipments';
-
-const prepaidPlanWith3Shipments = { sellingPlan: PREPAID_PLAN_3_SHIPMENTS, numberShipments: 3 };
-const prepaidPlanWith6Shipments = { sellingPlan: PREPAID_PLAN_6_SHIPMENTS, numberShipments: 6 };
-
-function buildReceiveOfferPayload(overrides = {}) {
-  return {
-    autoship: {},
-    autoship_by_default: {},
-    default_frequencies: {},
-    in_stock: {},
-    eligibility_groups: {},
-    offer: {},
-    frequencyConfig: {
-      frequencies: [],
-      frequenciesEveryPeriod: []
-    },
-    prepaidSellingPlans: [],
-    ...overrides
-  };
-}
-
-function buildPrepaidSellingPlanGroup(variantId, plans) {
-  return {
-    name: `Prepaid-${variantId}`,
-    selling_plans: plans.map((plan, index) => ({
-      id: plan.sellingPlan,
-      options: [
-        { name: 'Delivery every', value: `PREPAID-${index + 1} months` },
-        { name: 'Shipment amount', value: `${plan.numberShipments} shipments` }
-      ]
-    }))
-  };
-}
-
 describe('optedin', () => {
   it('should return optins given action SETUP_CART', () => {
     const actual = optedin([], {
@@ -622,208 +583,6 @@ describe('optedin', () => {
           ]);
         });
       });
-
-      describe('given product is prepaid eligible but NOT autoship eligible', () => {
-        describe('given prepaidSellingPlans are populated', () => {
-          it('should opt into 2nd prepaid plan and set prepaidShipments when multiple plans available', () => {
-            const actual = optedin([], {
-              type: constants.RECEIVE_OFFER,
-              payload: buildReceiveOfferPayload({
-                autoship: {
-                  [PREPAID_PRODUCT_ID]: false
-                },
-                autoship_by_default: {
-                  [PREPAID_PRODUCT_ID]: true
-                },
-                in_stock: {
-                  [PREPAID_PRODUCT_ID]: true
-                },
-                eligibility_groups: {
-                  [PREPAID_PRODUCT_ID]: [constants.ELIGIBILITY_GROUPS.PREPAID]
-                },
-                prepaidSellingPlans: [prepaidPlanWith3Shipments, prepaidPlanWith6Shipments]
-              })
-            });
-
-            expect(actual).toEqual([
-              {
-                id: PREPAID_PRODUCT_ID,
-                frequency: PREPAID_PLAN_6_SHIPMENTS,
-                prepaidShipments: 6
-              }
-            ]);
-          });
-
-          it('should opt into 1st prepaid plan and set prepaidShipments when only one plan available', () => {
-            const actual = optedin([], {
-              type: constants.RECEIVE_OFFER,
-              payload: buildReceiveOfferPayload({
-                autoship: {
-                  [PREPAID_PRODUCT_ID]: false
-                },
-                autoship_by_default: {
-                  [PREPAID_PRODUCT_ID]: true
-                },
-                in_stock: {
-                  [PREPAID_PRODUCT_ID]: true
-                },
-                eligibility_groups: {
-                  [PREPAID_PRODUCT_ID]: [constants.ELIGIBILITY_GROUPS.PREPAID]
-                },
-                prepaidSellingPlans: [prepaidPlanWith3Shipments]
-              })
-            });
-
-            expect(actual).toEqual([
-              {
-                id: PREPAID_PRODUCT_ID,
-                frequency: PREPAID_PLAN_3_SHIPMENTS,
-                prepaidShipments: 3
-              }
-            ]);
-          });
-        });
-
-        describe('given prepaidSellingPlans are NOT populated', () => {
-          it('should opt into prepaid with PREPAID_PLACEHOLDER and prepaidShipments null', () => {
-            const actual = optedin([], {
-              type: constants.RECEIVE_OFFER,
-              payload: buildReceiveOfferPayload({
-                autoship: {
-                  [PREPAID_PRODUCT_ID]: false
-                },
-                autoship_by_default: {
-                  [PREPAID_PRODUCT_ID]: true
-                },
-                in_stock: {
-                  [PREPAID_PRODUCT_ID]: true
-                },
-                eligibility_groups: {
-                  [PREPAID_PRODUCT_ID]: [constants.ELIGIBILITY_GROUPS.PREPAID]
-                },
-                prepaidSellingPlans: []
-              })
-            });
-
-            expect(actual).toEqual([
-              {
-                id: PREPAID_PRODUCT_ID,
-                frequency: 'prepaid-replace-me',
-                prepaidShipments: null
-              }
-            ]);
-          });
-        });
-
-        describe('edge cases', () => {
-          it('should not create optin when product not in stock, not autoship_by_default, or not in eligibility_groups', () => {
-            // Product not in stock
-            const notInStock = optedin([], {
-              type: constants.RECEIVE_OFFER,
-              payload: buildReceiveOfferPayload({
-                autoship: {
-                  [PREPAID_PRODUCT_ID]: false
-                },
-                autoship_by_default: {
-                  [PREPAID_PRODUCT_ID]: true
-                },
-                in_stock: {
-                  [PREPAID_PRODUCT_ID]: false
-                },
-                eligibility_groups: {
-                  [PREPAID_PRODUCT_ID]: [constants.ELIGIBILITY_GROUPS.PREPAID]
-                },
-                prepaidSellingPlans: [prepaidPlanWith3Shipments]
-              })
-            });
-
-            // Product not autoship_by_default
-            const notAutoshipByDefault = optedin([], {
-              type: constants.RECEIVE_OFFER,
-              payload: buildReceiveOfferPayload({
-                autoship: {
-                  [PREPAID_PRODUCT_ID]: false
-                },
-                autoship_by_default: {
-                  [PREPAID_PRODUCT_ID]: false
-                },
-                in_stock: {
-                  [PREPAID_PRODUCT_ID]: true
-                },
-                eligibility_groups: {
-                  [PREPAID_PRODUCT_ID]: [constants.ELIGIBILITY_GROUPS.PREPAID]
-                },
-                prepaidSellingPlans: [prepaidPlanWith3Shipments]
-              })
-            });
-
-            // Product not in eligibility_groups
-            const notInEligibilityGroups = optedin([], {
-              type: constants.RECEIVE_OFFER,
-              payload: buildReceiveOfferPayload({
-                autoship: {
-                  [PREPAID_PRODUCT_ID]: false
-                },
-                autoship_by_default: {
-                  [PREPAID_PRODUCT_ID]: true
-                },
-                in_stock: {
-                  [PREPAID_PRODUCT_ID]: true
-                },
-                eligibility_groups: {
-                  [PREPAID_PRODUCT_ID]: []
-                },
-                prepaidSellingPlans: [prepaidPlanWith3Shipments]
-              })
-            });
-
-            expect(notInStock).toEqual([]);
-            expect(notAutoshipByDefault).toEqual([]);
-            expect(notInEligibilityGroups).toEqual([]);
-          });
-        });
-      });
-
-      describe('given product is BOTH prepaid eligible AND autoship eligible', () => {
-        it('should opt into regular subscription with PSDF frequency, not prepaid', () => {
-          const actual = optedin([], {
-            type: constants.RECEIVE_OFFER,
-            payload: buildReceiveOfferPayload({
-              autoship: {
-                [BOTH_ELIGIBLE_PRODUCT_ID]: true
-              },
-              autoship_by_default: {
-                [BOTH_ELIGIBLE_PRODUCT_ID]: true
-              },
-              default_frequencies: {
-                [BOTH_ELIGIBLE_PRODUCT_ID]: {
-                  every: 1,
-                  every_period: 2
-                }
-              },
-              in_stock: {
-                [BOTH_ELIGIBLE_PRODUCT_ID]: true
-              },
-              eligibility_groups: {
-                [BOTH_ELIGIBLE_PRODUCT_ID]: [constants.ELIGIBILITY_GROUPS.PREPAID]
-              },
-              frequencyConfig: {
-                frequencies: ['yum selling plan id 1', 'yum selling plan id 2'],
-                frequenciesEveryPeriod: ['1_1', '1_2']
-              },
-              prepaidSellingPlans: [prepaidPlanWith3Shipments, prepaidPlanWith6Shipments]
-            })
-          });
-
-          expect(actual).toEqual([
-            {
-              id: BOTH_ELIGIBLE_PRODUCT_ID,
-              frequency: 'yum selling plan id 2'
-            }
-          ]);
-          expect(actual[0].prepaidShipments).toBeUndefined();
-        });
-      });
     });
   });
 
@@ -997,69 +756,6 @@ describe('optedin', () => {
         }
       ]);
     });
-
-    describe('given frequency is PREPAID_PLACEHOLDER', () => {
-      describe('given prepaidSellingPlans exist for variant', () => {
-        it('should replace prepaid placeholder optin', () => {
-          const actual = optedin(
-            [
-              {
-                id: PREPAID_PRODUCT_ID,
-                frequency: 'prepaid-replace-me',
-                prepaidShipments: null
-              }
-            ],
-            {
-              type: constants.SETUP_PRODUCT,
-              payload: {
-                product: {
-                  variants: [{ id: PREPAID_PRODUCT_ID }],
-                  selling_plan_groups: [
-                    buildPrepaidSellingPlanGroup(PREPAID_PRODUCT_ID, [
-                      prepaidPlanWith3Shipments,
-                      prepaidPlanWith6Shipments
-                    ])
-                  ]
-                }
-              }
-            }
-          );
-
-          expect(actual).toEqual([
-            {
-              id: PREPAID_PRODUCT_ID,
-              frequency: PREPAID_PLAN_6_SHIPMENTS,
-              prepaidShipments: 6
-            }
-          ]);
-        });
-      });
-
-      describe('given prepaidSellingPlans do NOT exist for variant', () => {
-        it('should remove placeholder optin', () => {
-          const actual = optedin(
-            [
-              {
-                id: PREPAID_PRODUCT_ID,
-                frequency: 'prepaid-replace-me',
-                prepaidShipments: null
-              }
-            ],
-            {
-              type: constants.SETUP_PRODUCT,
-              payload: {
-                product: {
-                  variants: [{ id: PREPAID_PRODUCT_ID }],
-                  selling_plan_groups: []
-                }
-              }
-            }
-          );
-
-          expect(actual).toEqual([]);
-        });
-      });
-    });
   });
 
   describe('given action is PRODUCT_CHANGE_PREPAID_SHIPMENTS', () => {
@@ -1111,49 +807,6 @@ describe('optedin', () => {
     });
   });
 
-  it('integration: SETUP_PRODUCT after RECEIVE_OFFER should handle default prepaid optin', () => {
-    // Step 1: RECEIVE_OFFER creates optin with placeholder (no prepaidSellingPlans available yet)
-    const afterReceiveOffer = optedin([], {
-      type: constants.RECEIVE_OFFER,
-      payload: buildReceiveOfferPayload({
-        autoship: {
-          [PREPAID_PRODUCT_ID]: false
-        },
-        autoship_by_default: {
-          [PREPAID_PRODUCT_ID]: true
-        },
-        in_stock: {
-          [PREPAID_PRODUCT_ID]: true
-        },
-        eligibility_groups: {
-          [PREPAID_PRODUCT_ID]: [constants.ELIGIBILITY_GROUPS.PREPAID]
-        },
-        prepaidSellingPlans: []
-      })
-    });
-
-    // Step 2: SETUP_PRODUCT replaces placeholder with actual selling plan
-    const afterSetupProduct = optedin(afterReceiveOffer, {
-      type: constants.SETUP_PRODUCT,
-      payload: {
-        product: {
-          variants: [{ id: PREPAID_PRODUCT_ID }],
-          selling_plan_groups: [
-            buildPrepaidSellingPlanGroup(PREPAID_PRODUCT_ID, [prepaidPlanWith3Shipments, prepaidPlanWith6Shipments])
-          ]
-        }
-      }
-    });
-
-    expect(afterSetupProduct).toEqual([
-      {
-        id: PREPAID_PRODUCT_ID,
-        frequency: PREPAID_PLAN_6_SHIPMENTS,
-        prepaidShipments: 6
-      }
-    ]);
-  });
-
   it('should return unmodified state given unsupported action', () => {
     const actual = optedin(
       { 'yum existing key': 'yum existing value' },