@rnmapbox/maps 10.0.0-beta.74 → 10.0.0-beta.76

package/javascript/components/MarkerView.tsx

@@ -9,6 +9,7 @@ import {
 
 import { toJSONString } from '../utils';
 import { makePoint } from '../utils/geoUtils';
+import { type Position } from '../types/Position';
 
 import PointAnnotation from './PointAnnotation';
 
@@ -20,7 +21,7 @@ type Props = ViewProps & {
   /**
    * The center point (specified as a map coordinate) of the marker.
    */
-  coordinate: [number, number];
+  coordinate: Position;
 
   /**
    * Any coordinate between (0, 0) and (1, 1), where (0, 0) is the top-left corner of
@@ -78,7 +79,7 @@ class MarkerView extends React.PureComponent<Props> {
     return this.__idForPointAnnotation;
   }
 
-  _getCoordinate(coordinate: [number, number]): string | undefined {
+  _getCoordinate(coordinate: Position): string | undefined {
     if (!coordinate) {
       return undefined;
     }

package/javascript/components/NativeBridgeComponent.tsx

@@ -82,7 +82,7 @@ const NativeBridgeComponent = <
 
     _runNativeCommand<RefType, ReturnType = NativeArg>(
       methodName: string,
-      nativeRef: RefType,
+      nativeRef: RefType | undefined,
       args: NativeArg[] = [],
     ): Promise<ReturnType> {
       if (!nativeRef) {

package/javascript/components/PointAnnotation.tsx

@@ -10,6 +10,7 @@ import { type Feature } from 'geojson';
 import { toJSONString, isFunction } from '../utils';
 import { makePoint } from '../utils/geoUtils';
 import { type BaseProps } from '../types/BaseProps';
+import { Position } from '../types/Position';
 
 import NativeBridgeComponent, { type RNMBEvent } from './NativeBridgeComponent';
 
@@ -24,7 +25,7 @@ const styles = StyleSheet.create({
 });
 
 type FeaturePayload = {
-  feature: Feature;
+  feature: Feature<GeoJSON.Point, { id: string }>;
 };
 
 type Props = BaseProps & {
@@ -56,7 +57,7 @@ type Props = BaseProps & {
   /**
    * The center point (specified as a map coordinate) of the annotation.
    */
-  coordinate: [number, number];
+  coordinate: Position;
 
   /**
    * Specifies the anchor being set on a particular point of the annotation.
@@ -104,7 +105,7 @@ type Props = BaseProps & {
   /**
    * Expects one child, and an optional callout can be added as well
    */
-  children: React.ReactElement;
+  children: React.ReactElement | [React.ReactElement, React.ReactElement];
 
   style?: ViewProps['style'];
 };

package/javascript/components/RasterDemSource.tsx

@@ -0,0 +1,105 @@
+import React from 'react';
+import { NativeModules, requireNativeComponent } from 'react-native';
+
+import { cloneReactChildrenWithProps } from '../utils';
+
+import AbstractSource from './AbstractSource';
+
+const isTileTemplateUrl = (url?: string): url is string =>
+  !!url &&
+  (url.includes('{z}') || url.includes('{bbox-') || url.includes('{quadkey}'));
+
+const MapboxGL = NativeModules.MGLModule;
+
+export const NATIVE_MODULE_NAME = 'RCTMGLRasterDemSource';
+
+type Props = {
+  /**
+   * A string that uniquely identifies the source.
+   */
+  id: string;
+
+  /**
+   * A URL to a TileJSON configuration file describing the source’s contents and other metadata.
+   */
+  url?: string;
+
+  /**
+   * An array of tile URL templates. If multiple endpoints are specified, clients may use any combination of endpoints.
+   * Example: https://example.com/raster-tiles/{z}/{x}/{y}.png
+   */
+  tileUrlTemplates?: string[];
+
+  /**
+   * An unsigned integer that specifies the minimum zoom level at which to display tiles from the source.
+   * The value should be between 0 and 22, inclusive, and less than
+   * maxZoomLevel, if specified. The default value for this option is 0.
+   */
+  minZoomLevel?: number;
+
+  /**
+   * An unsigned integer that specifies the maximum zoom level at which to display tiles from the source.
+   * The value should be between 0 and 22, inclusive, and less than
+   * minZoomLevel, if specified. The default value for this option is 22.
+   */
+  maxZoomLevel?: number;
+
+  /**
+   * Size of the map tiles.
+   * Mapbox urls default to 256, all others default to 512.
+   */
+  tileSize?: number;
+
+  children?: React.ReactElement | React.ReactElement[];
+};
+
+type NativeProps = Props;
+
+class RasterDemSource extends AbstractSource<Props, NativeProps> {
+  static defaultProps = {
+    id: MapboxGL.StyleSource.DefaultSourceID,
+  };
+
+  constructor(props: Props) {
+    super(props);
+    if (isTileTemplateUrl(props.url)) {
+      console.warn(
+        `RasterDemSource 'url' property contains a Tile URL Template, but is intended for a StyleJSON URL. Please migrate your VectorSource to use: \`tileUrlTemplates=["${props.url}"]\` instead.`,
+      );
+    }
+  }
+
+  render() {
+    let { url } = this.props;
+    let { tileUrlTemplates } = this.props;
+
+    // Swapping url for tileUrlTemplates to provide backward compatibility
+    // when RasterSource supported only tile url as url prop
+    if (isTileTemplateUrl(url)) {
+      tileUrlTemplates = [url];
+      url = undefined;
+    }
+
+    const props = {
+      ...this.props,
+      id: this.props.id,
+      url,
+      tileUrlTemplates,
+      minZoomLevel: this.props.minZoomLevel,
+      maxZoomLevel: this.props.maxZoomLevel,
+      tileSize: this.props.tileSize,
+    };
+    return (
+      <RCTMGLRasterDemSource ref={this.setNativeRef} {...props}>
+        {cloneReactChildrenWithProps(this.props.children, {
+          sourceID: this.props.id,
+        })}
+      </RCTMGLRasterDemSource>
+    );
+  }
+}
+
+const RCTMGLRasterDemSource =
+  requireNativeComponent<NativeProps>(NATIVE_MODULE_NAME);
+
+export default RasterDemSource;

package/javascript/components/RasterSource.tsx

@@ -0,0 +1,124 @@
+import React from 'react';
+import { NativeModules, requireNativeComponent } from 'react-native';
+
+import { cloneReactChildrenWithProps } from '../utils';
+import { BaseProps } from '../types/BaseProps';
+
+import AbstractSource from './AbstractSource';
+
+const MapboxGL = NativeModules.MGLModule;
+
+export const NATIVE_MODULE_NAME = 'RCTMGLRasterSource';
+
+const isTileTemplateUrl = (url?: string): url is string =>
+  !!url &&
+  (url.includes('{z}') || url.includes('{bbox-') || url.includes('{quadkey}'));
+
+type Props = BaseProps & {
+  /**
+   * A string that uniquely identifies the source.
+   */
+  id: string;
+
+  /**
+   * A URL to a TileJSON configuration file describing the source’s contents and other metadata.
+   */
+  url?: string;
+
+  /**
+   * An array of tile URL templates. If multiple endpoints are specified, clients may use any combination of endpoints.
+   * Example: https://example.com/raster-tiles/{z}/{x}/{y}.png
+   */
+  tileUrlTemplates?: string[];
+
+  /**
+   * An unsigned integer that specifies the minimum zoom level at which to display tiles from the source.
+   * The value should be between 0 and 22, inclusive, and less than
+   * maxZoomLevel, if specified. The default value for this option is 0.
+   */
+  minZoomLevel?: number;
+
+  /**
+   * An unsigned integer that specifies the maximum zoom level at which to display tiles from the source.
+   * The value should be between 0 and 22, inclusive, and less than
+   * minZoomLevel, if specified. The default value for this option is 22.
+   */
+  maxZoomLevel?: number;
+
+  /**
+   * Size of the map tiles.
+   * Mapbox urls default to 256, all others default to 512.
+   */
+  tileSize?: number;
+
+  /**
+   * Influences the y direction of the tile coordinates. (tms inverts y axis)
+   */
+  tms?: boolean;
+
+  /**
+   * An HTML or literal text string defining the buttons to be displayed in an action sheet when the
+   * source is part of a map view’s style and the map view’s attribution button is pressed.
+   */
+  attribution?: string;
+
+  children?: React.ReactElement | React.ReactElement[];
+};
+
+type NativeProps = Props;
+
+/**
+ * RasterSource is a map content source that supplies raster image tiles to be shown on the map.
+ * The location of and metadata about the tiles are defined either by an option dictionary
+ * or by an external file that conforms to the TileJSON specification.
+ */
+class RasterSource extends AbstractSource<Props, NativeProps> {
+  static defaultProps: Props = {
+    id: MapboxGL.StyleSource.DefaultSourceID,
+  };
+
+  constructor(props: Props) {
+    super(props);
+    if (isTileTemplateUrl(props.url)) {
+      console.warn(
+        `RasterSource 'url' property contains a Tile URL Template, but is intended for a StyleJSON URL. Please migrate your VectorSource to use: \`tileUrlTemplates=["${props.url}"]\` instead.`,
+      );
+    }
+  }
+
+  render() {
+    let { url } = this.props;
+    let { tileUrlTemplates } = this.props;
+
+    // Swapping url for tileUrlTemplates to provide backward compatibility
+    // when RasterSource supported only tile url as url prop
+    if (isTileTemplateUrl(url)) {
+      tileUrlTemplates = [url];
+      url = undefined;
+    }
+
+    const props = {
+      ...this.props,
+      id: this.props.id,
+      url,
+      tileUrlTemplates,
+      minZoomLevel: this.props.minZoomLevel,
+      maxZoomLevel: this.props.maxZoomLevel,
+      tileSize: this.props.tileSize,
+      tms: this.props.tms,
+      attribution: this.props.attribution,
+    };
+    return (
+      <RCTMGLRasterSource ref={this.setNativeRef} {...props}>
+        {cloneReactChildrenWithProps(this.props.children, {
+          sourceID: this.props.id,
+        })}
+      </RCTMGLRasterSource>
+    );
+  }
+}
+
+const RCTMGLRasterSource =
+  requireNativeComponent<NativeProps>(NATIVE_MODULE_NAME);
+
+export default RasterSource;

package/javascript/components/ShapeSource.tsx

@@ -136,7 +136,7 @@ export type Props = {
     height: number;
   };
 
-  children: React.ReactElement | React.ReactElement[];
+  children?: React.ReactElement | React.ReactElement[];
 };
 
 /**

package/javascript/components/{Style.js → Style.tsx}

@@ -1,5 +1,6 @@
 import React, { useMemo, useState, useEffect } from 'react';
-import PropTypes from 'prop-types';
+
+import { FilterExpression } from '../utils/MapboxStyles';
 
 import CircleLayer from './CircleLayer';
 import RasterLayer from './RasterLayer';
@@ -14,7 +15,7 @@ import RasterSource from './RasterSource';
 import ImageSource from './ImageSource';
 import { ShapeSource } from './ShapeSource';
 
-function toCamelCase(s) {
+function toCamelCase(s: string): string {
   return s.replace(/([-_][a-z])/gi, ($1) => {
     return $1.toUpperCase().replace('-', '').replace('_', '');
   });
@@ -22,11 +23,13 @@ function toCamelCase(s) {
 
 // Patches the Mapbox Style Specification keys into the style props attributes:
 // icon-allow-overlap -> iconAllowOverlap
-function toCamelCaseKeys(oldObj) {
+function toCamelCaseKeys(oldObj?: { [key: string]: unknown }): {
+  [key: string]: unknown;
+} {
   if (!oldObj) {
     return {};
   }
-  const newObj = {};
+  const newObj: { [key: string]: unknown } = {};
   Object.keys(oldObj).forEach((key) => {
     const value = oldObj[key];
     if (key.includes('-')) {
@@ -38,7 +41,7 @@ function toCamelCaseKeys(oldObj) {
   return newObj;
 }
 
-function getLayerComponentType(layer) {
+function getLayerComponentType(layer: { type: string }) {
   const { type } = layer;
 
   switch (type) {
@@ -65,8 +68,10 @@ function getLayerComponentType(layer) {
   return null;
 }
 
-function asLayerComponent(layer) {
-  const LayerComponent = getLayerComponentType(layer);
+function asLayerComponent(layer: MapboxJSONLayer) {
+  type GenericProps = { key?: string; id: string };
+  const LayerComponent: typeof React.PureComponent<GenericProps> | null =
+    getLayerComponentType(layer) as typeof React.PureComponent<GenericProps>;
   if (!LayerComponent) {
     return null;
   }
@@ -76,7 +81,14 @@ function asLayerComponent(layer) {
     ...toCamelCaseKeys(layer.layout),
   };
 
-  const layerProps = {};
+  const layerProps: {
+    sourceID?: string;
+    sourceLayerID?: string;
+    minZoomLevel?: number;
+    maxZoomLevel?: number;
+    filter?: FilterExpression;
+    style?: object;
+  } = {};
 
   if (layer.source) {
     layerProps.sourceID = layer.source;
@@ -100,8 +112,17 @@ function asLayerComponent(layer) {
   return <LayerComponent key={layer.id} id={layer.id} {...layerProps} />;
 }
 
-function getTileSourceProps(source) {
-  const sourceProps = {};
+type SourceProps = {
+  url?: string;
+  tileUrlTemplates?: string[];
+  minZoomLevel?: number;
+  maxZoomLevel?: number;
+  attribution?: string;
+  tms?: boolean;
+};
+
+function getTileSourceProps(source: MapboxJSONSource): SourceProps {
+  const sourceProps: SourceProps = {};
   if (source.url) {
     sourceProps.url = source.url;
   }
@@ -123,20 +144,22 @@ function getTileSourceProps(source) {
   return sourceProps;
 }
 
-function getVectorSource(id, source) {
+function getVectorSource(id: string, source: MapboxJSONSource) {
   const sourceProps = { ...getTileSourceProps(source) };
   return <VectorSource key={id} id={id} {...sourceProps} />;
 }
 
-function getRasterSource(id, source) {
-  const sourceProps = { ...getTileSourceProps(source) };
+function getRasterSource(id: string, source: MapboxJSONSource) {
+  const sourceProps: { tileSize?: number } & SourceProps = {
+    ...getTileSourceProps(source),
+  };
   if (source.tileSize) {
     sourceProps.tileSize = source.tileSize;
   }
   return <RasterSource key={id} id={id} {...sourceProps} />;
 }
 
-function getImageSource(id, source) {
+function getImageSource(id: string, source: MapboxJSONSource) {
   const sourceProps = {
     url: source.url,
     coordinates: source.coordinates,
@@ -144,12 +167,24 @@ function getImageSource(id, source) {
   return <ImageSource key={id} id={id} {...sourceProps} />;
 }
 
-function getShapeSource(id, source) {
-  const sourceProps = {};
+type ShapeShourceShape = typeof ShapeSource.prototype.props['shape'];
+
+function getShapeSource(id: string, source: MapboxJSONSource) {
+  const sourceProps: {
+    url?: string;
+    shape?: ShapeShourceShape;
+    cluster?: boolean;
+    clusterRadius?: number;
+    clusterMaxZoomLevel?: number;
+    clusterProperties?: object;
+    buffer?: number;
+    tolerance?: number;
+    lineMetrics?: boolean;
+  } & SourceProps = {};
   if (source.data && typeof source.data === 'string') {
     sourceProps.url = source.data;
   } else if (source.data && typeof source.data === 'object') {
-    sourceProps.shape = source.data;
+    sourceProps.shape = source.data as ShapeShourceShape;
   }
   if (source.cluster !== undefined) {
     sourceProps.cluster = source.cluster;
@@ -178,7 +213,7 @@ function getShapeSource(id, source) {
   return <ShapeSource key={id} id={id} {...sourceProps} />;
 }
 
-function asSourceComponent(id, source) {
+function asSourceComponent(id: string, source: MapboxJSONSource) {
   switch (source.type) {
     case 'vector':
       return getVectorSource(id, source);
@@ -195,26 +230,79 @@ function asSourceComponent(id, source) {
   return null;
 }
 
+type MapboxJSONLayer = {
+  type: string;
+  id: string;
+  paint?: { [k: string]: unknown };
+  layout?: { [k: string]: unknown };
+  source?: string;
+  minzoom?: number;
+  maxzoom?: number;
+  filter?: FilterExpression;
+  style?: object;
+  ['source-layer']: string;
+};
+
+type MapboxJSONSource = {
+  type: string;
+  url?: string;
+  tiles?: string[];
+  minzoom?: number;
+  maxzoom?: number;
+  attribution?: string;
+  scheme?: string;
+  tileSize?: number;
+  coordinates?: [
+    [number, number],
+    [number, number],
+    [number, number],
+    [number, number],
+  ];
+  data?: string | object;
+
+  buffer: number;
+  cluster?: boolean;
+  clusterRadius?: number;
+  clusterMaxZoom?: number;
+  clusterProperties?: object;
+  tolerance?: number;
+  lineMetrics?: boolean;
+};
+
+type MapboxJSON = {
+  layers?: MapboxJSONLayer[];
+  sources?: { [key: string]: MapboxJSONSource };
+};
+
+type Props = {
+  /**
+   * A JSON object conforming to the schema described in the Mapbox Style Specification , or a URL to such JSON.
+   */
+  json: MapboxJSON | URL;
+};
+
 /**
  * Style is a component that automatically adds sources / layers to the map using Mapbox GL Style Spec.
  * Only [`sources`](https://docs.mapbox.com/mapbox-gl-js/style-spec/sources) & [`layers`](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/) are supported.
  * Other fields such as `sprites`, `glyphs` etc. will be ignored. Not all layer / source attributes from the style spec are supported, in general the supported attributes will be mentioned under https://github.com/rnmapbox/maps/tree/main/docs.
  */
