Skip to main content

Crate kindling_types

Crate kindling_types 

Source
Expand description

Canonical kindling domain types.

This crate is the source of truth for the wire-format shapes shared between the Rust implementation and TypeScript consumers. Each public type round-trips through the JSON encoding produced by the existing TypeScript definitions in packages/kindling-core/src/types/.

Enable the ts-rs feature to derive the TypeScript projection — running cargo test -p kindling-types --features ts-rs writes the corresponding .ts files into crates/kindling-types/bindings/.

Re-exports§

pub use capability::build_capability;
pub use capability::kind_registry;
pub use capability::supported_kind_names;
pub use capability::Capability;
pub use capability::KindRegistryEntry;
pub use capability::OBSERVATION_REQUIRED_FIELDS;
pub use capsule::Capsule;
pub use capsule::CapsuleInput;
pub use capsule::CapsuleStatus;
pub use capsule::CapsuleType;
pub use common::Id;
pub use common::ScopeIds;
pub use common::Timestamp;
pub use common::ValidationError;
pub use list::ListObservationsRequest;
pub use list::ListObservationsResult;
pub use observation::Observation;
pub use observation::ObservationInput;
pub use observation::ObservationKind;
pub use pin::is_pin_active;
pub use pin::Pin;
pub use pin::PinInput;
pub use pin::PinTargetType;
pub use retrieval::CandidateResult;
pub use retrieval::PinResult;
pub use retrieval::ProviderSearchOptions;
pub use retrieval::ProviderSearchResult;
pub use retrieval::RetrieveOptions;
pub use retrieval::RetrieveProvenance;
pub use retrieval::RetrieveResult;
pub use retrieval::RetrievedEntity;
pub use summary::is_valid_confidence;
pub use summary::Summary;
pub use summary::SummaryInput;

Modules§

capability
Capability handshake and machine-readable kind registry.
capsule
common
list
Types for the exhaustive, deterministically-paginated observation list (POST /v1/observations/list).
observation
pin
retrieval
summary