@mappedin/react-native-sdk 4.1.0-beta.0 → 4.1.0-beta.1

package/dist/index.d.ts

@@ -27,6 +27,7 @@ declare module '@mappedin/react-native-sdk' {
     export type TLabelAllLocationCommonOptions = Omit<TLabelAllLocationCommonOptionsBase, 'sortFunction' | 'translationMap'>;
     export type { IDirectionsResult, MappedinDirections, TMappedinDirective } from '@mappedin/react-native-sdk/core/packages/renderer/index.rn';
     export type { TShowVenueOptions } from '@mappedin/react-native-sdk/core/packages/renderer/index.rn';
+    export { ERROR, ERROR_MESSAGES } from '@mappedin/react-native-sdk/wrappers/common/errors';
     export { E_GET_DIRECTIONS_MESSAGES, BEARING_TYPE, ACTION_TYPE, MappedinLocation, Mappedin, MappedinPolygon, MappedinNode, MappedinCategory, MappedinMap, MappedinEvent, MappedinMapGroup, MappedinVenue, MappedinVortex, MappedinRankings, MappedinDestinationSet } from '@mappedin/react-native-sdk/core/packages/renderer/index.rn';
 }
 
@@ -36,6 +37,7 @@ declare module '@mappedin/react-native-sdk/wrappers/react-native-sdk/src/MiMapVi
     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 { ERROR, ERROR_MESSAGES } from '@mappedin/react-native-sdk/wrappers/common/errors';
     export type TMiMapViewProps = {
             /**
                 * The MapViewStore instance will be returned here
@@ -100,6 +102,16 @@ declare module '@mappedin/react-native-sdk/wrappers/react-native-sdk/src/MiMapVi
             onStateChanged?: (prop: {
                     state: STATE;
             }) => void;
+            /**
+                * Called if an error occurs loading the venue map
+                */
+            onVenueLoadError?: (prop: {
+                    error: {
+                            name: ERROR;
+                            message: ERROR_MESSAGES;
+                            stack?: string;
+                    };
+            }) => void;
     };
     /**
         * Mappedin MapView component
@@ -108,7 +120,7 @@ declare module '@mappedin/react-native-sdk/wrappers/react-native-sdk/src/MiMapVi
     /**
         * @category Component
         */
