plugin: add instance lifecycle surface

2026-06-20 23:15:47 +09:00
parent 5ec8bae983
commit 147a600577
12 changed files with 1399 additions and 34 deletions
@@ -0,0 +1,12 @@
+[package]
+name = "example-yoi-instance-plugin"
+version = "0.1.0"
+edition = "2024"
+
+[lib]
+crate-type = ["cdylib"]
+
+[dependencies]
+yoi-plugin-pdk = { path = "../../../../crates/plugin-pdk" }
+serde = { version = "1", features = ["derive"] }
+serde_json = "1"
@@ -0,0 +1,9 @@
+# Yoi instance Plugin template
+
+This template targets `yoi:plugin/instance@1.0.0`. The host creates one
+`PluginInstance` for the package; Tool, Service, and Ingress surfaces share that
+instance state while each surface keeps separate permissions/grants.
+
+Tools still run only through ordinary model/user-initiated Tool calls. Ingress
+handlers receive bounded typed untrusted events and must return explicit JSON
+for host-mediated visible/durable paths.
@@ -0,0 +1,3 @@
+# Build with:
+# cargo component build --release
+# cp target/wasm32-wasip1/release/example_yoi_instance_plugin.wasm plugin.component.wasm
@@ -0,0 +1,35 @@
+schema_version = 1
+id = "example.rust_instance_plugin"
+name = "Rust Instance Plugin Template"
+version = "0.1.0"
+description = "Example instance-oriented Yoi Plugin with shared Tool/Ingress state."
+surfaces = ["tool", "service", "ingress"]
+permissions = [
+  { kind = "surface", surface = "tool" },
+  { kind = "tool", name = "example_instance_tool" },
+  { kind = "surface", surface = "service" },
+  { kind = "service", name = "example_instance_service" },
+  { kind = "surface", surface = "ingress" },
+  { kind = "ingress", name = "example_instance_ingress" },
+]
+
+[runtime]
+kind = "wasm-component"
+world = "yoi:plugin/instance@1.0.0"
+component = "plugin.component.wasm"
+
+[[tools]]
+name = "example_instance_tool"
+description = "Return the input and increment shared instance state."
+input_schema = { type = "object" }
+
+[[services]]
+name = "example_instance_service"
+description = "Reports shared plugin instance lifecycle status."
+lifecycle = "host-managed"
+
+[[ingresses]]
+name = "example_instance_ingress"
+description = "Accepts bounded in-process ingress events."
+event_kinds = ["example"]
+input_schema = { type = "object" }
@@ -0,0 +1,37 @@
+use serde_json::{json, Value};
+use yoi_plugin_pdk::{export_plugin_instance, Plugin, PluginIngressEvent, PluginStatus, ToolOutput};
+
+struct ExamplePlugin {
+    calls: u64,
+}
+
+impl Plugin for ExamplePlugin {
+    fn start(_config: Value) -> yoi_plugin_pdk::Result<Self> {
+        Ok(Self { calls: 0 })
+    }
+
+    fn handle_tool(&mut self, name: &str, input: Value) -> yoi_plugin_pdk::Result<ToolOutput> {
+        self.calls += 1;
+        Ok(ToolOutput::text(json!({
+            "tool": name,
+            "calls": self.calls,
+            "input": input
+        }).to_string()))
+    }
+
+    fn handle_ingress(&mut self, name: &str, event: PluginIngressEvent) -> yoi_plugin_pdk::Result<Value> {
+        Ok(json!({
+            "ingress": name,
+            "kind": event.kind,
+            "source": event.source,
+            "calls": self.calls,
+            "accepted": true
+        }))
+    }
+
+    fn status(&self) -> yoi_plugin_pdk::Result<PluginStatus> {
+        Ok(PluginStatus::ready(json!({ "calls": self.calls })))
+    }
+}
+
+export_plugin_instance!(ExamplePlugin);
@@ -0,0 +1,12 @@
+package yoi:plugin@1.0.0;
+
+world instance {
+  import yoi:host/https@1.0.0;
+  import yoi:host/fs@1.0.0;
+
+  export start: func(config-json: string) -> string;
+  export handle-tool: func(name: string, input-json: string) -> string;
+  export handle-ingress: func(name: string, event-json: string) -> string;
+  export status: func() -> string;
+  export stop: func() -> string;
+}