-const Style = (props) => {
+const Style = (props: Props) => {
   const [fetchedJson, setFetchedJson] = useState({});
-  const json = typeof props.json === 'object' ? props.json : fetchedJson;
+  const json: MapboxJSON =
+    typeof props.json === 'object' ? props.json : fetchedJson;
 
   // Fetch style when props.json is a URL
   useEffect(() => {
     const abortController = new AbortController();
-    const fetchStyleJson = async () => {
+    const fetchStyleJson = async (json: string) => {
       try {
-        const response = await fetch(props.json, {
+        const response = await fetch(json, {
           signal: abortController.signal,
         });
         const responseJson = await response.json();
         setFetchedJson(responseJson);
-      } catch (e) {
+      } catch (error: unknown) {
+        const e = error as { name?: string };
         if (e.name === 'AbortError') {
           return;
         }
@@ -222,7 +310,7 @@ const Style = (props) => {
       }
     };
     if (typeof props.json === 'string') {
-      fetchStyleJson();
+      fetchStyleJson(props.json);
     }
     return function cleanup() {
       abortController.abort();
@@ -238,14 +326,15 @@ const Style = (props) => {
   }, [json.layers]);
 
   // Extract source components from json
+  const { sources } = json;
   const sourceComponents = useMemo(() => {
-    if (!json.sources || !Object.keys(json.sources)) {
+    if (!sources || !Object.keys(sources)) {
       return [];
     }
-    return Object.keys(json.sources)
-      .map((id) => asSourceComponent(id, json.sources[id]))
+    return Object.keys(sources)
+      .map((id) => asSourceComponent(id, sources[id]))
       .filter((x) => !!x);
-  }, [json.sources]);
+  }, [sources]);
 
   return (
     <>
@@ -255,11 +344,4 @@ const Style = (props) => {
   );
 };
 
-Style.propTypes = {
-  /**
-   * A JSON object conforming to the schema described in the Mapbox Style Specification , or a URL to such JSON.
-   */
-  json: PropTypes.any,
-};
-
 export default Style;

package/javascript/components/Terrain.tsx

@@ -11,7 +11,7 @@ type Props = BaseProps & {
   /**
    * Name of a source of raster_dem type to be used for terrain elevation.
    */
-  sourceID: string;
+  sourceID?: string;
 
   /**
    * Deprecated, use exaggeration in style instead
@@ -21,7 +21,11 @@ type Props = BaseProps & {
   /**
    * Customizable style attributes
    */
-  style: TerrainLayerStyleProps;
+  style?: TerrainLayerStyleProps;
+};
+
+type NativeProps = Omit<Props, 'style'> & {
+  reactStyle?: { [key: string]: StyleValue };
 };
 
 export const Terrain = memo((props: Props) => {
@@ -46,8 +50,5 @@ export const Terrain = memo((props: Props) => {
   return <RCTMGLTerrain {...baseProps} />;
 });
 
-const RCTMGLTerrain: HostComponent<{
-  sourceID: string;
-  reactStyle?: { [key: string]: StyleValue };
-  style?: undefined;
-}> = requireNativeComponent(NATIVE_MODULE_NAME);
+const RCTMGLTerrain: HostComponent<NativeProps> =
+  requireNativeComponent(NATIVE_MODULE_NAME);