@mappedin/react-native-sdk 5.34.2 → 5.35.0

package/dist/index.d.ts

@@ -1843,6 +1843,23 @@ declare module '@mappedin/react-native-sdk/sdks/packages/legacy-renderer/MapView
     export type { TOutdoorViewOptions, TOutdoorViewOptionsWithHeaders, TOutdoorViewOptionsWithAuthURL };
     export type { default as BlueDotController } from '@mappedin/react-native-sdk/sdks/packages/legacy-renderer/private/controllers/BlueDotController';
     export type { default as Journey } from '@mappedin/react-native-sdk/sdks/packages/legacy-renderer/public/api/Journey';
+    export type TStackedMapsOptions = {
+            /**
+                * The vertical distance between maps in overview, in metres.
+                * @default 50
+                */
+            verticalDistanceBetweenMaps?: number;
+            /**
+                * Whether to show map level labels in overview.
+                * @default true
+                */
+            mapLabels?: boolean;
+            /**
+                * Whether to show only Journey maps in the stack if a Journey is active and the current map is part of the Journey.
+                * @default true
+                */
+            prioritizeJourneyMaps?: boolean;
+    };
 }
 
 declare module '@mappedin/react-native-sdk/sdks/packages/get-venue' {
@@ -4477,13 +4494,49 @@ declare module '@mappedin/react-native-sdk/sdks/packages/legacy-renderer/interna
                             inactive?: string;
                     };
                     /**
-                        * Size of bounding box of SVG icon
+                        * Size of bounding box of the icon
+                        * @default 10
                         */
                     iconSize?: number;
                     /**
-                        * SVG of icon to place inside Floating Label
+                        * Icon to be placed inside the Floating Label marker. Supports SVG or a URL to png or jpeg.
+                        * @example
+                        * ```ts
+                        * // SVG
+                        * mapView.FloatingLabels.add(polygon, "Label", {
+                        * 	appearance: {
+                        * 		marker: {
+                        * 			icon: `<svg>...</svg>`,
+                        * 		},
+                        * 	},
+                        * });
+                        * ```
+                        *
+                        * @example
+                        * ```ts
+                        * // Image URL
+                        * mapView.FloatingLabels.add(polygon, "Label", {
+                        * 	appearance: {
+                        * 		marker: {
+                        * 			icon: 'https://example.com/icon.png',
+                        * 		},
+                        * 	},
+                        * });
+                        * ```
                         */
                     icon?: string;
+                    /**
+                        * How the icon should fit inside the marker. By default, this is not set and the icon will be centered inside the marker.
+                        *  - `fill` will stretch the icon to fill the marker.
+                        *  - `cover` will maintain aspect ratio and fill the marker.
+                        *  - `contain` will maintain aspect ratio and fit the icon inside the marker.
+                        */
+                    iconFit?: 'contain' | 'fill' | 'cover';
+                    /**
+                        * Padding around the icon, in pixels.
+                        * @default 4
+                        */
+                    iconPadding?: number;
                     /**
                         * Defines when the icon becomes visible relative to the current zoom level
                         * anything below 0 will result in icons never showing up
@@ -4515,6 +4568,8 @@ declare module '@mappedin/react-native-sdk/sdks/packages/legacy-renderer/interna
                     };
                     iconSize?: number;
                     icon?: string;
+                    iconFit?: 'fill' | 'cover' | 'contain';
+                    iconPadding: number;
                     iconVisibilityThreshold?: number;
             };
     };
@@ -4581,6 +4636,12 @@ declare module '@mappedin/react-native-sdk/sdks/packages/legacy-renderer/interna
             static imagePromiseCache: {
                     [key in number]?: Promise<HTMLImageElement>;
             };
+            static imageDimensionsCache: {
+                    [key in number]: {
+                            width: number;
+                            height: number;
+                    };
+            };
             get pinCanvasSize(): number;
             draw(context: CanvasRenderingContext2D): void;
     }
@@ -4661,7 +4722,7 @@ declare module '@mappedin/react-native-sdk/sdks/packages/legacy-renderer/interna
             map: MappedinMap | null;
             bearing: any;
             nearestNode: any;
-            forceBlueDot: boolean;
+            hasEverReceivedFloorLevel: boolean;
     };
     export interface IBlueDotCore extends IPubSub {
             positionUpdater: IPositionUpdater | null;
@@ -4677,6 +4738,8 @@ declare module '@mappedin/react-native-sdk/sdks/packages/legacy-renderer/interna
             Whether blue dot should be allowed with missing floor level information.
              */
             forceBlueDot: boolean;
