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

package/fesm2022/scion-workbench.mjs

@@ -19,7 +19,7 @@ import * as i1 from '@angular/forms';
 import { NonNullableFormBuilder, ReactiveFormsModule, NG_VALUE_ACCESSOR } from '@angular/forms';
 import { FocusMonitor, CdkTrapFocus } from '@angular/cdk/a11y';
 import { trigger, transition, style, animate } from '@angular/animations';
-import { ManifestService, MicrofrontendPlatform, PlatformState, MessageHeaders, MessageClient, ResponseStatusCodes, OutletRouter, MicrofrontendPlatformConfig, APP_IDENTITY, mapToBody, HostManifestInterceptor, ObservableDecorator, IntentInterceptor, CapabilityInterceptor, MicrofrontendPlatformHost, IntentClient, PlatformPropertyService } from '@scion/microfrontend-platform';
+import { ManifestService, MicrofrontendPlatform, PlatformState, MessageHeaders, MessageClient, ResponseStatusCodes, mapToBody, OutletRouter, MicrofrontendPlatformConfig, APP_IDENTITY, HostManifestInterceptor, ObservableDecorator, IntentInterceptor, CapabilityInterceptor, MicrofrontendPlatformHost, IntentClient, PlatformPropertyService } from '@scion/microfrontend-platform';
 import { Beans } from '@scion/toolkit/bean-manager';
 import { ɵMicrofrontendRouteParams as _MicrofrontendRouteParams, WorkbenchCapabilities, WorkbenchTextService, WorkbenchMessageBox, eMESSAGE_BOX_MESSAGE_PARAM, ɵTHEME_CONTEXT_KEY as _THEME_CONTEXT_KEY, ɵWorkbenchCommands as _WorkbenchCommands, ɵPOPUP_CONTEXT as _POPUP_CONTEXT, ɵWorkbenchPopupMessageHeaders as _WorkbenchPopupMessageHeaders, WorkbenchPopup, ɵMESSAGE_BOX_CONTEXT as _MESSAGE_BOX_CONTEXT, ɵDIALOG_CONTEXT as _DIALOG_CONTEXT, ɵWorkbenchDialogMessageHeaders as _WorkbenchDialogMessageHeaders, WorkbenchDialog as WorkbenchDialog$1, WorkbenchRouter as WorkbenchRouter$1, WorkbenchPopupService, WorkbenchMessageBoxService as WorkbenchMessageBoxService$1, ɵWorkbenchMessageBoxService as _WorkbenchMessageBoxService, WorkbenchDialogService as WorkbenchDialogService$1, ɵWorkbenchDialogService as _WorkbenchDialogService, WorkbenchNotificationService, ɵWorkbenchTextService as _WorkbenchTextService, ɵVIEW_ID_CONTEXT_KEY as _VIEW_ID_CONTEXT_KEY, WorkbenchClient } from '@scion/workbench-client';
 import { SciThrobberComponent } from '@scion/components/throbber';
@@ -5570,22 +5570,22 @@ function parseMatrixParams(matrixParams) {
         return {};
     }
     const params = {};
