rolldown_plugin 0.1.0

use std::{any::Any, borrow::Cow, fmt::Debug, sync::Arc};

use super::plugin_context::PluginContext;
use crate::{
  HookAddonArgs, HookBuildEndArgs, HookGenerateBundleArgs, HookLoadArgs, HookLoadOutput,
  HookRenderChunkArgs, HookRenderChunkOutput, HookResolveIdArgs, HookResolveIdOutput,
  HookTransformArgs, HookUsage, HookWriteBundleArgs, PluginHookMeta, SharedTransformPluginContext,
  types::{
    hook_build_start_args::HookBuildStartArgs, hook_render_error::HookRenderErrorArgs,
    hook_render_start_args::HookRenderStartArgs, hook_transform_ast_args::HookTransformAstArgs,
    hook_transform_output::HookTransformOutput,
  },
};
use anyhow::Result;
use rolldown_common::{ModuleInfo, NormalModule, RollupRenderedChunk, WatcherChangeKind};
use rolldown_ecmascript::EcmaAst;

pub type HookResolveIdReturn = Result<Option<HookResolveIdOutput>>;
pub type HookTransformAstReturn = Result<EcmaAst>;
pub type HookTransformReturn = Result<Option<HookTransformOutput>>;
pub type HookLoadReturn = Result<Option<HookLoadOutput>>;
pub type HookNoopReturn = Result<()>;
pub type HookRenderChunkReturn = Result<Option<HookRenderChunkOutput>>;
pub type HookAugmentChunkHashReturn = Result<Option<String>>;
pub type HookInjectionOutputReturn = Result<Option<String>>;

