pinakes-server: add widget, theme-extension, and event plugin routes; expose allowed_endpoints in UI page DTO

Signed-off-by: NotAShelf <raf@notashelf.dev>
Change-Id: Ia7efa6db85da2d44b59e0e2e57f6e45b6a6a6964
This commit is contained in:
raf 2026-03-11 16:55:27 +03:00
commit ada1c07f66
Signed by: NotAShelf
GPG key ID: 29D95B64378DB4BF
3 changed files with 89 additions and 40 deletions

View file

@ -480,7 +480,10 @@ pub fn create_router_with_tls(
.route("/database/backup", post(routes::backup::create_backup)) .route("/database/backup", post(routes::backup::create_backup))
// Plugin management // Plugin management
.route("/plugins", get(routes::plugins::list_plugins)) .route("/plugins", get(routes::plugins::list_plugins))
.route("/plugins/events", post(routes::plugins::emit_plugin_event))
.route("/plugins/ui-pages", get(routes::plugins::list_plugin_ui_pages)) .route("/plugins/ui-pages", get(routes::plugins::list_plugin_ui_pages))
.route("/plugins/ui-widgets", get(routes::plugins::list_plugin_ui_widgets))
.route("/plugins/ui-theme-extensions", get(routes::plugins::list_plugin_ui_theme_extensions))
.route("/plugins/{id}", get(routes::plugins::get_plugin)) .route("/plugins/{id}", get(routes::plugins::get_plugin))
.route("/plugins/install", post(routes::plugins::install_plugin)) .route("/plugins/install", post(routes::plugins::install_plugin))
.route("/plugins/{id}", delete(routes::plugins::uninstall_plugin)) .route("/plugins/{id}", delete(routes::plugins::uninstall_plugin))

View file

@ -1,4 +1,4 @@
use pinakes_plugin_api::UiPage; use pinakes_plugin_api::{UiPage, UiWidget};
use serde::{Deserialize, Serialize}; use serde::{Deserialize, Serialize};
#[derive(Debug, Serialize)] #[derive(Debug, Serialize)]
@ -26,9 +26,29 @@ pub struct TogglePluginRequest {
#[derive(Debug, Serialize)] #[derive(Debug, Serialize)]
pub struct PluginUiPageEntry { pub struct PluginUiPageEntry {
/// Plugin ID that provides this page /// Plugin ID that provides this page
pub plugin_id: String, pub plugin_id: String,
/// Full page definition /// Full page definition
pub page: UiPage, pub page: UiPage,
/// Endpoint paths this plugin is allowed to fetch (empty means no
/// restriction)
pub allowed_endpoints: Vec<String>,
}
/// A single plugin UI widget entry in the list response
#[derive(Debug, Serialize)]
pub struct PluginUiWidgetEntry {
/// Plugin ID that provides this widget
pub plugin_id: String,
/// Full widget definition
pub widget: UiWidget,
}
/// Request body for emitting a plugin event
#[derive(Debug, Deserialize)]
pub struct PluginEventRequest {
pub event: String,
#[serde(default)]
pub payload: serde_json::Value,
} }
impl PluginResponse { impl PluginResponse {

View file

@ -1,28 +1,39 @@
use std::{collections::HashMap, sync::Arc};
use axum::{ use axum::{
Json, Json,
extract::{Path, State}, extract::{Path, State},
}; };
use pinakes_core::plugin::PluginManager;
use crate::{ use crate::{
dto::{ dto::{
InstallPluginRequest, InstallPluginRequest,
PluginEventRequest,
PluginResponse, PluginResponse,
PluginUiPageEntry, PluginUiPageEntry,
PluginUiWidgetEntry,
TogglePluginRequest, TogglePluginRequest,
}, },
error::ApiError, error::ApiError,
state::AppState, state::AppState,
}; };
fn require_plugin_manager(
state: &AppState,
) -> Result<Arc<PluginManager>, ApiError> {
state.plugin_manager.clone().ok_or_else(|| {
ApiError(pinakes_core::error::PinakesError::InvalidOperation(
"Plugin system is not enabled".to_string(),
))
})
}
/// List all installed plugins /// List all installed plugins
pub async fn list_plugins( pub async fn list_plugins(
State(state): State<AppState>, State(state): State<AppState>,
) -> Result<Json<Vec<PluginResponse>>, ApiError> { ) -> Result<Json<Vec<PluginResponse>>, ApiError> {
let plugin_manager = state.plugin_manager.as_ref().ok_or_else(|| { let plugin_manager = require_plugin_manager(&state)?;
ApiError(pinakes_core::error::PinakesError::InvalidOperation(
"Plugin system is not enabled".to_string(),
))
})?;
let plugins = plugin_manager.list_plugins().await; let plugins = plugin_manager.list_plugins().await;
let mut responses = Vec::with_capacity(plugins.len()); let mut responses = Vec::with_capacity(plugins.len());
@ -38,11 +49,7 @@ pub async fn get_plugin(
State(state): State<AppState>, State(state): State<AppState>,
Path(id): Path<String>, Path(id): Path<String>,
) -> Result<Json<PluginResponse>, ApiError> { ) -> Result<Json<PluginResponse>, ApiError> {
let plugin_manager = state.plugin_manager.as_ref().ok_or_else(|| { let plugin_manager = require_plugin_manager(&state)?;
ApiError(pinakes_core::error::PinakesError::InvalidOperation(
"Plugin system is not enabled".to_string(),
))
})?;
let plugin = plugin_manager.get_plugin(&id).await.ok_or_else(|| { let plugin = plugin_manager.get_plugin(&id).await.ok_or_else(|| {
ApiError(pinakes_core::error::PinakesError::NotFound(format!( ApiError(pinakes_core::error::PinakesError::NotFound(format!(
@ -59,11 +66,7 @@ pub async fn install_plugin(
State(state): State<AppState>, State(state): State<AppState>,
Json(req): Json<InstallPluginRequest>, Json(req): Json<InstallPluginRequest>,
) -> Result<Json<PluginResponse>, ApiError> { ) -> Result<Json<PluginResponse>, ApiError> {
let plugin_manager = state.plugin_manager.as_ref().ok_or_else(|| { let plugin_manager = require_plugin_manager(&state)?;
ApiError(pinakes_core::error::PinakesError::InvalidOperation(
"Plugin system is not enabled".to_string(),
))
})?;
let plugin_id = let plugin_id =
plugin_manager plugin_manager
@ -91,11 +94,7 @@ pub async fn uninstall_plugin(
State(state): State<AppState>, State(state): State<AppState>,
Path(id): Path<String>, Path(id): Path<String>,
) -> Result<Json<serde_json::Value>, ApiError> { ) -> Result<Json<serde_json::Value>, ApiError> {
let plugin_manager = state.plugin_manager.as_ref().ok_or_else(|| { let plugin_manager = require_plugin_manager(&state)?;
ApiError(pinakes_core::error::PinakesError::InvalidOperation(
"Plugin system is not enabled".to_string(),
))
})?;
plugin_manager.uninstall_plugin(&id).await.map_err(|e| { plugin_manager.uninstall_plugin(&id).await.map_err(|e| {
ApiError(pinakes_core::error::PinakesError::InvalidOperation( ApiError(pinakes_core::error::PinakesError::InvalidOperation(
@ -112,11 +111,7 @@ pub async fn toggle_plugin(
Path(id): Path<String>, Path(id): Path<String>,
Json(req): Json<TogglePluginRequest>, Json(req): Json<TogglePluginRequest>,
) -> Result<Json<serde_json::Value>, ApiError> { ) -> Result<Json<serde_json::Value>, ApiError> {
let plugin_manager = state.plugin_manager.as_ref().ok_or_else(|| { let plugin_manager = require_plugin_manager(&state)?;
ApiError(pinakes_core::error::PinakesError::InvalidOperation(
"Plugin system is not enabled".to_string(),
))
})?;
if req.enabled { if req.enabled {
plugin_manager.enable_plugin(&id).await.map_err(|e| { plugin_manager.enable_plugin(&id).await.map_err(|e| {
@ -153,30 +148,61 @@ pub async fn toggle_plugin(
pub async fn list_plugin_ui_pages( pub async fn list_plugin_ui_pages(
State(state): State<AppState>, State(state): State<AppState>,
) -> Result<Json<Vec<PluginUiPageEntry>>, ApiError> { ) -> Result<Json<Vec<PluginUiPageEntry>>, ApiError> {
let plugin_manager = state.plugin_manager.as_ref().ok_or_else(|| { let plugin_manager = require_plugin_manager(&state)?;
ApiError(pinakes_core::error::PinakesError::InvalidOperation(
"Plugin system is not enabled".to_string(),
))
})?;
let pages = plugin_manager.list_ui_pages().await; let pages = plugin_manager.list_ui_pages_with_endpoints().await;
let entries = pages let entries = pages
.into_iter() .into_iter()
.map(|(plugin_id, page)| PluginUiPageEntry { plugin_id, page }) .map(|(plugin_id, page, allowed_endpoints)| PluginUiPageEntry {
plugin_id,
page,
allowed_endpoints,
})
.collect(); .collect();
Ok(Json(entries)) Ok(Json(entries))
} }
/// List all UI widgets provided by loaded plugins
pub async fn list_plugin_ui_widgets(
State(state): State<AppState>,
) -> Result<Json<Vec<PluginUiWidgetEntry>>, ApiError> {
let plugin_manager = require_plugin_manager(&state)?;
let widgets = plugin_manager.list_ui_widgets().await;
let entries = widgets
.into_iter()
.map(|(plugin_id, widget)| PluginUiWidgetEntry { plugin_id, widget })
.collect();
Ok(Json(entries))
}
/// Receive a plugin event emitted from the UI and dispatch it to interested
/// server-side event-handler plugins via the pipeline.
pub async fn emit_plugin_event(
State(state): State<AppState>,
Json(req): Json<PluginEventRequest>,
) -> Result<Json<serde_json::Value>, ApiError> {
tracing::info!(event = %req.event, "plugin UI event received");
state.emit_plugin_event(&req.event, &req.payload);
Ok(Json(
serde_json::json!({ "received": true, "event": req.event }),
))
}
/// List merged CSS custom property overrides from all enabled plugins
pub async fn list_plugin_ui_theme_extensions(
State(state): State<AppState>,
) -> Result<Json<HashMap<String, String>>, ApiError> {
let plugin_manager = require_plugin_manager(&state)?;
Ok(Json(plugin_manager.list_ui_theme_extensions().await))
}
/// Reload a plugin (for development) /// Reload a plugin (for development)
pub async fn reload_plugin( pub async fn reload_plugin(
State(state): State<AppState>, State(state): State<AppState>,
Path(id): Path<String>, Path(id): Path<String>,
) -> Result<Json<serde_json::Value>, ApiError> { ) -> Result<Json<serde_json::Value>, ApiError> {
let plugin_manager = state.plugin_manager.as_ref().ok_or_else(|| { let plugin_manager = require_plugin_manager(&state)?;
ApiError(pinakes_core::error::PinakesError::InvalidOperation(
"Plugin system is not enabled".to_string(),
))
})?;
plugin_manager.reload_plugin(&id).await.map_err(|e| { plugin_manager.reload_plugin(&id).await.map_err(|e| {
ApiError(pinakes_core::error::PinakesError::InvalidOperation( ApiError(pinakes_core::error::PinakesError::InvalidOperation(