# Versa Rust
This crate is the official Versa SDK for Rust.
Versa uses [semantic versioning](https://semver.org/) to ensure the stability of its data model. The current schema version **1.11.0**
You can use this crate broadly in two ways: either just referencing the type bindings, or to implement a custom client in Rust.
You will need to enable either the `client_sender` or `client_receiver` feature to leverage the corresponding client implementation.
## Type Bindings
There are broadly two kinds of types represented in this repository: Protocol Bindings and the Receipt Schema
This repository references the root JSON schema files, at https://github.com/versa-protocol/schema, to generate the Rust bindings for a Versa receipt.
### Protocol Bindings
Protocol Bindings represent the types of requests, responses, and error codes to be expected when developing client implementations according to the specifications of the Versa Protocol. These types are defined in the `protocol` directory.
### Receipt Schema
The Receipt struct represents the receipt and invoice data schemas to be handled when developing client implementations according to the specifications of the Versa Protocol. These types are defined in `receipt.rs`
## Build Process
This crate uses the [typify](https://crates.io/crates/typify) crate to construct the receipt schema bindings from our json schema
## Features
- `client` Enables Versa client initialization with customer registration APIs
- `client_sender` Enables the Versa sending client implementation
- `client_receiver` Enables the Versa receiving client implementation
- `diesel` Implements diesel traits for MySQL on certain structs (*UNSTABLE:* Use with caution)
- `validator` Includes features related to validation of the Versa schema
## Schema Validation
The validator feature makes it simple to validate incoming data from the Versa network and to generate a misuse code if necessary.
Example usage:
```rs
use serde_json::Value;
use versa::protocol::{misuse::MisuseCode, WebhookEventType};
pub async fn validate(event: &WebhookEventType, data: &Value) -> Result<(), (MisuseCode, String)> {
let validator = versa::schema::validator::Validator::new().allow_remote_lookup(true);
validator.validate(event, data).await
}
```
## For Developers
Interested in contributing to the official crate? Get started below:
### Codegen
To avoid bundling build-dependencies like reqwest into the crate regardless of feature, codegen is a separate script (rather than employing `build.rs`).
Make sure [rust-script](https://rust-script.org/) is installed, then run `rust-script ./codegen.rs`
## TODO
- [ ] Rust stable crate
- [ ] Expanded diesel database support