@livekit/protocol 1.43.4 → 1.44.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@livekit/protocol",
-  "version": "1.43.4",
+  "version": "1.44.1",
   "description": "",
   "type": "module",
   "require": "dist/index.cjs",
@@ -34,6 +34,9 @@
   "dependencies": {
     "@bufbuild/protobuf": "^1.10.0"
   },
+  "repository": {
+    "url": "https://github.com/livekit/protocol"
+  },
   "scripts": {
     "generate:proto": "mkdir -p src/gen && protoc --es_out src/gen --es_opt target=dts+js -I=../../protobufs ../../protobufs/livekit_*.proto ../../protobufs/agent/livekit_*.proto",
     "generate:version": "genversion --esm --semi src/gen/version.js",

package/src/gen/agent/livekit_agent_text_pb.d.ts

@@ -0,0 +1,281 @@
+// Copyright 2023 LiveKit, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// @generated by protoc-gen-es v1.10.1 with parameter "target=dts+js"
+// @generated from file agent/livekit_agent_text.proto (package livekit.agent, 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 { AgentHandoff, ChatMessage, FunctionCall, FunctionCallOutput } from "./livekit_agent_session_pb.js";
+
+/**
+ * @generated from enum livekit.agent.TextMessageErrorCode
+ */
+export declare enum TextMessageErrorCode {
+  /**
+   * Unexpected internal error
+   *
+   * @generated from enum value: INTERNAL_ERROR = 0;
+   */
+  INTERNAL_ERROR = 0,
+
+  /**
+   * Session state not found in cache or version mismatch
+   *
+   * @generated from enum value: SESSION_STATE_NOT_FOUND = 1;
+   */
+  SESSION_STATE_NOT_FOUND = 1,
+
+  /**
+   * An exception was raised inside the user's text handler
+   *
+   * @generated from enum value: TEXT_HANDLER_ERROR = 2;
+   */
+  TEXT_HANDLER_ERROR = 2,
+
+  /**
+   * The worker process exited before the text session completed
+   *
+   * @generated from enum value: PROCESS_CLOSED = 3;
+   */
+  PROCESS_CLOSED = 3,
+}
+
+/**
+ * Request to send a text message to an agent.
+ *
+ * @generated from message livekit.agent.TextMessageRequest
+ */
+export declare class TextMessageRequest extends Message<TextMessageRequest> {
+  /**
+   * @generated from field: string text = 1;
+   */
+  text: string;
+
+  /**
+   * @generated from field: string message_id = 2;
+   */
+  messageId: string;
+
+  /**
+   * @generated from field: string session_id = 3;
+   */
+  sessionId: string;
+
+  /**
+   * @generated from field: string agent_name = 4;
+   */
+  agentName: string;
+
+  /**
+   * @generated from field: string metadata = 5;
+   */
+  metadata: string;
+
+  /**
+   * @generated from field: optional livekit.agent.AgentSessionState session_state = 6;
+   */
+  sessionState?: AgentSessionState;
+
+  constructor(data?: PartialMessage<TextMessageRequest>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.agent.TextMessageRequest";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): TextMessageRequest;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): TextMessageRequest;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): TextMessageRequest;
+
+  static equals(a: TextMessageRequest | PlainMessage<TextMessageRequest> | undefined, b: TextMessageRequest | PlainMessage<TextMessageRequest> | undefined): boolean;
+}
+
+/**
+ * Response to a text message request, multiple responses may be sent for a single request until it is complete.
+ *
+ * @generated from message livekit.agent.TextMessageResponse
+ */
+export declare class TextMessageResponse extends Message<TextMessageResponse> {
+  /**
+   * @generated from field: string message_id = 1;
+   */
+  messageId: string;
+
+  /**
+   * @generated from field: string session_id = 2;
+   */
+  sessionId: string;
+
+  /**
+   * @generated from oneof livekit.agent.TextMessageResponse.event
+   */
+  event: {
+    /**
+     * @generated from field: livekit.agent.ChatMessage message = 3;
+     */
+    value: ChatMessage;
+    case: "message";
+  } | {
+    /**
+     * @generated from field: livekit.agent.FunctionCall function_call = 4;
+     */
+    value: FunctionCall;
+    case: "functionCall";
+  } | {
+    /**
+     * @generated from field: livekit.agent.FunctionCallOutput function_call_output = 5;
+     */
+    value: FunctionCallOutput;
+    case: "functionCallOutput";
+  } | {
+    /**
+     * @generated from field: livekit.agent.AgentHandoff agent_handoff = 6;
+     */
+    value: AgentHandoff;
+    case: "agentHandoff";
+  } | {
+    /**
+     * @generated from field: livekit.agent.TextMessageComplete complete = 7;
+     */
+    value: TextMessageComplete;
+    case: "complete";
+  } | { case: undefined; value?: undefined };
+
+  constructor(data?: PartialMessage<TextMessageResponse>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.agent.TextMessageResponse";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): TextMessageResponse;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): TextMessageResponse;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): TextMessageResponse;
+
+  static equals(a: TextMessageResponse | PlainMessage<TextMessageResponse> | undefined, b: TextMessageResponse | PlainMessage<TextMessageResponse> | undefined): boolean;
+}
+
+/**
+ * Indicates the text message session is complete.
+ *
+ * @generated from message livekit.agent.TextMessageComplete
+ */
+export declare class TextMessageComplete extends Message<TextMessageComplete> {
+  /**
+   * @generated from oneof livekit.agent.TextMessageComplete.result
+   */
+  result: {
+    /**
+     * @generated from field: livekit.agent.AgentSessionState session_state = 1;
+     */
+    value: AgentSessionState;
+    case: "sessionState";
+  } | {
+    /**
+     * @generated from field: livekit.agent.TextMessageError error = 2;
+     */
+    value: TextMessageError;
+    case: "error";
+  } | { case: undefined; value?: undefined };
+
+  constructor(data?: PartialMessage<TextMessageComplete>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.agent.TextMessageComplete";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): TextMessageComplete;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): TextMessageComplete;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): TextMessageComplete;
+
+  static equals(a: TextMessageComplete | PlainMessage<TextMessageComplete> | undefined, b: TextMessageComplete | PlainMessage<TextMessageComplete> | undefined): boolean;
+}
+
+/**
+ * @generated from message livekit.agent.AgentSessionState
+ */
+export declare class AgentSessionState extends Message<AgentSessionState> {
+  /**
+   * @generated from field: uint64 version = 1;
+   */
+  version: bigint;
+
+  /**
+   * @generated from oneof livekit.agent.AgentSessionState.data
+   */
+  data: {
+    /**
+     * @generated from field: bytes snapshot = 2;
+     */
+    value: Uint8Array;
+    case: "snapshot";
+  } | {
+    /**
+     * @generated from field: bytes delta = 3;
+     */
+    value: Uint8Array;
+    case: "delta";
+  } | { case: undefined; value?: undefined };
+
+  constructor(data?: PartialMessage<AgentSessionState>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.agent.AgentSessionState";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): AgentSessionState;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): AgentSessionState;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): AgentSessionState;
+
+  static equals(a: AgentSessionState | PlainMessage<AgentSessionState> | undefined, b: AgentSessionState | PlainMessage<AgentSessionState> | undefined): boolean;
+}
+
+/**
+ * @generated from message livekit.agent.TextMessageError
+ */
+export declare class TextMessageError extends Message<TextMessageError> {
+  /**
+   * @generated from field: string message = 1;
+   */
+  message: string;
+
+  /**
+   * @generated from field: livekit.agent.TextMessageErrorCode code = 2;
+   */
+  code: TextMessageErrorCode;
+
+  constructor(data?: PartialMessage<TextMessageError>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.agent.TextMessageError";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): TextMessageError;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): TextMessageError;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): TextMessageError;
+
+  static equals(a: TextMessageError | PlainMessage<TextMessageError> | undefined, b: TextMessageError | PlainMessage<TextMessageError> | undefined): boolean;
+}
+

package/src/gen/agent/livekit_agent_text_pb.js

@@ -0,0 +1,106 @@
+// Copyright 2023 LiveKit, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// @generated by protoc-gen-es v1.10.1 with parameter "target=dts+js"
+// @generated from file agent/livekit_agent_text.proto (package livekit.agent, syntax proto3)
+/* eslint-disable */
+// @ts-nocheck
+
+import { proto3 } from "@bufbuild/protobuf";
+import { AgentHandoff, ChatMessage, FunctionCall, FunctionCallOutput } from "./livekit_agent_session_pb.js";
+
+/**
+ * @generated from enum livekit.agent.TextMessageErrorCode
+ */
+export const TextMessageErrorCode = /*@__PURE__*/ proto3.makeEnum(
+  "livekit.agent.TextMessageErrorCode",
+  [
+    {no: 0, name: "INTERNAL_ERROR"},
+    {no: 1, name: "SESSION_STATE_NOT_FOUND"},
+    {no: 2, name: "TEXT_HANDLER_ERROR"},
+    {no: 3, name: "PROCESS_CLOSED"},
+  ],
+);
+
+/**
+ * Request to send a text message to an agent.
+ *
+ * @generated from message livekit.agent.TextMessageRequest
+ */
+export const TextMessageRequest = /*@__PURE__*/ proto3.makeMessageType(
+  "livekit.agent.TextMessageRequest",
+  () => [
+    { no: 1, name: "text", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 2, name: "message_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 3, name: "session_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 4, name: "agent_name", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 5, name: "metadata", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 6, name: "session_state", kind: "message", T: AgentSessionState, opt: true },
+  ],
+);
+
+/**
+ * Response to a text message request, multiple responses may be sent for a single request until it is complete.
+ *
+ * @generated from message livekit.agent.TextMessageResponse
+ */
+export const TextMessageResponse = /*@__PURE__*/ proto3.makeMessageType(
+  "livekit.agent.TextMessageResponse",
+  () => [
+    { no: 1, name: "message_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 2, name: "session_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 3, name: "message", kind: "message", T: ChatMessage, oneof: "event" },
+    { no: 4, name: "function_call", kind: "message", T: FunctionCall, oneof: "event" },
+    { no: 5, name: "function_call_output", kind: "message", T: FunctionCallOutput, oneof: "event" },
+    { no: 6, name: "agent_handoff", kind: "message", T: AgentHandoff, oneof: "event" },
+    { no: 7, name: "complete", kind: "message", T: TextMessageComplete, oneof: "event" },
+  ],
+);
+
+/**
+ * Indicates the text message session is complete.
+ *
+ * @generated from message livekit.agent.TextMessageComplete
+ */
+export const TextMessageComplete = /*@__PURE__*/ proto3.makeMessageType(
+  "livekit.agent.TextMessageComplete",
+  () => [
+    { no: 1, name: "session_state", kind: "message", T: AgentSessionState, oneof: "result" },
+    { no: 2, name: "error", kind: "message", T: TextMessageError, oneof: "result" },
+  ],
+);
+
+/**
+ * @generated from message livekit.agent.AgentSessionState
+ */
+export const AgentSessionState = /*@__PURE__*/ proto3.makeMessageType(
+  "livekit.agent.AgentSessionState",
+  () => [
+    { no: 1, name: "version", kind: "scalar", T: 4 /* ScalarType.UINT64 */ },
+    { no: 2, name: "snapshot", kind: "scalar", T: 12 /* ScalarType.BYTES */, oneof: "data" },
+    { no: 3, name: "delta", kind: "scalar", T: 12 /* ScalarType.BYTES */, oneof: "data" },
+  ],
+);
+
+/**
+ * @generated from message livekit.agent.TextMessageError
+ */
+export const TextMessageError = /*@__PURE__*/ proto3.makeMessageType(
+  "livekit.agent.TextMessageError",
+  () => [
+    { no: 1, name: "message", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 2, name: "code", kind: "enum", T: proto3.getEnumType(TextMessageErrorCode) },
+  ],
+);
+

package/src/gen/livekit_agent_dispatch_pb.d.ts

@@ -219,7 +219,7 @@ export declare class AgentDispatch extends Message<AgentDispatch> {
  */
 export declare class AgentDispatchState extends Message<AgentDispatchState> {
   /**
-   * For dispatches of tyoe JT_ROOM, there will be at most 1 job. 
+   * For dispatches of tyoe JT_ROOM, there will be at most 1 job.
    * For dispatches of type JT_PUBLISHER, there will be 1 per publisher.
    *
    * @generated from field: repeated livekit.Job jobs = 1;

package/src/gen/livekit_analytics_pb.d.ts

@@ -1044,12 +1044,19 @@ export declare class FeatureUsageInfo extends Message<FeatureUsageInfo> {
   /**
    * time ranges during which the feature was enabled.
    * for e. g., noise cancellation may not be applied when a media track is paused/muted,
-   * this allows reporting only periods during which a feature is avtive.
+   * this allows reporting only periods during which a feature is active.
    *
    * @generated from field: repeated livekit.TimeRange time_ranges = 8;
    */
   timeRanges: TimeRange[];
 
+  /**
+   * Feature specific metadata included in the report
+   *
+   * @generated from field: map<string, string> feature_info = 9;
+   */
+  featureInfo: { [key: string]: string };
+
   constructor(data?: PartialMessage<FeatureUsageInfo>);
 
   static readonly runtime: typeof proto3;

package/src/gen/livekit_analytics_pb.js

@@ -309,6 +309,7 @@ export const FeatureUsageInfo = /*@__PURE__*/ proto3.makeMessageType(
     { no: 6, name: "participant_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
     { no: 7, name: "track_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
     { no: 8, name: "time_ranges", kind: "message", T: TimeRange, repeated: true },
+    { no: 9, name: "feature_info", kind: "map", K: 9 /* ScalarType.STRING */, V: {kind: "scalar", T: 9 /* ScalarType.STRING */} },
   ],
 );