empire-core 0.7.3__py3-none-any.whl

empire_core/protocol/models/attack.py

@@ -0,0 +1,229 @@
+"""
+Attack and spy protocol models.
+
+Commands:
+- cra: Create/send attack
+- csm: Send spy mission
+- gas: Get attack presets
+- msd: Skip attack cooldown
+- sdc: Skip defense cooldown
+"""
+
+from __future__ import annotations
+
+from pydantic import ConfigDict, Field
+
+from .base import BaseRequest, BaseResponse, UnitCount
+
+# =============================================================================
+# CRA - Create Attack
+# =============================================================================
+
+
+class CreateAttackRequest(BaseRequest):
+    """
+    Send an attack to a target.
+
+    Command: cra
+    Payload: {
+        "CID": source_castle_id,
+        "TX": target_x,
+        "TY": target_y,
+        "TK": target_kingdom,
+        "U": [{"UID": unit_id, "C": count}, ...],
+        "T": [{"TID": tool_id, "C": count}, ...],  # optional
+        "AT": attack_type,  # 1=attack, 2=support, etc.
+    }
+    """
+
+    command = "cra"
+
+    castle_id: int = Field(alias="CID")
+    target_x: int = Field(alias="TX")
+    target_y: int = Field(alias="TY")
+    target_kingdom: int = Field(alias="TK", default=0)
+    units: list[UnitCount] = Field(alias="U", default_factory=list)
+    tools: list[UnitCount] = Field(alias="T", default_factory=list)
+    attack_type: int = Field(alias="AT", default=1)  # 1=attack
+
+
+class CreateAttackResponse(BaseResponse):
+    """
+    Response to attack creation.
+
+    Command: cra
+    """
+
+    command = "cra"
+
+    movement_id: int = Field(alias="MID", default=0)
+    arrival_time: int = Field(alias="AT", default=0)  # Unix timestamp
+    error_code: int = Field(alias="E", default=0)
+    error_message: str | None = Field(alias="EM", default=None)
+
+
+# =============================================================================
+# CSM - Send Spy Mission
+# =============================================================================
+
+
+class SendSpyRequest(BaseRequest):
+    """
+    Send a spy mission to a target.
+
+    Command: csm
+    Payload: {
+        "CID": source_castle_id,
+        "TX": target_x,
+        "TY": target_y,
+        "TK": target_kingdom,
+        "SC": spy_count,
+    }
+    """
+
+    command = "csm"
+
+    castle_id: int = Field(alias="CID")
+    target_x: int = Field(alias="TX")
+    target_y: int = Field(alias="TY")
+    target_kingdom: int = Field(alias="TK", default=0)
+    spy_count: int = Field(alias="SC", default=1)
+
+
+class SendSpyResponse(BaseResponse):
+    """
+    Response to spy mission.
+
+    Command: csm
+    """
+
+    command = "csm"
+
+    movement_id: int = Field(alias="MID", default=0)
+    arrival_time: int = Field(alias="AT", default=0)
+    error_code: int = Field(alias="E", default=0)
+
+
+# =============================================================================
+# GAS - Get Attack Presets
+# =============================================================================
+
+
+class GetPresetsRequest(BaseRequest):
+    """
+    Get saved attack presets.
+
+    Command: gas
+    Payload: {"CID": castle_id} or {} (empty for all)
+    """
+
+    command = "gas"
+
+    castle_id: int | None = Field(alias="CID", default=None)
+
+
+class AttackPreset(BaseResponse):
+    """A saved attack preset."""
+
+    model_config = ConfigDict(populate_by_name=True, extra="allow")
+
+    preset_id: int = Field(alias="PID")
+    name: str = Field(alias="N")
+    units: list[UnitCount] = Field(alias="U", default_factory=list)
+    tools: list[UnitCount] = Field(alias="T", default_factory=list)
+
+
+class GetPresetsResponse(BaseResponse):
+    """
+    Response containing attack presets.
+
+    Command: gas
+    """
+
+    command = "gas"
+
+    presets: list[AttackPreset] = Field(alias="P", default_factory=list)
+
+
+# =============================================================================
+# MSD - Skip Attack Cooldown
+# =============================================================================
+
+
+class SkipAttackCooldownRequest(BaseRequest):
+    """
+    Skip attack cooldown using rubies.
+
+    Command: msd
+    Payload: {"CID": castle_id}
+    """
+
+    command = "msd"
+
+    castle_id: int = Field(alias="CID")
+
+
+class SkipAttackCooldownResponse(BaseResponse):
+    """
+    Response to skipping attack cooldown.
+
+    Command: msd
+    """
+
+    command = "msd"
+
+    success: bool = Field(default=True)
+    rubies_spent: int = Field(alias="RS", default=0)
+    error_code: int = Field(alias="E", default=0)
+
+
+# =============================================================================
+# SDC - Skip Defense Cooldown
+# =============================================================================
+
+
+class SkipDefenseCooldownRequest(BaseRequest):
+    """
+    Skip defense cooldown using rubies.
+
+    Command: sdc
+    Payload: {"CID": castle_id}
+    """
+
+    command = "sdc"
+
+    castle_id: int = Field(alias="CID")
+
+
+class SkipDefenseCooldownResponse(BaseResponse):
+    """
+    Response to skipping defense cooldown.
+
+    Command: sdc
+    """
+
+    command = "sdc"
+
+    success: bool = Field(default=True)
+    rubies_spent: int = Field(alias="RS", default=0)
+    error_code: int = Field(alias="E", default=0)
+
+
+__all__ = [
+    # CRA - Create Attack
+    "CreateAttackRequest",
+    "CreateAttackResponse",
+    # CSM - Send Spy
+    "SendSpyRequest",
+    "SendSpyResponse",
+    # GAS - Get Presets
+    "GetPresetsRequest",
+    "GetPresetsResponse",
+    "AttackPreset",
+    # MSD - Skip Attack Cooldown
+    "SkipAttackCooldownRequest",
+    "SkipAttackCooldownResponse",
+    # SDC - Skip Defense Cooldown
+    "SkipDefenseCooldownRequest",
+    "SkipDefenseCooldownResponse",
+]

