browser-commander 0.17.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 `APIRequestContext`.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct APIRequestContextInitializer {
    #[serde(rename = "tracing")]
    pub tracing: Ref<Tracing>,
}

/// Parameters of `APIRequestContext.fetch` ({method}).
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct APIRequestContextFetchParams {
    #[serde(rename = "url")]
    pub url: String,
    #[serde(rename = "encodedParams", default, skip_serializing_if = "Option::is_none")]
    pub encoded_params: Option<String>,
    #[serde(rename = "params", default, skip_serializing_if = "Option::is_none")]
    pub params: Option<Vec<NameValue>>,
    #[serde(rename = "method", default, skip_serializing_if = "Option::is_none")]
    pub method: Option<String>,
    #[serde(rename = "headers", default, skip_serializing_if = "Option::is_none")]
    pub headers: Option<Vec<NameValue>>,
    #[serde(rename = "postData", default, skip_serializing_if = "Option::is_none")]
    pub post_data: Option<Binary>,
    #[serde(rename = "jsonData", default, skip_serializing_if = "Option::is_none")]
    pub json_data: Option<String>,
    #[serde(rename = "formData", default, skip_serializing_if = "Option::is_none")]
    pub form_data: Option<Vec<NameValue>>,
    #[serde(rename = "multipartData", default, skip_serializing_if = "Option::is_none")]
    pub multipart_data: Option<Vec<FormField>>,
    #[serde(rename = "failOnStatusCode", default, skip_serializing_if = "Option::is_none")]
    pub fail_on_status_code: Option<bool>,
    #[serde(rename = "ignoreHTTPSErrors", default, skip_serializing_if = "Option::is_none")]
    pub ignore_https_errors: Option<bool>,
    #[serde(rename = "maxRedirects", default, skip_serializing_if = "Option::is_none")]
    pub max_redirects: Option<i64>,
    #[serde(rename = "maxRetries", default, skip_serializing_if = "Option::is_none")]
    pub max_retries: Option<i64>,
}

/// Result of `APIRequestContext.fetch` ({method}).
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct APIRequestContextFetchResult {
    #[serde(rename = "response")]
    pub response: APIResponse,
}

/// Parameters of `APIRequestContext.fetchResponseBody` (Get response body).
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct APIRequestContextFetchResponseBodyParams {
    #[serde(rename = "fetchUid")]
    pub fetch_uid: String,
}

/// Result of `APIRequestContext.fetchResponseBody` (Get response body).
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct APIRequestContextFetchResponseBodyResult {
    #[serde(rename = "binary", default, skip_serializing_if = "Option::is_none")]
    pub binary: Option<Binary>,
}

/// Parameters of `APIRequestContext.fetchLog`.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct APIRequestContextFetchLogParams {
    #[serde(rename = "fetchUid")]
    pub fetch_uid: String,
}

/// Result of `APIRequestContext.fetchLog`.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct APIRequestContextFetchLogResult {
    #[serde(rename = "log")]
    pub log: Vec<String>,
}

/// Parameters of `APIRequestContext.storageState` (Get storage state).
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct APIRequestContextStorageStateParams {
    #[serde(rename = "indexedDB", default, skip_serializing_if = "Option::is_none")]
    pub indexed_db: Option<bool>,
    #[serde(rename = "opfs", default, skip_serializing_if = "Option::is_none")]
    pub opfs: Option<bool>,
}

/// Result of `APIRequestContext.storageState` (Get storage state).
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct APIRequestContextStorageStateResult {
    #[serde(rename = "cookies")]
    pub cookies: Vec<NetworkCookie>,
    #[serde(rename = "origins")]
    pub origins: Vec<OriginStorage>,
}

/// Parameters of `APIRequestContext.disposeAPIResponse`.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct APIRequestContextDisposeAPIResponseParams {
    #[serde(rename = "fetchUid")]
    pub fetch_uid: String,
}

/// Parameters of `APIRequestContext.dispose`.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct APIRequestContextDisposeParams {
    #[serde(rename = "reason", default, skip_serializing_if = "Option::is_none")]
    pub reason: Option<String>,
}

/// Events a `APIRequestContext` channel can emit.
#[derive(Debug, Clone, PartialEq)]
pub enum APIRequestContextEvent {
    /// 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 APIRequestContextEvent {
    fn parse(method: &str, params: serde_json::Value) -> Result<Self, serde_json::Error> {
        match method {
            _ => Ok(Self::Unknown { method: method.to_string(), params }),
        }
    }
}

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

impl ChannelType for APIRequestContext {
    const INTERFACE: &'static str = "APIRequestContext";
    type Initializer = APIRequestContextInitializer;
    type Event = APIRequestContextEvent;

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

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

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

impl APIRequestContext {
    /// `APIRequestContext.fetch` ("{method}").
    pub async fn fetch(&self, params: APIRequestContextFetchParams) -> Result<APIRequestContextFetchResult, ProtocolError> {
        self.channel.send("fetch", &params).await
    }

    /// `APIRequestContext.fetchResponseBody` ("Get response body").
    pub async fn fetch_response_body(&self, params: APIRequestContextFetchResponseBodyParams) -> Result<APIRequestContextFetchResponseBodyResult, ProtocolError> {
        self.channel.send("fetchResponseBody", &params).await
    }

    /// `APIRequestContext.fetchLog` (internal).
    pub async fn fetch_log(&self, params: APIRequestContextFetchLogParams) -> Result<APIRequestContextFetchLogResult, ProtocolError> {
        self.channel.send("fetchLog", &params).await
    }

    /// `APIRequestContext.storageState` ("Get storage state").
    pub async fn storage_state(&self, params: APIRequestContextStorageStateParams) -> Result<APIRequestContextStorageStateResult, ProtocolError> {
        self.channel.send("storageState", &params).await
    }

    /// `APIRequestContext.disposeAPIResponse` (internal).
    pub async fn dispose_api_response(&self, params: APIRequestContextDisposeAPIResponseParams) -> Result<(), ProtocolError> {
        self.channel.send_no_result("disposeAPIResponse", &params).await
    }

    /// `APIRequestContext.dispose` (internal).
    pub async fn dispose(&self, params: APIRequestContextDisposeParams) -> Result<(), ProtocolError> {
        self.channel.send_no_result("dispose", &params).await
    }
}