@mappedin/mappedin-js 4.0.14 → 4.0.17

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

@@ -1,10 +1,12 @@
 // Generated by dts-bundle v0.7.3
+// Dependencies for this module:
+//   ../geojson
 
 declare module '@mappedin/mappedin-js/lib/esm/get-venue' {
     import type { TGetVenueOptions } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.types';
     import { Mappedin } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin';
     /** Classes */
-    export { Mappedin } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin';
+    export { Mappedin, MappedinCollectionType } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin';
     export { MappedinLocation } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinLocation';
     export { MappedinPolygon } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinPolygon';
     export { MappedinNode } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinNode';
@@ -27,6 +29,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue' {
     /** API data types */
     export type { TLocationType, TNode, TImage, TLogo, TGalleryImage, TPhone, TSocial, TColor, TVortex, TPicture, TOpeningHours, TSiblingGroup, TState, TCategory, TEvent, TGeoReference, TMap, TMapGroup, TBuilding, TLocation, TPolygon, TPolygonRanking, TVenue, TMappedinAPI } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.API.types';
     export type { TGetVenueOptions } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.types';
+    import { MAP_RENDER_MODE } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.types';
     export type TShowVenueOptions = {
             /**
                 * Sets the initial background color of the map, including while loading.
@@ -38,14 +41,24 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue' {
                 */
             backgroundAlpha?: number;
             /**
-                * Whether or not to display labels initially
+                * Whether or not to display default styled Floating Labels initially
                 */
             labelAllLocationsOnInit?: boolean;
             /**
                 * The id of the first map to show on map load
                 */
             firstMapId?: string;
+            loadOptions?: {
+                    /**
+                        * Set the map render strategy in order to optimize FPS
+                        *
+                        * @beta
+                        */
+                    mapRenderStrategy?: MAP_RENDER_MODE;
+            };
     };
+    export { MAP_RENDER_MODE };
+    export function getVenueMVF(userOptions: TGetVenueOptions): Promise<Mappedin>;
     /**
         * Get Venue Data for a Mappedin Venue
         */
@@ -82,42 +95,70 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue' {
             url: any;
             updated_at: any;
     }): Promise<Mappedin>;
+    /**
+        * Get the bundle URL and updated_at time.
+        * @internal
+        */
+    export function getVenueMVFURL(userOptions: TGetVenueBundleOptions): Promise<{
+            url: string;
+            updated_at: string;
+    }>;
+    /**
+        * @internal
+        */
+    export function downloadVenueBundleMVF(options: TGetVenueOptions, 
+    /**
+        * use Web Workers to speed up MVF parsing. This is likely only benefitial for larger venues,
+        * and may be determental to smaller ones, hence it is off by default
+        */
+    useWorker?: boolean): Promise<unknown>;
 }
 
 declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.types' {
     export type TGetVenueOptions = {
-        accessToken?: string;
-        clientId?: string;
-        clientSecret?: string;
-        baseUrl?: string;
-        includeHidden?: boolean;
-        noAuth?: boolean;
-        perspective?: string;
-        language?: string;
-        headers?: {
-            [key in string]: string;
-        };
-        venue: string;
-        things?: any;
+            accessToken?: string;
+            clientId?: string;
+            clientSecret?: string;
+            baseUrl?: string;
+            includeHidden?: boolean;
+            noAuth?: boolean;
+            perspective?: string;
+            language?: string;
+            headers?: {
+                    [key in string]: string;
+            };
+            venue: string;
+            things?: any;
     };
     export type TGetVenueOptionsInternal = {
-        baseUrl?: string;
-        supplementaryUrl?: string;
-        noAuth?: boolean;
-        includeHidden?: boolean;
-        apiGateway?: string;
-        authorization?: string;
-        /**
-          * @deprecated 2D support will be removed in the future
-          */
-        do2D?: boolean;
-        things?: any;
-        headers?: any;
+            baseUrl?: string;
+            supplementaryUrl?: string;
+            noAuth?: boolean;
+            includeHidden?: boolean;
+            apiGateway?: string;
+            authorization?: string;
+            /**
+                * @deprecated 2D support will be removed in the future
+                */
+            do2D?: boolean;
+            things?: any;
+            headers?: any;
     };
