@mappedin/react-native-sdk 5.0.0 → 5.0.2

package/README.md

@@ -38,14 +38,13 @@ const MiMapView = (props: TMapViewProps) => React.ReactElement;
 | ----------------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | -------- |
 | options                       | Options to initialize MapView with                                            | <a href="modules.html#tmimapviewoptions">`TMiMapViewOptions`<a>                                  | Yes      |
 | ref                           | Exposes Imperative API <a href="classes/mapviewstore.html">`MapViewStore`</a> | React.MutableRefObject<<a href="classes/mapviewstore.html">`MapViewStore`</a>\>                  | No       |
-| onPolygonClicked              | Gets called when clicking interactive polygon                                 | ({ polygon: <a href="classes/mappedinpolygon.html">`MappedinPolygon`</a> }) => void              | No       |
 | onDataLoaded                  | Fired when <a href="classes/mappedin.html">`Mappedin`</a> data is loaded      | ({ venueData: <a href="classes/mappedin.html">`Mappedin`</a> }) => void                          | No       |
 | onFirstMapLoaded              | Fires when map can first be interacted with                                   | () => void                                                                                       | No       |
 | onBlueDotStateChanged         | Fires when BlueDot state changes                                              | ({ stateChange: <a href="modules.html#tbluedotstatechange">`TBlueDotStateChange`</a> }) => void  | No       |
 | onBlueDotPositionUpdated      | Fires when BlueDot position changes                                           | ({ update: <a href="modules.html#tbluedotpositionupdate">`TBlueDotPositionUpdate`</a> }) => void | No       |
 | onCameraChanged               | Fires when Camera position, tilt, zoom or rotation changes                    | ({ change: <a href="modules.html#TCameraChange">`TCameraChange`</a> }) => void                   | No       |
 | onStateChanged                | Fires when SDK State changes                                                  | ({ state: <a href="enums/state.html">`STATE`</a> }) => void                                      | No       |
-
+| onClick                       | Fires when clicking within the mapView                                        | (prop: <a href="modules.html#TMapClickEvent">TMapClickEvent</a> ) => void
 ### Imperative API
 
 <a href="classes/mapviewstore.html">Documented in Detail here: MapViewStore</a>

package/dist/index.d.ts

