@sap/ux-ui5-tooling 1.20.4 → 1.22.0

package/dist/preview-middleware/dist/client/utils/version.ts

@@ -0,0 +1,138 @@
+import VersionInfo from 'sap/ui/VersionInfo';
+import Log from 'sap/base/Log';
+import { sendInfoCenterMessage } from './info-center-message';
+import { MessageBarType } from '@sap-ux-private/control-property-editor-common';
+
+type SingleVersionInfo =
+    | {
+          name: string;
+          version: string;
+      };
+
+export type Ui5VersionInfo = {
+    major: number;
+    minor: number;
+    patch?: number;
+    label?: string;
+    /**
+     * Indicates if the UI5 version is served from CDN.
+     */
+    isCdn?: boolean;
+};
+
+/**
+ * Default minimal supported UI5 version
+ */
+export const minVersionInfo = {
+    major: 1,
+    minor: 71
+} as Readonly<Ui5VersionInfo>;
+
+/**
+ * Check if the given version info is valid.
+ *
+ * @param versionInfo to check
+ * @throws Error if the version info is invalid
+ */
+function checkVersionInfo(versionInfo: Ui5VersionInfo): void {
+    if (Number.isNaN(versionInfo.major) || Number.isNaN(versionInfo.minor) || Number.isNaN(versionInfo.patch ?? 0)) {
+        void sendInfoCenterMessage({
+            title: { key: 'FLP_UI_VERSION_RETRIEVAL_FAILURE_TITLE' },
+            description: { key: 'FLP_UI_INVALID_UI5_VERSION_DESCRIPTION' },
+            type: MessageBarType.error
+        });
+        throw new Error('Invalid version info');
+    }
+}
+
+/**
+ * Retrieve the UI5 version.
+ * If no library is given, the version from 'sap.ui.core' will be retrieved.
+ * Note that the patch version of actual SAPUI5 version might differ from the lib that has been used for the version request (e.g. SAPUI5 1.96.38 contains sap.ui.core 1.96.36).
+ * For details see the patch info of the respective SAPUI5 version (e.g. https://ui5.sap.com/1.96.38/patchinfo.html).
+ *
+ * @param library - (optional) specific library name to get the version from, e.g. 'sap.m'
+ * @returns Ui5VersionInfo
+ */
+export async function getUi5Version(library: string = 'sap.ui.core'): Promise<Ui5VersionInfo> {
+    const versionInfo = await VersionInfo.load() as { name: string; libraries: SingleVersionInfo[] } | undefined;
+    let version = versionInfo?.libraries?.find((lib) => lib.name === library)?.version;
+    const isCdn = versionInfo?.name === 'SAPUI5 Distribution';
+    if (!version) {
+        Log.error('Could not get UI5 version of application. Using version: 1.130.9 as fallback.');
+        version = '1.130.9';
+        await sendInfoCenterMessage({
+            title: { key: 'FLP_UI_VERSION_RETRIEVAL_FAILURE_TITLE' },
+            description: { key: 'FLP_UI_VERSION_RETRIEVAL_FAILURE_DESCRIPTION', params: [version] },
+            type: MessageBarType.error
+        });
+    }
+    const [major, minor, patch] = version.split('.').map((versionPart) => Number.parseInt(versionPart, 10));
+    const label = version.split(/-(.*)/s)?.[1];
+
+    return {
+        major,
+        minor,
+        patch,
+        label,
+        isCdn
+    } satisfies Ui5VersionInfo;
+}
+
+/**
+ * Checks if the given version is lower than the required minimal version.
+ * Note that the patch version of actual SAPUI5 version might differ from the lib that has been used for the version request (e.g. SAPUI5 1.96.38 contains sap.ui.core 1.96.36).
+ * For details see the patch info of the respective SAPUI5 version (e.g. https://ui5.sap.com/1.96.38/patchinfo.html).
+ *
+ * @param ui5VersionInfo to check
+ * @param minUi5VersionInfo to check against (default is 1.71)
+ * @throws Error if the version info is invalid
+ * @returns boolean
+ */
+export function isLowerThanMinimalUi5Version(
+    ui5VersionInfo: Ui5VersionInfo,
+    minUi5VersionInfo: Ui5VersionInfo = minVersionInfo
+): boolean {
+    checkVersionInfo(ui5VersionInfo);
+    checkVersionInfo(minUi5VersionInfo);
+    return (
+        ui5VersionInfo.major < minUi5VersionInfo.major ||
+        (ui5VersionInfo.major === minUi5VersionInfo.major && ui5VersionInfo.minor < minUi5VersionInfo.minor) ||
+        (ui5VersionInfo.major === minUi5VersionInfo.major &&
+            ui5VersionInfo.minor === minUi5VersionInfo.minor &&
+            (ui5VersionInfo?.patch ?? 0) < (minUi5VersionInfo?.patch ?? 0))
+    );
+}
+
+/**
+ * Checks if the given version is equal to the specified version.
+ * Note that the patch version of actual SAPUI5 version might differ from the lib that has been used for the version request (e.g. SAPUI5 1.96.38 contains sap.ui.core 1.96.36).
+ * For details see the patch info of the respective SAPUI5 version (e.g. https://ui5.sap.com/1.96.38/patchinfo.html).
+ *
+ * @param ui5VersionInfo to check
+ * @param targetUi5VersionInfo to check against (default is 1.71)
+ * @throws Error if the version info is invalid
+ * @returns boolean
+ */
+export function isVersionEqualOrHasNewerPatch(
+    ui5VersionInfo: Ui5VersionInfo,
+    targetUi5VersionInfo: Ui5VersionInfo = minVersionInfo
+): boolean {
+    checkVersionInfo(ui5VersionInfo);
+    checkVersionInfo(targetUi5VersionInfo);
+    return (
+        ui5VersionInfo.major === targetUi5VersionInfo.major &&
+        ui5VersionInfo.minor === targetUi5VersionInfo.minor &&
+        (ui5VersionInfo?.patch ?? 0) >= (targetUi5VersionInfo?.patch ?? 0)
+    );
+}
+
+/**
+ * Returns the fully qualified UI5 version string - major and minor version concatenated.
+ *
+ * @param {Ui5VersionInfo} ui5VersionInfo - The ui5 version info object containing major and minor version.
+ * @returns {string} The fully qualified UI5 version string.
+ */
+export function getFullyQualifiedUi5Version(ui5VersionInfo: Ui5VersionInfo): string {
+    return `${ui5VersionInfo.major}.${ui5VersionInfo.minor}`;
+}

