1  # Script Reference
  2  
  3  This section provides an overview of the main JavaScript and Python classes and their key methods used throughout the AI-enhanced CV system. For more detailed API documentation, please refer to the [JSDoc-generated HTML documentation](jsdoc_output/index.html) for JavaScript components.
  4  
  5  ## JavaScript Components
  6  
  7  ### `ActivityAnalyzer` (`.github/scripts/activity-analyzer.js`)
  8  
  9  **Role**: Responsible for collecting and analyzing GitHub activity data to generate professional metrics.
 10  
 11  ### Key Methods:
 12  
 13  *   `analyze()`: Runs the comprehensive activity analysis pipeline.
 14  *   `analyzeUserProfile()`: Analyzes basic user profile statistics.
 15  *   `analyzeRepositories()`: Analyzes user repositories with detailed metrics.
 16  *   `analyzeActivityPatterns()`: Analyzes activity patterns and contribution consistency.
 17  *   `calculateProfessionalMetrics()`: Calculates comprehensive professional development metrics.
 18  *   `analyzeSkillProficiency()`: Analyzes skill proficiency based on language usage and project complexity.
 19  
 20  ### `ClaudeApiClient` (`.github/scripts/claude-enhancer.js`)
 21  
 22  **Role**: Provides an enhanced HTTP client for interacting with the Claude API, including caching and token optimization.
 23  
 24  ### Key Methods:
 25  
 26  *   `makeRequest(messages, options, sourceContent)`: Makes a Claude API request with caching and token tracking.
 27  *   `httpRequest(url, options, maxRetries, retryDelay)`: HTTP request wrapper with retry logic and exponential backoff.
 28  *   `generateCacheKey(requestPayload, sourceContent)`: Generates a content-aware cache key for request deduplication.
 29  *   `getCachedResponse(cacheKey)`: Retrieves a cached response.
 30  *   `cacheResponse(cacheKey, response)`: Caches an API response.
 31  *   `getUsageStats()`: Returns token usage statistics.
 32  
 33  ### `CVContentEnhancer` (`.github/scripts/claude-enhancer.js`)
 34  
 35  **Role**: Orchestrates the multi-stage AI enhancement pipeline for professional CV content.
 36  
 37  ### Key Methods:
 38  
 39  *   `enhance()`: Runs the comprehensive CV content enhancement pipeline.
 40  *   `enhanceProfessionalSummary(cvData, activityMetrics)`: Enhances the professional summary with AI optimization.
 41  *   `enhanceSkillsSection(cvData, activityMetrics)`: Enhances the skills section with proficiency analysis.
 42  *   `enhanceExperience(cvData, activityMetrics)`: Enhances experience descriptions.
 43  *   `enhanceProjects(cvData, activityMetrics)`: Enhances project descriptions with impact analysis.
 44  *   `generateStrategicInsights(cvData, activityMetrics)`: Generates strategic career insights.
 45  
 46  ### `CVGenerator` (`.github/scripts/cv-generator.js`)
 47  
 48  **Role**: Compiles all CV data sources into a production-ready website with verified GitHub metrics integration.
 49  
 50  ### Key Methods:
 51  
 52  *   `generate()`: Runs the complete CV website generation pipeline with GitHub data integration.
 53  *   `loadDataSources()`: Loads and validates all data sources including activity data, CV data, and AI enhancements.
 54  *   `validateActivityData()`: Validates and sanitizes GitHub activity metrics for data integrity.
 55  *   `updateGitHubMetrics(htmlContent)`: Replaces placeholder metrics with verified GitHub data.
 56  *   `updateStructuredDataWithGitHubSkills(htmlContent)`: Enhances structured data with GitHub-verified skills.
 57  *   `calculateCredibilityScore(summary, professionalMetrics)`: Calculates data integrity score based on GitHub metrics completeness.
 58  
 59  ### GitHub Data Integration Features:
 60  
 61  *   **Real-time Metrics**: Displays actual GitHub commit counts, activity scores, and contribution data
 62  *   **Data Validation**: Comprehensive validation and sanitization of all GitHub metrics
 63  *   **Fallback Mechanisms**: Graceful degradation when GitHub data is unavailable
 64  *   **Credibility Scoring**: Transparency scoring based on data verification and completeness
 65  *   **Skills Enhancement**: Structured data enhanced with GitHub-verified programming languages
 66  *   `generateHTML()`: Generates the HTML file with dynamic content.
 67  *   `processHTMLTemplate(htmlContent)`: Processes the HTML template with dynamic data.
 68  *   `copyAssets()`: Copies assets to the output directory.
 69  *   `generateSitemap()`: Generates `sitemap.xml`.
 70  *   `generateRobotsTxt()`: Generates `robots.txt`.
 71  *   `generateManifest()`: Generates web manifest.
 72  *   `generateGitHubPagesFiles()`: Generates GitHub Pages specific files.
 73  *   `generatePDF()`: Generates a high-quality PDF from the generated HTML.
 74  
 75  ### `CVApplication` (`assets/script.js`)
 76  
 77  **Role**: The main application controller for the interactive frontend of the CV.
 78  
 79  ### Key Methods:
 80  
 81  *   `init()`: Initializes the application.
 82  *   `setupEventListeners()`: Sets up event listeners for user interactions.
 83  *   `setupNavigationSystem()`: Sets up the navigation system.
 84  *   `setupThemeToggle()`: Sets up theme toggle functionality.
 85  *   `loadApplicationData()`: Loads application data from various sources.
 86  *   `initializeLiveStats()`: Initializes live statistics display.
 87  *   `updateLiveStats()`: Updates live statistics in the header.
 88  *   `initializeContentSections()`: Initializes content sections.
 89  *   `navigateToSection(sectionId)`: Navigates to a specific section.
 90  *   `toggleTheme()`: Toggles theme between dark and light.
 91  *   `refreshLiveData()`: Refreshes live data.
 92  
 93  ## Python Components
 94  
 95  ### `ConfigManager` (`src/python/config_manager/config_manager.py`)
 96  
 97  **Role**: Manages application configurations from `.ini` files and environment variables.
 98  
 99  ### Key Methods:
