@sap-ux/preview-middleware 0.16.1 → 0.16.2

package/dist/client/flp/init.js

@@ -1,267 +1,205 @@
-"use strict";
-
-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
-   */
-  const UI5_LIBS = ['sap.apf', 'sap.base', 'sap.chart', 'sap.collaboration', 'sap.f', 'sap.fe', 'sap.fileviewer', 'sap.gantt', 'sap.landvisz', 'sap.m', 'sap.ndc', 'sap.ovp', 'sap.rules', 'sap.suite', 'sap.tnt', 'sap.ui', 'sap.uiext', 'sap.ushell', 'sap.uxap', 'sap.viz', 'sap.webanalytics', 'sap.zen'];
-  /**
-   * Check whether a specific dependency is a custom library, and if yes, add it to the map.
-   *
-   * @param dependency dependency from the manifest
-   * @param customLibs map containing the required custom libraries
-   */
-  function addKeys(dependency, customLibs) {
-    Object.keys(dependency).forEach(function (key) {
-      // ignore libs or Components that start with SAPUI5 delivered namespaces
-      if (!UI5_LIBS.some(function (substring) {
-        return key === substring || key.startsWith(substring + '.');
-      })) {
-        customLibs[key] = true;
-      }
-    });
-  }
-
-  /**
-   * Fetch the manifest for all the given application urls and generate a string containing all required custom library ids.
-   *
-   * @param appUrls urls pointing to included applications
-   * @returns Promise of a comma separated list of all required libraries.
-   */
-  async function getManifestLibs(appUrls) {
-    const result = {};
-    const promises = [];
-    for (const url of appUrls) {
-      promises.push(fetch(`${url}/manifest.json`).then(async resp => {
-        const manifest = await resp.json();
-        if (manifest) {
-          if (manifest['sap.ui5']?.dependencies) {
-            if (manifest['sap.ui5'].dependencies.libs) {
-              addKeys(manifest['sap.ui5'].dependencies.libs, result);
+'use strict';
+sap.ui.define([
+    'sap/base/Log',
+    'open/ux/preview/client/thirdparty/@sap-ux-private/control-property-editor-common',
+    'sap/ui/core/IconPool',
+    'sap/base/i18n/ResourceBundle',
+    '../adp/api-handler'
+], function (Log, ___sap_ux_private_control_property_editor_common, IconPool, ResourceBundle, ___adp_api_handler) {
+    'use strict';
+    const SCENARIO = ___sap_ux_private_control_property_editor_common['SCENARIO'];
+    const getManifestAppdescr = ___adp_api_handler['getManifestAppdescr'];
+    const UI5_LIBS = [
+        'sap.apf',
+        'sap.base',
+        'sap.chart',
+        'sap.collaboration',
+        'sap.f',
+        'sap.fe',
+        'sap.fileviewer',
+        'sap.gantt',
+        'sap.landvisz',
+        'sap.m',
+        'sap.ndc',
+        'sap.ovp',
+        'sap.rules',
+        'sap.suite',
+        'sap.tnt',
+        'sap.ui',
+        'sap.uiext',
+        'sap.ushell',
+        'sap.uxap',
+        'sap.viz',
+        'sap.webanalytics',
+        'sap.zen'
+    ];
+    function addKeys(dependency, customLibs) {
+        Object.keys(dependency).forEach(function (key) {
+            if (!UI5_LIBS.some(function (substring) {
+                    return key === substring || key.startsWith(substring + '.');
+                })) {
+                customLibs[key] = true;
             }
-            if (manifest['sap.ui5'].dependencies.components) {
-              addKeys(manifest['sap.ui5'].dependencies.components, result);
-            }
-          }
-          if (manifest['sap.ui5']?.componentUsages) {
-            addKeys(manifest['sap.ui5'].componentUsages, result);
-          }
+        });
+    }
+    async function getManifestLibs(appUrls) {
+        const result = {};
+        const promises = [];
+        for (const url of appUrls) {
+            promises.push(fetch(`${ url }/manifest.json`).then(async resp => {
+                const manifest = await resp.json();
+                if (manifest) {
+                    if (manifest['sap.ui5']?.dependencies) {
+                        if (manifest['sap.ui5'].dependencies.libs) {
+                            addKeys(manifest['sap.ui5'].dependencies.libs, result);
+                        }
+                        if (manifest['sap.ui5'].dependencies.components) {
+                            addKeys(manifest['sap.ui5'].dependencies.components, result);
+                        }
+                    }
+                    if (manifest['sap.ui5']?.componentUsages) {
+                        addKeys(manifest['sap.ui5'].componentUsages, result);
+                    }
+                }
+            }));
         }
-      }));
+        return Promise.all(promises).then(() => Object.keys(result).join(','));
     }
-    return Promise.all(promises).then(() => Object.keys(result).join(','));
-  }
-
-  /**
-   * Register the custom libraries and their url with the UI5 loader.
-   *
-   * @param dataFromAppIndex data returned from the app index service
-   */
-  function registerModules(dataFromAppIndex) {
-    Object.keys(dataFromAppIndex).forEach(function (moduleDefinitionKey) {
-      const moduleDefinition = dataFromAppIndex[moduleDefinitionKey];
-      if (moduleDefinition && moduleDefinition.dependencies) {
-        moduleDefinition.dependencies.forEach(function (dependency) {
-          if (dependency.url && dependency.url.length > 0 && dependency.type === 'UI5LIB') {
-            Log.info('Registering Library ' + dependency.componentId + ' from server ' + dependency.url);
-            const compId = dependency.componentId.replace(/\./g, '/');
-            const config = {
-              paths: {}
-            };
-            config.paths[compId] = dependency.url;
-            sap.ui.loader.config(config);
-          }
+    function registerModules(dataFromAppIndex) {
+        Object.keys(dataFromAppIndex).forEach(function (moduleDefinitionKey) {
+            const moduleDefinition = dataFromAppIndex[moduleDefinitionKey];
+            if (moduleDefinition && moduleDefinition.dependencies) {
+                moduleDefinition.dependencies.forEach(function (dependency) {
+                    if (dependency.url && dependency.url.length > 0 && dependency.type === 'UI5LIB') {
+                        Log.info('Registering Library ' + dependency.componentId + ' from server ' + dependency.url);
+                        const compId = dependency.componentId.replace(/\./g, '/');
+                        const config = { paths: {} };
+                        config.paths[compId] = dependency.url;
+                        sap.ui.loader.config(config);
+                    }
+                });
+            }
         });
-      }
-    });
-  }
-
-  /**
-   * Fetch the app state from the given application urls, then reset the app state.
-   *
-   * @param container the UShell container
-   */
-  async function resetAppState(container) {
-    const appStateService = await container.getServiceAsync('AppState');
-    const urlParams = new URLSearchParams(window.location.hash);
-    const appStateValue = urlParams.get('sap-iapp-state') ?? urlParams.get('/?sap-iapp-state');
-    if (appStateValue) {
-      appStateService.deleteAppState(appStateValue);
     }
-  }
-
-  /**
-   * Fetch the manifest from the given application urls, then parse them for custom libs, and finally request their urls.
-   *
-   * @param appUrls application urls
-   * @param urlParams URLSearchParams object
-   * @returns returns a promise when the registration is completed.
-   */
-  async function registerComponentDependencyPaths(appUrls, urlParams) {
-    const libs = await getManifestLibs(appUrls);
-    if (libs && libs.length > 0) {
-      let url = '/sap/bc/ui2/app_index/ui5_app_info?id=' + libs;
-      const sapClient = urlParams.get('sap-client');
-      if (sapClient && sapClient.length === 3) {
-        url = url + '&sap-client=' + sapClient;
-      }
-      const response = await fetch(url);
-      try {
-        registerModules(await response.json());
-      } catch (error) {
-        Log.error(`Registering of reuse libs failed. Error:${error}`);
-      }
+    async function resetAppState(container) {
+        const appStateService = await container.getServiceAsync('AppState');
+        const urlParams = new URLSearchParams(window.location.hash);
+        const appStateValue = urlParams.get('sap-iapp-state') ?? urlParams.get('/?sap-iapp-state');
+        if (appStateValue) {
+            appStateService.deleteAppState(appStateValue);
+        }
     }
-  }
-
-  /**
-   * Register SAP fonts that are also registered in a productive Fiori launchpad.
-   */
-  function registerSAPFonts() {
-    //Fiori Theme font family and URI
-    const fioriTheme = {
-      fontFamily: 'SAP-icons-TNT',
-      fontURI: sap.ui.require.toUrl('sap/tnt/themes/base/fonts/')
-    };
-    //Registering to the icon pool
-    IconPool.registerFont(fioriTheme);
-    //SAP Business Suite Theme font family and URI
-    const suiteTheme = {
-      fontFamily: 'BusinessSuiteInAppSymbols',
-      fontURI: sap.ui.require.toUrl('sap/ushell/themes/base/fonts/')
-    };
-    //Registering to the icon pool
-    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
-      });
+    async function registerComponentDependencyPaths(appUrls, urlParams) {
+        const libs = await getManifestLibs(appUrls);
+        if (libs && libs.length > 0) {
+            let url = '/sap/bc/ui2/app_index/ui5_app_info?id=' + libs;
+            const sapClient = urlParams.get('sap-client');
+            if (sapClient && sapClient.length === 3) {
+                url = url + '&sap-client=' + sapClient;
+            }
+            const response = await fetch(url);
+            try {
+                registerModules(await response.json());
+            } catch (error) {
+                Log.error(`Registering of reuse libs failed. Error:${ error }`);
+            }
+        }
     }
-    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(resourceBundle) {
-    let i18nKey = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'appTitle';
-    if (resourceBundle.hasText(i18nKey)) {
-      document.title = resourceBundle.getText(i18nKey) ?? document.title;
+    function registerSAPFonts() {
+        const fioriTheme = {
+            fontFamily: 'SAP-icons-TNT',
+            fontURI: sap.ui.require.toUrl('sap/tnt/themes/base/fonts/')
+        };
+        IconPool.registerFont(fioriTheme);
+        const suiteTheme = {
+            fontFamily: 'BusinessSuiteInAppSymbols',
+            fontURI: sap.ui.require.toUrl('sap/ushell/themes/base/fonts/')
+        };
+        IconPool.registerFont(suiteTheme);
     }
-  }
-
-  /**
-   * 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
-   * @param params.customInit path to the custom init module to be called
-   * @returns promise
-   */
-  async function init(_ref) {
-    let {
-      appUrls,
-      flex,
-      customInit
-    } = _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 => {
-          const version = sap.ui.version;
-          const minor = parseInt(version.split('.')[1], 10);
-          const view = event.getParameter('componentInstance');
-          const flexSettings = JSON.parse(flex);
-          const pluginScript = flexSettings.pluginScript ?? '';
-          let libs = [];
-          if (minor > 71) {
-            libs.push('sap/ui/rta/api/startAdaptation');
-          } else {
-            libs.push('open/ux/preview/client/flp/initRta');
-          }
-          if (flexSettings.pluginScript) {
-            libs.push(pluginScript);
-            delete flexSettings.pluginScript;
-          }
-          const options = {
-            rootControl: view,
-            validateAppVersion: false,
-            flexSettings
-          };
-          sap.ui.require(libs, async function (startAdaptation, pluginScript) {
-            await startAdaptation(options, pluginScript);
-          });
-        });
-      });
+    async function loadI18nResourceBundle(scenario) {
+        if (scenario === SCENARIO.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' });
     }
-
-    // reset app state if requested
-    if (urlParams.get('fiori-tools-iapp-state')?.toLocaleLowerCase() !== 'true') {
-      await resetAppState(container);
+    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;
+        }
     }
-
-    // Load custom library paths if configured
-    if (appUrls) {
-      await registerComponentDependencyPaths(JSON.parse(appUrls), urlParams);
+    async function init(_ref) {
+        let {appUrls, flex, customInit} = _ref;
+        const urlParams = new URLSearchParams(window.location.search);
+        const container = sap?.ushell?.Container ?? sap.ui.require('sap/ushell/Container');
+        let scenario = '';
+        if (flex) {
+            const flexSettings = JSON.parse(flex);
+            scenario = flexSettings.scenario;
+            container.attachRendererCreatedEvent(async function () {
+                const lifecycleService = await container.getServiceAsync('AppLifeCycle');
+                lifecycleService.attachAppLoaded(event => {
+                    const version = sap.ui.version;
+                    const minor = parseInt(version.split('.')[1], 10);
+                    const view = event.getParameter('componentInstance');
+                    const flexSettings = JSON.parse(flex);
+                    const pluginScript = flexSettings.pluginScript ?? '';
+                    let libs = [];
+                    if (minor > 71) {
+                        libs.push('sap/ui/rta/api/startAdaptation');
+                    } else {
+                        libs.push('open/ux/preview/client/flp/initRta');
+                    }
+                    if (flexSettings.pluginScript) {
+                        libs.push(pluginScript);
+                        delete flexSettings.pluginScript;
+                    }
+                    const options = {
+                        rootControl: view,
+                        validateAppVersion: false,
+                        flexSettings
+                    };
+                    sap.ui.require(libs, async function (startAdaptation, pluginScript) {
+                        await startAdaptation(options, pluginScript);
+                    });
+                });
+            });
+        }
+        if (urlParams.get('fiori-tools-iapp-state')?.toLocaleLowerCase() !== 'true') {
+            await resetAppState(container);
+        }
+        if (appUrls) {
+            await registerComponentDependencyPaths(JSON.parse(appUrls), urlParams);
+        }
+        if (customInit) {
+            sap.ui.require([customInit]);
+        }
+        const resourceBundle = await loadI18nResourceBundle(scenario);
+        setI18nTitle(resourceBundle);
+        registerSAPFonts();
+        const renderer = await container.createRenderer(undefined, true);
+        renderer.placeAt('content');
     }
-
-    // Load custom initialization module
-    if (customInit) {
-      sap.ui.require([customInit]);
+    const bootstrapConfig = document.getElementById('sap-ui-bootstrap');
+    if (bootstrapConfig) {
+        init({
+            appUrls: bootstrapConfig.getAttribute('data-open-ux-preview-libs-manifests'),
+            flex: bootstrapConfig.getAttribute('data-open-ux-preview-flex-settings'),
+            customInit: bootstrapConfig.getAttribute('data-open-ux-preview-customInit')
+        }).catch(() => Log.error('Sandbox initialization failed.'));
     }
-
-    // init
-    const resourceBundle = await loadI18nResourceBundle(scenario);
-    setI18nTitle(resourceBundle);
-    registerSAPFonts();
-    const renderer = await container.createRenderer(undefined, true);
-    renderer.placeAt('content');
-  }
-  const bootstrapConfig = document.getElementById('sap-ui-bootstrap');
-  if (bootstrapConfig) {
-    init({
-      appUrls: bootstrapConfig.getAttribute('data-open-ux-preview-libs-manifests'),
-      flex: bootstrapConfig.getAttribute('data-open-ux-preview-flex-settings'),
-      customInit: bootstrapConfig.getAttribute('data-open-ux-preview-customInit')
-    }).catch(() => Log.error('Sandbox initialization failed.'));
-  }
-  var __exports = {
-    __esModule: true
-  };
-  __exports.resetAppState = resetAppState;
-  __exports.registerComponentDependencyPaths = registerComponentDependencyPaths;
-  __exports.registerSAPFonts = registerSAPFonts;
-  __exports.loadI18nResourceBundle = loadI18nResourceBundle;
-  __exports.setI18nTitle = setI18nTitle;
-  __exports.init = init;
-  return __exports;
-});
-//# sourceMappingURL=init.js.map
+    var __exports = { __esModule: true };
+    __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,7 +1,7 @@
 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 { SCENARIO, type Scenario } from '@sap-ux-private/control-property-editor-common';
 import type { FlexSettings, RTAOptions } from 'sap/ui/rta/RuntimeAuthoring';
 import IconPool from 'sap/ui/core/IconPool';
 import ResourceBundle from 'sap/base/i18n/ResourceBundle';
@@ -196,7 +196,7 @@ export function registerSAPFonts() {
  * @param scenario to be used for the resource bundle.
  */
 export async function loadI18nResourceBundle(scenario: Scenario): Promise<ResourceBundle> {
-    if (scenario === scenarios.AdaptationProject) {
+    if (scenario === SCENARIO.AdaptationProject) {
         const manifest = await getManifestAppdescr();
         const enhanceWith = (manifest.content as { texts: { i18n: string } }[])
             .filter((content) => content.texts?.i18n)

package/dist/client/thirdparty/@sap-ux-private/control-property-editor-common.js

@@ -8,7 +8,7 @@ sap.ui.define((function () { 'use strict';
 
 	(function (exports) {
 		Object.defineProperty(exports, "__esModule", { value: true });
-		exports.save = exports.redo = exports.undo = exports.appLoaded = exports.setSaveEnablement = exports.setUndoRedoEnablement = exports.setAppMode = exports.storageFileChanged = exports.reloadApplication = exports.showMessage = exports.changeStackModified = exports.propertyChangeFailed = exports.propertyChanged = exports.changeProperty = exports.outlineChanged = exports.deletePropertyChanges = exports.addExtensionPoint = exports.selectControl = exports.controlSelected = exports.iconsLoaded = exports.EXTERNAL_ACTION_PREFIX = exports.scenario = exports.CHECKBOX_EDITOR_TYPE = exports.DROPDOWN_EDITOR_TYPE = exports.INPUT_EDITOR_TYPE = exports.STRING_VALUE_TYPE = exports.FLOAT_VALUE_TYPE = exports.INTEGER_VALUE_TYPE = exports.BOOLEAN_VALUE_TYPE = void 0;
+		exports.save = exports.redo = exports.undo = exports.appLoaded = exports.setSaveEnablement = exports.setUndoRedoEnablement = exports.setAppMode = exports.storageFileChanged = exports.reloadApplication = exports.showMessage = exports.changeStackModified = exports.propertyChangeFailed = exports.propertyChanged = exports.changeProperty = exports.outlineChanged = exports.deletePropertyChanges = exports.addExtensionPoint = exports.selectControl = exports.controlSelected = exports.iconsLoaded = exports.EXTERNAL_ACTION_PREFIX = exports.SCENARIO = exports.CHECKBOX_EDITOR_TYPE = exports.DROPDOWN_EDITOR_TYPE = exports.INPUT_EDITOR_TYPE = exports.STRING_VALUE_TYPE = exports.FLOAT_VALUE_TYPE = exports.INTEGER_VALUE_TYPE = exports.BOOLEAN_VALUE_TYPE = void 0;
 		exports.BOOLEAN_VALUE_TYPE = 'boolean';
 		exports.INTEGER_VALUE_TYPE = 'integer';
 		exports.FLOAT_VALUE_TYPE = 'float';
@@ -16,7 +16,7 @@ sap.ui.define((function () { 'use strict';
 		exports.INPUT_EDITOR_TYPE = 'input';
 		exports.DROPDOWN_EDITOR_TYPE = 'dropdown';
 		exports.CHECKBOX_EDITOR_TYPE = 'checkbox';
-		exports.scenario = {
+		exports.SCENARIO = {
 		    AppVariant: 'APP_VARIANT',
 		    VersionedAppVariant: 'VERSIONED_APP_VARIANT',
 		    AdaptationProject: 'ADAPTATION_PROJECT',

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.16.1",
+  "version": "0.16.2",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -45,10 +45,10 @@
     "supertest": "6.3.3",
     "@sap-ux-private/playwright": "0.1.0",
     "dotenv": "16.3.1",
-    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.10.0",
+    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.10.1",
     "@sap-ux/axios-extension": "1.15.1",
-    "@sap-ux/store": "0.7.0",
     "@sap-ux/ui5-info": "0.6.0",
+    "@sap-ux/store": "0.7.0",
     "@sap-ux/i18n": "0.1.0"
   },
   "peerDependencies": {