finance_query/models/edgar/

company_facts.rs

//! EDGAR Company Facts (XBRL) models.
//!
//! Models for structured XBRL financial data from
//! `https://data.sec.gov/api/xbrl/companyfacts/CIK{padded}.json`.
//!
//! This data includes historical financial statement values (revenue, assets,
//! liabilities, etc.) extracted from 10-K and 10-Q filings.

use serde::{Deserialize, Deserializer, Serialize};
use std::collections::HashMap;

/// Deserialize CIK that may come as a number or a zero-padded string.
fn deserialize_cik<'de, D: Deserializer<'de>>(deserializer: D) -> Result<Option<u64>, D::Error> {
    #[derive(Deserialize)]
    #[serde(untagged)]
    enum CikValue {
        Num(u64),
        Str(String),
    }

    match Option::<CikValue>::deserialize(deserializer)? {
        Some(CikValue::Num(n)) => Ok(Some(n)),
        Some(CikValue::Str(s)) => s
            .trim_start_matches('0')
            .parse::<u64>()
            .map(Some)
            .map_err(serde::de::Error::custom),
        None => Ok(None),
    }
}

/// Complete company facts response containing all XBRL financial data.
///
/// Facts are organized by taxonomy (e.g., `us-gaap`, `ifrs-full`, `dei`).
/// Use the convenience methods to access common taxonomies.
///
/// # Example
///
/// ```no_run
/// # use finance_query::CompanyFacts;
/// # fn example(facts: CompanyFacts) {
/// // Get US-GAAP revenue data
/// if let Some(revenue) = facts.get_us_gaap_fact("Revenue") {
///     for (unit, values) in &revenue.units {
///         println!("Unit: {}, data points: {}", unit, values.len());
///     }
/// }
/// # }
/// ```
#[derive(Debug, Clone, Serialize, Deserialize)]
#[non_exhaustive]
pub struct CompanyFacts {
    /// CIK number (SEC returns this as either a number or a zero-padded string)
    #[serde(default, deserialize_with = "deserialize_cik")]
    pub cik: Option<u64>,

    /// Company name
    #[serde(default, rename = "entityName")]
    pub entity_name: Option<String>,

    /// Facts organized by taxonomy (e.g., "us-gaap", "ifrs-full", "dei")
    #[serde(default)]
    pub facts: HashMap<String, FactsByTaxonomy>,
}

impl CompanyFacts {
    /// Get US-GAAP facts (most common for US-listed companies).
    pub fn us_gaap(&self) -> Option<&FactsByTaxonomy> {
        self.facts.get("us-gaap")
    }

    /// Get a specific fact concept from the US-GAAP taxonomy.
    ///
    /// Common concepts: `"Revenue"`, `"Assets"`, `"Liabilities"`,
    /// `"NetIncomeLoss"`, `"EarningsPerShareBasic"`, `"StockholdersEquity"`.
    pub fn get_us_gaap_fact(&self, concept: &str) -> Option<&FactConcept> {
        self.us_gaap().and_then(|gaap| gaap.0.get(concept))
    }

    /// Get IFRS facts (for companies reporting under International Financial Reporting Standards).
    pub fn ifrs(&self) -> Option<&FactsByTaxonomy> {
        self.facts.get("ifrs-full")
    }

    /// Get DEI (Document and Entity Information) facts.
    pub fn dei(&self) -> Option<&FactsByTaxonomy> {
        self.facts.get("dei")
    }
}

/// Facts within a single taxonomy (e.g., "us-gaap").
///
/// Maps concept names (e.g., "Revenue", "Assets") to their [`FactConcept`].
#[derive(Debug, Clone, Serialize, Deserialize)]
#[non_exhaustive]
pub struct FactsByTaxonomy(pub HashMap<String, FactConcept>);

/// A single XBRL concept (e.g., "Revenue") with all reported values.
///
/// Values are organized by unit of measure (e.g., "USD", "shares", "pure").
#[derive(Debug, Clone, Serialize, Deserialize)]
#[non_exhaustive]
pub struct FactConcept {
    /// Human-readable label
    #[serde(default)]
    pub label: Option<String>,

