@mappedin/react-native-sdk 5.6.1 → 5.7.1

package/dist/index.d.ts

@@ -582,7 +582,7 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/MapView.types'
     import { TBlueDotPositionUpdate, TBlueDotStateChange } from '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappedin.BlueDot/Mappedin.BlueDot.core';
     import { TOOLTIP_ANCHOR } from '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappedin.SmartTooltip';
     import type { Euler, Object3D, Vector3 } from 'three';
-    import { GEOLOCATION_STATUS, COLLISION_RANKING_TIERS, STATE, MARKER_ANCHOR, E_SDK_EVENT, E_BLUEDOT_EVENT, E_CAMERA_EVENT, MAP_RENDER_MODE } from '@mappedin/react-native-sdk/core/packages/renderer/MapView.enums';
+    import { GEOLOCATION_STATUS, COLLISION_RANKING_TIERS, STATE, MARKER_ANCHOR, E_SDK_EVENT, E_BLUEDOT_EVENT, E_CAMERA_EVENT, MAP_RENDER_MODE, CAMERA_EASING_MODE } from '@mappedin/react-native-sdk/core/packages/renderer/MapView.enums';
     export type { TEnableBlueDotOptions, TFloatingLabelAppearance };
     /**
     An extension of the GeolocationPosition type.
@@ -772,6 +772,16 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/MapView.types'
             rank?: COLLISION_RANKING_TIERS | number;
             anchor?: MARKER_ANCHOR;
     };
+    export type TAnimationOptions = {
+            /**
+                * Animation duration in milliseconds
+                */
+            duration?: number;
+            /**
+                * Mode for easing in and out of the animation.
+                */
+            easing?: CAMERA_EASING_MODE;
+    };
     export type TCreateTooltipInternalOptions = {
             nodeOrCoordinate: MappedinNode | MappedinCoordinate;
             html?: string;
@@ -1028,7 +1038,7 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/MapView.types'
             text: string;
             scale?: number;
             /**
-                * Ranking tier to determine how likely a {@link FloatingLabel} will appear
+                * Ranking tier to determine how likely a {@link FloatingLabels | Floating Label} will appear
                 */
             rank?: COLLISION_RANKING_TIERS | number;
             /**
@@ -1059,7 +1069,7 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/MapView.types'
                 */
             locations?: MappedinLocation[];
             /**
-                * Custom Translation Map for {@link MappedinLocation.MappedinLocationState}
+                * Custom translation map for location states
                 */
             translationMap?: {
                     [key in string]: string;
@@ -1560,7 +1570,10 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/MapView.FlatLa
                 */
             setAppearance(polygon: MappedinPolygon, appearance: TFlatLabelAppearance): T;
             /**
-                * Sets the color for hovering over labels
+                * Sets the hover text color for all Flat Labels.
+                * Expects color in hexadecimal string e.g. `#2e2e2e`
+                *
+                * To set hover color for all polygons, see {@link MapView.setHoverColor}.
                 */
             setHoverColorForAll(color: string): T;
     }
@@ -1646,8 +1659,8 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/Camera' {
     import { ICore } from '@mappedin/react-native-sdk/core/packages/renderer/Core.interface';
     import { MappedinNode, MappedinPolygon, MappedinCoordinate } from '@mappedin/react-native-sdk/core/packages/get-venue';
     import { PubSub } from '@mappedin/react-native-sdk/core/packages/renderer/internal/pub-sub.typed';
-    import { CAMERA_EVENT_PAYLOAD } from '@mappedin/react-native-sdk/core/packages/renderer/MapView.types';
-    import { E_CAMERA_EVENT, E_CAMERA_DIRECTION, CAMERA_EASING_MODE, SAFE_AREA_INSET_TYPE } from '@mappedin/react-native-sdk/core/packages/renderer/MapView.enums';
+    import { CAMERA_EVENT_PAYLOAD, TAnimationOptions } from '@mappedin/react-native-sdk/core/packages/renderer/MapView.types';
+    import { E_CAMERA_EVENT, E_CAMERA_DIRECTION, SAFE_AREA_INSET_TYPE } from '@mappedin/react-native-sdk/core/packages/renderer/MapView.enums';
     export type TSafeAreaInsets = {
             top: number;
             left: number;
@@ -1682,13 +1695,7 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/Camera' {
             rotation?: number;
             position?: MappedinCoordinate | MappedinNode;
     };
-    export type TCameraAnimationOptions = {
-            /**
-                * Animation duration in milliseconds
-                */
-            duration?: number;
-            easing?: CAMERA_EASING_MODE;
-    };
+    export type TCameraAnimationOptions = TAnimationOptions;
     /**
         * The Camera object specifies a view of the map and allows manipulation of that view.
         */
@@ -2624,7 +2631,7 @@ declare module '@mappedin/react-native-sdk/wrappers/common/controller' {
                                     options: import("../react-native-sdk/src").TGetVenueOptions;
                                     locationId: string;
                                     polygonHighlightColor?: string | undefined;
-                                    focusOptions?: (import("../react-native-sdk/src").TFocusOnCameraOptions & import("../react-native-sdk/src").TCameraAnimationOptions) | undefined;
+                                    focusOptions?: (import("../react-native-sdk/src").TFocusOnCameraOptions & import("../../core/packages/renderer").TAnimationOptions) | undefined;
                             };
                     };
                     SET_DEBUG_FLAGS: {
@@ -2776,7 +2783,7 @@ declare module '@mappedin/react-native-sdk/wrappers/common/controller' {
                                     config: Omit<import("../react-native-sdk/src").TCameraTransform, "position"> & {
                                             position?: import("./types").TSerializedCoordinate | import("./types").TSerializedNode | undefined;
                                     };
-                                    options?: import("../react-native-sdk/src").TCameraAnimationOptions | undefined;
+                                    options?: import("../../core/packages/renderer").TAnimationOptions | undefined;
                             };
                     };
                     CAMERA_TRANSLATE: {
@@ -2784,7 +2791,7 @@ declare module '@mappedin/react-native-sdk/wrappers/common/controller' {
                             data: {
                                     direction: import("../react-native-sdk/src").E_CAMERA_DIRECTION;
                                     distance: number;
-                                    options?: import("../react-native-sdk/src").TCameraAnimationOptions | undefined;
+                                    options?: import("../../core/packages/renderer").TAnimationOptions | undefined;
                             };
                     };
                     CAMERA_SET_SAFE_AREA_INSETS: {
@@ -2808,7 +2815,7 @@ declare module '@mappedin/react-native-sdk/wrappers/common/controller' {
                             msgID?: string | undefined;
                             data: {
                                     targets: import("./types").TFocusOnTargetsSerializable;
-                                    options?: (import("../react-native-sdk/src").TFocusOnCameraOptions & import("../react-native-sdk/src").TCameraAnimationOptions) | undefined;
+                                    options?: (import("../react-native-sdk/src").TFocusOnCameraOptions & import("../../core/packages/renderer").TAnimationOptions) | undefined;
                             };
                     };
                     SET_POLYGON_COLOR: {
@@ -3984,7 +3991,7 @@ declare module '@mappedin/react-native-sdk/core/packages/get-venue/Mappedin' {
             hydrateFromMVF(mvfData: MVFData): Promise<undefined>;
             /**
                 *
-                * [experimental] Hydrate the Mappedin instance using a response from either {@link IMappedin.toString()}, {@link getVenueBundle} or by downloading the bundle manually
+                * @experimental Hydrate the Mappedin instance using a response from either {@link Mappedin.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
                 */
@@ -4975,10 +4982,10 @@ declare module '@mappedin/react-native-sdk/core/packages/get-venue/Mappedin.Offl
     export const removeAccents: (it: string) => string;
     export type { SearchOptions };
     /**
-        * A {@link Mappedin.OfflineSearch} is an offline search module
+        * A {@link OfflineSearch} is an offline search module
         *
         *
-        * @class Mappedin.OfflineSearch
+        * @class OfflineSearch
         */
     export type TMappedinOfflineSearchAllOptions = {
             /**
@@ -5642,7 +5649,7 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer' {
     import type { TMapViewOptions, TJourneyOptions } from '@mappedin/react-native-sdk/core/packages/renderer/MapView.types';
     import { labelThemes } from '@mappedin/react-native-sdk/core/packages/renderer/MapView.types';
     import { MARKER_ANCHOR } from '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappedin.Marker';
-    export type { Marker } from '@mappedin/react-native-sdk/core/packages/renderer/layers/Markers';
+    export type { Marker } from '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappedin.Markers';
     export { BEARING_TYPE, ACTION_TYPE } from '@mappedin/react-native-sdk/core/packages/navigator';
     export type { IDirectionsResult, E_MESSAGES as E_GET_DIRECTIONS_MESSAGES } from '@mappedin/react-native-sdk/core/packages/navigator';
     export type { IFlatLabels, FlatLabels } from '@mappedin/react-native-sdk/core/packages/renderer/MapView.FlatLabels';
@@ -5746,13 +5753,14 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/MapView' {
     import { E_SDK_EVENT, STATE } from '@mappedin/react-native-sdk/core/packages/renderer/MapView.enums';
     import SmartTooltip from '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappedin.SmartTooltip';
     import Camera from '@mappedin/react-native-sdk/core/packages/renderer/Camera';
-    import { Marker } from '@mappedin/react-native-sdk/core/packages/renderer/layers/Markers';
+    import { Marker } from '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappedin.Markers';
     import { PubSub } from '@mappedin/react-native-sdk/core/packages/renderer/internal/pub-sub.typed';
     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 { TGetPolygonsAtCoordinateOptions } from '@mappedin/react-native-sdk/core/packages/renderer';
     import { IFlatLabels } from '@mappedin/react-native-sdk/core/packages/renderer/MapView.FlatLabels';
     import { IFloatingLabels } from '@mappedin/react-native-sdk/core/packages/renderer/MapView.FloatingLabels';
+    import { MarkersLayer } from '@mappedin/react-native-sdk/core/packages/renderer/layers/Markers';
     export enum INTERNAL_EVENT {
             ON_FIRST_MAP_LOADED = 0,
             TEXTURE_LOADED = 1,
@@ -5824,6 +5832,7 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/MapView' {
             Camera: Camera;
             FlatLabels: IFlatLabels<void>;
             FloatingLabels: IFloatingLabels<void>;
+            Markers: MarkersLayer;
             options: TMapViewOptions;
             constructor(container: HTMLElement, venue: Mappedin, options?: TMapViewOptions & {
                     onFirstMapLoaded: () => void;
@@ -5924,16 +5933,18 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/MapView' {
                 */
             removeInteractivePolygon(polygonOrPolygonId: MappedinPolygon | string): void;
             /**
-                * Attach any HTML to a {@link MappedinNode}, and have the marker interact and collide with smart labels and tooltips
+                * Attach any HTML to a {@link MappedinNode} or {@link MappedinCoordinate}, and have the marker interact and collide with smart labels and tooltips
+                * @deprecated use `mapView.Markers.add` instead.
                 */
             createMarker(nodeOrCoordinate: MappedinNode | MappedinCoordinate, contentHtml: string, options?: TCreateMarkerOptions): Marker;
             /**
                 * Remove Marker
+                * @deprecated use `mapView.Markers.remove` instead.
                 */
             removeMarker(markerOrMarkerId: Marker | Marker['id']): void;
             /**
                 * Removes all Markers (from all Maps, not just the current one).
-                *
+                * @deprecated use `mapView.Markers.removeAll` instead.
                 */
             removeAllMarkers(): void;
             /**
@@ -5991,9 +6002,9 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/MapView' {
                 */
             nodeOrCoordinate: MappedinNode | MappedinCoordinate, contentHtml: string, selector: string, options?: TCreateTooltipCommonOptions): SmartTooltip;
             /**
-                * Removes a {@link Tooltip} you have added previously.
+                * Removes a Tooltip you have added previously.
                 *
-                * @param tooltipOrTooltipId A Tooltip that has previously been returned from {@link MapView.createTooltip}.
+                * @param tooltipOrTooltipId A Tooltip or Tooltip id that has previously been returned from {@link MapView.createTooltip}.
                 */
             removeTooltip(tooltipOrTooltipId: SmartTooltip | SmartTooltip['id']): void;
             /**
@@ -7030,6 +7041,7 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappe
         };
         flipIfNeeded(): void;
         constructor(options: any);
+        setPosition(position: MappedinNode | MappedinCoordinate): void;
         setPriority(rank: any): void;
         setAction(action: any): void;
         resetPriority(): void;
@@ -7813,9 +7825,9 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappe
     export default InternalMarker;
 }
 
-declare module '@mappedin/react-native-sdk/core/packages/renderer/layers/Markers' {
+declare module '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappedin.Markers' {
     import { MappedinCoordinate, MappedinNode } from '@mappedin/react-native-sdk/core/packages/get-venue';
-    import { TCreateMarkerOptions } from '@mappedin/react-native-sdk/core/packages/renderer';
+    import { TCreateMarkerOptions, TAnimationOptions } from '@mappedin/react-native-sdk/core/packages/renderer';
     import InternalMarker from '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappedin.Marker';
     import { ICore } from '@mappedin/react-native-sdk/core/packages/renderer/Core.interface';
     /**
@@ -7837,14 +7849,42 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/layers/Markers
                 */
             get contentEl(): any;
     }
-    class MarkersLayer {
+    class MarkersController {
             #private;
             constructor(core: ICore);
-            createMarker(nodeOrCoordinate: MappedinNode | MappedinCoordinate, contentHtml: string, options?: TCreateMarkerOptions): Marker;
-            removeMarker(markerOrMarkerId: Marker | Marker['id']): void;
-            removeAllMarkers(): void;
+            /**
+                * Create a new Marker, containing some HTML, at the specified position
+                * @param nodeOrCoordinate the position for the Marker
+                * @param contentHtml the content to show in the Marker
+                * @param options options for the display of the Marker
+                * @returns the Marker object that was created.
+                */
+            add(nodeOrCoordinate: MappedinNode | MappedinCoordinate, contentHtml: string, options?: TCreateMarkerOptions): Marker;
+            updateMap(internalMarker: InternalMarker, from: string, to: string): void;
+            /**
+                * Moves a Marker to a new position instantaneously.
+                * @param markerOrMarkerId the Marker to move
+                * @param target the new position for this Marker
+                */
+            setPosition(markerOrMarkerId: Marker | Marker['id'], target: MappedinNode | MappedinCoordinate): void;
+            /**
+                * Moves a Marker to a new position over time.
+                * @param markerOrMarkerId the Marker to move
+                * @param target the new position for this Marker
+                * @param options the options for how this movement should be animated
+                */
+            animate(markerOrMarkerId: Marker | Marker['id'], target: MappedinCoordinate | MappedinNode, options?: TAnimationOptions): Promise<void>;
+            /**
+                * Removes a Marker.
+                * @param markerOrMarkerId the Marker to be removed
+                */
+            remove(markerOrMarkerId: Marker | Marker['id']): void;
+            /**
+                * Remove all Markers from all maps.
+                */
+            removeAll(): void;
     }
-    export default MarkersLayer;
+    export default MarkersController;
 }
 
 declare module '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappedin.AssetManager' {
@@ -7927,6 +7967,47 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/bundle-asset-m
     }
 }
 
+declare module '@mappedin/react-native-sdk/core/packages/renderer/layers/Markers' {
+    import { TAnimationOptions } from '@mappedin/react-native-sdk/core/packages/renderer';
+    import { MappedinCoordinate, MappedinNode } from '@mappedin/react-native-sdk/core/packages/get-venue';
+    import { TCreateMarkerOptions } from '@mappedin/react-native-sdk/core/packages/renderer/index.rn';
+    import MarkersController, { Marker } from '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappedin.Markers';
+    export class MarkersLayer {
+            #private;
+            constructor(markersController: MarkersController);
+            /**
+                * Create a new Marker, containing some HTML, at the specified position
+                * @param nodeOrCoordinate the position for the Marker
+                * @param contentHtml the content to show in the Marker
+                * @param options options for the display of the Marker
+                * @returns the Marker object that was created.
+                */
+            add(nodeOrCoordinate: MappedinNode | MappedinCoordinate, contentHtml: string, options?: TCreateMarkerOptions): Marker;
+            /**
+                * Moves a Marker to a new position instantaneously.
+                * @param markerOrMarkerId the Marker to move
+                * @param target the new position for this Marker
+                */
+            setPosition(markerOrMarkerId: Marker | Marker['id'], target: MappedinNode | MappedinCoordinate): void;
+            /**
+                * Moves a Marker to a new position over time.
+                * @param markerOrMarkerId the Marker to move
+                * @param target the new position for this Marker
+                * @param options the options for how this movement should be animated
+                */
+            animate(markerOrMarkerId: Marker | Marker['id'], target: MappedinCoordinate | MappedinNode, options?: TAnimationOptions): Promise<void>;
+            /**
+                * Removes a Marker.
+                * @param markerOrMarkerId the Marker to be removed
+                */
+            remove(markerOrMarkerId: Marker | Marker['id']): void;
+            /**
+                * Remove all Markers from all maps.
+                */
+            removeAll(): void;
+    }
+}
+
 declare module '@mappedin/react-native-sdk/core/packages/renderer/MapView.Scene' {
     import { MappedinMap } from '@mappedin/react-native-sdk/core/packages/get-venue';
     import { ICore } from '@mappedin/react-native-sdk/core/packages/renderer/Core.interface';
@@ -7992,6 +8073,7 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappe
         reposition: () => void;
         add: (colliderId: string, collider: ICollider) => void;
         remove: (colliderId: string) => void;
+        updateMap: (colliderId: string, from: string, to: string) => void;
         update: () => void;
         resize: (container: any) => void;
         destroy: () => void;
@@ -8071,37 +8153,72 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/layers/Outdoor
 }
 
 declare module '@mappedin/react-native-sdk/core/packages/renderer/layers/Outdoor-Context/Outdoor-Context.provider' {
+    /**
+        * @experimental
+        * The universal outdoor context interface
+        */
     export interface IOutdoorContextProvider {
-        fetchTile(tileX: number, tileY: number, zoom: number, signal: AbortSignal): Promise<Response>;
-        fetchAttribution?(zoomLevel: number, bounds: [number, number, number, number]): Promise<Response>;
+            /**
+                * Returns the appropriate tile at coordinate
+                */
+            fetchTile(tileX: number, tileY: number, zoom: number, signal: AbortSignal): Promise<Response>;
+            /**
+                * Fetch attribution for the current tiles
+                * format: [SouthwestCorner_Longitude, SouthwestCorner_Latitude, NortheastCorner_Longitude, NortheastCorner_Latitude]
+                */
+            fetchAttribution?(zoomLevel: number, bounds: [number, number, number, number]): Promise<Response>;
     }
+    /**
+        * @experimental
+        * Azure maps outdoor context class
+        */
     export class AzureOutdoorContextProvider implements IOutdoorContextProvider {
-        lang: string;
-        apiKey?: string;
-        token?: string;
-        tileSize: number;
-        tilesetId: string;
-        constructor(lang?: string, tileSize?: 256 | 512, apiKey?: string, token?: string);
-        makeURL(x: number, y: number, zoom: number): string;
-        /**
-          * Fetch attribution for the current tiles
-          * format: [SouthwestCorner_Longitude, SouthwestCorner_Latitude, NortheastCorner_Longitude, NortheastCorner_Latitude]
-          */
-        fetchAttribution(zoomLevel: number, bounds: [number, number, number, number]): Promise<Response>;
-        fetchTile(tileX: number, tileY: number, zoom: number, signal: AbortSignal): Promise<Response>;
+            lang: string;
+            apiKey?: string;
+            token?: string;
+            tileSize: number;
+            tilesetId: string;
+            constructor(lang?: string, tileSize?: 256 | 512, apiKey?: string, token?: string);
+            makeURL(x: number, y: number, zoom: number): string;
+            /**
+                * Fetch attribution for the current tiles
+                * format: [SouthwestCorner_Longitude, SouthwestCorner_Latitude, NortheastCorner_Longitude, NortheastCorner_Latitude]
+                */
+            fetchAttribution(zoomLevel: number, bounds: [number, number, number, number]): Promise<Response>;
+            /**
+                * Returns the appropriate tile at coordinate
+                */
+            fetchTile(tileX: number, tileY: number, zoom: number, signal: AbortSignal): Promise<Response>;
     }
+    /**
+        * @experimental
+        * Google maps outdoor context class
+        */
     export class GoogleOutdoorContextProvider implements IOutdoorContextProvider {
-        apiKey: string;
-        sessionToken: string;
-        lang: string;
-        constructor(lang: string | undefined, apiKey: string);
-        makeURL(x: number, y: number, zoom: number): string;
-        fetchSessionToken(): Promise<void>;
-        fetchTile(tileX: number, tileY: number, zoom: number, signal: any): Promise<Response>;
+            apiKey: string;
+            sessionToken: string;
+            lang: string;
+            constructor(lang: string | undefined, apiKey: string);
+            makeURL(x: number, y: number, zoom: number): string;
+            /**
+                * Returns the Google session token
+                */
+            fetchSessionToken(): Promise<void>;
+            /**
+                * Returns the appropriate tile at coordinate
+                */
+            fetchTile(tileX: number, tileY: number, zoom: number, signal: any): Promise<Response>;
     }
+    /**
+        * @experimental
+        * OpenStreetMap maps outdoor context class
+        */
     export class OpenStreetMapOutdoorContext implements IOutdoorContextProvider {
-        makeURL(x: number, y: number, z: number): string;
-        fetchTile(tileX: number, tileY: number, zoom: number, signal: any): Promise<Response>;
+            makeURL(x: number, y: number, z: number): string;
+            /**
+                * Returns the appropriate tile at coordinate
+                */
+            fetchTile(tileX: number, tileY: number, zoom: number, signal: any): Promise<Response>;
     }
 }