@sap-ux/preview-middleware 0.12.11 → 0.12.12

package/dist/client/flp/init.js

@@ -1,214 +1,222 @@
-"use strict";
-
-sap.ui.define(["sap/base/Log", "sap/ui/core/IconPool", "sap/base/i18n/ResourceBundle", "sap/base/util/UriParameters"], function (Log, IconPool, ResourceBundle, UriParameters) {
-  "use strict";
-
-  /**
-   * 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.
-   */
-  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'] && 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'] && manifest['sap.ui5'].componentUsages) {
-            addKeys(manifest['sap.ui5'].componentUsages, result);
-          }
-        }
-      }));
-    }
-    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);
-          }
-        });
-      }
-    });
-  }
-
-  /**
-   * Fetch the manifest from the given application urls, then parse them for custom libs, and finally request their urls.
-   *
-   * @param appUrls application urls
-   * @returns returns a promise when the registration is completed.
-   */
-  async function registerComponentDependencyPaths(appUrls) {
-    const libs = await getManifestLibs(appUrls);
-    if (libs && libs.length > 0) {
-      let url = '/sap/bc/ui2/app_index/ui5_app_info?id=' + libs;
-      const sapClient = UriParameters.fromQuery(window.location.search).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}`);
-      }
-    }
-  }
-
-  /**
-   * 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);
-  }
-
-  /**
-   * 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
-    });
-    if (resourceBundle.hasText(i18nKey)) {
-      document.title = resourceBundle.getText(i18nKey) ?? document.title;
-    }
-  }
-
-  /**
-   * 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
-   */
-  async function init(_ref) {
-    let {
-      appUrls,
-      flex
-    } = _ref;
-    // Register RTA if configured
-    if (flex) {
-      sap.ushell.Container.attachRendererCreatedEvent(async function () {
-        const lifecycleService = await sap.ushell.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);
-          });
-        });
-      });
-    }
-
-    // Load custom library paths if configured
-    if (appUrls) {
-      await registerComponentDependencyPaths(JSON.parse(appUrls));
-    }
-
-    // init
-    setI18nTitle();
-    registerSAPFonts();
-    const renderer = await sap.ushell.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')
-    }).catch(() => Log.error('Sandbox initialization failed.'));
-  }
-  var __exports = {
-    __esModule: true
-  };
-  __exports.registerComponentDependencyPaths = registerComponentDependencyPaths;
-  __exports.registerSAPFonts = registerSAPFonts;
-  __exports.setI18nTitle = setI18nTitle;
-  __exports.init = init;
-  return __exports;
+"use strict";
+
+sap.ui.define(["sap/base/Log", "sap/ui/core/IconPool", "sap/base/i18n/ResourceBundle", "sap/base/util/UriParameters"], function (Log, IconPool, ResourceBundle, UriParameters) {
+  "use strict";
+
+  /**
+   * 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.
+   */
+  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'] && 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'] && manifest['sap.ui5'].componentUsages) {
+            addKeys(manifest['sap.ui5'].componentUsages, result);
+          }
+        }
+      }));
+    }
+    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);
+          }
+        });
+      }
+    });
+  }
+
+  /**
+   * Fetch the manifest from the given application urls, then parse them for custom libs, and finally request their urls.
+   *
+   * @param appUrls application urls
+   * @returns returns a promise when the registration is completed.
+   */
+  async function registerComponentDependencyPaths(appUrls) {
+    const libs = await getManifestLibs(appUrls);
+    if (libs && libs.length > 0) {
+      let url = '/sap/bc/ui2/app_index/ui5_app_info?id=' + libs;
+      const sapClient = UriParameters.fromQuery(window.location.search).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}`);
+      }
+    }
+  }
+
+  /**
+   * 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);
+  }
+
+  /**
+   * 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
+    });
+    if (resourceBundle.hasText(i18nKey)) {
+      document.title = resourceBundle.getText(i18nKey) ?? document.title;
+    }
+  }
+
+  /**
+   * 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;
+    // Register RTA if configured
+    if (flex) {
+      sap.ushell.Container.attachRendererCreatedEvent(async function () {
+        const lifecycleService = await sap.ushell.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);
+          });
+        });
+      });
+    }
+
+    // Load custom library paths if configured
+    if (appUrls) {
+      await registerComponentDependencyPaths(JSON.parse(appUrls));
+    }
+
+    // Load custom initialization module
+    if (customInit) {
+      sap.ui.require([customInit]);
+    }
+
+    // init
+    setI18nTitle();
+    registerSAPFonts();
+    const renderer = await sap.ushell.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.registerComponentDependencyPaths = registerComponentDependencyPaths;
+  __exports.registerSAPFonts = registerSAPFonts;
+  __exports.setI18nTitle = setI18nTitle;
+  __exports.init = init;
+  return __exports;
 });
 //# sourceMappingURL=init.js.map

package/dist/client/flp/init.ts

@@ -185,9 +185,18 @@ export function setI18nTitle(i18nKey = 'appTitle') {
  * @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
  */
