@sapui5/ts-types 1.101.0 → 1.102.1

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

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.101.0
+// For Library Version: 1.102.0
 
 declare namespace sap {
   /**
@@ -28,6 +28,8 @@ declare namespace sap {
            *
            *
            * Submit the current set of changes and navigate back.
+           *
+           * @returns Promise resolves once the changes have been saved
            */
           applyDocument(
             /**
@@ -40,6 +42,8 @@ declare namespace sap {
            *
            *
            * Discard the editable document.
+           *
+           * @returns Promise resolves once editable document has been discarded
            */
           cancelDocument(
             /**
@@ -65,6 +69,8 @@ declare namespace sap {
            *
            *
            * Creates a new document.
+           *
+           * @returns Promise resolves once the object has been created
            */
           createDocument(
             /**
@@ -100,6 +106,8 @@ declare namespace sap {
            *
            *
            * Deletes the document.
+           *
+           * @returns Promise resolves once document has been deleted
            */
           deleteDocument(
             /**
@@ -125,6 +133,8 @@ declare namespace sap {
            *
            *
            * Creates a draft document for an existing active document.
+           *
+           * @returns Promise resolves once the editable document is available
            */
           editDocument(
             /**
@@ -185,6 +195,9 @@ declare namespace sap {
            * 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}.
+           *
+           * @returns A promise to be returned by the overridden method. If resolved, the 'Create' action is triggered.
+           * If rejected, the 'Create' action is not triggered.
            */
           onBeforeCreate(
             /**
@@ -210,6 +223,9 @@ declare namespace sap {
            * 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}.
+           *
+           * @returns A promise to be returned by the overridden method. If resolved, the 'Delete' action is triggered.
+           * If rejected, the 'Delete' action is not triggered.
            */
           onBeforeDelete(
             /**
@@ -231,6 +247,9 @@ declare namespace sap {
            * 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}.
+           *
+           * @returns A promise to be returned by the overridden method. If resolved, the 'Discard' action is triggered.
+           * If rejected, the 'Discard' action is not triggered and the user stays in edit mode.
            */
           onBeforeDiscard(
             /**
@@ -252,6 +271,9 @@ declare namespace sap {
            * 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}.
+           *
+           * @returns A promise to be returned by the overridden method. If resolved, the 'Edit' action is triggered.
+           * If rejected, the 'Edit' action is not triggered and the user stays in display mode.
            */
           onBeforeEdit(
             /**
@@ -273,6 +295,9 @@ declare namespace sap {
            * 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}.
+           *
+           * @returns A promise to be returned by the overridden method. If resolved, the 'Save' action is triggered.
+           * If rejected, the 'Save' action is not triggered and the user stays in edit mode.
            */
           onBeforeSave(
             /**
@@ -290,6 +315,8 @@ declare namespace sap {
            *
            *
            * Saves a new document after checking it.
+           *
+           * @returns Promise resolves once save is complete
            */
           saveDocument(
             /**
@@ -309,6 +336,9 @@ declare namespace sap {
            *
            * Secured execution of the given function. Ensures that the function is only executed when certain conditions
            * are fulfilled.
+           *
+           * @returns A promise that is rejected if the execution is prohibited and resolved by the promise returned
+           * by the fnFunction.
            */
           securedExecution(
             /**
@@ -346,6 +376,8 @@ declare namespace sap {
            *
            *
            * Updates the draft status and displays the error messages if there are errors during an update.
+           *
+           * @returns Promise resolves once draft status has been updated
            */
           updateDocument(
             /**
@@ -357,7 +389,7 @@ declare namespace sap {
              * update operation is completed, so the draft status can be updated.
              */
             oPromise: Promise<any>
-          ): Promise<any>;
+          ): undefined | Promise<any>;
         }
         /**
          * @SINCE 1.86.0
@@ -442,6 +474,9 @@ declare namespace sap {
            * can filter on message types and can display details as well as the long text. If there is one message,
            * the dialog immediately shows the details of the message. If there is just one success message, a message
            * toast is shown instead.
+           *
+           * @returns A promise that is resolved once the user closes the dialog. If there are no messages
+           * to be shown, the promise is resolved immediately
            */
           showMessageDialog(): Promise<any>;
         }
@@ -506,6 +541,8 @@ declare namespace sap {
           ): void;
           /**
            * Navigate to another target.
+           *
+           * @returns Promise that is resolved when the navigation is finalized
            */
           navigateToRoute(
             /**
@@ -561,6 +598,9 @@ declare namespace sap {
            *
            * 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}.
+           *
+           *
+           * @returns `true` to prevent the default execution, false to keep the standard behavior
            */
           onBeforeNavigation(
             /**
@@ -589,6 +629,8 @@ declare namespace sap {
            *
            * Adapts the metadata used while sharing the page URL via 'Send Email', 'Share in SAP Jam', and 'Save as
            * Tile'.
+           *
+           * @returns Share Metadata or a Promise resolving the Share Metadata
            */
           adaptShareMetadata(
             /**
@@ -755,6 +797,10 @@ declare namespace sap {
            *
            * Important:
            * You should only override this method for custom pages and not for the standard ListReportPage and ObjectPage!
+           *
+           *
+           * @returns If `true`, only the initial view state is applied once,
+           * else any new view state is also applied on follow-up calls (default)
            */
           applyInitialStateOnly(): boolean;
           /**
@@ -791,6 +837,8 @@ declare namespace sap {
           ): void;
           /**
            * Applies the given view state to this extensions view.
+           *
+           * @returns Promise for async state handling
            */
           applyViewState(
             /**
@@ -865,6 +913,8 @@ declare namespace sap {
            * Retrieve the view state of this extensions view.
            * When this function is called more than once before finishing, all but the final response will resolve
            * to `undefined`.
+           *
+           * @returns A promise resolving the view state
            */
           retrieveViewState(): Promise<any>;
         }
@@ -943,11 +993,15 @@ declare namespace sap {
          *
          *
          * Returns the current app component.
+         *
+         * @returns The app component or, if not found, null
          */
         getAppComponent(): sap.fe.core.AppComponent;
         /**
          * 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(
           /**
@@ -957,6 +1011,8 @@ declare namespace sap {
         ): sap.ui.model.Model;
         /**
          * Convenience method for setting the view model in every controller of the application.
+         *
+         * @returns The view instance
          */
         setModel(
           /**
@@ -1005,6 +1061,8 @@ declare namespace sap {
          *
          * .
          * editMode is deprecated and should not be used anymore. Use isEditable instead.
+         *
+         * @returns The required model
          */
         getModel(
           /**
@@ -1014,6 +1072,8 @@ declare namespace sap {
         ): undefined | sap.ui.model.Model;
         /**
          * Load a fragment and go through the template preprocessor with the current page context.
+         *
+         * @returns The fragment definition
          */
         loadFragment(
           /**
@@ -1067,6 +1127,8 @@ declare namespace sap {
         /**
          * 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>;
       }
@@ -1086,11 +1148,15 @@ declare namespace sap {
          *
          *
          * Returns the current app component.
+         *
+         * @returns The app component or, if not found, null
          */
         getAppComponent(): sap.fe.core.AppComponent;
         /**
          * 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(
           /**
@@ -1100,6 +1166,8 @@ declare namespace sap {
         ): sap.ui.model.Model;
         /**
          * Convenience method for setting the view model in every controller of the application.
+         *
+         * @returns The view instance
          */
         setModel(
           /**

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.101.0
+// For Library Version: 1.102.0
 
 declare namespace sap {
   namespace fe {
@@ -15,6 +15,10 @@ declare namespace sap {
            * Reference to the key of another action already displayed in the toolbar to properly place this one
            */
           anchor: string;
+          /**
+           * Enables or disables the action
+           */
+          enabled: boolean;
           /**
            * Unique identifier of the action
            */
@@ -95,7 +99,8 @@ declare namespace sap {
         personalization?:
           | boolean
           | string
-          | sap.ui.base.ManagedObject.PropertyBindingInfo;
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * Specifies the selection mode
@@ -115,7 +120,8 @@ declare namespace sap {
          */
         formatOptions?:
           | sap.fe.macros.FieldFormatOptions
-          | sap.ui.base.ManagedObject.PropertyBindingInfo;
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * The identifier of the Field control.
@@ -132,7 +138,10 @@ declare namespace sap {
          * If you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the
          * current state.
          */
-        readOnly?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
+        readOnly?:
+          | boolean
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * Option to add semantic objects to a field.
@@ -176,6 +185,11 @@ declare namespace sap {
          * Defines the relative path of the property in the metamodel, based on the current contextPath.
          */
         metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
+
+        /**
+         * The title of the form control.
+         */
+        title?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
       }
 
       interface $MacroAPISettings extends sap.ui.core.$ControlSettings {
@@ -195,7 +209,10 @@ declare namespace sap {
         /**
          * An expression that allows you to control the 'busy' state of the table.
          */
-        busy?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
+        busy?:
+          | boolean
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * Defines the path of the context used in the current page or block.
@@ -208,24 +225,32 @@ declare namespace sap {
          */
         enableAutoColumnWidth?:
           | boolean
-          | sap.ui.base.ManagedObject.PropertyBindingInfo;
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * Controls if the export functionality of the table is enabled or not.
          */
-        enableExport?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
+        enableExport?:
+          | boolean
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * Controls whether the table can be opened in fullscreen mode or not.
          */
         enableFullScreen?:
           | boolean
-          | sap.ui.base.ManagedObject.PropertyBindingInfo;
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * Controls if the paste functionality of the table is enabled or not.
          */
-        enablePaste?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
+        enablePaste?:
+          | boolean
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * ID of the FilterBar building block associated with the table.
@@ -240,7 +265,10 @@ declare namespace sap {
         /**
          * Controls if the header text should be shown or not.
          */
-        headerVisible?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
+        headerVisible?:
+          | boolean
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * The identifier of the table control.
@@ -250,7 +278,10 @@ declare namespace sap {
         /**
          * Defines whether to display the search action.
          */
-        isSearchable?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
+        isSearchable?:
+          | boolean
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * Groups menu actions by key.
@@ -284,14 +315,18 @@ declare namespace sap {
         personalization?:
           | boolean
           | string
-          | sap.ui.base.ManagedObject.PropertyBindingInfo;
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * An expression that allows you to control the 'read-only' state of the table.
          * If you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the
          * current state.
          */
-        readOnly?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
+        readOnly?:
+          | boolean
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * Defines the selection mode to be used by the table.
@@ -336,7 +371,8 @@ declare namespace sap {
        * <macro:FlexibleColumnLayoutActions />
        * ```
        */
-      class FlexibleColumnLayoutActions extends sap.fe.macros.MacroMetadata {
+      class FlexibleColumnLayoutActions
+        /* was: sap.fe.macros.MacroMetadata */ extends Object {
         constructor();
       }
       /**
@@ -344,16 +380,7 @@ declare namespace sap {
        *
        * Building block used to create a form element containing a label and a field.
        */
-      class FormElement extends sap.fe.macros.MacroMetadata {
-        constructor();
-      }
-      /**
-       * @SINCE 1.90.0
-       *
-       * Base class for all SAP Fiori elements building blocks. This class is not meant to be used as a stand-alone
-       * class.
-       */
-      class MacroMetadata {
+      class FormElement /* was: sap.fe.macros.MacroMetadata */ extends Object {
         constructor();
       }
       /**
@@ -361,7 +388,7 @@ declare namespace sap {
        *
        * Building block used to create a MicroChart based on the metadata provided by OData V4.
        */
-      class MicroChart extends sap.fe.macros.MacroMetadata {
+      class MicroChart /* was: sap.fe.macros.MacroMetadata */ extends Object {
         constructor();
       }
       /**
@@ -375,7 +402,7 @@ declare namespace sap {
        * <macro:Paginator />
        * ```
        */
-      class Paginator extends sap.fe.macros.MacroMetadata {
+      class Paginator /* was: sap.fe.macros.MacroMetadata */ extends Object {
         constructor();
       }
       /**
@@ -396,7 +423,7 @@ declare namespace sap {
        * />
        * ```
        */
-      class Share extends sap.fe.macros.MacroMetadata {
+      class Share /* was: sap.fe.macros.MacroMetadata */ extends Object {
         constructor();
       }
       /**
@@ -432,6 +459,8 @@ declare namespace sap {
 
         /**
          * Adds a message to the field.
+         *
+         * @returns The id of the message
          */
         addMessage(
           /**
@@ -458,6 +487,8 @@ declare namespace sap {
         ): string;
         /**
          * Retrieves the current value of the Field.
+         *
+         * @returns The current value of the field
          */
         getValue(): string | boolean;
         /**
@@ -488,7 +519,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(
           /**
@@ -502,19 +535,27 @@ declare namespace sap {
           /**
            * The values to be applied
            */
-          vValues: undefined | string | string[]
-        ): any;
+          vValues:
+            | undefined
+            | string
+            | number
+            | boolean
+            | string[]
+            | number[]
+            | boolean[]
+        ): void;
       }
       /**
        * Building block for creating a Form based on the metadata provided by OData V4.
        *
        *
-       * Usually, a ReferenceFacet or CollectionFacet is expected
+       * It is designed to work based on a FieldGroup annotation but can also work if you provide a ReferenceFacet
+       * or a CollectionFacet
        * Usage example:
        *
        * ```javascript
        *
-       * <macro:Form id="MyForm" metaPath="@com.sap.vocabularies.UI.v1.Facets/0" />
+       * <macro:Form id="MyForm" metaPath="@com.sap.vocabularies.UI.v1.FieldGroup#GeneralInformation" />
        * ```
        */
       class Form extends sap.fe.macros.MacroAPI {
@@ -545,6 +586,9 @@ declare namespace sap {
         /**
          * Adds a message to the table.
          * The message applies to the whole table and not to an individual table row.
+         *
+         *
+         * @returns The ID of the message
          */
         addMessage(
           /**
@@ -571,6 +615,8 @@ declare namespace sap {
         ): string;
         /**
          * Gets contexts from the table that have been selected by the user.
+         *
+         * @returns Contexts of the rows selected by the user
          */
         getSelectedContexts(): sap.ui.model.odata.v4.Context[];
         /**
@@ -671,8 +717,6 @@ declare namespace sap {
 
     "sap/fe/macros/MacroAPI": undefined;
 
-    "sap/fe/macros/MacroMetadata": undefined;
-
     "sap/fe/macros/MicroChart.metadata": undefined;
 
     "sap/fe/macros/Paginator.metadata": undefined;