"""Validation helpers for web_proxy/forward_server - Auto-generated"""

from typing import Any, TypedDict, Literal
from typing_extensions import NotRequired

# Import common validators from central _helpers module
from hfortix_fortios._helpers import (
    validate_enable_disable,
    validate_integer_range,
    validate_string_length,
    validate_port_number,
    validate_ip_address,
    validate_ipv6_address,
    validate_mac_address,
)

# Import central validation functions (avoid duplication across 1,062 files)
from hfortix_fortios._helpers.validation import (
    validate_required_fields as _validate_required_fields,
    validate_enum_field as _validate_enum_field,
    validate_query_parameter as _validate_query_parameter,
)

# ============================================================================
# Required Fields Validation
# Auto-generated from schema
# ============================================================================

# ⚠️  IMPORTANT: FortiOS schemas have known issues with required field marking:

# Do NOT use this list for strict validation - test with the actual FortiOS API!

# Fields marked as required (after filtering false positives)
REQUIRED_FIELDS = [
    "interface",  # Specify outgoing interface to reach server.
]

# Fields with defaults (optional)
FIELDS_WITH_DEFAULTS = {
    "name": "",
    "addr-type": "ip",
    "ip": "0.0.0.0",
    "ipv6": "::",
    "fqdn": "",
    "port": 3128,
    "interface-select-method": "sdwan",
    "interface": "",
    "vrf-select": -1,
    "comment": "",
    "masquerade": "enable",
    "healthcheck": "disable",
    "monitor": "www.google.com",
    "server-down-option": "block",
    "username": "",
}

# ============================================================================
# Deprecated Fields
# Auto-generated from schema - warns users about deprecated fields
# ============================================================================

# Deprecated fields with migration guidance
DEPRECATED_FIELDS = {
}

# ============================================================================
# Field Metadata (Type Information & Descriptions)
# Auto-generated from schema - use for IDE autocomplete and documentation
# ============================================================================

# Field types mapping
FIELD_TYPES = {
    "name": "string",  # Server name.
    "addr-type": "option",  # Address type of the forwarding proxy server: IP or FQDN.
    "ip": "ipv4-address-any",  # Forward proxy server IP address.
    "ipv6": "ipv6-address",  # Forward proxy server IPv6 address.
    "fqdn": "string",  # Forward server Fully Qualified Domain Name (FQDN).
    "port": "integer",  # Port number that the forwarding server expects to receive HT
    "interface-select-method": "option",  # Specify how to select outgoing interface to reach server.
    "interface": "string",  # Specify outgoing interface to reach server.
    "vrf-select": "integer",  # VRF ID used for connection to server.
    "comment": "string",  # Comment.
    "masquerade": "option",  # Enable/disable use of the IP address of the outgoing interfa
    "healthcheck": "option",  # Enable/disable forward server health checking. Attempts to c
    "monitor": "string",  # URL for forward server health check monitoring (default = ww
    "server-down-option": "option",  # Action to take when the forward server is found to be down: 
    "username": "string",  # HTTP authentication user name.
    "password": "password",  # HTTP authentication password.
}

# Field descriptions (help text from FortiOS API)
FIELD_DESCRIPTIONS = {
    "name": "Server name.",
    "addr-type": "Address type of the forwarding proxy server: IP or FQDN.",
    "ip": "Forward proxy server IP address.",
    "ipv6": "Forward proxy server IPv6 address.",
    "fqdn": "Forward server Fully Qualified Domain Name (FQDN).",
    "port": "Port number that the forwarding server expects to receive HTTP sessions on (1 - 65535, default = 3128).",
    "interface-select-method": "Specify how to select outgoing interface to reach server.",
    "interface": "Specify outgoing interface to reach server.",
    "vrf-select": "VRF ID used for connection to server.",
    "comment": "Comment.",
    "masquerade": "Enable/disable use of the IP address of the outgoing interface as the client IP address (default = enable)",
    "healthcheck": "Enable/disable forward server health checking. Attempts to connect through the remote forwarding server to a destination to verify that the forwarding server is operating normally.",
    "monitor": "URL for forward server health check monitoring (default = www.google.com).",
    "server-down-option": "Action to take when the forward server is found to be down: block sessions until the server is back up or pass sessions to their destination.",
    "username": "HTTP authentication user name.",
    "password": "HTTP authentication password.",
}

