@openui5/sap.ui.rta 1.128.0 → 1.130.0

package/src/sap/ui/rta/util/whatsNew/WhatsNewOverviewDialog.fragment.xml

@@ -0,0 +1,75 @@
+<core:FragmentDefinition
+	xmlns:core="sap.ui.core"
+	xmlns="sap.m"
+	xmlns:grid="sap.ui.layout.cssgrid"
+	xmlns:f="sap.f"
+	xmlns:util="sap.ui.fl.util">
+	<Dialog
+		id="sapUiRtaWhatsNewOverviewDialog"
+		title="What's New in Key User Adaptation"
+		contentWidth="50rem"
+		contentHeight="33rem"
+		horizontalScrolling="false">
+		<List id="whatsNewOverview" items="{path: 'whatsNewModel>/featureCollection'}" visible="{whatsNewModel>overviewActive}">
+			<StandardListItem description="{whatsNewModel>description}" title="{whatsNewModel>title}" press=".onSelectListItem" type="Active"/>
+		</List>
+		<VBox  id="whatsNewItemPage" visible="{= ${whatsNewModel>overviewActive} === false}">
+			<VBox height="100%" width="100%" >
+				<Title text="{whatsNewModel>title}" class="sapUiMediumMarginTop sapUiLargeMarginBegin sapUiTinyMarginBottom" level="H3"/>
+				<VBox class="sapUiSmallMargin sapUiLargeMarginBegin sapUiLargeMarginEnd" >
+					<VBox height="100%" width="100%" items="{whatsNewModel>information}">
+						<HBox alignItems="Center" class=" sapUiSmallMarginBottom ">
+								<FormattedText
+									visible="{= (${whatsNewModel>image} === null ? true : false) &amp;&amp; (${whatsNewModel>text} !== null ? true : false)}"
+									htmlText="{whatsNewModel>text}"
+									class="sapUiMediumMarginEnd"/>
+								<Image
+									src= "{whatsNewModel>image}"
+									visible="{= (${whatsNewModel>image} !== null ? true : false) &amp;&amp; (${whatsNewModel>text} === null ? true : false)}"
+									class=" sapUiMediumMarginEnd whatsNewImage"
+									width="100%"
+									/>
+								<grid:CSSGrid
+									visible="{= (${whatsNewModel>image} !== null ? true : false) &amp;&amp; (${whatsNewModel>text} !== null ? true : false)}"
+									gridTemplateColumns="2fr 3fr"
+									gridGap="1rem">
+									<Image
+										src= "{whatsNewModel>image}"
+										decorative="true"
+										densityAware="false"
+										class=" sapUiMediumMarginEnd whatsNewImage"
+										width="100%"
+										/>
+									<HBox alignItems="Center">
+										<FormattedText htmlText="{whatsNewModel>text}"/>
+									</HBox>
+							</grid:CSSGrid>
+						</HBox>
+					</VBox>
+				</VBox>
+			</VBox>
+		</VBox>
+		<footer>
+			<Toolbar>
+				<content>
+					<ToolbarSpacer />
+					<Button
+						id="sapUiRtaWhatsNewOverviewDialog_LearnMore"
+						visible="{= ${whatsNewModel>overviewActive} === false}"
+						text="{i18n>BTN_LEARN_MORE_WHATS_NEW_DIALOG}"
+						press=".onLearnMorePress"/>
+					<Button
+						id="sapUiRtaWhatsNewOverviewDialog_ButtonClose"
+						visible="{whatsNewModel>overviewActive}"
+						text="{i18n>BTN_CLOSE_FEEDBACK_DIALOG}"
+						press=".closeWhatsNewOverviewDialog"/>
+					<Button
+						id="sapUiRtaWhatsNewOverviewDialog_ButtonBack"
+						visible="{= ${whatsNewModel>overviewActive} === false}"
+						text="{i18n>BTN_BACK_WHATS_NEW_OVERVIEW_DIALOG}"
+						press=".backToOverview"/>
+				</content>
+			</Toolbar>
+		</footer>
+	</Dialog>
+</core:FragmentDefinition>

package/src/sap/ui/rta/util/whatsNew/WhatsNewUtils.js

