sheetport-spec 0.3.0

SheetPort spec schema + validation tooling
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
55
56
57

# sheetport-spec (FIO / SheetPort)

`sheetport-spec` defines the Formualizer I/O (FIO) manifest format used by SheetPort.

- Canonical JSON Schema: `schema/fio-0.3.json` (Draft 2019-09)
- Current spec version: `0.3.0` (`spec_version`)
- Conformance profiles: `core-v0` (default), `full-v0` (reserved)

## What Is FIO?

A FIO manifest binds typed input/output ports to workbook regions so a spreadsheet can be treated like a deterministic function:

- Inputs are written into declared locations
- The workbook is recalculated
- Outputs are read from declared locations

The manifest is a contract: it describes *what* data is expected, *where* it lives in the workbook, and *how* it is shaped.

## Profiles (Capability Gating)

Manifests may include:

```yaml
capabilities:
  profile: core-v0
```

`core-v0` limits selector usage to features expected to be broadly supported.

- `core-v0` supports: `a1`, `name`, `layout`
- `full-v0` is reserved for: `struct_ref`, workbook `table` selectors

## Validation

Rust:

```rust
use sheetport_spec::Manifest;

let yaml = std::fs::read_to_string("manifest.fio.yaml")?;
let manifest: Manifest = Manifest::from_yaml_str(&yaml)?;
manifest.validate()?;
```

CLI (from workspace root):

```bash
cargo run -p sheetport-spec --bin fio-lint -- tests/fixtures/supply_planning.yaml
cargo run -p sheetport-spec --bin fio-lint -- tests/fixtures/supply_planning.yaml --normalize
```

`--normalize` emits a canonicalized YAML form (sorted/deduped where applicable).

## Versioning

- `spec_version` in the manifest is the authoritative spec version.
- The crate version is expected to track the supported spec version.