@elizaos/schemas 2.0.0-alpha.10

package/eliza/v1/settings.proto

@@ -0,0 +1,44 @@
+// settings.proto - Runtime and onboarding settings for elizaOS
+syntax = "proto3";
+
+package eliza.v1;
+
+import "google/protobuf/struct.proto";
+
+// Runtime settings provided as key/value strings (typically from env).
+message RuntimeSettings {
+  map<string, string> values = 1;
+}
+
+// Definition for a configurable setting (metadata only).
+message SettingDefinition {
+  string name = 1;
+  string description = 2;
+  string usage_description = 3;
+  bool required = 4;
+  optional bool public = 5;
+  optional bool secret = 6;
+  repeated string depends_on = 7;
+}
+
+// Concrete setting value (value may be string, bool, or null).
+message Setting {
+  string name = 1;
+  string description = 2;
+  string usage_description = 3;
+  bool required = 4;
+  optional bool public = 5;
+  optional bool secret = 6;
+  repeated string depends_on = 7;
+  google.protobuf.Value value = 8;
+}
+
+// World settings configuration map.
+message WorldSettings {
+  map<string, Setting> settings = 1;
+}
+
+// Onboarding configuration with setting definitions.
+message OnboardingConfig {
+  map<string, SettingDefinition> settings = 1;
+}

package/eliza/v1/state.proto

@@ -0,0 +1,86 @@
+// state.proto - State and context types for elizaOS
+syntax = "proto3";
+
+package eliza.v1;
+
+import "eliza/v1/components.proto";
+import "eliza/v1/environment.proto";
+import "google/protobuf/struct.proto";
+
+// Single step in an action plan
+message ActionPlanStep {
+  string action = 1;
+  string status = 2;
+  optional string error = 3;
+  optional ActionResult result = 4;
+}
+
+// Multi-step action plan
+message ActionPlan {
+  string thought = 1;
+  int32 total_steps = 2;
+  int32 current_step = 3;
+  repeated ActionPlanStep steps = 4;
+  google.protobuf.Struct metadata = 5;
+}
+
+// Provider result cache entry
+message ProviderCacheEntry {
+  optional string text = 1;
+  google.protobuf.Struct values = 2;
+  google.protobuf.Struct data = 3;
+}
+
+// Working memory item for multi-step action execution
+message WorkingMemoryItem {
+  // Name of the action that created this entry
+  string action_name = 1;
+  // Result from the action execution
+  ActionResult result = 2;
+  // Timestamp when the entry was created
+  int64 timestamp = 3;
+}
+
+// Structured data cached in state by providers and actions
+message StateData {
+  // Cached room data from providers
+  optional Room room = 1;
+  // Cached world data from providers
+  optional World world = 2;
+  // Cached entity data from providers
+  optional Entity entity = 3;
+  // Provider results cache keyed by provider name
+  map<string, ProviderCacheEntry> providers = 4;
+  // Current action plan for multi-step actions
+  optional ActionPlan action_plan = 5;
+  // Results from previous action executions
+  repeated ActionResult action_results = 6;
+  // Working memory for temporary state during multi-step action execution
+  map<string, WorkingMemoryItem> working_memory = 7;
+  // Dynamic properties for plugin extensions
+  google.protobuf.Struct extra = 8;
+}
+
+// State values populated by providers
+message StateValues {
+  // Agent name
+  optional string agent_name = 1;
+  // Action names available to the agent
+  optional string action_names = 2;
+  // Provider names used
+  optional string providers = 3;
+  // Other dynamic values
+  google.protobuf.Struct extra = 4;
+}
+
+// Represents the current state or context of a conversation or agent interaction
+message State {
+  // Key-value store for state variables populated by providers
+  StateValues values = 1;
+  // Structured data cache with typed properties
+  StateData data = 2;
+  // String representation of the current context
+  string text = 3;
+  // Dynamic properties for template expansion
+  google.protobuf.Struct extra = 4;
+}

package/eliza/v1/task.proto

