forma-ir-derive 3.2.0

PageProps derive for Forma declared data schemas and checked encoding
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

# forma-ir-derive

`#[derive(PageProps)]` supplies Forma's Rust page contract. Use its re-export
from `forma-ir`; applications do not need a direct dependency on this proc-macro
crate. The historical version 0.0.0 was a reservation placeholder. The current
3.2.0 implementation supports the declared FMIR props schema.

```rust
use forma_ir::PageProps;

#[derive(PageProps)]
struct User {
    display_name: String, // TypeScript displayName
    #[props(rename = "account-id")]
    account_id: u64,
    last_seen: Option<std::time::SystemTime>,
    roles: Vec<Role>,
}

#[derive(PageProps)]
enum Role {
    #[props(rename = "reader")]
    Reader,
    #[props(rename = "editor")]
    Editor,
}
```

Named structs and unit enums may contain `bool`, `String`, integer types through
64 bits, `f32`, `f64`, `SystemTime`, `Option<T>`, `Vec<T>`, and other derived named
types. Struct fields default to camelCase; enum literals retain their variant
names unless renamed. Attributes belong on fields or enum variants. Tuples,
unit structs, enum payloads/discriminants, generic declarations, recursive shapes,
maps, sets, references and unrestricted JSON values are unsupported. Invalid
shapes, attributes and duplicate final names report the offending declaration.
Recursive shapes return a bind error before value encoding.

The derive uses FMIR's actual `PropsSchema` and records each Rust field's source
file, line and column. Binding compares fields by name, regardless of order.
Every TypeScript field must exist in Rust, including optional fields. A required
Rust field may satisfy an optional TypeScript field; a Rust `Option` cannot
satisfy a required TypeScript field. Enum sets must match exactly. Extra Rust
fields produce warnings and are never encoded.

`forma_ir::props::BoundProps<P>` verifies a module once and retains it immutably.
Each call to `encode` projects only the declared fields, omits absent object
fields, and preserves absent array elements as null placeholders. Integer checks
run before any floating-point conversion and enforce ±(2^53−1); floats must be
finite. Dates encode signed epoch milliseconds, truncating sub-millisecond
precision toward zero, with the valid JavaScript Date bound ±8.64e15 ms. Failures
include route, property path and both declarations where available. A development
reload constructs a fresh binding for the new module.

Licensed under the MIT licence.