@@ -15,7 +15,7 @@ declare module '@mappedin/react-native-sdk' {
     export type { TMiMiniMapProps } from '@mappedin/react-native-sdk/wrappers/react-native-sdk/src/MiMiniMap';
     export type { MapViewStore } from '@mappedin/react-native-sdk/wrappers/react-native-sdk/src/MiMapView.store';
     export { getVenue, getVenueBundle } from '@mappedin/react-native-sdk/core/packages/renderer/index.rn';
-    export type { TGetVenueOptions, TGetVenueBundleOptions, TMappedinOfflineSearchResult, TMappedinOfflineSearchSuggestions, TMappedinOfflineSearchOptions, TMappedinOfflineSearchAllOptions, TMappedinOfflineAllSearchMatch } from '@mappedin/react-native-sdk/core/packages/renderer/index.rn';
+    export type { TGetVenueOptions, TGetVenueBundleOptions, TMappedinOfflineSearchResult, TMappedinOfflineSearchSuggestions, TMappedinOfflineSearchOptions, TMappedinOfflineSearchAllOptions, TMappedinOfflineAllSearchMatch, TMapClickEvent } from '@mappedin/react-native-sdk/core/packages/renderer/index.rn';
     export { STATE } from '@mappedin/react-native-sdk/core/packages/renderer/index.rn';
     export { COLLISION_RANKING_TIERS, MARKER_ANCHOR, E_BLUEDOT_STATE, MappedinCoordinate, labelThemes, E_BLUEDOT_MARKER_STATE, E_BLUEDOT_STATE_REASON, MAP_RENDER_MODE } from '@mappedin/react-native-sdk/core/packages/renderer/index.rn';
     export type { TSerializableJourneyOptions, TMiMapViewOptions } from '@mappedin/react-native-sdk/wrappers/common';
@@ -37,7 +37,7 @@ declare module '@mappedin/react-native-sdk/wrappers/react-native-sdk/src/MiMapVi
     import { TMiMapViewOptions } from '@mappedin/react-native-sdk/wrappers/common';
     import { STATE } from '@mappedin/react-native-sdk/wrappers/react-native-sdk/src';
     import { MapViewStore } from '@mappedin/react-native-sdk/wrappers/react-native-sdk/src/MiMapView.store';
-    import type { TBlueDotPositionUpdate, TBlueDotStateChange, MappedinPolygon, MappedinMap, Mappedin } from '@mappedin/react-native-sdk/core/packages/renderer/index.rn';
+    import type { TBlueDotPositionUpdate, TBlueDotStateChange, TMapClickEvent, MappedinPolygon, MappedinMap, Mappedin } from '@mappedin/react-native-sdk/core/packages/renderer/index.rn';
     import { ERROR, ERROR_MESSAGES } from '@mappedin/react-native-sdk/wrappers/common/errors';
     import { TCameraChange, TMapViewRNOptions } from '@mappedin/react-native-sdk/wrappers/react-native-sdk/src/MiMapView.store.types';
     export type TMiMapViewProps = {
@@ -93,14 +93,7 @@ declare module '@mappedin/react-native-sdk/wrappers/react-native-sdk/src/MiMapVi
             /**
                 * Called when the map is clicked. Payload contains the lat-lon of the click event, an array of interactive polygons that were clicked, and a flag indicating whether the click is likely above the blue dot.
                 */
-            onClick?: (prop: {
-                    position: {
-                            latitude: number;
-                            longitude: number;
-                    };
-                    polygons: MappedinPolygon[];
-                    nearBlueDot: boolean;
-            }) => void;
+            onClick?: (prop: TMapClickEvent) => void;
             /**
                 * Called when the map is ready for interaction
                 */
@@ -403,12 +396,16 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/index.rn' {
     import { getVenue, getVenueBundle, Mappedin, MappedinDestinationSet } from '@mappedin/react-native-sdk/core/packages/get-venue';
     import { randomId } from '@mappedin/react-native-sdk/core/common/random-id';
     export * from '@mappedin/react-native-sdk/core/packages/renderer/MapView.enums';
-    export { getVenue, getVenueBundle, MappedinDestinationSet, Mappedin, randomId };
+    export { getVenue, 
+    /**
+      * @deprecated
+      */
+    getVenueBundle, MappedinDestinationSet, Mappedin, randomId };
     export { GEOLOCATION_STATUS, COLLISION_RANKING_TIERS, E_BLUEDOT_STATE_REASON, E_BLUEDOT_STATE, E_BLUEDOT_MARKER_STATE, STATE, MARKER_ANCHOR, E_SDK_EVENT, E_BLUEDOT_EVENT, E_CAMERA_EVENT, E_CAMERA_DIRECTION, SAFE_AREA_INSET_TYPE, ANIMATION_TWEENS, CAMERA_EASING_MODE } from '@mappedin/react-native-sdk/core/packages/renderer/MapView.enums';
     export { labelThemes } from '@mappedin/react-native-sdk/core/packages/renderer/MapView.types';
     export type { IFlatLabels } from '@mappedin/react-native-sdk/core/packages/renderer/MapView.FlatLabels';
     export type { IFloatingLabels } from '@mappedin/react-native-sdk/core/packages/renderer/MapView.FloatingLabels';
-    export type { TBlueDotPositionUpdate, TBlueDotStateChange, TJourneyOptions, TMapViewOptions, TCreateMarkerOptions, TGeolocationObject, TPathOptions, TFlatLabelOptions, TAddFloatingLabelOptions, TAddFlatLabelOptions, TLabelAllLocationCommonOptions, TFloatingLabelAllLocationsOptions, TFlatLabelAllLocationsOptions, TLabelAllLocationFlatLabelOptions, TLabelAllLocationFloatingLabelOptions, TEnableBlueDotOptions, TFloatingLabelAppearance, TFlatLabelAppearance, CAMERA_EVENT_PAYLOAD, TGetPolygonsAtCoordinateOptions } from '@mappedin/react-native-sdk/core/packages/renderer/MapView.types';
+    export type { TBlueDotPositionUpdate, TBlueDotStateChange, TJourneyOptions, TMapViewOptions, TCreateMarkerOptions, TGeolocationObject, TPathOptions, TFlatLabelOptions, TAddFloatingLabelOptions, TAddFlatLabelOptions, TLabelAllLocationCommonOptions, TFloatingLabelAllLocationsOptions, TFlatLabelAllLocationsOptions, TLabelAllLocationFlatLabelOptions, TLabelAllLocationFloatingLabelOptions, TEnableBlueDotOptions, TFloatingLabelAppearance, TFlatLabelAppearance, CAMERA_EVENT_PAYLOAD, TMapClickEvent, TGetPolygonsAtCoordinateOptions } from '@mappedin/react-native-sdk/core/packages/renderer/MapView.types';
     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 { TGetVenueBundleOptions, TGetVenueOptions, TMappedinDirective, TShowVenueOptions, TMappedinOfflineSearchOptions, TMappedinOfflineSearchResult, TMappedinOfflineSearchSuggestions, TMappedinOfflineSearchAllOptions, TMappedinOfflineAllSearchMatch } from '@mappedin/react-native-sdk/core/packages/get-venue';
@@ -515,7 +512,7 @@ declare module '@mappedin/react-native-sdk/wrappers/react-native-sdk/src' {
     export type { TMiMiniMapProps } from '@mappedin/react-native-sdk/wrappers/react-native-sdk/src/MiMiniMap';
     export type { MapViewStore } from '@mappedin/react-native-sdk/wrappers/react-native-sdk/src/MiMapView.store';
     export { getVenue, getVenueBundle } from '@mappedin/react-native-sdk/core/packages/renderer/index.rn';
-    export type { TGetVenueOptions, TGetVenueBundleOptions, TMappedinOfflineSearchResult, TMappedinOfflineSearchSuggestions, TMappedinOfflineSearchOptions, TMappedinOfflineSearchAllOptions, TMappedinOfflineAllSearchMatch } from '@mappedin/react-native-sdk/core/packages/renderer/index.rn';
+    export type { TGetVenueOptions, TGetVenueBundleOptions, TMappedinOfflineSearchResult, TMappedinOfflineSearchSuggestions, TMappedinOfflineSearchOptions, TMappedinOfflineSearchAllOptions, TMappedinOfflineAllSearchMatch, TMapClickEvent } from '@mappedin/react-native-sdk/core/packages/renderer/index.rn';
     export { STATE } from '@mappedin/react-native-sdk/core/packages/renderer/index.rn';
     export { COLLISION_RANKING_TIERS, MARKER_ANCHOR, E_BLUEDOT_STATE, MappedinCoordinate, labelThemes, E_BLUEDOT_MARKER_STATE, E_BLUEDOT_STATE_REASON, MAP_RENDER_MODE } from '@mappedin/react-native-sdk/core/packages/renderer/index.rn';
     export type { TSerializableJourneyOptions, TMiMapViewOptions } from '@mappedin/react-native-sdk/wrappers/common';
@@ -1164,8 +1161,6 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/MapView.types'
     };
     export type { default as BlueDotLayer } from '@mappedin/react-native-sdk/core/packages/renderer/layers/BlueDot';
     export type { default as JourneyLayer } from '@mappedin/react-native-sdk/core/packages/renderer/layers/Journey';
-    export type { FlatLabel as TFlatLabel } from '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappedin.LabelAtlas';
-    export type { default as TFloatingLabel } from '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappedin.FloatingLabel';
 }
 
 declare module '@mappedin/react-native-sdk/core/packages/get-venue' {
@@ -1262,7 +1257,8 @@ declare module '@mappedin/react-native-sdk/core/packages/get-venue' {
             shouldPopulateBundledImagesAsBlobs?: boolean;
     };
     /**
-        * [experimental] Fetching an offline Venue bundle
+        * @deprecated
+        * 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.
@@ -1316,10 +1312,15 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/MapView.enums'
             SUCCESS = 0
     }
     export enum COLLISION_RANKING_TIERS {
+            /** @internal */
             OPTIONAL_MINIMUM = 0,
+            /** @internal */
             OPTIONAL_MAXIMUM = 1,
             MEDIUM = 2,
             HIGH = 3,
+            /**
+                * Always display collider, regardless of collisions
+                */
             ALWAYS_VISIBLE = 4
     }
     export enum E_BLUEDOT_STATE_REASON {
@@ -1434,7 +1435,13 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/MapView.enums'
             MAP_CHANGED = "MAP_CHANGED"
     }
     export enum E_BLUEDOT_EVENT {
+            /**
+                * Emitted when the BlueDot position changes
+                */
             POSITION_UPDATE = "POSITION_UPDATE",
+            /**
+                * Emitted when the BlueDot state changes
+                */
             STATE_CHANGE = "STATE_CHANGE"
     }
     export enum E_CAMERA_EVENT {
@@ -1617,8 +1624,17 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/Camera' {
             safeAreaInsets?: TSafeAreaInsets;
     };
     export type TCameraTransform = {
+            /**
+                * Zoom = distance in meters from Camera to target
+                */
             zoom?: number;
+            /**
+                * Tilt in radians
+                */
             tilt?: number;
+            /**
+                * Rotation in radians from north
+                */
             rotation?: number;
             position?: MappedinCoordinate | MappedinNode;
     };
@@ -3551,76 +3567,6 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/layers/Journey
     export default JourneyLayer;
 }
 
