1.0.0-beta.8 (@scion/workbench-client)
1.0.0-beta.8 (2022-02-11)
Code Refactoring
- workbench/popup: open popups from within an interceptor (a11fd9d), closes #276
- workbench/view: open views from within an interceptor (137b8d0)
Features
- workbench: allow controlling which view params to persist in the URL (dcb5ee1), closes #278
- workbench: migrate to @scion/microfrontend-platform v1.0.0-beta.20 (24dfec2), closes SchweizerischeBundesbahnen/scion-microfrontend-platform/#96
BREAKING CHANGES
-
workbench: Supporting
@scion/microfrontend-platform v1.0.0-beta.20
introduced a breaking change in the configuration of the host application and the host/client communication protocol.SCION Microfrontend Platform consolidated the API for configuring the platform, eliminating the different ways to configure the platform. Consequently, SCION Workbench could also simplify its API for enabling microfrontend support.
Related issue of the SCION Microfrontend Platform: SchweizerischeBundesbahnen/scion-microfrontend-platform/#96
Client App Migration
- the micro application must now pass its identity (symbolic name) directly as the first argument, rather than via the options object;
- the options object passed to
WorkbenchClient.connect
has been renamed fromMicroApplicationConfig
toConnectOptions
and messaging options are now top-level options; - the bean
MicroApplicationConfig
has been removed; you can now obtain the application's symbolic name as following:Beans.get<string>(APP_IDENTITY)
;
For further instructions on how to migrate the client, refer to https://github.com/SchweizerischeBundesbahnen/scion-microfrontend-platform/blob/master/docs/site/changelog/changelog.md#client-app-migration
-
workbench/popup: Opening popups from within an interceptor introduced a breaking change in the host/client communication protocol.
The communication protocol between host and client HAS CHANGED for opening a popup. You need to update host and affected clients to the new version simultaneously. The API has not changed; the breaking change applies only to the version of @scion/workbench and @scion/workbench-client. To migrate, upgrade to @scion/[email protected] and @scion/[email protected], respectively.
-
workbench/view: Opening views from within an interceptor introduced a breaking change in the host/client communication protocol.
The communication protocol between host and client HAS CHANGED for opening a view. You need to update host and affected clients to the new version simultaneously. The API has not changed; the breaking change applies only to the version of @scion/workbench and @scion/workbench-client. To migrate, upgrade to @scion/[email protected] and @scion/[email protected], respectively.