@mappedin/mappedin-js 4.0.18 → 4.0.21

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

@@ -58,7 +58,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue' {
             };
     };
     export { MAP_RENDER_MODE };
-    export function getVenueMVF(userOptions: TGetVenueOptions): Promise<Mappedin>;
+    export function getVenueMVF(userOptions: TGetVenueBundleOptions): Promise<Mappedin>;
     /**
         * Get Venue Data for a Mappedin Venue
         */
@@ -106,7 +106,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue' {
     /**
         * @internal
         */
-    export function downloadVenueBundleMVF(options: TGetVenueOptions, 
+    export function downloadVenueBundleMVF(options: TGetVenueBundleOptions, 
     /**
         * 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
@@ -173,6 +173,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin' {
     import { MappedinTheme } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinTheme';
     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';
+    import Analytics from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.Analytics';
     export const defaultOptions: TGetVenueOptionsInternal & TGetVenueOptions;
     export enum MappedinCollectionType {
             CATEGORY = "categories",
@@ -401,9 +402,11 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin' {
                 */
             hydrate(mappedinSerializableData: string | object, shouldPopulateBundledImagesAsBlobs?: boolean): Promise<undefined>;
             images: any;
+            imageBinaries?: Map<string, Uint8Array>;
             scenes: any;
             fetch(): Promise<void>;
             constructor(options: TGetVenueOptionsInternal & TGetVenueOptions);
+            analytics: Analytics;
             /**
                 * @hidden
                 */
@@ -551,6 +554,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinPolygo
                             y: number;
                             z: number;
                     };
+                    _isAbsolutelyPositioned?: boolean;
             };
             holes?: unknown[];
             textures?: {
@@ -1410,179 +1414,192 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.API.t
         venue: TVenue;
         vortexes: TVortex[];
         locationStates?: TLocationState[];
+        imageBinaries?: Map<string, Uint8Array>;
     };
 }
 
 declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.MVF.types' {
