webc-miam 8.7.0 → 9.0.0

package/3rdpartylicenses.txt

@@ -253,6 +253,9 @@ licenses; we recommend you read them, as their terms may differ from the
 terms above.
 
 
+mealz-shared-analytics
+GNU GPLv3
+
 miam-jsonapi
 
 regenerator-runtime

package/interfaces/comparable-product.ts

@@ -1,24 +1,24 @@
 /**
- * An interface used to represent a product when Miam synchronizes the client's cart with
- * Miam's basket, and need to compare products present in each one.
+ * An interface used to represent a product when Mealz synchronizes the client's cart with
+ * Mealz's basket, and need to compare products present in each one.
  */
 export interface ComparableProduct {
   /**
-   * Id of the product in the client's database (called ext-id on Miam's end).
+   * Id of the product in the client's database (called ext-id on Mealz's end).
    */
   id: string;
   /**
-   * When client side sends an array of ComparableProduct to Miam, the SDK expects quantities
+   * When client side sends an array of ComparableProduct to Mealz, the SDK expects quantities
    * to match the quantity of each product in the cart of the client.
    *
-   * When Miam sends an array of ComparableProducts to the client, quantities represent the quantity
+   * When Mealz sends an array of ComparableProducts to the client, quantities represent the quantity
    * of products to add to the client's cart, and as such can be negatives if products need to be
    * removed from the cart.
    */
   quantity: number;
   /**
    * The client can add attributes if they need when sending ComparableProducts to the SDK.
-   * Miam will send the attributes back if changes are to be made about those products.
+   * Mealz will send the attributes back if changes are to be made about those products.
    */
   additionalInfos?: any;
 }

package/interfaces/{miam-interface.ts → mealz-interface.ts}

@@ -1,10 +1,10 @@
 import { EventEmitter } from '@angular/core';
-import { Observable } from 'rxjs';
-import { ComparableProduct } from './comparable-product';
 import { DocumentCollection } from 'miam-jsonapi';
+import { Observable } from 'rxjs';
 import { PointOfSale, Supplier } from '../../_models';
+import { ComparableProduct } from './comparable-product';
 
