Releases: wuespace/telestion-client
v0.12.1
v0.12.0
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 andfalse
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 aisQuiet={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
v0.11.2
v0.11.1
v0.11.0
v0.10.1
0.10.1 (2021-02-27)
Bug Fixes
- common: Fix tabs in
NavBar
to adjust to new header height introduced in 555b9a1 (7309a86) - common: Reduce header height (from
size-700
tosize-600
) to abide by Spectrum guidelines and fix layout issues with tabs in theNavBar
component (6c99744) - common: Reduce size of
AppLogo
fromsize-500
tosize-400
to adjust to the different header height introduced in 555b9a1 (844fa9f) - deps: Regenerate package-lock.json to fix compatibility issues with React Spectrum 3.8 (1fcc9d3)
v0.10.0
0.10.0 (2021-02-23)
Features
- common: Add
overrideState
toConnectionIndicator
for debugging purposes (92492fa)
Bug Fixes
- common: Fix Dashboard rendering issues (73afae2)
Documentation Changes
- Add template CSS rules to Storybook stories (ab41e1c)
- Document new storybook-internal component folders in package
README.md
s (89e8754) - Improve storybook stories (4b662bf)
- common: Add storybook stories for
AccountControls
andNavBar
(b6c73d5) - common: Add storybook stories for
Actions
,NotificationAction
,ColorSchemeAction
,FullscreenAction
, andActionDivider
. (ea47787) - common: Add storybook stories for
CommonWrapper
andAppLogo
(29b408c) - common: Add storybook stories for
ConnectionIndicator
(346096a) - common: Add storybook stories for
DashboardPicker
(5aab481) - common: Add storybook stories for
Header
(2574afa) - common: Fix storybook stories for
AccountControls
(ce373af) - common: Fix storybook stories for
AccountControls
andNavBar
(4edd201) - common: Fix storybook stories for
Actions
(476607c) - common: Improve storybook stories (1cd24d1)
- core: Add storybook stories for
DashboardPage
,LoginPage
, andNotFoundPage
(7c38682) - core: Add storybook stories for
LoadingIndicator
(ebb96ce) - core: Add storybook stories for
LoginDescription
,LoginForm
,LoginLogo
, andLoginTitle
(69c8c4a) - core: Improve storybook stories for
TelestionClient
(dfdc8e1)
v0.9.0
v0.8.0
0.8.0 (2021-02-08)
⚠ BREAKING CHANGES
-
template: While, in and of itself, this doesn't constitute a breaking change, issues may arise in PSCs generated using the template before this change. This is why we want to bring special attention to it.
To fix PSCs generated before with versions prior to this, add the following property to the PSC's
package.json
:"eslintConfig": { "extends": [ "react-app", "react-app/jest" ] }
You won't have to do this steps for PSCs generated with the new version.
-
cli: PSC's now require a
telestion.config.js
file in the PSC's root directory (next to thepackage.json
).To migrate PSCs generated with older versions of the CLI, please add a
telestion.config.js
file with the following content into the root PSC directory, next to thepackage.json
:module.exports = {}
-
template: Setting the
homepage
to'.'
is required for building native applications from PSC projects usingtc-cli build
. For projects generated before this change, please manually add the following line to your PSC'spackage.json
:
"homepage": "."
Features
- cli:
tc-cli build
command implementation (6de3183), closes #263 - cli: Add configuration file parsing to the CLI (f2760e3)
- cli: Add Electron Main Process Plugin system (05ba70c)
- cli: Compile and run the actual Electron app and use Craco in
tc-cli start --electron
(05ee18b) - cli: Expose programmatic APIs for common CLI lib functions (d266ad0)
- cli: Show files generated by electron-builder in
tc-cli build
(b1fbd3d) - template: Add
@wuespace/telestion-client-prop-types
as default dependency of newly initialized PSC projects (3d7d4ec) - template: Add prettier in template for new PSCs (3165a18)
Bug Fixes
- cli: Stop output
'DEBUG: '
for debug log entries (1b57547) - deps: Remove no-longer needed webpack-dev-server dependency from CLI (d91dd48)
- template: Add
eslintConfig
to PSC package.json (050664e), closes #305 - template: Add
homepage
specifier to PSC package.json (b7ee792) - template: Fix
devDependencies
in template (b01b2d5)
Documentation Changes
- WueSpace becomes WüSpace (a typo in previous commits) (9c44d69)
- cli: Add better code documentation for the
tc-cli build
library functions (de37093) - cli: Improve wording in console output, doc comments, and function names (e22e365)
- cli: Update the package's README.md (6b54f6f)
- common: Update the package's README.md (52b36f1)
- core: Update the package's README.md (f36fd06)
- mock-server: Update the package's README.md (035bfe6)
- prop-types: Update the package's README.md (59a1a0c)
- template: Include project structure description in PSC README.md (e3893cb)
- template: Update the package's README.md (747efe1)
- template: Update the template's PSC README.md (2d95652)
- types: Update the package's README.md (81753df)
- vertx-event-bus: Update the package's README.md (cbb605a)
- Add contributing guidelines as its own file (42d1783)
- Revamp repository
README.md
(8188653) - Use pure Markdown for the Contributors image in the README (cb40ee8)