@openui5/sap.ui.documentation 1.138.0 → 1.139.0

package/src/sap/ui/documentation/sdk/index.js

@@ -22,9 +22,9 @@
         if (!bIsStandAlone) {
             window.parent.postMessage(data, getUrlParam('sap-ui-xx-dk-origin'));
         }
-    };
+    },
 
-    const loadComponentModule = function(sCompName) {
+    loadComponentModule = function(sCompName) {
         return new Promise((resolve) => {
             const componentModule =
                 `${sCompName.replace(/\./g, "/")}/Component`;
@@ -94,8 +94,10 @@
                 ]).then(async function(){
 
                     Log.info("Samples paths added successfully");
-                    var sCompId = 'sampleComp-' + sSampleId;
-                    var sCompName = sSampleId;
+                    var sInnerCompId = 'sampleComp-' + sSampleId,
+                        sInnerCompName = sSampleId,
+                        oOuterComponent,
+                        oOuterContainer;
 
                     sap.ui.require([
                         "sap/ui/fl/Utils",
@@ -120,17 +122,29 @@
                     });
 
                     // preprocessing: load Component.js before the factory call to prevent 404s to the "Component-preload.js" (does not exist in demokit samples)
-                    await loadComponentModule(sCompName);
+                    await loadComponentModule(sInnerCompName);
 
                     Component.create({
-                        id: sCompId,
-                        name: sCompName
-                    }).then(function (oComponent) {
-                        var oConfig = oComponent.getManifestEntry("/sap.ui5/config");
+                        id: "wrapperComp",
+                        name: "sap.ui.documentation.sdk.samples",
+                        settings: {
+                            innerComponentName: sInnerCompName,
+                            innerComponentId: sInnerCompId
+                        }
+                    }).then(function (oWrapperComponent) {
+
+                        oOuterComponent = oWrapperComponent;
 
-                        var oContainer = new ComponentContainer({component : oComponent, height: "100%"})
+                        oOuterContainer = new ComponentContainer({component : oOuterComponent, height: "100%"})
                                 .placeAt("content");
 
+                        return oOuterComponent.createInnerComponent();
+                    }).then(function(oInnerComponent) {
+
+                        oOuterContainer.invalidate(); // required to ensure that the inner component is rendered
+
+                        var oConfig = oInnerComponent.getManifestEntry("/sap.ui5/config");
+
                         var bOpenStandalone = window.location.search.includes("dk-sample-standalone");
                         // if dk-sample-standalone is used,
                         // display message for samples with own index.html
@@ -139,7 +153,7 @@
                                 "sap/m/IllustratedMessage",
                                 "sap/m/IllustratedMessageType"
                             ], function (IllustratedMessage, IllustratedMessageType) {
-                                oContainer.destroy();
+                                oOuterContainer.destroy();
                                 new IllustratedMessage({
                                     title: "Sample unsupported",
                                     description: "Samples with own index.html are currently unsupported by dk-sample-standalone.",
@@ -148,7 +162,6 @@
                             });
                         }
                         var oMessage = {};
-                        var objRta = null;
                         oMessage.type = "INIT";
                         oMessage.data = {
                             "msg": "fired after component container is placed in DOM"
@@ -158,7 +171,7 @@
                         postMessageToOrigin(oMessage);
                         window.addEventListener("message", function(eMessage){
                             if (eMessage.data.type === "EXIT") {
-                                oComponent.destroy();
+                                oOuterComponent.destroy();
                             } else if (eMessage.data.type === "RTA") {
                                 enableRta();
                             } else if (eMessage.data.type === "SETTINGS") {
@@ -180,32 +193,13 @@
                         });
 
                         function enableRta() {
-                            if (objRta) {
-                                objRta.stop();
-                                objRta = null;
-                                return;
-                            }
                             sap.ui.require([
                                 "sap/ui/rta/api/startKeyUserAdaptation"
                             ], function (
                                 startKeyUserAdaptation
                             ) {
                                 startKeyUserAdaptation({
-                                    rootControl: oContainer.getComponentInstance()
-                                }).then(function (oRta) {
-                                    objRta = oRta;
-                                    oContainer.$().css({
-                                        "padding-top": "2.5rem",
-                                        "box-sizing": "border-box"
-                                    });
-                                    oRta.attachStop(function () {
-                                        oContainer.$().css({
-                                            "padding-top": "0",
-                                            "box-sizing": "content-box"
-                                        });
-                                        oRta.destroy();
-                                        objRta = null;
-                                    });
+                                    rootControl: oOuterContainer.getComponentInstance()
                                 });
                             });
                         }

package/src/sap/ui/documentation/sdk/model/messagesData.json

@@ -9,7 +9,7 @@
 	  	"id": "IM2",
 		"type": "Warning",
 		"versionValidator": ".*.legacy-free(-SNAPSHOT)?$",
-		"text": "This version ({0}) is intended for experimentation only and should not be used for productive purposes. For more information, see",
+		"text": "This version ({0}) is intended for experimentation only and must not be used for productive purposes. For more information, see",
 		"expire": "2027-04-30",
 		"linkText": "the SAP Community blog post",
 		"mandatory": true,

package/src/sap/ui/documentation/sdk/samples/Component.js

@@ -0,0 +1,143 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2025 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+/**
+ * @namespace sap.ui.documentation.sdk.samples
+ * @classdesc
+ * A UI5 component wrapper for dynamically loading and embedding an inner component
+ * corresponding to a Demokit sample.
+ * The purpose of this component is to provide the required setup for Runtime Adaptation (RTA),
+ * namely:
+ * (1) wrapper component is of "type": "application" in the manifest,
+ * (2) the wrapper component registers to the "start" and "stop" events of RTA via its custom design time metadata
+ *
+ * @extends sap.ui.core.UIComponent
+ *
+ * @param {object} mSettings - Configuration settings for the component.
+ * @param {string} mSettings.innerComponentName - The name of the inner component to load.
+ * @param {string} mSettings.innerComponentId - The ID to assign to the inner component.
+ *
+ */
+sap.ui.define([
+    "sap/ui/core/Component",
+    "sap/ui/core/UIComponent",
+    "sap/ui/core/ComponentContainer",
+    "sap/ui/core/CustomData",
+    "sap/ui/core/Manifest",
+    "sap/m/Page"
+], function (Component, UIComponent, ComponentContainer, CustomData, Manifest, Page) {
+    "use strict";
+
+    /**
+     * An object containing configuration settings.
+     * @type {Object}
+     */
+    let oSettings = {};
+
+    return UIComponent.extend("sap.ui.documentation.sdk.samples", {
+        metadata: {
+            manifest: "json",
+            properties: {
+                innerComponentName: { type: "string" },
+                innerComponentId: { type: "string" }
+            }
+        },
+
+        constructor: function (mSettings) {
+            oSettings = mSettings;
+            UIComponent.prototype.constructor.apply(this, arguments);
+        },
+
+        init: function () {
+            UIComponent.prototype.init.apply(this, arguments);
+        },
+
+        /**
+         * @override
+         * Returns the manifest object for the component.
+         * This method checks if the manifest contains the <code>appVariantId</code> for its inner component.
+         * If not, it adds the <code>appVariantId</code> to the manifest.
+         *
+         * The <code>appVariantId</code> coincides with the name of the currently nested inner component.
+         * This is required to ensure that any RTA changes made to the inner component are
+         * saved in local storage as belonging to that same inner component.
+         * @returns {sap.ui.core.Manifest} The manifest object for the component.
+         */
+        getManifestObject: function () {
+            var oManifest = UIComponent.prototype.getManifestObject.call(this),
+                sAppVariantId = oSettings.innerComponentName;
+
+            if (!this._checkManifestContainsAppVariant(oManifest, sAppVariantId)) {
+                this._addVariantToManifest(oManifest, sAppVariantId);
+            }
+
+            return oManifest;
+        },
+
+        _checkManifestContainsAppVariant: function (oManifest, sAppVariantId) {
+            var oUI5Entry = oManifest.getEntry("sap.ui5");
+            return (oUI5Entry && oUI5Entry.appVariantId === sAppVariantId);
+        },
+
+        _addVariantToManifest: function (oManifest, appVariantId) {
+            oManifest.getEntry = function (sPath) {
+                var oEntry = Manifest.prototype.getEntry.call(oManifest, sPath);
+                if (sPath === "sap.ui5") {
+                    oEntry = Object.assign({}, oEntry, {
+                        appVariantId
+                    });
+                }
+                return oEntry;
+            };
+        },
+
+        createInnerComponent: function () {
+            var sName = oSettings.innerComponentName;
+            var sId = oSettings.innerComponentId;
+
+            return Component.create({
+                    id: sId,
+                    name: sName
+                }).then(function (oComponent) {
+                    this._oInnerComponent = oComponent;
+                    this._createComponentContainer();
+                    return oComponent;
+                }.bind(this));
+        },
+
+        _createComponentContainer: function() {
+            var oContainer = new ComponentContainer({
+                component: this._oInnerComponent,
+                propagateModel: true,
+                height: "100%"
+            });
+
+            var oRootControl = new Page({
+                content: [oContainer],
+                showHeader: false,
+                customData: [
+                    new CustomData({
+                        key: "sap-ui-custom-settings",
+                        value: {
+                            "sap.ui.dt": {
+                                "designtime": "sap/ui/documentation/sdk/samples/Page.designtime"
+                            }
+                        }
+                    })
+                ]
+            });
+
+            // Set the container as the root control of the wrapper
+            this.setAggregation("rootControl", oRootControl);
+        },
+
+        exit: function() {
+            if (this._oInnerComponent) {
+                this._oInnerComponent.destroy();
+            }
+        }
+    });
+});

package/src/sap/ui/documentation/sdk/samples/Page.designtime.js

@@ -0,0 +1,55 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2025 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+/**
+ * Design Time Metadata extension for the UI Component.
+ *
+ * This module extends the default PageDesigntime metadata with additional tooling methods
+ * for starting and stopping RTA (Runtime Adaptation) via postMessage communication.
+ *
+ * @module sap/ui/documentation/sdk/samples/Page.designtime
+ *
+ * @requires sap/m/designtime/Page.designtime
+ *
+ * @returns {object} Extended PageDesigntime metadata object with `tool` property.
+ *
+ * @property {object} tool - Tooling methods for RTA integration.
+ * @property {Function} tool.start - Sends a "RTA_START" message to the parent window with a status message.
+ * @property {Function} tool.stop - Sends a "RTA_STOP" message to the parent window with a status message.
+ */
+// Provides the Design Time Metadata for the UI Component
+sap.ui.define(["sap/m/designtime/Page.designtime"],
+	function (PageDesigntime) {
+		"use strict";
+
+		const getUrlParam = function(sParamName) {
+			return new window.URLSearchParams(window.location.search).get(sParamName);
+		},
+		postMessageToOrigin = function(oData) {
+			window.parent.postMessage(oData, getUrlParam('sap-ui-xx-dk-origin'));
+		};
+
+		return Object.assign({}, PageDesigntime, {
+			tool: {
+				start:function() {
+					postMessageToOrigin({
+						type: "RTA_START",
+						data: {
+							"msg": "RTA started"
+						}
+					});
+				},
+				stop:function() {
+					postMessageToOrigin({
+						type: "RTA_STOP",
+						data: {
+							"msg": "RTA stopped"
+						}
+					});
+				}
+			}
+		});
+	});

package/src/sap/ui/documentation/sdk/samples/manifest.json

@@ -0,0 +1,19 @@
+{
+    "sap.app": {
+        "id": "sap.ui.documentation.sdk.samples",
+        "type": "application",
+        "title": "Wrapper Component for RTA",
+        "applicationVersion": {
+            "version": "1.0.0"
+        }
+    },
+    "sap.ui5": {
+        "dependencies": {
+            "minUI5Version": "1.60.0",
+            "libs": {
+                "sap.ui.core": {},
+                "sap.m": {}
+            }
+        }
+    }
+}

package/src/sap/ui/documentation/sdk/thirdparty/highlight.js/highlight.js

@@ -998,10 +998,10 @@ var hljs = (function () {
    * @param {string} message
    */
   const deprecated = (version, message) => {
-    if (seenDeprecations[`1.138.0/${message}`]) return;
+    if (seenDeprecations[`1.139.0/${message}`]) return;
 
-    console.log(`Deprecated as of 1.138.0. ${message}`);
-    seenDeprecations[`1.138.0/${message}`] = true;
+    console.log(`Deprecated as of 1.139.0. ${message}`);
+    seenDeprecations[`1.139.0/${message}`] = true;
   };
 
   /* eslint-disable no-throw-literal */

package/src/sap/ui/documentation/sdk/view/App.view.xml

@@ -85,7 +85,10 @@
 							type="Default"
 							icon="sap-icon://dimension"
 							text="{= ${appView>/bDesktopSize}
-								? [${i18n>APP_VERSION_VERSION}, ${versionData>/version}].join(' ')
+								? [${i18n>APP_VERSION_VERSION}, ${versionData>/fullVersion}].join(' ')
+								: '' }"
+							tooltip="{= ${appView>/bDesktopSize}
+								? [${i18n>APP_VERSION_VERSION}, ${versionData>/fullVersion}].join(' ')
 								: '' }"
 							press="onChangeVersionButtonPress"
 							visible="{= ${appView>/bShowVersionSwitchButton} }">
@@ -197,7 +200,8 @@
 							icon="sap-icon://bell"
 							press="onNewsButtonPress"
 							text="{i18n>APP_INFORMATION_BTN_NEWS}"
-							tooltip="{i18n>APP_NEWS_BTN_TOOLTIP}">
+							tooltip="{i18n>APP_NEWS_BTN_TOOLTIP}"
+							visible="{= !${versionData>/isURLVersioned} }">
 							<customData>
 								<BadgeCustomData key="badge" value="{news>/newsCount}" />
 							</customData>

package/src/sap/ui/documentation/sdk/view/Code.view.xml

@@ -136,7 +136,6 @@
 					</subHeader>
 					<fileEditor:FileEditor
 						id="fileEditor"
-						fileChange="onFileEditorFileChange"
 						fileSwitch="onFileSwitch"
 						visible="{= ${settings>/editorType} === 'text' }" />
 				</Page>

package/src/sap/ui/documentation/sdk/view/Sample.view.xml

@@ -68,7 +68,9 @@
 							class="sapUiHideOnPhone"
 							tooltip="{i18n>SAMPLE_ADAPT_BTN_TOOLTIP}"
 							press="onToggleAdaptationMode"
-							visible="{= ${/rtaLoaded} && !${/iframe} && !${/external} }" />
+							visible="{= ${/rtaLoaded} && !${/iframe} && !${/external} }"
+							enabled="{= !${/rtaStarted}}"/>
+
 					<Button
 							id="code"
 							icon="sap-icon://source-code"

package/src/sap/ui/documentation/sdk/view/warningSampleDialog.fragment.xml

@@ -0,0 +1,27 @@
+<core:FragmentDefinition
+		xmlns="sap.m"
+		xmlns:core="sap.ui.core">
+	<Dialog
+			title="{i18n>CACHE_CLEANUP_DIALOG_TITLE}"
+			class="sapUiContentPadding"
+			contentWidth="400px"
+			id="cacheCleanupDialog"
+			type="Message"
+			state="{= ${settings>/showWarning} ? 'Warning' : 'Error'}" >
+		<content>
+			<VBox class="sapUiTinyMarginTop">
+				<MessageStrip
+					class="sapUiTinyMarginBottom"
+					showIcon="true"
+					type="{= ${settings>/showWarning} ? 'Warning' : 'Error'}"
+    				text="{= ${settings>/showWarning} ? ${i18n>CACHE_CLEANUP_DIALOG_WARNING_MESSAGE} : ${i18n>CACHE_CLEANUP_DIALOG_ERROR_MESSAGE}}" />
+				<Text
+					class="sapUiSmallMarginTop"
+					text="{i18n>CACHE_CLEANUP_DIALOG_DESCRIPTION}" />
+			</VBox>
+		</content>
+		<beginButton>
+			<Button text="{i18n>CACHE_CLEANUP_DIALOG_OK_BTN}" press="handleDialogClose" type="Emphasized" />
+		</beginButton>
+	</Dialog>
+</core:FragmentDefinition>