@livekit/protocol 1.12.0 → 1.13.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@livekit/protocol",
-  "version": "1.12.0",
+  "version": "1.13.0",
   "description": "",
   "type": "module",
   "main": "src/index.js",

package/src/gen/livekit_agent_pb.d.ts

@@ -12,14 +12,14 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// @generated by protoc-gen-es v1.7.2 with parameter "target=js+dts"
+// @generated by protoc-gen-es v1.8.0 with parameter "target=js+dts"
 // @generated from file livekit_agent.proto (package livekit, syntax proto3)
 /* eslint-disable */
 // @ts-nocheck
 
 import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialMessage, PlainMessage } from "@bufbuild/protobuf";
 import { Message, proto3 } from "@bufbuild/protobuf";
-import type { ParticipantInfo, Room } from "./livekit_models_pb.js";
+import type { ParticipantInfo, ParticipantPermission, Room, ServerInfo } from "./livekit_models_pb.js";
 
 /**
  * @generated from enum livekit.JobType
@@ -71,6 +71,55 @@ export declare enum JobStatus {
   JS_FAILED = 2,
 }
 
+/**
+ * @generated from message livekit.WorkerInfo
+ */
+export declare class WorkerInfo extends Message<WorkerInfo> {
+  /**
+   * @generated from field: string id = 1;
+   */
+  id: string;
+
+  /**
+   * @generated from field: string namespace = 2;
+   */
+  namespace: string;
+
+  /**
+   * @generated from field: string version = 3;
+   */
+  version: string;
+
+  /**
+   * @generated from field: string name = 4;
+   */
+  name: string;
+
+  /**
+   * @generated from field: livekit.JobType type = 5;
+   */
+  type: JobType;
+
+  /**
+   * @generated from field: livekit.ParticipantPermission allowed_permissions = 6;
+   */
+  allowedPermissions?: ParticipantPermission;
+
+  constructor(data?: PartialMessage<WorkerInfo>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.WorkerInfo";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): WorkerInfo;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): WorkerInfo;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): WorkerInfo;
+
+  static equals(a: WorkerInfo | PlainMessage<WorkerInfo> | undefined, b: WorkerInfo | PlainMessage<WorkerInfo> | undefined): boolean;
+}
+
 /**
  * @generated from message livekit.AgentInfo
  */
@@ -129,6 +178,11 @@ export declare class Job extends Message<Job> {
    */
   participant?: ParticipantInfo;
 
+  /**
+   * @generated from field: string namespace = 5;
+   */
+  namespace: string;
+
   constructor(data?: PartialMessage<Job>);
 
   static readonly runtime: typeof proto3;
@@ -173,16 +227,36 @@ export declare class WorkerMessage extends Message<WorkerMessage> {
     /**
      * worker can update its status to the server, including taking itself out of the pool
      *
-     * @generated from field: livekit.UpdateWorkerStatus status = 3;
+     * @generated from field: livekit.UpdateWorkerStatus update_worker = 3;
      */
     value: UpdateWorkerStatus;
-    case: "status";
+    case: "updateWorker";
+  } | {
+    /**
+     * job can send status updates to the server, useful for tracking progress
+     *
+     * @generated from field: livekit.UpdateJobStatus update_job = 4;
+     */
+    value: UpdateJobStatus;
+    case: "updateJob";
+  } | {
+    /**
+     * @generated from field: livekit.WorkerPing ping = 5;
+     */
+    value: WorkerPing;
+    case: "ping";
+  } | {
+    /**
+     * @generated from field: livekit.SimulateJobRequest simulate_job = 6;
+     */
+    value: SimulateJobRequest;
+    case: "simulateJob";
   } | {
     /**
-     * @generated from field: livekit.JobStatusUpdate job_update = 4;
+     * @generated from field: livekit.MigrateJobRequest migrate_job = 7;
      */
-    value: JobStatusUpdate;
-    case: "jobUpdate";
+    value: MigrateJobRequest;
+    case: "migrateJob";
   } | { case: undefined; value?: undefined };
 
   constructor(data?: PartialMessage<WorkerMessage>);
@@ -231,6 +305,12 @@ export declare class ServerMessage extends Message<ServerMessage> {
      */
     value: JobAssignment;
     case: "assignment";
+  } | {
+    /**
+     * @generated from field: livekit.WorkerPong pong = 4;
+     */
+    value: WorkerPong;
+    case: "pong";
   } | { case: undefined; value?: undefined };
 
   constructor(data?: PartialMessage<ServerMessage>);
@@ -249,20 +329,104 @@ export declare class ServerMessage extends Message<ServerMessage> {
 }
 
 /**
- * @generated from message livekit.RegisterWorkerRequest
+ * @generated from message livekit.SimulateJobRequest
  */
-export declare class RegisterWorkerRequest extends Message<RegisterWorkerRequest> {
+export declare class SimulateJobRequest extends Message<SimulateJobRequest> {
   /**
    * @generated from field: livekit.JobType type = 1;
    */
   type: JobType;
 
   /**
-   * @generated from field: string worker_id = 2;
+   * @generated from field: livekit.Room room = 2;
    */
-  workerId: string;
+  room?: Room;
+
+  /**
+   * @generated from field: livekit.ParticipantInfo participant = 3;
+   */
+  participant?: ParticipantInfo;
+
+  constructor(data?: PartialMessage<SimulateJobRequest>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.SimulateJobRequest";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): SimulateJobRequest;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): SimulateJobRequest;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): SimulateJobRequest;
+
+  static equals(a: SimulateJobRequest | PlainMessage<SimulateJobRequest> | undefined, b: SimulateJobRequest | PlainMessage<SimulateJobRequest> | undefined): boolean;
+}
+
+/**
+ * @generated from message livekit.WorkerPing
+ */
+export declare class WorkerPing extends Message<WorkerPing> {
+  /**
+   * @generated from field: int64 timestamp = 1;
+   */
+  timestamp: bigint;
+
+  constructor(data?: PartialMessage<WorkerPing>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.WorkerPing";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): WorkerPing;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): WorkerPing;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): WorkerPing;
+
+  static equals(a: WorkerPing | PlainMessage<WorkerPing> | undefined, b: WorkerPing | PlainMessage<WorkerPing> | undefined): boolean;
+}
+
+/**
+ * @generated from message livekit.WorkerPong
+ */
+export declare class WorkerPong extends Message<WorkerPong> {
+  /**
+   * @generated from field: int64 last_timestamp = 1;
+   */
+  lastTimestamp: bigint;
+
+  /**
+   * @generated from field: int64 timestamp = 2;
+   */
+  timestamp: bigint;
+
+  constructor(data?: PartialMessage<WorkerPong>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.WorkerPong";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): WorkerPong;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): WorkerPong;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): WorkerPong;
+
+  static equals(a: WorkerPong | PlainMessage<WorkerPong> | undefined, b: WorkerPong | PlainMessage<WorkerPong> | undefined): boolean;
+}
 
+/**
+ * @generated from message livekit.RegisterWorkerRequest
+ */
+export declare class RegisterWorkerRequest extends Message<RegisterWorkerRequest> {
   /**
+   * @generated from field: livekit.JobType type = 1;
+   */
+  type: JobType;
+
+  /**
+   * string worker_id = 2;
+   *
    * @generated from field: string version = 3;
    */
   version: string;
@@ -272,6 +436,21 @@ export declare class RegisterWorkerRequest extends Message<RegisterWorkerRequest
    */
   name: string;
 
+  /**
+   * @generated from field: uint32 ping_interval = 5;
+   */
+  pingInterval: number;
+
+  /**
+   * @generated from field: optional string namespace = 6;
+   */
+  namespace?: string;
+
+  /**
+   * @generated from field: livekit.ParticipantPermission allowed_permissions = 7;
+   */
+  allowedPermissions?: ParticipantPermission;
+
   constructor(data?: PartialMessage<RegisterWorkerRequest>);
 
   static readonly runtime: typeof proto3;
@@ -297,9 +476,9 @@ export declare class RegisterWorkerResponse extends Message<RegisterWorkerRespon
   workerId: string;
 
   /**
-   * @generated from field: string server_version = 2;
+   * @generated from field: livekit.ServerInfo server_info = 3;
    */
-  serverVersion: string;
+  serverInfo?: ServerInfo;
 
   constructor(data?: PartialMessage<RegisterWorkerResponse>);
 
@@ -316,6 +495,30 @@ export declare class RegisterWorkerResponse extends Message<RegisterWorkerRespon
   static equals(a: RegisterWorkerResponse | PlainMessage<RegisterWorkerResponse> | undefined, b: RegisterWorkerResponse | PlainMessage<RegisterWorkerResponse> | undefined): boolean;
 }
 
+/**
+ * @generated from message livekit.MigrateJobRequest
+ */
+export declare class MigrateJobRequest extends Message<MigrateJobRequest> {
+  /**
+   * @generated from field: string job_id = 1;
+   */
+  jobId: string;
+
+  constructor(data?: PartialMessage<MigrateJobRequest>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.MigrateJobRequest";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): MigrateJobRequest;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): MigrateJobRequest;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): MigrateJobRequest;
+
+  static equals(a: MigrateJobRequest | PlainMessage<MigrateJobRequest> | undefined, b: MigrateJobRequest | PlainMessage<MigrateJobRequest> | undefined): boolean;
+}
+
 /**
  * @generated from message livekit.AvailabilityRequest
  */
@@ -325,6 +528,14 @@ export declare class AvailabilityRequest extends Message<AvailabilityRequest> {
    */
   job?: Job;
 
+  /**
+   * True when the job was previously assigned to another worker but has been 
+   * migrated due to different reasons (e.g. worker failure, job migration)
+   *
+   * @generated from field: bool resuming = 2;
+   */
+  resuming: boolean;
+
   constructor(data?: PartialMessage<AvailabilityRequest>);
 
   static readonly runtime: typeof proto3;
@@ -354,6 +565,26 @@ export declare class AvailabilityResponse extends Message<AvailabilityResponse>
    */
   available: boolean;
 
+  /**
+   * @generated from field: bool supports_resume = 3;
+   */
+  supportsResume: boolean;
+
+  /**
+   * @generated from field: string participant_name = 4;
+   */
+  participantName: string;
+
+  /**
+   * @generated from field: string participant_identity = 5;
+   */
+  participantIdentity: string;
+
+  /**
+   * @generated from field: string participant_metadata = 6;
+   */
+  participantMetadata: string;
+
   constructor(data?: PartialMessage<AvailabilityResponse>);
 
   static readonly runtime: typeof proto3;
@@ -370,89 +601,122 @@ export declare class AvailabilityResponse extends Message<AvailabilityResponse>
 }
 
 /**
- * @generated from message livekit.JobStatusUpdate
+ * @generated from message livekit.UpdateJobStatus
  */
-export declare class JobStatusUpdate extends Message<JobStatusUpdate> {
+export declare class UpdateJobStatus extends Message<UpdateJobStatus> {
   /**
    * @generated from field: string job_id = 1;
    */
   jobId: string;
 
   /**
-   * @generated from field: livekit.JobStatus status = 2;
+   * The worker can indicate the job end by either specifying SUCCESS or FAILED
+   *
+   * @generated from field: optional livekit.JobStatus status = 2;
    */
-  status: JobStatus;
+  status?: JobStatus;
 
   /**
+   * metadata shown on the dashboard, useful for debugging
+   *
    * @generated from field: string error = 3;
    */
   error: string;
 
   /**
-   * @generated from field: string user_data = 4;
+   * the metadata can be updated multiple times
+   *
+   * @generated from field: optional string metadata = 4;
+   */
+  metadata?: string;
+
+  /**
+   * The load that the job currently has on the worker
+   *
+   * @generated from field: float load = 5;
    */
-  userData: string;
+  load: number;
 
-  constructor(data?: PartialMessage<JobStatusUpdate>);
+  constructor(data?: PartialMessage<UpdateJobStatus>);
 
   static readonly runtime: typeof proto3;
-  static readonly typeName = "livekit.JobStatusUpdate";
+  static readonly typeName = "livekit.UpdateJobStatus";
   static readonly fields: FieldList;
 
-  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): JobStatusUpdate;
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): UpdateJobStatus;
 
-  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): JobStatusUpdate;
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): UpdateJobStatus;
 
-  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): JobStatusUpdate;
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): UpdateJobStatus;
 
-  static equals(a: JobStatusUpdate | PlainMessage<JobStatusUpdate> | undefined, b: JobStatusUpdate | PlainMessage<JobStatusUpdate> | undefined): boolean;
+  static equals(a: UpdateJobStatus | PlainMessage<UpdateJobStatus> | undefined, b: UpdateJobStatus | PlainMessage<UpdateJobStatus> | undefined): boolean;
 }
 
 /**
- * @generated from message livekit.JobAssignment
+ * @generated from message livekit.UpdateWorkerStatus
  */
-export declare class JobAssignment extends Message<JobAssignment> {
+export declare class UpdateWorkerStatus extends Message<UpdateWorkerStatus> {
   /**
-   * @generated from field: livekit.Job job = 1;
+   * @generated from field: optional livekit.WorkerStatus status = 1;
    */
-  job?: Job;
+  status?: WorkerStatus;
 
-  constructor(data?: PartialMessage<JobAssignment>);
+  /**
+   * @generated from field: optional string metadata = 2;
+   */
+  metadata?: string;
+
+  /**
+   * @generated from field: float load = 3;
+   */
+  load: number;
+
+  constructor(data?: PartialMessage<UpdateWorkerStatus>);
 
   static readonly runtime: typeof proto3;
-  static readonly typeName = "livekit.JobAssignment";
+  static readonly typeName = "livekit.UpdateWorkerStatus";
   static readonly fields: FieldList;
 
-  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): JobAssignment;
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): UpdateWorkerStatus;
 
-  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): JobAssignment;
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): UpdateWorkerStatus;
 
