@sapui5/sap.ushell 1.122.1 → 1.123.0

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview APIs for the S/4 MyHome
- * @version 1.122.1
+ * @version 1.123.0
  */
 sap.ui.define([
     "sap/ushell/Config",
@@ -61,7 +61,7 @@ sap.ui.define([
      * Returns the data of a page
      *
      * @param {string} pageId ID of the page
-     * @returns {Promise<object>} Promise that resolves with the page data
+     * @returns {Promise<sap.ushell.services.Pages.PageData>} Promise that resolves with the page data
      * @since 1.103.0
      *
      * @private
@@ -84,7 +84,7 @@ sap.ui.define([
      * Returns the data of multiple pages
      *
      * @param {string[]} pageIds IDs of the pages
-     * @returns {Promise<object>} Promise that resolves with the page data
+     * @returns {Promise<sap.ushell.services.Pages.PageData[]>} Promise that resolves with the page data
      * @since 1.103.0
      *
      * @private
@@ -112,7 +112,7 @@ sap.ui.define([
      *
      * @param {string} pageId The ID of the page to which the section is added
      * @param {int} sectionIndex The index of the added section on the page
-     * @param {object} [sectionProperties] Properties of the added section
+     * @param {sap.ushell.services.Pages.Section} [sectionProperties] Properties of the added section
      *
      * @returns {Promise<undefined>} Promise which resolves after the personalization was saved
      *
@@ -161,7 +161,7 @@ sap.ui.define([
      * @param {int} targetSectionIndex The index of the section to which the visualization should be moved
      * @param {int} targetVisualizationIndex The new index of the moved visualization. If -1 is passed, the visualization is moved to the last position.
      *
-     * @returns {Promise<object>} Promise which resolves with an object containing the visualizationIndex after the personalization was saved
+     * @returns {Promise<{visualizationIndex: int}>} Promise which resolves with an object containing the visualizationIndex after the personalization was saved.
      * @since 1.103.0
      *
      * @private
@@ -235,7 +235,7 @@ sap.ui.define([
     /**
      * Creates VizInstance controls from the visualization data returned by getPage and getPages.
      *
-     * @param {object} vizData Data for a visualization
+     * @param {sap.ushell.services.Pages.Visualization} vizData Data for a visualization
      *
      * @returns {sap.ushell.ui.launchpad.VizInstanceBase} A VizInstance control
      *
@@ -303,15 +303,22 @@ sap.ui.define([
     };
 
     /**
-     * Attempt to determine a value for the parameter name.
+     * Type for describing a parameter value range.
      *
-     * @param {string} parameterName The parameter name
+     * @typedef {object} sap.ushell.services.SpaceContent.Range
+     * @property {string} Sign The sign value of the range.
+     * @property {string} Option The option value of the range.
+     * @property {string} Low The low value of the range.
+     * @property {string} High The high value of the range.
      *
-     * @returns {Promise<object>}
-     *    A Promise that resolves to an object containing the parameter values.
-     *    Returns single parameters in property value and range parameters in
-     *    property extendedValue.
-     *    Example:
+     * @since 1.120.0
+     * @public
+     */
+
+    /**
+     * Type for the value of a UserDefault parameter. It contains either a value, an extendedValue, or both.
+     *
+     * Example:
      * <pre>
      *      {
      *          "value": "ZMAT1",
@@ -328,6 +335,24 @@ sap.ui.define([
      *      }
      * </pre>
      *
+     * @typedef {object} sap.ushell.services.SpaceContent.ParameterValue
+     * @property {string} [value] The value of a single-parameter.
+     * @property {{Ranges: sap.ushell.services.SpaceContent.Range[]}} [extendedValue] Object containing the ranges for a range-parameter.
+     *
+     * @since 1.120.0
+     * @public
+     */
+
+    /**
+     * Attempt to determine a value for the parameter name.
+     *
+     * @param {string} parameterName The parameter name
+     *
+     * @returns {Promise<null|sap.ushell.services.SpaceContent.ParameterValue>}
+     *    A Promise that resolves to an object containing the parameter values.
+     *    Returns single parameters in property value and range parameters in
+     *    property extendedValue. Returns null if the parameter has no value.
+     *
      * @since 1.103.0
      *
      * @private

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

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's UI tracing service.
  *
- * @version 1.122.1
+ * @version 1.123.0
  */
 sap.ui.define([
     "sap/ushell/EventHub",

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

@@ -158,10 +158,18 @@ sap.ui.define([
         };
 
         /**
-         * parse parameters from a URI query string (starting with ?) into a parameter object
+         * Type for Url value
+         * @typedef {string|int} sap.ushell.services.URLParsing.URLValue
+         * @since 1.120.0
+         * @public
+         */
+
+        /**
+         * This method parses parameters from a URI query string (starting with ?)
+         *  and puts the result into a parameter object.
          *
-         * @param {string} sParams Parameter string, e.g. <code>?ABC=1&ABC=1%202DEF=4</code>
-         * @returns {object} oParams, any value { ABC : ["1", "1 2DEF=4"]}
+         * @param {sap.ui.core.URI} sParams Parameter string, e.g. <code>?ABC=1&ABC=1%202&DEF=4</code>
+         * @returns {Object<string, sap.ushell.services.URLParsing.URLValue[]>} The parsed parameters, e.g. { ABC : ["1", "1 2"], DEF : ["4"]}.
          *
          * @since 1.20.0
          * @public
@@ -171,11 +179,12 @@ sap.ui.define([
         };
 
         /**
+         *
          * combine members of a javascript object into a parameter string,
          * note that parameters are ordered in an arbitrary manner which is subject to change
          *
-         * @param {object} oParams any value { ABC : [1,"1 2"], DEF : ["4"]}
-         * @returns {string} <code>ABC=1&ABC=1%202DEF=4</code>
+         * @param {Object<string, sap.ushell.services.URLParsing.URLValue[]>} oParams The parameters to combine into the parameter String, e.g. <code>{ ABC : [1,"1 2"], DEF : ["4"]}</code>
+         * @returns {sap.ui.core.URI} * @returns {sap.ui.core.URI} The parameter string, e.g. <code>ABC=1&ABC=1%202&DEF=4</code>.
          *   Note that the result is *not* prefixed with a "?", parameter values are encodeURIComponent encoded.
          *
          * @since 1.20.0
@@ -200,22 +209,24 @@ sap.ui.define([
             return UrlParsingUtil.privparamsToString(oParams, sDelimiter, sAssign);
         };
 
+        /**
+         * Type for decomposedHash
+         * @typedef {object} sap.ushell.services.URLParsing.decomposedHash
+         * @property {string} semanticObject the semantic object
+         * @property {string} action the action
+         * @property {string} contextRaw the raw context string
+         * @property {Object<string, string[]>} params the parameters
+         * @since 1.120.0
+         * @public
+         */
+
         /**
          * Decompose a shell hash into the respective parts
          *
-         * @param {string} sHash Hash part of a shell compliant URL
+         * @param {sap.ushell.services.Navigation.TargetIntent} sHash Hash part of a shell compliant URL
          *   <code>#SO-Action~Context?P1=a&P2=x&/route?RPV=1</code> the hash part of an URL, <br/>
          *   e.g. <code>"#Object-name~AFE2==?PV1=PV2&PV4=V5&/display/detail/7?UU=HH</code>
-         * @returns {object} <code>undefined</code> if not a parsable hash<br/>
-         * <pre>
-         *   {
-         *     semanticObject : string, <br/>
-         *     action : string, <br/>
-         *     contextRaw : string, <br/>
-         *     params :  MapObject<String,Array[String]>, <br/>
-         *     appSpecificRoute : string <br/>
-         *   }
-         * </pre>
+         * @returns {sap.ushell.services.URLParsing.decomposedHash} <code>undefined</code> if not a parsable hash<br/>
          *   Note that params always has an Array for each parameter value!
          *
          * @since 1.16.0
@@ -238,15 +249,26 @@ sap.ui.define([
             return UrlParsingUtil.privstripLeadingHash(sHash);
         };
 
+        /**
+         * Type for splitHash
+         * @typedef {object} sap.ushell.services.URLParsing.splitHash
+         * @property {sap.ui.core.URI} shellPart the shell part of the hash
+         * @property {sap.ui.core.URI} appSpecificRoute the app specific route part of the hash
+         * @since 1.120.0
+         * @public
+         */
+
         /**
          * split a Unified Shell compliant hash into an Object containing a shell specific part and an app specific parts</br>
          * for non compliant hash strings, the empty object {} is returned.
          * an optional leading # is stripped
          *
-         * @param {string} sHash Hash part of a shell conformant URL
-         *   <code>#SO-Action~Context?P1=a&P2=x&/route?RPV=1<code>
-         *   the hash part of an URL, e.g. <code>"#Object-name~AFE2==?PV1=PV2&PV4=V5&/display/detail/7?UU=HH<code>
-         * @returns {object}
+         * @param {sap.ushell.services.Navigation.TargetIntent} sHash The hash part of a shell conformant URL.
+         *  It has to have the following format:
+         *  <code>#SO-Action~Context?P1=a&P2=x&/route?RPV=1<code>
+         *  Here is an example for the hash part of an URL:
+         *  <code>"#Object-name~AFE2==?PV1=PV2&PV4=V5&/display/detail/7?UU=HH<code>
+         * @returns {sap.ushell.services.URLParsing.splitHash}
          *   <code>{}</code>(empty object) if not a parsable hash
          * <pre>
          *   {

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

@@ -6,7 +6,7 @@
  * Service wrapper for the sap/ushell/utils/UrlShortening module.
  * @deprecated since 1.118. Please use the UrlShortening module directly.
  *
- * @version 1.122.1
+ * @version 1.123.0
  */
  sap.ui.define(["sap/ushell/utils/UrlShortening"], function (UrlShortening) {
     "use strict";

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

@@ -1,7 +1,7 @@
 // Copyright (c) 2009-2023 SAP SE, All Rights Reserved
 /**
  * @fileOverview The URLTemplate service provides utilities when working with URL templates
- * @version 1.122.1
+ * @version 1.123.0
  */
 sap.ui.define([
     "sap/ushell/utils",

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

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's UI5 component loader service.
  * This is a shell-internal service and no public or application facing API!
  *
- * @version 1.122.1
+ * @version 1.123.0
  */
 sap.ui.define([
     "sap/base/Log",

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

@@ -14,7 +14,7 @@
  *
  * This is *not* an application facing service, but for Shell Internal usage.
  *
- * @version 1.122.1
+ * @version 1.123.0
  */
 sap.ui.define([
     "sap/base/Log",

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

@@ -7,7 +7,7 @@
  *               This service should be accessed by the application
  *               via the CrossApplicationNavigation service.
  *
- * @version 1.122.1
+ * @version 1.123.0
  */
 sap.ui.define([
     "sap/base/Log",

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

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's user information service. Allows retrieving information about the logged-in user.
  *
- * @version 1.122.1
+ * @version 1.123.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -119,10 +119,23 @@ sap.ui.define([
         };
 
         /**
-         * Returns an object representing data about the user: ID, first name, last name, full name, e-mail address.
+         * Type for an object representing data about the user: ID, first name, last name, full name, e-mail address.
+         * @typedef {object} sap.ushell.services.UserInfo.ShellUserInfo
+         * @property {string} id The user id.
+         * @property {string} email The user's email address.
+         * @property {string} firstName The user's first name.
+         * @property {string} lastName The user's last name.
+         * @property {string} fullName The user's full name.
+         *
+         * @since 1.120.0
+         * @public
+         */
+
+        /**
+         * Returns an object representing data about the user.
          *
-         * @returns {Promise}
-         *      object providing information about the logged-in user: ID, first name, last name, full name, e-mail address
+         * @returns {Promise<sap.ushell.services.UserInfo.ShellUserInfo>}
+         *      Object providing information about the logged-in user.
          *
          * @since 1.71.0
          * @public

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview The Unified Shell's user activity service.
- * @version 1.122.1
+ * @version 1.123.0
  */
 sap.ui.define([
     "sap/base/util/ObjectPath",

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

@@ -7,7 +7,7 @@
  *
  * Configured with the LaunchPageAdapter.
  *
- * @version 1.122.1
+ * @version 1.123.0
  */
 sap.ui.define([
     "sap/ushell/resources",

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview This module deals with the instantiation of visualizations in a platform independent way.
- * @version 1.122.1
+ * @version 1.123.0
  */
 sap.ui.define([
     "sap/ushell/ui/launchpad/VizInstance",

package/src/main/js/sap/ushell/services/_ClientSideTargetResolution/Formatter.js

@@ -13,7 +13,7 @@
  * <p>This is a dependency of ClientSideTargetResolution.  Interfaces exposed
  * by this module may change at any time without notice.</p>
  *
- * @version 1.122.1
+ * @version 1.123.0
  */
 sap.ui.define([
 ], function () {

package/src/main/js/sap/ushell/services/_ClientSideTargetResolution/InboundIndex.js

@@ -27,7 +27,7 @@
  *
  * @private
  *
- * @version 1.122.1
+ * @version 1.123.0
  */
 sap.ui.define([
 "sap/base/util/ObjectPath",

package/src/main/js/sap/ushell/services/_ClientSideTargetResolution/InboundProvider.js

@@ -34,7 +34,7 @@
  * <p>This is a dependency of ClientSideTargetResolution.  Interfaces exposed
  * by this module may change at any time without notice.</p>
  *
- * @version 1.122.1
+ * @version 1.123.0
  */
 sap.ui.define([
     "sap/ushell/services/_ClientSideTargetResolution/VirtualInbounds",

package/src/main/js/sap/ushell/services/_ClientSideTargetResolution/PrelaunchOperations.js

@@ -4,7 +4,7 @@
  * @file PrelaunchOperations are executed just before launching the application (post parameter mapping and app state merging) if the
  * <code>sap-prelaunch-operations</code> parameter is specified as a technical parameter.
  *
- * @version 1.122.1
+ * @version 1.123.0
  */
 sap.ui.define([
     "sap/base/Log",

package/src/main/js/sap/ushell/services/_ClientSideTargetResolution/Search.js

@@ -8,7 +8,7 @@
  * <p>This is a dependency of ClientSideTargetResolution.  Interfaces exposed
  * by this module may change at any time without notice.</p>
  *
- * @version 1.122.1
+ * @version 1.123.0
  */
 sap.ui.define([
     "sap/ushell/utils",

package/src/main/js/sap/ushell/services/_ClientSideTargetResolution/StagedLogger.js

@@ -39,7 +39,7 @@
  *
  * This is a dependency of ClientSideTargetResolution. Interfaces exposed by this module may change at any time without notice.
  *
- * @version 1.122.1
+ * @version 1.123.0
  */
 sap.ui.define([
     "sap/base/Log",

package/src/main/js/sap/ushell/services/_ClientSideTargetResolution/SystemContext.js

@@ -8,7 +8,7 @@
  * <p>This is a dependency of ClientSideTargetResolution. Interfaces exposed
  * by this module may change at any time without notice.</p>
  *
- * @version 1.122.1
+ * @version 1.123.0
  */
 sap.ui.define([
     "sap/base/util/ObjectPath",

package/src/main/js/sap/ushell/services/_ClientSideTargetResolution/Utils.js

@@ -6,7 +6,7 @@
  * This is a dependency of ClientSideTargetResolution.
  * Interfaces exposed by this module may change at any time without notice.
  *
- * @version 1.122.1
+ * @version 1.123.0
  */
 sap.ui.define([
     "sap/base/util/deepExtend"

package/src/main/js/sap/ushell/services/_ClientSideTargetResolution/VirtualInbounds.js

@@ -12,7 +12,7 @@
  * <p>This is a dependency of ClientSideTargetResolution.  Interfaces
  * exposed by this module may change at any time without notice.</p>
  *
- * @version 1.122.1
+ * @version 1.123.0
  */
 sap.ui.define([], function () {
     "use strict";

package/src/main/js/sap/ushell/services/_ClientSideTargetResolution/XAppStateProcessing.js

@@ -6,7 +6,7 @@
  * Operations in this module are assumed to be executed after the target mapping has been identified (post search).
  *
  * @private
- * @version 1.122.1
+ * @version 1.123.0
  */
 sap.ui.define([
     "sap/ushell/services/_ClientSideTargetResolution/Utils",

package/src/main/js/sap/ushell/services/_CommonDataModel/SiteConverter.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview Because the personalization processor only works with a CDM 3.0 site, this converter is used to transform a dedicated
  * CDM 3.1 site object into a CDM 3.0 site and backwards.
- * @version 1.122.1
+ * @version 1.123.0
  */
 sap.ui.define([
     "sap/base/Log"

package/src/main/js/sap/ushell/services/_CommonDataModel/vizTypeDefaults/VizTypeDefaults.js

@@ -2,7 +2,7 @@
 
 /**
  * @file Utility for loading the default visualization types for the CDM runtime.
- * @version 1.122.1
+ * @version 1.123.0
  */
 
 sap.ui.define([

package/src/main/js/sap/ushell/services/_ContentExtensionAdapterFactory/ContentExtensionAdapterConfig.js

@@ -7,7 +7,7 @@
  *  config handler which is called by the factory to generate an explicit
  *  Adapter configuration
  *
- * @version 1.122.1
+ * @version 1.123.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/services/_ContentExtensionAdapterFactory/FeaturedGroupConfig.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview Provide mock feature group data
  *
- * @version 1.122.1
+ * @version 1.123.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/services/_CrossApplicationNavigation/utils.js

@@ -2,7 +2,7 @@
 /**
  * @fileOverview Cross Application Navigation utility functions
  *
- * @version 1.122.1
+ * @version 1.123.0
  * @deprecated since 1.120.0
  */
 

package/src/main/js/sap/ushell/services/_MessageBroker/MessageBrokerEngine.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview This module contains the implementation of the message broker
- * @version 1.122.1
+ * @version 1.123.0
  */
 sap.ui.define([
     "sap/base/Log",

package/src/main/js/sap/ushell/services/_PageReferencing/PageReferencer.js

@@ -4,7 +4,7 @@
  * @file This module is responsible to create reference pages,
  * which are shareable JSON representations of layout and navigation targets in the specific format.
  *
- * @version 1.122.1
+ * @version 1.123.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/services/_PluginManager/Extensions.js

@@ -2,7 +2,7 @@
 /**
  * @fileOverview The extensions which plugins can use to customise the launchpad
  *
- * @version 1.122.1
+ * @version 1.123.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/services/_PluginManager/HeaderExtensions.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview The extensions for the ShellHeader
- * @version 1.122.1
+ * @version 1.123.0
  */
 sap.ui.define([
     "sap/ushell/EventHub"

package/src/main/js/sap/ushell/services/_PluginManager/MenuExtensions.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The extensions for the MenuBar, an interface to let plugins request menu entry providers.
  *
- * @version 1.122.1
+ * @version 1.123.0
  */
 sap.ui.define([], function () {
     "use strict";

package/src/main/js/sap/ushell/services/_Ui5ComponentLoader/utils.js

@@ -3,7 +3,7 @@
  * @fileOverview Helper functions for <code>sap.ushell.services.Ui5ComponentLoader
  *  This is a shell-internal service and no public or application facing API!
  *
- * @version 1.122.1
+ * @version 1.123.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -33,14 +33,29 @@ sap.ui.define([
      */
     aDefaultDependencies = ["sap.ca.scfld.md", "sap.ca.ui", "sap.me", "sap.ui.unified"];
 
+    /**
+     * Type for component data
+     * sap.ushell.services.Ui5ComponentLoader.ComponentData
+     * @typedef {object} sap.ushell.services.Ui5ComponentLoader.ComponentData
+     * @property {object} [config] Application configuration, or technical parameter if not present
+     * @property {object} [startupParameters] Application startup parameters
+
+     * @property {sap.ui.core.URI} url URL of the component
+     * @property {object} applicationDependencies  Application dependencies
+     * @property {string} ui5ComponentName  Name of the UI5 component
+     * @since 1.120.0
+     * @private
+     * @ui5-restricted unified inbox
+     */
+
     /**
      * Creates a UI5 component instance asynchronously.
      *
-     * @param {object} oComponentProperties
+     * @param {{manifest:object}} oComponentProperties
      *  the Ui5 component properties
-     * @param {object} oComponentData
+     * @param {sap.ushell.services.Ui5ComponentLoader.ComponentData} oComponentData
      *  the Ui5 component data
-     * @returns {jQuery.Promise} Resolves with an instance of
+     * @returns {jQuery.Promise<sap.ui.component>} Resolves with an instance of
      *  <code>sap.ui.component</code> containing the instantiated
      *  Ui5 component.
      *
@@ -218,6 +233,15 @@ sap.ui.define([
     /**
      * Creates a componentProperties object that can be used to instantiate
      * a ui5 component.
+     * @param {boolean} bAddCoreExtPreloadBundle Whether to add the core-ext-light-preload bundle to the component properties.
+     * @param {boolean} bLoadDefaultDependencies Whether to load default dependencies.
+     * @param {boolean} bNoCachebusterTokens Whether to remove cachebuster tokens from the URLs in the component properties.
+     * @param {string[]} aWaitForBeforeInstantiation The list of components to wait for before instantiating the component.
+     * @param {object} oApplicationDependencies The application dependencies.
+     * @param {string} sUi5ComponentName The name of the UI5 component.
+     * @param {string} sComponentUrl The URL of the component.
+     * @param {string} sAppComponentId The ID of the app component.
+     * @param {string[]} aCoreResourcesComplement The list of core resources to complement the component properties with.
      *
      * @returns {object}
      *    The component properties that can be used to instantiate the UI5
@@ -279,10 +303,15 @@ sap.ui.define([
         return oComponentProperties;
     }
 
-
     /**
      * Creates a componentData object that can be used to instantiate a ui5
      * component.
+     * @param {object} oBaseComponentData The base component data.
+     * @param {string} sComponentUrl The URL of the component.
+     * @param {object} oApplicationConfiguration The application configuration.
+     * @param {object} oTechnicalParameters The technical parameters.
+     * @returns {sap.ushell.services.Ui5ComponentLoader.ComponentData}
+}
      */
     function createComponentData (oBaseComponentData, sComponentUrl, oApplicationConfiguration, oTechnicalParameters) {
         var oComponentData = deepExtend({

package/src/main/js/sap/ushell/support/plugins/flpConfig/FlpConfigurationPlugin.js

@@ -9,7 +9,7 @@
  * Fiori launchpad in a tree table separated by IconTabFilters for the first level properties of the configuration object.
  * Also it provides a search for last level properties.
  *
- * @version 1.122.1
+ * @version 1.123.0
  */
 sap.ui.define([
     "sap/ui/core/Element",