-export async function init({ appUrls, flex }: { appUrls?: string | null; flex?: string | null }): Promise<void> {
+export async function init({
+    appUrls,
+    flex,
+    customInit
+}: {
+    appUrls?: string | null;
+    flex?: string | null;
+    customInit?: string | null;
+}): Promise<void> {
     // Register RTA if configured
     if (flex) {
         sap.ushell.Container.attachRendererCreatedEvent(async function () {
@@ -232,6 +241,11 @@ export async function init({ appUrls, flex }: { appUrls?: string | null; flex?:
         await registerComponentDependencyPaths(JSON.parse(appUrls));
     }
 
+    // Load custom initialization module
+    if (customInit) {
+        sap.ui.require([customInit]);
+    }
+
     // init
     setI18nTitle();
     registerSAPFonts();
@@ -243,6 +257,7 @@ 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')
+        flex: bootstrapConfig.getAttribute('data-open-ux-preview-flex-settings'),
+        customInit: bootstrapConfig.getAttribute('data-open-ux-preview-customInit')
     }).catch(() => Log.error('Sandbox initialization failed.'));
 }

package/dist/client/flp/initConnectors.js

@@ -1,35 +1,35 @@
-"use strict";
-
-sap.ui.define([], function () {
-  "use strict";
-
-  /**
-   * Initializes UI5 connectors based on the current UI5 version.
-   *
-   * For UI5 versions below 1.72, this function dynamically requires and executes a FakeLrepConnector.
-   * For UI5 versions 1.72 and above, it defines a local connector that reuses the WorkspaceConnector.
-   * This setup allows for flexibility in using different connectors based on the UI5 version.
-   *
-   * @example
-   * intiConnectors(); // Simply call the function without any arguments.
-   * @returns {void}
-   */
-  function initConnectors() {
-    const version = sap.ui.version;
-    const minor = parseInt(version.split('.')[1], 10);
-    if (minor < 72) {
-      sap.ui.require(['open/ux/preview/client/flp/enableFakeConnector'], function (enableFakeConnector) {
-        enableFakeConnector();
-      });
-    } else {
-      sap.ui.define('custom.connectors.WorkspaceConnector', ['open/ux/preview/client/flp/WorkspaceConnector'], connector => connector, true);
-    }
-  }
-  initConnectors();
-  var __exports = {
-    __esModule: true
-  };
-  __exports.initConnectors = initConnectors;
-  return __exports;
+"use strict";
+
+sap.ui.define([], function () {
+  "use strict";
+
+  /**
+   * Initializes UI5 connectors based on the current UI5 version.
+   *
+   * For UI5 versions below 1.72, this function dynamically requires and executes a FakeLrepConnector.
+   * For UI5 versions 1.72 and above, it defines a local connector that reuses the WorkspaceConnector.
+   * This setup allows for flexibility in using different connectors based on the UI5 version.
+   *
+   * @example
+   * intiConnectors(); // Simply call the function without any arguments.
+   * @returns {void}
+   */
+  function initConnectors() {
+    const version = sap.ui.version;
+    const minor = parseInt(version.split('.')[1], 10);
+    if (minor < 72) {
+      sap.ui.require(['open/ux/preview/client/flp/enableFakeConnector'], function (enableFakeConnector) {
+        enableFakeConnector();
+      });
+    } else {
+      sap.ui.define('custom.connectors.WorkspaceConnector', ['open/ux/preview/client/flp/WorkspaceConnector'], connector => connector, true);
+    }
+  }
+  initConnectors();
+  var __exports = {
+    __esModule: true
+  };
+  __exports.initConnectors = initConnectors;
+  return __exports;
 });
 //# sourceMappingURL=initConnectors.js.map