Skip to content

Releases

1.0.0

Choose a tag to compare

@qsc-carolinegingles qsc-carolinegingles released this 23 Sep 22:40

QRWC v1.0.0

First stable release. QRWC graduates from 0.5.0-beta to 1.0.0 with a stable, production-ready API.

Highlights

  • Managed WebSocket mode. Pass the core's host and QRWC builds, connects, and maintains the WebSocket for you, automatically reconnecting with configurable exponential backoff. Unmanaged (bring-your-own socket) mode remains fully supported; the two are mutually exclusive.
  • Deeper design typing. The createQrwc<T>() generic now also accepts an expanded schema describing each control's full state shape and Direction, giving precise per-control types and hiding update() on Read Only controls. The existing simple map still works.
  • Authentication. Added authentication to match the QRC API changes in Q-SYS Designer 10.5.
  • Engine Status event. A new event was added to allow client apps to respond to changes in the engine status.

Breaking changes

  • createQrwc always resolves, returning undefined on connection/startup failure instead of rejecting.

Fixes

  • Eliminated duplicate update events on outgoing control updates.

v0.5.0-beta

Choose a tag to compare

@qsc-carolinegingles qsc-carolinegingles released this 10 Nov 23:17

Hi everyone!

This update fixes a few bugs the community found, adds some missing typescript types to control state, exposes engine status in the root QRWC object, allows updating specific fields in a control instead of always using Value (yay!), and adds a dependency-injected logger to the startup parameters.

This should for the most part not break client apps, but some Typescript apps in strict mode might need to add some additional logic to indicate that components or controls are not undefined.

Changelog:

  • Adds a dependency-injected logger to QRWC's startup options
  • Reimplement the ability to set Position and String on controls such that it actually uses Position and String
  • Adds an engineStatus property to the root object returned by createQrwc
  • Adds some typescript types representing array properties to control state e.g. Values[]
  • Update the README
  • Fixes an issue preventing client apps from gracefully recovering after QRWC lost its connection to the core
  • Fixes the Controls property in component state being null (it's now an array of the controls' states)
  • Fixes an issue where the typescript type of controls and components would lose the possibility of being undefined

v0.4.1-beta

Choose a tag to compare

@qsc-carolinegingles qsc-carolinegingles released this 27 May 20:31
  • fixed issues with browser apps
  • added several build target compatibility tests