@sapui5/sap.ushell 1.131.1 → 1.132.0

package/src/main/js/sap/ushell/services/Bookmark.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's bookmark service. Allows creating shortcuts on the user's home page.
  *
- * @version 1.131.1
+ * @version 1.132.0
  * @deprecated As of version 1.120
  */
 sap.ui.define([
@@ -11,6 +11,7 @@ sap.ui.define([
     "sap/ui/thirdparty/jquery",
     "sap/ushell/Config",
     "sap/ushell/library",
+    "sap/ushell/utils",
     "sap/base/util/deepClone",
     "sap/base/util/deepExtend",
     "sap/base/Log"
@@ -19,6 +20,7 @@ sap.ui.define([
     jQuery,
     Config,
     ushellLibrary,
+    ushellUtils,
     deepClone,
     deepExtend,
     Log
@@ -199,7 +201,12 @@ sap.ui.define([
             }
 
             this._checkBookmarkParameters(oParameters)
-                .then(function () {
+                .then(() => {
+                    return this._changeUrlStatesToPersistent(oParameters.url);
+                })
+                .then(function (sNewUrl) {
+                    oParameters.url = sNewUrl;
+
                     // Check if no container was provided and we are in spaces mode.
                     if (typeof vContainer === "undefined" && bEnableSpace) {
                         return sap.ushell.Container.getServiceAsync("Menu")
@@ -285,7 +292,7 @@ sap.ui.define([
          * @private
          * @ui5-restricted ssuite.smartbusiness
          */
-        this.addCustomBookmark = function (sVizType, oConfig, vContentNodes, sContentProviderId) {
+        this.addCustomBookmark = async function (sVizType, oConfig, vContentNodes, sContentProviderId) {
             var oClonedConfig = deepClone(oConfig);
             var oBookmarkConfig = deepExtend(oClonedConfig, {
                 vizType: sVizType,
@@ -302,6 +309,8 @@ sap.ui.define([
             delete oBookmarkConfig.chipConfig;
             delete oBookmarkConfig.loadManifest;
 
+            oBookmarkConfig.url = await this._changeUrlStatesToPersistent(oBookmarkConfig.url);
+
             // Make sure we always use an array of content nodes
             var aContentNodes = [].concat(vContentNodes);
 
@@ -990,14 +999,22 @@ sap.ui.define([
             var oDeferred = new jQuery.Deferred();
 
             if (Config.last("/core/spaces/enabled")) {
-                this._oPagesServicePromise
-                    .then(function (oPagesService) {
+                Promise.all([
+                    this._oPagesServicePromise,
+                    this._changeUrlStatesToPersistent(oParameters.url)
+                ])
+                    .then(function ([oPagesService, sNewUrl]) {
+                        oParameters.url = sNewUrl;
                         return oPagesService.updateBookmarks({ url: sUrl, contentProviderId: sContentProviderId }, oParameters);
                     })
                     .then(oDeferred.resolve, oDeferred.reject);
             } else {
-                this._oLaunchPageServicePromise
-                    .then(function (LaunchPageService) {
+                Promise.all([
+                    this._oLaunchPageServicePromise,
+                    this._changeUrlStatesToPersistent(oParameters.url)
+                ])
+                    .then(function ([LaunchPageService, sNewUrl]) {
+                        oParameters.url = sNewUrl;
                         LaunchPageService.updateBookmarks(sUrl, oParameters, sContentProviderId)
                             .done(oDeferred.resolve)
                             .fail(oDeferred.reject);
@@ -1061,7 +1078,7 @@ sap.ui.define([
          * @private
          * @ui5-restricted ssuite.smartbusiness
          */
-        this.updateCustomBookmarks = function (oIdentifier, oConfig) {
+        this.updateCustomBookmarks = async function (oIdentifier, oConfig) {
             if (!oIdentifier || !oIdentifier.url || !oIdentifier.vizType) {
                 return Promise.reject("deleteCustomBookmarks: Some required parameters are missing.");
             }
@@ -1080,6 +1097,8 @@ sap.ui.define([
             delete oBookmarkConfig.chipConfig;
             delete oBookmarkConfig.loadManifest;
 
+            oBookmarkConfig.url = await this._changeUrlStatesToPersistent(oBookmarkConfig.url);
+
             if (Config.last("/core/spaces/enabled")) {
                 return this._oPagesServicePromise
                     .then(function (oPagesService) {
@@ -1163,8 +1182,37 @@ sap.ui.define([
                     });
             }.bind(this));
         };
+
+        /**
+         * If the bookmark created contains state keys, change their state
+         * to be persistent (originally, a cFLP requirement).
+         * In case of an error, the function reports it but it will not stop
+         * the creation of the bookmark.
+         *
+         * @param {string} sUrl The URL of the bookmark.
+         * @returns {Promise<string>} The URL with the changed states
+         * @since 1.133
+         * @private
+         */
+        this._changeUrlStatesToPersistent = async function (sUrl) {
+            const AppState = await sap.ushell.Container.getServiceAsync("AppState");
+
+            var bAppStateConfigPersistent = AppState.getPersistentWhenShared();
+            // gate keeper - if the platform did not implement yet the new persistency mechanism
+            // with different persistency method types, no action should be taken
+            if (AppState.getSupportedPersistencyMethods().length === 0 && bAppStateConfigPersistent !== true) {
+                return sUrl;
+            }
+
+            if (sUrl && sUrl.length > 0) {
+                return ushellUtils.promisify(AppState.setAppStateToPublic(sUrl));
+            }
+
+            return sUrl;
+        };
     }
 
+
     Bookmark.hasNoAdapter = true;
     return Bookmark;
 }, true /* bExport */);