@ordergroove/offers 2.34.8-alpha-PR-793-2.0 → 2.34.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ordergroove/offers",
-  "version": "2.34.8-alpha-PR-793-2.0+19172c88",
+  "version": "2.34.9",
   "description": "offer state component",
   "author": "Eugenio Lattanzio <eugenio63@gmail.com>",
   "homepage": "https://github.com/ordergroove/plush-toys#readme",
@@ -45,7 +45,8 @@
     "throttle-debounce": "^2.1.0"
   },
   "devDependencies": {
-    "@ordergroove/offers-templates": "^0.9.2"
+    "@ordergroove/offers-templates": "^0.9.2",
+    "@types/lodash.memoize": "^4.1.9"
   },
-  "gitHead": "19172c88b22e278a33838e2fe3fd6b946463fba2"
+  "gitHead": "a191165538ff5f2855d0a10a218eca99669602b5"
 }

package/src/shopify/reducers/productPlans.ts

@@ -119,13 +119,14 @@ export const mapSellingPlanToDiscount = (
   return productPlan;
 };
 
-export const sellingPlanAllocationsReducer = (acc, cur, sellingPlans = []) => [
-  ...acc,
-  mapSellingPlanToDiscount(cur, sellingPlans)
-];
+export const sellingPlanAllocationsReducer = (
+  acc: ProductPlanEntity[],
+  cur: ShopifySellingPlanAllocationsEntity,
+  sellingPlans: ShopifySellingPlansEntity[] = []
+) => [...acc, mapSellingPlanToDiscount(cur, sellingPlans)];
 
 export const getSellingPlans = (product: ShopifyProductEntity) =>
