typeduck-codex-async-utils 0.33.0

Support package for the standalone Codex Web runtime (codex-extension-items)
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
60
61

//! Typed display items owned by Codex extensions.
//!
//! This crate intentionally sits below `codex-protocol` so core can carry
//! extension items without owning each extension's display schema.

use schemars::JsonSchema;
use serde::Deserialize;
use serde::Serialize;
use ts_rs::TS;

pub mod image_generation;
pub mod sleep;
pub mod web_search;

/// Canonical extension-owned turn item carried through core lifecycle events.
///
/// The item is serialized as a flattened, namespaced envelope:
///
/// ```json
/// {
///   "kind": "image_gen.generation",
///   "id": "call-id",
///   "status": "completed",
///   "revisedPrompt": "A blue square",
///   "result": "cG5n",
///   "savedPath": "/tmp/image.png"
/// }
/// ```
///
/// `kind` values follow `<extension_namespace>.<item_kind>`. Adding a variant
/// also requires app-server to add its typed public wrapper.
#[derive(Debug, Clone, Deserialize, Serialize, TS, JsonSchema, PartialEq)]
#[serde(tag = "kind")]
#[ts(tag = "kind")]
pub enum ExtensionItem {
    #[serde(rename = "image_gen.generation")]
    #[ts(rename = "image_gen.generation")]
    ImageGeneration(image_generation::ImageGenerationItem),
    #[serde(rename = "clock.sleep")]
    #[ts(rename = "clock.sleep")]
    Sleep(sleep::SleepItem),
    #[serde(rename = "web.search")]
    #[ts(rename = "web.search")]
    WebSearch(web_search::WebSearchItem),
}

impl ExtensionItem {
    /// Returns the stable item identifier without exposing variant fields to
    /// core or rollout persistence.
    pub fn id(&self) -> &str {
        match self {
            Self::ImageGeneration(item) => &item.id,
            Self::Sleep(item) => &item.id,
            Self::WebSearch(item) => &item.id,
        }
    }
}

#[cfg(test)]
#[path = "tests.rs"]
mod tests;