@rnmapbox/maps 10.2.7 → 10.2.8

package/src/components/RasterArraySource.tsx

@@ -0,0 +1,134 @@
+import React from 'react';
+import { NativeModules } from 'react-native';
+
+import { cloneReactChildrenWithProps } from '../utils';
+import { BaseProps } from '../types/BaseProps';
+import RNMBXRasterArraySourceNativeComponent from '../specs/RNMBXRasterArraySourceNativeComponent';
+
+import AbstractSource from './AbstractSource';
+
+const Mapbox = NativeModules.RNMBXModule;
+
+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;
+
+  /**
+   * The id refers to an existing source in the style. Does not create a new source.
+   */
+  existing?: boolean;
+
+  /**
+   * 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.
+   * Defaults to 512.
+   *
+   * @platform android
+   * Note: This property is not supported on iOS due to SDK limitations.
+   * On iOS, tileSize will be derived from the TileJSON when using url, or use the default value.
+   * If you need custom tile size on iOS, include it in your TileJSON response.
+   */
+  tileSize?: number;
+
+  children?: React.ReactElement | React.ReactElement[];
+
+  /**
+   * An array containing the longitude and latitude of the southwest and northeast corners of
+   * the source's bounding box in the following order: `[sw.lng, sw.lat, ne.lng, ne.lat]`.
+   * When this property is included in a source, no tiles outside of the given bounds are requested by Mapbox GL.
+   *
+   * @platform android
+   * Note: This property is not supported on iOS due to SDK limitations.
+   * On iOS, bounds will be derived from the TileJSON when using url.
+   * If you need custom bounds on iOS, include them in your TileJSON response.
+   */
+  sourceBounds?: number[];
+};
+
+type NativeProps = Props;
+
+/**
+ * RasterArraySource is a map content source that supplies raster array image tiles to be shown on the map.
+ * This is typically used for particle animations like wind or precipitation patterns.
+ * 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.
+ *
+ * @experimental This component requires Mapbox Maps SDK v11.4.0 or later
+ */
+class RasterArraySource extends AbstractSource<Props, NativeProps> {
+  static defaultProps: Props = {
+    id: Mapbox.StyleSource.DefaultSourceID,
+  };
+
+  constructor(props: Props) {
+    super(props);
+    if (isTileTemplateUrl(props.url)) {
+      console.warn(
+        `RasterArraySource 'url' property contains a Tile URL Template, but is intended for a StyleJSON URL. Please migrate your RasterArraySource to use: \`tileUrlTemplates=["${props.url}"]\` instead.`,
+      );
+    }
+  }
+
+  render() {
+    let { url } = this.props;
+    let { tileUrlTemplates } = this.props;
+
+    // Swapping url for tileUrlTemplates to provide backward compatibility
+    // when RasterArraySource supported only tile url as url prop
+    if (isTileTemplateUrl(url)) {
+      tileUrlTemplates = [url];
+      url = undefined;
+    }
+
+    const props = {
+      ...this.props,
+      id: this.props.id,
+      existing: this.props.existing,
+      url,
+      tileUrlTemplates,
+      minZoomLevel: this.props.minZoomLevel,
+      maxZoomLevel: this.props.maxZoomLevel,
+      tileSize: this.props.tileSize,
+    };
+    return (
+      // @ts-expect-error just codegen stuff
+      <RNMBXRasterArraySourceNativeComponent ref={this.setNativeRef} {...props}>
+        {cloneReactChildrenWithProps(this.props.children, {
+          sourceID: this.props.id,
+        })}
+      </RNMBXRasterArraySourceNativeComponent>
+    );
+  }
+}
+
+export default RasterArraySource;

package/src/components/RasterParticleLayer.tsx

