@openui5/sap.ui.fl 1.104.0 → 1.105.1

package/src/sap/ui/fl/write/api/PersistenceWriteAPI.js

@@ -1,5 +1,5 @@
-/*
- * ! OpenUI5
+/*!
+ * OpenUI5
  * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
@@ -16,12 +16,10 @@ sap.ui.define([
 	"sap/ui/fl/write/_internal/flexState/FlexObjectState",
 	"sap/ui/fl/write/_internal/Storage",
 	"sap/ui/fl/apply/_internal/flexState/ManifestUtils",
-	"sap/ui/fl/apply/_internal/flexState/controlVariants/VariantManagementState",
 	"sap/ui/fl/write/api/FeaturesAPI",
 	"sap/ui/fl/Layer",
 	"sap/ui/fl/LayerUtils",
-	"sap/ui/fl/registry/Settings",
-	"sap/ui/fl/Utils"
+	"sap/ui/fl/registry/Settings"
 ], function(
 	includes,
 	_omit,
@@ -34,12 +32,10 @@ sap.ui.define([
 	FlexObjectState,
 	Storage,
 	ManifestUtils,
-	VariantManagementState,
 	FeaturesAPI,
 	Layer,
 	LayerUtils,
-	Settings,
-	FlUtils
+	Settings
 ) {
 	"use strict";
 
@@ -84,37 +80,6 @@ sap.ui.define([
 			});
 	}
 
-	/**
-	 * Removes variant-dependent changes belonging to variants which are currently not selected
-	 *
-	 * @param {array} aChanges - List of changes to check
-	 * @param {sap.ui.fl.Control} oControl - Control for which the changes are being checked
-	 * @returns {sap.ui.fl.Change[]} List of variant-dependent changes belonging to the currently selected variants
-	 */
-	function filterChangesByCurrentVariants(aChanges, oControl) {
-		// 1. Get current variant references
-		var oComponent = FlUtils.getAppComponentForControl(oControl);
-		var oModel = oComponent.getModel(FlUtils.VARIANT_MODEL_NAME);
-		var sFlexReference = oModel && oModel.sFlexReference;
-		var aVariantManagementReferences = VariantManagementState.getVariantManagementReferences(sFlexReference);
-
-		if (aVariantManagementReferences.length === 0) {
-			return aChanges;
-		}
-
-		var aCurrentVariantReferences = aVariantManagementReferences.map(function(sVMReference) {
-			return oModel.getCurrentVariantReference(sVMReference);
-		});
-
-		// 2. Remove variant-dependent changes not assigned to a current variant reference
-		return aChanges.filter(function(oChange) {
-			return aCurrentVariantReferences.some(function(sCurrentVariantReference) {
-				return oChange.getVariantReference() === sCurrentVariantReference
-					|| !oChange.getVariantReference();
-			});
-		});
-	}
-
 	/**
 	 * Determines if user-specific changes or variants are present in the flex persistence.
 	 *
@@ -414,13 +379,7 @@ sap.ui.define([
 		}
 
 		//TODO: Check the mPropertyBag.selector parameter name - the methods called on FlexObjectState expect a control
-		return FlexObjectState.getFlexObjects(mPropertyBag)
-			.then(function(aChanges) {
-				if (mPropertyBag.onlyCurrentVariants) {
-					return filterChangesByCurrentVariants(aChanges, mPropertyBag.selector);
-				}
-				return aChanges;
-			});
+		return FlexObjectState.getFlexObjects(mPropertyBag);
 	};
 
 	return PersistenceWriteAPI;

package/src/sap/ui/fl/write/api/ReloadInfoAPI.js

@@ -1,5 +1,5 @@
-/*
- * ! OpenUI5
+/*!
+ * OpenUI5
  * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
@@ -9,20 +9,19 @@ sap.ui.define([
 	"sap/ui/fl/Layer",
 	"sap/ui/fl/Utils",
 	"sap/ui/fl/write/api/Version",
-	"sap/ui/fl/apply/_internal/flexState/ManifestUtils",
 	"sap/ui/fl/write/api/VersionsAPI",
 	"sap/ui/fl/write/api/FeaturesAPI",
 	"sap/ui/fl/write/api/PersistenceWriteAPI",
-	"sap/base/util/UriParameters"
+	"sap/ui/fl/write/_internal/FlexInfoSession"
 ], function(
 	LayerUtils,
 	Layer,
 	Utils,
 	Version,
-	ManifestUtils,
 	VersionsAPI,
 	FeaturesAPI,
-	PersistenceWriteAPI
+	PersistenceWriteAPI,
+	FlexInfoSession
 ) {
 	"use strict";
 
@@ -83,35 +82,44 @@ sap.ui.define([
 		});
 	}
 
-	function isAllContextsAvailable(oReloadInfo) {
-		var sContextsFromSession = getInfoContextsSession(oReloadInfo.selector);
-		if (sContextsFromSession !== null) {
-			return false; //already call flex/info and do not retrigger reload again
+	/**
+	 * Should reload happen when starting RTA due to allContextsProvided flag.
+	 * allContextsProvided determines if the user has provided all nessesary roles to see the views.
+	 * If allContextsProvided=false, that means that EndUser hasn't some specific roles to see the views,
+	 * so the reload should happen in order to provide all views for a KeyUser.
+	 *
+	 * @param {sap.ui.core.Control} oReloadInfo.selector - Root control instance
+	 * @return {boolean} true if allContextsProvided false and RTA wasn't started yet, otherwise false.
+	 */
+	function needContextSpecificReload(oReloadInfo) {
+		var oFlexInfoSession = FlexInfoSession.get(oReloadInfo.selector);
+		if (oFlexInfoSession && oFlexInfoSession.initialAllContexts) {
+			return false; // if we are already in RTA mode, no reload needed again
 		}
-		var mPropertyBag = {
-			selector: oReloadInfo.selector,
-			layer: oReloadInfo.layer
-		};
-		return PersistenceWriteAPI.getResetAndPublishInfo(mPropertyBag)
-			.then(function (oResult) {
-				setInfoSessionStorage(oResult, oReloadInfo.selector);
-				return !oResult.allContextsProvided;
-			});
+		if (oFlexInfoSession === null || oFlexInfoSession.allContextsProvided === undefined) {
+			var mPropertyBag = {
+				selector: oReloadInfo.selector,
+				layer: oReloadInfo.layer
+			};
+			return PersistenceWriteAPI.getResetAndPublishInfo(mPropertyBag)
+				.then(function (oResult) {
+					if (oFlexInfoSession === null || !oFlexInfoSession.initialAllContexts) {
+						oResult.initialAllContexts = true;
+					}
+					FlexInfoSession.set(oResult, oReloadInfo.selector);
+					return !oResult.allContextsProvided;
+				});
+		}
+		oFlexInfoSession.initialAllContexts = true;
+		FlexInfoSession.set(oFlexInfoSession, oReloadInfo.selector);
+		return !oFlexInfoSession.allContextsProvided;
 	}
 
