DF Runtime Migration Notes Template

Release Summary

  • Release date: YYYY-MM-DD
  • Affected packages: @designful/df-player-web, @designful/df-runtime-core, ...
  • Breaking level: minor | major

Deprecations Added

Deprecated APIReplacement APIWarning SincePlanned Removal
oldApi()newApi()vX.Y.ZvA.B.0

Behavior Changes

List behavior-level changes that do not necessarily rename APIs:

  • playback/render-loop ordering updates
  • event emission order changes
  • default option precedence changes

Required Migration Steps

  1. Replace deprecated APIs with replacements.
  2. Verify event ordering assumptions in integration tests.
  3. Verify runtime/player options against latest defaults.
  4. Re-run npm run lint and relevant runtime/docs tests.

Compatibility Test Checklist

  • Public API surface snapshot updated
  • Deprecated alias warning flow covered by tests
  • Interaction parity tests still pass
  • Pre-ready command queue tests still pass

Example Before/After

// Before
player.startRenderLoop()
player.dispose()

// After
player.startRendering()
player.destroy()