@mirad-work/sms-core/CHANGELOG.md

A framework-agnostic TypeScript SMS service core with provider abstraction for Iranian SMS providers

# 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).

## [0.5.1] - 2026-07-16

### Fixed

- **Malformed timeout configuration no longer breaks every request**: a non-numeric `SMS_TIMEOUT`
  (e.g. `SMS_TIMEOUT=fast`) parsed to `NaN`, and because `setTimeout(fn, NaN)` fires immediately,
  every SMS request was aborted before it could be sent. `SmsConfigManager.fromEnvironment()` now
  falls back to the default (`10000` ms) for absent, empty, non-numeric, or non-positive values.
- `SMS_MOCK_DELAY` is parsed the same way, falling back to `0` instead of `NaN`.
- `HttpClient` now rejects non-finite timeouts. The previous `timeout <= 0` guard did not catch
  `NaN` (`NaN <= 0` is `false`), so an invalid timeout was accepted and silently aborted requests.
  Both the constructor and per-request `timeout` overrides are validated.

### Added

- `./package.json` subpath to the `exports` map, so tooling can read package metadata.

## [0.5.0] - 2026-06-13

### Changed

- **Melipayamak Driver**: migrated to the REST `BaseServiceNumber` API for shared-service template
  messages, replacing the previous SOAP-based integration
  - Uses `username`/`password` credentials against `https://rest.payamak-panel.com/api/SendSMS/`
  - Tokens are sent as semicolon-separated template variables
  - Provider status codes are mapped to descriptive error messages

## [0.4.0] - 2025-11-30

### Added

- **IPPanel Driver**: Added full support for IPPanel SMS provider
  - Pattern-based SMS sending via `/api/v1/sms/pattern/normal/send` endpoint
  - API key authentication via header
  - Support for dynamic variables in templates
  - Comprehensive error handling for IPPanel API responses
  - Environment variable configuration support (`SMS_IPPANEL_API_KEY`, `SMS_IPPANEL_LINE_NUMBER`, `SMS_IPPANEL_URL`)
  - Factory method `createIppanelSmsService()` for easy setup
  - Full TypeScript type definitions

### Changed

- Updated driver factory to support IPPanel driver type
- Extended configuration manager to handle IPPanel settings

## [0.2.0] - 2025-01-27

### Changed

- **BREAKING CHANGE**: Package name changed from `mirad-sms-core` to `@mirad-work/sms-core` to align
  with Mirad Work Organization's scoped package naming convention
  - Update your imports from `import { ... } from "mirad-sms-core"` to
    `import { ... } from "@mirad-work/sms-core"`
  - Update your package.json dependencies from `"mirad-sms-core"` to `"@mirad-work/sms-core"`
  - This change affects all existing installations and requires manual migration
  - See [Migration Guide](MIGRATION.md) for detailed instructions

## [Unreleased]

### Added

- Initial release of Mirad SMS Core
- Support for Kavenegar SMS provider
- Support for SMS.ir provider
- Support for Melipayamak provider
- Support for IPPanel SMS provider
- Mock driver for testing
- TypeScript-first architecture
- Comprehensive error handling
- Environment-based configuration
- HTTP client abstraction
- Verification SMS support
- Template-based messaging
- Production-ready logging
- Comprehensive test suite

### Features

- Framework-agnostic design
- Multiple SMS provider support
- Flexible configuration options
- Type-safe API
- Comprehensive documentation
- MIT License

## [0.1.1] - 2025-08-20

### Added

- Initial public release
- Core SMS service functionality
- Driver pattern implementation
- Configuration management
- Error handling and exceptions
- HTTP client utilities
- TypeScript interfaces and types
- Comprehensive documentation
- Example usage and integration guides
- Testing framework and examples

### Supported Providers

- Kavenegar (verification APIs)
- SMS.ir (template messaging)
- Melipayamak (pattern-based SMS)
- Mock driver (testing)

### Technical Features

- Node.js 18+ support
- TypeScript 5.9+ support
- Jest testing framework
- ESLint and Prettier configuration
- Husky pre-commit hooks
- GitHub Actions CI/CD
- NPM package publishing setup

---

## Version History

- **0.5.1** - Fixed malformed timeout configuration silently aborting every request
- **0.5.0** - Migrated Melipayamak driver to the REST BaseServiceNumber API
- **0.4.0** - Added IPPanel SMS provider support
- **0.2.0** - Package name change to scoped package (@mirad-work/sms-core) - **BREAKING CHANGE**
- **0.1.1** - Initial release with core functionality and multiple provider support

## Contributing

Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct and the process for
submitting pull requests.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.