@sapui5/ts-types 1.101.1 → 1.102.2

package/types/sap.fe.navigation.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.101.1
+// For Library Version: 1.102.1
 
 declare namespace sap {
   namespace fe {
@@ -35,6 +35,8 @@ declare namespace sap {
          * the information contained in `oClassInfo`.
          *
          * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
+         *
+         * @returns Created class / constructor function
          */
         static extend<T extends Record<string, unknown>>(
           /**
@@ -53,10 +55,14 @@ declare namespace sap {
         ): Function;
         /**
          * Returns a metadata object for class sap.fe.navigation.NavError.
+         *
+         * @returns Metadata object describing this class
          */
         static getMetadata(): sap.ui.base.Metadata;
         /**
          * Returns the error code with which the instance has been created.
+         *
+         * @returns The error code of the error
          */
         getErrorCode(): string;
       }
@@ -105,6 +111,8 @@ declare namespace sap {
          * The method creates a context url based on provided data. This context url can either be used as {@link
          * sap.fe.navigation.NavigationHandler#setParameterContextUrl ParameterContextUrl} or {@link sap.fe.navigation.NavigationHandler#setFilterContextUrl
          * FilterContextUrl}.
+         *
+         * @returns The context url for the given entities
          */
         static constructContextUrl(
           /**
@@ -121,6 +129,8 @@ declare namespace sap {
          * it with the information contained in `oClassInfo`.
          *
          * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
+         *
+         * @returns Created class / constructor function
          */
         static extend<T extends Record<string, unknown>>(
           /**
@@ -139,6 +149,8 @@ declare namespace sap {
         ): Function;
         /**
          * Returns a metadata object for class sap.fe.navigation.NavigationHandler.
+         *
+         * @returns Metadata object describing this class
          */
         static getMetadata(): sap.ui.base.Metadata;
         /**
@@ -148,6 +160,8 @@ declare namespace sap {
          * 	 - `sap-system`
          * 	 - `sap-ushell-defaultedParameterNames`
          * 	 - `"hcpApplicationId"` .
+         *
+         * @returns Containing the technical parameters.
          */
         static getTechnicalParameters(): any[];
         /**
@@ -156,6 +170,8 @@ declare namespace sap {
          * variant does not contain any parameters. All parameters are merged into select options. The output of
          * this function, converted to a JSON string, can be used for the {@link #.navigate NavigationHandler.navigate}
          * method.
+         *
+         * @returns Instance of {@link sap.fe.navigation.SelectionVariant}
          */
         static mixAttributesAndSelectionVariant(
           /**
@@ -647,6 +663,33 @@ declare namespace sap {
          * state is returned in the resolved Promise. Otherwise startup parameters will be merged into the app state
          * provided by cross app navigation, and a combined app state will be returned. The conflict resolution
          * can be influenced with sParamHandlingMode defined in the constructor.
+         *
+         * @returns A Promise object to monitor when all the actions of the function have been executed. If the
+         * execution is successful, the extracted app state, the startup parameters, and the type of navigation
+         * are returned, see also the example above. The app state is an object that contains the following information:
+         *
+         * 	 - `oAppData.oSelectionVariant`: An instance of {@link sap.fe.navigation.SelectionVariant} containing
+         * 			only parameters/select options that are related to navigation
+         * 	 - `oAppData.selectionVariant`: The navigation-related selection variant as a JSON-formatted string
+         *
+         * 	 - `oAppData.oDefaultedSelectionVariant`: An instance of {@link sap.fe.navigation.SelectionVariant}
+         * 			containing only the parameters/select options that are set by user default data
+         * 	 - `oAppData.bNavSelVarHasDefaultsOnly`: A Boolean flag that indicates whether only defaulted parameters
+         * 			and no navigation parameters are present.
+         *  **Note:** If no navigation parameters are available, `bNavSelVarHasDefaultsOnly` is set to `true`, even
+         * though parameters without default might be available as well.  If the navigation-related selection
+         * variant is empty, it is replaced by a copy of the defaulted selection variant.
+         *  The navigation type is an enumeration type of type {@link sap.fe.navigation.NavType} (possible values
+         * are initial, URLParams, xAppState, and iAppState).
+         *  **Note:** If the navigation type is {@link sap.fe.navigation.NavType.iAppState} oAppData has two additional
+         * properties
+         * 	 - `oAppData.tableVariantId`
+         * 	 - `oAppData.customData`  which return the inner app data as stored in {@link #.navigate navigate}
+         * 			or {@link #.storeInnerAppState storeInnerAppState}. `oAppData.oDefaultedSelectionVariant` is an empty
+         * 			selection variant and `oAppData.bNavSelVarHasDefaultsOnly` is `false` in this case.
+         *  **Note:** If the navigation type is {@link sap.fe.navigation.NavType.initial} oAppData is an empty object!
+         *  If an error occurs, an error object of type {@link sap.fe.navigation.NavError}, URL parameters (if available)
+         * and the type of navigation are returned.
          */
         static parseNavigation(): object;
         /**
@@ -663,6 +706,10 @@ declare namespace sap {
          * 			popover as semantic attributes.
          * 	 - The method `oTableEventParameters.open()` is called. Note that this does not really open the popover,
          * 			but the SmartLink control proceeds with firing the event `navigationTargetsObtained`. .
+         *
+         * @returns A Promise object to monitor when all actions of the function have been executed; if the execution
+         * is successful, the modified oTableEventParameters is returned; if an error occurs, an error object of
+         * type {@link sap.fe.navigation.NavError} is returned
          */
         static processBeforeSmartLinkPopoverOpens(
           /**
@@ -760,6 +807,10 @@ declare namespace sap {
         ): void;
         /**
          * Changes the URL according to the current app state and stores the app state for later retrieval.
+         *
+         * @returns A Promise object to monitor when all the actions of the function have been executed; if the
+         * execution is successful, the app state key is returned; if an error occurs, an object of type {@link
+         * sap.fe.navigation.NavError} is returned
          */
         static storeInnerAppState(
           /**
@@ -800,6 +851,9 @@ declare namespace sap {
         ): object;
         /**
          * Changes the URL according to the current app state and stores the app state for later retrieval.
+         *
+         * @returns An object containing the appStateId and a promise object to monitor when all the actions of
+         * the function have been executed; Please note that the appStateKey may be undefined or empty.
          */
         static storeInnerAppStateWithImmediateReturn(
           /**
@@ -862,6 +916,8 @@ declare namespace sap {
          * it with the information contained in `oClassInfo`.
          *
          * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
+         *
+         * @returns Created class / constructor function
          */
         static extend<T extends Record<string, unknown>>(
           /**
@@ -880,34 +936,50 @@ declare namespace sap {
         ): Function;
         /**
          * Gets the chart visualization property.
+         *
+         * @returns An object containing the properties to be used for the chart visualization.
          */
         static getChartVisualization(): Record<string, any>;
         /**
          * Gets the current context URL intended for the query.
+         *
+         * @returns The current context URL for the query
          */
         static getContextUrl(): string;
         /**
          * Returns the identification of the selection variant.
+         *
+         * @returns The identification of the selection variant as made available during construction
          */
         static getID(): string;
         /**
          * Returns a metadata object for class sap.fe.navigation.PresentationVariant.
+         *
+         * @returns Metadata object describing this class
          */
         static getMetadata(): sap.ui.base.Metadata;
         /**
          * Gets the more trivial properties. Basically all properties with the exception of the Visualization.
+         *
+         * @returns The current properties.
          */
         static getProperties(): Record<string, any>;
         /**
          * Gets the table visualization property.
+         *
+         * @returns An object containing the properties to be used for the table visualization.
          */
         static getTableVisualization(): Record<string, any>;
         /**
          * Returns the current text / description of this selection variant.
+         *
+         * @returns The current description of this selection variant.
          */
         static getText(): string;
         /**
          * Returns `true` if the presentation variant does not contain any properties. nor ranges.
+         *
+         * @returns If set to `true` there are no current properties set; `false` otherwise.
          */
         static isEmpty(): boolean;
         /**
@@ -966,10 +1038,14 @@ declare namespace sap {
         ): void;
         /**
          * Returns the external representation of the selection variant as JSON object.
+         *
+         * @returns The external representation of this instance as a JSON object
          */
         static toJSONObject(): object;
         /**
          * Serializes this instance into a JSON-formatted string.
+         *
+         * @returns The JSON-formatted representation of this instance in stringified format
          */
         static toJSONString(): string;
       }
@@ -993,6 +1069,8 @@ declare namespace sap {
         /**
          * Sets the value of a parameter called `sName` to the new value `sValue`. If the parameter has already
          * been set before, its value is overwritten.
+         *
+         * @returns This instance to allow method chaining
          */
         static addParameter(
           /**
@@ -1006,6 +1084,8 @@ declare namespace sap {
         ): object;
         /**
          * Adds a new range to the list of select options for a given parameter.
+         *
+         * @returns This instance to allow method chaining.
          */
         static addSelectOption(
           /**
@@ -1028,16 +1108,23 @@ declare namespace sap {
            */
           sLow: string,
           /**
-           * Set only if sOption is **BT**: the upper boundary of the interval; must be `undefined` or `null` in all
-           * other cases
+           * Set only if sOption is **BT**: the upper boundary of the interval;
+           */
+          sHigh?: string,
+          /**
+           * Text representing the SelectOption. This is an optional parameter, consumption of this parameter is completely
+           * decided by the consumer. For an example in most Fiori applications fetch the Text based on the ID and
+           * doesn't consider this text property must be `undefined` or `null` in all other cases
            */
-          sHigh?: string
+          sText?: string
         ): object;
         /**
          * Creates a new subclass of class sap.fe.navigation.SelectionVariant with name `sClassName` and enriches
          * it with the information contained in `oClassInfo`.
          *
          * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
+         *
+         * @returns Created class / constructor function
          */
         static extend<T extends Record<string, unknown>>(
           /**
@@ -1056,19 +1143,27 @@ declare namespace sap {
         ): Function;
         /**
          * Gets the current context URL intended for the filters.
+         *
+         * @returns The current context URL for the filters
          */
         static getFilterContextUrl(): string;
         /**
          * Returns the identification of the selection variant.
+         *
+         * @returns The identification of the selection variant as made available during construction
          */
         static getID(): string;
         /**
          * Returns a metadata object for class sap.fe.navigation.SelectionVariant.
+         *
+         * @returns Metadata object describing this class
          */
         static getMetadata(): sap.ui.base.Metadata;
         /**
          * Returns the value of the parameter called `sName` if it has been set. If the parameter has never been
          * set or has been removed, `undefined` is returned.
+         *
+         * @returns The value of parameter `sName`; returning the value `null` not possible
          */
         static getParameter(
           /**
@@ -1078,18 +1173,33 @@ declare namespace sap {
         ): string;
         /**
          * Gets the current context URL intended for the parameters.
+         *
+         * @returns The current context URL for the parameters
          */
         static getParameterContextUrl(): string;
         /**
          * Returns the set of parameter names available in this selection variant.
+         *
+         * @returns The list of parameter names which are valid
          */
         static getParameterNames(): any[];
         /**
          * Returns the names of the parameter and select option properties available for this instance.
+         *
+         * @returns The list of parameter and select option property names available for this instance
          */
         static getPropertyNames(): any[];
         /**
          * Returns the set of select options/ranges available for a given property name.
+         *
+         * @returns If `sPropertyName` is an invalid name of a property or no range exists, `undefined` is returned;
+         * otherwise, an immutable array of ranges is returned. Each entry of the array is an object with the following
+         * properties:
+         * 	 - `Sign`: The sign of the range
+         * 	 - `Option`: The option of the range
+         * 	 - `Low`: The low value of the range; returning value `null` is not possible
+         * 	 - `High`: The high value of the range; if this value is not necessary, `null` is used  For further
+         * 			information about the meaning of the attributes, refer to method `addSelectOption`.
          */
         static getSelectOption(
           /**
@@ -1099,10 +1209,14 @@ declare namespace sap {
         ): any[];
         /**
          * Returns the names of the properties available for this instance.
+         *
+         * @returns The list of property names available for this instance
          */
         static getSelectOptionsPropertyNames(): any[];
         /**
          * Returns the current text / description of this selection variant.
+         *
+         * @returns The current description of this selection variant.
          */
         static getText(): string;
         /**
@@ -1111,6 +1225,15 @@ declare namespace sap {
          * `sName`, is 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.  If neither a select option
          * nor a parameter could be found, `undefined` is returned.
+         *
+         * @returns The ranges in the select options for the specified property or a range-converted representation
+         * of a parameter is returned. If both lookups fail, `undefined` is returned.  The returned ranges
+         * have the format:
+         * 	 - `Sign`: The sign of the range
+         * 	 - `Option`: The option of the range
+         * 	 - `Low`: The low value of the range; returning the value `null` is not possible
+         * 	 - `High`: The high value of the range; if this value is not necessary, `null` (but does exist)
+         * 			For further information on the meaning of the attributes, refer to method {@link #.addSelectOption addSelectOption}.
          */
         static getValue(
           /**
@@ -1120,10 +1243,15 @@ declare namespace sap {
         ): any[];
         /**
          * Returns `true` if the selection variant does neither contain parameters nor ranges.
+         *
+         * @returns If set to `true` there are no parameters and no select options available in the selection variant;
+         * `false` otherwise.
          */
         static isEmpty(): boolean;
         /**
          * Adds a set of select options to the list of select options for a given parameter.
+         *
+         * @returns This instance to allow method chaining
          */
         static massAddSelectOption(
           /**
@@ -1137,6 +1265,8 @@ declare namespace sap {
         ): object;
         /**
          * Removes a parameter called `sName` from the selection variant.
+         *
+         * @returns This instance to allow method chaining
          */
         static removeParameter(
           /**
@@ -1146,6 +1276,8 @@ declare namespace sap {
         ): object;
         /**
          * Removes a select option called `sName` from the selection variant.
+         *
+         * @returns This instance to allow method chaining.
          */
         static removeSelectOption(
           /**
@@ -1157,6 +1289,8 @@ declare namespace sap {
          * Renames a parameter called `sNameOld` to `sNameNew`. If a parameter or a select option with the name
          * `sNameNew` already exist, an error is thrown. If a parameter with the name `sNameOld` does not exist,
          * nothing is changed.
+         *
+         * @returns This instance to allow method chaining
          */
         static renameParameter(
           /**
@@ -1172,6 +1306,8 @@ declare namespace sap {
          * Renames a select option called `sNameOld` to `sNameNew`. If a select option or a parameter with the name
          * `sNameNew` already exist, an error is thrown. If a select option with the name `sNameOld` does not exist,
          * nothing is changed.
+         *
+         * @returns This instance to allow method chaining
          */
         static renameSelectOption(
           /**
@@ -1221,10 +1357,14 @@ declare namespace sap {
         ): void;
         /**
          * Returns the external representation of the selection variant as JSON object.
+         *
+         * @returns The external representation of this instance as a JSON object
          */
         static toJSONObject(): object;
         /**
          * Serializes this instance into a JSON-formatted string.
+         *
+         * @returns The JSON-formatted representation of this instance in stringified format
          */
         static toJSONString(): string;
       }

package/types/sap.fe.templates.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.101.1
+// For Library Version: 1.102.1
 
 declare namespace sap {
   namespace fe {
@@ -28,13 +28,15 @@ declare namespace sap {
           ): void;
           /**
            * This method converts filter conditions to filters.
+           *
+           * @returns Object containing the converted FilterBar filters.
            */
           createFiltersFromFilterConditions(
             /**
              * Map containing the filter conditions of the FilterBar.
              */
             mFilterConditions: any
-          ): any;
+          ): object;
           /**
            * Get access to models managed by SAP Fiori elements.
            *
@@ -53,6 +55,8 @@ declare namespace sap {
            *
            * .
            * editMode is deprecated and should not be used anymore. Use isEditable instead.
+           *
+           * @returns The required model
            */
           getModel(
             /**
@@ -62,10 +66,14 @@ declare namespace sap {
           ): undefined | sap.ui.model.Model;
           /**
            * Gets the list entries currently selected for the displayed control.
+           *
+           * @returns Array containing the selected contexts
            */
           getSelectedContexts(): any;
           /**
            * Load a fragment and go through the template preprocessor with the current page context.
+           *
+           * @returns The fragment definition
            */
           loadFragment(
             /**
@@ -113,6 +121,8 @@ declare namespace sap {
            * in the List Report Filter Bar. It can be used to request the initial load or to refresh the
            * currently shown data based on the filters entered by the user.
            * Please note: The Promise is resolved once the search is triggered and not once the data is returned.
+           *
+           * @returns Resolved once the data is refreshed or rejected if the request failed
            */
           refresh(): any;
           /**
@@ -127,7 +137,9 @@ declare namespace sap {
           /**
            * Set the filter values for the given property in the filter bar.
            * The filter values can be either a single value or an array of values.
-           * Each filter value must be represented as a string corresponding to the given operator.
+           * Each filter value must be represented as a primitive value.
+           *
+           * @returns A promise for asynchronous handling
            */
           setFilterValues(
             /**
@@ -141,11 +153,20 @@ declare namespace sap {
             /**
              * The values to be applied
              */
-            vValues: undefined | string | string[]
-          ): any;
+            vValues:
+              | undefined
+              | string
+              | number
+              | boolean
+              | string[]
+              | number[]
+              | boolean[]
+          ): void;
           /**
            * Triggers an update of the app state.
            * Should be called if the state of a control, or any other state-relevant information, was changed.
+           *
+           * @returns A promise that resolves with the new app state object.
            */
           updateAppState(): undefined | Promise<any>;
         }