webc-miam 6.0.0 → 6.0.2

package/interfaces/miam-interface.ts

@@ -34,6 +34,12 @@ export interface MiamInterface  {
      * side), so you can start the basket-sync earlier
      */
     initialize: () => void;
+    /**
+     * If you have different price tables (or pricebooks) for the same point of sale, you can call this
+     * method to make Miam know on which pricebook you are using
+     * For example, prices can be different depending on if the user chose home delivery or drive-in
+     */
+    updatePricebook: (pricebookName: string) => void,
   };
 
   basketSync: {
@@ -44,6 +50,13 @@ export interface MiamInterface  {
      * products if their quantity is positive, and removing them if their quantity is negative
      */
     definePushProductsToBasket: (pushProductsToBasket: (products: ComparableProduct[]) => void) => void;
+    /**
+     * The callback parameter is called when Miam's basket changes to update the user's cart accordingly
+     *
+     * @param pushProductsToBasket a method that updates the user's cart with the pruducts passed in parameter, by adding
+     * products if their quantity is positive, and removing them if their quantity is negative
+     */
+    definePushBasketEntriesToBasket: (pushProductsToBasket: (products: ComparableProduct[]) => void) => void;
     /**
      * Call to notify Miam that the user's cart has been updated
      *
@@ -116,6 +129,10 @@ export interface MiamInterface  {
      * Returns an observable that will emit true if the recipe passed in parameter is in Miam's GroceriesList
      */
     hasRecipe: (recipeId: string) => Observable<boolean>;
+    /**
+     * @returns A BehaviorSubject that emits the current number of recipes in Miam's GroceriesList
+     */
+    recipeCount: Observable<number>;
   };
 
   // ---------------------------------------------------------------------------------------------------
@@ -125,9 +142,9 @@ export interface MiamInterface  {
      * Call to inform Miam of the point of sale the user is currently on. Do not forget to call the method
      * if it changes after user loads the page
      *
-     * @param extId the id of the PointOfSale in client's database
+     * @param externalId the id of the PointOfSale in client's database
      */
-    loadWithExtId: (extId) => void;
+    load: (externalId) => void;
   };
 
   // ---------------------------------------------------------------------------------------------------
@@ -162,6 +179,10 @@ export interface MiamInterface  {
     //  * /!\ DEPRECATED: DO NOT USE /!\
     //  */
     // setSuggestionsPrimaryButtonActions: (display: boolean, addToBasket: boolean) => void;
+    /**
+     * If called, adding a recipe to Miam's basket will display a confirmation toaster
+     */
+    showConfirmationToaster: () => void;
   };
 
   // ---------------------------------------------------------------------------------------------------