empire_core/protocol/models/auth.py

@@ -0,0 +1,216 @@
+"""
+Authentication protocol models.
+
+Commands:
+- lli: Login
+- lre: Register new account
+- vpn: Check username availability
+- vln: Check if username exists (for login)
+- lpp: Password recovery
+"""
+
+from __future__ import annotations
+
+from pydantic import ConfigDict, Field
+
+from .base import BaseRequest, BaseResponse
+
+# =============================================================================
+# LLI - Login
+# =============================================================================
+
+
+class LoginRequest(BaseRequest):
+    """
+    Login request.
+
+    Command: lli
+    Payload: {"NM": "username", "PW": "password", "L": "en", "AID": "..."}
+
+    Note: The actual login is typically handled by the client's login() method
+    which manages the full authentication flow including handshake.
+    """
+
+    command = "lli"
+
+    username: str = Field(alias="NM")
+    password: str = Field(alias="PW")
+    language: str = Field(alias="L", default="en")
+    app_id: str | None = Field(alias="AID", default=None)
+
+
+class PlayerData(BaseRequest):
+    """Player data returned after login."""
+
+    model_config = ConfigDict(populate_by_name=True, extra="allow")
+
+    player_id: int = Field(alias="PID")
+    player_name: str = Field(alias="PN")
+    alliance_id: int | None = Field(alias="AID", default=None)
+    alliance_name: str | None = Field(alias="AN", default=None)
+    level: int = Field(alias="L", default=1)
+    experience: int = Field(alias="XP", default=0)
+    rubies: int = Field(alias="R", default=0)
+    coins: int = Field(alias="C", default=0)
+
+
+class LoginResponse(BaseResponse):
+    """
+    Login response.
+
+    Command: lli
+    Contains player data on successful login.
+    """
+
+    command = "lli"
+
+    player: PlayerData | None = Field(alias="P", default=None)
+    session_id: str | None = Field(alias="SID", default=None)
+    error_code: int = Field(alias="E", default=0)
+
+
+# =============================================================================
+# LRE - Register
+# =============================================================================
+
+
+class RegisterRequest(BaseRequest):
+    """
+    Register new account request.
+
+    Command: lre
+    Payload: {"NM": "username", "PW": "password", "EM": "email", "L": "en"}
+    """
+
+    command = "lre"
+
+    username: str = Field(alias="NM")
+    password: str = Field(alias="PW")
+    email: str = Field(alias="EM")
+    language: str = Field(alias="L", default="en")
+
+
+class RegisterResponse(BaseResponse):
+    """
+    Register response.
+
+    Command: lre
+    """
+
+    command = "lre"
+
+    success: bool = Field(alias="S", default=False)
+    error_code: int = Field(alias="E", default=0)
+    error_message: str | None = Field(alias="EM", default=None)
+
+
+# =============================================================================
+# VPN - Check Username Availability
+# =============================================================================
+
+
+class CheckUsernameAvailableRequest(BaseRequest):
+    """
+    Check if a username is available for registration.
+
+    Command: vpn
+    Payload: {"NM": "username"}
+    """
+
+    command = "vpn"
+
+    username: str = Field(alias="NM")
+
+
+class CheckUsernameAvailableResponse(BaseResponse):
+    """
+    Response for username availability check.
+
+    Command: vpn
+    """
+
+    command = "vpn"
+
+    available: bool = Field(alias="A", default=False)
+
+
+# =============================================================================
+# VLN - Check Username Exists (for login)
+# =============================================================================
+
+
+class CheckUsernameExistsRequest(BaseRequest):
+    """
+    Check if a username exists (for login validation).
+
+    Command: vln
+    Payload: {"NM": "username"}
+    """
+
+    command = "vln"
+
+    username: str = Field(alias="NM")
+
+
+class CheckUsernameExistsResponse(BaseResponse):
+    """
+    Response for username existence check.
+
+    Command: vln
+    """
+
+    command = "vln"
+
+    exists: bool = Field(alias="E", default=False)
+
+
+# =============================================================================
+# LPP - Password Recovery
+# =============================================================================
+
+
+class PasswordRecoveryRequest(BaseRequest):
+    """
+    Request password recovery email.
+
+    Command: lpp
+    Payload: {"EM": "email"} or {"NM": "username"}
+    """
+
+    command = "lpp"
+
+    email: str | None = Field(alias="EM", default=None)
+    username: str | None = Field(alias="NM", default=None)
+
+
+class PasswordRecoveryResponse(BaseResponse):
+    """
+    Response for password recovery request.
+
+    Command: lpp
+    """
+
+    command = "lpp"
+
+    success: bool = Field(alias="S", default=False)
+    error_code: int = Field(alias="E", default=0)
+
+
+__all__ = [
+    # LLI - Login
+    "LoginRequest",
+    "LoginResponse",
+    "PlayerData",
+    # LRE - Register
+    "RegisterRequest",
+    "RegisterResponse",
+    # VPN - Username Available
+    "CheckUsernameAvailableRequest",
+    "CheckUsernameAvailableResponse",
+    # VLN - Username Exists
+    "CheckUsernameExistsRequest",
+    "CheckUsernameExistsResponse",
+    # LPP - Password Recovery
+    "PasswordRecoveryRequest",
+    "PasswordRecoveryResponse",
+]