package/dist/preview-middleware/templates/flp/cdm.base.json

@@ -0,0 +1,47 @@
+{
+    "_version": "3.1.0",
+    "catalogs": {
+        "homeCatalog": {
+            "identification": {
+                "id": "homeCatalog",
+                "title": "Homepage Apps"
+            },
+            "payload": {
+                "viz": []
+            }
+        }
+    },
+    "site": {
+        "payload": {
+            "groupsOrder": []
+        }
+    },
+    "groups": {},
+    "visualizations": {},
+    "applications": {},
+    "pages": {
+        "SAP_BASIS_PG_UI_MYHOME": {
+            "identification": {
+                "id": "SAP_BASIS_PG_UI_MYHOME"
+            },
+            "payload": {
+                "layout": {
+                    "sectionOrder": [
+                        "homeAppsSection"
+                    ]
+                },
+                "sections": {
+                    "homeAppsSection": {
+                        "id": "homeAppsSection",
+                        "title": "Recently Added Apps",
+                        "default": true,
+                        "layout": {
+                            "vizOrder": []
+                        },
+                        "viz": {}
+                    }
+                }
+            }
+        }
+    }
+}

package/dist/preview-middleware/templates/flp/cdm.ejs

@@ -0,0 +1,72 @@
+<!DOCTYPE HTML>
+<html lang="en">
+<!-- Copyright (c) 2015 SAP AG, All Rights Reserved -->
+
+<head>
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Local FLP Sandbox</title>
+
+    <!-- Bootstrap the unified shell in sandbox mode for standalone usage.
+
+         The renderer is specified in the global Unified Shell configuration object "sap-ushell-config".
+
+         The fiori2 renderer will render the shell header allowing, for instance,
+         testing of additional application setting buttons.
+
+         The navigation target resolution service is configured in a way that the empty URL hash is
+         resolved to our own application.
+
+         This example uses relative path references for the SAPUI5 resources and test-resources;
+         it might be necessary to adapt them depending on the target runtime platform.
+         The sandbox platform is restricted to development or demo use cases and must NOT be used
+         for productive scenarios.
+    -->
+
+    <!-- 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"
+        data-sap-ui-libs="<%- ui5.libs %>"
+        data-sap-ui-async="true"
+        data-sap-ui-preload="async"
+        data-sap-ui-theme="<%- ui5.theme %>"
+        data-sap-ui-compatVersion="edge"
+        data-sap-ui-language="en"
+        data-sap-ui-bindingSyntax="complex"
+        data-sap-ui-flexibilityServices='<%- JSON.stringify(ui5.flex) %>'
+        data-sap-ui-resourceroots='<%- JSON.stringify(ui5.resources) %>'
+        data-sap-ui-frameOptions="allow"
+        data-sap-ui-xx-componentPreload="off"<%- ui5.bootstrapOptions %><% if (enableCardGenerator) { %>
+        data-open-ux-preview-enable-card-generator="<%- enableCardGenerator %>"
+        <% } %>
+        data-sap-ui-oninit="module:open/ux/preview/client/flp/init"<% if (locals.init) { %>
+        data-open-ux-preview-custom-init='<%- init %>'<% } if (locals.flexSettings) { %>
+        data-open-ux-preview-features='<%- JSON.stringify(features) %>'
+        data-open-ux-preview-flex-settings='<%- JSON.stringify(flexSettings) %>'<% } if (locals.locateReuseLibsScript) { %>
+        data-open-ux-preview-libs-manifests='<%- JSON.stringify(Object.values(apps).map(app => app.url)) %>'<% } %>
+        data-open-ux-preview-base-url='<%- baseUrl %>'
+        data-open-ux-preview-enhanced-homepage='true'>
+    </script>
+
+<% if (locals.flexSettings && flexSettings?.developerMode) { %>
+        <!-- Hides Rta native toolbar  -->
+    <style>
+        #shell-header, .sapUiRtaToolbar {
+            visibility: hidden;
+            height: 1px;
+        }
+        .sapUshellShellCanvas {
+            top: 0 !important;
+        }
+        .sapUiRtaMode .sapUiShellBackgroundImage.sapUiGlobalBackgroundImageForce.sapUshellShellBG {
+            background-color: transparent !important;
+        }
+    </style><% } %>
+</head>
+
+<!-- UI Content -->
+<body class="sapUiBody" id="content">
+</body>
+
+</html>

