Skip to content

v0.12.0

Compare
Choose a tag to compare
@fussel178 fussel178 released this 08 Apr 00:40
· 1429 commits to main since this release

0.12.0 (2021-04-08)

Please see the migration guide for v0.12 for an in-depth explanation of the changes in this release.

⚠ BREAKING CHANGES

  • event-bus: Numerous changes, please see https://github.com/TelestionTeam/telestion-client/wiki/v0.12-Migration-Guide
  • types: The error message is no longer addressable.
  • The minimum required node version for all packages is now Node v14!
  • mock-server: The listen function now requires an object as argument which contains the port and hostname as properties.
  • mock-server: The event bus and http server instance properties are now marked private. Please use the provided abstractions and hooks instead. (see onInit, send, handle, register, etc.)
  • common: The loading indicator gives the children function the current dependencies which are always defined:
const [position, setPosition] = useState<Position>();
const [height, setHeight] = useState<number>();

return (
  <LoadingIndicator dependencies={[position, height]}>
    {(currentPos, currentHeight) => (
      <p>{currentPos} - {currentHeight}</p>
    )}
  </LoadingIndicator>
);
  • common: The useDependencyTimeout now returns true if all dependencies are defined and false if not all dependencies are defined yet. Before the return value was inverted.
    The type guard makes the hook useful as a condition in if-statements, for example:
const [position, setPosition] = useState<Position>();

// throws if no position received after 5 seconds
if (useDependencyTimeout(5000, [position])) {
  // type guarded - "position" is always defined
  return <p>Latest position: {position}</p>;
}

return <p>Waiting for incoming data</p>;
  • deps: Moving forward, testing is done with React Spectrum v3.9. Consider all previous versions unsupported.
  • deps: <ActionButton>s for header actions now require a isQuiet={true} attribute to work properly with React Spectrum 3.9

Features

  • common: Enhance loading indicator component (#350) (82d07f1)
  • event-bus: Implement basic event bus as first part of the refactoring process (d8ccc73)
  • event-bus: Rewrite Vert.x Event Bus (8d83dec)
  • mock-server: Add close function (3e0b5a8)
  • mock-server: Add logger option to constructor and clean up some internals (cefceae)
  • mock-server: First full implementation (7461df5)
  • types: The error message now extends from base message (a8f17dd)
  • Specify minimum node version in all packages and update workflows to use npm v7 as default (b727223)
  • mock-server: Add protected method to get all connections (cf9e267)

Bug Fixes

  • cli: Init: npm install command to be compatible with npm v7 (c81b35e)
  • core: Fix breaking changes (b6551c3)
  • deps: Fix issues with react-spectrum v3.9 (14bcfe4)
  • mock-server: Fix breaking changes (eab07d3)

Documentation Changes

  • event-bus: Document basic event bus (395e677)
  • mock-server: Document all methods (e0127e5)