chore: deprecate access token support

Signed-off-by: Oleksii Zubko <oleksii.zubko@gmail.com>
maplibre · Jan 5, 2025 · e8c89bd · e8c89bd
1 parent 0661d38
commit e8c89bd
Show file tree

Hide file tree

Showing 8 changed files with 40 additions and 8 deletions.
diff --git a/android/src/main/java/org/maplibre/reactnative/modules/MLRNModule.java b/android/src/main/java/org/maplibre/reactnative/modules/MLRNModule.java
@@ -127,7 +127,21 @@ public Map<String, Object> getConstants() {
                 .build();
     }
 
+    @ReactMethod
+    public void createMapLibreInstance() {
+        mReactContext.runOnUiQueueThread(new Runnable() {
+            @Override
+            public void run() {
+              MapLibre.getInstance(getReactApplicationContext());
+            }
+        });
+    }
+
     // TODO: How to handle this? API has changed significantly
+    /**
+     * @deprecated This will be removed in the next major version, Use createMapLibreInstance instead.
+     * @see https://github.com/maplibre/maplibre-react-native/issues/25#issuecomment-1382382044
+     */
     @ReactMethod
     public void setAccessToken(final String accessToken) {
         mReactContext.runOnUiQueueThread(new Runnable() {
@@ -171,6 +185,10 @@ public void run() {
     }
 
     // TODO: How to handle this? Underlying API has changed significantly on Android
+    /**
+     * @deprecated This will be removed in the next major version.
+     * @see https://github.com/maplibre/maplibre-react-native/issues/25#issuecomment-1382382044
+     */
     @ReactMethod
     public void getAccessToken(Promise promise) {
         String token = MapLibre.getApiKey();

diff --git a/docs/guides/MLRNModule.md b/docs/guides/MLRNModule.md
@@ -2,9 +2,9 @@
 
 ## Methods
 
-### `setAccessToken(accessToken)`
+### `createMapLibreInstance()`
 
-Set accessToken, which is required when you want to use Mapbox tiles. Not required when using other tiles.
+MapLibre Native for Android **requires** calling this.
 
 #### Arguments
 

diff --git a/docs/guides/setup/Getting-Started.md b/docs/guides/setup/Getting-Started.md
@@ -47,19 +47,18 @@ After completing the installation and rebuilding the app, you can start using th
 
 ```tsx
 import React from "react";
-import { MapView, setAccessToken } from "@maplibre/maplibre-react-native";
+import { MapView, createMapLibreInstance } from "@maplibre/maplibre-react-native";
 
 // Required on Android, see note below
-setAccessToken(null);
+createMapLibreInstance();
 
 function App() {
   return <MapView style={{ flex: 1 }} />;
 }
 ```
 
 > [!Important]
-> MapLibre Native for Android **requires** calling `setAccessToken` with either `null` or a proper value, if you are
-> using Mapbox.
+> MapLibre Native for Android **requires** calling `MapLibre.getInstance` before inflating or creating the view.
 
 ## Further reading
 

diff --git a/ios/MLRN/MLRNModule.m b/ios/MLRN/MLRNModule.m
@@ -90,6 +90,10 @@ + (BOOL)requiresMainQueueSetup
     };
 }
 
+/**
+* @deprecated This will be removed in the next major version.
+* @see https://github.com/maplibre/maplibre-react-native/issues/25#issuecomment-1382382044
+*/
 RCT_EXPORT_METHOD(setAccessToken:(NSString *)accessToken)
 {
     if (accessToken.length > 0) {

diff --git a/packages/examples/src/App.tsx b/packages/examples/src/App.tsx
@@ -1,6 +1,6 @@
 import {
   requestAndroidLocationPermissions,
-  setAccessToken,
+  createMapLibreInstance,
 } from "@maplibre/maplibre-react-native";
 import { useEffect, useState } from "react";
 import { LogBox, Platform, StyleSheet, Text, View } from "react-native";
@@ -24,7 +24,9 @@ const styles = StyleSheet.create({
 
 const IS_ANDROID = Platform.OS === "android";
 
-setAccessToken(null);
+if (IS_ANDROID) {
+  createMapLibreInstance();
+}
 
 export function App() {
   const [isFetchingAndroidPermission, setIsFetchingAndroidPermission] =

diff --git a/src/MLRNModule.ts b/src/MLRNModule.ts
@@ -25,6 +25,8 @@ interface IMLRNModule {
     Default: string;
   };
 
+  createMapLibreInstance(): Promise<void>;
+
   setAccessToken(accessToken: string | null): Promise<string | null>;
   getAccessToken(): Promise<string>;
 
@@ -42,6 +44,8 @@ export const {
   StyleSource,
   StyleURL,
 
+  createMapLibreInstance,
+
   setAccessToken,
   getAccessToken,
 

diff --git a/src/__tests__/__mocks__/NativeModules.mock.ts b/src/__tests__/__mocks__/NativeModules.mock.ts
@@ -38,6 +38,9 @@ NativeModules.MLRNModule = {
   OfflineCallbackName: keyMirror(["Progress", "Error"]),
 
   // Methods
+
+  createMapLibreInstance: jest.fn(),
+
   setAccessToken: jest.fn(),
   getAccessToken: () => Promise.resolve("test-token"),
 

diff --git a/src/__tests__/exports.ts b/src/__tests__/exports.ts
@@ -54,6 +54,8 @@ describe("Package Exports", () => {
 
       // Methods
 
+      "createMapLibreInstance",
+
       "setAccessToken",
       "getAccessToken",