package/dist/preview-middleware/templates/flp/editor.ejs

@@ -0,0 +1,28 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <meta charset="utf-8" />
+        <meta name="viewport" content="width=device-width, initial-scale=1" />
+        <meta name="theme-color" content="#000000" />
+        <meta name="description" content="Web page for rendering SAP Fiori Tools Control Property Editor" />
+        <link rel="stylesheet" type="text/css" href="./editor/app.css" />
+        <title>Editing <%- appName %></title>
+    </head>
+    <body>
+        <noscript>You need to enable JavaScript to run this app.</noscript>
+        <div id="root" data-open-ux-preview-base-url="<%- baseUrl %>"></div>
+        <script type="module">
+            import { start } from './editor/app.js';
+            start({
+                previewUrl: '<%- previewUrl %>',
+                telemetry: <%- telemetry %>,
+                rootElementId: 'root',
+                scenario: '<%- scenario %>',
+                livereloadPort: <%- livereloadPort %>,
+                livereloadUrl: '<%- livereloadUrl %>',
+                features: <%- features %>
+            });
+        </script>
+    </body>
+    <!-- livereload disabled for editor </body>-->
+</html>

package/dist/preview-middleware/templates/flp/sandbox.ejs

@@ -0,0 +1,88 @@
+<!DOCTYPE HTML>
+<html lang="en">
+<!-- Copyright (c) 2015 SAP AG, All Rights Reserved -->
+
+<head>
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Local FLP Sandbox</title>
+
+    <!-- Bootstrap the unified shell in sandbox mode for standalone usage.
+
+         The renderer is specified in the global Unified Shell configuration object "sap-ushell-config".
+
+         The fiori2 renderer will render the shell header allowing, for instance,
+         testing of additional application setting buttons.
+
+         The navigation target resolution service is configured in a way that the empty URL hash is
+         resolved to our own application.
+
+         This example uses relative path references for the SAPUI5 resources and test-resources;
+         it might be necessary to adapt them depending on the target runtime platform.
+         The sandbox platform is restricted to development or demo use cases and must NOT be used
+         for productive scenarios.
+    -->
+    <script type="text/javascript">
+        window["sap-ushell-config"] = {
+            defaultRenderer: "fiori2",
+            renderers: {
+                fiori2: {
+                    componentData: {
+                        config: {
+                            search: "hidden",
+                            enableSearch: false
+                        }
+                    }
+                }
+            },
+            applications:  <%- JSON.stringify(apps) %>
+        };
+    </script>
+
+    <script src="<%- basePath %>/test-resources/sap/ushell/bootstrap/sandbox.js" 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"
+        data-sap-ui-libs="<%- ui5.libs %>"
+        data-sap-ui-async="true"
+        data-sap-ui-preload="async"
+        data-sap-ui-theme="<%- ui5.theme %>"
+        data-sap-ui-compatVersion="edge"
+        data-sap-ui-language="en"
+        data-sap-ui-bindingSyntax="complex"
+        data-sap-ui-flexibilityServices='<%- JSON.stringify(ui5.flex) %>'
+        data-sap-ui-resourceroots='<%- JSON.stringify(ui5.resources) %>'
+        data-sap-ui-frameOptions="allow"
+        data-sap-ui-xx-componentPreload="off"<%- ui5.bootstrapOptions %><% if (enableCardGenerator) { %>
+        data-open-ux-preview-enable-card-generator="<%- enableCardGenerator %>"
+        <% } %>
+        data-sap-ui-oninit="module:open/ux/preview/client/flp/init"<% if (locals.init) { %>
+        data-open-ux-preview-custom-init='<%- init %>'<% } if (locals.flexSettings) { %>
+        data-open-ux-preview-features='<%- JSON.stringify(features) %>'
+        data-open-ux-preview-flex-settings='<%- JSON.stringify(flexSettings) %>'<% } if (locals.locateReuseLibsScript) { %>
+        data-open-ux-preview-libs-manifests='<%- JSON.stringify(Object.values(apps).map(app => app.url)) %>'<% } %>
+        data-open-ux-preview-base-url='<%- baseUrl %>'>
+    </script>
+
+<% if (locals.flexSettings && flexSettings?.developerMode) { %>
+        <!-- Hides Rta native toolbar  -->
+    <style>
+        #shell-header, .sapUiRtaToolbar {
+            visibility: hidden;
+            height: 1px;
+        }
+        .sapUshellShellCanvas {
+            top: 0 !important;
+        }
+        .sapUiRtaMode .sapUiShellBackgroundImage.sapUiGlobalBackgroundImageForce.sapUshellShellBG {
+            background-color: transparent !important;
+        }
+    </style><% } %>
+</head>
+
+<!-- UI Content -->
+<body class="sapUiBody" id="content">
+</body>
+
+</html>

