@zio.dev/zio-blocks 0.0.33 → 0.0.55

package/reference/typeid.md

@@ -2484,7 +2484,7 @@ object Email {
 
 The `Deriver` trait receives a `TypeId` for each node in the schema. Methods like `deriveRecord` and `deriveVariant` include a `typeId: TypeId[A]` parameter alongside fields/cases, bindings, documentation, modifiers, and more. This lets you inspect the type's structure, annotations, and relationships when generating code.
 
-For details on the full `Deriver` API and how to implement custom derivers, see the [Type Class Derivation](./type-class-derivation.md) reference.
+For details on the full `Deriver` API and how to implement custom derivers, see the [Type Class Derivation](./schema/type-class-derivation.md) reference.
 
 ## Comparison with Alternatives
 
@@ -2527,26 +2527,10 @@ cd zio-blocks
 Demonstrates deriving TypeIds for case classes, accessing their properties (name, fullName, owner, arity), using predefined TypeIds for built-in types, and implicit derivation:
 
 ```scala title="schema-examples/src/main/scala/typeid/TypeIdBasicExample.scala" 
-/*
- * Copyright 2024-2026 John A. De Goes and the ZIO Contributors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
 package typeid
 
 import zio.blocks.typeid.*
-import util.ShowExpr.show
+import zio.sbt.ExprEval.show
 
 /**
  * TypeId Basic Example
@@ -2789,26 +2773,10 @@ sbt "schema-examples/runMain typeid.TypeIdBasicExample"
 Demonstrates subtype checking with `isSubtypeOf`, `isSupertypeOf`, and `isEquivalentTo`, including direct inheritance, transitive inheritance, sealed trait cases, and variance-aware subtyping for applied types like `List[Dog] <: List[Animal]`:
 
 ```scala title="schema-examples/src/main/scala/typeid/TypeIdSubtypingExample.scala" 
-/*
- * Copyright 2024-2026 John A. De Goes and the ZIO Contributors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
 package typeid
 
 import zio.blocks.typeid._
-import util.ShowExpr.show
+import zio.sbt.ExprEval.show
 
 /**
  * TypeId Subtyping Example
@@ -2912,26 +2880,10 @@ sbt "schema-examples/runMain typeid.TypeIdSubtypingExample"
 Demonstrates type alias handling, normalization to underlying types, structural equality, and building type-indexed registries using erased TypeIds:
 
 ```scala title="schema-examples/src/main/scala/typeid/TypeIdNormalizationExample.scala" 
-/*
- * Copyright 2024-2026 John A. De Goes and the ZIO Contributors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
 package typeid
 
 import zio.blocks.typeid._
-import util.ShowExpr.show
+import zio.sbt.ExprEval.show
 
 /**
  * TypeId Normalization Example
@@ -2963,10 +2915,8 @@ object TypeIdNormalizationExample extends App {
     aliased = TypeRepr.Ref(TypeId.long)
   )
 
-  println("userIdAlias.name")
   show(userIdAlias.name)
 
-  println("userIdAlias.fullName")
   show(userIdAlias.fullName)
 
   println("\n--- Normalization ---\n")
@@ -2974,10 +2924,8 @@ object TypeIdNormalizationExample extends App {
   // Normalize the alias to its underlying type
   val normalized = TypeId.normalize(userIdAlias)
 
-  println("TypeId.normalize(userIdAlias).name")
   show(normalized.name)
 
-  println("TypeId.normalize(userIdAlias).fullName")
   show(normalized.fullName)
 
   println("\n--- Equality with Normalization ---\n")
@@ -2990,10 +2938,8 @@ object TypeIdNormalizationExample extends App {
     aliased = TypeRepr.Ref(TypeId.long)
   )
 
-  println("userIdAlias == anotherUserIdAlias")
   show(userIdAlias == anotherUserIdAlias)
 
-  println("TypeId.normalize(userIdAlias) == TypeId.long")
   show(TypeId.normalize(userIdAlias) == TypeId.long)
 
   println("\n--- Erased TypeIds for Registries ---\n")
@@ -3003,13 +2949,10 @@ object TypeIdNormalizationExample extends App {
   val stringErased: TypeId.Erased  = TypeId.string.erased
   val listIntErased: TypeId.Erased = TypeId.of[List[Int]].erased
 
-  println("TypeId.int.erased")
   show(intErased)
 
-  println("TypeId.string.erased")
   show(stringErased)
 
-  println("TypeId.of[List[Int]].erased")
   show(listIntErased)
 
   println("\n--- Type Registry Using Erased TypeIds ---\n")
@@ -3022,13 +2965,10 @@ object TypeIdNormalizationExample extends App {
     TypeId.of[List[Int]].erased -> "List of integers"
   )
 
-  println("registry.get(TypeId.int.erased)")
   show(registry.get(TypeId.int.erased))
 
-  println("registry.get(TypeId.string.erased)")
   show(registry.get(TypeId.string.erased))
 
-  println("registry.get(TypeId.of[List[Int]].erased)")
   show(registry.get(TypeId.of[List[Int]].erased))
 
   println("\n--- Querying the Registry ---\n")
@@ -3037,10 +2977,8 @@ object TypeIdNormalizationExample extends App {
   val intType    = TypeId.of[Int].erased
   val doubleType = TypeId.of[Double].erased
 
-  println("registry.get(intType)")
   show(registry.get(intType))
 
-  println("registry.get(doubleType)")
   show(registry.get(doubleType))
 
   println("\n═══════════════════════════════════════════════════════════════")
@@ -3058,26 +2996,10 @@ sbt "schema-examples/runMain typeid.TypeIdNormalizationExample"
 Demonstrates how TypeId preserves the semantic distinction of opaque types, enabling runtime type safety that pure Scala reflection cannot provide. Shows building type-indexed validator registries keyed by opaque type identity:
 
 ```scala title="schema-examples/src/main/scala/typeid/OpaqueTypesExample.scala" 
-/*
- * Copyright 2024-2026 John A. De Goes and the ZIO Contributors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
 package typeid
 
 import zio.blocks.typeid._
-import util.ShowExpr.show
+import zio.sbt.ExprEval.show
 
 /**
  * Opaque Types Example

package/sidebars.js

@@ -6,38 +6,113 @@ const sidebars = {
       collapsed: false,
       link: { type: "doc", id: "index" },
       items: [
-         "reference/schema",
-         "reference/allows",
-         "reference/reflect",
-         "reference/binding",
-         "reference/binding-resolver",
-         "reference/registers",
-         "reference/typeid",
-         "reference/modifier",
-         "reference/dynamic-value",
-         "reference/dynamic-schema",
-         "reference/lazy",
-         "reference/structural-types",
-         "reference/optics",
-         "reference/patch",
-         "reference/schema-expr",
-         "reference/dynamic-optic",
-         "reference/type-class-derivation",
-         "reference/codec",
-         "reference/formats",
-         "path-interpolator",
-         "reference/chunk",
-         "reference/schema-error",
-         "reference/validation",
          {
            type: "category",
-           label: "Schema Evolution",
-           link: { type: "doc", id: "reference/schema-evolution/index" },
+           label: "Schema",
+           link: { type: "doc", id: "reference/schema/index" },
            items: [
-             "reference/schema-evolution/into",
-             "reference/schema-evolution/as",
+             {
+               type: "category",
+               label: "Core Type System",
+               collapsed: false,
+               items: [
+                 "reference/schema/schema",
+                 "reference/schema/reflect",
+                 "reference/schema/binding",
+                 "reference/schema/registers",
+                 "reference/schema/binding-resolver",
+                 "reference/schema/reflect-transformer",
+                 "reference/schema/modifier",
+                 "reference/schema/structural-types",
+               ]
+             },
+             {
+               type: "category",
+               label: "Dynamic Values",
+               collapsed: false,
+               items: [
+                 "reference/schema/dynamic-value",
+                 "reference/schema/dynamic-schema",
+               ]
+             },
+             {
+               type: "category",
+               label: "Reflective Optics",
+               collapsed: false,
+               items: [
+                 "reference/schema/optics",
+                 "reference/schema/dynamic-optic",
+                 "reference/schema/path-interpolator",
+                 "reference/schema/schema-search",
+                 "reference/schema/schema-expr",
+                 "reference/schema/patch",
+               ]
+             },
+             {
+               type: "category",
+               label: "Serialization",
+               collapsed: false,
+               items: [
+                 "reference/schema/type-class-derivation",
+                 "reference/schema/codec",
+                 "reference/schema/format",
+                 "reference/schema/lazy",
+               ]
+             },
+             {
+               type: "category",
+               label: "Built-in Formats and Codecs",
+               link: { type: "doc", id: "reference/schema/built-in-codecs/index" },
+               collapsed: false,
+               items: [
+                 {
+                   type: "category",
+                   label: "JSON Codec",
+                   link: { type: "doc", id: "reference/schema/built-in-codecs/json/index" },
+                   collapsed: false,
+                   items: [
+                     "reference/schema/built-in-codecs/json/json",
+                     "reference/schema/built-in-codecs/json/json-config",
+                     "reference/schema/built-in-codecs/json/json-patch",
+                     "reference/schema/built-in-codecs/json/json-differ",
+                     "reference/schema/built-in-codecs/json/json-selection",
+                     "reference/schema/built-in-codecs/json/json-schema",
+                   ]
+                 },
+                 "reference/schema/built-in-codecs/avro",
+                 "reference/schema/built-in-codecs/bson",
+                 "reference/schema/built-in-codecs/csv",
+                 "reference/schema/built-in-codecs/messagepack",
+                 "reference/schema/built-in-codecs/thrift",
+                 "reference/schema/built-in-codecs/toon",
+                 "reference/schema/built-in-codecs/xml",
+                 "reference/schema/built-in-codecs/yaml",
+               ]
+             },
+             {
+               type: "category",
+               label: "Validation & Errors",
+               collapsed: false,
+               items: [
+                 "reference/schema/validation",
+                 "reference/schema/schema-error",
+                 "reference/schema/allows",
+               ]
+             },
+              {
+                type: "category",
+                label: "Schema Evolution",
+                link: { type: "doc", id: "reference/schema/schema-evolution/index" },
+                items: [
+                  "reference/schema/schema-evolution/into",
+                  "reference/schema/schema-evolution/as",
+                  "reference/schema/migration",
+                ]
+              },
+             "reference/schema/syntax",
            ]
          },
+         "reference/typeid",
          "reference/context",
          {
            type: "category",
@@ -52,30 +127,288 @@ const sidebars = {
              "reference/resource-management/finalizer",
              "reference/resource-management/finalization",
            ]
+          },
+          "reference/combinators",
+          "reference/docs",
+         {
+           type: "category",
+           label: "Config",
+           link: { type: "doc", id: "reference/config/index" },
+           items: [
+             "reference/config/config-source",
+             "reference/config/config-decoder",
+             "reference/config/errors",
+             "reference/config/flags",
+             "reference/config/rollout",
+             "reference/config/formats",
+           ]
          },
-         "reference/combinators",
-         "reference/docs",
-         "reference/json",
-         "reference/json-patch",
-         "reference/json-differ",
-         "reference/json-schema",
-         "reference/xml",
-         "reference/syntax",
-         "reference/media-type",
-         "reference/http-model",
-         "ringbuffer",
-      ]
-    },
+          "reference/media-type",
+         {
+           type: "category",
+           label: "Code Generation",
+           link: { type: "doc", id: "reference/codegen/index" },
+           items: [
+             "reference/codegen/scala-file",
+             "reference/codegen/type-definition",
+             "reference/codegen/case-class",
+             "reference/codegen/sealed-trait",
+             "reference/codegen/field",
+             "reference/codegen/type-ref",
+             "reference/codegen/scala-emitter",
+             "reference/codegen/emitter-config",
+             "reference/codegen/examples",
+           ]
+         },
+          {
+            type: "category",
+            label: "HTTP Model",
+            link: { type: "doc", id: "reference/http-model/index" },
+            items: [
+              "reference/http-model/model",
+              "reference/http-model/headers",
+              "reference/http-model/server-sent-event",
+              "reference/http-model/schema",
+              "reference/http-model/schema-codecs",
+            ]
+          },
+          {
+            type: "category",
+            label: "Endpoint",
+            link: { type: "doc", id: "reference/endpoint/index" },
+            items: [
+              "reference/endpoint/endpoint",
+              "reference/endpoint/bulk-creation",
+              "reference/endpoint/http-codec",
+              "reference/endpoint/route-pattern",
+              "reference/endpoint/path-codec",
+              "reference/endpoint/segment-codec",
+              "reference/endpoint/auth-type",
+              "reference/endpoint/route-tree",
+            ]
+          },
+          "reference/chunk",
+          "reference/maybe",
+          "reference/async",
+          "reference/mux",
+          {
+            type: "category",
+            label: "RingBuffer",
+            link: { type: "doc", id: "reference/ringbuffer/index" },
+            items: [
+              "reference/ringbuffer/spsc",
+              "reference/ringbuffer/spmc",
+              "reference/ringbuffer/mpsc",
+              "reference/ringbuffer/mpmc",
+              "reference/ringbuffer/advanced",
+            ]
+          },
+          "reference/html",
+          "reference/smithy",
+          "reference/openapi",
+          "reference/jwt",
+         {
+            type: "category",
+            label: "Datastar",
+           link: { type: "doc", id: "reference/datastar/index" },
+           items: [
+             "reference/datastar/signals",
+             "reference/datastar/attributes",
+             "reference/datastar/events",
+             "reference/datastar/sse",
+           ]
+         },
+          {
+            type: "category",
+            label: "HTMX",
+            link: { type: "doc", id: "reference/htmx/index" },
+            items: [
+              "reference/htmx/hx-swap",
+              "reference/htmx/hx-trigger",
+              "reference/htmx/hx-target",
+              "reference/htmx/hx-params",
+              "reference/htmx/hx-url-update",
+              "reference/htmx/hx-encoding",
+              "reference/htmx/hx-sync",
+              "reference/htmx/attribute-values",
+              "reference/htmx/response-headers",
+            ]
+          },
+          {
+            type: "category",
+            label: "Streams",
+            link: { type: "doc", id: "reference/streams/index" },
+            items: [
+              {
+                type: "category",
+                label: "Core Types",
+                collapsed: false,
+                link: { type: "doc", id: "reference/streams/core/index" },
+                items: [
+                  "reference/streams/core/stream",
+                  "reference/streams/core/pipeline",
+                  "reference/streams/core/sink",
+                ]
+              },
+              {
+                type: "category",
+                label: "Low-Level Primitives",
+                collapsed: false,
+                link: { type: "doc", id: "reference/streams/primitives/index" },
+                items: [
+                  "reference/streams/primitives/reader",
+                  "reference/streams/primitives/writer",
+                ]
+              },
+              {
+                type: "category",
+                label: "Execution and Compatibility",
+                collapsed: false,
+                link: { type: "doc", id: "reference/streams/execution-and-compatibility/index" },
+                items: [
+                  "reference/streams/execution-and-compatibility/async-execution",
+                  "reference/streams/execution-and-compatibility/zero-boxing",
+                  "reference/streams/execution-and-compatibility/platform-differences",
+                  "reference/streams/execution-and-compatibility/scala-2-compatibility",
+                ]
+              },
+            ]
+          },
+          {
+            type: "category",
+            label: "SQL",
+            link: { type: "doc", id: "reference/sql/index" },
+            items: [
+              {
+                type: "category",
+                label: "Core Types",
+                collapsed: false,
+                items: [
+                  "reference/sql/db-codec",
+                  "reference/sql/frag",
+                  "reference/sql/table",
+                  "reference/sql/repo",
+                  "reference/sql/transactor",
+                  "reference/sql/db-con",
+                  "reference/sql/db-tx",
+                ],
+              },
+              {
+                type: "category",
+                label: "Supporting Types",
+                collapsed: false,
+                items: [
+                  "reference/sql/db-value",
+                  "reference/sql/db-param",
+                  "reference/sql/sql-dialect",
+                  "reference/sql/sql-logger",
+                  "reference/sql/sql-name-mapper",
+                  "reference/sql/table-metadata",
+                  "reference/sql/ddl",
+                  "reference/sql/db-connection",
+                  "reference/sql/db-result-reader",
+                  "reference/sql/db-param-writer",
+                  "reference/sql/db-codec-deriver",
+                  "reference/sql/transactor-zio",
+                ],
+              },
+            ],
+          },
+          "reference/sql-zio",
+          "reference/data-migration",
+          "reference/projection",
+          {
+            type: "category",
+            label: "Telemetry",
+            link: { type: "doc", id: "reference/telemetry/index" },
+            items: [
+              {
+                type: "category",
+                label: "Tracing",
+                link: { type: "doc", id: "reference/telemetry/tracing/index" },
+                collapsed: false,
+                items: [
+                  "reference/telemetry/tracing/tracer-provider",
+                  "reference/telemetry/tracing/tracer",
+                  "reference/telemetry/tracing/span",
+                  "reference/telemetry/tracing/span-context",
+                  "reference/telemetry/tracing/span-data",
+                  "reference/telemetry/tracing/span-builder",
+                  "reference/telemetry/tracing/span-processor",
+                  "reference/telemetry/tracing/sampler",
+                  "reference/telemetry/tracing/span-kind",
+                  "reference/telemetry/tracing/span-status",
+                ]
+              },
+              {
+                type: "category",
+                label: "Logging",
+                link: { type: "doc", id: "reference/telemetry/logging/index" },
+                collapsed: false,
+                items: [
+                  "reference/telemetry/logging/logger-provider",
+                  "reference/telemetry/logging/logger",
+                  "reference/telemetry/logging/log-record",
+                  "reference/telemetry/logging/log-record-processor",
+                  "reference/telemetry/logging/log-formatter",
+                  "reference/telemetry/logging/log-writer",
+                  "reference/telemetry/logging/severity",
+                  "reference/telemetry/logging/log-enrichment",
+                ]
+              },
+              {
+                type: "category",
+                label: "Metrics",
+                link: { type: "doc", id: "reference/telemetry/metrics/index" },
+                collapsed: false,
+                items: [
+                  "reference/telemetry/metrics/meter-provider",
+                  "reference/telemetry/metrics/meter",
+                  "reference/telemetry/metrics/instruments",
+                  "reference/telemetry/metrics/labeled-instruments",
+                  "reference/telemetry/metrics/metric-data",
+                ]
+              },
+              {
+                type: "category",
+                label: "Common Types",
+                link: { type: "doc", id: "reference/telemetry/common/index" },
+                collapsed: false,
+                items: [
+                  "reference/telemetry/common/attributes",
+                  "reference/telemetry/common/attribute-key",
+                  "reference/telemetry/common/any-value",
+                  "reference/telemetry/common/resource",
+                  "reference/telemetry/common/instrumentation-scope",
+                ]
+              },
+              {
+                type: "category",
+                label: "OTLP Export",
+                link: { type: "doc", id: "reference/telemetry/otel/index" },
+                collapsed: false,
+                items: [
+                  "reference/telemetry/otel/custom-exporter",
+                ]
+              },
+            ]
+          },
+        ]
+      },
     {
       type: "category",
       label: "Guides",
       items: [
+        "guides/async-getting-started",
         "guides/compile-time-resource-safety-with-scope",
-        "guides/zio-schema-migration",
-        "guides/query-dsl-reified-optics",
-        "guides/query-dsl-sql",
+        "guides/getting-started-with-mux",
         "guides/query-dsl-extending",
         "guides/query-dsl-fluent-builder",
+        "guides/query-dsl-reified-optics",
+        "guides/query-dsl-sql",
+        "guides/sql-transactions",
+        "guides/zio-schema-migration",
+        "guides/telemetry-guide",
       ]
     }
   ]