@livekit/protocol 1.52.1 → 1.53.1

package/src/gen/livekit_agent_pb.d.ts

@@ -79,6 +79,51 @@ export declare enum JobStatus {
    * @generated from enum value: JS_FAILED = 3;
    */
   JS_FAILED = 3,
+
+  /**
+   * the job ended before it was assigned to an agent
+   *
+   * @generated from enum value: JS_CANCELLED = 4;
+   */
+  JS_CANCELLED = 4,
+}
+
+/**
+ * @generated from enum livekit.JobStateReason
+ */
+export declare enum JobStateReason {
+  /**
+   * @generated from enum value: JSR_UNSPECIFIED = 0;
+   */
+  JSR_UNSPECIFIED = 0,
+
+  /**
+   * no agent was available to accept the job
+   *
+   * @generated from enum value: JSR_NO_CAPACITY = 1;
+   */
+  JSR_NO_CAPACITY = 1,
+
+  /**
+   * the room closed before an agent was assigned
+   *
+   * @generated from enum value: JSR_ROOM_CLOSED = 2;
+   */
+  JSR_ROOM_CLOSED = 2,
+
+  /**
+   * the dispatch was deleted before an agent was assigned
+   *
+   * @generated from enum value: JSR_DISPATCH_DELETED = 3;
+   */
+  JSR_DISPATCH_DELETED = 3,
+
+  /**
+   * the job failed and is being dispatched again
+   *
+   * @generated from enum value: JSR_RETRYING = 4;
+   */
+  JSR_RETRYING = 4,
 }
 
 /**
@@ -210,6 +255,13 @@ export declare class JobState extends Message<JobState> {
    */
   agentId: string;
 
+  /**
+   * why the job has no agent, for JS_PENDING and JS_CANCELLED jobs
+   *
+   * @generated from field: livekit.JobStateReason reason = 9;
+   */
+  reason: JobStateReason;
+
   constructor(data?: PartialMessage<JobState>);
 
   static readonly runtime: typeof proto3;
@@ -344,6 +396,15 @@ export declare class ServerMessage extends Message<ServerMessage> {
      */
     value: WorkerPong;
     case: "pong";
+  } | {
+    /**
+     * the server is draining this control connection: re-register elsewhere,
+     * in-flight agent HTTP streams run to completion
+     *
+     * @generated from field: livekit.AgentHttp.GoAway go_away = 6;
+     */
+    value: AgentHttp_GoAway;
+    case: "goAway";
   } | { case: undefined; value?: undefined };
 
   constructor(data?: PartialMessage<ServerMessage>);
@@ -463,15 +524,11 @@ export declare class RegisterWorkerRequest extends Message<RegisterWorkerRequest
   agentName: string;
 
   /**
-   * string worker_id = 2;
-   *
    * @generated from field: string version = 3;
    */
   version: string;
 
   /**
-   * string name = 4 [deprecated = true];
-   *
    * @generated from field: uint32 ping_interval = 5;
    */
   pingInterval: number;
@@ -491,6 +548,29 @@ export declare class RegisterWorkerRequest extends Message<RegisterWorkerRequest
    */
   deployment: string;
 
+  /**
+   * HTTP endpoints this worker serves through the data plane, in route order.
+   * Empty means the worker exposes no endpoints and needs no data connections.
+   *
+   * @generated from field: repeated livekit.AgentHttp.AgentEndpoint endpoints = 10;
+   */
+  endpoints: AgentHttp_AgentEndpoint[];
+
+  /**
+   * random per process; a re-registration with a new instance_id supersedes the
+   * previous epoch and closes its remaining connections
+   *
+   * @generated from field: string instance_id = 11;
+   */
+  instanceId: string;
+
+  /**
+   * highest data-plane protocol version the worker supports; 0 = unsupported
+   *
+   * @generated from field: uint32 endpoint_protocol = 12;
+   */
+  endpointProtocol: number;
+
   constructor(data?: PartialMessage<RegisterWorkerRequest>);
 
   static readonly runtime: typeof proto3;
@@ -520,6 +600,13 @@ export declare class RegisterWorkerResponse extends Message<RegisterWorkerRespon
    */
   serverInfo?: ServerInfo;
 
