@mappedin/mappedin-js 5.2.0 → 5.2.2

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

@@ -35,6 +35,13 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue' {
     export { MappedinRankings } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinRankings';
     export { MappedinDestinationSet } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinDestinationSet';
     export { MappedinNavigatable } from '@mappedin/mappedin-js/lib/esm/get-venue/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/lib/esm/get-venue/get-venue/Mappedin.CustomerAnalytics';
     export type { TTHINGS } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin';
     export type { TMappedinDirective } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinDirections';
     export type { IDirectionsResult } from '@mappedin/mappedin-js/lib/esm/get-venue/navigator';
@@ -137,6 +144,13 @@ declare module '@mappedin/mappedin-js/lib/esm/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/lib/esm/get-venue/get-venue/Mappedin.types' {
@@ -445,6 +459,9 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin' {
             imageBinaries?: Map<string, Uint8Array>;
             scenes: any;
             fetch(): Promise<void>;
+            /**
+                * @deprecated Use {@link hydrateVenue} instead
+                */
             constructor(options: TGetVenueOptionsInternal & TGetVenueOptions);
             analytics: IAnalytics;
             /**
@@ -1289,6 +1306,121 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinNaviga
     }
 }
 
+declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.CustomerAnalytics' {
+    import { MappedinCategory, MappedinLocation } from '@mappedin/mappedin-js/lib/esm/get-venue/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/lib/esm/get-venue/navigator' {
     import NavigationGraph from '@mappedin/mappedin-js/lib/esm/get-venue/navigator/NavigationGraph';
     import Navigator from '@mappedin/mappedin-js/lib/esm/get-venue/navigator/Navigator';
@@ -2004,121 +2136,6 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinTheme'
     }
 }
 
-declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.CustomerAnalytics' {
-    import { MappedinCategory, MappedinLocation } from '@mappedin/mappedin-js/lib/esm/get-venue/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/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';
@@ -2151,6 +2168,13 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue' {
     export { MappedinRankings } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinRankings';
     export { MappedinDestinationSet } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinDestinationSet';
     export { MappedinNavigatable } from '@mappedin/mappedin-js/lib/esm/get-venue/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/lib/esm/get-venue/get-venue/Mappedin.CustomerAnalytics';
     export type { TTHINGS } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin';
     export type { TMappedinDirective } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinDirections';
     export type { IDirectionsResult } from '@mappedin/mappedin-js/lib/esm/get-venue/navigator';
@@ -2253,6 +2277,13 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/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/lib/esm/get-venue/navigator/Directive' {