-    export const MiMapView: React.MemoExoticComponent<React.ForwardRefExoticComponent<Pick<TMiMapViewProps, "options" | "style" | "onFirstMapLoaded" | "onDataLoaded" | "venueData" | "onPolygonClicked" | "onBlueDotStateChanged" | "onBlueDotPositionUpdated" | "onNothingClicked" | "onMapChanged" | "onStateChanged"> & React.RefAttributes<MapViewStore>>>;
+    export const MiMapView: React.MemoExoticComponent<React.ForwardRefExoticComponent<Pick<TMiMapViewProps, "options" | "style" | "onFirstMapLoaded" | "onDataLoaded" | "venueData" | "onPolygonClicked" | "onBlueDotStateChanged" | "onBlueDotPositionUpdated" | "onNothingClicked" | "onMapChanged" | "onStateChanged" | "onVenueLoadError"> & React.RefAttributes<MapViewStore>>>;
 }
 
 declare module '@mappedin/react-native-sdk/wrappers/react-native-sdk/src/MiMiniMap' {
@@ -116,6 +128,7 @@ declare module '@mappedin/react-native-sdk/wrappers/react-native-sdk/src/MiMiniM
     import { TMiMapViewOptions } from '@mappedin/react-native-sdk/wrappers/common';
     import { TFocusOnOptions } from '@mappedin/react-native-sdk/core/packages/renderer/index.rn';
     import type { MappedinLocation, Mappedin } from '@mappedin/react-native-sdk/core/packages/renderer/index.rn';
+    import { ERROR, ERROR_MESSAGES } from '@mappedin/react-native-sdk/wrappers/common/errors';
     export type TMiMiniMapProps = {
             /**
                 * Options to initialze MiMapView with
@@ -133,6 +146,16 @@ declare module '@mappedin/react-native-sdk/wrappers/react-native-sdk/src/MiMiniM
             venueData?: Mappedin;
             location: MappedinLocation['id'] | MappedinLocation;
             focusOptions?: TFocusOnOptions;
+            /**
+                * Called if there's an error loading the minimap
+                */
+            onMiniMapLoadError?: (prop: {
+                    error: {
+                            name: ERROR;
+                            message: ERROR_MESSAGES;
+                            stack?: string;
+                    };
+            }) => void;
     };
     /**
         * Mappedin MiniMap component
@@ -170,12 +193,12 @@ declare module '@mappedin/react-native-sdk/wrappers/react-native-sdk/src/MiMapVi
             /**
                 * @hidden
                 */
-            loadVenue(options: TGetVenueOptions, showVenueOptions: TShowVenueOptions): Promise<Mappedin | undefined>;
+            loadVenue(options: TGetVenueOptions, showVenueOptions: TShowVenueOptions): Promise<unknown>;
             /**
                 *
                 * @hidden
                 */
-            showVenue(venueData: Mappedin, showVenueOptions: TShowVenueOptions): Promise<void>;
+            showVenue(venueData: Mappedin, showVenueOptions: TShowVenueOptions): Promise<unknown>;
             /**
                 * Clear any cached venue bundles that were downloaded as part of LOAD_VENUE with useBundle: true
                 * This ensure that the next time keys are passed in, we get a fresh bundle
@@ -264,12 +287,12 @@ declare module '@mappedin/react-native-sdk/wrappers/react-native-sdk/src/MiMapVi
                         */
                     setTilt: (tilt: number) => Promise<undefined>;
                     /**
-                        * The current rotation in degrees from north.
+                        * The current rotation in radians from north.
                         * @deprecated Use CameraControls.rotation instead
                         */
                     rotation: number;
                     /**
-                        * @param rotation The new value to set the rotation to, in degrees from north..
+                        * @param rotation The new value to set the rotation to, in radians from north..
                         * @deprecated Use CameraControls.setRotation instead
                         */
                     setRotation: (rotation: number) => Promise<undefined>;
@@ -287,7 +310,7 @@ declare module '@mappedin/react-native-sdk/wrappers/react-native-sdk/src/MiMapVi
                         */
                     set: (positionOptions?: TAnimatePositionOptions | undefined) => Promise<unknown>;
                     /**
-                        * The current rotation in degrees from north.
+                        * The current rotation in radians from north.
                         */
                     rotation: number;
                     /**
@@ -393,6 +416,20 @@ declare module '@mappedin/react-native-sdk/wrappers/common' {
     export { PubSub } from '@mappedin/react-native-sdk/wrappers/common/pub-sub';
 }
 
+declare module '@mappedin/react-native-sdk/wrappers/common/errors' {
+    export enum ERROR {
+        LOAD_VENUE_FAILED = "LOAD_VENUE_FAILED",
+        SHOW_VENUE_FAILED = "SHOW_VENUE_FAILED",
+        SET_MAP_FAILED = "SET_MAP_FAILED",
+        SHOW_MINIMAP_ERROR = "SHOW_MINIMAP_ERROR",
+        LOAD_MINIMAP_ERROR = "LOAD_MINIMAP_ERROR"
+    }
+    export enum ERROR_MESSAGES {
+        GENERIC_LOAD_VENUE_ERROR = "Unable to load Venue. Please check your keys",
+        GENERIC_SET_MAP_ERROR = "Unable to set map, check that you're passing a valid map"
+    }
+}
+
 declare module '@mappedin/react-native-sdk/wrappers/react-native-sdk/src' {
     export { MiMapView } from '@mappedin/react-native-sdk/wrappers/react-native-sdk/src/MiMapView';
     export type { TMiMapViewProps } from '@mappedin/react-native-sdk/wrappers/react-native-sdk/src/MiMapView';
@@ -411,6 +448,7 @@ declare module '@mappedin/react-native-sdk/wrappers/react-native-sdk/src' {
     export type TLabelAllLocationCommonOptions = Omit<TLabelAllLocationCommonOptionsBase, 'sortFunction' | 'translationMap'>;
     export type { IDirectionsResult, MappedinDirections, TMappedinDirective } from '@mappedin/react-native-sdk/core/packages/renderer/index.rn';
     export type { TShowVenueOptions } from '@mappedin/react-native-sdk/core/packages/renderer/index.rn';
+    export { ERROR, ERROR_MESSAGES } from '@mappedin/react-native-sdk/wrappers/common/errors';
     export { E_GET_DIRECTIONS_MESSAGES, BEARING_TYPE, ACTION_TYPE, MappedinLocation, Mappedin, MappedinPolygon, MappedinNode, MappedinCategory, MappedinMap, MappedinEvent, MappedinMapGroup, MappedinVenue, MappedinVortex, MappedinRankings, MappedinDestinationSet } from '@mappedin/react-native-sdk/core/packages/renderer/index.rn';
 }
 
@@ -905,6 +943,13 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/MapView.types'
                 * The rank of the object used when comparing colliders to determine which should be shown.
                 */
             collisionRank?: COLLISION_RANKING_TIERS;
+            /**
+                * By default, we don't hide tooltips when they collide. This is
+                * so that for floor switching tooltips we don't lose where the elevator is
+                * This option will override that behavior
+                * @default true
+                */
+            alwaysVisible?: boolean;
     };
     export type TCreateTextTooltipOptions = TCreateTooltipCommonOptions & {
             /**
@@ -3092,7 +3137,7 @@ declare module '@mappedin/react-native-sdk/core/packages/get-venue/MappedinMap'
             createCoordinate(lat: number, lon: number): MappedinCoordinate;
             /**
                 *
-                * @returns map rotation in degrees from North
+                * @returns map rotation in radians from north
                 */
             getNorth(): any;
             static hydrate(maps: any, mappedin: Mappedin): MappedinMap[];
@@ -3776,7 +3821,7 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappe
             get strategies(): TColliderStrategy[];
             getCachedSymbol(orientation: any, textAlign: any, xCoordinate: any): any;
             colliderDidMount(): void;
-            colliderDidUpdatePosition(x: any, y: any): void;
+            colliderDidUpdatePosition(pos: any): void;
             setPriority(priority: any): void;
             colliderDidUpdateVisiblity(): void;
             colliderDidGoOutsideGrid(): void;
@@ -3998,6 +4043,7 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappe
         selector?: string;
         map: string;
         padding?: number;
+        alwaysVisible?: boolean;
         collisionRank?: COLLISION_RANKING_TIERS;
         defaultAnchorType?: string;
         enabledAnchorTypes?: {
@@ -4019,6 +4065,7 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappe
         bottomRight?: boolean;
     };
     class SmartTooltip extends HTMLCollider implements IHTMLCollider {
+        #private;
         className: string;
         _el: Element | null;
         style: TTooltipStyle;
@@ -4027,7 +4074,6 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappe
         get strategies(): TColliderStrategy[];
         colliderDidMount(): void;
         setAction(action: any): void;
-        updateDimensions(): void;
         colliderDidNotFindAHome(): void;
         colliderDidGoOffscreen(): void;
         colliderDidUpdateVisiblity(): void;
@@ -4680,6 +4726,19 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/MapView' {
                 * @param polygon The Polygon you want the primary Location of.
                 */
             getPrimaryLocationForPolygon(polygon: MappedinPolygon): MappedinLocation;
+            /**
+                * Finds all polygons that contain the specified MappedinCoordinate. If multiple
+                * polygons are stacked on top of each other, the array of polygons returned will be
+                * in the order of top to bottom.
+                *
+                * By default, this only considers interactive polygons.
+                *
+                * @param coordinate The MappedinCoordinate to check
+                * @param includeNonInteractive Specifies if all polygons should be included rather
+                * than just interactive polygons.
+                * @returns MappedinPolygon[]
+                */
+            getPolygonsAtCoordinate(coordinate: MappedinCoordinate, includeNonInteractive?: boolean): MappedinPolygon[];
             /**
                 * Destroy instance and clean up memory
                 */
@@ -4792,7 +4851,7 @@ declare module '@mappedin/react-native-sdk/core/packages/get-venue/MappedinTheme
 }
 
 declare module '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappedin.SmartCollider' {
-    import { ISmartCollisionEngine } from '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappedin.SmartCollisionEngine';
+    import SmartCollisionEngine from '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappedin.SmartCollisionEngine';
     import { Vector3 } from 'three';
     export type TRange = [number, number, number, number];
     type TCustomCollider<T> = ICollider & T;
@@ -4829,7 +4888,7 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappe
         setAction: (action: EColliderAction) => void;
         action?: EColliderAction;
         position: Vector3;
-        __engine?: ISmartCollisionEngine;
+        __engine?: SmartCollisionEngine;
         enable: () => void;
         disable: () => void;
         enabled: boolean;
@@ -4843,7 +4902,7 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappe
         colliderDidGoOffscreen?: () => void;
         colliderDidGoOutsideGrid?: () => void;
         colliderDidUpdateVisiblity?: () => void;
-        colliderDidUpdatePosition?: (x: number, y: number) => void;
+        colliderDidUpdatePosition?: (prop: [x: number, y: number]) => void;
     }
     class BaseCollider implements ICollider {
         __engine: any;
@@ -4873,7 +4932,7 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappe
         removeSelf(): void;
         enable(): void;
         disable(): void;
-        colliderDidUpdatePosition(x: any, y: any): void;
+        colliderDidUpdatePosition(pos: any): void;
         colliderDidNotFindAHome(): void;
         colliderDidMount(): void;
         colliderDidUpdateVisiblity(): void;
@@ -5096,6 +5155,7 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappe
         contentEl: any;
     }
     class HTMLCollider extends BaseCollider {
+        #private;
         contentEl: any;
         containerEl: any;
         removeSelf(): void;
@@ -5103,7 +5163,12 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappe
         disable(): void;
         colliderDidGoOffscreen(): void;
         colliderDidNotFindAHome(): void;
-        colliderDidUpdatePosition(x: any, y: any): void;
+        colliderDidUpdatePosition(pos: any): void;
+        updateDimensions(): void;
+        /**
+          * @internal
+          */
+        updateDimensionsImmediately(): void;
         colliderDidMount(): void;
         colliderDidUpdateVisiblity(): void;
     }
@@ -5338,7 +5403,6 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappe
         get strategies(): TColliderStrategy[];
         colliderDidMount(): void;
         setAction(action: any): void;
-        updateDimensions(): void;
         colliderDidGoOffscreen(): void;
         colliderDidUpdateVisiblity(): void;
     }
