proto_core 0.55.5

use crate::id::Id;
use schematic::Schematic;
use serde::{Deserialize, Serialize};
use url::Url;
use warpgate::PluginLocator;

/// Format of the plugin.
#[derive(Debug, Deserialize, Serialize, Schematic)]
#[serde(rename_all = "lowercase")]
pub enum PluginFormat {
    Json,
    Toml,
    Wasm,
    Yaml,
}

/// Information about a person.
#[derive(Debug, Default, Deserialize, Serialize, Schematic)]
pub struct PluginPerson {
    pub name: String,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub email: Option<String>,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub url: Option<Url>,
}

/// Information about an author, either their name, or an object of additional fields.
#[derive(Debug, Deserialize, Serialize, Schematic)]
#[serde(untagged)]
pub enum PluginAuthor {
    String(String),
    Object(PluginPerson),
}

impl PluginAuthor {
    pub fn get_name(&self) -> &str {
        match self {
            Self::String(name) => name,
            Self::Object(author) => &author.name,
        }
    }
}

/// A file source where the plugin attempts to detect a version from.
#[derive(Debug, Default, Deserialize, Serialize, Schematic)]
pub struct PluginDetectionSource {
    pub file: String,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub label: Option<String>,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub url: Option<Url>,
}

/// Information about a plugin.
#[derive(Debug, Deserialize, Serialize, Schematic)]
#[serde(rename_all = "camelCase")]
pub struct PluginEntry {
    // PLUGIN
    /// Suggested identifier of the plugin. This will become the primary binary/shim name,
    /// as well as the name used on the command line, and within environment variables.
    pub id: Id,

    /// The location in which to acquire the plugin.
    /// More information: https://moonrepo.dev/docs/guides/wasm-plugins#configuring-plugin-locations
    pub locator: PluginLocator,

    /// Format of the plugin: WASM, or TOML
    pub format: PluginFormat,

    // METADATA
    /// Human readable name of the tool.
    pub name: String,

    /// Description of the tool in which the plugin is providing.
    pub description: String,

    /// Information about the author.
    #[schema(nested)]
    pub author: PluginAuthor,

    /// URL to the tool's homepage or documentation.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub homepage_url: Option<Url>,

    /// URL to the plugin's repository.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub repository_url: Option<Url>,

    /// Devicon (https://devicon.dev) for the tool.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub devicon: Option<String>,

    // PROVIDES
    /// List of binary/shim names that are provided by this plugin.
    pub bins: Vec<String>,

    /// List of sources in which versions are detected from.
    #[schema(nested)]
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub detection_sources: Vec<PluginDetectionSource>,

    /// List of directories in which the plugin locates globally installed binaries/packages. Supports environment variables.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub globals_dirs: Vec<String>,
}

/// A collection of plugins that can be utilized by consumers.
#[derive(Debug, Deserialize, Serialize, Schematic)]
pub struct PluginRegistryDocument {
    /// Path to a JSON schema.
    #[serde(rename = "$schema")]
    pub schema: String,

    /// Current version of the registry document.
    pub version: u8,

    /// List of available plugins.
    #[schema(nested)]
    pub plugins: Vec<PluginEntry>,
}