@rescript-tauri/schema

rescript-schema integration for @rescript-tauri/core. Implements Layer 3 of the 3-layer IPC stack defined in RFC-0001: declare a Core.Command.t<'args, 'result> from a single S.t<'args> + S.t<'result> pair instead of writing the encoder and decoder by hand.

Status

Phase 2 — feature-complete on main. Awaiting first npm publish (schema-v0.1.0).

Install (planned)

pnpm add @rescript-tauri/schema @rescript-tauri/core @tauri-apps/api rescript-schema

Add to rescript.json:

{
  "dependencies": ["@rescript/core", "@rescript-tauri/core", "@rescript-tauri/schema", "rescript-schema"]
}

Quick example

module Core = RescriptTauriCore.Core
module Schema = RescriptTauriSchema.Schema
module S = RescriptSchema.S

let greet = Schema.fromSchemas(
  ~name="greet",
  ~args=S.object(s => {name: s.field("name", S.string)}),
  ~result=S.string,
)

switch await greet->Core.Command.invoke({name: "ReScript"}) {
| Ok(message) => Console.log(message)
| Error(DecodeError(msg)) => Console.error("decode failed: " ++ msg)
| Error(RustError(json)) => Console.error2("rust error:", json)
}

Compatibility

| Component | Supported range | |---|---| | @rescript-tauri/schema | this package | | @rescript-tauri/core | ^0.1.0 (peer) | | rescript-schema | ^9.0.0 (peer) | | @tauri-apps/api | ^2.0.0 (transitive via core) | | rescript | >=12.0.0 | | @rescript/core | >=1.6.0 | | OS | Linux / macOS / Windows |

rescript-struct is not supported (deprecated upstream — see RFC-0002 §2.1).

Public API

| Symbol | Purpose | |---|---| | Schema.toDecoder | S.t<'value> → Core.decoder<'value> | | Schema.fromSchemas | Builds a typed Core.Command.t from arg + result schemas | | Schema.channelFromSchema | Builds a typed Core.Channel.t from a message schema | | Schema.eventFromSchema | Builds a typed Event.t from a payload schema |

See src/Schema.resi for full doc comments and the linked Tauri / rescript-schema upstream documentation.

See also

• Changelog
• User guide page
• Runnable demo: examples/ipc-typed-with-schema (pairs against examples/ipc-typed/ to compare Layer 2 vs Layer 3)
• RFC-0002 Schema Integration
• @rescript-tauri/core README
• rescript-schema docs