@openui5/sap.ui.documentation 1.94.0 → 1.97.0

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

@@ -4,12 +4,11 @@
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
-/* global URLSearchParams */
-
 sap.ui.define([
 	"sap/ui/events/KeyCodes",
 	"sap/ui/thirdparty/jquery",
 	"sap/ui/documentation/sdk/controller/BaseController",
+	"sap/ui/documentation/sdk/controller/util/NewsInfo",
 	"sap/ui/documentation/sdk/controller/util/SearchUtil",
 	"sap/ui/core/mvc/Controller",
 	"sap/ui/model/Filter",
@@ -38,6 +37,7 @@ sap.ui.define([
 	KeyCodes,
 	jQuery,
 	BaseController,
+	NewsInfo,
 	SearchUtil,
 	Controller,
 	Filter,
@@ -78,18 +78,17 @@ sap.ui.define([
 				home: MAIN_WEB_PAGE_TITLE
 			};
 
-		function returnResourcePath(sParam) {
+		function getResourcePath(sResource) {
 
-			return bUseUnifiedResourceOrigin && !self['sap-ui-documentation-config'] ?
-				window.origin + sParam :
-				ResourcesUtil.getResourceOriginPath(sParam);
+			return ResourcesUtil.getResourcesVersion() && !self['sap-ui-documentation-config'] ?
+				window.origin + sResource :
+				ResourcesUtil.getResourceOriginPath(sResource);
 
 		}
 		// shortcut for sap.m.URLHelper
-		var bUseUnifiedResourceOrigin =  new URLSearchParams(window.location.search).get('sap-ui-xx-unifiedResources') != null,
-			URLHelper = mobileLibrary.URLHelper,
-			sNeoAppJsonPath = returnResourcePath("/neo-app.json"), /* Load neo-app.json always from root URL */
-			sVersionOverviewJsonPath = returnResourcePath("/versionoverview.json"), /* Load versionoverview.json always from root URL */
+		var URLHelper = mobileLibrary.URLHelper,
+			sNeoAppJsonPath = getResourcePath("/neo-app.json"), /* Load neo-app.json always from root URL */
+			sVersionOverviewJsonPath = getResourcePath("/versionoverview.json"), /* Load versionoverview.json always from root URL */
 			ABOUT_TEXT = "about",
 			FEEDBACK_TEXT = "feedback",
 			FEEDBACK_URL = "https://demokit-feedback-proxy.cfapps.eu12.hana.ondemand.com/issue",
@@ -132,7 +131,8 @@ sap.ui.define([
 					aResultArr.push({
 						"groupTitle": sCurrGroupTitle,
 						"version": sCurrGroupTitle + " (" + iCounter + " versions)",
-						"nodes": aNodes
+						"nodes": aNodes,
+						"path": aNodes[0].path
 					});
 				}
 
@@ -197,6 +197,9 @@ sap.ui.define([
 
 				}.bind(this));
 
+				this._oNewsModel = new JSONModel();
+				this.setModel(this._oNewsModel, "news");
+
 				// Cache view reference
 				this._oSupportedLangModel = new JSONModel();
 
@@ -216,6 +219,10 @@ sap.ui.define([
 
 				this._oConfigUtil = this.getOwnerComponent().getConfigUtil();
 				this._oCookieNames = this._oConfigUtil.COOKIE_NAMES;
+				this._sLocalStorageNewsName = this._oConfigUtil.LOCAL_STORAGE_NAMES['OLD_NEWS_IDS'];
+
+				NewsInfo.prepareNewsData(this._oConfigUtil);
+
 				this._bSupportsPrefersColorScheme = !!(window.matchMedia &&
 					(window.matchMedia('(prefers-color-scheme: dark)').matches ||
 					window.matchMedia('(prefers-color-scheme: light)').matches));
@@ -235,6 +242,7 @@ sap.ui.define([
 				}, this);
 
 				this.bus = Core.getEventBus();
+				this.bus.subscribe("newsChanged", "onDemoKitNewsChanged", this._syncNewsModelWithNewsInfo, this);
 
 				this._createConfigurationBasedOnURIInput();
 
@@ -291,6 +299,8 @@ sap.ui.define([
 				jQuery(document.body).addClass(this.getOwnerComponent().getContentDensityClass());
 
 				Device.orientation.attachHandler(this._onOrientationChange, this);
+
+				this._syncNewsModelWithNewsInfo();
 			},
 
 			onExit: function() {
@@ -382,6 +392,69 @@ sap.ui.define([
 				}
 			},
 
+			navigateToNews: function() {
+				this.getRouter().navTo("news");
+			},
+
+			handleNewsPress: function (oEvent) {
+				var oButton = oEvent.getSource(),
+					oView = this.getView();
+
+				if (this._oNewsModel.getProperty("/newsCount") === 0) {
+					this.navigateToNews();
+				} else if (!this._oNewsPopover) {
+					Fragment.load({
+						name: "sap.ui.documentation.sdk.view.NewsPopover",
+						controller: this
+					}).then(function(oPopover) {
+						oView.addDependent(oPopover);
+						this._oNewsPopover = oPopover;
+						this._oNewsPopover.openBy(oButton);
+					}.bind(this));
+				} else {
+					this._oNewsPopover.openBy(oButton);
+				}
+			},
+
+			handleShowAllPress: function () {
+				this._oNewsPopover.close();
+				this.navigateToNews();
+			},
+
+			handleDismissAllPress: function () {
+				NewsInfo.moveAllNewItemsToOld();
+			},
+
+			handleNewsItemClose: function (oEvent) {
+				var oItem = oEvent.getSource(),
+					iItemCustomId = oItem.getCustomData()[0].getValue(),
+					oItemInfoInItemsProperty = this._oNewsModel.getProperty("/items").find(function(oItem){
+						return oItem.id === iItemCustomId;
+					});
+
+					NewsInfo.moveNewItemToOld(oItemInfoInItemsProperty);
+			},
+
+			handleVisitNewsLink: function(oEvent) {
+				var oItem = oEvent.getSource(),
+					sItemLink = oItem.getCustomData()[0].getValue();
+
+				URLHelper.redirect(sItemLink, true);
+			},
+
+			_syncNewsModelWithNewsInfo: function() {
+				var aNewsInfoCopy,
+					sPreparationFailureMessage = NewsInfo.getPreparationFailureMessage();
+
+				if (!sPreparationFailureMessage) {
+					aNewsInfoCopy = NewsInfo.getNewNewsArray().slice();
+					this._oNewsModel.setProperty("/items", aNewsInfoCopy);
+					this._oNewsModel.setProperty("/newsCount", aNewsInfoCopy.length);
+				}
+
+				this._oNewsModel.setProperty("/newsPreparationFailureMessage", sPreparationFailureMessage);
+			},
+
 			handleMenuItemClick: function (oEvent) {
 				var sTargetText = oEvent.getParameter("item").getKey(),
 					sTarget = this.MENU_LINKS_MAP[sTargetText];
@@ -1038,14 +1111,22 @@ sap.ui.define([
 				this.oRouter.navTo("sitemap", {});
 			},
 
+			onLatestVersionItemPress: function() {
+				if (ResourcesUtil.getResourcesVersion()) {
+					window.sessionStorage.removeItem("versionPrefixPath");
+					window.location.reload();
+				} else {
+					window.location.href = "/";
+				}
+			},
+
 			onVersionItemPress: function (oEvent) {
-				var oSelectedItem = oEvent.getParameter("listItem"),
-					oCustomData = oSelectedItem.getCustomData()[0],
-					bUseUnifiedResourceOrigin =  new URLSearchParams(window.location.search).get('sap-ui-xx-unifiedResources') != null;
+				var oSelectedItem = sap.ui.getCore().byId("versionList").getSelectedItem(),
+					oCustomData = oSelectedItem.getCustomData()[0];
 
 				if (oCustomData && oCustomData.getKey() === "path") {
 
-					if (bUseUnifiedResourceOrigin) {
+					if (ResourcesUtil.getHasProxy()) {
 						window.sessionStorage.setItem("versionPrefixPath", oCustomData.getValue());
 						window.location.reload();
 					} else {
@@ -1517,6 +1598,7 @@ sap.ui.define([
 							this._aNeoAppVersions = aNeoAppVersions;
 							// Make version select visible
 							this._updateVersionSwitchVisibility();
+							this.getModel("versionData").setProperty("/latestVersion", this._aNeoAppVersions[0].version);
 						} else {
 							Log.warning("No multi-version environment detected");
 						}
@@ -1529,7 +1611,8 @@ sap.ui.define([
 			},
 
 			_getUI5Version: function () {
-				return this.getModel("versionData").getProperty("/version");
+				return ResourcesUtil.getResourcesVersion() ?
+					window.sessionStorage.getItem("versionPrefixPath") : this.getModel("versionData").getProperty("/version");
 			},
 
 			_getUI5VersionGav: function () {

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

@@ -0,0 +1,77 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2021 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define([
+		"sap/ui/documentation/sdk/controller/BaseController",
+		'sap/ui/model/json/JSONModel',
+		"sap/ui/documentation/sdk/controller/util/NewsInfo",
+		"sap/ui/core/Core",
+		"sap/m/library"
+		],
+		function (BaseController, JSONModel, NewsInfo, Core, mobileLibrary) {
+		'use strict';
+
+		return BaseController.extend('sap.ui.documentation.sdk.controller.News', {
+			onInit: function() {
+				this.getRouter().getRoute("news").attachPatternMatched(this._onMatched, this);
+
+				this._oModel = new JSONModel();
+				this.setModel(this._oModel);
+
+				NewsInfo.prepareNewsData(this.getOwnerComponent().getConfigUtil());
+
+				Core.getEventBus().subscribe("newsChanged", "onDemoKitNewsChanged", this._syncModelWithNewsInfo, this);
+			},
+
+			onAfterRendering: function() {
+				this._syncModelWithNewsInfo();
+			},
+
+			handleNewsItemClose: function (oEvent) {
+				var oItem = oEvent.getSource(),
+					iItemCustomId = oItem.getCustomData()[0].getValue(),
+					oItemInfoInItemsProperty = this._oModel.getProperty("/new").find(function(oItem){
+						return oItem.id === iItemCustomId;
+					});
+
+					NewsInfo.moveNewItemToOld(oItemInfoInItemsProperty);
+			},
+
+			handleMarkAsRead: function () {
+				NewsInfo.moveAllNewItemsToOld();
+			},
+
+			handleVisitLink: function(oEvent) {
+				var oItem = oEvent.getSource(),
+					sItemLink = oItem.getCustomData()[0].getValue();
+
+				mobileLibrary.URLHelper.redirect(sItemLink, true);
+			},
+
+			_syncModelWithNewsInfo: function() {
+				var sPreparationFailureMessage = NewsInfo.getPreparationFailureMessage();
+
+				if (!sPreparationFailureMessage) {
+					this._oModel.setProperty("/new", NewsInfo.getNewNewsArray().slice());
+					this._oModel.setProperty("/old", NewsInfo.getOldNewsArray().slice());
+				}
+				this._oModel.setProperty("/preparationFailureMessage", sPreparationFailureMessage);
+			},
+
+			/**
+			 * Handles "demoapps" routing
+			 * @function
+			 * @private
+			 */
+			_onMatched: function () {
+				try {
+					this.hideMasterSide();
+				} catch (e) {
+					// try-catch due to a bug in UI5 SplitApp, CL 1898264 should fix it
+				}
+			}
+		});
+	});

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

@@ -4,7 +4,6 @@
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
-/*global URLSearchParams*/
 
 sap.ui.define([
     "sap/ui/thirdparty/jquery",
@@ -56,11 +55,6 @@ sap.ui.define([
 					rtaLoaded: false
 				});
 
-				this._sSampleVersion = window.sessionStorage.getItem("versionPrefixPath");
-
-				this._sDefaultSampleTheme = (this._sSampleVersion && parseInt(this._sSampleVersion.slice(3,5)) < 68) ?
-					"sap_belize" : sap.ui.getCore().getConfiguration().getTheme();
-
 				this._sId = null; // Used to hold sample ID
 				this._sEntityId = null; // Used to hold entity ID for the sample currently shown
 
@@ -72,8 +66,6 @@ sap.ui.define([
 
 				this.getView().setModel(this.oModel);
 
-				this.bUseUnifiedResourceOrigin =  new URLSearchParams(window.location.search).get('sap-ui-xx-unifiedResources') != null;
-
 				this.bus = sap.ui.getCore().getEventBus();
 				this.setDefaultSampleTheme();
 				this.bus.subscribe("themeChanged", "onDemoKitThemeChanged", this.onDemoKitThemeChanged, this);
@@ -153,7 +145,7 @@ sap.ui.define([
 						var oSampleConfig = oConfig && oConfig.sample || {};
 
 						// only have the option to run standalone if there is an iframe
-						oModelData.showNewTab = !!oSampleConfig.iframe || this.bUseUnifiedResourceOrigin;
+						oModelData.showNewTab = !!oSampleConfig.iframe || ResourcesUtil.getHasProxy();
 						oModelData.id = oSample.id;
 						oModelData.name = oSample.name;
 						oModelData.details = oSample.details;
@@ -177,7 +169,7 @@ sap.ui.define([
 								}
 							}
 
-							if (oSampleConfig.iframe || this.bUseUnifiedResourceOrigin) {
+							if (oSampleConfig.iframe || ResourcesUtil.getHasProxy()) {
 								oComponentContainer = this._createIframe(oComponentContainer, oSampleConfig.iframe);
 							} else {
 								this.sIFrameUrl = null;
@@ -185,7 +177,7 @@ sap.ui.define([
 						}
 
 						// Sets the current iframe URL or restores it to "undefined"
-						oModelData.iframe = oSampleConfig.iframe || this.bUseUnifiedResourceOrigin;
+						oModelData.iframe = oSampleConfig.iframe || ResourcesUtil.getHasProxy();
 
 						// handle stretch content
 						var bStretch = !!oSampleConfig.stretch;
@@ -316,13 +308,13 @@ sap.ui.define([
 
 					// combine namespace with the file name again
 					this.sIFrameUrl = sap.ui.require.toUrl((sIframePath + "/" + sIframeWithoutUI5Ending).replace(/\./g, "/")) + sFileEnding || ".html";
-				} else if (this.bUseUnifiedResourceOrigin) {
+				} else if (ResourcesUtil.getHasProxy()) {
 					var sSamplePath =  ResourcesUtil.getResourceOriginPath(sap.ui.require.toUrl(this._sId.replace(/\./g, "/"))),
 						sSampleOrigin = (window['sap-ui-documentation-config'] && window['sap-ui-documentation-config'].demoKitResourceOrigin) || "",
-						sSampleVersion = this._sSampleVersion || "";
+						sSampleVersion = ResourcesUtil.getResourcesVersion();
 
-					this.sIFrameUrl = sap.ui.require.toUrl(
-						"sap/ui/demo/mock/index.html") +
+					this.sIFrameUrl =
+						"resources/sap/ui/documentation/sdk/index.html" +
 						"?sap-ui-xx-sample-id=" + sSampleId
 						+ "&&sap-ui-xx-sample-path=" + sSamplePath
 						+ "&&sap-ui-xx-sample-origin=" + sSampleOrigin
@@ -349,7 +341,7 @@ sap.ui.define([
 									oSampleFrame.sap.ui.getCore().attachInit(function () {
 										var bCompact = jQuery(document.body).hasClass("sapUiSizeCompact");
 
-										oSampleFrameCore.applyTheme(this.bUseUnifiedResourceOrigin ? this._sDefaultSampleTheme : this._oCore.getConfiguration().getTheme());
+										oSampleFrameCore.applyTheme(ResourcesUtil.getHasProxy() ? this._sDefaultSampleTheme : this._oCore.getConfiguration().getTheme());
 										oSampleFrameCore.getConfiguration().setRTL(this._oCore.getConfiguration().getRTL());
 										oSampleFrame.jQuery('body')
 											.toggleClass("sapUiSizeCompact", bCompact)
@@ -397,7 +389,8 @@ sap.ui.define([
 			},
 
 			setDefaultSampleTheme: function() {
-				this._sDefaultSampleTheme = (this._sSampleVersion && parseInt(this._sSampleVersion.slice(3,5)) < 68) ?
+				var sSampleVersion = ResourcesUtil.getResourcesVersion();
+				this._sDefaultSampleTheme = sSampleVersion && parseInt(sSampleVersion.slice(3,5)) < 68 ?
 					"sap_belize" : sap.ui.getCore().getConfiguration().getTheme();
 			},
 
@@ -481,25 +474,30 @@ sap.ui.define([
 
 			onToggleAdaptationMode : function (oEvt) {
 				sap.ui.require([
-					"sap/ui/rta/RuntimeAuthoring"
+					"sap/ui/rta/api/startKeyUserAdaptation"
 				], function (
-					RuntimeAuthoring
+					startKeyUserAdaptation
 				) {
 					if (!this._oRTA) {
-						// default developerMode for CUSTOMER-layer is 'true'
-						this._oRTA = new RuntimeAuthoring({
-							rootControl : this.byId("page").getContent()[0],
-							flexSettings: {
-								developerMode: false
-							}
-						});
-						this._oRTA.attachStop(function () {
-							this._oRTA.destroy();
-							delete this._oRTA;
+						startKeyUserAdaptation({
+							rootControl : this.byId("page").getContent()[0].getComponentInstance()
+						}).then(function(oRta) {
+							this._oRTA = oRta;
+							this._oRTA.attachStop(function () {
+								this._oRTA.destroy();
+								delete this._oRTA;
+							}.bind(this));
 						}.bind(this));
-						this._oRTA.start();
 					}
 				}.bind(this));
+			},
+
+			onRouteNotFound: function() {
+				var sNotFoundTitle = this.getModel("i18n").getProperty("NOT_FOUND_SAMPLE_TITLE");
+
+				this.getRouter().myNavToWithoutHash("sap.ui.documentation.sdk.view.SampleNotFound", "XML", false);
+				setTimeout(this.appendPageTitle.bind(this, sNotFoundTitle));
+				return;
 			}
 		});
 	}

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

@@ -8,8 +8,10 @@ sap.ui.define([
 	"sap/ui/documentation/sdk/controller/BaseController",
 	"sap/ui/thirdparty/URI",
 	"sap/base/Log",
-	"sap/ui/documentation/sdk/controller/util/ResourceDownloadUtil"
-], function (BaseController, URI, Log, ResourceDownloadUtil) {
+	"sap/ui/documentation/sdk/controller/util/ResourceDownloadUtil",
+	"sap/ui/documentation/sdk/util/Resources"
+
+], function (BaseController, URI, Log, ResourceDownloadUtil, ResourcesUtil) {
 	"use strict";
 
 		var TMPL_REF = sap.ui.require.toUrl("sap/ui/documentation/sdk/tmpl"),
@@ -40,7 +42,7 @@ sap.ui.define([
 				"sap/ui/core/util/File"
 			], function (JSZip, File) {
 				var oZipFile = new JSZip(),
-					sRef = sap.ui.require.toUrl((this._sId).replace(/\./g, "/")),
+					sRef = ResourcesUtil.getResourceOriginPath(sap.ui.require.toUrl((this._sId).replace(/\./g, "/"))),
 					oData = this.oModel.getData(),
 					aExtraFiles = oData.includeInDownload || [],
 					oManifestFile,
@@ -88,7 +90,7 @@ sap.ui.define([
 				}
 
 				// iframe examples have a separate index file and a component file to describe it
-				if (!oData.iframe) {
+				if (!oData.iframe || ResourcesUtil.getHasProxy()) {
 					bHasManifest = oData.files.some(function (oFile) {
 						return oFile.name === "manifest.json";
 					});

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

@@ -0,0 +1,14 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2021 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define([
+	"./BaseController"
+], function (BaseController) {
+	"use strict";
+
+	return BaseController.extend("sap.ui.documentation.sdk.controller.SampleNotFound", {
+	});
+});

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

@@ -154,7 +154,7 @@ sap.ui.define([
 						}
 						this._sHljsDelayedCallID = setTimeout(function () {
 							//The event is called even if all the sub-sections are un-stashed so apply the class and highlights only when we have un-processed targets.
-							var $aNotApplied = jQuery('.sapUxAPObjectPageContainer .APIDetailMethodsSection pre:not(.hljs)', this._objectPage.$());
+							var $aNotApplied = this._objectPage.$().find("pre:not(.hljs)");
 							if ($aNotApplied.length > 0 && window.hljs) {
 								$aNotApplied.addClass('hljs');
 								document.querySelectorAll('pre').forEach(function(block) {

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

@@ -283,7 +283,7 @@ sap.ui.define([
 					sTopicId = aUrlParts[0],
 					sSubTopicId = aUrlParts[1];
 
-				this.sTopicId = sTopicId;
+				this.sTopicId = sTopicId.replace(".html", "");
 				this.sSubTopicId = sSubTopicId;
 				this.sTopicURL = ResourcesUtil.getResourceOriginPath(this._oConfig.docuPath + sTopicId + (sTopicId.match(/\.html/) ? "" : ".html"));
 				this.sSubTopicId = event.getParameter("arguments").subId || sSubTopicId;

package/src/sap/ui/documentation/sdk/controller/util/ConfigUtil.js

@@ -21,6 +21,10 @@ sap.ui.define([
 			"DEMOKIT_IMPORTANT_MESSAGES_READ": "IMR"
 		},
 
+		"LOCAL_STORAGE_NAMES": {
+			"OLD_NEWS_IDS": "dk_old_news_ids"
+		},
+
 		constructor : function (oComponent) {
 			this._oComponent = oComponent;
 		},
@@ -68,6 +72,18 @@ sap.ui.define([
 			return "";
 		},
 
+		setLocalStorageItem: function (sItem, vValue) {
+			window.localStorage.setItem(sItem, JSON.stringify(vValue));
+		},
+
+		getLocalStorageItem: function (sItem) {
+			return JSON.parse(window.localStorage.getItem(sItem));
+		},
+
+		removeLocalStorageItem: function (sItem) {
+			window.localStorage.removeItem(sItem);
+		},
+
 		_getMasterTargetName: function(sRouteName) {
 			var oRouteConfig = this._getRouteConfig(sRouteName),
 				bIsSplitView = oRouteConfig && oRouteConfig.target.length === 2,