🥮 mooncakes.io

    moonjtd

    MoonBit-native RFC 8927 JSON Type Definition validator and code generator

    json
    jtd
    rfc8927
    validation
    codegen
    Download zip
    Author
    Version
    0.2.0
    License
    Apache-2.0
    Repository
    Last updated
    last month
    Downloads
    30

    No dependencies

    #MoonJTD

    CI License

    MoonJTD is a MoonBit-native implementation of JSON Type Definition (JTD), as specified by RFC 8927. It validates schemas and JSON instances, emits standard instancePath / schemaPath diagnostics, and generates idiomatic MoonBit types and a schema-bound JSON codec API.

    #Why JTD

    JTD is intentionally smaller than JSON Schema. Its eight mutually exclusive forms map predictably to mainstream type systems, including records, enums, arrays, dictionaries, nullable values, references, and tagged unions. This makes it useful for API contracts and source generation where deterministic types matter more than arbitrary validation constraints.

    #Project status

    The MVP contains the complete eight-form JTD data model, strict schema checks, bounded validation, MoonBit type generation, a validated JSON codec API, a builder API, schema analysis, machine-readable reports, a CLI, runnable examples, and multi-target CI. The hash-pinned upstream conformance corpus currently passes all 316 validation cases and all 49 invalid-schema cases.

    JTD is an Experimental RFC rather than an IETF Standards Track specification. MoonJTD states that status explicitly and targets the published RFC semantics.

    #Scope

    MoonJTD implements RFC 8927. It is not a JSON Schema validator, an Apache Avro codec, a database migration system, or a general-purpose data-contract platform.

    #Current release status

    MoonJTD 0.2.0 is the current release on Mooncakes. Install the package with:

    moon add ppyj663/moonjtd@0.2.0

    To evaluate the source, CLI, and examples directly from GitHub:

    git clone https://github.com/ppyj663/MoonJTD.git
cd MoonJTD
moon test --target js
moon run examples/quickstart --target js

    The Git repository remains the authoritative source for development.

    #Library example

    let document = @jtd.parse_checked_schema(
      "{\"properties\":{\"id\":{\"type\":\"uint32\"}}}",
    )

    match document {
      Ok(schema) => {
        let errors = @jtd.validate(schema, Json::object(Map([
          ("id", Json::number(7.0)),
        ])))
        println(errors.length())
      }
      Err(errors) => for error in errors { println(error.to_string()) }
    }

    The typed builder avoids raw schema JSON:

    ///|
    let user = @jtd.jtd_object()
      .required("id", @jtd.jtd_uint32())
      .required("name", @jtd.jtd_string())
      .optional("email", @jtd.jtd_string())
      .build()

    Run the examples:

    moon run examples/quickstart --target js
moon run examples/codegen --target js

    #CLI

    moonjtd --help
moonjtd check schema.jtd.json
moonjtd validate schema.jtd.json instance.json
moonjtd validate schema.jtd.json instance.json --format json
moonjtd generate schema.jtd.json RootType output.mbt
moonjtd inspect schema.jtd.json
moonjtd format schema.jtd.json output.json
moonjtd report schema.jtd.json
moonjtd report schema.jtd.json --format markdown report.md

    report prints a pretty JSON report by default. Select markdown for a review-friendly summary containing schema statistics, a node inventory, and lint findings. Reports go to standard output unless an output path is supplied. validate --format json emits the structured validation result, including validity, resource-limit status, visited-node count, and diagnostics. Invalid instances still produce JSON and return exit status 1.

    During development, replace moonjtd with moon run cmd/main --target js --.

    Exit status is 0 for success, 1 for an invalid schema/instance or failed generation, and 2 for usage or filesystem errors. Malformed JSON is an input error (1); a missing or unreadable file is a filesystem error (2).

    #Repository structure

    MoonJTD/
├── *.mbt, moon.pkg       # portable core library package
├── cmd/main/             # JavaScript CLI entry point
├── cmd/conformance/      # upstream RFC 8927 corpus runner
├── examples/             # runnable quickstart and code generation demos
├── fixtures/             # small, authored CLI smoke-test inputs
├── docs/                 # design, standards, provenance, and history
├── scripts/              # CLI smoke checks, coverage, conformance, and audit
└── .github/workflows/    # multi-target continuous integration

    Generated pkg.generated.mbti interface files are committed so reviewers can inspect the public API. Build output, downloaded conformance data, and Mooncakes working state are ignored.

    #Validation safety

    ValidationOptions bounds the number of diagnostics, instance depth, reference depth, and visited nodes. SchemaCheckOptions independently bounds untrusted schema traversal. Recursive references therefore fail closed instead of overflowing the runtime stack indefinitely.

    #Testing

    moon build --target js
