|
| 1 | +# Changelog |
| 2 | + |
| 3 | +All notable changes to this project will be documented in this file. |
| 4 | + |
| 5 | +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), |
| 6 | +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). |
| 7 | + |
| 8 | +## [2.0.0] - 1/7/2026 |
| 9 | + |
| 10 | +### Changed |
| 11 | +- **Versioning Correction:** Re-released as v2.0.0 to properly indicate breaking changes that were inadvertently introduced in v1.10.1 |
| 12 | +- No code changes from v1.12.1 - this is a versioning correction to follow semantic versioning |
| 13 | +- Versions v1.10.1 through v1.12.1 are now deprecated on npm in favor of this properly versioned v2.0.0 release |
| 14 | + |
| 15 | +### ⚠️ BREAKING CHANGES (from v1.10.0) |
| 16 | + |
| 17 | +**API Class Restructure:** The unified `MxPlatformApi` class has been replaced with granular, domain-specific API classes (e.g., `UsersApi`, `MembersApi`, `AccountsApi`) to better align with the OpenAPI specification structure. This change improves code organization and maintainability but requires migration of existing code. |
| 18 | + |
| 19 | +**Note:** This breaking change was originally introduced in v1.10.1 but should have been released as v2.0.0. If you are currently using v1.10.1 through v1.12.1, the code is functionally identical to v2.0.0. |
| 20 | + |
| 21 | +**See [MIGRATION.md](MIGRATION.md) for detailed upgrade instructions.** |
| 22 | + |
| 23 | +### Changed |
| 24 | +- Restructured API classes from single `MxPlatformApi` to domain-specific classes |
| 25 | + |
| 26 | +## [1.12.1] - 11/25/2025 |
| 27 | + |
| 28 | +### Fixed |
| 29 | +- Updated package template (`package.mustache`) to fix recurring dependency regression |
| 30 | + - axios: ^0.21.4 → ^1.6.8 (fixes CVE GHSA-wf5p-g6vw-rhxx) |
| 31 | + - typescript: ^3.6.4 → ^5.4.5 |
| 32 | + - @types/node: ^12.11.5 → ^20.12.7 |
| 33 | +- Added automated validation workflow to prevent template/package.json drift |
| 34 | + |
| 35 | +### ⚠️ DEPRECATED |
| 36 | +This version contains breaking API changes that should have been released as v2.0.0. Please upgrade to v2.0.0 (code is functionally identical, just properly versioned). |
| 37 | + |
| 38 | +## [1.12.0] and earlier (1.10.1 - 1.12.0) - Various dates |
| 39 | + |
| 40 | +### ⚠️ DEPRECATED |
| 41 | +These versions (v1.10.1 through v1.12.0) contain the breaking API restructure but were incorrectly published as minor/patch releases instead of a major version. They have been deprecated on npm in favor of v2.0.0. |
| 42 | + |
| 43 | +**If you are on any of these versions:** Please upgrade to v2.0.0. |
| 44 | + |
| 45 | +## [1.10.0] - 11/5/2025 |
| 46 | + |
| 47 | +### Note |
| 48 | +- Last stable version with unified `MxPlatformApi` class |
| 49 | +- Upgrade from this version to v2.0.0 requires code changes (see [MIGRATION.md](MIGRATION.md)) |
| 50 | + |
| 51 | +--- |
| 52 | + |
| 53 | +**Note:** This CHANGELOG was created retroactively. For detailed version history prior to v2.0.0, please refer to the [commit history](https://github.com/mxenabled/mx-platform-node/commits/master). |
0 commit comments