openaudio-suite 2.5.6 → 2.6.3

package/CHANGELOG.md

@@ -2,201 +2,261 @@
 
 All notable changes to the OpenAudio suite are documented here.
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/), and this project adheres to [Semantic Versioning](https://semver.org/).
-
-## v2.5.0 – 2026-03-15
-### Improvements
-- Added consistent **semantic versioning** strategy across releases.
-- Added **package-lock.json** to support reproducible installs and GitHub Actions CI.
-- No changes to OpenAudio JS files; all improvements are tooling and release management.
+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/).
 
 ---
+## OpenAudio.js
 
+### [1.4.0] — 2026-03-17
 ## OpenAudio.js
+ * <Strong>Lazy Loading</strong>: The audio source is set only when play() is called for the first time, <em>optimizing performance</em> by avoiding unnecessary network requests.
+ * <strong>Enhanced Error Handling</strong>: <em>Additional</em> error checks and informative error messages are added to ensure robust error handling.
+ * <strong>Improved Readability</strong>: Comments are <em>added</em> to explain complex parts of the code, making it easier to understand.<br><br>
+<em>Patched version should be more robust, performant, and easier to maintain.</em>
+
+### [1.3.0] — 2026-03-16
+
+#### Fixed
+- **`#isUnlocked` flag** — The silent-MP3 unlock is now performed only once per instance. Previously, every `play()` call (including replays) re-ran the full unlock dance: discarding all buffered/preloaded audio, reassigning `src` to the silent MP3, awaiting the Promise, then restoring the real `src`. This meant the constructor's `preload = 'auto'` was silently wasted on every play. From 1.3.0, subsequent `play()` calls skip directly to `#playClip()` — preloaded data is preserved and replay latency is eliminated.
+- **`#playCancelled` flag** — `stop()` now plants a cancellation token that the in-flight unlock `.then()` checks before calling `#playClip()`. Previously, calling `stop()` during an async unlock was a race: the `.then()` would resolve ~50–200 ms later and start the clip anyway, overriding the explicit stop.
+- **`isPlaying` encapsulation** — `isPlaying` is now a private field (`#isPlaying`) exposed via a read-only getter. Previously a plain public property, it could be written by callers to silently corrupt the state machine.
+- **`#isPlaying` race in `#playClip()`** — `#isPlaying` is now set `true` synchronously before `#audio.play()`, closing the double-play race window where a rapid second `play()` call between the `.play()` call and its `.then()` resolution could bypass the guard and attempt concurrent playback. `#isPlaying` is reverted in `.catch()` on failure.
+- **`resume()` race in `#onVisibilityChange()`** — The visibility-restore `.play()` path now uses the same pre-set/revert pattern. Previously, a concurrent `stop()` in the `.then()` window could leave `isPlaying = true` after `stop()` had set it to `false`.
+- **`destroy()` resource release** — Uses `removeAttribute('src')` + `load()` per the WHATWG HTMLMediaElement resource-release spec, replacing `src = ''` which can fire spurious `error` events on some browsers.
+- **`#pausedByVisibility` in `destroy()`** — Now reset to `false` during teardown for consistent state.
+- **Removed unreachable optional chain** — `this.#audio?.pause()` in `#playClip()` `.then()` was unreachable since `#isDestroyed` implies `destroy()` already paused; removed to avoid misleading readers.
+
+---
 
-### [1.1.0] — 2025-03-15
+### [1.2.0] — 2026-03-16
 
+#### Fixed
+- **Unlock now plays on the shared `#audio` element** — Previously the silent MP3 was played on a throwaway `new Audio()`, blessing the wrong element. On iOS Safari this caused `NotAllowedError` for every clip after the first. The shared element is now unlocked directly.
+- **`#isDestroyed` flag** — All public methods (`play`, `stop`, `destroy`) are safe no-ops after `destroy()` has been called, preventing throws on the nulled `#audio` element.
+- **Double-`destroy()` safe** — Calling `destroy()` more than once no longer throws.
+- **`ended` listener stored and removed** — `#endedHandler` is now stored as a named reference and removed in `destroy()`, preventing a callback-into-null race on teardown.
+- **`canPlay()` input guard** — Returns `false` for non-string or empty input rather than passing `undefined` to `canPlayType()`.
+
+---
+
+### [1.1.0] — 2026-03-16
 #### Added
