Merge pull request #746 from ralphocdol/custom-api-object-range

Added Object helper for custom-api

docs/custom-api.md

@@ -219,6 +219,38 @@ Output:
 
 JSON response:
 
+```json
+{
+  "user": {
+    "id": 42,
+    "name": "Alice",
+    "active": true
+  }
+}
+```
+
+To loop through each property of the object, you would use the following:
+
+```html
+{{ range $key, $value := .JSON.Entries "user" }}
+  <div>{{ $key }}: {{ $value.String "" }}</div>
+{{ end }}
+```
+
+Output:
+
+```html
+<div>id: 42</div>
+<div>name: Alice</div>
+<div>active: true</div>
+```
+
+Each property in the object is exposed as a pair, with `$key` being a string and `$value` providing access to the value using the usual JSON methods.
+
+<hr>
+
+JSON response:
+
 ```json
 {
     "price": 100,
@@ -414,6 +446,7 @@ The following functions are available on the `JSON` object:
 - `Bool(key string) bool`: Returns the value of the key as a boolean.
 - `Array(key string) []JSON`: Returns the value of the key as an array of `JSON` objects.
 - `Exists(key string) bool`: Returns true if the key exists in the JSON object.
+- `Entries(key string)`: Returns an iterator that allows you to loop through each property of the object. Example: `{{ range $key, $value := .JSON.Entries "user" }}`. This will yield pairs of key and value, where `$key` is a string and `$value` is a `JSON` object.
 
 The following functions are available on the `Options` object:
 

internal/glance/widget-custom-api.go

@@ -8,6 +8,7 @@ import (
 	"fmt"
 	"html/template"
 	"io"
+	"iter"
 	"log/slog"
 	"math"
 	"net/http"
@@ -415,6 +416,21 @@ func (r *decoratedGJSONResult) Get(key string) *decoratedGJSONResult {
 	return &decoratedGJSONResult{r.Result.Get(key)}
 }
 
+func (r *decoratedGJSONResult) Entries(key string) iter.Seq2[string, *decoratedGJSONResult] {
+	var obj gjson.Result
+	if key == "" {
+		obj = r.Result
+	} else {
+		obj = r.Result.Get(key)
+	}
+
+	return func(yield func(string, *decoratedGJSONResult) bool) {
+		obj.ForEach(func(k, v gjson.Result) bool {
+			return yield(k.String(), &decoratedGJSONResult{v})
+		})
+	}
+}
+
 func customAPIDoMathOp[T int | float64](a, b T, op string) T {
 	switch op {
 	case "add":