document_session_api/lib.rs
1// Copyright 2026 Mark Alan Boykin
2// This Source Code Form is subject to the terms of the Mozilla Public
3// License, v. 2.0. If a copy of the MPL was not distributed with this
4// file, You can obtain one at https://mozilla.org/MPL/2.0/.
5// SPDX-License-Identifier: MPL-2.0
6
7//! # document-session-api
8//!
9//! The contracts an engine implements to be hosted: the retained session
10//! traits (`SessionEngine`, `DocumentSession`) and their input, clip, find
11//! and report vocabulary; the accessibility projection an engine produces;
12//! the document-capability declaration; page capture; and the engine-id
13//! namespace with the genet render-rung ladder.
14//!
15//! This is the engine-facing half of `inker`, split out under the platform
16//! boundary plan (mere `design_docs/mere_docs/implementation_strategy/`
17//! `2026-09-02_platform_boundary_and_repository_topology_plan.md`, P1) so
18//! that Genet's engines depend on a crate Genet owns, and `inker`, the
19//! controller that selects and orchestrates engines, can move to Mere and
20//! depend downward on this. `inker` re-exports everything here, so its paths
21//! still resolve for its consumers. Frame-type generic and paint-free.
22
23/// Accessibility capability contract (R0 invariant: every surface declares
24/// what it can expose to the a11y tree; degradation is declared, never silent).
25pub mod a11y;
26
27/// Shared retained/hosted document-control capability vocabulary.
28pub mod capabilities;
29
30/// The engine-id namespace and the genet render-rung ladder.
31pub mod engine_ids;
32
33/// Shared page-capture request/result vocabulary.
34pub mod page_capture;
35
36/// Session-engine traits and registry: retained document sessions producing
37/// paint frames (the genet HTML lanes, smolweb native).
38pub mod session_engine;
39
40pub use a11y::{
41 A11yCapability, DocumentA11yAction, DocumentA11yActionData, DocumentA11yActionRequest,
42 DocumentA11yBounds, DocumentA11yClickTarget, DocumentA11yHasPopup, DocumentA11yLive,
43 DocumentA11yNode, DocumentA11yNodeId, DocumentA11yOrientation, DocumentA11yPoint,
44 DocumentA11yProjection, DocumentA11yRole, DocumentA11yState, DocumentA11ySupport,
45 DocumentA11ySupportError, DocumentA11yToggled,
46};
47pub use capabilities::{
48 CapabilityStatus, DocumentCapabilities, DocumentCapabilityStatus, WebFeatureStatus,
49};
50pub use engine_ids::*;
51pub use page_capture::{
52 CssExtent, CssPoint, PageCaptureImageArtifact, PageCaptureOutput, PageCaptureRequest,
53 PageCaptureRequestId, PageCaptureScope, PageCaptureViewportFacts,
54};
55pub use session_engine::{
56 ContentLineage, ContentReport, DocumentClip, DocumentClipArtifact, DocumentClipArtifactRole,
57 DocumentFindDirection, DocumentFindMatch, DocumentFindQuery, DocumentFindReveal,
58 DocumentFindState, DocumentSession, DocumentZoomState, EngineKindIndex, EngineKinds,
59 OutlineEntry, SessionButtonState, SessionClick, SessionCursor, SessionEffect, SessionEngine,
60 SessionError, SessionExternalTextureDraw, SessionFocusDirection, SessionFormMethod,
61 SessionDocumentRequest, SessionEncodedFormSubmission, SessionRequestSpawnResult,
62 SessionFormSubmission, SessionIme, SessionInput, SessionInputResult, SessionKey, SessionLink,
63 SessionModifiers, SessionNavigationCommand, SessionPendingWork, SessionPointerButton,
64 SessionRegistry, SessionScrollKey, SessionSpawnRequest, SessionTextTarget,
65};