moon build --target wasm-gc
moon fmt --check
moon check --target js
moon test --target js
moon check --target wasm-gc
moon test --target wasm-gc
moon check --target native
moon test --target native
moon coverage analyze
pwsh ./scripts/conformance.ps1
pwsh ./scripts/audit.ps1
pwsh ./scripts/cli-smoke.ps1
pwsh ./scripts/check-toolchain.ps1

    Native tests require a C compiler (clang, gcc, cc, or MSVC cl). Native static checking does not require one.

    The conformance script downloads two data files from a fixed upstream commit, checks their SHA-256 digests, and keeps them under ignored _build/ storage. The files are not redistributed by MoonJTD because their upstream repository does not declare a license. See the conformance notes for the exact revision, hashes, runner behavior, and reproducibility details.

    #Standards and provenance

    • RFC 8927, JSON Type Definition, November 2020.
    • RFC 6901 JSON Pointer paths for validation diagnostics.
    • RFC 3339 timestamps as refined by RFC 8927.

    See third-party notices for source and AI-assistance disclosure, development history for the feature and commit trail, and reproducibility for the validated toolchain. No source code from another JTD implementation is copied into this repository.

    #License

    Apache-2.0. See LICENSE and THIRD_PARTY_NOTICES.md.

    CodecError

    source
    pub(all) suberror CodecError {
      CodecInvalidSchema(Array[Diagnostic])
      CodecInvalidJson(String)
      CodecValidationFailed(Array[Diagnostic])
    } derive(Eq, 
    Debug    )

    CodecError::equal

    source
    #deprecated("`CodecError::equal` is deprecated, use `Eq::equal` instead.")
    fn CodecError::equal(CodecError, CodecError) -> Bool

    CodecError::not_equal

    source
    #deprecated("`CodecError::not_equal` is deprecated, use `Eq::not_equal` instead.")
    fn CodecError::not_equal(x : CodecError, y : CodecError) -> Bool

    CodecError::to_repr

    source
    #deprecated("`CodecError::to_repr` is deprecated, use `@moonbitlang/core/debug.Debug::to_repr` instead.")
    fn CodecError::to_repr(CodecError) -> 
    Repr

    CodegenError

    source
    pub(all) suberror CodegenError {
      CodegenDiagnostic(Diagnostic)
    } derive(Eq, 
    Debug    )

    CodegenError::equal

    source
    #deprecated("`CodegenError::equal` is deprecated, use `Eq::equal` instead.")
    fn CodegenError::equal(CodegenError, CodegenError) -> Bool

    CodegenError::not_equal

    source
    #deprecated("`CodegenError::not_equal` is deprecated, use `Eq::not_equal` instead.")
    fn CodegenError::not_equal(x : CodegenError, y : CodegenError) -> Bool

    CodegenError::to_repr

    source
    #deprecated("`CodegenError::to_repr` is deprecated, use `@moonbitlang/core/debug.Debug::to_repr` instead.")
    fn CodegenError::to_repr(CodegenError) -> 
    Repr

    SchemaError

    source
    pub(all) suberror SchemaError {
      SchemaDiagnostic(Diagnostic)
    } derive(Eq, 
    Debug    )

    SchemaError::equal

    source
    #deprecated("`SchemaError::equal` is deprecated, use `Eq::equal` instead.")
    fn SchemaError::equal(SchemaError, SchemaError) -> Bool

    SchemaError::not_equal

    source
    #deprecated("`SchemaError::not_equal` is deprecated, use `Eq::not_equal` instead.")
    fn SchemaError::not_equal(x : SchemaError, y : SchemaError) -> Bool

    SchemaError::to_repr

    source
    #deprecated("`SchemaError::to_repr` is deprecated, use `@moonbitlang/core/debug.Debug::to_repr` instead.")
    fn SchemaError::to_repr(SchemaError) -> 
    Repr

    CodegenOptions

    source
    pub(all) struct CodegenOptions {
      root_name : String
      public_types : Bool
      derive_eq : Bool
      derive_debug : Bool
      header : Bool
    } derive(Eq, 
    Debug    )

    Controls naming and visibility of generated MoonBit declarations.

    CodegenOptions::default

    source

    CodegenOptions::equal

    source
    #deprecated("`CodegenOptions::equal` is deprecated, use `Eq::equal` instead.")
    fn CodegenOptions::equal(CodegenOptions, CodegenOptions) -> Bool

    CodegenOptions::new

    source
    fn CodegenOptions::new(root_name? : String, public_types? : Bool, derive_eq? : Bool, derive_debug? : Bool, header? : Bool) -> CodegenOptions

    CodegenOptions::not_equal

    source
    #deprecated("`CodegenOptions::not_equal` is deprecated, use `Eq::not_equal` instead.")
    fn CodegenOptions::not_equal(x : CodegenOptions, y : CodegenOptions) -> Bool

    CodegenOptions::root_name

    source
    fn CodegenOptions::root_name(self : CodegenOptions) -> String

    CodegenOptions::to_repr

    source
    #deprecated("`CodegenOptions::to_repr` is deprecated, use `@moonbitlang/core/debug.Debug::to_repr` instead.")
    fn CodegenOptions::to_repr(CodegenOptions) -> 
    Repr

    Diagnostic

    source
    pub(all) struct Diagnostic {
      code : DiagnosticCode
      message : String
      instance_path : JsonPointer
      schema_path : JsonPointer
    } derive(Eq, 
    Debug    )

    A structured error that can be rendered by a CLI or editor integration.

    Diagnostic::code

    source

    Diagnostic::equal

    source
    #deprecated("`Diagnostic::equal` is deprecated, use `Eq::equal` instead.")
    fn Diagnostic::equal(Diagnostic, Diagnostic) -> Bool

    Diagnostic::instance_path

    source
    fn Diagnostic::instance_path(self : Diagnostic) -> JsonPointer

    Diagnostic::message

    source
    fn Diagnostic::message(self : Diagnostic) -> String

    Diagnostic::new

    source
    fn Diagnostic::new(code : DiagnosticCode, message : String, instance_path? : JsonPointer, schema_path? : JsonPointer) -> Diagnostic

    Diagnostic::not_equal

    source
    #deprecated("`Diagnostic::not_equal` is deprecated, use `Eq::not_equal` instead.")
    fn Diagnostic::not_equal(x : Diagnostic, y : Diagnostic) -> Bool

    Diagnostic::schema_path

    source
    fn Diagnostic::schema_path(self : Diagnostic) -> JsonPointer

    Diagnostic::to_repr

    source
    #deprecated("`Diagnostic::to_repr` is deprecated, use `@moonbitlang/core/debug.Debug::to_repr` instead.")
    fn Diagnostic::to_repr(Diagnostic) -> 
    Repr

    Diagnostic::to_string

    source
    fn Diagnostic::to_string(self : Diagnostic) -> String

    DiagnosticCode

    source
    pub(all) enum DiagnosticCode {
      InvalidJson
      ExpectedObject
      UnknownKeyword
      MixedSchemaForms
      InvalidMemberType
      InvalidTypeName
      EmptyEnum
      DuplicateEnumValue
      UnknownReference
      NestedDefinitions
      PropertyOverlap
      InvalidDiscriminatorMapping
      DuplicateDiscriminatorProperty
      ValidationMismatch
      MissingProperty
      AdditionalProperty
      InvalidDiscriminatorTag
      UnknownDiscriminatorValue
      ResourceLimitExceeded
      InvalidIdentifier
      GenerationFailure
    } derive(Eq, 
    Debug    )

    Stable categories for machine-readable MoonJTD diagnostics.

    DiagnosticCode::equal

    source
    #deprecated("`DiagnosticCode::equal` is deprecated, use `Eq::equal` instead.")
    fn DiagnosticCode::equal(DiagnosticCode, DiagnosticCode) -> Bool

    DiagnosticCode::name

    source
    fn DiagnosticCode::name(self : DiagnosticCode) -> String

    DiagnosticCode::not_equal

    source
    #deprecated("`DiagnosticCode::not_equal` is deprecated, use `Eq::not_equal` instead.")
    fn DiagnosticCode::not_equal(x : DiagnosticCode, y : DiagnosticCode) -> Bool

    DiagnosticCode::to_repr

    source
    #deprecated("`DiagnosticCode::to_repr` is deprecated, use `@moonbitlang/core/debug.Debug::to_repr` instead.")
    fn DiagnosticCode::to_repr(DiagnosticCode) -> 
    Repr

    DiscriminatorSchemaBuilder

    source
    pub(all) struct DiscriminatorSchemaBuilder {
      tag : String
      mapping : Map[String, Schema]
      nullable : Bool
      metadata : Map[String, Json]
    } derive(
    Debug    )

    Fluent builder for a JTD discriminator-form schema.

    DiscriminatorSchemaBuilder::branch

    source

    DiscriminatorSchemaBuilder::branch_count

    source

    DiscriminatorSchemaBuilder::build

    source

    DiscriminatorSchemaBuilder::metadata_entry

    source
    fn DiscriminatorSchemaBuilder::metadata_entry(self : DiscriminatorSchemaBuilder, name : String, value : Json) -> DiscriminatorSchemaBuilder

    DiscriminatorSchemaBuilder::new

    source

    DiscriminatorSchemaBuilder::nullable

    source

    DiscriminatorSchemaBuilder::to_repr

    source
    #deprecated("`DiscriminatorSchemaBuilder::to_repr` is deprecated, use `@moonbitlang/core/debug.Debug::to_repr` instead.")
    fn DiscriminatorSchemaBuilder::to_repr(DiscriminatorSchemaBuilder) -> 
    Repr

    DocumentBuilder

    source
    pub(all) struct DocumentBuilder {
      root : Schema
      definitions : Map[String, Schema]
    } derive(
    Debug    )

    Fluent builder for a complete schema document and its root definitions.

    DocumentBuilder::build

    source

    DocumentBuilder::definition

    source
    fn DocumentBuilder::definition(self : DocumentBuilder, name : String, schema : Schema) -> DocumentBuilder

    DocumentBuilder::definition_count

    source
    fn DocumentBuilder::definition_count(self : DocumentBuilder) -> Int

    DocumentBuilder::new

    source

    DocumentBuilder::to_repr

    source
    #deprecated("`DocumentBuilder::to_repr` is deprecated, use `@moonbitlang/core/debug.Debug::to_repr` instead.")
    fn DocumentBuilder::to_repr(DocumentBuilder) -> 
    Repr

    JsonPointer

    source
    pub(all) struct JsonPointer {
      segments : Array[PathSegment]
    } derive(Eq, 
    Debug    )

    An immutable path into either a schema or an instance document.

    JsonPointer::append

    source
    fn JsonPointer::append(self : JsonPointer, suffix : JsonPointer) -> JsonPointer

    JsonPointer::depth

    source
    fn JsonPointer::depth(self : JsonPointer) -> Int

    JsonPointer::display

    source
    fn JsonPointer::display(self : JsonPointer) -> String

    JsonPointer::equal

    source
    #deprecated("`JsonPointer::equal` is deprecated, use `Eq::equal` instead.")
    fn JsonPointer::equal(JsonPointer, JsonPointer) -> Bool

    JsonPointer::index

    source
    fn JsonPointer::index(self : JsonPointer, index : Int) -> JsonPointer

    JsonPointer::is_root

    source
    fn JsonPointer::is_root(self : JsonPointer) -> Bool

    JsonPointer::last_index

    source
    fn JsonPointer::last_index(self : JsonPointer) -> Int?

    JsonPointer::last_property

    source
    fn JsonPointer::last_property(self : JsonPointer) -> String?

    JsonPointer::not_equal

    source
    #deprecated("`JsonPointer::not_equal` is deprecated, use `Eq::not_equal` instead.")
    fn JsonPointer::not_equal(x : JsonPointer, y : JsonPointer) -> Bool

    JsonPointer::parent

    source
    fn JsonPointer::parent(self : JsonPointer) -> JsonPointer?

    JsonPointer::property

    source
    fn JsonPointer::property(self : JsonPointer, name : String) -> JsonPointer

    JsonPointer::root

    source
    fn JsonPointer::root() -> JsonPointer

    JsonPointer::segments_copy

    source
    fn JsonPointer::segments_copy(self : JsonPointer) -> Array[PathSegment]

    JsonPointer::to_repr

    source
    #deprecated("`JsonPointer::to_repr` is deprecated, use `@moonbitlang/core/debug.Debug::to_repr` instead.")
    fn JsonPointer::to_repr(JsonPointer) -> 
    Repr

    JsonPointer::to_string

    source
    fn JsonPointer::to_string(self : JsonPointer) -> String

    JtdCodec

    source
    pub(all) struct JtdCodec {
      document : SchemaDocument
      options : ValidationOptions
    } derive(
    Debug    )

    Schema-bound JSON codec with the same resource limits as direct validation.

    JtdCodec::decode

    source
    fn JtdCodec::decode(self : JtdCodec, text : StringView) -> Result[ValidatedJson, CodecError]

    Parse JSON text, validate it, and return only a schema-conforming value.

    JtdCodec::decode_batch

    source
    fn JtdCodec::decode_batch(self : JtdCodec, values : Array[Json]) -> Array[Result[ValidatedJson, CodecError]]

    Decode multiple independent JSON values, preserving input order.

    JtdCodec::decode_json

    source
    fn JtdCodec::decode_json(self : JtdCodec, value : Json) -> Result[ValidatedJson, CodecError]

    Validate an already parsed JSON value and wrap it on success.

    JtdCodec::decode_json_array

    source
    fn JtdCodec::decode_json_array(self : JtdCodec, text : StringView) -> Result[Array[ValidatedJson], CodecError]

    Decode a JSON array and validate each element as a separate root instance.

    JtdCodec::document

    source
    fn JtdCodec::document(self : JtdCodec) -> SchemaDocument

    JtdCodec::encode_json

    source
    fn JtdCodec::encode_json(self : JtdCodec, value : Json, escape_slash? : Bool) -> Result[String, CodecError]

    Validate a JSON value before serializing it.

    JtdCodec::encode_validated

    source
    fn JtdCodec::encode_validated(self : JtdCodec, value : ValidatedJson, escape_slash? : Bool) -> String

    A previously validated value can be serialized without another traversal.

    JtdCodec::new

    source
    fn JtdCodec::new(document : SchemaDocument, options? : ValidationOptions) -> Result[JtdCodec, CodecError]

    JtdCodec::options

    source
    fn JtdCodec::options(self : JtdCodec) -> ValidationOptions

    JtdCodec::to_repr

    source
    #deprecated("`JtdCodec::to_repr` is deprecated, use `@moonbitlang/core/debug.Debug::to_repr` instead.")
    fn JtdCodec::to_repr(JtdCodec) -> 
    Repr

    JtdType

    source
    pub(all) enum JtdType {
      BooleanType
      Float32Type
      Float64Type
      Int8Type
      Uint8Type
      Int16Type
      Uint16Type
      Int32Type
      Uint32Type
      StringType
      TimestampType
    } derive(Eq, 
    Debug    )

    Primitive types defined by RFC 8927 section 2.2.3.

    JtdType::equal

    source
    #deprecated("`JtdType::equal` is deprecated, use `Eq::equal` instead.")
    fn JtdType::equal(JtdType, JtdType) -> Bool

    JtdType::is_integer

    source
    fn JtdType::is_integer(self : JtdType) -> Bool

    JtdType::is_numeric

    source
    fn JtdType::is_numeric(self : JtdType) -> Bool

    JtdType::is_signed

    source
    fn JtdType::is_signed(self : JtdType) -> Bool

    JtdType::maximum

    source
    fn JtdType::maximum(self : JtdType) -> Double?

    JtdType::minimum

    source
    fn JtdType::minimum(self : JtdType) -> Double?

    JtdType::name

    source
    fn JtdType::name(self : JtdType) -> String

    JtdType::not_equal

    source
    #deprecated("`JtdType::not_equal` is deprecated, use `Eq::not_equal` instead.")
    fn JtdType::not_equal(x : JtdType, y : JtdType) -> Bool

    JtdType::to_repr

    source
    #deprecated("`JtdType::to_repr` is deprecated, use `@moonbitlang/core/debug.Debug::to_repr` instead.")
    fn JtdType::to_repr(JtdType) -> 
    Repr

    ObjectSchemaBuilder

    source
    pub(all) struct ObjectSchemaBuilder {
      required : Map[String, Schema]
      optional : Map[String, Schema]
      additional : Bool
      nullable : Bool
      metadata : Map[String, Json]
    } derive(
    Debug    )

    Fluent builder for a JTD properties-form schema.

    ObjectSchemaBuilder::allow_additional

    source
    fn ObjectSchemaBuilder::allow_additional(self : ObjectSchemaBuilder, allowed : Bool) -> ObjectSchemaBuilder

    ObjectSchemaBuilder::build

    source

    ObjectSchemaBuilder::metadata_entry

    source
    fn ObjectSchemaBuilder::metadata_entry(self : ObjectSchemaBuilder, name : String, value : Json) -> ObjectSchemaBuilder

    ObjectSchemaBuilder::new

    source

    ObjectSchemaBuilder::nullable

    source
    fn ObjectSchemaBuilder::nullable(self : ObjectSchemaBuilder, nullable : Bool) -> ObjectSchemaBuilder

    ObjectSchemaBuilder::optional

    source
    fn ObjectSchemaBuilder::optional(self : ObjectSchemaBuilder, name : String, schema : Schema) -> ObjectSchemaBuilder

    ObjectSchemaBuilder::optional_count

    source
    fn ObjectSchemaBuilder::optional_count(self : ObjectSchemaBuilder) -> Int

    ObjectSchemaBuilder::required

    source
    fn ObjectSchemaBuilder::required(self : ObjectSchemaBuilder, name : String, schema : Schema) -> ObjectSchemaBuilder

    ObjectSchemaBuilder::required_count

    source
    fn ObjectSchemaBuilder::required_count(self : ObjectSchemaBuilder) -> Int

    ObjectSchemaBuilder::to_repr

    source
    #deprecated("`ObjectSchemaBuilder::to_repr` is deprecated, use `@moonbitlang/core/debug.Debug::to_repr` instead.")
    fn ObjectSchemaBuilder::to_repr(ObjectSchemaBuilder) -> 
    Repr

    PathSegment

    source
    pub(all) enum PathSegment {
      Property(String)
      Index(Int)
    } derive(Eq, 
    Debug    )

    One segment in an RFC 6901 JSON Pointer.

    PathSegment::equal

    source
    #deprecated("`PathSegment::equal` is deprecated, use `Eq::equal` instead.")
    fn PathSegment::equal(PathSegment, PathSegment) -> Bool

    PathSegment::not_equal

    source
    #deprecated("`PathSegment::not_equal` is deprecated, use `Eq::not_equal` instead.")
    fn PathSegment::not_equal(x : PathSegment, y : PathSegment) -> Bool

    PathSegment::to_repr

    source
    #deprecated("`PathSegment::to_repr` is deprecated, use `@moonbitlang/core/debug.Debug::to_repr` instead.")
    fn PathSegment::to_repr(PathSegment) -> 
    Repr

    Schema

    source
    pub(all) struct Schema {
      form : SchemaForm
      nullable : Bool
      metadata : Map[String, Json]
    } derive(
    Debug    )

    A schema node. Metadata is retained without assigning it validation meaning.

    Schema::allows_additional_properties

    source
    fn Schema::allows_additional_properties(self : Schema) -> Bool

    Schema::discriminator

    source
    fn Schema::discriminator(tag : String, mapping : Map[String, Schema]) -> Schema

    Schema::discriminator_mapping

    source
    fn Schema::discriminator_mapping(self : Schema) -> Map[String, Schema]?

    Schema::discriminator_tag

    source
    fn Schema::discriminator_tag(self : Schema) -> String?

    Schema::element_schema

    source
    fn Schema::element_schema(self : Schema) -> Schema?

    Schema::elements

    source
    fn Schema::elements(element : Schema) -> Schema

    Schema::empty

    source
    fn Schema::empty() -> Schema

    Schema::enum_

    source
    fn Schema::enum_(values : Array[String]) -> Schema

    Schema::enum_values

    source
    fn Schema::enum_values(self : Schema) -> Array[String]?

    Schema::form

    source
    fn Schema::form(self : Schema) -> SchemaForm

    Schema::form_name

    source
    fn Schema::form_name(self : Schema) -> String

    Schema::is_nullable

    source
    fn Schema::is_nullable(self : Schema) -> Bool

    Schema::metadata

    source
    fn Schema::metadata(self : Schema) -> Map[String, Json]

    Schema::new

    source
    fn Schema::new(form : SchemaForm) -> Schema

    Schema::optional_properties

    source
    fn Schema::optional_properties(self : Schema) -> Map[String, Schema]?

    Schema::properties

    source
    fn Schema::properties(required : Map[String, Schema], optional : Map[String, Schema], additional : Bool) -> Schema

    Schema::ref_name

    source
    fn Schema::ref_name(self : Schema) -> String?

    Schema::reference

    source
    fn Schema::reference(name : String) -> Schema

    Schema::required_properties

    source
    fn Schema::required_properties(self : Schema) -> Map[String, Schema]?

    Schema::to_repr

    source
    #deprecated("`Schema::to_repr` is deprecated, use `@moonbitlang/core/debug.Debug::to_repr` instead.")
    fn Schema::to_repr(Schema) -> 
    Repr

    Schema::type_

    source
    fn Schema::type_(kind : JtdType) -> Schema

    Schema::type_kind

    source
    fn Schema::type_kind(self : Schema) -> JtdType?

    Schema::value_schema

    source
    fn Schema::value_schema(self : Schema) -> Schema?

    Schema::values

    source
    fn Schema::values(value : Schema) -> Schema

    Schema::with_metadata

    source
    fn Schema::with_metadata(self : Schema, metadata : Map[String, Json]) -> Schema

    Schema::with_nullable

    source
    fn Schema::with_nullable(self : Schema, nullable : Bool) -> Schema

    SchemaCheckOptions

    source
    pub(all) struct SchemaCheckOptions {
      max_depth : Int
      max_nodes : Int
      max_errors : Int
    } derive(Eq, 
    Debug    )

    Limits applied while checking an untrusted schema document.

    SchemaCheckOptions::default

    source

    SchemaCheckOptions::equal

    source
    #deprecated("`SchemaCheckOptions::equal` is deprecated, use `Eq::equal` instead.")
    fn SchemaCheckOptions::equal(SchemaCheckOptions, SchemaCheckOptions) -> Bool

    SchemaCheckOptions::max_depth

    source
    fn SchemaCheckOptions::max_depth(self : SchemaCheckOptions) -> Int

    SchemaCheckOptions::max_errors

    source
    fn SchemaCheckOptions::max_errors(self : SchemaCheckOptions) -> Int

    SchemaCheckOptions::max_nodes

    source
    fn SchemaCheckOptions::max_nodes(self : SchemaCheckOptions) -> Int

    SchemaCheckOptions::new

    source
    fn SchemaCheckOptions::new(max_depth? : Int, max_nodes? : Int, max_errors? : Int) -> SchemaCheckOptions

    SchemaCheckOptions::not_equal

    source
    #deprecated("`SchemaCheckOptions::not_equal` is deprecated, use `Eq::not_equal` instead.")
    fn SchemaCheckOptions::not_equal(x : SchemaCheckOptions, y : SchemaCheckOptions) -> Bool

    SchemaCheckOptions::to_repr

    source
    #deprecated("`SchemaCheckOptions::to_repr` is deprecated, use `@moonbitlang/core/debug.Debug::to_repr` instead.")
    fn SchemaCheckOptions::to_repr(SchemaCheckOptions) -> 
    Repr

    SchemaDocument

    source
    pub(all) struct SchemaDocument {
      root : Schema
      definitions : Map[String, Schema]
    } derive(
    Debug    )

    A complete JTD document. Only this root level may contain definitions.

    SchemaDocument::definition

    source
    fn SchemaDocument::definition(self : SchemaDocument, name : String) -> Schema?

    SchemaDocument::definition_count

    source
    fn SchemaDocument::definition_count(self : SchemaDocument) -> Int

    SchemaDocument::definition_names

    source
    fn SchemaDocument::definition_names(self : SchemaDocument) -> Array[String]

    SchemaDocument::definitions

    source
    fn SchemaDocument::definitions(self : SchemaDocument) -> Map[String, Schema]

    SchemaDocument::has_definition

    source
    fn SchemaDocument::has_definition(self : SchemaDocument, name : String) -> Bool

    SchemaDocument::new

    source
    fn SchemaDocument::new(root : Schema, definitions? : Map[String, Schema]) -> SchemaDocument

    SchemaDocument::root

    source

    SchemaDocument::to_repr

    source
    #deprecated("`SchemaDocument::to_repr` is deprecated, use `@moonbitlang/core/debug.Debug::to_repr` instead.")
    fn SchemaDocument::to_repr(SchemaDocument) -> 
    Repr

    SchemaForm

    source
    pub(all) enum SchemaForm {
      EmptyForm
      RefForm(String)
      TypeForm(JtdType)
      EnumForm(Array[String])
      ElementsForm(Schema)
      PropertiesForm(Map[String, Schema], Map[String, Schema], Bool)
      ValuesForm(Schema)
      DiscriminatorForm(String, Map[String, Schema])
    } derive(
    Debug    )

    The eight mutually exclusive schema forms from RFC 8927.

    SchemaForm::to_repr

    source
    #deprecated("`SchemaForm::to_repr` is deprecated, use `@moonbitlang/core/debug.Debug::to_repr` instead.")
    fn SchemaForm::to_repr(SchemaForm) -> 
    Repr

    SchemaNodeInfo

    source
    pub(all) struct SchemaNodeInfo {
      path : JsonPointer
      form : String
      shape : String
      nullable : Bool
      child_count : Int
    } derive(Eq, 
    Debug    )

    One syntactic node in a schema inventory.

    SchemaNodeInfo::child_count

    source
    fn SchemaNodeInfo::child_count(self : SchemaNodeInfo) -> Int

    SchemaNodeInfo::equal

    source
    #deprecated("`SchemaNodeInfo::equal` is deprecated, use `Eq::equal` instead.")
    fn SchemaNodeInfo::equal(SchemaNodeInfo, SchemaNodeInfo) -> Bool

    SchemaNodeInfo::form

    source
    fn SchemaNodeInfo::form(self : SchemaNodeInfo) -> String

    SchemaNodeInfo::is_nullable

    source
    fn SchemaNodeInfo::is_nullable(self : SchemaNodeInfo) -> Bool

    SchemaNodeInfo::not_equal

    source
    #deprecated("`SchemaNodeInfo::not_equal` is deprecated, use `Eq::not_equal` instead.")
    fn SchemaNodeInfo::not_equal(x : SchemaNodeInfo, y : SchemaNodeInfo) -> Bool

    SchemaNodeInfo::path

    source

    SchemaNodeInfo::shape

    source
    fn SchemaNodeInfo::shape(self : SchemaNodeInfo) -> String

    SchemaNodeInfo::to_repr

    source
    #deprecated("`SchemaNodeInfo::to_repr` is deprecated, use `@moonbitlang/core/debug.Debug::to_repr` instead.")
    fn SchemaNodeInfo::to_repr(SchemaNodeInfo) -> 
    Repr

    SchemaStats

    source
    pub(all) struct SchemaStats {
      node_count : Int
      max_depth : Int
      definition_count : Int
      reference_count : Int
      nullable_count : Int
      empty_count : Int
      type_count : Int
      enum_count : Int
      elements_count : Int
      properties_count : Int
      values_count : Int
      discriminator_count : Int
      required_property_count : Int
      optional_property_count : Int
      discriminator_branch_count : Int
    } derive(Eq, 
    Debug    )

    Structural metrics for a complete JTD schema document.

    SchemaStats::definition_count

    source
    fn SchemaStats::definition_count(self : SchemaStats) -> Int

    SchemaStats::discriminator_branch_count

    source
    fn SchemaStats::discriminator_branch_count(self : SchemaStats) -> Int

    SchemaStats::discriminator_count

    source
    fn SchemaStats::discriminator_count(self : SchemaStats) -> Int

    SchemaStats::elements_count

    source
    fn SchemaStats::elements_count(self : SchemaStats) -> Int

    SchemaStats::empty_count

    source
    fn SchemaStats::empty_count(self : SchemaStats) -> Int

    SchemaStats::enum_count

    source
    fn SchemaStats::enum_count(self : SchemaStats) -> Int

    SchemaStats::equal

    source
    #deprecated("`SchemaStats::equal` is deprecated, use `Eq::equal` instead.")
    fn SchemaStats::equal(SchemaStats, SchemaStats) -> Bool

    Compatibility aliases for the trait methods formerly attached implicitly. Prefer qualified trait calls in new code.

    SchemaStats::max_depth

    source
    fn SchemaStats::max_depth(self : SchemaStats) -> Int

    SchemaStats::node_count

    source
    fn SchemaStats::node_count(self : SchemaStats) -> Int

    SchemaStats::not_equal

    source
    #deprecated("`SchemaStats::not_equal` is deprecated, use `Eq::not_equal` instead.")
    fn SchemaStats::not_equal(x : SchemaStats, y : SchemaStats) -> Bool

    Compatibility aliases for the trait methods formerly attached implicitly. Prefer qualified trait calls in new code.

    SchemaStats::nullable_count

    source
    fn SchemaStats::nullable_count(self : SchemaStats) -> Int

    SchemaStats::optional_property_count

    source
    fn SchemaStats::optional_property_count(self : SchemaStats) -> Int

    SchemaStats::properties_count

    source
    fn SchemaStats::properties_count(self : SchemaStats) -> Int

    SchemaStats::reference_count

    source
    fn SchemaStats::reference_count(self : SchemaStats) -> Int

    SchemaStats::required_property_count

    source
    fn SchemaStats::required_property_count(self : SchemaStats) -> Int

    SchemaStats::to_repr

    source
    #deprecated("`SchemaStats::to_repr` is deprecated, use `@moonbitlang/core/debug.Debug::to_repr` instead.")
    fn SchemaStats::to_repr(SchemaStats) -> 
    Repr

    SchemaStats::to_string

    source
    fn SchemaStats::to_string(self : SchemaStats) -> String

    SchemaStats::type_count

    source
    fn SchemaStats::type_count(self : SchemaStats) -> Int

    SchemaStats::values_count

    source
    fn SchemaStats::values_count(self : SchemaStats) -> Int

    ValidatedJson

    source
    pub(all) struct ValidatedJson {
      value : Json
    } derive(Eq, 
    Debug    )

    A JSON value proven valid against the codec's JTD document at decode time.

    ValidatedJson::equal

    source
    #deprecated("`ValidatedJson::equal` is deprecated, use `Eq::equal` instead.")
    fn ValidatedJson::equal(ValidatedJson, ValidatedJson) -> Bool

    ValidatedJson::not_equal

    source
    #deprecated("`ValidatedJson::not_equal` is deprecated, use `Eq::not_equal` instead.")
    fn ValidatedJson::not_equal(x : ValidatedJson, y : ValidatedJson) -> Bool

    ValidatedJson::stringify

    source
    fn ValidatedJson::stringify(self : ValidatedJson, escape_slash? : Bool) -> String

    ValidatedJson::to_repr

    source
    #deprecated("`ValidatedJson::to_repr` is deprecated, use `@moonbitlang/core/debug.Debug::to_repr` instead.")
    fn ValidatedJson::to_repr(ValidatedJson) -> 
    Repr

    ValidatedJson::value

    source
    fn ValidatedJson::value(self : ValidatedJson) -> Json

    ValidationOptions

    source
    pub(all) struct ValidationOptions {
      max_errors : Int
      max_depth : Int
      max_ref_depth : Int
      max_nodes : Int
    } derive(Eq, 
    Debug    )

    Resource limits for validating untrusted JSON values and recursive schemas.

    ValidationOptions::default

    source

    ValidationOptions::equal

    source
    #deprecated("`ValidationOptions::equal` is deprecated, use `Eq::equal` instead.")
    fn ValidationOptions::equal(ValidationOptions, ValidationOptions) -> Bool

    ValidationOptions::max_depth

    source
    fn ValidationOptions::max_depth(self : ValidationOptions) -> Int

    ValidationOptions::max_errors

    source
    fn ValidationOptions::max_errors(self : ValidationOptions) -> Int

    ValidationOptions::max_nodes

    source
    fn ValidationOptions::max_nodes(self : ValidationOptions) -> Int

    ValidationOptions::max_ref_depth

    source
    fn ValidationOptions::max_ref_depth(self : ValidationOptions) -> Int

    ValidationOptions::new

    source
    fn ValidationOptions::new(max_errors? : Int, max_depth? : Int, max_ref_depth? : Int, max_nodes? : Int) -> ValidationOptions

    ValidationOptions::not_equal

    source
    #deprecated("`ValidationOptions::not_equal` is deprecated, use `Eq::not_equal` instead.")
    fn ValidationOptions::not_equal(x : ValidationOptions, y : ValidationOptions) -> Bool

    ValidationOptions::to_repr

    source
    #deprecated("`ValidationOptions::to_repr` is deprecated, use `@moonbitlang/core/debug.Debug::to_repr` instead.")
    fn ValidationOptions::to_repr(ValidationOptions) -> 
    Repr

    ValidationReport

    source
    pub(all) struct ValidationReport {
      errors : Array[Diagnostic]
      visited_nodes : Int
      truncated : Bool
    } derive(
    Debug    )

    Complete outcome of one validation pass.

    ValidationReport::errors

    source

    ValidationReport::is_truncated

    source
    fn ValidationReport::is_truncated(self : ValidationReport) -> Bool

    ValidationReport::is_valid

    source
    fn ValidationReport::is_valid(self : ValidationReport) -> Bool

    ValidationReport::to_repr

    source
    #deprecated("`ValidationReport::to_repr` is deprecated, use `@moonbitlang/core/debug.Debug::to_repr` instead.")
    fn ValidationReport::to_repr(ValidationReport) -> 
    Repr

    ValidationReport::visited_nodes

    source
    fn ValidationReport::visited_nodes(self : ValidationReport) -> Int

    SPECIFICATION

    source
    let SPECIFICATION : String

    The RFC implemented by this package.

    VERSION

    source
    let VERSION : String

    Semantic version of the public MoonJTD API.

    analyze_schema

    source
    fn analyze_schema(document : SchemaDocument) -> SchemaStats

    Count schema structure without following references, so recursive definitions are safe and each syntactic node is counted exactly once.

    check_schema

    source
    fn check_schema(document : SchemaDocument) -> Array[Diagnostic]

    check_schema_with

    source
    fn check_schema_with(document : SchemaDocument, options : SchemaCheckOptions) -> Array[Diagnostic]

    Check cross-node constraints that cannot be decided while parsing one node.

    codec_error_diagnostics

    source
    fn codec_error_diagnostics(error : CodecError) -> Array[Diagnostic]

    codec_error_message

    source
    fn codec_error_message(error : CodecError) -> String

    codec_from_schema

    source
    fn codec_from_schema(schema_text : StringView, options? : ValidationOptions) -> Result[JtdCodec, CodecError]

    diagnostic_to_json

    source
    fn diagnostic_to_json(diagnostic : Diagnostic) -> Json

    diagnostics_to_json

    source
    fn diagnostics_to_json(diagnostics : Array[Diagnostic]) -> Json

    diagnostics_to_string

    source
    fn diagnostics_to_string(diagnostics : Array[Diagnostic], pretty? : Bool) -> String

    generate_moonbit_types

    source
    fn generate_moonbit_types(document : SchemaDocument, root_name? : String) -> Result[String, CodegenError]

    generate_moonbit_types_with

    source
    fn generate_moonbit_types_with(document : SchemaDocument, options : CodegenOptions) -> Result[String, CodegenError]

    Generate deterministic MoonBit type declarations for a checked JTD document.

    is_rfc3339_timestamp

    source
    fn is_rfc3339_timestamp(text : String) -> Bool

    Validate the RFC 3339 profile required by RFC 8927 timestamp values.

    json_kind

    source
    fn json_kind(value : Json) -> String

    jtd_any

    source
    fn jtd_any() -> Schema

    Short constructor functions for schema-builder DSLs.

    jtd_array

    source
    fn jtd_array(element : Schema) -> Schema

    jtd_boolean

    source
    fn jtd_boolean() -> Schema

    jtd_document

    source
    fn jtd_document(root : Schema) -> DocumentBuilder

    jtd_enum

    source
    fn jtd_enum(values : Array[String]) -> Schema

    jtd_float32

    source
    fn jtd_float32() -> Schema

    jtd_float64

    source
    fn jtd_float64() -> Schema

    jtd_int16

    source
    fn jtd_int16() -> Schema

    jtd_int32

    source
    fn jtd_int32() -> Schema

    jtd_int8

    source
    fn jtd_int8() -> Schema

    jtd_map

    source
    fn jtd_map(value : Schema) -> Schema

    jtd_object

    source
    fn jtd_object() -> ObjectSchemaBuilder

    jtd_reference

    source
    fn jtd_reference(name : String) -> Schema

    jtd_string

    source
    fn jtd_string() -> Schema

    jtd_timestamp

    source
    fn jtd_timestamp() -> Schema

    jtd_type_from_name

    source
    fn jtd_type_from_name(name : String) -> JtdType?

    jtd_uint16

    source
    fn jtd_uint16() -> Schema

    jtd_uint32

    source
    fn jtd_uint32() -> Schema

    jtd_uint8

    source
    fn jtd_uint8() -> Schema

    jtd_union

    source
    fn jtd_union(tag : String) -> DiscriminatorSchemaBuilder

    lint_schema

    source
    fn lint_schema(document : SchemaDocument) -> Array[Diagnostic]

    Produce human-readable lint diagnostics that are not RFC correctness errors.

    moon_field_name

    source
    fn moon_field_name(name : String) -> String

    Convert an arbitrary property name to a safe MoonBit field identifier.

    moon_type_name

    source
    fn moon_type_name(name : String) -> String

    Convert an arbitrary schema name to a valid exported MoonBit type name.

    parse_checked_schema

    source
    fn parse_checked_schema(text : StringView) -> Result[SchemaDocument, Array[Diagnostic]]

    Parse a schema and reject semantic violations in one operation.

    parse_schema

    source
    fn parse_schema(text : StringView) -> Result[SchemaDocument, SchemaError]

    Parse UTF-8 JSON text as a complete RFC 8927 schema document.

    parse_schema_json

    source
    fn parse_schema_json(value : Json) -> Result[SchemaDocument, SchemaError]

    Parse a JSON value as a complete RFC 8927 schema document.

    referenced_definitions

    source
    fn referenced_definitions(document : SchemaDocument) -> Array[String]

    Collect every syntactically referenced definition name.

    rfc3339_day

    source
    fn rfc3339_day(text : String) -> Int?

    rfc3339_hour

    source
    fn rfc3339_hour(text : String) -> Int?

    rfc3339_minute

    source
    fn rfc3339_minute(text : String) -> Int?

    rfc3339_month

    source
    fn rfc3339_month(text : String) -> Int?

    rfc3339_second

    source
    fn rfc3339_second(text : String) -> Int?

    rfc3339_year

    source
    fn rfc3339_year(text : String) -> Int?

    scalar_accepts

    source
    fn scalar_accepts(kind : JtdType, value : Json) -> Bool

    scalar_expectation

    source
    fn scalar_expectation(kind : JtdType) -> String

    schema_inventory

    source
    fn schema_inventory(document : SchemaDocument) -> Array[SchemaNodeInfo]

    Enumerate each syntactic schema node without following refs.

    schema_node_info_to_json

    source
    fn schema_node_info_to_json(info : SchemaNodeInfo) -> Json

    schema_report_json

    source
    fn schema_report_json(document : SchemaDocument) -> Json

    schema_report_markdown

    source
    fn schema_report_markdown(document : SchemaDocument) -> String

    schema_report_string

    source
    fn schema_report_string(document : SchemaDocument, pretty? : Bool) -> String

    schema_shape

    source
    fn schema_shape(schema : Schema) -> String

    Return a deep structural form signature useful in reports and tests.

    schema_stats_to_json

    source
    fn schema_stats_to_json(stats : SchemaStats) -> Json

    schema_to_json

    source
    fn schema_to_json(document : SchemaDocument) -> Json

    Convert a schema document into its JSON data model.

    schema_to_pretty_string

    source
    fn schema_to_pretty_string(document : SchemaDocument, indent? : Int) -> String

    Render indented JSON without depending on host filesystem or console APIs.

    schema_to_string

    source
    fn schema_to_string(document : SchemaDocument) -> String

    Serialize a schema document as compact JSON.

    unused_definitions

    source
    fn unused_definitions(document : SchemaDocument) -> Array[String]

    Definitions that are not transitively reachable from the root schema.

    validate

    source
    fn validate(document : SchemaDocument, value : Json) -> Array[Diagnostic]

    validate_json_text

    source
    fn validate_json_text(document : SchemaDocument, text : StringView) -> Result[Array[Diagnostic], Diagnostic]

    validate_with

    source
    fn validate_with(document : SchemaDocument, value : Json, options : ValidationOptions) -> ValidationReport

    validation_report_to_json

    source
    fn validation_report_to_json(report : ValidationReport) -> Json

    version_banner

    source
    fn version_banner() -> String

    Return a compact identity suitable for CLI version output.

    Source Files

    Powered by MoonBit

    Site sourceReport issueModulesSkillsCLIBuild queueStatistics

    © 2026 mooncakes.io