+  /**
+   * present iff the registration carried endpoints and the server supports the data plane
+   *
+   * @generated from field: livekit.AgentHttp.AgentEndpointSettings endpoint_settings = 4;
+   */
+  endpointSettings?: AgentHttp_AgentEndpointSettings;
+
   constructor(data?: PartialMessage<RegisterWorkerResponse>);
 
   static readonly runtime: typeof proto3;
@@ -546,6 +633,14 @@ export declare class MigrateJobRequest extends Message<MigrateJobRequest> {
    */
   jobIds: string[];
 
+  /**
+   * the jobs in job_ids as they were assigned, with state.participant_identity
+   * set to the identity the worker accepted them with
+   *
+   * @generated from field: repeated livekit.Job jobs = 3;
+   */
+  jobs: Job[];
+
   constructor(data?: PartialMessage<MigrateJobRequest>);
 
   static readonly runtime: typeof proto3;
@@ -702,8 +797,6 @@ export declare class UpdateWorkerStatus extends Message<UpdateWorkerStatus> {
   status?: WorkerStatus;
 
   /**
-   * optional string metadata = 2 [deprecated=true];
-   *
    * @generated from field: float load = 3;
    */
   load: number;
@@ -713,6 +806,21 @@ export declare class UpdateWorkerStatus extends Message<UpdateWorkerStatus> {
    */
   jobCount: number;
 
+  /**
+   * worker wants no new streams; existing streams run to completion
+   *
+   * @generated from field: bool draining = 5;
+   */
+  draining: boolean;
+
+  /**
+   * monotonic per registration; status updates may interleave across connections
+   * and a stale report must not regress newer state
+   *
+   * @generated from field: uint64 seq = 6;
+   */
+  seq: bigint;
+
   constructor(data?: PartialMessage<UpdateWorkerStatus>);
 
   static readonly runtime: typeof proto3;
@@ -786,3 +894,315 @@ export declare class JobTermination extends Message<JobTermination> {
   static equals(a: JobTermination | PlainMessage<JobTermination> | undefined, b: JobTermination | PlainMessage<JobTermination> | undefined): boolean;
 }
 
+/**
+ * ----- agent HTTP endpoints data plane -----
+ *
+ * AgentHttp namespaces the data plane: workers expose HTTP endpoints served at
+ * /agents/{agent_name}/{deployment}/{path} without binding any local listener.
+ * The worker opens ONE WebTransport (QUIC) session to /agent that carries both
+ * its control stream (the same WorkerMessage/ServerMessage exchange as the
+ * WebSocket control connection, length-delimited) and every HTTP exchange: the
+ * node opens one bidirectional QUIC stream per request. QUIC provides the
+ * multiplexing and per-stream flow control, so there is no credit accounting
+ * and no attach handshake.
+ *
+ * Each exchange stream is:
+ *
+ *   [len:u32be][StreamPreamble]   the only LiveKit framing
+ *   [ ... opaque bytes ... ]      one HTTP/1.1 exchange, to FIN or RESET_STREAM
+ *
+ * After the preamble the stream is byte-transparent: the node writes a
+ * canonical HTTP/1.1 request and the worker replies with an HTTP/1.1 response,
+ * each parsed by whatever HTTP implementation the side already has. A WebSocket
+ * upgrade is therefore an ordinary request whose response is a 101, after which
+ * the stream is a byte pipe. The protocol evolves by version negotiation at
+ * registration, so the preamble carries no version of its own.
+ *
+ * Bodies use ordinary HTTP/1.1 framing, Content-Length or chunked, and are
+ * unbounded: a body may be many gigabytes and must be streamed. Request and
+ * response size limits are policy for the layer above.
+ *
+ * How one direction ends:
+ *
+ *   success             end of message per the body's own framing, then FIN.
+ *   failed mid-body     chunked trailer fields x-lk-completion and x-lk-error,
+ *                       in band, so the outcome cannot race the bytes it
+ *                       describes.
+ *   failed before any   RESET_STREAM carrying an HttpStreamResetCode, sound
+ *   bytes               only here, where nothing is in flight.
+ *
+ * FIN before the body's own framing says it is complete is truncation, and a
+ * receiver must surface it as such.
+ *
+ * The x-lk- header prefix is reserved for this signalling in both directions.
+ * A node strips it from client-supplied request headers, so a client cannot
+ * forge one, and strips it from responses, so it never reaches the end client.
+ *
+ * @generated from message livekit.AgentHttp
+ */
+export declare class AgentHttp extends Message<AgentHttp> {
+  constructor(data?: PartialMessage<AgentHttp>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.AgentHttp";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): AgentHttp;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): AgentHttp;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): AgentHttp;
+
+  static equals(a: AgentHttp | PlainMessage<AgentHttp> | undefined, b: AgentHttp | PlainMessage<AgentHttp> | undefined): boolean;
+}
+
+/**
+ * @generated from enum livekit.AgentHttp.AgentEndpointKind
+ */
+export declare enum AgentHttp_AgentEndpointKind {
+  /**
+   * @generated from enum value: AEK_HTTP = 0;
+   */
+  AEK_HTTP = 0,
+
+  /**
+   * reserved for future text-mode endpoints
+   *
+   * @generated from enum value: AEK_TEXT = 1;
+   */
+  AEK_TEXT = 1,
+}
+
+/**
+ * why a stream was reset before any HTTP bytes flowed. This travels as the
+ * QUIC RESET_STREAM / STOP_SENDING error code, so it is a number with no room
+ * for detail: the reason string is logged by the side that reset and joined
+ * to this by request_id. An outcome after bytes have flowed travels in
+ * trailers instead, where it cannot race them.
+ *
+ * @generated from enum livekit.AgentHttp.HttpStreamResetCode
+ */
+export declare enum AgentHttp_HttpStreamResetCode {
+  /**
+   * no information. The ordinary cancel code, sent whenever a stream is torn
+   * down without a specific outcome, so it must stay the zero value and must
+   * not imply that anything was or was not applied.
+   *
+   * @generated from enum value: HSR_ABORT = 0;
+   */
+  HSR_ABORT = 0,
+
+  /**
+   * the worker aborted before any application code observed the request, so
+   * nothing was applied and the exchange is safe to retry. Requires that the
+   * application was never entered; a 404 it returned is an ordinary response.
+   *
+   * @generated from enum value: HSR_REFUSED = 1;
+   */
+  HSR_REFUSED = 1,
+
+  /**
+   * the application was entered and then failed before producing a response
+   * head; side effects may already have happened, so this is not safe to
+   * retry.
+   *
+   * @generated from enum value: HSR_INTERNAL = 2;
+   */
+  HSR_INTERNAL = 2,
+
+  /**
+   * the deadline elapsed before a response head was produced
+   *
+   * @generated from enum value: HSR_TIMEOUT = 3;
+   */
+  HSR_TIMEOUT = 3,
+
+  /**
+   * the peer's bytes were not valid HTTP/1.1
+   *
+   * @generated from enum value: HSR_PROTOCOL = 4;
+   */
+  HSR_PROTOCOL = 4,
+}
+
+/**
+ * @generated from message livekit.AgentHttp.AgentEndpoint
+ */
+export declare class AgentHttp_AgentEndpoint extends Message<AgentHttp_AgentEndpoint> {
+  /**
+   * starlette-style path template rooted at '/': {name} (one segment, default),
+   * {name:int}, {name:float}, {name:uuid} (constrained single segments),
+   * {name:path} (multi-segment). Custom converters are rejected.
+   *
+   * @generated from field: string path = 1;
+   */
+  path: string;
+
+  /**
+   * uppercase, exactly as the application routes them (FastAPI does not imply
+   * HEAD from GET)
+   *
+   * @generated from field: repeated string methods = 2;
+   */
+  methods: string[];
+
+  /**
+   * @generated from field: livekit.AgentHttp.AgentEndpointKind kind = 3;
+   */
+  kind: AgentHttp_AgentEndpointKind;
+
+  /**
+   * reachable without a project token
+   *
+   * @generated from field: bool public = 4;
+   */
+  public: boolean;
+
+  constructor(data?: PartialMessage<AgentHttp_AgentEndpoint>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.AgentHttp.AgentEndpoint";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): AgentHttp_AgentEndpoint;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): AgentHttp_AgentEndpoint;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): AgentHttp_AgentEndpoint;
+
+  static equals(a: AgentHttp_AgentEndpoint | PlainMessage<AgentHttp_AgentEndpoint> | undefined, b: AgentHttp_AgentEndpoint | PlainMessage<AgentHttp_AgentEndpoint> | undefined): boolean;
+}
+
+/**
+ * registration-level settings negotiated on the control connection, returned
+ * in RegisterWorkerResponse when the worker declares endpoints and the server
+ * supports the data plane.
+ *
+ * @generated from message livekit.AgentHttp.AgentEndpointSettings
+ */
+export declare class AgentHttp_AgentEndpointSettings extends Message<AgentHttp_AgentEndpointSettings> {
+  /**
+   * the negotiated data-plane protocol version; the worker speaks exactly this
+   * or closes the session
+   *
+   * @generated from field: uint32 protocol = 1;
+   */
+  protocol: number;
+
+  constructor(data?: PartialMessage<AgentHttp_AgentEndpointSettings>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.AgentHttp.AgentEndpointSettings";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): AgentHttp_AgentEndpointSettings;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): AgentHttp_AgentEndpointSettings;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): AgentHttp_AgentEndpointSettings;
+
+  static equals(a: AgentHttp_AgentEndpointSettings | PlainMessage<AgentHttp_AgentEndpointSettings> | undefined, b: AgentHttp_AgentEndpointSettings | PlainMessage<AgentHttp_AgentEndpointSettings> | undefined): boolean;
+}
+
+/**
+ * the first thing on every exchange stream, node -> worker. It carries only
+ * what the worker cannot derive from the HTTP bytes that follow and what it
+ * must not infer from client-supplied headers - identity above all.
+ *
+ * @generated from message livekit.AgentHttp.StreamPreamble
+ */
+export declare class AgentHttp_StreamPreamble extends Message<AgentHttp_StreamPreamble> {
+  /**
+   * what the bytes after this preamble are. A field rather than a framing
+   * tag, so a new stream semantic costs no new mechanism.
+   *
+   * @generated from field: livekit.AgentHttp.AgentEndpointKind kind = 1;
+   */
+  kind: AgentHttp_AgentEndpointKind;
+
+  /**
+   * @generated from field: string request_id = 2;
+   */
+  requestId: string;
+
+  /**
+   * the caller holds agent-endpoint call permission for this agent and
+   * deployment. Always true on a non-public route.
+   *
+   * @generated from field: bool authorized = 3;
+   */
+  authorized: boolean;
+
+  /**
+   * the manifest template that matched, e.g. "/items/{id}"
+   *
+   * @generated from field: string route = 4;
+   */
+  route: string;
+
+  /**
+   * relative, because node and worker clocks are not synchronized. 0 imposes
+   * no deadline.
+   *
+   * @generated from field: uint32 timeout_ms = 5;
+   */
+  timeoutMs: number;
+
+  /**
+   * end client address, host only
+   *
+   * @generated from field: string client_addr = 6;
+   */
+  clientAddr: string;
+
+  /**
+   * "http" or "https" as the end client saw it; not derivable worker-side
+   *
+   * NEXT_ID: 8
+   *
+   * @generated from field: string scheme = 7;
+   */
+  scheme: string;
+
+  constructor(data?: PartialMessage<AgentHttp_StreamPreamble>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.AgentHttp.StreamPreamble";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): AgentHttp_StreamPreamble;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): AgentHttp_StreamPreamble;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): AgentHttp_StreamPreamble;
+
+  static equals(a: AgentHttp_StreamPreamble | PlainMessage<AgentHttp_StreamPreamble> | undefined, b: AgentHttp_StreamPreamble | PlainMessage<AgentHttp_StreamPreamble> | undefined): boolean;
+}
+
+/**
+ * the server is draining: the worker should re-register elsewhere; in-flight
+ * HTTP exchanges run to completion
+ *
+ * @generated from message livekit.AgentHttp.GoAway
+ */
+export declare class AgentHttp_GoAway extends Message<AgentHttp_GoAway> {
+  /**
+   * @generated from field: string reason = 1;
+   */
+  reason: string;
+
+  constructor(data?: PartialMessage<AgentHttp_GoAway>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.AgentHttp.GoAway";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): AgentHttp_GoAway;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): AgentHttp_GoAway;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): AgentHttp_GoAway;
+
+  static equals(a: AgentHttp_GoAway | PlainMessage<AgentHttp_GoAway> | undefined, b: AgentHttp_GoAway | PlainMessage<AgentHttp_GoAway> | undefined): boolean;
+}
+