package/dist/preview-middleware/templates/flp/sandbox2.ejs

@@ -0,0 +1,86 @@
+<!DOCTYPE HTML>
+<html lang="en">
+<!-- Copyright (c) 2015 SAP AG, All Rights Reserved -->
+
+<head>
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Local FLP Sandbox</title>
+
+    <!-- Bootstrap the unified shell in sandbox mode for standalone usage.
+
+         The renderer is specified in the global Unified Shell configuration object "sap-ushell-config".
+
+         The fiori2 renderer will render the shell header allowing, for instance,
+         testing of additional application setting buttons.
+
+         The navigation target resolution service is configured in a way that the empty URL hash is
+         resolved to our own application.
+
+         This example uses relative path references for the SAPUI5 resources and test-resources;
+         it might be necessary to adapt them depending on the target runtime platform.
+         The sandbox platform is restricted to development or demo use cases and must NOT be used
+         for productive scenarios.
+    -->
+    <script type="text/javascript">
+        window["sap-ushell-config"] = {
+            defaultRenderer: "fiori2",
+            renderers: {
+                fiori2: {
+                    componentData: {
+                        config: {
+                            search: "hidden",
+                            enableSearch: false
+                        }
+                    }
+                }
+            },
+            applications:  <%- JSON.stringify(apps) %>
+        };
+    </script>
+
+    <script src="<%- basePath %>/resources/sap/ushell/bootstrap/sandbox2.js" 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"
+        data-sap-ui-libs="<%- ui5.libs %>"
+        data-sap-ui-async="true"
+        data-sap-ui-theme="<%- ui5.theme %>"
+        data-sap-ui-compat-version="edge"
+        data-sap-ui-language="en"
+        data-sap-ui-flexibility-services='<%- JSON.stringify(ui5.flex) %>'
+        data-sap-ui-resource-roots='<%- JSON.stringify(ui5.resources) %>'
+        data-sap-ui-frame-options="allow"
+        data-sap-ui-xx-component-preload="off"<%- ui5.bootstrapOptions %><% if (enableCardGenerator) { %>
+        data-open-ux-preview-enable-card-generator="<%- enableCardGenerator %>"
+        <% } %>
+        data-sap-ui-on-init="module:open/ux/preview/client/flp/init"<% if (locals.init) { %>
+        data-open-ux-preview-custom-init='<%- init %>'<% } if (locals.flexSettings) { %>
+        data-open-ux-preview-features='<%- JSON.stringify(features) %>'
+        data-open-ux-preview-flex-settings='<%- JSON.stringify(flexSettings) %>'<% } if (locals.locateReuseLibsScript) { %>
+        data-open-ux-preview-libs-manifests='<%- JSON.stringify(Object.values(apps).map(app => app.url)) %>'<% } %>
+        data-open-ux-preview-base-url='<%- baseUrl %>'>
+    </script>
+
+<% if (locals.flexSettings && flexSettings?.developerMode) { %>
+        <!-- Hides Rta native toolbar  -->
+    <style>
+        #shell-header, .sapUiRtaToolbar {
+            visibility: hidden;
+            height: 1px;
+        }
+        .sapUshellShellCanvas {
+            top: 0 !important;
+        }
+        .sapUiRtaMode .sapUiShellBackgroundImage.sapUiGlobalBackgroundImageForce.sapUshellShellBG {
+            background-color: transparent !important;
+        }
+    </style><% } %>
+</head>
+
+<!-- UI Content -->
+<body class="sapUiBody" id="content">
+</body>
+
+</html>

