@sapui5/ts-types 1.97.1 → 1.99.0

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.97.0
+// For Library Version: 1.99.0
 
 declare namespace sap {
   interface IUI5DefineDependencyNames {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.97.0
+// For Library Version: 1.99.0
 
 declare namespace sap {
   /**
@@ -16,7 +16,6 @@ declare namespace sap {
       namespace controllerextensions {
         /**
          * @SINCE 1.90.0
-         * @EXPERIMENTAL (since 1.90.0)
          *
          * A controller extension offering hooks into the edit flow of the application
          */
@@ -53,7 +52,6 @@ declare namespace sap {
           static getMetadata(): sap.ui.base.Metadata;
           /**
            * @SINCE 1.90.0
-           * @EXPERIMENTAL (since 1.90.0)
            *
            * Submit the current set of changes and navigate back.
            */
@@ -65,7 +63,6 @@ declare namespace sap {
           ): Promise<any>;
           /**
            * @SINCE 1.90.0
-           * @EXPERIMENTAL (since 1.90.0)
            *
            * Discard the editable document.
            */
@@ -77,16 +74,19 @@ declare namespace sap {
             /**
              * Can contain the following attributes:
              */
-            mParameters?: {
+            mParameters: {
               /**
-               * This is the control used to open the Discard popover. It is mandatory.
+               * This is the control used to open the discard popover
                */
               control: object;
+              /**
+               * Optional, supresses the discard popover and allows custom handling
+               */
+              skipDiscardPopover?: boolean;
             }
           ): Promise<any>;
           /**
            * @SINCE 1.90.0
-           * @EXPERIMENTAL (since 1.90.0)
            *
            * Creates a new document.
            */
@@ -94,11 +94,30 @@ declare namespace sap {
             /**
              * ODataListBinding object or the binding path for a temporary list binding
              */
-            vListBinding: sap.ui.model.odata.v4.ODataListBinding | string
+            vListBinding: sap.ui.model.odata.v4.ODataListBinding | string,
+            /**
+             * Contains the following attributes:
+             */
+            mParameters: {
+              /**
+               * 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 Inline - The creation is done inline
+               * (in a table) External - The creation is done in a different application specified via the parameter 'outbound'
+               */
+              creationMode: string;
+              /**
+               * The navigation target where the document is created in case of creationMode 'External'
+               */
+              outbound?: string;
+              /**
+               * Specifies if the new entry should be created at the top or bottom of a table in case of creationMode
+               * 'Inline'
+               */
+              createAtEnd?: boolean;
+            }
           ): Promise<any>;
           /**
            * @SINCE 1.90.0
-           * @EXPERIMENTAL (since 1.90.0)
            *
            * Deletes the document.
            */
@@ -108,9 +127,9 @@ declare namespace sap {
              */
             oContext: object,
             /**
-             * Optional, can contain the following attributes:
+             * Can contain the following attributes:
              */
-            mParameters?: {
+            mParameters: {
               /**
                * Title of the object being deleted
                */
@@ -123,7 +142,6 @@ declare namespace sap {
           ): Promise<any>;
           /**
            * @SINCE 1.90.0
-           * @EXPERIMENTAL (since 1.90.0)
            *
            * Creates a draft document for an existing active document.
            */
@@ -131,11 +149,19 @@ declare namespace sap {
             /**
              * Context of the active document
              */
-            oContext: object
+            oContext: object,
+            /**
+             * Contains the following attributes:
+             */
+            mParameters?: {
+              /**
+               * For a service with a prepare action, this parameter decides if the action is to be executed
+               */
+              prepareOnEdit?: boolean;
+            }
           ): Promise<any>;
           /**
            * @SINCE 1.90.0
-           * @EXPERIMENTAL (since 1.90.0)
            *
            * Invokes an action (bound or unbound) and tracks the changes so that other pages can be refreshed and
            * show the updated data upon navigation.
@@ -150,7 +176,7 @@ declare namespace sap {
              */
             mParameters?: {
               /**
-               * For a bound action, a context or an array with contexts for which the action shall be called must be
+               * For a bound action, a context or an array with contexts for which the action is to be called must be
                * provided
                */
               contexts?: sap.ui.model.odata.v4.Context;
@@ -160,31 +186,138 @@ declare namespace sap {
               model?: sap.ui.model.odata.v4.ODataModel;
               /**
                * Boolean value indicating whether navigation is required after the action has been executed. Navigation
-               * takes place to the context returned by the action.
+               * takes place to the context returned by the action
                */
               requiresNavigation?: boolean;
               /**
                * A human-readable label for the action. This is needed in case the action has a parameter and a parameter
-               * dialog is shown to the user.
+               * dialog is shown to the user. The label will be used for the title of the dialog and for the confirmation
+               * button
                */
               label?: string;
+              /**
+               * Mode how actions are to be called: 'ChangeSet' to put all action calls into one changeset, 'Isolated'
+               * to put them into separate changesets
+               */
+              invocationGrouping?: string;
+            }
+          ): Promise<any>;
+          /**
+           * @SINCE 1.98.0
+           * @EXPERIMENTAL (since 1.98.0)
+           *
+           * This function can be used to intercept the 'Create' action. You can execute custom coding in this function.
+           * 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}.
+           */
+          onBeforeCreate(
+            /**
+             * Object containing the parameters passed to onBeforeCreate
+             */
+            mParameters?: {
+              /**
+               * Path pointing to the context on which Create action is triggered
+               */
+              contextPath?: string;
+              /**
+               * Array of values that are filled in the Action Parameter Dialog
+               */
+              createParameters?: any[];
+            }
+          ): Promise<any>;
+          /**
+           * @SINCE 1.98.0
+           * @EXPERIMENTAL (since 1.98.0)
+           *
+           * This function can be used to intercept the 'Delete' action. You can execute custom coding in this function.
+           * 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}.
+           */
+          onBeforeDelete(
+            /**
+             * Object containing the parameters passed to onBeforeDelete
+             */
+            mParameters?: {
+              /**
+               * An array of contexts that are going to be deleted
+               */
+              contexts?: any[];
+            }
+          ): Promise<any>;
+          /**
+           * @SINCE 1.98.0
+           * @EXPERIMENTAL (since 1.98.0)
+           *
+           * This function can be used to intercept the 'Discard' action. You can execute custom coding in this function.
+           * 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}.
+           */
+          onBeforeDiscard(
+            /**
+             * Object containing the parameters passed to onBeforeDiscard
+             */
+            mParameters?: {
+              /**
+               * Page context that is going to be discarded.
+               */
+              context?: sap.ui.model.odata.v4.Context;
+            }
+          ): Promise<any>;
+          /**
+           * @SINCE 1.98.0
+           * @EXPERIMENTAL (since 1.98.0)
+           *
+           * This function can be used to intercept the 'Edit' action. You can execute custom coding in this function.
+           * 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}.
+           */
+          onBeforeEdit(
+            /**
+             * Object containing the parameters passed to onBeforeEdit
+             */
+            mParameters?: {
+              /**
+               * Page context that is going to be edited.
+               */
+              context?: sap.ui.model.odata.v4.Context;
             }
           ): Promise<any>;
           /**
            * @SINCE 1.90.0
            * @EXPERIMENTAL (since 1.90.0)
            *
-           * This function can be used to intercept the save action. You can execute custom coding in this function.
-           * 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 can be used to intercept the 'Save' action. You can execute custom coding in this function.
+           * 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.Instead}.
+           * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
            */
-          onBeforeSave(): Promise<any>;
+          onBeforeSave(
+            /**
+             * Object containing the parameters passed to onBeforeSave
+             */
+            mParameters?: {
+              /**
+               * Page context that is going to be saved.
+               */
+              context?: sap.ui.model.odata.v4.Context;
+            }
+          ): Promise<any>;
           /**
            * @SINCE 1.90.0
-           * @EXPERIMENTAL (since 1.90.0)
            *
            * Saves a new document after checking it.
            */
@@ -234,7 +367,6 @@ declare namespace sap {
           ): Promise<any>;
           /**
            * @SINCE 1.90.0
-           * @EXPERIMENTAL (since 1.90.0)
            *
            * Updates the draft status and displays the error messages if there are errors during an update.
            */
@@ -388,6 +520,19 @@ declare namespace sap {
              */
             oContext: sap.ui.model.odata.v4.Context
           ): void;
+          /**
+           * Navigate to another target.
+           */
+          navigateToRoute(
+            /**
+             * Name of the target route
+             */
+            sTargetRouteName: string,
+            /**
+             * Parameters to be used with route to create the target hash
+             */
+            oParameters?: object
+          ): Promise<any>;
           /**
            * @SINCE 1.90.0
            *
@@ -1026,7 +1171,7 @@ declare namespace sap {
            * Context instance
            */
           oContext?: sap.ui.model.Context
-        ): void;
+        ): Promise<any>;
         /**
          * Remove a dependent control from this SAP Fiori elements page.
          */

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.97.0
+// For Library Version: 1.99.0
 
 declare namespace sap {
   namespace fe {
@@ -31,6 +31,18 @@ declare namespace sap {
        */
       export const Field: undefined;
 
+      /**
+       * Building block for creating a Form based on the metadata provided by OData V4.
+       *  Usually, a ReferenceFacet or CollectionFacet is expected
+       *
+       * Usage example:
+       * ```javascript
+       *
+       * <macro:Form id="MyForm" metaPath="@com.sap.vocabularies.UI.v1.Facets/0" />
+       * ```
+       */
+      export const Form: undefined;
+
       /**
        * Building block used to create a table based on the metadata provided by OData V4.
        *  Usually, a LineItem or PresentationVariant annotation is expected, but the Table building block can

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

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.97.0
+// For Library Version: 1.99.0
 
 declare namespace sap {
   namespace fe {
@@ -81,6 +81,10 @@ declare namespace sap {
         class ExtensionAPI extends sap.fe.core.ExtensionAPI {
           constructor();
 
+          /**
+           * Gets the bound context of the current object page.
+           */
+          getBindingContext(): sap.ui.model.odata.v4.Context;
           /**
            * Gets the list entries currently selected for the table.
            */

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.97.0
+// For Library Version: 1.99.0
 
 declare namespace sap {
   namespace fe {
@@ -162,6 +162,10 @@ declare namespace sap {
         class DialogMessageActions extends sap.fe.test.api.DialogActions {
           constructor();
 
+          /**
+           * Confirms the draft message with Discard Draft when navigating back to the list-report.
+           */
+          iConfirmDiscardDraft(): object;
           /**
            * Executes the `Back` action on the message dialog.
            */
@@ -1345,10 +1349,6 @@ declare namespace sap {
              */
             vAction: string | object
           ): object;
-          /**
-           * Executes the `Paste` action on the table.
-           */
-          iExecutePaste(): object;
           /**
            * Executes the `Show/Hide details` action on the table.
            */
@@ -1788,14 +1788,9 @@ declare namespace sap {
             mProperty?: object
           ): object;
           /**
-           * Checks the `Paste` action of the table.
+           * Checks whether the paste button is available for the table.
            */
-          iCheckPaste(
-            /**
-             * Defines the expected state of the button
-             */
-            mState?: object
-          ): object;
+          iCheckPaste(): object;
           /**
            * Checks the quick filter action of the table.
            */
@@ -2097,6 +2092,10 @@ declare namespace sap {
            * The name of the navigation property used for the table
            */
           property: string;
+          /**
+           * The name of a qualifier for the table
+           */
+          qualifier?: string;
         };
       }
 
@@ -2685,7 +2684,10 @@ declare namespace sap {
           },
           /**
            * The journeys to be executed. If a journey is represented as a string, it will be interpreted as a module
-           * path to the file that should be loaded. Else it is expected to be a function
+           * path to the file that should be loaded. Else it is expected to be a function. Alternatively, instead
+           * of being wrapped in an array, the journeys can also be given as separate parameters:
+           * ```javascript
+           * .run(mSettings, Journey1, Journey2, ...)```
            */
           vJourneys: Array<() => void> | string[]
         ): object;
@@ -2697,7 +2699,10 @@ declare namespace sap {
         run(
           /**
            * The journeys to be executed. If a journey is represented as a string, it will be interpreted as a module
-           * path to the file that should be loaded. Else it is expected to be a function
+           * path to the file that should be loaded. Else it is expected to be a function. Alternatively, instead
+           * of being wrapped in an array, the journeys can also be given as separate parameters:
+           * ```javascript
+           * .run(mSettings, Journey1, Journey2, ...)```
            */
           vJourneys: Array<() => void> | string[]
         ): object;

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.97.0
+// For Library Version: 1.99.0
 
 declare namespace sap {
   interface IUI5DefineDependencyNames {

package/types/sap.gantt.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.97.0
+// For Library Version: 1.99.0
 
 declare namespace sap {
   /**
@@ -19609,6 +19609,8 @@ declare namespace sap {
           | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
         /**
+         * @deprecated (since 1.97) - **Note:**With the new implementation, this property won't have any effect.
+         *
          * Delay in milliseconds for the marker popover to show up
          */
         markerPopoverDelay?:
@@ -20219,6 +20221,26 @@ declare namespace sap {
          * The titleSpacing property defines the space between the start of the shape and the shape title in pixels
          */
         titleSpacing?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
+
+        /**
+         * @SINCE 1.99
+         *
+         * The selectedFill property defines the color (or any SVG paint servers like gradients or patterns) of
+         * the shape when it is selected.
+         */
+        selectedFill?:
+          | sap.gantt.ValueSVGPaintServer
+          | sap.ui.base.ManagedObject.PropertyBindingInfo;
+
+        /**
+         * @SINCE 1.99
+         *
+         * The selectedTitleColor property defines the color (or any SVG paint servers like gradients or patterns)
+         * of the shape's title when it is selected.
+         */
+        selectedTitleColor?:
+          | sap.gantt.ValueSVGPaintServer
+          | sap.ui.base.ManagedObject.PropertyBindingInfo;
       }
 
       interface $BaseTextSettings extends sap.gantt.simple.$BaseShapeSettings {
@@ -20528,6 +20550,8 @@ declare namespace sap {
         visible?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
         /**
+         * @deprecated (since 1.97) - **Note:**With the new implementation, this property won't have any effect.
+         *
          * Visibility of the Delta Line
          */
         timeDelay?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
@@ -21277,6 +21301,15 @@ declare namespace sap {
           | sap.gantt.simple.relationshipShapeSize
           | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
+        /**
+         * @EXPERIMENTAL (since 1.98)
+         *
+         * Determines if only tasks need to be used for rendering the expanded shapes. Subtasks are not required.
+         */
+        useParentShapeOnExpand?:
+          | boolean
+          | sap.ui.base.ManagedObject.PropertyBindingInfo;
+
         /**
          * Table of the Gantt Chart
          *
@@ -22791,6 +22824,8 @@ declare namespace sap {
          */
         getDraggable(): boolean;
         /**
+         * @deprecated (since 1.97) - **Note:**With the new implementation, this property won't have any effect.
+         *
          * Gets current value of property {@link #getMarkerPopoverDelay markerPopoverDelay}.
          *
          * Delay in milliseconds for the marker popover to show up
@@ -22945,6 +22980,8 @@ declare namespace sap {
           bDraggable?: boolean
         ): this;
         /**
+         * @deprecated (since 1.97) - **Note:**With the new implementation, this property won't have any effect.
+         *
          * Sets a new value for property {@link #getMarkerPopoverDelay markerPopoverDelay}.
          *
          * Delay in milliseconds for the marker popover to show up
@@ -25118,6 +25155,24 @@ declare namespace sap {
          * Default value is `false`.
          */
         getSelected(): boolean;
+        /**
+         * @SINCE 1.99
+         *
+         * Gets current value of property {@link #getSelectedFill selectedFill}.
+         *
+         * The selectedFill property defines the color (or any SVG paint servers like gradients or patterns) of
+         * the shape when it is selected.
+         */
+        getSelectedFill(): sap.gantt.ValueSVGPaintServer;
+        /**
+         * @SINCE 1.99
+         *
+         * Gets current value of property {@link #getSelectedTitleColor selectedTitleColor}.
+         *
+         * The selectedTitleColor property defines the color (or any SVG paint servers like gradients or patterns)
+         * of the shape's title when it is selected.
+         */
+        getSelectedTitleColor(): sap.gantt.ValueSVGPaintServer;
         /**
          * Gets current value of property {@link #getShapeId shapeId}.
          *
@@ -25624,6 +25679,38 @@ declare namespace sap {
            */
           bSelected?: boolean
         ): this;
+        /**
+         * @SINCE 1.99
+         *
+         * Sets a new value for property {@link #getSelectedFill selectedFill}.
+         *
+         * The selectedFill property defines the color (or any SVG paint servers like gradients or patterns) of
+         * the shape when it is selected.
+         *
+         * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+         */
+        setSelectedFill(
+          /**
+           * New value for property `selectedFill`
+           */
+          sSelectedFill: sap.gantt.ValueSVGPaintServer
+        ): this;
+        /**
+         * @SINCE 1.99
+         *
+         * Sets a new value for property {@link #getSelectedTitleColor selectedTitleColor}.
+         *
+         * The selectedTitleColor property defines the color (or any SVG paint servers like gradients or patterns)
+         * of the shape's title when it is selected.
+         *
+         * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+         */
+        setSelectedTitleColor(
+          /**
+           * New value for property `selectedTitleColor`
+           */
+          sSelectedTitleColor: sap.gantt.ValueSVGPaintServer
+        ): this;
         /**
          * Sets a new value for property {@link #getShapeId shapeId}.
          *
@@ -28023,6 +28110,8 @@ declare namespace sap {
          */
         getStrokeOpacity(): float;
         /**
+         * @deprecated (since 1.97) - **Note:**With the new implementation, this property won't have any effect.
+         *
          * Gets current value of property {@link #getTimeDelay timeDelay}.
          *
          * Visibility of the Delta Line
@@ -28295,6 +28384,8 @@ declare namespace sap {
           fStrokeOpacity?: float
         ): this;
         /**
+         * @deprecated (since 1.97) - **Note:**With the new implementation, this property won't have any effect.
+         *
          * Sets a new value for property {@link #getTimeDelay timeDelay}.
          *
          * Visibility of the Delta Line
@@ -31322,6 +31413,16 @@ declare namespace sap {
          * Default value is `library.config.DEFAULT_TIME_PATTERN`.
          */
         getTimePattern(): string;
+        /**
+         * @EXPERIMENTAL (since 1.98)
+         *
+         * Gets current value of property {@link #getUseParentShapeOnExpand useParentShapeOnExpand}.
+         *
+         * Determines if only tasks need to be used for rendering the expanded shapes. Subtasks are not required.
+         *
+         * Default value is `false`.
+         */
+        getUseParentShapeOnExpand(): boolean;
         /**
          * Gets current value of property {@link #getWidth width}.
          *
@@ -32411,6 +32512,23 @@ declare namespace sap {
            */
           sTimePattern?: string
         ): this;
+        /**
+         * @EXPERIMENTAL (since 1.98)
+         *
+         * Sets a new value for property {@link #getUseParentShapeOnExpand useParentShapeOnExpand}.
+         *
+         * Determines if only tasks need to be used for rendering the expanded shapes. Subtasks are not required.
+         *
+         * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+         *
+         * Default value is `false`.
+         */
+        setUseParentShapeOnExpand(
+          /**
+           * New value for property `useParentShapeOnExpand`
+           */
+          bUseParentShapeOnExpand?: boolean
+        ): this;
         /**
          * Sets a new value for property {@link #getWidth width}.
          *