@openui5/sap.ui.documentation 1.122.1 → 1.123.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openui5/sap.ui.documentation",
-  "version": "1.122.1",
+  "version": "1.123.1",
   "description": "OpenUI5 UI Library sap.ui.documentation",
   "author": "SAP SE (https://www.sap.com)",
   "license": "Apache-2.0",
@@ -14,11 +14,11 @@
     "url": "https://github.com/SAP/openui5.git"
   },
   "dependencies": {
-    "@openui5/sap.m": "1.122.1",
-    "@openui5/sap.ui.core": "1.122.1",
-    "@openui5/sap.ui.layout": "1.122.1",
-    "@openui5/themelib_sap_belize": "1.122.1",
-    "@openui5/themelib_sap_fiori_3": "1.122.1",
-    "@openui5/themelib_sap_horizon": "1.122.1"
+    "@openui5/sap.m": "1.123.1",
+    "@openui5/sap.ui.core": "1.123.1",
+    "@openui5/sap.ui.layout": "1.123.1",
+    "@openui5/themelib_sap_belize": "1.123.1",
+    "@openui5/themelib_sap_fiori_3": "1.123.1",
+    "@openui5/themelib_sap_horizon": "1.123.1"
   }
 }

package/src/sap/ui/documentation/.library

@@ -6,7 +6,7 @@
   <copyright>OpenUI5
  * (c) Copyright 2009-2024 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.</copyright>
-  <version>1.122.1</version>
+  <version>1.123.1</version>
 
   <documentation>SAPUI5 library for the Demokit 2.0.</documentation>
 
@@ -41,7 +41,7 @@
     </packaging>
     <!-- Thirdparty references -->
     <thirdparty xmlns="http://www.sap.com/ui5/buildext/thirdparty" >
