@sapui5/ts-types-esm 1.146.0 → 1.147.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (69) hide show
  1. package/package.json +1 -1
  2. package/types/{sap.ui.commons.d.ts → commons-1.147.0-esm-d.ts} +1 -1
  3. package/types/{sap.ui.core.d.ts → core-1.147.0-esm-d.ts} +172 -16
  4. package/types/{sap.ui.dt.d.ts → dt-1.147.0-esm-d.ts} +1 -1
  5. package/types/index.d.ts +7 -10
  6. package/types/{sap.ui.mdc.d.ts → mdc-1.147.0-esm-d.ts} +112 -21
  7. package/types/{sap.m.d.ts → mobile-1.147.0-esm-d.ts} +371 -127
  8. package/types/sap.apf.d.ts +1 -1
  9. package/types/sap.ca.ui.d.ts +1 -1
  10. package/types/sap.chart.d.ts +4 -7
  11. package/types/sap.collaboration.d.ts +1 -1
  12. package/types/sap.esh.search.ui.d.ts +1 -52
  13. package/types/sap.f.d.ts +148 -2
  14. package/types/sap.fe.ariba.d.ts +1 -1
  15. package/types/sap.fe.controls.d.ts +1 -1
  16. package/types/sap.fe.core.d.ts +1 -1
  17. package/types/sap.fe.ina.d.ts +1 -1
  18. package/types/sap.fe.macros.d.ts +3892 -3211
  19. package/types/sap.fe.navigation.d.ts +1 -1
  20. package/types/sap.fe.placeholder.d.ts +1 -1
  21. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  22. package/types/sap.fe.templates.d.ts +1 -1
  23. package/types/sap.fe.test.d.ts +49 -1
  24. package/types/sap.fe.tools.d.ts +1 -1
  25. package/types/sap.feedback.ui.d.ts +1 -1
  26. package/types/sap.gantt.d.ts +184 -1
  27. package/types/sap.insights.d.ts +14 -1
  28. package/types/sap.makit.d.ts +1 -1
  29. package/types/sap.me.d.ts +1 -1
  30. package/types/sap.ndc.d.ts +1 -1
  31. package/types/sap.ovp.d.ts +1 -1
  32. package/types/sap.rules.ui.d.ts +1 -1
  33. package/types/sap.sac.df.d.ts +1 -1
  34. package/types/sap.suite.ui.commons.d.ts +122 -1
  35. package/types/sap.suite.ui.generic.template.d.ts +79 -1
  36. package/types/sap.suite.ui.microchart.d.ts +1 -1
  37. package/types/sap.ui.codeeditor.d.ts +82 -46
  38. package/types/sap.ui.comp.d.ts +5 -15
  39. package/types/sap.ui.export.d.ts +1 -1
  40. package/types/sap.ui.fl.d.ts +5 -1
  41. package/types/sap.ui.generic.app.d.ts +5 -5
  42. package/types/sap.ui.generic.template.d.ts +1 -1
  43. package/types/sap.ui.geomap.d.ts +1 -1
  44. package/types/sap.ui.integration.d.ts +23 -25
  45. package/types/sap.ui.layout.d.ts +1 -1
  46. package/types/sap.ui.richtexteditor.d.ts +1 -1
  47. package/types/sap.ui.rta.d.ts +1 -1
  48. package/types/sap.ui.suite.d.ts +1 -1
  49. package/types/sap.ui.support.d.ts +2 -2
  50. package/types/sap.ui.table.d.ts +1 -1
  51. package/types/sap.ui.testrecorder.d.ts +1 -1
  52. package/types/sap.ui.unified.d.ts +6 -9
  53. package/types/sap.ui.vbm.d.ts +8 -24
  54. package/types/sap.ui.vk.d.ts +1 -1
  55. package/types/sap.ui.vtm.d.ts +1 -1
  56. package/types/sap.uiext.inbox.d.ts +1 -1
  57. package/types/sap.ushell.d.ts +416 -67
  58. package/types/sap.ushell_abap.d.ts +1 -1
  59. package/types/sap.uxap.d.ts +151 -2
  60. package/types/sap.viz.d.ts +4 -5
  61. package/types/sap.webanalytics.core.d.ts +1 -1
  62. package/types/sap.zen.commons.d.ts +1 -1
  63. package/types/sap.zen.crosstab.d.ts +1 -1
  64. package/types/sap.zen.dsh.d.ts +1 -1
  65. package/types/{sap.tnt.d.ts → tnt-1.147.0-esm-d.ts} +1 -4
  66. package/types/{sap.ui.ux3.d.ts → ux3-1.147.0-esm-d.ts} +1 -1
  67. package/types/sap.ui.webc.common.d.ts +0 -164
  68. package/types/sap.ui.webc.fiori.d.ts +0 -16235
  69. package/types/sap.ui.webc.main.d.ts +0 -51365
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sapui5/ts-types-esm",
3
- "version": "1.146.0",
3
+ "version": "1.147.1",
4
4
  "description": "SAPUI5 TypeScript Definitions - ES Modules",
