@mappedin/mappedin-js 5.46.0 → 5.48.0

package/lib/esm/get-venue/index.d.ts

@@ -30,7 +30,7 @@ declare module '@mappedin/mappedin-js/lib/esm/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/lib/esm/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/lib/esm/get-venue/internal';
     /**
         * @internal
         * @hidden
@@ -226,6 +226,11 @@ declare module '@mappedin/mappedin-js/lib/esm/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;
             };
@@ -292,18 +297,18 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin.types' {
 declare module '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin' {
     import { Navigator } from '@mappedin/mappedin-js/lib/esm/get-venue/--/navigator';
     import type { TAllGetVenueOptions, TGetVenueOptions, TGetVenueOptionsInternal } from '@mappedin/mappedin-js/lib/esm/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/lib/esm/get-venue/internal';
-    import { TAccessors, GET_VENUE_EVENT } from '@mappedin/mappedin-js/lib/esm/get-venue/internal';
-    import { IAnalytics } from '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin.CustomerAnalytics';
-    import { ParsedMVF } from '@mappedin/mvf';
-    import { ParsedMVFv1 } from '@mappedin/mappedin-js/lib/esm/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/lib/esm/get-venue/internal';
+    import { GET_VENUE_EVENT } from '@mappedin/mappedin-js/lib/esm/get-venue/internal';
+    import type { IAnalytics } from '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin.CustomerAnalytics';
+    import type { ParsedMVF } from '@mappedin/mvf';
+    import type { ParsedMVFv1 } from '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin.MVF.types';
     import { PubSub } from '@mappedin/mappedin-js/lib/esm/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[];
@@ -545,6 +550,25 @@ declare module '@mappedin/mappedin-js/lib/esm/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/lib/esm/get-venue/default-things' {
@@ -629,7 +653,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/internal' {
             code: string;
         };
     };
-    export { Mappedin } from '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin';
+    export { Mappedin, findPreferredLanguage } from '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin';
 }
 
 declare module '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin.CustomerAnalytics' {
@@ -1297,11 +1321,7 @@ declare module '@mappedin/mappedin-js/lib/esm/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
@@ -1566,7 +1586,7 @@ declare module '@mappedin/mappedin-js/lib/esm/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/lib/esm/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/lib/esm/get-venue/internal';
     /**
         * @internal
         * @hidden
@@ -2074,9 +2094,9 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/MappedinNavigatable' {
 }
 
 declare module '@mappedin/mappedin-js/lib/esm/get-venue/MappedinNode' {
-    import type { MappedinPolygon, MappedinLocation, Mappedin } from '@mappedin/mappedin-js/lib/esm/get-venue/internal';
+    import type { MappedinPolygon, MappedinLocation, Mappedin, MappedinDirections, MappedinMap, TDirectionToOptions } from '@mappedin/mappedin-js/lib/esm/get-venue/internal';
     import type { TOpeningHours } from '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin.API.types';
-    import { MappedinNavigatable, MappedinDirections, MappedinDestinationSet, MappedinMap, TDirectionToOptions } from '@mappedin/mappedin-js/lib/esm/get-venue/internal';
+    import { MappedinNavigatable, MappedinDestinationSet } from '@mappedin/mappedin-js/lib/esm/get-venue/internal';
     /**
         * A {@link MappedinNode} represents a position, anchored to a specific {@link MappedinMap}.
         *
@@ -2853,27 +2873,51 @@ declare module '@mappedin/mappedin-js/lib/esm/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;
         };