-- **Background tab detection** — Listens to Page Visibility API (`document.visibilitychange`)
-- **`pauseOnHidden` option** — Pause audio when tab hides, resume when tab returns
-- **`onHidden` callback** — Fires when tab becomes hidden
-- **`onVisible` callback** — Fires when tab becomes visible
-- **`#boundVisibility` bound listener** — Proper cleanup prevents stale listeners in SPAs
+- Background tab detection via Page Visibility API (`document.visibilitychange`)
+- `pauseOnHidden` option — pause audio when tab hides, resume when tab returns
+- `onHidden` callback — fires when tab becomes hidden
+- `onVisible` callback — fires when tab becomes visible
+- `#boundVisibility` bound listener — proper cleanup prevents stale listeners in SPAs
 
 #### Fixed
-- Stale visibilitychange listeners in SPA environments (React, Vue, Svelte, etc.)
+- Stale `visibilitychange` listeners in SPA environments
 - Listener cleanup in `destroy()` now removes the exact function reference
 
 #### Changed
 - Class renamed: `SingleAudio` → `OpenAudio` (matches filename)
-- Improved documentation with background tab behavior examples
 
 ---
 
-### [1.0.0] — 2025-01-15
+### [1.0.0] — 2026-03-16
 
 #### Added
-- Initial release: Single-clip, one-shot player
+- Initial release: single-clip, one-shot player
 - Silent MP3 unlock for autoplay policy compliance
 - `onPlay` and `onEnd` callbacks
 - `destroy()` method for SPA cleanup
 - `canPlay()` static format checking
-- Complete API documentation
 
 ---
 
 ## OpenAudio_s.js
 
-### [1.0.0] — 2025-01-15
+### [1.3.0] — 2026-03-16
+
+#### Fixed
+- **`#playCancelled` flag** — `stop()` and `reset()` now plant a cancellation token that the in-flight silent-MP3 unlock `.then()` checks before calling `#playClip()`. Previously, calling `reset()` or `stop()` during the ~50–200 ms unlock window was silently ignored: the unlock `.then()` would fire unconditionally and start the first clip regardless. The fix mirrors the pattern introduced in `OpenAudio.js` 1.3.0.
+
+#### Changed
+- **Usage example** — `goto(getCurrentIndex() - 1)` in the guided-tour example now uses `Math.max(0, …)`, preventing a spurious out-of-range `console.warn` when the user is already on clip 0.
+
+#### Documentation
+- `stop()` method note updated to describe both the auto-advance timer cancellation (v1.2.0) and the new unlock cancellation (v1.3.0).
+- `play()` JSDoc updated with a design note explaining that `#isStarted` becomes `true` after the unlock resolves (inside `#playClip()`), and why this intentionally differs from `OpenAudio_r.js`.
+
+---
+
+### [1.2.0] — 2026-03-16
+
+#### Fixed
+- **`isPlaying` + `isStarted` encapsulation** — Both are now private fields (`#isPlaying`, `#isStarted`) exposed via read-only getters. Previously plain public properties, they could be written by callers to silently corrupt the state machine and all navigation guards.
+- **`#isPlaying` / `#isStarted` race in `#playClip()`** — Both flags are now set `true` synchronously before `#audio.play()`, closing the double-play race window where a rapid `next()` or `goto()` between the `.play()` call and its `.then()` resolution could bypass guards and abort a starting clip. `#isPlaying` is reverted in `.catch()` on failure.
+- **`#advanceTimer`** — The auto-advance `setTimeout` handle is now stored and cleared by `stop()`, `reset()`, and `destroy()`. Previously, calling `stop()` or `reset()` during the advance delay window could not cancel the pending `next()`, causing the next clip to start after an explicit stop.
+- **`resume()` race** — `#isPlaying` is now set `true` synchronously before `#audio.play()` in `resume()`, then reverted in `.catch()`. Previously the `.then()` could set `isPlaying = true` after a concurrent `stop()` had already set it to `false`.
+- **`destroy()` resource release** — Uses `removeAttribute('src')` + `load()` per the WHATWG HTMLMediaElement resource-release spec, replacing `src = ''`.
+- **`getCurrentClip()` live reference** — Now returns a shallow copy `({ ...clip })` instead of a direct reference to the internal clip object. Callers can no longer mutate the internal playlist via the returned object.
+- **`getClips()` live references** — Now deep-copies inner objects via `map(c => ({ ...c }))`. Previously the shallow spread copied the array but left inner object references live.
+- **Removed unreachable optional chain** — `this.#audio?.pause()` in `#playClip()` `.then()` removed.
+
+---
+
+### [1.1.0] — 2026-03-16
+
+#### Fixed
+- **Unlock now plays on the shared `#audio` element** — Same root cause as `OpenAudio.js` 1.2.0.
+- **`play()` guard extended** — Now checks `isStarted` in addition to `isPlaying` and `#isUnlocking`.
+- **`next()` / `goto()` / `gotoLabel()` guard** — All return immediately if `!isStarted`.
+- **`pause()` / `resume()` guard** — Both check `isStarted` before touching the Audio element.
+- **`destroy()` teardown** — `ended` listener removed via stored `#endedHandler` reference before `#audio` is nulled.
+- **`#isDestroyed` flag** — All public methods are safe no-ops after `destroy()`.
 
 #### Added
