@rnmapbox/maps 10.1.0-rc.6 → 10.1.0

package/src/components/LocationPuck.tsx

@@ -1,143 +0,0 @@
-import React, { memo } from 'react';
-import { processColor, type ColorValue } from 'react-native';
-
-import RNMBXNativeUserLocation, {
-  type NativeProps,
-} from '../specs/RNMBXNativeUserLocationNativeComponent';
-import type { Expression } from '../utils/MapboxStyles';
-
-type Value<T> = T | Expression;
-
-export type Props = {
-  /**
-   * Android render mode.
-   *
-   *  - normal: just a circle
-   *  - compass: triangle with heading
-   *  - gps: large arrow
-   *
-   * @deprecated use `puckBearing` for source and `bearingImage` for image
-   * @platform android
-   */
-  androidRenderMode?: 'normal' | 'compass' | 'gps';
-
-  /**
-   * The bearing of the puck.
-   *
-   *  - heading: Orients the puck to match the direction in which the device is facing.
-   *  - course: Orients the puck to match the direction in which the device is moving.
-   */
-  puckBearing?: 'heading' | 'course';
-
-  /**
-   * Whether the puck rotates to track the bearing source.
-   */
-  puckBearingEnabled?: boolean;
-
-  /**
-   * iOS only. A Boolean value indicating whether the user location annotation may display a permanent heading indicator.
-   *
-   * @platform ios
-   * @deprecated use `puckBearingEnabled={true} puckBrearing="heading"` instead
-   */
-  iosShowsUserHeadingIndicator?: boolean;
-
-  /**
-   * The name of image to use as the top layer for the location indicator. Images component should define this image.
-   */
-  topImage?: string;
-
-  /**
-   * The name of image to use as the middle layer for the location indicator. Images component should define this image.
-   */
-  bearingImage?: string;
-
-  /**
-   * The name of image to use as the background for the location indicator. Images component should define this image.
-   */
-  shadowImage?: string;
-
-  /**
-   * The size of the images, as a scale factor applied to the size of the specified image. Supports expressions based on zoom.
-   *
-   * @example
-   * ["interpolate",["linear"], ["zoom"], 10.0, 1.0, 20.0, 4.0]]
-   * @example
-   * 2.0
-   */
-  scale?: Value<number>;
-
-  /**
-   * The configration parameters for sonar-like pulsing circle animation shown around the 2D puck.
-   */
-  pulsing?:
-    | {
-        /**
-         * Flag determining whether the pulsing circle animation.
-         */
-        isEnabled?: boolean;
-
-        /**
-         * The color of the pulsing circle.
-         */
-        color?: number | ColorValue;
-
-        /**
-         * Circle radius configuration for the pulsing circle animation.
-         *  - accuracy:  Pulsing circle animates with the `horizontalAccuracy` form the latest puck location.
-         *  - number: Pulsing circle should animate with the constant radius.
-         */
-        radius?: 'accuracy' | number;
-      }
-    | 'default';
-
-  /**
-   * Whether location icon is visible, defaults to true
-   */
-  visible?: boolean;
-};
-
-const defaultProps = {
-  visible: true,
-} as const;
-
-/**
- * Renders a puck on the map that shows the device's current location.
- */
-const LocationPuck = memo((props: Props) => {
-  const { iosShowsUserHeadingIndicator, pulsing, ...rest } = props;
-  const nativePulsing = pulsing ? _pulsingToNative(pulsing) : undefined;
-  let baseProps: NativeProps = { ...defaultProps, pulsing: nativePulsing };
-  if (iosShowsUserHeadingIndicator) {
-    console.warn(
-      'LocationPuck: iosShowsUserHeadingIndicator is deprecated, use puckBearingEnabled={true} puckBearing="heading" instead',
-    );
-
-    baseProps = {
-      ...baseProps,
-      puckBearingEnabled: true,
-      puckBearing: 'heading',
-    };
-  }
-  const actualProps = { ...baseProps, ...rest };
-  return <RNMBXNativeUserLocation {...actualProps} />;
-});
-
-function _pulsingToNative(
-  pulsing: Props['pulsing'],
-): NativeProps['pulsing'] | undefined {
-  if (pulsing === 'default') {
-    return { kind: 'default' };
-  }
-  if (pulsing == null) {
-    return undefined;
-  }
-  const { color, isEnabled, radius } = pulsing;
-  return {
-    color: processColor(color),
-    isEnabled,
-    radius,
-  };
-}
-
-export default LocationPuck;

