73 lines
3.2 KiB
Rust
73 lines
3.2 KiB
Rust
// file: crates/ksp-app-backfill-desk/src/dto_common.rs
|
|
// version: 2
|
|
|
|
//! Common Tauri DTOs shared by the Backfill Desk shell.
|
|
|
|
use ts_rs::TS; // rust-rules: trait-import
|
|
|
|
/// Safe Transport-readiness subset of the Backfill Desk options contract.
|
|
///
|
|
/// Campaign scopes, commitments and backend-owned bounds are added in the dedicated request/DTO slice. Endpoint URLs, provider identities and credentials
|
|
/// are intentionally absent.
|
|
#[derive(Clone, Debug, serde::Serialize, TS)]
|
|
#[serde(rename_all = "camelCase")]
|
|
#[ts(export, export_to = "../frontend/ts/bindings/ksp_app_backfill_desk/dto_common/BackfillDeskOptionsDto.ts")]
|
|
pub(crate) struct BackfillDeskOptionsDto {
|
|
/// Logical roles that can route both RPC methods required by the Backfill runtime.
|
|
pub(crate) compatible_roles: std::vec::Vec<String>,
|
|
/// Distinct enabled HTTP cluster labels selected by the active Transport profile.
|
|
pub(crate) configured_networks: std::vec::Vec<String>,
|
|
/// Safe startup diagnostic when Transport configuration could not be resolved or constructed.
|
|
pub(crate) transport_diagnostic: std::option::Option<CommandErrorDto>,
|
|
/// Whether Transport currently has one coherent network and at least one compatible available role.
|
|
pub(crate) transport_ready: bool,
|
|
}
|
|
|
|
/// Safe command error projection that never serializes arbitrary KSP error context or source values.
|
|
#[derive(Clone, Debug, serde::Serialize, TS)]
|
|
#[serde(rename_all = "camelCase")]
|
|
#[ts(export, export_to = "../frontend/ts/bindings/ksp_app_backfill_desk/dto_common/CommandErrorDto.ts")]
|
|
pub(crate) struct CommandErrorDto {
|
|
/// Stable KSP error domain.
|
|
pub(crate) domain: String,
|
|
/// Stable KSP error code within the domain.
|
|
pub(crate) code: String,
|
|
/// Human-readable error message without arbitrary context fields.
|
|
pub(crate) message: String,
|
|
}
|
|
|
|
impl crate::CommandErrorDto {
|
|
/// Builds a bounded safe projection from a KSP error.
|
|
#[must_use]
|
|
pub(crate) fn from_error(error: &ksp_core_lib::Error) -> Self {
|
|
return Self {
|
|
domain: error.code().domain().to_owned(),
|
|
code: error.code().code().to_owned(),
|
|
message: error.message().to_owned(),
|
|
};
|
|
}
|
|
}
|
|
|
|
/// Safe scaffold/runtime snapshot exposed to the Backfill Desk shell.
|
|
#[derive(Clone, Debug, serde::Serialize, TS)]
|
|
#[serde(rename_all = "camelCase")]
|
|
#[ts(export, export_to = "../frontend/ts/bindings/ksp_app_backfill_desk/dto_common/ShellStatusDto.ts")]
|
|
pub(crate) struct ShellStatusDto {
|
|
/// Active configured Logging profile, or `None` while transient fallback Logging is active.
|
|
pub(crate) active_logging_profile: std::option::Option<String>,
|
|
/// Cargo application version.
|
|
pub(crate) application_version: String,
|
|
/// Number of logical Config resources registered by the current runtime.
|
|
pub(crate) config_document_count: u32,
|
|
/// Whether Backfill Desk had to install its transient in-memory Logging fallback.
|
|
pub(crate) fallback_logging_active: bool,
|
|
/// Current implementation phase exposed by the shell.
|
|
pub(crate) shell_phase: String,
|
|
/// Safe startup diagnostic that caused fallback Logging, when applicable.
|
|
pub(crate) startup_diagnostic: std::option::Option<CommandErrorDto>,
|
|
}
|
|
|
|
#[cfg(test)]
|
|
#[path = "../unit_tests/dto_common.rs"]
|
|
mod tests;
|