-  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): JobAssignment;
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): UpdateWorkerStatus;
 
-  static equals(a: JobAssignment | PlainMessage<JobAssignment> | undefined, b: JobAssignment | PlainMessage<JobAssignment> | undefined): boolean;
+  static equals(a: UpdateWorkerStatus | PlainMessage<UpdateWorkerStatus> | undefined, b: UpdateWorkerStatus | PlainMessage<UpdateWorkerStatus> | undefined): boolean;
 }
 
 /**
- * @generated from message livekit.UpdateWorkerStatus
+ * @generated from message livekit.JobAssignment
  */
-export declare class UpdateWorkerStatus extends Message<UpdateWorkerStatus> {
+export declare class JobAssignment extends Message<JobAssignment> {
   /**
-   * @generated from field: livekit.WorkerStatus status = 1;
+   * @generated from field: livekit.Job job = 1;
    */
-  status: WorkerStatus;
+  job?: Job;
 
-  constructor(data?: PartialMessage<UpdateWorkerStatus>);
+  /**
+   * @generated from field: optional string url = 2;
+   */
+  url?: string;
+
+  /**
+   * @generated from field: string token = 3;
+   */
+  token: string;
+
+  constructor(data?: PartialMessage<JobAssignment>);
 
   static readonly runtime: typeof proto3;
-  static readonly typeName = "livekit.UpdateWorkerStatus";
+  static readonly typeName = "livekit.JobAssignment";
   static readonly fields: FieldList;
 
-  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): UpdateWorkerStatus;
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): JobAssignment;
 
-  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): UpdateWorkerStatus;
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): JobAssignment;
 
-  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): UpdateWorkerStatus;
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): JobAssignment;
 
-  static equals(a: UpdateWorkerStatus | PlainMessage<UpdateWorkerStatus> | undefined, b: UpdateWorkerStatus | PlainMessage<UpdateWorkerStatus> | undefined): boolean;
+  static equals(a: JobAssignment | PlainMessage<JobAssignment> | undefined, b: JobAssignment | PlainMessage<JobAssignment> | undefined): boolean;
 }