@sap-ux/preview-middleware 1.1.2 → 1.2.0

package/dist/base/flp.js

@@ -13,7 +13,7 @@ import { isAppStudio, exposePort } from '@sap-ux/btp-utils';
 import { FeatureToggleAccess } from '@sap-ux/feature-toggle';
 import { deleteChange, readChanges, readLocalModulePaths, stripLocalModulesFromLrepResponse, writeChange } from './flex.js';
 import { generateImportList, mergeTestConfigDefaults } from './test.js';
-import { getFlpConfigWithDefaults, createFlpTemplateConfig, PREVIEW_URL, isFlexConnector, createTestTemplateConfig, addApp, getAppName, sanitizeRtaConfig, CARD_GENERATOR_DEFAULT, remapResourcesForPath } from './config.js';
+import { getFlpConfigWithDefaults, createFlpTemplateConfig, PREVIEW_URL, isFlexConnector, createTestTemplateConfig, addApp, getAppName, sanitizeRtaConfig, CARD_GENERATOR_DEFAULT, remapResourcesForPath, generateSandboxAppConfig, qualifiesForNewSandbox } from './config.js';
 import { generateCdm } from './cdm.js';
 import { readFileSync } from 'node:fs';
 import { getIntegrationCard } from './utils/cards.js';