@@ -0,0 +1,73 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2024 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define([
+	"sap/ui/fl/registry/Settings",
+	"sap/ui/rta/util/whatsNew/whatsNewContent/WhatsNewFeatures"
+], function(
+	Settings,
+	WhatsNewFeatures
+) {
+	"use strict";
+
+	function filterDontShowAgainFeatures(aFeatures, aDontShowAgainFeatureIds) {
+		return aFeatures.filter((oFeature) => {
+			return !aDontShowAgainFeatureIds?.includes(oFeature.featureId);
+		});
+	}
+
+	async function filterApplicableFeatures(aFeatures, sLayer) {
+		const aAreFeaturesApplicable = await Promise.all(
+			aFeatures.map((oFeature) => {
+				if (typeof oFeature.isFeatureApplicable === "function") {
+					return oFeature.isFeatureApplicable(sLayer);
+				}
+				return true;
+			})
+		);
+
+		const aFilteredFeatures = aFeatures.filter((oFeature, iIndex) => {
+			return aAreFeaturesApplicable[iIndex];
+		});
+
+		return aFilteredFeatures;
+	}
+
+	const WhatsNewUtils = {
+		/**
+		 * Get the URL for the feature documentation
+		 * @param {string} sPath - The path of the feature, including the index
+		 * @param {Array} aFeatureCollection - Feature collection
+		 * @returns {string} URL for the feature documentation
+		 */
+		getLearnMoreURL(sPath, aFeatureCollection) {
+			const sFeaturePageIndex = sPath.slice(-1);
+			const oSettings = Settings.getInstanceOrUndef();
+			if (oSettings?.isAtoEnabled() && oSettings?.getSystem()) {
+				return aFeatureCollection[sFeaturePageIndex].documentationUrls.s4HanaCloudUrl;
+			}
+			if (!oSettings?.isAtoEnabled() && oSettings?.getSystem()) {
+				return aFeatureCollection[sFeaturePageIndex].documentationUrls.s4HanaOnPremUrl;
+			}
+			return aFeatureCollection[sFeaturePageIndex].documentationUrls.btpUrl;
+		},
+
+		/**
+		 * Filters the new features based on the dontShowAgain feature IDs and the Flex settings
+		 * @param {string[]} aDontShowAgainFeatureIds - Array of feature IDs that should be excluded
+		 * from the What's New dialog
+		 * @param {string} sLayer - Layer for which the features should be filtered
+		 * @returns {object[]} Filtered What's New features
+		 */
+		getFilteredFeatures(aDontShowAgainFeatureIds, sLayer) {
+			const aAllFeatures = WhatsNewFeatures.getAllFeatures();
+			const aNewFeatures = filterDontShowAgainFeatures(aAllFeatures, aDontShowAgainFeatureIds);
+			return filterApplicableFeatures(aNewFeatures, sLayer);
+		}
+	};
+
+	return WhatsNewUtils;
+});

package/src/sap/ui/rta/util/whatsNew/whatsNewContent/WhatsNewFeatures.js

