autowebhook/CHANGELOG.md

Automatic ngrok tunnel manager with health checking for webhooks

# Changelog

All notable changes to this project 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).

## [3.0.0] - 2025-09-05

### Changed
- **BREAKING CHANGE**: Package now publishes compiled JavaScript instead of raw TypeScript files
- Switch moduleResolution from 'node' to 'bundler' for better compatibility with modern build tools
- Package now includes both ESM (`index.js`) and CommonJS (`index.cjs`) builds for maximum compatibility
- Source TypeScript files are no longer included in the npm package, only compiled output and type definitions
- Improved CI/CD pipeline with comprehensive matrix testing and automated GitHub releases

### Added
- Dual build system supporting both ES modules and CommonJS
- Comprehensive build scripts with separate TypeScript compilation and bundling
- Enhanced GitHub Actions workflows with build verification and caching
- Automated GitHub release creation with generated release notes
- Support for npm provenance attestation for enhanced security

### Fixed
- Resolved TypeScript compilation issues with stricter compiler options
- Fixed CI/CD pipeline failures with postpack script during dry-run publishing
- Improved package structure to exclude development files from npm distribution

## [2.2.0] - 2025-09-05

### Added
- Enhanced TypeScript configuration with stricter compiler options
- Comprehensive CI/CD pipeline with GitHub Actions
- Automated testing and linting in continuous integration
- Package publishing automation with tag-based releases

### Changed
- Improved project structure and build configuration
- Updated package metadata with repository information
- Enhanced development scripts for better DX

## [2.1.0] - 2025-09-05

### Added
- **Expanded ngrok Functionality**: Added support for more advanced ngrok features:
  - **TCP Tunnels**: Create tunnels for non-HTTP traffic (e.g., SSH, databases) using the `proto: 'tcp'` option.
  - **Custom Domains**: Support for custom hostnames with the `hostname` option (requires a paid ngrok plan).
  - **IP Whitelisting**: Restrict tunnel access to specific IP addresses using the `allow_cidr` option.
  - **Basic Auth**: Added support for password-protecting tunnels using the `basic_auth` option.

### Fixed
- Fixed a TypeScript error (`Object is possibly 'undefined'`) in the ngrok provider that occurred during tunnel URL retrieval.

## [2.0.0] - 2025-09-03

### Added
- **Multi-Tunnel Support**: Added the ability to configure and manage multiple tunnels simultaneously, enabling use cases like load balancing and A/B testing.

### Changed
- **BREAKING CHANGE**: The configuration now accepts a `tunnels` array to define multiple tunnels. The previous `providers` array for fallback has been removed.
- **Event-Driven Architecture**: Replaced specific callbacks like `onUrlChange` and `onProviderChange` with a more flexible event-based system (`tunnelReady`, `tunnelDown`) to better handle multiple tunnels.

## [1.3.0] - 2025-09-03

### Added
- **Multi-Provider Support**: Added support for multiple tunnel providers, starting with `ngrok` and `localhost.run`.
- **Provider Fallback**: The library can now automatically switch to a different provider if the active one fails its health checks.

### Changed
- **Major Refactoring**: The core logic was significantly refactored from being `ngrok`-specific to supporting a provider-based architecture.

## [1.2.0] - 2025-09-03

### Added
- **Expanded Debug Logs**: An `expanded` flag was added to the configuration to enable detailed logging for health checks, including ping times and status updates.

## [1.1.0] - 2025-09-02

### Changed
- Refactored the ngrok tunnel startup logic to use the ngrok agent API for URL retrieval instead of parsing stdout. This provides a more robust and reliable way to get the tunnel URL.
- The entire project documentation (README, EXAMPLES) and source code comments have been translated from Russian to English.

### Fixed
- Corrected TypeScript errors related to `exactOptionalPropertyTypes` by adjusting type definitions for optional class properties.
- Fixed a timeout bug during startup where the ngrok URL was not found in time. The new API polling method resolves this.

### Added
- Comprehensive documentation in English, including `README.md` and `EXAMPLES.md`.
- CI/CD pipeline using GitHub Actions for automatic package publishing to npm.

## [1.0.0] - 2025-09-02

### Added
- Initial release of AutoWebhook.
- Automatic management of the ngrok tunnel.
- Health checker with configurable intervals.
- Automatic restart on tunnel failures.
- Support for multiple ngrok regions.
- Full TypeScript support with type definitions.
- Event-driven architecture for monitoring tunnel status.
- Graceful shutdown handling.