Add global types file

src/constants.py

@@ -4,16 +4,18 @@ constants.py
 This module defines global constants used throughout the project.
 """
 
+from src.types import OptionKey, TTSProviderName
+
 # UI constants
-HUME_AI: str = 'Hume'
-ELEVENLABS: str = 'ElevenLabs'
-UNKNOWN_PROVIDER: str = 'Unknown'
+HUME_AI: TTSProviderName = 'Hume AI'
+ELEVENLABS: TTSProviderName = 'ElevenLabs'
+UNKNOWN_PROVIDER: TTSProviderName = 'Unknown'
 
 PROMPT_MIN_LENGTH: int = 10
 PROMPT_MAX_LENGTH: int = 400
 
-OPTION_A: str = 'Option A'
-OPTION_B: str = 'Option B'
+OPTION_A: OptionKey = 'Option A'
+OPTION_B: OptionKey = 'Option B'
 TROPHY_EMOJI: str = '🏆'
 VOTE_FOR_OPTION_A: str = 'Vote for option A'
 VOTE_FOR_OPTION_B: str = 'Vote for option B'

src/types.py

@@ -0,0 +1,34 @@
+"""
+types.py
+
+This module defines custom types for the application to enforce the structure
+of the options map used in the user interface. This ensures that each option
+has a consistent structure including both the provider and the associated voice.
+"""
+
+from typing import TypedDict, Literal, Dict
+
+
+TTSProviderName = Literal['Hume AI', 'ElevenLabs', 'Unknown']
+"""TTSProviderName represents the allowed provider names for TTS services."""
+
+
+class OptionDetails(TypedDict):
+    """
+    A typed dictionary representing the details of an option.
+
+    Attributes:
+        provider (TTSProviderName): The name of the provider (either 'Hume AI' or 'ElevenLabs').
+        voice (str): The name of the voice associated with the option.
+    """
+    provider: TTSProviderName
+    voice: str
+
+
+OptionKey = Literal['Option A', 'Option B']
+"""OptionKey is restricted to the literal values 'Option A' or 'Option B'."""
+
+
+OptionMap = Dict[OptionKey, OptionDetails]
+"""OptionMap defines the structure of the options mapping, where each key is an OptionKey
+and the value is an OptionDetails dictionary."""