@maplibre/maplibre-react-native 10.0.0-alpha.8 → 10.0.0-beta.1

package/javascript/modules/location/locationManager.ts

@@ -1,162 +0,0 @@
-import {
-  NativeModules,
-  NativeEventEmitter,
-  EmitterSubscription,
-} from 'react-native';
-
-const MapLibreGL = NativeModules.MLNModule;
-const MapLibreGLLocationManager = NativeModules.MLNLocationModule;
-
-export const LocationModuleEventEmitter = new NativeEventEmitter(
-  MapLibreGLLocationManager,
-);
-
-/**
- * Location sent by locationManager
- */
-export interface Location {
-  coords: Coordinates;
-  timestamp?: number;
-}
-
-/**
- * Coorinates 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
-   * and will be corrected in a future update.
-   */
-  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;
-}
-
-class LocationManager {
-  _listeners: ((location: Location) => void)[];
-  _lastKnownLocation: Location | null;
-  _isListening: boolean;
-  subscription: EmitterSubscription | null;
-
-  constructor() {
-    this._listeners = [];
-    this._lastKnownLocation = null;
-    this._isListening = false;
-    this.onUpdate = this.onUpdate.bind(this);
-    this.subscription = null;
-  }
-
-  async getLastKnownLocation(): Promise<Location | null> {
-    if (!this._lastKnownLocation) {
-      let lastKnownLocation;
-
-      // as location can be brittle it might happen,
-      // that we get an exception from native land
-      // let's silently catch it and simply log out
-      // instead of throwing an exception
-      try {
-        lastKnownLocation =
-          await MapLibreGLLocationManager.getLastKnownLocation();
-      } catch (error) {
-        console.log('locationManager Error: ', error);
-      }
-
-      if (!this._lastKnownLocation && lastKnownLocation) {
-        this._lastKnownLocation = lastKnownLocation;
-      }
-    }
-
-    return this._lastKnownLocation;
-  }
-
-  addListener(listener: (location: Location) => void): void {
-    if (!this._isListening) {
-      this.start();
-    }
-    if (!this._listeners.includes(listener)) {
-      this._listeners.push(listener);
-
-      if (this._lastKnownLocation) {
-        listener(this._lastKnownLocation);
-      }
-    }
-  }
-
-  removeListener(listener: (location: Location) => void): void {
-    this._listeners = this._listeners.filter(l => l !== listener);
-    if (this._listeners.length === 0) {
-      this.stop();
-    }
-  }
-
-  removeAllListeners(): void {
-    this._listeners = [];
-    this.stop();
-  }
-
-  start(displacement = 0): void {
-    if (!this._isListening) {
-      MapLibreGLLocationManager.start(displacement);
-
-      this.subscription = LocationModuleEventEmitter.addListener(
-        MapLibreGL.LocationCallbackName.Update,
-        this.onUpdate,
-      );
-
-      this._isListening = true;
-    }
-  }
-
-  stop(): void {
-    MapLibreGLLocationManager.stop();
-
-    if (this._isListening) {
-      this.subscription?.remove();
-    }
-
-    this._isListening = false;
-  }
-
-  setMinDisplacement(minDisplacement: number): void {
-    MapLibreGLLocationManager.setMinDisplacement(minDisplacement);
-  }
-
-  onUpdate(location: Location): void {
-    this._lastKnownLocation = location;
-
-    this._listeners.forEach(l => l(location));
-  }
-}
-
-export default new LocationManager();

package/javascript/modules/offline/OfflineCreatePackOptions.ts