+    export enum MAP_RENDER_MODE {
+            /** Each polygon, its geometry and mesh are sent to the GPU every render frame.
+                * This was the default rendering mode before 4.0.17
+                */
+            MULTI_GEOMETRY = "MULTI_GEOMETRY",
+            /** Polygons' geometries are grouped by material and merged together, resulting in far fewer
+                * draw calls to the GPU. Default rendering mode since 4.0.17
+                */
+            SINGLE_GEOMETRY = "SINGLE_GEOMETRY"
+    }
 }
 
 declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin' {
     import { Navigator } from '@mappedin/mappedin-js/lib/esm/get-venue/navigator';
+    import { MVFData } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.MVF.types';
     import type { TGetVenueOptions, TGetVenueOptionsInternal } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.types';
     import { MappedinCategory } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinCategory';
     import { MappedinEvent } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinEvent';
@@ -133,7 +174,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin' {
     import { MappedinVenue } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinVenue';
     import { MappedinVortex } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinVortex';
     export const defaultOptions: TGetVenueOptionsInternal & TGetVenueOptions;
-    export enum CollectionType {
+    export enum MappedinCollectionType {
             CATEGORY = "categories",
             EVENT = "events",
             LOCATION = "locations",
@@ -144,14 +185,14 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin' {
             VORTEX = "vortexes"
     }
     type TAccessors = {
-            [CollectionType.CATEGORY]: MappedinCategory;
-            [CollectionType.EVENT]: MappedinEvent;
-            [CollectionType.LOCATION]: MappedinLocation;
-            [CollectionType.MAPGROUP]: MappedinMapGroup;
-            [CollectionType.MAP]: MappedinMap;
-            [CollectionType.NODE]: MappedinNode;
-            [CollectionType.POLYGON]: MappedinPolygon;
-            [CollectionType.VORTEX]: MappedinVortex;
+            [MappedinCollectionType.CATEGORY]: MappedinCategory;
+            [MappedinCollectionType.EVENT]: MappedinEvent;
+            [MappedinCollectionType.LOCATION]: MappedinLocation;
+            [MappedinCollectionType.MAPGROUP]: MappedinMapGroup;
+            [MappedinCollectionType.MAP]: MappedinMap;
+            [MappedinCollectionType.NODE]: MappedinNode;
+            [MappedinCollectionType.POLYGON]: MappedinPolygon;
+            [MappedinCollectionType.VORTEX]: MappedinVortex;
     };
     const THINGS: {
             categories: typeof MappedinCategory;
@@ -347,6 +388,11 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin' {
                     [id: string]: MappedinRankings;
             };
             getCollectionItemById<T extends keyof TAccessors, I extends string>(name: T, id: I): TAccessors[T] | null;
+            /**
+                * @hidden
+                * @internal
+                */
+            hydrateFromMVF(mvfData: MVFData): Promise<undefined>;
             /**
                 *
                 * [experimental] Hydrate the Mappedin instance using a response from either {@link IMappedin.toString()}, {@link getVenueBundle} or by downloading the bundle manually
@@ -481,6 +527,59 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinPolygo
     export class MappedinPolygon extends MappedinNavigatable {
             #private;
             geometry: any;
+            image?: {
+                    visible: boolean;
+                    url: string | Blob;
+                    original: string | Blob;
+                    useLocalScaling: boolean;
+                    viewBox: {
+                            width: number;
+                            height: number;
+                    };
+                    scale: {
+                            x: number;
+                            y: number;
+                    };
+                    fitToBounds: boolean;
+                    position: {
+                            x: number;
+                            y: number;
+                            z: number;
+                    };
+                    rotation: {
+                            x: number;
+                            y: number;
+                            z: number;
+                    };
+            };
+            holes?: unknown[];
+            textures?: {
+                    image: any;
+                    name: 'front' | 'side';
+                    useFrontFaceImage?: boolean;
+            }[];
+            material: {
+                    color: string;
+                    opacity?: number;
+            };
+            label?: {
+                    visible: boolean;
+                    text: string;
+                    align: string;
+                    position: {
+                            x: number;
+                            y: number;
+                            z: number;
+                    };
+                    rotation: {
+                            x: number;
+                            y: number;
+                            z: number;
+                    };
+                    fontFamily: string;
+                    fontSize: number;
+                    color: string;
+            };
             /**
                 * Node ID.
                 *
@@ -667,6 +766,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinMap' {
     import type { TGeoReference } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.API.types';
     import type { MappedinMapGroup } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinMapGroup';
     import { MappedinCoordinate } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinCoordinate';
+    import { MappedinLocation } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue';
     /**
         * A {@link MappedinMap} belonging to a specific {@link MappedinVenue}. Typically represents a certain floor. Give this to a {@link MapView} to display to the user.
         *
@@ -693,6 +793,11 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinMap' {
             shortName: string;
             elevation: number;
             scale?: number;
+            layers: {
+                    visible: boolean;
+                    name: string;
+                    id: string;
+            }[];
             x_scale?: number;
             perspectiveId?: string;
             scene: any;
@@ -707,6 +812,11 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinMap' {
                 * @property polygons {[MappedinPolygon]}
                 */
             get polygons(): MappedinPolygon[] | undefined;
+            /**
+                * Locations on this map
+                */
+            get locations(): MappedinLocation[];
+            get nodes(): import("./MappedinNode").MappedinNode[];
             /**
                 * Map Group this map belongs to.
                 *
@@ -744,28 +854,56 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinEvent'
     import type { Mappedin } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin';
     import type { MappedinLocation } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinLocation';
     /**
-        * An event.
+        * An event such as a promotion attached to a location in a venue for a period of time. Events can be created in the Mappedin CMS.
         *
         * @class MappedinEvent
         */
     export class MappedinEvent {
             #private;
+            /**
+                * Unique id string of the event.
+                */
             id: string;
             type: string;
+            /**
+                * Event name
+                */
             name: string;
+            /**
+                * Optional, longer description of the event.
+                */
             description?: string | undefined;
+            /**
+                * Optional image to be used for displaying the event.
+                */
             image?: TImage | undefined;
+            /**
+                * Start timestamp of the event. Javascript date in milliseconds since 1 January 1970 UTC.
+                */
             startDate?: number | undefined;
+            /**
+                * Start timestamp of the event. Javascript date in milliseconds since 1 January 1970 UTC.
+                */
             endDate?: number | undefined;
+            /**
+                * Timestamp when the event should be displayed. Javascript date in milliseconds since 1 January 1970 UTC.
+                */
             showDate?: number | undefined;
+            /**
+                * @internal
+                */
             constructor(mappedin: Mappedin, data: any);
             /**
-                * Location this Event is occuring at.
-                *
-                * @property location {MappedinLocation}
+                * Location this event is occuring at.
                 */
             location(): MappedinLocation | undefined;
+            /**
+                * @internal
+                */
             static hydrate(events: any, mappedin: Mappedin): MappedinEvent[];
+            /**
+                * @internal
+                */
             static fetch(mappedin: Mappedin): Promise<MappedinEvent[]>;
             toJSON(): any;
     }
@@ -1181,9 +1319,6 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.API.t
     export type TMapGroup = {
         name: string;
         id: string;
-        maps: {
-            id: TMap['id'];
-        }[];
     };
     export type TBuilding = TLocation & {
         groupId: string;
@@ -1236,27 +1371,32 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.API.t
         entranceNodeId: string;
         score: number;
     };
-    export type TVenue = {
-        address: string;
-        city: string;
-        countrycode: string;
-        defaultMap: string;
-        externalId: string;
+    export type TLocationState = {
         id: string;
-        latitude: number;
-        logo: TLogo;
-        longitude: number;
-        metadata?: any;
         name: string;
-        operationHours: TOpeningHours[];
-        postal: string;
-        slug: string;
-        state: string;
-        telephone: string;
-        tzid: string;
-        tzidOverride: string;
-        utcOffset: string;
-        website: string;
+        value: string;
+    };
+    export type TVenue = {
+        address?: string;
+        city?: string;
+        countrycode?: string;
+        defaultMap?: string;
+        externalId?: string;
+        id?: string;
+        latitude?: number;
+        logo?: TLogo;
+        longitude?: number;
+        metadata?: any;
+        name?: string;
+        operationHours?: TOpeningHours[];
+        postal?: string;
+        slug?: string;
+        state?: string;
+        telephone?: string;
+        tzid?: string;
+        tzidOverride?: string;
+        utcOffset?: string;
+        website?: string;
     };
     export type TMappedinAPI = {
         nodes: TNode[];
@@ -1268,9 +1408,213 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.API.t
         themes: any;
         venue: TVenue;
         vortexes: TVortex[];
+        locationStates?: TLocationState[];
     };
 }
 
+declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.MVF.types' {
+    import { FeatureCollection, Polygon, Point, MultiPolygon } from 'geojson';
+    type ManifestFile = {
+        type: 'file';
+        name: string;
+    };
+    type ManifestFolder = {
+        type: 'folder';
+        name: string;
+        children: ManifestFile[];
+    };
+    type OpeningHours = {
+        opens: string;
+        closes: string;
+        dayOfWeek: string;
+        validFrom?: string;
+        validThrough?: string;
+    };
+    type Image = {
+        original?: string;
+        xlarge?: string;
+        xxlarge?: string;
+        medium?: string;
+        '140x140'?: string;
+        xsmall?: string;
+        xxsmall?: string;
+        '66x66'?: string;
+        small?: string;
+        large?: string;
+    };
+    type PolygonImage = string;
+    type Phone = {
+        number: string;
+        extension?: string;
+    };
+    type Link = {
+        label: string;
+        url: string;
+    };
+    type Social = {
+        facebook?: string;
+        twitter?: string;
+        instagram?: string;
+        website?: string;
+    };
+    type LocationState = {
+        type: string;
+        start?: string;
+        end?: string;
+    };
+    type ImageTransform = {
+        position: {
+            x: number;
+            y: number;
+            z: number;
+        };
+        rotation: number;
+        scale: {
+            x: number;
+            y: number;
+        };
+    };
+    type SiblingGroup = {
+        label: string;
+        siblings: string[];
+    };
+    export type MILocationProperties = {
+        id: string;
+        address?: string | null;
+        categories: string[];
+        description?: string | null;
+        email?: string | null;
+        externalId?: string | null;
+        hours?: OpeningHours[] | null;
+        links?: Link[] | null;
+        logo?: Image | null;
+        name: string;
+        phone?: Phone | null;
+        picture?: Image | null;
+        services?: string | null;
+        siblingGroups?: SiblingGroup[] | null;
+        social?: Social | null;
+        spaces?: TLocationSpaceReference[] | null;
+        states?: LocationState[] | null;
+        type: string;
+    };
+    export type MICategoryProperties = {
+        id: string;
+        name: string;
+        picture?: Image;
+    };
+    export type MIBuildingProperties = {
+        id: string;
+        name: string;
+        venue: string;
+    };
+    export type MILevelProperties = {
+        id: string;
+        abbreviation?: string;
+        building?: string;
+        elevation?: number;
+        name: string;
+    };
+    export type MIPolygonlikeProperties = {
+        id: string;
+        altitude?: string;
+        color?: string;
+        externalId?: string | null;
+        height?: string;
+        layer?: string;
+        level: string;
+        parent?: string | null;
+    };
+    type TPseudoNodeSpaceReference = {
+        node: string;
+        map: string;
+    };
+    export type TRealSpaceReference = {
+        id: string;
+        map: string;
+    };
+    type TLocationSpaceReference = TPseudoNodeSpaceReference | TRealSpaceReference;
+    export type TEntrances = {
+        id: string;
+        level: string;
+    };
+    export type MISpaceProperties = MIPolygonlikeProperties & {
+        entrances: TEntrances[];
+    };
+    export type MIObstructionProperties = MIPolygonlikeProperties;
+    export type MIConnectionProperties = {
+        id: string;
+        accessible: boolean;
+        destinations: string[];
+        level: string;
+        multiplier: number;
+        name: string;
+        type: string;
+        weight: number;
+    };
+    export type MINodeProperties = {
+        id: string;
+        accessible: boolean;
+        externalId: string | null;
+        level: string;
+        multiplier: number;
+        neighbors: string[];
+        weight: number;
+    };
+    export type MIManifestProperties = {
+        name: string;
+        folder_struct: (ManifestFolder | ManifestFile)[];
+        version: string;
+        time: string;
+    };
+    export type MILayerStyleProperties = {
+        layer: string;
+        altitude: number;
+        color: string;
+        height: number;
+        opacity: number;
+    };
+    export type MIPolygonStyleProperties = {
+        id: string;
+        altitude: number;
+        color: string;
+        height: number;
+        image: PolygonImage;
+        imageTransform: ImageTransform;
+        opacity: number;
+    };
+    export type MIGeoJSONManifestCollection = FeatureCollection<Point, MIManifestProperties>;
+    export type MIGeoJSONBuildingCollection = FeatureCollection<Polygon, MIBuildingProperties>;
+    export type MIGeoJSONConnectionCollection = FeatureCollection<Point, MIConnectionProperties>;
+    export type MIGeoJSONLevelCollection = FeatureCollection<Polygon | MultiPolygon, MILevelProperties>;
+    export type MIGeoJSONSpaceCollection = FeatureCollection<Polygon, MISpaceProperties>;
+    export type MIGeoJSONObstructionCollection = FeatureCollection<Polygon, MIObstructionProperties>;
+    export type MIGeoJSONNodeCollection = FeatureCollection<Point, MINodeProperties>;
+    export type MIGeoJSONLocationCollection = FeatureCollection<null, MILocationProperties>;
+    export type MIGeoJSONCategoryCollection = FeatureCollection<null, MICategoryProperties>;
+    export type MIGeoJSONLayerStyleCollection = FeatureCollection<null, MILayerStyleProperties>;
+    export type MIGeoJSONPolygonStyleCollection = FeatureCollection<null, MIPolygonStyleProperties>;
+    export type WithIDs<T> = Map<string, T>;
+    /**
+      * The entire data collection for an MVF, in a single JSON collection.
+      *
+      */
+    export type MVFData = {
+        connection: WithIDs<MIGeoJSONConnectionCollection>;
+        level: WithIDs<MIGeoJSONLevelCollection>;
+        node: WithIDs<MIGeoJSONNodeCollection>;
+        obstruction: WithIDs<MIGeoJSONObstructionCollection>;
+        polygonStyle: WithIDs<MIGeoJSONPolygonStyleCollection>;
+        space: WithIDs<MIGeoJSONSpaceCollection>;
+        building: MIGeoJSONBuildingCollection;
+        category: MIGeoJSONCategoryCollection;
+        layerStyle: MIGeoJSONLayerStyleCollection;
+        location: MIGeoJSONLocationCollection;
+        manifest: MIGeoJSONManifestCollection;
+    };
+    export {};
+}
+
 declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinLocationRankings' {
     import type { Mappedin } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin';
     import type { TLocation } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.API.types';
