use crate::error::FetchiumError;
use async_trait::async_trait;
#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum PluginType {
Backend,
Extractor,
Ranker,
Formatter,
Validator,
AiProvider,
}
impl std::fmt::Display for PluginType {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
PluginType::Backend => write!(f, "backend"),
PluginType::Extractor => write!(f, "extractor"),
PluginType::Ranker => write!(f, "ranker"),
PluginType::Formatter => write!(f, "formatter"),
PluginType::Validator => write!(f, "validator"),
PluginType::AiProvider => write!(f, "ai_provider"),
}
}
}
pub trait Plugin: Send + Sync {
fn name(&self) -> &str;
fn version(&self) -> &str;
fn plugin_type(&self) -> PluginType;
fn description(&self) -> &str {
""
}
fn init(&mut self, config: &serde_json::Value) -> Result<(), FetchiumError>;
fn shutdown(&mut self) -> Result<(), FetchiumError>;
}
#[async_trait]
pub trait BackendPlugin: Plugin {
async fn search(
&self,
query: &str,
max_results: usize,
) -> Result<Vec<crate::types::ResultItem>, FetchiumError>;
fn supported_features(&self) -> BackendFeatures {
BackendFeatures::default()
}
}
#[derive(Debug, Default, Clone)]
pub struct BackendFeatures {
pub supports_date_filter: bool,
pub supports_language_filter: bool,
pub max_results_per_query: usize,
}
#[async_trait]
pub trait ExtractorPlugin: Plugin {
async fn extract(
&self,
url: &str,
raw_html: &str,
) -> Result<crate::extract::ExtractedContent, FetchiumError>;
fn supported_content_types(&self) -> Vec<String>;
}
pub trait RankerPlugin: Plugin {
fn rank(
&self,
query: &str,
results: &mut Vec<crate::types::ResultItem>,
) -> Result<(), FetchiumError>;
}
pub trait FormatterPlugin: Plugin {
fn format(&self, result: &crate::types::SearchResult) -> Result<String, FetchiumError>;
fn file_extension(&self) -> &str;
fn mime_type(&self) -> &str;
}
pub trait ValidatorPlugin: Plugin {
fn validate(&self, text: &str, url: &str) -> Result<f64, FetchiumError>;
}
#[async_trait]
pub trait AiProviderPlugin: Plugin {
async fn complete(&self, prompt: &str, max_tokens: u32) -> Result<String, FetchiumError>;
fn available_models(&self) -> Vec<String>;
}