Skip to content

Commit 6683bf5

Browse files
danielwiehlMarcarrian
authored andcommitted
release(workbench-client): v1.0.0-beta.28
1 parent 4326a63 commit 6683bf5

File tree

4 files changed

+134
-4
lines changed

4 files changed

+134
-4
lines changed

CHANGELOG_WORKBENCH_CLIENT.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,50 @@
1+
# [1.0.0-beta.28](https://github.com/SchweizerischeBundesbahnen/scion-workbench/compare/workbench-client-1.0.0-beta.27...workbench-client-1.0.0-beta.28) (2024-11-25)
2+
3+
4+
### Features
5+
6+
* **workbench-client/view:** add functional `CanClose` guard, deprecate class-based guard ([ecd52b3](https://github.com/SchweizerischeBundesbahnen/scion-workbench/commit/ecd52b3afe82c0e1353cf96be550f925e76a72d5))
7+
8+
9+
### Deprecations
10+
11+
* **workbench-client/view:** The class-based `CanClose` guard has been deprecated in favor of a functional guard that can be registered on `WorkbenchView.canClose`.
12+
13+
Migrate by registering a callback on `WorkbenchView.canClose` instead of implementing the `CanClose` interface.
14+
15+
**Before migration:**
16+
```ts
17+
import {CanClose, WorkbenchView} from '@scion/workbench-client';
18+
import {Beans} from '@scion/toolkit/bean-manager';
19+
20+
export class ViewComponent implements CanClose {
21+
22+
constructor() {
23+
Beans.get(WorkbenchView).addCanClose(this);
24+
}
25+
26+
public canClose(): boolean {
27+
return true;
28+
}
29+
}
30+
```
31+
32+
**After migration:**
33+
```ts
34+
import {WorkbenchView} from '@scion/workbench-client';
35+
import {Beans} from '@scion/toolkit/bean-manager';
36+
37+
export class ViewComponent {
38+
39+
constructor() {
40+
Beans.get(WorkbenchView).canClose(() => {
41+
return true;
42+
});
43+
}
44+
}
45+
```
46+
47+
148
# [1.0.0-beta.27](https://github.com/SchweizerischeBundesbahnen/scion-workbench/compare/workbench-client-1.0.0-beta.26...workbench-client-1.0.0-beta.27) (2024-10-11)
249

350

CHANGELOG_WORKBENCH_CLIENT_LATEST.md

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,45 @@
1-
# [1.0.0-beta.27](https://github.com/SchweizerischeBundesbahnen/scion-workbench/compare/workbench-client-1.0.0-beta.26...workbench-client-1.0.0-beta.27) (2024-10-11)
1+
# [1.0.0-beta.28](https://github.com/SchweizerischeBundesbahnen/scion-workbench/compare/workbench-client-1.0.0-beta.27...workbench-client-1.0.0-beta.28) (2024-11-25)
22

33

4-
### Bug Fixes
4+
### Features
55

6-
* **workbench-client:** position document root as required by `@scion/toolkit` ([007e9c3](https://github.com/SchweizerischeBundesbahnen/scion-workbench/commit/007e9c396dff4c2dde11c62d810b5997c034eca2))
6+
* **workbench-client/view:** add functional `CanClose` guard, deprecate class-based guard ([ecd52b3](https://github.com/SchweizerischeBundesbahnen/scion-workbench/commit/ecd52b3afe82c0e1353cf96be550f925e76a72d5))
77

88

9+
### Deprecations
910

11+
* **workbench-client/view:** The class-based `CanClose` guard has been deprecated in favor of a functional guard that can be registered on `WorkbenchView.canClose`.
12+
13+
Migrate by registering a callback on `WorkbenchView.canClose` instead of implementing the `CanClose` interface.
14+
15+
**Before migration:**
16+
```ts
17+
import {CanClose, WorkbenchView} from '@scion/workbench-client';
18+
import {Beans} from '@scion/toolkit/bean-manager';
19+
20+
export class ViewComponent implements CanClose {
21+
22+
constructor() {
23+
Beans.get(WorkbenchView).addCanClose(this);
24+
}
25+
26+
public canClose(): boolean {
27+
return true;
28+
}
29+
}
30+
```
31+
32+
**After migration:**
33+
```ts
34+
import {WorkbenchView} from '@scion/workbench-client';
35+
import {Beans} from '@scion/toolkit/bean-manager';
36+
37+
export class ViewComponent {
38+
39+
constructor() {
40+
Beans.get(WorkbenchView).canClose(() => {
41+
return true;
42+
});
43+
}
44+
}
45+
```

docs/site/changelog-workbench-client/changelog.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,53 @@
66
## [Changelog][menu-changelog] > Workbench Client (@scion/workbench-client)
77

88

9+
# [1.0.0-beta.28](https://github.com/SchweizerischeBundesbahnen/scion-workbench/compare/workbench-client-1.0.0-beta.27...workbench-client-1.0.0-beta.28) (2024-11-25)
10+
11+
12+
### Features
13+
14+
* **workbench-client/view:** add functional `CanClose` guard, deprecate class-based guard ([ecd52b3](https://github.com/SchweizerischeBundesbahnen/scion-workbench/commit/ecd52b3afe82c0e1353cf96be550f925e76a72d5))
15+
16+
17+
### Deprecations
18+
19+
* **workbench-client/view:** The class-based `CanClose` guard has been deprecated in favor of a functional guard that can be registered on `WorkbenchView.canClose`.
20+
21+
Migrate by registering a callback on `WorkbenchView.canClose` instead of implementing the `CanClose` interface.
22+
23+
**Before migration:**
24+
```ts
25+
import {CanClose, WorkbenchView} from '@scion/workbench-client';
26+
import {Beans} from '@scion/toolkit/bean-manager';
27+
28+
export class ViewComponent implements CanClose {
29+
30+
constructor() {
31+
Beans.get(WorkbenchView).addCanClose(this);
32+
}
33+
34+
public canClose(): boolean {
35+
return true;
36+
}
37+
}
38+
```
39+
40+
**After migration:**
41+
```ts
42+
import {WorkbenchView} from '@scion/workbench-client';
43+
import {Beans} from '@scion/toolkit/bean-manager';
44+
45+
export class ViewComponent {
46+
47+
constructor() {
48+
Beans.get(WorkbenchView).canClose(() => {
49+
return true;
50+
});
51+
}
52+
}
53+
```
54+
55+
956
# [1.0.0-beta.27](https://github.com/SchweizerischeBundesbahnen/scion-workbench/compare/workbench-client-1.0.0-beta.26...workbench-client-1.0.0-beta.27) (2024-10-11)
1057

1158

projects/scion/workbench-client/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@scion/workbench-client",
3-
"version": "1.0.0-beta.27",
3+
"version": "1.0.0-beta.28",
44
"description": "SCION Workbench Client provides core API for a web app to interact with SCION Workbench and other microfrontends. It is a pure TypeScript library based on the framework-agnostic `@scion/microfrontend-platform` library and can be used with any web stack.",
55
"license": "EPL-2.0",
66
"private": false,

0 commit comments

Comments
 (0)