@sapui5/ts-types 1.118.0 → 1.119.0

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.111.0
+// For Library Version: 1.119.0
 
 declare namespace sap {
   namespace fe {
@@ -9,7 +9,7 @@ declare namespace sap {
       /**
        * @since 1.83.0
        *
-       * This is the successor of {@link sap.ui.generic.app.navigation.service.NavError}.
+       * This is the successor of {@link sap.ui.generic.app.navigation.service.NavError }.
        *  An object that provides error handling information during runtime.
        */
       class NavError extends sap.ui.base.Object {
@@ -33,7 +33,7 @@ declare namespace sap {
       /**
        * @since 1.83.0
        *
-       * This is the successor of {@link sap.ui.generic.app.navigation.service.NavigationHandler}.
+       * This is the successor of {@link sap.ui.generic.app.navigation.service.NavigationHandler }.
        *  Creates a new NavigationHandler class by providing the required environment.
        *
        * The `NavigationHandler` supports the verification of sensitive information. All properties that are part
@@ -49,7 +49,7 @@ declare namespace sap {
        * xapp state.
        *
        * To verify the information to be removed, the `NavigationHandler` requires an unnamed model of type
-       * {@link sap.ui.model.odata.v2.ODataModel} on component level. It is possible to set such a model using
+       * {@link sap.ui.model.odata.v2.ODataModel } on component level. It is possible to set such a model using
        * the `setModel`
        * method.
        *
@@ -58,7 +58,7 @@ declare namespace sap {
        * If the OData metadata model has not been loaded completely, all properties are removed from the application
        * context.
        *
-       * **Note:** This class requires that the UShell {@link sap.ushell.services.CrossApplicationNavigation }
+       * **Note:** This class requires that the UShell {@link sap.ushell.services.CrossApplicationNavigation  }
        * is available and initialized.
        */
       class NavigationHandler extends sap.ui.base.Object {
@@ -79,7 +79,7 @@ declare namespace sap {
            */
           sEntitySetName: string,
           /**
-           * undefined
+           * Used for url determination. If omitted, the NavigationHandler model is used.
            */
           oModel?:
             | sap.ui.model.odata.v2.ODataModel
@@ -110,7 +110,7 @@ declare namespace sap {
          * the
          * {@link #.navigate NavigationHandler.navigate} method.
          *
-         * @returns Instance of {@link sap.fe.navigation.SelectionVariant}
+         * @returns Instance of {@link sap.fe.navigation.SelectionVariant }
          */
         mixAttributesAndSelectionVariant(
           /**
@@ -124,7 +124,13 @@ declare namespace sap {
             | any
             | string,
           /**
-           * undefined
+           * Indicates whether semantic
+           * attributes with special values (see {@link sap.fe.navigation.SuppressionBehavior suppression behavior})
+           * must be
+           * suppressed before they are combined with the selection variant; several
+           * {@link sap.fe.navigation.SuppressionBehavior suppression behaviors} can be combined with the bitwise
+           * OR operator
+           * (|)
            */
           iSuppressionBehavior?: number
         ): sap.fe.navigation.SelectionVariant;
@@ -146,7 +152,7 @@ declare namespace sap {
          *
          * {object}
          * **oError**
-         * NavError object (instance of {@link sap.fe.navigation.NavError}) that describes which kind of error
+         * NavError object (instance of {@link sap.fe.navigation.NavError }) that describes which kind of error
          * occurred
          *
          * {string}
@@ -192,23 +198,23 @@ declare namespace sap {
           oExternalAppData?: {
             /**
              * Object containing the current ui state of the app which will be forwarded to the
-             *        target component.
+             * target component.
              */
-            presentationVariant?: object;
+            presentationVariant?: object | undefined;
             /**
              * Stringified JSON object, which will be forwarded to the target component. If not
-             *        provided the selectionVariant will be constructed based on the vNavigationParameters.
+             * provided the selectionVariant will be constructed based on the vNavigationParameters.
              */
-            selectionVariant?: object;
+            selectionVariant?: object | undefined;
             /**
              * Object containing value descriptions which will be forwarded to the target component.
              */
-            valueTexts?: object;
+            valueTexts?: object | undefined;
           },
           /**
            * Argument is used to overwrite the FLP-configured target for opening a URL. If used, only the
-           *        `explace` or `inplace` values are allowed. Any other value will lead to an exception
-           *        `NavigationHandler.INVALID_NAV_MODE`.
+           * `explace` or `inplace` values are allowed. Any other value will lead to an exception
+           * `NavigationHandler.INVALID_NAV_MODE`.
            */
           sNavMode?: string
         ): void;
@@ -221,51 +227,48 @@ declare namespace sap {
          *
          * @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:
+         * 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.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.
+         * `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).
+         * 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
+         * **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 #.storeInnerAppStateAsync storeInnerAppStateAsync}.
-         *          `oAppData.oDefaultedSelectionVariant` is an empty selection variant and
-         *          `oAppData.bNavSelVarHasDefaultsOnly` is `false` in this case.
+         * which return the inner app data as stored in {@link  #.navigate navigate} or {@link  #.storeInnerAppStateAsync storeInnerAppStateAsync}.
+         * `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!
+         * **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.
+         * 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.
          */
         parseNavigation(): object;
         /**
@@ -297,13 +300,13 @@ declare namespace sap {
          *
          * @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
+         * modified oTableEventParameters is returned; if an error occurs, an error object of type
+         * {@link sap.fe.navigation.NavError } is returned
          */
         processBeforeSmartLinkPopoverOpens(
           /**
            * The parameters made available by the SmartTable control when the SmartLink control has been clicked,
-           *        an instance of a PopOver object
+           * an instance of a PopOver object
            */
           oTableEventParameters: any,
           /**
@@ -312,7 +315,7 @@ declare namespace sap {
           sSelectionVariant: string,
           /**
            * Object containing the current state of the app. If provided, opening the Popover is deferred until the
-           *        inner app data is saved in a consistent way.
+           * inner app data is saved in a consistent way.
            */
           mInnerAppData?: /* was: sap.fe.navigation.NavigationHandler.InnerAppData */ any,
           /**
@@ -321,12 +324,12 @@ declare namespace sap {
           oExternalAppData?: {
             /**
              * Object containing the current ui presentationVariant of the app, which will be
-             *        passed to the target screen
+             * passed to the target screen
              */
             presentationVariant?: object;
             /**
              * Object containing selectionVariant, which will be passed to the target screen. If not
-             *        set the sSelectionVariant will be used.
+             * set the sSelectionVariant will be used.
              */
             selectionVariant?: object;
             /**
@@ -373,22 +376,21 @@ declare namespace sap {
         setTechnicalParameters(
           /**
            * List of parameter names to be considered as technical parameters. `null` or
-           *        `undefined` may be used to reset the complete list.
+           * `undefined` may be used to reset the complete list.
            */
           aTechnicalParameters?: any[]
         ): void;
         /**
-         * @deprecated (since 1.104) - Use the {@link sap.fe.navigation.NavigationHandler.storeInnerAppStateAsync }
+         * @deprecated (since 1.104) - Use the {@link sap.fe.navigation.NavigationHandler.storeInnerAppStateAsync  }
          * instead.
          *
-         *
          * 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 }
+         * app state key is returned; if an error occurs, an object of type {@link sap.fe.navigation.NavError  }
          * is
-         *          returned
+         * returned
          */
         storeInnerAppState(
           /**
@@ -397,8 +399,8 @@ declare namespace sap {
           mInnerAppData: /* was: sap.fe.navigation.NavigationHandler.InnerAppData */ any,
           /**
            * If set to false, the inner app hash will not be replaced until storing is successful; do not
-           *        set to false if you cannot react to the resolution of the Promise, for example, when calling the
-           * beforeLinkPressed event
+           * set to false if you cannot react to the resolution of the Promise, for example, when calling the beforeLinkPressed
+           * event
            */
           bImmediateHashReplace?: boolean
         ): jQuery.Promise<string>;
@@ -407,9 +409,9 @@ declare namespace sap {
          *
          * @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 }
+         * app state key is returned; if an error occurs, an object of type {@link sap.fe.navigation.NavError  }
          * is
-         *          returned
+         * returned
          */
         storeInnerAppStateAsync(
           /**
@@ -418,26 +420,25 @@ declare namespace sap {
           mInnerAppData: /* was: sap.fe.navigation.NavigationHandler.InnerAppData */ any,
           /**
            * If set to false, the inner app hash will not be replaced until storing is successful; do not
-           *        set to false if you cannot react to the resolution of the Promise, for example, when calling the
-           * beforeLinkPressed event
+           * set to false if you cannot react to the resolution of the Promise, for example, when calling the beforeLinkPressed
+           * event
            */
           bImmediateHashReplace?: boolean,
           /**
            * If set to true, the inner app hash will not be replaced in the storeInnerAppStateAsync. Also the bImmediateHashReplace
-           * 		  will be ignored.
+           * will be ignored.
            */
           bSkipHashReplace?: boolean
         ): jQuery.Promise<string>;
         /**
-         * @deprecated (since 1.104) - Use the {@link sap.fe.navigation.NavigationHandler.storeInnerAppStateAsync }
+         * @deprecated (since 1.104) - Use the {@link sap.fe.navigation.NavigationHandler.storeInnerAppStateAsync  }
          * instead.
          *
-         *
          * 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.
+         * executed; Please note that the appStateKey may be undefined or empty.
          */
         storeInnerAppStateWithImmediateReturn(
           /**
@@ -446,11 +447,11 @@ declare namespace sap {
           mInnerAppData: /* was: sap.fe.navigation.NavigationHandler.InnerAppData */ any,
           /**
            * If set to false, the inner app hash will not be replaced until storing is successful; do not
-           *        set to false if you cannot react to the resolution of the Promise, for example, when calling the
-           * beforeLinkPressed event. **Note:**If
-           *        not provided it will be treated as set to false. **Note:**If set to true, the calling instance
-           * has to ensure that a follow-on
-           *        call to `replaceHash` will take place!
+           * set to false if you cannot react to the resolution of the Promise, for example, when calling the beforeLinkPressed
+           * event. **Note:**If
+           * not provided it will be treated as set to false. **Note:**If set to true, the calling instance has to
+           * ensure that a follow-on
+           * call to `replaceHash` will take place!
            */
           bImmediateHashReplace?: boolean
         ): object;
@@ -458,7 +459,7 @@ declare namespace sap {
       /**
        * @since 1.83.0
        *
-       * This is the successor of {@link sap.ui.generic.app.navigation.service.PresentationVariant}.
+       * This is the successor of {@link sap.ui.generic.app.navigation.service.PresentationVariant }.
        *  Creates a new instance of a PresentationVariant class. If no parameter is passed, an new empty instance
        * is created whose ID has been set to `""`. Passing a JSON-serialized string complying to the Selection
        * Variant Specification will parse it, and the newly created instance will contain the same information.
@@ -719,7 +720,9 @@ declare namespace sap {
            * The name of the property for which the set of select options/ranges is returned
            */
           sPropertyName: string
-        ): undefined | undefined[];
+        ): /* was: sap.fe.navigation.SelectionVariant.SelectOption */
+          | any[]
+          | undefined;
         /**
          * Returns the names of the properties available for this instance.
          *
@@ -755,14 +758,16 @@ declare namespace sap {
          *
          * 	 - `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}.
+         * For further information on the meaning of the attributes, refer to method {@link  #.addSelectOption addSelectOption}.
          */
         getValue(
           /**
            * The name of the attribute for which the value is retrieved
            */
           sName: string
-        ): undefined | undefined[];
+        ): /* was: sap.fe.navigation.SelectionVariant.SelectOption */
+          | any[]
+          | undefined;
         /**
          * Returns `true` if the selection variant does neither contain parameters
          * nor ranges.
@@ -784,7 +789,7 @@ declare namespace sap {
           /**
            * Set of select options to be added
            */
-          aSelectOptions: undefined[]
+          aSelectOptions: /* was: sap.fe.navigation.SelectionVariant.SelectOption */ any[]
         ): this;
         /**
          * Removes a parameter called `sName` from the selection variant.
@@ -911,16 +916,11 @@ declare namespace sap {
       /**
        * @since 1.86.0
        *
-       * This is the successor of {@link sap.ui.generic.app.navigation.service.NavType}.
+       * This is the successor of {@link sap.ui.generic.app.navigation.service.NavType }.
        *
        * A static enumeration type which indicates the type of inbound navigation.
        */
       enum NavType {
-        /**
-         * Basic cross-app navigation with URL parameters only (without sap-xapp-state) or initial start with default
-         * parameters
-         */
-        URLParams = "undefined",
         /**
          * Back navigation with sap-iapp-state parameter
          */
@@ -929,6 +929,11 @@ declare namespace sap {
          * Initial startup without any navigation or default parameters
          */
         initial = "undefined",
+        /**
+         * Basic cross-app navigation with URL parameters only (without sap-xapp-state) or initial start with default
+         * parameters
+         */
+        URLParams = "undefined",
         /**
          * Cross-app navigation with sap-xapp-state parameter (and URL parameters), defaulted parameters may be
          * added
@@ -938,7 +943,7 @@ declare namespace sap {
       /**
        * @since 1.83.0
        *
-       * This is the successor of {@link sap.ui.generic.app.navigation.service.ParamHandlingMode}.
+       * This is the successor of {@link sap.ui.generic.app.navigation.service.ParamHandlingMode }.
        *
        * A static enumeration type which indicates the conflict resolution method when merging URL parameters
        * into select options.
@@ -964,7 +969,7 @@ declare namespace sap {
       /**
        * @since 1.83.0
        *
-       * This is the successor of {@link sap.ui.generic.app.navigation.service.SuppressionBehavior}.
+       * This is the successor of {@link sap.ui.generic.app.navigation.service.SuppressionBehavior }.
        *
        * A static enumeration type which indicates whether semantic attributes with values `null`,
        * `undefined` or `""` (empty string) shall be suppressed, before they are mixed in to the selection variant

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

@@ -1,3 +1,3 @@
-// For Library Version: 1.118.0
+// For Library Version: 1.119.0
 
 declare namespace sap {}

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.111.0
+// For Library Version: 1.119.0
 
 declare namespace sap {
   namespace fe {
@@ -85,7 +85,7 @@ declare namespace sap {
              */
             sConditionPath: string,
             /**
-             * undefined
+             * The operator to be used (optional) - if not set, the default operator (EQ) will be used
              */
             sOperator: string | undefined,
             /**
@@ -98,6 +98,7 @@ declare namespace sap {
               | number[]
               | string
               | string[]
+              | undefined
           ): Promise<void>;
         }
         /**
@@ -137,21 +138,21 @@ declare namespace sap {
              *
              * ```javascript
              *
-             * 	{
-             * 		filterConditions: {
-             * 			Country: [
-             * 				{
-             * 					operator: "EQ"
-             * 					validated: "NotValidated"
-             * 					values: ["Germany", ...]
-             * 				},
-             * 				...
-             * 			]
-             * 			...
-             * 		},
-             * 		currentTabId: "fe::CustomTab::tab1",
-             * 		refreshCause: "tabChanged" | "search"
-             * 	}
+             * {
+             * filterConditions: {
+             * Country: [
+             * {
+             * operator: "EQ"
+             * validated: "NotValidated"
+             * values: ["Germany", ...]
+             * },
+             * ...
+             * ]
+             * ...
+             * },
+             * currentTabId: "fe::CustomTab::tab1",
+             * refreshCause: "tabChanged" | "search"
+             * }
              * ```
              */
             mParameters: any
@@ -199,9 +200,12 @@ declare namespace sap {
            */
           refresh(
             /**
-             * undefined
+             * Path or array of paths referring to entities or properties to be refreshed.
+             * If omitted, the whole object page is refreshed. The path "" refreshes the entity assigned to the object
+             * page
+             * without navigations
              */
-            vPath: string | string[] | undefined
+            vPath?: string | string[]
           ): Promise<void>;
           /**
            * Displays the message strip between the title and the header of the ObjectPage.
@@ -221,9 +225,9 @@ declare namespace sap {
              */
             sSubSectionKey: string,
             /**
-             * undefined
+             * Optional Boolean flag to show or hide the side content
              */
-            bShow: boolean | undefined
+            bShow?: boolean
           ): void;
         }
       }

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.118.0
+// For Library Version: 1.119.0
 
 declare namespace sap {
   namespace fe {

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

@@ -1,3 +1,3 @@
-// For Library Version: 1.118.0
+// For Library Version: 1.119.0
 
 declare namespace sap {}

package/types/sap.feedback.ui.d.ts

@@ -1,3 +1,3 @@
-// For Library Version: 1.118.0
+// For Library Version: 1.119.0
 
 declare namespace sap {}