@mappedin/react-native-sdk 4.1.2 → 4.1.4

package/README.md

@@ -336,33 +336,28 @@ Example:
 
 ```
 
-## Get Directions from One Location to Another and show path and connections on map
+## Get directions from one location to another and show path and connections on map
 
 ```tsx
 import { MiMapView } from '@mappedin/react-native-sdk';
 import type {
-  TBlueDotUpdate,
-  MapViewStore,
   MappedinLocation,
-  MappedinNode,
+  MapViewStore,
+  MappedinPolygon,
 } from '@mappedin/react-native-sdk';
 
-// Imperative API
-const mapView = React.useRef<MapViewStore>();
-const [destination, setDestination] = React.useRef<MappedinLocation>();
-const [departure, setDeparture] = React.useState<MappedinLocation>({});
-
 const App = () => {
+  const mapView = React.useRef<MapViewStore>(null);
+  const [destination, setDestination] = React.useState<MappedinLocation>(null);
+  const [departure, setDeparture] = React.useState<MappedinLocation>(null);
+
   return (
     <>
       <MiMapView
-        style={{ flex: 1 }}
+        style={{flex: 1}}
         ref={mapView}
         options={options}
-        onDataLoaded={() => {
-          mapView.current.BlueDot.enable();
-        }}
-        onPolygonClicked={({ polygon: MappedinPolygon }) => {
+        onPolygonClicked={({polygon: MappedinPolygon}) => {
           // first, let's set departure
           if (departure == null) {
             setDeparture(polygon.locations[0]);
@@ -379,25 +374,24 @@ const App = () => {
             // get Directions
             const directions = departure.directionsTo(destination);
             // draw path on map
-            await controller.current?.Journey.draw(directions);
+            await mapView.current?.Journey.draw(directions);
             // focus on the path
-            controller.current?.Camera.focusOn({ targets: {
+            mapView.current?.Camera.focusOn({
+              targets: {
                 nodes: directions.path,
-              }
+              },
             });
           } catch (e) {
             console.error(e);
           }
-        }}
-      ></Button>
+        }}></Button>
       <Button
         title="Reset"
         onPress={() => {
-          mapView.current.clearAllPaths();
+          mapView.current?.removeAllPaths();
           setDeparture(undefined);
           setDestination(undefined);
-        }}
-      ></Button>
+        }}></Button>
     </>
   );
 };

package/dist/index.d.ts

@@ -226,7 +226,24 @@ declare module '@mappedin/react-native-sdk/wrappers/react-native-sdk/src/MiMapVi
             /**
                 * Set Polygon Color
                 */
-            setPolygonColor(polygonIdOrPolygon: MappedinPolygon['id'] | MappedinPolygon, color: string, opacity?: number, textColor?: string): Promise<unknown>;
+            setPolygonColor(
+            /**
+                * Polygon or PolygonId
+                */
+            polygonIdOrPolygon: MappedinPolygon['id'] | MappedinPolygon, 
+            /**
+                * Color to use
+                */
+            color: string, 
+            /**
+                * Opacity of polygon after setting color
+                * @deprecated
+                */
+            opacity?: number, 
+            /**
+                * Color of flat label text on polygon
+                */
+            textColor?: string): Promise<unknown>;
             /**
                 * Clear Polygon Color
                 */
@@ -645,11 +662,14 @@ declare module '@mappedin/react-native-sdk/core/packages/get-venue' {
             };
     };
     export { MAP_RENDER_MODE };
-    export function getVenueMVF(userOptions: TGetVenueBundleOptions): Promise<Mappedin>;
     /**
         * Get Venue Data for a Mappedin Venue
         */
     export function getVenue(userOptions: TGetVenueOptions): Promise<Mappedin>;
+    /**
+        * @internal
+        */
+    export function __setGetVenueMock(fn: any): void;
     export type TGetVenueBundleOptions = TGetVenueOptions & {
             bundleBaseUri?: string;
             version?: string;
@@ -961,7 +981,7 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/MapView.types'
             icon: string;
             location?: MappedinLocation;
     };
