eve/dist/src/compiled/@agentclientprotocol/sdk/stream.d.ts

Filesystem-first framework for durable backend AI agents that run anywhere.

import type { AnyMessage, AnyWireMessage } from "./jsonrpc.js";
/**
 * Stream interface for ACP connections.
 *
 * This type powers the bidirectional communication for an ACP connection,
 * providing readable and writable streams of messages.
 *
 * The most common way to create a Stream is using {@link ndJsonStream}.
 */
export type Stream<Message extends AnyWireMessage = AnyMessage> = {
    /**
     * Outgoing JSON-RPC messages written by this side of the ACP connection.
     */
    writable: WritableStream<Message>;
    /**
     * Incoming JSON-RPC messages read by this side of the ACP connection.
     */
    readable: ReadableStream<Message>;
};
/**
 * ACP stream that exposes JSON-RPC batch messages in addition to individual
 * messages.
 */
export type WireStream = Stream<AnyWireMessage>;
/**
 * Creates an ACP Stream from a pair of newline-delimited JSON streams.
 *
 * This is the typical way to handle ACP connections over stdio, converting
 * between AnyMessage objects and newline-delimited JSON.
 *
 * @param output - The writable stream to send encoded messages to
 * @param input - The readable stream to receive encoded messages from
 * @returns A Stream for bidirectional ACP communication
 */
export declare function ndJsonStream<Message extends AnyWireMessage = AnyMessage>(output: WritableStream<Uint8Array>, input: ReadableStream<Uint8Array>): Stream<Message>;