From 2b31eb21686ffc6d1ec8ce179a7964e919b262e5 Mon Sep 17 00:00:00 2001 From: danielwiehl Date: Mon, 28 Oct 2024 16:56:03 +0100 Subject: [PATCH] release(workbench): v18.0.0-beta.8 --- CHANGELOG_WORKBENCH.md | 64 ++++++++++++++++++++++ CHANGELOG_WORKBENCH_LATEST.md | 61 +++++++++++++++++++-- docs/site/changelog-workbench/changelog.md | 64 ++++++++++++++++++++++ projects/scion/workbench/package.json | 2 +- 4 files changed, 186 insertions(+), 5 deletions(-) diff --git a/CHANGELOG_WORKBENCH.md b/CHANGELOG_WORKBENCH.md index f73b55ad1..acddd956f 100644 --- a/CHANGELOG_WORKBENCH.md +++ b/CHANGELOG_WORKBENCH.md @@ -1,3 +1,67 @@ +# [18.0.0-beta.8](https://github.com/SchweizerischeBundesbahnen/scion-workbench/compare/18.0.0-beta.7...18.0.0-beta.8) (2024-10-28) + + +### Bug Fixes + +* **workbench/popup:** ensure the popup anchor not leaving view boundaries ([c629f49](https://github.com/SchweizerischeBundesbahnen/scion-workbench/commit/c629f49f3ba520c2cd700a008e4ed0af1c86e01f)) +* **workbench/view:** ensure view overlays align with view boundaries when view position changes ([2998295](https://github.com/SchweizerischeBundesbahnen/scion-workbench/commit/29982951bf8290108d3b09104ebc456f3acb9f6c)) + + +### Features + +* **workbench:** prevent tracking unwanted dependencies in effects ([7a7eaf8](https://github.com/SchweizerischeBundesbahnen/scion-workbench/commit/7a7eaf847f3ed54dcc7eeab300cbde53700b8e46)) + + +### BREAKING CHANGES + +* **workbench:** SCION Workbench requires `@scion/toolkit` version `1.6.0` or later. +* **workbench:** SCION Workbench requires `@scion/components` version `18.1.1` or later. +* **workbench:** Calling following workbench methods in a reactive (tracking) context (e.g., `effect`) now throws an error. Migrate by using Angular's `untracked()` function. + - `WorkbenchRouter.navigate` + - `WorkbenchService.registerPerspective` + - `WorkbenchService.switchPerspective` + - `WorkbenchService.resetPerspective` + - `WorkbenchService.closeViews` + - `WorkbenchService.switchTheme` + - `WorkbenchService.registerPartAction` + - `WorkbenchService.registerViewMenuItem` + - `WorkbenchLauncher.launch` + - `WorkbenchDialogService.open` + - `WorkbenchMessageBoxService.open` + - `NotificationService.notify` + - `PopupService.open` + - `WorkbenchPart.activate` + - `WorkbenchView.activate` + - `WorkbenchView.close` + - `WorkbenchView.move` + - `WorkbenchView.registerMenuItem` + - `WorkbenchDialog.close` + - `Popup.close` + + **Migration Example** + ```ts + import {effect, inject, untracked} from '@angular/core'; + import {WorkbenchRouter} from '@scion/workbench'; + + const workbenchRouter = inject(WorkbenchRouter); + + // Before + effect(() => { + if (someSignal()) { + workbenchRouter.navigate(['path/to/view']); + } + }); + + // After + effect(() => { + if (someSignal()) { + untracked(() => workbenchRouter.navigate(['path/to/view'])); + } + }); + ``` + + + # [18.0.0-beta.7](https://github.com/SchweizerischeBundesbahnen/scion-workbench/compare/18.0.0-beta.6...18.0.0-beta.7) (2024-10-11) diff --git a/CHANGELOG_WORKBENCH_LATEST.md b/CHANGELOG_WORKBENCH_LATEST.md index f43c6f831..5c080c449 100644 --- a/CHANGELOG_WORKBENCH_LATEST.md +++ b/CHANGELOG_WORKBENCH_LATEST.md @@ -1,11 +1,64 @@ -# [18.0.0-beta.7](https://github.com/SchweizerischeBundesbahnen/scion-workbench/compare/18.0.0-beta.6...18.0.0-beta.7) (2024-10-11) +# [18.0.0-beta.8](https://github.com/SchweizerischeBundesbahnen/scion-workbench/compare/18.0.0-beta.7...18.0.0-beta.8) (2024-10-28) ### Bug Fixes -* **workbench/dialog:** enable updating dialog properties in an Angular effect ([7da2418](https://github.com/SchweizerischeBundesbahnen/scion-workbench/commit/7da24185e8cc94db2f45a31a6d367c190c5f4104)) -* **workbench/view:** enable updating view properties in an Angular effect ([a7d3594](https://github.com/SchweizerischeBundesbahnen/scion-workbench/commit/a7d3594193c31715ac5fcb5da2d8015e803bb0aa)) -* **workbench:** position document root as required by `@scion/toolkit` ([0d2f6c2](https://github.com/SchweizerischeBundesbahnen/scion-workbench/commit/0d2f6c2229d6c75f8271795b6e399affaa43eef1)) +* **workbench/popup:** ensure the popup anchor not leaving view boundaries ([c629f49](https://github.com/SchweizerischeBundesbahnen/scion-workbench/commit/c629f49f3ba520c2cd700a008e4ed0af1c86e01f)) +* **workbench/view:** ensure view overlays align with view boundaries when view position changes ([2998295](https://github.com/SchweizerischeBundesbahnen/scion-workbench/commit/29982951bf8290108d3b09104ebc456f3acb9f6c)) + + +### Features + +* **workbench:** prevent tracking unwanted dependencies in effects ([7a7eaf8](https://github.com/SchweizerischeBundesbahnen/scion-workbench/commit/7a7eaf847f3ed54dcc7eeab300cbde53700b8e46)) + + +### BREAKING CHANGES + +* **workbench:** SCION Workbench requires `@scion/toolkit` version `1.6.0` or later. +* **workbench:** SCION Workbench requires `@scion/components` version `18.1.1` or later. +* **workbench:** Calling following workbench methods in a reactive (tracking) context (e.g., `effect`) now throws an error. Migrate by using Angular's `untracked()` function. + - `WorkbenchRouter.navigate` + - `WorkbenchService.registerPerspective` + - `WorkbenchService.switchPerspective` + - `WorkbenchService.resetPerspective` + - `WorkbenchService.closeViews` + - `WorkbenchService.switchTheme` + - `WorkbenchService.registerPartAction` + - `WorkbenchService.registerViewMenuItem` + - `WorkbenchLauncher.launch` + - `WorkbenchDialogService.open` + - `WorkbenchMessageBoxService.open` + - `NotificationService.notify` + - `PopupService.open` + - `WorkbenchPart.activate` + - `WorkbenchView.activate` + - `WorkbenchView.close` + - `WorkbenchView.move` + - `WorkbenchView.registerMenuItem` + - `WorkbenchDialog.close` + - `Popup.close` + + **Migration Example** + ```ts + import {effect, inject, untracked} from '@angular/core'; + import {WorkbenchRouter} from '@scion/workbench'; + + const workbenchRouter = inject(WorkbenchRouter); + + // Before + effect(() => { + if (someSignal()) { + workbenchRouter.navigate(['path/to/view']); + } + }); + + // After + effect(() => { + if (someSignal()) { + untracked(() => workbenchRouter.navigate(['path/to/view'])); + } + }); + ``` diff --git a/docs/site/changelog-workbench/changelog.md b/docs/site/changelog-workbench/changelog.md index f53e031b3..b4fee501f 100644 --- a/docs/site/changelog-workbench/changelog.md +++ b/docs/site/changelog-workbench/changelog.md @@ -6,6 +6,70 @@ ## [Changelog][menu-changelog] > Workbench (@scion/workbench) +# [18.0.0-beta.8](https://github.com/SchweizerischeBundesbahnen/scion-workbench/compare/18.0.0-beta.7...18.0.0-beta.8) (2024-10-28) + + +### Bug Fixes + +* **workbench/popup:** ensure the popup anchor not leaving view boundaries ([c629f49](https://github.com/SchweizerischeBundesbahnen/scion-workbench/commit/c629f49f3ba520c2cd700a008e4ed0af1c86e01f)) +* **workbench/view:** ensure view overlays align with view boundaries when view position changes ([2998295](https://github.com/SchweizerischeBundesbahnen/scion-workbench/commit/29982951bf8290108d3b09104ebc456f3acb9f6c)) + + +### Features + +* **workbench:** prevent tracking unwanted dependencies in effects ([7a7eaf8](https://github.com/SchweizerischeBundesbahnen/scion-workbench/commit/7a7eaf847f3ed54dcc7eeab300cbde53700b8e46)) + + +### BREAKING CHANGES + +* **workbench:** SCION Workbench requires `@scion/toolkit` version `1.6.0` or later. +* **workbench:** SCION Workbench requires `@scion/components` version `18.1.1` or later. +* **workbench:** Calling following workbench methods in a reactive (tracking) context (e.g., `effect`) now throws an error. Migrate by using Angular's `untracked()` function. + - `WorkbenchRouter.navigate` + - `WorkbenchService.registerPerspective` + - `WorkbenchService.switchPerspective` + - `WorkbenchService.resetPerspective` + - `WorkbenchService.closeViews` + - `WorkbenchService.switchTheme` + - `WorkbenchService.registerPartAction` + - `WorkbenchService.registerViewMenuItem` + - `WorkbenchLauncher.launch` + - `WorkbenchDialogService.open` + - `WorkbenchMessageBoxService.open` + - `NotificationService.notify` + - `PopupService.open` + - `WorkbenchPart.activate` + - `WorkbenchView.activate` + - `WorkbenchView.close` + - `WorkbenchView.move` + - `WorkbenchView.registerMenuItem` + - `WorkbenchDialog.close` + - `Popup.close` + + **Migration Example** + ```ts + import {effect, inject, untracked} from '@angular/core'; + import {WorkbenchRouter} from '@scion/workbench'; + + const workbenchRouter = inject(WorkbenchRouter); + + // Before + effect(() => { + if (someSignal()) { + workbenchRouter.navigate(['path/to/view']); + } + }); + + // After + effect(() => { + if (someSignal()) { + untracked(() => workbenchRouter.navigate(['path/to/view'])); + } + }); + ``` + + + # [18.0.0-beta.7](https://github.com/SchweizerischeBundesbahnen/scion-workbench/compare/18.0.0-beta.6...18.0.0-beta.7) (2024-10-11) diff --git a/projects/scion/workbench/package.json b/projects/scion/workbench/package.json index c4de077b5..ed4cf1083 100644 --- a/projects/scion/workbench/package.json +++ b/projects/scion/workbench/package.json @@ -1,6 +1,6 @@ { "name": "@scion/workbench", - "version": "18.0.0-beta.7", + "version": "18.0.0-beta.8", "description": "SCION Workbench enables the creation of Angular web applications that require a flexible layout to arrange content side-by-side or stacked, all personalizable by the user via drag & drop.", "license": "EPL-2.0", "private": false,