-      <lib name="highlight.js" displayName="highlight.js" npmName="highlight.js" hash="96a6c881e38caa1b71ffeb11fe783b80" version="11.9.0" homepage="https://highlightjs.org/" id="73555000106100051976">
+      <lib name="highlight.js" displayName="highlight.js" npmName="highlight.js" hash="ad04c8737a21411588b021733d622c49" version="11.9.0" homepage="https://highlightjs.org/" id="73555000106100051976">
         <license url="https://github.com/highlightjs/highlight.js/blob/11.9.0/LICENSE" type="BSD-3-Clause" />
         <copyright>2006-2020, Ivan Sagalaev</copyright>
         <pattern>sap/ui/documentation/sdk/thirdparty/highlight.js/*</pattern>

package/src/sap/ui/documentation/library.js

@@ -25,14 +25,14 @@ sap.ui.define([
 	 * @namespace
 	 * @alias sap.ui.documentation
 	 * @author SAP SE
-	 * @version 1.122.1
+	 * @version 1.123.1
 	 * @since 1.48
 	 * @public
 	 */
 	var thisLibrary = Lib.init({
 		apiVersion: 2,
 		name : 'sap.ui.documentation',
-		version: '1.122.1',
+		version: '1.123.1',
 		dependencies : ['sap.ui.core','sap.m'],
 		types: [],
 		interfaces: [],

package/src/sap/ui/documentation/sdk/controller/App.controller.js

@@ -1569,7 +1569,7 @@ sap.ui.define([
 						aHiddenValues = this._processVersionOverview(oValues[1]),
 						aFilteredVersionsEOCP = this._filterVersionsPastEOCP(oValues[1]);
 
-					if (Array.isArray(aNeoAppVersions)) {
+					if (Array.isArray(aNeoAppVersions) && aNeoAppVersions.length > 0) {
 						aNeoAppVersions = aNeoAppVersions.filter(function (oVersion) {
 							return aHiddenValues.indexOf(oVersion.version) === -1;
 						});

package/src/sap/ui/documentation/sdk/controller/MasterTreeBaseController.js

@@ -91,12 +91,14 @@ sap.ui.define([
 			},
 
 			/**
-			 * Handler for the SearchField
-			 * @param oEvent
+			 * Handler for the SearchField event.
+			 *
+			 * @param {sap.ui.base.Event} oEvent - The event object.
 			 */
 			onTreeFilter: function (oEvent) {
 				// Update filter value
-				this._sFilter = oEvent.getParameter("newValue").trim();
+				var newValue = oEvent.getParameter("newValue").trim();
+				this._sFilter = newValue.replace(/\//g, '.');
 
 				if (this._filterTimeout) {
 					clearTimeout(this._filterTimeout);

package/src/sap/ui/documentation/sdk/controller/SubApiDetail.controller.js

@@ -162,7 +162,7 @@ sap.ui.define([
 							if ($aNotApplied.length > 0 && window.hljs) {
 								$aNotApplied.addClass('hljs');
 								document.querySelectorAll('pre').forEach(function(block) {
-									window.hljs.highlightBlock(block);
+									window.hljs.highlightElement(block);
 								});
 							}
 						}.bind(this), 200);
@@ -301,7 +301,7 @@ sap.ui.define([
 			_hljs: function () {
 				if (window.hljs) {
 					document.querySelectorAll('pre').forEach(function(block) {
-						window.hljs.highlightBlock(block);
+						window.hljs.highlightElement(block);
 					});
 				}
 			},

package/src/sap/ui/documentation/sdk/controller/TopicDetail.controller.js

@@ -345,7 +345,7 @@ sap.ui.define([
 
 				if (window.hljs) {
 					document.querySelectorAll('pre:not([class*="lines"])').forEach(function(block) {
-						window.hljs.highlightBlock(block);
+						window.hljs.highlightElement(block);
 					});
 				}
 			},

package/src/sap/ui/documentation/sdk/css/style.css

@@ -1575,7 +1575,7 @@ html:not(.sapUiMedia-Std-Phone) .sapUiParamText.depth-2 {
 	padding-left: 4rem;
 }
 html:not(.sapUiMedia-Std-Phone) .sapUiParamText.depth-3 {
-	padding-left: 2.25rem;
+	padding-left: 6rem;
 }
 html:not(.sapUiMedia-Std-Phone) .sapUiParamText.depth-4 {
 	padding-left: 8rem;

package/src/sap/ui/documentation/sdk/images/logo_sap.svg

@@ -0,0 +1 @@
+<svg id="Layer_1" data-name="Layer 1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 412.38 204"><defs><style>.cls-1,.cls-2{fill-rule:evenodd;}.cls-1{fill:url(#linear-gradient);}.cls-2{fill:#fff;}</style><linearGradient id="linear-gradient" x1="206.19" x2="206.19" y2="204" gradientUnits="userSpaceOnUse"><stop offset="0" stop-color="#00b8f1"/><stop offset="0.02" stop-color="#01b6f0"/><stop offset="0.31" stop-color="#0d90d9"/><stop offset="0.58" stop-color="#1775c8"/><stop offset="0.82" stop-color="#1c65bf"/><stop offset="1" stop-color="#1e5fbb"/></linearGradient></defs><title>SAP_grad_R_scrn_Zeichenfläche 1</title><polyline class="cls-1" points="0 204 208.41 204 412.38 0 0 0 0 204"/><path class="cls-2" d="M244.73,38.36l-40.6,0v96.52L168.67,38.33H133.51l-30.27,80.72C100,98.7,79,91.67,62.4,86.4,51.46,82.89,39.85,77.72,40,72c.09-4.68,6.23-9,18.38-8.38,8.17.43,15.37,1.09,29.71,8l14.1-24.55C89.06,40.42,71,36.21,56.17,36.19h-.09c-17.28,0-31.68,5.6-40.6,14.83A34.23,34.23,0,0,0,5.77,74.7C5.54,87.15,10.11,96,19.71,103c8.1,5.94,18.46,9.79,27.6,12.62,11.27,3.49,20.47,6.53,20.36,13A9.57,9.57,0,0,1,65,135c-2.81,2.9-7.13,4-13.09,4.1-11.49.24-20-1.56-33.61-9.59L5.77,154.42a93.77,93.77,0,0,0,46,12.22l2.11,0c14.24-.25,25.74-4.31,34.92-11.71.53-.41,1-.84,1.49-1.28L86.17,164.5H123l6.19-18.82a67.46,67.46,0,0,0,21.68,3.43,68.33,68.33,0,0,0,21.16-3.25l6,18.64h60.14v-39h13.11c31.71,0,50.46-16.15,50.46-43.2C301.74,52.19,283.52,38.36,244.73,38.36ZM150.91,121a36.93,36.93,0,0,1-13-2.28l12.87-40.59H151l12.65,40.71A38.5,38.5,0,0,1,150.91,121Zm96.2-23.33h-8.94V64.91h8.94c11.93,0,21.44,4,21.44,16.14,0,12.6-9.51,16.57-21.44,16.57"/></svg>

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

@@ -208,6 +208,7 @@
                                             "box-sizing": "content-box"
                                         });
                                         oRta.destroy();
+                                        objRta = null;
                                     });
                                 });
                             });

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.122.1/${message}`]) return;
+    if (seenDeprecations[`1.123.1/${message}`]) return;
 
-    console.log(`Deprecated as of 1.122.1. ${message}`);
-    seenDeprecations[`1.122.1/${message}`] = true;
+    console.log(`Deprecated as of 1.123.1. ${message}`);
+    seenDeprecations[`1.123.1/${message}`] = true;
   };
 
   /* eslint-disable no-throw-literal */
@@ -15826,5 +15826,191 @@ if (typeof exports === 'object' && typeof module !== 'undefined') { module.expor
 
   })();
 
+	// ##### BEGIN MODIFIED BY SAP
+	// Source: https://github.com/highlightjs/highlight.js/issues/2889
+	var mergeHTMLPlugin = (function () {
+		'use strict';
+
+		var originalStream;
+
+		/**
+		 * @param {string} value
+		 * @returns {string}
+		 */
+		function escapeHTML(value) {
+		return value
+			.replace(/&/g, '&')
+			.replace(/</g, '&lt;')
+			.replace(/>/g, '&gt;')
+			.replace(/"/g, '&quot;')
+			.replace(/'/g, '&#x27;');
+		}
+
+		/* plugin itself */
+
+		/** @type {HLJSPlugin} */
+		const mergeHTMLPlugin = {
+		// preserve the original HTML token stream
+		"before:highlightElement": ({ el }) => {
+			originalStream = nodeStream(el);
+		},
+		// merge it afterwards with the highlighted token stream
+		"after:highlightElement": ({ el, result, text }) => {
+			if (!originalStream.length) return;
+
+			const resultNode = document.createElement('div');
+			resultNode.innerHTML = result.value;
+			result.value = mergeStreams(originalStream, nodeStream(resultNode), text);
+			el.innerHTML = result.value;
+		}
+		};
+
+		/* Stream merging support functions */
+
+		/**
+		 * @typedef Event
+		 * @property {'start'|'stop'} event
+		 * @property {number} offset
+		 * @property {Node} node
+		 */
+
+		/**
+		 * @param {Node} node
+		 */
+		function tag(node) {
+		return node.nodeName.toLowerCase();
+		}
+
+		/**
+		 * @param {Node} node
+		 */
+		function nodeStream(node) {
+		/** @type Event[] */
+		const result = [];
+		(function _nodeStream(node, offset) {
+			for (let child = node.firstChild; child; child = child.nextSibling) {
+			if (child.nodeType === 3) {
+				offset += child.nodeValue.length;
+			} else if (child.nodeType === 1) {
+				result.push({
+				event: 'start',
+				offset: offset,
+				node: child
+				});
+				offset = _nodeStream(child, offset);
+				// Prevent void elements from having an end tag that would actually
+				// double them in the output. There are more void elements in HTML
+				// but we list only those realistically expected in code display.
+				if (!tag(child).match(/br|hr|img|input/)) {
+				result.push({
+					event: 'stop',
+					offset: offset,
+					node: child
+				});
+				}
+			}
+			}
+			return offset;
+		})(node, 0);
+		return result;
+		}
+
+		/**
+		 * @param {any} original - the original stream
+		 * @param {any} highlighted - stream of the highlighted source
+		 * @param {string} value - the original source itself
+		 */
+		function mergeStreams(original, highlighted, value) {
+		let processed = 0;
+		let result = '';
+		const nodeStack = [];
+
+		function selectStream() {
+			if (!original.length || !highlighted.length) {
+			return original.length ? original : highlighted;
+			}
+			if (original[0].offset !== highlighted[0].offset) {
+			return (original[0].offset < highlighted[0].offset) ? original : highlighted;
+			}
+
+			/*
+			To avoid starting the stream just before it should stop the order is
+			ensured that original always starts first and closes last:
+
+			if (event1 == 'start' && event2 == 'start')
+			return original;
+			if (event1 == 'start' && event2 == 'stop')
+			return highlighted;
+			if (event1 == 'stop' && event2 == 'start')
+			return original;
+			if (event1 == 'stop' && event2 == 'stop')
+			return highlighted;
+
+			... which is collapsed to:
+			*/
+			return highlighted[0].event === 'start' ? original : highlighted;
+		}
+
+		/**
+		 * @param {Node} node
+		 */
+		function open(node) {
+			/** @param {Attr} attr */
+			function attributeString(attr) {
+			return ' ' + attr.nodeName + '="' + escapeHTML(attr.value) + '"';
+			}
+			// @ts-ignore
+			result += '<' + tag(node) + [].map.call(node.attributes, attributeString).join('') + '>';
+		}
+
+		/**
+		 * @param {Node} node
+		 */
+		function close(node) {
+			result += '</' + tag(node) + '>';
+		}
+
+		/**
+		 * @param {Event} event
+		 */
+		function render(event) {
+			(event.event === 'start' ? open : close)(event.node);
+		}
+
+		while (original.length || highlighted.length) {
+			let stream = selectStream();
+			result += escapeHTML(value.substring(processed, stream[0].offset));
+			processed = stream[0].offset;
+			if (stream === original) {
+			/*
+			On any opening or closing tag of the original markup we first close
+			the entire highlighted node stack, then render the original tag along
+			with all the following original tags at the same offset and then
+			reopen all the tags on the highlighted stack.
+			*/
+			nodeStack.reverse().forEach(close);
+			do {
+				render(stream.splice(0, 1)[0]);
+				stream = selectStream();
+			} while (stream === original && stream.length && stream[0].offset === processed);
+			nodeStack.reverse().forEach(open);
+			} else {
+			if (stream[0].event === 'start') {
+				nodeStack.push(stream[0].node);
+			} else {
+				nodeStack.pop();
+			}
+			render(stream.splice(0, 1)[0]);
+			}
+		}
+		return result + escapeHTML(value.substr(processed));
+		}
+
+		return mergeHTMLPlugin;
+
+	}());
+
+	hljs.addPlugin(mergeHTMLPlugin);
+	// ##### END MODIFIED BY SAP
   hljs.registerLanguage('yaml', hljsGrammar);
 })();

package/src/sap/ui/documentation/sdk/util/DocumentationRouter.js

@@ -449,6 +449,13 @@ sap.ui.define([
 				}
 			}.bind(this));
 
+			if (!sMemberType && aEntity.includes("methods")) {
+				var iSeparatorIndex = aEntity.indexOf("methods");
+				sMemberType = "methods";
+				aMember = aEntity.slice(iSeparatorIndex + 1);
+				aEntity = aEntity.slice(0, iSeparatorIndex);
+			}
+
 			return {
 				id: aEntity.join("/"),
 				entityId: aMember.length ? aMember.join("/") : undefined,

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

@@ -9,8 +9,9 @@
 				width="100%">
 			<items>
 				<Image
-						src="./resources/sap/ui/documentation/sdk/images/logo_sap.png"
+						src="./resources/sap/ui/documentation/sdk/images/logo_sap.svg"
 						densityAware="false"
+						alt="SAP Company Logo"
 						width="3rem"
 						height="1.5rem">
 				</Image>

package/src/sap/ui/documentation/themes/base/Documentation.less

@@ -1012,6 +1012,12 @@ html.sapUiMedia-Std-Tablet {
 			top: -0.125rem;
 		}
 	}
+
+	.sapUiDemoKitHeaderActionsVersionSwitch .sapMBtnInner {
+		&:after {
+			top: 0.75rem;
+		}
+	}
 }
 
 // Media queries
@@ -1073,6 +1079,23 @@ html.sap-desktop {
 html.sap-tablet {
 	&:not(html.sap-combi) .sapUiDemokit.sapTntToolPage {
 		padding: 0;
+
+		// Adjust the style of the version switch button to match the design specifiaction
+		.sapUiDemoKitHeaderActionsVersionSwitch .sapMBtnInner {
+			padding: 0;
+
+			&:after {
+				content: none;
+			}
+
+			.sapMBtnIcon {
+				padding: 0;
+			}
+		}
+
+		.sapUiDemoKitHeaderActionsVersionSwitchTextContent {
+			display: none;
+		}
 	}
 
 	.sapUiDemokit {
@@ -1102,23 +1125,6 @@ html.sap-tablet {
 			.sapUiDocumentationMasterToggleButton {
 				margin-left: 1rem;
 			}
-
-			// Adjust the style of the version switch button to match the design specifiaction
-			.sapUiDemoKitHeaderActionsVersionSwitch .sapMBtnInner {
-				padding: 0;
-
-				&:after {
-					content: none;
-				}
-
-				.sapMBtnIcon {
-					padding: 0;
-				}
-			}
-
-			.sapUiDemoKitHeaderActionsVersionSwitchTextContent {
-				display: none;
-			}
 		}
 	}
 }