Expand description
Shared document store models.
The format, projection and edit-op vocabulary is defined beside the
codec seam in systemprompt_provider_contracts::documents and
re-exported here, so every layer names one set of types. This module
adds what only the store and its clients need: access levels, actions,
grant audit events and access request states (access), the bridge
drive sync protocol (drive), the AG-UI custom event payloads
(events, with the comment edit, delete and mention payloads in
comment_events) and the document:// URI (uri).
Copyright (c) systemprompt.io — Business Source License 1.1. See https://systemprompt.io for licensing details.
Re-exports§
pub use access::AccessLevel;pub use access::AccessRequestStatus;pub use access::ActorKind;pub use access::AgentEditPolicy;pub use access::DocumentAction;pub use access::EditMode;pub use access::GrantEventKind;pub use access::ProposalStatus;pub use access::RevisionOriginKind;pub use access::UnknownDocumentValue;pub use awareness::AwarenessCursor;pub use awareness::AwarenessMode;pub use awareness::AwarenessState;pub use awareness::AwarenessViewport;pub use awareness::DocumentAwarenessEvent;pub use awareness::DocumentLiveClosedEvent;pub use awareness::DocumentLiveReadyEvent;pub use awareness::DocumentLiveResyncEvent;pub use awareness::LiveResyncReason;pub use comment_events::DocumentCommentDeletedEvent;pub use comment_events::DocumentCommentMentionedEvent;pub use comment_events::DocumentCommentUpdatedEvent;pub use comment_events::MENTION_EVENT_VERSION;pub use comment_events::MENTION_EXCERPT_CHARS;pub use drive::BRIDGE_DEVICE_AUDIENCE;pub use drive::DRIVE_SYNC_AUDIENCE;pub use drive::DriveChange;pub use drive::DriveChangeKind;pub use drive::DriveChanges;pub use drive::DriveCommitMeta;pub use drive::DriveCommitResponse;pub use drive::DriveEntry;pub use drive::DriveManifest;pub use drive::DriveProposal;pub use drive::DriveProposals;pub use drive::DriveSyncToken;pub use drive::PresenceBeacon;pub use drive::PresenceSource;pub use drive::PresenceState;pub use events::DocumentAccessRequestedEvent;pub use events::DocumentCollabDegradedEvent;pub use events::DocumentCollabUpdateEvent;pub use events::DocumentCommentCreatedEvent;pub use events::DocumentCommentResolvedEvent;pub use events::DocumentConflictEvent;pub use events::DocumentEventName;pub use events::DocumentLockEvent;pub use events::DocumentOwnershipTransferredEvent;pub use events::DocumentPresenceEvent;pub use events::DocumentProposalEvent;pub use events::DocumentRevisionCreatedEvent;pub use events::SHARED_EVENT_VERSION;pub use uri::DocumentUri;pub use uri::DocumentUriError;
Modules§
- access
- Document access levels, the actions they gate, the provenance vocabulary recorded on every revision, and the sharing audit and access request vocabulary.
- awareness
- Awareness: the ephemeral state each participant of a live document shares with the others (who they are, their colour, caret, selection and viewport), and the live channel’s own control events.
- collab_
events - The live-session events: an engine update, and a checkpoint that saved less than the live document holds.
- comment_
events - Payloads of the comment events beyond creation and resolution: an edit of a comment’s body or mentions, a deletion, and the notice a mentioned user receives.
- drive
- The bridge drive sync protocol.
- events
- Payloads of the AG-UI custom events the document store emits.
- sharing_
events - Payloads of the sharing events.
- uri
- The
document://<id>[@<revision>][#<node>]reference agents quote to name a precise location in a document.
Structs§
- Projection
- A codec’s view of one document revision.
- Projection
Node - Quote
Target - Unknown
Document Format
Enums§
- Cell
Value - Content
As - Document
Format - EditOp
- Node
Kind - Node
Target - The node an anchored op addresses: a node id from a read, or a quote of the block’s text.