@sapui5/ts-types 1.94.1 → 1.97.0

package/types/sap.suite.ui.commons.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.94.0
+// For Library Version: 1.97.0
 
 declare namespace sap {
   namespace suite {
@@ -8310,7 +8310,11 @@ declare namespace sap {
               /**
                * icon to render
                */
-              sIcon: undefined
+              sIcon: undefined,
+              /**
+               * Options passed to the method (optional).
+               */
+              mOptions?: Object
             ): string;
             /**
              * Renders custom info icon for HTML rendering.
@@ -8319,7 +8323,11 @@ declare namespace sap {
               /**
                * Object with additional style appended to info icon
                */
-              oStyle: object
+              oStyle: object,
+              /**
+               * Options passed to the method (optional).
+               */
+              mOptions?: Object
             ): void;
             /**
              * Creates an SVG icon string.
@@ -17614,6 +17622,22 @@ declare namespace sap {
            */
           userNameClicked?: (oEvent: sap.ui.base.Event) => void;
 
+          /**
+           * @SINCE 1.95
+           *
+           * This event is fired when a non-interactive content or white space(where no content is available) inside
+           * an timeline post is clicked, triggers the click event of the item.
+           */
+          select?: (oEvent: sap.ui.base.Event) => void;
+
+          /**
+           * @SINCE 1.95
+           *
+           * This event is fired when the embedded control link is clicked of the timeline post. triggers the click
+           * event of the content.
+           */
+          press?: (oEvent: sap.ui.base.Event) => void;
+
           /**
            * This event is fired when the Reply button is clicked in the links section of a timeline post.
            */
@@ -35988,6 +36012,53 @@ declare namespace sap {
              */
             oListener?: object
           ): this;
+          /**
+           * @SINCE 1.95
+           *
+           * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.suite.ui.commons.TimelineItem`.
+           *
+           * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
+           * otherwise it will be bound to this `sap.suite.ui.commons.TimelineItem` itself.
+           *
+           * This event is fired when the embedded control link is clicked of the timeline post. triggers the click
+           * event of the content.
+           */
+          attachPress(
+            /**
+             * An application-specific payload object that will be passed to the event handler along with the event
+             * object when firing the event
+             */
+            oData: object,
+            /**
+             * The function to be called when the event occurs
+             */
+            fnFunction: (p1: sap.ui.base.Event) => void,
+            /**
+             * Context object to call the event handler with. Defaults to this `sap.suite.ui.commons.TimelineItem` itself
+             */
+            oListener?: object
+          ): this;
+          /**
+           * @SINCE 1.95
+           *
+           * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.suite.ui.commons.TimelineItem`.
+           *
+           * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
+           * otherwise it will be bound to this `sap.suite.ui.commons.TimelineItem` itself.
+           *
+           * This event is fired when the embedded control link is clicked of the timeline post. triggers the click
+           * event of the content.
+           */
+          attachPress(
+            /**
+             * The function to be called when the event occurs
+             */
+            fnFunction: (p1: sap.ui.base.Event) => void,
+            /**
+             * Context object to call the event handler with. Defaults to this `sap.suite.ui.commons.TimelineItem` itself
+             */
+            oListener?: object
+          ): this;
           /**
            * Attaches event handler `fnFunction` to the {@link #event:replyListOpen replyListOpen} event of this `sap.suite.ui.commons.TimelineItem`.
            *
@@ -36070,6 +36141,53 @@ declare namespace sap {
              */
             oListener?: object
           ): this;
+          /**
+           * @SINCE 1.95
+           *
+           * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.suite.ui.commons.TimelineItem`.
+           *
+           * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
+           * otherwise it will be bound to this `sap.suite.ui.commons.TimelineItem` itself.
+           *
+           * This event is fired when a non-interactive content or white space(where no content is available) inside
+           * an timeline post is clicked, triggers the click event of the item.
+           */
+          attachSelect(
+            /**
+             * An application-specific payload object that will be passed to the event handler along with the event
+             * object when firing the event
+             */
+            oData: object,
+            /**
+             * The function to be called when the event occurs
+             */
+            fnFunction: (p1: sap.ui.base.Event) => void,
+            /**
+             * Context object to call the event handler with. Defaults to this `sap.suite.ui.commons.TimelineItem` itself
+             */
+            oListener?: object
+          ): this;
+          /**
+           * @SINCE 1.95
+           *
+           * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.suite.ui.commons.TimelineItem`.
+           *
+           * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
+           * otherwise it will be bound to this `sap.suite.ui.commons.TimelineItem` itself.
+           *
+           * This event is fired when a non-interactive content or white space(where no content is available) inside
+           * an timeline post is clicked, triggers the click event of the item.
+           */
+          attachSelect(
+            /**
+             * The function to be called when the event occurs
+             */
+            fnFunction: (p1: sap.ui.base.Event) => void,
+            /**
+             * Context object to call the event handler with. Defaults to this `sap.suite.ui.commons.TimelineItem` itself
+             */
+            oListener?: object
+          ): this;
           /**
            * @SINCE 1.28.1
            * @deprecated (since 1.46.0) - Use the Group Feed Component instead.
@@ -36257,6 +36375,23 @@ declare namespace sap {
              */
             oListener?: object
           ): this;
