RD-1381: Add centerOnIpPoint method to the map - Kotlin (#92)

Co-authored-by: klokantechsysadmin <[email protected]>
Co-authored-by: sasaprodribaba <[email protected]>

Author: 3 people

MapTilerSDK/src/main/java/com/maptiler/maptilersdk/commands/navigation/CenterOnIpPoint.kt

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2025, MapTiler
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD 3-Clause
+ */
+
+package com.maptiler.maptilersdk.commands.navigation
+
+import com.maptiler.maptilersdk.bridge.MTBridge
+import com.maptiler.maptilersdk.bridge.MTCommand
+
+internal class CenterOnIpPoint : MTCommand {
+    override val isPrimitiveReturnType: Boolean = false
+
+    override fun toJS(): String = "${MTBridge.MAP_OBJECT}.centerOnIpPoint();"
+}

MapTilerSDK/src/main/java/com/maptiler/maptilersdk/map/MTMapViewController.kt

@@ -350,6 +350,11 @@ class MTMapViewController(
      */
     override fun fitToIpBounds() = navigableWorker.fitToIpBounds()
 
+    /**
+     * Centers the map on the coarse location inferred from the device's public IP address.
+     */
+    override fun centerOnIpPoint() = navigableWorker.centerOnIpPoint()
+
     /**
      * Returns the map's current bearing.
      */

MapTilerSDK/src/main/java/com/maptiler/maptilersdk/map/workers/navigable/MTNavigable.kt

@@ -78,6 +78,11 @@ interface MTNavigable {
      */
     fun fitToIpBounds()
 
+    /**
+     * Centers the map on the visitor's location inferred from their public IP address.
+     */
+    fun centerOnIpPoint()
+
     /**
      * Returns the map's current bearing.
      */

MapTilerSDK/src/main/java/com/maptiler/maptilersdk/map/workers/navigable/NavigableWorker.kt

@@ -12,6 +12,7 @@ import com.maptiler.maptilersdk.bridge.MTBridgeReturnType.DoubleValue
 import com.maptiler.maptilersdk.bridge.MTBridgeReturnType.Null
 import com.maptiler.maptilersdk.bridge.MTBridgeReturnType.StringValue
 import com.maptiler.maptilersdk.commands.navigation.AreTilesLoaded
+import com.maptiler.maptilersdk.commands.navigation.CenterOnIpPoint
 import com.maptiler.maptilersdk.commands.navigation.EaseTo
 import com.maptiler.maptilersdk.commands.navigation.FitBounds
 import com.maptiler.maptilersdk.commands.navigation.FitToIpBounds
@@ -50,6 +51,7 @@ import com.maptiler.maptilersdk.map.options.MTPaddingOptions
 import com.maptiler.maptilersdk.map.types.MTBounds
 import com.maptiler.maptilersdk.map.types.MTPoint
 import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.CoroutineStart
 import kotlinx.coroutines.launch
 import kotlinx.serialization.decodeFromString
 
@@ -131,6 +133,14 @@ internal class NavigableWorker(
         }
     }
 
+    override fun centerOnIpPoint() {
+        scope.launch(start = CoroutineStart.UNDISPATCHED) {
+            bridge.execute(
+                CenterOnIpPoint(),
+            )
+        }
+    }
+
     override suspend fun getMaxBounds(): MTBounds? {
         val returnTypeValue =
             bridge.execute(

MapTilerSDK/src/test/java/com/maptiler/maptilersdk/WorkerAndStyleTests.kt

@@ -11,6 +11,7 @@ import com.maptiler.maptilersdk.bridge.MTBridgeReturnType
 import com.maptiler.maptilersdk.bridge.MTCommand
 import com.maptiler.maptilersdk.bridge.MTCommandExecutable
 import com.maptiler.maptilersdk.commands.navigation.AreTilesLoaded
+import com.maptiler.maptilersdk.commands.navigation.CenterOnIpPoint
 import com.maptiler.maptilersdk.commands.navigation.GetBearing
 import com.maptiler.maptilersdk.commands.navigation.GetCenterClampedToGround
 import com.maptiler.maptilersdk.commands.navigation.GetCenterElevation
@@ -48,6 +49,23 @@ class WorkerAndStyleTests {
             assertTrue(usedGetBearing)
         }
 
+    @Test fun navigableWorker_centerOnIpPoint_UsesCenterOnIpPointCommand() =
+        runBlocking {
+            var usedCenterOnIpPoint = false
+            val exec =
+                object : MTCommandExecutable {
+                    override suspend fun execute(command: MTCommand): MTBridgeReturnType {
+                        if (command is CenterOnIpPoint) usedCenterOnIpPoint = true
+                        return MTBridgeReturnType.Null
+                    }
+                }
+
+            val bridge = MTBridge(exec)
+            val worker = NavigableWorker(bridge, this)
+            worker.centerOnIpPoint()
+            assertTrue(usedCenterOnIpPoint)
+        }
+
     @Test fun navigableWorker_getCenterClampedToGround_ParsesPrimitiveReturnTypes() =
         runBlocking {
             val executedCommands = mutableListOf<MTCommand>()

MapTilerSDK/src/test/java/com/maptiler/maptilersdk/commands/navigation/BoundsCommandsTest.kt

@@ -48,6 +48,14 @@ class BoundsCommandsTest {
         assertTrue(!command.isPrimitiveReturnType)
     }
 
+    @Test
+    fun `centerOnIpPoint emits expected invocation`() {
+        val command = CenterOnIpPoint()
+
+        assertEquals("map.centerOnIpPoint();", command.toJS())
+        assertTrue(!command.isPrimitiveReturnType)
+    }
+
     @Test
     fun `getBounds uses primitive return`() {
         val command = GetBounds()