@mappedin/react-native-sdk 4.0.10 → 4.0.13

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, "venueData" | "options" | "style" | "onPolygonClicked" | "onBlueDotStateChanged" | "onBlueDotPositionUpdated" | "onDataLoaded" | "onNothingClicked" | "onFirstMapLoaded" | "onMapChanged" | "onStateChanged"> & React.RefAttributes<MapViewStore>>>;
+    export const MiMapView: React.MemoExoticComponent<React.ForwardRefExoticComponent<Pick<TMiMapViewProps, "onFirstMapLoaded" | "onDataLoaded" | "venueData" | "options" | "style" | "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
@@ -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';
 }
 
@@ -4680,6 +4718,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
                 */