@sap-ux/preview-middleware 0.16.26 → 0.16.28

package/dist/base/config.d.ts

@@ -101,9 +101,10 @@ export declare function addApp(templateConfig: TemplateConfig, manifest: Partial
  *
  * @param config FLP configuration
  * @param manifest application manifest
+ * @param resources additional resources
  * @returns configuration object for the sandbox.html template
  */
-export declare function createFlpTemplateConfig(config: FlpConfig, manifest: Partial<Manifest>): TemplateConfig;
+export declare function createFlpTemplateConfig(config: FlpConfig, manifest: Partial<Manifest>, resources?: Record<string, string>): TemplateConfig;
 /**
  * Creates the configuration object for the test template.
  *

package/dist/base/config.js

@@ -196,9 +196,10 @@ async function getI18nTextFromProperty(projectRoot, propertyValue, logger) {
  *
  * @param config FLP configuration
  * @param manifest application manifest
+ * @param resources additional resources
  * @returns configuration object for the sandbox.html template
  */
-function createFlpTemplateConfig(config, manifest) {
+function createFlpTemplateConfig(config, manifest, resources = {}) {
     const flex = getFlexSettings();
     const supportedThemes = manifest['sap.ui5']?.supportedThemes ?? [exports.DEFAULT_THEME];
     const ui5Theme = config.theme ?? (supportedThemes.includes(exports.DEFAULT_THEME) ? exports.DEFAULT_THEME : supportedThemes[0]);
@@ -213,6 +214,7 @@ function createFlpTemplateConfig(config, manifest) {
             theme: ui5Theme,
             flex,
             resources: {
+                ...resources,
                 [exports.PREVIEW_URL.client.ns]: exports.PREVIEW_URL.client.url
             },
             bootstrapOptions: ''

package/dist/base/flp.js

@@ -72,7 +72,7 @@ class FlpSandbox {
         this.createFlexHandler();
         this.config.libs ??= await this.hasLocateReuseLibsScript();
         const id = manifest['sap.app'].id;
-        this.templateConfig = (0, config_1.createFlpTemplateConfig)(this.config, manifest);
+        this.templateConfig = (0, config_1.createFlpTemplateConfig)(this.config, manifest, resources);
         await (0, config_1.addApp)(this.templateConfig, manifest, {
             componentId,
             target: resources[componentId ?? id] ?? this.templateConfig.basePath,

package/dist/client/adp/init.js

@@ -33,7 +33,7 @@ sap.ui.define([
     const getUI5VersionValidationMessage = ___ui5_version_utils['getUI5VersionValidationMessage'];
     const getError = ___cpe_error_utils['getError'];
     var __exports = async function (rta) {
-        const {version} = await VersionInfo.load();
+        const version = (await VersionInfo.load({ library: 'sap.ui.core' }))?.version;
         const versionParts = version.split('.');
         const minor = parseInt(versionParts[1], 10);
         const flexSettings = rta.getFlexSettings();

package/dist/client/adp/init.ts

@@ -14,9 +14,10 @@ import VersionInfo from 'sap/ui/VersionInfo';
 import { getUI5VersionValidationMessage } from './ui5-version-utils';
 import UI5Element from 'sap/ui/dt/Element';
 import { getError } from '../cpe/error-utils';
+import type {SingleVersionInfo} from '../../types/global';
 
 export default async function (rta: RuntimeAuthoring) {
-    const { version } = (await VersionInfo.load()) as { version: string };
+    const version = (await VersionInfo.load({library:'sap.ui.core'}) as SingleVersionInfo)?.version;
     const versionParts = version.split('.');
     const minor = parseInt(versionParts[1], 10);
     const flexSettings = rta.getFlexSettings();

package/dist/client/cpe/connector-service.js

@@ -20,7 +20,7 @@ sap.ui.define([
     const storageFileChanged = ___sap_ux_private_control_property_editor_common['storageFileChanged'];
     class WorkspaceConnectorService {
         async init(sendAction) {
-            const {version} = await VersionInfo.load();
+            const version = (await VersionInfo.load({ library: 'sap.ui.core' }))?.version;
             const versionParts = version.split('.');
             const minor = parseInt(versionParts[1], 10);
             if (minor > 72) {

package/dist/client/cpe/connector-service.ts

@@ -1,6 +1,7 @@
 import { ExternalAction, storageFileChanged } from '@sap-ux-private/control-property-editor-common';
 import { ActionSenderFunction } from './types';
 import VersionInfo from 'sap/ui/VersionInfo';
+import type {SingleVersionInfo} from '../../types/global';
 
 /**
  * A Class of WorkspaceConnectorService
@@ -12,7 +13,7 @@ export class WorkspaceConnectorService {
      * @param sendAction action sender function
      */
     public async init(sendAction: ActionSenderFunction): Promise<void> {
-        const { version } = (await VersionInfo.load()) as { version: string };
+        const version = (await VersionInfo.load({library:'sap.ui.core'}) as SingleVersionInfo)?.version;
         const versionParts = version.split('.');
         const minor = parseInt(versionParts[1], 10);
         if (minor > 72) {

package/dist/client/cpe/outline/nodes.js

@@ -75,9 +75,9 @@ sap.ui.define(["./utils", "sap/ui/VersionInfo"], function (___utils, VersionInfo
   async function transformNodes(input, scenario, reuseComponentsIds) {
     const stack = [...input];
     const items = [];
-    const {
-      version
-    } = await VersionInfo.load();
+    const version = (await VersionInfo.load({
+      library: 'sap.ui.core'
+    }))?.version;
     const versionParts = version.split('.');
     const minor = parseInt(versionParts[1], 10);
     while (stack.length) {

package/dist/client/cpe/outline/nodes.ts

@@ -3,6 +3,7 @@ import type { OutlineViewNode } from 'sap/ui/rta/command/OutlineService';
 import type { Scenario } from 'sap/ui/fl/Scenario';
 import { isEditable, isReuseComponent } from './utils';
 import VersionInfo from 'sap/ui/VersionInfo';
+import type {SingleVersionInfo} from '../../../types/global';
 
 interface AdditionalData {
     text?: string;
@@ -87,7 +88,7 @@ export async function transformNodes(
 ): Promise<OutlineNode[]> {
     const stack = [...input];
     const items: OutlineNode[] = [];
-    const { version } = (await VersionInfo.load()) as { version: string };
+    const version = (await VersionInfo.load({library:'sap.ui.core'}) as SingleVersionInfo)?.version;
     const versionParts = version.split('.');
     const minor = parseInt(versionParts[1], 10);
     while (stack.length) {

package/dist/client/flp/WorkspaceConnector.js

@@ -68,8 +68,10 @@ sap.ui.define(["sap/base/util/merge", "sap/ui/fl/write/api/connectors/ObjectStor
     },
     loadFeatures: async function () {
       const features = await ObjectStorageConnector.loadFeatures();
-      const ui5Version = await VersionInfo.load();
-      const [majorVersion, minorVersion] = ui5Version.version.split('.').map(v => parseInt(v, 10));
+      const version = (await VersionInfo.load({
+        library: 'sap.ui.core'
+      }))?.version;
+      const [majorVersion, minorVersion] = version.split('.').map(v => parseInt(v, 10));
       features.isVariantAdaptationEnabled = majorVersion >= 1 && minorVersion >= 90;
       const settings = getFlexSettings();
       if (settings?.developerMode) {

package/dist/client/flp/WorkspaceConnector.ts

@@ -2,6 +2,7 @@ import merge from 'sap/base/util/merge';
 import ObjectStorageConnector from 'sap/ui/fl/write/api/connectors/ObjectStorageConnector';
 import Layer from 'sap/ui/fl/Layer';
 import VersionInfo from 'sap/ui/VersionInfo';
+import type {SingleVersionInfo} from '../../types/global';
 import { CHANGES_API_PATH, FlexChange, getFlexSettings } from './common';
 
 const connector = merge({}, ObjectStorageConnector, {
@@ -69,8 +70,8 @@ const connector = merge({}, ObjectStorageConnector, {
     loadFeatures: async function () {
         const features = await ObjectStorageConnector.loadFeatures();
 
-        const ui5Version = (await VersionInfo.load()) as { version: string };
-        const [majorVersion, minorVersion] = ui5Version.version.split('.').map((v: string) => parseInt(v, 10));
+        const version = (await VersionInfo.load({library:'sap.ui.core'}) as SingleVersionInfo)?.version;
+        const [majorVersion, minorVersion] = version.split('.').map((v: string) => parseInt(v, 10));
         features.isVariantAdaptationEnabled = majorVersion >= 1 && minorVersion >= 90;
         const settings = getFlexSettings();
         if (settings?.developerMode) {

package/dist/client/flp/bootstrap.js

@@ -0,0 +1,38 @@
+/* eslint-disable @typescript-eslint/no-unsafe-assignment,
+                  @typescript-eslint/no-unsafe-member-access,
+                  @typescript-eslint/no-unsafe-assignment,
+                  @typescript-eslint/no-unsafe-argument,
+                  no-console */
+
+/**
+ * Calculates the script content for accessing the right sap/ushell/bootstrap sandbox.
+ * @param fnCallback {Function} The callback function to be executed after the bootstrap is loaded.
+ */
+async function ushellBootstrap(fnCallback) {
+    let src = '/test-resources/sap/ushell/bootstrap/sandbox.js';
+    try {
+        const response = await fetch('/resources/sap-ui-version.json');
+        const json = await response.json();
+        const version = json?.libraries?.find((lib) => lib.name === 'sap.ui.core')?.version;
+        const major = version ? parseInt(version.split('.')[0], 10) : 2;
+        if (major >= 2) {
+            src = '/resources/sap/ushell/bootstrap/sandbox2.js';
+        }
+    } catch (error) {
+        console.warn('Failed to fetch sap-ui-version.json. Assuming it is a 1.x version.');
+    }
+
+    // eslint-disable-next-line fiori-custom/sap-no-dom-access,fiori-custom/sap-browser-api-warning
+    const shellBootstrap = document.getElementById('sap-ushell-bootstrap');
+    if (shellBootstrap) {
+        shellBootstrap.onload = () => {
+            window['sap-ui-config']['xx-bootTask'](fnCallback);
+        };
+        shellBootstrap.setAttribute('src', src);
+    }
+}
+
+// eslint-disable-next-line fiori-custom/sap-no-global-define
+window['sap-ui-config'] = {
+    'xx-bootTask': ushellBootstrap
+};

package/dist/client/flp/init.js

@@ -4,11 +4,19 @@ sap.ui.define([
     '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) {
+    '../adp/api-handler',
+    'sap/ui/VersionInfo',
+    '../cpe/error-utils',
+    './initConnectors'
+], function (Log, ___sap_ux_private_control_property_editor_common, IconPool, ResourceBundle, ___adp_api_handler, VersionInfo, ___cpe_error_utils, __initConnectors) {
     'use strict';
+    function _interopRequireDefault(obj) {
+        return obj && obj.__esModule && typeof obj.default !== 'undefined' ? obj.default : obj;
+    }
     const SCENARIO = ___sap_ux_private_control_property_editor_common['SCENARIO'];
     const getManifestAppdescr = ___adp_api_handler['getManifestAppdescr'];
+    const getError = ___cpe_error_utils['getError'];
+    const initConnectors = _interopRequireDefault(__initConnectors);
     const UI5_LIBS = [
         'sap.apf',
         'sap.base',
@@ -151,13 +159,13 @@ sap.ui.define([
         const urlParams = new URLSearchParams(window.location.search);
         const container = sap?.ushell?.Container ?? sap.ui.require('sap/ushell/Container');
         let scenario = '';
+        const version = (await VersionInfo.load({ library: 'sap.ui.core' }))?.version;
         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);
@@ -189,13 +197,15 @@ sap.ui.define([
         if (appUrls) {
             await registerComponentDependencyPaths(JSON.parse(appUrls), urlParams);
         }
+        await initConnectors();
         if (customInit) {
             sap.ui.require([customInit]);
         }
         const resourceBundle = await loadI18nResourceBundle(scenario);
         setI18nTitle(resourceBundle);
         registerSAPFonts();
-        const renderer = await container.createRenderer(undefined, true);
+        const major = version ? parseInt(version.split('.')[0], 10) : 2;
+        const renderer = major < 2 ? await container.createRenderer(undefined, true) : await container.createRendererInternal(undefined, true);
         renderer.placeAt('content');
     }
     const bootstrapConfig = document.getElementById('sap-ui-bootstrap');
@@ -204,7 +214,10 @@ sap.ui.define([
             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.'));
+        }).catch(e => {
+            const error = getError(e);
+            Log.error('Sandbox initialization failed: ' + error.message);
+        });
     }
     var __exports = { __esModule: true };
     __exports.resetAppState = resetAppState;

package/dist/client/flp/init.ts

@@ -7,6 +7,10 @@ import IconPool from 'sap/ui/core/IconPool';
 import ResourceBundle from 'sap/base/i18n/ResourceBundle';
 import AppState from 'sap/ushell/services/AppState';
 import { getManifestAppdescr } from '../adp/api-handler';
+import VersionInfo from 'sap/ui/VersionInfo';
+import { getError } from '../cpe/error-utils';
+import initConnectors from './initConnectors';
+import type {SingleVersionInfo} from '../../types/global';
 
 /**
  * SAPUI5 delivered namespaces from https://ui5.sap.com/#/api/sap
@@ -264,8 +268,9 @@ export async function init({
     customInit?: string | null;
 }): Promise<void> {
     const urlParams = new URLSearchParams(window.location.search);
-    const container = sap?.ushell?.Container ?? (sap.ui.require('sap/ushell/Container') as typeof sap.ushell.Container);
+    const container = sap?.ushell?.Container ?? sap.ui.require('sap/ushell/Container');
     let scenario: string = '';
+    const version = (await VersionInfo.load({library:'sap.ui.core'}) as SingleVersionInfo)?.version;
     // Register RTA if configured
     if (flex) {
         const flexSettings = JSON.parse(flex) as FlexSettings;
@@ -273,7 +278,6 @@ export async function init({
         container.attachRendererCreatedEvent(async function () {
             const lifecycleService = await container.getServiceAsync<AppLifeCycle>('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) as FlexSettings;
@@ -317,6 +321,9 @@ export async function init({
         await registerComponentDependencyPaths(JSON.parse(appUrls), urlParams);
     }
 
+    // Load rta connector
+    await initConnectors();
+
     // Load custom initialization module
     if (customInit) {
         sap.ui.require([customInit]);
@@ -326,15 +333,22 @@ export async function init({
     const resourceBundle = await loadI18nResourceBundle(scenario as Scenario);
     setI18nTitle(resourceBundle);
     registerSAPFonts();
-    const renderer = await container.createRenderer(undefined, true);
+    const major = version ? parseInt(version.split('.')[0], 10) : 2;
+
+    const renderer =
+        major < 2
+            ? await container.createRenderer(undefined, true)
+            : await container.createRendererInternal(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.'));
+    }).catch((e) => {
+        const error = getError(e);
+        Log.error('Sandbox initialization failed: ' + error.message);
+    });
 }

package/dist/client/flp/initConnectors.js

@@ -1,6 +1,6 @@
 "use strict";
 
-sap.ui.define([], function () {
+sap.ui.define(["sap/ui/VersionInfo"], function (VersionInfo) {
   "use strict";
 
   /**
@@ -12,12 +12,15 @@ sap.ui.define([], function () {
    *
    * @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) {
+  async function initConnectors() {
+    const version = (await VersionInfo.load({
+      library: 'sap.ui.core'
+    }))?.version;
+    const versionArray = version ? version.split('.') : ['2', '99'];
+    const minor = parseInt(versionArray[1], 10);
+    const major = parseInt(versionArray[0], 10);
+    if (major === 1 && minor < 72) {
       sap.ui.require(['open/ux/preview/client/flp/enableFakeConnector'], function (enableFakeConnector) {
         enableFakeConnector();
       });
@@ -25,11 +28,6 @@ sap.ui.define([], function () {
       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;
+  return initConnectors;
 });
 //# sourceMappingURL=initConnectors.js.map

package/dist/client/flp/initConnectors.ts

@@ -1,3 +1,6 @@
+import VersionInfo from 'sap/ui/VersionInfo';
+import type {SingleVersionInfo} from '../../types/global';
+
 /**
  * Initializes UI5 connectors based on the current UI5 version.
  *
@@ -7,13 +10,14 @@
  *
  * @example
  * intiConnectors(); // Simply call the function without any arguments.
- * @returns {void}
  */
-export function initConnectors(): void {
-    const version = sap.ui.version;
-    const minor = parseInt(version.split('.')[1], 10);
+export default async function initConnectors(): Promise<void> {
+    const version = (await VersionInfo.load({library:'sap.ui.core'}) as SingleVersionInfo)?.version;
+    const versionArray = version ? version.split('.') : ['2', '99'];
+    const minor = parseInt(versionArray[1], 10);
+    const major = parseInt(versionArray[0], 10);
 
-    if (minor < 72) {
+    if (major === 1 && minor < 72) {
         sap.ui.require(['open/ux/preview/client/flp/enableFakeConnector'], function (enableFakeConnector: () => void) {
             enableFakeConnector();
         });
@@ -26,5 +30,3 @@ export function initConnectors(): void {
         );
     }
 }
-
-initConnectors();

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.26",
+  "version": "0.16.28",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -26,8 +26,8 @@
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
     "@sap-ux/logger": "0.6.0",
-    "@sap-ux/btp-utils": "0.15.0",
     "@sap-ux/adp-tooling": "0.12.18",
+    "@sap-ux/btp-utils": "0.15.0",
     "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.4.26",
     "@sap-ux/project-access": "1.25.7"
   },
@@ -45,7 +45,7 @@
     "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.4",
+    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.10.5",
     "@sap-ux/axios-extension": "1.16.1",
     "@sap-ux/store": "0.7.0",
     "@sap-ux/ui5-info": "0.7.0",

package/templates/flp/sandbox.html

@@ -40,7 +40,8 @@
         };
     </script>
 
-    <script src="<%- basePath %>/test-resources/sap/ushell/bootstrap/sandbox.js" id="sap-ushell-bootstrap"></script>
+    <script src="/preview/client/flp/bootstrap.js" id="preview-bootstrap"></script>
+    <script id="sap-ushell-bootstrap"></script>
     <!-- Bootstrap the UI5 core library. 'data-sap-ui-frameOptions="allow"'' is a NON-SECURE setting for test environments -->
     <script id="sap-ui-bootstrap"
         src="<%- basePath %>/resources/sap-ui-core.js"
@@ -61,10 +62,6 @@
         data-open-ux-preview-libs-manifests='<%- JSON.stringify(Object.values(apps).map(app => app.url)) %>'<% } %>>
     </script>
 
-    <script type="text/javascript">
-        (() => sap.ui.require(['open/ux/preview/client/flp/initConnectors']))()
-    </script>
-
 <% if (locals.flex && flex?.developerMode) { %>
         <!-- Hides Rta native toolbar  -->
     <style>