@openui5/sap.m 1.119.1 → 1.120.0

package/src/sap/m/upload/p13n/handlers/FilterStateChangeHandler.js

@@ -0,0 +1,65 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2023 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+/**
+ *
+ *
+ * State Change Handler for the filter related data based on flexibility
+ *
+ * @internal
+ * @private
+ *
+ */
+
+
+sap.ui.define([], function () {
+	"use strict";
+
+	const FilterStateChangeHandler = {};
+
+	FilterStateChangeHandler.createRevertData = function (oContent) {
+		const oRevertData = { targetAggregation: oContent.targetAggregation };
+		if (oContent.deleted) {
+			oRevertData.inserted = oContent.deleted.map((oEntry) => {
+				return {
+					key: oEntry.key,
+					index: oEntry.prevIndex,
+					path: oEntry.prevPath,
+					operator: oEntry.prevOperator,
+					value: oEntry.prevValue
+				};
+			});
+		}
+		if (oContent.moved) {
+			oRevertData.moved = oContent.moved.map((oEntry) => {
+				return {
+					key: oEntry.key,
+					index: oEntry.prevIndex,
+					prevIndex: oEntry.index,
+					path: oEntry.prevPath,
+					prevPath: oEntry.path,
+					operator: oEntry.prevOperator,
+					prevOperator: oEntry.operator,
+					value: oEntry.prevValue,
+					prevValue: oEntry.value
+				};
+			});
+		}
+		if (oContent.inserted) {
+			oRevertData.deleted = oContent.inserted.map((oEntry) => {
+				return {
+					key: oEntry.key,
+					prevIndex: oEntry.index,
+					prevPath: oEntry.path,
+					prevOperator: oEntry.operator,
+					prevValue: oEntry.value
+				};
+			});
+		}
+		return oRevertData;
+	};
+
+	return FilterStateChangeHandler;
+});

package/src/sap/m/upload/p13n/handlers/GroupConfigHandler.js

@@ -0,0 +1,57 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2023 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+/**
+ *
+ *
+ * Config handler for Grouping state
+ *
+ * @internal
+ * @private
+ *
+ */
+
+
+sap.ui.define(["sap/m/upload/p13n/handlers/BaseConfigHandler"], function (BaseConfigHandler) {
+	"use strict";
+
+	const GroupConfigHandler = BaseConfigHandler.extend("sap.m.upload.p13n.handlers.GroupConfigHandler", {});
+
+	const EVENT_NAME = "uploadSetTableGroupStateChange";
+
+	GroupConfigHandler.getEventName = function () {
+		return EVENT_NAME;
+	};
+
+	GroupConfigHandler.prototype.modifyState = function (oPayload, oExistingConfig) {
+		const oContent = oPayload.content,
+			sAggregation = oContent.targetAggregation,
+			oConfig = oExistingConfig || {};
+
+		oConfig.properties ??= {};
+		oConfig.properties[sAggregation] ??= {};
+
+		if (oContent.deleted) {
+			oContent.deleted.forEach((oEntry) => {
+				oConfig.properties[sAggregation][oEntry.key] = { key: oEntry.key, prevIndex: oEntry.prevIndex, grouped: false };
+			});
+		}
+		if (oContent.moved) {
+			oContent.moved.forEach((oEntry) => {
+				oConfig.properties[sAggregation][oEntry.key] = { key: oEntry.key, index: oEntry.index, grouped: true };
+			});
+		}
+		if (oContent.inserted) {
+			oContent.inserted.forEach((oEntry) => {
+				oConfig.properties[sAggregation][oEntry.key] = { key: oEntry.key, index: oEntry.index, grouped: true };
+			});
+		}
+
+		return oConfig;
+	};
+
+	return GroupConfigHandler;
+});

package/src/sap/m/upload/p13n/handlers/GroupStateChangeHandler.js

@@ -0,0 +1,46 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2023 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+/**
+ *
+ *
+ * State Change Handler for the grouping related data based on flexibility
+ *
+ * @internal
+ * @private
+ *
+ */
+
+sap.ui.define([], function () {
+	"use strict";
+
+	const GroupStateChangeHandler = {};
+
+	GroupStateChangeHandler.createRevertData = function (oContent) {
+		const oRevertData = { targetAggregation: oContent.targetAggregation };
+		if (oContent.deleted) {
+			oRevertData.inserted = oContent.deleted.map((oEntry) => {
+				return { key: oEntry.key, index: oEntry.prevIndex };
+			});
+		}
+		if (oContent.moved) {
+			oRevertData.moved = oContent.moved.map((oEntry) => {
+				return {
+					key: oEntry.key,
+					index: oEntry.prevIndex,
+					prevIndex: oEntry.index
+				};
+			});
+		}
+		if (oContent.inserted) {
+			oRevertData.deleted = oContent.inserted.map((oEntry) => {
+				return { key: oEntry.key, prevIndex: oEntry.index };
+			});
+		}
+		return oRevertData;
+	};
+
+	return GroupStateChangeHandler;
+});

