@openui5/sap.ui.fl 1.100.0 → 1.102.1

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

@@ -8,24 +8,19 @@ sap.ui.define([
 	"sap/ui/fl/apply/_internal/flexState/FlexState",
 	"sap/ui/fl/write/_internal/Versions",
 	"sap/ui/fl/Utils",
+	"sap/ui/fl/write/api/Version",
 	"sap/ui/fl/apply/_internal/flexState/ManifestUtils"
 ], function(
 	FlexState,
 	Versions,
 	Utils,
+	Version,
 	ManifestUtils
 ) {
 	"use strict";
 
-	function getReference(oAppComponent) {
-		var sReference;
-		if (oAppComponent) {
-			var oManifest = oAppComponent.getManifest();
-			sReference = ManifestUtils.getFlexReference({
-				manifest: oManifest,
-				componentData: oAppComponent.getComponentData()
-			});
-		}
+	function getFlexReferenceForControl(control) {
+		var sReference = ManifestUtils.getFlexReferenceForControl(control);
 
 		if (!sReference) {
 			throw Error("The application ID could not be determined");
@@ -35,16 +30,18 @@ sap.ui.define([
 	}
 
 	function getVersionsModel(mPropertyBag) {
-		if (!mPropertyBag.selector) {
-			throw Error("No selector was provided");
+		if (!mPropertyBag.control) {
+			throw Error("No control was provided");
 		}
 		if (!mPropertyBag.layer) {
 			throw Error("No layer was provided");
 		}
 
-		var oAppComponent = Utils.getAppComponentForControl(mPropertyBag.selector);
+		var sReference = getFlexReferenceForControl(mPropertyBag.control);
+
 		return Versions.getVersionsModel({
-			reference: Utils.normalizeReference(getReference(oAppComponent)),
+			nonNormalizedReference: sReference,
+			reference: Utils.normalizeReference(sReference),
 			layer: mPropertyBag.layer
 		});
 	}
@@ -61,27 +58,27 @@ sap.ui.define([
 	var VersionsAPI = /** @lends sap.ui.fl.write.api.VersionsAPI */ {};
 
 	/**
-	 * Initializes the versions for a given selector and layer.
+	 * Initializes the versions for a given control and layer.
 	 *
 	 * @param {object} mPropertyBag - Property bag
-	 * @param {sap.ui.fl.Selector} mPropertyBag.selector - Selector for which the request is done
+	 * @param {sap.ui.core.Control} mPropertyBag.control - Control for which the request is done
 	 * @param {string} mPropertyBag.layer - Layer for which the versions should be retrieved
 	 *
 	 * @returns {Promise<sap.ui.model.json.JSONModel>} Model with list of versions if available and further version properties;
 	 * Rejects if not all parameters were passed or the application could not be determined
 	 */
 	VersionsAPI.initialize = function (mPropertyBag) {
-		if (!mPropertyBag.selector) {
-			return Promise.reject("No selector was provided");
+		if (!mPropertyBag.control) {
+			return Promise.reject("No control was provided");
 		}
 		if (!mPropertyBag.layer) {
 			return Promise.reject("No layer was provided");
 		}
 
-		var oAppComponent = Utils.getAppComponentForControl(mPropertyBag.selector);
+		var oAppComponent = Utils.getAppComponentForControl(mPropertyBag.control);
 
 		return Versions.initialize({
-			reference: Utils.normalizeReference(getReference(oAppComponent)),
+			reference: Utils.normalizeReference(getFlexReferenceForControl(oAppComponent)),
 			layer: mPropertyBag.layer
 		});
 	};
@@ -90,7 +87,7 @@ sap.ui.define([
 	 * Returns a flag if a draft exists for the current application and layer.
 	 *
 	 * @param {object} mPropertyBag - Property bag
-	 * @param {sap.ui.fl.Selector} mPropertyBag.selector - Selector for which the request is done
+	 * @param {sap.ui.core.Control} mPropertyBag.control - Control for which the request is done
 	 * @param {string} mPropertyBag.layer - Layer for which the versions should be retrieved
 	 *
 	 * @return {boolean} Flag if a draft is available;
@@ -101,7 +98,7 @@ sap.ui.define([
 
 		var aVersions = oModel.getProperty("/versions");
 		var oDraft = aVersions.find(function (oVersion) {
-			return oVersion.version === sap.ui.fl.Versions.Draft;
+			return oVersion.version === Version.Number.Draft;
 		});
 
 		return !!oDraft;
@@ -111,7 +108,7 @@ sap.ui.define([
 	 * Returns a flag if the displayed version is not the active version for the current application and layer.
 	 *
 	 * @param {object} mPropertyBag - Property bag
-	 * @param {sap.ui.fl.Selector} mPropertyBag.selector - Selector for which the request is done
+	 * @param {sap.ui.core.Control} mPropertyBag.control - Control for which the request is done
 	 * @param {string} mPropertyBag.layer - Layer for which the versions should be retrieved
 	 *
 	 * @return {boolean} Flag if the displayed version is not the active version
@@ -123,7 +120,7 @@ sap.ui.define([
 		var displayedVersion = oModel.getProperty("/displayedVersion");
 		var activeVersion = oModel.getProperty("/activeVersion");
 
-		return displayedVersion !== sap.ui.fl.Versions.Draft && displayedVersion !== activeVersion;
+		return displayedVersion !== Version.Number.Draft && displayedVersion !== activeVersion;
 	};
 
 	/**
@@ -131,13 +128,13 @@ sap.ui.define([
 	 * an actual reload of the application has to be triggered by the caller.
 	 *
 	 * @param {object} mPropertyBag - Property bag
-	 * @param {sap.ui.fl.Selector} mPropertyBag.selector - Selector for which the request is done
+	 * @param {sap.ui.core.Control} mPropertyBag.control - Control for which the request is done
 	 * @param {string} mPropertyBag.layer - Layer for which the versions should be retrieved
 	 *
 	 * @returns {Promise} Resolves as soon as the clearance and the requesting is triggered.
 	 */
 	VersionsAPI.loadDraftForApplication = function (mPropertyBag) {
-		mPropertyBag.version = sap.ui.fl.Versions.Draft;
+		mPropertyBag.version = Version.Number.Draft;
 		return VersionsAPI.loadVersionForApplication(mPropertyBag);
 	};
 
@@ -146,7 +143,7 @@ sap.ui.define([
 	 * an actual reload of the application has to be triggered by the caller.
 	 *
 	 * @param {object} mPropertyBag - Property bag
-	 * @param {sap.ui.fl.Selector} mPropertyBag.selector - Selector for which the request is done
+	 * @param {sap.ui.core.Control} mPropertyBag.control - Control for which the request is done
 	 * @param {string} mPropertyBag.layer - Layer for which the versions should be retrieved
 	 * @param {string} [mPropertyBag.version] - Version to be loaded
 	 * @param {boolean} [mPropertyBag.allContexts] - Includes also restricted contexts
@@ -154,8 +151,8 @@ sap.ui.define([
 	 * @returns {Promise} Resolves as soon as the clearance and the requesting is triggered.
 	 */
 	VersionsAPI.loadVersionForApplication = function (mPropertyBag) {
-		if (!mPropertyBag.selector) {
-			return Promise.reject("No selector was provided");
+		if (!mPropertyBag.control) {
+			return Promise.reject("No control was provided");
 		}
 		if (!mPropertyBag.layer) {
 			return Promise.reject("No layer was provided");
@@ -167,16 +164,13 @@ sap.ui.define([
 			}
 		}
 
-		var oAppComponent = Utils.getAppComponentForControl(mPropertyBag.selector);
-		return Promise.resolve()
-		.then(getReference.bind(undefined, oAppComponent))
-		.then(function (sReference) {
-			return FlexState.clearAndInitialize({
-				componentId: oAppComponent.getId(),
-				reference: sReference,
-				version: mPropertyBag.version,
-				allContexts: mPropertyBag.allContexts
-			});
+		var oAppComponent = Utils.getAppComponentForControl(mPropertyBag.control);
+		var sReference = getFlexReferenceForControl(oAppComponent);
+		return FlexState.clearAndInitialize({
+			componentId: oAppComponent.getId(),
+			reference: sReference,
+			version: mPropertyBag.version,
+			allContexts: mPropertyBag.allContexts
 		});
 	};
 
@@ -184,7 +178,7 @@ sap.ui.define([
 	 * (Re-)activates a version.
 	 *
 	 * @param {object} mPropertyBag - Property bag
-	 * @param {sap.ui.fl.Selector} mPropertyBag.selector - Selector for which the request is done
+	 * @param {sap.ui.core.Control} mPropertyBag.control - Control for which the request is done
 	 * @param {string} mPropertyBag.layer - Layer for which the versions should be retrieved
 	 * @param {string} mPropertyBag.title - Title of the to be activated version
 	 *
@@ -192,12 +186,12 @@ sap.ui.define([
 	 *
 	 * @returns {Promise<sap.ui.fl.Version>} Promise resolving with the updated list of versions for the application
 	 * when the version was activated;
-	 * rejects if an error occurs, the layer does not support draft handling, there is no draft to activate or
+	 * rejects if an error occurs, the layer does not support draft handling, there is unsaved content, there is no draft to activate or
 	 * when the displayed version is already active
 	 */
 	VersionsAPI.activate = function (mPropertyBag) {
-		if (!mPropertyBag.selector) {
-			return Promise.reject("No selector was provided");
+		if (!mPropertyBag.control) {
+			return Promise.reject("No control was provided");
 		}
 		if (!mPropertyBag.layer) {
 			return Promise.reject("No layer was provided");
@@ -206,18 +200,14 @@ sap.ui.define([
 			return Promise.reject("No version title was provided");
 		}
 
-		var oAppComponent = Utils.getAppComponentForControl(mPropertyBag.selector);
+		var sReference = getFlexReferenceForControl(mPropertyBag.control);
 
-		return Promise.resolve()
-		.then(getReference.bind(undefined, oAppComponent))
-		.then(function (sReference) {
-			return Versions.activate({
-				nonNormalizedReference: sReference,
-				reference: Utils.normalizeReference(sReference),
-				layer: mPropertyBag.layer,
-				title: mPropertyBag.title,
-				appComponent: oAppComponent
-			});
+		return Versions.activate({
+			nonNormalizedReference: sReference,
+			reference: Utils.normalizeReference(sReference),
+			layer: mPropertyBag.layer,
+			title: mPropertyBag.title,
+			appComponent: Utils.getAppComponentForControl(mPropertyBag.control)
 		});
 	};
 
@@ -227,40 +217,66 @@ sap.ui.define([
 	 * and the consumer must take care of making a reload of the application itself.
 	 *
 	 * @param {object} mPropertyBag - Property bag
-	 * @param {sap.ui.fl.Selector} mPropertyBag.selector - Selector for which the request is done
+	 * @param {sap.ui.core.Control} mPropertyBag.control - Control for which the request is done
 	 * @param {string} mPropertyBag.layer - Layer for which the versions should be retrieved
 	 * @returns {Promise<boolean>} Promise resolving with a flag if a discarding took place;
 	 * rejects if an error occurs or the layer does not support draft handling
 	 */
 	VersionsAPI.discardDraft = function (mPropertyBag) {
-		if (!mPropertyBag.selector) {
-			return Promise.reject("No selector was provided");
+		if (!mPropertyBag.control) {
+			return Promise.reject("No control was provided");
 		}
 		if (!mPropertyBag.layer) {
 			return Promise.reject("No layer was provided");
 		}
 
-		var oAppComponent = Utils.getAppComponentForControl(mPropertyBag.selector);
+		var oAppComponent = Utils.getAppComponentForControl(mPropertyBag.control);
+		var sReference = getFlexReferenceForControl(oAppComponent);
 
-		return Promise.resolve()
-		.then(getReference.bind(undefined, oAppComponent))
-		.then(function (sReference) {
-			return Versions.discardDraft({
-				nonNormalizedReference: sReference,
-				reference: Utils.normalizeReference(sReference),
-				layer: mPropertyBag.layer
-			}).then(function(oDiscardInfo) {
-				if (oDiscardInfo.backendChangesDiscarded) {
-					//invalidate flexState to trigger getFlexData for the current active version after discard
-					FlexState.clearAndInitialize({
-						componentId: oAppComponent.getId(),
-						reference: sReference
-					});
-				}
-				return oDiscardInfo;
-			});
+		return Versions.discardDraft({
+			nonNormalizedReference: sReference,
+			reference: Utils.normalizeReference(sReference),
+			layer: mPropertyBag.layer
+		}).then(function(oDiscardInfo) {
+			if (oDiscardInfo.backendChangesDiscarded) {
+				//invalidate flexState to trigger getFlexData for the current active version after discard
+				FlexState.clearAndInitialize({
+					componentId: oAppComponent.getId(),
+					reference: sReference
+				});
+			}
+			return oDiscardInfo;
 		});
 	};
 
+	/**
+	 * Publish a version.
+	 *
+	 * @param {object} mPropertyBag - Property bag
+	 * @param {sap.ui.fl.Selector} mPropertyBag.selector - To retrieve the associated flex persistence
+	 * @param {string} [mPropertyBag.styleClass] - Style class name that will be added to the transport dialog
+	 * @param {string} mPropertyBag.layer - Working layer
+	 * @param {string} mPropertyBag.version - ID of version which need to be published
+	 * @returns {Promise<string>} Promise that can resolve to the following strings:
+	 * - "Cancel" if publish process was canceled
+	 * - <sMessage> when all the version is successfully transported fl will return the message to show
+	 * - "Error" in case of a problem
+	 */
+	VersionsAPI.publish = function (mPropertyBag) {
+		if (!mPropertyBag.selector) {
+			return Promise.reject("No selector was provided");
+		}
+		if (!mPropertyBag.layer) {
+			return Promise.reject("No layer was provided");
+		}
+		if (!mPropertyBag.version) {
+			return Promise.reject("No version was provided");
+		}
+		mPropertyBag.styleClass = mPropertyBag.styleClass || "";
+		mPropertyBag.reference = getFlexReferenceForControl(mPropertyBag.selector);
+
+		return Versions.publish(mPropertyBag);
+	};
+
 	return VersionsAPI;
 });