-export interface MiamInterface {
+export interface MealzInterface {
   /**
    * Method to call when the user begins the payment procedure (typically when they click
    * on a "Confirm my cart" button)
@@ -19,9 +19,8 @@ export interface MiamInterface {
      * Initialize Analytics
      *
      * @param domain Plausible domain
-     * @param optimizeKey Google Optimize key
      */
-    init: (domain: string, _optimizeKey: string) => void;
+    init: (domain: string) => void;
 
     /**
      * Observable on events as a string sent from Analytics
@@ -38,28 +37,28 @@ export interface MiamInterface {
 
   basket: {
     /**
-     * Emits true when Miam's basket has succesfully loaded for the first time.
+     * Emits true when Mealz's basket has succesfully loaded for the first time.
      * Does not emit anything before or after that.
      */
     basketIsReady$: Observable<boolean>;
     /**
-     * Fetch the first Basket early (before any action requires it on Miam's
+     * Fetch the first Basket early (before any action requires it on Mealz's
      * side), so you can start the basket-sync earlier
      */
     initialize: () => void;
     /**
-     * Resets Miam's basket : empties all products & recipes added by the user
+     * Resets Mealz's basket : empties all products & recipes added by the user
      * /!\ We heavily recommend not to use this method except in the console for testing purposes /!\
      */
     reset: () => 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
+     * method to make Mealz 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) => Observable<void>;
     /**
-     * @returns A BehaviorSubject that emits the current number of recipes in Miam's Basket
+     * @returns A BehaviorSubject that emits the current number of recipes in Mealz's Basket
      */
     recipeCount: () => Observable<number>;
     /**
@@ -77,28 +76,28 @@ export interface MiamInterface {
 
   basketSync: {
     /**
-     * The callback parameter is called when Miam's basket changes to update the user's cart accordingly
+     * The callback parameter is called when Mealz'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
+     * @param pushProductsToCart 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
      */
-    definePushProductsToBasket: (pushProductsToBasket: (products: ComparableProduct[]) => void) => void;
+    definePushProductsToCart: (pushProductsToCart: (products: ComparableProduct[]) => void) => void;
     /**
-     * The callback parameter is called when Miam's basket changes to update the user's cart accordingly
+     * The callback parameter is called when Mealz'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
+     * @param pushProductsToCart 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;
+    definePushBasketEntriesToBasket: (pushProductsToCart: (products: ComparableProduct[]) => void) => void;
     /**
-     * Call to notify Miam that the user's cart has been updated
+     * Call to notify Mealz that the user's cart has been updated
      *
      * @param comparableProducts The products in the user's cart
      */
     retailerBasketChanged: (comparableProducts: ComparableProduct[]) => void;
     /**
-     * Call to notify Miam that the user's cart was paid
-     * Miam then refreshes the basket for the next user's cart
+     * Call to notify Mealz that the user's cart was paid
+     * Mealz then refreshes the basket for the next user's cart
      *
      * @param total The total price of the cart paid
      */
@@ -117,7 +116,7 @@ export interface MiamInterface {
      */
     enableArticlesInCatalog: () => void;
     /**
-     * Call to authorize Miam to ask for user preferences the first time users view the recipe catalog
+     * Call to authorize Mealz to ask for user preferences the first time users view the recipe catalog
      */
     enableUserPreferences: () => void;
     /**
@@ -155,17 +154,17 @@ export interface MiamInterface {
 
   hook: {
     /**
-     * Set up a callback which Miam will call before adding a recipe to the user's cart
+     * Set up a callback which Mealz will call before adding a recipe to the user's cart
      *
      * @param callback a method that will be called passing two parameters :
-     *  - isLogged, true if the user is logged (according to Miam, see user.loadWithExtId for more)
-     *  - isPosValid true if the PointOfSale is recognized by Miam
+     *  - isLogged, true if the user is logged (according to Mealz, see user.loadWithExtId for more)
+     *  - isPosValid true if the PointOfSale is recognized by Mealz
      * Typically you might want to use this to show your connexion page if the user tries to add a recipe while logged out
      * or to show your point of sale picker if the user has not chosen one
      */
     setHookCallback: (callback: (isLogged, isPosValid) => boolean) => void;
     /**
-     * Set up a callback which Miam will call when it needs to force the POS
+     * Set up a callback which Mealz will call when it needs to force the POS
      * (only used when tranfering a basket from an affiliated website)
      *
      * @param callback a method that will be called passing :
@@ -178,7 +177,7 @@ export interface MiamInterface {
 
   pos: {
     /**
-     * Call to inform Miam of the point of sale the user is currently on. Do not forget to call the method
+     * Call to inform Mealz 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 externalId the id of the PointOfSale in client's database
@@ -247,19 +246,19 @@ export interface MiamInterface {
 
   router: {
     /**
-     * Inform Miam of the url where the catalog is for the redirection link of recipe-details
+     * Inform Mealz of the url where the catalog is for the redirection link of recipe-details
      */
     setRecipeCatalogUrl: (url?: string) => void;
     /**
-     * Inform Miam of the url where the onboarding section of the catalog should redirect
+     * Inform Mealz of the url where the onboarding section of the catalog should redirect
      */
     setRecipeInfoLink: (url?: string) => void;
     /**
-     * Inform Miam of the url of the retailer's if Miam needs to redirect there
+     * Inform Mealz of the url of the retailer's if Mealz needs to redirect there
      */
     setRetailerCartUrl: (url?: string) => void;
     /**
-     * Inform Miam of the url where the promotions are
+     * Inform Mealz of the url where the promotions are
      */
     setPromotionsUrl: (url?: string) => void;
   };
@@ -269,15 +268,15 @@ export interface MiamInterface {
   supplier: {
     /**
      * /!\ This needs to be the first method called, because nothing will work if the origin isn't set
-     * @param origin an identifier string that Miam passes to the API with each request to keep track of the origin
+     * @param origin an identifier string that Mealz passes to the API with each request to keep track of the origin
      * of the request
      */
     setOrigin: (origin: string) => void;
     /**
-     * Call to inform Miam of the supplier the user is currently on. Do not forget to call the method
+     * Call to inform Mealz of the supplier the user is currently on. Do not forget to call the method
      * if it changes after user loads the page (should not happen escept in very specific cases)
      *
-     * @param supplierId the Supplier id in Miam's database
+     * @param supplierId the Supplier id in Mealz's database
      */
     load: (supplierId: number | string) => void;
     /**
@@ -293,7 +292,7 @@ export interface MiamInterface {
 
   user: {
     /**
-     * Call to inform Miam of the id of the user.
+     * Call to inform Mealz of the id of the user.
      *
      * @param id a string unique identifier to the user
      * @param forbidProfiling if set to true, desactivate personalized content (personalized recipes & products)
@@ -302,9 +301,16 @@ export interface MiamInterface {
      */
     loadWithExternalId: (id: string, forbidProfiling?: boolean, initBasket?: boolean) => Observable<object>;
     /**
-     * Call to inform Miam that the user has logged out
+     * Call to inform Mealz that the user has logged out
      */
     reset: () => void;
+
+    /**
+     * Set user language with a ISO 639-1 code or custom language name
+     * @param lang
+     */
+    setLanguage: (lang: string) => void;
+
     /**
      * If your website has a "favorite products" feature, you can pass the ids of all products
      * which the user has marked as favorites, so they can be prioritized when adding a recipe

package/interfaces/mealz-internal-interface.ts

@@ -0,0 +1,105 @@
+import { Observable } from 'rxjs';
+import { BasketEntry, Recipe } from '../../_models';
+import { RecipePricing } from '../../_models/recipe-pricing';
+
+export interface MealzInternalInterface {
+
+  // ---------------------------------------------------------------------------------------------------
+
+  basket: {
+
+    /**
+     * Emits the list of recipe IDs when recipes are added to the basket.
+     */
+    recipesAddedToBasket$: () => Observable<string[]>;
+
+    /**
+     * Emits the pricing information for recipes in the basket.
+     */
+    recipePricesInBasket$: () => Observable<{ id: string; price: string }[]>;
+
+    /**
+     * Emits the list of recipes in the basket.
+     */
+    waitForBasketEntries: () => Observable<BasketEntry[]>;
+  };
+
+  // ---------------------------------------------------------------------------------------------------
+
+  catalog: {
+    /**
+     * Opens filter modal
+     */
+    openFilters: () => void;
+
+    /**
+     * Opens preferences modal
+     */
+    openPreferences: () => void;
+
+    loadMoreRecipes: (packageId: string, page: number, pageSize: number, guests: number) => Observable<Recipe[]>;
+  };
+
+  // ---------------------------------------------------------------------------------------------------
+
+  recipes: {
+    /**
+     * Opens the recipe details by calling the `openRecipeDetails` method of the `recipesService`.
+     */
+    openDetails: (recipeId: string, guests: number) => void;
+
+    /**
+     * Updates or creates a recipe like entry.
+     * If `recipeLikeId` is provided, it updates the existing like; otherwise, it creates a new one.
+     * It also sets the `isPast` status and tracks the update event.
+     */
+    updateRecipeLike: (recipeLikeId: string, recipeId: string, isPast: boolean, recipe: any) => void;
+
+    /**
+     * Emits an observable that notifies subscribers when a recipe like has been updated.
+     */
+    recipeLikeUpdated: () => Observable<{ id: string; isPast: boolean }>;
+
+    /**
+     * Emits an observable that notifies subscribers when the number of guests of a recipe has been updated from recipe details.
+     */
+    guestsUpdated: () => Observable<{ guests: number; recipeId: string }>;
+
+    /**
+     * Emits an observable that notifies subscribers when a recipe price has been updated.
+     */
+    recipePriceUpdated: () => Observable<{ remaining: number; inBasket: number; recipeId: string }>;
+
+    /**
+     * Fetches the pricing information for a specific recipe based on the provided parameters.
+     */
+    fetchPricing: (recipeId: string, posId: string, pricebookKey: string, serves: number) => Observable<RecipePricing>;
+  };
+
+  // ---------------------------------------------------------------------------------------------------
+
+  supplier: {
+
+    /**
+     * Retrieves the token from the suppliers service
+     */
+    getToken: () => string;
+  };
+
+  // ---------------------------------------------------------------------------------------------------
+
+  user: {
+
+    /**
+     * Retrieve user language as an ISO 639-1 code or custom code
+     */
+    getLanguage: () => string;
+
+    /**
+     * Retrieves the current authentication status of the user.
+     */
+    isAuthenticated: () => Observable<boolean>;
+  };
+
+  getStickyHeaderHeight: () => Observable<number>;
+}