[create-pull-request] automated change (#90)

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

Author: github-actions[bot]

MapTilerSDK/src/main/java/com/maptiler/maptilersdk/commands/style/AddSprite.kt

@@ -0,0 +1,26 @@
+/*
+ * Copyright (c) 2025, MapTiler
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD 3-Clause
+ */
+
+package com.maptiler.maptilersdk.commands.style
+
+import com.maptiler.maptilersdk.bridge.MTBridge
+import com.maptiler.maptilersdk.bridge.MTCommand
+import com.maptiler.maptilersdk.helpers.formatUrlForJs
+import java.net.URL
+
+internal data class AddSprite(
+    val identifier: String,
+    val spriteUrl: URL,
+) : MTCommand {
+    override val isPrimitiveReturnType: Boolean = false
+
+    override fun toJS(): String {
+        val sanitizedIdentifier = identifier.replace("\\", "\\\\").replace("'", "\\'")
+        val formattedUrl = formatUrlForJs(spriteUrl)
+
+        return "${MTBridge.MAP_OBJECT}.addSprite('$sanitizedIdentifier', '$formattedUrl');"
+    }
+}

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

@@ -41,6 +41,7 @@ import com.maptiler.maptilersdk.map.workers.zoomable.ZoomableWorker
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.launch
+import java.net.URL
 
 interface MTMapViewDelegate {
     fun onMapViewInitialized()
@@ -425,6 +426,19 @@ class MTMapViewController(
      */
     suspend fun getProjection(): MTProjectionType = style?.getProjection() ?: MTProjectionType.MERCATOR
 
+    /**
+     * Registers a sprite resource that can be referenced from style layers.
+     *
+     * @param identifier Unique identifier for the sprite.
+     * @param url Fully qualified URL to the sprite image.
+     */
+    fun addSprite(
+        identifier: String,
+        url: URL,
+    ) {
+        style?.addSprite(identifier, url)
+    }
+
     /**
      * Project coordinates to point on the container.
      */

MapTilerSDK/src/main/java/com/maptiler/maptilersdk/map/style/MTStyle.kt

@@ -130,6 +130,17 @@ class MTStyle(
         options: MTAddImageOptions? = null,
     ) = stylableWorker.addImage(identifier, image, options)
 
+    /**
+     * Registers a sprite hosted at the provided URL under the given identifier.
+     *
+     * @param identifier Unique name for the sprite resource.
+     * @param url Fully qualified URL pointing to the sprite image.
+     */
+    fun addSprite(
+        identifier: String,
+        url: URL,
+    ) = stylableWorker.addSprite(identifier, url)
+
     /**
      * Adds a layer to the map.
      *

MapTilerSDK/src/main/java/com/maptiler/maptilersdk/map/workers/stylable/StylableWorker.kt

@@ -19,6 +19,7 @@ import com.maptiler.maptilersdk.commands.misc.AddLogoControl
 import com.maptiler.maptilersdk.commands.style.AddImage
 import com.maptiler.maptilersdk.commands.style.AddLayer
 import com.maptiler.maptilersdk.commands.style.AddSource
+import com.maptiler.maptilersdk.commands.style.AddSprite
 import com.maptiler.maptilersdk.commands.style.DisableHalo
 import com.maptiler.maptilersdk.commands.style.DisableHaloAnimations
 import com.maptiler.maptilersdk.commands.style.DisableSpaceAnimations
@@ -215,6 +216,17 @@ internal class StylableWorker(
         }
     }
 
+    fun addSprite(
+        identifier: String,
+        spriteUrl: URL,
+    ) {
+        scope.launch {
+            bridge.execute(
+                AddSprite(identifier, spriteUrl),
+            )
+        }
+    }
+
     fun removeLayer(layer: MTLayer) {
         scope.launch {
             bridge.execute(

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

@@ -13,6 +13,7 @@ import com.maptiler.maptilersdk.bridge.MTCommand
 import com.maptiler.maptilersdk.bridge.MTCommandExecutable
 import com.maptiler.maptilersdk.commands.style.AddImage
 import com.maptiler.maptilersdk.commands.style.AddSource
+import com.maptiler.maptilersdk.commands.style.AddSprite
 import com.maptiler.maptilersdk.commands.style.DisableTerrain
 import com.maptiler.maptilersdk.commands.style.EnableGlobeProjection
 import com.maptiler.maptilersdk.commands.style.EnableMercatorProjection
@@ -210,6 +211,17 @@ class StyleAndCommandsTests {
         assertTrue(js.contains("\"pixelRatio\":2.0"))
     }
 
+    @Test fun addSpriteToJS_ReturnsValidJSString() {
+        val url = URL("https://example.com/sprites/poi.png")
+
+        val js = AddSprite("poi-sprite", url).toJS()
+
+        assertEquals(
+            "${MTBridge.MAP_OBJECT}.addSprite('poi-sprite', 'https://example.com/sprites/poi.png');",
+            js,
+        )
+    }
+
     @Test fun mtStyleAddImage_DelegatesToBridge() {
         val recordedCommands = mutableListOf<MTCommand>()
         val bridge =
@@ -231,4 +243,24 @@ class StyleAndCommandsTests {
         assertEquals(1, recordedCommands.size)
         assertTrue(recordedCommands.first() is AddImage)
     }
+
+    @Test fun mtStyleAddSprite_DelegatesToBridge() {
+        val recordedCommands = mutableListOf<MTCommand>()
+        val bridge =
+            MTBridge(
+                object : MTCommandExecutable {
+                    override suspend fun execute(command: MTCommand): MTBridgeReturnType {
+                        recordedCommands.add(command)
+                        return MTBridgeReturnType.Null
+                    }
+                },
+            )
+        val style = MTStyle(MTMapReferenceStyle.STREETS)
+        style.initWorker(bridge, CoroutineScope(Dispatchers.Unconfined))
+
+        style.addSprite("poi-sprite", URL("https://example.com/sprite.png"))
+
+        assertEquals(1, recordedCommands.size)
+        assertTrue(recordedCommands.first() is AddSprite)
+    }
 }