@ordergroove/offers 2.36.1 → 2.36.2-alpha-PR-836-4.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ordergroove/offers",
-  "version": "2.36.1",
+  "version": "2.36.2-alpha-PR-836-4.4+979e5e4f",
   "description": "offer state component",
   "author": "Eugenio Lattanzio <eugenio63@gmail.com>",
   "homepage": "https://github.com/ordergroove/plush-toys#readme",
@@ -48,5 +48,5 @@
     "@ordergroove/offers-templates": "^0.9.6",
     "@types/lodash.memoize": "^4.1.9"
   },
-  "gitHead": "174743085e4d3672ceb73b8384b5cb897bc41289"
+  "gitHead": "979e5e4f88661c37d410fc44a0a8c658938a23d9"
 }

package/src/components/Offer.js

@@ -28,16 +28,24 @@ import { DEFAULT_OFFER_MODULE } from '../core/constants';
 
 const memoizeKey = (...args) => JSON.stringify(args);
 
-let hasLogged = false;
-function logMulticurrencyWarning(storeCurrency, primaryCurrency) {
-  // only log once
-  if (!hasLogged) {
-    console.warn(
-      `Hiding Ordergroove offer since the store currency ${storeCurrency} does not match your configured currency ${primaryCurrency} and you are not set up for multicurrency. Contact your Ordergroove representative for next steps.`
-    );
-    hasLogged = true;
-  }
-}
+const logOnce = messageFn => {
+  let hasLogged = false;
+  return (...args) => {
+    if (!hasLogged) {
+      console.warn(messageFn(...args));
+      hasLogged = true;
+    }
+  };
+};
+
+const logMulticurrencyWarning = logOnce(
+  (storeCurrency, primaryCurrency) =>
+    `Hiding Ordergroove offer since the store currency ${storeCurrency} does not match your configured currency ${primaryCurrency} and you are not set up for multicurrency. Contact your Ordergroove representative for next steps.`
+);
+
+const logProductSpecificFrequencyListWarning = logOnce(
+  () => `Hiding Ordergroove offer since cart offers does not currently support product-specific frequency lists.`
+);
 
 export const productAndComponents = memoize(
   (product, components) => Object.assign({ components }, product),
@@ -327,8 +335,14 @@ export class Offer extends TemplateElement {
         this.config.storeCurrency === this.config.merchantSettings.currency_code;
       if (!shouldEnable) {
         logMulticurrencyWarning(this.config.storeCurrency, this.config.merchantSettings.currency_code);
+        return false;
       }
-      return shouldEnable;
+    }
+
+    // product-specific frequency lists are not supported in cart offers
+    if (this.isCart && this.config?.hasProductSpecificFrequencies) {
+      logProductSpecificFrequencyListWarning();
+      return false;
     }
 
     return true;

package/src/components/SelectFrequency.js

@@ -3,6 +3,7 @@ import { productChangeFrequency } from '../core/actions';
 import { withChildOptions } from '../core/resolveProperties';
 import { FrequencyStatus, mapStateToProps, frequencyText } from './FrequencyStatus';
 import { connect } from '../core/connect';
+import { frequencyToSellingPlan } from '../core/utils';
 
 export const frequencyEquals = (a, b) => {
   if (a === null || b === null) return false;
@@ -62,12 +63,10 @@ export class SelectFrequency extends withChildOptions(FrequencyStatus) {
     } else {
       result = this._defaultFrequency;
     }
+
     // this runs for shopify selling plans translated to freq
-    if (this.frequencies?.length && result && this.config?.frequenciesEveryPeriod) {
-      const index = this.config.frequenciesEveryPeriod.findIndex(it => it === result);
-      if (index >= 0) {
-        return this.frequencies[index];
-      }
+    if (this.config?.frequencies?.length && result && this.config?.frequenciesEveryPeriod?.length) {
+      return frequencyToSellingPlan(result, this.config);
     }
 
     return result;

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

@@ -302,25 +302,25 @@ describe('previewMode', () => {
   });
 });
 
-describe('multi-currency', () => {
-  async function getOfferElement(config) {
-    const element = new Offer();
-    element.innerHTML = `
-      <p>Offer content</p>
-    `;
-    element.config = config;
-    await appendToBody(element);
-    return element;
-  }
-
-  function assertOfferShown(element) {
-    expect(element.querySelector('*').assignedSlot).not.toBeNull();
-  }
-
-  function assertOfferHidden(element) {
-    expect(element.querySelector('*').assignedSlot).toBeNull();
-  }
+async function getOfferElement(config) {
+  const element = new Offer();
+  element.innerHTML = `
+    <p>Offer content</p>
+  `;
+  element.config = config;
+  await appendToBody(element);
+  return element;
+}
+
+function assertOfferShown(element) {
+  expect(element.querySelector('*').assignedSlot).not.toBeNull();
+}
+
+function assertOfferHidden(element) {
+  expect(element.querySelector('*').assignedSlot).toBeNull();
+}
 
+describe('multi-currency', () => {
   it('should show the offer when config not set', async () => {
     const element = await getOfferElement();
     assertOfferShown(element);
@@ -369,3 +369,22 @@ describe('multi-currency', () => {
     assertOfferShown(element);
   });
 });
+
+describe('product specific frequencies', () => {
+  it('should hide the offer when on cart', async () => {
+    const element = await getOfferElement({
+      hasProductSpecificFrequencies: true
+    });
+    element.isCart = true;
+    await element.updateComplete;
+
+    assertOfferHidden(element);
+  });
+
+  it('should show the offer when not on cart', async () => {
+    const element = await getOfferElement({
+      hasProductSpecificFrequencies: true
+    });
+    assertOfferShown(element);
+  });
+});

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

@@ -15,12 +15,20 @@ describe('frequencyToSellingPlan', () => {
     expect(frequencyToSellingPlan('345', {})).toEqual('345');
   });
 
-  it('should return original frequency if no frequency match', () => {
+  it('should return first frequency if no frequency match', () => {
     expect(
       frequencyToSellingPlan('1_2', {
         frequenciesEveryPeriod: ['1_1', '1_3'],
         frequencies: [123, 789]
       })
+    ).toEqual(123);
+  });
+
+  it('should return original frequency if no frequency match and frequenciesEveryPeriod not defined', () => {
+    expect(
+      frequencyToSellingPlan('1_2', {
+        frequencies: [123, 789]
+      })
     ).toEqual('1_2');
   });
 });

package/src/core/utils.ts

@@ -70,6 +70,12 @@ export const frequencyToSellingPlan = (ogFrequency, config) => {
     return config.frequencies[ix];
   }
 
+  // if we can't find the OG frequency, but we have selling plans, return the first selling plan
+  if (config.frequencies?.length > 0 && config.frequenciesEveryPeriod?.length > 0) {
+    console.warn(`Unable to find selling plan match for frequency ${ogFrequency}; falling back to first selling plan`);
+    return config.frequencies[0];
+  }
+
   return ogFrequency;
 };
 

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

@@ -337,7 +337,42 @@ describe('config', () => {
     );
   });
 
+  const defaultSellingPlanPayload = {
+    product: {
+      selling_plan_groups: [
+        {
+          name: DEFAULT_PAY_AS_YOU_GO_GROUP_NAME,
+          selling_plans: [
+            {
+              id: 'yum selling plan id 1'
+            },
+            {
+              id: 'yum selling plan id 2'
+            }
+          ]
+        }
+      ]
+    }
+  };
+
   it('should return selling plan ids as frequencies given action SETUP_PRODUCT', () => {
+    const actual = config(
+      {},
+      {
+        type: constants.SETUP_PRODUCT,
+        payload: defaultSellingPlanPayload
+      }
+    );
+
+    expect(actual).toEqual(
+      jasmine.objectContaining({
+        frequencies: ['yum selling plan id 1', 'yum selling plan id 2'],
+        hasProductSpecificFrequencies: false
+      })
+    );
+  });
+
+  it('should return values of first OG selling plan group as frequencies text given action SETUP_PRODUCT', () => {
     const actual = config(
       {},
       {
@@ -346,13 +381,20 @@ describe('config', () => {
           product: {
             selling_plan_groups: [
               {
-                name: DEFAULT_PAY_AS_YOU_GO_GROUP_NAME,
+                name: 'Old Selling Plan Group',
+                options: [{ values: 'old yum values' }],
                 selling_plans: [
                   {
-                    id: 'yum selling plan id 1'
-                  },
+                    id: 'old yum selling plan id'
+                  }
+                ]
+              },
+              {
+                name: DEFAULT_PAY_AS_YOU_GO_GROUP_NAME,
+                options: [{ values: 'yum values' }],
+                selling_plans: [
                   {
-                    id: 'yum selling plan id 2'
+                    id: 'yum selling plan id'
                   }
                 ]
               }
@@ -364,12 +406,12 @@ describe('config', () => {
 
     expect(actual).toEqual(
       jasmine.objectContaining({
-        frequencies: ['yum selling plan id 1', 'yum selling plan id 2']
+        frequenciesText: 'yum values'
       })
     );
   });
 
-  it('should return values of first OG selling plan group as frequencies text given action SETUP_PRODUCT', () => {
+  it('should use product-specific frequency selling plan groups if present', () => {
     const actual = config(
       {},
       {
@@ -378,20 +420,40 @@ describe('config', () => {
           product: {
             selling_plan_groups: [
               {
-                name: 'Old Selling Plan Group',
-                options: [{ values: 'old yum values' }],
+                name: 'og_psfl_2m4m6m',
+                options: [
+                  {
+                    values: ['2 months', '4 months', '6 months']
+                  }
+                ],
                 selling_plans: [
                   {
-                    id: 'old yum selling plan id'
+                    id: 'psfl-id-1'
+                  },
+                  {
+                    id: 'psfl-id-2'
+                  },
+                  {
+                    id: 'psfl-id-3'
                   }
                 ]
               },
               {
-                name: DEFAULT_PAY_AS_YOU_GO_GROUP_NAME,
-                options: [{ values: 'yum values' }],
+                name: 'Subscribe and Save',
+                options: [
+                  {
+                    values: ['month', '2 months', '3 months']
+                  }
+                ],
                 selling_plans: [
                   {
-                    id: 'yum selling plan id'
+                    id: 'regular-id-1'
+                  },
+                  {
+                    id: 'regular-id-2'
+                  },
+                  {
+                    id: 'regular-id-3'
                   }
                 ]
               }
@@ -403,7 +465,26 @@ describe('config', () => {
 
     expect(actual).toEqual(
       jasmine.objectContaining({
-        frequenciesText: 'yum values'
+        frequencies: ['psfl-id-1', 'psfl-id-2', 'psfl-id-3'],
+        hasProductSpecificFrequencies: true
+      })
+    );
+  });
+
+  it('does not overwrite hasProductSpecificFrequencies on subsequent calls', () => {
+    const actual = config(
+      {
+        hasProductSpecificFrequencies: true
+      },
+      {
+        type: constants.SETUP_PRODUCT,
+        payload: defaultSellingPlanPayload
+      }
+    );
+
+    expect(actual).toEqual(
+      jasmine.objectContaining({
+        hasProductSpecificFrequencies: true
       })
     );
   });

package/src/shopify/shopifyReducer.js

@@ -33,6 +33,7 @@ import {
 } from '../core/utils';
 
 import { getObjectStructuredProductPlans } from '../core/adapters';
+
 import {
   sellingPlanAllocationsReducer,
   getSellingPlans,
@@ -126,12 +127,18 @@ export const reduceNewOptinsFromOfferResponse = (
   }, []);
 
 const getOGSellingPlanGroup = product => {
-  const sellingPlanGroup = product?.selling_plan_groups.find(group => {
-    return group.name === DEFAULT_PAY_AS_YOU_GO_GROUP_NAME;
-  });
-  return sellingPlanGroup;
+  const productSpecificFrequencySellingPlanGroup = product?.selling_plan_groups.find(
+    isProductSpecificFrequencySellingPlanGroup
+  );
+
+  return (
+    productSpecificFrequencySellingPlanGroup ||
+    product?.selling_plan_groups.find(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
@@ -280,7 +287,9 @@ export const config = (
         frequencies,
         frequenciesEveryPeriod,
         frequenciesText,
-        ...(defaultFrequency ? { defaultFrequency } : {})
+        ...(defaultFrequency ? { defaultFrequency } : {}),
+        hasProductSpecificFrequencies:
+          state.hasProductSpecificFrequencies || isProductSpecificFrequencySellingPlanGroup(sellingPlanGroup)
       };
     }