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,4 +1,4 @@
# fai-studio-plugin-sdk
# fai-plugin-sdk
#
# Ergonomic wrapper around the WIT bindings declared in
# `wit/studio-plugin.wit`. Studio plugins depend on this crate
@ -8,27 +8,33 @@
# provides. The macro lands in v0.2 once the contract is
# stable enough.
#
# Naming: this is the Rust SDK for building plugins. Sister
# crates per the SDK-family convention in
# `docs/architecture/sdks.md`:
# - fai-module-sdk (Rust) — flow modules
# - fai-plugin-sdk (Rust) — Studio plugins ← this crate
# - fai-client-sdk (Dart) — clients talking to the hub
# Each gets a language-suffix on the dir / repo
# (fai_plugin_sdk_rust / git.flemming.ai/fai/plugin-sdk-rust)
# so polyglot variants can be added later without renaming.
#
# Build a plugin:
#
# cargo build --release --target wasm32-wasip2
#
# Use:
#
# use fai_studio_plugin_sdk::{export_plugin, theme, ColorScheme,
# PluginError};
# use fai_plugin_sdk::{export_plugin, bindings};
#
# struct MyTheme;
# impl theme::Guest for MyTheme {
# fn theme_for(brightness: String)
# -> Result<ColorScheme, PluginError> {
# ...
# }
# impl bindings::exports::fai::studio_plugin::theme::Guest for MyTheme {
# fn theme_for(brightness: String) -> Result<_, _> { ... }
# }
#
# export_plugin!(MyTheme with_types_in fai_studio_plugin_sdk::bindings);
# export_plugin!(MyTheme);
[package]
name = "fai-studio-plugin-sdk"
name = "fai-plugin-sdk"
version = "0.1.0"
# edition 2021 for now — wit-bindgen 0.36 emits the older
# `#[link_section]` / `unsafe`-attribute syntax that the
@ -39,8 +45,8 @@ edition = "2021"
authors = ["Dr. Stefan Flemming <platform@flemming.ai>"]
license = "Apache-2.0"
publish = false
description = "F∆I Studio Plugin SDK — Rust wrapper for the studio-plugin WIT"
repository = "https://git.flemming.ai/fai/studio-plugin-sdk"
description = "F∆I Plugin SDK (Rust) — wrapper for the studio-plugin WIT"
repository = "https://git.flemming.ai/fai/plugin-sdk-rust"
rust-version = "1.85"
[lib]