@@ -0,0 +1,138 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2024 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define([
+	"sap/ui/core/Lib"
+], function(
+	Lib
+) {
+	"use strict";
+
+	const WhatsNewFeatures = {};
+
+	const oTextResources = Lib.getResourceBundleFor("sap.ui.rta");
+
+	function getImagePath(sFileName) {
+		const _sAppModulePath = "sap/ui/rta/util/";
+		return `${sap.ui.require.toUrl(_sAppModulePath)}whatsNew/whatsNewContent/whatsNewImages/${sFileName}`;
+	}
+
+	/**
+	 * Callback filter function to determine if the feature should be displayed in the dialog
+	 * @typedef {function} sap.ui.rta.util.whatsNew.whatsNewContent.WhatsNewFeatures.isFeatureApplicable
+	 * @param {sap.ui.fl.registry.Settings} oFlexSettings - Flex settings
+	 * @returns {boolean} <code>false</code> if the feature shouldn't be displayed in the dialog
+	 */
+
+	/**
+	 * The `aWhatsNewFeaturesContent` array defines the features that will be displayed inside the "What's New" dialog.
+	 * To add a new feature, add a new object to this array. Each feature object should have the following structure:
+	 *
+	 *	{
+	 *		featureId: <Unique identifier for the feature, saved in the backend>,
+	 *		title: <Title of the new feature>,
+	 *		description: <Description of the new feature>,
+	 *		documentationUrls: {
+	 *			btpUrl: <Url to the btp documentation of the feature>
+	 *			s4HanaCloudUrl: <Url to the s4HanaCloud documentation of the feature>
+	 *			s4HanaOnPremUrl: <Url to the ABAP on-Premise documentation of the feature>
+	 *		}
+	 *		information: [
+	 *		to display content inside the dialog there are three options:
+	 *		option 1: text and image to the left
+	 *		{
+	 *			text: <Text description of the feature>,
+	 *			image: <URL or path to an image representing the feature>
+	 *		}
+	 *		option 2: text only
+	 *		{
+	 *			text: <Text description of the feature>,
+	 *			image: null (the null is mandatory for spacing to work properly)
+	 *		}
+	 *		option 3: image only
+	 *		{
+	 *			text: null (the null is mandatory for spacing to work properly),
+	 *			image: <URL or path to an image representing the feature>
+	 *		}]
+	 *		isFeatureApplicable: <Filter function that returns a boolean value to determine
+	 * 			if the feature should be displayed in the dialog> (optional)
+	 *  		<code>{@link sap.ui.rta.util.whatsNew.whatsNewContent.WhatsNewFeatures.isFeatureApplicable isFeatureApplicable}</code>
+	 * 	}
+	 *
+	 */
+	const aWhatsNewFeaturesContent =
+	[
+		{
+			featureId: "WhatsNewFeature",
+			title: oTextResources.getText("TIT_WHATS_NEW_DIALOG_WHATS_NEW_FEATURE_TITLE"),
+			description: oTextResources.getText("TXT_WHATS_NEW_DIALOG_WHATS_NEW_FEATURE_DESCRIPTION"),
+			documentationUrls: {
+				btpUrl: "https://help.sap.com/docs/ui5-flexibility-for-key-users/ui5-flexibility-for-key-users/adapting-ui",
+				s4HanaCloudUrl: "https://help.sap.com/docs/SAP_S4HANA_CLOUD/4fc8d03390c342da8a60f8ee387bca1a/d868950a1e8c4b0f9b9453176939a19b.html",
+				s4HanaOnPremUrl: "https://help.sap.com/docs/ABAP_PLATFORM_NEW/a7b390faab1140c087b8926571e942b7/d868950a1e8c4b0f9b9453176939a19b.html"
+			},
+			information: [
+				{
+					text: oTextResources.getText("TXT_WHATS_NEW_DIALOG_WHATS_NEW_FEATURE_TEXT"),
+					image: null
+				},
+				{
+					text: oTextResources.getText("TXT_WHATS_NEW_DIALOG_WHATS_NEW_OVERVIEW_TEXT"),
+					image: getImagePath("WhatsNewOverview.png")
+				}
+			]
+		},
+		{
+			featureId: "IFrameSandboxProperties",
+			description: oTextResources.getText("TXT_WHATS_NEW_DIALOG_IFRAME_SANDBOX_DESCRIPTION"),
+			documentationUrls: {
+				btpUrl: "https://help.sap.com/docs/ui5-flexibility-for-key-users/ui5-flexibility-for-key-users/embedding-content",
+				s4HanaCloudUrl: "https://help.sap.com/docs/SAP_S4HANA_CLOUD/4fc8d03390c342da8a60f8ee387bca1a/8db25610e91342919fcf63d4e5868ae9.html",
+				s4HanaOnPremUrl: "https://help.sap.com/docs/ABAP_PLATFORM_NEW/a7b390faab1140c087b8926571e942b7/8db25610e91342919fcf63d4e5868ae9.html"
+			},
+			title: oTextResources.getText("TIT_WHATS_NEW_DIALOG_IFRAME_SANDBOX_TITLE"),
+			information: [
+				{
+					text: oTextResources.getText("TXT_WHATS_NEW_DIALOG_IFRAME_SANDBOX_TEXT"),
+					image: null
+				},
+				{
+					text: oTextResources.getText("TXT_WHATS_NEW_DIALOG_IFRAME_SANDBOX_TEXT_2"),
+					image: getImagePath("FullIframe.png")
+				},
+				{
+					text: oTextResources.getText("TXT_WHATS_NEW_DIALOG_IFRAME_SANDBOX_TEXT_3"),
+					image: getImagePath("AdvancedSettingsImage.png")
+				}
+			]
+		 },
+		 {
+			featureId: "MinimenuRemoval",
+			title: oTextResources.getText("TIT_WHATS_NEW_DIALOG_MINIMENU_REMOVAL_TITLE"),
+			description: oTextResources.getText("TXT_WHATS_NEW_DIALOG_MINIMENU_REMOVAL_DESCRIPTION"),
+			documentationUrls: {
+				btpUrl: "https://help.sap.com/docs/ui5-flexibility-for-key-users/ui5-flexibility-for-key-users/adapting-ui",
+				s4HanaCloudUrl: "https://help.sap.com/docs/SAP_S4HANA_CLOUD/4fc8d03390c342da8a60f8ee387bca1a/d868950a1e8c4b0f9b9453176939a19b.html",
+				s4HanaOnPremUrl: "https://help.sap.com/docs/ABAP_PLATFORM_NEW/a7b390faab1140c087b8926571e942b7/d868950a1e8c4b0f9b9453176939a19b.html"
+			},
+			information: [
+				{
+					text: oTextResources.getText("TXT_WHATS_NEW_DIALOG_MINIMENU_REMOVAL_TEXT"),
+					image: getImagePath("MiniMenu.png")
+				}
+			]
+		}
+	];
+
+	/**
+	 * @returns {object[]} All What's New features
+	 */
+	WhatsNewFeatures.getAllFeatures = function() {
+		return aWhatsNewFeaturesContent;
+	};
+
+	return WhatsNewFeatures;
+});