yfinance-rs 0.9.0

//! Public profile types + loading strategy.
//!
//! Internals are split into:
//! - `api`: quoteSummary v10 API path
//! - `debug`: optional debug dump helpers (only in debug builds or with `debug-dumps` feature)

mod api;

#[cfg(feature = "debug-dumps")]
pub(crate) mod debug;

use crate::{
    YfClient, YfError, YfResponse,
    core::{CallOptions, client::CacheMode, conversions::string_to_fund_kind},
};
use paft::fundamentals::profile::FundKind;

mod model;
pub use model::{Address, Company, Fund, Profile};

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum YahooProfileKind {
    Company,
    Fund(FundQuoteKind),
}

impl YahooProfileKind {
    fn from_quote_type(quote_type: &str) -> Result<Self, YfError> {
        match quote_type {
            "EQUITY" => Ok(Self::Company),
            "ETF" => Ok(Self::Fund(FundQuoteKind::Etf)),
            "MUTUALFUND" => Ok(Self::Fund(FundQuoteKind::MutualFund)),
            other => Err(YfError::InvalidData(format!(
                "profile unavailable for Yahoo quoteType {other}"
            ))),
        }
    }

    const fn quote_type(self) -> &'static str {
        match self {
            Self::Company => "EQUITY",
            Self::Fund(fund) => fund.quote_type(),
        }
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum FundQuoteKind {
    Etf,
    MutualFund,
}

impl FundQuoteKind {
    const fn quote_type(self) -> &'static str {
        match self {
            Self::Etf => "ETF",
            Self::MutualFund => "MUTUALFUND",
        }
    }

    const fn fund_kind(self) -> FundKind {
        match self {
            Self::Etf => FundKind::Etf,
            Self::MutualFund => FundKind::MutualFund,
        }
    }
}

fn resolve_fund_kind(
    legal_type: Option<String>,
    quote_kind: FundQuoteKind,
) -> Result<FundKind, YfError> {
    Ok(string_to_fund_kind(legal_type)?.unwrap_or_else(|| quote_kind.fund_kind()))
}

pub(crate) fn load_profile_from_quote_summary_raw(
    client: &YfClient,
    symbol: &str,
    raw: &serde_json::value::RawValue,
    options: &CallOptions,
) -> Result<YfResponse<Profile>, YfError> {
    let root: api::V10Result<'_> = serde_json::from_str(raw.get()).map_err(YfError::json)?;
    api::load_from_quote_summary_result_with_diagnostics(
        client,
        symbol,
        &root,
        options.data_quality(),
    )
}

pub(crate) async fn load_profile_with_options(
    client: &YfClient,
    symbol: &str,
    options: &CallOptions,
) -> Result<Profile, YfError> {
    Ok(
        load_profile_with_options_and_diagnostics(client, symbol, options)
            .await?
            .into_data(),
    )
}

pub(crate) async fn load_profile_with_options_and_diagnostics(
    client: &YfClient,
    symbol: &str,
    options: &CallOptions,
) -> Result<YfResponse<Profile>, YfError> {
    let symbol = crate::core::client::normalize_symbol(symbol)?;
    api::load_from_quote_summary_api_with_diagnostics(client, &symbol, options).await
}

/// Loads the profile for a given symbol.
///
/// This function loads the profile from Yahoo's quoteSummary API.
///
/// # Errors
///
/// Returns `YfError` if the network request fails, the response cannot be parsed,
/// or the data for the symbol is not available.
pub async fn load_profile(client: &YfClient, symbol: &str) -> Result<Profile, YfError> {
    Ok(load_profile_with_diagnostics(client, symbol)
        .await?
        .into_data())
}

/// Loads the profile for a given symbol with projection diagnostics.
///
/// This function loads the profile from Yahoo's quoteSummary API and reports
/// malformed optional provider fields that were omitted from the returned
/// profile.
///
/// # Errors
///
/// Returns `YfError` if the network request fails, the response cannot be parsed,
/// the data for the symbol is not available, or strict data-quality mode rejects
/// a projection issue.
pub async fn load_profile_with_diagnostics(
    client: &YfClient,
    symbol: &str,
) -> Result<YfResponse<Profile>, YfError> {
    let options = CallOptions::default().with_cache_mode(CacheMode::Use);
    load_profile_with_options_and_diagnostics(client, symbol, &options).await
}