@sap-ux/preview-middleware 1.1.3 → 1.2.1

package/dist/client/flp/WorkspaceConnector.js

@@ -8,8 +8,10 @@ sap.ui.define(["sap/base/util/merge", "sap/ui/fl/write/api/connectors/ObjectStor
   const getUi5Version = ___utils_versionjs["getUi5Version"];
   const isLowerThanMinimalUi5Version = ___utils_versionjs["isLowerThanMinimalUi5Version"];
   const getAdditionalChangeInfo = ___utils_additional_change_infojs["getAdditionalChangeInfo"];
-  const baseUrl = document.getElementById('sap-ui-bootstrap')?.dataset.openUxPreviewBaseUrl ?? '';
-  const changesApiPath = `${baseUrl}${CHANGES_API_PATH_STATIC}`;
+  const getChangesApiPath = () => {
+    const baseUrl = document.getElementById('sap-ui-bootstrap')?.dataset.openUxPreviewBaseUrl ?? '';
+    return `${baseUrl}${CHANGES_API_PATH_STATIC}`;
+  };
   const connector = merge({}, ObjectStorageConnector, {
     layers: [Layer.VENDOR, Layer.CUSTOMER_BASE],
     storage: {
@@ -33,7 +35,7 @@ sap.ui.define(["sap/base/util/merge", "sap/ui/fl/write/api/connectors/ObjectStor
           change,
           additionalChangeInfo
         };
-        return fetch(changesApiPath, {
+        return fetch(getChangesApiPath(), {
           method: 'POST',
           body: JSON.stringify(body, null, 2),
           headers: {
@@ -49,7 +51,7 @@ sap.ui.define(["sap/base/util/merge", "sap/ui/fl/write/api/connectors/ObjectStor
             // exceptions in the listener call are ignored
           }
         }
-        return fetch(changesApiPath, {
+        return fetch(getChangesApiPath(), {
           method: 'DELETE',
           body: JSON.stringify({
             fileName: key
@@ -66,7 +68,7 @@ sap.ui.define(["sap/base/util/merge", "sap/ui/fl/write/api/connectors/ObjectStor
         // not implemented
       },
       getItems: async function () {
-        const response = await fetch(changesApiPath, {
+        const response = await fetch(getChangesApiPath(), {
           method: 'GET',
           headers: {
             'content-type': 'application/json'

package/dist/client/flp/WorkspaceConnector.ts

@@ -6,8 +6,10 @@ import { CHANGES_API_PATH as CHANGES_API_PATH_STATIC, getFlexSettings } from './
 import { getUi5Version, isLowerThanMinimalUi5Version } from '../utils/version.js';
 import { getAdditionalChangeInfo } from '../utils/additional-change-info.js';
 
-const baseUrl = document.getElementById('sap-ui-bootstrap')?.dataset.openUxPreviewBaseUrl ?? '';
-const changesApiPath = `${baseUrl}${CHANGES_API_PATH_STATIC}`;
+const getChangesApiPath = (): string => {
+    const baseUrl = document.getElementById('sap-ui-bootstrap')?.dataset.openUxPreviewBaseUrl ?? '';
+    return `${baseUrl}${CHANGES_API_PATH_STATIC}`;
+};
 
 const connector = merge({}, ObjectStorageConnector, {
     layers: [Layer.VENDOR, Layer.CUSTOMER_BASE],
@@ -36,7 +38,7 @@ const connector = merge({}, ObjectStorageConnector, {
                 additionalChangeInfo
             };
 
-            return fetch(changesApiPath, {
+            return fetch(getChangesApiPath(), {
                 method: 'POST',
                 body: JSON.stringify(body, null, 2),
                 headers: {
@@ -53,7 +55,7 @@ const connector = merge({}, ObjectStorageConnector, {
                 }
             }
 
-            return fetch(changesApiPath, {
+            return fetch(getChangesApiPath(), {
                 method: 'DELETE',
                 body: JSON.stringify({ fileName: key }),
                 headers: {
@@ -68,7 +70,7 @@ const connector = merge({}, ObjectStorageConnector, {
             // not implemented
         },
         getItems: async function (): Promise<FlexChange[]> {
-            const response = await fetch(changesApiPath, {
+            const response = await fetch(getChangesApiPath(), {
                 method: 'GET',
                 headers: {
                     'content-type': 'application/json'

package/dist/client/flp/common.js

@@ -1,10 +1,157 @@
 "use strict";
 
-sap.ui.define([], function () {
+sap.ui.define(["sap/base/Log", "open/ux/preview/client/thirdparty/@sap-ux-private/control-property-editor-common", "../utils/error", "../utils/version", "../utils/info-center-message"], function (Log, ___sap_ux_private_control_property_editor_common, ___utils_errorjs, ___utils_versionjs, ___utils_info_center_messagejs) {
   "use strict";
 
+  const MessageBarType = ___sap_ux_private_control_property_editor_common["MessageBarType"];
+  const getError = ___utils_errorjs["getError"];
+  const isLowerThanMinimalUi5Version = ___utils_versionjs["isLowerThanMinimalUi5Version"];
+  const sendInfoCenterMessage = ___utils_info_center_messagejs["sendInfoCenterMessage"];
+  const CONTROLLER_EXTENSION_PATH_REGEX = /\/changes\/coding\/.+\.(js|ts)/;
+
+  /**
+   * Extracts an Error object from a global error event.
+   * Handles both synchronous errors (ErrorEvent) and unhandled promise rejections (PromiseRejectionEvent).
+   *
+   * @param {GlobalErrorEvent} event - The global error or unhandled rejection event.
+   * @returns {Error | undefined} The extracted Error instance, or undefined if no Error could be extracted.
+   */
+  function extractError(event) {
+    if ('error' in event && event.error instanceof Error) {
+      return event.error;
+    }
+    if ('reason' in event && event.reason instanceof Error) {
+      return event.reason;
+    }
+    return undefined;
+  }
+
+  /**
+   * Reports controller extension errors to the Info Center.
+   * Filters events by checking if the stack trace contains 'ControllerExtension',
+   * and sends matching errors as error-level messages to the Info Center panel.
+   *
+   * @param {GlobalErrorEvent} event - The global error or unhandled rejection event.
+   */
+  const reportControllerExtensionErrorToInfoCenter = event => {
+    const error = extractError(event);
+    const stackTrace = error?.stack ?? '';
+    if (!CONTROLLER_EXTENSION_PATH_REGEX.test(stackTrace)) {
+      return;
+    }
+    void sendInfoCenterMessage({
+      title: {
+        key: 'CONTROLLER_EXTENSION_UNHANDLED_ERROR_TITLE'
+      },
+      description: error?.message ?? '',
+      type: MessageBarType.error,
+      details: stackTrace
+    });
+  };
+
+  /**
+   * Registers global event listeners for uncaught errors and unhandled promise rejections
+   * to detect and report controller extension errors to the Info Center.
+   */
+  function registerForControllerExtensionErrors() {
+    globalThis.addEventListener('error', reportControllerExtensionErrorToInfoCenter);
+    globalThis.addEventListener('unhandledrejection', reportControllerExtensionErrorToInfoCenter);
+  }
   const CHANGES_API_PATH = '/preview/api/changes';
 
+  /**
+   * 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) {
+      if (!UI5_LIBS.some(function (substring) {
+        return key === substring || key.startsWith(substring + '.');
+      })) {
+        customLibs[key] = true;
+      }
+    });
+  }
+
+  /**
+   * Check whether a specific ComponentUsage is a custom component, and if yes, add it to the map.
+   *
+   * @param compUsages ComponentUsage from the manifest
+   * @param customLibs map containing the required custom libraries
+   */
+  function getComponentUsageNames(compUsages, customLibs) {
+    const compNames = Object.keys(compUsages).map(function (compUsageKey) {
+      return compUsages[compUsageKey].name;
+    });
+    compNames.forEach(function (key) {
+      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);
+            }
+            if (manifest['sap.ui5'].dependencies.components) {
+              addKeys(manifest['sap.ui5'].dependencies.components, result);
+            }
+          }
+          if (manifest['sap.ui5']?.componentUsages) {
+            getComponentUsageNames(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?.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.replaceAll('.', '/');
+            const config = {
+              paths: {}
+            };
+            config.paths[compId] = dependency.url;
+            sap.ui.loader.config(config);
+          }
+        });
+      }
+    });
+  }
+
   /**
    * Retrieves Flex settings from a 'sap-ui-bootstrap' element's data attribute.
    * Parses the 'data-open-ux-preview-flex-settings' attribute as JSON.
@@ -20,11 +167,156 @@ sap.ui.define([], function () {
     }
     return result;
   }
+
+  /**
+   * Fetch the app state from the given application urls, then reset the app state.
+   *
+   * @param container the UShell container
+   */
+  async function resetAppState(container) {
+    const urlParams = new URLSearchParams(globalThis.location.hash);
+    const appStateValue = urlParams.get('sap-iapp-state') ?? urlParams.get('/?sap-iapp-state');
+    if (appStateValue) {
+      const appStateService = await container.getServiceAsync('AppState');
+      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=' + encodeURIComponent(libs);
+      const sapClient = urlParams.get('sap-client');
+      if (sapClient?.length === 3 && /^\d+$/.test(sapClient)) {
+        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}`);
+      }
+    }
+  }
+
+  /**
+   * Handle higher layer changes when starting UI Adaptation.
+   * When RTA detects higher layer changes an error with Reload triggered text is thrown, the RTA instance is destroyed and the application is reloaded.
+   * For UI5 version lower than 1.84.0 RTA is showing a popup with notification text about the detection of higher layer changes.
+   *
+   * @param error the error thrown when there are higher layer changes when starting UI Adaptation.
+   * @param ui5VersionInfo ui5 version info
+   */
+  async function handleHigherLayerChanges(error, ui5VersionInfo) {
+    const err = getError(error);
+    if (err.message.includes('Reload triggered')) {
+      if (!isLowerThanMinimalUi5Version(ui5VersionInfo, {
+        major: 1,
+        minor: 84
+      })) {
+        await sendInfoCenterMessage({
+          title: {
+            key: 'HIGHER_LAYER_CHANGES_TITLE'
+          },
+          description: {
+            key: 'HIGHER_LAYER_CHANGES_INFO_MESSAGE'
+          },
+          type: MessageBarType.warning
+        });
+      }
+      globalThis.location.reload();
+    }
+  }
+
+  /**
+   * Starts UI adaptation (RTA) for the given component instance.
+   * Contains the inner logic shared between sandbox 1 (sandbox1Init.ts) and sandbox 2 (sandbox2AfterInit.ts).
+   *
+   * @param view - the component instance returned by AppLifeCycle attachAppLoaded
+   * @param flexSettings - the parsed flex settings
+   * @param ui5VersionInfo - current UI5 version
+   */
+  function startRtaForAppInstance(view, flexSettings, ui5VersionInfo) {
+    const {
+      pluginScript,
+      ...flexSettingsWithoutPlugin
+    } = flexSettings;
+    const libs = [];
+    if (isLowerThanMinimalUi5Version(ui5VersionInfo, {
+      major: 1,
+      minor: 72
+    })) {
+      libs.push('open/ux/preview/client/flp/initRta');
+    } else {
+      libs.push('sap/ui/rta/api/startAdaptation');
+    }
+    if (pluginScript) {
+      libs.push(pluginScript);
+    }
+    const options = {
+      rootControl: view,
+      validateAppVersion: false,
+      flexSettings: flexSettingsWithoutPlugin
+    };
+    sap.ui.require(libs, async function (startAdaptation, pluginScript) {
+      try {
+        await startAdaptation(options, pluginScript);
+      } catch (error) {
+        await sendInfoCenterMessage({
+          title: {
+            key: 'FLP_ADAPTATION_START_FAILED_TITLE'
+          },
+          description: getError(error).message,
+          type: MessageBarType.error
+        });
+        await handleHigherLayerChanges(error, ui5VersionInfo);
+      }
+    });
+  }
+
+  /**
+   * Dynamically adds a "Generate Card" action to the SAP Fiori Launchpad for the given component instance.
+   *
+   * @param componentInstance - The component instance for which the card generation action is added.
+   * @param container - The SAP Fiori Launchpad container used to access services.
+   */
+  function addCardGenerationUserAction(componentInstance, container) {
+    sap.ui.require(['sap/cards/ap/generator/CardGenerator'], async CardGenerator => {
+      const extensionService = await container.getServiceAsync('Extension');
+      const controlProperties = {
+        icon: 'sap-icon://add',
+        id: 'generate_card',
+        text: 'Generate Card',
+        tooltip: 'Generate Card',
+        press: () => {
+          CardGenerator.initializeAsync(componentInstance);
+        }
+      };
+      const parameters = {
+        controlType: 'sap.ushell.ui.launchpad.ActionItem'
+      };
+      const generateCardAction = await extensionService.createUserAction(controlProperties, parameters);
+      generateCardAction.showForCurrentApp();
+    });
+  }
   var __exports = {
     __esModule: true
   };
+  __exports.registerForControllerExtensionErrors = registerForControllerExtensionErrors;
   __exports.CHANGES_API_PATH = CHANGES_API_PATH;
   __exports.getFlexSettings = getFlexSettings;
+  __exports.resetAppState = resetAppState;
+  __exports.registerComponentDependencyPaths = registerComponentDependencyPaths;
+  __exports.handleHigherLayerChanges = handleHigherLayerChanges;
+  __exports.startRtaForAppInstance = startRtaForAppInstance;
+  __exports.addCardGenerationUserAction = addCardGenerationUserAction;
   return __exports;
 });
 //# sourceMappingURL=common.js.map