oino-client 1.1.0

Oino client SDK: SessionBackend contract, RPC command records, in-process and fake backends
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

//! `oino-client`: how frontends talk to a session.
//!
//! Every frontend (RPC server, TUI, GPUI, ACP adapter) drives a session through
//! [`SessionBackend`]: Oino [`RpcCommand`]s in, one ordered stream of
//! [`oino_core::events::ClientEvent`]s out, dialog answers via
//! [`SessionBackend::ui_respond`]. The in-process backend passes the enums without
//! serialisation; `oino-rpc`'s `RpcBackend` serialises them over JSONL, so a frontend cannot
//! tell the two apart.
//!
//! # API map
//!
//! | Module | Contents |
//! |---|---|
//! | [`protocol`] | [`RpcCommand`] ([`AgentCommand`], [`OinoCommand`]), [`RpcRequest`], [`RpcResponse`], [`RpcSessionState`] |
//! | [`backend`] | [`SessionBackend`], [`ClientError`] |
//! | [`frontend`] | [`FrontendApi`]: typed `_oino/*` frontend commands (completions, panel actions, shortcuts, editor intents, settings, services, sign-in, topics, agents, queue edits, checkpoints / rewind, running bash, extensions) for every backend |
//! | [`in_process`] (feature `in-process`) | `rpc-mode.ts` `handleCommand` | [`InProcessBackend`] over `AgentSessionRuntime` |
//! | [`fake`] | [`fake::FakeBackend`]: scripted events and replies |
//!
//! The protocol records live here until `oino-protocol` exists (deviations/modes.md).

#![doc(
    html_logo_url = "https://raw.githubusercontent.com/Neuron-Mr-White/Oino/main/docs/assets/brand/png/oino-256.png",
    html_favicon_url = "https://raw.githubusercontent.com/Neuron-Mr-White/Oino/main/docs/assets/brand/oino.ico"
)]
#![forbid(unsafe_code)]
#![cfg_attr(
    test,
    allow(
        clippy::unwrap_used,
        clippy::expect_used,
        clippy::panic,
        reason = "tests assert by unwrapping"
    )
)]

pub mod backend;
pub mod fake;
#[cfg(feature = "in-process")]
mod follow;
pub mod frontend;
#[cfg(feature = "in-process")]
pub mod hub;
#[cfg(feature = "in-process")]
pub mod in_process;
pub mod protocol;

pub use backend::{ClientError, SessionBackend};
#[cfg(feature = "in-process")]
pub use follow::FollowStream;
pub use frontend::{AgentTree, FrontendApi, RenderRow, RewindOptions, ShortcutInfo};
#[cfg(feature = "in-process")]
pub use hub::{HubOptions, HubSession, HubSessionState, SessionHub};
#[cfg(feature = "in-process")]
pub use in_process::{InProcessBackend, ServerInfo};
pub use protocol::{
    AgentCommand, OinoCommand, RejectedCommand, RpcCommand, RpcRequest, RpcResponse,
    RpcResponseData, RpcSessionState,
};