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