# Field constraints (string lengths, integer ranges)
FIELD_CONSTRAINTS = {
    "name": {"type": "string", "max_length": 63},
    "fqdn": {"type": "string", "max_length": 255},
    "port": {"type": "integer", "min": 1, "max": 65535},
    "interface": {"type": "string", "max_length": 15},
    "vrf-select": {"type": "integer", "min": 0, "max": 511},
    "comment": {"type": "string", "max_length": 63},
    "monitor": {"type": "string", "max_length": 255},
    "username": {"type": "string", "max_length": 64},
}

# Nested schemas (for table/list fields with children)
NESTED_SCHEMAS = {
}


# Valid enum values from API documentation
VALID_BODY_ADDR_TYPE = [
    "ip",
    "ipv6",
    "fqdn",
]
VALID_BODY_INTERFACE_SELECT_METHOD = [
    "sdwan",
    "specify",
]
VALID_BODY_MASQUERADE = [
    "enable",
    "disable",
]
VALID_BODY_HEALTHCHECK = [
    "disable",
    "enable",
]
VALID_BODY_SERVER_DOWN_OPTION = [
    "block",
    "pass",
]
VALID_QUERY_ACTION = ["default", "schema"]

# ============================================================================
# GET Validation
# ============================================================================


def validate_web_proxy_forward_server_get(
    attr: str | None = None,
    filters: dict[str, Any] | None = None,
    **params: Any,
) -> tuple[bool, str | None]:
    """Validate GET request parameters for web_proxy/forward_server."""
    # Validate query parameters using central function
    if "action" in params:
        is_valid, error = _validate_query_parameter(
            "action",
            params.get("action"),
            VALID_QUERY_ACTION
        )
        if not is_valid:
            return (False, error)

    return (True, None)


# ============================================================================
# POST Validation
# ============================================================================


def validate_web_proxy_forward_server_post(
    payload: dict,
    **params: Any,
) -> tuple[bool, str | None]:
    """Validate POST request to create new web_proxy/forward_server object."""
    # Step 1: Validate required fields using central function
    is_valid, error = _validate_required_fields(
        payload,
        REQUIRED_FIELDS,
        FIELD_DESCRIPTIONS
    )
    if not is_valid:
        return (False, error)

    # Step 2: Validate enum values using central function
    if "addr-type" in payload:
        is_valid, error = _validate_enum_field(
            "addr-type",
            payload["addr-type"],
            VALID_BODY_ADDR_TYPE,
            FIELD_DESCRIPTIONS
        )
        if not is_valid:
            return (False, error)
    if "interface-select-method" in payload:
        is_valid, error = _validate_enum_field(
            "interface-select-method",
            payload["interface-select-method"],
            VALID_BODY_INTERFACE_SELECT_METHOD,
            FIELD_DESCRIPTIONS
        )
        if not is_valid:
            return (False, error)
    if "masquerade" in payload:
        is_valid, error = _validate_enum_field(
            "masquerade",
            payload["masquerade"],
            VALID_BODY_MASQUERADE,
            FIELD_DESCRIPTIONS
        )
        if not is_valid:
            return (False, error)
    if "healthcheck" in payload:
        is_valid, error = _validate_enum_field(
            "healthcheck",
            payload["healthcheck"],
            VALID_BODY_HEALTHCHECK,
            FIELD_DESCRIPTIONS
        )
        if not is_valid:
            return (False, error)
    if "server-down-option" in payload:
        is_valid, error = _validate_enum_field(
            "server-down-option",
            payload["server-down-option"],
            VALID_BODY_SERVER_DOWN_OPTION,
            FIELD_DESCRIPTIONS
        )
        if not is_valid:
            return (False, error)

    return (True, None)


