@openui5/sap.ui.fl 1.104.0 → 1.105.0

package/.reuse/dep5

@@ -159,7 +159,7 @@ Copyright:
 License: Apache-2.0 and MIT
 Comment: these files contain content from SAP and jQuery.rtl-scroll-type: _FeatureDetection.js is overall written by SAP, but contains code which is inspired by jQuery.rtl-scroll-type
 
-Files: src/sap.ui.core/src/sap/ui/thirdparty/qunit-composite*
+Files: src/sap.ui.core/src/sap/ui/thirdparty/qunit-composite.*
 Copyright: jQuery Foundation and other contributors
 License: MIT
 Comment: these files belong to: QUnit Composite

package/THIRDPARTY.txt

@@ -104,7 +104,7 @@ Component: QUnit Composite, version: 1.0.2-pre
 Copyright: jQuery Foundation and other contributors
 License: MIT
 License Text: https://github.com/SAP/openui5/blob/master/LICENSES/MIT.txt
-Contained in: src/sap.ui.core/src/sap/ui/thirdparty/qunit-composite*
+Contained in: src/sap.ui.core/src/sap/ui/thirdparty/qunit-composite.*
 
 Component: JUnit Reporter for QUnit, version: 1.1.1
 Copyright: jQuery Foundation and other contributors

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openui5/sap.ui.fl",
-  "version": "1.104.0",
+  "version": "1.105.0",
   "description": "OpenUI5 UI Library sap.ui.fl",
   "author": "SAP SE (https://www.sap.com)",
   "license": "Apache-2.0",
@@ -14,7 +14,7 @@
     "url": "https://github.com/SAP/openui5.git"
   },
   "dependencies": {
-    "@openui5/sap.m": "1.104.0",
-    "@openui5/sap.ui.core": "1.104.0"
+    "@openui5/sap.m": "1.105.0",
+    "@openui5/sap.ui.core": "1.105.0"
   }
 }

package/src/sap/ui/fl/.library

@@ -6,7 +6,7 @@
   <copyright>OpenUI5
  * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.</copyright>
-  <version>1.104.0</version>
+  <version>1.105.0</version>
 
   <documentation>SAPUI5 library with sap.ui.fl controls.</documentation>
 

package/src/sap/ui/fl/Cache.js

