@openui5/sap.ui.documentation 1.96.2 → 1.97.0

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

@@ -8,6 +8,7 @@ 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",
@@ -36,6 +37,7 @@ sap.ui.define([
 	KeyCodes,
 	jQuery,
 	BaseController,
+	NewsInfo,
 	SearchUtil,
 	Controller,
 	Filter,
@@ -129,7 +131,8 @@ sap.ui.define([
 					aResultArr.push({
 						"groupTitle": sCurrGroupTitle,
 						"version": sCurrGroupTitle + " (" + iCounter + " versions)",
-						"nodes": aNodes
+						"nodes": aNodes,
+						"path": aNodes[0].path
 					});
 				}
 
@@ -194,6 +197,9 @@ sap.ui.define([
 
 				}.bind(this));
 
+				this._oNewsModel = new JSONModel();
+				this.setModel(this._oNewsModel, "news");
+
 				// Cache view reference
 				this._oSupportedLangModel = new JSONModel();
 
@@ -213,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));
@@ -232,6 +242,7 @@ sap.ui.define([
 				}, this);
 
 				this.bus = Core.getEventBus();
+				this.bus.subscribe("newsChanged", "onDemoKitNewsChanged", this._syncNewsModelWithNewsInfo, this);
 
 				this._createConfigurationBasedOnURIInput();
 
@@ -288,6 +299,8 @@ sap.ui.define([
 				jQuery(document.body).addClass(this.getOwnerComponent().getContentDensityClass());
 
 				Device.orientation.attachHandler(this._onOrientationChange, this);
+
+				this._syncNewsModelWithNewsInfo();
 			},
 
 			onExit: function() {
@@ -379,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];

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/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,

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

@@ -0,0 +1,188 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2021 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+// Provides reuse functionality for reading news from news RSS files
+sap.ui.define([
+		"sap/ui/core/Core",
+		"sap/ui/thirdparty/jquery",
+		"sap/ui/documentation/sdk/util/Resources",
+		"sap/base/Log"
+	],
+	function(Core, jQuery, ResourcesUtil, Log) {
+		"use strict";
+
+		var _oNewsDataCache = {},
+			_aNewNews = [],
+			_aOldNews = [],
+			_sPreparationFailureMessage = null,
+			_bInitiallySplit = false,
+			_sOldNewsLocalStorageKey = 'OLD_NEWS_IDS',
+			_sLocalStorageNewsName,
+			_oConfigUtilInstance;
+
+		function prepareNewsData(oConfigUtilInstance) {
+
+			if (_oNewsDataCache["newsRSS"]) {
+				return Promise.resolve(_oNewsDataCache["newsRSS"]);
+			}
+
+			_oConfigUtilInstance = oConfigUtilInstance;
+			_sLocalStorageNewsName = _oConfigUtilInstance.LOCAL_STORAGE_NAMES[_sOldNewsLocalStorageKey];
+
+			return _requireConfigJSON()
+					.then(_requireFeedXML)
+					.then(_parseDateToLocaleString)
+					.then(_splitNewAndOldItems)
+					.catch(function (vReason) {
+						_sPreparationFailureMessage = vReason.message;
+						Log.error(_sPreparationFailureMessage);
+					})
+					.finally(_publishNewsChangedEvent);
+		}
+
+		function _splitNewAndOldItems() {
+
+			if (_bInitiallySplit) {
+				return Promise.resolve();
+			}
+
+			var aLocalStorageCachedIDs = _oConfigUtilInstance.getLocalStorageItem(_sLocalStorageNewsName);
+
+			return new Promise(function (resolve) {
+
+				var aItems = _oNewsDataCache["newsRSS"].items,
+					oCurrItem;
+
+				if (Array.isArray(aLocalStorageCachedIDs)) {
+					for (var i = 0; i < aItems.length; i++) {
+						oCurrItem = aItems[i];
+						if (aLocalStorageCachedIDs.indexOf(oCurrItem.id) !== -1) {
+							_aOldNews.push(oCurrItem);
+						} else {
+							_aNewNews.push(oCurrItem);
+						}
+					}
+				} else {
+					_aNewNews = aItems.slice();
+				}
+				_bInitiallySplit = true;
+				resolve();
+			});
+		}
+
+		function getPreparationFailureMessage() {
+			return _sPreparationFailureMessage;
+		}
+
+		function getNewNewsArray() {
+			return _aNewNews;
+		}
+
+		function getOldNewsArray() {
+			return _aOldNews;
+		}
+
+		function moveNewItemToOld(oItem) {
+			var iIndexInNewArr = _aNewNews.indexOf(oItem),
+				aLocalStorageIDs = _oConfigUtilInstance.getLocalStorageItem(_sLocalStorageNewsName) || [];
+
+			if (iIndexInNewArr > -1) {
+				_aNewNews.splice(iIndexInNewArr, 1);
+			}
+
+			_aOldNews.push(oItem);
+			aLocalStorageIDs.push(oItem.id);
+
+			_oConfigUtilInstance.setLocalStorageItem(_sLocalStorageNewsName, aLocalStorageIDs);
+			_publishNewsChangedEvent();
+		}
+
+		function moveAllNewItemsToOld() {
+			var aLocalStorageIDs = _oConfigUtilInstance.getLocalStorageItem(_sLocalStorageNewsName) || [],
+				oCurrItem;
+
+			for (var i = 0; i < _aNewNews.length; i++) {
+				oCurrItem = _aNewNews[i];
+				_aOldNews.push(oCurrItem);
+				aLocalStorageIDs.push(oCurrItem.id);
+			}
+
+			_aNewNews = [];
+			_oConfigUtilInstance.setLocalStorageItem(_sLocalStorageNewsName, aLocalStorageIDs);
+
+			_publishNewsChangedEvent();
+		}
+
+		function _parseDateToLocaleString() {
+			var aItems = _oNewsDataCache["newsRSS"].items;
+
+			aItems.forEach(function(oItem) {
+				oItem.updated = new Date(oItem.updated).toLocaleString();
+			});
+		}
+
+		function _publishNewsChangedEvent() {
+			Core.getEventBus().publish("newsChanged", "onDemoKitNewsChanged");
+		}
+
+		function _requireConfigJSON() {
+			return new Promise(function (resolve) {
+				jQuery.ajax(ResourcesUtil.getResourceOriginPath("/news-config.json"), {
+						type: "GET",
+						dataType: "JSON",
+					success : function(oResult) {
+						resolve(oResult);
+					},
+					error : function () {
+						Log.error("failed to load news-config.json");
+						resolve();
+					}
+				});
+			});
+		}
+
+		function _requireFeedXML(oJSON) {
+			return new Promise(function (resolve) {
+				jQuery.ajax(ResourcesUtil.getResourceOriginPath(oJSON.feedPath), {
+						type: "GET",
+						dataType: "xml",
+					success : function(oResult) {
+
+						var items = [];
+						jQuery('item', oResult).each( function() {
+							var item = {};
+							item.title = jQuery(this).find('title').eq(0).text();
+							item.link = jQuery(this).find('link').eq(0).text();
+							item.description = jQuery(this).find('description').eq(0).text();
+							item.updated = jQuery(this).find('pubDate').eq(0).text();
+							item.id = jQuery(this).find('guid').eq(0).text();
+							items.push(item);
+						});
+
+						_oNewsDataCache["newsRSS"] = {"items" : items};
+						resolve(
+							_oNewsDataCache["newsRSS"]
+						);
+					},
+					error : function () {
+						Log.error("failed to load news rss");
+						_oNewsDataCache["newsRSS"] = null;
+						resolve();
+					}
+				});
+			});
+		}
+
+		return {
+			moveAllNewItemsToOld: moveAllNewItemsToOld,
+			moveNewItemToOld: moveNewItemToOld,
+			prepareNewsData: prepareNewsData,
+			getPreparationFailureMessage: getPreparationFailureMessage,
+			getNewNewsArray: getNewNewsArray,
+			getOldNewsArray: getOldNewsArray
+		};
+
+	});

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

@@ -12,7 +12,8 @@ sap.ui.define([],
 		var aTools = [
 			{
 				"id": "uiThemeDesigner",
-				"text": "UI Theme Designer"
+				"text": "UI Theme Designer",
+				"href": "https://www.sap.com/community/topics/ui-theme-designer.html"
 			},
 			{
 				"id": "businessApplicationStudio",
@@ -63,6 +64,11 @@ sap.ui.define([],
 				"id": "fioriTools",
 				"text": "SAP Fiori Tools",
 				"href": "https://help.sap.com/viewer/product/SAP_FIORI_tools/Latest/en-US"
+			},
+			{
+				"id": "flexibleProgrammingModelExplorer",
+				"text": "Flexible Programming Model Explorer",
+				"href": "https://sapui5.hana.ondemand.com/test-resources/sap/fe/core/fpmExplorer/index.html#/overview/introduction"
 			}
 		];
 

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

@@ -11,6 +11,22 @@
 	vertical-align: bottom;
 }
 
+.newsButton.sapMBtn .sapMBadgeTopRight.sapMBadge .sapMBadgeIndicator {
+	position: absolute;
+	top: 0;
+	right: 0;
+	padding: 0;
+}
+
+.sapUiSizeCompact .newsButton.sapMBtn .sapMBadgeTopRight.sapMBadge .sapMBadgeIndicator {
+	top: -0.25rem;
+	right: -0.125rem;
+}
+
+.sapUiDemokitCustomNLI.sapMNLI {
+	cursor: default;
+}
+
 .aboutDialog .sapMMsgStrip .sapMFT {
     word-break: break-word;
 }
@@ -1089,6 +1105,21 @@ html:not(.sapUiTheme-sap_belize_hcw):not(.sapUiTheme-sap_belize_hcb):not(.sapUiT
 	}
 }
 
+.sapUiDemokit .videoWrapper {
+	position: relative;
+	padding-bottom: 56.25%;
+	height: 0;
+}
+
+.sapUiDemokit .videoWrapper iframe {
+	position: absolute;
+	top: 0;
+	left: 0;
+	width: 100%;
+	height: 100%;
+	border: none;
+}
+
 /* ==========================================================================
    Documentation Page Header styles
   ========================================================================== */

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

@@ -297,6 +297,13 @@
 						"tools"
 					]
 				},
