@scion/workbench 21.0.0-beta.2 → 21.0.0-beta.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scion/workbench",
-  "version": "21.0.0-beta.2",
+  "version": "21.0.0-beta.4",
   "description": "SCION Workbench enables the creation of Angular web applications that require a flexible layout to display content side-by-side or stacked, all personalizable by the user via drag & drop. This type of layout is ideal for applications with non-linear workflows, enabling users to work on content in parallel.",
   "license": "EPL-2.0",
   "private": false,
@@ -35,9 +35,9 @@
     "@angular/forms": "^21.0.0",
     "@angular/router": "^21.0.0",
     "@scion/components": "^21.0.0",
-    "@scion/toolkit": "^2.0.0",
-    "@scion/microfrontend-platform": "^1.6.0",
-    "@scion/workbench-client": "^1.0.0-beta.37",
+    "@scion/toolkit": "^2.1.0",
+    "@scion/microfrontend-platform": "^2.0.0",
+    "@scion/workbench-client": "^1.0.0-beta.39",
     "rxjs": "^7.8.0"
   },
   "peerDependenciesMeta": {

package/types/scion-workbench.d.ts

@@ -305,6 +305,39 @@ declare function canMatchWorkbenchMessageBoxCapability(qualifier: Qualifier): Ca
  * @return guard matching the specified popup capability.
  */
 declare function canMatchWorkbenchPopupCapability(qualifier: Qualifier): CanMatchFn;
+/**
+ * Configures a route to only match workbench notifications navigated to the specified notification capability.
+ *
+ * Use this guard to differentiate microfrontend routes, which must all have an empty path.
+ *
+ * @example - Route matching a notification capability with qualifier {notification: 'info'}
+ * ```ts
+ * import {Routes} from '@angular/router';
+ * import {canMatchWorkbenchNotificationCapability} from '@scion/workbench';
+ *
+ * const routes: Routes = [
+ *   {path: '', canMatch: [canMatchWorkbenchNotificationCapability({notification: 'info'})], component: InfoComponent},
+ * ];
+ * ```
+ *
+ * The above route matches the following notification capability:
+ *
+ * ```json
+ * {
+ *   "type": "notification",
+ *   "qualifier": {
+ *     "notification": "info"
+ *   },
+ *   "properties": {
+ *     "path": ""
+ *   }
+ * }
+ * ```
+ *
+ * @param qualifier - Identifies the notification capability.
+ * @return guard matching the specified notification capability.
+ */
+declare function canMatchWorkbenchNotificationCapability(qualifier: Qualifier): CanMatchFn;
 /**
  * Format of a microfrontend capability id.
  */
@@ -317,7 +350,7 @@ type MicrofrontendCapabilityId = string;
  * Format: `workbench.microfrontend.host.<capabilityId>.<workbenchElementType>.<workbenchElementId>`
  * Example: `workbench.microfrontend.host.39768ab.part.5485357a`
  */
-type MicrofrontendHostOutlet = `workbench.microfrontend.host.${MicrofrontendCapabilityId}.${PartId | ViewId | DialogId | PopupId}`;
+type MicrofrontendHostOutlet = `workbench.microfrontend.host.${MicrofrontendCapabilityId}.${PartId | ViewId | DialogId | PopupId | NotificationId}`;
 
 /**
  * DI token to get a unique id of the workbench.
@@ -349,6 +382,10 @@ type DialogId = `${typeof DIALOG_ID_PREFIX}${string}`;
  * Format of a popup identifier.
  */
 type PopupId = `${typeof POPUP_ID_PREFIX}${string}`;
+/**
+ * Format of a notification identifier.
+ */
+type NotificationId = `${typeof NOTIFICATION_ID_PREFIX}${string}`;
 /**
  * Format of an activity identifier.
  *
@@ -393,6 +430,12 @@ declare const ACTIVITY_ID_PREFIX = "activity.";
  * @see DialogId
  */
 declare const DIALOG_ID_PREFIX = "dialog.";
+/**
+ * Represents the id prefix of notifications.
+ *
+ * @see NotificationId
+ */
+declare const NOTIFICATION_ID_PREFIX = "notification.";
 /**
  * Represents the id prefix of popups.
  *
@@ -1726,6 +1769,10 @@ declare abstract class WorkbenchPart {
      * Activates this part.
      */
     abstract activate(): Promise<boolean>;
+    /**
+     * Gets size and position of this part, or `undefined` if not constructed.
+     */
+    abstract readonly bounds: Signal<DOMRect | undefined>;
 }
 /**
  * Provides navigation details of a workbench part.
@@ -1918,6 +1965,10 @@ declare abstract class WorkbenchView {
      * @returns Reference to the `CanClose` guard, which can be used to unregister the guard.
      */
     abstract canClose(canClose: CanCloseFn): CanCloseRef;