    /// Description of this concept
    #[serde(default)]
    pub description: Option<String>,

    /// Values organized by unit type (e.g., "USD" -> vec of data points)
    #[serde(default)]
    pub units: HashMap<String, Vec<FactUnit>>,
}

#[cfg(feature = "dataframe")]
impl FactConcept {
    /// Convert all data points from a specific unit to a polars DataFrame.
    ///
    /// # Arguments
    ///
    /// * `unit` - The unit of measure (e.g., "USD", "shares", "pure")
    ///
    /// # Example
    ///
    /// ```no_run
    /// # #[cfg(feature = "dataframe")]
    /// # use finance_query::CompanyFacts;
    /// # #[cfg(feature = "dataframe")]
    /// # fn example(facts: CompanyFacts) -> Result<(), Box<dyn std::error::Error>> {
    /// if let Some(revenue) = facts.get_us_gaap_fact("Revenue") {
    ///     // Convert USD revenue data to DataFrame
    ///     if let Some(df) = revenue.to_dataframe_for_unit("USD")? {
    ///         println!("Revenue in USD: {:?}", df);
    ///     }
    /// }
    /// # Ok(())
    /// # }
    /// ```
    pub fn to_dataframe_for_unit(
        &self,
        unit: &str,
    ) -> ::polars::prelude::PolarsResult<Option<::polars::prelude::DataFrame>> {
        if let Some(data_points) = self.units.get(unit) {
            Ok(Some(FactUnit::vec_to_dataframe(data_points)?))
        } else {
            Ok(None)
        }
    }

    /// Convert all data points from all units to a single polars DataFrame.
    ///
    /// Adds a "unit" column to distinguish between different units of measure.
    ///
    /// # Example
    ///
    /// ```no_run
    /// # #[cfg(feature = "dataframe")]
    /// # use finance_query::CompanyFacts;
    /// # #[cfg(feature = "dataframe")]
    /// # fn example(facts: CompanyFacts) -> Result<(), Box<dyn std::error::Error>> {
    /// if let Some(revenue) = facts.get_us_gaap_fact("Revenue") {
    ///     let df = revenue.to_dataframe()?;
    ///     println!("All revenue data: {:?}", df);
    /// }
    /// # Ok(())
    /// # }
    /// ```
    pub fn to_dataframe(&self) -> ::polars::prelude::PolarsResult<::polars::prelude::DataFrame> {
        use ::polars::prelude::*;

        // Collect all data points with their unit labels
        let mut units: Vec<String> = Vec::new();
        let mut facts: Vec<FactUnit> = Vec::new();
        for (unit, data_points) in &self.units {
            for point in data_points {
                units.push(unit.clone());
                facts.push(point.clone());
            }
        }

        if facts.is_empty() {
            // Return empty DataFrame with correct schema
            return Ok(DataFrame::empty());
        }

        // Convert facts to DataFrame
        let mut df = FactUnit::vec_to_dataframe(&facts)?;

        // Add unit column at the beginning
        let unit_series = Series::new("unit".into(), units);
        df.insert_column(0, unit_series.into())?;

        Ok(df)
    }
}

/// A single data point for an XBRL fact.
///
/// Represents one reported value from a specific filing and period.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[cfg_attr(feature = "dataframe", derive(crate::ToDataFrame))]
#[non_exhaustive]
pub struct FactUnit {
    /// Start date of the reporting period (for duration facts, e.g., revenue)
    #[serde(default)]
    pub start: Option<String>,

    /// End date of the period (for duration facts) or instant date (for point-in-time facts)
    #[serde(default)]
    pub end: Option<String>,

    /// The reported value
    #[serde(default)]
    pub val: Option<f64>,

    /// Accession number of the filing that reported this value
    #[serde(default)]
    pub accn: Option<String>,

    /// Fiscal year
    #[serde(default)]
    pub fy: Option<i32>,

    /// Fiscal period (FY, Q1, Q2, Q3, Q4)
    #[serde(default)]
    pub fp: Option<String>,

    /// Form type (10-K, 10-Q, etc.)
    #[serde(default)]
    pub form: Option<String>,

