@sap-ux/preview-middleware 0.15.6 → 0.15.8

package/dist/client/cpe/changes/flex-change.js

@@ -33,7 +33,7 @@ sap.ui.define(["sap/ui/rta/command/CommandFactory", "./validator"], function (Co
     const flexSettings = rta.getFlexSettings();
     const changeType = isBindingString ? 'BindProperty' : 'Property';
     if (isBindingModel) {
-      validateBindingModel(change.value);
+      validateBindingModel(modifiedControl, change.value);
     }
     const property = isBindingString ? 'newBinding' : 'newValue';
     const modifiedValue = {

package/dist/client/cpe/changes/flex-change.ts

@@ -33,7 +33,7 @@ export async function applyChange(options: UI5AdaptationOptions, change: Propert
     const changeType = isBindingString ? 'BindProperty' : 'Property';
 
     if (isBindingModel) {
-        validateBindingModel(change.value as string);
+        validateBindingModel(modifiedControl, change.value as string);
     }
 
     const property = isBindingString ? 'newBinding' : 'newValue';

package/dist/client/cpe/changes/validator.js

@@ -1,14 +1,15 @@
 "use strict";
 
-sap.ui.define(["sap/base/i18n/ResourceBundle"], function (ResourceBundle) {
+sap.ui.define([], function () {
   "use strict";
 
   /**
    * Function to validate if a given value is a valid binding model.
    *
+   * @param modifiedControl control to be modified.
    * @param value value to be checked.
    */
-  function validateBindingModel(value) {
+  function validateBindingModel(modifiedControl, value) {
     const bindingValue = value.replace(/[{}]/gi, '').trim();
     const bindingParts = bindingValue.split('>').filter(el => el !== '');
     if (!bindingParts.length) {
@@ -16,11 +17,9 @@ sap.ui.define(["sap/base/i18n/ResourceBundle"], function (ResourceBundle) {
     }
     if (bindingParts[0].trim() === 'i18n') {
       if (bindingParts.length === 2) {
-        const resourceBundle = ResourceBundle.create({
-          url: '../i18n/i18n.properties'
-        });
         const resourceKey = bindingParts[1].trim();
-        if (!resourceBundle.hasText(resourceKey)) {
+        const resourceBundle = modifiedControl.getModel('i18n').getResourceBundle();
+        if (!resourceBundle.getText(resourceKey, undefined, true)) {
           throw new SyntaxError('Invalid key in the binding string. Supported value pattern is {i18n>YOUR_KEY}. Check if the key already exists in i18n.properties.' + 'If not, add the key in the i18n.properties file and reload the editor for the new key to take effect.');
         }
       } else {

package/dist/client/cpe/changes/validator.ts

@@ -1,11 +1,14 @@
 import ResourceBundle from 'sap/base/i18n/ResourceBundle';
+import ResourceModel from 'sap/ui/model/resource/ResourceModel';
+import type UI5Element from 'sap/ui/core/Element';
 
 /**
  * Function to validate if a given value is a valid binding model.
  *
+ * @param modifiedControl control to be modified.
  * @param value value to be checked.
  */
-export function validateBindingModel(value: string): void {
+export function validateBindingModel(modifiedControl: UI5Element, value: string): void {
     const bindingValue = value.replace(/[{}]/gi, '').trim();
     const bindingParts = bindingValue.split('>').filter((el) => el !== '');
 
@@ -15,11 +18,9 @@ export function validateBindingModel(value: string): void {
 
     if (bindingParts[0].trim() === 'i18n') {
         if (bindingParts.length === 2) {
-            const resourceBundle = ResourceBundle.create({
-                url: '../i18n/i18n.properties'
-            }) as ResourceBundle;
             const resourceKey = bindingParts[1].trim();
-            if (!resourceBundle.hasText(resourceKey)) {
+            const resourceBundle = (modifiedControl.getModel('i18n') as ResourceModel).getResourceBundle() as ResourceBundle;
+            if (!resourceBundle.getText(resourceKey, undefined, true)) {
                 throw new SyntaxError(
                     'Invalid key in the binding string. Supported value pattern is {i18n>YOUR_KEY}. Check if the key already exists in i18n.properties.' +
                         'If not, add the key in the i18n.properties file and reload the editor for the new key to take effect.'

package/dist/client/flp/init.js

@@ -1,8 +1,9 @@
 "use strict";
 
-sap.ui.define(["sap/base/Log", "sap/ui/core/IconPool", "sap/base/i18n/ResourceBundle"], function (Log, IconPool, ResourceBundle) {
+sap.ui.define(["sap/base/Log", "sap/ui/fl/Scenario", "sap/ui/core/IconPool", "sap/base/i18n/ResourceBundle", "../adp/api-handler"], function (Log, scenarios, IconPool, ResourceBundle, ___adp_api_handler) {
   "use strict";
 
+  const getManifestAppdescr = ___adp_api_handler["getManifestAppdescr"];
   /**
    * SAPUI5 delivered namespaces from https://ui5.sap.com/#/api/sap
    */
@@ -136,19 +137,35 @@ sap.ui.define(["sap/base/Log", "sap/ui/core/IconPool", "sap/base/i18n/ResourceBu
     IconPool.registerFont(suiteTheme);
   }
 
+  /**
+   * Create Resource Bundle based on the scenario.
+   *
+   * @param scenario to be used for the resource bundle.
+   */
+  async function loadI18nResourceBundle(scenario) {
+    if (scenario === scenarios.AdaptationProject) {
+      const manifest = await getManifestAppdescr();
+      const enhanceWith = manifest.content.filter(content => content.texts?.i18n).map(content => ({
+        bundleUrl: `../${content.texts.i18n}`
+      }));
+      return ResourceBundle.create({
+        url: '../i18n/i18n.properties',
+        enhanceWith
+      });
+    }
+    return ResourceBundle.create({
+      url: 'i18n/i18n.properties'
+    });
+  }
+
   /**
    * Read the application title from the resource bundle and set it as document title.
    *
+   * @param resourceBundle resource bundle to read the title from.
    * @param i18nKey optional parameter to define the i18n key to be used for the title.
    */
-  function setI18nTitle() {
-    let i18nKey = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'appTitle';
-    const localization = sap.ui.require('sap/base/i18n/Localization') ?? sap.ui.getCore().getConfiguration();
-    const locale = localization.getLanguage();
-    const resourceBundle = ResourceBundle.create({
-      url: 'i18n/i18n.properties',
-      locale
-    });
+  function setI18nTitle(resourceBundle) {
+    let i18nKey = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'appTitle';
     if (resourceBundle.hasText(i18nKey)) {
       document.title = resourceBundle.getText(i18nKey) ?? document.title;
     }
@@ -171,8 +188,11 @@ sap.ui.define(["sap/base/Log", "sap/ui/core/IconPool", "sap/base/i18n/ResourceBu
     } = _ref;
     const urlParams = new URLSearchParams(window.location.search);
     const container = sap?.ushell?.Container ?? sap.ui.require('sap/ushell/Container');
+    let scenario = '';
     // Register RTA if configured
     if (flex) {
+      const flexSettings = JSON.parse(flex);
+      scenario = flexSettings.scenario;
       container.attachRendererCreatedEvent(async function () {
         const lifecycleService = await container.getServiceAsync('AppLifeCycle');
         lifecycleService.attachAppLoaded(event => {
@@ -219,7 +239,8 @@ sap.ui.define(["sap/base/Log", "sap/ui/core/IconPool", "sap/base/i18n/ResourceBu
     }
 
     // init
-    setI18nTitle();
+    const resourceBundle = await loadI18nResourceBundle(scenario);
+    setI18nTitle(resourceBundle);
     registerSAPFonts();
     const renderer = await container.createRenderer(undefined, true);
     renderer.placeAt('content');
@@ -238,6 +259,7 @@ sap.ui.define(["sap/base/Log", "sap/ui/core/IconPool", "sap/base/i18n/ResourceBu
   __exports.resetAppState = resetAppState;
   __exports.registerComponentDependencyPaths = registerComponentDependencyPaths;
   __exports.registerSAPFonts = registerSAPFonts;
+  __exports.loadI18nResourceBundle = loadI18nResourceBundle;
   __exports.setI18nTitle = setI18nTitle;
   __exports.init = init;
   return __exports;

package/dist/client/flp/init.ts

@@ -1,11 +1,13 @@
 import Log from 'sap/base/Log';
 import type AppLifeCycle from 'sap/ushell/services/AppLifeCycle';
 import type { InitRtaScript, RTAPlugin, StartAdaptation } from 'sap/ui/rta/api/startAdaptation';
+import scenarios, { type Scenario } from 'sap/ui/fl/Scenario';
 import type { FlexSettings, RTAOptions } from 'sap/ui/rta/RuntimeAuthoring';
 import IconPool from 'sap/ui/core/IconPool';
 import ResourceBundle from 'sap/base/i18n/ResourceBundle';
 import AppState from 'sap/ushell/services/AppState';
-import type Localization from 'sap/base/i18n/Localization';
+import { getManifestAppdescr } from '../adp/api-handler';
+
 /**
  * SAPUI5 delivered namespaces from https://ui5.sap.com/#/api/sap
  */
@@ -188,19 +190,34 @@ export function registerSAPFonts() {
     IconPool.registerFont(suiteTheme);
 }
 
+/**
+ * Create Resource Bundle based on the scenario.
+ *
+ * @param scenario to be used for the resource bundle.
+ */
+export async function loadI18nResourceBundle(scenario: Scenario): Promise<ResourceBundle> {
+    if (scenario === scenarios.AdaptationProject) {
+        const manifest = await getManifestAppdescr();
+        const enhanceWith = (manifest.content as { texts: { i18n: string } }[])
+            .filter((content) => content.texts?.i18n)
+            .map((content) => ({ bundleUrl: `../${content.texts.i18n}` }));
+        return ResourceBundle.create({
+            url: '../i18n/i18n.properties',
+            enhanceWith
+        });
+    }
+    return ResourceBundle.create({
+        url: 'i18n/i18n.properties'
+    });
+}
+
 /**
  * Read the application title from the resource bundle and set it as document title.
  *
+ * @param resourceBundle resource bundle to read the title from.
  * @param i18nKey optional parameter to define the i18n key to be used for the title.
  */
-export function setI18nTitle(i18nKey = 'appTitle') {
-    const localization =
-        (sap.ui.require('sap/base/i18n/Localization') as Localization) ?? sap.ui.getCore().getConfiguration();
-    const locale = localization.getLanguage();
-    const resourceBundle = ResourceBundle.create({
-        url: 'i18n/i18n.properties',
-        locale
-    }) as ResourceBundle;
+export function setI18nTitle(resourceBundle: ResourceBundle, i18nKey = 'appTitle') {
     if (resourceBundle.hasText(i18nKey)) {
         document.title = resourceBundle.getText(i18nKey) ?? document.title;
     }
@@ -226,8 +243,11 @@ export async function init({
 }): Promise<void> {
     const urlParams = new URLSearchParams(window.location.search);
     const container = sap?.ushell?.Container ?? (sap.ui.require('sap/ushell/Container') as typeof sap.ushell.Container);
+    let scenario: string = '';
     // Register RTA if configured
     if (flex) {
+        const flexSettings = JSON.parse(flex) as FlexSettings;
+        scenario = flexSettings.scenario;
         container.attachRendererCreatedEvent(async function () {
             const lifecycleService = await container.getServiceAsync<AppLifeCycle>('AppLifeCycle');
             lifecycleService.attachAppLoaded((event) => {
@@ -281,7 +301,8 @@ export async function init({
     }
 
     // init
-    setI18nTitle();
+    const resourceBundle = await loadI18nResourceBundle(scenario as Scenario);
+    setI18nTitle(resourceBundle);
     registerSAPFonts();
     const renderer = await container.createRenderer(undefined, true);
     renderer.placeAt('content');

package/package.json

@@ -9,7 +9,7 @@
   "bugs": {
     "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Apreview-middleware"
   },
-  "version": "0.15.6",
+  "version": "0.15.8",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -27,9 +27,9 @@
     "mem-fs-editor": "9.4.0",
     "@sap-ux/logger": "0.5.1",
     "@sap-ux/btp-utils": "0.14.4",
-    "@sap-ux/adp-tooling": "0.11.12",
-    "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.4.23",
-    "@sap-ux/project-access": "1.22.3"
+    "@sap-ux/adp-tooling": "0.11.13",
+    "@sap-ux/project-access": "1.22.4",
+    "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.4.23"
   },
   "devDependencies": {
     "@types/ejs": "3.1.2",
@@ -45,11 +45,11 @@
     "supertest": "6.3.3",
     "@sap-ux-private/playwright": "0.0.3",
     "dotenv": "16.3.1",
-    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.9.17",
+    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.9.18",
     "@sap-ux/axios-extension": "1.14.4",
+    "@sap-ux/i18n": "0.0.7",
     "@sap-ux/store": "0.6.0",
-    "@sap-ux/ui5-info": "0.5.0",
-    "@sap-ux/i18n": "0.0.7"
+    "@sap-ux/ui5-info": "0.5.0"
   },
   "peerDependencies": {
     "express": "4"