@@ -0,0 +1,38 @@
+// task.proto - Task types for elizaOS
+syntax = "proto3";
+
+package eliza.v1;
+
+import "google/protobuf/struct.proto";
+
+// Task status enumeration
+enum TaskStatus {
+  TASK_STATUS_UNSPECIFIED = 0;
+  TASK_STATUS_PENDING = 1;
+  TASK_STATUS_IN_PROGRESS = 2;
+  TASK_STATUS_COMPLETED = 3;
+  TASK_STATUS_FAILED = 4;
+  TASK_STATUS_CANCELLED = 5;
+}
+
+// Task metadata
+message TaskMetadata {
+  // Custom metadata values
+  google.protobuf.Struct values = 1;
+}
+
+// Represents a task
+message Task {
+  optional string id = 1;
+  string name = 2;
+  optional string description = 3;
+  TaskStatus status = 4;
+  optional string room_id = 5;
+  optional string world_id = 6;
+  optional string entity_id = 7;
+  repeated string tags = 8;
+  optional TaskMetadata metadata = 9;
+  optional int64 created_at = 10;
+  optional int64 updated_at = 11;
+  optional int64 due_at = 12;
+}

package/eliza/v1/tee.proto

@@ -0,0 +1,64 @@
+// tee.proto - Trusted Execution Environment types for elizaOS
+syntax = "proto3";
+
+package eliza.v1;
+
+import "google/protobuf/struct.proto";
+
+// Registration details for an agent within a TEE context.
+message TeeAgent {
+  string id = 1;
+  string agent_id = 2;
+  string agent_name = 3;
+  int64 created_at = 4;
+  string public_key = 5;
+  string attestation = 6;
+}
+
+// Operational modes for a TEE.
+enum TEEMode {
+  TEE_MODE_UNSPECIFIED = 0;
+  TEE_MODE_OFF = 1;
+  TEE_MODE_LOCAL = 2;
+  TEE_MODE_DOCKER = 3;
+  TEE_MODE_PRODUCTION = 4;
+}
+
+// Quote obtained during remote attestation.
+message RemoteAttestationQuote {
+  string quote = 1;
+  int64 timestamp = 2;
+}
+
+// Data used to derive a key within a TEE.
+message DeriveKeyAttestationData {
+  string agent_id = 1;
+  string public_key = 2;
+  optional string subject = 3;
+}
+
+// Message content attested by a TEE.
+message AttestedMessage {
+  string entity_id = 1;
+  string room_id = 2;
+  string content = 3;
+}
+
+// Represents a message that has been attested by a TEE.
+message RemoteAttestationMessage {
+  string agent_id = 1;
+  int64 timestamp = 2;
+  AttestedMessage message = 3;
+}
+
+// Types or vendors of TEEs.
+enum TeeType {
+  TEE_TYPE_UNSPECIFIED = 0;
+  TEE_TYPE_TDX_DSTACK = 1;
+}
+
+// Configuration for a TEE plugin.
+message TeePluginConfig {
+  optional string vendor = 1;
+  google.protobuf.Struct vendor_config = 2;
+}

package/eliza/v1/testing.proto

@@ -0,0 +1,16 @@
+// testing.proto - Test suite metadata for elizaOS
+syntax = "proto3";
+
+package eliza.v1;
+
+// Represents a test case definition (handler is runtime-only).
+message TestCase {
+  string name = 1;
+  optional string handler_id = 2;
+}
+
+// Represents a suite of related test cases.
+message TestSuite {
+  string name = 1;
+  repeated TestCase tests = 2;
+}

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@elizaos/schemas",
+  "version": "2.0.0-alpha.10",
+  "description": "Protocol Buffer schemas for elizaOS - single source of truth for all types",
+  "files": [
+    "eliza",
+    "buf.yaml",
+    "buf.gen.yaml",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "lint": "buf lint",
+    "format": "buf format -w",
+    "breaking": "buf breaking --against '.git#branch=main'",
+    "generate": "buf generate",
+    "generate:ts": "buf generate --template buf.gen.ts.yaml",
+    "generate:py": "buf generate --template buf.gen.py.yaml",
+    "generate:rs": "buf generate --template buf.gen.rs.yaml",
+    "clean": "rm -rf ../typescript/src/types/generated ../python/elizaos/types/generated ../rust/src/types/generated",
+    "build": "npm run lint && npm run generate",
+    "test": "buf lint"
+  },
+  "devDependencies": {
+    "@bufbuild/buf": "^1.47.2"
+  }
+}