Module @grounds/schema

Full type inference: Static extracts TypeScript types from schemas
Runtime validation: TypeBox validates values during encoding
Symbol metadata: Schemas carry Relish type codes without property conflicts
API symmetry: toRelish and fromRelish both work with bytes (ADR 0001)

TypeBox-integrated schema system for type-safe Relish encoding and decoding.

Provides schema constructors that combine TypeBox's runtime validation with Relish's binary wire format, enabling full type safety from schema definition through encoding and decoding.

Example

Defining and using a schema:

import {
  RStruct,
  field,
  RString,
  RU32,
  createCodec,
  type Static
} from '@grounds/schema';

// Define schema
const UserSchema = RStruct({
  name: field(0, RString()),
  age: field(1, RU32()),
  email: field(2, RString())
});

// Infer TypeScript type
type User = Static<typeof UserSchema>;
// { name: string, age: number, email: string }

// Create codec
const codec = createCodec(UserSchema);

// Type-safe encoding
const user: User = {
  name: 'Alice',
  age: 25,
  email: 'alice@example.com'
};

codec.encode(user).match(
  (bytes) => {
    // Roundtrip
    codec.decode(bytes).match(
      (decoded) => console.log(decoded.name), // Alice
      (error) => console.error(error.code)
    );
  },
  (error) => console.error(error.message)
);

Example

Working with enums:

import { REnum, RStruct, variant, field, RString, RNull } from '@grounds/schema';

const ResultSchema = REnum({
  success: variant(0, RStruct({
    data: field(0, RString())
  })),
  error: variant(1, RStruct({
    message: field(0, RString())
  }))
});

const codec = createCodec(ResultSchema);

// Variant inferred automatically
codec.encode({ success: { data: 'OK' } });
codec.encode({ error: { message: 'Failed' } });