M0: compilable skeleton — Kigi 0.1.0 fork surgery

Hard fork of xai-org/grok-build (Apache-2.0) re-targeted as Kigi, an unofficial Kimi Code CLI community build. Rename & identity - 72 xai-*/xai-grok-* crates -> kigi-* (explicit: xai-grok-pager-bin -> kigi-bin [binary `kigi`], xai-grok-pager -> kigi-tui; rest mechanical); ptyctl, ptyctl-cli, third_party/ unchanged; proto package xai.grok.tools.v1 -> kigi.tools.v1 - Config home ~/.kigi (KIGI_SHARE_DIR override), env prefix GROK_* -> KIGI_*, `kigi --version` carries the unofficial-community-build notice - clap identity, help text, startup banner, prompt templates rebranded (templates re-encrypted) Deletions (PRD removal list #5/#6/#7/#9/#10) - voice input (xai-grok-voice) and all TUI wiring - telemetry: Mixpanel client, external OTel stream, Sentry, OTLP layers, trace/GCS/S3 upload queues (kigi-file-utils halved), workspace upload module & dc_log, heap-profile uploader, auth-diagnostics uploader, session-analytics halves of feedback; local zero-egress observability preserved in new kigi-log crate (unified log, --debug firehose, subsystem file logs, opt-in instrumentation) - announcements (crate, remote-settings fields, TUI surfaces) - plugin marketplace (crate, sources/browse/CTA/extensions-modal tab); direct plugin install/uninstall/update via kigi-agent git_install kept - relay/gateway/assets endpoints and features (agent relay, headless relay transport, gateway bridge, LeaderEnvUrls); leader IPC socket now ~/.kigi/leader.sock + KIGI_LEADER_SOCKET, no ws-url derivation - functional types rehomed instead of deleted: PermissionMode -> kigi-config-types, McpInitStrategy -> kigi-mcp, PrCreationSource -> session signals, TerminalDiagnostics -> kigi-pager-render, agent_id -> shell util Endpoints - kigi-env rewritten: single production KigiEndpoints {coding_api_base_url https://api.kimi.com/coding/v1 (KIGI_CODE_BASE_URL), oauth_host https://auth.kimi.com (KIGI_OAUTH_HOST), update_base_url (GitHub Releases API), upgrade_page_url}; GrokBuildEnvironment enum deleted Toolchain & workspace hygiene - Rust 1.97.0 pinned; edition 2024; full cargo update; git2 hoisted to workspace at 0.21 (Option->Result API migration), quick-xml 0.41 - Root Cargo.toml hand-maintained (PRD §8.1): version 0.1.0 inherited by all members, members sorted, unused deps pruned - cargo-deny advisories gate (deny.toml with documented transitive exceptions); CI workflow (check/clippy/fmt/deny/test, macOS+Linux) - cross-crate test seams re-gated behind `test-support` cargo feature; insta snapshot baselines renamed to the kigi_tui prefix - clippy --workspace --all-targets: zero warnings; fmt clean Fixes surfaced by the port - updater probe/installer divergence (bin/kigi vs bin/grok symlink set) - idle model-metadata refresh dead under KIGI_CODE_BASE_URL override (new is_effective_coding_endpoint_url, loopback+override aware) - macOS symlinked-TMPDIR fixture canonicalization (foreign_sessions, fast-worktree); RSS measurement tests serialized via serial_test Docs & legal (Apache §4) - NOTICE added (upstream attribution + change statement); THIRD-PARTY notices sustained; kigi-tools ported-code notices extended; README, CONTRIBUTING, SECURITY, AGENTS.md rewritten Out of scope for M0 (tracked): Kimi auth/inference (M1), search/fetch, command parity, config import (M2), Computer Hub excision & final brand-token sweep (M2), distribution & self-update rewrite (M3).
2026-07-17 05:31:01 -04:00
commit d6c20fc13f
@@ -0,0 +1,9 @@
+//! API-agnostic conversation representation.
+//!
+//! The canonical types now live in `kigi_sampling_types::conversation`.
+//! This module re-exports them.
+
+// Re-export everything from the standalone crate.
+pub use kigi_sampling_types::conversation::*;
+
+// Tests for conversation types now live in kigi-sampling-types crate.
@@ -0,0 +1,606 @@
+//! Sampling error types.
+//!
+//! The canonical error types now live in `kigi_sampling_types::error`.
+//! This module re-exports them and adds `map_sampling_err_to_acp` which
+//! depends on `agent_client_protocol::Error` (a grok-shell dependency).
+
+// Re-export everything from the standalone crate.
+pub use kigi_sampling_types::error::*;
+
+use agent_client_protocol as acp;
+
+/// ACP error code for rate-limited requests (HTTP 429).
+/// Uses the JSON-RPC implementation-defined server error range (-32000 to -32099).
+///
+/// Contract: this code must only be set for actual HTTP 429 responses from the
+/// sampling client. Clients (desktop, pager) suppress error detail when they
+/// see this code and show a user-friendly upgrade message instead.
+pub const RATE_LIMITED_ERROR_CODE: i32 = -32003;
+
+/// OAuth / session rate-limit copy (personal plan upgrade path).
+pub const RATE_LIMITED_USER_MESSAGE_OAUTH: &str =
+    "You\u{2019}ve hit the rate limit for your plan. Upgrade your account or try again later.";
+
+/// API key / team rate-limit copy. Personal grok.com upgrades do not raise API
+/// team limits; admins purchase credits or a higher spend-based tier.
+/// See https://docs.x.ai/developers/rate-limits#rate-limit-tiers
+pub const RATE_LIMITED_USER_MESSAGE_API_KEY: &str = "You\u{2019}ve hit your team\u{2019}s API rate limit. Ask a team admin to purchase more credits for higher limits, or try again later. See https://docs.x.ai/developers/rate-limits#rate-limit-tiers";
+
+/// Pick rate-limit copy from the *active* auth method.
+///
+/// Pass the real `is_api_key_auth` flag (pager `AppView`, `AuthMethodKind::is_api_key`
+/// for the selected method). Do **not** decide from `has_xai_api_key_env()` alone:
+/// when both an env key and a cached OAuth session exist, auth prefers the
+/// cached session over the API key.
+pub fn rate_limited_user_message(is_api_key_auth: bool) -> &'static str {
+    if is_api_key_auth {
+        RATE_LIMITED_USER_MESSAGE_API_KEY
+    } else {
+        RATE_LIMITED_USER_MESSAGE_OAUTH
+    }
+}
+
+/// Map a `SamplingError` to an ACP `Error` for client-facing responses.
+/// This stays in kigi-shell because it depends on `agent_client_protocol::Error`.
+pub fn map_sampling_err_to_acp(err: SamplingError) -> acp::Error {
+    use reqwest::StatusCode;
+    match err {
+        SamplingError::Auth(msg) => acp::Error::auth_required().data(msg),
+        SamplingError::InvalidConfiguration(msg) => acp::Error::invalid_params().data(msg),
+        SamplingError::Http(e) => {
+            acp::Error::internal_error().data(format!("http client init failed: {e}"))
+        }
+        SamplingError::Serialization(_) => acp::Error::invalid_params().data(err.to_string()),
+        SamplingError::Api {
+            status, message, ..
+        } => match status {
+            StatusCode::UNAUTHORIZED => acp::Error::auth_required().data(message),
+            // 403 Forbidden is NOT an auth error — the request was
+            // authenticated, but the action is not permitted (content-safety
+            // blocks, ZDR-gated operations, remote-settings-blocked users).
+            // Surfacing the proxy's message via internal_error keeps the
+            // explanation visible to the user without triggering the client's
+            // re-auth flow on -32000.
+            StatusCode::FORBIDDEN => {
+                let message = if message.contains("requires a Grok subscription")
+                    && crate::agent::auth_method::has_xai_api_key_env()
+                {
+                    format!(
+                        "{message}\n\nYou have an API key set (XAI_API_KEY). \
+                         Your cached OAuth session is being used instead. \
+                         To use your API key, run `grok logout` or type /logout in the TUI."
+                    )
+                } else {
+                    message
+                };
+                acp::Error::internal_error().data(message)
+            }
+            StatusCode::BAD_REQUEST => acp::Error::invalid_params().data(message),
+            StatusCode::NOT_FOUND => acp::Error::resource_not_found(None).data(message),
+            StatusCode::PAYLOAD_TOO_LARGE => acp::Error::invalid_params().data(message),
+            StatusCode::TOO_MANY_REQUESTS => {
+                acp::Error::new(RATE_LIMITED_ERROR_CODE, "Rate limited".to_string()).data(message)
+            }
+            _ => acp::Error::internal_error().data(message),
+        },
+        SamplingError::EventStreamError(message) => acp::Error::internal_error().data(message),
+        SamplingError::StreamError {
+            error_type,
+            message,
+        } => acp::Error::internal_error().data(format!("{error_type}: {message}")),
+        SamplingError::EmptyResponse { context } => acp::Error::internal_error().data(format!(
+            "empty response from model ({}): model={}, had_reasoning={}, finish_reason={}",
+            context.reason,
+            context.model,
+            context.had_reasoning,
+            context.finish_reason_str(),
+        )),
+        SamplingError::MaxTokensTruncation => {
+            acp::Error::internal_error().data(terminal_error_data(
+                err.to_string(),
+                None,
+                kigi_sampler::SamplingErrorKind::MaxTokensTruncation,
+            ))
+        }
+        SamplingError::IdleTimeout { elapsed_secs } => acp::Error::internal_error().data(format!(
+            "No response from model for {elapsed_secs}s — the model may be stuck"
+        )),
+        // Recovery consumes these inside the sampler's retry loop; a stray
+        // terminal one still renders its labels.
+        SamplingError::DoomLoopDetected { .. } => {
+            acp::Error::internal_error().data(err.to_string())
+        }
+    }
+}
+
+pub fn error_data_with_status(message: String, http_status: Option<u16>) -> serde_json::Value {
+    match http_status {
+        Some(sc) => serde_json::json!({ "message": message, "http_status": sc }),
+        None => serde_json::Value::String(message),
+    }
+}
+
+/// Terminal-failure `acp::Error.data`: max-tokens truncation carries an `error_kind` marker (the kind's stable `as_str` name); other kinds keep the legacy shape.
+pub fn terminal_error_data(
+    message: String,
+    http_status: Option<u16>,
+    kind: kigi_sampler::SamplingErrorKind,
+) -> serde_json::Value {
+    if kind != kigi_sampler::SamplingErrorKind::MaxTokensTruncation {
+        return error_data_with_status(message, http_status);
+    }
+    let mut data = serde_json::json!({ "message": message, "error_kind": kind.as_str() });
+    if let Some(sc) = http_status {
+        data["http_status"] = serde_json::json!(sc);
+    }
+    data
+}
+
+/// `turn_result.json` stop_reason for a failed turn: "MaxTokens" when the marker is present, else "Error" (matches the success path's `acp::StopReason` names).
+pub fn stop_reason_for_turn_error(err: &acp::Error) -> &'static str {
+    let is_max_tokens = err
+        .data
+        .as_ref()
+        .and_then(|d| d.get("error_kind"))
+        .and_then(|v| v.as_str())
+        .is_some_and(|k| k == kigi_sampler::SamplingErrorKind::MaxTokensTruncation.as_str());
+    if is_max_tokens { "MaxTokens" } else { "Error" }
+}
+
+fn error_message_from_data(data: &serde_json::Value) -> serde_json::Value {
+    data.get("message").cloned().unwrap_or_else(|| data.clone())
+}
+
+pub fn error_detail_from_data(data: &serde_json::Value) -> Option<String> {
+    if let Some(m) = data.get("message").and_then(|v| v.as_str()) {
+        return Some(m.to_owned());
+    }
+    if let Some(s) = data.as_str() {
+        return Some(s.to_owned());
+    }
+    data.get("detail")
+        .and_then(|v| v.as_str())
+        .map(str::to_owned)
+}
+
+pub fn http_status_from_error(err: &acp::Error) -> Option<u16> {
+    err.data
+        .as_ref()?
+        .get("http_status")?
+        .as_u64()
+        .map(|s| s as u16)
+}
+
+const PROMPT_USAGE_DATA_KEY: &str = "promptUsage";
+
+pub fn attach_prompt_usage(
+    err: acp::Error,
+    usage: Option<crate::extensions::notification::PromptUsage>,
+) -> acp::Error {
+    let Some(usage) = usage else {
+        return err;
+    };
+    let Ok(usage_val) = serde_json::to_value(&usage) else {
+        tracing::warn!(
+            "attach_prompt_usage: failed to serialize PromptUsage; leaving error unchanged"
+        );
+        return err;
+    };
+    let mut map = match err.data.clone() {
+        Some(serde_json::Value::Object(map)) => map,
+        Some(serde_json::Value::String(message)) => {
+            let mut m = serde_json::Map::new();
+            m.insert("message".into(), serde_json::Value::String(message));
+            m
+        }
+        Some(other) => {
+            let mut m = serde_json::Map::new();
+            m.insert("message".into(), other);
+            m
+        }
+        None => {
+            let mut m = serde_json::Map::new();
+            m.insert(
+                "message".into(),
+                serde_json::Value::String(err.message.clone()),
+            );
+            m
+        }
+    };
+    map.insert(PROMPT_USAGE_DATA_KEY.into(), usage_val);
+    err.data(serde_json::Value::Object(map))
+}
+
+pub fn prompt_usage_from_error(
+    err: &acp::Error,
+) -> Option<crate::extensions::notification::PromptUsage> {
+    let data = err.data.as_ref()?;
+    let raw = data.get(PROMPT_USAGE_DATA_KEY)?;
+    serde_json::from_value(raw.clone()).ok()
+}
+
+/// Derive `(stopReason, agentResult)` JSON values for the `prompt_complete`
+/// notification from a prompt result. Rate-limit errors produce
+/// `("rate_limit", null)` so the client shows its own upgrade message;
+/// other errors produce `("error", <detail>)`.
+pub fn prompt_complete_fields(
+    result: &std::result::Result<acp::StopReason, acp::Error>,
+) -> (serde_json::Value, serde_json::Value) {
+    match result {
+        Ok(reason) => (serde_json::json!(*reason), serde_json::Value::Null),
+        Err(err) => {
+            let is_rate_limit = i32::from(err.code) == RATE_LIMITED_ERROR_CODE;
+            let stop = if is_rate_limit { "rate_limit" } else { "error" };
+            let result = if is_rate_limit {
+                serde_json::Value::Null
+            } else {
+                err.data
+                    .as_ref()
+                    .map(error_message_from_data)
+                    .unwrap_or_else(|| serde_json::Value::String(err.message.clone()))
+            };
+            (serde_json::json!(stop), result)
+        }
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use reqwest::StatusCode;
+
+    #[test]
+    fn attach_prompt_usage_preserves_error_kind_and_round_trips() {
+        let mut ledger = kigi_chat_state::UsageLedger::default();
+        ledger.record_main_loop_call(
+            "m",
+            &kigi_sampling_types::TokenUsage {
+                prompt_tokens: 3,
+                completion_tokens: 1,
+                total_tokens: 4,
+                reasoning_tokens: 0,
+                cached_prompt_tokens: 0,
+            },
+            None,
+            Some(10),
+        );
+        let usage = crate::extensions::notification::PromptUsage::from(&ledger);
+        let err = attach_prompt_usage(
+            acp::Error::internal_error().data(terminal_error_data(
+                "truncated".into(),
+                None,
+                kigi_sampler::SamplingErrorKind::MaxTokensTruncation,
+            )),
+            Some(usage.clone()),
+        );
+        assert_eq!(stop_reason_for_turn_error(&err), "MaxTokens");
+        let back = prompt_usage_from_error(&err).expect("usage attached");
+        assert_eq!(back.totals.input_tokens, 3);
+        assert_eq!(back.num_turns, 1);
+    }
+
+    #[test]
+    fn attach_prompt_usage_keeps_string_message_readable() {
+        let usage = crate::extensions::notification::PromptUsage {
+            totals: Default::default(),
+            model_usage: Default::default(),
+            num_turns: 1,
+            usage_is_incomplete: false,
+        };
+        let free = "subscription:free-usage-exhausted quota hit";
+        let err = attach_prompt_usage(
+            acp::Error::new(RATE_LIMITED_ERROR_CODE, "Rate limited").data(free),
+            Some(usage),
+        );
+        let msg = err
+            .data
+            .as_ref()
+            .and_then(|d| {
+                d.as_str()
+                    .or_else(|| d.get("message").and_then(|m| m.as_str()))
+            })
+            .unwrap_or("");
+        assert!(msg.contains("subscription:free-usage-exhausted"));
+        assert!(prompt_usage_from_error(&err).is_some());
+        assert!(!err.data.as_ref().unwrap().is_string());
+    }
+
+    #[test]
+    fn error_detail_from_data_reads_message_field() {
+        let data = error_data_with_status("upstream unavailable".into(), Some(503));
+        assert_eq!(
+            error_detail_from_data(&data).as_deref(),
+            Some("upstream unavailable")
+        );
+    }
+
+    #[test]
+    fn rate_limited_user_message_oauth_vs_api_key() {
+        assert_eq!(
+            rate_limited_user_message(false),
+            RATE_LIMITED_USER_MESSAGE_OAUTH
+        );
+        assert_eq!(
+            rate_limited_user_message(true),
+            RATE_LIMITED_USER_MESSAGE_API_KEY
+        );
+        assert!(RATE_LIMITED_USER_MESSAGE_OAUTH.contains("Upgrade your account"));
+        assert!(RATE_LIMITED_USER_MESSAGE_API_KEY.contains("team"));
+        assert!(RATE_LIMITED_USER_MESSAGE_API_KEY.contains("credits"));
+        assert!(
+            RATE_LIMITED_USER_MESSAGE_API_KEY
+                .contains("https://docs.x.ai/developers/rate-limits#rate-limit-tiers")
+        );
+        assert!(!RATE_LIMITED_USER_MESSAGE_API_KEY.contains("Upgrade your account"));
+    }
+
+    #[test]
+    fn rate_limit_error_uses_dedicated_code() {
+        let err = SamplingError::Api {
+            status: StatusCode::TOO_MANY_REQUESTS,
+            message: "Rate limit exceeded".into(),
+            model_metadata: None,
+            retry_after_secs: None,
+            should_retry: None,
+        };
+        let acp_err = map_sampling_err_to_acp(err);
+        assert_eq!(acp_err.code, acp::ErrorCode::from(RATE_LIMITED_ERROR_CODE));
+        assert_eq!(acp_err.message, "Rate limited");
+        assert_eq!(
+            acp_err.data,
+            Some(serde_json::Value::String("Rate limit exceeded".into()))
+        );
+    }
+
+    #[test]
+    fn rate_limit_mapping_is_stable_with_retry_after() {
+        let err = SamplingError::Api {
+            status: StatusCode::TOO_MANY_REQUESTS,
+            message: "Rate limit exceeded".into(),
+            model_metadata: None,
+            retry_after_secs: Some(60),
+            should_retry: None,
+        };
+        assert_eq!(err.retry_after(), Some(60));
+        let acp_err = map_sampling_err_to_acp(err);
+        assert_eq!(acp_err.code, acp::ErrorCode::from(RATE_LIMITED_ERROR_CODE));
+        assert_eq!(acp_err.message, "Rate limited");
+    }
+
+    #[test]
+    fn rate_limit_code_differs_from_internal_error() {
+        let rate_err = SamplingError::Api {
+            status: StatusCode::TOO_MANY_REQUESTS,
+            message: "limited".into(),
+            model_metadata: None,
+            retry_after_secs: None,
+            should_retry: None,
+        };
+        let server_err = SamplingError::Api {
+            status: StatusCode::INTERNAL_SERVER_ERROR,
+            message: "oops".into(),
+            model_metadata: None,
+            retry_after_secs: None,
+            should_retry: None,
+        };
+        let rate_acp = map_sampling_err_to_acp(rate_err);
+        let server_acp = map_sampling_err_to_acp(server_err);
+
+        assert_eq!(rate_acp.code, acp::ErrorCode::from(RATE_LIMITED_ERROR_CODE));
+        assert_ne!(rate_acp.code, server_acp.code);
+        assert_eq!(server_acp.code, acp::Error::internal_error().code);
+    }
+
+    #[test]
+    fn auth_errors_map_to_auth_required() {
+        let err = SamplingError::Api {
+            status: StatusCode::UNAUTHORIZED,
+            message: "bad token".into(),
+            model_metadata: None,
+            retry_after_secs: None,
+            should_retry: None,
+        };
+        let acp_err = map_sampling_err_to_acp(err);
+        assert_eq!(acp_err.code, acp::Error::auth_required().code);
+    }
+
+    /// Regression test: 403 Forbidden must NOT map to auth_required.
+    /// The cli-chat-proxy returns 403 for policy denials that are unrelated to
+    /// the caller's credentials (content-safety blocks like
+    /// SAFETY_CHECK_TYPE_DATA_LEAKAGE, ZDR-gated operations, remote settings
+    /// blocks). Mapping these to auth_required causes the desktop app to
+    /// tear down the session and kick off silent re-auth on -32000, and
+    /// can race with invalid_grant_threshold to wipe auth.json.
+    #[test]
+    fn forbidden_does_not_map_to_auth_required() {
+        let err = SamplingError::Api {
+            status: StatusCode::FORBIDDEN,
+            message:
+                "Content violates usage guidelines. Failed check: SAFETY_CHECK_TYPE_DATA_LEAKAGE"
+                    .into(),
+            model_metadata: None,
+            retry_after_secs: None,
+            should_retry: None,
+        };
+        let acp_err = map_sampling_err_to_acp(err);
+        assert_ne!(
+            acp_err.code,
+            acp::Error::auth_required().code,
+            "403 Forbidden must not be surfaced as auth_required"
+        );
+        assert_eq!(
+            acp_err.data,
+            Some(serde_json::Value::String(
+                "Content violates usage guidelines. Failed check: SAFETY_CHECK_TYPE_DATA_LEAKAGE"
+                    .into()
+            ))
+        );
+    }
+
+    /// Helper: run a closure with XAI_API_KEY temporarily set (or cleared).
+    /// Cleans up even if the closure panics.
+    fn with_api_key_env<F: FnOnce()>(key: Option<&str>, f: F) {
+        let prev = std::env::var("XAI_API_KEY").ok();
+        let prev_legacy = std::env::var("KIGI_CODE_XAI_API_KEY").ok();
+        // SAFETY: serial_test ensures no concurrent env mutation.
+        unsafe {
+            std::env::remove_var("XAI_API_KEY");
+            std::env::remove_var("KIGI_CODE_XAI_API_KEY");
+            if let Some(k) = key {
+                std::env::set_var("XAI_API_KEY", k);
+            }
+        }
+        let result = std::panic::catch_unwind(std::panic::AssertUnwindSafe(f));
+        // Restore original state.
+        unsafe {
+            std::env::remove_var("XAI_API_KEY");
+            std::env::remove_var("KIGI_CODE_XAI_API_KEY");
+            if let Some(v) = prev {
+                std::env::set_var("XAI_API_KEY", v);
+            }
+            if let Some(v) = prev_legacy {
+                std::env::set_var("KIGI_CODE_XAI_API_KEY", v);
+            }
+        }
+        if let Err(e) = result {
+            std::panic::resume_unwind(e);
+        }
+    }
+
+    #[test]
+    #[serial_test::serial]
+    fn forbidden_subscription_error_includes_api_key_hint_when_env_set() {
+        with_api_key_env(Some("xai-test"), || {
+            let err = SamplingError::Api {
+                status: StatusCode::FORBIDDEN,
+                message: "The model 'grok-build' requires a Grok subscription.".into(),
+                model_metadata: None,
+                retry_after_secs: None,
+                should_retry: None,
+            };
+            let acp_err = map_sampling_err_to_acp(err);
+            let data = acp_err.data.unwrap();
+            let msg = data.as_str().unwrap();
+            assert!(
+                msg.contains("grok logout"),
+                "should suggest grok logout when API key is available: {msg}"
+            );
+            assert!(
+                msg.contains("/logout"),
+                "should mention /logout TUI command: {msg}"
+            );
+        });
+    }
+
+    #[test]
+    #[serial_test::serial]
+    fn forbidden_subscription_error_no_hint_without_api_key() {
+        with_api_key_env(None, || {
+            let err = SamplingError::Api {
+                status: StatusCode::FORBIDDEN,
+                message: "The model 'grok-build' requires a Grok subscription.".into(),
+                model_metadata: None,
+                retry_after_secs: None,
+                should_retry: None,
+            };
+            let acp_err = map_sampling_err_to_acp(err);
+            let data = acp_err.data.unwrap();
+            let msg = data.as_str().unwrap();
+            assert!(
+                !msg.contains("grok logout"),
+                "should NOT suggest logout when no API key is available: {msg}"
+            );
+        });
+    }
+
+    #[test]
+    #[serial_test::serial]
+    fn forbidden_non_subscription_error_no_hint() {
+        with_api_key_env(Some("xai-test"), || {
+            let err = SamplingError::Api {
+                status: StatusCode::FORBIDDEN,
+                message: "Content violates usage guidelines.".into(),
+                model_metadata: None,
+                retry_after_secs: None,
+                should_retry: None,
+            };
+            let acp_err = map_sampling_err_to_acp(err);
+            let data = acp_err.data.unwrap();
+            let msg = data.as_str().unwrap();
+            assert!(
+                !msg.contains("grok logout"),
+                "should NOT suggest logout for non-subscription 403: {msg}"
+            );
+        });
+    }
+
+    #[test]
+    fn prompt_complete_fields_ok_passes_through_stop_reason() {
+        let result: std::result::Result<acp::StopReason, acp::Error> = Ok(acp::StopReason::EndTurn);
+        let (stop, agent_result) = prompt_complete_fields(&result);
+        assert_eq!(stop, serde_json::json!("end_turn"));
+        assert_eq!(agent_result, serde_json::Value::Null);
+    }
+
+    #[test]
+    fn prompt_complete_fields_rate_limit_omits_detail() {
+        let err = acp::Error::new(RATE_LIMITED_ERROR_CODE, "Rate limited".to_string())
+            .data("Rate limit exceeded");
+        let (stop, agent_result) = prompt_complete_fields(&Err(err));
+        assert_eq!(stop, serde_json::json!("rate_limit"));
+        assert_eq!(agent_result, serde_json::Value::Null);
+    }
+
+    #[test]
+    fn prompt_complete_fields_generic_error_includes_detail() {
+        let err = acp::Error::internal_error().data("connection reset");
+        let (stop, agent_result) = prompt_complete_fields(&Err(err));
+        assert_eq!(stop, serde_json::json!("error"));
+        assert_eq!(
+            agent_result,
+            serde_json::Value::String("connection reset".into())
+        );
+    }
+
+    #[test]
+    fn prompt_complete_fields_error_without_data_falls_back_to_message() {
+        let err = acp::Error::new(-32000, "something broke".to_string());
+        assert!(err.data.is_none());
+        let (stop, agent_result) = prompt_complete_fields(&Err(err));
+        assert_eq!(stop, serde_json::json!("error"));
+        assert_eq!(
+            agent_result,
+            serde_json::Value::String("something broke".into())
+        );
+    }
+
+    #[test]
+    fn http_status_from_error_extracts_status() {
+        let err = acp::Error::internal_error()
+            .data(error_data_with_status("bad token".into(), Some(401)));
+        assert_eq!(http_status_from_error(&err), Some(401));
+    }
+
+    /// The typed max-tokens kind round-trips through `acp::Error.data` to the uploaded stop_reason.
+    #[test]
+    fn stop_reason_for_turn_error_distinguishes_max_tokens() {
+        let err = map_sampling_err_to_acp(SamplingError::MaxTokensTruncation);
+        assert_eq!(stop_reason_for_turn_error(&err), "MaxTokens");
+        assert_eq!(
+            stop_reason_for_turn_error(&acp::Error::internal_error()),
+            "Error"
+        );
+    }
+
+    #[test]
+    fn prompt_complete_fields_extracts_message_from_status_data() {
+        let err = acp::Error::internal_error()
+            .data(error_data_with_status("model not found".into(), Some(404)));
+        let (stop, agent_result) = prompt_complete_fields(&Err(err));
+        assert_eq!(stop, serde_json::json!("error"));
+        assert_eq!(
+            agent_result,
+            serde_json::Value::String("model not found".into())
+        );
+    }
+}
@@ -0,0 +1,32 @@
+pub mod conversation;
+pub mod error;
+pub mod types;
+
+// `Client` is the legacy alias used throughout the shell. A later refactor
+// retired the bespoke shell HTTP client and points `Client` at the sampler crate's
+// `SamplingClient` -- the two have identical method sets, so call-sites
+// compile unchanged.
+pub use self::conversation::*;
+pub use self::error::{ResponseModelMetadata, Result, SamplingError};
+pub use self::types::*;
+pub use kigi_sampler::ApiBackend;
+pub use kigi_sampler::SamplingClient as Client;
+
+// Re-export async-openai Responses API types under `rs` namespace
+pub use async_openai::types::responses as rs;
+
+// ---------------------------------------------------------------------------
+// kigi-sampler re-exports
+// ---------------------------------------------------------------------------
+//
+// The actual streaming / retry / HTTP-client logic lives in the
+// `kigi-sampler` crate. We re-export the public surface here so
+// `crate::sampling::{SamplerHandle, SamplerConfig, ...}` paths keep working
+// for callers that haven't been ported to spell these directly via
+// `kigi_sampler::*`. The shell-side `sampling::client::Config`
+// composite was removed when its only remaining role -- session-snapshot
+// state for `MvpAgent` -- was migrated to `RefCell<SamplerConfig>` directly.
+pub use kigi_sampler::{
+    InferenceLatencyStats, OriginClientInfo, RequestId, SamplerActor, SamplerConfig, SamplerHandle,
+    SamplingChannel, SamplingClient, SamplingErrorInfo, SamplingErrorKind, SamplingEvent,
+};
@@ -0,0 +1,64 @@
+// Re-export all types from the standalone kigi-sampling-types crate.
+// This keeps all existing `crate::sampling::types::*` imports working.
+pub use kigi_sampling_types::types::*;
+
+// `CreateResponseWrapper` and `MessagesRequestWrapper` previously lived
+// here. They were moved into `kigi-sampling-types::types` (and
+// are re-exported above via the wildcard) so the new
+// `kigi-sampler` crate can reference them without a circular
+// dep on `kigi-shell`.
+
+// Tests for the types now live in kigi-sampling-types crate.
+
+use kigi_tools::types::output::ImageContent as ToolsImageContent;
+
+/// Render an `ImageContent` produced by the read-file tool as a URL
+/// string suitable for an `image_url` content block: passes the
+/// explicit `uri` through if present, otherwise builds a
+/// `data:<mime>;base64,<data>` URI.
+///
+/// Lives in the shell (rather than `kigi-sampling-types` or
+/// `kigi-tools`) so neither of those crates needs to depend on
+/// `agent-client-protocol`.
+pub fn get_image_content_url(image_content: &ToolsImageContent) -> String {
+    if let Some(uri) = &image_content.uri {
+        uri.clone()
+    } else {
+        format!(
+            "data:{};base64,{}",
+            image_content.mime_type, image_content.data
+        )
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn get_image_content_url_returns_uri_when_present() {
+        let img = ToolsImageContent {
+            data: "AAA".to_string(),
+            mime_type: "image/png".to_string(),
+            uri: Some("https://example.com/image.png".to_string()),
+            annotations: None,
+            meta: None,
+        };
+        assert_eq!(get_image_content_url(&img), "https://example.com/image.png");
+    }
+
+    #[test]
+    fn get_image_content_url_builds_data_uri_when_no_uri() {
+        let img = ToolsImageContent {
+            data: "VGVzdA==".to_string(),
+            mime_type: "image/png".to_string(),
+            uri: None,
+            annotations: None,
+            meta: None,
+        };
+        assert_eq!(
+            get_image_content_url(&img),
+            "data:image/png;base64,VGVzdA=="
+        );
+    }
+}