-declare module '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappedin.LabelAtlas' {
-    export namespace DEFAULT_LABEL_SIZING {
-        const MARGIN: number;
-        const HEIGHT_MARGIN: number;
-        const SIZE: number;
-    }
-    export class Atlas {
-        layers: any[];
-        canvas: HTMLCanvasElement;
-        context: CanvasRenderingContext2D | null;
-        addLabel(map: any, lines: any, font: any, size: any, scope: any, pixelsPerScale: any): Label | undefined;
-        removeLayer(layer: any): void;
-        measure(text: any, font: any, size: any): TextMetrics;
-        onWebGLContextRestored(): void;
-        dispose(): void;
-    }
-    export class FlatLabel {
-        constructor(options: any, venue: any, mapObject: any, DEFAULT_FONT: any, polygonMeshesById: any, textLabelsByPolygonId: any, mapView: any, scope: any, atlas: any);
-        id: any;
-        text: any;
-        stateText: string;
-        fullText: any;
-        font: any;
-        atlas: any;
-        canvasBounds: any;
-        mapScale: any;
-        margin: number;
-        heightMargin: number;
-        scaleMin: any;
-        scaleStep: any;
-        multiline: any;
-        height: number | null;
-        polygonMeshesById: any;
-        polyId: any;
-        map: any;
-        color: any;
-        baseColor: any;
-        hideOnCreate: boolean;
-        hoverLabelText: any;
-        fontSize: number;
-        hoverLabelMode: any;
-        hoverLabelClass: any;
-        showHoverLabel: boolean;
-        hoverIfLabelFails: boolean;
-        textLabelsByPolygonId: any;
-        create(): void;
-        invalid: boolean | undefined;
-        label: any;
-        created: boolean | undefined;
-        flipIfNeeded(cameraAngle: any): void;
-        removeSelf(bulk: any): void;
-        doNotCreate: boolean | undefined;
-        setColor(textColor: any): void;
-        clearColor(): void;
-        hide(): void;
-        show(): void;
-        toString(): any;
-    }
-    class Label {
-        x: number;
-        y: number;
-        width: number;
-        height: number;
-        layer: any;
-        index: any;
-        layout(map: any, origin: any, size: any, rotation: any, uv: any, color: any): void;
-    }
-    export {};
-}
-
 declare module '@mappedin/react-native-sdk/core/packages/get-venue/Mappedin.types' {
     export type TGetVenueOptions = {
             accessToken?: string;
@@ -5405,7 +5351,7 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/internal/pub-s
             on<EVENT_NAME extends EVENT>(eventName: EVENT_NAME, fn: (payload: EVENT_PAYLOAD[EVENT_NAME] extends {
                     data: null;
             } ? EVENT_PAYLOAD[EVENT_NAME]['data'] : EVENT_PAYLOAD[EVENT_NAME]) => void): void;
-            off<EVENT_NAME extends keyof EVENT_PAYLOAD>(eventName: EVENT_NAME, fn: (payload: EVENT_PAYLOAD[EVENT_NAME]) => void): void;
+            off<EVENT_NAME extends EVENT>(eventName: EVENT_NAME, fn: (payload: EVENT_PAYLOAD[EVENT_NAME]) => void): void;
             /**
                 * @private
                 */
@@ -5450,16 +5396,22 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer' {
     export { COLLISION_RANKING_TIERS, STATE, E_SDK_EVENT, E_BLUEDOT_STATE_REASON, E_BLUEDOT_MARKER_STATE, E_BLUEDOT_EVENT, E_BLUEDOT_STATE, E_CAMERA_EVENT, E_CAMERA_DIRECTION, SAFE_AREA_INSET_TYPE, ANIMATION_TWEENS, CAMERA_EASING_MODE } from '@mappedin/react-native-sdk/core/packages/renderer/MapView.enums';
     export { getVenue, getVenueBundle, showVenue, downloadBundle, getVenueBundleURL, downloadVenueBundleMVF, PositionUpdater, MappedinDestinationSet, MARKER_ANCHOR, labelThemes };
     import DefaultAssetManager from '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappedin.AssetManager';
+    /**
+        * @internal
+        */
     const setAssetManager: <T extends DefaultAssetManager>(am: T) => void;
+    export { 
     /**
         * @internal
         */
-    export { setAssetManager, DefaultAssetManager as AssetManager };
+    setAssetManager, 
+    /**
+        * @internal
+        */
+    DefaultAssetManager as AssetManager };
     export type { TMappedinDirective } from '@mappedin/react-native-sdk/core/packages/get-venue/MappedinDirections';
     export type { TMapViewOptions, TMappedinInitializeOptions, TJourneyOptions };
     export type { TBlueDotPositionUpdate, TBlueDotStateChange, TEnableBlueDotOptions } from '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappedin.BlueDot/Mappedin.BlueDot.core';
-    import FloatingLabel from '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappedin.FloatingLabel';
-    export type { FloatingLabel };
     export * from '@mappedin/react-native-sdk/core/packages/renderer/MapView.types';
     export type { MapView } from '@mappedin/react-native-sdk/core/packages/renderer/MapView';
     export type { TSafeAreaInsets, TCameraTargets, TFocusOnCameraOptions, TCameraTransform, TCameraAnimationOptions, default as Camera } from '@mappedin/react-native-sdk/core/packages/renderer/Camera';
@@ -6596,6 +6548,76 @@ declare module '@mappedin/react-native-sdk/core/packages/get-venue/Mappedin.Anal
     export default Analytics;
 }
 
+declare module '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappedin.LabelAtlas' {
+    export namespace DEFAULT_LABEL_SIZING {
+        const MARGIN: number;
+        const HEIGHT_MARGIN: number;
+        const SIZE: number;
+    }
+    export class Atlas {
+        layers: any[];
+        canvas: HTMLCanvasElement;
+        context: CanvasRenderingContext2D | null;
+        addLabel(map: any, lines: any, font: any, size: any, scope: any, pixelsPerScale: any): Label | undefined;
+        removeLayer(layer: any): void;
+        measure(text: any, font: any, size: any): TextMetrics;
+        onWebGLContextRestored(): void;
+        dispose(): void;
+    }
+    export class FlatLabel {
+        constructor(options: any, venue: any, mapObject: any, DEFAULT_FONT: any, polygonMeshesById: any, textLabelsByPolygonId: any, mapView: any, scope: any, atlas: any);
+        id: any;
+        text: any;
+        stateText: string;
+        fullText: any;
+        font: any;
+        atlas: any;
+        canvasBounds: any;
+        mapScale: any;
+        margin: number;
+        heightMargin: number;
+        scaleMin: any;
+        scaleStep: any;
+        multiline: any;
+        height: number | null;
+        polygonMeshesById: any;
+        polyId: any;
+        map: any;
+        color: any;
+        baseColor: any;
+        hideOnCreate: boolean;
+        hoverLabelText: any;
+        fontSize: number;
+        hoverLabelMode: any;
+        hoverLabelClass: any;
+        showHoverLabel: boolean;
+        hoverIfLabelFails: boolean;
+        textLabelsByPolygonId: any;
+        create(): void;
+        invalid: boolean | undefined;
+        label: any;
+        created: boolean | undefined;
+        flipIfNeeded(cameraAngle: any): void;
+        removeSelf(bulk: any): void;
+        doNotCreate: boolean | undefined;
+        setColor(textColor: any): void;
+        clearColor(): void;
+        hide(): void;
+        show(): void;
+        toString(): any;
+    }
+    class Label {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+        layer: any;
+        index: any;
+        layout(map: any, origin: any, size: any, rotation: any, uv: any, color: any): void;
+    }
+    export {};
+}
+
 declare module '@mappedin/react-native-sdk/core/packages/navigator/Edge' {
     import INode from '@mappedin/react-native-sdk/core/packages/navigator/interfaces/INode';
     import IVortex from '@mappedin/react-native-sdk/core/packages/navigator/interfaces/IVortex';