betabounty-sdk/CHANGELOG.md

BetaBounty SDK for integrating user testing widgets into web applications

# Changelog

All notable changes to the BetaBounty SDK will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.1.0-beta.1] - 2024-01-24

### Added
- Initial beta release of BetaBounty SDK
- Core widget functionality for user testing sessions
- Session detection from URL parameters
- Interactive testing widget with task management
- Issue reporting and note-taking capabilities
- Screen recording reminder for video-required bounties
- Comprehensive TypeScript support with full type definitions
- Production-ready logging with debug mode
- Automatic context collection (user actions, errors, performance)
- Session state persistence across page refreshes
- Mock mode for development and testing
- Support for completed/expired session validation
- Responsive design for desktop and mobile devices

### Features
- **Widget Components**:
  - SessionWelcome - Initial testing screen
  - ActiveTesting - Main testing interface
  - SessionComplete - Completion confirmation
  - ScreenRecordingReminder - Video recording instructions with countdown
  - IssueReporter - Bug reporting interface
  - TaskManager - Guided task completion

- **Core SDK Functions**:
  - `initializeSDK()` - Main initialization function
  - Session lifecycle management (start, pause, resume, complete)
  - Automatic API communication
  - Error handling and recovery
  - Context data collection

- **Developer Experience**:
  - Full TypeScript support
  - Comprehensive documentation
  - Example implementations for React, Vue, and Vanilla JS
  - Debug logging for development
  - Production-optimized builds

### Technical Details
- Built with React 19 and TypeScript
- Bundled with Vite for optimal performance
- Uses modern ES modules
- Includes both UMD and ES module exports
- Comprehensive error handling
- Production-ready logging levels

### Browser Support
- Chrome (recommended)
- Firefox
- Safari  
- Edge

---

## [Unreleased]

### Planned Features
- Additional widget themes and customization options
- Enhanced mobile responsiveness
- More granular error reporting
- Performance optimizations
- Additional browser support

---

**Legend:**
- `Added` for new features
- `Changed` for changes in existing functionality  
- `Deprecated` for soon-to-be removed features
- `Removed` for now removed features
- `Fixed` for any bug fixes
- `Security` for vulnerability fixes