package/src/sap/m/upload/p13n/handlers/SortConfigHandler.js

@@ -0,0 +1,57 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2023 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+/**
+ *
+ *
+ * Configuration handler for sorting state based on flex layer
+ *
+ * @internal
+ * @private
+ * @experimental
+ */
+
+
+sap.ui.define(["sap/m/upload/p13n/handlers/BaseConfigHandler"], function (BaseConfigHandler) {
+	"use strict";
+
+	const SortConfigHandler = BaseConfigHandler.extend("sap.m.upload.p13n.handlers.SortConfigHandler", {});
+
+	const EVENT_NAME = "uploadSetTableSortStateChange";
+
+	SortConfigHandler.getEventName = function () {
+		return EVENT_NAME;
+	};
+
+	SortConfigHandler.prototype.modifyState = function (oPayload, oExistingConfig) {
+		const oContent = oPayload.content,
+				sAggregation = oContent.targetAggregation,
+				oConfig = oExistingConfig || {};
+
+			oConfig.properties ??= {};
+			oConfig.properties[sAggregation] ??= {};
+
+			if (oContent.deleted) {
+				oContent.deleted.forEach((oEntry) => {
+					oConfig.properties[sAggregation][oEntry.key] = { key: oEntry.key, prevIndex: oEntry.prevIndex, prevDescending: oEntry.prevDescending, sorted: false };
+				});
+			}
+			if (oContent.moved) {
+				oContent.moved.forEach((oEntry) => {
+					oConfig.properties[sAggregation][oEntry.key] = { key: oEntry.key, index: oEntry.index, descending: oEntry.descending, sorted: true };
+				});
+			}
+			if (oContent.inserted) {
+				oContent.inserted.forEach((oEntry) => {
+					oConfig.properties[sAggregation][oEntry.key] = { key: oEntry.key, index: oEntry.index, descending: oEntry.descending, sorted: true };
+				});
+			}
+
+			return oConfig;
+	};
+
+	return SortConfigHandler;
+});

package/src/sap/m/upload/p13n/handlers/SortStateChangeHandler.js

@@ -0,0 +1,48 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2023 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+/**
+ *
+ *
+ * State Change Handler for the soritng related data based on flexibility
+ *
+ * @internal
+ * @private
+ *
+ */
+
+sap.ui.define([], function () {
+	"use strict";
+
+	const SortStateChangeHandler = {};
+
+	SortStateChangeHandler.createRevertData = function (oContent) {
+		const oRevertData = { targetAggregation: oContent.targetAggregation };
+		if (oContent.deleted) {
+			oRevertData.inserted = oContent.deleted.map((oEntry) => {
+				return { key: oEntry.key, index: oEntry.prevIndex, descending: oEntry.prevDescending };
+			});
+		}
+		if (oContent.moved) {
+			oRevertData.moved = oContent.moved.map((oEntry) => {
+				return {
+					key: oEntry.key,
+					index: oEntry.prevIndex,
+					prevIndex: oEntry.index,
+					descending: oEntry.prevDescending,
+					prevDescending: oEntry.descending
+				};
+			});
+		}
+		if (oContent.inserted) {
+			oRevertData.deleted = oContent.inserted.map((oEntry) => {
+				return { key: oEntry.key, prevIndex: oEntry.index, prevDescending: oEntry.descending };
+			});
+		}
+		return oRevertData;
+	};
+
+	return SortStateChangeHandler;
+});

package/src/sap/m/upload/p13n/mediator/BaseMediator.js

