@sapui5/types 1.114.0 → 1.115.0

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

@@ -3,14 +3,19 @@
 declare module "sap/fe/macros/MacroAPI" {
   import { default as Control, $ControlSettings } from "sap/ui/core/Control";
 
+  import { IFormContent } from "sap/ui/core/library";
+
   import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
 
   /**
    * Base API control for building blocks.
    */
-  export default class MacroAPI extends Control {
+  class MacroAPI extends Control implements IFormContent {
+    __implements__sap_ui_core_IFormContent: boolean;
+
     constructor();
   }
+  export default MacroAPI;
 
   export interface $MacroAPISettings extends $ControlSettings {
     /**
@@ -51,7 +56,7 @@ declare module "sap/fe/macros/chart/ChartAPI" {
    * <macro:Chart id="Mychart" contextPath="/RootEntity" metaPath="@com.sap.vocabularies.UI.v1.Chart" />
    * ```
    */
-  export default class Chart extends MacroAPI {
+  class Chart extends MacroAPI {
     constructor();
 
     /**
@@ -61,6 +66,8 @@ declare module "sap/fe/macros/chart/ChartAPI" {
      */
     getSelectedContexts(): Context[];
   }
+  export default Chart;
+
   /**
    * Definition of a custom action to be used inside the chart toolbar
    */
@@ -156,17 +163,42 @@ declare module "sap/fe/macros/chart/ChartAPI" {
     metaPath?: string | PropertyBindingInfo;
 
     /**
-     * Parameter which sets the personalization of the MDC_Chart
+     * Controls which options should be enabled for the chart personalization dialog.
+     * If it is set to `true`, all possible options for this kind of chart are enabled.
+     *
+     * If it is set to `false`, personalization is disabled.
+     *
+     *
+     *
+     * You can also provide a more granular control for the personalization by providing a comma-separated list
+     * with the options you want to be available.
+     *
+     * Available options are:
+     *
+     *  - Sort
+     *
+     *  - Type
+     *
+     *  - Item
+     *
+     *  - Filter
      */
     personalization?: boolean | string | PropertyBindingInfo | `{${string}}`;
 
     /**
-     * Specifies the selection mode
+     * Defines the selection mode to be used by the chart.
+     * Allowed values are `None`, `Single` or `Multiple`
      */
     selectionMode?: string | PropertyBindingInfo;
 
     /**
-     * This is the parameter that specifies variant management for chart
+     * Controls the kind of variant management that should be enabled for the chart.
+     * Allowed value is `Control`.
+     *
+     * If set with value `Control`, a variant management control is seen within the chart and the chart is linked
+     * to this.
+     *
+     * If not set with any value, variant management control is not available for this chart.
      */
     variantManagement?: string | PropertyBindingInfo;
 
@@ -175,6 +207,8 @@ declare module "sap/fe/macros/chart/ChartAPI" {
      */
     actions?: Action[] | Action | AggregationBindingInfo | `{${string}}`;
   }
+
+  export interface $ChartSelectionChangeEventParameters {}
 }
 
 declare module "sap/fe/macros/field/FieldAPI" {
@@ -200,7 +234,7 @@ declare module "sap/fe/macros/field/FieldAPI" {
    * <macro:Field id="MyField" metaPath="MyProperty" />
    * ```
    */
-  export default class Field extends MacroAPI {
+  class Field extends MacroAPI {
     constructor();
 
     /**
@@ -247,6 +281,8 @@ declare module "sap/fe/macros/field/FieldAPI" {
       id: string
     ): void;
   }
+  export default Field;
+
   /**
    * Additional format options for the field.
    */
@@ -350,6 +386,8 @@ declare module "sap/fe/macros/field/FieldAPI" {
      */
     semanticObject?: string | PropertyBindingInfo;
   }
+
+  export interface $FieldChangeEventParameters {}
 }
 
 declare module "sap/fe/macros/field/TextAreaEx" {
@@ -358,9 +396,10 @@ declare module "sap/fe/macros/field/TextAreaEx" {
   /**
    * Extension of the TextArea control to add a check for the maximum length when setting the value.
    */
-  export default class TextAreaEx extends TextArea {
+  class TextAreaEx extends TextArea {
     constructor();
   }
+  export default TextAreaEx;
 
   export interface $TextAreaExSettings extends $TextAreaSettings {}
 }
@@ -388,7 +427,7 @@ declare module "sap/fe/macros/filterBar/FilterBarAPI" {
    * <macro:FilterBar id="MyFilterBar" metaPath="@com.sap.vocabularies.UI.v1.SelectionFields" />
    * ```
    */
-  export default class FilterBar extends MacroAPI {
+  class FilterBar extends MacroAPI {
     constructor();
 
     /**
@@ -427,9 +466,13 @@ declare module "sap/fe/macros/filterBar/FilterBarAPI" {
     ): Promise<void>;
     /**
      * Triggers the API search on the filter bar.
+     *
+     * @returns Returns a promise which resolves if filter go is triggered successfully; otherwise gets rejected.
      */
-    triggerSearch(): Promise<void>;
+    triggerSearch(): Promise<any>;
   }
+  export default FilterBar;
+
   /**
    * Definition of a custom filter to be used inside the FilterBar.
    * The template for the FilterField has to be provided as the default aggregation
@@ -504,6 +547,12 @@ declare module "sap/fe/macros/filterBar/FilterBarAPI" {
       | AggregationBindingInfo
       | `{${string}}`;
   }
+
+  export interface $FilterBarAfterClearEventParameters {}
+
+  export interface $FilterBarFilterChangedEventParameters {}
+
+  export interface $FilterBarSearchEventParameters {}
 }
 
 declare module "sap/fe/macros/form/Form.block" {
@@ -526,9 +575,10 @@ declare module "sap/fe/macros/form/Form.block" {
    * <macro:Form id="MyForm" metaPath="@com.sap.vocabularies.UI.v1.FieldGroup#GeneralInformation" />
    * ```
    */
-  export default class Form extends Control {
+  class Form extends Control {
     constructor();
   }
+  export default Form;
 
   export interface $FormSettings extends $ControlSettings {
     /**
@@ -566,9 +616,10 @@ declare module "sap/fe/macros/form/FormElement.block" {
    *
    * Building block used to create a form element based on the metadata provided by OData V4.
    */
-  export default class FormElement extends Control {
+  class FormElement extends Control {
     constructor();
   }
+  export default FormElement;
 
   export interface $FormElementSettings extends $ControlSettings {
     /**
@@ -615,9 +666,10 @@ declare module "sap/fe/macros/microchart/MicroChart.block" {
    *
    * Building block used to create a MicroChart based on the metadata provided by OData V4.
    */
-  export default class MicroChart extends Control {
+  class MicroChart extends Control {
     constructor();
   }
+  export default MicroChart;
 
   export interface $MicroChartSettings extends $ControlSettings {}
 }
@@ -638,9 +690,10 @@ declare module "sap/fe/macros/paginator/Paginator.block" {
    * <macro:Paginator />
    * ```
    */
-  export default class Paginator extends Control {
+  class Paginator extends Control {
     constructor();
   }
+  export default Paginator;
 
   export interface $PaginatorSettings extends $ControlSettings {
     /**
@@ -678,7 +731,7 @@ declare module "sap/fe/macros/table/TableAPI" {
    * <macro:Table id="MyTable" metaPath="@com.sap.vocabularies.UI.v1.LineItem" />
    * ```
    */
-  export default class Table extends MacroAPI {
+  class Table extends MacroAPI {
     constructor();
 
     /**
@@ -727,6 +780,8 @@ declare module "sap/fe/macros/table/TableAPI" {
       id: string
     ): void;
   }
+  export default Table;
+
   /**
    * Definition of a custom action to be used inside the table toolbar
    */
@@ -806,7 +861,7 @@ declare module "sap/fe/macros/table/TableAPI" {
     /**
      * Aligns the header as well as the content horizontally
      */
-    horizontalAlign: /* was: sap.fe.core.HorizontalAlign */ any;
+    horizontalAlign: /* was: sap.fe.core.converters.ManifestSettings.HorizontalAlign */ any;
     /**
      * Defines the column importance.
      * You can define which columns should be automatically moved to the pop-in area based on their importance
@@ -931,7 +986,8 @@ declare module "sap/fe/macros/table/TableAPI" {
 
     /**
      * Defines the selection mode to be used by the table.
-     * Allowed values are `None`, `Single`, `Multi` or `Auto`
+     * Allowed values are `None`, `Single`, `Multi` or `Auto`. If not set to 'None', SAP Fiori elements hooks
+     * into the standard lifecycle to determine the consistent selection mode.
      */
     selectionMode?: string | PropertyBindingInfo;
 
@@ -962,6 +1018,10 @@ declare module "sap/fe/macros/table/TableAPI" {
      */
     columns?: Column[] | Column | AggregationBindingInfo | `{${string}}`;
   }
+
+  export interface $TableRowPressEventParameters {}
+
+  export interface $TableSelectionChangeEventParameters {}
 }
 
 declare namespace sap {

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

@@ -9,7 +9,7 @@ declare module "sap/fe/navigation/NavError" {
    * This is the successor of {@link sap.ui.generic.app.navigation.service.NavError}.
    *  An object that provides error handling information during runtime.
    */
-  export default class NavError extends BaseObject {
+  class NavError extends BaseObject {
     /**
      * Constructor requiring the error code as input.
      */
@@ -27,6 +27,7 @@ declare module "sap/fe/navigation/NavError" {
      */
     getErrorCode(): string;
   }
+  export default NavError;
 }
 
 declare module "sap/fe/navigation/NavigationHandler" {
@@ -66,10 +67,10 @@ declare module "sap/fe/navigation/NavigationHandler" {
    * If the OData metadata model has not been loaded completely, all properties are removed from the application
    * context.
    *
-   * **Note:** This class requires that the UShell {@link sap.ushell.services.CrossApplicationNavigation}
+   * **Note:** This class requires that the UShell {@link sap.ushell.services.CrossApplicationNavigation }
    * is available and initialized.
    */
-  export default class NavigationHandler extends BaseObject {
+  class NavigationHandler extends BaseObject {
     constructor();
 
     /**
@@ -126,7 +127,7 @@ declare module "sap/fe/navigation/NavigationHandler" {
       /**
        * The selection variant in string format as provided by the SmartFilterBar control
        */
-      sSelectionVariant: /* was: sap.fe.navigation.SerializedSelectionVariant */
+      sSelectionVariant: /* was: sap.fe.navigation.SelectionVariant.SerializedSelectionVariant */
         | any
         | string,
       /**
@@ -187,7 +188,7 @@ declare module "sap/fe/navigation/NavigationHandler" {
       /**
        * Object for storing current state of the app
        */
-      oInnerAppData?: /* was: sap.fe.navigation.InnerAppData */ any,
+      oInnerAppData?: /* was: sap.fe.navigation.NavigationHandler.InnerAppData */ any,
       /**
        * Callback that is called if an error occurs during navigation
        */
@@ -262,8 +263,7 @@ declare module "sap/fe/navigation/NavigationHandler" {
      *
      * 	 - `oAppData.customData`
      *
-     *          which return the inner app data as stored in {@link #.navigate navigate} or {@link #.storeInnerAppStateAsync
-     * storeInnerAppStateAsync}.
+     *          which return the inner app data as stored in {@link #.navigate navigate} or {@link #.storeInnerAppStateAsync storeInnerAppStateAsync}.
      *          `oAppData.oDefaultedSelectionVariant` is an empty selection variant and
      *          `oAppData.bNavSelVarHasDefaultsOnly` is `false` in this case.
      *
@@ -290,7 +290,7 @@ declare module "sap/fe/navigation/NavigationHandler" {
      * in the URL.
      *
      * 	 - All single selections ("including equal") of the combined selection data are passed to the SmartLink
-     * 			popover as semantic attributes.
+     *     popover as semantic attributes.
      * The method `oTableEventParameters.open()` is called. Note that this does not really open the popover,
      * but the SmartLink
      * control proceeds with firing the event `navigationTargetsObtained`.
@@ -321,7 +321,7 @@ declare module "sap/fe/navigation/NavigationHandler" {
        * Object containing the current state of the app. If provided, opening the Popover is deferred until the
        *        inner app data is saved in a consistent way.
        */
-      mInnerAppData?: /* was: sap.fe.navigation.InnerAppData */ any,
+      mInnerAppData?: /* was: sap.fe.navigation.NavigationHandler.InnerAppData */ any,
       /**
        * Object containing the state which will be passed to the target screen.
        */
@@ -383,11 +383,15 @@ declare module "sap/fe/navigation/NavigationHandler" {
       aTechnicalParameters?: any[]
     ): void;
     /**
+     * @deprecated (since 1.104) - Use the {@link sap.fe.navigation.NavigationHandler.storeInnerAppStateAsync }
+     * instead.
+     *
+     *
      * Changes the URL according to the current app state and stores the app state for later retrieval.
      *
      * @returns A Promise object to monitor when all the actions of the function have been executed; if the
      * execution is successful, the
-     *          app state key is returned; if an error occurs, an object of type {@link sap.fe.navigation.NavError}
+     *          app state key is returned; if an error occurs, an object of type {@link sap.fe.navigation.NavError }
      * is
      *          returned
      */
@@ -395,7 +399,7 @@ declare module "sap/fe/navigation/NavigationHandler" {
       /**
        * Object containing the current state of the app
        */
-      mInnerAppData: /* was: sap.fe.navigation.InnerAppData */ any,
+      mInnerAppData: /* was: sap.fe.navigation.NavigationHandler.InnerAppData */ any,
       /**
        * If set to false, the inner app hash will not be replaced until storing is successful; do not
        *        set to false if you cannot react to the resolution of the Promise, for example, when calling the
@@ -408,7 +412,7 @@ declare module "sap/fe/navigation/NavigationHandler" {
      *
      * @returns A Promise object to monitor when all the actions of the function have been executed; if the
      * execution is successful, the
-     *          app state key is returned; if an error occurs, an object of type {@link sap.fe.navigation.NavError}
+     *          app state key is returned; if an error occurs, an object of type {@link sap.fe.navigation.NavError }
      * is
      *          returned
      */
@@ -416,7 +420,7 @@ declare module "sap/fe/navigation/NavigationHandler" {
       /**
        * Object containing the current state of the app
        */
-      mInnerAppData: /* was: sap.fe.navigation.InnerAppData */ any,
+      mInnerAppData: /* was: sap.fe.navigation.NavigationHandler.InnerAppData */ any,
       /**
        * If set to false, the inner app hash will not be replaced until storing is successful; do not
        *        set to false if you cannot react to the resolution of the Promise, for example, when calling the
@@ -430,6 +434,10 @@ declare module "sap/fe/navigation/NavigationHandler" {
       bSkipHashReplace?: boolean
     ): jQuery.Promise<string>;
     /**
+     * @deprecated (since 1.104) - Use the {@link sap.fe.navigation.NavigationHandler.storeInnerAppStateAsync }
+     * instead.
+     *
+     *
      * Changes the URL according to the current app state and stores the app state for later retrieval.
      *
      * @returns An object containing the appStateId and a promise object to monitor when all the actions of
@@ -440,7 +448,7 @@ declare module "sap/fe/navigation/NavigationHandler" {
       /**
        * Object containing the current state of the app
        */
-      mInnerAppData: /* was: sap.fe.navigation.InnerAppData */ any,
+      mInnerAppData: /* was: sap.fe.navigation.NavigationHandler.InnerAppData */ any,
       /**
        * If set to false, the inner app hash will not be replaced until storing is successful; do not
        *        set to false if you cannot react to the resolution of the Promise, for example, when calling the
@@ -452,6 +460,7 @@ declare module "sap/fe/navigation/NavigationHandler" {
       bImmediateHashReplace?: boolean
     ): object;
   }
+  export default NavigationHandler;
 }
 
 declare module "sap/fe/navigation/PresentationVariant" {
@@ -465,7 +474,7 @@ declare module "sap/fe/navigation/PresentationVariant" {
    * is created whose ID has been set to `""`. Passing a JSON-serialized string complying to the Selection
    * Variant Specification will parse it, and the newly created instance will contain the same information.
    */
-  export default class PresentationVariant extends BaseObject {
+  class PresentationVariant extends BaseObject {
     /**
      * If no parameter is passed, a new empty instance is created whose ID has been set to `""`.
      * Passing a JSON-serialized string complying to the Selection Variant Specification will parse it,
@@ -484,7 +493,7 @@ declare module "sap/fe/navigation/PresentationVariant" {
      *
      * @returns An object containing the properties to be used for the chart visualization.
      */
-    getChartVisualization(): /* was: sap.fe.navigation.Visualization */
+    getChartVisualization(): /* was: sap.fe.navigation.PresentationVariant.Visualization */
       | any
       | undefined;
     /**
@@ -510,7 +519,7 @@ declare module "sap/fe/navigation/PresentationVariant" {
      *
      * @returns An object containing the properties to be used for the table visualization.
      */
-    getTableVisualization(): /* was: sap.fe.navigation.Visualization */
+    getTableVisualization(): /* was: sap.fe.navigation.PresentationVariant.Visualization */
       | any
       | undefined;
     /**
@@ -533,7 +542,7 @@ declare module "sap/fe/navigation/PresentationVariant" {
       /**
        * An object containing the properties to be used for the chart visualization.
        */
-      properties: /* was: sap.fe.navigation.Visualization */ any
+      properties: /* was: sap.fe.navigation.PresentationVariant.Visualization */ any
     ): void;
     /**
      * Sets the context URL.
@@ -569,7 +578,7 @@ declare module "sap/fe/navigation/PresentationVariant" {
       /**
        * An object containing the properties to be used for the table visualization.
        */
-      properties: /* was: sap.fe.navigation.Visualization */ any
+      properties: /* was: sap.fe.navigation.PresentationVariant.Visualization */ any
     ): void;
     /**
      * Sets the text / description of the selection variant.
@@ -585,7 +594,7 @@ declare module "sap/fe/navigation/PresentationVariant" {
      *
      * @returns The external representation of this instance as a JSON object
      */
-    toJSONObject(): /* was: sap.fe.navigation.ExternalPresentationVariant */ any;
+    toJSONObject(): /* was: sap.fe.navigation.PresentationVariant.ExternalPresentationVariant */ any;
     /**
      * Serializes this instance into a JSON-formatted string.
      *
@@ -593,6 +602,7 @@ declare module "sap/fe/navigation/PresentationVariant" {
      */
     toJSONString(): string;
   }
+  export default PresentationVariant;
 }
 
 declare module "sap/fe/navigation/SelectionVariant" {
@@ -601,7 +611,7 @@ declare module "sap/fe/navigation/SelectionVariant" {
   /**
    * @SINCE 1.83.0
    */
-  export default class SelectionVariant extends BaseObject {
+  class SelectionVariant extends BaseObject {
     constructor();
 
     /**
@@ -619,7 +629,7 @@ declare module "sap/fe/navigation/SelectionVariant" {
        * The value of the parameter to be set
        */
       sValue: string
-    ): SelectionVariant;
+    ): this;
     /**
      * Adds a new range to the list of select options for a given parameter.
      *
@@ -648,7 +658,7 @@ declare module "sap/fe/navigation/SelectionVariant" {
       /**
        * Set only if sOption is **BT**: the upper boundary of the interval;
        */
-      sHigh?: string,
+      sHigh?: null | string,
       /**
        * Text representing the SelectOption. This is an optional parameter. For an example in most Fiori applications
        * if the text is not provided, it is fetched based on the ID.
@@ -658,8 +668,8 @@ declare module "sap/fe/navigation/SelectionVariant" {
       /**
        * Object containing semanticDates filter information
        */
-      semanticDates?: /* was: sap.fe.navigation.SemanticDateConfiguration */ any
-    ): SelectionVariant;
+      semanticDates?: /* was: sap.fe.navigation.SelectionVariant.SemanticDateConfiguration */ any
+    ): this;
     /**
      * Gets the current context URL intended for the filters.
      *
@@ -792,7 +802,7 @@ declare module "sap/fe/navigation/SelectionVariant" {
        * Set of select options to be added
        */
       aSelectOptions: undefined[]
-    ): SelectionVariant;
+    ): this;
     /**
      * Removes a parameter called `sName` from the selection variant.
      *
@@ -803,7 +813,7 @@ declare module "sap/fe/navigation/SelectionVariant" {
        * The name of the parameter to be removed
        */
       sName: string
-    ): SelectionVariant;
+    ): this;
     /**
      * Removes a select option called `sName` from the selection variant.
      *
@@ -814,7 +824,7 @@ declare module "sap/fe/navigation/SelectionVariant" {
        * The name of the select option to be removed
        */
       sName: string
-    ): SelectionVariant;
+    ): this;
     /**
      * Renames a parameter called `sNameOld` to `sNameNew`. If a parameter or a select option with
      * the name `sNameNew` already exist, an error is thrown. If a parameter with the name `sNameOld`
@@ -831,7 +841,7 @@ declare module "sap/fe/navigation/SelectionVariant" {
        * The new name of the parameter
        */
       sNameNew: string
-    ): SelectionVariant;
+    ): this;
     /**
      * Renames a select option called `sNameOld` to `sNameNew`. If a select option or a parameter
      * with the name `sNameNew` already exist, an error is thrown. If a select option with the name `sNameOld`
@@ -848,7 +858,7 @@ declare module "sap/fe/navigation/SelectionVariant" {
        * The new name of the select option property
        */
       sNameNew: string
-    ): SelectionVariant;
+    ): this;
     /**
      * Sets the context URL intended for the filters.
      */
@@ -890,7 +900,7 @@ declare module "sap/fe/navigation/SelectionVariant" {
      *
      * @returns The external representation of this instance as a JSON object
      */
-    toJSONObject(): /* was: sap.fe.navigation.SerializedSelectionVariant */ any;
+    toJSONObject(): /* was: sap.fe.navigation.SelectionVariant.SerializedSelectionVariant */ any;
     /**
      * Serializes this instance into a JSON-formatted string.
      *
@@ -898,6 +908,7 @@ declare module "sap/fe/navigation/SelectionVariant" {
      */
     toJSONString(): string;
   }
+  export default SelectionVariant;
 }
 
 declare module "sap/fe/navigation/library" {}