@rnmapbox/maps 10.0.0-beta.78 → 10.0.0-beta.79

package/src/components/MapView.tsx

@@ -25,12 +25,19 @@ import { type Position } from '../types/Position';
 
 import NativeBridgeComponent from './NativeBridgeComponent';
 
-const MapboxGL = NativeModules.MGLModule;
-if (MapboxGL == null) {
+const { MGLModule } = NativeModules;
+const { EventTypes } = MGLModule;
+
+if (MGLModule == null) {
   console.error(
     'Native part of Mapbox React Native libraries were not registered properly, double check our native installation guides.',
   );
 }
+if (!MGLModule.MapboxV10) {
+  console.warn(
+    '@rnmapbox/maps: Non v10 implementations are deprecated and will be removed in next version - see https://github.com/rnmapbox/maps/wiki/Deprecated-RNMapboxImpl-Maplibre',
+  );
+}
 
 export const NATIVE_MODULE_NAME = 'RCTMGLMapView';
 
@@ -40,7 +47,7 @@ const styles = StyleSheet.create({
   matchParent: { flex: 1 },
 });
 
-const defaultStyleURL = MapboxGL.StyleURL.Street;
+const defaultStyleURL = MGLModule.StyleURL.Street;
 
 export type Point = {
   x: number;
@@ -59,7 +66,7 @@ export type RegionPayload = {
 };
 
 /**
- * v10 only - experimental
+ * v10 only
  */
 export type MapState = {
   properties: {
@@ -74,19 +81,20 @@ export type MapState = {
   };
   gestures: {
     isGestureActive: boolean;
-    isAnimatingFromGesture: boolean;
   };
 };
 
 /**
- * label localization settings (v10 only)
+ * label localization settings (v10 only). `true` is equivalent to current locale.
  */
-type LocalizeLabels = {
-  /** locale code like `es` or `current` for the device's current locale */
-  locale: string;
-  /** layer id to localize. If not specified, all layers will be localized */
-  layerIds?: string[];
-};
+type LocalizeLabels =
+  | {
+      /** locale code like `es` or `current` for the device's current locale */
+      locale: string;
+      /** layer id to localize. If not specified, all layers will be localized */
+      layerIds?: string[];
+    }
+  | true;
 
 type Props = ViewProps & {
   /**
@@ -100,7 +108,7 @@ type Props = ViewProps & {
   projection?: 'mercator' | 'globe';
 
   /**
-   * Style URL for map - notice, if non is set it _will_ default to `MapboxGL.StyleURL.Street`
+   * Style URL for map - notice, if non is set it _will_ default to `Mapbox.StyleURL.Street`
    */
   styleURL?: string;
 
@@ -266,12 +274,12 @@ type Props = ViewProps & {
   ) => void;
 
   /**
-   * iOS, v10 only, deprecated will be removed in next version - please use onRegionIsChanging.
+   * v10 only, replaces onRegionIsChanging
    */
   onCameraChanged?: (state: MapState) => void;
 
   /**
-   * iOS, v10 only, deprecated will be removed in next version - please use onRegionDidChange
+   * v10 only, replaces onRegionDidChange
    */
   onMapIdle?: (state: MapState) => void;
 
@@ -467,12 +475,12 @@ class MapView extends NativeBridgeComponent(
   }
 
   _setHandledMapChangedEvents(props: Props) {
-    if (isAndroid() || MapboxGL.MapboxV10) {
+    if (isAndroid() || MGLModule.MapboxV10) {
       const events: string[] = [];
 
       function addIfHasHandler(name: CallbablePropKeysWithoutOn) {
         if (props[`on${name}`] != null) {
-          if (MapboxGL.EventTypes[name] == null) {
+          if (EventTypes[name] == null) {
             if (name === 'DidFailLoadingMap') {
               console.warn(
                 `rnmapbox maps: on${name} is deprecated, please use onMapLoadingError`,
@@ -481,7 +489,7 @@ class MapView extends NativeBridgeComponent(
               console.warn(`rnmapbox maps: ${name} is not supported`);
             }
           } else {
-            events.push(MapboxGL.EventTypes[name]);
+            events.push(EventTypes[name]);
             return true;
           }
         }
@@ -504,9 +512,9 @@ class MapView extends NativeBridgeComponent(
       addIfHasHandler('DidFinishRenderingMapFully');
       addIfHasHandler('DidFinishLoadingStyle');
 
-      if (addIfHasHandler('MapIdle')) {
+      if (addIfHasHandler('RegionDidChange')) {
         console.warn(
-          'onMapIdle is deprecated and will be removed in next beta - please use onRegionDidChange',
+          'onRegionDidChange is deprecated and will be removed in next beta - please use onMapIdle',
         );
         if (props.onRegionDidChange) {
           console.warn(
@@ -514,11 +522,11 @@ class MapView extends NativeBridgeComponent(
           );
         }
       }
-      if (addIfHasHandler('CameraChanged')) {
+      if (addIfHasHandler('RegionIsChanging')) {
         console.warn(
-          'onCameraChanged is deprecated and will be removed in next beta - please use onRegionIsChanging',
+          'onRegionIsChanging is deprecated and will be removed in next beta - please use onCameraChanged',
         );
-        if (props.onRegionIsChanging) {
+        if (props.onCameraChanged) {
           console.warn(
             'rnmapbox/maps: only one of MapView.onRegionIsChanging or onCameraChanged is supported',
           );
@@ -639,7 +647,7 @@ class MapView extends NativeBridgeComponent(
   ): Promise<GeoJSON.FeatureCollection | undefined> {
     if (
       bbox != null &&
-      (bbox.length === 4 || (MapboxGL.MapboxV10 && bbox.length === 0))
+      (bbox.length === 4 || (MGLModule.MapboxV10 && bbox.length === 0))
     ) {
       const res = await this._runNative<{ data: GeoJSON.FeatureCollection }>(
         'queryRenderedFeaturesInRect',
@@ -815,64 +823,64 @@ class MapView extends NativeBridgeComponent(
     let deprecatedPropName: CallbablePropKeys | '' = '';
 
     switch (type) {
-      case MapboxGL.EventTypes.RegionWillChange:
+      case EventTypes.RegionWillChange:
         if (regionWillChangeDebounceTime && regionWillChangeDebounceTime > 0) {
           this._onDebouncedRegionWillChange(payload);
         } else {
           propName = 'onRegionWillChange';
         }
         break;
-      case MapboxGL.EventTypes.RegionIsChanging:
+      case EventTypes.RegionIsChanging:
         propName = 'onRegionIsChanging';
         break;
-      case MapboxGL.EventTypes.RegionDidChange:
+      case EventTypes.RegionDidChange:
         if (regionDidChangeDebounceTime && regionDidChangeDebounceTime > 0) {
           this._onDebouncedRegionDidChange(payload);
         } else {
           propName = 'onRegionDidChange';
         }
         break;
-      case MapboxGL.EventTypes.CameraChanged:
+      case EventTypes.CameraChanged:
         propName = 'onCameraChanged';
         break;
-      case MapboxGL.EventTypes.MapIdle:
+      case EventTypes.MapIdle:
         propName = 'onMapIdle';
         break;
-      case MapboxGL.EventTypes.UserLocationUpdated:
+      case EventTypes.UserLocationUpdated:
         propName = 'onUserLocationUpdate';
         break;
-      case MapboxGL.EventTypes.WillStartLoadingMap:
+      case EventTypes.WillStartLoadingMap:
         propName = 'onWillStartLoadingMap';
         break;
-      case MapboxGL.EventTypes.DidFinishLoadingMap:
+      case EventTypes.DidFinishLoadingMap:
         propName = 'onDidFinishLoadingMap';
         break;
-      case MapboxGL.EventTypes.DidFailLoadingMap:
+      case EventTypes.DidFailLoadingMap:
         propName = 'onDidFailLoadingMap';
         break;
-      case MapboxGL.EventTypes.MapLoadingError:
+      case EventTypes.MapLoadingError:
         propName = 'onMapLoadingError';
         deprecatedPropName = 'onDidFailLoadingMap';
         break;
-      case MapboxGL.EventTypes.WillStartRenderingFrame:
+      case EventTypes.WillStartRenderingFrame:
         propName = 'onWillStartRenderingFrame';
         break;
-      case MapboxGL.EventTypes.DidFinishRenderingFrame:
+      case EventTypes.DidFinishRenderingFrame:
         propName = 'onDidFinishRenderingFrame';
         break;
-      case MapboxGL.EventTypes.DidFinishRenderingFrameFully:
+      case EventTypes.DidFinishRenderingFrameFully:
         propName = 'onDidFinishRenderingFrameFully';
         break;
-      case MapboxGL.EventTypes.WillStartRenderingMap:
+      case EventTypes.WillStartRenderingMap:
         propName = 'onWillStartRenderingMap';
         break;
-      case MapboxGL.EventTypes.DidFinishRenderingMap:
+      case EventTypes.DidFinishRenderingMap:
         propName = 'onDidFinishRenderingMap';
         break;
-      case MapboxGL.EventTypes.DidFinishRenderingMapFully:
+      case EventTypes.DidFinishRenderingMapFully:
         propName = 'onDidFinishRenderingMapFully';
         break;
-      case MapboxGL.EventTypes.DidFinishLoadingStyle:
+      case EventTypes.DidFinishLoadingStyle:
         propName = 'onDidFinishLoadingStyle';
         break;
       default:
@@ -944,13 +952,10 @@ class MapView extends NativeBridgeComponent(
   }
 
   _setLocalizeLabels(props: Props) {
-    if (!MapboxGL.MapboxV10) {
+    if (!MGLModule.MapboxV10) {
       return;
     }
     if (typeof props.localizeLabels === 'boolean') {
-      console.warn(
-        'boolean value of localizeLabels is deprecated. Please set this as Locale object instead',
-      );
       props.localizeLabels = {
         locale: 'current',
       };

package/src/components/PointAnnotation.tsx

@@ -8,6 +8,7 @@ import {
 import { Feature, Point } from 'geojson';
 
 import { toJSONString, isFunction } from '../utils';
+import checkRequiredProps from '../utils/checkRequiredProps';
 import { makePoint } from '../utils/geoUtils';
 import { type BaseProps } from '../types/BaseProps';
 import { Position } from '../types/Position';
@@ -136,6 +137,7 @@ class PointAnnotation extends NativeBridgeComponent(
 
   constructor(props: Props) {
     super(props);
+    checkRequiredProps('PointAnnotation', props, ['id', 'coordinate']);
     this._onSelected = this._onSelected.bind(this);
     this._onDeselected = this._onDeselected.bind(this);
     this._onDragStart = this._onDragStart.bind(this);

package/src/utils/checkRequiredProps.ts

@@ -0,0 +1,17 @@
+type RequiredKeys<T> = {
+  [k in keyof T]-?: undefined extends T[k] ? never : k;
+}[keyof T];
+
+export default function checkRequiredProps<
+  Props extends { [key: string]: unknown },
+>(tag: string, props: Props, required: RequiredKeys<Props>[]) {
+  for (const key of required) {
+    if (props[key] === undefined) {
+      console.error(
+        `Error: ${tag} property: ${
+          key as string
+        } is required but it was missing.`,
+      );
+    }
+  }
+}