@davi-ai/retorik-map 3.0.2 → 4.0.1

package/dist/index.d.ts

@@ -1,144 +1,102 @@
-import { LatLngExpression } from "leaflet";
-export enum POIType {
-    restaurant = "restaurant",
-    afaire = "afaire",
-    avoir = "avoir",
-    hebergement = "hebergement",
-    produit = "produit",
-    service = "service"
-}
-/**
- * @param {string | undefined} iconUrl path to the icon that will appear on the button and the pin on the map
- * @param {string | undefined} label label on the button, use this if the same label is used in every language
- * @param {Record<string, string> | undefined} localizedLabel use this if there are different labels for different languages. Each tuple must be set as <locale>: <label> (for example: "fr-FR": "bonjour")
- */
-interface FilterData {
-    iconUrl?: string;
-    label?: string;
-    localizedLabel?: Record<string, string>;
-}
-/**
- * Used to create a new category to filter POI
- * @param {string} name category name, used in graphql / elasticsearch generic queries to get corresponding POI
- * @param {string | undefined} color color set on filter button and pin icons on the map
- * @param {FilterData} filter data used on the filter button and the pin icon on the map
- */
-interface CustomCategory {
-    name: string;
-    color?: string;
-    filter?: FilterData;
-}
-/**
- * Used to modify basic hospitality categories
- * @param {boolean} display false to prevent this category from being displayed
- * @param {string | undefined} label category's label, use this if the same label is used in every language
- * @param {Record<string, string> | undefined} localizedLabel this if there are different labels for different languages. Each tuple must be set as <locale>: <label> (for example: "fr-FR": "bonjour")
- * @param {string | undefined} color use this to change the color of the button and the pin on the map for this category
- */
-interface HospitalityCategory {
-    display: boolean;
-    label?: string;
-    localizedLabel?: Record<string, string>;
-    color?: string;
-}
-/**
- * Category settings
- * @param {Array<CustomCategory> | undefined} categories use this to display POI from categories outside of the hospitality field
- * @param hospitalityCategories use this to change the data (label / color) of the hospitality categories
- * @param {Array<HospitalityPOIType>} showFilter can't be used with hospitalityCategories. Use this to tell which basic hospitality categories you want to display
- */
-export interface MapSettings {
-    categories?: Array<CustomCategory>;
-    hospitalityCategories?: {
-        restaurant?: HospitalityCategory;
-        afaire?: HospitalityCategory;
-        avoir?: HospitalityCategory;
-        hebergement?: HospitalityCategory;
-        produit?: HospitalityCategory;
-        service?: HospitalityCategory;
-    };
-    showFilter?: Array<POIType>;
-}
-/**
- * @deprecated not used anymore since v2.0.1, see the settings field instead
- */
-export interface MapLabel {
-    title: string;
-    afaire: string;
-    restaurant: string;
-    hebergement: string;
-    avoir: string;
-    produit: string;
-    service: string;
-}
-export interface Tenant {
-    name: string;
-    retorikName: string;
-    areaLocation: Array<Array<LatLngExpression>>;
-    aroundMeDistance?: number;
-}
-export const MapIcon: () => JSX.Element;
-export const labels: {
-    'ar-EG': string;
-    'ar-SA': string;
-    'ca-ES': string;
-    'cs-CZ': string;
-    'da-DK': string;
-    'de-AT': string;
-    'de-CH': string;
-    'de-DE': string;
-    'en-CA': string;
-    'en-GB': string;
-    'en-HK': string;
-    'en-IE': string;
-    'en-IN': string;
-    'en-US': string;
-    'es-ES': string;
-    'es-MX': string;
-    'fi-FI': string;
-    'fr-BE': string;
-    'fr-CA': string;
-    'fr-CH': string;
-    'fr-FR': string;
-    'hi-IN': string;
-    'hu-HU': string;
-    'id-ID': string;
-    'it-IT': string;
-    'ja-JP': string;
-    'ko-KR': string;
-    'nb-NO': string;
-    'nl-BE': string;
-    'nl-NL': string;
-    'pl-PL': string;
-    'pt-BR': string;
-    'pt-PT': string;
-    'ru-RU': string;
-    'sv-SE': string;
-    'th-TH': string;
-    'tr-TR': string;
-    'zh-CN': string;
-    'zh-HK': string;
-    'zh-TW': string;
-};
-/**
- * Interactive map's props
- * @param {string | undefined} activeTenant the key of the active tenant defined in tenantList
- * @param {boolean | undefined} isDevTenant using a dev tenant ?
- * @param {Record<string, Tenant>} tenantList list of the tenants with their data that can be used in this instance of interactive map
- * @param {LatLngExpression | undefined} userLocation position of the user
- * @param {LatLngExpression | undefined} mapCenter position of the center of the map
- * @param {number | undefined} limitAroundCenter limit the map around the center, default 200km. Min zoom will be set depending on this number with 3 breakpoints : 0->199 / 200->599 / 599->?
- * @param {MapSettings | undefined} settings categogy settings
- */
-interface MapProps {
-    activeTenant?: string;
-    isDevTenant?: boolean;
-    tenantList: Record<string, Tenant>;
-    userLocation?: LatLngExpression;
-    mapCenter?: LatLngExpression;
-    limitAroundCenter?: number;
-    settings?: MapSettings;
-}
-export const Map: ({ activeTenant, isDevTenant, tenantList, userLocation, mapCenter, limitAroundCenter, settings }: MapProps) => JSX.Element;
-
-//# sourceMappingURL=index.d.ts.map
+/// <reference types="react" />
+
+import { LatLngExpression } from 'leaflet';
+
+/**
+ * Used to create a new category to filter POI
+ * @param {string} name category name, used in graphql / elasticsearch generic queries to get corresponding POI
+ * @param {string | undefined} color color set on filter button and pin icons on the map
+ * @param {FilterData} filter data used on the filter button and the pin icon on the map
+ */
+declare interface CustomCategory {
+    name: string;
+    color?: string;
+    filter?: FilterData;
+}
+
+/**
+ * @param {string | undefined} iconUrl path to the icon that will appear on the button and the pin on the map
+ * @param {string | undefined} label label on the button, use this if the same label is used in every language
+ * @param {Record<string, string> | undefined} localizedLabel use this if there are different labels for different languages. Each tuple must be set as <locale>: <label> (for example: "fr-FR": "bonjour")
+ */
+declare interface FilterData {
+    iconUrl?: string;
+    label?: string;
+    localizedLabel?: Record<string, string>;
+}
+
+/**
+ * Used to modify basic hospitality categories
+ * @param {boolean} display false to prevent this category from being displayed
+ * @param {string | undefined} label category's label, use this if the same label is used in every language
+ * @param {Record<string, string> | undefined} localizedLabel this if there are different labels for different languages. Each tuple must be set as <locale>: <label> (for example: "fr-FR": "bonjour")
+ * @param {string | undefined} color use this to change the color of the button and the pin on the map for this category
+ */
+declare interface HospitalityCategory {
+    display: boolean;
+    label?: string;
+    localizedLabel?: Record<string, string>;
+    color?: string;
+}
+
+declare const Map_2: ({ tenantAddress, userLocation, mapCenter, limitAroundCenter, settings, locale, isWidget, isUsedOnBorne, setModalFullscreenContent, sendMessage }: MapProps) => JSX.Element;
+export { Map_2 as Map }
+
+export declare const MapIcon: () => JSX.Element;
+
+/**
+ * Interactive map's props
+ * @param tenantAddress full address of the tenant on Retorik Studio (ex: https://studio.retorik.ai/asklea_lesbertranges)
+ * @param userLocation position of the user
+ * @param mapCenter position of the center of the map
+ * @param limitAroundCenter limit the map around the center, default 200km. Min zoom will be set depending on this number with 3 breakpoints : 0->199 / 200->599 / 599->?
+ * @param settings category settings
+ * @param locale current locale used
+ * @param isWidget using widget mode ?
+ * @param isUsedOnBorne used on a borne ? (no external link, QR-codes instead)
+ * @param detailedAttachmentOpened has the map been used to open a detailed attachment ?
+ * @param setModalFullscreenContent method to insert the loader inside a component
+ * @param sendMessage method used to send a message activity in directline
+ */
+declare interface MapProps {
+    tenantAddress: string;
+    userLocation?: LatLngExpression;
+    mapCenter?: LatLngExpression;
+    limitAroundCenter?: number;
+    settings?: MapSettings;
+    locale: string;
+    isWidget: boolean;
+    isUsedOnBorne: boolean;
+    setModalFullscreenContent: (value: JSX.Element | null) => void;
+    sendMessage: (text: string | undefined, value: Record<string, string>) => void;
+}
+
+/**
+ * Category settings
+ * @param {Array<CustomCategory> | undefined} categories use this to display POI from categories outside of the hospitality field
+ * @param hospitalityCategories use this to change the data (label / color) of the hospitality categories
+ * @param {Array<HospitalityPOIType>} showFilter can't be used with hospitalityCategories. Use this to tell which basic hospitality categories you want to display
+ */
+export declare interface MapSettings {
+    categories?: Array<CustomCategory>;
+    hospitalityCategories?: {
+        restaurant?: HospitalityCategory;
+        afaire?: HospitalityCategory;
+        avoir?: HospitalityCategory;
+        hebergement?: HospitalityCategory;
+        produit?: HospitalityCategory;
+        service?: HospitalityCategory;
+    };
+    showFilter?: Array<POIType>;
+}
+
+export declare enum POIType {
+    restaurant = "restaurant",
+    afaire = "afaire",
+    avoir = "avoir",
+    hebergement = "hebergement",
+    produit = "produit",
+    service = "service"
+}
+
+export { }