@mappedin/mappedin-js 5.46.0 → 5.48.0

package/lib/esm/renderer/index.d.ts

@@ -108,7 +108,7 @@ declare module '@mappedin/mappedin-js' {
     export { TILE_RENDER_MODES } from '@mappedin/mappedin-js/renderer/internal/outdoor-context/Mappedin.TileManager';
     export { AzureOutdoorContextProvider, OpenStreetMapOutdoorContext, } from '@mappedin/mappedin-js/renderer/internal/outdoor-context/Outdoor-Context.provider';
     export type { IOutdoorContextProvider } from '@mappedin/mappedin-js/renderer/internal/outdoor-context/Outdoor-Context.provider';
-    export { setMaplibreWorkerURL } from '@mappedin/mappedin-js/renderer/internal';
+    export { setMaplibreWorkerURL, findPreferredLanguage } from '@mappedin/mappedin-js/renderer/internal';
 }
 
 declare module '@mappedin/mappedin-js/renderer/public/MapView' {
@@ -794,7 +794,7 @@ declare module '@mappedin/mappedin-js/get-venue' {
         */
     export function setFetchFn(fetchFn: any): void;
     /** Classes */
-    export { MappedinCollectionType, MappedinNavigatable, MappedinNode, MappedinLocation, MappedinPolygon, MappedinCategory, MappedinDirections, MappedinDestinationSet, MappedinVortex, MappedinVenue, MappedinRankings, MappedinEvent, MappedinLocationState, MappedinMap, MappedinCoordinate, MappedinMapGroup, Mappedin, } from '@mappedin/mappedin-js/get-venue/internal';
+    export { MappedinCollectionType, MappedinNavigatable, MappedinNode, MappedinLocation, MappedinPolygon, MappedinCategory, MappedinDirections, MappedinDestinationSet, MappedinVortex, MappedinVenue, MappedinRankings, MappedinEvent, MappedinLocationState, MappedinMap, MappedinCoordinate, MappedinMapGroup, findPreferredLanguage, Mappedin, } from '@mappedin/mappedin-js/get-venue/internal';
     /**
         * @internal
         * @hidden
@@ -1384,7 +1384,7 @@ declare module '@mappedin/mappedin-js/renderer/MapView.types' {
             overviewPathOptions?: TPathOptions;
             overviewPathOnConnectionsOptions?: TPathOptions;
             showOverviewPathOnMap?: MappedinMap;
-            overviewPathMode?: 'always' | 'current-elevation-and-mapgroup';
+            overviewPathMode?: 'always' | 'current-elevation-and-mapgroup' | 'current-elevation';
             overviewInactivePathSizeFactor?: number;
             overviewPathInactiveColor?: string;
     };
@@ -3910,7 +3910,7 @@ declare module '@mappedin/mappedin-js/renderer/internal' {
     import { TMapClickEvent } from '@mappedin/mappedin-js/renderer/MapView.types';
     import { MappedinMap } from '@mappedin/mappedin-js/get-venue';
     import { Vector3 } from '@mappedin/mvf';
-    export { MappedinMap, Mappedin, MappedinCoordinate, MappedinPolygon, MappedinNode, MappedinLocation, MappedinVenue, } from '@mappedin/mappedin-js/get-venue';
+    export { MappedinMap, Mappedin, MappedinCoordinate, MappedinPolygon, MappedinNode, MappedinLocation, MappedinVenue, findPreferredLanguage, } from '@mappedin/mappedin-js/get-venue';
     export type { TEnableBlueDotOptions, TFloatingLabelAppearance, TGeolocationObject, TPathOptions, TConnectionProps, TConnectionTemplateFn, TMarkerTemplateProps, TMarkerTemplateFn, TJourneyOptions, TPadding, TCreateMarkerOptions, TAnimationOptions, TCreateTooltipInternalOptions, TCreateTooltipCommonOptions, TCreateTooltipOptions, TCreateTextTooltipOptions, TCreateCustomInnerHTMLTooltipOptions, TCreateCustomTooltipOptions, TCreateThreeDMarkerOptions, TGetPolygonsAtCoordinateOptions, TMapViewOptions, TMapViewOptionsLegacy, TFlatLabelOptions, TFlatLabelAppearance, TFloatingLabelPolygonOptions, TAddFlatLabelOptions, TAddFloatingLabelOptions, TLabelAllLocationCommonOptions, TLabelAllLocationFloatingLabelOptions, TLabelAllLocationFlatLabelOptions, TFloatingLabelAllLocationsOptions, TFlatLabelAllLocationsOptions, changeListenerFn, TMapClickEvent, E_SDK_EVENT_PAYLOAD, E_BLUEDOT_EVENT_PAYLOAD, CAMERA_EVENT_PAYLOAD, } from '@mappedin/mappedin-js/renderer/MapView.types';
     export { labelThemes } from '@mappedin/mappedin-js/renderer/MapView.types';
     export { GEOLOCATION_STATUS, COLLISION_RANKING_TIERS, E_BLUEDOT_STATE_REASON, E_BLUEDOT_STATE, E_BLUEDOT_MARKER_STATE, STATE, MARKER_ANCHOR, E_SDK_EVENT, E_BLUEDOT_EVENT, E_CAMERA_EVENT, E_CAMERA_DIRECTION, SAFE_AREA_INSET_TYPE, CAMERA_EASING_MODE, ANIMATION_TWEENS, STACKED_MAPS_STATE, } from '@mappedin/mappedin-js/renderer/MapView.enums';
@@ -4952,6 +4952,11 @@ declare module '@mappedin/mappedin-js/get-venue/Mappedin.types' {
             noAuth?: boolean;
             perspective?: string;
             language?: string;
+            /**
+                * Fallback to navigator language if the language is not available
+                * @default true
+                */
+            fallbackToNavigatorLanguages?: boolean;
             headers?: {
                     [key in string]: string;
             };
@@ -5018,18 +5023,18 @@ declare module '@mappedin/mappedin-js/get-venue/Mappedin.types' {
 declare module '@mappedin/mappedin-js/get-venue/Mappedin' {
     import { Navigator } from '@mappedin/mappedin-js/navigator';
     import type { TAllGetVenueOptions, TGetVenueOptions, TGetVenueOptionsInternal } from '@mappedin/mappedin-js/get-venue/Mappedin.types';
-    import type { MappedinNode, MappedinPolygon, MappedinLocation, MappedinCategory, MappedinVortex, MappedinVenue, MappedinTheme, MappedinRankings, MappedinLocationRankings, MappedinEvent, MappedinLocationState, MappedinMap, MappedinMapGroup, GET_VENUE_PAYLOAD } from '@mappedin/mappedin-js/get-venue/internal';
-    import { TAccessors, GET_VENUE_EVENT } from '@mappedin/mappedin-js/get-venue/internal';
-    import { IAnalytics } from '@mappedin/mappedin-js/get-venue/Mappedin.CustomerAnalytics';
-    import { ParsedMVF } from '@mappedin/mvf';
-    import { ParsedMVFv1 } from '@mappedin/mappedin-js/get-venue/Mappedin.MVF.types';
+    import type { MappedinNode, MappedinPolygon, MappedinLocation, MappedinCategory, MappedinVortex, MappedinVenue, MappedinTheme, MappedinRankings, MappedinLocationRankings, MappedinEvent, MappedinLocationState, MappedinMap, MappedinMapGroup, GET_VENUE_PAYLOAD, TAccessors } from '@mappedin/mappedin-js/get-venue/internal';
+    import { GET_VENUE_EVENT } from '@mappedin/mappedin-js/get-venue/internal';
+    import type { IAnalytics } from '@mappedin/mappedin-js/get-venue/Mappedin.CustomerAnalytics';
+    import type { ParsedMVF } from '@mappedin/mvf';
+    import type { ParsedMVFv1 } from '@mappedin/mappedin-js/get-venue/Mappedin.MVF.types';
     import { PubSub } from '@mappedin/mappedin-js/get-venue/pub-sub.typed';
     export const defaultOptions: TGetVenueOptionsInternal<TGetVenueOptions>;
     export class Mappedin extends PubSub<GET_VENUE_PAYLOAD, GET_VENUE_EVENT> {
             #private;
             perspective: any;
             things: any;
-            options: any;
+            options: TGetVenueOptionsInternal<TAllGetVenueOptions> & Pick<TGetVenueOptions, 'language' | 'fallbackToNavigatorLanguages'>;
             updatedAt?: string;
             categories: MappedinCategory[];
             locations: MappedinLocation[];
@@ -5271,6 +5276,25 @@ declare module '@mappedin/mappedin-js/get-venue/Mappedin' {
                 */
             toString: (includeOptions?: boolean) => string;
     }
+    /**
+        * Finds the ideal language for the venue based on the following priority:
+        * 1. User specified language (if it exists in venue languages)
+        * 2. Browser navigator languages (if fallback is enabled)
+        * 3. Venue's default language
+        *
+        * @param venue - The MappedinVenue object containing available languages
+        * @param options - Configuration options
+        * @param options.language - Preferred language code to use
+        * @param options.fallbackToNavigatorLanguages - Whether to use browser's language settings as fallback (defaults to true)
+        * @returns An object containing the selected language code and name, or undefined if no language is found
+        */
+    export function findPreferredLanguage(venue: MappedinVenue, options: {
+            language?: string;
+            fallbackToNavigatorLanguages?: boolean;
+    }): {
+            code: string;
+            name: string;
+    } | undefined;
 }
 
 declare module '@mappedin/mappedin-js/get-venue/default-things' {
@@ -5355,7 +5379,7 @@ declare module '@mappedin/mappedin-js/get-venue/internal' {
             code: string;
         };
     };
-    export { Mappedin } from '@mappedin/mappedin-js/get-venue/Mappedin';
+    export { Mappedin, findPreferredLanguage } from '@mappedin/mappedin-js/get-venue/Mappedin';
 }
 
 declare module '@mappedin/mappedin-js/get-venue/Mappedin.CustomerAnalytics' {
@@ -5955,11 +5979,7 @@ declare module '@mappedin/mappedin-js/get-venue/Mappedin.OfflineSearch' {
             /**
                 * Search for a term
                 */
-            search(
-            /**
-                * Search term
-                */
-            term: string): Promise<TMappedinOfflineSearchResult[]>;
+            search(term: string): Promise<TMappedinOfflineSearchResult[]>;
             /**
                 * Export search index to JSON for storage/caching - this would avoid having to re-index
                 * on page reload
@@ -9358,8 +9378,8 @@ declare module '@mappedin/mappedin-js/renderer/private/controllers/JourneyContro
         constructor(directions: MappedinDirections | MappedinDirections[], options: TJourneyOptions | undefined, core: Core);
         setStep: (step: any) => void;
         setStepByPath: (path: Path) => void;
-        overviewPathMode: 'never' | 'always' | 'current-elevation-and-mapgroup';
-        setOverviewPathMode(mode: 'never' | 'always' | 'current-elevation-and-mapgroup'): void;
+        overviewPathMode: 'never' | 'always' | 'current-elevation-and-mapgroup' | 'current-elevation';
+        setOverviewPathMode(mode: 'never' | 'always' | 'current-elevation-and-mapgroup' | 'current-elevation'): void;
         static instance: JourneyController | null;
         static create(directions: MappedinDirections | MappedinDirections[], options: any, core: Core): JourneyController;
         destroy(): void;
@@ -10680,9 +10700,9 @@ declare module '@mappedin/mappedin-js/get-venue/MappedinNavigatable' {
 }
 
 declare module '@mappedin/mappedin-js/get-venue/MappedinNode' {
-    import type { MappedinPolygon, MappedinLocation, Mappedin } from '@mappedin/mappedin-js/get-venue/internal';
+    import type { MappedinPolygon, MappedinLocation, Mappedin, MappedinDirections, MappedinMap, TDirectionToOptions } from '@mappedin/mappedin-js/get-venue/internal';
     import type { TOpeningHours } from '@mappedin/mappedin-js/get-venue/Mappedin.API.types';
-    import { MappedinNavigatable, MappedinDirections, MappedinDestinationSet, MappedinMap, TDirectionToOptions } from '@mappedin/mappedin-js/get-venue/internal';
+    import { MappedinNavigatable, MappedinDestinationSet } from '@mappedin/mappedin-js/get-venue/internal';
     /**
         * A {@link MappedinNode} represents a position, anchored to a specific {@link MappedinMap}.
         *
@@ -11459,27 +11479,51 @@ declare module '@mappedin/mappedin-js/get-venue/Mappedin.cache' {
         categories: {
             [id: string]: MappedinCategory;
         };
+        categoriesByExternalId: {
+            [externalId: string]: MappedinCategory;
+        };
         locations: {
             [id: string]: MappedinLocation;
         };
+        locationsByExternalId: {
+            [externalId: string]: MappedinLocation;
+        };
         vortexes: {
             [id: string]: MappedinVortex;
         };
+        vortexesByExternalId: {
+            [externalId: string]: MappedinVortex;
+        };
         maps: {
             [id: string]: MappedinMap;
         };
+        mapsByExternalId: {
+            [externalId: string]: MappedinMap;
+        };
         nodes: {
             [id: string]: MappedinNode;
         };
+        nodesByExternalId: {
+            [externalId: string]: MappedinNode;
+        };
         polygons: {
             [id: string]: MappedinPolygon;
         };
+        polygonsByExternalId: {
+            [externalId: string]: MappedinPolygon;
+        };
         events: {
             [id: string]: MappedinEvent;
         };
+        eventsByExternalId: {
+            [externalId: string]: MappedinEvent;
+        };
         mapGroups: {
             [id: string]: MappedinMapGroup;
         };
+        mapGroupsByExternalId: {
+            [externalId: string]: MappedinMapGroup;
+        };
         locationStates: {
             [id: string]: MappedinLocationState;
         };