package/dist/preview-middleware/templates/test/qunit.ejs

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+	<title><%- framework %> tests</title>
+	<meta charset="utf-8">
+
+	<script
+		src="<%- basePath %>/resources/sap-ui-core.js"
+		data-sap-ui-theme='<%- theme %>'
+		data-sap-ui-resourceroots='{
+			"<%- id %>": "<%- basePath %>"
+		}'
+		data-sap-ui-animation="false"
+		data-sap-ui-compatVersion="edge"
+		data-sap-ui-async="true">
+	</script>
+
+	<script src="<%- initPath %>"></script>
+
+	<link rel="stylesheet" type="text/css" href="<%- basePath %>/resources/sap/ui/thirdparty/qunit-2.css">
+</head>
+<body>
+	<div id="qunit"></div>
+	<div id="qunit-fixture"></div>
+</body>
+</html>

package/dist/preview-middleware/templates/test/qunit.js

@@ -0,0 +1,29 @@
+sap.ui.loader.config({
+    shim: {
+        "sap/ui/qunit/qunit-junit": {
+            deps: ["sap/ui/thirdparty/qunit-2"]
+        },
+        "sap/ui/qunit/qunit-coverage": {
+            deps: ["sap/ui/thirdparty/qunit-2"]
+        },
+        "sap/ui/thirdparty/sinon-qunit": {
+            deps: ["sap/ui/thirdparty/qunit-2", "sap/ui/thirdparty/sinon"]
+        },
+        "sap/ui/qunit/sinon-qunit-bridge": {
+            deps: ["sap/ui/thirdparty/qunit-2", "sap/ui/thirdparty/sinon-4"]
+        }
+    }
+});
+
+window.QUnit = Object.assign({}, window.QUnit, { config: { autostart: false } });
+
+sap.ui.require([
+    "sap/ui/thirdparty/qunit-2",
+    "sap/ui/qunit/qunit-junit",
+    "sap/ui/qunit/qunit-coverage"
+], function (QUnit) {
+    'use strict';
+    sap.ui.require(<%- JSON.stringify(tests) %>, function() {
+        QUnit.start();
+    });
+});

package/dist/preview-middleware/templates/test/testsuite.qunit.ejs

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <title>QUnit TestSuite</title>
+    <script src="<%- basePath %>/resources/sap/ui/qunit/qunit-redirect.js"></script>
+    <script src="<%- initPath %>" data-sap-ui-testsuite></script>
+</head>
+<body>
+</body>
+</html>

package/dist/preview-middleware/templates/test/testsuite.qunit.js

@@ -0,0 +1,8 @@
+window.suite = function () {
+    const oSuite = new parent.jsUnitTestSuite();
+    var sContextPath = location.pathname.substring(0, location.pathname.lastIndexOf("/") + 1);
+<% for (const path of locals.testPaths) { %>
+    oSuite.addTestPage(sContextPath + "<%- path %>");
+<% } %>
+    return oSuite;
+}