Skip to main content

plexus_core/plexus/
mod.rs

1// Guidance system removed during caller-wraps streaming architecture refactor
2// pub mod guidance;
3
4pub mod auth;
5/// AUTH-5: the `auth` activation and what a service supplies it.
6pub mod auth_activation;
7pub mod auth_params;
8/// AUTH-5: a reference in-memory backend and stores for the `auth` activation.
9pub mod auth_memory;
10pub mod test_validator;
11/// MACRO-20: a hub sees through its activations' static children.
12pub mod children;
13pub mod context;
14/// NEST-21: a service's configuration at runtime — settings, the library,
15/// the `config` activation.
16pub mod config;
17// RETURNS-10: canonical schema JSON and the SHA-256/16 hash every schema hash is.
18pub mod content_hash;
19pub mod credential_envelope;
20pub mod dispatch;
21/// BIDIR-8 (BIDIR-5's rule): the gate over a duplex call — open, admit,
22/// re-verify on the gate's grants generation, answer, audit.
23pub mod duplex_gate;
24pub mod errors;
25pub mod forward_registry;
26/// AUTH-2: the grant gate in dispatch, and the task-local reach.
27pub mod grant_gate;
28pub mod hub_context;
29/// RETURNS-40: the IR a service writes of itself — IR 3.0, as synapse builds it.
30pub mod ir;
31// MACRO-2.B3: the in-process transport for the macro-generated typed client.
32pub mod in_process;
33/// BIDIR-6: `Input<T>`, the input half of a call.
34pub mod input;
35/// LOCAL-6: a whole hub, called in memory.
36pub mod hub_transport;
37pub mod method_enum;
38pub mod middleware;
39pub mod parent;
40pub mod path;
41pub mod plexus;
42/// DYNAUTH-8: frame logs never carry a credential.
43pub mod redact;
44/// DYNAUTH-12: tokens a service signs for the peers it forwards calls to.
45#[cfg(not(target_arch = "wasm32"))]
46pub mod peer_token;
47// POLYGLOT-5: the child seam's second implementation — a process or a socket.
48// PLEXUS-45: native only. A browser has no processes, and a ws child waits
49// for a browser-WebSocket transport (a later ticket); on wasm32 the module
50// would compile to a child with no way to reach it.
51#[cfg(not(target_arch = "wasm32"))]
52pub mod remote_child;
53pub mod schema;
54// NEST-11: which service a call is routed in.
55pub mod service_scope;
56/// NEST-15: the service root — a table of peers answered by `peer(name)`.
57pub mod service_root;
58/// NEST-5: slot types and slot grants.
59pub mod slots;
60/// NEST-7: the primitive — an activation returns an activation.
61pub mod peer;
62mod schema_sites;
63pub(crate) mod scope_gate;
64pub mod streaming;
65pub mod types;
66/// AUTH-4: the caller's view of a gated hub.
67pub mod view;
68/// PERF-7: the item path — each item encoded once, straight into the frame
69/// its socket writes.
70pub mod wire;
71
72// AuthContext + SessionValidator + the sealed Principal / VerifiedUser /
73// ServiceIdentity types are re-exported from plexus-auth-core via
74// plexus::auth. New code should import directly from plexus_auth_core.
75pub use auth::{AuthContext, Principal, ServiceIdentity, SessionValidator, VerifiedUser, Anonymous, CallSite, ForwardDerivation, ForwardPolicy, ForwardPolicyName, IdentityOnly, MethodPath, MethodPathError, PassThrough, ANONYMOUS_NAME, IDENTITY_ONLY_NAME, PASS_THROUGH_NAME};
76pub use test_validator::TestSessionValidator;
77pub use context::PlexusContext;
78pub use in_process::InProcessTransport;
79pub use input::{Delivered, Input, InputTable};
80pub use hub_transport::HubTransport;
81#[cfg(not(target_arch = "wasm32"))]
82pub use remote_child::{check_ws_url, is_loopback_host, Backoff, ChildError, ChildMethods, ChildOptions, ChildSpec, ChildStats, Consented, MountTimings, PeerIdentity, RemoteChild};
83#[cfg(all(feature = "clap", not(target_arch = "wasm32")))]
84pub use remote_child::ChildArgs;
85#[deprecated(note = "Use GuidanceErrorType and GuidanceSuggestion from stream events instead")]
86pub use errors::{GuidedError, GuidedErrorData, TryRequest};
87pub use forward_registry::{ForwardPolicyRegistry, SameService, SAME_SERVICE_NAME};
88pub use grant_gate::{current_reach, require_everywhere, with_reach, ForbiddenItem};
89pub use view::View;
90pub use service_scope::WeakService;
91pub use service_root::{RootError, ServiceRoot};
92pub use peer::{Contract, FindPeer, Interface, ListPeers, Peer, PeerError, PeerRouter, PeerSlot, PeerTransport, RouterPeer, Stamp};
93pub use auth_activation::{
94    AuthActivation, AuthBackend, AuthClient, AuthEvent, AuthFailure, AuthSetup, LoginAnswer, LoginFlow, MembershipEntry, MembershipStore,
95    Provider, ProviderKind, Requirement, RoleStore, Session, SignupAnswer, StoreError, Waiting, SIGNED_IN_GRANTS,
96};
97pub use auth_memory::{MemoryAuthBackend, MemoryMemberships, MemoryRoles};
98// AUTH-2: the grant model, re-exported so an activation needs only plexus-core.
99pub use plexus_auth_core::grants::{
100    Ceiling, Gate, Grant, GrantSet, Membership, Memberships, Reach, Refusal, Resolve, RoleOrGrant,
101    RoleTable, Roles, ScopeRef, ADMIN, CEILING_KEY,
102};
103#[deprecated(note = "Middleware removed - guidance provided via PlexusStreamEvent::Guidance")]
104pub use middleware::{ActivationRegistry, GuidedErrorMiddleware};
105pub use path::Provenance;
106#[allow(deprecated)]
107pub use plexus::{error_item, Activation, ActivationInfo, AuthzDenyReason, ChildCapabilities, ChildRouter, DynamicHub, PlexusError, TransportErrorKind, plexus_error_to_jsonrpc, route_to_child, PLEXUS_NOTIF_METHOD};
108// RETURNS-6: the wire's typed call failure, re-exported so server code (and
109// the code `#[activation]` emits) names it through plexus-core.
110pub use plexus_client::{DenyReason, ParamProblem, RemoteError};
111// RETURNS-8: a method's progress vocabulary, named by the code
112// `#[plexus_macros::method]` emits (the default `P` of `Progress<T>` is `Note`).
113pub use plexus_client::{Note, Progress};
114pub use crate::types::Handle;
115pub use schema::{
116    AuthPosture, Cardinality, ChildHashes, ChildSummary, DeprecationInfo, MethodExample, MethodRole,
117    MethodSchema, ParamSchema, PluginHashes, PluginSchema, RequiredCredential, Schema,
118    Need, SchemaParams, SchemaProperty, SchemaResult, SchemaType, ViewKind, JSON_TYPES,
119    X_PLEXUS_VALUES,
120};
121pub use types::{PlexusStreamItem, StreamMetadata};
122pub use wire::Shared;
123pub use method_enum::MethodEnumSchema;
124pub use streaming::{PlexusStream, wrap_stream, error_stream, done_stream, progress_stream};
125// RETURNS-8: one wrapper per signature form (`wrap_stream` is the plain-T stream's).
126pub use streaming::{wrap_one, wrap_one_result, wrap_result_stream, wrap_progress_stream, wrap_result_progress_stream};
127// Note: Method enum is auto-generated by hub_macro and exported from plexus module
128pub use dispatch::{HubDispatch, StreamItem, from_dispatch_stream};
129pub use crate::request::PlexusRequestField;
130pub use hub_context::{HubContext, ParentAware, NoParent};
131// NEST-16: a graft that knows its parent.
132pub use parent::{NeedsMiss, Notice, Parent, ParentTransport, Upward, UpwardError};