@newrelic/video-core 4.1.6-beta → 4.1.6

package/CHANGELOG.md

@@ -1,35 +1,79 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
-## [4.1.5-beta] - 2025/01/19
+## [4.1.6] - 2026/04/16
 
-### Fix
+### Chore
+
+- **README.md overhaul**
+  Rewrote `README.md` with comprehensive documentation including table of contents, installation instructions, quick start guide, configuration reference, exposed API details, custom tracker guide, getter methods reference, QoE section, obfuscation rules, build & development instructions, and distribution formats.
+
+## [4.1.5] - 2026/04/08
+
+### Changed
+
+- **Bitrate attribute and method renaming**
+  Renamed bitrate attributes and their corresponding getter methods for better clarity:
+  - Attribute: `contentMeasuredBitrate` → `contentSegmentDownloadBitrate`
+  - Method: `getMeasuredBitrate()` → `getSegmentDownloadBitrate()`
+  - Attribute: `contentDownloadBitrate` → `contentNetworkDownloadBitrate`
+  - Method: `getDownloadBitrate()` → `getNetworkDownloadBitrate()`
+
+### Removed
+
+- **Deprecated rendition bitrate attributes**
+  Removed `contentRenditionBitrate` and `adRenditionBitrate` attributes from `getAttributes()` in `videotracker.js`. These attributes are no longer included in video events.
+
+- **Updated data model documentation**
+  Updated `DATAMODEL.md` to reflect the removal of rendition bitrate attributes and the renaming of download bitrate attributes.
 
-- update configs for correct module resolution for consumer
+## [4.1.4] - 2026/03/31
 
-## [4.1.1-beta] - 2025/12/19
+### Feat
 
-## Fix
+- **Add obfuscation rules support for pre-harvest payload masking**
+  Introduces regex-based obfuscation rules that mask sensitive data in event payloads before they are sent to New Relic. Allows configuration of custom regex patterns with replacement strings to protect PII and sensitive tokens. Rules are applied in order to the serialized JSON payload, with invalid regex patterns logged as warnings and skipped.
 
-- Added an attribute numberOfErrors in QOE KPIs attribute.
+## [4.1.3] - 2026/03/24
 
-## [4.1.3-beta] - 2025/01/16
+### Fix
+
+- **Bitrate attributes default to 0 instead of null**
+  Updated `getAttributes()` in `videotracker.js` to fallback bitrate values (`contentBitrate`, `contentRenditionBitrate`, `contentManifestBitrate`, `contentMeasuredBitrate`, `contentDownloadBitrate`) to `0` when null, preventing attributes from being dropped by `cleanData`.
+
+## [4.1.2] - 2026/03/18
 
 ### Fix
 
-- Update logic for average bitrate to consider correct delta time
+- **QoE aggregate improvements - KPI accuracy**
+  Fixed startup time, average bitrate, and rebuffering time calculations for more accurate QoE KPI reporting
+
+- **QoE harvest lifecycle and dedup**
+  Improved harvest cycle management with state refresh before drain, forced QoE at `CONTENT_END`, cross-cycle dirty check to skip unchanged KPIs.
+
+- **Rename QOE playback failure attrs to error**
+  Renamed `hadStartupFailure` and `hadPlaybackFailure` properties to `hadStartupError` and `hadPlaybackError` in `videotrackerstate.js` to align with error terminology.
 
-## [4.1.4-beta] - 2025/01/19
+## [4.1.1] - 2026/03/13
 
 ### Fix
+- Added bitrate related changes](d588f72)
+- Added qoe harvest cycle multiplier
 
-- Excluded test folder from module.exports in webpack config
+## [4.1.0] - 2026/02/18
 
-## [4.1.0-beta] - 2025/12/18
+### Feat
+
+- **Add QOE health index KPIs with toggle config**
+  Introduced Quality of Experience (QOE) health index key performance indicators with configurable toggle to enable/disable tracking
+
+## [4.0.3] - 2026/01/29
+
+### Fix
 
-### Feature
+- **Drop bitrate values before start**
+  Modified `getAttributes()` in `videotracker.js` to check `this.state.isStarted` before adding bitrate attributes
 
-- Add QOE KPIs attributes for VideoAction event with updated DATAMODEL.md
 
 ## [4.0.2] - 2025/11/03