100  
101  *   `__init__(config_file=None)`: Initializes the ConfigManager, optionally loading from a file.
102  *   `get(section, option, default=None)`: Retrieves a configuration value, prioritizing environment variables.
103  *   `get_int(section, option, default=None)`: Retrieves an integer configuration value.
104  *   `get_boolean(section, option, default=None)`: Retrieves a boolean configuration value.
105  
106  ### `DataValidator` (`src/python/data_validation/data_validator.py`)
107  
108  **Role**: Provides static methods for common data validation tasks.
109  
110  ### Key Methods:
111  
112  *   `is_not_empty(value, field_name="Value")`: Checks if a value is not None and not empty.
113  *   `is_type(value, expected_type, field_name="Value")`: Checks if a value is of the expected type.
114  *   `is_in_range(value, min_val, max_val, field_name="Value")`: Checks if a numeric value is within a specified range.
115  *   `matches_regex(value, pattern, field_name="Value")`: Checks if a string matches a regex pattern.
116  *   `is_email(value, field_name="Email")`: Checks if a string is a valid email format.
117  *   `is_url(value, field_name="URL")`: Checks if a string is a valid URL format.
118  
119  ### Logging Utilities (`src/python/utils/logging_utils.py`)
120  
121  **Role**: Provides functions for setting up and managing application logging.
122  
123  ### Key Functions:
124  
125  *   `setup_logger(name, log_file, level=logging.INFO)`: Sets up a logger that writes to a file and the console.
126  
127  ### `MetricsCollector` (`src/python/utils/logging_utils.py`)
128  
129  **Role**: A simple class to collect and store application metrics.
130  
131  ### Key Methods:
132  
133  *   `__init__()`: Initializes the MetricsCollector.
134  *   `collect(name, value)`: Collects a single metric.
135  *   `get_metrics()`: Returns all collected metrics.
136  *   `save_metrics(file_path)`: Saves the collected metrics to a JSON file.
137  
138  ### External API Wrappers (`src/python/api_wrappers/external_apis.py`)
139  
140  **Role**: Provides wrappers for interacting with third-party APIs (e.g., firmographics, funding data).
141  
142  ### Key Classes:
143  
144  *   `AbstractApiWrapper`: Wrapper for the Abstract API for firmographics data.
145      *   `get_company_info(domain)`: Fetches company information by domain.
146  *   `IntellizenceApiWrapper`: Wrapper for the Intellizence Startup Funding Dataset API.
147      *   `get_funding_data(query_params=None)`: Fetches funding data based on query parameters.