+            /** Whether we have received floorLevel data and are on a floorLevel supported device */
+            hasEverReceivedFloorLevel: boolean;
             /**
             The state machine for the current state of the blue dot.
              */
@@ -7066,21 +7129,64 @@ declare module '@mappedin/react-native-sdk/sdks/packages/legacy-renderer/private
     import { Sprite } from 'three';
     type TPosition = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' | 'center' | 'top' | 'bottom' | 'left' | 'right';
     export type TShowWatermarkOptions = {
-        padding?: number;
-        position?: TPosition;
-        iconOnly?: boolean;
-        scale?: number;
-        onClick?: () => void;
+            /**
+                * Padding in pixels. Can be a number or an object with top, right, bottom, and left properties.
+                * @default 16
+                * @example
+                * ```ts
+                * // Watermark with 20 pixels of padding on all sides
+                * __showWatermark({
+                * 	padding: 20,
+                * });
+                * ```
+                * @example
+                * ```ts
+                * // Watermark with unique top, right, bottom, left padding
+                * __showWatermark({
+                * 	padding: {
+                * 		top: 10,
+                * 		right: 20,
+                * 		bottom: 30,
+                * 		left: 40,
+                * 	},
+                * });
+                * ```
+                */
+            padding?: number | {
+                    top?: number;
+                    right?: number;
+                    bottom?: number;
+                    left?: number;
+            };
+            /**
+                * Position of the watermark on the screen.
+                * @default 'bottom-left'
+                */
+            position?: TPosition;
+            /**
+                * Show only the Mappedin icon without text.
+                * @default false
+                */
+            iconOnly?: boolean;
+            /**
+                * Scale of the watermark between 0.5 and 1.5.
+                * @default 1
+                */
+            scale?: number;
+            /**
+                * Callback when the watermark is clicked.
+                */
+            onClick?: () => void;
     };
     class WatermarkController {
-        #private;
-        static ENABLED: boolean;
-        static OPTIONS: Required<TShowWatermarkOptions>;
-        object?: Sprite;
-        constructor(core: ICore);
-        show: () => void;
-        hide: () => void;
-        resize: () => void;
+            #private;
+            static ENABLED: boolean;
+            static OPTIONS: Required<TShowWatermarkOptions>;
+            object?: Sprite;
+            constructor(core: ICore);
+            show: () => void;
+            hide: () => void;
+            resize: () => void;
     }
     export default WatermarkController;
 }
@@ -10434,142 +10540,126 @@ declare module '@mappedin/react-native-sdk/sdks/packages/legacy-renderer/private
     import { MappedinDirections, MappedinMap, MappedinNode } from '@mappedin/react-native-sdk/sdks/packages/get-venue';
     import { STACKED_MAPS_STATE, MapViewScene, MapViewStackScene, CAMERA_EASING_MODE } from '@mappedin/react-native-sdk/sdks/packages/legacy-renderer/internal';
     import type { ICore, TCameraTransform } from '@mappedin/react-native-sdk/sdks/packages/legacy-renderer/internal';