+				{
+					"pattern": "news",
+					"name": "news",
+					"target": [
+						"news"
+					]
+				},
 				{
 					"pattern": "search/{searchParam}:?options:",
 					"name": "search",
@@ -422,6 +429,11 @@
 					"viewLevel": 2,
 					"viewId": "tools"
 				},
+				"news": {
+					"viewName": "News",
+					"viewLevel": 2,
+					"viewId": "news"
+				},
 				"apiDetailInitial": {
 					"viewName": "ApiDetailInitial",
 					"viewId": "apiDetailInitial",

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

@@ -97,6 +97,24 @@
 							</layoutData>
 						</Button>
 
+						<Button
+							visible="{=!${news>/newsPreparationFailureMessage}}"
+							id="notificationsButton"
+							tooltip="{i18n>APP_NEWS_BTN_TOOLTIP}"
+							press="handleNewsPress"
+							icon="sap-icon://bell"
+							type="Transparent"
+							class="newsButton">
+							<customData>
+								<BadgeCustomData
+									key="badge"
+									value="{news>/newsCount}"/>
+							</customData>
+							<layoutData>
+								<OverflowToolbarLayoutData priority="NeverOverflow" />
+							</layoutData>
+						</Button>
+
 						<MenuButton tooltip="{i18n>APP_INFORMATION_BTN_TOOLTIP}" id="aboutMenuButton" icon="sap-icon://action-settings" type="Transparent" visible="{=!${appView>/bSearchMode}}">
 							<layoutData>
 								<OverflowToolbarLayoutData priority="NeverOverflow" />

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

@@ -47,8 +47,7 @@
 					}]
 				}">
 			<StandardTreeItem
