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

package/javascript/components/Images.tsx

@@ -1,5 +1,9 @@
 import React, { ReactNode, ReactElement } from 'react';
-import { requireNativeComponent, Image as RNImage } from 'react-native';
+import {
+  requireNativeComponent,
+  Image as RNImage,
+  ImageURISource,
+} from 'react-native';
 import { ImageSourcePropType, ImageResolvedAssetSource } from 'react-native';
 
 import { ShapeSource } from './ShapeSource';
@@ -12,7 +16,7 @@ export type RNMBEvent<PayloadType = { [key: string]: string }> = {
   type: string;
 };
 
-function _isUrlOrPath(value: string | ImageSourcePropType): value is string {
+function _isUrlOrPath(value: ImageEntry): value is string {
   return (
     (typeof value === 'string' || value instanceof String) &&
     (value.startsWith('file://') ||
@@ -24,6 +28,16 @@ function _isUrlOrPath(value: string | ImageSourcePropType): value is string {
   );
 }
 
+function isImageSourcePropType(
+  value: ImageEntry,
+): value is ImageSourcePropType {
+  if (typeof value === 'number' || value instanceof Number) {
+    return true;
+  }
+  const valueAsSource = value as ImageURISource;
+  return !!valueAsSource.uri && typeof valueAsSource.uri === 'string';
+}
+
 type TypedReactNode<T> = ReactElement<T> | Array<TypedReactNode<T>> | never;
 
 type NativeImage =
@@ -33,8 +47,33 @@ type NativeImage =
       sdf?: boolean;
       stretchX?: [number, number][];
       stretchY?: [number, number][];
+      content?: [number, number, number, number];
+      scale?: number;
     };
 
+export type ImageEntryData = {
+  url?: string;
+  image?: ImageSourcePropType;
+  resolvedImage?: ImageResolvedAssetSource;
+  sdf?: boolean;
+  stretchX?: [number, number][];
+  stretchY?: [number, number][];
+  content?: [number, number, number, number];
+  scale?: number;
+};
+
+type ResolvedImageEntryData = {
+  url?: string;
+  resolvedImage?: ImageResolvedAssetSource;
+  sdf?: boolean;
+  stretchX?: [number, number][];
+  stretchY?: [number, number][];
+  content?: [number, number, number, number];
+  scale?: number;
+};
+
+export type ImageEntry = string | ImageSourcePropType | ImageEntryData;
+
 const isChildAnImage = (
   child: ReactNode,
 ): child is React.ReactElement<typeof Image> => {
@@ -47,7 +86,7 @@ interface Props {
    * Keys are names - see iconImage expressions, values can be either urls-s objects
    * with format {uri: 'http://...'}` or `require('image.png')` or `import 'image.png'`
    */
-  images?: { [key: string]: ImageSourcePropType };
+  images?: { [key: string]: ImageEntry };
 
   /**
    * If you have an asset under Image.xcassets on iOS and the drawables directory on android
@@ -77,7 +116,9 @@ class Images extends React.PureComponent<Props> {
       return {};
     }
 
-    const images: { [key: string]: string | ImageResolvedAssetSource } = {};
+    const images: {
+      [key: string]: string | ImageResolvedAssetSource | ResolvedImageEntryData;
+    } = {};
     let nativeImages: NativeImage[] = [];
 
     if (this.props.images) {
@@ -93,11 +134,20 @@ class Images extends React.PureComponent<Props> {
           );
         } else if (_isUrlOrPath(value)) {
           images[imageName] = value;
-        } else {
+        } else if (isImageSourcePropType(value)) {
           const res = RNImage.resolveAssetSource(value);
           if (res && res.uri) {
             images[imageName] = res;
           }
+        } else {
+          let imageEntry = value as ImageEntryData;
+          if (imageEntry.image) {
+            imageEntry = {
+              ...imageEntry,
+              resolvedImage: RNImage.resolveAssetSource(imageEntry.image),
+            };
+          }
+          images[imageName] = imageEntry;
         }
       }
     }
@@ -147,7 +197,9 @@ class Images extends React.PureComponent<Props> {
 type NativeProps = {
   hasOnImageMissing: boolean;
   onImageMissing?: (event: React.SyntheticEvent<Element, RNMBEvent>) => void;
-  images?: { [key: string]: string | ImageResolvedAssetSource };
+  images?: {
+    [key: string]: string | ImageResolvedAssetSource | ResolvedImageEntryData;
+  };
   nativeImages?: NativeImage[];
 };
 

package/javascript/components/MapView.tsx

@@ -21,6 +21,7 @@ import {
 import { getFilter } from '../utils/filterUtils';
 import Logger from '../utils/Logger';
 import { FilterExpression } from '../utils/MapboxStyles';
+import { type Position } from '../types/Position';
 
 import NativeBridgeComponent from './NativeBridgeComponent';
 
@@ -46,7 +47,6 @@ export type Point = {
   y: number;
 };
 
-export type Position = [number, number];
 type BBox = [number, number, number, number];
 
 export type RegionPayload = {

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/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/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);