+    import { TStackedMapsOptions } from '@mappedin/react-native-sdk/sdks/packages/legacy-renderer/MapView.types';
     enum ACTION {
-            enable = "enable",
-            disable = "disable",
-            showOverview = "showOverview",
-            zoomInToMap = "zoomInToMap",
-            scrollToMap = "scrollToMap",
-            restack = "restack"
+        enable = "enable",
+        disable = "disable",
+        showOverview = "showOverview",
+        zoomInToMap = "zoomInToMap",
+        scrollToMap = "scrollToMap",
+        restack = "restack"
     }
     type TTargetTransitionFunction = ((options: TParams) => () => Promise<void>) | ((options: TParams) => void);
     type TParams = {
-            map: MappedinMap;
+        map: MappedinMap;
     } | {
-            directions: MappedinDirections | MappedinDirections[];
+        directions: MappedinDirections | MappedinDirections[];
     } | {
-            stackScene: MapViewStackScene;
-            directions: MappedinDirections | MappedinDirections[];
-            verticalDistanceBetweenMaps?: number;
+        stackScene: MapViewStackScene;
+        directions: MappedinDirections | MappedinDirections[];
+        verticalDistanceBetweenMaps?: number;
     } | {
-            stackScene: MapViewStackScene;
-            verticalDistanceBetweenMaps?: number;
-            map: MappedinMap;
-            nodes: MappedinNode[];
+        stackScene: MapViewStackScene;
+        verticalDistanceBetweenMaps?: number;
+        map: MappedinMap;
+        nodes: MappedinNode[];
     } | {
-            stackScene: MapViewStackScene;
-            map: MappedinMap;
-            nodes: MappedinNode[];
-            rotation: number;
-            cameraTransform?: TCameraTransform;
-            verticalDistanceBetweenMaps?: number;
+        stackScene: MapViewStackScene;
+        map: MappedinMap;
+        nodes: MappedinNode[];
+        rotation: number;
+        cameraTransform?: TCameraTransform;
+        verticalDistanceBetweenMaps?: number;
     };
     type TActionFn = [STACKED_MAPS_STATE, TTargetTransitionFunction[]];
     type TState = {
-            [stateName in STACKED_MAPS_STATE]?: {
-                    actions: {
-                            [actionName in ACTION]?: TActionFn;
-                    };
+        [stateName in STACKED_MAPS_STATE]?: {
+            actions: {
+                [actionName in ACTION]?: TActionFn;
             };
+        };
     };
     export type TInternalTransitionOptions = {
-            animate?: boolean;
-    };
-    export type TStackedMapsOptions = {
-            /**
-                * The vertical distance between maps in overview, in metres.
-                * @default 50
-                */
-            verticalDistanceBetweenMaps?: number;
-            /**
-                * Whether to show map level labels in overview.
-                * @default true
-                */
-            mapLabels?: boolean;
-            /**
-                * Whether to show only Journey maps in the stack if a Journey is active and the current map is part of the Journey.
-                * @default true
-                */
-            prioritizeJourneyMaps?: boolean;
+        animate?: boolean;
     };
     class StackedMapsController {
-            #private;
-            options: TStackedMapsOptions;
-            enabled: boolean;
-            stackScene: MapViewStackScene;
-            constructor(core: ICore);
-            needsUpdate: boolean;
-            currentState: STACKED_MAPS_STATE;
-            mapsInStack: MappedinMap[];
-            getZoomIntoMapOptions: (params: TParams) => (MapViewScene | {
-                    activeMap: MappedinMap;
-                    focusOn: {
-                            targets: {
-                                    nodes: MappedinNode[];
-                            };
-                            options: {
-                                    zoom?: number;
-                                    tilt: number;
-                                    rotation: number;
-                                    position?: MappedinNode | import("../../internal").MappedinCoordinate;
-                                    easing: CAMERA_EASING_MODE;
-                            };
-                    };
-            })[];
-            getDisableOptions: (params: TParams) => (MapViewScene | {
-                    activeMap: MappedinMap;
-            })[];
-            getShowOverviewOptions: (params: TParams) => (MapViewStackScene | {
-                    activeMap: MappedinMap;
-                    focusOn: {
-                            options: {
-                                    tilt: number;
-                                    duration: number;
-                            };
-                    };
-                    verticalDistanceBetweenMaps: number;
-            })[];
-            getScrollToMapOptions: (params: TParams) => (MapViewStackScene | {
-                    focusOn: {
-                            targets: {
-                                    nodes: MappedinNode[];
-                            };
-                            options: {
-                                    tilt: number;
-                                    easing: CAMERA_EASING_MODE;
-                            };
-                    };
-                    activeMap: MappedinMap;
-            })[];
-            getRestackOptions: (params: TParams) => (MapViewStackScene | {
-                    activeMap: MappedinMap;
-                    focusOn: {
-                            options: {
-                                    tilt: number;
-                                    duration: number;
-                            };
-                    };
-                    verticalDistanceBetweenMaps: number;
-            })[];
-            getEnableOptions: () => void;
-            getShowOverviewTransition: (options: any, inTransit?: boolean) => () => Promise<void>;
-            getZoomInToMapTransition: (options: any) => () => Promise<void>;
-            getScrollToMapTransition: (options: any, inTransit?: boolean) => () => Promise<void>;
-            getRestackTransition: (options: any, inTransit?: boolean) => () => Promise<void>;
-            getDisableTransition: (options: any) => () => Promise<void>;
-            getEnableTransition: () => () => void;
-            states: TState;
-            get determineMapStack(): MappedinMap[];
-            transition(currentState: STACKED_MAPS_STATE, actionName: ACTION): TTargetTransitionFunction[] | void;
-            exec(transitions: TTargetTransitionFunction[] | void, params: TParams): Promise<void>;
-            disable: () => Promise<void>;
-            enable: (opts?: TStackedMapsOptions) => Promise<void>;
-            get nodesInJourneyOrMap(): any[];
-            showOverview: () => Promise<void>;
-            scrollToMap: (map: MappedinMap) => Promise<void>;
-            restack: (options?: TStackedMapsOptions) => Promise<void>;
-            zoomInToMap: (map: MappedinMap, cameraTransform?: TCameraTransform) => Promise<void>;
-            get currentMap(): MappedinMap;
+        #private;
+        options: TStackedMapsOptions;
+        enabled: boolean;
+        stackScene: MapViewStackScene;
+        constructor(core: ICore);
+        needsUpdate: boolean;
+        currentState: STACKED_MAPS_STATE;
+        mapsInStack: MappedinMap[];
+        getZoomIntoMapOptions: (params: TParams) => (MapViewScene | {
+            activeMap: MappedinMap;
+            focusOn: {
+                targets: {
+                    nodes: MappedinNode[];
+                };
+                options: {
+                    zoom?: number;
+                    tilt: number;
+                    rotation: number;
+                    position?: MappedinNode | import("../../internal").MappedinCoordinate;
+                    easing: CAMERA_EASING_MODE;
+                };
+            };
+        })[];
+        getDisableOptions: (params: TParams) => (MapViewScene | {
+            activeMap: MappedinMap;
+        })[];
+        getShowOverviewOptions: (params: TParams) => (MapViewStackScene | {
+            activeMap: MappedinMap;
+            focusOn: {
+                options: {
+                    tilt: number;
+                    duration: number;
+                };
+            };
+            verticalDistanceBetweenMaps: number;
+        })[];
+        getScrollToMapOptions: (params: TParams) => (MapViewStackScene | {
+            focusOn: {
+                targets: {
+                    nodes: MappedinNode[];
+                };
+                options: {
+                    tilt: number;
+                    easing: CAMERA_EASING_MODE;
+                };
+            };
+            activeMap: MappedinMap;
+        })[];
+        getRestackOptions: (params: TParams) => (MapViewStackScene | {
+            activeMap: MappedinMap;
+            focusOn: {
+                options: {
+                    tilt: number;
+                    duration: number;
+                };
+            };
+            verticalDistanceBetweenMaps: number;
+        })[];
+        getEnableOptions: () => void;
+        getShowOverviewTransition: (options: any, inTransit?: boolean) => () => Promise<void>;
+        getZoomInToMapTransition: (options: any) => () => Promise<void>;
+        getScrollToMapTransition: (options: any, inTransit?: boolean) => () => Promise<void>;
+        getRestackTransition: (options: any, inTransit?: boolean) => () => Promise<void>;
+        getDisableTransition: (options: any) => () => Promise<void>;
+        getEnableTransition: () => () => void;
+        states: TState;
+        get determineMapStack(): MappedinMap[];
+        transition(currentState: STACKED_MAPS_STATE, actionName: ACTION): TTargetTransitionFunction[] | void;
+        exec(transitions: TTargetTransitionFunction[] | void, params: TParams): Promise<void>;
+        disable: () => Promise<void>;
+        enable: (opts?: TStackedMapsOptions) => Promise<void>;
+        get nodesInJourneyOrMap(): any[];
+        showOverview: () => Promise<void>;
+        scrollToMap: (map: MappedinMap) => Promise<void>;
+        restack: (options?: TStackedMapsOptions) => Promise<void>;
+        zoomInToMap: (map: MappedinMap, cameraTransform?: TCameraTransform) => Promise<void>;
+        get currentMap(): MappedinMap;
     }
     export default StackedMapsController;
 }