-	function getInfoContextsSession(oControl) {
-		var sFlexReference = ManifestUtils.getFlexReferenceForControl(oControl);
-		var sParameter = sFlexReference || "true";
-		var oFlexInfoSession = JSON.parse(window.sessionStorage.getItem("sap.ui.fl.info." + sParameter));
+	function isAllContextsAvailable(oControl) {
+		var oFlexInfoSession = FlexInfoSession.get(oControl);
 		return oFlexInfoSession && !oFlexInfoSession.allContextsProvided;
 	}
 
-	function setInfoSessionStorage(oInfo, oControl) {
-		var sFlexReference = ManifestUtils.getFlexReferenceForControl(oControl);
-		var sParameter = sFlexReference || "true";
-		window.sessionStorage.setItem("sap.ui.fl.info." + sParameter, JSON.stringify(oInfo));
-	}
-
 	/**
 	 * Provides an API to get information about reload behavior in case of a draft and/or personalization changes.
 	 *
@@ -137,7 +145,7 @@ sap.ui.define([
 			return Promise.all([
 				areHigherLayerChangesAvailable.call(this, oReloadInfo),
 				isDraftAvailable(oReloadInfo),
-				isAllContextsAvailable(oReloadInfo)
+				needContextSpecificReload(oReloadInfo)
 			]).then(function(aReasons) {
 				oReloadInfo.hasHigherLayerChanges = aReasons[0];
 				oReloadInfo.isDraftAvailable = aReasons[1];
@@ -146,17 +154,6 @@ sap.ui.define([
 			});
 		},
 
-		/**
-		 * Remove flex info form session storage.
-		 *
-		 * @param {object} oControl - Root control instance
-		 */
-		removeInfoSessionStorage: function(oControl) {
-			var sFlexReference = ManifestUtils.getFlexReferenceForControl(oControl);
-			var sParameter = sFlexReference || "true";
-			window.sessionStorage.removeItem("sap.ui.fl.info." + sParameter);
-		},
-
 		/**
 		 * Checks if the the <code>sap-ui-fl-version</code> parameter name with the given value is contained in the URL.
 		 *
@@ -169,6 +166,15 @@ sap.ui.define([
 			return Utils.hasParameterAndValue(Version.UrlParameter, oParameter.value, oURLParsingService);
 		},
 
+		/**
+		 * Remove flex info form session storage.
+		 *
+		 * @param {object} oControl - Root control instance
+		 */
+		removeInfoSessionStorage: function(oControl) {
+			FlexInfoSession.remove(oControl);
+		},
+
 		/**
 		 * Checks if the the <code>sap-ui-fl-max-layer</code> parameter name with the given value is contained in the URL.
 		 *
@@ -311,7 +317,7 @@ sap.ui.define([
 			if (oReloadInfo.initialDraftGotActivated) {
 				oReloadInfo.isDraftAvailable = false;
 			}
-			oReloadInfo.allContexts = getInfoContextsSession(oReloadInfo.selector);
+			oReloadInfo.allContexts = isAllContextsAvailable(oReloadInfo.selector);
 			if (oReloadInfo.changesNeedReload
 				|| oReloadInfo.isDraftAvailable
 				|| oReloadInfo.hasHigherLayerChanges
@@ -325,7 +331,7 @@ sap.ui.define([
 					oReloadInfo.reloadMethod = oRELOAD.VIA_HASH;
 				}
 			}
-			this.removeInfoSessionStorage(oReloadInfo.selector);
+			FlexInfoSession.remove(oReloadInfo.selector);
 			return oReloadInfo;
 		}
 	};

package/src/sap/ui/fl/write/api/SmartBusinessWriteAPI.js

@@ -1,5 +1,5 @@
-/*
- * ! OpenUI5
+/*!
+ * OpenUI5
  * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */

package/src/sap/ui/fl/write/api/SmartVariantManagementWriteAPI.js

@@ -1,5 +1,5 @@
-/*
- * ! OpenUI5
+/*!
+ * OpenUI5
  * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */

package/src/sap/ui/fl/write/api/TranslationAPI.js

@@ -1,5 +1,5 @@
-/*
- * ! OpenUI5
+/*!
+ * OpenUI5
  * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */

package/src/sap/ui/fl/write/api/UI2PersonalizationWriteAPI.js

@@ -1,5 +1,5 @@
-/*
- * ! OpenUI5
+/*!
+ * OpenUI5
  * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */

package/src/sap/ui/fl/write/api/VersionsAPI.js

@@ -1,5 +1,5 @@
-/*
- * ! OpenUI5
+/*!
+ * OpenUI5
  * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */

package/src/sap/ui/fl/write/api/connectors/FileListBaseConnector.js

@@ -1,5 +1,5 @@
-/*
- * ! OpenUI5
+/*!
+ * OpenUI5
  * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
@@ -19,7 +19,8 @@ sap.ui.define([
 	 * The inherited objects must implement the function <code>getFileList</code>.
 	 * The <code>loadFlexData</code> already ensures that all <code>sap.ui.fl</code>-internals are handled accordingly.
 	 *
-	 * @public
+	 * @private
+	 * @ui5-restricted sap.ui.fl, SAPUI5 Visual Editor, UX Tools
 	 * @abstract
 	 */
 	return {

package/src/sap/ui/fl/write/api/connectors/ObjectStorageConnector.js

@@ -1,5 +1,5 @@
-/*
- * ! OpenUI5
+/*!
+ * OpenUI5
  * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
@@ -72,7 +72,8 @@ sap.ui.define([
 	 * @namespace sap.ui.fl.write.api.connectors.ObjectStorageConnector
 	 * @extends sap.ui.fl.write.connectors.BaseConnector
 	 * @since 1.84
-	 * @public
+	 * @private
+	 * @ui5-restricted sap.ui.fl, SAPUI5 Visual Editor, UX Tools
 	 * @abstract
 	 */
 	var ObjectStorageConnector = merge({}, BaseConnector, /** @lends sap.ui.fl.write.api.connectors.ObjectStorageConnector */ {

package/src/sap/ui/fl/write/connectors/BaseConnector.js

@@ -1,5 +1,5 @@
-/*
- * ! OpenUI5
+/*!
+ * OpenUI5
  * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
@@ -13,9 +13,9 @@ sap.ui.define([
 	 * Base class for connectors.
 	 *
 	 * @namespace sap.ui.fl.write.connectors.BaseConnector
-	 * @experimental Since 1.67
 	 * @since 1.67
-	 * @public
+	 * @private
+	 * @ui5-restricted sap.ui.fl
 	 */
 	var BaseConnector = /** @lends sap.ui.fl.write.connectors.BaseConnector */{