@sapui5/sap.ushell 1.136.3 → 1.138.0

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

@@ -3,18 +3,20 @@
 /**
  * @fileOverview The app runtime wrapper for {@link sap.ushell.services.Bookmark}.
  *
- * @version 1.136.3
+ * @version 1.138.0
  * @deprecated since 1.120. Use {@link sap.ushell.services.BookmarkV2} instead.
  */
 sap.ui.define([
+    "sap/ui/thirdparty/jquery",
     "sap/ushell/services/Bookmark",
     "sap/ushell/appRuntime/ui5/AppRuntimeService",
     "sap/ushell/appRuntime/ui5/AppRuntimeContext"
-], function (
+], (
+    jQuery,
     Bookmark,
     AppRuntimeService,
     AppRuntimeContext
-) {
+) => {
     "use strict";
 
     /**
@@ -24,25 +26,29 @@ sap.ui.define([
      *
      * @hideconstructor
      *
+     * @param {object} oContainerInterface The interface.
+     * @param {string} sParameters Service instantiation.
+     * @param {object} oServiceConfiguration service configuration. A configuration object which may contain service configuration.
+     *
      * @private
      * @deprecated since 1.120. Use {@link sap.ushell.services.BookmarkV2} instead.
      */
     function BookmarkProxy (oContainerInterface, sParameters, oServiceConfiguration) {
         Bookmark.call(this, oContainerInterface, sParameters, oServiceConfiguration);
 
-        //addBookmark(oParameters, vContainer?) : object - jQuery.Deferred promise
-        //Adds a bookmark tile to one of the user's classic homepage groups or to multiple provided content nodes.
+        // addBookmark(oParameters, vContainer?) : object - jQuery.Deferred promise
+        // Adds a bookmark tile to one of the user's classic homepage groups or to multiple provided content nodes.
         this.addBookmark = function (oParameters, vContainer) {
-            var oDeferred = new jQuery.Deferred();
-            var fnAddBookmark = function () {
+            const oDeferred = new jQuery.Deferred();
+            function fnAddBookmark () {
                 return AppRuntimeService.sendMessageToOuterShell("sap.ushell.services.Bookmark.addBookmarkUI5", {
                     oParameters: oParameters,
                     vContainer: vContainer
                 });
-            };
+            }
 
             if (oParameters.url.startsWith("#")) {
-                AppRuntimeContext.checkIntentsConversionForScube([{ intent: oParameters.url }]).then(function (aIntentResult) {
+                AppRuntimeContext.checkIntentsConversionForScube([{ intent: oParameters.url }]).then((aIntentResult) => {
                     oParameters.url = aIntentResult[0].intent;
                     fnAddBookmark().then(oDeferred.resolve, oDeferred.reject);
                 });
@@ -67,8 +73,8 @@ sap.ui.define([
             );
         };
 
-        //addCatalogTileToGroup(sCatalogTileId, sGroupId?, oCatalogData?) : object - jQuery.Deferred object's promise
-        //Adds the catalog tile with the given ID to given group.
+        // addCatalogTileToGroup(sCatalogTileId, sGroupId?, oCatalogData?) : object - jQuery.Deferred object's promise
+        // Adds the catalog tile with the given ID to given group.
         this.addCatalogTileToGroup = function (sCatalogTileId, sGroupId, oCatalogData) {
             return AppRuntimeService.sendMessageToOuterShell("sap.ushell.services.Bookmark.addCatalogTileToGroup", {
                 sCatalogTileId: sCatalogTileId,
@@ -77,24 +83,24 @@ sap.ui.define([
             });
         };
 
-        //countBookmarks(sUrl) : object - jQuery.Deferred object's promise
-        //Counts all bookmarks pointing to the given URL from all of the user's pages
+        // countBookmarks(sUrl) : object - jQuery.Deferred object's promise
+        // Counts all bookmarks pointing to the given URL from all of the user's pages
         this.countBookmarks = function (sUrl) {
             return AppRuntimeService.sendMessageToOuterShell("sap.ushell.services.Bookmark.countBookmarks", {
                 sUrl: sUrl
             });
         };
 
-        //deleteBookmarks(sUrl) : object - jQuery.Deferred object's promise
-        //Deletes all bookmarks pointing to the given URL from all of the user's pages.
+        // deleteBookmarks(sUrl) : object - jQuery.Deferred object's promise
+        // Deletes all bookmarks pointing to the given URL from all of the user's pages.
         this.deleteBookmarks = function (sUrl) {
             return AppRuntimeService.sendMessageToOuterShell("sap.ushell.services.Bookmark.deleteBookmarks", {
                 sUrl: sUrl
             });
         };
 
-        //updateBookmarks(sUrl, oParameters) : object - jQuery.Deferred object's promise
-        //Updates all bookmarks pointing to the given URL on all of the user's pages with the given new parameters.
+        // updateBookmarks(sUrl, oParameters) : object - jQuery.Deferred object's promise
+        // Updates all bookmarks pointing to the given URL on all of the user's pages with the given new parameters.
         this.updateBookmarks = function (sUrl, oParameters) {
             return AppRuntimeService.sendMessageToOuterShell("sap.ushell.services.Bookmark.updateBookmarks", {
                 sUrl: sUrl,
@@ -102,14 +108,14 @@ sap.ui.define([
             });
         };
 
-        //getContentNodes() : object - jQuery.Deferred promise
-        //Returns available content nodes based on the current launchpad context. (Classic homepage, spaces mode)
+        // getContentNodes() : object - jQuery.Deferred promise
+        // Returns available content nodes based on the current launchpad context. (Classic homepage, spaces mode)
         this.getContentNodes = function () {
             return AppRuntimeService.postMessageToFLP("sap.ushell.services.Bookmark.getContentNodes");
         };
 
-        //addCustomBookmark(sVizType, oConfig, vContentNodes) : object - jQuery.Deferred promise
-        //Adds a custom bookmark visualization to one or multiple provided content nodes.
+        // addCustomBookmark(sVizType, oConfig, vContentNodes) : object - jQuery.Deferred promise
+        // Adds a custom bookmark visualization to one or multiple provided content nodes.
         this.addCustomBookmark = function (sVizType, oConfig, vContentNodes) {
             return AppRuntimeService.postMessageToFLP("sap.ushell.services.Bookmark.addCustomBookmark", {
                 sVizType: sVizType,
@@ -118,18 +124,18 @@ sap.ui.define([
             });
         };
 
-        //countCustomBookmarks(oIdentifier) : The count of bookmarks matching the identifier. Promise
-        //Counts all custom bookmarks matching exactly the identification data.
-        //Can be used to check if a bookmark already exists (e.g. before updating).
+        // countCustomBookmarks(oIdentifier) : The count of bookmarks matching the identifier. Promise
+        // Counts all custom bookmarks matching exactly the identification data.
+        // Can be used to check if a bookmark already exists (e.g. before updating).
         this.countCustomBookmarks = function (oIdentifier) {
             return AppRuntimeService.postMessageToFLP("sap.ushell.services.Bookmark.countCustomBookmarks", {
                 oIdentifier: oIdentifier
             });
         };
 
-        //updateCustomBookmarks(oIdentifier, oConfig) : The count of bookmarks which were updated. Promise
-        //Updates all custom bookmarks matching exactly the identification data.
-        //Only given properties are updated.
+        // updateCustomBookmarks(oIdentifier, oConfig) : The count of bookmarks which were updated. Promise
+        // Updates all custom bookmarks matching exactly the identification data.
+        // Only given properties are updated.
         this.updateCustomBookmarks = function (oIdentifier, oConfig) {
             return AppRuntimeService.postMessageToFLP("sap.ushell.services.Bookmark.updateCustomBookmarks", {
                 oIdentifier: oIdentifier,
@@ -137,8 +143,8 @@ sap.ui.define([
             });
         };
 
-        //deleteCustomBookmarks(oIdentifier) : The count of bookmarks which were deleted. Promise
-        //Deletes all custom bookmarks matching exactly the identification data.
+        // deleteCustomBookmarks(oIdentifier) : The count of bookmarks which were deleted. Promise
+        // Deletes all custom bookmarks matching exactly the identification data.
         this.deleteCustomBookmarks = function (oIdentifier) {
             return AppRuntimeService.postMessageToFLP("sap.ushell.services.Bookmark.deleteCustomBookmarks", {
                 oIdentifier: oIdentifier

package/src/main/js/sap/ushell/appRuntime/ui5/services/BookmarkV2.js

@@ -3,17 +3,17 @@
 /**
  * @fileOverview The app runtime wrapper for {@link sap.ushell.services.BookmarkV2}.
  *
- * @version 1.136.3
+ * @version 1.138.0
  */
 sap.ui.define([
     "sap/ushell/services/BookmarkV2",
     "sap/ushell/appRuntime/ui5/AppRuntimeService",
     "sap/ushell/appRuntime/ui5/AppRuntimeContext"
-], function (
+], (
     BookmarkV2,
     AppRuntimeService,
     AppRuntimeContext
-) {
+) => {
     "use strict";
 
     /**
@@ -21,6 +21,10 @@ sap.ui.define([
      * @class
      * @classdesc The app runtime wrapper for {@link sap.ushell.services.BookmarkV2}.
      *
+     * @param {object} oContainerInterface The interface.
+     * @param {string} sParameters Service instantiation.
+     * @param {object} oServiceConfiguration service configuration. A configuration object which may contain service configuration.
+     *
      * @hideconstructor
      *
      * @private
@@ -28,19 +32,19 @@ sap.ui.define([
     function BookmarkV2Proxy (oContainerInterface, sParameters, oServiceConfiguration) {
         BookmarkV2.call(this, oContainerInterface, sParameters, oServiceConfiguration);
 
-        //addBookmark(oParameters, vContainer?) : object - jQuery.Deferred promise
-        //Adds a bookmark tile to one of the user's classic homepage groups or to multiple provided content nodes.
+        // addBookmark(oParameters, vContainer?) : object - jQuery.Deferred promise
+        // Adds a bookmark tile to one of the user's classic homepage groups or to multiple provided content nodes.
         this.addBookmark = function (oParameters, vContainer) {
-            var fnAddBookmark = function () {
+            function fnAddBookmark () {
                 return AppRuntimeService.postMessageToFLP("sap.ushell.services.BookmarkV2.addBookmarkUI5", {
                     oParameters: oParameters,
                     vContainer: vContainer
                 });
-            };
+            }
 
             return new Promise((fnResolve, fnReject) => {
                 if (oParameters.url.startsWith("#")) {
-                    AppRuntimeContext.checkIntentsConversionForScube([{ intent: oParameters.url }]).then(function (aIntentResult) {
+                    AppRuntimeContext.checkIntentsConversionForScube([{ intent: oParameters.url }]).then((aIntentResult) => {
                         oParameters.url = aIntentResult[0].intent;
                         fnAddBookmark().then(fnResolve).catch(fnReject);
                     }).catch(fnReject);
@@ -83,24 +87,24 @@ sap.ui.define([
             );
         };
 
-        //countBookmarks(sUrl) : object - jQuery.Deferred object's promise
-        //Counts all bookmarks pointing to the given URL from all of the user's pages
+        // countBookmarks(sUrl) : object - jQuery.Deferred object's promise
+        // Counts all bookmarks pointing to the given URL from all of the user's pages
         this.countBookmarks = function (sUrl) {
             return AppRuntimeService.postMessageToFLP("sap.ushell.services.BookmarkV2.countBookmarks", {
                 sUrl: sUrl
             });
         };
 
-        //deleteBookmarks(sUrl) : object - jQuery.Deferred object's promise
-        //Deletes all bookmarks pointing to the given URL from all of the user's pages.
+        // deleteBookmarks(sUrl) : object - jQuery.Deferred object's promise
+        // Deletes all bookmarks pointing to the given URL from all of the user's pages.
         this.deleteBookmarks = function (sUrl) {
             return AppRuntimeService.postMessageToFLP("sap.ushell.services.BookmarkV2.deleteBookmarks", {
                 sUrl: sUrl
             });
         };
 
-        //updateBookmarks(sUrl, oParameters) : object - jQuery.Deferred object's promise
-        //Updates all bookmarks pointing to the given URL on all of the user's pages with the given new parameters.
+        // updateBookmarks(sUrl, oParameters) : object - jQuery.Deferred object's promise
+        // Updates all bookmarks pointing to the given URL on all of the user's pages with the given new parameters.
         this.updateBookmarks = function (sUrl, oParameters) {
             return AppRuntimeService.postMessageToFLP("sap.ushell.services.BookmarkV2.updateBookmarks", {
                 sUrl: sUrl,
@@ -108,14 +112,14 @@ sap.ui.define([
             });
         };
 
-        //getContentNodes() : object - jQuery.Deferred promise
-        //Returns available content nodes based on the current launchpad context. (Classic homepage, spaces mode)
+        // getContentNodes() : object - jQuery.Deferred promise
+        // Returns available content nodes based on the current launchpad context. (Classic homepage, spaces mode)
         this.getContentNodes = function () {
             return AppRuntimeService.postMessageToFLP("sap.ushell.services.BookmarkV2.getContentNodes");
         };
 
-        //addCustomBookmark(sVizType, oConfig, vContentNodes) : object - jQuery.Deferred promise
-        //Adds a custom bookmark visualization to one or multiple provided content nodes.
+        // addCustomBookmark(sVizType, oConfig, vContentNodes) : object - jQuery.Deferred promise
+        // Adds a custom bookmark visualization to one or multiple provided content nodes.
         this.addCustomBookmark = function (sVizType, oConfig, vContentNodes) {
             return AppRuntimeService.postMessageToFLP(
                 "sap.ushell.services.BookmarkV2.addCustomBookmark",
@@ -127,9 +131,9 @@ sap.ui.define([
             );
         };
 
-        //countCustomBookmarks(oIdentifier) : The count of bookmarks matching the identifier. Promise
-        //Counts all custom bookmarks matching exactly the identification data.
-        //Can be used to check if a bookmark already exists (e.g. before updating).
+        // countCustomBookmarks(oIdentifier) : The count of bookmarks matching the identifier. Promise
+        // Counts all custom bookmarks matching exactly the identification data.
+        // Can be used to check if a bookmark already exists (e.g. before updating).
         this.countCustomBookmarks = function (oIdentifier) {
             return AppRuntimeService.postMessageToFLP(
                 "sap.ushell.services.BookmarkV2.countCustomBookmarks",
@@ -139,9 +143,9 @@ sap.ui.define([
             );
         };
 
-        //updateCustomBookmarks(oIdentifier, oConfig) : The count of bookmarks which were updated. Promise
-        //Updates all custom bookmarks matching exactly the identification data.
-        //Only given properties are updated.
+        // updateCustomBookmarks(oIdentifier, oConfig) : The count of bookmarks which were updated. Promise
+        // Updates all custom bookmarks matching exactly the identification data.
+        // Only given properties are updated.
         this.updateCustomBookmarks = function (oIdentifier, oConfig) {
             return AppRuntimeService.postMessageToFLP(
                 "sap.ushell.services.BookmarkV2.updateCustomBookmarks",
@@ -152,8 +156,8 @@ sap.ui.define([
             );
         };
 
-        //deleteCustomBookmarks(oIdentifier) : The count of bookmarks which were deleted. Promise
-        //Deletes all custom bookmarks matching exactly the identification data.
+        // deleteCustomBookmarks(oIdentifier) : The count of bookmarks which were deleted. Promise
+        // Deletes all custom bookmarks matching exactly the identification data.
         this.deleteCustomBookmarks = function (oIdentifier) {
             return AppRuntimeService.postMessageToFLP(
                 "sap.ushell.services.BookmarkV2.deleteCustomBookmarks",

package/src/main/js/sap/ushell/appRuntime/ui5/services/CommonDataModel.js

@@ -3,15 +3,15 @@
 /**
  * @fileOverview The app runtime wrapper for {@link sap.ushell.services.CommonDataModel}.
  *
- * @version 1.136.3
+ * @version 1.138.0
  */
 sap.ui.define([
     "sap/ushell/services/CommonDataModel",
     "sap/ushell/appRuntime/ui5/AppRuntimeService"
-], function (
+], (
     CommonDataModel,
     AppRuntimeService
-) {
+) => {
     "use strict";
 
     /**
@@ -19,6 +19,11 @@ sap.ui.define([
      * @class
      * @classdesc The app runtime wrapper for {@link sap.ushell.services.CommonDataModel}.
      *
+     * @param {object} oAdapter The service adapter for the CommonDataModel service, as already provided by the container
+     * @param {object} oContainerInterface The interface.
+     * @param {string} sParameters Service instantiation.
+     * @param {object} oServiceConfiguration service configuration. A configuration object which may contain service configuration.
+     *
      * @hideconstructor
      *
      * @private

package/src/main/js/sap/ushell/appRuntime/ui5/services/Container.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The app runtime wrapper for {@link sap.ushell.Container}.
  *
- * @version 1.136.3
+ * @version 1.138.0
  */
 sap.ui.define([
     "sap/ushell/Container",
@@ -16,20 +16,20 @@ sap.ui.define([
 ) {
     "use strict";
 
-    var oAdapter,
-        oSessionHandlerAgent,
-        oRenderer,
-        isDirty = false,
-        aRegisteredDirtyMethods = [],
-        aAsyncLogoutEventFunctions = [],
-        aSyncLogoutEventFunctions = [],
-        bRegistered = false;
+    let oAdapter;
+    let oSessionHandlerAgent;
+    let oRenderer;
+    let isDirty = false;
+    let aRegisteredDirtyMethods = [];
+    let aAsyncLogoutEventFunctions = [];
+    let aSyncLogoutEventFunctions = [];
+    let bRegistered = false;
 
-    //get indication if we are in App Runtime
+    // get indication if we are in App Runtime
     Container.inAppRuntime = function () {
         return true;
     };
-    //for backward computability
+    // for backward computability
     Container.runningInIframe = this.inAppRuntime;
 
     Container.getFLPUrl = function (bIncludeHash) {
@@ -105,10 +105,10 @@ sap.ui.define([
      * @private
      */
     Container.handleDirtyStateProvider = function (oExternalNavigationContext) {
-        var bDirty = false;
+        let bDirty = false;
         if (aRegisteredDirtyMethods.length > 0) {
             const oNavigationContext = oExternalNavigationContext || this._oShellNavigationInternal.getNavigationContext();
-            for (var i = 0; i < aRegisteredDirtyMethods.length && bDirty === false; i++) {
+            for (let i = 0; i < aRegisteredDirtyMethods.length && bDirty === false; i++) {
                 bDirty = bDirty || (aRegisteredDirtyMethods[i](oNavigationContext) || false);
             }
         }
@@ -120,8 +120,8 @@ sap.ui.define([
             throw new Error("fnDirty must be a function");
         }
 
-        var nIndex = -1;
-        for (var i = aRegisteredDirtyMethods.length - 1; i >= 0; i--) {
+        let nIndex = -1;
+        for (let i = aRegisteredDirtyMethods.length - 1; i >= 0; i--) {
             if (aRegisteredDirtyMethods[i] === fnDirty) {
                 nIndex = i;
                 break;
@@ -139,7 +139,7 @@ sap.ui.define([
     };
 
     this.setAsyncDirtyStateProvider = function () {
-        //overide the orig function in order to do nothing in AppRuntime
+        // overide the orig function in order to do nothing in AppRuntime
     };
 
     // This is used ONLY when a keep-alive application is stored
@@ -154,9 +154,9 @@ sap.ui.define([
     };
 
     function _insertFunction (aFunctionsArray, fnFunction) {
-        var bFound = false;
+        let bFound = false;
 
-        for (var i = 0; i < aFunctionsArray.length; i++) {
+        for (let i = 0; i < aFunctionsArray.length; i++) {
             if (aFunctionsArray[i] === fnFunction) {
                 bFound = true;
                 break;
@@ -194,17 +194,17 @@ sap.ui.define([
     };
 
     Container.executeAsyncAndSyncLogoutFunctions = function () {
-        return new Promise(function (fnResolve, fnReject) {
-            var arrAsyncLogoutEventsPromises = [];
+        return new Promise((fnResolve, fnReject) => {
+            const arrAsyncLogoutEventsPromises = [];
 
             if (aSyncLogoutEventFunctions.length > 0) {
-                for (var i = 0; i < aSyncLogoutEventFunctions.length; i++) {
+                for (let i = 0; i < aSyncLogoutEventFunctions.length; i++) {
                     aSyncLogoutEventFunctions[i]();
                 }
             }
 
             if (aAsyncLogoutEventFunctions.length > 0) {
-                for (var j = 0; j < aAsyncLogoutEventFunctions.length; j++) {
+                for (let j = 0; j < aAsyncLogoutEventFunctions.length; j++) {
                     arrAsyncLogoutEventsPromises.push(aAsyncLogoutEventFunctions[j]());
                 }
             }
@@ -214,7 +214,7 @@ sap.ui.define([
     };
 
     function _detachFunction (aFunctionArray, fnFunction) {
-        for (var i = 0; i < aFunctionArray.length; i++) {
+        for (let i = 0; i < aFunctionArray.length; i++) {
             if (aFunctionArray[i] === fnFunction) {
                 aFunctionArray.splice(i, 1);
                 break;
@@ -245,12 +245,12 @@ sap.ui.define([
 
     const _originalInit = Container.init.bind(Container);
     Container.init = function (sPlatform, mAdapterPackagesByPlatform) {
-        return new Promise(function (fnResolve) {
+        return new Promise((fnResolve) => {
             sap.ui.require([
                 "sap/ushell/appRuntime/ui5/SessionHandlerAgent",
                 "sap/ushell/appRuntime/ui5/renderers/fiori2/Renderer",
                 "sap/ushell/appRuntime/ui5/ui/UIProxy"
-            ], function (SessionHandlerAgent, Renderer) {
+            ], (SessionHandlerAgent, Renderer) => {
                 oSessionHandlerAgent = SessionHandlerAgent;
                 oRenderer = Renderer;
                 _originalInit(sPlatform, mAdapterPackagesByPlatform)
@@ -258,7 +258,7 @@ sap.ui.define([
                         oAdapter = Container._getAdapter();
                         return Container.getServiceAsync("ShellNavigationInternal");
                     })
-                    .then(function (oShellNavigationInternal) {
+                    .then((oShellNavigationInternal) => {
                         // This is already set by the original init function of the Container
                         // We set it again here so that we don't rely on this dependency
                         Container._oShellNavigationInternal = oShellNavigationInternal;