@@ -1320,75 +1664,11 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinTheme'
     }
 }
 
-declare module '@mappedin/mappedin-js/lib/esm/get-venue/navigator/Directive' {
-    import ILocation from '@mappedin/mappedin-js/lib/esm/get-venue/navigator/interfaces/ILocation';
-    import IMap from '@mappedin/mappedin-js/lib/esm/get-venue/navigator/interfaces/IMap';
-    import INode from '@mappedin/mappedin-js/lib/esm/get-venue/navigator/interfaces/INode';
-    export enum ACTION_TYPE {
-        DEPARTURE = "Departure",
-        TAKEVORTEX = "TakeVortex",
-        EXITVORTEX = "ExitVortex",
-        TURN = "Turn",
-        ARRIVAL = "Arrival"
-    }
-    export enum BEARING_TYPE {
-        STRAIGHT = "Straight",
-        RIGHT = "Right",
-        SLIGHTRIGHT = "SlightRight",
-        LEFT = "Left",
-        SLIGHTLEFT = "SlightLeft"
-    }
-    export enum VORTEX_DIRECTION_TYPE {
-        UP = "up",
-        DOWN = "down",
-        NONE = "none"
-    }
-    interface IActionDeparture {
-        type: ACTION_TYPE.DEPARTURE;
-    }
-    interface IActionArrival {
-        type: ACTION_TYPE.ARRIVAL;
-    }
-    interface IActionTakeVortex {
-        type: ACTION_TYPE.TAKEVORTEX;
-        toMap: IMap;
-        fromMap: IMap;
-        direction: VORTEX_DIRECTION_TYPE;
-    }
-    interface IActionExitVortex {
-        type: ACTION_TYPE.EXITVORTEX;
-        toMap: IMap;
-        fromMap: IMap;
-    }
-    interface IActionTurn {
-        type: ACTION_TYPE.TURN;
-        bearing: BEARING_TYPE;
-        referencePosition?: string;
-    }
-    export type IAction = IActionArrival | IActionDeparture | IActionTurn | IActionTakeVortex | IActionExitVortex;
-    class Directive {
-        node?: INode;
-        instruction: string;
-        action?: IAction;
-        atLocation?: ILocation;
-        type?: BEARING_TYPE;
-        distance: number;
-        constructor({ origin, action, distance, atLocation, instruction }: {
-            origin?: INode;
-            action?: IAction;
-            distance?: number;
-            atLocation?: ILocation;
-            instruction?: string;
-        });
-    }
-    export default Directive;
-}
-
 declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue' {
     import type { TGetVenueOptions } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.types';
     import { Mappedin } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin';
     /** Classes */
