webc-miam 8.1.1 → 8.2.0

package/interfaces/miam-interface.ts

@@ -1,7 +1,8 @@
+import { EventEmitter } from '@angular/core';
 import { Observable } from 'rxjs';
 import { ComparableProduct } from './comparable-product';
 
-export interface MiamInterface  {
+export interface MiamInterface {
   /**
    * Method to call when the user begins the payment procedure (typically when they click
    * on a "Confirm my cart" button)
@@ -54,6 +55,10 @@ export interface MiamInterface  {
      * @returns A BehaviorSubject that emits the current number of recipes in Miam's Basket
      */
     recipeCount: () => Observable<number>;
+    /**
+     * Opens the preview by calling the `openBasket` method of the `recipesService`.
+     */
+    openPreview: () => void;
   };
 
   basketSync: {
@@ -83,7 +88,7 @@ export interface MiamInterface  {
      *
      * @param total The total price of the cart paid
      */
-     handlePayment: (total: number) => void;
+    handlePayment: (total: number) => void;
   };
 
   // ---------------------------------------------------------------------------------------------------
@@ -116,6 +121,10 @@ export interface MiamInterface  {
      * @param antiInflation if you want to use the anti inflation
      */
     enableMealsPlanner: (url: string, antiInflation?: boolean) => void;
+    /**
+     * Call to enable guests input on my-meals cards
+     */
+    enableGuestsInputOnMyMeals: () => void;
   };
 
   // ---------------------------------------------------------------------------------------------------
@@ -152,6 +161,10 @@ export interface MiamInterface  {
      * An observable that emits a value when the recipe-modal is closed
      */
     hidden: Observable<boolean>;
+    /**
+     * An EventEmitter that emits a value when the "Add all ingredients" CTA on recipe-details is clicked
+     */
+    addAllIngredientsCTAWasClicked: EventEmitter<{ ingredientsAdded: number; ingredientsTotal: number }>;
     /**
      * Call with an url of a picture to change the default picture displayed if an ingredient doesn't have a picture
      * and if ingredients picture have been enabled with recipes.shouldDisplayIngredientPicturesOnRecipeCards(true)
@@ -253,6 +266,12 @@ export interface MiamInterface  {
     setFavoriteItems: (favoriteProductIds: string[]) => Observable<object>;
   };
 
+  /**
+   * Call with the height in px of your website's header when it is sticky so Mealz can offset its sticky components
+   * If not called, any sticky components from Mealz may appear not stick correctly below your header
+   */
+  setStickyHeaderHeight: (height: number) => void;
+
   // ---------------------------------------------------------------------------------------------------
 
   /**
@@ -261,4 +280,10 @@ export interface MiamInterface  {
    * @param url of the new icon
    */
   overrideIcon: (icon, url: string) => void;
+
+  /**
+   * Pass a callback that returns the default scroll container of the page so mealz modal can block the scroll when opened
+   * Default callback returns document.body
+   */
+  setDefaultScrollElementGetter: (callback: () => HTMLElement) => void;
 }