// Copyright (c) 2025-2026 Zensical and contributors

// SPDX-License-Identifier: MIT
// All contributions are certified under the DCO

// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:

// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.

// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.

// ----------------------------------------------------------------------------

//! Navigation item.

use pyo3::FromPyObject;
use serde::Serialize;

use crate::structure::page::PageMeta;

// ----------------------------------------------------------------------------
// Structs
// ----------------------------------------------------------------------------

/// Navigation item.
#[derive(Clone, Debug, PartialEq, Eq, Hash, FromPyObject, Serialize)]
#[pyo3(from_item_all)]
pub struct NavigationItem {
    /// Item title.
    pub title: Option<String>,
    /// Item URL.
    pub url: Option<String>,
    /// Item canonical URL.
    pub canonical_url: Option<String>,
    /// Item metadata.
    pub meta: Option<PageMeta>,
    /// Item children.
    pub children: Vec<NavigationItem>,
    /// Whether this item is an index page.
    pub is_index: bool,
    /// Whether this item is currently active.
    pub active: bool,
}