-    export { Mappedin } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin';
+    export { Mappedin, MappedinCollectionType } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin';
     export { MappedinLocation } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinLocation';
     export { MappedinPolygon } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinPolygon';
     export { MappedinNode } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinNode';
@@ -1411,6 +1691,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue' {
     /** API data types */
     export type { TLocationType, TNode, TImage, TLogo, TGalleryImage, TPhone, TSocial, TColor, TVortex, TPicture, TOpeningHours, TSiblingGroup, TState, TCategory, TEvent, TGeoReference, TMap, TMapGroup, TBuilding, TLocation, TPolygon, TPolygonRanking, TVenue, TMappedinAPI } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.API.types';
     export type { TGetVenueOptions } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.types';
+    import { MAP_RENDER_MODE } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.types';
     export type TShowVenueOptions = {
             /**
                 * Sets the initial background color of the map, including while loading.
@@ -1422,14 +1703,24 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue' {
                 */
             backgroundAlpha?: number;
             /**
-                * Whether or not to display labels initially
+                * Whether or not to display default styled Floating Labels initially
                 */
             labelAllLocationsOnInit?: boolean;
             /**
                 * The id of the first map to show on map load
                 */
             firstMapId?: string;
+            loadOptions?: {
+                    /**
+                        * Set the map render strategy in order to optimize FPS
+                        *
+                        * @beta
+                        */
+                    mapRenderStrategy?: MAP_RENDER_MODE;
+            };
     };
