@maplibre/maplibre-react-native 10.0.0-beta.12 → 10.0.0-beta.14

package/src/hooks/useAbstractLayer.ts

@@ -1,4 +1,4 @@
-import { useMemo, useRef } from "react";
+import { type Component, useMemo, useRef } from "react";
 import { processColor, type NativeMethods } from "react-native";
 
 import { type BaseProps } from "../types/BaseProps";
@@ -60,7 +60,7 @@ export interface NativeBaseProps {
   reactStyle?: { [key: string]: StyleValue };
 }
 
-export default function useAbstractLayer<
+export function useAbstractLayer<
   Props extends BaseProps,
   NativeProps extends NativeBaseProps,
 >(
@@ -68,13 +68,13 @@ export default function useAbstractLayer<
 ): {
   baseProps: Props & BaseLayerProps;
   setNativeLayer: (
-    instance: (React.Component<NativeProps> & Readonly<NativeMethods>) | null,
+    instance: (Component<NativeProps> & Readonly<NativeMethods>) | null,
   ) => void;
   getStyleTypeFormatter: (styleType: string) => typeof processColor | undefined;
   setNativeProps: (nativeProps: { [key: string]: unknown }) => void;
 } {
   const nativeLayer = useRef<
-    (React.Component<NativeProps> & Readonly<NativeMethods>) | null
+    (Component<NativeProps> & Readonly<NativeMethods>) | null
   >(null);
 
   const baseProps = useMemo(() => {
@@ -94,7 +94,7 @@ export default function useAbstractLayer<
   }, [props]);
 
   const setNativeLayer = (
-    instance: (React.Component<NativeProps> & Readonly<NativeMethods>) | null,
+    instance: (Component<NativeProps> & Readonly<NativeMethods>) | null,
   ): void => {
     nativeLayer.current = instance;
   };

package/src/hooks/useAbstractSource.ts

@@ -1,21 +1,21 @@
-import { useRef } from "react";
+import { Component, useRef } from "react";
 import { type NativeMethods } from "react-native";
 
-export default function useAbstractSource<NativePropsType extends object>(): {
+export function useAbstractSource<NativePropsType extends object>(): {
   _nativeRef:
-    | (React.Component<NativePropsType> & Readonly<NativeMethods>)
+    | (Component<NativePropsType> & Readonly<NativeMethods>)
     | undefined;
   setNativeRef: (
-    instance: React.Component<NativePropsType> & Readonly<NativeMethods>,
+    instance: Component<NativePropsType> & Readonly<NativeMethods>,
   ) => void;
   setNativeProps: (nativeProps: NativePropsType) => void;
 } {
   const _nativeRef = useRef<
-    (React.Component<NativePropsType> & Readonly<NativeMethods>) | undefined
+    (Component<NativePropsType> & Readonly<NativeMethods>) | undefined
   >(undefined);
 
   const setNativeRef = (
-    instance: React.Component<NativePropsType> & Readonly<NativeMethods>,
+    instance: Component<NativePropsType> & Readonly<NativeMethods>,
   ): void => {
     _nativeRef.current = instance;
   };

package/src/hooks/useNativeBridge.ts

@@ -1,4 +1,9 @@
-import { Component, type SyntheticEvent, useRef } from "react";
+import {
+  Component,
+  type MutableRefObject,
+  type SyntheticEvent,
+  useRef,
+} from "react";
 
 import { runNativeCommand, isAndroid, type NativeArg } from "../utils";
 
@@ -12,8 +17,8 @@ let callbackIncrement = 0;
 type UseNativeBridge = {
   _nativeModuleName: string;
   _onAndroidCallback: (e: SyntheticEvent<Element, RNMLEvent>) => void;
-  _callbackMap: React.MutableRefObject<Map<string, any>>;
-  _preRefMapMethodQueue: React.MutableRefObject<any[]>;
+  _callbackMap: MutableRefObject<Map<string, any>>;
+  _preRefMapMethodQueue: MutableRefObject<any[]>;
   _addAddAndroidCallback: <ReturnType>(
     id: string,
     resolve: (value: ReturnType) => void,
@@ -30,7 +35,7 @@ type UseNativeBridge = {
   ) => Promise<ReturnType>;
 };
 
-const useNativeBridge: (moduleName: string) => UseNativeBridge = (
+export const useNativeBridge: (moduleName: string) => UseNativeBridge = (
   _nativeModuleName: string,
 ) => {
   const _callbackMap = useRef<Map<string, any>>(new Map());
@@ -121,5 +126,3 @@ const useNativeBridge: (moduleName: string) => UseNativeBridge = (
     _runNativeCommand,
   };
 };
-
-export default useNativeBridge;

package/src/hooks/useNativeRef.ts

@@ -1,4 +1,4 @@
-import { Component, useRef } from "react";
+import { Component, type RefObject, useRef } from "react";
 import { type NativeMethods } from "react-native";
 
 export type NativeRef<NativeProps> = Component<NativeProps> &
@@ -7,7 +7,7 @@ export type NativeRef<NativeProps> = Component<NativeProps> &
 /**
  * Separate  module which allows to be mocked in tests.
  */
-export function useNativeRef<NativeProps = object>(): React.RefObject<
+export function useNativeRef<NativeProps = object>(): RefObject<
   NativeRef<NativeProps>
 > {
   return useRef<NativeRef<NativeProps>>(null);

package/src/hooks/useOnce.ts

@@ -1,6 +1,8 @@
 import { useRef } from "react";
 
-const useOnce: (callback: () => void) => void = (callback: () => void) => {
+export const useOnce: (callback: () => void) => void = (
+  callback: () => void,
+) => {
   const once = useRef(false);
 
   if (!once.current) {
@@ -8,5 +10,3 @@ const useOnce: (callback: () => void) => void = (callback: () => void) => {
     callback();
   }
 };
-
-export default useOnce;

package/src/index.ts

@@ -1,4 +1,7 @@
 import * as MapLibreRN from "./MapLibreRN";
 export * from "./MapLibreRN";
 
+/**
+ * @deprecated Use named imports or `import * as MapLibreRN` instead
+ */
 export default MapLibreRN;

package/src/modules/location/{locationManager.ts → LocationManager.ts}

@@ -4,26 +4,26 @@ import {
   type EmitterSubscription,
 } from "react-native";
 
-const MapLibreRN = NativeModules.MLRNModule;
+const MLRNModule = NativeModules.MLRNModule;
 const MLRNLocationModule = NativeModules.MLRNLocationModule;
 
 export const LocationModuleEventEmitter = new NativeEventEmitter(
   MLRNLocationModule,
 );
 
-/**
- * Location sent by locationManager
+/*
+ * Location sent by LocationManager
  */
 export interface Location {
   coords: Coordinates;
   timestamp?: number;
 }
 
-/**
- * Coorinates sent by locationManager
+/*
+ * Coordinates sent by LocationManager
  */
 interface Coordinates {
-  /**
+  /*
    * The heading (measured in degrees) relative to true north.
    * Heading is used to describe the direction the device is pointing to (the value of the compass).
    * Note that on Android this is incorrectly reporting the course value as mentioned in issue https://github.com/rnmapbox/maps/issues/1213
@@ -31,33 +31,33 @@ interface Coordinates {
    */
   heading?: number;
 
-  /**
+  /*
    * The direction in which the device is traveling, measured in degrees and relative to due north.
    * The course refers to the direction the device is actually moving (not the same as heading).
    */
   course?: number;
 
-  /**
+  /*
    * The instantaneous speed of the device, measured in meters per second.
    */
   speed?: number;
 
-  /**
+  /*
    * The latitude in degrees.
    */
   latitude: number;
 
-  /**
+  /*
    * The longitude in degrees.
    */
   longitude: number;
 
-  /**
+  /*
    * The radius of uncertainty for the location, measured in meters.
    */
   accuracy?: number;
 
-  /**
+  /*
    * The altitude, measured in meters.
    */
   altitude?: number;
@@ -88,7 +88,7 @@ class LocationManager {
       try {
         lastKnownLocation = await MLRNLocationModule.getLastKnownLocation();
       } catch (error) {
-        console.log("locationManager Error: ", error);
+        console.log("LocationManager Error: ", error);
       }
 
       if (!this._lastKnownLocation && lastKnownLocation) {
@@ -129,7 +129,7 @@ class LocationManager {
       MLRNLocationModule.start(displacement);
 
       this.subscription = LocationModuleEventEmitter.addListener(
-        MapLibreRN.LocationCallbackName.Update,
+        MLRNModule.LocationCallbackName.Update,
         this.onUpdate,
       );
 
@@ -158,4 +158,5 @@ class LocationManager {
   }
 }
 
-export default new LocationManager();
+const locationManager = new LocationManager();
+export { locationManager as LocationManager };

package/src/modules/offline/OfflineCreatePackOptions.ts

@@ -9,7 +9,7 @@ export interface OfflineCreatePackInputOptions {
   metadata?: Record<string, any>;
 }
 
-class OfflineCreatePackOptions {
+export class OfflineCreatePackOptions {
   name: string;
   styleURL: string;
   bounds: string;
@@ -51,5 +51,3 @@ class OfflineCreatePackOptions {
     });
   }
 }
-
-export default OfflineCreatePackOptions;

package/src/modules/offline/{offlineManager.ts → OfflineManager.ts}

@@ -4,13 +4,14 @@ import {
   type EventSubscription,
 } from "react-native";
 
-import OfflineCreatePackOptions, {
+import {
+  OfflineCreatePackOptions,
   type OfflineCreatePackInputOptions,
 } from "./OfflineCreatePackOptions";
-import OfflinePack, { type OfflinePackStatus } from "./OfflinePack";
+import { OfflinePack, type OfflinePackStatus } from "./OfflinePack";
 import { isUndefined, isFunction, isAndroid } from "../../utils";
 
-const MapLibreRN = NativeModules.MLRNModule;
+const MLRNModule = NativeModules.MLRNModule;
 const MLRNOfflineModule = NativeModules.MLRNOfflineModule;
 export const OfflineModuleEventEmitter = new NativeEventEmitter(
   MLRNOfflineModule,
@@ -67,7 +68,7 @@ class OfflineManager {
    * const progressListener = (offlineRegion, status) => console.log(offlineRegion, status);
    * const errorListener = (offlineRegion, err) => console.log(offlineRegion, err);
    *
-   * await MapLibreGL.offlineManager.createPack({
+   * await OfflineManager.createPack({
    *   name: 'offlinePack',
    *   styleURL: 'https://demotiles.maplibre.org/tiles/tiles.json',
    *   minZoom: 14,
@@ -106,9 +107,9 @@ class OfflineManager {
    * This is more efficient than deleting the offline pack and downloading it again. If the data stored locally matches that on the server, new data will not be downloaded.
    *
    * @example
-   * await MapLibreGL.offlineManager.invalidatePack('packName')
+   * await OfflineManager.invalidatePack('packName')
    *
-   * @param  {String}  name  Name of the offline pack.
+   * @param  {string}  name  Name of the offline pack.
    * @return {void}
    */
   async invalidatePack(name: string): Promise<void> {
@@ -128,9 +129,9 @@ class OfflineManager {
    * Unregisters the given offline pack and allows resources that are no longer required by any remaining packs to be potentially freed.
    *
    * @example
-   * await MapLibreGL.offlineManager.deletePack('packName')
+   * await OfflineManager.deletePack('packName')
    *
-   * @param  {String}  name  Name of the offline pack.
+   * @param  {string}  name  Name of the offline pack.
    * @return {void}
    */
   async deletePack(name: string): Promise<void> {
@@ -154,7 +155,7 @@ class OfflineManager {
    * It does not erase resources from the ambient cache or delete the database, which can be computationally expensive operations that may carry unintended side effects.
    *
    * @example
-   * await MapLibreGL.offlineManager.invalidateAmbientCache();
+   * await OfflineManager.invalidateAmbientCache();
    *
    * @return {void}
    */
@@ -168,7 +169,7 @@ class OfflineManager {
    * This method clears the cache and decreases the amount of space that map resources take up on the device.
    *
    * @example
-   * await MapLibreGL.offlineManager.clearAmbientCache();
+   * await OfflineManager.clearAmbientCache();
    *
    * @return {void}
    */
@@ -182,9 +183,9 @@ class OfflineManager {
    * This method may be computationally expensive because it will erase resources from the ambient cache if its size is decreased.
    *
    * @example
-   * await MapLibreGL.offlineManager.setMaximumAmbientCacheSize(5000000);
+   * await OfflineManager.setMaximumAmbientCacheSize(5000000);
    *
-   * @param  {Number}  size  Size of ambient cache.
+   * @param  {number}  size  Size of ambient cache.
    * @return {void}
    */
   async setMaximumAmbientCacheSize(size: number): Promise<void> {
@@ -196,7 +197,7 @@ class OfflineManager {
    * Deletes the existing database, which includes both the ambient cache and offline packs, then reinitializes it.
    *
    * @example
-   * await MapLibreGL.offlineManager.resetDatabase();
+   * await OfflineManager.resetDatabase();
    *
    * @return {void}
    */
@@ -209,7 +210,7 @@ class OfflineManager {
    * Retrieves all the current offline packs that are stored in the database.
    *
    * @example
-   * const offlinePacks = await MapLibreGL.offlineManager.getPacks();
+   * const offlinePacks = await OfflineManager.getPacks();
    *
    * @return {Array<OfflinePack>}
    */
@@ -225,9 +226,9 @@ class OfflineManager {
    * Retrieves an offline pack that is stored in the database by name.
    *
    * @example
-   * const offlinePack = await MapLibreGL.offlineManager.getPack();
+   * const offlinePack = await OfflineManager.getPack();
    *
-   * @param  {String}  name  Name of the offline pack.
+   * @param  {string}  name  Name of the offline pack.
    * @return {OfflinePack}
    */
   async getPack(name: string) {
@@ -239,9 +240,9 @@ class OfflineManager {
    * Sideloads offline db
    *
    * @example
-   * await MapLibreGL.offlineManager.mergeOfflineRegions(path);
+   * await OfflineManager.mergeOfflineRegions(path);
    *
-   * @param {String} path Path to offline tile db on file system.
+   * @param {string} path Path to offline tile db on file system.
    * @return {void}
    */
   async mergeOfflineRegions(path: string): Promise<void> {
@@ -254,9 +255,9 @@ class OfflineManager {
    * Consult the Terms of Service for your map tile host before changing this value.
    *
    * @example
-   * MapLibreGL.offlineManager.setTileCountLimit(1000);
+   * OfflineManager.setTileCountLimit(1000);
    *
-   * @param {Number} limit Map tile limit count.
+   * @param {number} limit Map tile limit count.
    * @return {void}
    */
   setTileCountLimit(limit: number): void {
@@ -268,9 +269,9 @@ class OfflineManager {
    * The default is 500ms.
    *
    * @example
-   * MapLibreGL.offlineManager.setProgressEventThrottle(500);
+   * OfflineManager.setProgressEventThrottle(500);
    *
-   * @param {Number} throttleValue event throttle value in ms.
+   * @param {number} throttleValue event throttle value in ms.
    * @return {void}
    */
   setProgressEventThrottle(throttleValue: number): void {
@@ -284,7 +285,7 @@ class OfflineManager {
    * @example
    * const progressListener = (offlinePack, status) => console.log(offlinePack, status)
    * const errorListener = (offlinePack, err) => console.log(offlinePack, err)
-   * MapLibreGL.offlineManager.subscribe('packName', progressListener, errorListener)
+   * OfflineManager.subscribe('packName', progressListener, errorListener)
    *
    * @param  {string} packName           Name of the offline pack.
    * @param  {ProgressListener} progressListener Callback that listens for status events while downloading the offline resource.
@@ -300,7 +301,7 @@ class OfflineManager {
     if (isFunction(progressListener)) {
       if (totalProgressListeners === 0) {
         this.subscriptionProgress = OfflineModuleEventEmitter.addListener(
-          MapLibreRN.OfflineCallbackName.Progress,
+          MLRNModule.OfflineCallbackName.Progress,
           this._onProgress,
         );
       }
@@ -311,7 +312,7 @@ class OfflineManager {
     if (isFunction(errorListener)) {
       if (totalErrorListeners === 0) {
         this.subscriptionError = OfflineModuleEventEmitter.addListener(
-          MapLibreRN.OfflineCallbackName.Error,
+          MLRNModule.OfflineCallbackName.Error,
           this._onError,
         );
       }
@@ -335,9 +336,9 @@ class OfflineManager {
    * It's a good idea to call this on componentWillUnmount.
    *
    * @example
-   * MapLibreGL.offlineManager.unsubscribe('packName')
+   * OfflineManager.unsubscribe('packName')
    *
-   * @param  {String} packName Name of the offline pack.
+   * @param  {string} packName Name of the offline pack.
    * @return {void}
    */
   unsubscribe(packName: string): void {
@@ -390,7 +391,7 @@ class OfflineManager {
     }
 
     // cleanup listeners now that they are no longer needed
-    if (state === MapLibreRN.OfflinePackDownloadState.Complete) {
+    if (state === MLRNModule.OfflinePackDownloadState.Complete) {
       this.unsubscribe(name);
     }
   }
@@ -421,4 +422,4 @@ class OfflineManager {
 }
 
 const offlineManager = new OfflineManager();
-export default offlineManager;
+export { offlineManager as OfflineManager };

package/src/modules/offline/OfflinePack.ts

@@ -1,6 +1,6 @@
 import { NativeModules } from "react-native";
 
-import OfflineCreatePackOptions from "./OfflineCreatePackOptions";
+import { OfflineCreatePackOptions } from "./OfflineCreatePackOptions";
 
 const MLRNOfflineModule = NativeModules.MLRNOfflineModule;
 
@@ -15,7 +15,7 @@ export type OfflinePackStatus = {
   requiredResourceCount: number;
 };
 
-class OfflinePack {
+export class OfflinePack {
   private pack: OfflineCreatePackOptions;
   private _metadata: Record<string, any> | null;
 
@@ -52,5 +52,3 @@ class OfflinePack {
     return MLRNOfflineModule.pausePackDownload(this.name);
   }
 }
-
-export default OfflinePack;

package/src/modules/snapshot/{snapshotManager.ts → SnapshotManager.ts}

@@ -1,11 +1,11 @@
 import { NativeModules } from "react-native";
 
-import SnapshotOptions, { type SnapshotInputOptions } from "./SnapshotOptions";
+import { SnapshotOptions, type SnapshotInputOptions } from "./SnapshotOptions";
 
 const MLRNSnapshotModule = NativeModules.MLRNSnapshotModule;
 
 /**
- * The snapshotManager generates static raster images of the map.
+ * The SnapshotManager generates static raster images of the map.
  * Each snapshot image depicts a portion of a map defined by an SnapshotOptions object you provide.
  * The snapshotter generates the snapshot asynchronous.
  */
@@ -16,35 +16,35 @@ class SnapshotManager {
    * @example
    *
    * // creates a temp file png of base map
-   * const uri = await MapLibreGL.snapshotManager.takeSnap({
+   * const uri = await SnapshotManager.takeSnap({
    *   centerCoordinate: [-74.126410, 40.797968],
    *   width: width,
    *   height: height,
    *   zoomLevel: 12,
    *   pitch: 30,
    *   heading: 20,
-   *   styleURL: MapLibreGL.StyleURL.Default,
+   *   styleURL: StyleURL.Default,
    *   writeToDisk: true, // Create a temporary file
    * });
    *
    * // creates base64 png of base map without logo
-   * const uri = await MapLibreGL.snapshotManager.takeSnap({
+   * const uri = await SnapshotManager.takeSnap({
    *   centerCoordinate: [-74.126410, 40.797968],
    *   width: width,
    *   height: height,
    *   zoomLevel: 12,
    *   pitch: 30,
    *   heading: 20,
-   *   styleURL: MapLibreGL.StyleURL.Default,
+   *   styleURL: StyleURL.Default,
    *   withLogo: false, // Disable Mapbox logo (Android only)
    * });
    *
    * // creates snapshot with bounds
-   * const uri = await MapLibreGL.snapshotManager.takeSnap({
+   * const uri = await SnapshotManager.takeSnap({
    *   bounds: [[-74.126410, 40.797968], [-74.143727, 40.772177]],
    *   width: width,
    *   height: height,
-   *   styleURL: MapLibreGL.StyleURL.Default,
+   *   styleURL: StyleURL.Default,
    * });
    *
    * @param  {SnapshotOptions}  options Snapshot options for create a static image of the base map
@@ -59,4 +59,4 @@ class SnapshotManager {
 }
 
 const snapshotManager = new SnapshotManager();
-export default snapshotManager;
+export { snapshotManager as SnapshotManager };

package/src/modules/snapshot/SnapshotOptions.ts

@@ -3,7 +3,7 @@ import { NativeModules } from "react-native";
 
 import { toJSONString } from "../../utils";
 
-const MapLibreRN = NativeModules.MLRNModule;
+const MLRNModule = NativeModules.MLRNModule;
 
 export interface SnapshotInputOptions {
   centerCoordinate?: GeoJSON.Position;
@@ -50,7 +50,7 @@ export class SnapshotOptions {
       );
     }
 
-    this.styleURL = options.styleURL || MapLibreRN.StyleURL.Default;
+    this.styleURL = options.styleURL || MLRNModule.StyleURL.Default;
     this.heading = options.heading || 0.0;
     this.pitch = options.pitch || 0.0;
     this.zoomLevel = options.zoomLevel || 16.0;
@@ -99,5 +99,3 @@ export class SnapshotOptions {
     return toJSONString(featureCollection(features));
   }
 }
-
-export default SnapshotOptions;