-    export type TMarkerTemplateFn = ({ icon: string, location: MappedinLocation }: TMarkerTemplateProps) => string;
+    export type TMarkerTemplateFn = ({ icon, location }: TMarkerTemplateProps) => string;
     export type TJourneyOptions = {
             /**
                 * What color to highlight departure and destination polygons
@@ -1307,7 +1327,6 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/MapView.types'
     };
     export type TFloatingLabelPolygonOptions = TCommonLabelOptions & {
             scale?: number;
-            flatLabels?: false | undefined;
             /**
                 * Ranking tier to determine how likely a {@link FloatingLabel} will appear
                 */
@@ -1625,7 +1644,12 @@ declare module '@mappedin/react-native-sdk/wrappers/common/events' {
             MAP_CHANGED = "MAP_CHANGED",
             ROTATION_CHANGED = "ROTATION_CHANGED",
             TILT_CHANGED = "TILT_CHANGED",
+            ZOOM_CHANGED = "ZOOM_CHANGED",
             CAMERA_SET = "CAMERA_SET",
+            /**
+                * @deprecated
+                */
+            SET_ZOOM = "SET_ZOOM",
             /**
                 * @deprecated
                 */
@@ -1776,6 +1800,9 @@ declare module '@mappedin/react-native-sdk/wrappers/common/payloads' {
             [EVENT.TILT_CHANGED]: {
                     tilt: number;
             };
+            [EVENT.ZOOM_CHANGED]: {
+                    zoom: number;
+            };
             [EVENT.UPDATE_GEOLOCATION]: {
                     msgID: undefined;
                     data: unknown;
@@ -1835,6 +1862,9 @@ declare module '@mappedin/react-native-sdk/wrappers/common/payloads' {
             [EVENT.SET_TILT]: {
                     tilt: number;
             };
+            [EVENT.SET_ZOOM]: {
+                    zoom: number;
+            };
             [EVENT.CAMERA_SET_SAFE_AREA_INSETS]: {
                     safeAreaInsets: {
                             top: number;
@@ -2331,7 +2361,10 @@ declare module '@mappedin/react-native-sdk/wrappers/common/controller' {
                     CACHE_IMAGE: {
                             msgID?: string | undefined;
                             data: {
-                                    url?: string | undefined;
+                                    url?: string | undefined; /**
+                                     * Send a message to the other side of the bridge
+                                     *
+                                     * @hidden
                                     options: import("../react-native-sdk/src").TGetVenueOptions;
                                     locationId: string;
                                     polygonHighlightColor?: string | undefined;
@@ -2388,6 +2421,12 @@ declare module '@mappedin/react-native-sdk/wrappers/common/controller' {
                                     tilt: number;
                             };
                     };
+                    ZOOM_CHANGED: {
+                            msgID?: string | undefined;
+                            data: {
+                                    zoom: number;
+                            };
+                    };
                     UPDATE_GEOLOCATION: {
                             msgID?: string | undefined;
                             data: {
@@ -2463,6 +2502,12 @@ declare module '@mappedin/react-native-sdk/wrappers/common/controller' {
                                     tilt: number;
                             };
                     };
+                    SET_ZOOM: {
+                            msgID?: string | undefined;
+                            data: {
+                                    zoom: number;
+                            };
+                    };
                     CAMERA_SET_SAFE_AREA_INSETS: {
                             msgID?: string | undefined;
                             data: {
@@ -4371,6 +4416,7 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappe
             };
     };
     export type TFloatingLabelOptionsInternal = {
+            id: string;
             position?: Vector3;
             polygon: MappedinPolygon;
             polygonHeight?: number;
@@ -4400,6 +4446,7 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappe
             contextConfigured: boolean;
             fillText: TDrawFn | undefined;
             newStyle: {};
+            static testId: number;
             style: TStyle;
             setColor: () => void;
             clearColor: () => void;
@@ -5001,7 +5048,6 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/MapView' {
     import { Mappedin, MappedinCoordinate, MappedinLocation, MappedinMap, MappedinNode, MappedinPolygon } from '@mappedin/react-native-sdk/core/packages/get-venue';
     import { E_SDK_EVENT_PAYLOAD, TCreateCustomInnerHTMLTooltipOptions, TCreateCustomTooltipOptions, TCreateMarkerOptions, TCreateTextTooltipOptions, TLabelAllLocationFlatLabelOptions, TLabelAllLocationFloatingLabelOptions, TFloatingLabelPolygonOptions, TMapViewOptions, TPathOptions } from '@mappedin/react-native-sdk/core/packages/renderer/MapView.types';
     import { E_SDK_EVENT, STATE } from '@mappedin/react-native-sdk/core/packages/renderer/MapView.enums';
-    import FloatingLabel from '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappedin.FloatingLabel';
     import Marker from '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappedin.Marker';
     import SmartTooltip from '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappedin.SmartTooltip';
     import Camera from '@mappedin/react-native-sdk/core/packages/renderer/Camera';
@@ -5009,7 +5055,7 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/MapView' {
     import BlueDotLayer from '@mappedin/react-native-sdk/core/packages/renderer/layers/BlueDot';
     import JourneyLayer from '@mappedin/react-native-sdk/core/packages/renderer/layers/Journey';
     import { ThreeJSMarkerHandle } from '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappedin.MapObject';
-    import { TCreateThreeDMarkerOptions, TFlatLabel, TFlatLabelPolygonOptions, TFloatingLabel } from '@mappedin/react-native-sdk/core/packages/renderer';
+    import { FloatingLabel, TCreateThreeDMarkerOptions, TFlatLabel, TFlatLabelPolygonOptions, TFloatingLabel } from '@mappedin/react-native-sdk/core/packages/renderer';
     export enum INTERNAL_EVENT {
             CAMERA_MOVING = 0,
             SET_BLUE_DOT_SIZE_FROM_ZOOM = 1,
@@ -5333,7 +5379,9 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/MapView' {
                 */
             getPolygonsAtCoordinate(coordinate: MappedinCoordinate, includeNonInteractive?: boolean): MappedinPolygon[];
             /**
-                * Destroy instance and clean up memory
+                * Destroy instance and reclaim memory. Note: this does not destroy the instance of {@link Mappedin}
+                * that was passed in. For applications that require destroying and re-creating the mapView, it is
+                * recommended to keep the {@link Mappedin} object around.
                 */
             destroy(): void;
     }
@@ -6104,7 +6152,7 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/layers/EventSy
         rendererDomElement: any;
         currentHover: null;
         hoverLabel: any;
-        hoverColor: string | number;
+        hoverColor: number;
         options: {
             disableHover: boolean;
         };
@@ -6149,6 +6197,7 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/layers/EventSy
         doHoverEffect: () => void;
         onPolygonHoverOut: (polygonId: any) => false | undefined;
         onPolygonHoverOver: (polygon: any) => false | undefined;
+        setHoverColor: (color: string | number) => void;
         destroy(): void;
     }
     export default EventSystemLayer;
@@ -6394,7 +6443,7 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappe
             _visibilityLatch: boolean | null;
             _objLoadedComplete: boolean;
             _objLoaded(object: any): any;
-            _objLoadedMerged(object: any): void;
+            _objLoadedMerged(object: any): Promise<any>;
             enableImageFlipping(polygonId: any, rotation: any): void;
             elements: any;
             boundingBox: {