-					title="{path: 'version'}{= ${path: 'version'} === ${versionData>/latestVersion} ? ' (Latest)' : ''}"
-					type="{= ${path: 'path'} ? 'Active' : 'Inactive'}">
+					title="{path: 'version'}{= ${path: 'version'} === ${versionData>/latestVersion} ? ' (Latest)' : ''}">
 				<customData>
 					<core:CustomData key="path" value="{path: 'path'}" />
 				</customData>

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

@@ -0,0 +1,68 @@
+<mvc:View controllerName="sap.ui.documentation.sdk.controller.News"
+		xmlns:mvc="sap.ui.core.mvc"
+		xmlns="sap.m"
+		xmlns:l="sap.ui.layout"
+		xmlns:core="sap.ui.core">
+
+	<MessagePage
+		visible="{=!!${/preparationFailureMessage}}"
+		text="{i18n>NEWS_PREP_FAILURE_TITLE}"
+		description="{/preparationFailureMessage}"
+		showHeader="false"
+		icon="sap-icon://message-warning"/>
+	<VBox visible="{=!${/preparationFailureMessage}}">
+		<NotificationList>
+
+			<NotificationListGroup
+				items="{path:  '/new', templateShareable: false}"
+				title="{i18n>NEWS_NEW_GROUP_TITLE}"
+				showCloseButton="false">
+
+				<buttons>
+					<Button text="{i18n>NEWS_BTN_MARK_AS_READ}" press="handleMarkAsRead" />
+				</buttons>
+
+				<NotificationListItem
+					title="{title}"
+					description="{description}"
+					datetime="{updated}"
+					close="handleNewsItemClose"
+					class="sapUiDemokitCustomNLI">
+					<buttons>
+						<Button visible="{= %{link} !== ''}" text="{i18n>NEWS_BTN_VISIT_LINK}" press="handleVisitLink">
+							<customData>
+								<core:CustomData key="newsLink" value="{link}"/>
+							</customData>
+						</Button>
+					</buttons>
+					<customData>
+						<core:CustomData key="newsID" value="{id}"/>
+					</customData>
+				</NotificationListItem>
+
+			</NotificationListGroup>
+
+			<NotificationListGroup
+				items="{path:  '/old', templateShareable: false}"
+				title="{i18n>NEWS_READ_GROUP_TITLE}"
+				showCloseButton="false">
+
+				<NotificationListItem
+					title="{title}"
+					description="{description}"
+					datetime="{updated}"
+					showCloseButton="false"
+					class="sapUiDemokitCustomNLI">
+					<buttons>
+						<Button visible="{= %{link} !== ''}" text="{i18n>NEWS_BTN_VISIT_LINK}" press="handleVisitLink">
+							<customData>
+								<core:CustomData key="newsLink" value="{link}"/>
+							</customData>
+						</Button>
+					</buttons>
+				</NotificationListItem>
+
+			</NotificationListGroup>
+		</NotificationList>
+	</VBox>
+</mvc:View>

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