+          /**
+           * @SINCE 1.95
+           *
+           * Detaches event handler `fnFunction` from the {@link #event:press press} event of this `sap.suite.ui.commons.TimelineItem`.
+           *
+           * The passed function and listener object must match the ones used for event registration.
+           */
+          detachPress(
+            /**
+             * The function to be called, when the event occurs
+             */
+            fnFunction: (p1: sap.ui.base.Event) => void,
+            /**
+             * Context object on which the given function had to be called
+             */
+            oListener?: object
+          ): this;
           /**
            * Detaches event handler `fnFunction` from the {@link #event:replyListOpen replyListOpen} event of this
            * `sap.suite.ui.commons.TimelineItem`.
@@ -36288,6 +36423,23 @@ declare namespace sap {
              */
             oListener?: object
           ): this;
+          /**
+           * @SINCE 1.95
+           *
+           * Detaches event handler `fnFunction` from the {@link #event:select select} event of this `sap.suite.ui.commons.TimelineItem`.
+           *
+           * The passed function and listener object must match the ones used for event registration.
+           */
+          detachSelect(
+            /**
+             * The function to be called, when the event occurs
+             */
+            fnFunction: (p1: sap.ui.base.Event) => void,
+            /**
+             * Context object on which the given function had to be called
+             */
+            oListener?: object
+          ): this;
           /**
            * @SINCE 1.28.1
            * @deprecated (since 1.46.0) - Use the Group Feed Component instead.
@@ -36363,6 +36515,17 @@ declare namespace sap {
               linkObj?: sap.m.Link;
             }
           ): this;
+          /**
+           * @SINCE 1.95
+           *
+           * Fires event {@link #event:press press} to attached listeners.
+           */
+          firePress(
+            /**
+             * Parameters to pass along with the event
+             */
+            mParameters?: object
+          ): this;
           /**
            * Fires event {@link #event:replyListOpen replyListOpen} to attached listeners.
            */
@@ -36386,6 +36549,17 @@ declare namespace sap {
               value?: string;
             }
           ): this;
+          /**
+           * @SINCE 1.95
+           *
+           * Fires event {@link #event:select select} to attached listeners.
+           */
+          fireSelect(
+            /**
+             * Parameters to pass along with the event
+             */
+            mParameters?: object
+          ): this;
           /**
            * @SINCE 1.28.1
            * @deprecated (since 1.46.0) - Use the Group Feed Component instead.

package/types/sap.suite.ui.generic.template.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.94.0
+// For Library Version: 1.97.0
 
 declare namespace sap {
   namespace suite {
@@ -554,11 +554,11 @@ declare namespace sap {
                    */
                   mUrlParameters: Record<string, any>,
                   /**
-                   * Parameters which are used to set patameters for involing Application controller's incokeActions method
+                   * Parameters that are set for invoking Application controller's invokeActions method
                    */
                   oSettings: {
                     /**
-                     * determined whether common or unique changeset will be sent in batch
+                     * Determines whether the common or unique changeset gets sent in batch
                      */
                     bInvocationGroupingChangeSet: boolean;
                   }
