nyx-agent-types 0.1.0

Implementation-detail serde and TypeScript wire types shared by nyx-agent crates.
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

//! Shared run-row shape.
//!
//! `RunRecord` is the on-the-wire representation of one row in the
//! `runs` table; it crosses both crate and wire boundaries (the API
//! returns it verbatim from `GET /runs/:id` and `GET /runs?status=...`).
//! Lives here so the TS frontend can `import type { RunRecord }` from
//! `types.gen.ts` instead of hand-rolling a parallel interface.
//!
//! The runtime enums `RunStatus` and `TriggeredBy` stay in
//! `nyx_agent_core::store::run` because they are convenience helpers that
//! only produce the string form persisted in the `status` /
//! `triggered_by` columns; the wire shape itself is already a `String`.

use serde::{Deserialize, Serialize};
use ts_rs::TS;

/// On-the-wire shape of a `runs` table row. All `i64` columns carry
/// `#[ts(type = "number")]` so the generated TS declaration uses
/// `number` rather than `bigint` (`serde_json` emits a JSON number for
/// `i64`, which JS receives as `number`).
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, TS)]
pub struct RunRecord {
    pub id: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    #[ts(optional)]
    pub project_id: Option<String>,
    #[serde(default)]
    pub kind: String,
    #[ts(type = "number")]
    pub started_at: i64,
    #[ts(type = "number | null")]
    pub finished_at: Option<i64>,
    pub status: String,
    pub triggered_by: String,
    pub git_ref: Option<String>,
    pub parent_run_id: Option<String>,
    #[ts(type = "number | null")]
    pub wall_clock_ms: Option<i64>,
    #[ts(type = "number")]
    pub total_ai_spend_usd_micros: i64,
}