+    export { MAP_RENDER_MODE };
+    export function getVenueMVF(userOptions: TGetVenueOptions): Promise<Mappedin>;
     /**
         * Get Venue Data for a Mappedin Venue
         */
@@ -1466,6 +1757,87 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue' {
             url: any;
             updated_at: any;
     }): Promise<Mappedin>;
+    /**
+        * Get the bundle URL and updated_at time.
+        * @internal
+        */
+    export function getVenueMVFURL(userOptions: TGetVenueBundleOptions): Promise<{
+            url: string;
+            updated_at: string;
+    }>;
+    /**
+        * @internal
+        */
+    export function downloadVenueBundleMVF(options: TGetVenueOptions, 
+    /**
+        * use Web Workers to speed up MVF parsing. This is likely only benefitial for larger venues,
+        * and may be determental to smaller ones, hence it is off by default
+        */
+    useWorker?: boolean): Promise<unknown>;
+}
+
+declare module '@mappedin/mappedin-js/lib/esm/get-venue/navigator/Directive' {
+    import ILocation from '@mappedin/mappedin-js/lib/esm/get-venue/navigator/interfaces/ILocation';
+    import IMap from '@mappedin/mappedin-js/lib/esm/get-venue/navigator/interfaces/IMap';
+    import INode from '@mappedin/mappedin-js/lib/esm/get-venue/navigator/interfaces/INode';
+    export enum ACTION_TYPE {
+        DEPARTURE = "Departure",
+        TAKEVORTEX = "TakeVortex",
+        EXITVORTEX = "ExitVortex",
+        TURN = "Turn",
+        ARRIVAL = "Arrival"
+    }
+    export enum BEARING_TYPE {
+        STRAIGHT = "Straight",
+        RIGHT = "Right",
+        SLIGHTRIGHT = "SlightRight",
+        LEFT = "Left",
+        SLIGHTLEFT = "SlightLeft"
+    }
+    export enum VORTEX_DIRECTION_TYPE {
+        UP = "up",
+        DOWN = "down",
+        NONE = "none"
+    }
+    interface IActionDeparture {
+        type: ACTION_TYPE.DEPARTURE;
+    }
+    interface IActionArrival {
+        type: ACTION_TYPE.ARRIVAL;
+    }
+    interface IActionTakeVortex {
+        type: ACTION_TYPE.TAKEVORTEX;
+        toMap: IMap;
+        fromMap: IMap;
+        direction: VORTEX_DIRECTION_TYPE;
+    }
+    interface IActionExitVortex {
+        type: ACTION_TYPE.EXITVORTEX;
+        toMap: IMap;
+        fromMap: IMap;
+    }
+    interface IActionTurn {
+        type: ACTION_TYPE.TURN;
+        bearing: BEARING_TYPE;
+        referencePosition?: string;
+    }
+    export type IAction = IActionArrival | IActionDeparture | IActionTurn | IActionTakeVortex | IActionExitVortex;
+    class Directive {
+        node?: INode;
+        instruction: string;
+        action?: IAction;
+        atLocation?: ILocation;
+        type?: BEARING_TYPE;
+        distance: number;
+        constructor({ origin, action, distance, atLocation, instruction }: {
+            origin?: INode;
+            action?: IAction;
+            distance?: number;
+            atLocation?: ILocation;
+            instruction?: string;
+        });
+    }
+    export default Directive;
 }
 
 declare module '@mappedin/mappedin-js/lib/esm/get-venue/navigator/NavigationGraph' {