@@ -0,0 +1,117 @@
+import React from 'react';
+import { NativeModules } from 'react-native';
+
+import type {
+  FilterExpression,
+  RasterParticleLayerStyleProps,
+} from '../utils/MapboxStyles';
+import { StyleValue } from '../utils/StyleValue';
+import RNMBXRasterParticleLayerNativeComponent from '../specs/RNMBXRasterParticleLayerNativeComponent';
+
+import AbstractLayer from './AbstractLayer';
+
+const Mapbox = NativeModules.RNMBXModule;
+
+// @{codepart-replace-start(LayerPropsCommon.codepart-tsx)}
+type Slot = 'bottom' | 'middle' | 'top';
+
+type LayerPropsCommon = {
+  /**
+   * A string that uniquely identifies the source in the style to which it is added.
+   */
+  id: string;
+
+  /**
+   * The id refers to an existing layer in the style. Does not create a new layer.
+   */
+  existing?: boolean;
+
+  /**
+   * The source from which to obtain the data to style.
+   * If the source has not yet been added to the current style, the behavior is undefined.
+   * Inferred from parent source only if the layer is a direct child to it.
+   */
+  sourceID?: string;
+
+  /**
+   * Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style.
+   */
+  sourceLayerID?: string;
+
+  /**
+   * Inserts a layer above aboveLayerID.
+   */
+  aboveLayerID?: string;
+
+  /**
+   * Inserts a layer below belowLayerID
+   */
+  belowLayerID?: string;
+
+  /**
+   * Inserts a layer at a specified index
+   */
+  layerIndex?: number;
+
+  /**
+   *  Filter only the features in the source layer that satisfy a condition that you define
+   */
+  filter?: FilterExpression;
+
+  /**
+   * The minimum zoom level at which the layer gets parsed and appears.
+   */
+  minZoomLevel?: number;
+
+  /**
+   * The maximum zoom level at which the layer gets parsed and appears.
+   */
+  maxZoomLevel?: number;
+
+  /**
+   * The slot this layer is assigned to. If specified, and a slot with that name exists, it will be placed at that position in the layer order.
+   *
+   * v11 only
+   */
+  slot?: Slot;
+};
+// @{codepart-replace-end}
+
+export type Props = LayerPropsCommon & {
+  /**
+   * Customizable style attributes
+   */
+  style: RasterParticleLayerStyleProps;
+} & React.ComponentProps<typeof AbstractLayer>;
+
+type NativeTypeProps = Omit<Props, 'style'> & {
+  reactStyle?: { [key: string]: StyleValue };
+};
+
+/**
+ * RasterParticleLayer renders a particle animation driven by velocity data from a raster array source.
+ * This is typically used to visualize wind patterns, ocean currents, or other directional flow data.
+ *
+ * @experimental This component requires Mapbox Maps SDK v11.4.0 or later
+ */
+class RasterParticleLayer extends AbstractLayer<Props, NativeTypeProps> {
+  static defaultProps = {
+    sourceID: Mapbox.StyleSource.DefaultSourceID,
+  };
+
+  render() {
+    const props = {
+      ...this.baseProps,
+      sourceLayerID: this.props.sourceLayerID,
+    };
+    return (
+      // @ts-expect-error just codegen stuff
+      <RNMBXRasterParticleLayerNativeComponent
+        ref={this.setNativeLayer}
+        {...props}
+      />
+    );
+  }
+}
+
+export default RasterParticleLayer;

package/src/modules/offline/offlineManagerLegacy.ts

@@ -159,6 +159,20 @@ class OfflineManagerLegacy {
     return this._offlinePacks[name];
   }
 
