browser-commander 0.18.0

// @generated by scripts/generate-playwright-protocol.mjs from
// rust/protocol/playwright/*.yml. Do not edit by hand.

#![allow(clippy::all, missing_docs, unused_imports)]

use serde::{Deserialize, Serialize};

use super::*;
use crate::playwright::connection::{
    Binary, Channel, ChannelType, ObjectRef, ProtocolError, ProtocolEvent, Ref,
};

/// Initializer the driver sends when it creates a `ElectronApplication`.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ElectronApplicationInitializer {
    #[serde(rename = "context")]
    pub context: Ref<BrowserContext>,
}

/// Parameters of `ElectronApplication.browserWindow`.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ElectronApplicationBrowserWindowParams {
    #[serde(rename = "page")]
    pub page: Ref<Page>,
}

/// Result of `ElectronApplication.browserWindow`.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ElectronApplicationBrowserWindowResult {
    #[serde(rename = "handle")]
    pub handle: Ref<JSHandle>,
}

/// Parameters of `ElectronApplication.evaluateExpression` (Evaluate).
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ElectronApplicationEvaluateExpressionParams {
    #[serde(rename = "expression")]
    pub expression: String,
    #[serde(rename = "isFunction", default, skip_serializing_if = "Option::is_none")]
    pub is_function: Option<bool>,
    #[serde(rename = "arg")]
    pub arg: SerializedArgument,
}

/// Result of `ElectronApplication.evaluateExpression` (Evaluate).
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ElectronApplicationEvaluateExpressionResult {
    #[serde(rename = "value")]
    pub value: SerializedValue,
}

/// Parameters of `ElectronApplication.evaluateExpressionHandle` (Evaluate).
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ElectronApplicationEvaluateExpressionHandleParams {
    #[serde(rename = "expression")]
    pub expression: String,
    #[serde(rename = "isFunction", default, skip_serializing_if = "Option::is_none")]
    pub is_function: Option<bool>,
    #[serde(rename = "arg")]
    pub arg: SerializedArgument,
}

/// Result of `ElectronApplication.evaluateExpressionHandle` (Evaluate).
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ElectronApplicationEvaluateExpressionHandleResult {
    #[serde(rename = "handle")]
    pub handle: Ref<JSHandle>,
}

#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub enum ElectronApplicationUpdateSubscriptionParamsEvent {
    #[default]
    #[serde(rename = "console")]
    Console,
}

/// Parameters of `ElectronApplication.updateSubscription`.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ElectronApplicationUpdateSubscriptionParams {
    #[serde(rename = "event")]
    pub event: ElectronApplicationUpdateSubscriptionParamsEvent,
    #[serde(rename = "enabled")]
    pub enabled: bool,
}

/// Payload of the `ElectronApplication.console` event.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ElectronApplicationConsoleEventParams {
    /// Properties of the `ConsoleMessage` mixin.
    #[serde(flatten)]
    pub console_message: ConsoleMessage,
}

/// Events a `ElectronApplication` channel can emit.
#[derive(Debug, Clone, PartialEq)]
pub enum ElectronApplicationEvent {
    /// `ElectronApplication.close`
    Close,
    /// `ElectronApplication.console`
    Console(ElectronApplicationConsoleEventParams),
    /// An event this binding does not know (a newer driver).
    Unknown {
        /// Event name.
        method: String,
        /// Raw event parameters.
        params: serde_json::Value,
    },
}

impl ProtocolEvent for ElectronApplicationEvent {
    fn parse(method: &str, params: serde_json::Value) -> Result<Self, serde_json::Error> {
        match method {
            "close" => Ok(Self::Close),
            "console" => Ok(Self::Console(serde_json::from_value(params)?)),
            _ => Ok(Self::Unknown { method: method.to_string(), params }),
        }
    }
}

/// Channel for the `ElectronApplication` interface (`electron.yml`).
#[derive(Debug, Clone)]
pub struct ElectronApplication {
    channel: Channel,
}

impl ChannelType for ElectronApplication {
    const INTERFACE: &'static str = "ElectronApplication";
    type Initializer = ElectronApplicationInitializer;
    type Event = ElectronApplicationEvent;

    fn accepts(interface: &str) -> bool {
        matches!(interface, "ElectronApplication")
    }

    fn from_channel(channel: Channel) -> Self {
        Self { channel }
    }

    fn channel(&self) -> &Channel {
        &self.channel
    }
}

impl ElectronApplication {
    /// `ElectronApplication.browserWindow` (internal).
    pub async fn browser_window(&self, params: ElectronApplicationBrowserWindowParams) -> Result<ElectronApplicationBrowserWindowResult, ProtocolError> {
        self.channel.send("browserWindow", &params).await
    }

    /// `ElectronApplication.evaluateExpression` ("Evaluate").
    pub async fn evaluate_expression(&self, params: ElectronApplicationEvaluateExpressionParams) -> Result<ElectronApplicationEvaluateExpressionResult, ProtocolError> {
        self.channel.send("evaluateExpression", &params).await
    }

    /// `ElectronApplication.evaluateExpressionHandle` ("Evaluate").
    pub async fn evaluate_expression_handle(&self, params: ElectronApplicationEvaluateExpressionHandleParams) -> Result<ElectronApplicationEvaluateExpressionHandleResult, ProtocolError> {
        self.channel.send("evaluateExpressionHandle", &params).await
    }

    /// `ElectronApplication.updateSubscription` (internal).
    pub async fn update_subscription(&self, params: ElectronApplicationUpdateSubscriptionParams) -> Result<(), ProtocolError> {
        self.channel.send_no_result("updateSubscription", &params).await
    }
}