+    /**
+     * Gets size and position of this view, or `undefined` if not constructed.
+     */
+    abstract readonly bounds: Signal<DOMRect | undefined>;
 }
 /**
  * Provides navigation details of a workbench view.
@@ -1996,6 +2047,10 @@ declare abstract class WorkbenchDialog {
      * Closes the dialog. Optionally, pass a result or an error to the dialog opener.
      */
     abstract close<R>(result?: R | Error): void;
+    /**
+     * Gets size and position of this dialog, or `undefined` if not constructed.
+     */
+    abstract readonly bounds: Signal<DOMRect | undefined>;
 }
 /**
  * Represents the preferred dialog size.
@@ -2069,6 +2124,10 @@ declare abstract class WorkbenchPopup {
      * Closes the popup. Optionally, pass a result or an error to the popup opener.
      */
     abstract close<R>(result?: R | Error): void;
+    /**
+     * Gets size and position of this popup, or `undefined` if not constructed.
+     */
+    abstract readonly bounds: Signal<DOMRect | undefined>;
 }
 /**
  * Represents the preferred size of a popup.
@@ -2106,6 +2165,79 @@ interface WorkbenchPopupSize {
     set maxWidth(maxWidth: string | undefined);
 }
 
+/**
+ * A notification is a closable message displayed in the upper-right corner that disappears after a few seconds unless hovered or focused.
+ * It informs about system events, task completion, or errors. Severity indicates importance or urgency.
+ *
+ * The notification component can inject this handle to interact with the notification.
+ *
+ * Notification inputs are available as input properties in the notification component.
+ *
+ * @see WorkbenchNotificationService
+ */
+declare abstract class WorkbenchNotification {
+    /**
+     * Identity of this notification.
+     */
+    abstract readonly id: NotificationId;
+    /**
+     * Sets the title of the notification.
+     *
+     * Can be text or a translation key. A translation key starts with the percent symbol (`%`) and may include parameters in matrix notation for text interpolation.
+     */
+    abstract get title(): Signal<Translatable | undefined>;
+    abstract set title(title: Translatable | undefined);
+    /**
+     * Sets the preferred notification size. Defaults to the content's intrinsic size, constrained by min and max size, if set.
+     */
+    abstract readonly size: WorkbenchNotificationSize;
+    /**
+     * Sets the severity of the notification to indicate importance or urgency.
+     */
+    abstract get severity(): Signal<'info' | 'warn' | 'error'>;
+    abstract set severity(severity: 'info' | 'warn' | 'error');
+    /**
+     * Controls how long to display the notification.
+     *
+     * Can be a duration alias, or milliseconds.
+     */
+    abstract get duration(): Signal<'short' | 'medium' | 'long' | 'infinite' | number>;
+    abstract set duration(duration: 'short' | 'medium' | 'long' | 'infinite' | number);
+    /**
+     * Specifies CSS class(es) to add to the notification, e.g., to locate the notification in tests.
+     */
+    abstract get cssClass(): Signal<string[]>;
+    abstract set cssClass(cssClass: string | string[]);
+    /**
+     * Indicates whether this notification has the focus.
+     */
+    abstract readonly focused: Signal<boolean>;
+    /**
+     * Closes the notification.
+     */
+    abstract close(): void;
+}
+/**
+ * Represents the preferred notification size.
+ */
+interface WorkbenchNotificationSize {
+    /**
+     * Specifies the height of the notification, constrained by {@link minHeight} and {@link maxHeight}, if any.
+     */
+    get height(): Signal<string | undefined>;
+    set height(height: string | undefined);
+    /**
+     * Specifies the minimum height of the notification.
+     */
+    get minHeight(): Signal<string | undefined>;
+    set minHeight(minHeight: string | undefined);
+    /**
+     * Specifies the maximum height of the notification.
+     */
+    get maxHeight(): Signal<string | undefined>;
+    set maxHeight(maxHeight: string | undefined);
+}
+
 /**
  * The signature of a function to confirm closing a view., e.g., if dirty.
  *
@@ -2281,7 +2413,7 @@ type WorkbenchViewMenuItemFn = (view: WorkbenchView) => WorkbenchMenuItem | null
 /**
  * Union of workbench elements.
  */