@@ -89,7 +89,7 @@ export class FlpSandbox {
         this.createFlexHandler();
         this.flpConfig.libs ??= await this.hasLocateReuseLibsScript();
         const id = manifest['sap.app']?.id ?? '';
-        this.templateConfig = createFlpTemplateConfig(this.flpConfig, manifest, resources, adp !== undefined);
+        this.templateConfig = createFlpTemplateConfig(this.flpConfig, manifest, resources, adp !== undefined, this.projectType !== 'EDMXBackend', this.logger);
         this.adp = adp;
         this.manifest = manifest;
         await addApp(this.templateConfig, manifest, {
@@ -161,14 +161,15 @@ export class FlpSandbox {
      * Also deletes the ABAP connector in case of a CAP project.
      * Deletes all connectors if UI5 version is < 1.84 and served from npmjs.
      *
+     * @param config - the template config to mutate (must be a per-request clone, not the shared this.templateConfig)
      * @param ui5VersionMajor - the major version of UI5
      * @param ui5VersionMinor - the minor version of UI5
      * @param isCDN - whether the UI5 sources are served from CDN
      * @private
      */
-    checkDeleteConnectors(ui5VersionMajor, ui5VersionMinor, isCDN) {
+    checkDeleteConnectors(config, ui5VersionMajor, ui5VersionMinor, isCDN) {
         if (ui5VersionMajor === 1 && ui5VersionMinor < 84) {
-            this.templateConfig.ui5.flex = this.templateConfig.ui5?.flex?.filter((connector) => isFlexConnector(connector));
+            config.ui5.flex = config.ui5?.flex?.filter((connector) => isFlexConnector(connector));
             this.logger.debug(`The Fiori Tools local connector (WorkspaceConnector) is not being used because the current UI5 version does not support it.${isCDN ? 'The Fiori Tools fake connector (FakeLrepConnector) will be used instead.' : ''} `);
             if (!isCDN) {
                 this.logger.warn(`The preview with virtual endpoints does not support flex changes for the current UI5 version ${ui5VersionMajor}.${ui5VersionMinor} from npmjs. Consider using a proxy to load UI5 resources from the CDN (e.g., https://ui5.sap.com), or upgrade the UI5 version in the yaml configuration to at least 1.84.`);
@@ -177,14 +178,6 @@ export class FlpSandbox {
         else {
             this.logger.debug(`The Fiori Tools local connector (WorkspaceConnector) is being used.`);
         }
-        if (this.projectType === 'CAPJava' || this.projectType === 'CAPNodejs') {
-            this.templateConfig.ui5.flex = this.templateConfig.ui5?.flex?.filter((connector) => !isFlexConnector(connector) ||
-                (isFlexConnector(connector) && !connector.url?.startsWith('/sap/bc/lrep')));
-            this.logger.debug(`The ABAP connector is not being used because the current project type is '${this.projectType}'.`);
-        }
-        else {
-            this.logger.debug(`The ABAP connector is being used.`);
-        }
     }
     /**
      * Generates the FLP sandbox for an editor.
@@ -201,7 +194,6 @@ export class FlpSandbox {
         await this.setApplicationDependencies();
         this.templateConfig.baseUrl = req['ui5-patched-router']?.baseUrl ?? '';
         const ui5Version = await this.getUi5Version(req.protocol, req.headers.host, this.templateConfig.baseUrl);
-        this.checkDeleteConnectors(ui5Version.major, ui5Version.minor, ui5Version.isCdn);
         if (ui5Version.major === 1 && ui5Version.minor <= 71) {
             this.removeAsyncHintsRequests();
         }
@@ -209,6 +201,8 @@ export class FlpSandbox {
             this.removeFlexExtensionPointEnabled();
         }
         const config = structuredClone(this.templateConfig);
+        config.ui5.versionMajor = ui5Version.major;
+        this.checkDeleteConnectors(config, ui5Version.major, ui5Version.minor, ui5Version.isCdn);
         if (!config.ui5.libs.includes('sap.ui.rta')) {
             // sap.ui.rta needs to be added to the list of preload libs for variants management and adaptation projects
             config.ui5.libs += ',sap.ui.rta';
@@ -226,7 +220,7 @@ export class FlpSandbox {
         config.features = FeatureToggleAccess.getAllFeatureToggles();
         const appId = this.manifest['sap.app']?.id ?? '';
         remapResourcesForPath(config, editor.path, appId);
-        return render(this.getSandboxTemplate(ui5Version), config);
+        return render(await this.getSandboxTemplate(ui5Version), config);
     }
     /**
      * Sets application dependencies in the template configuration.
@@ -359,15 +353,56 @@ export class FlpSandbox {
             // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
             this.templateConfig.baseUrl = ('ui5-patched-router' in req && req['ui5-patched-router']?.baseUrl) || '';
             const ui5Version = await this.getUi5VersionFromRequest(req, this.templateConfig.baseUrl);
-            this.checkDeleteConnectors(ui5Version.major, ui5Version.minor, ui5Version.isCdn);
+            this.templateConfig.ui5.versionMajor = ui5Version.major;
+            this.checkDeleteConnectors(this.templateConfig, ui5Version.major, ui5Version.minor, ui5Version.isCdn);
             if (ui5Version.major === 1 && ui5Version.minor < 120) {
                 this.removeFlexExtensionPointEnabled();
             }
             //for consistency reasons, we also add the baseUrl to the HTML here, although it is only used in editor mode
-            const html = render(this.getSandboxTemplate(ui5Version), this.templateConfig);
+            const html = render(await this.getSandboxTemplate(ui5Version), this.templateConfig);
             this.sendResponse(res, 'text/html', 200, html);
         }
     }
+    /**
+     * Handler for GET requests to fioriSandboxAppConfig.json (Sandbox 2.0).
+     * Serves a virtual config, optionally merged with a user-provided file.
+     * If a real HTML file exists at the FLP path, no virtual config is served.
+     *
+     * @param req incoming request
+     * @param res server response
+     * @param next next middleware function
+     * @param configJsonPath project-relative path to fioriSandboxAppConfig.json
+     */
+    async sandboxAppConfigGetHandler(req, res, next, configJsonPath) {
+        const baseUrl = (this.templateConfig.baseUrl =
+            ('ui5-patched-router' in req && req['ui5-patched-router']?.baseUrl) || '');
+        const file = await this.project.byPath(`${baseUrl}${this.flpConfig.path}`);
+        if (file) {
+            this.logger.info(`HTML file returned at '${this.flpConfig.path}'. No virtual 'fioriSandboxAppConfig.json' will be served.`);
+            next();
+            return;
+        }
+        // If the legacy fioriSandboxConfig.json exists, sandbox 2 is disabled — no config to serve.
+        const legacyFile = await this.project.byPath(`${baseUrl}/appconfig/fioriSandboxConfig.json`);
+        if (legacyFile) {
+            next();
+            return;
+        }
+        // check for user-provided fioriSandboxAppConfig.json and merge if present
+        const userConfigFile = await this.project.byPath(`${baseUrl}${configJsonPath}`);
+        let config = generateSandboxAppConfig(this.templateConfig, this.flpConfig, this.adp !== undefined, this.projectType !== 'EDMXBackend', this.logger);
+        if (userConfigFile) {
+            const userConfig = JSON.parse(await userConfigFile.getString());
+            config = {
+                ...config,
+                ...userConfig,
+                // beforeFlpStart and afterFlpStart must always point to our hooks
+                beforeFlpStart: config.beforeFlpStart,
+                afterFlpStart: config.afterFlpStart
+            };
+        }
+        this.sendResponse(res, 'application/json', 200, JSON.stringify(config));
+    }
     /**
      * Add routes for html and scripts required for a local FLP.
      */
@@ -378,6 +413,35 @@ export class FlpSandbox {
         this.router.get(this.flpConfig.path, async (req, res, next) => {
             await this.flpGetHandler(req, res, next);
         });
+        // add routes for fioriSandboxAppConfig.json (Sandbox 2.0) — only when sandbox 2 is not explicitly disabled.
+        // The config must be served at the directory of every sandbox HTML endpoint,
+        // since each endpoint fetches fioriSandboxAppConfig.json relative to its own location.
+        if (this.flpConfig.useNewSandbox === true) {
+            const sandboxDirs = new Set();
+            sandboxDirs.add(dirname(this.flpConfig.path));
+            if (this.cardGenerator?.path) {
+                const cardGeneratorPath = this.cardGenerator.path.startsWith('/')
+                    ? this.cardGenerator.path
+                    : `/${this.cardGenerator.path}`;
+                sandboxDirs.add(dirname(cardGeneratorPath));
+            }
+            if (this.rta) {
+                for (const editor of this.rta.endpoints) {
+                    sandboxDirs.add(dirname(editor.path));
+                }
+            }
+            // Register one route per directory rather than passing an array to router.get()
+            // sandboxAppConfigGetHandler needs the concrete configJsonPath to look up the user-provided
+            // file via project.byPath(), and connect.IncomingMessage does not expose req.path,
+            // so we cannot derive the path from the request inside the handler.
+            for (const dir of sandboxDirs) {
+                const configJsonPath = `${dir}/fioriSandboxAppConfig.json`;
+                this.logger.debug(`Add route for ${configJsonPath}`);
+                this.router.get(configJsonPath, async (req, res, next) => {
+                    await this.sandboxAppConfigGetHandler(req, res, next, configJsonPath);
+                });
+            }
+        }
     }
     /**
      * Adds a middleware route for the Card Generator in the FLP sandbox.
@@ -463,6 +527,11 @@ export class FlpSandbox {
             this.flpConfig.enhancedHomePage = this.templateConfig.enhancedHomePage = false;
             this.logger.warn(`Feature enhancedHomePage disabled: UI5 version: ${version} not supported.`);
         }
+        // enhancedHomePage (CDM) is not supported with Sandbox 2 — fall back to sandbox 1
+        if (this.flpConfig.enhancedHomePage && qualifiesForNewSandbox({ major, minor, patch, label, isCdn })) {
+            this.flpConfig.useNewSandbox = false;
+            this.logger.warn(`New FLP Sandbox disabled: enhancedHomePage is not supported with Sandbox 2.`);
+        }
         return {
             major,
             minor,
@@ -473,13 +542,22 @@ export class FlpSandbox {
     }
     /**
      * Read the sandbox template file based on the given UI5 version.
+     * Also checks for a legacy 'appconfig/fioriSandboxConfig.json' and falls back to Sandbox 1 if found.
      *
      * @param ui5Version - the UI5 version
      * @returns the template for the sandbox HTML file
      */
-    getSandboxTemplate(ui5Version) {
+    async getSandboxTemplate(ui5Version) {
         this.logger.info(`Using sandbox template for UI5 version: ${ui5Version.major}.${ui5Version.minor}.${ui5Version.patch}${ui5Version.label ? `-${ui5Version.label}` : ''}.`);
-        const filePrefix = ui5Version.major > 1 || ui5Version.label?.includes('legacy-free') ? '2' : '';
+        const qualifies = qualifiesForNewSandbox(ui5Version);
+        const legacyConfigPresent = qualifies
+            ? await this.hasLegacySandboxConfig(ui5Version, this.templateConfig.baseUrl)
+            : false;
+        const useNewSandbox = qualifies && this.flpConfig.useNewSandbox === true && !legacyConfigPresent;
+        if (qualifies && !useNewSandbox && !this.flpConfig.enhancedHomePage) {
+            this.logger.info('New FLP Sandbox disabled in configuration.');
+        }
+        const filePrefix = useNewSandbox ? '2' : '';
         const template = this.flpConfig.enhancedHomePage ? 'cdm' : 'sandbox';
         return readFileSync(join(__dirname, `../../templates/flp/${template}${filePrefix}.ejs`), 'utf-8');
     }
@@ -495,6 +573,26 @@ export class FlpSandbox {
             }
         }
     }
+    /**
+     * Checks if a legacy 'appconfig/fioriSandboxConfig.json' file is present when using the new FLP Sandbox.
+     * If found, warns the user to migrate and returns true so the caller can fall back to the classic Sandbox
+     * for this request.
+     *
+     * @param ui5Version - the resolved UI5 version
+     * @param baseUrl - the base URL of the current request
+     * @returns true if the legacy file is present and sandbox 2 should be suppressed
+     * @private
+     */
+    async hasLegacySandboxConfig(ui5Version, baseUrl) {
+        if (qualifiesForNewSandbox(ui5Version) && this.flpConfig.useNewSandbox === true) {
+            const legacyFile = await this.project.byPath(`${baseUrl}/appconfig/fioriSandboxConfig.json`);
+            if (legacyFile) {
+                this.logger.warn(`Found legacy file at 'appconfig/fioriSandboxConfig.json'. Falling back to the classic Sandbox. Please migrate your application configuration first.`);
+                return true;
+            }
+        }
+        return false;
+    }
     /**
      * For UI5 versions below 1.120, flexExtensionPointEnabled must be removed from the application
      * dependencies manifest. Older UI5 versions cannot handle this property at bootstrap time.

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