Snapshot: V4 plugin API and host integration

crates/ocs_plugin_api/src/ipc/protocol.rs

@@ -7,7 +7,7 @@
 
 use serde::{Deserialize, Serialize};
 
-use crate::host::CommandStep;
+use crate::host::{CommandSource, CommandStep};
 use crate::manifest::ApiVersion;
 use crate::ribbon::owned::{OwnedPluginManifest, OwnedRibbonGroup};
 
@@ -27,9 +27,14 @@ pub enum InteractiveEvent {
 /// The runner proves it was spawned by this host by presenting a pre-shared
 /// token delivered through the `OCS_PLUGIN_TOKEN` environment variable. A
 /// mismatch causes the host to close the connection.
+///
+/// `TokenV4` is appended as the last variant so the existing `Token(String)`
+/// variant keeps its bincode discriminant index (0), preserving V2/V3 wire
+/// compatibility.
 #[derive(Debug, Serialize, Deserialize)]
 pub enum RunnerHandshake {
     Token(String),
+    TokenV4 { token: String, protocol_version: u32 },
 }
 
 /// Environment variable through which the host passes the pre-shared
@@ -54,6 +59,12 @@ pub enum HostRequest {
     NeedsEntityPick {
         command_id: u64,
     },
+    ExecuteCode {
+        command_id: u64,
+        source: CommandSource,
+        code: String,
+        tab_index: usize,
+    },
     Shutdown,
 }
 
@@ -61,10 +72,11 @@ pub enum HostRequest {
 #[derive(Debug, Serialize, Deserialize)]
 pub enum HostResponse {
     Bool(bool),
-    CommandStep(CommandStep),
+    CommandStep(Box<CommandStep>),
     Text(String),
     Ribbon(Vec<OwnedRibbonGroup>),
     Manifest(OwnedPluginManifest),
+    CodeExecutionResult(crate::host::ExecutionResult),
     Error(String),
 }
 
@@ -75,6 +87,8 @@ pub enum PluginRequest {
     PushOutput(String),
     PushError(String),
     AddEntity(EntityType),
+    /// Add multiple entities in a single request.
+    AddEntities(Vec<EntityType>),
     /// Replace the existing entity carrying this entity's handle in place.
     UpdateEntity(EntityType),
     /// Delete the entity with `handle`.
@@ -105,6 +119,13 @@ pub enum PluginRequest {
     /// Ask the host to create/refresh a shared-memory document view and return
     /// the file path + current version.
     OpenDocumentView,
+    /// V4: ask the host to create/refresh a tab-keyed shared-memory document
+    /// view and return the file path + current version.
+    OpenDocumentViewV4 { tab_id: u64 },
+    /// V4: ask the host to close the tab-keyed shared-memory document view.
+    CloseDocumentViewV4 { tab_id: u64 },
+    /// V4: ask the host for the stable tab identifier of the active tab.
+    GetTabId,
 }
 
 /// Responses the host sends back for `PluginRequest`.
@@ -113,27 +134,35 @@ pub enum PluginResponse {
     Ok,
     Bool(bool),
     Handle(Handle),
+    Handles(Vec<Handle>),
     Record(Option<ExtendedDataRecord>),
-    Document(CadDocument),
+    Document(Box<CadDocument>),
     Error(String),
     /// Path to the memory-mapped file and the current snapshot version.
     DocumentView {
         path: String,
         version: u64,
     },
+    /// V4: path to the tab-keyed memory-mapped file and current version.
+    DocumentViewV4 {
+        path: String,
+        version: u64,
+    },
+    /// V4: stable tab identifier of the active tab.
+    TabId(u64),
 }
 
 /// Messages sent from the host to the plugin runner.
 #[derive(Debug, Serialize, Deserialize)]
 pub enum HostToPlugin {
     Request(HostRequest),
-    Response(PluginResponse),
+    Response(Box<PluginResponse>),
 }
 
 /// Messages sent from the plugin runner to the host.
 #[derive(Debug, Serialize, Deserialize)]
 pub enum PluginToHost {
-    Request(PluginRequest),
+    Request(Box<PluginRequest>),
     Response(HostResponse),
 }