5
5
  "homepage": "https://ui5.sap.com",
6
6
  "author": "SAP SE (https://www.sap.com)",
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.146.0
1
+ // For Library Version: 1.147.0
2
2
 
3
3
  declare module "sap/ui/commons/library" {
4
4
  import { ColorPickerMode as ColorPickerMode1 } from "sap/ui/unified/library";
@@ -279,7 +279,7 @@ declare namespace sap {
279
279
  "sap/ui/thirdparty/qunit-2": undefined;
280
280
  }
281
281
  }
282
- // For Library Version: 1.146.0
282
+ // For Library Version: 1.147.0
283
283
 
284
284
  declare module "sap/base/assert" {
285
285
  /**
@@ -7745,9 +7745,9 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
7745
7745
  * has been resolved!
7746
7746
  *
7747
7747
  *
7748
- * @returns The meta model for this `ODataModel`
7748
+ * @returns The meta model for this `ODataModel`, or `undefined` if the model has been destroyed
7749
7749
  */
7750
- getMetaModel(): ODataMetaModel;
7750
+ getMetaModel(): ODataMetaModel | undefined;
7751
7751
  /**
7752
7752
  * Returns a JSON object that is a copy of the entity data referenced by the given `sPath` and `oContext`.
7753
7753
  * It does not load any data and may not return all requested data if it is not available.
@@ -17444,7 +17444,6 @@ declare module "sap/ui/core/library" {
17444
17444
  /**
17445
17445
  * Implementing this interface allows a control to be accessible via access keys.
17446
17446
  *
17447
- * @since 1.104
17448
17447
  * @experimental As of version 1.104.
17449
17448
  */
17450
17449
  export interface IAccessKeySupport {
@@ -17454,21 +17453,18 @@ declare module "sap/ui/core/library" {
17454
17453
  * Returns a refence to DOM element to be focused during Access key navigation. If not implemented getFocusDomRef()
17455
17454
  * method is used.
17456
17455
  *
17457
- * @since 1.104
17458
17456
  * @experimental As of version 1.104.
17459
17457
  */
17460
17458
  getAccessKeysFocusTarget?(): void;
17461
17459
  /**
17462
17460
  * If implemented called when access keys feature is enabled and highlighting is over
17463
17461
  *
17464
- * @since 1.104
17465
17462
  * @experimental As of version 1.104.
17466
17463
  */
17467
17464
  onAccKeysHighlightEnd?(): void;
17468
17465
  /**
17469
17466
  * If implemented called when access keys feature is enabled and highlighting is ongoing
17470
17467
  *
17471
- * @since 1.104
17472
17468
  * @experimental As of version 1.104.
17473
17469
  */
17474
17470
  onAccKeysHighlightStart?(): void;
@@ -42242,6 +42238,59 @@ declare module "sap/ui/core/RenderManager" {
42242
42238
  */
42243
42239
  oTargetDomNode: Element
42244
42240
  ): void;
42241
+ /**
42242
+ * Executes a rendering callback and flushes the result into the provided DOM node.
42243
+ *
42244
+ * The rendering callback receives a RenderManager instance with the semantic rendering API implementation
42245
+ * (DOM interface methods like `openStart`, `attr`, `openEnd`, `text`, `close`, etc.).
42246
+ *
42247
+ * This method combines rendering and flushing in a single call, automatically handling non-HTML namespaces
42248
+ * (e.g., SVG, MathML) by detecting the namespace of the target DOM node.
42249
+ *
42250
+ * **Difference from calling render() then flush() separately:** When rendering into a non-HTML namespace
42251
+ * context (e.g., SVG or MathML elements), this method automatically detects the target node's namespace
42252
+ * and applies it as a fallback namespace for the rendering operation. This ensures that elements created
42253
+ * without an explicit parent element (such as when rendering into a DocumentFragment initially) inherit
42254
+ * the correct namespace.
42255
+ *
42256
+ * This function must not be called within control renderers.
42257
+ *
42258
+ * Usage:
42259
+ * ```javascript
42260
+ *
42261
+ * const oRM = new RenderManager().getInterface();
42262
+ *
42263
+ * // assume that oSvgContainer is already part of the DOM and we want to render a circle into it
42264
+ * oRM.renderAndFlush(function(oRM) {
42265
+ * oRM.openStart("circle").attr("cx", "50").attr("cy", "50").attr("r", "40");
42266
+ * oRM.openEnd();
42267
+ * oRM.close("circle");
42268
+ * }, oSvgContainer);
42269
+ *
42270
+ * oRM.destroy();
42271
+ * ```
42272
+ *
42273
+ *
42274
+ * @since 1.147
42275
+ *
42276
+ * @returns Reference to `this` to allow method chaining
42277
+ */
42278
+ renderAndFlush(
42279
+ /**
42280
+ * Rendering callback that receives a RenderManager instance with the semantic rendering API implementation
42281
+ * (DOM interface methods like `openStart`, `attr`, `openEnd`, `text`, `close`, etc.)
42282
+ */
42283
+ fnRender: (p1: RenderManager) => void,
42284
+ /**
42285
+ * Node in the DOM where the result should be flushed into
42286
+ */
42287
+ oTargetDomNode: Element,
42288
+ /**
42289
+ * Determines whether the buffer of the target DOM node is expanded (`true`) or replaced (`false`), or the
42290
+ * new entry is inserted at a specific position (value of type `int`)
42291
+ */
42292
+ vInsert?: boolean | int
42293
+ ): this;
42245
42294
  /**
42246
42295
  * Turns the given control into its HTML representation and appends it to the rendering buffer.
42247
42296
  *
@@ -53254,6 +53303,9 @@ declare module "sap/ui/core/ws/SapPcpWebSocket" {
53254
53303
  * 'SUPPORTED_PROTOCOLS'.
53255
53304
  */
53256
53305
  enum SUPPORTED_PROTOCOLS {
53306
+ /**
53307
+ * Protocol v10.pcp.sap.com
53308
+ */
53257
53309
  v10 = "v10.pcp.sap.com",
53258
53310
  }
53259
53311
  /**
@@ -62981,7 +63033,7 @@ declare module "sap/ui/model/Model" {
62981
63033
  /**
62982
63034
  * HTTP status code returned by the request (if available)
62983
63035
  */
62984
- statusCode?: string;
63036
+ statusCode?: string | number;
62985
63037
 
62986
63038
  /**
62987
63039
  * The status as a text, details not specified, intended only for diagnosis output
@@ -73616,11 +73668,24 @@ declare module "sap/ui/model/odata/v4/Context" {
73616
73668
  * @returns `true` if this context is kept alive
73617
73669
  */
73618
73670
  isKeepAlive(): boolean;
73671
+ /**
73672
+ * Tells whether this context is outdated:
73673
+ * `undefined`: The outdated state has not been determined yet `true`: The context is outdated `false`:
73674
+ * The context is up to date
73675
+ *
73676
+ * The outdated state can also be accessed via the instance annotation "@$ui5.context.isOutdated".
73677
+ *
73678
+ * @experimental As of version 1.147.
73679
+ *
73680
+ * @returns Whether this context is outdated, or `undefined` if the outdated state has not been determined
73681
+ * yet
73682
+ */
73683
+ isOutdated(): boolean | undefined;
73619
73684
  /**
73620
73685
  * Tells whether this context is currently selected, but not {@link #delete deleted} on the client. Selection
73621
- * was experimental as of version 1.111.0. Since 1.122.0, the selection state can also be accessed via instance
73622
- * annotation "@$ui5.context.isSelected" at the entity. Note that the annotation does not take the deletion
73623
- * state into account.
73686
+ * was experimental as of version 1.111.0. Since 1.122.0, the selection state can also be accessed via the
73687
+ * instance annotation "@$ui5.context.isSelected" at the entity. Note that the annotation does not take
73688
+ * the deletion state into account.
73624
73689
  * See:
73625
73690
  * #setSelected
73626
73691
  *
@@ -73896,9 +73961,11 @@ declare module "sap/ui/model/odata/v4/Context" {
73896
73961
  * effects fail to load. Use it to set fields affected by side effects to read-only before {@link #requestSideEffects }
73897
73962
  * and make them editable again when the promise resolves; in the error handler, you can repeat the loading
73898
73963
  * of side effects.
73899
- * The promise is rejected if the call wants to refresh a whole list binding (via header context or an
73900
- * absolute path), but the deletion of a row context (see {@link #delete}) is pending with a different group
73901
- * ID.
73964
+ * The promise is rejected if
73965
+ * the call attempts to refresh an entire list binding (via header context or an absolute path) while
73966
+ * the deletion of a row context (see {@link #delete}) is pending with a different group ID, this is
73967
+ * the row context of a list binding with data aggregation which has `groupLevels` or `"grandTotal like
73968
+ * 1.84"`, or this context does not represent a single entity
73902
73969
  */
73903
73970
  requestSideEffects(
73904
73971
  /**
@@ -75427,9 +75494,11 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
75427
75494
  */
75428
75495
  getGroupId(): string;
75429
75496
  /**
75430
- * Returns the header context which allows binding to `$count` or `@$ui5.context.isSelected`.
75497
+ * Returns the header context which allows binding to `$count`, `@$ui5.context.isOutdated`, or `@$ui5.context.isSelected`.
75431
75498
  * See:
75432
75499
  * #getCount
75500
+ * sap.ui.model.odata.v4.Context#isOutdated
75501
+ * sap.ui.model.odata.v4.Context#isSelected
75433
75502
  *
75434
75503
  * @since 1.45.0
75435
75504
  *
@@ -79911,6 +79980,11 @@ declare module "sap/ui/model/Sorter" {
79911
79980
  * See `vGroup` parameter
79912
79981
  */
79913
79982
  group?: boolean | Function;
79983
+ /**
79984
+ * An array of paths that are required for grouping. Supported since 1.147.0; consult the documentation
79985
+ * of the specific model implementation whether it evaluates these paths.
79986
+ */
79987
+ groupPaths?: string[];
79914
79988
  /**
79915
79989
  * The binding path for this sorter
79916
79990
  */
@@ -80020,6 +80094,14 @@ declare module "sap/ui/model/Sorter" {
80020
80094
  * @returns The group function
80021
80095
  */
80022
80096
  getGroupFunction(): Function;
80097
+ /**
80098
+ * Returns the group paths.
80099
+ *
80100
+ * @since 1.147.0
80101
+ *
80102
+ * @returns The array of group paths or `undefined` if this sorter has no group paths.
80103
+ */
80104
+ getGroupPaths(): string[] | undefined;
80023
80105
  /**
80024
80106
  * Returns the binding path for this sorter; see the path parameter of {@link sap.ui.model.Sorter#constructor}.
80025
80107
  *
@@ -82821,6 +82903,10 @@ declare module "sap/ui/test/actions/Press" {
82821
82903
  * The `Press` action is used to simulate a press interaction with a control. Most controls are supported,
82822
82904
  * for example buttons, links, list items, tables, filters, and form controls.
82823
82905
  *
82906
+ * The `Press` action can also simulate right-click (context menu) interactions by setting the `rightClick`
82907
+ * property to true. This is useful for testing controls with custom context menus, such as `sap.ui.table.Table`
82908
+ * and `sap.m.Table`.
82909
+ *
82824
82910
  * The `Press` action targets a special DOM element representing the control. This DOM element can be customized.
82825
82911
  *
82826
82912
  * For most most controls (even custom ones), the DOM focus reference is an appropriate choice. You can
@@ -82917,7 +83003,9 @@ declare module "sap/ui/test/actions/Press" {
82917
83003
  /**
82918
83004
  * Sets focus on given control and triggers a 'tap' event on it (which is internally translated into a 'press'
82919
83005
  * event). If `keyDown` or `keyUp` is set to `true`, dispatches the corresponding keyboard event instead
82920
- * of mouse events. Logs an error if control is not visible (i.e. has no dom representation)
83006
+ * of mouse events. If `rightClick` property is set to `true`, triggers a `contextmenu` event instead, along
83007
+ * with appropriate `mousedown` and `mouseup` events. Logs an error if control is not visible (i.e. has
83008
+ * no dom representation)
82921
83009
  */
82922
83010
  executeOn(
82923
83011
  /**
@@ -82967,6 +83055,21 @@ declare module "sap/ui/test/actions/Press" {
82967
83055
  * @returns Value of property `keyUp`
82968
83056
  */
82969
83057
  getKeyUp(): boolean;
83058
+ /**
83059
+ * Gets current value of property {@link #getRightClick rightClick}.
83060
+ *
83061
+ * If set to `true`, a right-click (context menu) event will be triggered instead of a left-click. This
83062
+ * simulates the native browser right-click behavior by dispatching `mousedown` and `mouseup` with `button:
83063
+ * 2`, followed by a `contextmenu` event. The `xPercentage` and `yPercentage` properties can be used to
83064
+ * specify the position of the right-click event.
83065
+ *
83066
+ * Default value is `false`.
83067
+ *
83068
+ * @since 1.147
83069
+ *
83070
+ * @returns Value of property `rightClick`
83071
+ */
83072
+ getRightClick(): boolean;
82970
83073
  /**
82971
83074
  * Gets current value of property {@link #getShiftKey shiftKey}.
82972
83075
  *
@@ -83069,6 +83172,28 @@ declare module "sap/ui/test/actions/Press" {
83069
83172
  */
83070
83173
  bKeyUp: boolean
83071
83174
  ): this;
83175
+ /**
83176
+ * Sets a new value for property {@link #getRightClick rightClick}.
83177
+ *
83178
+ * If set to `true`, a right-click (context menu) event will be triggered instead of a left-click. This
83179
+ * simulates the native browser right-click behavior by dispatching `mousedown` and `mouseup` with `button:
83180
+ * 2`, followed by a `contextmenu` event. The `xPercentage` and `yPercentage` properties can be used to
83181
+ * specify the position of the right-click event.
83182
+ *
83183
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
83184
+ *
83185
+ * Default value is `false`.
83186
+ *
83187
+ * @since 1.147
83188
+ *
83189
+ * @returns Reference to `this` in order to allow method chaining
83190
+ */
83191
+ setRightClick(
83192
+ /**
83193
+ * New value for property `rightClick`
83194
+ */
83195
+ bRightClick?: boolean
83196
+ ): this;
83072
83197
  /**
83073
83198
  * Sets a new value for property {@link #getShiftKey shiftKey}.
83074
83199
  *
@@ -83179,6 +83304,16 @@ declare module "sap/ui/test/actions/Press" {
83179
83304
  * @since 1.146
83180
83305
  */
83181
83306
  keyUp?: boolean | PropertyBindingInfo | `{${string}}`;
83307
+
83308
+ /**
83309
+ * If set to `true`, a right-click (context menu) event will be triggered instead of a left-click. This
83310
+ * simulates the native browser right-click behavior by dispatching `mousedown` and `mouseup` with `button:
83311
+ * 2`, followed by a `contextmenu` event. The `xPercentage` and `yPercentage` properties can be used to
83312
+ * specify the position of the right-click event.
83313
+ *
83314
+ * @since 1.147
83315
+ */
83316
+ rightClick?: boolean | PropertyBindingInfo | `{${string}}`;
83182
83317
  }
83183
83318
  }
83184
83319
 
@@ -86655,6 +86790,27 @@ declare module "sap/ui/test/Opa5" {
86655
86790
  * Use when there are multiple views with the same viewName.
86656
86791
  */
86657
86792
  viewId?: string;
86793
+ /**
86794
+ * The namespace to be prepended to the view name defined in the `viewName` parameter. When set, all `waitFor`
86795
+ * calls inside the page object will resolve the view by `viewNamespace + "." + viewName`.
86796
+ *
86797
+ * Example:
86798
+ * ```javascript
86799
+ *
86800
+ * Opa5.createPageObjects({
86801
+ * onMyPage: {
86802
+ * viewName: "myView",
86803
+ * viewNamespace: "my.app.namespace",
86804
+ * assertions: { ... }
86805
+ * }
86806
+ * });
86807
+ * ```
86808
+ *
86809
+ *
86810
+ * Note: If all page objects share the same `viewNamespace`, consider setting it globally via {@link sap.ui.test.Opa5.extendConfig }
86811
+ * to avoid repetition.
86812
+ */
86813
+ viewNamespace?: string;
86658
86814
  /**
86659
86815
  * Base class for the page object's actions and assertions
86660
86816
  */
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.146.0
1
+ // For Library Version: 1.147.0
2
2
 
3
3
  declare module "sap/ui/dt/library" {
4
4
  export namespace designtime {
package/types/index.d.ts CHANGED
@@ -17,10 +17,10 @@
17
17
  /// <reference path="./sap.zen.dsh.d.ts"/>
18
18
  /// <reference path="./sap.zen.commons.d.ts"/>
19
19
  /// <reference path="./sap.sac.df.d.ts"/>
20
- /// <reference path="./sap.ui.commons.d.ts"/>
20
+ /// <reference path="./commons-1.147.0-esm-d.ts"/>
21
21
  /// <reference path="./sap.ui.comp.d.ts"/>
22
- /// <reference path="./sap.ui.core.d.ts"/>
23
- /// <reference path="./sap.ui.dt.d.ts"/>
22
+ /// <reference path="./core-1.147.0-esm-d.ts"/>
23
+ /// <reference path="./dt-1.147.0-esm-d.ts"/>
24
24
  /// <reference path="./sap.ui.export.d.ts"/>
25
25
  /// <reference path="./sap.f.d.ts"/>
26
26
  /// <reference path="./sap.ui.fl.d.ts"/>
@@ -33,8 +33,8 @@
33
33
  /// <reference path="./sap.ui.integration.d.ts"/>
34
34
  /// <reference path="./sap.ui.layout.d.ts"/>
35
35
  /// <reference path="./sap.makit.d.ts"/>
36
- /// <reference path="./sap.ui.mdc.d.ts"/>
37
- /// <reference path="./sap.m.d.ts"/>
36
+ /// <reference path="./mdc-1.147.0-esm-d.ts"/>
37
+ /// <reference path="./mobile-1.147.0-esm-d.ts"/>
38
38
  /// <reference path="./sap.me.d.ts"/>
39
39
  /// <reference path="./sap.ndc.d.ts"/>
40
40
  /// <reference path="./sap.ovp.d.ts"/>
@@ -70,15 +70,12 @@
70
70
  /// <reference path="./sap.ui.support.d.ts"/>
71
71
  /// <reference path="./sap.ui.table.d.ts"/>
72
72
  /// <reference path="./sap.ui.testrecorder.d.ts"/>
73
- /// <reference path="./sap.tnt.d.ts"/>
73
+ /// <reference path="./tnt-1.147.0-esm-d.ts"/>
74
74
  /// <reference path="./sap.ca.ui.d.ts"/>
75
75
  /// <reference path="./sap.ui.unified.d.ts"/>
76
76
  /// <reference path="./sap.ushell.d.ts"/>
77
77
  /// <reference path="./sap.ushell_abap.d.ts"/>
78
- /// <reference path="./sap.ui.ux3.d.ts"/>
78
+ /// <reference path="./ux3-1.147.0-esm-d.ts"/>
79
79
  /// <reference path="./sap.uxap.d.ts"/>
80
80
  /// <reference path="./sap.ui.vbm.d.ts"/>
81
81
  /// <reference path="./sap.viz.d.ts"/>
82
- /// <reference path="./sap.ui.webc.common.d.ts"/>
83
- /// <reference path="./sap.ui.webc.fiori.d.ts"/>
84
- /// <reference path="./sap.ui.webc.main.d.ts"/>
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.146.0
1
+ // For Library Version: 1.147.0
2
2
 
3
3
  declare module "sap/ui/mdc/AggregationBaseDelegate" {
4
4
  import BaseDelegate from "sap/ui/mdc/BaseDelegate";
@@ -3767,6 +3767,17 @@ declare module "sap/ui/mdc/library" {
3767
3767
 
3768
3768
  import ParseException from "sap/ui/model/ParseException";
3769
3769
 
3770
+ export type DelegateConfig = {
3771
+ /**
3772
+ * Delegate module path
3773
+ */
3774
+ name: string;
3775
+ /**
3776
+ * defines application-specific information that can be used in the given delegate
3777
+ */
3778
+ payload?: any;
3779
+ };
3780
+
3770
3781
  /**
3771
3782
  * Acts a subset of the `FilterBarDelegate` that can be used in {@link module:sap/ui/mdc/TableDelegate.getFilterDelegate TableDelegate.getFilterDelegate }
3772
3783
  * or {@link module:sap/ui/mdc/ChartDelegate.getFilterDelegate Chart.getFilterDelegate} to enable inbuilt
@@ -4819,8 +4830,10 @@ declare module "sap/ui/mdc/Chart" {
4819
4830
  * Gets current value of property {@link #getDelegate delegate}.
4820
4831
  *
4821
4832
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
4822
- * The object has the following properties:
4823
- * - `name` defines the path to the `Delegate` module
4833
+ * The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
4834
+ *
4835
+ * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/ChartDelegate ChartDelegate}.
4836
+ *
4824
4837
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
4825
4838
  * Sample delegate object:
4826
4839
  * ```javascript
@@ -5152,8 +5165,10 @@ declare module "sap/ui/mdc/Chart" {
5152
5165
  * Sets a new value for property {@link #getDelegate delegate}.
5153
5166
  *
5154
5167
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
5155
- * The object has the following properties:
5156
- * - `name` defines the path to the `Delegate` module
5168
+ * The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
5169
+ *
5170
+ * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/ChartDelegate ChartDelegate}.
5171
+ *
5157
5172
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
5158
5173
  * Sample delegate object:
5159
5174
  * ```javascript
@@ -5518,8 +5533,10 @@ declare module "sap/ui/mdc/Chart" {
5518
5533
 
5519
5534
  /**
5520
5535
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
5521
- * The object has the following properties:
5522
- * - `name` defines the path to the `Delegate` module
5536
+ * The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
5537
+ *
5538
+ * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/ChartDelegate ChartDelegate}.
5539
+ *
5523
5540
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
5524
5541
  * Sample delegate object:
5525
5542
  * ```javascript
@@ -7769,7 +7786,8 @@ declare module "sap/ui/mdc/Control" {
7769
7786
  export interface $ControlSettings extends $ControlSettings1 {
7770
7787
  /**
7771
7788
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
7772
- * The object has the following properties:
7789
+ * The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
7790
+ *
7773
7791
  * - `name` defines the path to the `Delegate` module
7774
7792
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
7775
7793
  * Sample delegate object:
@@ -7991,7 +8009,8 @@ declare module "sap/ui/mdc/Element" {
7991
8009
  export interface $ElementSettings extends $ElementSettings1 {
7992
8010
  /**
7993
8011
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
7994
- * The object has the following properties:
8012
+ * The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
8013
+ *
7995
8014
  * - `name` defines the path to the `Delegate` module
7996
8015
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
7997
8016
  * Sample delegate object:
@@ -13483,13 +13502,17 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
13483
13502
 
13484
13503
  import InvisibleText from "sap/ui/core/InvisibleText";
13485
13504
 
13505
+ import { MessageType, ID } from "sap/ui/core/library";
13506
+
13507
+ import Message from "sap/ui/core/message/Message";
13508
+
13486
13509
  import FilterBarValidationStatus from "sap/ui/mdc/enums/FilterBarValidationStatus";
13487
13510
 
13488
13511
  import FilterField from "sap/ui/mdc/FilterField";
13489
13512
 
13490
13513
  import ElementMetadata from "sap/ui/core/ElementMetadata";
13491
13514
 
13492
- import { ID } from "sap/ui/core/library";
13515
+ import Message1 from "sap/ui/core/Message";
13493
13516
 
13494
13517
  import VariantManagement from "sap/ui/fl/variants/VariantManagement";
13495
13518
 
@@ -13588,6 +13611,28 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
13588
13611
  */
13589
13612
  oInvisibleText: InvisibleText
13590
13613
  ): void;
13614
+ /**
13615
+ * Adds a message to the {@link sap.ui.model.message.MessageModel MessageModel} for a `propertyKey`. The
13616
+ * message is displayed on the corresponding {@link sap.ui.mdc.FilterField FilterField}.
13617
+ *
13618
+ * @since 1.147
13619
+ *
13620
+ * @returns The created message object
13621
+ */
13622
+ addMessage(
13623
+ /**
13624
+ * The `propertyKey` of the {@link sap.ui.mdc.FilterField FilterField}
13625
+ */
13626
+ sPropertyKey: string,
13627
+ /**
13628
+ * The message text
13629
+ */
13630
+ sMessage: string,
13631
+ /**
13632
+ * The message type
13633
+ */
13634
+ sMessageType: MessageType | keyof typeof MessageType
13635
+ ): Message;
13591
13636
  /**
13592
13637
  * Attaches event handler `fnFunction` to the {@link #event:filtersChanged filtersChanged} event of this
13593
13638
  * `sap.ui.mdc.filterbar.FilterBarBase`.
@@ -13834,8 +13879,10 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
13834
13879
  * Gets current value of property {@link #getDelegate delegate}.
13835
13880
  *
13836
13881
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
13837
- * The object has the following properties:
13838
- * - `name` defines the path to the `Delegate` module
13882
+ * The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
13883
+ *
13884
+ * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/FilterBarDelegate FilterBarDelegate}.
13885
+ *
13839
13886
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
13840
13887
  * Sample delegate object:
13841
13888
  * ```javascript
@@ -13893,6 +13940,19 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
13893
13940
  * @returns Value of property `liveMode`
13894
13941
  */
13895
13942
  getLiveMode(): boolean;
13943
+ /**
13944
+ * Returns all messages associated with the given `propertyKey` from the {@link sap.ui.model.message.MessageModel MessageModel}.
13945
+ *
13946
+ * @since 1.147
13947
+ *
13948
+ * @returns Array of messages for the given `propertyKey`
13949
+ */
13950
+ getMessages(
13951
+ /**
13952
+ * The `propertyKey` of the {@link sap.ui.mdc.FilterField FilterField}
13953
+ */
13954
+ sPropertyKey: string
13955
+ ): Message[];
13896
13956
  /**
13897
13957
  * Gets the value of the basic search condition.
13898
13958
  *
@@ -13970,6 +14030,30 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
13970
14030
  * @returns Resolves after the initial filters have been applied and the metadata has been obtained
13971
14031
  */
13972
14032
  initializedWithMetadata(): Promise<any>;
14033
+ /**
14034
+ * Removes a given message from the {@link sap.ui.model.message.MessageModel MessageModel}. The message
14035
+ * is removed from the corresponding {@link sap.ui.mdc.FilterField FilterField}.
14036
+ *
14037
+ * @since 1.147
14038
+ */
14039
+ removeMessage(
14040
+ /**
14041
+ * The message to remove
14042
+ */
14043
+ oMessage: Message1
14044
+ ): void;
14045
+ /**
14046
+ * Removes all messages for the given `propertyKey` from the {@link sap.ui.model.message.MessageModel MessageModel}.
14047
+ * Clears the messages from the corresponding {@link sap.ui.mdc.FilterField FilterField}.
14048
+ *
14049
+ * @since 1.147
14050
+ */
14051
+ removeMessages(
14052
+ /**
14053
+ * The `propertyKey` of the {@link sap.ui.mdc.FilterField FilterField}
14054
+ */
14055
+ sPropertyKey: string
14056
+ ): void;
13973
14057
  /**
13974
14058
  * Sets the aggregated {@link #getBasicSearchField basicSearchField}.
13975
14059
  *
@@ -13986,8 +14070,10 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
13986
14070
  * Sets a new value for property {@link #getDelegate delegate}.
13987
14071
  *
13988
14072
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
13989
- * The object has the following properties:
13990
- * - `name` defines the path to the `Delegate` module
14073
+ * The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
14074
+ *
14075
+ * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/FilterBarDelegate FilterBarDelegate}.
14076
+ *
13991
14077
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
13992
14078
  * Sample delegate object:
13993
14079
  * ```javascript
@@ -14141,8 +14227,10 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
14141
14227
  export interface $FilterBarBaseSettings extends $ControlSettings {
14142
14228
  /**
14143
14229
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
14144
- * The object has the following properties:
14145
- * - `name` defines the path to the `Delegate` module
14230
+ * The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
14231
+ *
14232
+ * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/FilterBarDelegate FilterBarDelegate}.
14233
+ *
14146
14234
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
14147
14235
  * Sample delegate object:
14148
14236
  * ```javascript
@@ -14198,8 +14286,8 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
14198
14286
  * aggregation) should be specified here, rather than in the `FilterField` configuration.
14199
14287
  * **Note**: This property must not be bound.
14200
14288
  * **Node**: Please check {@link sap.ui.mdc.filterbar.PropertyInfo} for more information about the supported
14201
- * inner elements. **Note**: Existing properties (set via `sap.ui.mdc.filterbar.FilterBarBase#setPropertyInfo`)
14202
- * must not be removed and their attributes must not be changed during the {@link module:sap/ui/mdc/FilterBarDelegate.fetchProperties fetchProperties }
14289
+ * inner elements. **Note**: Existing properties (set via {@link #setPropertyInfo setPropertyInfo}) must
14290
+ * not be removed and their attributes must not be changed during the {@link module:sap/ui/mdc/FilterBarDelegate.fetchProperties fetchProperties }
14203
14291
  * callback. Otherwise validation errors might occur whenever personalization-related control features (such
14204
14292
  * as the opening of any personalization dialog) are activated.
14205
14293
  *
@@ -18088,7 +18176,8 @@ declare module "sap/ui/mdc/Table" {
18088
18176
  *
18089
18177
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
18090
18178
  *
18091
- * The object has the following properties:
18179
+ * The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
18180
+ *
18092
18181
  * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/TableDelegate TableDelegate}.
18093
18182
  *
18094
18183
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
@@ -18649,7 +18738,8 @@ declare module "sap/ui/mdc/Table" {
18649
18738
  *
18650
18739
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
18651
18740
  *
18652
- * The object has the following properties:
18741
+ * The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
18742
+ *
18653
18743
  * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/TableDelegate TableDelegate}.
18654
18744
  *
18655
18745
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
@@ -19325,7 +19415,8 @@ declare module "sap/ui/mdc/Table" {
19325
19415
  /**
19326
19416
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
19327
19417
  *
19328
- * The object has the following properties:
19418
+ * The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
19419
+ *
19329
19420
  * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/TableDelegate TableDelegate}.
19330
19421
  *
19331
19422
  * - `payload` (optional) defines application-specific information that can be used in the given delegate