@mappedin/mappedin-js 4.0.4-alpha.9 → 4.0.8

package/README.md

@@ -27,7 +27,8 @@ async function init() {
 
     const mapView = await showVenue(document.getElementById('mappedin-map'), venueData);
     mapView.labelAllLocations();
-    mapView.on(E_SDK_EVENT.ON_POLYGON_CLICKED, (polygon) => {
+    mapView.addInteractivePolygonsForAllLocations();
+    mapView.on(E_SDK_EVENT.POLYGON_CLICKED, (polygon) => {
         console.log(`Polygon with id ${polygon.id} clicked!`);
     });
 }

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

@@ -54,9 +54,10 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue' {
             bundleBaseUri?: string;
             version?: string;
             /**
-                * Use bundled images and assets to show MapView. This is unnecessary and should be false in React Native
+                * Parse bundle and convert images to blobs. Disabled in React Native
+                * @private
                 */
-            useBundleAssets?: boolean;
+            shouldPopulateBundledImagesAsBlobs?: boolean;
     };
     /**
         * [experimental] Fetching an offline Venue bundle
@@ -333,8 +334,10 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/Mappedin' {
             /**
                 *
                 * [experimental] Hydrate the Mappedin instance using a response from either {@link IMappedin.toString()}, {@link getVenueBundle} or by downloading the bundle manually
+                * @param mappedinSerializableData Mappedin data that was serialized or exported as JSON
+                * @param shouldPopulateBundledImagesAsBlobs Takes the scenes and images from a bundle and maps them as blobs to where they exist as URLs in the bundle. False by default
                 */
-            hydrate(mappedinSerializableData: string | object): Promise<undefined>;
+            hydrate(mappedinSerializableData: string | object, shouldPopulateBundledImagesAsBlobs?: boolean): Promise<undefined>;
             images: any;
             scenes: any;
             fetch(): Promise<void>;
@@ -409,7 +412,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinLocati
             siblingGroups?: TSiblingGroup[] | undefined;
             gallery?: TGalleryImage[] | undefined;
             constructor(mappedin: Mappedin, data: any);
-            categories: TCategory[];
+            categories: TCategory['id'][];
             /**
                 * Polygons this Location is attached to.
                 *
@@ -559,6 +562,14 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinNode'
             operationHours?: TOpeningHours[];
             externalId?: string;
             constructor(mappedin: Mappedin, data: any);
+            /**
+                * Latitude of node. This is expensive, especially if doing it for many/all nodes
+                */
+            get lat(): number;
+            /**
+                * Longitude of node. This is expensive, especially if doing it for many/all nodes
+                */
+            get lon(): number;
             /**
                 * Adjacent Nodes.
                 *
@@ -641,7 +652,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinMap' {
     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';
     /**
-        * A {@link MappedinMap} belonging to a specific {@link MappedinVenue}. Typically represents a certain floor. Give this to a {@link MiMapView} to display to the user.
+        * 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.
         *
         * A Map can have more properties such as 'elevation', 'name' (e.g. Level 1), and 'shortName' (e.g. L1). The elevation property can be used to determine the order of the floors (first, second, etc). Elevation is 0 based, going up and down in integers representing the number of floors above or below 0, which is ground level.
         *
@@ -685,6 +696,14 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinMap' {
                 * @property mapGroup {MappedinMapGroup}
                 */
             get mapGroup(): MappedinMapGroup | null;
+            /**
+                * Create coordinate using mappedin units
+                * @internal
+                *
+                * @param x x of coordinate
+                * @param y y of coordinate
+                */
+            createCoordinateByXY(x: number, y: number): MappedinCoordinate;
             /**
                 * Create coordinate using lat/lon
                 *
@@ -896,6 +915,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinDirect
 }
 
 declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinCoordinate' {
+    import { Mappedin, MappedinNode } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue';
     import type { MappedinMap } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinMap';
     /**
         * A {@link MappedinCoordinate} represents a coordinate on a map, created using lat/lon.
@@ -903,6 +923,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinCoordi
         * @class MappedinCoordinate
         */
     export class MappedinCoordinate {
+            #private;
             /**
                 * ID of Map that the Node is located on.
                 *
@@ -927,7 +948,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinCoordi
                 * Longitude
                 */
             lon: number;
-            constructor(lat: number, lon: number, x: number, y: number, map: MappedinMap | string);
+            constructor(lat: number, lon: number, x: number, y: number, map: MappedinMap | string, mappedin: Mappedin);
             /**
                 *
                 * Calculate distance between a coordinate and a {@link MappedinNode} or {@link MappedinCoordinate}
@@ -936,6 +957,10 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinCoordi
                 * @returns distance in meters
                 */
             absoluteDistanceTo(destination: MappedinCoordinate): number;
+            /**
+                * Get Nearest Node to Coordinate, which can then be used for navigation
+                */
+            get nearestNode(): MappedinNode;
     }
 }
 
