Support rich output types (#74)

* Bump rust deps * Support data field in API * Support data field in JS and Python SDKs * Address comments
jamsocket · Jan 29, 2025 · 7f1a7b2 · 7f1a7b2
1 parent 0bacdab
commit 7f1a7b2
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 10 deletions.
diff --git a/javascript/sdk/src/types.ts b/javascript/sdk/src/types.ts
@@ -35,6 +35,7 @@ export interface ApiExecResponse {
 
 export interface ExecResponse {
   value?: string | null
+  data?: { [key: string]: unknown }
   error?: string
   runtime_ms: number
 }

diff --git a/python/sdk/forevervm_sdk/types.py b/python/sdk/forevervm_sdk/types.py
@@ -1,4 +1,4 @@
-from typing import List, Literal, Optional, TypedDict
+from typing import Any, Dict, List, Literal, Optional, TypedDict
 
 
 class WhoamiResponse(TypedDict):
@@ -27,6 +27,7 @@ class ExecResultBase(TypedDict):
 
 class ExecResultValue(ExecResultBase):
     value: Optional[str]
+    data: Optional[Dict[str, Any]]
 
 
 class ExecResultError(ExecResultBase):

diff --git a/rust/Cargo.lock b/rust/Cargo.lock
diff --git a/rust/forevervm-sdk/src/api/api_types.rs b/rust/forevervm-sdk/src/api/api_types.rs
@@ -60,11 +60,13 @@ impl Instruction {
 }
 
 #[derive(Debug, Serialize, Deserialize, PartialEq, Clone)]
+#[serde(untagged, rename_all = "snake_case")]
 pub enum ExecResultType {
-    #[serde(rename = "value")]
-    Value(Option<String>),
+    Value {
+        value: Option<String>,
+        data: Option<serde_json::Value>,
+    },
 
-    #[serde(rename = "error")]
     Error(String),
 }
 

diff --git a/rust/forevervm-sdk/tests/basic_sdk_tests.rs b/rust/forevervm-sdk/tests/basic_sdk_tests.rs
@@ -77,7 +77,10 @@ async fn test_exec() {
 
     assert_eq!(
         exec_result.result.result,
-        ExecResultType::Value(Some("567".to_string()))
+        ExecResultType::Value {
+            value: Some("567".to_string()),
+            data: None
+        }
     );
 }
 

diff --git a/rust/forevervm/src/commands/repl.rs b/rust/forevervm/src/commands/repl.rs
@@ -37,10 +37,16 @@ pub async fn machine_repl(machine_name: Option<MachineName>) -> anyhow::Result<(
                                 ExecResultType::Error(err) => {
                                     eprintln!("Error: {}", err);
                                 }
-                                ExecResultType::Value(Some(data)) => {
-                                    println!("{}", data);
+                                ExecResultType::Value {
+                                    value: Some(value),
+                                    data: _,
+                                } => {
+                                    println!("{}", value);
                                 }
-                                ExecResultType::Value(None) => {}
+                                ExecResultType::Value {
+                                    value: None,
+                                    data: _,
+                                } => {}
                             },
                             Err(err) => {
                                 eprintln!("Error: {}", err);