chore: rename fai-studio-plugin-sdk → fai-plugin-sdk

Adopts the three SDK families convention documented in
fai/platform/docs/architecture/sdks.md: each base SDK
(module, plugin, client) gets a language suffix on dir + repo
so polyglot variants can be added later without renaming.

  fai_studio_plugin_sdk  → fai_plugin_sdk_rust
  fai-studio-plugin-sdk  → fai-plugin-sdk
  fai/studio-plugin-sdk  → fai/plugin-sdk-rust

Signed-off-by: flemming-it <sf@flemming.it>
This commit is contained in:
flemming-it 2026-05-26 00:59:48 +02:00
parent 3753c6bc37
commit 25353adb43
3 changed files with 36 additions and 20 deletions

View file

@ -1,6 +1,16 @@
# fai-studio-plugin-sdk
# fai-plugin-sdk (Rust)
Rust SDK for writing F∆I Studio plugins.
Rust SDK for writing F∆I plugins (Studio extensions). One of
three SDK families documented in
`fai/platform/docs/architecture/sdks.md`:
* `fai-module-sdk` (Rust) — building flow modules
* `fai-plugin-sdk` (Rust) — building plugins ← this crate
* `fai-client-sdk` (Dart) — building hub-talking clients
Each gets a language-suffix on its dir/repo so polyglot
variants can be added later without renaming the existing
ones (e.g. a future `fai-plugin-sdk-go`).
## Status
@ -8,14 +18,14 @@ Rust SDK for writing F∆I Studio plugins.
world declared in `wit/studio-plugin.wit` can be compiled to
`wasm32-wasip2` against this crate today. The proof-of-
contract plugin is `studio-theme-solarized` in the
fai-modules namespace.
fai-plugins namespace.
What's NOT yet implemented:
- **Hub side**: a Component-Model loader path for
`studio-plugin`-world components + the `InvokePlugin`
gRPC RPC that Studio talks to. Tracked in
`fai/platform/docs/advanced/studio-plugin-sdk.md`.
`fai/platform/docs/advanced/plugin-sdk.md`.
- **Studio side**: `plugin_host.dart` that discovers
installed `studio.*` capabilities and dispatches.
- **Per-hook worlds**: today's v0.1 ships a single world
@ -43,12 +53,12 @@ edition = "2021" # match SDK edition
crate-type = ["cdylib"]
[dependencies]
fai-studio-plugin-sdk = { git = "https://git.flemming.ai/fai/studio-plugin-sdk", branch = "main" }
fai-plugin-sdk = { git = "https://git.flemming.ai/fai/plugin-sdk-rust", branch = "main" }
```
```rust
// src/lib.rs of your plugin
use fai_studio_plugin_sdk::{bindings, export_plugin};
use fai_plugin_sdk::{bindings, export_plugin};
type ColorScheme = bindings::fai::studio_plugin::plugin_types::ColorScheme;
type PluginError = bindings::fai::studio_plugin::plugin_types::PluginError;