@sapui5/ts-types 1.123.1 → 1.124.0

package/types/sap.makit.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.123.0
+// For Library Version: 1.124.0
 
 declare namespace sap {
   /**

package/types/sap.me.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.123.0
+// For Library Version: 1.124.0
 
 declare namespace sap {
   /**

package/types/sap.ndc.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.123.0
+// For Library Version: 1.124.0
 
 declare namespace sap {
   /**

package/types/sap.ovp.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.123.0
+// For Library Version: 1.124.0
 
 declare namespace sap {
   /**

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.123.0
+// For Library Version: 1.124.0
 
 declare namespace sap {
   namespace rules {

package/types/sap.sac.df.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.123.1
+// For Library Version: 1.124.0
 
 declare namespace sap {
   namespace sac {
@@ -87,6 +87,16 @@ declare namespace sap {
       }
 
       namespace model {
+        /**
+         * Parameters of the DataProvider#dataUpdated event.
+         */
+        interface DataProvider$DataUpdatedEventParameters {}
+
+        /**
+         * Parameters of the MultiDimModel#dataLoaded event.
+         */
+        interface MultiDimModel$DataLoadedEventParameters {}
+
         /**
          * Parameters of the MultiDimModel#dataProviderAdded event.
          */
@@ -107,6 +117,11 @@ declare namespace sap {
          */
         interface MultiDimModel$LoadedEventParameters {}
 
+        /**
+         * Parameters of the MultiDimModel#variableGroupsAdded event.
+         */
+        interface MultiDimModel$VariableGroupsAddedEventParameters {}
+
         /**
          * Axis Layout showing which dimensions are set on rows and which on columns.
          *
@@ -196,17 +211,23 @@ declare namespace sap {
          *  },
          * "Grid": { },
          * "Messages": [ ]
+         * "AutoFetchEnabled": ""
          * ```
          *
          *
          * @since 1.119
          * @experimental (since 1.119)
          */
-        class DataProvider extends sap.ui.base.Object {
+        class DataProvider extends sap.ui.model.json.JSONModel {
           /**
            * @ui5-protected Do not call from applications (only from related classes in the framework)
            */
           protected constructor();
+          /**
+           * Indicator if the result set should be fetched automatically. The default value is true.
+           */
+          AutoFetchEnabled: boolean;
+
           /**
            * AxesLayout
            */
@@ -241,7 +262,7 @@ declare namespace sap {
            * Creates a new subclass of class sap.sac.df.model.DataProvider with name `sClassName` and enriches it
            * with the information contained in `oClassInfo`.
            *
-           * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
+           * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.json.JSONModel.extend}.
            *
            *
            * @returns Created class / constructor function
@@ -297,6 +318,22 @@ declare namespace sap {
              */
             oDataExportConfig: object
           ): void;
+          /**
+           * Fires event {@link #event:dataUpdated dataUpdated} to attached listeners.
+           *
+           *
+           * @returns Reference to this in order to allow method chaining
+           */
+          fireDataUpdated(
+            /**
+             * Parameters to pass along with the event
+             */
+            oParameters?: object
+          ): this;
+          /**
+           * Get the property AutoFetchEnabled
+           */
+          getAutoFetchEnabled(): boolean;
           /**
            * Get axis Layout
            *
@@ -380,14 +417,19 @@ declare namespace sap {
            */
           getMeasureStructureDimension(): sap.sac.df.model.Dimension;
           /**
-           * Get result set
+           * Trigger data update
+           *
+           * @deprecated (since 1.124) - Replaced by {@link sap.sac.df.model.DataProvider#setAutoFetchEnabled setAutoFetchEnabled }
+           * API to refresh the data.
+           *
+           * @returns Promise with reference to this in order to allow method chaining
            */
           getResultSet(
             /**
              * Enforce result set update
              */
-            bEnforceResultSetUpdate?: boolean
-          ): void;
+            bEnforceDataUpdate?: boolean
+          ): Promise<this>;
           /**
            * Get the scaling factor of a measure or cell
            *
@@ -442,6 +484,10 @@ declare namespace sap {
              */
             sFormat?: string
           ): object;
+          /**
+           * Set the property `AutoFetchEnabled`, if the data should be automatically be refreshed on invalid.
+           */
+          setAutoFetchEnabled(bAutoFetchEnabled: boolean): void;
           /**
            * Set the number of decimal places of a measure or cell
            *
@@ -951,6 +997,22 @@ declare namespace sap {
            * @returns Metadata object describing this class
            */
           static getMetadata(): sap.ui.base.Metadata;
+          /**
+           * Create and retrieve document in the document store
+           *
+           *
+           * @returns a promise which resolves with the newly created document.
+           */
+          createAndRetrieveDocument(
+            /**
+             * the document ID
+             */
+            sDocumentId: undefined,
+            /**
+             * the content of the document
+             */
+            sContent: undefined
+          ): Promise<object>;
           /**
            * Create a document in the document store
            *
@@ -1063,12 +1125,26 @@ declare namespace sap {
             aDocumentIds: undefined
           ): Promise<object>;
           /**
-           * Is document storage supporting Read / Write access
+           * Is document storage supporting delete access
+           *
+           *
+           * @returns if delete access is supported
+           */
+          supportsDelete(): boolean;
+          /**
+           * Is document storage supporting read access
            *
            *
-           * @returns if Read / Write access is supported
+           * @returns if read access is supported
            */
-          supportsReadWrite(): boolean;
+          supportsRead(): boolean;
+          /**
+           * Is document storage supporting write (create and change) access
+           *
+           *
+           * @returns if write (create and change) access is supported
+           */
+          supportsWrite(): boolean;
           /**
            * Update a document in the document store
            *
@@ -1272,7 +1348,11 @@ declare namespace sap {
             /**
              * Data source type
              */
-            sDataSourceType?: sap.sac.df.types.DataSourceType
+            sDataSourceType?: sap.sac.df.types.DataSourceType,
+            /**
+             * if the data should be fetched automatically
+             */
+            bAutoFetchEnabled?: boolean
           ): Promise<sap.sac.df.model.DataProvider>;
           /**
            * Creates a new variable group and attaches it to the model.
@@ -1280,6 +1360,8 @@ declare namespace sap {
            * A variable group defines which variables of the underlying data providers should behave as the same variable.
            * The group is defined by a name and a rule. The first added variable becomes automatically the `MergedVariable`.
            *
+           * @deprecated (since 1.124) - Replaced by {@link sap.sac.df.model.MultiDimModel#setVariableGroups setAutoFetchEnabled }
+           * API to set the variables.
            *
            * @returns Promise which resolves the created variable group
            */
@@ -1304,6 +1386,8 @@ declare namespace sap {
            * A variable group defines which variables of the underlying data providers should behave as the same variable.
            * The group is defined by a name and a rule. The first added variable becomes automatically the `MergedVariable`.
            *
+           * @deprecated (since 1.124) - Replaced by {@link sap.sac.df.model.MultiDimModel#setVariableGroups setAutoFetchEnabled }
+           * API to set the variables.
            *
            * @returns created variable group
            */
@@ -1453,6 +1537,8 @@ declare namespace sap {
           /**
            * Remove a variable group from the model
            *
+           * @deprecated (since 1.124) - Replaced by {@link sap.sac.df.model.MultiDimModel#setVariableGroups setAutoFetchEnabled }
+           * API to set the variables.
            *
            * @returns Promise which resolves when the removing s finished
            */
@@ -1955,6 +2041,22 @@ declare namespace sap {
           ): this;
         }
 
+        /**
+         * Event object of the DataProvider#dataUpdated event.
+         */
+        type DataProvider$DataUpdatedEvent = sap.ui.base.Event<
+          DataProvider$DataUpdatedEventParameters,
+          DataProvider
+        >;
+
+        /**
+         * Event object of the MultiDimModel#dataLoaded event.
+         */
+        type MultiDimModel$DataLoadedEvent = sap.ui.base.Event<
+          MultiDimModel$DataLoadedEventParameters,
+          MultiDimModel
+        >;
+
         /**
          * Event object of the MultiDimModel#dataProviderAdded event.
          */
@@ -1986,6 +2088,14 @@ declare namespace sap {
           MultiDimModel$LoadedEventParameters,
           MultiDimModel
         >;
+
+        /**
+         * Event object of the MultiDimModel#variableGroupsAdded event.
+         */
+        type MultiDimModel$VariableGroupsAddedEvent = sap.ui.base.Event<
+          MultiDimModel$VariableGroupsAddedEventParameters,
+          MultiDimModel
+        >;
       }
 
       namespace types {
@@ -2027,7 +2137,7 @@ declare namespace sap {
            */
           Read = "READ",
           /**
-           * Read, create, change documents support
+           * Read, create, change documents support.
            */
           ReadCreateChange = "READ_CREATE_CHANGE",
           /**
@@ -2072,10 +2182,9 @@ declare namespace sap {
       /**
        * Describes the settings that can be provided to the FilterField constructor.
        *
-       * @experimental (since 1.48.0)
+       * @experimental (since 1.121)
        */
-      interface $FilterFieldSettings
-        extends sap.ui.mdc.field.$FieldBaseSettings {
+      interface $FilterFieldSettings extends sap.ui.mdc.$FilterFieldSettings {
         /**
          * Defines the relative path of the property in the metamodel, based on the current contextPath.
          */
@@ -2111,6 +2220,9 @@ declare namespace sap {
 
         /**
          * Indicates if Flexible Analysis component automatically requests the ResultSet for the shown data source
+         *
+         * @deprecated (since 1.124) - the concept has been discarded. Refreshing the data is handled by the data
+         * provider.
          */
         autoUpdate?:
           | boolean
@@ -2133,7 +2245,7 @@ declare namespace sap {
           | `{${string}}`;
 
         /**
-         * configuration Id
+         * Configuration Id
          */
         configId?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
@@ -2217,26 +2329,24 @@ declare namespace sap {
           | sap.ui.base.ManagedObject.PropertyBindingInfo
           | `{${string}}`;
 
-        /**
-         * Additional Flag to be passed to the control TODO: Document the possibilities
-         */
-        environment?:
-          | string[]
-          | sap.ui.base.ManagedObject.PropertyBindingInfo
-          | `{${string}}`;
-
         /**
          * System to take data from. If not set or set to "local" current url will be used to determine the system
+         *
+         * @deprecated (since 1.124) - Replaced by metaPath property and the corresponding data provider definition.
          */
         systemName?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
         /**
          * Data source (Query name/ View, InA model etc) to be used to get the data from
+         *
+         * @deprecated (since 1.124) - Replaced by metaPath property and the corresponding data provider definition.
          */
         dataSource?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
         /**
          * Type the system to connect to get data
+         *
+         * @deprecated (since 1.124) - Replaced by metaPath property and the corresponding data provider definition.
          */
         systemType?:
           | sap.sac.df.types.SystemType
@@ -2253,6 +2363,8 @@ declare namespace sap {
 
         /**
          * Client Identifier to be used for underlying InA queries
+         *
+         * @deprecated (since 1.124) - Replaced by metaPath property and the corresponding data provider definition.
          */
         clientIdentifier?:
           | string
@@ -2260,6 +2372,8 @@ declare namespace sap {
 
         /**
          * Name of the Data Provider from the corresponding MultiDimModel to be used
+         *
+         * @deprecated (since 1.124) - Replaced by metaPath property and the corresponding data provider definition.
          */
         dataProvider?:
           | any
@@ -2268,11 +2382,18 @@ declare namespace sap {
 
         /**
          * Id of the MultiDimModel to use
+         *
+         * @deprecated (since 1.124) - Replaced by metaPath property and the corresponding data provider definition.
          */
         multiDimModelId?:
           | string
           | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
+        /**
+         * Defines the relative path to the data provider in the multidimensional model.
+         */
+        metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
+
         /**
          * Indicates if the variable are handled internal handling by FlexAnalysis. If set to false it is done via
          * corresponding MultiDimModel
@@ -2416,40 +2537,18 @@ declare namespace sap {
       }
       /**
        * The `FilterField` control is used to filter data based on the conditions. The conditions are managed
-       * in the corresponding {@link sap.ui.mdc.condition.ConditionModel ConditionModel}. That is why the `conditions`
-       * property must be bound to the related conditions in the {@link sap.ui.mdc.condition.ConditionModel ConditionModel}.
-       * The type of this data must be defined in the `dataType` property.
+       * in the corresponding {@link sap.ui.mdc.condition.ConditionModel ConditionModel}.
        *
-       * Based on the data type settings, a default control is rendered by the `FilterField` as follows:
-       *
-       *
-       * 	 - In display mode, usually a {@link sap.m.Text Text} control is rendered.
-       * 	 - If `multipleLines` is set, an {@link sap.m.ExpandableText ExpandableText} control is rendered.
-       * 	 - If multiple values are allowed, a {@link sap.m.Tokenizer Tokenizer} control is rendered.
-       * 	 - In edit mode, usually an {@link sap.m.Input Input} control is rendered.
-       * 	 - If multiple values are allowed, a {@link sap.m.MultiInput MultiInput} control is rendered.
-       * 	 - If `multipleLines` is set, a {@link sap.m.TextArea TextArea} control is rendered.
-       * 	 - If a date type or a date/time type is used, a {@link sap.m.DateRangeSelection DateRangeSelection }
-       *     control is rendered.
-       * 	 - If a date type is used and only single values are allowed, a {@link sap.m.DatePicker DatePicker }
-       *     control is rendered.
-       * 	 - If a date type is used and only single ranges are allowed, a {@link sap.m.DateRangeSelection DateRangeSelection }
-       *     control is rendered.
-       * 	 - If a date/time type is used and only single values are allowed, a {@link sap.m.DateTimePicker DateTimePicker }
-       *     control is rendered.
-       * 	 - If a time type is used and only single values are allowed, a {@link sap.m.TimePicker TimePicker }
-       *     control is rendered.
-       * 	 - If used for search, a {@link sap.m.SearchField SearchField} control is rendered.
-       *
-       * @since 1.48.0
-       * @experimental (since 1.48.0)
+       * @since 1.121
+       * @experimental (since 1.121)
        */
       class FilterField
-        extends sap.ui.mdc.field.FieldBase
+        extends sap.ui.mdc.FilterField
         implements
           sap.ui.core.IFormContent,
           sap.ui.core.ISemanticFormContent,
-          sap.m.IOverflowToolbarContent {
+          sap.m.IOverflowToolbarContent
+      {
         __implements__sap_ui_core_IFormContent: boolean;
         __implements__sap_ui_core_ISemanticFormContent: boolean;
         __implements__sap_m_IOverflowToolbarContent: boolean;
@@ -2679,6 +2778,7 @@ declare namespace sap {
          * See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a detailed description
          * of the possible properties of `oBindingInfo`
          *
+         * @deprecated (since 1.124) - Replaced by metaPath property and the corresponding data provider definition.
          *
          * @returns Reference to `this` in order to allow method chaining
          */
@@ -2733,6 +2833,8 @@ declare namespace sap {
          *
          * Default value is `true`.
          *
+         * @deprecated (since 1.124) - the concept has been discarded. Refreshing the data is handled by the data
+         * provider.
          *
          * @returns Value of property `autoUpdate`
          */
@@ -2742,6 +2844,7 @@ declare namespace sap {
          *
          * Client Identifier to be used for underlying InA queries
          *
+         * @deprecated (since 1.124) - Replaced by metaPath property and the corresponding data provider definition.
          *
          * @returns Value of property `clientIdentifier`
          */
@@ -2749,7 +2852,7 @@ declare namespace sap {
         /**
          * Gets current value of property {@link #getConfigId configId}.
          *
-         * configuration Id
+         * Configuration Id
          *
          *
          * @returns Value of property `configId`
@@ -2784,6 +2887,7 @@ declare namespace sap {
          *
          * Name of the Data Provider from the corresponding MultiDimModel to be used
          *
+         * @deprecated (since 1.124) - Replaced by metaPath property and the corresponding data provider definition.
          *
          * @returns Value of property `dataProvider`
          */
@@ -2795,21 +2899,11 @@ declare namespace sap {
          *
          * Default value is `"$datasource"`.
          *
+         * @deprecated (since 1.124) - Replaced by metaPath property and the corresponding data provider definition.
          *
          * @returns Value of property `dataSource`
          */
         getDataSource(): string;
-        /**
-         * Gets current value of property {@link #getEnvironment environment}.
-         *
-         * Additional Flag to be passed to the control TODO: Document the possibilities
-         *
-         * Default value is `[]`.
-         *
-         *
-         * @returns Value of property `environment`
-         */
-        getEnvironment(): string[];
         /**
          * Gets current value of property {@link #getHeight height}.
          *
@@ -2932,6 +3026,15 @@ declare namespace sap {
          * @returns Value of property `keepAliveInterval`
          */
         getKeepAliveInterval(): int;
+        /**
+         * Gets current value of property {@link #getMetaPath metaPath}.
+         *
+         * Defines the relative path to the data provider in the multidimensional model.
+         *
+         *
+         * @returns Value of property `metaPath`
+         */
+        getMetaPath(): string;
         /**
          * Gets current value of property {@link #getMultiDimModelId multiDimModelId}.
          *
@@ -2939,6 +3042,7 @@ declare namespace sap {
          *
          * Default value is `"om"`.
          *
+         * @deprecated (since 1.124) - Replaced by metaPath property and the corresponding data provider definition.
          *
          * @returns Value of property `multiDimModelId`
          */
@@ -2969,6 +3073,7 @@ declare namespace sap {
          *
          * System to take data from. If not set or set to "local" current url will be used to determine the system
          *
+         * @deprecated (since 1.124) - Replaced by metaPath property and the corresponding data provider definition.
          *
          * @returns Value of property `systemName`
          */
@@ -2980,6 +3085,7 @@ declare namespace sap {
          *
          * Default value is `BW`.
          *
+         * @deprecated (since 1.124) - Replaced by metaPath property and the corresponding data provider definition.
          *
          * @returns Value of property `systemType`
          */
@@ -3065,6 +3171,8 @@ declare namespace sap {
          *
          * Default value is `true`.
          *
+         * @deprecated (since 1.124) - the concept has been discarded. Refreshing the data is handled by the data
+         * provider.
          *
          * @returns Reference to `this` in order to allow method chaining
          */
@@ -3081,6 +3189,7 @@ declare namespace sap {
          *
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
+         * @deprecated (since 1.124) - Replaced by metaPath property and the corresponding data provider definition.
          *
          * @returns Reference to `this` in order to allow method chaining
          */
@@ -3093,7 +3202,7 @@ declare namespace sap {
         /**
          * Sets a new value for property {@link #getConfigId configId}.
          *
-         * configuration Id
+         * Configuration Id
          *
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
@@ -3145,6 +3254,7 @@ declare namespace sap {
          *
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
+         * @deprecated (since 1.124) - Replaced by metaPath property and the corresponding data provider definition.
          *
          * @returns Reference to `this` in order to allow method chaining
          */
@@ -3163,6 +3273,7 @@ declare namespace sap {
          *
          * Default value is `"$datasource"`.
          *
+         * @deprecated (since 1.124) - Replaced by metaPath property and the corresponding data provider definition.
          *
          * @returns Reference to `this` in order to allow method chaining
          */
@@ -3172,24 +3283,6 @@ declare namespace sap {
            */
           sDataSource?: string
         ): this;
-        /**
-         * Sets a new value for property {@link #getEnvironment environment}.
-         *
-         * Additional Flag to be passed to the control TODO: Document the possibilities
-         *
-         * When called with a value of `null` or `undefined`, the default value of the property will be restored.
-         *
-         * Default value is `[]`.
-         *
-         *
-         * @returns Reference to `this` in order to allow method chaining
-         */
-        setEnvironment(
-          /**
-           * New value for property `environment`
-           */
-          sEnvironment?: string[]
-        ): this;
         /**
          * Sets a new value for property {@link #getHeight height}.
          *
@@ -3389,6 +3482,22 @@ declare namespace sap {
            */
           iKeepAliveInterval?: int
         ): this;
+        /**
+         * Sets a new value for property {@link #getMetaPath metaPath}.
+         *
+         * Defines the relative path to the data provider in the multidimensional model.
+         *
+         * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+         *
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        setMetaPath(
+          /**
+           * New value for property `metaPath`
+           */
+          sMetaPath: string
+        ): this;
         /**
          * Sets a new value for property {@link #getMultiDimModelId multiDimModelId}.
          *
@@ -3398,6 +3507,7 @@ declare namespace sap {
          *
          * Default value is `"om"`.
          *
+         * @deprecated (since 1.124) - Replaced by metaPath property and the corresponding data provider definition.
          *
          * @returns Reference to `this` in order to allow method chaining
          */
@@ -3449,6 +3559,7 @@ declare namespace sap {
          *
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
+         * @deprecated (since 1.124) - Replaced by metaPath property and the corresponding data provider definition.
          *
          * @returns Reference to `this` in order to allow method chaining
          */
@@ -3467,6 +3578,7 @@ declare namespace sap {
          *
          * Default value is `BW`.
          *
+         * @deprecated (since 1.124) - Replaced by metaPath property and the corresponding data provider definition.
          *
          * @returns Reference to `this` in order to allow method chaining
          */
@@ -3513,6 +3625,7 @@ declare namespace sap {
         /**
          * Unbinds property {@link #getDataProvider dataProvider} from model data.
          *
+         * @deprecated (since 1.124) - Replaced by metaPath property and the corresponding data provider definition.
          *
          * @returns Reference to `this` in order to allow method chaining
          */