@sap-ux/preview-middleware 0.6.1 → 0.6.2

package/dist/client/flp/init.js

@@ -110,35 +110,40 @@ sap.ui.define(["sap/base/Log", "sap/ui/core/IconPool", "sap/base/i18n/ResourceBu
     //Registering to the icon pool
     IconPool.registerFont(fioriTheme);
     //SAP Business Suite Theme font family and URI
-    const bSuiteTheme = {
+    const suiteTheme = {
       fontFamily: 'BusinessSuiteInAppSymbols',
       fontURI: sap.ui.require.toUrl('sap/ushell/themes/base/fonts/')
     };
     //Registering to the icon pool
-    IconPool.registerFont(bSuiteTheme);
+    IconPool.registerFont(suiteTheme);
   }
 
   /**
    * Read the application title from the resource bundle and set it as document title.
+   *
+   * @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 locale = sap.ui.getCore().getConfiguration().getLanguage();
     const resourceBundle = ResourceBundle.create({
       url: 'i18n/i18n.properties',
       locale
     });
-    document.title = resourceBundle.getText('appTitle') ?? document.title;
+    if (resourceBundle.hasText(i18nKey)) {
+      document.title = resourceBundle.getText(i18nKey) ?? document.title;
+    }
   }
 
   /**
-   * Apply additional configuration.
+   * Apply additional configuration and initialize sandbox.
    *
    * @param params init parameters read from the script tag
    * @param params.appUrls JSON containing a string array of application urls
    * @param params.flex JSON containing the flex configuration
    * @returns promise
    */
-  function configure(_ref) {
+  async function init(_ref) {
     let {
       appUrls,
       flex
@@ -146,18 +151,18 @@ sap.ui.define(["sap/base/Log", "sap/ui/core/IconPool", "sap/base/i18n/ResourceBu
     // Register RTA if configured
     if (flex) {
       sap.ushell.Container.attachRendererCreatedEvent(async function () {
-        const serviceInstance = await sap.ushell.Container.getServiceAsync('AppLifeCycle');
-        serviceInstance.attachAppLoaded(event => {
-          const oView = event.getParameter('componentInstance');
-          const requiredLibs = ['sap/ui/rta/api/startAdaptation'];
+        const lifecycleService = await sap.ushell.Container.getServiceAsync('AppLifeCycle');
+        lifecycleService.attachAppLoaded(event => {
+          const view = event.getParameter('componentInstance');
+          const libs = ['sap/ui/rta/api/startAdaptation'];
           const flexSettings = JSON.parse(flex);
           if (flexSettings.pluginScript) {
-            requiredLibs.push(flexSettings.pluginScript);
+            libs.push(flexSettings.pluginScript);
             delete flexSettings.pluginScript;
           }
-          sap.ui.require(requiredLibs, function (startAdaptation, pluginScript) {
+          sap.ui.require(libs, function (startAdaptation, pluginScript) {
             const options = {
-              rootControl: oView,
+              rootControl: view,
               validateAppVersion: false,
               flexSettings
             };
@@ -169,26 +174,21 @@ sap.ui.define(["sap/base/Log", "sap/ui/core/IconPool", "sap/base/i18n/ResourceBu
 
     // Load custom library paths if configured
     if (appUrls) {
-      return registerComponentDependencyPaths(JSON.parse(appUrls));
-    } else {
-      return Promise.resolve();
+      await registerComponentDependencyPaths(JSON.parse(appUrls));
     }
-  }
 
-  /**
-   * Initialize the FLP sandbox.
-   */
-  function init() {
+    // init
     setI18nTitle();
     registerSAPFonts();
-    sap.ushell.Container.createRenderer().placeAt('content');
+    const renderer = await sap.ushell.Container.createRenderer(true);
+    renderer.placeAt('content');
   }
   const bootstrapConfig = document.getElementById('sap-ui-bootstrap');
   if (bootstrapConfig) {
-    configure({
+    init({
       appUrls: bootstrapConfig.getAttribute('data-open-ux-preview-libs-manifests'),
       flex: bootstrapConfig.getAttribute('data-open-ux-preview-flex-settings')
-    }).then(init).catch(() => Log.error('Sandbox initialization failed.'));
+    }).catch(() => Log.error('Sandbox initialization failed.'));
   }
   var __exports = {
     __esModule: true
@@ -196,7 +196,6 @@ sap.ui.define(["sap/base/Log", "sap/ui/core/IconPool", "sap/base/i18n/ResourceBu
   __exports.registerComponentDependencyPaths = registerComponentDependencyPaths;
   __exports.registerSAPFonts = registerSAPFonts;
   __exports.setI18nTitle = setI18nTitle;
-  __exports.configure = configure;
   __exports.init = init;
   return __exports;
 });

package/dist/client/flp/init.ts

@@ -150,50 +150,54 @@ export function registerSAPFonts() {
     //Registering to the icon pool
     IconPool.registerFont(fioriTheme);
     //SAP Business Suite Theme font family and URI
-    const bSuiteTheme = {
+    const suiteTheme = {
         fontFamily: 'BusinessSuiteInAppSymbols',
         fontURI: sap.ui.require.toUrl('sap/ushell/themes/base/fonts/')
     };
     //Registering to the icon pool
-    IconPool.registerFont(bSuiteTheme);
+    IconPool.registerFont(suiteTheme);
 }
 
 /**
  * Read the application title from the resource bundle and set it as document title.
+ *
+ * @param i18nKey optional parameter to define the i18n key to be used for the title.
  */
-export function setI18nTitle() {
+export function setI18nTitle(i18nKey = 'appTitle') {
     const locale = sap.ui.getCore().getConfiguration().getLanguage();
     const resourceBundle = ResourceBundle.create({
         url: 'i18n/i18n.properties',
         locale
     }) as ResourceBundle;
-    document.title = resourceBundle.getText('appTitle') ?? document.title;
+    if (resourceBundle.hasText(i18nKey)) {
+        document.title = resourceBundle.getText(i18nKey) ?? document.title;
+    }
 }
 
 /**
- * Apply additional configuration.
+ * Apply additional configuration and initialize sandbox.
  *
  * @param params init parameters read from the script tag
  * @param params.appUrls JSON containing a string array of application urls
  * @param params.flex JSON containing the flex configuration
  * @returns promise
  */
-export function configure({ appUrls, flex }: { appUrls?: string | null; flex?: string | null }): Promise<void> {
+export async function init({ appUrls, flex }: { appUrls?: string | null; flex?: string | null }): Promise<void> {
     // Register RTA if configured
     if (flex) {
         sap.ushell.Container.attachRendererCreatedEvent(async function () {
-            const serviceInstance = await sap.ushell.Container.getServiceAsync<AppLifeCycle>('AppLifeCycle');
-            serviceInstance.attachAppLoaded(event => {
-                const oView = event.getParameter('componentInstance');
-                const requiredLibs = ['sap/ui/rta/api/startAdaptation'];
+            const lifecycleService = await sap.ushell.Container.getServiceAsync<AppLifeCycle>('AppLifeCycle');
+            lifecycleService.attachAppLoaded(event => {
+                const view = event.getParameter('componentInstance');
+                const libs = ['sap/ui/rta/api/startAdaptation'];
                 const flexSettings = JSON.parse(flex);
                 if (flexSettings.pluginScript) {
-                    requiredLibs.push(flexSettings.pluginScript);
+                    libs.push(flexSettings.pluginScript);
                     delete flexSettings.pluginScript;
                 }
-                sap.ui.require(requiredLibs, function (startAdaptation: StartAdaptation, pluginScript?: RTAPlugin) {
+                sap.ui.require(libs, function (startAdaptation: StartAdaptation, pluginScript?: RTAPlugin) {
                     const options = {
-                        rootControl: oView,
+                        rootControl:view,
                         validateAppVersion: false,
                         flexSettings
                     };
@@ -205,27 +209,20 @@ export function configure({ appUrls, flex }: { appUrls?: string | null; flex?: s
 
     // Load custom library paths if configured
     if (appUrls) {
-        return registerComponentDependencyPaths(JSON.parse(appUrls));
-    } else {
-        return Promise.resolve();
+        await registerComponentDependencyPaths(JSON.parse(appUrls));
     }
-}
 
-/**
- * Initialize the FLP sandbox.
- */
-export function init() {
+    // init
     setI18nTitle();
     registerSAPFonts();
-    sap.ushell.Container.createRenderer().placeAt('content');
+    const renderer = await sap.ushell.Container.createRenderer(true);
+    renderer.placeAt('content');
 }
 
 const bootstrapConfig = document.getElementById('sap-ui-bootstrap');
 if (bootstrapConfig) {
-    configure({
+    init({
         appUrls: bootstrapConfig.getAttribute('data-open-ux-preview-libs-manifests'),
         flex: bootstrapConfig.getAttribute('data-open-ux-preview-flex-settings')
-    })
-        .then(init)
-        .catch(() => Log.error('Sandbox initialization failed.'));
+    }).catch(() => Log.error('Sandbox initialization failed.'));
 }

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.6.1",
+  "version": "0.6.2",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -36,7 +36,7 @@
     "express": "4.18.2",
     "nock": "13.2.1",
     "supertest": "6.3.3",
-    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.2.0",
+    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.2.1",
     "@sap-ux/project-access": "1.13.6",
     "@sap-ux/store": "0.3.14"
   },