Implement replace-all expression

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ### ✨ Features and improvements
 - Improve performance by sending style layers to worker thread before processing it on main thread to allow parallel processing ([#2131](https://github.com/maplibre/maplibre-gl-js/pull/2131))
+- Implement `replace-all` expression. ([#2059](https://github.com/maplibre/maplibre-gl-js/pull/2059))
 - *...Add new stuff here...*
 
 ### 🐞 Bug fixes

build/generate-style-spec.ts

@@ -211,6 +211,7 @@ export type ExpressionSpecification =
     | ['concat', ...(ExpressionInputType | ExpressionSpecification)[]] // at least two inputs required -> string
     | ['downcase', string | ExpressionSpecification] // string
     | ['is-supported-script', string | ExpressionSpecification] // boolean
+    | ['replace-all', string | ExpressionSpecification, string | ExpressionSpecification, string | ExpressionSpecification] // string
     | ['resolved-locale', CollatorExpressionSpecification] // string
     | ['upcase', string | ExpressionSpecification] // string
     // Color

src/style-spec/CHANGELOG.md

@@ -1,3 +1,7 @@
+## main
+
+* Implement `replace-all` expression. ([#2059](https://github.com/maplibre/maplibre-gl-js/pull/2059))
+
 ## 17.0.2
 
 * Fix errors when running style-spec bin scripts and added missing help. Removed unnecessary script 'gl-style-composite'. ([#1971](https://github.com/maplibre/maplibre-gl-js/pull/1971))

src/style-spec/expression/definitions/index.ts

@@ -554,6 +554,11 @@ CompoundExpression.register(expressions, {
         varargs(ValueType),
         (ctx, args) => args.map(arg => valueToString(arg.evaluate(ctx))).join('')
     ],
+    'replace-all': [
+        StringType,
+        [StringType, StringType, StringType],
+        (ctx, [s, regex, replacement]) => s.evaluate(ctx).replaceAll(regex.evaluate(ctx), replacement.evaluate(ctx))
+    ],
     'resolved-locale': [
         StringType,
         [CollatorType],

src/style-spec/reference/v8.json

@@ -3711,6 +3711,15 @@
             "macos": "0.9.0"
           }
         }
+      },
+      "replace-all": {
+        "doc": "Returns a new string with all matches of a pattern replaced by a replacement. The pattern is a string to match, and the replacement is a string to replace it with.",
+        "group": "String",
+        "sdk-support": {
+          "basic functionality": {
+            "js": "3.0.0"
+          }
+        }
       }
     }
   },

test/integration/expression/tests/replace/basic/test.json

@@ -0,0 +1,15 @@
+{
+  "expression": ["replace-all", "cats;dogs;ferrets", ";", " and "],
+  "inputs": [
+    [{}, {}, {}, {}]
+  ],
+  "expected": {
+    "compiled": {
+      "result": "success",
+      "isFeatureConstant": true,
+      "isZoomConstant": true,
+      "type": "string"
+    },
+    "outputs": ["cats and dogs and ferrets"]
+  }
+}

test/integration/expression/tests/replace/expr/test.json

@@ -0,0 +1,27 @@
+{
+  "expression": ["replace-all", ["get", "s"], ["get", "f"], ["get", "r"]],
+  "inputs": [
+    [{}, {"properties": {"s": "cats;dogs;ferrets", "f": ";", "r": " and "}}],
+    [{}, {"properties": {"s": "cats dogs  ferrets   ", "f": " ", "r": ""}}],
+    [{}, {"properties": {"s": "cats dogs ferrets", "f": "?", "r": ""}}],
+    [{}, {"properties": {"s": "cats dogs ferrets", "f": "", "r": ""}}],
+    [{}, {"properties": {"s": "", "f": "", "r": ""}}],
+    [{}, {"properties": {"s": "cats dogs ferrets", "f": "dogs", "r": "bats"}}]
+  ],
+  "expected": {
+    "compiled": {
+      "result": "success",
+      "isFeatureConstant": false,
+      "isZoomConstant": true,
+      "type": "string"
+    },
+    "outputs": [
+      "cats and dogs and ferrets",
+      "catsdogsferrets",
+      "cats dogs ferrets",
+      "cats dogs ferrets",
+      "",
+      "cats bats ferrets"
+    ]
+  }
+}