release(workbench): v16.0.0-beta.6

SchweizerischeBundesbahnen · Sep 20, 2023 · 5ad5538 · 5ad5538
1 parent 08a968f
commit 5ad5538
Show file tree

Hide file tree

Showing 4 changed files with 244 additions and 1 deletion.
diff --git a/CHANGELOG_WORKBENCH.md b/CHANGELOG_WORKBENCH.md
@@ -1,3 +1,85 @@
+# [16.0.0-beta.6](https://github.com/SchweizerischeBundesbahnen/scion-workbench/compare/16.0.0-beta.5...16.0.0-beta.6) (2023-09-20)
+
+
+### Bug Fixes
+
+* **workbench:** do not publish changed layout objects until processed a layout change ([8286d65](https://github.com/SchweizerischeBundesbahnen/scion-workbench/commit/8286d657487cfc23717cf02a502ea141e36357af))
+
+
+### Features
+
+* **workbench:** allow for a layout with an optional main area ([ff6697a](https://github.com/SchweizerischeBundesbahnen/scion-workbench/commit/ff6697a641b6719faedea966a5f1bc3e1099805f)), closes [#443](https://github.com/SchweizerischeBundesbahnen/scion-workbench/issues/443)
+
+
+### BREAKING CHANGES
+
+* **workbench:** Adding support for optional main area introduced breaking changes.
+
+  The following APIs have changed:
+    - renamed `MAIN_AREA_PART_ID` to `MAIN_AREA`;
+    - changed signature of `WorkbenchLayoutFn` to take `WorkbenchLayoutFactory` instead of `WorkbenchLayout` as argument;
+    - layout definitions, if any, must now add the `MAIN_AREA` part explicitly;
+    - changed inputs of `wbPartAction` directive to take `canMatch` function instead of `view`, `part` and `area` inputs;
+
+  ### The following snippets illustrate how a migration could look like:
+
+  #### Initial layout: Before migration
+
+  ```ts
+  import {MAIN_AREA_PART_ID, WorkbenchModule} from '@scion/workbench';
+
+  WorkbenchModule.forRoot({
+    layout: layout => layout
+      .addPart('left', {relativeTo: MAIN_AREA_PART_ID, align: 'left', ratio: .25})
+      .addView('navigator', {partId: 'left', activateView: true})
+  });
+  ```
+
+  #### Initial layout: After migration
+
+  ```ts
+  import {MAIN_AREA, WorkbenchLayoutFactory, WorkbenchModule} from '@scion/workbench';
+
+  WorkbenchModule.forRoot({
+    layout: (factory: WorkbenchLayoutFactory) => factory
+      .addPart(MAIN_AREA)
+      .addPart('left', {relativeTo: MAIN_AREA, align: 'left', ratio: .25})
+      .addView('navigator', {partId: 'left', activateView: true})
+  });
+  ```
+
+  #### Part Action: Before migration
+
+  ```html
+  <wb-workbench>
+    <ng-template wbPartAction area="main">
+      <button [wbRouterLink]="'/path/to/view'">
+        Open View
+      </button>
+    </ng-template>
+  </wb-workbench>
+  ```
+
+  #### Part Action: After migration
+
+  ```html
+  <wb-workbench>
+    <ng-template wbPartAction [canMatch]="isPartInMainArea">
+      <button [wbRouterLink]="'/path/to/view'">
+        Open View
+      </button>
+    </ng-template>
+  </wb-workbench>
+  ```
+
+  ```ts
+  isPartInMainArea = (part: WorkbenchPart): boolean => {
+    return part.isInMainArea;
+  };
+  ```
+
+
+
 # [16.0.0-beta.5](https://github.com/SchweizerischeBundesbahnen/scion-workbench/compare/16.0.0-beta.4...16.0.0-beta.5) (2023-08-24)
 
 

diff --git a/CHANGELOG_WORKBENCH_LATEST.md b/CHANGELOG_WORKBENCH_LATEST.md
@@ -0,0 +1,79 @@
+# [16.0.0-beta.6](https://github.com/SchweizerischeBundesbahnen/scion-workbench/compare/16.0.0-beta.5...16.0.0-beta.6) (2023-09-20)
+
+
+### Bug Fixes
+
+* **workbench:** do not publish changed layout objects until processed a layout change ([8286d65](https://github.com/SchweizerischeBundesbahnen/scion-workbench/commit/8286d657487cfc23717cf02a502ea141e36357af))
+
+
+### Features
+
+* **workbench:** allow for a layout with an optional main area ([ff6697a](https://github.com/SchweizerischeBundesbahnen/scion-workbench/commit/ff6697a641b6719faedea966a5f1bc3e1099805f)), closes [#443](https://github.com/SchweizerischeBundesbahnen/scion-workbench/issues/443)
+
+
+### BREAKING CHANGES
+
+* **workbench:** Adding support for optional main area introduced breaking changes.
+
+  The following APIs have changed:
+    - renamed `MAIN_AREA_PART_ID` to `MAIN_AREA`;
+    - changed signature of `WorkbenchLayoutFn` to take `WorkbenchLayoutFactory` instead of `WorkbenchLayout` as argument;
+    - layout definitions, if any, must now add the `MAIN_AREA` part explicitly;
+    - changed inputs of `wbPartAction` directive to take `canMatch` function instead of `view`, `part` and `area` inputs;
+
+  ### The following snippets illustrate how a migration could look like:
+
+  #### Initial layout: Before migration
+
+  ```ts
+  import {MAIN_AREA_PART_ID, WorkbenchModule} from '@scion/workbench';
+
+  WorkbenchModule.forRoot({
+    layout: layout => layout
+      .addPart('left', {relativeTo: MAIN_AREA_PART_ID, align: 'left', ratio: .25})
+      .addView('navigator', {partId: 'left', activateView: true})
+  });
+  ```
+
+  #### Initial layout: After migration
+
+  ```ts
+  import {MAIN_AREA, WorkbenchLayoutFactory, WorkbenchModule} from '@scion/workbench';
+
+  WorkbenchModule.forRoot({
+    layout: (factory: WorkbenchLayoutFactory) => factory
+      .addPart(MAIN_AREA)
+      .addPart('left', {relativeTo: MAIN_AREA, align: 'left', ratio: .25})
+      .addView('navigator', {partId: 'left', activateView: true})
+  });
+  ```
+
+  #### Part Action: Before migration
+
+  ```html
+  <wb-workbench>
+    <ng-template wbPartAction area="main">
+      <button [wbRouterLink]="'/path/to/view'">
+        Open View
+      </button>
+    </ng-template>
+  </wb-workbench>
+  ```
+
+  #### Part Action: After migration
+
+  ```html
+  <wb-workbench>
+    <ng-template wbPartAction [canMatch]="isPartInMainArea">
+      <button [wbRouterLink]="'/path/to/view'">
+        Open View
+      </button>
+    </ng-template>
+  </wb-workbench>
+  ```
+
+  ```ts
+  isPartInMainArea = (part: WorkbenchPart): boolean => {
+    return part.isInMainArea;
+  };
+  ```
diff --git a/docs/site/changelog-workbench/changelog.md b/docs/site/changelog-workbench/changelog.md
@@ -6,6 +6,88 @@
 ## [Changelog][menu-changelog] > Workbench (@scion/workbench)
 
 
+# [16.0.0-beta.6](https://github.com/SchweizerischeBundesbahnen/scion-workbench/compare/16.0.0-beta.5...16.0.0-beta.6) (2023-09-20)
+
+
+### Bug Fixes
+
+* **workbench:** do not publish changed layout objects until processed a layout change ([8286d65](https://github.com/SchweizerischeBundesbahnen/scion-workbench/commit/8286d657487cfc23717cf02a502ea141e36357af))
+
+
+### Features
+
+* **workbench:** allow for a layout with an optional main area ([ff6697a](https://github.com/SchweizerischeBundesbahnen/scion-workbench/commit/ff6697a641b6719faedea966a5f1bc3e1099805f)), closes [#443](https://github.com/SchweizerischeBundesbahnen/scion-workbench/issues/443)
+
+
+### BREAKING CHANGES
+
+* **workbench:** Adding support for optional main area introduced breaking changes.
+
+  The following APIs have changed:
+    - renamed `MAIN_AREA_PART_ID` to `MAIN_AREA`;
+    - changed signature of `WorkbenchLayoutFn` to take `WorkbenchLayoutFactory` instead of `WorkbenchLayout` as argument;
+    - layout definitions, if any, must now add the `MAIN_AREA` part explicitly;
+    - changed inputs of `wbPartAction` directive to take `canMatch` function instead of `view`, `part` and `area` inputs;
+
+  ### The following snippets illustrate how a migration could look like:
+
+  #### Initial layout: Before migration
+
+  ```ts
+  import {MAIN_AREA_PART_ID, WorkbenchModule} from '@scion/workbench';
+
+  WorkbenchModule.forRoot({
+    layout: layout => layout
+      .addPart('left', {relativeTo: MAIN_AREA_PART_ID, align: 'left', ratio: .25})
+      .addView('navigator', {partId: 'left', activateView: true})
+  });
+  ```
+
+  #### Initial layout: After migration
+
+  ```ts
+  import {MAIN_AREA, WorkbenchLayoutFactory, WorkbenchModule} from '@scion/workbench';
+
+  WorkbenchModule.forRoot({
+    layout: (factory: WorkbenchLayoutFactory) => factory
+      .addPart(MAIN_AREA)
+      .addPart('left', {relativeTo: MAIN_AREA, align: 'left', ratio: .25})
+      .addView('navigator', {partId: 'left', activateView: true})
+  });
+  ```
+
+  #### Part Action: Before migration
+
+  ```html
+  <wb-workbench>
+    <ng-template wbPartAction area="main">
+      <button [wbRouterLink]="'/path/to/view'">
+        Open View
+      </button>
+    </ng-template>
+  </wb-workbench>
+  ```
+
+  #### Part Action: After migration
+
+  ```html
+  <wb-workbench>
+    <ng-template wbPartAction [canMatch]="isPartInMainArea">
+      <button [wbRouterLink]="'/path/to/view'">
+        Open View
+      </button>
+    </ng-template>
+  </wb-workbench>
+  ```
+
+  ```ts
+  isPartInMainArea = (part: WorkbenchPart): boolean => {
+    return part.isInMainArea;
+  };
+  ```
+
+
+
 # [16.0.0-beta.5](https://github.com/SchweizerischeBundesbahnen/scion-workbench/compare/16.0.0-beta.4...16.0.0-beta.5) (2023-08-24)
 
 

diff --git a/projects/scion/workbench/package.json b/projects/scion/workbench/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@scion/workbench",
-  "version": "16.0.0-beta.5",
+  "version": "16.0.0-beta.6",
   "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,