@@ -1018,9 +1043,8 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinNaviga
 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';
-    import Directive from '@mappedin/mappedin-js/lib/esm/get-venue/navigator/Directive';
     export { ACTION_TYPE, BEARING_TYPE } from '@mappedin/mappedin-js/lib/esm/get-venue/navigator/Directive';
-    export { Navigator, NavigationGraph, Directive as TMappedinDirective };
+    export { Navigator, NavigationGraph };
     export type { IDirectionsResult } from '@mappedin/mappedin-js/lib/esm/get-venue/navigator/Navigator';
     export { E_MESSAGES } from '@mappedin/mappedin-js/lib/esm/get-venue/navigator/Navigator';
 }
@@ -1343,6 +1367,74 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/navigator/Directive' {
     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 { 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';
+    export { MappedinCategory } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinCategory';
+    export { MappedinMap } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinMap';
+    export { MappedinEvent } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinEvent';
+    export { MappedinMapGroup } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinMapGroup';
+    export { MappedinVenue } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinVenue';
+    export { MappedinVortex } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinVortex';
+    export { MappedinDirections } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinDirections';
+    export { MappedinCoordinate } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinCoordinate';
+    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';
+    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';
+    export type { TOperationHoursMap } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinLocation';
+    export type { TDirectionToOptions } from '@mappedin/mappedin-js/lib/esm/get-venue/get-venue/MappedinNavigatable';
+    /** 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';
+    export type TShowVenueOptions = {
+            /**
+                * Sets the initial background color of the map, including while loading.
+                *
+                */
+            backgroundColor?: string;
+            /**
+                * The opacity of the initial background color.
+                */
+            backgroundAlpha?: number;
+            /**
+                * Whether or not to display labels initially
+                */
+            labelAllLocationsOnInit?: boolean;
+            /**
+                * The id of the first map to show on map load
+                */
+            firstMapId?: string;
+    };
+    /**
+        * Get Venue Data for a Mappedin Venue
+        */
+    export function getVenue(userOptions: TGetVenueOptions): Promise<Mappedin>;
+    export type TGetVenueBundleOptions = TGetVenueOptions & {
+            bundleBaseUri?: string;
+            version?: string;
+            /**
+                * Parse bundle and convert images to blobs. Disabled in React Native
+                * @private
+                */
+            shouldPopulateBundledImagesAsBlobs?: boolean;
+    };
+    /**
+        * [experimental] Fetching an offline Venue bundle
+        * It is possible to download the venue bundle with all assets built in, which allows for caching/offline solutions.
+        * Note 1: This requires enabling from Mappedin's Customer Solutions team.
+        * Note 2: This may behave a lot slower for large venues, especially those with many images. We are actively working on improving load times.
+        */
+    export function getVenueBundle(userOptions: TGetVenueBundleOptions): Promise<Mappedin>;
+}
+
 declare module '@mappedin/mappedin-js/lib/esm/get-venue/navigator/NavigationGraph' {
     import Edge from '@mappedin/mappedin-js/lib/esm/get-venue/navigator/Edge';
     import IMap from '@mappedin/mappedin-js/lib/esm/get-venue/navigator/interfaces/IMap';