@rnmapbox/maps 10.0.0-beta.28

package/README.md

@@ -0,0 +1,283 @@
+
+# Mapbox Maps SDK for React Native
+
+<table style="border: none; border-width: 0px">
+<tr style="border: none; border-width: 0px">
+<td style="border: none; border-width: 0px">
+<img src="./assets/mapbox_logo.png" height="75">
+</td>
+<td style="border: none; border-width: 0px">
+<img src="./assets/React-icon.svg" height="75">
+</td>
+</tr>
+</table>
+
+|  [![npm version](https://badge.fury.io/js/%40react-native-mapbox-gl%2Fmaps.svg)](https://badge.fury.io/js/%40react-native-mapbox-gl%2Fmaps)  | [![iOS & Android Build](https://github.com/rnmapbox/maps/actions/workflows/on-push.yml/badge.svg?branch=main)](https://github.com/rnmapbox/maps/actions/workflows/on-push.yml?branch=main)  |
+|---|---|
+
+
+
+_A community-supported, open-source React Native library for building maps with the [Mapbox Maps SDK for iOS](https://www.mapbox.com/ios-sdk/) and [Mapbox Maps SDK for Android](https://www.mapbox.com/android-sdk/)_
+
+---
+## News & Discussions
+#### <span style="color:red">&rarr;</span> Future of this repo: participate in the [discussion thread](https://github.com/rnmapbox/maps/discussions/1680)
+
+#### <span style="color:red">&rarr;</span> Call for additional maintainers [discussion thread](https://github.com/rnmapbox/maps/discussions/1551)
+
+#### <span style="color:red">&rarr;</span> This README is for the unreleased 10* branch. Please see [v8 branch](https://github.com/rnmapbox/maps/tree/v8) for documentation on 8.* releases
+---
+
+<table>
+<tr>
+<td colspan="2" align="center">
+<img src="./assets/intro-examples.png"/>
+</td>
+</tr>
+<tr>
+<td>
+<img src="./assets/beta-maps-example-point-annotation-960-d280759f6a3d8d75458f399c7a044926.webp" width="1200"/>
+</td>
+</tr>
+<tr>
+<td>
+<img src="./assets/beta-maps-guides-migrate-3d-terrain-960-48b1080117817ccfd92e434d0df7546f.webp" width="1200"/>
+</td>
+</tr>
+<tr>
+<td>
+<img src="./assets/maps-examples-building-extrusions-960-aaa140cce77da4e8b2dd216032b191b6.webp" width="1200"/>
+</td>
+</tr>
+
+<tr>
+<td>
+<img src="./assets/maps-examples-data-driven-symbols-960-2e2061a6b8127ef305c1b6c159f8dc65.webp" width="1200"/>
+</td>
+</tr>
+</table>
+
+---
+
+### Supported Implementations 
+At the moment, the following implementations are supported: 
+
+
+|*RNMapboxMapsImpl*|*Notes*|
+|----------------|-----|
+|mapbox|New [Mapbox v10](https://www.mapbox.com/mobile-maps-sdk) implementation (BETA)|
+|maplibre|[MapLibre](https://github.com/maplibre/maplibre-gl-native) opensource fork of Mapbox SDKs|
+|mapbox-gl|Legacy mapbox implementation [iOS](https://docs.mapbox.com/android/legacy/maps/guides/) [Android](https://docs.mapbox.com/ios/legacy/maps/guides/)|
+
+_See [iOS](ios/install.md) & [Android](android/install.md) setup guide for more details on setting `RNMapboxMapsImpl`_
+
+
+
+
+## Prerequisite
+
+1. On Android we support from version 6 (API 23) upwards
+2. Please [Sign Up to Mapbox](https://account.mapbox.com/auth/signup/) to get the Mapbox Access Token.
+
+
+## Dependencies
+
+- [node](https://nodejs.org)
+- [npm](https://www.npmjs.com/)
+- [React Native](https://facebook.github.io/react-native/) (0.60+)
+
+
+## Installation
+
+### Step 1 - Install Package:
+
+```sh
+# install with Yarn
+# yarn add @rnmapbox/maps
+yarn add rnmapbox/maps#main
+
+
+# or install with NPM
+# npm install @rnmapbox/maps --save
+npm install rnmapbox/maps#main --save
+
+```
+
+### Step 2 - Installation Guides:
+
+- [Android](/android/install.md)
+- [iOS](/ios/install.md)
+- [Expo](/plugin/install.md)
+- [Example](/example)
+
+
+### Getting Started
+For more information, check out our [Getting Started](/docs/GettingStarted.md) section
+
+## Run Project
+Before you run your project be sure you have completed the Installation Guides for Android or iOS.
+
+### Run iOS Simulator
+```sh
+# Run with yarn
+yarn run ios
+
+# or Run with NPM
+npm run ios
+```
+
+### Run Android Emulator
+```sh
+# Run with yarn
+yarn run android
+
+# or Run with NPM
+npm run android
+```
+
+## Adding a map
+
+```js
+import React, { Component } from 'react';
+import { StyleSheet, View } from 'react-native';
+import MapboxGL from '@rnmapbox/maps';
+
+MapboxGL.setAccessToken('<YOUR_ACCESSTOKEN>');
+
+const styles = StyleSheet.create({
+  page: {
+    flex: 1,
+    justifyContent: 'center',
+    alignItems: 'center',
+    backgroundColor: '#F5FCFF'
+  },
+  container: {
+    height: 300,
+    width: 300,
+    backgroundColor: 'tomato'
+  },
+  map: {
+    flex: 1
+  }
+});
+
+export default class App extends Component {
+  render() {
+    return (
+      <View style={styles.page}>
+        <View style={styles.container}>
+          <MapboxGL.MapView style={styles.map} />
+        </View>
+      </View>
+    );
+  }
+}
+```
+---
+## Documentation
+
+### Components
+
+- [MapView](/docs/MapView.md)
+- [Light](/docs/Light.md)
+- [StyleSheet](/docs/StyleSheet.md)
+- [PointAnnotation](/docs/PointAnnotation.md)
+- [MarkerView](/docs/MarkerView.md)
+- [Callout](/docs/Callout.md)
+- [Camera](docs/Camera.md)
+- [UserLocation](docs/UserLocation.md)
+- [Images](docs/Images.md)
+
+### Sources
+
+- [VectorSource](/docs/VectorSource.md)
+- [ShapeSource](/docs/ShapeSource.md)
+- [RasterSource](/docs/RasterSource.md)
+- [RasterDemSource](/docs/RasterDemSource.md)
+
+### Layers
+
+- [BackgroundLayer](/docs/BackgroundLayer.md)
+- [CircleLayer](/docs/CircleLayer.md)
+- [FillExtrusionLayer](/docs/FillExtrusionLayer.md)
+- [FillLayer](/docs/FillLayer.md)
+- [LineLayer](/docs/LineLayer.md)
+- [RasterLayer](/docs/RasterLayer.md)
+- [SymbolLayer](/docs/SymbolLayer.md)
+- [HeatmapLayer](/docs/HeatmapLayer.md)
+- [SkyLayer](/docs/SkyLayer.md)
+
+### Terrain
+
+- [Terrain](/docs/Terrain.md)
+- [Atmosphere](/docs/Atmosphere.md)
+
+### Offline
+
+- [OfflineManager](/docs/OfflineManager.md)
+- [SnapshotManager](/docs/snapshotManager.md)
+
+### Misc
+
+- [MapboxGL](/docs/MapboxGL.md)
+- [CustomHttpHeaders](/docs/CustomHttpHeaders.md)
+- [Logger](/docs/Logger.md)
+
+## Expo Support
+
+This package is not available in the [Expo Go](https://expo.io/client) app. Learn how you can use it with [custom dev clients](/plugin/install.md).
+
+## Testing with Jest
+
+This library provides some mocks which are necessary for running tests.
+
+Example:
+
+```json
+"jest": {
+  "preset": "react-native",
+  "setupFilesAfterEnv": ["@rnmapbox/maps/setup-jest"],
+  "transformIgnorePatterns": [
+      "node_modules/(?!(...|@rnmapbox))"
+  ]
+}
+```
+---
+## Sponsors
+
+Help drive this repo forward - be a sponsor. Add a comment [here](https://github.com/rnmapbox/maps/discussions/1551) to discuss your sponsorship.
+
+<table style="border: none; border-width: 0px">
+<tr>
+<td align="center">
+<a href="https://scouttohunt.com/" target="_blank">
+<img src="./assets/sponsors/sth.png"
+     alt="Scout To Hunt"
+     height="60"
+      />
+      
+</td>
+<td align="center">
+<a href="https://terrain.dance/" target="_blank">
+<img src="./assets/sponsors/terrain.dance.png"
+     alt="Terrain Dance LLC"
+     height="60"
+      />
+  </a>
+
+  
+</td>
+</tr>
+<tr>
+<td align="center"></a>
+
+  <a href="https://scouttohunt.com/" target="_blank">Scout To Hunt</a></td>
+
+<td align="center"><a href="https://terrain.dance/" target="_blank">Terrain Dance</a></td>
+</tr>
+</table>
+
+---
+## Developer Group
+
+Have a question or need some help? Join our [Gitter developer group](https://gitter.im/rnmapbox/Lobby)!

package/RELEASE.md

@@ -0,0 +1,28 @@
+# How to create a release for this repo
+
+## Make sure `main` builds correctly
+
+Are all our [actions](https://github.com/rnmapbox/maps/actions) passing successfully?  
+If not, make sure to investigate the issue and fix it prior to a release.
+
+## Bump the version in our package.json
+
+Once you verified, that `main` isn't broken, go on and increase the `version` within our `package.json`.
+
+## Update the CHANGELOG accordingly
+
+Our [`CHANGELOG.md`](https://github.com/rnmapbox/maps/blob/main/CHANGELOG.md) should be updated whenever a PR is merged/ noteworthy changes are committed to `main`.  
+Prior to a release, the changes should be documented under the `UNRELEASED` section.  
+Once it's clear, that a release is about to be published, move the items under `UNRELEASED` to _this_ releases sections.  
+Let your actions be guided by the previous release entries.
+
+## Draft a new release on GitHub
+
+Within the [releases](https://github.com/rnmapbox/maps/releases) section of the repo you can [`Draft a new release`](https://github.com/rnmapbox/maps/releases/new).
+
+`Tag version` & `Release title` should be the same.  
+As redundant as it might sound, please add the changes from the `CHANGELOG.md` into the body of the release.
+
+## Monitor the repos issues for updates
+
+Once the release is out the door (on [npm](https://www.npmjs.com/package/@rnmapbox/maps)), make sure to monitor the [issues](https://github.com/rnmapbox/maps/issues) closely for problems the community might encounter

package/android/install.md

@@ -0,0 +1,137 @@
+# Android Installation
+
+## We're supporting 3 implementations at the moment:
+
+  - maplibre: *DEFAULT* open source fork of older open source mapbox libraries with many improvements
+  - mapbox: v10 latest mapbox implementation - not opensource requires access for download
+  - mapbox-gl: classic mapbox libraries - should work but will be dropped, recent versions are not open source and requires acess for download
+
+
+## Using MapLibre
+
+[MapLibre](https://github.com/maplibre/maplibre-gl-native) is an OSS fork of MapboxGL.
+This is the default, and should work without any changes in gradle files.
+
+### Custom versions
+
+Overwrite mapbox dependencies within your `android/build.gradle > buildscript > ext` section
+
+```groovy
+buildscript {
+    ext {
+        // ...
+        RNMapboxMapsImpl = "maplibre" // optinal - as this is the default
+
+        RNMapboxMapsLibs = { // optional - only required if you want to customize it
+            implementation ("org.maplibre.gl:android-sdk:9.5.2")
+            implementation ("org.maplibre.gl:android-sdk-turf:5.9.0")
+
+            implementation ("org.maplibre.gl:android-plugin-localization-v9:1.0.0")
+            implementation ("org.maplibre.gl:android-plugin-annotation-v9:1.0.0")
+            implementation ("org.maplibre.gl:android-plugin-markerview-v9:1.0.0")
+        }
+    }
+}
+```
+
+Feel free to check out the `/example` projects [`android/build.gradle`](https://github.com/rnmapbox/maps/blob/main/example/android/build.gradle) for inspiration!
+
+## Mapbox Maps SDK v10
+
+Add `RNMapboxMapsImpl = "mapbox"` to your gradle file - see bellow for details.
+
+### Custom versions
+
+Overwrite mapbox dependencies within your `android/build.gradle > buildscript > ext` section
+
+
+```groovy
+buildscript {
+    ext {
+        // ...
+        RNMapboxMapsImpl = "mapbox" // required for v10
+
+        RNMapboxMapsLibs = { // optional - only required if you want to customize it
+            implementation 'com.mapbox.maps:android:10.6.0'
+            implementation 'com.mapbox.mapboxsdk:mapbox-sdk-turf:5.4.1'
+        }
+    }
+}
+```
+
+## Mapbox Maps GL Native SDK (pre v10)
+
+
+### Custom versions
+
+We've set up default Mapbox dependencies for you.  
+Feel free to check em out [here](https://github.com/rnmapbox/maps/blob/eca4858744cab134b06ae455bcdacc63233318a5/android/rctmgl/build.gradle#L55-L76)
+
+However, it is also possible to set a custom version of the [Mapbox SDK](https://github.com/mapbox/mapbox-gl-native-android)  
+Which will overwrite our defaults.
+
+Add something like the following to your `android/build.gradle > buildscript > ext` section:
+
+```groovy
+// android/build.gradle
+
+buildscript {
+    // ... stuff
+    ext {
+        RNMapboxMapsImpl = "mapbox-gl"
+
+        // ... stuff
+        RNMapboxMapsLibs = {
+            implementation 'com.mapbox.mapboxsdk:mapbox-android-sdk:9.7.1'
+            implementation 'com.mapbox.mapboxsdk:mapbox-sdk-services:5.8.0'
+            implementation 'com.mapbox.mapboxsdk:mapbox-sdk-turf:5.8.0'
+            implementation 'com.mapbox.mapboxsdk:mapbox-android-gestures:0.7.0'
+
+            implementation 'com.mapbox.mapboxsdk:mapbox-android-plugin-annotation-v9:0.8.0'
+            implementation 'com.mapbox.mapboxsdk:mapbox-android-plugin-localization-v9:0.14.0'
+            implementation 'com.mapbox.mapboxsdk:mapbox-android-plugin-markerview-v9:0.4.0'
+        }
+    // ... more stuff?
+    }
+}
+```
+
+NOTICE, If you are using newer versions of the SDK, you will need to authorize your download of the Maps SDK via a secret access token with the `DOWNLOADS:READ` scope.  
+This [guide](https://docs.mapbox.com/android/maps/guides/install/#configure-credentials) explains how to `Configure credentials` and `Configure your secret token`.
+
+Then under section `allprojects/repositories` add your data:
+
+```groovy
+// android/build.gradle
+
+allprojects {
+    repositories {
+        // ...other repos
+        maven {
+            url 'https://api.mapbox.com/downloads/v2/releases/maven'
+            authentication {
+                basic(BasicAuthentication)
+            }
+            credentials {
+                // Do not change the username below.
+                // This should always be `mapbox` (not your username).
+                username = 'mapbox'
+                // Use the secret token you stored in gradle.properties as the password
+                password = project.properties['MAPBOX_DOWNLOADS_TOKEN'] ?: ""
+            }
+        }
+        // ...even more repos?
+    }
+}
+```
+
+Feel free to check out the `/example` projects [`android/build.gradle`](https://github.com/rnmapbox/maps/blob/main/example/android/build.gradle) for inspiration!
+
+<br>
+
+---
+
+<br>
+
+
+

package/android/rctmgl/.classpath

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<classpath>
+	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.8/"/>
+	<classpathentry kind="con" path="org.eclipse.buildship.core.gradleclasspathcontainer"/>
+	<classpathentry kind="output" path="bin/default"/>
+</classpath>

package/android/rctmgl/.settings/org.eclipse.buildship.core.prefs

@@ -0,0 +1,2 @@
+connection.project.dir=../../example/android
+eclipse.preferences.version=1

package/android/rctmgl/build.gradle

@@ -0,0 +1,148 @@
+def defaultMapboxMapsImpl = "maplibre"
+
+def safeExtGet(prop, fallback) {
+    rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback
+}
+
+// expo plugin
+if (rootProject.ext.has('expoRNMapboxMapsImpl')) {
+    rootProject.ext.set('RNMapboxMapsImpl', rootProject.ext.get('expoRNMapboxMapsImpl'))
+}
+
+buildscript {
+  repositories {
+    google()
+    mavenCentral()
+  }
+
+  dependencies {
+    classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:${rootProject.ext.has('kotlinVersion') ? rootProject.ext.get('kotlinVersion') : '1.6.21'}"
+  }
+}
+
+apply plugin: 'com.android.library'
+
+if (safeExtGet("RNMapboxMapsImpl", defaultMapboxMapsImpl) == "mapbox") {
+  apply plugin: 'kotlin-android'
+}
+
+android {
+    if (safeExtGet("RNMapboxMapsImpl", defaultMapboxMapsImpl) == "maplibre") {
+        sourceSets {
+            main {
+                java.srcDirs = ['src/main/java-mapboxgl/common','src/main/java-mapboxgl/maplibre']
+            }
+        }
+    }
+    else if (safeExtGet("RNMapboxMapsImpl", defaultMapboxMapsImpl) == "mapbox-gl") {
+        sourceSets {
+            main {
+                java.srcDirs = ['src/main/java-mapboxgl/common','src/main/java-mapboxgl/mapbox']
+            }
+        }
+    }
+    else if (safeExtGet("RNMapboxMapsImpl", defaultMapboxMapsImpl) == "mapbox") {
+        sourceSets {
+            main {
+                java.srcDirs = ['src/main/java-v10']
+            }
+        }
+
+        packagingOptions {
+            pickFirst 'lib/x86/libc++_shared.so'
+            pickFirst 'lib/x86_64/libc++_shared.so'
+            pickFirst 'lib/arm64-v8a/libc++_shared.so'
+            pickFirst 'lib/armeabi-v7a/libc++_shared.so'
+        }
+    }
+    else {
+        msg = "RNMapboxMapsImpl should be one of: mapbox, mapbox-gl, maplibre got: ${safeExtGet("mapboxV10", defaultMapboxMapsImpl)}"
+        logger.error(msg)
+        throw new GradleException(msg)
+    }
+
+    compileSdkVersion safeExtGet("compileSdkVersion", 28)
+    buildToolsVersion safeExtGet("buildToolsVersion", '28.0.3')
+
+    defaultConfig {
+        minSdkVersion safeExtGet('minSdkVersion', 16)
+        targetSdkVersion safeExtGet('targetSdkVersion', 26)
+        versionCode 1
+        versionName "1.0"
+    }
+
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_1_8
+        targetCompatibility JavaVersion.VERSION_1_8
+    }
+
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+}
+
+def customizableDependencies(name, defaultDependencies) {
+    if (rootProject.ext.has(name)) {
+        def libs = rootProject.ext.get(name)
+        if (libs instanceof CharSequence) {
+            libs.split(';').each {
+                implementation it
+            }
+        } else {
+            libs.delegate = defaultDependencies.owner.delegate
+            libs.call()
+        }
+    } else {
+        defaultDependencies.delegate = defaultDependencies.owner.delegate
+        defaultDependencies.call()
+    }
+}
+
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+
+    // React Native
+    implementation "com.facebook.react:react-native:+"
+
+    // Mapbox SDK
+    customizableDependencies('RNMapboxMapsLibs') {
+        if (safeExtGet("RNMapboxMapsImpl", defaultMapboxMapsImpl) == "maplibre") {
+            implementation ("org.maplibre.gl:android-sdk:9.5.2")
+            implementation ("org.maplibre.gl:android-sdk-turf:5.9.0")
+
+            implementation ("org.maplibre.gl:android-plugin-localization-v9:1.0.0")
+            implementation ("org.maplibre.gl:android-plugin-annotation-v9:1.0.0")
+            implementation ("org.maplibre.gl:android-plugin-markerview-v9:1.0.0")
+        }
+        else if (safeExtGet("RNMapboxMapsImpl", defaultMapboxMapsImpl) == "mapbox-gl") {
+            implementation 'com.mapbox.mapboxsdk:mapbox-sdk-services:5.1.0'
+            implementation 'com.mapbox.mapboxsdk:mapbox-android-sdk:9.1.0'
+            implementation 'com.mapbox.mapboxsdk:mapbox-android-telemetry:6.1.0'
+            implementation 'com.mapbox.mapboxsdk:mapbox-android-plugin-annotation-v9:0.8.0'
+
+                // plugins
+            implementation 'com.mapbox.mapboxsdk:mapbox-android-gestures:0.6.0'
+            implementation 'com.mapbox.mapboxsdk:mapbox-android-plugin-localization-v9:0.12.0'
+            implementation 'com.mapbox.mapboxsdk:mapbox-android-plugin-markerview-v9:0.4.0'
+            implementation 'com.mapbox.mapboxsdk:mapbox-sdk-turf:5.1.0'
+        }
+        else if (safeExtGet("RNMapboxMapsImpl", defaultMapboxMapsImpl) == "mapbox") {
+            implementation 'com.mapbox.maps:android:10.7.0'
+            implementation 'com.mapbox.mapboxsdk:mapbox-sdk-turf:6.4.0'
+        }
+    }
+
+    // Dependencies
+    customizableDependencies('RNMapboxMapsSupportLibs') {
+        implementation "com.android.support:support-vector-drawable:28.0.0"
+        implementation "com.android.support:support-annotations:28.0.0"
+        implementation "com.android.support:appcompat-v7:28.0.0"
+    }
+    customizableDependencies('RNMapboxMapsOkHTTPLibs') {
+        implementation "com.squareup.okhttp3:okhttp:4.9.0"
+        implementation "com.squareup.okhttp3:okhttp-urlconnection:4.9.0"
+    }
+}

package/android/rctmgl/proguard-rules.pro

@@ -0,0 +1,25 @@
+# Add project specific ProGuard rules here.
+# By default, the flags in this file are appended to flags specified
+# in /Users/nickitaliano/Library/Android/sdk/tools/proguard/proguard-android.txt
+# You can edit the include path and order by changing the proguardFiles
+# directive in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# Add any project specific keep options here:
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile

package/android/rctmgl/src/main/AndroidManifest.xml

@@ -0,0 +1,4 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android" package="com.mapbox.rctmgl">
+    <uses-permission android:name="android.permission.INTERNET" />
+    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>
+</manifest>