zenith-session 0.0.0-beta.1

Zenith document identity, ephemeral session DAG, and content-addressed version store.
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

//! zenith-session: local-machine history/session state for `.zen` documents.
//!
//! Pure crate with injected fs/clock/rng adapters; never depended on by the
//! deterministic render pipeline.
//!
//! # Module layout
//!
//! - [`adapter`] — injectable trait boundaries (filesystem, clock, RNG)
//! - [`mod@bundle`] — deterministic DEFLATE bundle/unbundle for portable transfer
//! - [`datadir`] — platform data-directory resolution
//! - [`docid`] — ULID document-identity minting
//! - [`error`] — [`SessionError`] (the single error type for this crate)
//! - [`mod@gc`] — object garbage collection ([`gc()`])
//! - [`global`] — global cross-document LRU storage cap ([`enforce_global_cap`])
//! - [`identity`] — document-identity reconciliation ([`reconcile`])
//! - [`layout`] — [`StorePaths`] pure path builders
//! - [`manifest`] — [`HistoryRecord`] schema and append-only JSONL manifest I/O
//! - [`retention`] — Time-Machine-style retention thinning for Tier-2 version history
//! - [`revspec`] — revision-spec resolver: map a human/agent revspec string to a record id
//! - [`session`] — Tier-1 ephemeral session: snapshot DAG with HEAD + redo stack
//! - [`store`] — content-addressed object store (SHA-256 + DEFLATE)
//! - [`previews`] — [`PreviewRecord`] schema and append-only preview-artifact log
//! - [`runs`] — [`RunRecord`] schema and append-only agent-run provenance log
//! - [`scratch`] — [`CandidateEntry`] schema and append-only scratch/candidate index
//! - [`tier2`] — Tier-2 durable version history: bounded flat list in `versions.jsonl`

pub mod adapter;
pub mod bundle;
pub mod datadir;
pub mod docid;
pub mod error;
pub mod gc;
pub mod global;
pub mod identity;
pub mod layout;
pub mod manifest;
pub mod previews;
pub mod retention;
pub mod revspec;
pub mod runs;
pub mod scratch;
pub mod session;
pub mod store;
pub mod tier2;

pub use bundle::{bundle, unbundle};
pub use datadir::{resolve_data_dir, resolve_data_dir_with};
pub use docid::mint_ulid;
pub use error::SessionError;
pub use gc::{GcReport, gc};
pub use global::{GlobalCapReport, enforce_global_cap};
pub use identity::{DocMeta, Outcome, Reconciled, reconcile};
pub use layout::StorePaths;
pub use manifest::{CheckpointMeta, HistoryRecord, append_record, read_records};
pub use previews::{PreviewCritique, PreviewRecord, append_preview, read_previews};
pub use retention::{
    CapReport, MaintainReport, RetentionPolicy, ThinReport, apply_caps, apply_thinning, maintain,
    thin_versions,
};
pub use revspec::{resolve_revspec, resolve_revspec_for};
pub use runs::{RunDiagnostic, RunRecord, RunStep, append_run, read_runs};
pub use scratch::{
    CandidateEntry, CandidateMeta, CandidateStatus, FinalizeReport, NewCandidate,
    finalize_candidates, get_scratch_snapshot, list_scratch, put_scratch, set_candidate_status,
};
pub use session::{
    RecordOutcome, SessionState, clear_session, current_content, record_state, redo, undo,
};
pub use store::{
    get_object, has_object, object_hash, object_size, put_object, put_object_with_hash,
};
pub use tier2::{
    VersionMeta, VersionOutcome, list_versions, record_version, resolve_version, restore_content,
    version_content,
};