package/src/components/ModelLayer.tsx

@@ -1,107 +0,0 @@
-import React from 'react';
-import { NativeModules } from 'react-native';
-
-import { FilterExpression, ModelLayerStyleProps } from '../utils/MapboxStyles';
-import { StyleValue } from '../utils/StyleValue';
-import RNMBXModelLayerNativeComponent from '../specs/RNMBXModelLayerNativeComponent';
-
-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 en 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?: ModelLayerStyleProps;
-};
-
-type NativeTypeProps = Omit<Props, 'style'> & {
-  reactStyle?: { [key: string]: StyleValue };
-};
-
-/**
- * ModelLayer is a style layer that renders one or more stroked polylines on the map.
- */
-class ModelLayer extends AbstractLayer<Props, NativeTypeProps> {
-  static defaultProps = {
-    sourceID: Mapbox.StyleSource.DefaultSourceID,
-  };
-
-  render() {
-    const props = {
-      ...this.baseProps,
-      sourceLayerID: this.props.sourceLayerID,
-    };
-    return (
-      <RNMBXModelLayerNativeComponent ref={this.setNativeLayer} {...props} />
-    );
-  }
-}
-
-export default ModelLayer;

package/src/components/Models.tsx

@@ -1,44 +0,0 @@
-import React from 'react';
-import { Image } from 'react-native';
-
-import NativeModels from '../specs/RNMBXModelsNativeComponent';
-
-type Props = {
-  /**
-   * pair odf model name to gltf and gbl file path/url, or asset id.
-   */
-  models: { [key: string]: string | number };
-};
-
-type Asset = {
-  __packager_asset?: boolean;
-  uri?: string;
-  url?: string;
-};
-
-function _resolveAssets(models: Props['models']): {
-  [key: string]: Asset;
-} {
-  const resolvedModels: { [key: string]: Asset } = {};
-  Object.keys(models).forEach((key) => {
-    const model = models[key];
-    if (typeof model === 'string') {
-      resolvedModels[key] = { url: model };
-    } else {
-      const asset = Image.resolveAssetSource(model);
-      if (!asset) {
-        throw new Error(`Could not resolve model asset: ${model}`);
-      }
-      resolvedModels[key] = asset;
-    }
-  });
-  return resolvedModels;
-}
-
-/**
- * Name of 3D model assets to be used in the map
- */
-export default function Models(props: Props) {
-  const { models, ...restOfProps } = props;
-  return <NativeModels {...restOfProps} models={_resolveAssets(models)} />;
-}

package/src/components/Viewport.tsx