-  product.selling_plan_groups.reduce(
+  product.selling_plan_groups.reduce<ShopifySellingPlansEntity[]>(
     (allGroups, group) => [
       ...allGroups,
       ...group.selling_plans.map(selling_plan => ({ ...selling_plan, group_name: group.name }))

package/src/shopify/shopifyMiddleware.ts

@@ -17,12 +17,21 @@ import {
 import { makeSubscribedSelector } from '../core/selectors';
 import { getOrCreateHidden, safeProductId } from '../core/utils';
 import { getTrackingKey } from './shopifyTrackingMiddleware';
+import { ShopifyCart, ShopifyProductEntity } from './types/shopify';
 
 const SHOPIFY_ROOT = window.Shopify?.routes?.root || '/';
 const CART_PAGE_URL = '/cart';
 const CART_JS_URL = `${SHOPIFY_ROOT}cart.js`;
+const CART_CHANGE_URL = `${SHOPIFY_ROOT}cart/change.js`;
 const PRODUCTS_URL = `${SHOPIFY_ROOT}products/`;
 
+type SetupProductPayload = {
+  product: ShopifyProductEntity;
+  offer: any;
+};
+
+type SetupCartPayload = ShopifyCart;
+
 /**
  * List of section DOM elements to update via section-rendering api https://shopify.dev/api/section-rendering
  */
@@ -43,7 +52,8 @@ async function setupPdp(store, offer) {
   if (handle) {
     try {
       const product = await getProduct(handle);
-      store.dispatch({ type: SETUP_PRODUCT, payload: { product, offer } });
+      const payload: SetupProductPayload = { product, offer };
+      store.dispatch({ type: SETUP_PRODUCT, payload });
     } catch (err) {
       console.warn('OG: Unable to fetch product details for PDP', err);
     }
@@ -79,7 +89,9 @@ async function setupPdp(store, offer) {
   }
 }
 
-const getCart = async () => await (await fetch(CART_JS_URL)).json();
+async function getCart(): Promise<ShopifyCart> {
+  return (await fetch(CART_JS_URL)).json();
+}
 
 /**
  * Attemps to guess the product handle o
@@ -120,12 +132,15 @@ export function guessProductHandle(offer): string {
   );
 }
 
-const getProduct = memoize(async handle => (await fetch(`${PRODUCTS_URL}${handle}.js`)).json());
+const getProduct = memoize(async function(handle: string): Promise<ShopifyProductEntity> {
+  return (await fetch(`${PRODUCTS_URL}${handle}.js`)).json();
+});
 
 async function setupCart(store, offer) {
   const cart = await getCart();
   const { items } = cart;
-  store.dispatch({ type: SETUP_CART, payload: cart });
+  const cartPayload: SetupCartPayload = cart;
+  store.dispatch({ type: SETUP_CART, payload: cartPayload });
 
   // some minicart templates does not contains line.key but contains line which corresponds to
   // the index on the cart items (Vedge)
@@ -136,7 +151,10 @@ async function setupCart(store, offer) {
   }
 
   const products = await Promise.all(Array.from(new Set(items.map(({ handle }) => handle))).map(getProduct));
-  products.forEach(product => store.dispatch({ type: SETUP_PRODUCT, payload: { product, offer } }));
+  products.forEach(product => {
+    const payload: SetupProductPayload = { product, offer };
+    store.dispatch({ type: SETUP_PRODUCT, payload });
+  });
 }
 
 /**
@@ -168,7 +186,7 @@ export async function synchronizeCartOptin(action: any, store: any) {
     const qty = item.quantity;
     const productId = safeProductId(key);
 
-    const res = await fetch('/cart/change.js', {
+    const res = await fetch(CART_CHANGE_URL, {
       method: 'POST',
       credentials: 'same-origin',
       headers: { 'Content-Type': 'application/json' },
@@ -184,7 +202,7 @@ export async function synchronizeCartOptin(action: any, store: any) {
 
     if (res.status !== 200) throw new Error('Cart not updated');
 
-    const newCart = await res.json();
+    const newCart: ShopifyCart = await res.json();
 
     // If both carts have same length we can update the item.key
     // to the original offer element, at least provide
@@ -213,7 +231,8 @@ export async function synchronizeCartOptin(action: any, store: any) {
     }
 
     // dispatch SETUP_CART so offer does not flip the state
-    store.dispatch({ type: SETUP_CART, payload: newCart });
+    const newCartPayload: SetupCartPayload = newCart;
+    store.dispatch({ type: SETUP_CART, payload: newCartPayload });
 
     // Use a custom event to hook custom cart updates.
     const cartUpdateEvent = new CustomEvent(CART_UPDATED_EVENT, { bubbles: true, cancelable: true });

package/src/shopify/types/shopify.ts

@@ -96,3 +96,136 @@ export interface ShopifyProductEntity {
   requires_selling_plan: boolean;
   selling_plan_groups?: ShopifySellingPlanGroupsEntity[] | null;
 }
+
+export interface ShopifyCart {
+  token: string;
+  note: string;
+  attributes: Record<string, string>;
+  original_total_price: number;
+  total_price: number;
+  total_discount: number;
+  total_weight: number;
+  item_count: number;
+  items: CartItem[];
+  requires_shipping: boolean;
+  currency: string;
+  items_subtotal_price: number;
+  cart_level_discount_applications: CartLevelDiscountApplication[];
+  sections?: Record<string, string>;
+}
+
+interface CartItem {
+  id: number;
+  properties: Record<string, string>;
+  quantity: number;
+  variant_id: number;
+  key: string;
+  title: string;
+  price: number;
+  original_price: number;
+  discounted_price: number;
+  line_price: number;
+  original_line_price: number;
+  total_discount: number;
+  discounts: Discount[];
+  sku: string;
+  grams: number;
+  vendor: string;
+  taxable: boolean;
+  product_id: number;
+  product_has_only_default_variant: boolean;
+  gift_card: boolean;
+  final_price: number;
+  final_line_price: number;
+  url: string;
+  featured_image: FeaturedImage;
+  image: string;
+  handle: string;
+  requires_shipping: boolean;
+  product_type: string;
+  product_title: string;
+  product_description: string;
+  variant_title?: string;
+  variant_options: string[];
+  options_with_values: OptionsWithValue[];
+  line_level_discount_allocations: LineLevelDiscountAllocation[];
+  line_level_total_discount: number;
+  quantity_rule: QuantityRule;
+  has_components: boolean;
+  selling_plan_allocation?: SellingPlanAllocation;
+  unit_price?: number;
+  unit_price_measurement?: UnitPriceMeasurement;
+}
+
+interface Discount {
+  amount: number;
+  title: string;
+}
+
+interface FeaturedImage {
+  aspect_ratio: number;
+  alt: string;
+  height: number;
+  url: string;
+  width: number;
+}
+
+interface OptionsWithValue {
+  name: string;
+  value: string;
+}
+
+interface LineLevelDiscountAllocation {
+  amount: number;
+  discount_application: DiscountApplication;
+}
+
+interface DiscountApplication {
+  type: string;
+  key: string;
+  title: string;
+  description: string;
+  value: string;
+  created_at: string;
+  value_type: string;
+  allocation_method: string;
+  target_selection: string;
+  target_type: string;
+  total_allocated_amount: number;
+}
+
+interface QuantityRule {
+  min: number;
+  max?: number;
+  increment: number;
+}
+
+interface SellingPlanAllocation {
+  price_adjustments: ShopifyPriceAdjustmentsEntity[];
+  price: number;
+  compare_at_price: number;
+  per_delivery_price: number;
+  selling_plan: ShopifySellingPlansEntity;
+}
+
+interface UnitPriceMeasurement {
+  measured_type: string;
+  quantity_value: string;
+  quantity_unit: string;
+  reference_value: number;
+  reference_unit: string;
+}
+
+interface CartLevelDiscountApplication {
+  type: string;
+  key: string;
+  title: string;
+  description: string;
+  value: string;
+  created_at: string;
+  value_type: string;
+  allocation_method: string;
+  target_selection: string;
+  target_type: string;
+  total_allocated_amount: number;
+}