@sapui5/ts-types 1.118.0 → 1.119.0

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.111.0
+// For Library Version: 1.119.0
 
 declare namespace sap {
   /**
@@ -14,12 +14,46 @@ declare namespace sap {
        * can override to allow more flexibility.
        */
       namespace controllerextensions {
+        namespace ViewState {
+          /**
+           * Definition of a custom action to be used inside the table toolbar
+           */
+          type NavigationParameter = {
+            /**
+             * The actual navigation type.
+             */
+            navigationType: string;
+            /**
+             * Defines whether the standard variant must be used in variant management
+             */
+            requiresStandardVariant: boolean;
+            /**
+             * The selectionVariant from the navigation.
+             */
+            selectionVariant: sap.fe.navigation.SelectionVariant;
+            /**
+             * The selectionVariant defaults from the navigation
+             */
+            selectionVariantDefaults: sap.fe.navigation.SelectionVariant;
+          };
+        }
+
+        /**
+         * @since 1.118.0
+         *
+         * A base implementation for controller extension used internally in sap.fe for central functionalities.
+         */
+        class BaseControllerExtension extends sap.ui.core.mvc
+          .ControllerExtension {
+          constructor();
+        }
         /**
          * @since 1.90.0
          *
          * A controller extension offering hooks into the edit flow of the application
          */
-        class EditFlow extends sap.ui.core.mvc.ControllerExtension {
+        class EditFlow extends sap.fe.core.controllerextensions
+          .BaseControllerExtension {
           constructor();
 
           /**
@@ -85,13 +119,12 @@ declare namespace sap {
               /**
                * The creation mode using one of the following:
                *
-               *                    NewPage - the created document is shown in a new page, depending on whether metadata
-               * 'Sync', 'Async' or 'Deferred' is used
+               * NewPage - the created document is shown in a new page, depending on whether metadata 'Sync', 'Async'
+               * or 'Deferred' is used
                *
-               *                    Inline - The creation is done inline (in a table)
+               * Inline - The creation is done inline (in a table)
                *
-               *                    External - The creation is done in a different application specified via the parameter
-               * 'outbound'
+               * External - The creation is done in a different application specified via the parameter 'outbound'
                */
               creationMode: string;
               /**
@@ -212,7 +245,7 @@ declare namespace sap {
            * This function can be used to execute code after the 'Create' action.
            * You can execute custom coding in this function.
            * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
-           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
+           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
            *
            *
            * @returns A promise to be returned by the overridden method.
@@ -234,7 +267,7 @@ declare namespace sap {
            * This function can be used to execute code after the 'Delete' action.
            * You can execute custom coding in this function.
            * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
-           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
+           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
            *
            *
            * @returns A promise to be returned by the overridden method.
@@ -256,7 +289,7 @@ declare namespace sap {
            * This function can be used to execute code after the 'Discard' action.
            * You can execute custom coding in this function.
            * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
-           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
+           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
            *
            *
            * @returns A promise to be returned by the overridden method.
@@ -278,7 +311,7 @@ declare namespace sap {
            * This function can be used to execute code after the 'Edit' action.
            * You can execute custom coding in this function.
            * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
-           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
+           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
            *
            *
            * @returns A promise to be returned by the overridden method.
@@ -300,7 +333,7 @@ declare namespace sap {
            * This function can be used to execute code after the 'Save' action.
            * You can execute custom coding in this function.
            * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
-           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
+           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
            *
            *
            * @returns A promise to be returned by the overridden method.
@@ -323,7 +356,7 @@ declare namespace sap {
            * The framework waits for the returned promise to be resolved before continuing the 'Create' action.
            * If you reject the promise, the 'Create' action is stopped.
            * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
-           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
+           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
            *
            *
            * @returns A promise to be returned by the overridden method. If resolved, the 'Create' action is triggered.
@@ -351,7 +384,7 @@ declare namespace sap {
            * The framework waits for the returned promise to be resolved before continuing the 'Delete' action.
            * If you reject the promise, the 'Delete' action is stopped.
            * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
-           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
+           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
            *
            *
            * @returns A promise to be returned by the overridden method. If resolved, the 'Delete' action is triggered.
@@ -375,7 +408,7 @@ declare namespace sap {
            * The framework waits for the returned promise to be resolved before continuing the 'Discard' action.
            * If you reject the promise, the 'Discard' action is stopped and the user stays in edit mode.
            * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
-           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
+           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
            *
            *
            * @returns A promise to be returned by the overridden method. If resolved, the 'Discard' action is triggered.
@@ -399,7 +432,7 @@ declare namespace sap {
            * The framework waits for the returned promise to be resolved before continuing the 'Edit' action.
            * If you reject the promise, the 'Edit' action is stopped and the user stays in display mode.
            * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
-           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
+           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
            *
            *
            * @returns A promise to be returned by the overridden method. If resolved, the 'Edit' action is triggered.
@@ -423,7 +456,7 @@ declare namespace sap {
            * The framework waits for the returned promise to be resolved before continuing the 'Save' action.
            * If you reject the promise, the 'Save' action is stopped and the user stays in edit mode.
            * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
-           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
+           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
            *
            *
            * @returns A promise to be returned by the overridden method. If resolved, the 'Save' action is triggered.
@@ -524,7 +557,7 @@ declare namespace sap {
           /**
            * @since 1.86.0
            *
-           * Provides a hook to customize the {@link sap.fe.navigation.SelectionVariant} related to the intent-based
+           * Provides a hook to customize the {@link sap.fe.navigation.SelectionVariant } related to the intent-based
            * navigation.
            */
           adaptNavigationContext(
@@ -556,7 +589,7 @@ declare namespace sap {
              * Identifier to locate the outbound definition in the manifest.
              * This provides the semantic object and action for the intent-based navigation.
              * Additionally, the outbound definition can be used to provide parameters for intent-based navigation.
-             * See {@link https://ui5.sap.com/#/topic/be0cf40f61184b358b5faedaec98b2da Descriptor for Applications, Components, and Libraries }
+             * See {@link topic :be0cf40f61184b358b5faedaec98b2da Descriptor for Applications, Components, and Libraries }
              * for more information.
              */
             sOutbound: string,
@@ -611,7 +644,7 @@ declare namespace sap {
             /**
              * ODataListBinding object
              */
-            oBinding: any,
+            oBinding: any | sap.ui.model.odata.v4.ODataListBinding,
             /**
              * Current context where the navigation is initiated
              */
@@ -668,9 +701,8 @@ declare namespace sap {
            *
            * This function is used to intercept the routing event after binding a page.
            * If it is declared as an extension, it allows you to intercept and change the normal flow of binding.
-           *
            * This function is not called directly, but overridden separately by consuming controllers.
-           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
+           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
            */
           onAfterBinding(
             /**
@@ -683,9 +715,8 @@ declare namespace sap {
            *
            * This function is used to intercept the routing event before binding a page.
            * If it is declared as an extension, it allows you to intercept and change the normal flow of binding.
-           *
            * This function is not called directly, but overridden separately by consuming controllers.
-           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
+           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
            */
           onBeforeBinding(
             /**
@@ -701,13 +732,11 @@ declare namespace sap {
            * clicked).
            * The function is NOT called during other means of external outbound navigation (like a navigation configured
            * via a link, or by using navigation buttons).
-           *
            * If declared as an extension, it allows you to intercept and change the normal navigation flow.
            * If you decide to do your own navigation processing, you can return `true` to prevent the default routing
            * behavior.
-           *
            * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
-           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
+           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
            *
            *
            * @returns `true` to prevent the default execution, false to keep the standard behavior
@@ -835,7 +864,7 @@ declare namespace sap {
            *
            * This function should add all controls relevant for refreshing to the provided control array.
            * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
-           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
+           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
            */
           adaptBindingRefreshControls(
             /**
@@ -848,7 +877,7 @@ declare namespace sap {
            *
            * Customize the `refreshBinding` function for a certain control.
            * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
-           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
+           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
            */
           adaptBindingRefreshHandler(
             /**
@@ -865,7 +894,7 @@ declare namespace sap {
            *
            * Customize the `retrieve` and `apply` functions for a certain control.
            * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
-           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
+           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
            */
           adaptControlStateHandler(
             /**
@@ -883,7 +912,7 @@ declare namespace sap {
            * This function should add all controls for given view that should be considered for the state handling
            * to the provided control array.
            * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
-           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
+           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
            */
           adaptStateControls(
             /**
@@ -896,7 +925,7 @@ declare namespace sap {
            *
            * Applying additional, not control related, states - is called only if navigation type is iAppState.
            * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
-           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
+           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
            */
           applyAdditionalStates(
             /**
@@ -913,8 +942,7 @@ declare namespace sap {
            *
            * Defines whether the view state should only be applied once initially.
            * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
-           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.Instead}.
-           *
+           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.Instead }.
            * Important:
            * You should only override this method for custom pages and not for the standard ListReportPage and ObjectPage!
            *
@@ -928,7 +956,7 @@ declare namespace sap {
            *
            * Apply navigation parameters is not called if the navigation type is iAppState
            * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
-           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
+           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
            */
           applyNavigationParameters(
             /**
@@ -940,17 +968,17 @@ declare namespace sap {
                */
               navigationType: any;
               /**
-               * undefined
+               * Defines whether the standard variant must be used in variant management
                */
-              requiresStandardVariant?: boolean;
+              requiresStandardVariant?: boolean | undefined;
               /**
-               * undefined
+               * The selectionVariant from the navigation
                */
-              selectionVariant?: object;
+              selectionVariant?: object | undefined;
               /**
-               * undefined
+               * The selectionVariant defaults from the navigation
                */
-              selectionVariantDefaults?: object;
+              selectionVariantDefaults?: object | undefined;
             },
             /**
              * Extensible array of promises to be resolved before continuing
@@ -970,7 +998,7 @@ declare namespace sap {
             /**
              * The current navigation parameter
              */
-            oNavParameter: /* was: sap.fe.core.controllerextensions.ViewState.NavigationParameter */ any,
+            oNavParameter: sap.fe.core.controllerextensions.ViewState.NavigationParameter,
             /**
              * Boolean which determines to skip the key user shine through
              */
@@ -981,7 +1009,7 @@ declare namespace sap {
            *
            * Hook to react when state for given view was applied.
            * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
-           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
+           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
            */
           onAfterStateApplied(
             /**
@@ -994,7 +1022,7 @@ declare namespace sap {
            *
            * Hook to react before a state for given view is applied.
            * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
-           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
+           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
            */
           onBeforeStateApplied(
             /**
@@ -1020,7 +1048,7 @@ declare namespace sap {
            * Extend the map of additional states (not control bound) to be added to the current view state of the
            * given view.
            * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
-           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
+           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
            */
           retrieveAdditionalStates(
             /**
@@ -1052,21 +1080,20 @@ declare namespace sap {
          * or you can use it to wrap your custom XML view directly the manifest when you define your custom page
          * under sapui5/routing/targets:
          *
-         *
          * ```javascript
          *
          * "myCustomPage": {
-         * 	"type": "Component",
-         * 	"id": "myCustomPage",
-         * 	"name": "sap.fe.core.fpm",
-         * 	"title": "My Custom Page",
-         * 	"options": {
-         * 		"settings": {
-         * 			"viewName": "myNamespace.myView",
-         * 			"contextPath": "/MyEntitySet"
-         * 			}
+         * "type": "Component",
+         * "id": "myCustomPage",
+         * "name": "sap.fe.core.fpm",
+         * "title": "My Custom Page",
+         * "options": {
+         * 	"settings": {
+         * 		"viewName": "myNamespace.myView",
+         * 		"contextPath": "/MyEntitySet"
          * 		}
          * 	}
+         * }
          * ```
          */
         class Component
@@ -1125,7 +1152,6 @@ declare namespace sap {
        * create their apps by extending this component.
        * This ensures that all the necessary services that you need for the building blocks and templates to work
        * properly are started.
-       *
        * When you use sap.fe.core.AppComponent as the base component, you also need to use a rootView. SAP Fiori
        * elements provides two options:
        *
@@ -1158,7 +1184,7 @@ declare namespace sap {
         /**
          * Provides a hook to initialize feature toggles.
          * This hook is being called by the SAP Fiori elements AppComponent at the time feature toggles can be initialized.
-         * To change page configuration use the {@link sap.fe.core.AppComponent#changePageConfiguration} method.
+         * To change page configuration use the {@link sap.fe.core.AppComponent#changePageConfiguration } method.
          *
          *
          * @returns A promise without any value to allow asynchronous processes
@@ -1185,15 +1211,13 @@ declare namespace sap {
         /**
          * Convenience method provided by SAP Fiori elements to enable applications to include the view model by
          * name into each controller.
-         *
-         * @returns The model instance
          */
         getModel(
           /**
            * The model name
            */
           sName?: string
-        ): sap.ui.model.Model | undefined;
+        ): void;
         /**
          * Convenience method for setting the view model in every controller of the application.
          *
@@ -1328,7 +1352,7 @@ declare namespace sap {
            */
           sTarget: string,
           /**
-           * undefined
+           * Context instance
            */
           oContext: sap.ui.model.Context
         ): void;
@@ -1393,6 +1417,8 @@ declare namespace sap {
 
     "sap/fe/core/BaseController": undefined;
 
+    "sap/fe/core/controllerextensions/BaseControllerExtension": undefined;
+
     "sap/fe/core/controllerextensions/EditFlow": undefined;
 
     "sap/fe/core/controllerextensions/IntentBasedNavigation": undefined;