NativeJsonPath

A utility class for querying JSON data using a JSONPath-like syntax. This class allows parsing and querying JSON strings to extract specific values or structures.

class NativeJsonPath

Example Usage

val jsonString = """
{
    "firstName": "John",
    "lastName": "Doe",
    "age": 26,
    "phoneNumbers": [
        {
            "type": "iPhone",
            "number": "0123-4567-8888"
        },
        {
            "type": "home",
            "number": "0123-4567-8910"
        }
    ]
}
""".trimIndent()

val query = "$[phoneNumbers][0][number]"
val result = NativeJsonPath().query(jsonString, query)
println(result) // Output: 0123-4567-8888

Initializers

NativeJsonPath()

Initializes a new instance of NativeJsonPath.

constructor()

Methods

query(jsonString: String?, query: String?): Any?

Queries a JSON string using a JSONPath-like query.

fun query(jsonString: String?, query: String?): Any?

Example Usage

val jsonString = """
[
    { "id": 1, "name": "Alice" },
    { "id": 2, "name": "Bob" }
]
""".trimIndent()

val query = "$[1][name]"
val result = NativeJsonPath().query(jsonString, query)
println(result) // Output: Bob

Parameters

• jsonString: The JSON string to query.
• query: The JSONPath-like query string.

Returns

The value or structure matching the query if found; otherwise, null. If the query is invalid, an error message is returned.

Utility Methods

isObject(jsonString: String): Boolean

Checks whether the given string represents a JSON object.

private fun isObject(jsonString: String): Boolean

isArray(jsonString: String): Boolean

Checks whether the given string represents a JSON array.

private fun isArray(jsonString: String): Boolean

parseWithJsonPath(variables:hierarchy:)

Extracts and evaluates a JSON path from a block data string.

fun String.parseWithJsonPath(
    variables: Map<String, NativeVariableModel>?,
    hierarchy: List<NativeBlockHierarchyModel>?,
): String

Example Usage:

val jsonString = "data$[0][name]"
val variables = mapOf(
    "data" to NativeVariableModel("[{\"name\":\"Alice\"}, {\"name\":\"Bob\"}]")
)
val hierarchy = listOf(NativeBlockHierarchyModel(key = "key", position = 0))
val result = jsonString.parseWithJsonPath(variables, hierarchy)
println(result) // Output: Alice

Parameters

• variables: A map of variable names to their corresponding NativeVariableModel values.
• hierarchy: A list representing the hierarchy of NativeBlockHierarchyModel items.

Returns

The evaluated string value based on the JSON path and the variables provided.

parseWithJsonPath(variables:index:)

Extracts and evaluates a JSON path from an action data string.

fun String.parseWithJsonPath(
    variables: Map<String, NativeVariableModel>?,
    index: Int?
): String

Example Usage:

val jsonString = "data$[0][email]"
val variables = mapOf(
    "data" to NativeVariableModel("[{\"email\":\"test@example.com\"}]")
)
val result = jsonString.parseWithJsonPath(variables, index = 0)
println(result) // Output: test@example.com

Parameters

• variables: A map of variable names to their corresponding NativeVariableModel values.
• index: An optional index used to replace key variables.

Returns

The evaluated string value based on the JSON path and the variables provided.

isJsonPath(): Boolean

Extension function to check if a string is a valid JSONPath.

fun String.isJsonPath(): Boolean

Example Usage

val query = "$[name]"
println(query.isJsonPath()) // Output: true