@sapui5/sap.suite.ui.generic.template 1.120.27 → 1.120.29

package/src/sap/suite/ui/generic/template/manifestMerger/ChangePageConfiguration.js

@@ -13,13 +13,34 @@ sap.ui.define([
     * @private
     */
 
+    /**
+     * @typedef {Object} ChangeContent
+     * 
+     * @property {object} parentPage - The parent page details
+     * @property {string} parentPage.component - The source page component where the new page will be added
+     * @property {string} parentPage.entitySet - The source page entityset name where the new page will be added
+     * 
+     * @property {object} entityPropertyChange - The details of the configuration to be changed
+     * @property {string} entityPropertyChange.propertyPath - The property path where the change has to be added
+     * @property {string} entityPropertyChange.operation - The operation type
+     * @property {object} entityPropertyChange.propertyValue - The property details that has to be modified
+     * 
+     */
+    
+    /**
+     * @typedef {Object} Change
+     * @property {string} changeType - The app descriptor change type name
+     * @property {string} layer - The target layer, can have values "CUSTOMER", "CUSTOMER_BASE", "PARTNER" or "VENDOR"
+     * @property {() => ChangeContent} getContent - The content of the change
+     */
+    var GLOBAL_MANIFEST_CHANGE_COMPONENT = "sap.suite.ui.generic.template";
     var changePageConfiguration = {
         /**
          * @param {object} oManifest - Contains the existing Manifest of the application
-         * @param {object} oChange - Contains the setting changes that the user wants to add to the oManifest
+         * @param {Change} oChange - Contains the setting changes that the user wants to add to the oManifest
          * The oChange for changePageConfiguration should have the following structure:
-         *
-         *  {
+         * @example 
+         * {
          *      "changeType": "appdescr_ui_generic_app_changePageConfiguration", // the app descriptor change type name
          *      "layer": Layer.CUSTOMER, // The target layer, can have values  "CUSTOMER" , "CUSTOMER_BASE", "PARTNER" or "VENDOR"
          *      "content": {
@@ -28,7 +49,7 @@ sap.ui.define([
          *              "entitySet": "C_STTA_SalesOrder_WD_20" // source page entityset name where the new page will be added
          *          },
          *          "entityPropertyChange": { // details of the configuration to be changed
-         *              "propertyPath": "component/settings", // property pth where the change has to be added
+         *              "propertyPath": "component/settings", // property path where the change has to be added
          *              "operation": "UPSERT", // operation type 
          *              "propertyValue": { // contains the property details that has to be modified
          *                  "tableType": "ResponsiveTable"
@@ -36,6 +57,25 @@ sap.ui.define([
          *          }
          *      }
          *  }
+         * 
+         * @example 
+         * {
+         *      "changeType": "appdescr_ui_generic_app_changePageConfiguration", // the app descriptor change type name
+         *      "layer": Layer.VENDOR, // The target layer, can have values  "CUSTOMER" , "CUSTOMER_BASE", "PARTNER" or "VENDOR"
+         *      "content": {
+         *          "parentPage" : { // source page details
+         *              "component": "sap.suite.ui.generic.template", // This is the global manifest change
+         *          },
+         *          "entityPropertyChange": { // details of the configuration to be changed
+         *              "propertyPath": "settings", // property path where the change has to be added
+         *              "operation": "UPSERT", // operation type 
+         *              "propertyValue": { // contains the property details that has to be modified
+         *                  "statePreservationMode": "persistence"
+         *              }
+         *          }
+         *      }
+         *  }
+         * 
          * @returns {object} the updated oManifest containing the oChange settings
          * @protected
          */
@@ -45,21 +85,30 @@ sap.ui.define([
             MergerUtil.consistencyCheck(oChangeContent, "MODIFY");
             var sParentEntitySet = oChangeContent.parentPage.entitySet;
             var sParentComponent = oChangeContent.parentPage.component;
-            var oPageStructure = MergerUtil.iterateAndFind(oManifest["sap.ui.generic.app"],sParentEntitySet, sParentComponent);
+            var oPageStructure;
+            if (sParentComponent === GLOBAL_MANIFEST_CHANGE_COMPONENT) {
+                oPageStructure = oManifest["sap.ui.generic.app"];
+            } else {
+                oPageStructure = MergerUtil.iterateAndFind(oManifest["sap.ui.generic.app"], sParentEntitySet, sParentComponent);
+            }
             var oPropertyChange = oChangeContent.entityPropertyChange;
-            
-            var aPropertyKeys = Object.keys(oPropertyChange.propertyValue);
-            aPropertyKeys.forEach(function(sCurrentKey) {
+            if (typeof oPropertyChange.propertyValue !== "object" || oPropertyChange.propertyValue === null) {
                 var aPropertyPath = oPropertyChange.propertyPath.split("/");
-                aPropertyPath.push(sCurrentKey);
-                var vVal = ObjectPath.get(aPropertyPath, oPageStructure);
-                if (vVal && typeof vVal === "object") {
-                    var oPropertyPathContent = ObjectPath.create(aPropertyPath, oPageStructure);
-                    Object.assign(oPropertyPathContent, oPropertyChange.propertyValue[sCurrentKey]);
-                } else {
-                    ObjectPath.set(aPropertyPath, oPropertyChange.propertyValue[sCurrentKey], oPageStructure);
-                }
-            });
+                ObjectPath.set(aPropertyPath, oPropertyChange.propertyValue, oPageStructure);
+            } else {
+                var aPropertyKeys = Object.keys(oPropertyChange.propertyValue);
+                aPropertyKeys.forEach(function (sCurrentKey) {
+                    var aPropertyPath = oPropertyChange.propertyPath.split("/");
+                    aPropertyPath.push(sCurrentKey);
+                    var vVal = ObjectPath.get(aPropertyPath, oPageStructure);
+                    if (vVal && typeof vVal === "object") {
+                        var oPropertyPathContent = ObjectPath.create(aPropertyPath, oPageStructure);
+                        Object.assign(oPropertyPathContent, oPropertyChange.propertyValue[sCurrentKey]);
+                    } else {
+                        ObjectPath.set(aPropertyPath, oPropertyChange.propertyValue[sCurrentKey], oPageStructure);
+                    }
+                });
+            }
             return oManifest;
         }
      };

package/src/sap/suite/ui/generic/template/manifestMerger/MergerUtil.js

@@ -10,6 +10,7 @@ sap.ui.define([
     * This class holds the helper functions that are invoked from the manifestMergers
     * @private
     */
+    var GLOBAL_MANIFEST_CHANGE_COMPONENT = "sap.suite.ui.generic.template";
     var mergerUtil = {
 
         /** 
@@ -75,12 +76,12 @@ sap.ui.define([
             if (!oChangeContent["parentPage"]) {
                 throw new Error("Mandatory 'parentPage' parameter is not provided.");
             }
-            if (!oChangeContent.parentPage.entitySet) {
-                throw new Error("Mandatory 'parentPage.entitySet' parameter is not provided.");
-            }
             if (!oChangeContent.parentPage.component) {
                 throw new Error("Mandatory 'parentPage.component' parameter is not provided.");
             }
+            if (!oChangeContent.parentPage.entitySet && oChangeContent.parentPage.component !== GLOBAL_MANIFEST_CHANGE_COMPONENT) {
+                throw new Error("Mandatory 'parentPage.entitySet' parameter is not provided.");
+            }
             if (sMergerType === "ADD") {
 
                 if (!oChangeContent.childPage.id) {
@@ -117,7 +118,7 @@ sap.ui.define([
                     if (!oEntityPropertyChange.operation || oEntityPropertyChange.operation  !== "UPSERT") {
                         throw new Error("Invalid change format: The mandatory 'operation' is not defined or is not valid type. Please define the mandatory property 'operation' with type 'UPSERT");
                     }
-                    if (!oEntityPropertyChange.propertyValue) {
+                    if (!oEntityPropertyChange.propertyValue === undefined) {
                         throw new Error("Invalid change format: The mandatory 'propertyValue' is not defined. Please define the mandatory property 'propertyValue'");
                     }
                 }