aivi.data.json

JSON text helpers plus structural JSON vocabulary.

This module has two layers today:

1. structural Json / JsonError types exported from the stdlib source file
2. compiler-backed helpers like validate, get, and pretty that operate on raw JSON text and return Task values in the current runtime

use aivi.data.json (
    Json
    JsonNull
    isNull
    validate
    get
    pretty
)

---

Structural JSON types

use aivi.core.dict (Dict)

type Json =
  | JsonNull
  | JsonBool Bool
  | JsonNumber Float
  | JsonString Text
  | JsonArray (List Json)
  | JsonObject (Dict Text Json)

use aivi.data.json (
    Json
    isObject
)

type Json -> Bool
func payloadIsObject =
  |> isObject

The module also exports JsonError and JsonPath:

type JsonError =
  | InvalidJson Text
  | MissingKey Text
  | IndexOutOfBounds Int
  | WrongType Text

type JsonPath = List Text

Predicates exported from the module file:

• isNull
• isObject
• isArray
• isBool
• isNumber
• isString

---

Text-level JSON helpers

These are compiler-backed helpers over raw JSON text.

Name	Type
validate	Text -> Task Text Bool
get	Text -> Text -> Task Text (Option Text)
at	Text -> Int -> Task Text (Option Text)
keys	Text -> Task Text (List Text)
pretty	Text -> Task Text Text
minify	Text -> Task Text Text

use aivi.data.json (
    get
    pretty
    validate
)

value validPayload : Task Text Bool = validate "\{\"name\":\"Ada\"\}"
value userName : Task Text (Option Text) = get "\{\"name\":\"Ada\"\}" "name"
value prettyPayload : Task Text Text = pretty "\{\"name\":\"Ada\",\"role\":\"admin\"\}"

get and at return raw JSON text fragments today, not decoded Json values. That is a compatibility surface; newer provider-based decode paths should prefer typed decoding at the source boundary.

Constructors

InvalidJson message, MissingKey key, IndexOutOfBounds index, and WrongType expected construct JsonError values.

The Json constructors are JsonNull, JsonBool value, JsonNumber value, JsonString value, JsonArray values, and JsonObject fields.