-- Initial release: Sequential playlist player
+- `advanceDelay` option (default `0.5s`) — replaces the hardcoded 500ms gap between auto-advance clips.
+
+---
+
+### [1.0.0] — 2026-03-16
+
+#### Added
+- Initial release: sequential playlist player
 - Click-to-advance playback control
-- Jump to clip by index or label
+- Jump to clip by index (`goto()`) or label (`gotoLabel()`)
 - Pause/resume support
-- Progress tracking
-- Complete API documentation with usage patterns
+- Progress tracking (`getCurrentClip()`, `getCurrentIndex()`, `getClipCount()`)
 
 ---
 
 ## OpenAudio_r.js
 
-### [2.4.0] — 2025-03-15
-
-### Added
-- **`#isUnlocking` flag** — Prevents duplicate unlock attempts when `start()` is called rapidly (spam-clicks). The unlock play() is async; without this flag, a race condition allowed multiple overlapping unlock sequences.
-- **`destroy()` method** — Removes the `visibilitychange` listener. Essential for SPAs (React, Vue, Svelte, etc.) where engine instances are created and destroyed across component lifecycles. Without it, stale listeners accumulate on `document` and defunct engines wake up on every tab-focus event.
-- **`AudioEngine.canPlay(type)` static method** — Wraps `HTMLAudioElement.canPlayType()` with a clean boolean return. Use to check browser support for `.ogg`, `.wav`, or `.flac` before constructing an engine, rather than discovering a silent failure at play() time.
-- **Callback resilience for `onCycleReset`** — Wrapped in try/catch, matching the existing resilience applied to `onPlay` and `onEnd`. A throwing `onCycleReset` can no longer stall the engine loop.
-- **Comprehensive documentation** — Added HTML5 AUDIO vs. WEB AUDIO API comparison, browser autoplay policy deep-dive, background tab throttling mitigation, and callback resilience guarantees.
+### [2.6.0] — 2026-03-16
 
-### Fixed
-- Race condition where spam-clicking `start()` could trigger multiple `#scheduleNext()` calls before the first unlock completed.
-- Potential memory leak: `visibilitychange` listener now properly removed on `destroy()`.
-
-### Changed
-- Better error messages in console (include clip label and context).
+#### Fixed
+- **`TypeError` for invalid arguments** — All constructor and `addClip()` validation throws changed from `Error` to `TypeError`. This matches the ECMAScript convention that type-mismatch errors should be `TypeError`, and aligns with `OpenAudio.js` and `OpenAudio_s.js`. Callers catching errors via `instanceof TypeError` now correctly catch `AudioEngine` validation failures.
 
-### Documentation
-- Added CHANGELOG.md (this file)
-- Expanded README with better examples and API reference
-- Created CONTRIBUTING.md with PR guidelines and testing checklist
+#### Changed
+- **`#isStarted` timing** — `#isStarted` is now set `true` inside the unlock `.then()` (after the Audio element is confirmed usable), not at the top of `start()` before the unlock. The duplicate-start guard during the unlock window continues to be handled by `#isUnlocking`. This aligns the state machine semantics with `OpenAudio_s.js`.
+- **`try/catch` formatting** — Three compact single-line `try/catch` blocks (in the `onended` handler, `#resetCycle()`, and `#playNext()` `.then()`) expanded to multi-line style, matching the formatting convention used throughout the suite.
 
 ---
 
-## [2.3.0] — 2025-02-20
+### [2.5.0] — 2026-03-16
 
