Skip to content

@zubridge/electron @ v2.1.0

Choose a tag to compare

@github-actions github-actions released this 19 Oct 13:58
· 138 commits to main since this release

New:

  • Configurable maxDepth for state serialization (#128)
  • Support for contextIsolation:false (#122)
    • Note this is not a recommended setting for new Electron apps, support has been added for legacy apps which cannot easily be transitioned to modern security settings.

Fixed:

  • Removed: getSubscribedWindows and getWindowSubscriptions methods from bridge
    • these methods, introduced in 2.0.0, don't provide much value to users IMO.
    • this change would normally be a major version bump, but given that 2.0.0 only has 18 downloads from NPM since release, I think it's ok here.
  • Removed: unnecessary WindowId type parameter from BaseBridge and BackendBridge interfaces
  • Removed: unnecessary getMetrics method on ResourceManager
  • onBridgeDestroy hook moved to before cleanup to allow users to access final state, log metrics, etc.

Documentation:

  • API reference changes
    • Added: maxDepth serialization configuration option
    • Added: missing documentation for resource management and onBridgeDestroy method
    • Added: experimental notification to middleware option
    • Removed: getSubscribedWindows and getWindowSubscriptions methods
    • Removed: WindowId type parameter from BaseBridge and BackendBridge interfaces
  • Getting started changes
    • Added: optional build setup section detailing electron-vite usage and ESM preload concerns
    • Added: context isolation disabled section detailing how to make it work and why you shouldn't
  • standardised filepath comments in code examples around the minimal apps

Developer:

  • Added: Zustand + Immer minimal app for manual testing (#129)
  • Added: minimal app using contextIsolation: false for manual testing (#122)
  • Added: integration tests to verify compatibility with Zustand + Immer
  • Fixed: issues around heap corruption affecting Windows CI jobs
  • Fixed: memory leak in minimal apps
  • Removed: Subscriptions from minimal apps header

Full Changelog: v2.0.0...v2.1.0