@@ -11857,8 +11947,8 @@ declare module '@mappedin/react-native-sdk/sdks/packages/legacy-renderer/public/
 
 declare module '@mappedin/react-native-sdk/sdks/packages/legacy-renderer/public/api/StackedMaps' {
     import { MappedinMap } from '@mappedin/react-native-sdk/sdks/packages/get-venue';
+    import { TStackedMapsOptions } from '@mappedin/react-native-sdk/sdks/packages/legacy-renderer/MapView.types';
     import { STACKED_MAPS_STATE, StackedMapsController, TCameraTransform } from '@mappedin/react-native-sdk/sdks/packages/legacy-renderer/internal';
-    import { TStackedMapsOptions } from '@mappedin/react-native-sdk/sdks/packages/legacy-renderer/private/controllers/StackedMapsController';
     /**
         * @experimental
         * API for showing multiple maps involved in a {@link Journey} as a vertical stack.
@@ -11871,7 +11961,8 @@ declare module '@mappedin/react-native-sdk/sdks/packages/legacy-renderer/public/
             constructor(markersController: StackedMapsController);
             /**
                 * @experimental
-                * Enable Stacked Maps. A {@link Journey} must be drawn beforehand or this method will fail.
+                * Enable Stacked Maps. If a {@link Journey} is drawn beforehand the default behaviour is to only display the floors that are part of the journey.
+                * {@link TStackedMapsOptions} can be used to enabling display of all maps including those that are not part of the journey.
                 * Use {@link showOverview} to expand the maps vertically after enabling.
                 *
                 * Upon enabling, map state will become {@link STATE.STACKED | STACKED} and Stacked Maps state will become {@link STACKED_MAPS_STATE.ACTIVE | ACTIVE}.
@@ -11909,7 +12000,7 @@ declare module '@mappedin/react-native-sdk/sdks/packages/legacy-renderer/public/
             /**
                 * @experimental
                 *
-                * Expand the maps in the current {@link Journey} vertically and add vertical paths between connections.
+                * Expand and display all maps in the current {@link MapGroup}. If a {@link Journey} has been drawn, vertical paths between connections are displayed.
                 * Stacked Maps must be enabled beforehand and state will become {@link STACKED_MAPS_STATE.OVERVIEW | OVERVIEW}.
                 *
                 * @example
@@ -11964,7 +12055,8 @@ declare module '@mappedin/react-native-sdk/sdks/packages/legacy-renderer/public/
                 * @experimental
                 *
                 * Used when in {@link STACKED_MAPS_STATE.OVERVIEW | OVERVIEW} state to replace the maps in the
-                * current stack if there is a new Journey or Journey is cleared.
+                * current stack after clearing or creating a {@link Journey}.
+                * Use this to hide maps that are not part of the journey or to display all maps in the {@link MapGroup}.
                 *
                 * @param options - Options to adjust the overview. Each option defaults to the setting passed in {@link enable}, unless provided.
                 *