@@ -1,62 +0,0 @@
-import {makeLatLngBounds} from '../../utils/geoUtils';
-import {toJSONString} from '../../utils';
-
-export interface OfflineCreatePackInputOptions {
-  name: string;
-  styleURL: string;
-  bounds: [GeoJSON.Position, GeoJSON.Position];
-  minZoom?: number;
-  maxZoom?: number;
-  metadata?: Record<string, any>;
-}
-
-class OfflineCreatePackOptions {
-  name: string;
-  styleURL: string;
-  bounds: string;
-  minZoom?: number;
-  maxZoom?: number;
-  metadata: string;
-
-  constructor(options: OfflineCreatePackInputOptions) {
-    this._assert(options);
-
-    this.name = options.name;
-    this.styleURL = options.styleURL;
-    this.bounds = this._makeLatLngBounds(options.bounds);
-    this.minZoom = options.minZoom;
-    this.maxZoom = options.maxZoom;
-    this.metadata = this._makeMetadata(options.metadata);
-  }
-
-  _assert(options: OfflineCreatePackInputOptions): void {
-    if (!options.styleURL) {
-      throw new Error(
-        'Style URL must be provided for creating an offline pack',
-      );
-    }
-
-    if (!options.name) {
-      throw new Error('Name must be provided for creating an offline pack');
-    }
-
-    if (!options.bounds) {
-      throw new Error('Bounds must be provided for creating an offline pack');
-    }
-  }
-
-  _makeLatLngBounds(bounds: [GeoJSON.Position, GeoJSON.Position]): string {
-    const ne = bounds[0];
-    const sw = bounds[1];
-    return toJSONString(makeLatLngBounds(ne, sw));
-  }
-
-  _makeMetadata(metadata?: Record<string, any>): string {
-    return JSON.stringify({
-      ...metadata,
-      name: this.name,
-    });
-  }
-}
-
-export default OfflineCreatePackOptions;

package/javascript/modules/offline/OfflinePack.ts

@@ -1,56 +0,0 @@
-import OfflineCreatePackOptions from './OfflineCreatePackOptions';
-
-import {NativeModules} from 'react-native';
-
-const MapLibreGLOfflineManager = NativeModules.MLNOfflineModule;
-
-type OfflinePackStatus = {
-  name: string;
-  state: number;
-  percentage: number;
-  completedResourceCount: number;
-  completedResourceSize: number;
-  completedTileSize: number;
-  completedTileCount: number;
-  requiredResourceCount: number;
-};
-
-class OfflinePack {
-  private pack: OfflineCreatePackOptions;
-  private _metadata: Record<string, any> | null;
-
-  constructor(pack: OfflineCreatePackOptions) {
-    this.pack = pack;
-    this._metadata = null;
-  }
-
-  get name(): string | null {
-    const {metadata} = this;
-    return metadata && metadata.name;
-  }
-
-  get bounds(): string {
-    return this.pack.bounds;
-  }
-
-  get metadata(): Record<string, any> | null {
-    if (!this._metadata && this.pack.metadata) {
-      this._metadata = JSON.parse(this.pack.metadata);
-    }
-    return this._metadata;
-  }
-
-  status(): Promise<OfflinePackStatus> {
-    return MapLibreGLOfflineManager.getPackStatus(this.name);
-  }
-
-  resume(): Promise<void> {
-    return MapLibreGLOfflineManager.resumePackDownload(this.name);
-  }
-
-  pause(): Promise<void> {
-    return MapLibreGLOfflineManager.pausePackDownload(this.name);
-  }
-}
-
-export default OfflinePack;

package/javascript/modules/offline/offlineManager.ts