@@ -24,7 +24,7 @@ function(
 	 * @alias sap.ui.fl.Cache
 	 * @experimental Since 1.25.0
 	 * @author SAP SE
-	 * @version 1.104.0
+	 * @version 1.105.0
 	 *
 	 * @private
 	 * @ui5-restricted sap.ui.fl
@@ -37,7 +37,7 @@ function(
 		if (oChange.fileType === "variant") {
 			return mStorageResponse.comp.variants;
 		}
-		if (oChange.selector.persistencyKey) {
+		if (oChange.selector && oChange.selector.persistencyKey) {
 			return mStorageResponse.comp.changes;
 		}
 		return mStorageResponse.changes;
@@ -103,7 +103,7 @@ function(
 	 * @return {Promise} Returns the promise resolved with the determined cache key
 	 *
 	 * @private
-	 * @restricted sap.ui.fl
+	 * @ui5-restricted sap.ui.fl
 	 *
 	 */
 	Cache.getCacheKey = function(mComponent, oAppComponent) {

package/src/sap/ui/fl/Change.js

@@ -149,7 +149,7 @@ sap.ui.define([
 
 	Change.prototype.isValidForDependencyMap = function() {
 		//Change without id in selector should be skipped from adding dependencies process
-		return this._oDefinition.selector && this._oDefinition.selector.id;
+		return this.getSelector() && this.getSelector().id;
 	};
 
 	Change.prototype.startApplying = function() {
@@ -525,26 +525,46 @@ sap.ui.define([
 	};
 
 	/**
-	 * Sets the new text for the given text ID.
+	 * Sets the new text for the given text ID or creates new text with the given ID.
 	 *
 	 * @param {string} sTextId - Text ID which was used as part of the <code>oTexts</code> object
 	 * @param {string} sNewText - New text for the given text ID
+	 * @param {string} sType - Translation text type
 	 *
 	 * @public
 	 */
-	Change.prototype.setText = function (sTextId, sNewText) {
+	Change.prototype.setText = function (sTextId, sNewText, sType) {
 		if (typeof (sTextId) !== "string") {
 			Log.error("sap.ui.fl.Change.setTexts : sTextId is not defined");
 			return;
 		}
+		this._oDefinition.texts = this._oDefinition.texts || {};
 		if (this._oDefinition.texts) {
 			if (this._oDefinition.texts[sTextId]) {
 				this._oDefinition.texts[sTextId].value = sNewText;
-				this.setState(Change.states.DIRTY);
+			} else {
+				this._oDefinition.texts[sTextId] = {
+					value: sNewText,
+					type: sType
+				};
 			}
+			this.setState(Change.states.DIRTY);
 		}
 	};
 
+	/**
+	 * Returns the OData Information of the change.
+	 * oDataInformation.propertyName - Name of the OData property
+	 * oDataInformation.entityType - Name of the OData entity type that the property belongs to
+	 * oDataInformation.oDataServiceUri - URI of the OData service
+	 * @returns {object} OData Information of the change - propertyName, entityType and oDataServiceUri
+	 *
+	 * @function
+	 */
+	Change.prototype.getODataInformation = function () {
+		return this._oDefinition.oDataInformation;
+	};
+
 	/**
 	 * Checks if change is read only because of its source system.
 	 * @returns {boolean} <code>true</code> if the change is from another system
@@ -672,6 +692,11 @@ sap.ui.define([
 		return this._oDefinition;
 	};
 
+	// temporary function
+	Change.prototype.convertToFileContent = function() {
+		return this.getDefinition();
+	};
+
 	/**
 	 * Sets the response from the back end after the change is saved.
 	 * @param {object} oResponse - Content of the change file

package/src/sap/ui/fl/ChangePersistence.js

@@ -14,6 +14,8 @@ sap.ui.define([
 	"sap/ui/core/Component",
 	"sap/ui/fl/apply/_internal/changes/Applier",
 	"sap/ui/fl/apply/_internal/changes/Utils",
+	"sap/ui/fl/apply/_internal/flexObjects/FlexObject",
+	"sap/ui/fl/apply/_internal/flexObjects/FlexObjectFactory",
 	"sap/ui/fl/apply/_internal/flexState/changes/DependencyHandler",
 	"sap/ui/fl/apply/_internal/flexState/controlVariants/VariantManagementState",
 	"sap/ui/fl/apply/_internal/flexState/FlexState",
@@ -27,7 +29,6 @@ sap.ui.define([
 	"sap/ui/fl/LayerUtils",
 	"sap/ui/fl/Layer",
 	"sap/ui/fl/Utils",
-	"sap/ui/fl/Variant",
 	"sap/ui/model/json/JSONModel",
 	"sap/ui/performance/Measurement"
 ], function(
@@ -40,6 +41,8 @@ sap.ui.define([
 	Component,
 	Applier,
 	ChangesUtils,
+	FlexObject,
+	FlexObjectFactory,
 	DependencyHandler,
 	VariantManagementState,
 	FlexState,
@@ -53,7 +56,6 @@ sap.ui.define([
 	LayerUtils,
 	Layer,
 	Utils,
-	Variant,
 	JSONModel,
 	Measurement
 ) {
@@ -64,7 +66,7 @@ sap.ui.define([
 	 *
 	 * @constructor
 	 * @author SAP SE
-	 * @version 1.104.0
+	 * @version 1.105.0
 	 * @experimental Since 1.25.0
 	 * @param {object} mComponent - Component data to initiate <code>ChangePersistence</code> instance
 	 * @param {string} mComponent.name - Name of the component this instance is responsible for
@@ -92,12 +94,16 @@ sap.ui.define([
 
 	function getChangeInstance(oFileContent, oChangeOrChangeContent) {
 		var oChange;
-		if (oChangeOrChangeContent instanceof Change) {
+		if (oChangeOrChangeContent instanceof Change || oChangeOrChangeContent instanceof FlexObject) {
 			oChange = oChangeOrChangeContent; // can have other states
 			this._mChangesEntries[oChange.getFileName()] = oChange;
 		} else {
 			if (!this._mChangesEntries[oChangeOrChangeContent.fileName]) {
-				this._mChangesEntries[oChangeOrChangeContent.fileName] = new Change(oChangeOrChangeContent);
+				if (oChangeOrChangeContent.changeType === "codeExt") {
+					this._mChangesEntries[oChangeOrChangeContent.fileName] = FlexObjectFactory.createFromFileContent(oChangeOrChangeContent);
+				} else {
+					this._mChangesEntries[oChangeOrChangeContent.fileName] = new Change(oChangeOrChangeContent);
+				}
 			}
 			oChange = this._mChangesEntries[oChangeOrChangeContent.fileName];
 			oChange.setState(Change.states.PERSISTED);
@@ -122,7 +128,7 @@ sap.ui.define([
 	 * @param {object} oAppComponent - Application component
 	 * @returns {Promise} Returns a promise with an ETag for caching
 	 * @private
-	 * @restricted sap.ui.fl
+	 * @ui5-restricted sap.ui.fl
 	 */
 	ChangePersistence.prototype.getCacheKey = function(oAppComponent) {
 		return Cache.getCacheKey(this._mComponent, oAppComponent);
@@ -240,7 +246,10 @@ sap.ui.define([
 
 	function getLayerFromChangeOrChangeContent(oChangeOrChangeContent) {
 		var sChangeLayer;
-		if (oChangeOrChangeContent instanceof Variant || oChangeOrChangeContent instanceof Change) {
+		if (
+			typeof oChangeOrChangeContent.isA === "function"
+			&& (oChangeOrChangeContent.isA("sap.ui.fl.apply._internal.flexObjects.FlVariant") || oChangeOrChangeContent.isA("sap.ui.fl.Change"))
+		) {
 			sChangeLayer = oChangeOrChangeContent.getLayer();
 		} else {
 			sChangeLayer = oChangeOrChangeContent.layer;
@@ -487,7 +496,7 @@ sap.ui.define([
 	ChangePersistence.prototype.addChange = function(vChange, oAppComponent) {
 		var oChange = this.addDirtyChange(vChange);
 		this._addRunTimeCreatedChangeAndUpdateDependencies(oAppComponent, oChange);
-		this._mChangesEntries[oChange.getFileName()] = oChange;
+		this._mChangesEntries[oChange.getId()] = oChange;
 		this._addPropagationListener(oAppComponent);
 		return oChange;
 	};
@@ -501,7 +510,10 @@ sap.ui.define([
 	 */
 	ChangePersistence.prototype.addDirtyChange = function(vChange) {
 		var oNewChange;
-		if (vChange instanceof Change || vChange instanceof Variant) {
+		if (
+			typeof vChange.isA === "function"
+			&& (vChange.isA("sap.ui.fl.Change") || vChange.isA("sap.ui.fl.apply._internal.flexObjects.FlexObject"))
+		) {
 			oNewChange = vChange;
 		} else {
 			oNewChange = new Change(vChange);
@@ -650,7 +662,7 @@ sap.ui.define([
 			}
 			return oCondensedChangesPromise.then(function(aCondensedChanges) {
 				var sRequest = aRequests[0];
-				var sLayer = aDirtyChanges[0].getDefinition().layer;
+				var sLayer = aDirtyChanges[0].getLayer();
 				if (bIsCondensingEnabled) {
 					return Storage.condense({
 						allChanges: aAllChanges,
@@ -756,14 +768,14 @@ sap.ui.define([
 				switch (oDirtyChange.getState()) {
 					case Change.states.NEW:
 						oDirtyChange.setState(Change.states.PERSISTED);
-						Cache.addChange(this._mComponent, oDirtyChange.getDefinition());
+						Cache.addChange(this._mComponent, oDirtyChange.convertToFileContent());
 						break;
 					case Change.states.DELETED:
-						Cache.deleteChange(this._mComponent, oDirtyChange.getDefinition());
+						Cache.deleteChange(this._mComponent, oDirtyChange.convertToFileContent());
 						break;
 					case Change.states.DIRTY:
 						oDirtyChange.setState(Change.states.PERSISTED);
-						Cache.updateChange(this._mComponent, oDirtyChange.getDefinition());
+						Cache.updateChange(this._mComponent, oDirtyChange.convertToFileContent());
 						break;
 				}
 			}
@@ -811,7 +823,7 @@ sap.ui.define([
 		var aChanges = [];
 
 		aDirtyChanges.forEach(function(oChange) {
-			aChanges.push(oChange.getDefinition());
+			aChanges.push(oChange.convertToFileContent());
 		});
 
 		return aChanges;

package/src/sap/ui/fl/ChangePersistenceFactory.js

@@ -30,7 +30,7 @@ sap.ui.define([
 	 * @alias sap.ui.fl.ChangePersistenceFactory
 	 * @experimental Since 1.27.0
 	 * @author SAP SE
-	 * @version 1.104.0
+	 * @version 1.105.0
 	 * @private
 	 * @ui5-restricted sap.ui.fl
 	 */

package/src/sap/ui/fl/FakeLrepConnector.js

@@ -27,6 +27,12 @@ sap.ui.define([
 	 * Hooks into the {@link sap.ui.fl.LrepConnector.createConnector} factory function to enable the fake LRep connector.
 	 * After enabling fake LRep connector, function {@link sap.ui.fl.FakeLrepConnector.disableFakeConnector} must be called to restore the original connector.
 	 *
+	 * @private
+	 * @ui5-restricted
+	 * @deprecated since 1.70. Configure the <code>sap.ui.core.Configuration.flexibilityServices</code> to use a test connector
+	 * like <code>["LocalStorageConnector"]</code>, <code>["SessionStorageConnector"]</code> or <code>["JsObjectConnector"]</code>.
+	 * @see {@link https://ui5.sap.com/#/topic/642dab291a7b47ec9d46c39b3c482aba|Boostrapping UI5 Flexibility}
+	 *
 	 * @param {string} sInitialComponentJsonPath Relative path to a test-component-changes.json file
 	 */
 	FakeLrepConnector.enableFakeConnector = function(sInitialComponentJsonPath) {

package/src/sap/ui/fl/FakeLrepConnectorLocalStorage.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.
  */
@@ -20,11 +20,17 @@ function(
 	 * @namespace
 	 *
 	 * @author SAP SE
-	 * @version 1.104.0
+	 * @version 1.105.0
 	 *
 	 * @private
 	 * @since 1.48
 	 * @alias sap.ui.fl.FakeLrepConnectorLocalStorage
+	 *
+	 * @private
+	 * @ui5-restricted
+	 * @deprecated since 1.70. Configure the <code>sap.ui.core.Configuration.flexibilityServices</code> to use a test connector
+	 * like <code>["LocalStorageConnector"]</code>, <code>["SessionStorageConnector"]</code> or <code>["JsObjectConnector"]</code>.
+	 * @see {@link https://ui5.sap.com/#/topic/642dab291a7b47ec9d46c39b3c482aba|Boostrapping UI5 Flexibility}
 	 */
 
 	return {

package/src/sap/ui/fl/FakeLrepConnectorSessionStorage.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.
  */
@@ -20,11 +20,17 @@ function(
 	 * @namespace
 	 *
 	 * @author SAP SE
-	 * @version 1.104.0
+	 * @version 1.105.0
 	 *
 	 * @private
 	 * @since 1.58
 	 * @alias sap.ui.fl.FakeLrepConnectorSessionStorage
+	 *
+	 * @private
+	 * @ui5-restricted
+	 * @deprecated since 1.70. Configure the <code>sap.ui.core.Configuration.flexibilityServices</code> to use a test connector
+	 * like <code>["LocalStorageConnector"]</code>, <code>["SessionStorageConnector"]</code> or <code>["JsObjectConnector"]</code>.
+	 * @see {@link https://ui5.sap.com/#/topic/642dab291a7b47ec9d46c39b3c482aba|Boostrapping UI5 Flexibility}
 	 */
 
 	return {

package/src/sap/ui/fl/FakeLrepLocalStorage.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.
  */
@@ -17,11 +17,17 @@ sap.ui.define([
 	 * @namespace
 	 *
 	 * @author SAP SE
-	 * @version 1.104.0
+	 * @version 1.105.0
 	 *
 	 * @private
 	 * @since 1.48
 	 * @alias sap.ui.fl.FakeLrepLocalStorage
+	 *
+	 * @private
+	 * @ui5-restricted
+	 * @deprecated since 1.70. Configure the <code>sap.ui.core.Configuration.flexibilityServices</code> to use a test connector
+	 * like <code>["LocalStorageConnector"]</code>, <code>["SessionStorageConnector"]</code> or <code>["JsObjectConnector"]</code>.
+	 * @see {@link https://ui5.sap.com/#/topic/642dab291a7b47ec9d46c39b3c482aba|Boostrapping UI5 Flexibility}
 	 */
 
 	"use strict";

package/src/sap/ui/fl/FlexController.js

@@ -86,7 +86,7 @@ sap.ui.define([
 	 * @alias sap.ui.fl.FlexController
 	 * @experimental Since 1.27.0
 	 * @author SAP SE
-	 * @version 1.104.0
+	 * @version 1.105.0
 	 */
 	var FlexController = function(sComponentName) {
 		this._oChangePersistence = undefined;
@@ -175,6 +175,8 @@ sap.ui.define([
 				throw new Error("Change handler could not be retrieved for change " + JSON.stringify(oChangeSpecificData) + ".");
 			})
 			.then(function () {
+				// completeChangeContent changes the content and might make it dirty
+				oChange.setState(Change.states.NEW);
 				return oChange;
 			})
 			.catch(function(oError) {

package/src/sap/ui/fl/FlexControllerFactory.js

@@ -32,7 +32,7 @@ sap.ui.define([
 	 * @alias sap.ui.fl.FlexControllerFactory
 	 * @experimental Since 1.27.0
 	 * @author SAP SE
-	 * @version 1.104.0
+	 * @version 1.105.0
 	 *
 	 * @private
 	 * @ui5-restricted sap.ui.fl

package/src/sap/ui/fl/Layer.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.
  */
@@ -10,6 +10,9 @@ sap.ui.define([], function () {
 	/**
 	 * Available layers
 	 *
+	 * @alias sap.ui.fl.Layer
+	 * @private
+	 * @ui5-restricted sap.ui.fl, sap.ui.rta, UX Tools, SAPUI5 Visual Editor
 	 * @enum {string}
 	 */
 	return {

package/src/sap/ui/fl/LayerUtils.js

@@ -41,7 +41,7 @@ sap.ui.define([
 	 *
 	 * @namespace sap.ui.fl.LayerUtils
 	 * @author SAP SE
-	 * @version 1.104.0
+	 * @version 1.105.0
 	 */
 	var LayerUtils = {
 		_mLayersIndex: mLayersIndex,