@zio.dev/zio-blocks 0.0.1 → 0.0.21

package/reference/dynamic-value.md

@@ -33,7 +33,7 @@ Key design decisions:
 
 Wraps scalar values in a `PrimitiveValue`:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.DynamicValue
 
 // Using convenience constructors
@@ -53,7 +53,7 @@ val instant = DynamicValue.Primitive(
 
 A collection of named fields, analogous to case classes or JSON objects:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.DynamicValue
 import zio.blocks.chunk.Chunk
 
@@ -80,7 +80,7 @@ Field order is preserved and significant for equality. Use `sortFields` to norma
 
 A tagged union value, analogous to sealed traits:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.DynamicValue
 
 // A Some variant containing a value
@@ -101,7 +101,7 @@ some.caseValue  // Some(DynamicValue.Primitive(...))
 
 An ordered collection of values:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.DynamicValue
 import zio.blocks.chunk.Chunk
 
@@ -126,7 +126,7 @@ val empty = DynamicValue.Sequence.empty
 
 Key-value pairs where both keys and values are `DynamicValue`:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.DynamicValue
 import zio.blocks.chunk.Chunk
 
@@ -152,7 +152,7 @@ Unlike `Record` which uses String keys, `Map` supports arbitrary `DynamicValue`
 
 Represents the absence of a value:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.DynamicValue
 
 val absent = DynamicValue.Null
@@ -199,7 +199,7 @@ val absent = DynamicValue.Null
 
 Use `Schema.toDynamicValue` to convert typed Scala values to `DynamicValue`:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.{Schema, DynamicValue}
 
 case class Person(name: String, age: Int)
@@ -220,7 +220,7 @@ val listDynamic = Schema[List[Int]].toDynamicValue(List(1, 2, 3))
 
 Use `Schema.fromDynamicValue` to convert `DynamicValue` back to typed Scala values:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.{Schema, DynamicValue, SchemaError}
 
 case class Person(name: String, age: Int)
@@ -248,7 +248,7 @@ val error = Schema[Person].fromDynamicValue(badDynamic)
 
 Each `DynamicValue` has a corresponding `DynamicValueType` for runtime type checking:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.{DynamicValue, DynamicValueType}
 
 val dv = DynamicValue.Record("x" -> DynamicValue.int(1))
@@ -269,7 +269,7 @@ val fields: Option[Chunk[(String, DynamicValue)]] =
 
 ### Extracting Primitive Values
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.{DynamicValue, PrimitiveType, Validation}
 
 val dv = DynamicValue.int(42)
@@ -288,7 +288,7 @@ val stringValue: Option[String] = dv.asPrimitive(PrimitiveType.String(Validation
 
 Navigate using `get` methods that return `DynamicValueSelection`:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.DynamicValue
 
 val data = DynamicValue.Record(
@@ -315,7 +315,7 @@ val name = firstName.one  // Either[SchemaError, DynamicValue]
 
 Use `DynamicOptic` for complex path expressions:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.{DynamicValue, DynamicOptic}
 
 val data = DynamicValue.Record(
@@ -337,7 +337,7 @@ val result = data.get(path).one  // Right(DynamicValue.Primitive(String("Alice")
 
 `DynamicValueSelection` wraps navigation results and provides fluent chaining:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.{DynamicValue, DynamicValueSelection}
 
 val selection: DynamicValueSelection = ???
@@ -366,7 +366,7 @@ selection.flatMap(dv => ???)  // Chain selections
 
 Update values at a path:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.{DynamicValue, DynamicOptic}
 
 val data = DynamicValue.Record(
@@ -386,7 +386,7 @@ val updated = data.modify(path)(dv => DynamicValue.string("Bob"))
 
 Replace a value at a path:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.{DynamicValue, DynamicOptic}
 
 val data = DynamicValue.Record("x" -> DynamicValue.int(1))
@@ -400,7 +400,7 @@ val updated = data.set(path, DynamicValue.int(99))
 
 Remove a value at a path:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.{DynamicValue, DynamicOptic}
 
 val data = DynamicValue.Record(
@@ -416,7 +416,7 @@ val updated = data.delete(DynamicOptic.root.field("a"))
 
 Add a value at a path (fails if path exists):
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.{DynamicValue, DynamicOptic}
 
 val data = DynamicValue.Record("a" -> DynamicValue.int(1))
@@ -432,7 +432,7 @@ val updated = data.insert(
 
 Use `*OrFail` variants for operations that should fail explicitly:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.{DynamicValue, DynamicOptic, SchemaError}
 
 val data = DynamicValue.Record("x" -> DynamicValue.int(1))
@@ -452,7 +452,7 @@ val result: Either[SchemaError, DynamicValue] =
 - Adds `@ {tag: "..."}` annotations for Variants
 - Adds `@ {type: "..."}` annotations for typed primitives (Instant, Duration, etc.)
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.{DynamicValue, PrimitiveValue}
 
 val person = DynamicValue.Record(
@@ -488,7 +488,7 @@ Use `toEjson(indent)` to control indentation level.
 
 Merge two `DynamicValue` structures using configurable strategies:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.{DynamicValue, DynamicValueMergeStrategy}
 
 val left = DynamicValue.Record(
@@ -517,7 +517,7 @@ val merged = left.merge(right, DynamicValueMergeStrategy.Auto)
 | `Concat` | Concatenate Sequences instead of merging by index |
 | `Custom(f, r)` | Custom function with custom recursion control |
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.{DynamicValue, DynamicValueMergeStrategy}
 
 val list1 = DynamicValue.Sequence(DynamicValue.int(1), DynamicValue.int(2))
@@ -532,7 +532,7 @@ val concatted = list1.merge(list2, DynamicValueMergeStrategy.Concat)
 
 Transform `DynamicValue` structures for comparison or serialization:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.DynamicValue
 
 val data = DynamicValue.Record(
@@ -566,7 +566,7 @@ data.normalize
 
 Apply functions to all values in a structure:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.{DynamicValue, DynamicOptic, PrimitiveValue}
 
 val data = DynamicValue.Record(
@@ -593,7 +593,7 @@ val topDown = data.transformDown { (path, dv) => ??? }
 
 Rename all record fields:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.{DynamicValue, DynamicOptic}
 
 val data = DynamicValue.Record(
@@ -615,7 +615,7 @@ val camelCase = data.transformFields { (path, name) =>
 
 Aggregate values from a `DynamicValue` tree:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.{DynamicValue, DynamicOptic, PrimitiveValue}
 
 val data = DynamicValue.Record(
@@ -638,7 +638,7 @@ val sum = data.foldUp(0) { (path, dv, acc) =>
 
 ### To JSON
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.DynamicValue
 import zio.blocks.schema.json.Json
 
@@ -653,7 +653,7 @@ val json: Json = dynamic.toJson
 
 ### From JSON
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.DynamicValue
 import zio.blocks.schema.json.Json
 
@@ -667,7 +667,7 @@ val dynamic: DynamicValue = json.toDynamicValue
 
 Search recursively for values matching a predicate:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.{DynamicValue, DynamicValueType, PrimitiveValue}
 
 val data = DynamicValue.Record(
@@ -691,7 +691,7 @@ val atDepth2 = data.select.queryPath(path => path.nodes.length == 2)
 
 Work with data when the schema isn't known at compile time:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.{DynamicValue, PrimitiveValue}
 
 def processAnyData(data: DynamicValue): DynamicValue = {
@@ -712,7 +712,7 @@ def processAnyData(data: DynamicValue): DynamicValue = {
 
 Transform data between schema versions:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.{DynamicValue, DynamicOptic}
 
 def migrateV1toV2(data: DynamicValue): DynamicValue = {
@@ -735,7 +735,7 @@ def migrateV1toV2(data: DynamicValue): DynamicValue = {
 
 Build queries at runtime:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.{DynamicValue, DynamicOptic}
 
 def buildPath(fields: List[String]): DynamicOptic =
@@ -761,7 +761,7 @@ val email = getValue(data, List("user", "profile", "email"))
 
 Use `DynamicValue` as an intermediate format:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.{Schema, DynamicValue}
 import zio.blocks.schema.json.Json
 
@@ -784,7 +784,7 @@ val json2 = dynamic2.toJson
 
 `DynamicValue` has a total ordering for sorting and comparison:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.DynamicValue
 
 val a = DynamicValue.int(1)
@@ -804,7 +804,7 @@ primitive < record  // true
 
 Compute differences between `DynamicValue` instances:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.DynamicValue
 import zio.blocks.schema.patch.DynamicPatch
 

package/reference/formats.md

@@ -9,7 +9,7 @@ ZIO Blocks Schema provides automatic codec derivation for multiple serialization
 
 All serialization formats in ZIO Blocks follow the same pattern: given a `Schema[A]`, you derive a codec by calling `derive` with a format object:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema._
 import zio.blocks.schema.toon._
 
@@ -54,7 +54,7 @@ libraryDependencies += "dev.zio" %% "zio-blocks-schema" % "<version>"
 
 ### Basic Usage
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema._
 import zio.blocks.schema.json._
 
@@ -89,7 +89,7 @@ Requires the Apache Avro library (1.12.x).
 
 ### Basic Usage
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema._
 import zio.blocks.schema.avro._
 
@@ -114,7 +114,7 @@ val decoded: Either[SchemaError, Person] = codec.decode(bytes)
 
 Each `AvroBinaryCodec` exposes an `avroSchema` property containing the Apache Avro schema:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema._
 import zio.blocks.schema.avro._
 import org.apache.avro.{Schema => AvroSchema}
@@ -162,7 +162,7 @@ println(avroSchema.toString(true))
 
 Sealed traits are encoded as Avro unions with an integer index prefix:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema._
 import zio.blocks.schema.avro._
 
@@ -202,7 +202,7 @@ libraryDependencies += "dev.zio" %% "zio-blocks-schema-toon" % "<version>"
 
 ### Basic Usage
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema._
 import zio.blocks.schema.toon._
 
@@ -260,7 +260,7 @@ orders[2]{id,total}:
 
 The `ToonBinaryCodecDeriver` provides extensive configuration:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema._
 import zio.blocks.schema.toon._
 
@@ -295,7 +295,7 @@ val codec = Schema[Person].derive(customDeriver)
 
 ### ADT Encoding Styles
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema._
 import zio.blocks.schema.toon._
 
@@ -331,7 +331,7 @@ libraryDependencies += "dev.zio" %% "zio-blocks-schema-messagepack" % "<version>
 
 ### Basic Usage
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema._
 import zio.blocks.schema.msgpack._
 
@@ -383,7 +383,7 @@ MessagePack provides significant space savings compared to JSON:
 
 Sealed traits encode a variant index followed by the case value:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema._
 import zio.blocks.schema.msgpack._
 
@@ -416,7 +416,7 @@ Requires the MongoDB BSON library (5.x).
 
 ### Basic Usage
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema._
 import zio.blocks.schema.bson._
 
@@ -438,7 +438,7 @@ val codec: BsonCodec[Person] = BsonSchemaCodec.bsonCodec(Schema[Person])
 
 BSON provides native support for MongoDB ObjectIds:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema._
 import zio.blocks.schema.bson._
 import org.bson.types.ObjectId
@@ -458,7 +458,7 @@ val codec = BsonSchemaCodec.bsonCodec(Schema[Document])
 
 ### Configuration Options
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema._
 import zio.blocks.schema.bson._
 import BsonSchemaCodec._
@@ -486,7 +486,7 @@ val codec = BsonSchemaCodec.bsonCodec(Schema[Person], config)
 
 ### Sum Type Handling
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.bson.BsonSchemaCodec.SumTypeHandling
 
 // Option 1: Wrapper with class name as field key (default)
@@ -515,7 +515,7 @@ Requires the Apache Thrift library (0.22.x).
 
 ### Basic Usage
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema._
 import zio.blocks.schema.thrift._
 import java.nio.ByteBuffer
@@ -616,7 +616,7 @@ All formats support the full set of ZIO Blocks Schema primitive types:
 
 All formats return `Either[SchemaError, A]` for decoding operations. Errors include path information for debugging:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema._
 import zio.blocks.schema.toon._
 

package/reference/json-schema.md

@@ -31,7 +31,7 @@ The most common use case is deriving a JSON Schema from an existing `Schema[A]`.
 
 ### Basic Derivation
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema._
 import zio.blocks.schema.json._
 
@@ -55,7 +55,7 @@ jsonSchema.conforms(invalid) // false
 
 For more control, derive through `JsonBinaryCodec`:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema._
 import zio.blocks.schema.json._
 
@@ -75,7 +75,7 @@ val jsonSchema = codec.toJsonSchema
 
 The simplest schemas accept or reject all values:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.json.JsonSchema
 
 // Accepts any valid JSON value
@@ -89,7 +89,7 @@ val rejectAll = JsonSchema.False
 
 Create schemas that validate specific JSON types:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.json.{JsonSchema, JsonSchemaType}
 
 // Single type
@@ -110,7 +110,7 @@ val isBoolean = JsonSchema.boolean
 
 Create schemas for string validation:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.json.{JsonSchema, NonNegativeInt, RegexPattern}
 
 // String with length constraints (compile-time validated literals)
@@ -134,7 +134,7 @@ val uuid = JsonSchema.string(format = Some("uuid"))
 
 Create schemas for number validation:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.json.{JsonSchema, PositiveNumber}
 
 // Number with range
@@ -158,7 +158,7 @@ val evenNumber = JsonSchema.integer(
 
 Create schemas for array validation:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.json.{JsonSchema, JsonSchemaType, NonNegativeInt}
 
 // Array of strings
@@ -192,7 +192,7 @@ val point2D = JsonSchema.array(
 
 Create schemas for object validation:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.json.{JsonSchema, JsonSchemaType}
 import zio.blocks.chunk.ChunkMap
 
@@ -218,7 +218,7 @@ val strictPerson = JsonSchema.obj(
 
 ### Enum and Const
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.json.{JsonSchema, Json}
 
 // Enum of string values
@@ -240,7 +240,7 @@ val alwaysTrue = JsonSchema.constOf(Json.Boolean(true))
 
 Combine schemas using logical operators:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.json.{JsonSchema, JsonSchemaType}
 
 val stringSchema = JsonSchema.ofType(JsonSchemaType.String)
@@ -266,7 +266,7 @@ val nullableString = stringSchema || nullSchema
 
 Make any schema nullable:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.json.{JsonSchema, JsonSchemaType}
 
 val stringSchema = JsonSchema.ofType(JsonSchemaType.String)
@@ -281,7 +281,7 @@ val nullableString = stringSchema.withNullable
 
 Apply different schemas based on conditions:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.json.{JsonSchema, JsonSchemaType, NonNegativeInt}
 
 // If type is string, require minLength
@@ -296,7 +296,7 @@ val conditionalSchema = JsonSchema.Object(
 
 Apply schemas when properties are present:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.json.{JsonSchema, JsonSchemaType}
 import zio.blocks.chunk.ChunkMap
 
@@ -316,7 +316,7 @@ val paymentSchema = JsonSchema.Object(
 
 ### Basic Validation
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.json.{JsonSchema, Json, JsonSchemaType}
 import zio.blocks.chunk.ChunkMap
 
@@ -350,7 +350,7 @@ schema.conforms(invalidJson) // false
 
 Control validation behavior:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.json.{JsonSchema, Json, ValidationOptions}
 
 val schema = JsonSchema.string(format = Some("email"))
@@ -369,7 +369,7 @@ schema.check(value, lenientOptions) // None
 
 Validation errors include path information:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.json.{JsonSchema, Json, JsonSchemaType}
 import zio.blocks.chunk.ChunkMap
 
@@ -402,7 +402,7 @@ schema.check(invalid) match {
 
 ### Parsing from JSON
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.json.{JsonSchema, Json}
 
 // From JSON string
@@ -426,7 +426,7 @@ val fromJson = JsonSchema.fromJson(json)
 
 ### Serializing to JSON
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.json.{JsonSchema, NonNegativeInt}
 
 val schema = JsonSchema.string(
@@ -466,7 +466,7 @@ Format validation is enabled by default. Use `ValidationOptions.annotationOnly`
 
 JSON Schema 2020-12 introduces `unevaluatedProperties` and `unevaluatedItems` for validating properties/items not matched by any applicator keyword:
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.json.{JsonSchema, JsonSchemaType}
 import zio.blocks.chunk.ChunkMap
 
@@ -554,7 +554,7 @@ The implementation passes **817 of 844 tests** (97%+) from the official JSON Sch
 
 ## Complete Example
 
-```scala mdoc:compile-only
+```scala
 import zio.blocks.schema.json._
 import zio.blocks.chunk.ChunkMap