-    import { FeatureCollection, Polygon, Point, MultiPolygon } from 'geojson';
+    import { FeatureCollection, Polygon, Point, MultiPolygon, Position } from 'geojson';
     type ManifestFile = {
-        type: 'file';
-        name: string;
+            type: 'file';
+            name: string;
     };
     type ManifestFolder = {
-        type: 'folder';
-        name: string;
-        children: ManifestFile[];
+            type: 'folder';
+            name: string;
+            children: ManifestFile[];
     };
     type OpeningHours = {
-        opens: string;
-        closes: string;
-        dayOfWeek: string;
-        validFrom?: string;
-        validThrough?: string;
+            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;
+            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;
+            number: string;
+            extension?: string;
     };
     type Link = {
-        label: string;
-        url: string;
+            label: string;
+            url: string;
     };
     type Social = {
-        facebook?: string;
-        twitter?: string;
-        instagram?: string;
-        website?: string;
+            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: string;
+            start?: string;
+            end?: string;
     };
     type SiblingGroup = {
-        label: string;
-        siblings: string[];
+            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;
+            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;
+            id: string;
+            name: string;
+            picture?: Image;
     };
     export type MIBuildingProperties = {
-        id: string;
-        name: string;
-        venue: string;
+            id: string;
+            name: string;
+            venue: string;
     };
     export type MILevelProperties = {
-        id: string;
-        abbreviation?: string;
-        building?: string;
-        elevation?: number;
-        name: string;
+            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;
+            id: string;
+            altitude?: string;
+            color?: string;
+            externalId?: string | null;
+            height?: string;
+            layer?: string;
+            level: string;
+            parent?: string | null;
     };
     type TPseudoNodeSpaceReference = {
-        node: string;
-        map: string;
+            node: string;
+            map: string;
     };
     export type TRealSpaceReference = {
-        id: string;
-        map: string;
+            id: string;
+            map: string;
     };
     type TLocationSpaceReference = TPseudoNodeSpaceReference | TRealSpaceReference;
     export type TEntrances = {
-        id: string;
-        level: string;
+            id: string;
+            level: string;
     };
     export type MISpaceProperties = MIPolygonlikeProperties & {
-        entrances: TEntrances[];
+            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;
+            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;
+            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;
+            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 MIStyle = {
+            id: string;
+            /** The altitude of the bottom of the geometry, in metres. */
+            altitude: number;
+            color: string;
+            height: number;
+            image?: PolygonImage;
+            opacity: number;
     };
-    export type MIPolygonStyleProperties = {
-        id: string;
-        altitude: number;
-        color: string;
-        height: number;
-        image: PolygonImage;
-        imageTransform: ImageTransform;
-        opacity: number;
+    export type MIImageInstance = {
+            /** The local path or URL of the image. */
+            path: string;
+            /** The position of the centre of the image, in [long, lat] form. */
+            position: Position;
+            /** The altitude of the image, in metres. */
+            altitude: number;
+            /** Euler angles representing the rotation of the image, in degrees. Angles are in XYZ order. */
+            rotation: {
+                    x: number;
+                    y: number;
+                    z: number;
+            };
+            /** The size of the image, in metres. */
+            size: {
+                    x: number;
+                    y: number;
+            };
+            /** The portion of the image to display. */
+            viewBox: {
+                    top: number;
+                    left: number;
+                    width: number;
+                    height: number;
+            };
+            /**
+                * A space or obstruction to associate this image with. If provided,
+                * changes to the polygon's visibility will affect this image.
+                * */
+            polygonId?: string;
     };
     export type MIGeoJSONManifestCollection = FeatureCollection<Point, MIManifestProperties>;
     export type MIGeoJSONBuildingCollection = FeatureCollection<Polygon, MIBuildingProperties>;
@@ -1593,25 +1610,35 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.MVF.t
     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>;
+    export type MIStyleCollection = MIStyle[];
     /**
-      * 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;
+        * A mapping of polygon IDs to style IDs;
+        */
+    export type MIPolygonStyle = {
+            [key in string]: string;
+    };
+    export type MIImageInstanceCollection = MIImageInstance[];
+    /**
+        * The entire data collection for an MVF, in a single JSON collection.
+        *
+        */
+    export type MVFDataJSON = {
+            connection: WithIDs<MIGeoJSONConnectionCollection>;
+            level: WithIDs<MIGeoJSONLevelCollection>;
+            node: WithIDs<MIGeoJSONNodeCollection>;
+            obstruction: WithIDs<MIGeoJSONObstructionCollection>;
+            space: WithIDs<MIGeoJSONSpaceCollection>;
+            building: MIGeoJSONBuildingCollection;
+            category: MIGeoJSONCategoryCollection;
+            style: MIStyleCollection;
+            polygonStyle: WithIDs<MIPolygonStyle>;
+            imageInstance: WithIDs<MIImageInstanceCollection>;
+            location: MIGeoJSONLocationCollection;
+            manifest: MIGeoJSONManifestCollection;
+    };
+    export type MVFData = MVFDataJSON & {
+            imageBinaries: WithIDs<Uint8Array>;
     };
     export {};
 }
@@ -1665,6 +1692,90 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinTheme'
     }
 }
 
+declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin.Analytics' {
+    type AnalyticsOptions = {
+            clientId?: string;
+            clientSecret?: string;
+            accessToken?: string;
+            noAuth?: boolean;
+            venue: string;
+            testMode?: boolean | string;
+            context?: string;
+    };
+    /**
+        * 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 {
+            #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;
+            /**
+                * 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 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';
@@ -1721,7 +1832,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue' {
             };
     };
     export { MAP_RENDER_MODE };
-    export function getVenueMVF(userOptions: TGetVenueOptions): Promise<Mappedin>;
+    export function getVenueMVF(userOptions: TGetVenueBundleOptions): Promise<Mappedin>;
     /**
         * Get Venue Data for a Mappedin Venue
         */
@@ -1769,7 +1880,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue' {
     /**
         * @internal
         */
-    export function downloadVenueBundleMVF(options: TGetVenueOptions, 
+    export function downloadVenueBundleMVF(options: TGetVenueBundleOptions, 
     /**
         * 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