+  /**
+   * Sets the maximum number of Mapbox-hosted tiles that may be downloaded and stored on the current device.
+   * The Mapbox Terms of Service prohibit changing or bypassing this limit without permission from Mapbox.
+   *
+   * @example
+   * Mapbox.offlineManagerLegacy.setTileCountLimit(1000);
+   *
+   * @param {Number} limit Map tile limit count.
+   * @return {void}
+   */
+  setTileCountLimit(limit: number): void {
+    MapboxOfflineManager.setTileCountLimit(limit);
+  }
+
   async _initialize(forceInit?: boolean): Promise<boolean> {
     if (this._hasInitialized && !forceInit) {
       return true;

package/src/specs/RNMBXRasterArraySourceNativeComponent.ts

@@ -0,0 +1,22 @@
+import type { HostComponent, ViewProps } from 'react-native';
+import codegenNativeComponent from 'react-native/Libraries/Utilities/codegenNativeComponent';
+// @ts-ignore - CI environment type resolution issue for CodegenTypes
+import { Double } from 'react-native/Libraries/Types/CodegenTypes';
+
+import { UnsafeMixed } from './codegenUtils';
+
+export interface NativeProps extends ViewProps {
+  id: UnsafeMixed<string>;
+  existing: UnsafeMixed<boolean>;
+  url: UnsafeMixed<string>;
+  tileUrlTemplates: UnsafeMixed<Array<string>>;
+  minZoomLevel: UnsafeMixed<Double>;
+  maxZoomLevel: UnsafeMixed<Double>;
+  tileSize: UnsafeMixed<Double>;
+  sourceBounds: UnsafeMixed<Array<number>>;
+}
+
+// @ts-ignore-error - Codegen requires single cast but TypeScript prefers double cast
+export default codegenNativeComponent<NativeProps>(
+  'RNMBXRasterArraySource',
+) as HostComponent<NativeProps>;

package/src/specs/RNMBXRasterParticleLayerNativeComponent.ts

@@ -0,0 +1,39 @@
+import type { HostComponent, ViewProps } from 'react-native';
+import codegenNativeComponent from 'react-native/Libraries/Utilities/codegenNativeComponent';
+// @ts-ignore - CI environment type resolution issue for CodegenTypes
+import { Double, Int32 } from 'react-native/Libraries/Types/CodegenTypes';
+
+import type { FilterExpression } from '../utils/MapboxStyles';
+
+import type { UnsafeMixed } from './codegenUtils';
+
+// @{codepart-replace-start(CommonLayerNativeComponentsProps.codepart-ts)}
+// see https://github.com/rnmapbox/maps/wiki/FabricOptionalProp
+type OptionalProp<T> = UnsafeMixed<T>;
+type Slot = 'bottom' | 'middle' | 'top';
+
+type CommonProps = {
+  sourceID?: OptionalProp<string>;
+  existing?: OptionalProp<boolean>;
+  filter?: UnsafeMixed<FilterExpression>;
+
+  aboveLayerID?: OptionalProp<string>;
+  belowLayerID?: OptionalProp<string>;
+  layerIndex?: OptionalProp<Int32>;
+
+  maxZoomLevel?: OptionalProp<Double>;
+  minZoomLevel?: OptionalProp<Double>;
+  sourceLayerID?: OptionalProp<string>;
+  slot?: OptionalProp<Slot>;
+};
+// @{codepart-replace-end}
+
+export interface NativeProps extends ViewProps, CommonProps {
+  id?: OptionalProp<string>;
+  reactStyle: UnsafeMixed<any>;
+}
+
+// @ts-ignore-error - Codegen requires single cast but TypeScript prefers double cast
+export default codegenNativeComponent<NativeProps>(
+  'RNMBXRasterParticleLayer',
+) as HostComponent<NativeProps>;

package/src/utils/MapboxStyles.ts

@@ -125,7 +125,8 @@ type ExpressionParameters =
   | 'line-progress'
   | 'heatmap-density'
   | 'measure-light'
-  | 'raster-value';
+  | 'raster-value'
+  | 'raster-particle-speed';
 
 type ResolvedImageType = ImageSourcePropType | string;
 
@@ -1913,6 +1914,50 @@ export interface RasterLayerStyleProps {
    */
   rasterElevationTransition?: Transition;
 }
+export interface RasterParticleLayerStyleProps {
+  /**
+   * Whether this layer is displayed.
+   */
+  visibility?: Value<Enum<VisibilityEnum, VisibilityEnumValues>>;
+  /**
+   * Displayed band of raster array source layer
+   */
+  rasterParticleArrayBand?: string;
+  /**
+   * Defines the amount of particles per tile.
+   */
+  rasterParticleCount?: number;
+  /**
+   * Defines a color map by which to colorize a raster particle layer, parameterized by the `["rasterParticleSpeed"]` expression and evaluated at 256 uniformly spaced steps over the range specified by `rasterParticleMaxSpeed`.
+   */
+  rasterParticleColor?: Value<string, ['raster-particle-speed']>;
+  /**
+   * Defines the maximum speed for particles. Velocities with magnitudes equal to or exceeding this value are clamped to the max value.
+   */
+  rasterParticleMaxSpeed?: number;
+  /**
+   * Defines a coefficient for the speed of particles’ motion.
+   */
+  rasterParticleSpeedFactor?: Value<number, ['zoom']>;
+
+  /**
+   * The transition affecting any changes to this layer’s rasterParticleSpeedFactor property.
+   */
+  rasterParticleSpeedFactorTransition?: Transition;
+  /**
+   * Defines defines the opacity coefficient applied to the faded particles in each frame. In practice, this property controls the length of the particle tail.
+   */
+  rasterParticleFadeOpacityFactor?: Value<number, ['zoom']>;
+
+  /**
+   * The transition affecting any changes to this layer’s rasterParticleFadeOpacityFactor property.
+   */
+  rasterParticleFadeOpacityFactorTransition?: Transition;
+  /**
+   * Defines a coefficient for a time period at which particles will restart at a random position, to avoid degeneration (empty areas without particles).
+   */
+  rasterParticleResetRateFactor?: number;
+}
 export interface HillshadeLayerStyleProps {
   /**
    * Whether this layer is displayed.
@@ -2307,6 +2352,7 @@ export type AllLayerStyleProps =
   | HeatmapLayerStyleProps
   | FillExtrusionLayerStyleProps
   | RasterLayerStyleProps
+  | RasterParticleLayerStyleProps
   | HillshadeLayerStyleProps
   | ModelLayerStyleProps
   | BackgroundLayerStyleProps

package/src/utils/styleMap.ts

@@ -265,6 +265,16 @@ const styleMap = {
   rasterElevation: StyleTypes.Constant,
   rasterElevationTransition: StyleTypes.Transition,
 
+  rasterParticleArrayBand: StyleTypes.Constant,
+  rasterParticleCount: StyleTypes.Constant,
+  rasterParticleColor: StyleTypes.Color,
+  rasterParticleMaxSpeed: StyleTypes.Constant,
+  rasterParticleSpeedFactor: StyleTypes.Constant,
+  rasterParticleSpeedFactorTransition: StyleTypes.Transition,
+  rasterParticleFadeOpacityFactor: StyleTypes.Constant,
+  rasterParticleFadeOpacityFactorTransition: StyleTypes.Transition,
+  rasterParticleResetRateFactor: StyleTypes.Constant,
+
   hillshadeIlluminationDirection: StyleTypes.Constant,
   hillshadeIlluminationAnchor: StyleTypes.Enum,
   hillshadeExaggeration: StyleTypes.Constant,