@@ -1,330 +0,0 @@
-import React, {
-  Component,
-  forwardRef,
-  memo,
-  useEffect,
-  useImperativeHandle,
-  useMemo,
-  useRef,
-} from 'react';
-import {
-  NodeHandle,
-  findNodeHandle,
-  type NativeMethods,
-  type NativeSyntheticEvent,
-} from 'react-native';
-
-import NativeViewport, {
-  type NativeViewportReal,
-  type OnStatusChangedEventTypeReal,
-} from '../specs/RNMBXViewportNativeComponent';
-import RNMBXViewportModule from '../specs/NativeRNMBXViewportModule';
-
-type FollowPuckOptions = {
-  /**
-   * The value to use for setting zoom. If 'keep', zoom will not be modified by the FollowPuckViewportState.
-   * @default DEFAULT_FOLLOW_PUCK_VIEWPORT_STATE_ZOOM.
-   */
-  zoom?: number | 'keep';
-
-  /**
-   * The value to use for setting pitch. If 'keep', pitch will not be modified by the FollowPuckViewportState.
-   * @default DEFAULT_FOLLOW_PUCK_VIEWPORT_STATE_PITCH degrees.
-   */
-  pitch?: number | 'keep';
-
-  /**
-   * Indicates how to obtain the value to use for bearing when setting the camera.
-   * If set to 'keep', bearing will not be modified by the FollowPuckViewportState.
-   *  - heading: sets bearing to the heading of the device
-   *  - course: sets bearing based on the direction of travel
-   *  - number: sets the camera bearing to the constant value on every frame
-   *
-   * On Android, 'heading' and 'coruse' sets the camera bearing to the same as the location puck's bearing. See
-   * [syncWithLocationPuck](https://docs.mapbox.com/android/maps/api/11.0.0/mapbox-maps-android/com.mapbox.maps.plugin.viewport.data/-follow-puck-viewport-state-bearing/-sync-with-location-puck/)
-   *
-   * @default 'heading'
-   */
-  bearing?: 'heading' | 'course' | number | 'keep';
-
-  /**
-   * The value to use for setting CameraOptions.padding. If 'keep', padding will not be modified by the FollowPuckViewportState.
-   *
-   * @default 0 padding
-   */
-  padding?:
-    | {
-        top?: number;
-        left?: number;
-        bottom?: number;
-        right?: number;
-      }
-    | 'keep';
-};
-
-type OverviewOptions = {
-  /**
-   * The geometry that the ``OverviewViewportState`` should use when calculating its camera.
-   */
-  geometry: GeoJSON.Geometry;
-
-  /**
-   * The padding that ``OverviewViewportState`` should use when calculating its camera.
-   *
-   * @default 0 padding
-   */
-  padding?: {
-    top?: number;
-    left?: number;
-    bottom?: number;
-    right?: number;
-  };
-
-  /**
-   * The bearing that ``OverviewViewportState`` should use when calcualting its camera.
-   */
-  bearing?: number;
-
-  /**
-   * The pitch that ``OverviewViewportState`` should use when calculating its camera.
-   */
-  pitch?: number;
-
-  /**
-   * The length of the animation performed by in seconds ``OverviewViewportState`` when it starts updating
-   * the camera.
-   */
-  animationDuration?: number;
-};
-
-type ViewportState =
-  | {
-      kind: 'followPuck';
-      options?: FollowPuckOptions;
-    }
-  | {
-      kind: 'overview';
-      options?: OverviewOptions;
-    };
-
-type ViewportStatus =
-  | {
-      kind: 'idle';
-    }
-  | {
-      kind: 'transition';
-      toState: ViewportState;
-      transition: ViewportTransition;
-    };
-
-type ViewportTransition =
-  | {
-      kind: 'immediate';
-    }
-  | {
-      kind: 'default';
-      maxDurationMs?: number;
-    };
-
-type ViewportStatusChangeReason =
-  | 'TransitionStarted'
-  | 'TransitionSucceeded'
-  | 'IdleRequested'
-  | 'UserInteraction';
-
-type ViewportStatusChangedEvent = {
-  from: ViewportStatus;
-  to: ViewportStatus;
-  reason: ViewportStatusChangeReason;
-};
-
-type Props = {
-  /**
-   * Indicates whether the Viewport should idle when the MapView receives touch input.
-   *
-   * Set this property to false to enable building custom ViewportStates that can work simultaneously with certain types of gestures.
-   *
-   * Defaults to true.
-   */
-  transitionsToIdleUponUserInteraction?: boolean;
-
-  /**
-   * Subscribes to status changes, will be called when the status changes.
-   *
-   * Observers are notified of status changes asynchronously on the main queue.
-   * This means that by the time the notification is delivered, the status may have already changed again.
-   * This behavior is necessary to allow observers to trigger further transitions while avoiding out-of-order
-   * delivery of status changed notifications.
-   *
-   */
-  onStatusChanged?: (event: ViewportStatusChangedEvent) => void;
-};
-
-export interface Ref {
-  getState(): Promise<string>;
-  idle(): Promise<void>;
-  transitionTo(
-    state: ViewportState,
-    transition?: ViewportTransition,
-  ): Promise<boolean>;
-}
-
-/**
- * provides a structured approach to organizing camera management logic into states and transitions between them.
- *
- * At any given time, the viewport is either:
- *  - idle
- *  - in a state (camera is being managed by a ViewportState)
- *  - transitioning between states
- *
- * See [android](https://docs.mapbox.com/android/maps/api/${ANDROID_SDK_VERSION}/mapbox-maps-android/com.mapbox.maps.plugin.viewport/viewport.html),
- * [ios](https://docs.mapbox.com/ios/maps/api/${IOS_SDK_VERSION}/Viewport.html#/s:10MapboxMaps8ViewportC)
- */
-export const Viewport = memo(
-  forwardRef<Ref, Props>((props: Props, ref: React.ForwardedRef<Ref>) => {
-    const commands = useMemo(() => new NativeCommands(RNMBXViewportModule), []);
-    const nativeViewport = useRef<RNMBXViewportRefType>(null);
-    useEffect(() => {
-      if (nativeViewport.current) {
-        commands.setNativeRef(nativeViewport.current);
-      }
-      // eslint-disable-next-line react-hooks/exhaustive-deps
-    }, [commands, nativeViewport.current]);
-
-    useImperativeHandle(ref, () => ({
-      getState() {
-        console.log(' => calling getState');
-        return commands.call<string>('getState', []);
-      },
-      async idle() {
-        return commands.call<void>('idle', []);
-      },
-      transitionTo(state, transition) {
-        return commands.call<boolean>('transitionTo', [state, transition]);
-      },
-    }));
-
-    const onStatusChangedNative = useMemo(() => {
-      const propsOnStatusChanged = props.onStatusChanged;
-      if (propsOnStatusChanged != null) {
-        return (event: NativeSyntheticEvent<OnStatusChangedEventTypeReal>) => {
-          propsOnStatusChanged(event.nativeEvent.payload);
-        };
-      } else {
-        return undefined;
-      }
-    }, [props.onStatusChanged]);
-
-    return (
-      <RNMBXViewport
-        {...props}
-        hasStatusChanged={props.onStatusChanged != null}
-        onStatusChanged={onStatusChangedNative}
-        ref={nativeViewport}
-      />
-    );
-  }),
-);
-export type Viewport = Ref;
-
-type NativeProps = Omit<Props, 'onStatusChanged'> & {
-  hasStatusChanged: boolean;
-  onStatusChanged?: (
-    event: NativeSyntheticEvent<{
-      type: string;
-      payload: ViewportStatusChangedEvent;
-    }>,
-  ) => void;
-};
-
-type RNMBXViewportRefType = Component<NativeProps> & Readonly<NativeMethods>;
-
-const RNMBXViewport = NativeViewport as NativeViewportReal;
-
-export type NativeArg =
-  | string
-  | number
-  | boolean
-  | null
-  | { [k: string]: NativeArg }
-  | NativeArg[]
-  // eslint-disable-next-line @typescript-eslint/ban-types
-  | Function
-  | GeoJSON.Geometry
-  | undefined;
-
-type FunctionKeys<T> = keyof {
-  // eslint-disable-next-line @typescript-eslint/ban-types
-  [K in keyof T as T[K] extends Function ? K : never]: T[K];
-};
-
-type RefType = React.Component;
-
-class NativeCommands<Spec extends object> {
-  module: Spec;
-
-  preRefMethodQueue: Array<{
-    method: { name: FunctionKeys<Spec>; args: NativeArg[] };
-    resolver: (value: unknown) => void;
-  }>;
-
-  nativeRef: RefType | undefined;
-
-  constructor(module: Spec) {
-    this.module = module;
-    this.preRefMethodQueue = [];
-  }
-
-  async setNativeRef(nativeRef: RefType) {
-    if (nativeRef) {
-      this.nativeRef = nativeRef;
-      while (this.preRefMethodQueue.length > 0) {
-        const item = this.preRefMethodQueue.pop();
-
-        if (item && item.method && item.resolver) {
-          const res = await this._call(
-            item.method.name,
-            nativeRef,
-            item.method.args,
-          );
-          item.resolver(res);
-        }
-      }
-    }
-  }
-
-  call<T>(name: FunctionKeys<Spec>, args: NativeArg[]): Promise<T> {
-    if (this.nativeRef) {
-      return this._call(name, this.nativeRef, args);
-    } else {
-      return new Promise((resolve) => {
-        this.preRefMethodQueue.push({
-          method: { name, args },
-          resolver: resolve as (args: unknown) => void,
-        });
-      });
-    }
-  }
-
-  _call<T>(
-    name: FunctionKeys<Spec>,
-    nativeRef: RefType,
-    args: NativeArg[],
-  ): Promise<T> {
-    const handle = findNodeHandle(nativeRef);
-    if (handle) {
-      return (
-        this.module[name] as (
-          arg0: NodeHandle,
-          ...args: NativeArg[]
-        ) => Promise<T>
-      )(handle, ...args);
-    } else {
-      throw new Error(
-        `Could not find handle for native ref ${module} when trying to invoke ${String(
-          name,
-        )}`,
-      );
-    }
-  }
-}

package/src/components/codeparts/LayerPropsCommon.codepart-tsx

@@ -1,62 +0,0 @@
-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 en 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;
-};