"""

    AUTHOR:

        Khushal P Soonderji

    DATE:

        Friday, 20th Dec., 2024.

    OBJECTIVE:

        To provide a structure to receive auth details for stock trading brokers like Zerodha.

    REFERENCES:

        N/A

    DOWNLOADS:

        N/A

"""


#   *****************************************************************************************************************
#  *****                                                                                                          ****
# ***                                                   IMPORT                                                      ***
#  *****                                                                                                          ****
#   *****************************************************************************************************************


# To make sibling directories accessible for imports:
import sys
sys.path.append(".")
sys.path.append("..")

# For making data behaviour_models:
from pydantic import BaseModel, Field, field_validator, PastDatetime, model_validator
from typing import Optional, Literal, Union

# My utils:
from utils_v2.string import regex
from utils_v2.date_time import date_time

# To work with date and time:
import datetime


#   *****************************************************************************************************************
#  *****                                                                                                          ****
# ***                                           MACROS / ONE-TIME INIT                                              ***
#  *****                                                                                                          ****
#   *****************************************************************************************************************


# RegEx Patterns:
REGEX_SESSION_TOKEN = r"^[a-f0-9]{8}-[a-f0-9]{4}-[1-5][a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$"


#   *****************************************************************************************************************
#  *****                                                                                                          ****
# ***                                                VARIABLES                                                      ***
#  *****                                                                                                          ****
#   *****************************************************************************************************************


# --- Nothing Yet


#   *****************************************************************************************************************
#  *****                                                                                                          ****
# ***                                                  FUNCTIONS                                                    ***
#  *****                                                                                                          ****
#   *****************************************************************************************************************


class PaperTradingAuth(BaseModel):

    username: str = Field(
        description = "??",
        frozen = True
    )

    password: str = Field(
        description = "??",
        frozen = True
    )

    # ┏┓    ┏•
    # ┃ ┏┓┏┓╋┓┏┓
    # ┗┛┗┛┛┗┛┗┗┫
    #          ┛

    class Config:
        extra = "forbid"


# ---------------------------------------------------------------------------------------------------------------------


class ZerodhaKiteAuth(BaseModel):

    userId: str = Field(
        description = "How Zerodha's Kite platform identifies this user.",
        frozen = True,
        alias = "clientId"
    )

    apiKey: str = Field(
        description = (
            "The API key of your Kite app. "
            "This remains constant throughout the life of the app."
        ),
        frozen = True
    )

    apiSecret: str = Field(
        description = (
            "The API secret of your Kite app. "
            "This can be changed if you think the security of your app has been compromised."
        ),
        frozen = True
    )

    # ┏┓    ┏•
    # ┃ ┏┓┏┓╋┓┏┓
    # ┗┛┗┛┛┗┛┗┗┫
    #          ┛

    class Config:
        extra = "forbid"
        populate_by_name = True


# ---------------------------------------------------------------------------------------------------------------------


class ICICIBreezeAuth(BaseModel):

    userId: str = Field(
        description = "How ICICI's Breeze platform identifies this user.",
        frozen = True,
        alias = "clientId"
    )

    apiKey: str = Field(
        description = (
            "The API key of your Breeze app. "
            "This remains constant throughout the life of the app."
        ),
        frozen = True
    )

    apiSecret: str = Field(
        description = (
            "The API secret of your Breeze app. "
            "This can be changed if you think the security of your app has been compromised."
        ),
        frozen = True
    )

    # ┏┓    ┏•
    # ┃ ┏┓┏┓╋┓┏┓
    # ┗┛┗┛┛┗┛┗┗┫
    #          ┛

    class Config:
        extra = "forbid"
        populate_by_name = True


# ---------------------------------------------------------------------------------------------------------------------


class TradingAuthRequestHeaders(BaseModel):

    sessionToken: str = Field(
        description = "the session token of the user who is requesting the service",
        pattern = REGEX_SESSION_TOKEN,
        frozen = True,
        alias = "X-Session-Token"
    )

    # ┏┓    ┏•
    # ┃ ┏┓┏┓╋┓┏┓
    # ┗┛┗┛┛┗┛┗┗┫
    #          ┛

    class Config:
        extra = "allow"

    def model_dump(self, *args, **kwargs):
        return super().model_dump(*args, by_alias = True, **kwargs)


# ---------------------------------------------------------------------------------------------------------------------


class TradingAuthRequestData(BaseModel):

    client: Literal["paperTrading", "zerodhaKite", "iciciBreeze"] = Field(alias = "client")
    auth: Union[PaperTradingAuth, ZerodhaKiteAuth, ICICIBreezeAuth]

    # ┏┓    ┏•
    # ┃ ┏┓┏┓╋┓┏┓
    # ┗┛┗┛┛┗┛┗┗┫
    #          ┛

    class Config:
        extra = "forbid"

    # ┓┏  ┓• ┓   •
    # ┃┃┏┓┃┓┏┫┏┓╋┓┏┓┏┓
    # ┗┛┗┻┗┗┗┻┗┻┗┗┗┛┛┗

    @model_validator(mode = "after")
    def ensure_harmony(cls, values):
        client = values.client
        auth = values.auth
        harmony_map = {
            "zerodhaKite": (ZerodhaKiteAuth, ICICIBreezeAuth),
            "iciciBreeze": (ICICIBreezeAuth, ZerodhaKiteAuth),
            "paperTrading": PaperTradingAuth
        }
        if not isinstance(auth, harmony_map[client]):
            raise ValueError(f"incorrect 'auth' for selected client '{client}'")
        return values


#   *****************************************************************************************************************
#  *****                                                                                                          ****
# ***                                               MAIN PROGRAM                                                    ***
#  *****                                                                                                          ****
#   *****************************************************************************************************************


if __name__ == "__main__":

    pass