tiny.acp.Initialize

1/// A caller uses this structure to learn which protocol version the agent speaks, which kinds of2/// prompt block it accepts, and how it authenticates. The structure holds the agent's answer to3/// `initialize`: protocol version, capability flags, authentication methods, and a raw copy of the4/// whole result. `Client.start` fills the structure and keeps it in `Client.initialize`. Every5/// field has a default, and the default value stands for an absent answer. The structure owns its6/// two strings, and `deinit` frees them.7pub const Initialize = struct {8    /// The protocol version the agent answered with, from `result.protocolVersion`. `Client.start`9    /// accepts only 1. The field defaults to 0.10    protocol_version: i64 = 0,11    /// The agent's `agentCapabilities.loadSession` flag. The value is false when the key is absent.12    load_session: bool = false,13    /// The agent's `promptCapabilities.audio` flag, for prompts that carry audio blocks. The value14    /// is false when the key is absent.15    prompt_audio: bool = false,16    /// The agent's `promptCapabilities.image` flag, for prompts that carry image blocks. The value17    /// is false when the key is absent.18    prompt_image: bool = false,19    /// Reports true when `promptCapabilities` sets either `embeddedContent` or `embeddedContext` to20    /// true. The value is false when both keys are absent.21    prompt_embedded_content: bool = false,22    /// The number of entries in the answer's `authMethods` list. The value is 0 when the key is23    /// absent or holds a non-list value.24    auth_methods: usize = 0,25    /// The ids of the authentication methods as one minified JSON array of strings, such as26    /// `["token"]`. A method lacking a string `id` is skipped, and the slice is empty when all27    /// methods lack one. The slice is owned.28    auth_method_ids: []u8 = &.{},29    /// A minified JSON copy of the whole `result` object. The slice is owned.30    raw: []u8 = &.{},3132    /// A caller uses this function to free the answer once the caller is done with it. The function33    /// frees the two owned strings with the given allocator and leaves the value undefined. The34    /// call is safe on the default value, which owns zero allocations. The caller provides the35    /// allocator that `fromResponse` used.36    pub fn deinit(self: *Initialize, allocator: Allocator) void {37        if (self.auth_method_ids.len != 0) allocator.free(self.auth_method_ids);38        if (self.raw.len != 0) allocator.free(self.raw);39        self.* = undefined;40    }4142    /// A caller uses this function to turn a parsed `initialize` response into typed fields, as43    /// `Client.start` does. The function reads a parsed JSON-RPC response and returns its result as44    /// an `Initialize`. The function fails with `error.AgentProtocolError` when the value is a45    /// non-object, carries an `error` member, lacks an object `result`, or the result lacks an46    /// integer `protocolVersion`. The parser reads a missing capability flag as false. The call47    /// copies the strings it keeps with the allocator, so the result outlives the parsed JSON, and48    /// the caller frees it with `deinit`. The function fails with `error.OutOfMemory` and leaves49    /// zero allocations when a copy fails.50    pub fn fromResponse(allocator: Allocator, value: std.json.Value) !Initialize {51        const result = try responseResult(value);52        const protocol_version = json.objectInteger(result, "protocolVersion") orelse return error.AgentProtocolError;53        const raw = try rawJsonAlloc(allocator, result);54        errdefer if (raw.len != 0) allocator.free(raw);55        const auth_method_ids = try authMethodIdsAlloc(allocator, result);56        errdefer if (auth_method_ids.len != 0) allocator.free(auth_method_ids);57        var load_session = false;58        var prompt_audio = false;59        var prompt_image = false;60        var prompt_embedded_content = false;61        if (json.objectObject(result, "agentCapabilities")) |capabilities| {62            load_session = json.objectBool(capabilities, "loadSession") orelse false;63            if (json.objectObject(capabilities, "promptCapabilities")) |prompt| {64                prompt_audio = json.objectBool(prompt, "audio") orelse false;65                prompt_image = json.objectBool(prompt, "image") orelse false;66                prompt_embedded_content = (json.objectBool(prompt, "embeddedContent") orelse false) or (json.objectBool(prompt, "embeddedContext") orelse false);67            }68        }69        return .{70            .protocol_version = protocol_version,71            .load_session = load_session,72            .prompt_audio = prompt_audio,73            .prompt_image = prompt_image,74            .prompt_embedded_content = prompt_embedded_content,75            .auth_methods = arrayLength(result, "authMethods"),76            .auth_method_ids = auth_method_ids,77            .raw = raw,78        };79    }80};

1pub const Initialize = protocol.Initialize;