@mappedin/mappedin-js 5.2.1 → 5.2.2

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

@@ -64,6 +64,10 @@ declare module '@mappedin/mappedin-js' {
     export type { TGetVenueOptions, TShowVenueOptions, TMappedinOfflineSearchOptions, TMappedinOfflineSearchResult, TMappedinOfflineSearchSuggestions, TMappedinOfflineAllSearchMatch, TMappedinOfflineSearchAllOptions } from '@mappedin/mappedin-js/get-venue';
     export { Mappedin, MappedinDirections, MappedinLocation, MappedinPolygon, MappedinNode, MappedinCategory, MappedinMap, MappedinEvent, MappedinMapGroup, MappedinVenue, MappedinVortex, MappedinNavigatable, MappedinCoordinate, OfflineSearch, MAP_RENDER_MODE, setFetchFn, MappedinCollectionType } from '@mappedin/mappedin-js/get-venue';
     export { BundleAssetManager } from '@mappedin/mappedin-js/renderer/bundle-asset-manager';
+    /**
+        * @internal
+        */
+    export function __useSceneManager(value: boolean): void;
 }
 
 declare module '@mappedin/mappedin-js/renderer/MapView' {
@@ -243,17 +247,28 @@ declare module '@mappedin/mappedin-js/renderer/MapView' {
                 */
             removeAllTooltips(): void;
             /**
+                * Create a tooltip with default styling that the MapView will attempt to position in 3D space. The tooltip will be anchored
+                * to a specified node or coordinate in one of eight anchor orientations.
                 *
-                * This creates a tooltip that allows you to pass dynamic content which will attempt
-                * to position around an anchor in 3D space. The tooltip will be positioned based on one of four
-                * AnchorTypes (top, bottom, left, right).
+                * The possible anchor types are `top`, `bottom`, `left`, `right`, `topLeft`, `topRight`, `bottomLeft`, and `bottomRight`. This
+                * describes the position of the tooltip relative to the node or coordinate to which it is attached.
                 *
-                *`options.defaultAnchorType` and `options.enabledAnchorTypes` should be one of the constants from Mappedin.Tooltip.ANCHOR
+                * The tooltip is rendered into the DOM with the following structure.
                 *
-                * `options.defaultAnchorType` will override `options.enabledAnchorTypes` if that anchor was disabled it will be automatically re-enabled
+                * ```jsx
+                * <div class="mappedin-tooltip tooltip--anchor-bottom-left">
+                * 	<div class="mappedin-tooltip__content">
+                * 		{contentHtml}
+                * 	</ div>
+                * </ div>
+                * ```
                 *
+                * The `.mappedin-tooltip` element controls the position and has a class in the form of `.tooltip--anchor-{type}` that indicates
+                * the current anchor type.
                 *
-                * @return The Tooltip you created, which has already been added to the scene.
+                * @param nodeOrCoordinate A {@link MappedinNode} or {@link MappedinCoordinate} the tooltip is attached to.
+                * @param contentHtml Stringified HTML content to render within the tooltip.
+                * @param options {@link TCreateTooltipOptions} for rendering the tooltip
                 */
             createTooltip(
             /**
@@ -261,17 +276,20 @@ declare module '@mappedin/mappedin-js/renderer/MapView' {
                 */
             nodeOrCoordinate: MappedinNode | MappedinCoordinate, contentHtml: string, options?: TCreateTooltipOptions): SmartTooltip;
             /**
+                * Create a tooltip with no default styling that the MapView will attempt to position in 3D space. The tooltip will be anchored
+                * to a specified node or coordinate in one of eight anchor orientations.
                 *
-                * This creates a tooltip that allows you to pass dynamic content which will attempt
-                * to position around an anchor in 3D space. The tooltip will be positioned based on one of four
-                * AnchorTypes (top, bottom, left, right).
+                * The possible anchor types are `top`, `bottom`, `left`, `right`, `topLeft`, `topRight`, `bottomLeft`, and `bottomRight`. This
+                * describes the position of the tooltip relative to the node or coordinate to which it is attached.
                 *
-                *`options.defaultAnchorType` and `options.enabledAnchorTypes` should be one of the constants from Mappedin.Tooltip.ANCHOR
+                * Unlike {@link createTooltip}, a custom tooltip is rendered without any additional wrappers, leaving styling entirely up to the
+                * external developer. The top-most element will be injected with a class in the form of `.tooltip--anchor-{type}` that indicates
+                * the current anchor type.
                 *
-                * `options.defaultAnchorType` will override `options.enabledAnchorTypes` if that anchor was disabled it will be automatically re-enabled
-                *
-                *
-                * @return The Tooltip you created, which has already been added to the scene.
+                * @param nodeOrCoordinate A {@link MappedinNode} or {@link MappedinCoordinate} the tooltip is attached to.
+                * @param contentHtml Stringified HTML content to render within the tooltip. The contents must be `position: absolute` in order to interact with the collision engine.
+                * @param selector A CSS selector string that allows the SDK to target the tooltip. This is required because we do not inject any default styling.
+                * @param options {@link TCreateTooltipCommonOptions} for rendering the tooltip
                 */
             createCustomTooltip(
             /**
@@ -406,6 +424,13 @@ declare module '@mappedin/mappedin-js/get-venue' {
     export { MappedinRankings } from '@mappedin/mappedin-js/get-venue/MappedinRankings';
     export { MappedinDestinationSet } from '@mappedin/mappedin-js/get-venue/MappedinDestinationSet';
     export { MappedinNavigatable } from '@mappedin/mappedin-js/get-venue/MappedinNavigatable';
+    /**
+        * @internal
+        * @hidden
+        *
+        * Export this only so our internal pre-built products can use it. We don't want to document it for external developers.
+        */
+    export { default as CustomerAnalytics } from '@mappedin/mappedin-js/get-venue/Mappedin.CustomerAnalytics';
     export type { TTHINGS } from '@mappedin/mappedin-js/get-venue/Mappedin';
     export type { TMappedinDirective } from '@mappedin/mappedin-js/get-venue/MappedinDirections';
     export type { IDirectionsResult } from '@mappedin/mappedin-js/navigator';
@@ -508,6 +533,13 @@ declare module '@mappedin/mappedin-js/get-venue' {
         * and may be determental to smaller ones, hence it is off by default
         */
     useWorker?: boolean): Promise<unknown>;
+    /**
+        * Returns a {@link Mappedin} object hydrated with JSON data.
+        * @param {string|Object} mappedinSerializableData A JSON string or object representing a venue.
+        * @param {boolean} shouldPopulateBundledImagesAsBlobs
+        * @returns {Mappedin} A new Mappedin object with data from the mappedinSerializableData parameter.
+        */
+    export function hydrateVenue(mappedinSerializableData: any, shouldPopulateBundledImagesAsBlobs?: boolean): Promise<Mappedin>;
 }
 
 declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.BlueDot/Mappedin.BlueDot.core' {
@@ -670,7 +702,7 @@ declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.BlueDot/Mappedi
     };
     export type TLatLonProps = [number, number];
     const BlueDot: {
-            ({ data, mapView, core }: TBlueDotProps): IBlueDotCore;
+            ({ data, mapView, core, manager }: TBlueDotProps): IBlueDotCore;
             FakeGeolocation: typeof FakeGeolocation;
     };
     export default BlueDot;
@@ -2099,6 +2131,10 @@ declare module '@mappedin/mappedin-js/renderer' {
     export type { TGetVenueOptions, TShowVenueOptions, TMappedinOfflineSearchOptions, TMappedinOfflineSearchResult, TMappedinOfflineSearchSuggestions, TMappedinOfflineAllSearchMatch, TMappedinOfflineSearchAllOptions } from '@mappedin/mappedin-js/get-venue';
     export { Mappedin, MappedinDirections, MappedinLocation, MappedinPolygon, MappedinNode, MappedinCategory, MappedinMap, MappedinEvent, MappedinMapGroup, MappedinVenue, MappedinVortex, MappedinNavigatable, MappedinCoordinate, OfflineSearch, MAP_RENDER_MODE, setFetchFn, MappedinCollectionType } from '@mappedin/mappedin-js/get-venue';
     export { BundleAssetManager } from '@mappedin/mappedin-js/renderer/bundle-asset-manager';
+    /**
+        * @internal
+        */
+    export function __useSceneManager(value: boolean): void;
 }
 
 declare module '@mappedin/mappedin-js/get-venue/Mappedin.types' {
@@ -2407,6 +2443,9 @@ declare module '@mappedin/mappedin-js/get-venue/Mappedin' {
             imageBinaries?: Map<string, Uint8Array>;
             scenes: any;
             fetch(): Promise<void>;
+            /**
+                * @deprecated Use {@link hydrateVenue} instead
+                */
             constructor(options: TGetVenueOptionsInternal & TGetVenueOptions);
             analytics: IAnalytics;
             /**
@@ -3193,6 +3232,121 @@ declare module '@mappedin/mappedin-js/get-venue/MappedinNavigatable' {
     }
 }
 
+declare module '@mappedin/mappedin-js/get-venue/Mappedin.CustomerAnalytics' {
+    import { MappedinCategory, MappedinLocation } from '@mappedin/mappedin-js/get-venue';
+    type AnalyticsOptions = {
+            clientId?: string;
+            clientSecret?: string;
+            accessToken?: string;
+            noAuth?: boolean;
+            venue: string;
+            testMode?: boolean | string;
+            context?: string;
+            platformString?: string;
+    };
+    interface IAnalytics {
+            locationSelected(location: MappedinLocation): void;
+            categorySelected(category: MappedinCategory): void;
+            getDirections(start: MappedinLocation, end: MappedinLocation): void;
+    }
+    interface IInternalAnalytics extends IAnalytics {
+            track(target: string, query: any): void;
+            mapViewLoaded(type: '2d' | '3d', forced: boolean, benchmark: number, reason: string): void;
+            getSessionID(): string;
+            getDeviceID(): string;
+            setGeolocationMode(mode: boolean): void;
+            trackBlueDotEvent(blueDotEvent: Record<string, unknown>): void;
+            trackSearch(searchAnalyticsObject: Record<string, unknown>): void;
+            trackSearchSuggest(searchAnalyticsObject: Record<string, unknown>): void;
+    }
+    /**
+        * A class to access the Mappedin Analytics platform. Correct usage will improve Smart Search results, and lead to more accurate insights.
+        * This will be created for you as part of Mappedin.{{#crossLink "Mappedin/initialize:method"}}{{/crossLink}}, but you can also create one manually. You are mostly going to use `locationSelected`.
+        *
+        * @type {any}
+        *
+        * @class Analytics
+        * @param options {Object} A list of configuration options for the Analytics API.
+        *	@param [options.clientId] {String} The same key you are using for getVenue. Handled automatically in Mapview.initialize()
+        *	@param [options.clientSecret] {String} The same secret you are using for getVenue. Handled automatically in Mapview.initialize()
+        *	@param [options.venue] {String} The same venue slug you are using for getVenue. Handled automatically in MapView.initialize()
+        *	@param [options.context] {String} The context to pass with the analytics request. Defaults to "websdk".
+        *	@param [options.noAuth] {Boolean} Whether authentication should not be sent with analytics requests.
+        *	@param [options.testMode] {Boolean} Whether analytics events should be dropped because this is running in a test environment.
+        */
+    class Analytics implements IInternalAnalytics {
+            #private;
+            constructor(options: AnalyticsOptions);
+            track(target: any, query: any): void;
+            /**
+                * Whenever a location is selected, you should fire this event. What "selected" means can vary by venue,
+                * but a good rule of thumb is that you fire the event whenever you would show the location's details.
+                * Typically this is when the user taps it's polygon on the map, picks it from search results or a category list.
+                * or deep links directly into the map.
+                * @method locationSelected
+                * @param location {MappedinLocation} The location the user selected.
+                */
+            locationSelected(location: any): void;
+            /**
+                * Whenever a category is selected, you should fire this event.
+                * @method categorySelected
+                * @param category {MappedinCategory} The category the user selected.
+                */
+            categorySelected(category: any): void;
+            mapViewLoaded(type: any, forced: any, benchmark: any, reason: any): void;
+            /**
+                * Whenever a user requests directions, you should fire this event.
+                * @method getDirections
+                * @param start {MappedinLocation} The start location for wayfinding.
+                * @param end {MappedinLocation} The end location for wayfinding.
+                */
+            getDirections(start: any, end: any): void;
+            getSessionID(): string;
+            getDeviceID(): string;
+            /**
+                * @param mode {Boolean} Indicates whether the user's geolocation is enabled.
+                */
+            setGeolocationMode(mode: any): void;
+            /**
+                * Track an event.
+                * @method trackBlueDotEvent
+                * @param event {String}
+                * event param should be a property of the {{#crossLink "Analytics/BLUEDOT_EVENT:property"}}{{/crossLink}} property.
+                */
+            trackBlueDotEvent(blueDotEvent: any): void;
+            trackSearch(searchAnalyticsObject: any): void;
+            trackSearchSuggest(searchAnalyticsObject: any): void;
+            /**
+                * Sets the current global context of the Analytics class.
+                * @method setContext
+                * @param context {String} The Analytics context to be set.
+                * @hidden
+                */
+            static setContext(context: any): void;
+            /**
+                * Sets the current global context of the Analytics class to undefined.
+                * @method clearContext
+                * @hidden
+                */
+            static clearContext(): void;
+            /**
+                * Enum of valid bluedot events.
+                * Pass a property of this into the {{#crossLink "Analytics/trackBlueDotEvent:method"}}{{/crossLink}} method.
+                * Valid properties are: ATTEMPT_BLUEDOT, FOUND_POSITION, FOUND_FLOOR.
+                * @property BLUEDOT_EVENT {Object}
+                * @example
+                *   Analytics.trackBlueDotEvent(Analytics.BLUEDOT_EVENT.ATTEMPT_BLUEDOT)
+                */
+            static BLUEDOT_EVENT: {
+                    ATTEMPT_BLUEDOT: string;
+                    FOUND_POSITION: string;
+                    FOUND_FLOOR: string;
+            };
+    }
+    export type { IAnalytics };
+    export default Analytics;
+}
+
 declare module '@mappedin/mappedin-js/get-venue/Mappedin.OfflineSearch' {
     import { Mappedin } from '@mappedin/mappedin-js/get-venue/Mappedin';
     import type { SearchOptions } from 'minisearch';
@@ -3769,6 +3923,10 @@ declare module '@mappedin/mappedin-js/renderer/Core.interface' {
                 * @internal
                 */
             currentScale: number;
+            /**
+                * @internal
+                */
+            USE_SCENE_MANAGER: boolean;
             referenceMap: MappedinMap;
             taskScheduler: TaskScheduler;
             sceneManager: SceneManager;
@@ -4968,121 +5126,6 @@ declare module '@mappedin/mappedin-js/get-venue/MappedinTheme' {
     }
 }
 
-declare module '@mappedin/mappedin-js/get-venue/Mappedin.CustomerAnalytics' {
-    import { MappedinCategory, MappedinLocation } from '@mappedin/mappedin-js/get-venue';
-    type AnalyticsOptions = {
-            clientId?: string;
-            clientSecret?: string;
-            accessToken?: string;
-            noAuth?: boolean;
-            venue: string;
-            testMode?: boolean | string;
-            context?: string;
-            platformString?: string;
-    };
-    interface IAnalytics {
-            locationSelected(location: MappedinLocation): void;
-            categorySelected(category: MappedinCategory): void;
-            getDirections(start: MappedinLocation, end: MappedinLocation): void;
-    }
-    interface IInternalAnalytics extends IAnalytics {
-            track(target: string, query: any): void;
-            mapViewLoaded(type: '2d' | '3d', forced: boolean, benchmark: number, reason: string): void;
-            getSessionID(): string;
-            getDeviceID(): string;
-            setGeolocationMode(mode: boolean): void;
-            trackBlueDotEvent(blueDotEvent: Record<string, unknown>): void;
-            trackSearch(searchAnalyticsObject: Record<string, unknown>): void;
-            trackSearchSuggest(searchAnalyticsObject: Record<string, unknown>): void;
-    }
-    /**
-        * A class to access the Mappedin Analytics platform. Correct usage will improve Smart Search results, and lead to more accurate insights.
-        * This will be created for you as part of Mappedin.{{#crossLink "Mappedin/initialize:method"}}{{/crossLink}}, but you can also create one manually. You are mostly going to use `locationSelected`.
-        *
-        * @type {any}
-        *
-        * @class Analytics
-        * @param options {Object} A list of configuration options for the Analytics API.
-        *	@param [options.clientId] {String} The same key you are using for getVenue. Handled automatically in Mapview.initialize()
-        *	@param [options.clientSecret] {String} The same secret you are using for getVenue. Handled automatically in Mapview.initialize()
-        *	@param [options.venue] {String} The same venue slug you are using for getVenue. Handled automatically in MapView.initialize()
-        *	@param [options.context] {String} The context to pass with the analytics request. Defaults to "websdk".
-        *	@param [options.noAuth] {Boolean} Whether authentication should not be sent with analytics requests.
-        *	@param [options.testMode] {Boolean} Whether analytics events should be dropped because this is running in a test environment.
-        */
-    class Analytics implements IInternalAnalytics {
-            #private;
-            constructor(options: AnalyticsOptions);
-            track(target: any, query: any): void;
-            /**
-                * Whenever a location is selected, you should fire this event. What "selected" means can vary by venue,
-                * but a good rule of thumb is that you fire the event whenever you would show the location's details.
-                * Typically this is when the user taps it's polygon on the map, picks it from search results or a category list.
-                * or deep links directly into the map.
-                * @method locationSelected
-                * @param location {MappedinLocation} The location the user selected.
-                */
-            locationSelected(location: any): void;
-            /**
-                * Whenever a category is selected, you should fire this event.
-                * @method categorySelected
-                * @param category {MappedinCategory} The category the user selected.
-                */
-            categorySelected(category: any): void;
-            mapViewLoaded(type: any, forced: any, benchmark: any, reason: any): void;
-            /**
-                * Whenever a user requests directions, you should fire this event.
-                * @method getDirections
-                * @param start {MappedinLocation} The start location for wayfinding.
-                * @param end {MappedinLocation} The end location for wayfinding.
-                */
-            getDirections(start: any, end: any): void;
-            getSessionID(): string;
-            getDeviceID(): string;
-            /**
-                * @param mode {Boolean} Indicates whether the user's geolocation is enabled.
-                */
-            setGeolocationMode(mode: any): void;
-            /**
-                * Track an event.
-                * @method trackBlueDotEvent
-                * @param event {String}
-                * event param should be a property of the {{#crossLink "Analytics/BLUEDOT_EVENT:property"}}{{/crossLink}} property.
-                */
-            trackBlueDotEvent(blueDotEvent: any): void;
-            trackSearch(searchAnalyticsObject: any): void;
-            trackSearchSuggest(searchAnalyticsObject: any): void;
-            /**
-                * Sets the current global context of the Analytics class.
-                * @method setContext
-                * @param context {String} The Analytics context to be set.
-                * @hidden
-                */
-            static setContext(context: any): void;
-            /**
-                * Sets the current global context of the Analytics class to undefined.
-                * @method clearContext
-                * @hidden
-                */
-            static clearContext(): void;
-            /**
-                * Enum of valid bluedot events.
-                * Pass a property of this into the {{#crossLink "Analytics/trackBlueDotEvent:method"}}{{/crossLink}} method.
-                * Valid properties are: ATTEMPT_BLUEDOT, FOUND_POSITION, FOUND_FLOOR.
-                * @property BLUEDOT_EVENT {Object}
-                * @example
-                *   Analytics.trackBlueDotEvent(Analytics.BLUEDOT_EVENT.ATTEMPT_BLUEDOT)
-                */
-            static BLUEDOT_EVENT: {
-                    ATTEMPT_BLUEDOT: string;
-                    FOUND_POSITION: string;
-                    FOUND_FLOOR: string;
-            };
-    }
-    export type { IAnalytics };
-    export default Analytics;
-}
-
 declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.RenderTasks' {
     export default RENDER;
     namespace RENDER {