@@ -1,435 +0,0 @@
-import {isUndefined, isFunction, isAndroid} from '../../utils';
-
-import OfflineCreatePackOptions, {
-  OfflineCreatePackInputOptions,
-} from './OfflineCreatePackOptions';
-import OfflinePack from './OfflinePack';
-
-import {
-  NativeModules,
-  NativeEventEmitter,
-  EventSubscription,
-} from 'react-native';
-
-const MapLibreGL = NativeModules.MLNModule;
-const MapLibreGLOfflineManager = NativeModules.MLNOfflineModule;
-export const OfflineModuleEventEmitter = new NativeEventEmitter(
-  MapLibreGLOfflineManager,
-);
-
-export type OfflineProgressStatus = {
-  name: string;
-  state: number;
-  percentage: number;
-  completedResourceSize: number;
-  completedTileCount: number;
-  completedResourceCount: number;
-  requiredResourceCount: number;
-  completedTileSize: number;
-};
-
-export type OfflinePackError = {
-  name: string;
-  message: string;
-};
-
-type ErrorEvent = {
-  payload: OfflinePackError;
-};
-
-type ProgressEvent = {
-  payload: OfflineProgressStatus;
-};
-
-type ProgressListener = (
-  pack: OfflinePack,
-  status: OfflineProgressStatus,
-) => void;
-type ErrorListener = (pack: OfflinePack, err: OfflinePackError) => void;
-
-/**
- * OfflineManager implements a singleton (shared object) that manages offline packs.
- * All of this class’s instance methods are asynchronous, reflecting the fact that offline resources are stored in a database.
- * The shared object maintains a canonical collection of offline packs.
- */
-class OfflineManager {
-  _hasInitialized: boolean;
-  _offlinePacks: Record<string, OfflinePack>;
-  _progressListeners: Record<string, ProgressListener>;
-  _errorListeners: Record<string, ErrorListener>;
-  subscriptionProgress: EventSubscription | null;
-  subscriptionError: EventSubscription | null;
-
-  constructor() {
-    this._hasInitialized = false;
-    this._offlinePacks = {};
-
-    this._progressListeners = {};
-    this._errorListeners = {};
-
-    this._onProgress = this._onProgress.bind(this);
-    this._onError = this._onError.bind(this);
-
-    this.subscriptionProgress = null;
-    this.subscriptionError = null;
-  }
-
-  /**
-   * Creates and registers an offline pack that downloads the resources needed to use the given region offline.
-   *
-   * @example
-   *
-   * const progressListener = (offlineRegion, status) => console.log(offlineRegion, status);
-   * const errorListener = (offlineRegion, err) => console.log(offlineRegion, err);
-   *
-   * await MapLibreGL.offlineManager.createPack({
-   *   name: 'offlinePack',
-   *   styleURL: 'mapbox://...',
-   *   minZoom: 14,
-   *   maxZoom: 20,
-   *   bounds: [[neLng, neLat], [swLng, swLat]]
-   * }, progressListener, errorListener)
-   *
-   * @param  {OfflineCreatePackOptions} options Create options for a offline pack that specifices zoom levels, style url, and the region to download.
-   * @param  {Callback=} progressListener Callback that listens for status events while downloading the offline resource.
-   * @param  {Callback=} errorListener Callback that listens for status events while downloading the offline resource.
-   * @return {void}
-   */
-  async createPack(
-    options: OfflineCreatePackInputOptions,
-    progressListener: ProgressListener,
-    errorListener: ErrorListener,
-  ): Promise<void> {
-    await this._initialize();
-
-    const packOptions = new OfflineCreatePackOptions(options);
-
-    if (this._offlinePacks[packOptions.name]) {
-      throw new Error(
-        `Offline pack with name ${packOptions.name} already exists.`,
-      );
-    }
-
-    this.subscribe(packOptions.name, progressListener, errorListener);
-    const nativeOfflinePack =
-      await MapLibreGLOfflineManager.createPack(packOptions);
-    this._offlinePacks[packOptions.name] = new OfflinePack(nativeOfflinePack);
-  }
-
-  /**
-   * Invalidates the specified offline pack. This method checks that the tiles in the specified offline pack match those from the server. Local tiles that do not match the latest version on the server are updated.
-   *
-   * 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')
-   *
-   * @param  {String}  name  Name of the offline pack.
-   * @return {void}
-   */
-  async invalidatePack(name: string): Promise<void> {
-    if (!name) {
-      return;
-    }
-
-    await this._initialize();
-
-    const offlinePack = this._offlinePacks[name];
-    if (offlinePack) {
-      await MapLibreGLOfflineManager.invalidatePack(name);
-    }
-  }
-
-  /**
-   * 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')
-   *
-   * @param  {String}  name  Name of the offline pack.
-   * @return {void}
-   */
-  async deletePack(name: string): Promise<void> {
-    if (!name) {
-      return;
-    }
-
-    await this._initialize();
-
-    const offlinePack = this._offlinePacks[name];
-    if (offlinePack) {
-      await MapLibreGLOfflineManager.deletePack(name);
-      delete this._offlinePacks[name];
-    }
-  }
-
-  /**
-   * Forces a revalidation of the tiles in the ambient cache and downloads a fresh version of the tiles from the tile server.
-   * This is the recommend method for clearing the cache.
-   * This is the most efficient method because tiles in the ambient cache are re-downloaded to remove outdated data from a device.
-   * 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();
-   *
-   * @return {void}
-   */
-  async invalidateAmbientCache(): Promise<void> {
-    await this._initialize();
-    await MapLibreGLOfflineManager.invalidateAmbientCache();
-  }
-
-  /**
-   * Erases resources from the ambient cache.
-   * This method clears the cache and decreases the amount of space that map resources take up on the device.
-   *
-   * @example
-   * await MapLibreGL.offlineManager.clearAmbientCache();
-   *
-   * @return {void}
-   */
-  async clearAmbientCache(): Promise<void> {
-    await this._initialize();
-    await MapLibreGLOfflineManager.clearAmbientCache();
-  }
-
-  /**
-   * Sets the maximum size of the ambient cache in bytes. Disables the ambient cache if set to 0.
-   * 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);
-   *
-   * @param  {Number}  size  Size of ambient cache.
-   * @return {void}
-   */
-  async setMaximumAmbientCacheSize(size: number): Promise<void> {
-    await this._initialize();
-    await MapLibreGLOfflineManager.setMaximumAmbientCacheSize(size);
-  }
-
-  /**
-   * Deletes the existing database, which includes both the ambient cache and offline packs, then reinitializes it.
-   *
-   * @example
-   * await MapLibreGL.offlineManager.resetDatabase();
-   *
-   * @return {void}
-   */
-  async resetDatabase(): Promise<void> {
-    await this._initialize();
-    await MapLibreGLOfflineManager.resetDatabase();
-  }
-
-  /**
-   * Retrieves all the current offline packs that are stored in the database.
-   *
-   * @example
-   * const offlinePacks = await MapLibreGL.offlineManager.getPacks();
-   *
-   * @return {Array<OfflinePack>}
-   */
-  async getPacks(): Promise<OfflinePack[]> {
-    await this._initialize();
-    return Object.keys(this._offlinePacks).map(
-      name => this._offlinePacks[name],
-    );
-  }
-
-  /**
-   * Retrieves an offline pack that is stored in the database by name.
-   *
-   * @example
-   * const offlinePack = await MapLibreGL.offlineManager.getPack();
-   *
-   * @param  {String}  name  Name of the offline pack.
-   * @return {OfflinePack}
-   */
-  async getPack(name: string): Promise<OfflinePack> {
-    await this._initialize();
-    return this._offlinePacks[name];
-  }
-
-  /**
-   * Sideloads offline db
-   *
-   * @example
-   * await MapLibreGL.offlineManager.mergeOfflineRegions(path);
-   *
-   * @param {String} path Path to offline tile db on file system.
-   * @return {void}
-   */
-  async mergeOfflineRegions(path: string): Promise<void> {
-    await this._initialize();
-    return MapLibreGLOfflineManager.mergeOfflineRegions(path);
-  }
-
-  /**
-   * Sets the maximum number of tiles that may be downloaded and stored on the current device.
-   * Consult the Terms of Service for your map tile host before changing this value.
-   *
-   * @example
-   * MapLibreGL.offlineManager.setTileCountLimit(1000);
-   *
-   * @param {Number} limit Map tile limit count.
-   * @return {void}
-   */
-  setTileCountLimit(limit: number): void {
-    MapLibreGLOfflineManager.setTileCountLimit(limit);
-  }
-
-  /**
-   * Sets the period at which download status events will be sent over the React Native bridge.
-   * The default is 500ms.
-   *
-   * @example
-   * MapLibreGL.offlineManager.setProgressEventThrottle(500);
-   *
-   * @param {Number} throttleValue event throttle value in ms.
-   * @return {void}
-   */
-  setProgressEventThrottle(throttleValue: number): void {
-    MapLibreGLOfflineManager.setProgressEventThrottle(throttleValue);
-  }
-
-  /**
-   * Subscribe to download status/error events for the requested offline pack.
-   * Note that createPack calls this internally if listeners are provided.
-   *
-   * @example
-   * const progressListener = (offlinePack, status) => console.log(offlinePack, status)
-   * const errorListener = (offlinePack, err) => console.log(offlinePack, err)
-   * MapLibreGL.offlineManager.subscribe('packName', progressListener, errorListener)
-   *
-   * @param  {String} packName           Name of the offline pack.
-   * @param  {Callback} progressListener Callback that listens for status events while downloading the offline resource.
-   * @param  {Callback} errorListener      Callback that listens for status events while downloading the offline resource.
-   * @return {void}
-   */
-  async subscribe(
-    packName: string,
-    progressListener: ProgressListener,
-    errorListener: ErrorListener,
-  ): Promise<void> {
-    const totalProgressListeners = Object.keys(this._progressListeners).length;
-    if (isFunction(progressListener)) {
-      if (totalProgressListeners === 0) {
-        this.subscriptionProgress = OfflineModuleEventEmitter.addListener(
-          MapLibreGL.OfflineCallbackName.Progress,
-          this._onProgress,
-        );
-      }
-      this._progressListeners[packName] = progressListener;
-    }
-
-    const totalErrorListeners = Object.keys(this._errorListeners).length;
-    if (isFunction(errorListener)) {
-      if (totalErrorListeners === 0) {
-        this.subscriptionError = OfflineModuleEventEmitter.addListener(
-          MapLibreGL.OfflineCallbackName.Error,
-          this._onError,
-        );
-      }
-      this._errorListeners[packName] = errorListener;
-    }
-
-    // we need to manually set the pack observer on Android
-    // if we're resuming a pack download instead of going thru the create flow
-    if (isAndroid() && this._offlinePacks[packName]) {
-      try {
-        // manually set a listener, since listeners are only set on create flow
-        await MapLibreGLOfflineManager.setPackObserver(packName);
-      } catch (e) {
-        console.log('Unable to set pack observer', e);
-      }
-    }
-  }
-
-  /**
-   * Unsubscribes any listeners associated with the offline pack.
-   * It's a good idea to call this on componentWillUnmount.
-   *
-   * @example
-   * MapLibreGL.offlineManager.unsubscribe('packName')
-   *
-   * @param  {String} packName Name of the offline pack.
-   * @return {void}
-   */
-  unsubscribe(packName: string): void {
-    delete this._progressListeners[packName];
-    delete this._errorListeners[packName];
-
-    if (
-      Object.keys(this._progressListeners).length === 0 &&
-      this.subscriptionProgress
-    ) {
-      this.subscriptionProgress.remove();
-    }
-
-    if (
-      Object.keys(this._errorListeners).length === 0 &&
-      this.subscriptionError
-    ) {
-      this.subscriptionError.remove();
-    }
-  }
-
-  async _initialize(): Promise<boolean> {
-    if (this._hasInitialized) {
-      return true;
-    }
-
-    const nativeOfflinePacks = await MapLibreGLOfflineManager.getPacks();
-
-    for (const nativeOfflinePack of nativeOfflinePacks) {
-      const offlinePack = new OfflinePack(nativeOfflinePack);
-      if (offlinePack.name) {
-        this._offlinePacks[offlinePack.name] = offlinePack;
-      }
-    }
-
-    this._hasInitialized = true;
-    return true;
-  }
-
-  _onProgress(e: ProgressEvent): void {
-    const {name, state} = e.payload;
-
-    if (!this._hasListeners(name, this._progressListeners)) {
-      return;
-    }
-
-    const pack = this._offlinePacks[name];
-    this._progressListeners[name](pack, e.payload);
-
-    // cleanup listeners now that they are no longer needed
-    if (state === MapLibreGL.OfflinePackDownloadState.Complete) {
-      this.unsubscribe(name);
-    }
-  }
-
-  _onError(e: ErrorEvent): void {
-    const {name} = e.payload;
-
-    if (!this._hasListeners(name, this._errorListeners)) {
-      return;
-    }
-
-    const pack = this._offlinePacks[name];
-    this._errorListeners[name](pack, e.payload);
-  }
-
-  _hasListeners(
-    name: string,
-    listenerMap:
-      | Record<string, ProgressListener>
-      | Record<string, ErrorListener>,
-  ): boolean {
-    return (
-      !isUndefined(this._offlinePacks[name]) && isFunction(listenerMap[name])
-    );
-  }
-}
-
-const offlineManager = new OfflineManager();
-export default offlineManager;