# ============================================================================
# PUT Validation
# ============================================================================


def validate_web_proxy_forward_server_put(
    payload: dict,
    **params: Any,
) -> tuple[bool, str | None]:
    """Validate PUT request to update web_proxy/forward_server."""
    # Validate enum values using central function
    if "addr-type" in payload:
        is_valid, error = _validate_enum_field(
            "addr-type",
            payload["addr-type"],
            VALID_BODY_ADDR_TYPE,
            FIELD_DESCRIPTIONS
        )
        if not is_valid:
            return (False, error)
    if "interface-select-method" in payload:
        is_valid, error = _validate_enum_field(
            "interface-select-method",
            payload["interface-select-method"],
            VALID_BODY_INTERFACE_SELECT_METHOD,
            FIELD_DESCRIPTIONS
        )
        if not is_valid:
            return (False, error)
    if "masquerade" in payload:
        is_valid, error = _validate_enum_field(
            "masquerade",
            payload["masquerade"],
            VALID_BODY_MASQUERADE,
            FIELD_DESCRIPTIONS
        )
        if not is_valid:
            return (False, error)
    if "healthcheck" in payload:
        is_valid, error = _validate_enum_field(
            "healthcheck",
            payload["healthcheck"],
            VALID_BODY_HEALTHCHECK,
            FIELD_DESCRIPTIONS
        )
        if not is_valid:
            return (False, error)
    if "server-down-option" in payload:
        is_valid, error = _validate_enum_field(
            "server-down-option",
            payload["server-down-option"],
            VALID_BODY_SERVER_DOWN_OPTION,
            FIELD_DESCRIPTIONS
        )
        if not is_valid:
            return (False, error)

    return (True, None)


# ============================================================================
# Metadata Access Functions
# Imported from central module to avoid duplication across 1,062 files
# Bound to this endpoint's data using functools.partial (saves ~7KB per file)
# ============================================================================

from functools import partial
from hfortix_fortios._helpers.metadata import (
    get_field_description,
    get_field_type,
    get_field_constraints,
    get_field_default,
    get_field_options,
    get_nested_schema,
    get_all_fields,
    get_field_metadata,
    validate_field_value,
)

# Bind module-specific data to central functions using partial application
get_field_description = partial(get_field_description, FIELD_DESCRIPTIONS)
get_field_type = partial(get_field_type, FIELD_TYPES)
get_field_constraints = partial(get_field_constraints, FIELD_CONSTRAINTS)
get_field_default = partial(get_field_default, FIELDS_WITH_DEFAULTS)
get_field_options = partial(get_field_options, globals())
get_nested_schema = partial(get_nested_schema, NESTED_SCHEMAS)
get_all_fields = partial(get_all_fields, FIELD_TYPES)
get_field_metadata = partial(get_field_metadata, FIELD_TYPES, FIELD_DESCRIPTIONS, 
                             FIELD_CONSTRAINTS, FIELDS_WITH_DEFAULTS, REQUIRED_FIELDS,
                             NESTED_SCHEMAS, globals())
validate_field_value = partial(validate_field_value, FIELD_TYPES, FIELD_DESCRIPTIONS,
                               FIELD_CONSTRAINTS, globals())


# ============================================================================
# Schema Information
# Metadata about this endpoint schema
# ============================================================================

SCHEMA_INFO = {
    "endpoint": "web_proxy/forward_server",
    "category": "cmdb",
    "api_path": "web-proxy/forward-server",
    "mkey": "name",
    "mkey_type": "string",
    "help": "Configure forward-server addresses.",
    "total_fields": 16,
    "required_fields_count": 1,
    "fields_with_defaults_count": 15,
}


def get_schema_info() -> dict[str, Any]:
    """Get information about this endpoint schema."""
    return SCHEMA_INFO.copy()