pub trait Plugin: Any + Debug + Send + Sync + 'static {
  fn name(&self) -> Cow<'static, str>;

  // The `option` hook consider call at node side.

  // --- Build hooks ---

  fn build_start(
    &self,
    _ctx: &PluginContext,
    _args: &HookBuildStartArgs<'_>,
  ) -> impl std::future::Future<Output = HookNoopReturn> + Send {
    async { Ok(()) }
  }

  fn build_start_meta(&self) -> Option<PluginHookMeta> {
    None
  }

  fn resolve_id(
    &self,
    _ctx: &PluginContext,
    _args: &HookResolveIdArgs<'_>,
  ) -> impl std::future::Future<Output = HookResolveIdReturn> + Send {
    async { Ok(None) }
  }

  fn resolve_id_meta(&self) -> Option<PluginHookMeta> {
    None
  }

  #[deprecated(
    note = "This hook is only for rollup compatibility, please use `resolve_id` instead."
  )]
  fn resolve_dynamic_import(
    &self,
    _ctx: &PluginContext,
    _args: &HookResolveIdArgs<'_>,
  ) -> impl std::future::Future<Output = HookResolveIdReturn> + Send {
    async { Ok(None) }
  }

  fn resolve_dynamic_import_meta(&self) -> Option<PluginHookMeta> {
    None
  }

  fn load(
    &self,
    _ctx: &PluginContext,
    _args: &HookLoadArgs<'_>,
  ) -> impl std::future::Future<Output = HookLoadReturn> + Send {
    async { Ok(None) }
  }

  fn load_meta(&self) -> Option<PluginHookMeta> {
    None
  }

  fn transform(
    &self,
    _ctx: SharedTransformPluginContext,
    _args: &HookTransformArgs<'_>,
  ) -> impl std::future::Future<Output = HookTransformReturn> + Send {
    async { Ok(None) }
  }

  fn transform_meta(&self) -> Option<PluginHookMeta> {
    None
  }

  fn module_parsed(
    &self,
    _ctx: &PluginContext,
    _module_info: Arc<ModuleInfo>,
    _normal_module: &NormalModule,
  ) -> impl std::future::Future<Output = HookNoopReturn> + Send {
    async { Ok(()) }
  }

  fn module_parsed_meta(&self) -> Option<PluginHookMeta> {
    None
  }

  fn build_end(
    &self,
    _ctx: &PluginContext,
    _args: Option<&HookBuildEndArgs>,
  ) -> impl std::future::Future<Output = HookNoopReturn> + Send {
    async { Ok(()) }
  }

  fn build_end_meta(&self) -> Option<PluginHookMeta> {
    None
  }

  // --- Generate hooks ---

  fn render_start(
    &self,
    _ctx: &PluginContext,
    _args: &HookRenderStartArgs<'_>,
  ) -> impl std::future::Future<Output = HookNoopReturn> + Send {
    async { Ok(()) }
  }

  fn render_start_meta(&self) -> Option<PluginHookMeta> {
    None
  }

  fn banner(
    &self,
    _ctx: &PluginContext,
    _args: &HookAddonArgs,
  ) -> impl std::future::Future<Output = HookInjectionOutputReturn> + Send {
    async { Ok(None) }
  }

  fn banner_meta(&self) -> Option<PluginHookMeta> {
    None
  }

  fn footer(
    &self,
    _ctx: &PluginContext,
    _args: &HookAddonArgs,
  ) -> impl std::future::Future<Output = HookInjectionOutputReturn> + Send {
    async { Ok(None) }
  }

  fn footer_meta(&self) -> Option<PluginHookMeta> {
    None
  }

  fn intro(
    &self,
    _ctx: &PluginContext,
    _args: &HookAddonArgs,
  ) -> impl std::future::Future<Output = HookInjectionOutputReturn> + Send {
    async { Ok(None) }
  }

  fn intro_meta(&self) -> Option<PluginHookMeta> {
    None
  }

  fn outro(
    &self,
    _ctx: &PluginContext,
    _args: &HookAddonArgs,
  ) -> impl std::future::Future<Output = HookInjectionOutputReturn> + Send {
    async { Ok(None) }
  }

  fn outro_meta(&self) -> Option<PluginHookMeta> {
    None
  }

  fn render_chunk(
    &self,
    _ctx: &PluginContext,
    _args: &HookRenderChunkArgs<'_>,
  ) -> impl std::future::Future<Output = HookRenderChunkReturn> + Send {
    async { Ok(None) }
  }

  fn render_chunk_meta(&self) -> Option<PluginHookMeta> {
    None
  }

  fn augment_chunk_hash(
    &self,
    _ctx: &PluginContext,
    _chunk: Arc<RollupRenderedChunk>,
  ) -> impl std::future::Future<Output = HookAugmentChunkHashReturn> + Send {
    async { Ok(None) }
  }

  fn augment_chunk_hash_meta(&self) -> Option<PluginHookMeta> {
    None
  }

  fn render_error(
    &self,
    _ctx: &PluginContext,
    _args: &HookRenderErrorArgs,
  ) -> impl std::future::Future<Output = HookNoopReturn> + Send {
    async { Ok(()) }
  }

  fn render_error_meta(&self) -> Option<PluginHookMeta> {
    None
  }

  fn generate_bundle(
    &self,
    _ctx: &PluginContext,
    _args: &mut HookGenerateBundleArgs<'_>,
  ) -> impl std::future::Future<Output = HookNoopReturn> + Send {
    async { Ok(()) }
  }

  fn generate_bundle_meta(&self) -> Option<PluginHookMeta> {
    None
  }

  fn write_bundle(
    &self,
    _ctx: &PluginContext,
    _args: &mut HookWriteBundleArgs,
  ) -> impl std::future::Future<Output = HookNoopReturn> + Send {
    async { Ok(()) }
  }

  fn write_bundle_meta(&self) -> Option<PluginHookMeta> {
    None
  }

  fn close_bundle(
    &self,
    _ctx: &PluginContext,
  ) -> impl std::future::Future<Output = HookNoopReturn> + Send {
    async { Ok(()) }
  }

  fn close_bundle_meta(&self) -> Option<PluginHookMeta> {
    None
  }

  // watch hooks

  fn watch_change(
    &self,
    _ctx: &PluginContext,
    _path: &str,
    _event: WatcherChangeKind,
  ) -> impl std::future::Future<Output = HookNoopReturn> + Send {
    async { Ok(()) }
  }

  fn watch_change_meta(&self) -> Option<PluginHookMeta> {
    None
  }

  fn close_watcher(
    &self,
    _ctx: &PluginContext,
  ) -> impl std::future::Future<Output = HookNoopReturn> + Send {
    async { Ok(()) }
  }

  fn close_watcher_meta(&self) -> Option<PluginHookMeta> {
    None
  }

  // --- experimental hooks ---
  fn transform_ast(
    &self,
    _ctx: &PluginContext,
    args: HookTransformAstArgs<'_>,
  ) -> impl std::future::Future<Output = HookTransformAstReturn> + Send {
    async { Ok(args.ast) }
  }

  fn transform_ast_meta(&self) -> Option<PluginHookMeta> {
    None
  }

  fn register_hook_usage(&self) -> HookUsage;
}