@mappedin/react-native-sdk 5.32.0 → 5.34.0

package/dist/index.d.ts

@@ -3642,7 +3642,10 @@ declare module '@mappedin/react-native-sdk/sdks/packages/legacy-renderer/private
                 * An object containing all outlined polygons.
                 */
             outlinedPolygons: Map<string, MappedinPolygon>;
-            cameraPlane: any;
+            /**
+                * A plane that is parallel to the ground and is used for raycasting.
+                */
+            worldPlane: Mesh;
             getPositionLatLon(lat: number, lon: number, map?: MappedinMap | string | null): Vector3;
             currentScale: number;
             getPositionPolygon(polygon: MappedinPolygon | string): Vector3;
@@ -5251,6 +5254,7 @@ declare module '@mappedin/react-native-sdk/sdks/packages/get-venue/Mappedin.type
             clientId: string;
             clientSecret: string;
             venue: string;
+            accessToken: string;
     };
     export type TAllGetVenueOptions = TGetVenueOptions | TGetVenueMVFOptions | (TProcessedMVFOptions & {
             perspective?: string;
@@ -5943,8 +5947,8 @@ declare module '@mappedin/react-native-sdk/sdks/packages/get-venue/MappedinLocat
 }
 
 declare module '@mappedin/react-native-sdk/sdks/packages/get-venue/MappedinCoordinate' {
-    import { MappedinNode, Mappedin } from '@mappedin/react-native-sdk/sdks/packages/get-venue/internal';
     import type { MappedinMap } from '@mappedin/react-native-sdk/sdks/packages/get-venue/internal';
+    import { Mappedin, MappedinNode } from '@mappedin/react-native-sdk/sdks/packages/get-venue/internal';
     export type TMappedinCoordinateOptions = {
             map: MappedinMap;
             mappedin: Mappedin;
@@ -6007,6 +6011,11 @@ declare module '@mappedin/react-native-sdk/sdks/packages/get-venue/MappedinCoord
                 * Get Nearest Node to Coordinate, which can then be used for navigation
                 */
             get nearestNode(): MappedinNode;
+            /**
+                * Get the {@link MappedinNode}s within a radius of the {@link MappedinCoordinate}.
+                * @param radius - The radius in metres.
+                */
+            nodesInRadius(radius: number): MappedinNode[];
             toJSON(): {
                     x: number;
                     y: number;
@@ -6585,13 +6594,15 @@ declare module '@mappedin/react-native-sdk/sdks/packages/navigator/NavigationGra
           * @param accessible boolean - optional, if true directions will only take accessible route, defaults to false
           * @param includedVortexIds set - optional, exclude all the vertexes matching the given IDs
           * @param excludedVortexIds set - optional, exclude all the vertexes matching the given IDs
+          * @param excludedNodeIds set - optional, exclude all the nodes matching the given IDs
           */
-        aStar({ originIds, destinationNodeIds, accessible, includedVortexIds, excludedVortexIds, }: {
+        aStar({ originIds, destinationNodeIds, accessible, includedVortexIds, excludedVortexIds, excludedNodeIds, }: {
             originIds: string[];
             destinationNodeIds: string[];
             accessible: boolean;
             includedVortexIds?: Set<string>;
             excludedVortexIds?: Set<string>;
+            excludedNodeIds?: Set<string>;
         }): Edge[];
         getDistance(origin: INode, destination: INode): number;
         getShortestEuclideanDistance(origin: INode, destinations: INode[]): number;
@@ -6658,10 +6669,11 @@ declare module '@mappedin/react-native-sdk/sdks/packages/navigator/Navigator' {
                 * @param includedVortexIds set - optional, exclude all the vertexes matching the given IDs
                 * @param excludedVortexIds set - optional, exclude all the vertexes matching the given IDs
                 */
-            getDirections({ originIds, destinationNodeIds, accessible, departFrom, arriveAt, includedVortexIds, excludedVortexIds, simplify, }: {
+            getDirections({ originIds, destinationNodeIds, accessible, departFrom, arriveAt, includedVortexIds, excludedVortexIds, excludedNodeIds, simplify, }: {
                     originIds: string[];
                     includedVortexIds?: Set<string>;
                     excludedVortexIds?: Set<string>;
+                    excludedNodeIds?: Set<string>;
                     destinationNodeIds: string[];
                     accessible: boolean;
                     departFrom?: ILocation;
@@ -7285,7 +7297,7 @@ declare module '@mappedin/react-native-sdk/sdks/packages/legacy-renderer/private
             resolution: Vector2;
             cameraParameters: any;
             controls: typeof Mappedin.CameraControls;
-            cameraPlane: Mesh;
+            worldPlane: Mesh;
             canvasWidth: number;
             canvasHeight: number;
             cachedPadding: TPadding;
@@ -7624,7 +7636,7 @@ declare module '@mappedin/react-native-sdk/sdks/packages/get-venue/pub-sub.typed
         * @template EVENT_PAYLOAD - The type of the event payload.
         * @template EVENT - The type of the event.
         */
-    export class PubSub<EVENT_PAYLOAD, EVENT extends keyof EVENT_PAYLOAD> {
+    export class PubSub<EVENT_PAYLOAD, EVENT extends keyof EVENT_PAYLOAD = keyof EVENT_PAYLOAD> {
             /**
                 * @private
                 * @internal
@@ -7695,6 +7707,10 @@ declare module '@mappedin/react-native-sdk/sdks/packages/get-venue/MappedinNavig
                 * Exclude all the vortexes matching the given IDs
                 */
             excludedVortexIds?: string[];
+            /**
+                * Exclude all the nodes matching the given IDs
+                */
+            excludedNodeIds?: string[];
             /**
                 * @experimental
                 * Apply line-of-sight simplifying to directions. This will attempt to remove unnecessary nodes between turns.
@@ -8509,6 +8525,7 @@ declare module '@mappedin/react-native-sdk/sdks/packages/get-venue/Mappedin.cach
         get polygonsByMapId(): Map<string, MappedinPolygon[]>;
         get nodesByMapId(): Map<string, MappedinNode[]>;
         findNearestNodeOnMap(mapId: string, coordinate: MappedinCoordinate): MappedinNode;
+        findNodeWithinRadiusOnMap(mapId: string, coordinate: MappedinCoordinate, radius: number): MappedinNode[];
         get locationsByMapId(): Map<string, MappedinLocation[]>;
         static instances: Map<Mappedin, MappedinCache>;
         static create(mappedin: Mappedin): MappedinCache;
@@ -10233,73 +10250,76 @@ declare module '@mappedin/react-native-sdk/sdks/packages/legacy-renderer/private
     import type { ICore, MappedinPolygon, Collider } from '@mappedin/react-native-sdk/sdks/packages/legacy-renderer/internal';
     import { BlueDotManager, Path } from '@mappedin/react-native-sdk/sdks/packages/legacy-renderer/internal';
     class EventSystem {
-        core: ICore;
-        blueDotManager?: BlueDotManager;
-        rendererDomElement: any;
-        currentHover: string | null;
-        hoverLabel: any;
-        hoverColor: Color;
-        options: {
-            disableHover: boolean;
-        };
-        constructor(core: ICore);
-        setBlueDotManager: (blueDotManager: any) => void;
-        touchCount: number;
-        zoomOut(): void;
-        zoomIn(event: any): void;
-        onPointerMove: (event: any) => void;
-        onPointerUp: (event: any) => void;
-        /**
-          * We've confirmed that a map click has occured, so handle that here
-          */
-        handleMapClick(event: any): void;
-        onPointerDown: (event: any) => void;
-        incrementTouches: (event: any) => void;
-        decrementTouches: (event: any) => void;
-        clearMouse: () => void;
-        getMousePos: (event: any) => {
-            x: any;
-            y: any;
-        };
-        getScaledMousePos: (event: any) => {
-            x: number;
-            y: number;
-        };
-        cursorPos: {
-            x: number;
-            y: number;
-        };
-        mouse: {
-            x: number;
-            y: number;
-        };
-        mouseDownStart: {
-            time: number;
-            clientX: number;
-            clientY: number;
-        };
-        scaledCursorPos: {
-            x: number;
-            y: number;
-        };
-        hasTouched: boolean;
-        calculateMouseCoordinates: (event: any) => void;
-        getMouseRayIntersects: (objects: Object3D | Object3D[]) => import("three").Intersection<Object3D<import("three").Object3DEventMap>>[];
-        detectCollidersUnderMouse: () => Collider[];
-        detectPolygonsUnderMouse: () => string[];
-        detectPathsUnderMouse: () => Path[];
-        detectWatermarkUnderMouse: () => boolean;
-        detectMapsUnderMouse: () => import("../../internal").MappedinMap[];
-        getMouseMapPosition: () => {
-            x: number;
-            y: number;
-        };
-        checkMouseIntersectsBlueDot: () => boolean;
-        doHoverEffect: () => void;
-        onPolygonHoverOut: (polygonId: string) => boolean;
-        onPolygonHoverOver: (polygon: MappedinPolygon | string) => boolean;
-        setHoverColor: (color: string) => void;
-        destroy(): void;
+            core: ICore;
+            blueDotManager?: BlueDotManager;
+            rendererDomElement: any;
+            currentHover: string | null;
+            hoverLabel: any;
+            hoverColor: Color;
+            options: {
+                    disableHover: boolean;
+            };
+            constructor(core: ICore);
+            setBlueDotManager: (blueDotManager: any) => void;
+            touchCount: number;
+            zoomOut(): void;
+            zoomIn(event: any): void;
+            onPointerMove: (event: any) => void;
+            onPointerUp: (event: any) => void;
+            /**
+                * We've confirmed that a map click has occured, so handle that here
+                */
+            handleMapClick(event: any): void;
+            onPointerDown: (event: any) => void;
+            incrementTouches: (event: any) => void;
+            decrementTouches: (event: any) => void;
+            clearMouse: () => void;
+            getMousePos: (event: any) => {
+                    x: any;
+                    y: any;
+            };
+            getScaledMousePos: (event: any) => {
+                    x: number;
+                    y: number;
+            };
+            cursorPos: {
+                    x: number;
+                    y: number;
+            };
+            mouse: {
+                    x: number;
+                    y: number;
+            };
+            mouseDownStart: {
+                    time: number;
+                    clientX: number;
+                    clientY: number;
+            };
+            scaledCursorPos: {
+                    x: number;
+                    y: number;
+            };
+            hasTouched: boolean;
+            calculateMouseCoordinates: (event: any) => void;
+            getMouseRayIntersects: (objects: Object3D | Object3D[]) => import("three").Intersection<Object3D<import("three").Object3DEventMap>>[];
+            detectCollidersUnderMouse: () => Collider[];
+            detectPolygonsUnderMouse: () => string[];
+            detectPathsUnderMouse: () => Path[];
+            detectWatermarkUnderMouse: () => boolean;
+            detectMapsUnderMouse: () => import("../../internal").MappedinMap[];
+            /**
+                * Gets mouse click position in x y map coordinates
+                */
+            getMouseMapPosition: () => {
+                    x: number;
+                    y: number;
+            };
+            checkMouseIntersectsBlueDot: () => boolean;
+            doHoverEffect: () => void;
+            onPolygonHoverOut: (polygonId: string) => boolean;
+            onPolygonHoverOver: (polygon: MappedinPolygon | string) => boolean;
+            setHoverColor: (color: string) => void;
+            destroy(): void;
     }
     export default EventSystem;
 }
@@ -10415,115 +10435,141 @@ declare module '@mappedin/react-native-sdk/sdks/packages/legacy-renderer/private
     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';
     enum ACTION {
-        enable = "enable",
-        disable = "disable",
-        showOverview = "showOverview",
-        zoomInToMap = "zoomInToMap",
-        scrollToMap = "scrollToMap"
+            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;
+            animate?: boolean;
     };
     export type TStackedMapsOptions = {
-        verticalDistanceBetweenMaps?: number;
-        mapLabels?: boolean;
+            /**
+                * 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;
     };
     class StackedMapsController {
-        #private;
-        options: TStackedMapsOptions;
-        enabled: boolean;
-        stackScene: MapViewStackScene;
-        directions: MappedinDirections | MappedinDirections[];
-        constructor(core: ICore);
-        needsUpdate: boolean;
-        currentState: STACKED_MAPS_STATE;
-        mapsInJourney: 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;
-        })[];
-        getEnableOptions: (params: TParams) => void;
-        getShowOverviewTransition: (options: any, inTransit?: boolean) => () => Promise<void>;
-        getZoomInToMapTransition: (options: any) => () => Promise<void>;
-        getScrollToMapTransition: (options: any, inTransit?: boolean) => () => Promise<void>;
-        getDisableTransition: (options: any) => () => Promise<void>;
-        getEnableTransition: () => () => void;
-        states: TState;
-        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 nodesInJourney(): MappedinNode[];
-        showOverview: () => Promise<void>;
-        scrollToMap: (map: MappedinMap) => 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;
 }
@@ -10551,7 +10597,7 @@ declare module '@mappedin/react-native-sdk/sdks/packages/legacy-renderer/private
             /**
                 * Exports the current scene as a GLTF file.
                 */
-            getCurrentSceneGLTF(userOptions: TGLTFExportOptions): Promise<Blob>;
+            getCurrentSceneGLTF: (userOptions: TGLTFExportOptions) => Promise<Blob>;
     }
 }
 
@@ -10575,6 +10621,7 @@ declare module '@mappedin/react-native-sdk/sdks/packages/legacy-renderer/private
                 */
             getVisibleLayersForLoadedMap(map: MappedinMap): string[];
             addGeoJSONLayer(layerName: string, featureOrFeatureCollection: Feature<Polygon, GeoJsonProperties | null> | FeatureCollection<Polygon, GeoJsonProperties | null>): Promise<void>;
+            removeGeoJSONLayer(layerName: string): Promise<void>;
     }
     export default LayerController;
 }
@@ -11913,6 +11960,26 @@ declare module '@mappedin/react-native-sdk/sdks/packages/legacy-renderer/public/
                 * @returns Promise when all animations are complete.
                 */
             zoomInToMap: (map: MappedinMap, cameraTransform?: TCameraTransform) => Promise<void>;
+            /**
+                * @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.
+                *
+                * @param options - Options to adjust the overview. Each option defaults to the setting passed in {@link enable}, unless provided.
+                *
+                * @example
+                * ```ts
+                * mapView.Journey.draw(...);
+                * mapView.StackedMaps.enable();
+                * mapView.StackedMaps.showOverview();
+                * mapView.Journey.clear();
+                * mapView.StackedMaps.restack();
+                * ```
+                *
+                * @returns Promise when all animations are complete.
+                */
+            restack: (options?: TStackedMapsOptions) => Promise<void>;
             /**
                 * @experimental
                 *
@@ -12077,6 +12144,12 @@ declare module '@mappedin/react-native-sdk/sdks/packages/legacy-renderer/public/
                 * Adds a GeoJSON Feature or FeatureCollection to the map as a layer. The layer name must be unique
                 */
             addGeoJSONLayer(layerName: string, featureOrFeatureCollection: Feature<Polygon, GeoJsonProperties | null> | FeatureCollection<Polygon, GeoJsonProperties | null>): Promise<void>;
+            /**
+                * @experimental
+                * Hides a GeoJSON layer from the map and removes it from the list of layers.
+                * It will not appear in {@link getAllLayersForMap} afterwards and can be overwritten by a new layer with the same name.
+                */
+            removeGeoJSONLayer(layerName: string): Promise<void>;
     }
     export default LayerController;
 }