@sapui5/sap.ushell 1.120.8 → 1.121.0

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

@@ -6,7 +6,7 @@
  * This is *not* an application facing service, but for Shell Internal usage.
  * This service should be accessed by the application via the CrossApplicationNavigation service.
  *
- * @version 1.120.8
+ * @version 1.121.0
  */
 sap.ui.define([
     "sap/ui/base/Object",
@@ -52,7 +52,7 @@ sap.ui.define([
      *
      * <b>Note:</b> To retrieve a valid instance of this service, it is necessary to call
      * <code>sap.ushell.Container.getServiceAsync("AppState")</code>. For details, see
-     * {@link sap.ushell.services.Container#getServiceAsync}.
+     * {@link sap.ushell.Container#getServiceAsync}.
      *
      * The AppState service allows to serialize non-sensitive application state in a bookmarkable and sharable manner
      * Data stored under the generated key is stored on the Frontend-Server.
@@ -122,6 +122,7 @@ sap.ui.define([
      * Method to obtain a session key
      *
      * @returns {string} session key
+     *
      * @private
      * @since 1.28.0
      */
@@ -138,11 +139,11 @@ sap.ui.define([
      * Note: The AppState object may not contain any sensitive or security critical data, as it is shared and accessible by any user
      *
      * @param {string} sKey Identifies the container. The string length is restricted to 40 characters.
-     * @returns {object} Promise object whose done function returns an unmodifiable
-     *   {@link sap.ushell.services.AppState.AppState} object as parameter.
+     * @returns {jQuery.Promise} Resolves an unmodifiable {@link sap.ushell.services.AppState.AppState} object as parameter.
      *   The object's getData method can be used to retrieve the data synchronously.
-     * @private Usage by other shell services (CrossApplicationNavigation) only!
+     *
      * @since 1.28.0
+     * @private
      */
     AppState.prototype.getAppState = function (sKey) {
         var oDeferred = new jQuery.Deferred();
@@ -167,8 +168,9 @@ sap.ui.define([
      *   it is only used during generating a new internal appstate during target resolution.
      *   Default value: not transient
      * @returns {string} generated key
-     * @private
+     *
      * @since 1.28.0
+     * @private
      */
     AppState.prototype._getGeneratedKey = function (transient) {
         var sKey = utils.generateRandomKey();
@@ -199,8 +201,7 @@ sap.ui.define([
      *        Support depends on the used platform.
      * @param {object} oPersistencySettings Persistency Settings.
      *   it is only used during generating a new internal appstate during target resolution
-     * @returns {Promise} promise. The promise's done function returns a {@link sap.ushell.services.AppState.AppState} object as parameter.
-     *   The returned AppState object is mutable.
+     * @returns {sap.ushell.services.AppState.AppState} Returns a mutable AppState.
      *
      * @since 1.28.0
      * @private
@@ -218,7 +219,7 @@ sap.ui.define([
         }
 
         if (oComponent) {
-            if (!BaseObject.isA(oComponent, "sap.ui.core.UIComponent")) {
+            if (!BaseObject.isObjectA(oComponent, "sap.ui.core.UIComponent")) {
                 throw new Error("oComponent passed must be a UI5 Component");
             }
             if (oComponent.getMetadata && oComponent.getMetadata() && typeof oComponent.getMetadata().getName === "function") {
@@ -228,10 +229,10 @@ sap.ui.define([
                 sAppName = oComponent.getMetadata().getComponentName();
             }
             if (oComponent.getMetadata && oComponent.getMetadata() &&
-                typeof oComponent.getMetadata().getManifest === "function" &&
-                typeof oComponent.getMetadata().getManifest() === "object" &&
-                typeof oComponent.getMetadata().getManifest()["sap.app"] === "object") {
-                sACHComponent = oComponent.getMetadata().getManifest()["sap.app"].ach || "";
+                typeof oComponent.getManifest === "function" &&
+                typeof oComponent.getManifest() === "object" &&
+                typeof oComponent.getManifest()["sap.app"] === "object") {
+                sACHComponent = oComponent.getManifest()["sap.app"].ach || "";
             }
         }
 
@@ -253,8 +254,9 @@ sap.ui.define([
      *
      * @param {object} oComponent A SAP UI5 Component, mandatory. An initial object is returned.
      * @returns {object} An unmodifiable container
-     * @private
+     *
      * @since 1.28.0
+     * @private
      */
     AppState.prototype.createEmptyUnmodifiableAppState = function (/*oComponent*/) {
         var sKey = this._getGeneratedKey();
@@ -275,10 +277,10 @@ sap.ui.define([
      * @param {boolean} iPersistencyMethod Persistency Method
      * @param {object} oPersistencySettings Persistency Settings
      *
-     * @returns {object} promise
+     * @returns {jQuery.Promise} Resolves once the app state was saved.
      *
-     * @private
      * @since 1.28.0
+     * @private
      */
     AppState.prototype._saveAppState = function (sKey, sData, sAppName, sComponent, bTransient, iPersistencyMethod, oPersistencySettings) {
         var sSessionKey = this._getSessionKey();
@@ -308,8 +310,9 @@ sap.ui.define([
      *
      * @param {string} sKey Application State key
      * @returns {boolean} true if the key is a JSON string
-     * @private
+     *
      * @since 1.114.0
+     * @private
      */
     AppState.prototype._keyIsJson = function (sKey) {
         if (typeof sKey === "string" && sKey.indexOf("{") === 0) {
@@ -328,9 +331,10 @@ sap.ui.define([
      * Method to load an application state
      *
      * @param {string} sKey Application State key
-     * @returns {object} promise
-     * @private
+     * @returns {jQuery.Promise} Resolves once the app state was loaded.
+     *
      * @since 1.28.0
+     * @private
      */
     AppState.prototype._loadAppState = function (sKey) {
         if (this._keyIsJson(sKey)) {
@@ -343,9 +347,10 @@ sap.ui.define([
      * Method to delete an application state
      *
      * @param {string} sKey Application State key
-     * @returns {object} promise
-     * @private
+     * @returns {jQuery.Promise} Resolves once the app state was deleted.
+     *
      * @since 1.69.0
+     * @private
      */
     AppState.prototype.deleteAppState = function (sKey) {
         return this._oAdapter.deleteAppState(sKey);
@@ -356,6 +361,7 @@ sap.ui.define([
      * (For testing only)
      *
      * @returns {object} Sequentializer
+     *
      * @private
      */
     AppState._getSequentializer = function () {
@@ -365,10 +371,11 @@ sap.ui.define([
     /**
      * Method to get an array of sap.ushell.services.AppStatePersistencyMethod.
      *
-     * @returns {array} Returns an array of sap.ushell.services.AppStatePersistencyMethod.
+     * @returns {sap.ushell.services.AppStatePersistencyMethod[]} Returns an array of persistency methods.
      *   An empty array indicates that the platform does not support persistent states.
-     * @private
+     *
      * @since 1.69.0
+     * @private
      */
     AppState.prototype.getSupportedPersistencyMethods = function () {
         if (this._oAdapter.getSupportedPersistencyMethods) {
@@ -383,9 +390,9 @@ sap.ui.define([
      *
      * @param {string} sPersistencyMethod the persistency method
      * @returns {boolean} true if the method supported or through if not
-     * @since 1.69.0
-     * @private
      *
+     * @since 1.69.0
+     * @protected
      */
     AppState.prototype.isPersistencyMethodSupported = function (sPersistencyMethod) {
         var aSupportedMethods = this.getSupportedPersistencyMethods();
@@ -402,9 +409,9 @@ sap.ui.define([
      *
      * @param {string} url The URL with the relevant state/s
      * @returns {Promise<string>} A promise with the updated AppState keys in the url
-     * @since 1.82.0
      *
-     * @protected
+     * @since 1.82.0
+     * @private
      */
     AppState.prototype.setAppStateToPublic = function (url) {
         var sXStateKey = getURLParamValue(url, "sap-xapp-state");
@@ -449,6 +456,8 @@ sap.ui.define([
      * @param {string} sUrl The URL from it the data will be retrieved
      * @param {string} sParamName The parameter to be fetched from the URL
      * @returns {string} The requested param data
+     *
+     * @private
      */
     function getURLParamValue (sUrl, sParamName) {
         var sReg = new RegExp("(?:" + sParamName + "=)([^&/]+)");
@@ -469,6 +478,8 @@ sap.ui.define([
      * @param {int} persistencyMethod - The chosen persistency method
      * @param {object} persistencySettings - The additional settings PersistencySettings
      * @returns {Promise<string>} - new key of the persistent AppState
+     *
+     * @private
      */
     AppState.prototype.makeStatePersistent = function (key, persistencyMethod, persistencySettings) {
         var oDeferred = new jQuery.Deferred();
@@ -521,9 +532,9 @@ sap.ui.define([
      * Method to check if app state need to be persistent regardless of the system default setting
      *
      * @returns {boolean} true if app state need to be persistent or through if not
+     *
      * @since 1.71.0
      * @private
-     *
      */
     AppState.prototype.getPersistentWhenShared = function () {
         // eslint-disable-next-line no-unneeded-ternary

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

@@ -3,9 +3,11 @@
 /**
  * @fileOverview The Unified Shell's bookmark service. Allows creating shortcuts on the user's home page.
  *
- * @version 1.120.8
+ * @version 1.121.0
+ * @deprecated As of version 1.120
  */
 sap.ui.define([
+    "sap/ui/core/EventBus",
     "sap/ui/thirdparty/jquery",
     "sap/ushell/Config",
     "sap/ushell/library",
@@ -13,6 +15,7 @@ sap.ui.define([
     "sap/base/util/deepExtend",
     "sap/base/Log"
 ], function (
+    EventBus,
     jQuery,
     Config,
     ushellLibrary,
@@ -36,8 +39,9 @@ sap.ui.define([
      *
      * <b>Note:</b> To retrieve a valid instance of this service, it is necessary to call
      * <code>sap.ushell.Container.getServiceAsync("Bookmark")</code>. For details, see
-     * {@link sap.ushell.services.Container#getServiceAsync}.
+     * {@link sap.ushell.Container#getServiceAsync}.
      *
+     * @augments sap.ushell.services.Service
      * @hideconstructor
      *
      * @since 1.15.0
@@ -170,8 +174,7 @@ sap.ui.define([
          *   or to the default page if spaces mode is active.
          * @param {string} [sContentProviderId] The contentProviderId or undefined outside the cFLP
          *
-         * @returns {jQuery.Promise}
-         *   A <code>jQuery.Promise</code> which resolves on success, but rejects
+         * @returns {jQuery.Promise} Resolves on success, but rejects
          *   with a reason-message on failure to add the bookmark to the specified or implied group.
          *   The promise gets resolved if personalization is disabled.
          *
@@ -179,7 +182,6 @@ sap.ui.define([
          * @since 1.15.0
          * @deprecated since 1.119. Please use {@link sap.ushell.services.BookmarkV2#addBookmark} instead.
          * @public
-         * @alias sap.ushell.services.Bookmark#addBookmark
          */
         this.addBookmark = function (oParameters, vContainer, sContentProviderId) {
             var oDeferred = new jQuery.Deferred();
@@ -278,8 +280,6 @@ sap.ui.define([
          * @since 1.81
          * @private
          * @ui5-restricted ssuite.smartbusiness
-         *
-         * @alias sap.ushell.services.Bookmark#addCustomBookmark
          */
         this.addCustomBookmark = function (sVizType, oConfig, vContentNodes, sContentProviderId) {
             var oClonedConfig = deepClone(oConfig);
@@ -346,7 +346,6 @@ sap.ui.define([
          * @see sap.ushell.services.URLParsing#getShellHash
          * @since 1.81.0
          * @private
-         * @alias sap.ushell.services.Bookmark#addBookmarkToHomepageGroup
          */
         this.addBookmarkToHomepageGroup = function (oParameters, oGroup, bCustom, sContentProviderId) {
             // Reject if in launchpad spaces mode
@@ -372,7 +371,7 @@ sap.ui.define([
                                 tile: oTile,
                                 group: oGroup
                             };
-                            sap.ui.getCore().getEventBus().publish("sap.ushell.services.Bookmark", "bookmarkTileAdded", oData);
+                            EventBus.getInstance().publish("sap.ushell.services.Bookmark", "bookmarkTileAdded", oData);
                             resolve();
                         })
                         .fail(reject);
@@ -419,7 +418,6 @@ sap.ui.define([
          * @see sap.ushell.services.URLParsing#getShellHash
          * @since 1.75.0
          * @private
-         * @alias sap.ushell.services.Bookmark#addBookmarkToPage
          */
         this.addBookmarkToPage = function (oParameters, sPageId, sContentProviderId) {
             // Reject of in launchpad home page mode
@@ -457,15 +455,13 @@ sap.ui.define([
          * @param {string} [groupId]
          *   ID of the group the bookmark tile should be added to.
          *
-         * @returns {jQuery.Promise}
-         *   A <code>jQuery.Promise</code> which resolves on success, but rejects
+         * @returns {jQuery.Promise} Resolves on success, but rejects
          *   (with a reason-message) on failure to add the bookmark to the specified or implied group.
          *    In launchpad spaces mode the promise gets rejected.
          *
          * @see sap.ushell.services.URLParsing#getShellHash
          * @since 1.66.0
          * @private
-         * @alias sap.ushell.services.Bookmark#addBookmarkByGroupId
          */
         this.addBookmarkByGroupId = function (oParameters, groupId, sContentProviderId) {
             // Reject if in launchpad spaces mode
@@ -497,16 +493,14 @@ sap.ui.define([
         /**
          * Returns the list of group ids and their titles of the user together with filtering out all groups that can not
          * be selected when adding a bookmark.
-         * In case of success, the <code>done</code> function gets an array of 'anonymous' groupId-title objects.
          * The order of the array is the order in which the groups will be displayed to the user.
          * the API is used from "AddBookmarkButton" by not native UI5 applications
          *
          * @param {boolean} bGetAll If set to `true`, all groups, including locked groups, are returned.
-         * @returns {jQuery.Promise} A promise that resolves to the list of groups. In launchpad spaces mode the promise gets rejected.
+         * @returns {jQuery.Promise} Resolves to the list of groups. In launchpad spaces mode the promise gets rejected.
          *
          * @since 1.66.0
          * @private
-         * @alias sap.ushell.services.Bookmark#getGroupsIdsForBookmarks
          */
         this.getShellGroupIDs = function (bGetAll) {
             var oDeferred = new jQuery.Deferred();
@@ -544,7 +538,7 @@ sap.ui.define([
          * @param {string} sCatalogTileId The ID of the tile within the catalog
          * @param {object} oCatalog The catalog containing the catalog tile
          * @param {string} [sGroupId] The id of the group. If not given, the tile is added to the default group
-         * @returns {jQuery.Promise} A <code>jQuery.Promise</code> which is resolved once tile has been added to the given group.
+         * @returns {jQuery.Promise} Resolves once tile has been added to the given group.
          *
          * @private
          */
@@ -610,7 +604,7 @@ sap.ui.define([
                                         .fail(oDeferred.reject)
                                         .done(function () { // ignore argument oTile!
                                             oDeferred.resolve();
-                                            sap.ui.getCore().getEventBus().publish("sap.ushell.services.Bookmark", "catalogTileAdded", sGroupId);
+                                            EventBus.getInstance().publish("sap.ushell.services.Bookmark", "catalogTileAdded", sGroupId);
                                         });
                                     return true;
                                 }
@@ -641,16 +635,13 @@ sap.ui.define([
          *   "/sap/hba/apps/kpi/s/odata/hana_chip_catalog.xsodata/"
          * @param {string} oCatalogData.remoteId
          *   The remote catalog's id on the remote system such as "HANA_CATALOG"
-         * @returns {jQuery.Promise}
-         *   A <code>jQuery.Promise</code> which informs about success or failure
-         *   of this asynchronous operation. In case of success, no further details are passed.
+         * @returns {jQuery.Promise} Resolves if successful.
          *   In case of failure, an error message is passed.
          *   In launchpad spaces mode the promise gets rejected.
          *
          * @since 1.21.2
          * @public
          * @deprecated since 1.112. Please use {@link sap.ushell.services.BookmarkV2#addBookmark} instead.
-         * @alias sap.ushell.services.Bookmark#addCatalogTileToGroup
          */
         this.addCatalogTileToGroup = function (sCatalogTileId, sGroupId, oCatalogData) {
             var oDeferred = new jQuery.Deferred();
@@ -785,9 +776,7 @@ sap.ui.define([
          * @param {string} sContentProviderId
          *   The Content Provider ID.
          *
-         * @returns {jQuery.Promise}
-         *   A <code>jQuery.Promise</code> which informs about success or failure
-         *   of this asynchronous operation. In case of success, the count of existing bookmarks
+         * @returns {jQuery.Promise} Resolves the count of existing bookmarks
          *   is provided (which might be zero). In case of failure, an error message is passed.
          *
          * @see #addBookmark
@@ -835,11 +824,8 @@ sap.ui.define([
          *
          * @see #addCustomBookmark
          * @since 1.83.0
-         *
          * @private
          * @ui5-restricted ssuite.smartbusiness
-         *
-         * @alias sap.ushell.services.Bookmark#countCustomBookmarks
          */
         this.countCustomBookmarks = function (oIdentifier) {
             if (!oIdentifier || !oIdentifier.url || !oIdentifier.vizType) {
@@ -866,9 +852,7 @@ sap.ui.define([
          *   The URL of the bookmarks to be deleted, exactly as specified to {@link #addBookmark}.
          * @param {string} [sContentProviderId] The contentProviderId or undefined outside the cFLP
          *
-         * @returns {jQuery.Promise}
-         *   A <code>jQuery.Promise</code> which informs about success or
-         *   failure of this asynchronous operation. In case of success, the number of deleted
+         * @returns {jQuery.Promise} Resolves the number of deleted
          *   bookmarks is provided (which might be zero). In case of failure, an error message is
          *   passed.
          *
@@ -877,7 +861,6 @@ sap.ui.define([
          * @since 1.17.1
          * @deprecated since 1.119. Please use {@link sap.ushell.services.BookmarkV2#deleteBookmarks} instead.
          * @public
-         * @alias sap.ushell.services.Bookmark#deleteBookmarks
          */
         this.deleteBookmarks = function (sUrl, sContentProviderId) {
             var oDeferred = new jQuery.Deferred();
@@ -892,7 +875,7 @@ sap.ui.define([
                 this._oLaunchPageServicePromise.then(function (LaunchPageService) {
                     LaunchPageService.deleteBookmarks(sUrl, sContentProviderId)
                         .done(function (oResult) {
-                            sap.ui.getCore().getEventBus().publish("sap.ushell.services.Bookmark", "bookmarkTileDeleted", sUrl);
+                            EventBus.getInstance().publish("sap.ushell.services.Bookmark", "bookmarkTileDeleted", sUrl);
 
                             oDeferred.resolve(oResult);
                         })
@@ -922,11 +905,8 @@ sap.ui.define([
          * @see #addCustomBookmark
          * @see #countCustomBookmarks
          * @since 1.83.0
-         *
          * @private
          * @ui5-restricted ssuite.smartbusiness
-         *
-         * @alias sap.ushell.services.Bookmark#deleteCustomBookmarks
          */
         this.deleteCustomBookmarks = function (oIdentifier) {
             if (!oIdentifier || !oIdentifier.url || !oIdentifier.vizType) {
@@ -944,7 +924,7 @@ sap.ui.define([
                     return LaunchPageService.deleteCustomBookmarks(oIdentifier);
                 })
                 .then(function () {
-                    sap.ui.getCore().getEventBus().publish("sap.ushell.services.Bookmark", "bookmarkTileDeleted", oIdentifier.url);
+                    EventBus.getInstance().publish("sap.ushell.services.Bookmark", "bookmarkTileDeleted", oIdentifier.url);
                 });
         };
 
@@ -991,9 +971,7 @@ sap.ui.define([
          *   The unit for the number retrieved from <code>serviceUrl</code>.
          * @param {string} [sContentProviderId] The contentProviderId or undefined outside the cFLP
          *
-         * @returns {jQuery.Promise}
-         *   A <code>jQuery.Promise</code> which informs about success or
-         *   failure of this asynchronous operation. In case of success, the number of updated
+         * @returns {jQuery.Promise} Resolves the number of updated
          *   bookmarks is provided (which might be zero). In case of failure, an error message is
          *   passed.
          *
@@ -1003,7 +981,6 @@ sap.ui.define([
          * @since 1.17.1
          * @deprecated since 1.119. Please use {@link sap.ushell.services.BookmarkV2#updateBookmarks} instead.
          * @public
-         * @alias sap.ushell.services.Bookmark#updateBookmarks
          */
         this.updateBookmarks = function (sUrl, oParameters, sContentProviderId) {
             var oDeferred = new jQuery.Deferred();
@@ -1077,11 +1054,8 @@ sap.ui.define([
          * @see #addCustomBookmark
          * @see #countCustomBookmarks
          * @since 1.83.0
-         *
          * @private
          * @ui5-restricted ssuite.smartbusiness
-         *
-         * @alias sap.ushell.services.Bookmark#updateCustomBookmarks
          */
         this.updateCustomBookmarks = function (oIdentifier, oConfig) {
             if (!oIdentifier || !oIdentifier.url || !oIdentifier.vizType) {
@@ -1154,7 +1128,6 @@ sap.ui.define([
          * @public
          * @since 1.81
          * @deprecated since 1.119. Please use {@link sap.ushell.services.BookmarkV2#getContentNodes} instead.
-         * @alias sap.ushell.services.Bookmark#getContentNodes
          */
         this.getContentNodes = function () {
             // Spaces mode