@@ -0,0 +1,183 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2023 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define(["sap/ui/base/Object", "sap/ui/core/mvc/XMLView"], function (BaseObject, View) {
+	"use strict";
+	/**
+	 * Constructor for a new <code>BaseMediator</code>.
+	 *
+	 *
+	 * @param {object} [mSettings] Initial settings for the new control
+     * @param {sap.ui.core.Control} mSettings.control The control instance that is personalized by this mediator
+     * @param {string} mSettings.targetAggregation The name of the aggregation that is now managed by this mediator
+     * @param {string} mSettings.p13nMetadataTarget The name of the personalization metadata target that is now managed by this mediator
+	 * @class
+	 * The <code>BaseMediator</code> entity serves as a base class to create control-specific personalization implementations.
+	 *
+	 * @extends sap.ui.base.Object
+	 *
+	 * @author SAP SE
+	 * @version 1.120.0
+	 *
+	 * @public
+	 * @experimental since 1.120
+	 * @since 1.120
+	 * @alias sap.m.upload.p13n.mediator.BaseMediator
+	 */
+
+	const BaseMediator = BaseObject.extend("sap.m.upload.p13n.mediator.BaseMediator", {
+		constructor: function (mSettings) {
+			BaseObject.call(this);
+			if (!mSettings?.control) {
+				throw Error('Please provide "control" for personalization');
+			}
+			this._oControl = mSettings.control;
+			if (!mSettings?.targetAggregation) {
+				throw Error('Please provide "targetAggregation" for personalization');
+			}
+			this._sTargetAggregation = mSettings.targetAggregation;
+			if (!mSettings?.p13nMetadataTarget) {
+				throw Error('Please provide "p13nMetadataTarget" for personalization');
+			}
+			this._sP13nMetadataTarget = mSettings.p13nMetadataTarget;
+		}
+	});
+
+	/**
+	 *
+	 * Returns the control instance that has been set
+	 * @returns {sap.m.upload.UploadSetwithTable} returns the upload set table control
+	 * @public
+	 */
+	BaseMediator.prototype.getControl = function () {
+		return this._oControl;
+	};
+
+	/**
+	 *
+	 * Returns the target aggregation that has been set
+	 * @returns {string} returns the target aggregation
+	 */
+
+	BaseMediator.prototype.getTargetAggregation = function () {
+		return this._sTargetAggregation;
+	};
+
+
+	/**
+	 *
+	 * Returns the target metadata that as been set
+	 * @returns {string} returns the p13 target metadata
+	 */
+
+	BaseMediator.prototype.getP13nMetadataTarget = function () {
+		return this._sP13nMetadataTarget;
+	};
+
+	/**
+	 *
+	 * Abstract method for constructing a panel and populating it with data specific to that panel.
+	 *
+	 * @name sap.m.upload.p13n.mediator.BaseMediator.prototype.createPanel
+	 * @function
+	 * @protected
+	 * @returns {Promise} returns a promise with the resolved p13 panel.
+	 *
+	 */
+
+	/**
+	 *
+	 * Abstract method to obtain changes by comparing the old and current states.
+	 *
+	 * @name sap.m.upload.p13n.mediator.BaseMediator.prototype.getChanges
+	 * @function
+	 * @protected
+	 * @returns {Array} returns array of delta changes
+	 *
+	 */
+
+	/**
+	 *
+	 *
+ 	 * An abstract method for applying changes to the upload set table.
+ 	 * Essentially, these changes should be applied after the current data becomes available.
+	 *
+	 * @name sap.m.upload.p13n.mediator.BaseMediator.prototype.applyStateToTable
+	 * @function
+	 * @protected
+	 *
+	 */
+
+
+	/***
+	 *
+	 * Gets the view for the particular control
+	 * @returns {object} returns the view object
+	 * @public
+	 *
+	 */
+
+	BaseMediator.prototype.getView = function () {
+		return this.getControlOfType(this.getControl(), View);
+	};
+
+	/***
+	 * Helper method to get control view
+	 * @private
+	 */
+
+	BaseMediator.prototype.getControlOfType = function (oControl, oType) {
+		if (oControl instanceof oType) {
+			return oControl;
+		}
+		if (oControl && typeof oControl["getParent" === "function"]) {
+			return this.getControlOfType(oControl.getParent(), oType);
+		}
+		return undefined;
+	};
+
+	/***
+	 *
+	 * Converts the array of objects with key properties to map and adds addIndex
+	 * @param {Array} aArray expects array of objects with key property
+	 * @param {boolean} addIndex expects a boolean in case index needs to be added
+	 * @returns {object} returns the converted object with key as value of key property inside the object
+	 * @internal
+	 *
+	 */
+
+	BaseMediator.prototype.arrayToMap = function (aArray, addIndex = false) {
+		return aArray.reduce(function (mMap, oProp, iIndex) {
+			mMap[oProp.key] = oProp;
+			if (addIndex) {
+				mMap[oProp.key].index = iIndex;
+			}
+			return mMap;
+		}, {});
+	};
+
+	/**
+	 *
+	 * Creates a change that can later be handeled by the flexibility layer to apply and revert the change.
+	 * @param {string} sChangeType expects the name of change which will be later handled in change handlers.
+	 * @param {*} oContent expects the changed content which is delta for the specific panel.
+	 * @returns {object} returns the change object.
+	 * @public
+	 */
+
+	BaseMediator.prototype.createChange = function (sChangeType, oContent) {
+		oContent.targetAggregation = this.getTargetAggregation();
+		return {
+			selectorElement: this.getControl(),
+			changeSpecificData: {
+				changeType: sChangeType,
+				content: oContent
+			}
+		};
+	};
+
+	return BaseMediator;
+});

