@sapui5/sap.ushell 1.112.1 → 1.113.0

package/src/main/js/sap/ushell/components/CatalogsManager.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2023 SAP SE, All Rights Reserved
 
 sap.ui.define([
     "sap/ui/base/Object",
@@ -56,14 +56,14 @@ sap.ui.define([
             MOVE_TILE: "FLP: Move Tile"
         },
 
-        _aDoableObjects: [],
+        _aDoables: [],
 
         constructor: function (sId, mSettings) {
             this.oLaunchPageServicePromise = sap.ushell.Container.getServiceAsync("LaunchPage").then(function (oLaunchPageService) {
                 this.oLaunchPageService = oLaunchPageService;
             }.bind(this));
 
-            //TODO should be removed when AppFinder and Homapage use seperate model
+            //TODO should be removed when AppFinder and Homepage use separate model
             this.oTileCatalogToGroupsMap = {};
             this.tagsPool = [];
             this.iInitialLoad = 100;
@@ -89,7 +89,7 @@ sap.ui.define([
             var oEventBus = Core.getEventBus();
             oEventBus.subscribe("renderCatalog", this.loadAllCatalogs, this);
             // Doable objects are kept in a global array to enable their off-ing later on.
-            this._aDoableObjects = [
+            this._aDoables = [
                 oEventHub.on("showCatalog").do(this.updateTilesAssociation.bind(this)),
                 oEventHub.on("updateGroups").do(this.updateTilesAssociation.bind(this))
             ];
@@ -98,9 +98,10 @@ sap.ui.define([
         unregisterEvents: function () {
             var oEventBus = Core.getEventBus();
             oEventBus.unsubscribe("renderCatalog", this.loadAllCatalogs, this);
-            this._aDoableObjects.forEach(function (oDoable) {
+            this._aDoables.forEach(function (oDoable) {
                 oDoable.off();
             });
+            this._aDoables = [];
         },
 
         // temporary - should not be exposed
@@ -111,15 +112,14 @@ sap.ui.define([
         loadAllCatalogs: function (/*sChannelId, sEventId, oData*/) {
             var oGroupsPromise = new jQuery.Deferred();
             var that = this;
-            var setDoneCBForGroups;
 
             // automatically resolving the group's promise for the scenario where the groups are
             // already loaded (so the group's promise Done callback will execute automatically is such a case)
             oGroupsPromise.resolve();
 
-            // this is a local function (which could be invoked at 2 points in thie method).
+            // this is a local function (which could be invoked at 2 points in this method).
             // this sets a Done callback on the promise object of the groups.
-            setDoneCBForGroups = function () {
+            var setDoneCBForGroups = function () {
                 oGroupsPromise.done(function () {
                     var aGroups = that.getModel().getProperty("/groups");
                     if (aGroups && aGroups.length !== 0) {
@@ -193,27 +193,20 @@ sap.ui.define([
         },
 
         mapCatalogTilesToGroups: function () {
+            var that = this;
             this.oTileCatalogToGroupsMap = {};
 
-            //Calculate the relation between the CatalogTile and the instances.
+            // calculate the relation between the CatalogTile and the instances.
             var aGroups = this.oModel.getProperty("/groups");
-
-            var tileInd,
-                aTiles,
-                tileId,
-                tileGroups,
-                groupId;
-            var that = this;
-
             aGroups.forEach(function (oGroup) {
                 ["tiles", "links"].forEach(function (sAttribute) {
-                    aTiles = oGroup[sAttribute];
+                    var aTiles = oGroup[sAttribute];
                     if (aTiles) {
-                        for (tileInd = 0; tileInd < aTiles.length; ++tileInd) {
+                        for (var tileInd = 0; tileInd < aTiles.length; ++tileInd) {
                             // no stableIds required, because this is only used in classic homepage
-                            tileId = encodeURIComponent(that.oLaunchPageService.getCatalogTileId(aTiles[tileInd].object));
-                            tileGroups = that.oTileCatalogToGroupsMap[tileId] || [];
-                            groupId = that.oLaunchPageService.getGroupId(oGroup.object);
+                            var tileId = encodeURIComponent(that.oLaunchPageService.getCatalogTileId(aTiles[tileInd].object));
+                            var tileGroups = that.oTileCatalogToGroupsMap[tileId] || [];
+                            var groupId = that.oLaunchPageService.getGroupId(oGroup.object);
                             // We make sure the group is visible and not locked, otherwise we should not put it in the map it fills.
                             if (tileGroups.indexOf(groupId) === -1
                                 && (typeof (oGroup.isGroupVisible) === "undefined" || oGroup.isGroupVisible)
@@ -228,46 +221,36 @@ sap.ui.define([
         },
 
         updateCatalogTilesToGroupsMap: function () {
+            var tileId;
+            var associatedGroups;
+            var aGroups;
             var aCatalog = this.getModel().getProperty("/catalogs");
-            var index,
-                tileId,
-                associatedGrps,
-                aGroups,
-                aCatalogCustom,
-                aCatalogAppboxes,
-                aCatalogCustomIndex,
-                aCatalogAppboxesIndex,
-                oAppBoxTile,
-                oCustomTile;
-            // if the catalogTile model doesn't exist, it will be updated in some time later
-            if (aCatalog) {
-                for (index = 0; index < aCatalog.length; index++) {
-                    aCatalogAppboxes = aCatalog[index].appBoxes;
-
-                    if (aCatalogAppboxes) {
-                        //Iterate over all the appBoxes.
-                        for (aCatalogAppboxesIndex = 0; aCatalogAppboxesIndex < aCatalogAppboxes.length; aCatalogAppboxesIndex++) {
-                            oAppBoxTile = aCatalogAppboxes[aCatalogAppboxesIndex];
+            if (aCatalog) { // if the catalogTile model doesn't exist, it will be updated in some time later
+                for (var index = 0; index < aCatalog.length; index++) {
+                    var aCatalogAppBoxes = aCatalog[index].appBoxes;
+                    if (aCatalogAppBoxes) {
+                        // iterate over all the appBoxes.
+                        for (var aCatalogAppBoxesIndex = 0; aCatalogAppBoxesIndex < aCatalogAppBoxes.length; aCatalogAppBoxesIndex++) {
+                            var oAppBoxTile = aCatalogAppBoxes[aCatalogAppBoxesIndex];
                             // no stableIds required, because this is only used in classic homepage
                             tileId = encodeURIComponent(this.oLaunchPageService.getCatalogTileId(oAppBoxTile.src));
-                            //Get the mapping of the associated groups map.
+                            // get the mapping of the associated groups map.
                             aGroups = this.oTileCatalogToGroupsMap[tileId];
-                            associatedGrps = (aGroups || []);
-                            oAppBoxTile.associatedGroups = associatedGrps;
+                            associatedGroups = (aGroups || []);
+                            oAppBoxTile.associatedGroups = associatedGroups;
                         }
                     }
 
-                    aCatalogCustom = aCatalog[index].customTiles;
-
+                    var aCatalogCustom = aCatalog[index].customTiles;
                     if (aCatalogCustom) {
-                        //Iterate over all the appBoxes.
-                        for (aCatalogCustomIndex = 0; aCatalogCustomIndex < aCatalogCustom.length; aCatalogCustomIndex++) {
-                            oCustomTile = aCatalogCustom[aCatalogCustomIndex];
+                        // iterate over all the appBoxes.
+                        for (var aCatalogCustomIndex = 0; aCatalogCustomIndex < aCatalogCustom.length; aCatalogCustomIndex++) {
+                            var oCustomTile = aCatalogCustom[aCatalogCustomIndex];
                             tileId = encodeURIComponent(this.oLaunchPageService.getCatalogTileId(oCustomTile.src));
-                            //Get the mapping of the associated groups map.
+                            // get the mapping of the associated groups map.
                             aGroups = this.oTileCatalogToGroupsMap[tileId];
-                            associatedGrps = (aGroups || []);
-                            oCustomTile.associatedGroups = associatedGrps;
+                            associatedGroups = (aGroups || []);
+                            oCustomTile.associatedGroups = associatedGroups;
                         }
                     }
                 }
@@ -295,7 +278,7 @@ sap.ui.define([
          *          numIntentSupportedTiles: 0,
          *          "static": false,
          *          customTiles: [
-         *              the notmal tile model.
+         *              the normal tile model.
          *          ],
          *          appBoxes: [
          *              {
@@ -311,12 +294,11 @@ sap.ui.define([
          *      }
          *  ]
          *
-         *  Also We can simplify TileContainer to support Flat List. with no headers.
-         *  TileContainer to support one level indexing visible (true / false).
+         * Also We can simplify TileContainer to support Flat List. with no headers.
+         * TileContainer to support one level indexing visible (true / false).
          *
-         * @param {object} oCatalog
-         *   The catalog that is added to the model
-         * @returns {object} oPromise Promise that resolves to a pending Catalog
+         * @param {object} oCatalog The catalog that is added to the model.
+         * @returns {Promise<object>} Resolves to a pending Catalog.
          *
          */
         addCatalogToModel: function (oCatalog) {
@@ -349,18 +331,14 @@ sap.ui.define([
 
         getTagList: function (maxTags) {
             var indexedTags = {};
-            var ind = 0;
             var tempTagsLst = [];
-            var tag,
-                oTag,
-                sorted;
 
             if (this.oModel.getProperty("/tagList") && this.oModel.getProperty("/tagList").length > 0) {
                 this.tagsPool.concat(this.oModel.getProperty("/tagList"));
             }
 
-            for (ind = 0; ind < this.tagsPool.length; ind++) {
-                oTag = this.tagsPool[ind];
+            for (var ind = 0; ind < this.tagsPool.length; ind++) {
+                var oTag = this.tagsPool[ind];
                 if (indexedTags[oTag]) {
                     indexedTags[oTag]++;
                 } else {
@@ -368,12 +346,12 @@ sap.ui.define([
                 }
             }
 
-            //find the place in the sortedTopTiles.
-            for (tag in indexedTags) {
+            // find the place in the sortedTopTiles.
+            for (var tag in indexedTags) {
                 tempTagsLst.push({ tag: tag, occ: indexedTags[tag] });
             }
 
-            sorted = tempTagsLst.sort(function (a, b) {
+            var sorted = tempTagsLst.sort(function (a, b) {
                 return b.occ - a.occ;
             });
 
@@ -385,9 +363,10 @@ sap.ui.define([
         },
 
         /**
-         * Processes the catalogs retrieved from the service and updates the model
-         * @param {object[]} aPendingCatalogQueue number of catalogs to be displayed
-         * @returns {Promise<void>} Resolves once the processing is done
+         * Processes the catalogs retrieved from the service and updates the model.
+         *
+         * @param {object[]} aPendingCatalogQueue number of catalogs to be displayed.
+         * @returns {Promise<undefined>} Resolves once the processing is done.
          */
         processPendingCatalogs: function (aPendingCatalogQueue) {
             var aCurrentCatalogs = this.oModel.getProperty("/catalogs");
@@ -402,8 +381,8 @@ sap.ui.define([
             // The catalogs are required to be processed one after each other to maintain the correct order
             var oCatalogProcessPromise = aPendingCatalogQueue.reduce(function (oProcessPromise, oPendingCatalogEntry) {
                 return oProcessPromise.then(function () {
-                    var bIsNewCatalog,
-                        oCatalogObject;
+                    var bIsNewCatalog;
+                    var oCatalogObject;
                     var oCatalogEntry = oPendingCatalogEntry.oCatalogEntry;
                     var oCatalogModel = oPendingCatalogEntry.oCatalogModel;
                     var oExistingCatalogInModel = this.searchModelCatalogByTitle(oCatalogModel.title);
@@ -429,7 +408,6 @@ sap.ui.define([
                                     aAllEntryInCatalogMaster.push({
                                         title: oCatalogModel.title
                                     });
-
                                 }
                             }
                             if (this.oModel.getProperty("/enableCatalogTagFilter") === true) {
@@ -454,7 +432,7 @@ sap.ui.define([
 
         _processCatalogObjectForModel: function (oCurrentCatalogObject, oCatalogTile) {
             var oAppBoxNew;
-            //Do not add Item if no intent supported
+            // do not add Item if no intent supported
             if (this._getIsIntentSupported(oCatalogTile)) {
                 if (this._getIsAppBox(oCatalogTile)) {
                     oAppBoxNew = this.createCatalogAppBoxes(oCatalogTile, true);
@@ -463,8 +441,8 @@ sap.ui.define([
                 }
                 return this.createCatalogTiles(oCatalogTile).then(function (oCatalogTileNew) {
                     oCurrentCatalogObject.customTiles.push(oCatalogTileNew);
-                    //add the getTileView to an array of functions that will be executed once the catalog finishs to load
-                    //we need this array in order to call geTileView for all customTiles. see incident: ******
+                    // add the getTileView to an array of functions that will be executed once the catalog finishes loading
+                    // we need this array in order to call geTileView for all customTiles. see incident: ******
                     if (!this.aFnToGetTileView) {
                         this.aFnToGetTileView = [];
                     }
@@ -484,18 +462,16 @@ sap.ui.define([
         },
 
         /**
-         * check if a catalog with the given title already exists in the model.
+         * Checks if a catalog with the given title already exists in the model.
          *
-         *  @param {string} catalogTitle Title of a catalog.
-         *
-         *  @returns {object} - an object that includes:
-         *  - result - a boolean value indicating whether the model already includes a catalog with the same title
-         *  - indexOfPreviousInstanceInModel - the index in the model (in /catalogs) of the existing catalog with the given title
-         *  - indexOfPreviousInstanceInPage - the index in the page of the existing  catalog with the given title,
-         *     this value usually equals (indexOfPreviousInstanceInModel-1) since the model
-         *     includes the dummy-catalog "All Cataslogs"
-         *     that doesn't appear in the page
-         *  - numOfTilesInCatalog - the number of tiles in the catalog with the given title
+         * @param {string} catalogTitle Title of a catalog.
+         * @returns {object} An object that includes:
+         *   - result - a boolean value indicating whether the model already includes a catalog with the same title
+         *   - indexOfPreviousInstanceInModel - the index in the model (in /catalogs) of the existing catalog with the given title
+         *   - indexOfPreviousInstanceInPage - the index in the page of the existing  catalog with the given title,
+         *     this value usually equals (indexOfPreviousInstanceInModel - 1),
+         *     since the model includes the dummy-catalog "All Catalogs" that doesn't appear in the page
+         *   - numOfTilesInCatalog - the number of tiles in the catalog with the given title
          */
         searchModelCatalogByTitle: function (catalogTitle) {
             var catalogs = this.oModel.getProperty("/catalogs");
@@ -526,11 +502,10 @@ sap.ui.define([
         },
 
         /**
-         * A wrapper for LaunchPage.getCatalogTileId which ensures that the stableCatalogTileId
-         * is only fetched for the required scenarios.
+         * A wrapper for LaunchPage.getCatalogTileId which ensures that the stableCatalogTileId is only fetched for the required scenarios.
+         *
          * @param {object} oCatalogTile The CatalogTile returned by the LaunchPage service
          * @returns {string} The catalogTileId
-         *
          * @since 1.99.0
          * @private
          */
@@ -543,8 +518,10 @@ sap.ui.define([
                 sCatalogTileId = this.oLaunchPageService.getStableCatalogTileId(oCatalogTile);
             }
 
-            /*Always fallback on the catalogTileId. Either getStableCatalogTileId is
-            not implemented by the LaunchPageAdapter or spaces is disabled.*/
+            /*
+            Always fallback on the catalogTileId.
+            Either getStableCatalogTileId is not implemented by the LaunchPageAdapter or spaces is disabled.
+            */
             if (!sCatalogTileId) {
                 sCatalogTileId = this.oLaunchPageService.getCatalogTileId(oCatalogTile);
             }
@@ -589,10 +566,9 @@ sap.ui.define([
             }.bind(this));
 
             Promise.all(aCatalogTilePromises).then(function (aResCatalogTile) {
-                var iIndexResCatalogTile;
                 var noTiles = true;
 
-                for (iIndexResCatalogTile = 0; iIndexResCatalogTile < aResCatalogTile.length; iIndexResCatalogTile++) {
+                for (var iIndexResCatalogTile = 0; iIndexResCatalogTile < aResCatalogTile.length; iIndexResCatalogTile++) {
                     if (aResCatalogTile[iIndexResCatalogTile].length !== 0) {
                         noTiles = false;
                         break;
@@ -732,13 +708,11 @@ sap.ui.define([
             var oContext = oData.groupContext;
             var oGroup = this.oModel.getProperty(oContext.getPath());
             var sGroupId = oGroup.groupId;
-            var oResultPromise;
             var oDeferred = new jQuery.Deferred();
             var oResponseData = {};
-            var oEventBus;
 
-            //publish event for UserActivityLog
-            oEventBus = Core.getEventBus();
+            // publish event for UserActivityLog
+            var oEventBus = Core.getEventBus();
             oEventBus.publish("launchpad", "addTile", {
                 catalogTileContext: oCatalogTileContext,
                 groupContext: oContext
@@ -750,7 +724,7 @@ sap.ui.define([
                 return Promise.resolve(oResponseData);
             }
 
-            oResultPromise = this.oLaunchPageService.addTile(oCatalogTileContext.getProperty("src"), oContext.getProperty("object"));
+            var oResultPromise = this.oLaunchPageService.addTile(oCatalogTileContext.getProperty("src"), oContext.getProperty("object"));
             oResultPromise.done(function (oTile) {
                 var aGroups = that.oModel.getProperty("/groups");
                 var sGroupPath = oGroupsHelper.getModelPathOfGroup(aGroups, sGroupId);
@@ -776,8 +750,8 @@ sap.ui.define([
         },
 
         /*
-        * Delete all instances of a catalog Tile from a Group
-        */
+         * Deletes all instances of a catalog Tile from a Group
+         */
         deleteCatalogTileFromGroup: function (oData) {
             var that = this;
             var sDeletedTileCatalogId = decodeURIComponent(oData.tileId);
@@ -786,18 +760,16 @@ sap.ui.define([
             var deferred = new jQuery.Deferred();
             var aDeleteTilePromises = [];
             var aRemovedTileIds = [];
-            var oPositiveDeferred,
-                oDeletePromise;
 
             ["tiles", "links"].forEach(function (sAttribute) {
                 oGroup[sAttribute].forEach(function (oTile) {
                     // no stableIds required, because this is only used in classic homepage
                     var sTmpTileCatalogId = that.oLaunchPageService.getCatalogTileId(oTile.object);
                     if (sTmpTileCatalogId === sDeletedTileCatalogId) {
-                    // Initialize oPositiveDeferred object that will later be resolved with the status of the delete request
-                        oPositiveDeferred = new jQuery.Deferred();
+                        // Initialize oPositiveDeferred object that will later be resolved with the status of the delete request
+                        var oPositiveDeferred = new jQuery.Deferred();
                         // Send the delete request to the server
-                        oDeletePromise = that.oLaunchPageService.removeTile(oGroup.object, oTile.object);
+                        var oDeletePromise = that.oLaunchPageService.removeTile(oGroup.object, oTile.object);
 
                         oDeletePromise.done(
                             (function (oDeferred) {
@@ -823,7 +795,7 @@ sap.ui.define([
 
             // Wait for all of the delete requests before resolving the deferred
             jQuery.when.apply(jQuery, aDeleteTilePromises).done(function (result) {
-            //If some promise was rejected, some tiles was not removed
+                //If some promise was rejected, some tiles was not removed
                 var bSuccess = aDeleteTilePromises.length === aRemovedTileIds.length;
                 //Update groups for removed tiles
                 that.oHomepageManager.deleteTilesFromGroup(oGroup.groupId, aRemovedTileIds);
@@ -834,10 +806,10 @@ sap.ui.define([
         },
 
         /**
-         * @param {i} catalogIndex the index of the catalog
-         * @param {i} numberOfExistingTiles the number of catalog tiles that were already loaded for previous catalog/s with the same title
-         * @param {i} iTile the index of the current catalog tile in the containing catalog
-         * @returns {i} result the catalog tile index
+         * @param {int} catalogIndex the index of the catalog.
+         * @param {int} numberOfExistingTiles the number of catalog tiles that were already loaded for previous catalog/s with the same title.
+         * @param {int} iTile the index of the current catalog tile in the containing catalog.
+         * @returns {int} result the catalog tile index.
          */
         calculateCatalogTileIndex: function (catalogIndex, numberOfExistingTiles, iTile) {
             var result = parseInt(catalogIndex * 100000, 10);
@@ -848,10 +820,8 @@ sap.ui.define([
         /**
          * Shows an appropriate message to the user when action (add or delete tile from group) fails
          *
-         * @param {string} sMsgId
-         *      The localization id of the message
-         * @param {object} aParameters
-         *      Additional parameters for the Message Toast showing the message. Can be undefined.
+         * @param {string} sMsgId The localization id of the message.
+         * @param {object} aParameters Additional parameters for the Message Toast showing the message. Can be undefined.
          */
         notifyOnActionFailure: function (sMsgId, aParameters) {
             oMessagingHelper.showLocalizedError(sMsgId, aParameters);
@@ -860,10 +830,8 @@ sap.ui.define([
         /**
          * Shows an message and update tiles association when action (add or delete tile from group) fails
          *
-         * @param {string} sMsgId
-         *      The localization id of the message
-         * @param {object} aParameters
-         *      Additional parameters for the Message Toast showing the message. Can be undefined.
+         * @param {string} sMsgId The localization id of the message.
+         * @param {object} aParameters Additional parameters for the Message Toast showing the message. Can be undefined.
          */
         resetAssociationOnFailure: function (sMsgId, aParameters) {
             this.notifyOnActionFailure(sMsgId, aParameters);
@@ -875,8 +843,7 @@ sap.ui.define([
         },
 
         _getIsAppBox: function (oCatalogTile) {
-            var sAppFinderDisplayMode,
-                bIsAppBox;
+            var bIsAppBox;
 
             /*
             When appFinderDisplayMode is set to "tiles", non-custom tiles will have the same display as custom tiles
@@ -886,18 +853,17 @@ sap.ui.define([
             */
 
             // get appFinder display mode from configuration
-            sAppFinderDisplayMode = this.oModel.getProperty("/appFinderDisplayMode");
+            var sAppFinderDisplayMode = this.oModel.getProperty("/appFinderDisplayMode");
 
             // determine the catalog tile display mode:
             if (sAppFinderDisplayMode === "tiles") {
                 bIsAppBox = false;
             } else {
                 bIsAppBox = !!(
-                    this.oLaunchPageService.getCatalogTileTargetURL(oCatalogTile)
-                        && (
-                            this.oLaunchPageService.getCatalogTilePreviewTitle(oCatalogTile)
-                            || this.oLaunchPageService.getCatalogTilePreviewSubtitle(oCatalogTile)
-                        )
+                    this.oLaunchPageService.getCatalogTileTargetURL(oCatalogTile) && (
+                        this.oLaunchPageService.getCatalogTilePreviewTitle(oCatalogTile) ||
+                        this.oLaunchPageService.getCatalogTilePreviewSubtitle(oCatalogTile)
+                    )
                 );
             }
             return bIsAppBox;

package/src/main/js/sap/ushell/components/ComponentKeysHandler.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2023 SAP SE, All Rights Reserved
 
 sap.ui.define([
     "sap/ui/core/Core",

package/src/main/js/sap/ushell/components/DestroyHelper.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2023 SAP SE, All Rights Reserved
 
 sap.ui.define([], function () {
     "use strict";

package/src/main/js/sap/ushell/components/GroupsHelper.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2023 SAP SE, All Rights Reserved
 
 sap.ui.define([], function () {
     "use strict";