@@ -576,11 +576,11 @@ declare namespace sap {
                    */
                   vContext: any[] | sap.ui.model.Context,
                   /**
-                   * Parameters which are used to set patameters for involing Application controller's incokeActions method
+                   * Parameters that are set for invoking Application controller's invokeActions method
                    */
                   oSettings: {
                     /**
-                     * determined whether common or unique changeset will be sent in batch
+                     * Determines whether the common or unique changeset gets sent in batch
                      */
                     bInvocationGroupingChangeSet: boolean;
                   }
@@ -955,11 +955,11 @@ declare namespace sap {
                    */
                   mUrlParameters: Record<string, any>,
                   /**
-                   * Parameters which are used to set patameters for involing Application controller's incokeActions method
+                   * Parameters that are set for invoking Application controller's invokeActions method
                    */
                   oSettings: {
                     /**
-                     * determined whether common or unique changeset will be sent in batch
+                     * Determines whether the common or unique changeset gets sent in batch
                      */
                     bInvocationGroupingChangeSet: boolean;
                   }
@@ -977,11 +977,11 @@ declare namespace sap {
                    */
                   vContext: any[] | sap.ui.model.Context,
                   /**
-                   * Parameters which are used to set patameters for involing Application controller's incokeActions method
+                   * Parameters that are set for invoking Application controller's invokeActions method
                    */
                   oSettings: {
                     /**
-                     * determined whether common or unique changeset will be sent in batch
+                     * Determines whether the common or unique changeset gets sent in batch
                      */
                     bInvocationGroupingChangeSet: boolean;
                   }
@@ -1215,7 +1215,23 @@ declare namespace sap {
                * This method is called by SAP Fiori elements before persisting the AppState. Application developers can
                * override this method for persisting the state of custom controls. State of the custom control (controls)
                * should be stored in the oCustomData passed as a parameter to this method. To make a complete functionality,
-               * this method should be overridden with `restoreCustomAppStateDataExtension`.
+               * this method should be overridden in combination with `restoreCustomAppStateDataExtension`.
+               *
+               * In some cases, applications might need to inform the framework about changes to their state by calling
+               * {@link sap.suite.ui.generic.template.ListReport.extensionAPI.onCustomAppStateChange onCustomAppStateChange}.
+               * For custom filters added to the filter bar, this should not be necessary.
+               *
+               * Remark: The term AppState actually relates to the UI state of the List Report. It is usually stored in
+               * the layered repository, and can be retrieved via the key, that is added as value of the URL parameter
+               * iAppState. (Although the value of the URL parameter xAppState used in navigation scenarios also points
+               * to data stored on the layered repository, in contrast to the iAppState it has nothing to do with the
+               * state of the app - conceptually, it is just a container for passing data from source to target during
+               * navigation. The confusion arises from the fact, that per definition the source app should provide all
+               * data available (to allow the target app to select the part it is interested in), and thus the structure
+               * contained looks quite similar to the iAppState.)
+               *
+               * For more information, see {@link topic:5fb9f57fcf12401bbe39a635e9a32a4e Adding Custom Fields to the Filter
+               * Bar}.
                */
               getCustomAppStateDataExtension(
                 /**
@@ -1235,7 +1251,11 @@ declare namespace sap {
                 /**
                  * SmartFilterBar of the ListReport
                  */
-                oSmartFilterBar: sap.ui.comp.smartfilterbar.SmartFilterBar
+                oSmartFilterBar: sap.ui.comp.smartfilterbar.SmartFilterBar,
+                /**
+                 * Default values returned by backend when Common.v1.DefaultValuesFunction annotation has been configured
+                 */
+                oDefaultValues: object
               ): Map<any, any>;
               /**
                * This method is called in the AppState creation lifecycle. Application developers can override this method,
@@ -1272,6 +1292,9 @@ declare namespace sap {
                * this method and programmatically modify parameters or filters before chart triggers a query to retrieve
                * data.
                *
+               * For more information, see {@link topic:5fb9f57fcf12401bbe39a635e9a32a4e Adding Custom Fields to the Filter
+               * Bar}.
+               *
                * **Note: **This method is called only when a chart is rebound, and not when it is refreshed.
                */
               onBeforeRebindChartExtension(
@@ -1285,6 +1308,9 @@ declare namespace sap {
                * this method and programmatically modify parameters or filters before the table triggers a query to retrieve
                * data.
                *
+               * For more information, see {@link topic:5fb9f57fcf12401bbe39a635e9a32a4e Adding Custom Fields to the Filter
+               * Bar}.
+               *
                * **Note: **This method is called only when a table is rebound, and not when it is refreshed.
                */
               onBeforeRebindTableExtension(
@@ -1331,8 +1357,15 @@ declare namespace sap {
               onInit(): void;
               /**
                * This method is called by SAP Fiori elements once the smart filter bar is initialized with a variant.
+               *
                * Application developers can override this method when there is a custom filter field bound outside the
                * standard model.
+               *
+               * Use this method to provide initial values for your extension filters if they deviate from the initial
+               * value according to the data type and cannot be provided in the view fragment.
+               *
+               * For more information, see {@link topic:5fb9f57fcf12401bbe39a635e9a32a4e Adding Custom Fields to the Filter
+               * Bar}.
                */
               onInitSmartFilterBarExtension(
                 /**
@@ -1392,9 +1425,19 @@ declare namespace sap {
               ): void;
               /**
                * This method is called by SAP Fiori elements while applying the AppState. This method should be overridden
-               * with `getCustomAppStateDataExtension`. The custom data retrieved from the AppState will be passed as
-               * a parameter to this method. Application developers can use this custom data to restore the state of the
-               * custom control.
+               * in combination with `getCustomAppStateDataExtension`. The custom data retrieved from the AppState will
+               * be passed as a parameter to this method. Application developers can use this custom data to restore the
+               * state of the custom control.
+               *
+               * Note: Application developers need to be aware that this method is also called during startup without
+               * restoring from an iAppState (initial startup or navigation). In this case, an empty object is provided.
+               * Originally, this happened unintended, but needs to be kept for compatibility, as it has been used by
+               * some applications to enforce specific filter values (contradicting the defined way navigation should
+               * work). This usage is not recommended! Recommended: When called with an empty object, just return without
+               * doing anything.
+               *
+               * For more information, see {@link topic:5fb9f57fcf12401bbe39a635e9a32a4e Adding Custom Fields to the Filter
+               * Bar}.
                */
               restoreCustomAppStateDataExtension(
                 /**
@@ -1677,11 +1720,11 @@ declare namespace sap {
                    */
                   mUrlParameters: Record<string, any>,
                   /**
-                   * Parameters which are used to set patameters for involing Application controller's incokeActions method
+                   * Parameters that are set for invoking Application controller's invokeActions method
                    */
                   oSettings: {
                     /**
-                     * determined whether common or unique changeset will be sent in batch
+                     * Determines whether the common or unique changeset gets sent in batch
                      */
                     bInvocationGroupingChangeSet: boolean;
                   }
@@ -1699,11 +1742,11 @@ declare namespace sap {
                    */
                   vContext: any[] | sap.ui.model.Context,
                   /**
-                   * Parameters which are used to set patameters for involing Application controller's incokeActions method
+                   * Parameters that are set for invoking Application controller's invokeActions method
                    */
                   oSettings: {
                     /**
-                     * determined whether common or unique changeset will be sent in batch
+                     * Determines whether the common or unique changeset gets sent in batch
                      */
                     bInvocationGroupingChangeSet: boolean;
                   }

package/types/sap.suite.ui.microchart.d.ts

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

package/types/sap.tnt.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.94.0
+// For Library Version: 1.97.0
 
 declare namespace sap {
   /**
@@ -1465,17 +1465,16 @@ declare namespace sap {
      *  The ToolHeader stylizes the contained controls with the Shell color parameters, to match the dark design
      * requirement. However, that's not a dark theme.
      *
-     *  Only the following controls are supported:
-     *
-     *  Control name Supported Not supported   sap.m.Text Single line text, text
-     * truncation Wrapping   sap.m.Title Single line text, text truncation.
-     * Consider using title headings of H4, H5, H6. Wrapping   sap.m.Label Single
-     * line text, text truncation Wrapping   sap.m.ObjectStatus Labels,
-     * semantic colors Indication colors   sap.ui.core.Icon sap.ui.core.IconColor
-     * enumeration for both icons and backgrounds. Interaction state colors   sap.m.Button
-     * Buttons in their Back, Default, Transparent and Up types. All four types are over-styled to look
-     * as transparent buttons. -   sap.m.MenuButton Emphasized button type.
-     * Should be used for triggering Mega menu. If there is no Mega menu, use Title (H6) instead.
+     *  Only the following controls are supported:    Control name Supported
+     * Not supported   sap.m.Text Single line text, text truncation Wrapping
+     *   sap.m.Title Single line text, text truncation. Consider using title headings
+     * of H4, H5, H6. Wrapping   sap.m.Label Single line text, text truncation
+     * Wrapping   sap.m.ObjectStatus Labels, semantic colors Indication
+     * colors   sap.ui.core.Icon sap.ui.core.IconColor enumeration for both icons
+     * and backgrounds. Interaction state colors   sap.m.Button Buttons
+     * in their Back, Default, Transparent and Up types. All four types are over-styled to look as transparent
+     * buttons. -   sap.m.MenuButton Emphasized button type. Should be used
+     * for triggering Mega menu. If there is no Mega menu, use Title (H6) instead.
      *  Default (over-styled as Transparent) and Transparent types are used for standard menu representation.
      * -   sap.m.Select Default and IconOnly types. IconOnly looks like a button
      * while Default looks is like an input. Semantic states   sap.m.SearchField