oino-extension-api 1.0.1

Contracts between oino-core and extension runtimes: instances, host services, manifests, permissions
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

//! `oino-extension-api`: the contract between `oino-core` and any extension runtime
//! (extension-api.md §6). It knows nothing about wasmtime.
//!
//! # Boundary
//!
//! Core implements [`HostServices`] (what extensions may do to sessions, UI, models, agents);
//! a runtime (the WASM host) implements [`ExtensionRuntime`] / [`ExtensionInstance`] (what core
//! may ask an extension). Data-model values cross as [`RawJson`] with exact shapes (D5);
//! capability calls use the typed records of the WIT package `oino:extension@2.0.0`.
//!
//! # API map
//!
//! | Module | WIT | Contents |
//! |---|---|---|
//! | [`json`] | `types.json` | [`RawJson`] |
//! | [`types`] | `types` | [`ExtensionId`], [`CallContext`], [`Mode`], [`CallKind`], [`HostError`], [`ExtensionError`] |
//! | [`registry`] | `registry` | [`EventKind`] (wire names), tool/command/shortcut/flag/renderer specs, [`Registration`] |
//! | [`guest`] | `guest` | [`InitInput`], [`ToolInvocation`], [`CompletionItem`] |
//! | [`ops`] | `session`, `control`, `models`, `ui`, `tasks`, `secrets`, `provider-host` | one enum variant per WIT function |
//! | [`runtime`] | — | [`ExtensionRuntime`], [`ExtensionInstance`], [`ProviderInstance`], [`HostServices`], [`AgentHandle`] |
//! | [`manifest`] | — | `extension.json`, [`manifest::Permissions`], package validation |
//! | [`host_service`] | `host-service` | [`host_service::HostService`] (capabilities an embedding host registers) |
//! | `testing` (feature) | — | `RecordingHostServices`, `FakeExtensionRuntime` |

#![forbid(unsafe_code)]
#![cfg_attr(
    test,
    allow(
        clippy::unwrap_used,
        clippy::expect_used,
        clippy::panic,
        reason = "tests assert by unwrapping"
    )
)]

pub mod guest;
pub mod host_service;
pub mod json;
pub mod manifest;
pub mod ops;
pub mod registry;
pub mod runtime;
#[cfg(feature = "testing")]
pub mod testing;
pub mod types;

pub use guest::{CompletionItem, InitInput, ToolInvocation};
pub use host_service::HostService;
pub use json::RawJson;
pub use manifest::{ExtensionKind, Manifest};
pub use registry::{EventKind, Registration};
pub use runtime::{
    AgentHandle, BoxFut, ComponentSource, DetachedBash, ExtensionInstance, ExtensionRuntime,
    HostServices, LoadedPackage, ProviderEventStream, ProviderInstance,
};
pub use tokio_util::sync::CancellationToken;
pub use types::{CallContext, CallKind, ExtensionError, ExtensionId, HostError, LogLevel, Mode};