-### Added
-- **Clip src validation** — Constructor and `addClip()` now verify that every clip has a non-empty string `src`. Previously a clip with missing or non-string `src` would silently map `undefined` into the engine, producing a confusing audio error rather than a clear failure at the point of entry.
-- **Next-clip prefetch** — `#scheduleNext()` now sets `#audio.src` to the next selected clip immediately after the current clip ends, before the inter-clip delay fires. The browser begins buffering the file during the gap, eliminating the network fetch delay at `#playNext()` time. The clip is still marked played and selected at schedule time, preserving shuffle-bag correctness.
-- **Background tab throttling mitigation** — `#scheduleNext()` records the wall-clock time (`#timerSetAt`) and delay duration (`#timerDelay`). A `visibilitychange` listener fires when the tab returns to foreground. If elapsed time meets or exceeds the intended delay, the pending timer is cancelled and `#playNext()` is called immediately. Otherwise, the remaining time is rescheduled precisely.
+#### Fixed
+- **`isStarted` + `isPlaying` encapsulation** — Both are now private fields (`#isStarted`, `#isPlaying`) exposed via read-only getters. Previously plain public properties, they could be written by callers to silently corrupt the scheduling state machine and all internal guards.
+- **`#isDestroyed` flag** — All public methods (`start`, `stop`, `reset`, `setVolume`, `addClip`, `destroy`) now return immediately after `destroy()` has been called, making post-destroy calls safe no-ops. Previously `destroy()` documented post-destroy behaviour as "undefined"; in practice, calling `start()` after `destroy()` would silently re-run the engine without a `visibilitychange` listener, leaving it in a partially torn-down state.
+- **`destroy()` resource release** — Now releases the Audio element via `removeAttribute('src')` + `load()` per the WHATWG HTMLMediaElement resource-release spec, then nulls `#audio`. Previously the element was kept live with its src intact after `destroy()`.
+- **`#isPlaying` race in `#playNext()`** — `#isPlaying` is now set `true` synchronously before `#audio.play()`, closing the narrow race window where `isPlaying` reported `false` while audio was starting. Reverted in `.catch()` on failure.
+
+---
 
-### Fixed
-- Network latency no longer visible as gaps between clips (prefetch eliminates fetch delay).
-- Background tab throttling no longer causes clips to bunch together on tab return (recalculation uses wall-clock time, not timer promises).
+### [2.4.1] — 2026-03-16
 
-### Changed
-- Improved console logging for debugging background tab behavior.
+#### Changed
+- Licence changed from GPL-3.0-or-later to Apache-2.0 across the entire suite.
 
 ---
 
-## [2.2.0] — 2025-01-10
+### [2.4.0] — 2026-03-16
 
-### Added
-- **`reset()` method** — Stops playback, clears all `played` flags, and optionally resets the current clip. Next `start()` begins a completely fresh random cycle.
-- **`setVolume()` method** — Updates volume immediately on live playback and all future clips. Clamps to [0, 1].
+#### Added
+- `#isUnlocking` flag — prevents duplicate unlock attempts on rapid `start()` calls.
+- `destroy()` method — removes the `visibilitychange` listener.
+- `AudioEngine.canPlay(type)` static method.
+- `onCycleReset` callback wrapped in try/catch.
 
-### Fixed
-- Volume no longer resets to default on clip transition.
+#### Fixed
+- Race condition on `start()` spam.
+- Potential memory leak: `visibilitychange` listener now properly removed.
 
 ---
 
-## [2.1.0] — 2024-12-05
+### [2.3.0] — 2026-03-16
 
-### Added
-- **`addClip(clip)` method** — Add new clips to the engine at runtime without reconstructing.
-- **Cycle-boundary repeat prevention** — When the unplayed pool is empty (cycle reset), the next clip is selected from all clips *except* the current clip, preventing the same clip from playing twice in a row across a cycle boundary.
+#### Added
+- Clip `src` validation in constructor and `addClip()`.
+- Next-clip prefetch to eliminate network fetch delay.
+- Background tab throttling mitigation via wall-clock correction.
 
-### Fixed
-- Shuffle bag now correctly prevents the same clip from playing at the start and end of successive cycles.
+---
+
+### [2.2.0] — 2026-03-16
+
+#### Added
+- `reset()` method.
+- `setVolume()` method with clamping.
+- True private fields (`#`).
+- NotAllowedError handling — engine halts rather than silent-loops.
+- Silent base64 unlock in `start()`.
 
 ---
 
-## [2.0.0] — 2024-10-01
+### [2.1.1] — 2026-03-16
 
-### Added
-- **Public API methods** — `start()`, `stop()`, `start()` for public control.
-- **Lifecycle callbacks** — `onPlay(clip)`, `onEnd(clip)`, `onCycleReset()` for integration with game/app logic.
-- **Options object** — `lowTime`, `maxTime`, `volume`, and callback configuration.
-- **Shuffle bag algorithm** — Guarantees each clip plays exactly once per cycle before repeats.
-- **Browser autoplay policy handling** — Silent base64 MP3 unlock on first `start()` call, subsequent clips scheduled via `setTimeout`.
-- **Background tab throttling mitigation** — Page Visibility API monitoring and wall-clock delay recalculation.
+#### Fixed
+- Constructor validates `lowTime` and `maxTime`.
+- `#scheduleNext()` clears existing timer before setting a new one.
+- Cycle-boundary repeat fix.
+- `stop()` no longer resets `currentTime`.
+
+---
 
