@scion/workbench 20.0.0-beta.5 → 20.0.0-beta.6

package/index.d.ts

@@ -385,7 +385,6 @@ type NavigateFn = (layout: WorkbenchLayout) => Promise<WorkbenchLayout | null> |
  * Signature of a function to provide texts to the SCION Workbench.
  *
  * Texts starting with the percent symbol (`%`) are passed to the text provider for translation, with the percent symbol omitted.
- * Otherwise, the text is returned as is.
  *
  * A text provider can be registered via configuration passed to the {@link provideWorkbench} function.
  *
@@ -393,9 +392,10 @@ type NavigateFn = (layout: WorkbenchLayout) => Promise<WorkbenchLayout | null> |
  * - Can call `inject` to get any required dependencies.
  * - Can call `toSignal` to convert an Observable to a Signal.
  *
- * @param key - Key for which to provide the text.
- * @param params - Parameters associated with the translation key.
- * @return The text associated with the provided key, or `undefined` if not found.
+ * @param key - Translation key of the text.
+ * @param params - Parameters used for text interpolation.
+ * @return Text associated with the key, or `undefined` if not found.
+ *         Localized applications should return the text in the current language, and update the signal with the translated text each time when the language changes.
  */
 type WorkbenchTextProviderFn = (key: string, params: {
     [name: string]: string;
@@ -403,14 +403,14 @@ type WorkbenchTextProviderFn = (key: string, params: {
 /**
  * Represents either a text or a key for translation.
  *
- * A translation key starts with the percent symbol (`%`) and can include parameters in matrix notation.
+ * A translation key starts with the percent symbol (`%`) and may include parameters in matrix notation for text interpolation.
  * Key and parameters are passed to {@link WorkbenchConfig.textProvider} for translation.
  *
  * Examples:
- * - `text`: no translatable text
  * - `%key`: translation key
- * - `%key;param=value`: translation key with a single param
- * - `%key;param1=value1;param2=value2`: translation key with multiple parameters
+ * - `%key;param=value`: translation key with a single interpolation parameter
+ * - `%key;param1=value1;param2=value2`: translation key with multiple interpolation parameters
+ * - `text`: no translation key, text is returned as is
  */
 type Translatable = string | `%${string}`;
 
@@ -690,6 +690,8 @@ interface ReferencePart {
 interface PartExtras {
     /**
      * Title displayed in the part bar.
+     *
+     * Can be a text or a translation key. A translation key starts with the percent symbol (`%`) and may include parameters in matrix notation for text interpolation.
      */
     title?: Translatable;
     /**
@@ -726,16 +728,22 @@ interface DockedPartExtras {
     icon: string;
     /**
      * Label of the toggle button in the sidebar.
+     *
+     * Can be a text or a translation key. A translation key starts with the percent symbol (`%`) and may include parameters in matrix notation for text interpolation.
      */
     label: Translatable;
     /**
      * Tooltip displayed when hovering over the toggle button in the sidebar.
+     *
+     * Can be a text or a translation key. A translation key starts with the percent symbol (`%`) and may include parameters in matrix notation for text interpolation.
      */
     tooltip?: Translatable;
     /**
      * Title displayed in the part bar.
      *
      * If not provided, defaults to {@link DockedPartExtras.label}. Set to `false` to not display a title.
+     *
+     * Can be a text or a translation key. A translation key starts with the percent symbol (`%`) and may include parameters in matrix notation for text interpolation.
      */
     title?: Translatable | false;
     /**
@@ -1075,7 +1083,6 @@ declare abstract class WorkbenchConfig {
      * A text provider is a function that returns the text for a translation key.
      *
      * Texts starting with the percent symbol (`%`) are passed to the text provider for translation, with the percent symbol omitted.
-     * Otherwise, the text is returned as is.
      *
      * The SCION Workbench uses the following translation keys for built-in texts:
      * - workbench.clear.tooltip
@@ -1508,9 +1515,11 @@ declare abstract class WorkbenchPart {
      * Title displayed in the part bar.
      *
      * Note that the title of the top-leftmost part of a docked part cannot be changed.
+     *
+     * Can be a 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<string | undefined>;
-    abstract set title(title: string | undefined);
+    abstract get title(): Signal<Translatable | undefined>;
+    abstract set title(title: Translatable | undefined);
     /**
      * Indicates whether this part is located in the workbench main area.
      */
@@ -1661,11 +1670,15 @@ declare abstract class WorkbenchView {
     abstract readonly part: Signal<WorkbenchPart>;
     /**
      * Title displayed in the view tab.
+     *
+     * Can be a 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 | null>;
     abstract set title(title: Translatable | null);
     /**
      * Subtitle displayed in the view tab.
+     *
+     * Can be a 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 heading(): Signal<Translatable | null>;
     abstract set heading(heading: Translatable | null);
@@ -1830,6 +1843,8 @@ declare abstract class WorkbenchDialog<R = unknown> {
     abstract readonly id: DialogId;
     /**
      * Sets the title of the dialog.
+     *
+     * Can be a 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);
@@ -2623,7 +2638,7 @@ declare class MPart {
     readonly type = "MPart";
     id: PartId;
     alternativeId?: string;
-    title?: string;
+    title?: Translatable;
     parent?: MTreeNode;
     views: MView[];
     activeViewId?: ViewId;
@@ -4189,9 +4204,9 @@ declare class ɵWorkbenchPart implements WorkbenchPart {
      */
     get injector(): Injector;
     /** @inheritDoc */
-    get title(): Signal<string | undefined>;
+    get title(): Signal<Translatable | undefined>;
     /** @inheritDoc */
-    set title(title: string | undefined);
+    set title(title: Translatable | undefined);
     /** @inheritDoc */
     set cssClass(cssClass: string | string[]);
     /** @inheritDoc */
@@ -5277,6 +5292,8 @@ declare function canMatchWorkbenchPerspective(id: string): CanMatchFn;
 interface WorkbenchMessageBoxOptions {
     /**
      * Specifies the title of the message box.
+     *
+     * Can be a text or a translation key. A translation key starts with the percent symbol (`%`) and may include parameters in matrix notation for text interpolation.
      */
     title?: Translatable;
     /**
@@ -5411,11 +5428,12 @@ declare abstract class WorkbenchMessageBoxService {
      * });
      * ```
      *
-     * @param  message - Specifies the text to display.
+     * @param  message - Specifies the text to display, if any.
+     *                   Can be a 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 message box.
      * @return Promise that resolves to the key of the action button that the user clicked to close the message box.
      */
-    abstract open(message: Translatable, options?: WorkbenchMessageBoxOptions): Promise<string>;
+    abstract open(message: Translatable | null, options?: WorkbenchMessageBoxOptions): Promise<string>;
     /**
      * Displays the specified component in a message box.
      *
@@ -5569,9 +5587,15 @@ declare abstract class Notification<T = any> {
      */
     readonly input: T | undefined;
     /**
-     * Sets the title of the notification; can be a string literal or an Observable.
+     * Sets the title of the notification.
+     */
+    abstract setTitle(title: Translatable | undefined): void;
+    /**
+     * Sets the title of the notification.
+     *
+     * @deprecated since version 20.0.0-beta.6. To migrate, pass a translatable and provide the text using a text provider registered in `WorkbenchClient.registerTextProvider`.
      */
-    abstract setTitle(title: Translatable | undefined | Observable<string | undefined>): void;
+    abstract setTitle(title: Observable<Translatable | undefined>): void;
     /**
      * Sets the severity of the notification.
      */
@@ -5598,9 +5622,13 @@ declare abstract class Notification<T = any> {
  */
 interface NotificationConfig {
     /**
-     * Optional title of the notification; can be a string literal or an Observable.
+     * Optional title of the notification.
+     *
+     * Can be a text or a translation key. A translation key starts with the percent symbol (`%`) and may include parameters in matrix notation for text interpolation.
+     *
+     * TODO [Angular 21] Passing an Observable is deprecated. To migrate, pass a translatable and provide the text using a text provider registered in `WorkbenchClient.registerTextProvider`. API will be removed in version 21.
      */
-    title?: Translatable | Observable<string>;
+    title?: Translatable | Observable<Translatable | undefined>;
     /**
      * Content of the notification, can be either a plain text message or a component.
      *
@@ -6050,6 +6078,12 @@ declare module '@scion/microfrontend-platform' {
          * @see WorkbenchPopupCapability.properties.showSplash
          */
         splash?: ComponentType<unknown>;
+        /**
+         * Controls whether to preload inactive microfrontend views not defining the `lazy` property to maintain compatibility with applications setting view titles and headings in view microfrontends. Defaults to `false`.
+         *
+         * @deprecated since version 20.0.0-beta.6. Introduced in 20.0.0-beta.6 to maintain compatibility with applications setting view titles and headings in view microfrontends. View capabilities can now define localized titles with optional interpolation parameters using resolvers. Applications should migrate to lazy view capabilities by setting 'lazy' in capability properties and define titles in the manifest. API will be removed in version 22.
+         */
+        preloadInactiveViews?: true;
     }
 }
 
@@ -6114,13 +6148,13 @@ declare abstract class WorkbenchLauncher {
  * Enables the translation of a given {@link Translatable}.
  *
  * A {@link Translatable} is a string that, if starting with the percent symbol (`%`), is passed to the text provider for translation, with the percent symbol omitted.
- * Otherwise, the text is returned as is. A translation key can include parameters in matrix notation.
+ * Otherwise, the text is returned as is. A translation key may include parameters in matrix notation for text interpolation.
  *
  * Examples:
- * - `text`: no translatable text
  * - `%key`: translation key
- * - `%key;param=value`: translation key with a single param
- * - `%key;param1=value1;param2=value2`: translation key with multiple parameters
+ * - `%key;param=value`: translation key with a single interpolation parameter
+ * - `%key;param1=value1;param2=value2`: translation key with multiple interpolation parameters
+ * - `text`: no translation key, text is returned as is
  *
  * @experimental since 20.0.0-beta.3; API and behavior may change in any version without notice.
  */
@@ -6138,13 +6172,13 @@ declare class TextPipe implements PipeTransform {
  * Provides the text for the given {@link Translatable} based on registered text providers.
  *
  * A {@link Translatable} is a string that, if starting with the percent symbol (`%`), is passed to the text provider for translation, with the percent symbol omitted.
- * Otherwise, the text is returned as is. A translation key can include parameters in matrix notation.
+ * Otherwise, the text is returned as is. A translation key may include parameters in matrix notation for text interpolation.
  *
  * Examples:
- * - `text`: no translatable text
  * - `%key`: translation key
- * - `%key;param=value`: translation key with a single param
- * - `%key;param1=value1;param2=value2`: translation key with multiple parameters
+ * - `%key;param=value`: translation key with a single interpolation parameter
+ * - `%key;param1=value1;param2=value2`: translation key with multiple interpolation parameters
+ * - `text`: no translation key, text is returned as is
  *
  * The function:
  * - Must be called within an injection context, or an explicit {@link Injector} passed.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scion/workbench",
-  "version": "20.0.0-beta.5",
+  "version": "20.0.0-beta.6",
   "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,
@@ -37,7 +37,7 @@
     "@scion/components": "^20.0.0",
     "@scion/toolkit": "^1.6.0 || ^2.0.0",
     "@scion/microfrontend-platform": "^1.4.0",
-    "@scion/workbench-client": "^1.0.0-beta.30",
+    "@scion/workbench-client": "^1.0.0-beta.31",
     "rxjs": "^7.8.0"
   },
   "peerDependenciesMeta": {