package/src/sap/m/upload/p13n/mediator/ColumnsMediator.js

@@ -0,0 +1,210 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2023 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define(
+	[
+		"sap/m/upload/p13n/mediator/BaseMediator",
+		"sap/m/p13n/SelectionPanel",
+		"sap/m/upload/p13n/modules/CustomDataConfig",
+		"sap/ui/core/Configuration",
+		"sap/base/util/deepEqual"
+	],
+	function (BaseMediator, SelectionPanel, CustomDataConfig, Configuration, deepEqual) {
+		"use strict";
+
+		/**
+		 * Constructor for a new <code>ColumnsMediator</code>.
+		 *
+		 * @param {object} [mSettings] Initial settings for the new control
+     	 * @param {sap.ui.core.Control} mSettings.control The control instance that is personalized by this mediator
+      	 * @param {string} mSettings.targetAggregation The name of the aggregation that is now managed by this mediator
+     	 * @param {string} mSettings.p13nMetadataTarget The name of the personalization metadata target that is now managed by this mediator
+		 *
+		 * @class
+		 * The <code>ColumnsMediator</code> entity serves as a class which handles columns panel related logic.
+		 *
+		 * @extends sap.m.upload.p13n.mediator.BaseMediator
+		 *
+		 * @author SAP SE
+		 * @version 1.120.0
+		 * @private
+		 * @experimental
+		 * @internal
+		 * @alias sap.m.upload.p13n.mediator.ColumnsMediator
+		 */
+
+		const ColumnsMediator = BaseMediator.extend("sap.m.upload.p13n.mediator.ColumnsMediator", {
+			constructor: function (mSettings) {
+				BaseMediator.call(this, mSettings);
+			}
+		});
+
+		ColumnsMediator.prototype.createPanel = function () {
+			return Promise.resolve(this.createUi(this.getPanelData()));
+		};
+
+		ColumnsMediator.prototype.createUi = function (aPanelData) {
+			this._oPanel = new SelectionPanel({ enableCount: true, showHeader: true });
+			this._oPanel.setP13nData(aPanelData);
+			return this._oPanel;
+		};
+
+		ColumnsMediator.prototype.getPanelData = function () {
+			const mCurrentState = this.arrayToMap(this.getCurrentState(), true);
+			const aPanelState = [],
+				oMetadata = this.getControl()._getP13nMetadata();
+			oMetadata[this.getP13nMetadataTarget()].forEach((oMetadataItem) => {
+				aPanelState.push({
+					key: oMetadataItem.key,
+					label: oMetadataItem.label || oMetadataItem.key,
+					tooltip: oMetadataItem.tooltip,
+					index: mCurrentState[oMetadataItem.key] ? mCurrentState[oMetadataItem.key].index : undefined,
+					visible: !!mCurrentState[oMetadataItem.key]
+				});
+			});
+
+			// Sort panel config
+			const sLocale = Configuration.getLocale().toString(),
+				oCollator = window.Intl.Collator(sLocale, {});
+			aPanelState.sort((mItem1, mItem2) => {
+				if (mItem1.visible && mItem2.visible) {
+					return (mItem1.index || 0) - (mItem2.index || 0);
+				}
+				if (mItem1.visible) {
+					return -1;
+				}
+				if (mItem2.visible) {
+					return 1;
+				}
+				return oCollator.compare(mItem1.label, mItem2.label);
+			});
+			aPanelState.forEach((oItem) => delete oItem.index);
+			return aPanelState;
+		};
+
+		ColumnsMediator.prototype.getCurrentState = function () {
+			const oState = [],
+				aAggregateItems = this.getControl().getAggregation(this.getTargetAggregation()) || [],
+				oView = this.getView();
+			aAggregateItems.forEach((oItem, iIndex) => {
+				const sKey = oView ? oView.getLocalId(oItem.getId()) : oItem.getId();
+				oState[sKey] = { key: sKey, index: iIndex, visible: oItem.getVisible() };
+			});
+
+			const oCustomConfig = CustomDataConfig.read(this.getControl()) || {};
+			const oFlexConfig = oCustomConfig.hasOwnProperty("aggregations")
+				? oCustomConfig.aggregations[this.getTargetAggregation()]
+				: {};
+
+
+			for (const sKey in oFlexConfig) {
+				const { index, visible = true } = oFlexConfig[sKey];
+				if (!oState[sKey]) {
+					continue;
+				}
+				if (index !== undefined) {
+					oState[sKey].index = index;
+				}
+				oState[sKey].visible = visible;
+			}
+			const aState = Object.values(oState)
+				.filter((oItem) => oItem.visible)
+				.sort((oItem1, oItem2) => {
+					return oItem1.index - oItem2.index;
+				});
+
+			return aState.map((oItem) => ({ key: oItem.key }));
+		};
+
+		ColumnsMediator.prototype._getP13nData = function () {
+			return this._oPanel ? this._oPanel.getP13nData() : {};
+		};
+
+		ColumnsMediator.prototype.getChanges = function () {
+			const aChanges = [],
+				aCurrentState = this.getCurrentState(),
+				aP13nData = this._getP13nData(),
+				aNextState = aP13nData.filter((oEntry) => !!oEntry.visible).map((oEntry) => ({ key: oEntry.key }));
+
+			if (deepEqual(aCurrentState, aNextState)) {
+				return aChanges;
+			}
+
+			// Calculate inserts, delete and move actions
+			const aDeleted = this._getDeletes(aCurrentState, aNextState),
+				aInserted = this._getInserts(aCurrentState, aNextState),
+				aMoved = this._getMove(aCurrentState, aNextState, aDeleted, aInserted);
+
+			aChanges.push(
+				this.createChange("uploadSetTableColumnsStateChange", { deleted: aDeleted, moved: aMoved, inserted: aInserted })
+			);
+			return aChanges;
+		};
+
+		ColumnsMediator.prototype._getDeletes = function (aCurrentState, aNextState) {
+			const aResult = [],
+				mNextState = this.arrayToMap(aNextState);
+
+			aCurrentState.forEach((oState, iIndex) => {
+				if (!mNextState[oState.key]) {
+					aResult.push({ key: oState.key, prevIndex: iIndex });
+				}
+			});
+			return aResult;
+		};
+
+		ColumnsMediator.prototype._getInserts = function (aCurrentState, aNextState) {
+			const aResult = [],
+				mCurrentState = this.arrayToMap(aCurrentState);
+
+			aNextState.forEach((oState, iIndex) => {
+				if (!mCurrentState[oState.key]) {
+					aResult.push({ key: oState.key, index: iIndex });
+				}
+			});
+			return aResult;
+		};
+
+		ColumnsMediator.prototype._getMove = function (aCurrentState, aNextState) {
+			const aResult = [],
+				mNextState = this.arrayToMap(aNextState, true);
+
+			aCurrentState.forEach((oState, iIndex) => {
+				if (mNextState[oState.key] && mNextState[oState.key].index !== iIndex) {
+					aResult.push({ key: oState.key, index: mNextState[oState.key].index, prevIndex: iIndex });
+				}
+			});
+			return aResult;
+		};
+
+		ColumnsMediator.prototype.applyStateToTable = function () {
+			const aState = this.getCurrentState(),
+				oView = this.getView();
+
+			this.getControl()
+				.getColumns()
+				.forEach((oCol) => {
+					oCol.setVisible(false);
+				});
+			const oColMap = this.getControl()
+				.getColumns()
+				.reduce((oInit, oCol) => {
+					const sKey = oView ? oView.getLocalId(oCol.getId()) : oCol.getId();
+					oInit[sKey] = oCol;
+					return oInit;
+				}, {});
+
+			aState.forEach((oCol, iIndex) => {
+				if (oColMap[oCol.key]) {
+					oColMap[oCol.key].setVisible(true);
+					oColMap[oCol.key].setOrder(iIndex);
+				}
+			});
+		};
+
+		return ColumnsMediator;
+	}
+);