-    for (const match of escapeSemicolon(matrixParams).matchAll(/(?<paramName>[^=;]+)=(?<paramValue>[^;]*)/g)) {
+    for (const match of encodeEscapedSemicolons(matrixParams).matchAll(/(?<paramName>[^=;]+)=(?<paramValue>[^;]*)/g)) {
         const { paramName, paramValue } = match.groups;
-        params[unescapeSemicolon(paramName)] = unescapeSemicolon(paramValue);
+        params[paramName] = decodeSemicolons(paramValue);
     }
     return params;
     /**
-     * Replaces escaped semicolons (`\;`) with the placeholder (`ɵ`) to prevent interpretation as key-value separators.
+     * Encodes escaped semicolons (`\\;`) as `&#x3b` (Unicode) to prevent interpretation as interpolation parameter separators.
      */
-    function escapeSemicolon(value) {
-        return value.replaceAll('\\;', 'ɵ');
+    function encodeEscapedSemicolons(value) {
+        return value.replaceAll('\\;', '&#x3b');
     }
     /**
-     * Restores escaped semicolons by replacing the placeholder (`ɵ`) back to semicolons (`;`).
+     * Decodes encoded semicolons (`&#x3b`) back to semicolons (`;`).
      */
-    function unescapeSemicolon(value) {
-        return value.replaceAll('ɵ', ';');
+    function decodeSemicolons(value) {
+        return value.replaceAll('&#x3b', ';');
     }
 }
 
@@ -14359,47 +14359,72 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.2.3", ngImpor
 /**
  * Registers a text provider for the SCION Workbench to get texts from micro apps.
  *
- * If the key matches the format of a remote key, text is requested via intent from the respective 'text-provider' capability.
- * If not, the key is ignored and `undefined` is returned.
- *
- * Remote key format: "workbench.external.~<APP_SYMBOLIC_NAME>~.<TEXT_KEY>".
+ * This text provider provides texts for keys matching the format: "workbench.external.scion-workbench-client.<APP_SYMBOLIC_NAME>.<TRANSLATABLE>".
  *
  * @see createRemoteTranslatable
  */
 function provideRemoteTextProvider() {
-    const REMOTE_KEY = /^workbench\.external\.~(?<provider>[^\\~]+)~\.(?<key>.+)$/;
+    const REMOTE_TRANSLATION_KEY = /^workbench\.external\.scion-workbench-client\.(?<provider>[^\\.]+)\.%(?<key>.+)$/;
+    const REMOTE_TEXT = /^workbench\.external\.scion-workbench-client\.(?<provider>[^\\.]+)\.(?<text>[^%].+)$/;
     return makeEnvironmentProviders([
         {
             provide: WORKBENCH_TEXT_PROVIDER,
-            useValue: remoteTextProvider,
+            useValue: provideRemoteText,
+            multi: true,
+        },
+        {
+            provide: WORKBENCH_TEXT_PROVIDER,
+            useValue: interpolateRemoteText,
             multi: true,
         },
     ]);
-    function remoteTextProvider(remoteKey, params) {
-        // Test if the key matches a remote key.
-        const match = REMOTE_KEY.exec(remoteKey);
+    /**
+     * Provides text from a remote app.
+     */
+    function provideRemoteText(translationKey, params) {
+        // Test if the key matches a remote translation key.
+        const match = REMOTE_TRANSLATION_KEY.exec(translationKey);
         if (!match) {
-            return undefined; // ignore key
+            return undefined;
         }
-        // Parse key and provider from the remote key.
+        // Parse key and provider from the remote translation key.
         const { key, provider } = match.groups;
         // Request the text by intent. Parameters starting with the topic protocol 'topic://' are resolved via messaging.
-        const text$ = observeParams$(params)
-            .pipe(map$1(params => params.reduce((translatable, [name, value]) => `${translatable};${name}=${value}`, `%${key}`)), switchMap(translatable => Beans.get(WorkbenchTextService).text$(translatable, { provider: provider })), map$1(text => text ?? key));
+        const text$ = observeParams$(params, { provider })
+            .pipe(map$1(params => params.reduce((translatable, [param, value]) => `${translatable};${param}=${encodeSemicolons$1(value)}`, `%${key}`)), switchMap(translatable => Beans.get(WorkbenchTextService).text$(translatable, { provider })), map$1(text => text ?? key));
         return toSignal(text$, { initialValue: '' });
     }
     /**
-     * Creates an Observable that emits tuples of name/value pairs from the passed parameters.
+     * Substitutes named parameters in a remote text.
+     */
+    function interpolateRemoteText(translationKey, params) {
+        // Test if the key matches a remote text.
+        const match = REMOTE_TEXT.exec(translationKey);
+        if (!match) {
+            return undefined;
+        }
+        // Parse text and provider from the remote text.
+        const { text, provider } = match.groups;
+        // Substitute params. Parameters starting with the topic protocol 'topic://' are resolved via messaging.
+        const text$ = observeParams$(params, { provider })
+            .pipe(map$1(params => params.reduce((text, [param, value]) => text.replaceAll(`:${param}`, value), decodeSemicolons(text))));
+        return toSignal(text$, { initialValue: '' });
+    }
+    /**
+     * Creates an Observable that emits tuples of name-value pairs from the passed parameters.
      *
      * Parameters starting with the topic protocol 'topic://' are resolved via topic-based messaging.
      */
-    function observeParams$(params) {
-        const observableParams = Object.entries(params).map(([name, value]) => {
+    function observeParams$(params, options) {
+        const observableParams = Object.entries(params).map(([param, value]) => {
             if (!value.startsWith(TOPIC_PROTOCOL)) {
-                return of([name, value]);
+                return of([param, value]);
             }
             const topic = value.substring(TOPIC_PROTOCOL.length);
-            return Beans.get(MessageClient).request$(topic, undefined, { retain: true }).pipe(map$1(({ body: resolved }) => ([name, resolved ?? ''])));
+            return Beans.get(MessageClient).request$(topic, undefined, { retain: true })
+                .pipe(mapToBody(), 
+            // Resolve text if the resolver returns a translatable.
+            switchMap(resolved => resolved?.startsWith('%') ? Beans.get(WorkbenchTextService).text$(resolved, options) : of(resolved)), map$1(resolved => [param, resolved ?? '']));
         });
         return observableParams.length ? combineLatest(observableParams) : of([]);
     }
@@ -14407,38 +14432,77 @@ function provideRemoteTextProvider() {
 /**
  * Creates a translatable for the SCION Workbench to request the text from a micro app.
  *
- * Passed parameters are used to substitute named interpolation parameters. A named interpolation parameter starts with a colon (`:`) followed by a name.
+ * Passed parameters are used to substitute named parameters in the text or interpolation parameters of the translation key.
  *
- * Example: %translationKey;param1=value1;param2=:value2 // :value2 is a named interpolation parameter
+ * A named parameter starts with a colon (`:`) followed by the parameter name and can be substituted by an explicit value (passed as value param) or topic (passed as topic param).
+ * Topic params define a topic with the actual value requested when resolving the translatable. A topic can also reference value params as named params in topic segments.
  *
- * Named interpolation parameters can be substituted by explicit values (passed as value params) or topics (passed as topic params).
- * Unlike value params, topic params define a topic and the actual value will be requested when resolving the translatable.
- * Like the translatable's interpolation params, a topic can reference value params as named parameters in topic segments.
+ * @example - Translation Key
+ * `%translationKey;param1=:namedParam1;param2=:namedParam2`
+ *
+ * @example - Text
+ * `Text with :namedParam1 and :namedParam2`
  *
  * @param translatable - Specifies the translatable.
- * @param config - Specifies the text provider and values for substituting named interpolation parameters.
+ * @param config - Specifies the text provider and values for substituting named parameters.
  * @return Translatable that can be passed to the workbench's {@link text()} function for translation.
  *
  * @see provideRemoteTextProvider
  */
 function createRemoteTranslatable(translatable, config) {
-    if (!translatable?.startsWith('%')) {
+    if (!translatable) {
+        return translatable;
+    }
+    // Create Map of value params.
+    const valueParams = new Map(Object.entries(Dictionaries.coerce(config.valueParams)).map(([param, value]) => [param, encodeSemicolons$1(value)]));
+    // Create Map of topic params, substituting referenced value params.
+    const topicParams = new Map(Object.entries(Dictionaries.coerce(config.topicParams)).map(([param, topic]) => [param, toTopicParam(topic)]));
+    // Return text as-is if not a translation key nor referencing parameters.
+    if (!translatable.startsWith('%') && !containsParam(translatable, valueParams) && !containsParam(translatable, topicParams)) {
         return translatable;
     }
-    const remoteTranslatable = `%workbench.external.~${config.appSymbolicName}~.${translatable.substring(1)}`;
-    const valueParams = Dictionaries.coerce(config.valueParams);
-    const topicParams = Object.fromEntries(Object.entries(Dictionaries.coerce(config.topicParams))
-        // Replace named params in topic segments.
-        .map(([name, topic]) => [name, topic.replace(/(?<=\/|^):(?<namedParam>[^/]+)/g, (match, namedParam) => `${valueParams[namedParam] ?? match}`)])
-        // Add topic protocol to indicate resolution via topic-based messaging.
-        .map(([paramName, topic]) => [paramName, `${TOPIC_PROTOCOL}${topic}`]));
-    // Replace named params in matrix param values.
-    return remoteTranslatable.replace(/(?<==):(?<namedParam>[^;]+)/g, (match, namedParam) => `${valueParams[namedParam] ?? topicParams[namedParam] ?? match}`);
+    const remoteTranslatablePrefix = `%workbench.external.scion-workbench-client.${config.appSymbolicName}`;
+    if (translatable.startsWith('%')) {
+        // Substitute named parameters in interpolation params.
+        return `${remoteTranslatablePrefix}.${translatable}`.replace(/(?<==):(?<namedParam>[^;]+)/g, (match, param) => valueParams.get(param) ?? topicParams.get(param) ?? match);
+    }
+    else {
+        // Append referenced parameters in matrix notation.
+        return [...valueParams, ...topicParams]
+            .filter(([param]) => translatable.includes(`:${param}`))
+            .reduce((translatable, [param, value]) => `${translatable};${param}=${value}`, `${remoteTranslatablePrefix}.${encodeSemicolons$1(translatable)}`);
+    }
+    /**
+     * Adds the topic protocol to indicate resolution via topic-based messaging and substitutes named topic segments.
+     */
+    function toTopicParam(topic) {
+        return `${TOPIC_PROTOCOL}${topic.replace(/(?<=\/|^):(?<namedParam>[^/]+)/g, (match, namedParam) => {
+            return valueParams.get(namedParam) ?? match;
+        })}`;
+    }
+    /**
+     * Tests whether the passed text references any of the passed params.
+     */
+    function containsParam(text, params) {
+        return Array.from(params.keys()).some(param => text.includes(`:${param}`));
+    }
 }
 /**
  * Prefix of topic params.
  */
 const TOPIC_PROTOCOL = 'topic://';
+/**
+ * Encodes semicolons (`;`) as `&#x3b` (Unicode) to prevent interpretation as interpolation parameter separators.
+ */
+function encodeSemicolons$1(value) {
+    return `${value}`.replaceAll(';', '&#x3b');
+}
+/**
+ * Decodes encoded semicolons (`&#x3b`) back to semicolons (`;`).
+ */
+function decodeSemicolons(value) {
+    return value.replaceAll('&#x3b', ';');
+}
 
 /*
  * Copyright (c) 2018-2024 Swiss Federal Railways
@@ -17055,7 +17119,7 @@ function provideHostTextProvider() {
         provideMicrofrontendPlatformInitializer(() => {
             const injector = inject(Injector);
             WorkbenchClient.registerTextProvider((key, params) => {
-                const translatable = Object.entries(params).reduce((translatable, [name, value]) => `${translatable};${name}=${value}`, `%${key}`);
+                const translatable = Object.entries(params).reduce((translatable, [name, value]) => `${translatable};${name}=${encodeSemicolons(value)}`, `%${key}`);
                 const environmentInjector = createEnvironmentInjector([], injector.get(EnvironmentInjector));
                 return toObservable(text(translatable, { injector: environmentInjector }), { injector: environmentInjector })
                     .pipe(map$1(text => text !== '' && text !== key ? text : undefined), // emit `undefined` if not found the text
@@ -17064,6 +17128,14 @@ function provideHostTextProvider() {
         }),
     ]);
 }
+/**
+ * Encodes semicolons (`;`) as `\\;` to prevent interpretation as interpolation parameter separators.
+ *
+ * @see Translatable
+ */
+function encodeSemicolons(value) {
+    return value.replaceAll(';', '\\;');
+}
 
 /*
  * Copyright (c) 2018-2024 Swiss Federal Railways