-### Documentation
-- Comprehensive JSDoc comments throughout
-- Browser compatibility notes
-- Web Audio API vs. HTML5 Audio comparison
-- Usage examples in code comments
+### [2.1.0] — 2026-03-16
+
+#### Added
+- `addClip()` method for runtime updates.
+- Cycle-boundary repeat prevention.
+- Single reusable Audio element created once in constructor.
 
 ---
 
-## [1.0.0] — 2024-09-01
+### [2.0.0] — 2026-03-16
 
-### Initial Release
-- Self-contained randomized audio scheduling engine
-- No dependencies, no external libraries
-- HTML5 `<audio>` element-based scheduling
-- Basic shuffle bag implementation
-- Mobile-compatible (respects autoplay policies)
+#### Added
+- Initial public release. Shuffle bag algorithm. `onPlay` / `onEnd` / `onCycleReset` callbacks. `addClip()` runtime insertion.
 
 ---
 
 ## Upgrade Guide
 
-### 2.3 → 2.4
-- **No breaking changes.** New features are additive.
-- **Recommended:** Call `engine.destroy()` when tearing down in SPAs to prevent listener accumulation.
-- **New:** Use `AudioEngine.canPlay('audio/ogg')` to check format support before constructing.
+### OpenAudio_s.js 1.2 → 1.3
+No breaking changes. `stop()` and `reset()` now cancel in-flight unlocks via `#playCancelled`; callers that relied on the previous (unintended) behaviour of the clip starting despite a `stop()` during the unlock window should review their flow, but this was never a documented or safe pattern.
 
-### 2.2 → 2.3
-- **No breaking changes.** Prefetch is transparent.
-- **Benefit:** Faster clip transitions due to network prefetch during inter-clip gap.
+### OpenAudio_r.js 2.5 → 2.6
+No breaking changes. `TypeError` is now thrown instead of `Error` for constructor and `addClip()` validation failures. If you catch these via `catch (e)` and check `e.message`, nothing changes. If you check `e instanceof Error` it still holds. Only `instanceof TypeError` (which previously returned `false`) now returns `true`.
 
-### 2.0 → 2.1
-- **No breaking changes.** New methods are additive.
-- **New:** Cycle-boundary repeat prevention automatically enabled.
+### OpenAudio.js 1.2 → 1.3
+No breaking changes. `player.isPlaying` is now read-only (getter); existing read access is unaffected. Write access (`player.isPlaying = ...`) was never a supported pattern.
 
-### 1.0 → 2.0
-- **Breaking:** Old version had no public API. Complete rewrite with methods and callbacks.
-- **Migration:** Wrap old code in a new `AudioEngine` constructor.
+### OpenAudio_s.js 1.1 → 1.2
+No breaking changes. `player.isPlaying` and `player.isStarted` are now read-only getters; existing read access is unaffected.
 
----
+### OpenAudio_r.js 2.4 → 2.5
+No breaking changes. `engine.isStarted` and `engine.isPlaying` are now read-only getters; existing read access is unaffected.
+
+### OpenAudio.js 1.1 → 1.2
+No breaking changes. Fixes are internal.
 
-## Future Considerations
+### OpenAudio_s.js 1.0 → 1.1
+No breaking changes. `advanceDelay` is now configurable.
 
-These features are **out of scope** for OpenAudio_r.js (it would violate the "self-contained, no dependencies" principle):
+### OpenAudio_r.js 2.4 → 2.4.1
+Licence header update only.
 
-- Crossfading between clips
-- Sub-second precision scheduling
-- Real-time DSP effects (reverb, EQ, compression)
-- Frequency analysis or visualization
+### OpenAudio_r.js 2.3 → 2.4
+Additive features only.
 
-For these, consider graduating to the **Web Audio API**. See README.md for comparison.
+### OpenAudio_r.js 1.0 → 2.0
+**Breaking:** Complete rewrite with methods and callbacks.
 
 ---
 
 ## Contributing
 
-Have a feature request or bug to report? See [CONTRIBUTING.md](./CONTRIBUTING.md).
-
-All contributions will be credited in the changelog.
+See [CONTRIBUTING.md](https://github.com/Rexore/OpenAudio/blob/main/CONTRIBUTING.md).
 
 ---
 
 ## License
 
-OpenAudio_r.js is licensed under the GNU General Public License v3.0 or later. See [LICENSE](./LICENSE) for details.
+Licensed under the **Apache License 2.0**.
 
 ---
 
-*Last updated: March 15, 2025*
+*Last updated: March 16, 2026*