    /// Date the filing was filed
    #[serde(default)]
    pub filed: Option<String>,

    /// Frame identifier (e.g., "CY2023Q4I")
    #[serde(default)]
    pub frame: Option<String>,
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    #[cfg(feature = "dataframe")]
    fn test_fact_concept_dataframe_conversion() {
        let mut units = HashMap::new();
        units.insert(
            "USD".to_string(),
            vec![FactUnit {
                start: Some("2023-10-01".to_string()),
                end: Some("2024-09-30".to_string()),
                val: Some(391035000000.0),
                accn: Some("0000320193-24-000123".to_string()),
                fy: Some(2024),
                fp: Some("FY".to_string()),
                form: Some("10-K".to_string()),
                filed: Some("2024-11-01".to_string()),
                frame: Some("CY2024".to_string()),
            }],
        );

        let concept = FactConcept {
            label: Some("Revenue".to_string()),
            description: Some("Total revenue".to_string()),
            units,
        };

        // Test single unit conversion
        let df = concept.to_dataframe_for_unit("USD").unwrap().unwrap();
        assert_eq!(df.height(), 1);
        let col_names = df.get_column_names_owned();
        assert!(col_names.iter().any(|n| n.as_str() == "val"));
        assert!(col_names.iter().any(|n| n.as_str() == "fy"));

        // Test all units conversion (includes unit column)
        let df = concept.to_dataframe().unwrap();
        assert_eq!(df.height(), 1);
        let col_names = df.get_column_names_owned();
        assert!(col_names.iter().any(|n| n.as_str() == "unit"));
        assert!(col_names.iter().any(|n| n.as_str() == "val"));
    }

    #[test]
    fn test_deserialize_company_facts() {
        let json = r#"{
            "cik": 320193,
            "entityName": "Apple Inc.",
            "facts": {
                "us-gaap": {
                    "Revenue": {
                        "label": "Revenue",
                        "description": "Amount of revenue recognized.",
                        "units": {
                            "USD": [
                                {
                                    "start": "2023-10-01",
                                    "end": "2024-09-28",
                                    "val": 391035000000.0,
                                    "accn": "0000320193-24-000123",
                                    "fy": 2024,
                                    "fp": "FY",
                                    "form": "10-K",
                                    "filed": "2024-11-01",
                                    "frame": "CY2024"
                                },
                                {
                                    "start": "2022-09-25",
                                    "end": "2023-09-30",
                                    "val": 383285000000.0,
                                    "accn": "0000320193-23-000106",
                                    "fy": 2023,
                                    "fp": "FY",
                                    "form": "10-K",
                                    "filed": "2023-11-03"
                                }
                            ]
                        }
                    },
                    "Assets": {
                        "label": "Assets",
                        "description": "Sum of the carrying amounts.",
                        "units": {
                            "USD": [
                                {
                                    "end": "2024-09-28",
                                    "val": 364980000000.0,
                                    "accn": "0000320193-24-000123",
                                    "fy": 2024,
                                    "fp": "FY",
                                    "form": "10-K",
                                    "filed": "2024-11-01"
                                }
                            ]
                        }
                    }
                }
            }
        }"#;

        let facts: CompanyFacts = serde_json::from_str(json).unwrap();
        assert_eq!(facts.cik, Some(320193));
        assert_eq!(facts.entity_name.as_deref(), Some("Apple Inc."));

        // US-GAAP access
        let gaap = facts.us_gaap().unwrap();
        assert!(gaap.0.contains_key("Revenue"));
        assert!(gaap.0.contains_key("Assets"));

        // Convenience method
        let revenue = facts.get_us_gaap_fact("Revenue").unwrap();
        assert_eq!(revenue.label.as_deref(), Some("Revenue"));
        let usd_values = revenue.units.get("USD").unwrap();
        assert_eq!(usd_values.len(), 2);
        assert_eq!(usd_values[0].val, Some(391035000000.0));
        assert_eq!(usd_values[0].fy, Some(2024));
        assert_eq!(usd_values[0].fp.as_deref(), Some("FY"));
    }
}