webc-miam 8.4.2 → 8.6.0

package/interfaces/miam-interface.ts

@@ -2,8 +2,7 @@ import { EventEmitter } from '@angular/core';
 import { Observable } from 'rxjs';
 import { ComparableProduct } from './comparable-product';
 import { DocumentCollection } from 'miam-jsonapi';
-import { PointOfSale } from '../../_models';
-import { Coordinates } from '../coordinates';
+import { PointOfSale, Supplier } from '../../_models';
 
 export interface MiamInterface {
   /**
@@ -124,10 +123,20 @@ export interface MiamInterface {
      * @param antiInflation if you want to use the anti inflation
      */
     enableMealsPlanner: (url: string, antiInflation?: boolean) => void;
+
+    /**
+     * Call to enable SEO (Title and meta tags on recipe display)
+     */
+    enableSeo: () => void
     /**
      * Call to enable guests input on my-meals cards
      */
     enableGuestsInputOnMyMeals: () => void;
+
+    /**
+     * Call to enable collapsing of unavailable products by default
+     */
+    collapseUnavailableProductsByDefault: () => void;
   };
 
   // ---------------------------------------------------------------------------------------------------
@@ -143,6 +152,13 @@ export interface MiamInterface {
      * 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
+     * (only used when tranfering a basket from an affiliated website)
+     *
+     * @param callback a method that will be called passing :
+     *  - posExtId, the id of the POS (in your database)
+     */
     setForcePosCallback: (callback: (posExtId: string) => boolean) => void;
   };
 
@@ -157,8 +173,14 @@ export interface MiamInterface {
      */
     load: (externalId) => void;
 
-    getByAddress: (address: string, radius: string) => Observable<DocumentCollection<PointOfSale>>
-    getByCoordinates: (longitude: number, latitude: number, radius: number) => Observable<DocumentCollection<PointOfSale>>
+    /**
+     * This is an internal method that will be moved elsewhere soon. Do not call
+     */
+    getByAddress: (address: string, radius: string, suppliers: string[]) => Observable<DocumentCollection<PointOfSale>>;
+    /**
+     * This is an internal method that will be moved elsewhere soon. Do not call
+     */
+    getByCoordinates: (longitude: number, latitude: number, radius: number, suppliers: string[]) => Observable<DocumentCollection<PointOfSale>>;
   };
 
   // ---------------------------------------------------------------------------------------------------
@@ -251,6 +273,8 @@ export interface MiamInterface {
      * @param token a single token containing the information for supplierId, origin & plausible domain
      */
     setupWithToken: (token: string) => void;
+
+    getAffiliateSuppliers: () => Observable<Supplier[]>;
   };
 
   // ---------------------------------------------------------------------------------------------------
@@ -282,7 +306,7 @@ export interface MiamInterface {
      * User location can be set from the user's browser if they allowed it
      * @param coords must provide latitude (number) and longitude (number) and optionally an accuracy (number)
      */
-    setLocation: (coords: Coordinates) => void;
+    setLocation: (coords: GeolocationPosition) => void;
   };
 
   // ---------------------------------------------------------------------------------------------------