From ca97b4e016f65372570f3b3c3d4e83d06f535fb1 Mon Sep 17 00:00:00 2001 From: "flashduty[bot]" Date: Mon, 21 Sep 2026 05:19:49 -0700 Subject: [PATCH] docs(changelog): mark the v0.3.0 behaviour and session-API changes as breaking MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The v0.3.0 entry describes two changes that alter existing installations rather than only adding to them, and neither carries the 💥 marker the legend defines for a breaking change: - `startSessionReplayRecordingManually` now defaults to false whenever `remoteConfigurationEnabled` is on, so a site that gates recording on consent by calling `startSessionReplayRecording()` itself starts recording — and has replays uploaded and billed — without changing anything on its side. It is currently logged as 🐛 only. - `SessionManager.updateSessionState`, exported from `@flashcatcloud/browser-core`, changed shape in this release: it takes an updater function where it used to take a `Partial`. That is the case v0.2.0 already covers with a 💥 line of its own ("Breaking for TypeScript code that implements our interfaces"), and this release does not mention it. Docs only: no source file is touched. --- CHANGELOG.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 63c38904d7..a9f3e75030 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -20,6 +20,17 @@ ## v0.3.0 +- 💥 **Breaking**: `startSessionReplayRecordingManually` no longer defaults to `true` on an init + `sessionReplaySampleRate` of 0 when `remoteConfigurationEnabled` is on. The recorder now starts on + its own, so a rate delivered from the console has something to withhold — and replays are uploaded + and billed. A site that gates recording on consent by calling `startSessionReplayRecording()` + itself must pass `startSessionReplayRecordingManually: true` explicitly; without it, a session + starts recording before that call. The 🐛 entry below describes the same change. +- 💥 **Breaking for TypeScript code that calls our session APIs**: + `SessionManager.updateSessionState`, exported from `@flashcatcloud/browser-core`, now takes an + updater function `(state: SessionState) => Partial | undefined` instead of a + `Partial`. Code that only uses the RUM entry points is unaffected; code that calls + this method must wrap its patch in a function. - ✨ Two new init options keep only the sessions that report an error, for customers who want every error investigated without storing and paying for every session. `sessionOnError` keeps the events of a session the plain `sessionSampleRate` draw missed: it records from the start, uploads