-type WorkbenchElement = WorkbenchPart | WorkbenchView | WorkbenchDialog | WorkbenchPopup;
+type WorkbenchElement = WorkbenchPart | WorkbenchView | WorkbenchDialog | WorkbenchPopup | WorkbenchNotification;
 
 /**
  * The central class of the SCION Workbench.
@@ -4446,6 +4578,8 @@ declare class ɵWorkbenchPart implements WorkbenchPart, Blockable {
     readonly views: Signal<ɵWorkbenchView[]>;
     readonly classList: ClassList;
     readonly portal: WbComponentPortal<MainAreaPartComponent | PartComponent>;
+    readonly partBounds: Signal<DOMRect | undefined>;
+    /** Represents the bounds of the slot. Used for public API. Internally, use {@link slot.bounds()} instead. */
     readonly bounds: Signal<DOMRect | undefined>;
     readonly blockedBy: Signal<ɵWorkbenchDialog | null>;
     readonly slot: {
@@ -4569,6 +4703,7 @@ declare class ɵWorkbenchView implements WorkbenchView, Blockable {
     readonly focused: Signal<boolean>;
     readonly menuItems: Signal<WorkbenchMenuItem[]>;
     readonly blockedBy: Signal<ɵWorkbenchDialog | null>;
+    readonly bounds: Signal<DOMRect | undefined>;
     readonly slot: {
         portal: WbComponentPortal<ViewSlotComponent>;
         bounds: Signal<DOMRect | undefined>;
@@ -5967,8 +6102,8 @@ interface NotificationConfig {
 /**
  * Shows a notification.
  *
- * A notification is a closable message displayed in the upper-right corner that disappears after a few seconds unless hovered.
- * It informs about system events, task completion or errors. The severity indicates importance or urgency.
+ * A notification is a closable message displayed in the upper-right corner that disappears after a few seconds unless hovered or focused.
+ * It informs about system events, task completion, or errors. Severity indicates importance or urgency.
  *
  * Notifications can be grouped. Only the most recent notification within a group is displayed.
  *
@@ -5990,47 +6125,6 @@ declare class NotificationService {
     static ɵprov: i0.ɵɵInjectableDeclaration<NotificationService>;
 }
 
-/**
- * A notification is a closable message displayed in the upper-right corner that disappears after a few seconds unless hovered.
- * It informs about system events, task completion or errors. The severity indicates importance or urgency.
- *
- * The notification component can inject this handle to interact with the notification.
- *
- * Notification inputs are available as input properties in the notification component.
- *
- * @see WorkbenchNotificationService
- */
-declare abstract class WorkbenchNotification {
-    /**
-     * Sets the title of the notification.
-     *
-     * Can be text or a translation key. A translation key starts with the percent symbol (`%`) and may include parameters in matrix notation for text interpolation.
-     */
-    abstract get title(): Signal<Translatable | undefined>;
-    abstract set title(title: Translatable | undefined);
-    /**
-     * Sets the severity of the notification to indicate importance or urgency.
-     */
-    abstract get severity(): Signal<'info' | 'warn' | 'error'>;
-    abstract set severity(severity: 'info' | 'warn' | 'error');
-    /**
-     * Controls how long to display the notification.
-     *
-     * Can be a duration alias, or milliseconds.
-     */
-    abstract get duration(): Signal<'short' | 'medium' | 'long' | 'infinite' | number>;
-    abstract set duration(duration: 'short' | 'medium' | 'long' | 'infinite' | number);
-    /**
-     * Specifies CSS class(es) to add to the notification, e.g., to locate the notification in tests.
-     */
-    abstract get cssClass(): Signal<string[]>;
-    abstract set cssClass(cssClass: string | string[]);
-    /**
-     * Closes the notification.
-     */
-    abstract close(): void;
-}
-
 /**
  * Controls the appearance and behavior of a notification.
  */
@@ -6069,7 +6163,9 @@ interface WorkbenchNotificationOptions {
         [name: string]: unknown;
     }) => {
         [name: string]: unknown;
-    };
+    } | Promise<{
+        [name: string]: unknown;
+    }>;
     /**
      * Specifies data to pass to the notification component. Inputs are available as input properties in the notification component.
      *
@@ -6114,8 +6210,8 @@ interface WorkbenchNotificationOptions {
 /**
  * Shows a notification.
  *
- * A notification is a closable message displayed in the upper-right corner that disappears after a few seconds unless hovered.
- * It informs about system events, task completion or errors. The severity indicates importance or urgency.
+ * A notification is a closable message displayed in the upper-right corner that disappears after a few seconds unless hovered or focused.
+ * It informs about system events, task completion, or errors. Severity indicates importance or urgency.
  *
  * Notifications can be grouped. Only the most recent notification within a group is displayed.
  *
@@ -6125,11 +6221,11 @@ declare abstract class WorkbenchNotificationService {
     /**
      * Displays the specified message as workbench notification.
      *
-     * @param message - Specifies the text to display.
+     * @param message - Specifies the text to display, if any.
      *                  Can be text or a translation key. A translation key starts with the percent symbol (`%`) and may include parameters in matrix notation for text interpolation.
      * @param options - Controls the appearance and behavior of the notification.
      */
-    abstract show(message: Translatable, options?: WorkbenchNotificationOptions): void;
+    abstract show(message: Translatable | null, options?: WorkbenchNotificationOptions): void;
     /**
      * Displays the specified component as workbench notification.
      *
@@ -6719,5 +6815,5 @@ declare class IconComponent {
     static ɵcmp: i0.ɵɵComponentDeclaration<IconComponent, "wb-icon", never, { "icon": { "alias": "icon"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
 }
 
-export { ActivatedMicrofrontend, IconComponent, LogAppender, LogLevel, Logger, LoggerName, MAIN_AREA, MAIN_AREA_INITIAL_PART_ID, MicrofrontendPlatformConfigLoader, MicrofrontendPlatformStartupPhase, Notification, NotificationService, Popup, PopupConfig, PopupService, TextPipe, VIEW_TAB_RENDERING_CONTEXT, WORKBENCH_DIALOG_CONTEXT, WORKBENCH_ID, WORKBENCH_PART_CONTEXT, WORKBENCH_POPUP_CONTEXT, WORKBENCH_POPUP_REFERRER, WORKBENCH_VIEW_CONTEXT, WorkbenchComponent, WorkbenchConfig, WorkbenchDesktopDirective, WorkbenchDialog, WorkbenchDialogActionDirective, WorkbenchDialogFooterDirective, WorkbenchDialogHeaderDirective, WorkbenchDialogService, WorkbenchLauncher, WorkbenchLayoutFactory, WorkbenchMessageBoxService, WorkbenchNotification, WorkbenchNotificationService, WorkbenchPart, WorkbenchPartActionDirective, WorkbenchPerspectiveData, WorkbenchPopup, WorkbenchPopupService, WorkbenchRouteData, WorkbenchRouter, WorkbenchRouterLinkDirective, WorkbenchService, WorkbenchStartup, WorkbenchStartupPhase, WorkbenchStorage, WorkbenchView, WorkbenchViewMenuItemDirective, canMatchWorkbenchDialogCapability, canMatchWorkbenchMessageBoxCapability, canMatchWorkbenchOutlet, canMatchWorkbenchPart, canMatchWorkbenchPartCapability, canMatchWorkbenchPerspective, canMatchWorkbenchPopupCapability, canMatchWorkbenchView, canMatchWorkbenchViewCapability, provideMicrofrontendPlatformInitializer, provideWorkbench, provideWorkbenchInitializer, text };
-export type { ActivityId, BottomLeftPoint, BottomRightPoint, CanCloseFn, CanCloseRef, CloseStrategy$1 as CloseStrategy, Commands, DialogId, Disposable, DockedPartExtras, DockingArea, LogEvent, MenuItemConfig, MicrofrontendPlatformInitializerOptions, NavigateFn, NavigationData, NavigationState, NotificationConfig, PartExtras, PartId, Point, PopupId, PopupOrigin, ReferencePart, TopLeftPoint, TopRightPoint, Translatable, ViewId, ViewMenuItemsConfig, ViewTabRenderingContext, WorkbenchDialogOptions, WorkbenchDialogSize, WorkbenchElement, WorkbenchIconDescriptor, WorkbenchIconProviderFn, WorkbenchInitializerFn, WorkbenchInitializerOptions, WorkbenchLayout, WorkbenchLayoutFn, WorkbenchMenuItem, WorkbenchMessageBoxOptions, WorkbenchNavigationExtras, WorkbenchNotificationOptions, WorkbenchPartAction, WorkbenchPartActionFn, WorkbenchPartNavigation, WorkbenchPerspective, WorkbenchPerspectiveDefinition, WorkbenchPerspectiveSelectionFn, WorkbenchPerspectives, WorkbenchPopupOptions, WorkbenchPopupSize, WorkbenchTextProviderFn, WorkbenchViewMenuItemFn, WorkbenchViewNavigation };
+export { ActivatedMicrofrontend, IconComponent, LogAppender, LogLevel, Logger, LoggerName, MAIN_AREA, MAIN_AREA_INITIAL_PART_ID, MicrofrontendPlatformConfigLoader, MicrofrontendPlatformStartupPhase, Notification, NotificationService, Popup, PopupConfig, PopupService, TextPipe, VIEW_TAB_RENDERING_CONTEXT, WORKBENCH_DIALOG_CONTEXT, WORKBENCH_ID, WORKBENCH_PART_CONTEXT, WORKBENCH_POPUP_CONTEXT, WORKBENCH_POPUP_REFERRER, WORKBENCH_VIEW_CONTEXT, WorkbenchComponent, WorkbenchConfig, WorkbenchDesktopDirective, WorkbenchDialog, WorkbenchDialogActionDirective, WorkbenchDialogFooterDirective, WorkbenchDialogHeaderDirective, WorkbenchDialogService, WorkbenchLauncher, WorkbenchLayoutFactory, WorkbenchMessageBoxService, WorkbenchNotification, WorkbenchNotificationService, WorkbenchPart, WorkbenchPartActionDirective, WorkbenchPerspectiveData, WorkbenchPopup, WorkbenchPopupService, WorkbenchRouteData, WorkbenchRouter, WorkbenchRouterLinkDirective, WorkbenchService, WorkbenchStartup, WorkbenchStartupPhase, WorkbenchStorage, WorkbenchView, WorkbenchViewMenuItemDirective, canMatchWorkbenchDialogCapability, canMatchWorkbenchMessageBoxCapability, canMatchWorkbenchNotificationCapability, canMatchWorkbenchOutlet, canMatchWorkbenchPart, canMatchWorkbenchPartCapability, canMatchWorkbenchPerspective, canMatchWorkbenchPopupCapability, canMatchWorkbenchView, canMatchWorkbenchViewCapability, provideMicrofrontendPlatformInitializer, provideWorkbench, provideWorkbenchInitializer, text };
+export type { ActivityId, BottomLeftPoint, BottomRightPoint, CanCloseFn, CanCloseRef, CloseStrategy$1 as CloseStrategy, Commands, DialogId, Disposable, DockedPartExtras, DockingArea, LogEvent, MenuItemConfig, MicrofrontendPlatformInitializerOptions, NavigateFn, NavigationData, NavigationState, NotificationConfig, NotificationId, PartExtras, PartId, Point, PopupId, PopupOrigin, ReferencePart, TopLeftPoint, TopRightPoint, Translatable, ViewId, ViewMenuItemsConfig, ViewTabRenderingContext, WorkbenchDialogOptions, WorkbenchDialogSize, WorkbenchElement, WorkbenchIconDescriptor, WorkbenchIconProviderFn, WorkbenchInitializerFn, WorkbenchInitializerOptions, WorkbenchLayout, WorkbenchLayoutFn, WorkbenchMenuItem, WorkbenchMessageBoxOptions, WorkbenchNavigationExtras, WorkbenchNotificationOptions, WorkbenchPartAction, WorkbenchPartActionFn, WorkbenchPartNavigation, WorkbenchPerspective, WorkbenchPerspectiveDefinition, WorkbenchPerspectiveSelectionFn, WorkbenchPerspectives, WorkbenchPopupOptions, WorkbenchPopupSize, WorkbenchTextProviderFn, WorkbenchViewMenuItemFn, WorkbenchViewNavigation };