@sapui5/sap.fe.navigation 1.102.2 → 1.104.1

package/src/sap/fe/navigation/SelectionVariant.js

@@ -19,7 +19,7 @@ sap.ui.define(
 		 * @class
 		 * @public
 		 * @since 1.83.0
-		 * @alias sap.fe.navigation.SelectionVariant
+		 * @name sap.fe.navigation.SelectionVariant
 		 * @param {string|object} [vSelectionVariant] If of type <code>string</code>, the selection variant is JSON-formatted;
 		 * if of type <code>object</code>, the object represents a selection variant
 		 * @throws An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are:
@@ -34,9 +34,9 @@ sap.ui.define(
 		 * </table>
 		 * These exceptions can only be thrown if the parameter <code>vSelectionVariant</code> has been provided.
 		 */
-		var SelectionVariant = BaseObject.extend(
+		return BaseObject.extend(
 			"sap.fe.navigation.SelectionVariant",
-			/** @lends sap.fe.navigation.SelectionVariant */
+			/** @lends sap.fe.navigation.SelectionVariant.prototype */
 			{
 				_rVALIDATE_SIGN: new RegExp("[E|I]"),
 				_rVALIDATE_OPTION: new RegExp("EQ|NE|LE|GE|LT|GT|BT|CP"),
@@ -60,6 +60,7 @@ sap.ui.define(
 
 				/**
 				 * Returns the identification of the selection variant.
+				 *
 				 * @returns {string} The identification of the selection variant as made available during construction
 				 * @public
 				 */
@@ -69,6 +70,7 @@ sap.ui.define(
 
 				/**
 				 * Sets the identification of the selection variant.
+				 *
 				 * @param {string} sId The new identification of the selection variant
 				 * @public
 				 */
@@ -78,6 +80,7 @@ sap.ui.define(
 
 				/**
 				 * Sets the text / description of the selection variant.
+				 *
 				 * @param {string} sNewText The new description to be used
 				 * @public
 				 * @throws An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are:
@@ -95,6 +98,7 @@ sap.ui.define(
 
 				/**
 				 * Returns the current text / description of this selection variant.
+				 *
 				 * @returns {string} The current description of this selection variant.
 				 * @public
 				 */
@@ -104,6 +108,7 @@ sap.ui.define(
 
 				/**
 				 * Sets the context URL intended for the parameters.
+				 *
 				 * @param {string} sURL The URL of the parameter context
 				 * @public
 				 * @throws An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are:
@@ -121,6 +126,7 @@ sap.ui.define(
 
 				/**
 				 * Gets the current context URL intended for the parameters.
+				 *
 				 * @returns {string} The current context URL for the parameters
 				 * @public
 				 */
@@ -130,6 +136,7 @@ sap.ui.define(
 
 				/**
 				 * Gets the current context URL intended for the filters.
+				 *
 				 * @returns {string} The current context URL for the filters
 				 * @public
 				 */
@@ -139,6 +146,7 @@ sap.ui.define(
 
 				/**
 				 * Sets the context URL intended for the filters.
+				 *
 				 * @param {string} sURL The URL of the filters
 				 * @public
 				 * @throws An instance of {@link sap.fe.navigation.NavError} in case of input errors. Valid error codes are:
@@ -157,6 +165,7 @@ sap.ui.define(
 				/**
 				 * Sets the value of a parameter called <code>sName</code> to the new value <code>sValue</code>.
 				 * If the parameter has already been set before, its value is overwritten.
+				 *
 				 * @param {string} sName The name of the parameter to be set; the <code>null</code> value is not allowed
 				 * @param {string} sValue The value of the parameter to be set
 				 * @returns {object} This instance to allow method chaining
@@ -195,6 +204,7 @@ sap.ui.define(
 
 				/**
 				 * Removes a parameter called <code>sName</code> from the selection variant.
+				 *
 				 * @param {string} sName The name of the parameter to be removed
 				 * @returns {object} This instance to allow method chaining
 				 * @public
@@ -222,6 +232,7 @@ sap.ui.define(
 				 * Renames a parameter called <code>sNameOld</code> to <code>sNameNew</code>. If a parameter or a select option with
 				 * the name <code>sNameNew</code> already exist, an error is thrown. If a parameter with the name <code>sNameOld</code>
 				 * does not exist, nothing is changed.
+				 *
 				 * @param {string} sNameOld The current name of the parameter to be renamed
 				 * @param {string} sNameNew The new name of the parameter
 				 * @returns {object} This instance to allow method chaining
@@ -258,6 +269,7 @@ sap.ui.define(
 				/**
 				 * Returns the value of the parameter called <code>sName</code> if it has been set.
 				 * If the parameter has never been set or has been removed, <code>undefined</code> is returned.
+				 *
 				 * @param {string} sName The name of the parameter to be returned
 				 * @returns {string} The value of parameter <code>sName</code>; returning the value <code>null</code> not possible
 				 * @public
@@ -286,6 +298,7 @@ sap.ui.define(
 
 				/**
 				 * Adds a new range to the list of select options for a given parameter.
+				 *
 				 * @param {string} sPropertyName The name of the property for which the selection range is added
 				 * @param {string} sSign The sign of the range (<b>I</b>nclude or <b>E</b>xclude)
 				 * @param {string} sOption The option of the range (<b>EQ</b> for "equals", <b>NE</b> for "not equals",
@@ -311,7 +324,6 @@ sap.ui.define(
 				 * <tr><td>SelectionVariant.PARAMETER_SELOPT_COLLISION</td><td>Indicates that another parameter with the same name as the property name already exists</td></tr>
 				 * </table>
 				 */
-
 				addSelectOption: function (sPropertyName, sSign, sOption, sLow, sHigh, sText) {
 					/* {string} sLow The single value or the lower boundary of the interval; the <code>null</code> value is not allowed
 					 * (see specification "Selection Variants for UI Navigation in Fiori", section 2.4.2.1)
@@ -399,6 +411,7 @@ sap.ui.define(
 
 				/**
 				 * Removes a select option called <code>sName</code> from the selection variant.
+				 *
 				 * @param {string} sName The name of the select option to be removed
 				 * @returns {object} This instance to allow method chaining.
 				 * @public
@@ -427,6 +440,7 @@ sap.ui.define(
 				 * Renames a select option called <code>sNameOld</code> to <code>sNameNew</code>. If a select option or a parameter
 				 * with the name <code>sNameNew</code> already exist, an error is thrown. If a select option with the name <code>sNameOld</code>
 				 * does not exist, nothing is changed.
+				 *
 				 * @param {string} sNameOld The current name of the select option property to be renamed
 				 * @param {string} sNameNew The new name of the select option property
 				 * @returns {object} This instance to allow method chaining
@@ -462,6 +476,7 @@ sap.ui.define(
 
 				/**
 				 * Returns the set of select options/ranges available for a given property name.
+				 *
 				 * @param {string} sPropertyName The name of the property for which the set of select options/ranges is returned
 				 * @returns {Array} If <code>sPropertyName</code> is an invalid name of a property or no range exists, <code>undefined</code>
 				 * is returned; otherwise, an immutable array of ranges is returned. Each entry of the array is an object with the
@@ -499,6 +514,7 @@ sap.ui.define(
 
 				/**
 				 * Returns the names of the properties available for this instance.
+				 *
 				 * @returns {Array} The list of property names available for this instance
 				 * @public
 				 */
@@ -508,6 +524,7 @@ sap.ui.define(
 
 				/**
 				 * Returns the names of the parameter and select option properties available for this instance.
+				 *
 				 * @returns {Array} The list of parameter and select option property names available for this instance
 				 * @public
 				 */
@@ -517,6 +534,7 @@ sap.ui.define(
 
 				/**
 				 * Adds a set of select options to the list of select options for a given parameter.
+				 *
 				 * @param {string} sPropertyName The name of the property for which the set of select options is added
 				 * @param {Array} aSelectOptions Set of select options to be added
 				 * @returns {object} This instance to allow method chaining
@@ -552,6 +570,7 @@ sap.ui.define(
 				 * made. If the latter succeeds, the single value is converted to fit into an array of selections to make it
 				 * type compatible with ranges. This array is then returned. <br />
 				 * If neither a select option nor a parameter could be found, <code>undefined</code> is returned.
+				 *
 				 * @param {string} sName The name of the attribute for which the value is retrieved
 				 * @returns {Array} The ranges in the select options for the specified property or a range-converted representation of a parameter is returned.
 				 * If both lookups fail, <code>undefined</code> is returned. <br />
@@ -598,6 +617,7 @@ sap.ui.define(
 				/**
 				 * Returns <code>true</code> if the selection variant does neither contain parameters
 				 * nor ranges.
+				 *
 				 * @returns {boolean} If set to <code>true</code>  there are no parameters and no select options available in
 				 * the selection variant; <code>false</code> otherwise.
 				 * @public
@@ -608,6 +628,7 @@ sap.ui.define(
 
 				/**
 				 * Returns the external representation of the selection variant as JSON object.
+				 *
 				 * @returns {object} The external representation of this instance as a JSON object
 				 * @public
 				 */
@@ -646,6 +667,7 @@ sap.ui.define(
 
 				/**
 				 * Serializes this instance into a JSON-formatted string.
+				 *
 				 * @returns {string} The JSON-formatted representation of this instance in stringified format
 				 * @public
 				 */
@@ -777,8 +799,6 @@ sap.ui.define(
 				}
 			}
 		);
-
-		return SelectionVariant;
 	},
 	true
 );

package/src/sap/fe/navigation/library.js

@@ -25,7 +25,8 @@ sap.ui.define(
 		// delegate further initialization of this library to the Core
 		var thisLib = sap.ui.getCore().initLibrary({
 			name: "sap.fe.navigation",
-			version: "1.102.2",
+			// eslint-disable-next-line no-template-curly-in-string
+			version: "1.104.1",
 			dependencies: ["sap.ui.core"],
 			types: ["sap.fe.navigation.NavType", "sap.fe.navigation.ParamHandlingMode", "sap.fe.navigation.SuppressionBehavior"],
 			interfaces: [],
@@ -47,6 +48,7 @@ sap.ui.define(
 		thisLib.ParamHandlingMode = {
 			/**
 			 * The conflict resolution favors the SelectionVariant over URL parameters
+			 *
 			 * @public
 			 */
 			SelVarWins: "SelVarWins",
@@ -55,12 +57,14 @@ sap.ui.define(
 			 * The conflict resolution favors the URL parameters over the SelectionVariant. Caution: In case of cross-app navigation
 			 * a navigation parameter value from the source app is overwritten by a default, if a default is maintained in the launchpad
 			 * designer for this parameter in the target app!
+			 *
 			 * @public
 			 */
 			URLParamWins: "URLParamWins",
 
 			/**
 			 * The conflict resolution adds URL parameters to the SelectionVariant
+			 *
 			 * @public
 			 */
 			InsertInSelOpt: "InsertInSelOpt"
@@ -69,6 +73,7 @@ sap.ui.define(
 		/**
 		 * This is the successor of {@link sap.ui.generic.app.navigation.service.NavType}.<br>
 		 * A static enumeration type which indicates the type of inbound navigation.
+		 *
 		 * @enum {string}
 		 * @name sap.fe.navigation.NavType
 		 * @readonly
@@ -78,24 +83,28 @@ sap.ui.define(
 		thisLib.NavType = {
 			/**
 			 * Initial startup without any navigation or default parameters
+			 *
 			 * @public
 			 */
 			initial: "initial",
 
 			/**
 			 * Basic cross-app navigation with URL parameters only (without sap-xapp-state) or initial start with default parameters
+			 *
 			 * @public
 			 */
 			URLParams: "URLParams",
 
 			/**
 			 * Cross-app navigation with sap-xapp-state parameter (and URL parameters), defaulted parameters may be added
+			 *
 			 * @public
 			 */
 			xAppState: "xAppState",
 
 			/**
 			 * Back navigation with sap-iapp-state parameter
+			 *
 			 * @public
 			 */
 			iAppState: "iAppState"
@@ -107,7 +116,8 @@ sap.ui.define(
 		 * <code>undefined</code> or <code>""</code> (empty string) shall be suppressed, before they are mixed in to the selection variant in the
 		 * method {@link sap.fe.navigation.NavigationHandler.mixAttributesAndSelectionVariant mixAttributesAndSelectionVariant}
 		 * of the {@link sap.fe.navigation.NavigationHandler NavigationHandler}.
-		 * @enum {int}
+		 *
+		 * @enum {number}
 		 * @name sap.fe.navigation.SuppressionBehavior
 		 * @readonly
 		 * @public
@@ -117,6 +127,7 @@ sap.ui.define(
 			/**
 			 * Standard suppression behavior: semantic attributes with a <code>null</code> or an <code>undefined</code> value are ignored,
 			 * the remaining attributes are mixed in to the selection variant
+			 *
 			 * @public
 			 */
 			standard: 0,
@@ -124,18 +135,21 @@ sap.ui.define(
 			/**
 			 * Semantic attributes with an empty string are ignored, the remaining attributes are mixed in to the selection variant.
 			 * Warning! Consider the impact on Boolean variable values!
+			 *
 			 * @public
 			 */
 			ignoreEmptyString: 1,
 
 			/**
 			 * Semantic attributes with a <code>null</code> value lead to an {@link sap.fin.central.lib.error.Error error} of type NavigationHandler.INVALID_INPUT
+			 *
 			 * @public
 			 */
 			raiseErrorOnNull: 2,
 
 			/**
 			 * Semantic attributes with an <code>undefined</code> value lead to an {@link sap.fin.central.lib.error.Error error} of type NavigationHandler.INVALID_INPUT
+			 *
 			 * @public
 			 */
 			raiseErrorOnUndefined: 4
@@ -143,6 +157,7 @@ sap.ui.define(
 
 		/**
 		 * A static enumeration type which indicates the Odata version used for runnning the Navigation Handler.
+		 *
 		 * @enum {string}
 		 * @name sap.fe.navigation.Mode
 		 * @readonly
@@ -152,12 +167,14 @@ sap.ui.define(
 		thisLib.Mode = {
 			/**
 			 * This is used for ODataV2 services to do some internal tasks like creation of appstate, removal of sensitive data etc.,
+			 *
 			 * @public
 			 */
 			ODataV2: "ODataV2",
 
 			/**
 			 * This is used for ODataV4 services to do some internal tasks like creation of appstate, removal of sensitive data etc.,
+			 *
 			 * @public
 			 */
 			ODataV4: "ODataV4"