@@ -5572,27 +5636,55 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappe
 declare module '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappedin.SmartCollisionEngine' {
     import { Vector3 } from 'three';
     import './Mappedin.SmartCollisionEngine.scss';
-    import { ICollider } from '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappedin.SmartCollider';
+    import { ICollider, TRange } from '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappedin.SmartCollider';
+    import { MappedinMap, MapView } from '@mappedin/react-native-sdk/core/packages/renderer';
     export const COLLIDER_STRATEGY_LOW_PRIORITY = "LOW_PRIORITY";
-    type TProjectFn = ({ position, mapId }: {
-        position: Vector3;
-        mapId: string;
-    }) => [number, number];
-    export interface ISmartCollisionEngine {
-        add: (colliderId: string, collider: ICollider) => void;
-        remove: (colliderId: string) => void;
-        init: (container: HTMLElement, projectFn: TProjectFn) => void;
-        resize: (container: HTMLElement) => void;
-        resort: () => void;
-        updatePosition: () => void;
-        updateVisibility: () => void;
-        makeCollidersDirty: () => void;
-        update: () => void;
-        destroy: () => void;
-        makeCollidersDirtyThrottled: (time: number) => void;
-        _makeCollidersDirtyThrottled?: [() => void, number];
+    class SmartCollisionEngine {
+            #private;
+            _makeCollidersDirtyThrottled: any;
+            colliderCanvas: HTMLCanvasElement;
+            debugCanvas: HTMLCanvasElement;
+            colliderCanvasContext: CanvasRenderingContext2D;
+            debugCanvasContext: CanvasRenderingContext2D;
+            collisionEngineContainerEl: HTMLDivElement;
+            stepsX: any;
+            stepsY: any;
+            totalWidth: any;
+            totalHeight: any;
+            project: any;
+            grid: Uint8Array;
+            colliders: Map<string, ICollider>;
+            offscreenRanges: TRange[];
+            get sortedColliders(): ICollider[];
+            initialized: boolean;
+            mapView: MapView;
+            constructor(mapView: any);
+            init: (container: HTMLDivElement, projectFn: ({ position, mapId }: {
+                    position: Vector3;
+                    mapId: MappedinMap['id'];
+            }) => {
+                    x: number;
+                    y: number;
+            }) => void;
+            updatePosition: () => void;
+            updateVisibility: () => void;
+            add: (colliderId: string, collider: ICollider) => void;
+            remove: (colliderId: string) => void;
+            /**
+                * When adding/removing new colliders, or when updating their priorty, we need to make all colliders around them as "dirty",
+                * so they can be reconcilded correctly
+                */
+            makeCollidersDirty: () => void;
+            /**
+                * Allow to throttle making collders dirty. This is useful for things like BlueDot follow mode,
+                * As we follow the BlueDot, colliders will overlap, but constantly updating their visiblity makes
+                * for a bad experience
+                */
+            makeCollidersDirtyThrottled: (time: any) => void;
+            resize: (container: any) => void;
+            update: () => void;
+            destroy: () => void;
     }
-    const SmartCollisionEngine: () => ISmartCollisionEngine;
     export default SmartCollisionEngine;
 }