@sapui5/sap.ushell 1.122.1 → 1.123.0

package/src/main/js/sap/ushell/renderer/Renderer.js

@@ -83,9 +83,9 @@ sap.ui.define([
      */
     var Renderer = UIComponent.extend("sap.ushell.renderer.Renderer", /** @lends sap.ushell.renderer.Renderer.prototype */ {
         metadata: {
-            version: "1.122.1",
+            version: "1.123.0",
             dependencies: {
-                version: "1.122.1",
+                version: "1.123.0",
                 libs: ["sap.ui.core", "sap.m"],
                 components: []
             },
@@ -134,7 +134,17 @@ sap.ui.define([
                         "Shell-appfinder&/:innerHash*:",
                         "Shell-appfinder"
                     ],
-                    target: Config.last("/core/catalog/enabled") ? "appfinder" : undefined // Avoid the loading of Component
+                    target: (function () {
+                        if (
+                            !!Config.last("/core/site/siteId") &&
+                            Config.last("/core/catalog/enabled") &&
+                            Config.last("/core/workPages/contentFinderStandalone")
+                        ) {
+                            return "contentfinder";
+                        }
+
+                        return Config.last("/core/catalog/enabled") ? "appfinder" : undefined; // Avoid the loading of Component
+                    })()
                 }, {
                     name: "openFLPPage",
                     pattern: [
@@ -212,6 +222,16 @@ sap.ui.define([
                             }
                         }
                     },
+                    contentfinder: {
+                        name: "sap.ushell.components.contentFinderStandalone",
+                        type: "Component",
+                        id: "Shell-appfinder-component",
+                        options: {
+                            manifest: true,
+                            asyncHints: { preloadBundles: [] },
+                            componentData: {}
+                        }
+                    },
                     pages: {
                         name: "sap.ushell.components.pages",
                         type: "Component",
@@ -1416,18 +1436,6 @@ sap.ui.define([
         }
     };
 
-    /**
-     * This method returns the current state of the Viewport Container control.
-     *
-     * <br>Note: Was public with fiori2/Renderer
-     * @returns {string} The current Viewport State.
-     * @since 1.37
-     * @private
-     */
-    Renderer.prototype.getCurrentViewportState = function () {
-        return this.shellCtrl.getCurrentViewportState();
-    };
-
     /*------------------------------------------------ Adding controls functionality ------------------------------------------*/
 
     /**
@@ -2587,20 +2595,28 @@ sap.ui.define([
         }
     };
 
-    Renderer.prototype.addRightViewPort = function (oView) {
-        this.shellCtrl.getViewPortContainer().addRightViewPort(oView, false);
-    };
+    /**
+     * @param {sap.ui.core.Control} oView
+     * @deprecated since 1.120 The ViewPortState is related to Fiori2 and not used anymore.
+     */
+    Renderer.prototype.addRightViewPort = function (oView) {};
 
-    Renderer.prototype.addLeftViewPort = function (oView) {
-        this.shellCtrl.getViewPortContainer().addLeftViewPort(oView, false);
-    };
+    /**
+     * @param {sap.ui.core.Control} oView
+     * @deprecated since 1.120 The ViewPortState is related to Fiori2 and not used anymore.
+     */
+    Renderer.prototype.addLeftViewPort = function (oView) {};
 
     Renderer.prototype.getShellController = function () {
         return this.shellCtrl;
     };
 
+    /**
+     * @returns {string} The current ViewPort State
+     * @deprecated since 1.120 The ViewPortState is related to Fiori2 and not used anymore.
+     */
     Renderer.prototype.getViewPortContainerCurrentState = function () {
-        return this.shellCtrl.getViewPortContainer().getCurrentState();
+        return "Center";
     };
 
     Renderer.prototype.ViewPortContainerNavTo = function (sName, sTargetName, sAction) {
@@ -2621,18 +2637,10 @@ sap.ui.define([
         this.shellCtrl.setUserActionsMenuSelected(bSelected);
     };
 
-    Renderer.prototype.getUserActionsMenuSelected = function () {
-        return this.shellCtrl.getUserActionsMenuSelected();
-    };
-
     Renderer.prototype.setNotificationsSelected = function (bSelected) {
         this.shellCtrl.setNotificationsSelected(bSelected);
     };
 
-    Renderer.prototype.getNotificationsSelected = function () {
-        return this.shellCtrl.getNotificationsSelected();
-    };
-
     Renderer.prototype.addShellDanglingControl = function (oControl) {
         this.shellCtrl.getView().addDanglingControl(oControl);
     };
@@ -2641,8 +2649,12 @@ sap.ui.define([
         return (this.shellCtrl.getView().getViewData() ? this.shellCtrl.getView().getViewData().config || {} : {});
     };
 
+    /**
+     * @returns {object} The configuration
+     * @deprecated since 1.93
+     */
     Renderer.prototype.getEndUserFeedbackConfiguration = function () {
-        return {}; // Deprecated
+        return {};
     };
 
     Renderer.prototype.reorderUserPrefEntries = function (entries) {
@@ -2677,7 +2689,7 @@ sap.ui.define([
      * It returns true if it can match the intent, false otherwise.
      * On its first call, a copy of all of those path is created and stored.
      *
-     * @param {object} oParsedHash A resolved hash as returned by URLParing
+     * @param {object} oParsedHash A resolved hash as returned by URLParsing
      * @returns {boolean} True if the intent is built in, false otherwise
      * @private
      * @since 1.85.0

package/src/main/js/sap/ushell/renderer/Shell.controller.js

@@ -228,6 +228,7 @@ sap.ui.define([
             // this file to the custom router. Maybe use oRouter.attachBypassed?
             oRouter.getTarget("home").attachDisplay(this.onComponentTargetDisplay, this);
             oRouter.getTarget("appfinder").attachDisplay(this.onComponentTargetDisplay, this);
+            oRouter.getTarget("contentfinder").attachDisplay(this.onComponentTargetDisplay, this);
             oRouter.getTarget("pages").attachDisplay(this.onComponentTargetDisplay, this);
             oRouter.getTarget("workpages").attachDisplay(this.onComponentTargetDisplay, this);
             oRouter.getTarget("runtimeSwitcher").attachDisplay(this.onComponentTargetDisplay, this);
@@ -418,14 +419,12 @@ sap.ui.define([
                 EventHub.on("toggleContentDensity").do(this.toggleContentDensity.bind(this)),
                 EventHub.on("ShellFloatingContainerUndockOnResize").do(this._handleFloatingContainerUndockOnResize.bind(this)),
                 EventHub.on("ShellFloatingContainerDockedIsResized").do(this._emitFloatingContainerResizeEvent.bind(this)),
-                EventHub.on("LaunchpadCustomRouterRouteMatched").do(this._centerViewPort.bind(this)),
 
                 EventHub.once("CoreResourcesComplementLoaded").do(this._onCoreResourcesComplementLoaded.bind(this)),
                 EventHub.once("loadRendererExtensions").do(this._loadRendererExtensionPlugins.bind(this)),
                 EventHub.once("loadUsageAnalytics").do(this._loadUsageAnalytics.bind(this)),
                 EventHub.once("loadWarmupPlugins").do(this._loadWarmupPlugins.bind(this)),
-                EventHub.once("loadTrackingActivitiesSetting").do(this._loadTrackingActivitiesSetting.bind(this)),
-                EventHub.on("centerViewPort").do(this._centerViewPort.bind(this))
+                EventHub.once("loadTrackingActivitiesSetting").do(this._loadTrackingActivitiesSetting.bind(this))
             ].forEach(function (oDoable) {
                 this.addDoable(oDoable);
             }.bind(this));
@@ -1865,10 +1864,6 @@ sap.ui.define([
             return oHandlerPromise;
         },
 
-        _centerViewPort: function () {
-            this.oViewPortContainer.switchState("Center");
-        },
-
         _isShellHomeIntent: function (sIntent) {
             return sIntent === "#" || sIntent === oConfig.rootIntent;
         },
@@ -2369,10 +2364,6 @@ sap.ui.define([
             });
         },
 
-        getCurrentViewportState: function () {
-            return Config.last("/core/shell/model/currentViewPortState");
-        },
-
         _activateFloatingUIActions: function (iWindowWidth) {
             if (iWindowWidth < 417) {
                 this.oFloatingUIActions.disable();
@@ -2516,11 +2507,6 @@ sap.ui.define([
         },
 
         _emitFloatingContainerResizeEvent: function () {
-            var oViewPortContainer = Element.getElementById("viewPortContainer");
-            if (oViewPortContainer) {
-                oViewPortContainer._handleSizeChange();
-            }
-
             // handle appFinder size changed
             // timeOut waiting for resize event is finish
             window.setTimeout(function () {
@@ -3103,16 +3089,8 @@ sap.ui.define([
             EventHub.emit("showUserActionsMenu", bSelected);
         },
 
-        getUserActionsMenuSelected: function () {
-            return Config.last("/core/shell/model/currentViewPortState") === "LeftCenter";
-        },
-
         setNotificationsSelected: function (bSelected) {
             EventHub.emit("showNotifications", bSelected);
-        },
-
-        getNotificationsSelected: function () {
-            return Config.last("/core/shell/model/currentViewPortState") === "RightCenter";
         }
     });
 });

package/src/main/js/sap/ushell/renderer/search/searchComponent/manifest.json

@@ -3,7 +3,7 @@
     "sap.app": {
         "id": "sap.ushell.renderer.search.searchComponent",
         "applicationVersion": {
-            "version": "1.122.1"
+            "version": "1.123.0"
         },
         "type": "component"
     },

package/src/main/js/sap/ushell/renderers/fiori2/Renderer.js

@@ -464,7 +464,8 @@
      * @deprecated since 1.120.0 This functionality was discontinued
      */
     Fiori2Renderer.prototype.getCurrentViewportState = function () {
-        return Renderer.prototype.getCurrentViewportState.apply(this, arguments);
+        // Hardcoded to "Center" as this is related to removed fiori2 functionality
+        return "Center";
     };
 
     /**

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

@@ -140,18 +140,23 @@ sap.ui.define([
         };
         this.getCurrentAppliction = this.getCurrentApplication; // Fixes typo error in the naming of "this.getCurrentAppliction"
 
+
+        /**
+         * Type for the metadata object for AppConfiguration
+         * @typedef {object} sap.ushell.services.AppConfiguration.Metadata
+         * @property {string} title The title of the application
+         * @property {string} library The library of the application
+         * @property {string} version The version of the application
+         * @property {boolean} fullWidth A Boolean value indicating if the application fills the full width of the screen
+         * @since 1.120.0
+         * @public
+         */
+
         /**
          * Returns the current metadata.
          *
-         * {
-         *   title: {string}
-         *   library: {string}
-         *   version: {string}
-         *   fullWidth: {boolean}
-         * }
-         *
          * @param {object} [oApplication] oApplication
-         * @returns {object} A copy of the metadata object
+         * @returns {sap.ushell.services.AppConfiguration.Metadata} A copy of the metadata object
          *
          * @private
          * @ui5-restricted sap.feedback.ui
@@ -173,8 +178,10 @@ sap.ui.define([
         };
 
         /**
-         * @private
          * @alias sap.ushell.services.AppConfiguration#_getMemoizationKey
+         * @param {string} sCompleteHash The complete hash
+         * @returns {sap.ui.core.URI} The intent
+         * @private
          */
         this._getMemoizationKey = function (sCompleteHash) {
             var aHashParts = sCompleteHash.split("?");
@@ -445,9 +452,12 @@ sap.ui.define([
          * whose key is composed of the original key + the string "Resource".
          * e.g. For translating the value of the property "title" - there's another configuration property: "titleResource": "TITLE_KEY".
          * The value (e.g. "TITLE_KEY") is the translation key in the resource bundle
-         *
-         * @private
          * @alias sap.ushell.services.AppConfiguration#getPropertyValueFromConfig
+         * @param {object} oConfig The configuration
+         * @param {string} sPropertyKey The property key
+         * @param {sap.base.i18n.ResourceBundle} oResourceBundle The resource bundle
+         * @returns {string|undefined} The value of the property, or undefined if the property is not found
+         * @private
          */
         this.getPropertyValueFromConfig = function (oConfig, sPropertyKey, oResourceBundle) {
             var oValue;
@@ -464,8 +474,12 @@ sap.ui.define([
         /**
          * Reads a property value from the manifest
          *
-         * @private
          * @alias sap.ushell.services.AppConfiguration#getPropertyValueFromManifest
+         * @param {object} oLocalMetadataComponent The metadata component
+         * @param {object} oProperties The properties
+         * @param {string} sPropertyKey The property key
+         * @returns {string|Object"""} The value of the property, or undefined if the property is not found
+         * @private
          */
         this.getPropertyValueFromManifest = function (oLocalMetadataComponent, oProperties, sPropertyKey) {
             var sManifestEntryKey = oProperties[sPropertyKey].manifestEntryKey,

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

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's AppLifeCycle service enables plug-ins to enquire the which
  *    application is currently displayed and listen to life cycle events.
  *
- * @version 1.122.1
+ * @version 1.123.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -63,46 +63,160 @@ sap.ui.define([
         var oEventProvider;
 
         /**
-         * Returns information about the currently running application.
+         * Enumeration of application types.
+         * @since 1.120.0
+         * @public
+         * @enum {string}
          *
-         * The function returns an object with following parameters:
-         * <ul>
-         *   <li> applicationType: “UI5|WDA|NWBC|URL|TR” </li>
-         *   <li> componentInstance: reference to component (only for applicationType "UI5"). </li>
-         *   <li> homePage: <code>true</code> when root intent (normally #Shell-home) or Appfinder (#Shell-appfinder) is currently displayed. </li>
-         *   <li> getTechnicalParameter: <code>function</code> that returns the value of a technical parameter for the given application.
-         *        This method is for SAP internal usage only. </li>
-         *   <li> getIntent: <code>function</code> that returns a <code>Promise</code> that resolves with the current shell hash as
-         *        an <code>Object</code>. See {@link sap.ushell.services.URLParsing#parseShellHash} for details.
-         *        <i>This property is for SAP-internal use only!</i> </li>
-         *   <li> getInfo: <code>function</code> that is called with an <code>Array</code>
-         *        with following optional elements of type <code>String</code>
-         *        <ul>
-         *          <li> <code> productName </code> A human readable free form text maintained on the platform where FLP runs,
-         *               and identifying the current product.</li>
-         *          <li> <code> theme </code> Current FLP theme. Includes the path to the theme resources
-         *               if the theme is not an sap theme (does not start with sap_)</li>
-         *          <li> <code> languageTag </code> Current Language (BCP47 format)</li>
-         *          <li> <code> appIntent </code> Intent that was used to launch the application (including parameters)</li>
-         *          <li> <code> appFrameworkId </code>ID of the framework </li>
-         *          <li> <code> technicalAppComponentId </code> Identifier of the component that implements the base application.</li>
-         *          <li> <code> appId </code> Universal stable logical identifier of the application across the whole content.</li>
-         *          <li> <code> appVersion </code> Version of the app</li>
-         *          <li> <code> appSupportInfo </code> The name of an organizational component that handles support incidents.</li>
-         *          <li> <code> appFrameworkVersion </code> Version of the framework </li>
-         *        </ul>
-         *        The <code>function</code> returns a <code>Promise</code> that resolves with an <code>Object</code>
-         *        with properties corresponding to the elements of the <code>Array</code> passed as input.
-         *        Each of these properties holds its value or undefined if not configured.
-         * </ul>
+        */
+        AppLifeCycle.ApplicationType = {
+            /**
+             * The application is a UI5 application.
+             * @public
+             */
+            UI5: "UI5",
+            /**
+             * The application is a Webdynpro application.
+             * @public
+             */
+            WDA: "WDA",
+            /**
+             * The application is starting using the SAP Business Client.
+             * @public
+             */
+            NWBC: "NWBC",
+            /**
+             * The application is started using a URL
+             * @public
+             */
+            URL: "URL",
+            /**
+             * The application is started using a transaction
+             * @public
+             */
+            TR: "TR"
+        };
+
+        /**
+         * Defines an intent.
+         *  See {@link sap.ushell.services.URLParsing#parseShellHash} for details.
+         *
+         * @typedef {object} sap.ushell.services.AppLifeCycle.Intent
+         * @property {string} semanticObject The semantic object of the intent.
+         * @property {string} action The action of the intent.
+         * @property {string} contextRaw The raw context of the intent.
+         * @property {Object<string,string[]>} params The parameters of the intent.
+         * @property {string} appSpecificRoute The app specific route of the intent.
+         * @since 1.120.0
+         * @public
+         */
+
+        /**
+         * Enumeration of application info parameter names.
+         * @since 1.120.0
+         * @public
+         * @enum {string}
          *
+         */
+        AppLifeCycle.AppInfoParameterName = {
+            /**
+             * A human readable free form text maintained on the platform where FLP runs, and identifying the current product.
+             * @public
+             */
+            productName: "productName",
+            /**
+             * Current FLP theme. Includes the path to the theme resources if the theme is not an sap theme (does not start with sap_)
+             * @public
+             */
+            theme: "theme",
+            /**
+             * Current Language (BCP47 format)
+             * @public
+             */
+            languageTag: "languageTag",
+            /**
+             * Intent that was used to launch the application (including parameters)
+             * @public
+             */
+            appIntent: "appIntent",
+            /**
+             * ID of the framework
+             * @public
+             */
+            appFrameworkId: "appFrameworkId",
+            /**
+             * Identifier of the component that implements the base application.
+             * @public
+             */
+            technicalAppComponentId: "technicalAppComponentId",
+            /**
+             * Universal stable logical identifier of the application across the whole content.
+             * @public
+             */
+            appId: "appId",
+            /**
+             * Version of the app
+             * @public
+             */
+            appVersion: "appVersion",
+            /**
+             * The name of an organizational component that handles support incidents.
+             * @public
+             */
+            appSupportInfo: "appSupportInfo",
+            /**
+             * Version of the framework
+             * @public
+             */
+            appFrameworkVersion: "appFrameworkVersion"
+        };
+
+        /**
+         * Defines the application info.
+         *
+         * @typedef {object} sap.ushell.services.AppLifeCycle.AppInfo
+         * @property {string} productName
+         * A human readable free form text maintained on the platform where FLP runs, and identifying the current product.
+         * @property {string} theme
+         * Current FLP theme. Includes the path to the theme resources if the theme is not an sap theme (does not start with sap_)
+         * @property {string} languageTag Current Language (BCP47 format)
+         * @property {string} appIntent Intent that was used to launch the application (including parameters)
+         * @property {string} appFrameworkId ID of the framework
+         * @property {string} technicalAppComponentId Identifier of the component that implements the base application.
+         * @property {string} appId Universal stable logical identifier of the application across the whole content.
+         * @property {string} appVersion Version of the app
+         * @property {string} appSupportInfo The name of an organizational component that handles support incidents.
+         * @property {string} appFrameworkVersion Version of the framework
+         * @since 1.120.0
+         * @public
+         */
+
+        /**
+         * Defines the current application.
+         *
+         * @typedef sap.ushell.services.AppLifeCycle.CurrentApplication
+         * @property {sap.ushell.services.AppLifeCycle.ApplicationType} applicationType The type of the current application.
+         * @property {sap.ui.core.Component} [componentInstance] reference to component (only for applicationType "UI5")
+         * @property {boolean} homePage <code>true</code> when root intent (normally #Shell-home) or Appfinder (#Shell-appfinder) is currently displayed.
+         * @property {function} getTechnicalParameter
+         * function that returns the value of a technical parameter for the given application.
+         * This method is for SAP internal usage only.
+         * @property {function():Promise<sap.ushell.services.AppLifeCycle.Intent>} getIntent
+         * See {@link sap.ushell.services.URLParsing#parseShellHash} for details. <i>This property is for SAP-internal use only!</i>
+         * @property {function(Array<sap.ushell.services.AppLifeCycle.AppInfoParameterName>): Promise<sap.ushell.services.AppLifeCycle.AppInfo>} getInfo
+         * provides the values of the given parameters.
+         * @since 1.120.0
+         * @public
+        */
+
+        /**
+         * Returns information about the currently running application
+         * Information object about currently running application or <code>undefined</code> if no application is running.
+         *
+         * @returns {sap.ushell.services.AppLifeCycle.CurrentApplication|undefined} Information object about currently running application or <code>undefined</code> if no application is running.
          * <b>Note:</b>
          * Return value is only valid after app is loaded. See {@link #attachAppLoaded} for details.
          * Before an app is loaded, <code>undefined</code> is returned.
-         *
-         * @returns {object|undefined}
-         *   Information object about currently running application or <code>undefined</code> if no application is running.
-         *
          * @since 1.38
          * @public
          */
@@ -114,10 +228,11 @@ sap.ui.define([
          * Attaches an event handler for the appLoaded event. This event handler will be triggered
          * each time an application has been loaded.
          *
-         * @param {object} oData
+         * @template ObjectToBePassedToHandler {object} Object that will be passed to the handler along with the event object when the event is fired.
+         * @param {ObjectToBePassedToHandler} oData
          *     An object that will be passed to the handler along with the event object when the
          *     event is fired.
-         * @param {function} fnFunction
+         * @param {function(sap.ui.base.Event, ObjectToBePassedToHandler)} fnFunction
          *     The handler function to call when the event occurs.
          * @param {object} oListener
          *     The object that wants to be notified when the event occurs (this context within the
@@ -147,7 +262,7 @@ sap.ui.define([
          * Set current application object from AppRuntime in cFLP
          *
          * @param {string} sApplicationType The type of the current application.
-         * @param {object} oComponentInstance The instance of the component.
+         * @param {sap.ui.core.Component} oComponentInstance The instance of the component.
          * @param {boolean} bHomePage Indicator for a home page.
          * @param {string} oApplicationContainer The application container.
          * @param {string} sFramework The type of the current application running in iframe.

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.122.1
+ * @version 1.123.0
  */
 sap.ui.define([
     "sap/ui/base/Object",

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.122.1
+ * @version 1.123.0
  * @deprecated As of version 1.120
  */
 sap.ui.define([