gradatum-core 0.4.3

Shared primitives: errors, IDs, types
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

# gradatum-core

> Shared primitives: traits, canonical types, and typed errors. The L0 foundation every other gradatum crate depends on.

**Status**: Alpha (v0.4.x) — public, Apache-2.0. API not yet stable before v1.0.
Part of **[gradatum](https://crates.io/crates/gradatum)** — memory backbone for AI agents. · [github](https://github.com/gradatum/gradatum) · [gradatum.org](https://gradatum.org)

## Overview

`gradatum-core` is the dependency floor of the gradatum workspace. It defines the canonical
types (`NoteId`, `ContentHash`, `NoteVersion`), the 11 canonical vault sections (`Section`
enum), the three storage traits (`DocumentStore`, `IndexStore`, `VectorStore`), and the
top-level `GradatumError` enum (typed with `thiserror`, no `Box<dyn Error>`).

Every other gradatum crate depends on `gradatum-core`; `gradatum-core` itself has zero
workspace dependencies.

## Usage

```toml
[dependencies]
gradatum-core = "0.4.3"
```

```rust
use gradatum_core::error::GradatumError;
use gradatum_core::note::Note;
use gradatum_core::identity::NoteId;
use gradatum_core::section::Section;
```

## Key Modules

| Module | Contents |
|---|---|
| `error` | `GradatumError` — typed error enum (thiserror, no `Box<dyn Error>`) |
| `note` | `Note`, `NoteBody`, `EffectiveNote` |
| `identity` | `NoteId` (ULID newtype), `ContentHash`, `NoteVersion` |
| `section` | `Section` — 11 canonical sections (kebab-case, serde) |
| `tag` | `Tag` — normalized kebab-case note tag |
| `author` | `AuthorId` — note authorship |
| `status` | `NoteStatus` — note lifecycle state machine |
| `trust` | `TrustContext` — auth context propagated through layers |
| `scope` | `Scope` — JWT audience scopes (read / write / admin) |
| `document_store` | `DocumentStore` trait — raw Markdown persistence |
| `index_store` | `IndexStore` trait — SQLite full-text + vector index |
| `vector_store` | `VectorStore` trait — embedding storage |
| `config` | `VaultConfig` — root configuration deserialization |
| `frontmatter` | `Frontmatter` — YAML frontmatter canonical type |
| `acl` | ACL filter types and visibility markers |
| `audit` | `AuditEntry` — immutable append-only audit trail |

## License

Apache-2.0