@@ -0,0 +1,51 @@
+<core:FragmentDefinition
+	xmlns="sap.m"
+	xmlns:core="sap.ui.core">
+	<ResponsivePopover
+		id="myPopover"
+		placement="Bottom"
+		title="{i18n>APP_NEWS_BTN_TOOLTIP}">
+			<beginButton>
+				<Button
+					id="dismissAllNotifications"
+					text="{i18n>APP_NEWS_DISMISS_ALL_BTN}"
+					press="handleDismissAllPress"
+					enabled="{= %{news>/newsCount} > 0}" />
+			</beginButton>
+			<endButton>
+				<Button
+					id="showAllNotifications"
+					text="{i18n>APP_NEWS_SHOW_ALL_BTN}"
+					press="handleShowAllPress" />
+			</endButton>
+		<VBox>
+		<NotificationList
+			noDataText="{i18n>APP_NEWS_NO_NEW_TEXT}"
+			items="{path:  'news>/items', templateShareable: false}"
+			>
+			<layoutData>
+				<FlexItemData maxHeight="450px" />
+			</layoutData>
+
+			<NotificationListItem
+				title="{news>title}"
+				description="{news>description}"
+				datetime="{news>updated}"
+				close="handleNewsItemClose"
+				class="sapUiDemokitCustomNLI">
+				<buttons>
+					<Button visible="{= %{news>link} !== ''}" text="{i18n>NEWS_BTN_VISIT_LINK}" press="handleVisitNewsLink">
+						<customData>
+							<core:CustomData key="newsLink" value="{news>link}"/>
+						</customData>
+					</Button>
+				</buttons>
+				<customData>
+					<core:CustomData key="newsID" value="{news>id}"/>
+				</customData>
+			</NotificationListItem>
+
+		</NotificationList>
+	</VBox>
+	</ResponsivePopover>
+</core:FragmentDefinition>