@sapui5/ts-types-esm 1.136.2 → 1.138.0

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 (70) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +2 -1
  3. package/types/sap.apf.d.ts +30 -3
  4. package/types/sap.ca.ui.d.ts +1 -1
  5. package/types/sap.chart.d.ts +1 -1
  6. package/types/sap.collaboration.d.ts +1 -1
  7. package/types/sap.cux.home.d.ts +315 -65
  8. package/types/sap.esh.search.ui.d.ts +71 -1
  9. package/types/sap.f.d.ts +1 -1
  10. package/types/sap.fe.ariba.d.ts +3 -0
  11. package/types/sap.fe.base.d.ts +1 -1
  12. package/types/sap.fe.controls.d.ts +1 -1
  13. package/types/sap.fe.core.d.ts +50 -8
  14. package/types/sap.fe.ina.d.ts +1 -1
  15. package/types/sap.fe.macros.d.ts +192 -66
  16. package/types/sap.fe.navigation.d.ts +1 -1
  17. package/types/sap.fe.placeholder.d.ts +1 -1
  18. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  19. package/types/sap.fe.templates.d.ts +1 -1
  20. package/types/sap.fe.test.d.ts +4 -3
  21. package/types/sap.fe.tools.d.ts +1 -1
  22. package/types/sap.feedback.ui.d.ts +1 -1
  23. package/types/sap.gantt.d.ts +1 -1
  24. package/types/sap.insights.d.ts +1 -1
  25. package/types/sap.m.d.ts +1261 -566
  26. package/types/sap.makit.d.ts +1 -1
  27. package/types/sap.me.d.ts +1 -1
  28. package/types/sap.ndc.d.ts +1 -1
  29. package/types/sap.ovp.d.ts +1 -1
  30. package/types/sap.rules.ui.d.ts +1 -1
  31. package/types/sap.sac.df.d.ts +34 -1
  32. package/types/sap.suite.ui.commons.d.ts +4 -2
  33. package/types/sap.suite.ui.generic.template.d.ts +1 -1
  34. package/types/sap.suite.ui.microchart.d.ts +1 -1
  35. package/types/sap.tnt.d.ts +103 -16
  36. package/types/sap.ui.codeeditor.d.ts +1 -1
  37. package/types/sap.ui.commons.d.ts +1 -1
  38. package/types/sap.ui.comp.d.ts +67 -9
  39. package/types/sap.ui.core.d.ts +62 -49
  40. package/types/sap.ui.dt.d.ts +1 -1
  41. package/types/sap.ui.export.d.ts +221 -167
  42. package/types/sap.ui.fl.d.ts +3 -7
  43. package/types/sap.ui.generic.app.d.ts +1 -1
  44. package/types/sap.ui.generic.template.d.ts +1 -1
  45. package/types/sap.ui.integration.d.ts +44 -24
  46. package/types/sap.ui.layout.d.ts +1 -1
  47. package/types/{mdc-1.136.0-esm-d.ts → sap.ui.mdc.d.ts} +599 -297
  48. package/types/sap.ui.richtexteditor.d.ts +21 -17
  49. package/types/sap.ui.rta.d.ts +1 -1
  50. package/types/sap.ui.suite.d.ts +1 -1
  51. package/types/sap.ui.support.d.ts +1 -1
  52. package/types/sap.ui.table.d.ts +1 -1
  53. package/types/sap.ui.testrecorder.d.ts +1 -1
  54. package/types/sap.ui.unified.d.ts +9 -1
  55. package/types/sap.ui.ux3.d.ts +1 -1
  56. package/types/sap.ui.vbm.d.ts +75 -30
  57. package/types/sap.ui.vk.d.ts +364 -102
  58. package/types/sap.ui.vtm.d.ts +3 -2
  59. package/types/sap.ui.webc.common.d.ts +1 -1
  60. package/types/sap.ui.webc.fiori.d.ts +1 -1
  61. package/types/sap.ui.webc.main.d.ts +1 -1
  62. package/types/sap.uiext.inbox.d.ts +1 -1
  63. package/types/sap.ushell.d.ts +58 -31
  64. package/types/sap.ushell_abap.d.ts +1 -1
  65. package/types/sap.uxap.d.ts +1 -1
  66. package/types/sap.viz.d.ts +1 -1
  67. package/types/sap.webanalytics.core.d.ts +1 -1
  68. package/types/sap.zen.commons.d.ts +1 -1
  69. package/types/sap.zen.crosstab.d.ts +1 -1
  70. package/types/sap.zen.dsh.d.ts +1 -1
@@ -279,7 +279,7 @@ declare namespace sap {
279
279
  "sap/ui/thirdparty/qunit-2": undefined;
280
280
  }
281
281
  }
282
- // For Library Version: 1.136.1
282
+ // For Library Version: 1.138.0
283
283
 
284
284
  declare module "sap/base/assert" {
285
285
  /**
@@ -42670,7 +42670,10 @@ declare module "sap/ui/core/routing/Target" {
42670
42670
  oListener?: object
42671
42671
  ): this;
42672
42672
  /**
42673
- * Creates a view and puts it in an aggregation of a control that has been defined in the {@link sap.ui.core.routing.Target#constructor}.
42673
+ * Creates a view and puts it in an aggregation of a control that has been defined in the {@link #constructor}.
42674
+ *
42675
+ * This method can be used to display a target without changing the browser hash. If the browser hash should
42676
+ * be changed, the {@link sap.ui.core.routing.Router#navTo} method should be used instead
42674
42677
  *
42675
42678
  *
42676
42679
  * @returns resolves with {name: *, view: *, control: *} if the target can be successfully displayed otherwise
@@ -44590,6 +44593,27 @@ declare module "sap/ui/core/routing/RouterHashChanger" {
44590
44593
  * @returns Metadata object describing this class
44591
44594
  */
44592
44595
  static getMetadata(): Metadata;
44596
+ /**
44597
+ * Returns a managed instance of {@link sap.ui.core.routing.RouterHashChanger} associated with the current
44598
+ * instance.
44599
+ *
44600
+ * This sub-instance handles a specific part of the URL hash. When the sub-instance modifies the hash, it
44601
+ * notifies the parent instance, which then updates the browser’s hash accordingly. Likewise, when the relevant
44602
+ * part of the hash changes externally, the parent instance notifies the sub-instance.
44603
+ *
44604
+ * The provided `sKey` is used as an identifier for caching the sub-instance. If this method is called again
44605
+ * with the same key, the previously created instance is returned.
44606
+ *
44607
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
44608
+ *
44609
+ * @returns The corresponding sub RouterHashChanger instance.
44610
+ */
44611
+ createSubHashChanger(
44612
+ /**
44613
+ * A unique key used as the prefix for the sub RouterHashChanger.
44614
+ */
44615
+ sKey: string
44616
+ ): RouterHashChanger;
44593
44617
  /**
44594
44618
  * Save the given hash and potentially fires a "hashChanged" event; may be extended to modify the hash before
44595
44619
  * firing the event.
@@ -44706,10 +44730,6 @@ declare module "sap/ui/core/routing/Targets" {
44706
44730
  default as Target,
44707
44731
  } from "sap/ui/core/routing/Target";
44708
44732
 
44709
- import View from "sap/ui/core/mvc/View";
44710
-
44711
- import Control from "sap/ui/core/Control";
44712
-
44713
44733
  import Metadata from "sap/ui/base/Metadata";
44714
44734
 
44715
44735
  import Event from "sap/ui/base/Event";
@@ -45030,37 +45050,29 @@ declare module "sap/ui/core/routing/Targets" {
45030
45050
  * Creates a view and puts it in an aggregation of the specified control.
45031
45051
  *
45032
45052
  *
45033
- * @returns this pointer for chaining or a Promise
45053
+ * @returns resolving with {{name: *, view: *, control: *}|undefined} for every vTargets, object for single,
45054
+ * array for multiple
45034
45055
  */
45035
45056
  display(
45036
45057
  /**
45037
- * Either the target name or a target info object. To display multiple targets you may also pass an array
45038
- * of target names or target info objects.
45058
+ * the key of the target as specified in the {@link #constructor}. To display multiple targets you may also
45059
+ * pass an array of keys. If the target(s) represents a sap.ui.core.UIComponent, a prefix for its Router
45060
+ * is needed. You can set this parameter with an object which has the 'name' property set with the key of
45061
+ * the target and the 'prefix' property set with the prefix for the UIComponent's router. To display multiple
45062
+ * component targets, you man also pass an array of objects.
45039
45063
  */
45040
- vTargets: string | string[] | TargetInfo | TargetInfo[],
45064
+ vTargets: string | string[] | object | object[],
45041
45065
  /**
45042
45066
  * an object that will be passed to the display event in the data property. If the target has parents, the
45043
45067
  * data will also be passed to them.
45044
45068
  */
45045
- oData?: object,
45069
+ vData?: object,
45046
45070
  /**
45047
45071
  * the name of the target from which the title option is taken for firing the {@link sap.ui.core.routing.Targets#event:titleChanged titleChanged }
45048
45072
  * event
45049
45073
  */
45050
45074
  sTitleTarget?: string
45051
- ):
45052
- | this
45053
- | Promise<
45054
- Array<{
45055
- name: string;
45056
-
45057
- view: View;
45058
-
45059
- control: Control;
45060
-
45061
- targetInfo: TargetInfo;
45062
- }>
45063
- >;
45075
+ ): Promise<any>;
45064
45076
  /**
45065
45077
  * Fires event {@link #event:created created} to attached listeners.
45066
45078
  *
@@ -51741,8 +51753,7 @@ declare module "sap/ui/core/webc/WebComponent" {
51741
51753
  * properties, the aggregations and the events. It also ensures to render the control and put the aggregated
51742
51754
  * controls in the dedicated slots of the Web Component.
51743
51755
  *
51744
- * @since 1.118.0
51745
- * @experimental As of version 1.118.0. The API might change. It is not intended for productive usage yet!
51756
+ * @since 1.138.0
51746
51757
  */
51747
51758
  export default class WebComponent extends Control {
51748
51759
  /**
@@ -51889,8 +51900,6 @@ declare module "sap/ui/core/webc/WebComponent" {
51889
51900
 
51890
51901
  /**
51891
51902
  * Describes the settings that can be provided to the WebComponent constructor.
51892
- *
51893
- * @experimental As of version 1.118.0. The API might change. It is not intended for productive usage yet!
51894
51903
  */
51895
51904
  export interface $WebComponentSettings extends $ControlSettings {}
51896
51905
 
@@ -51990,8 +51999,7 @@ declare module "sap/ui/core/webc/WebComponentMetadata" {
51990
51999
  import ElementMetadata from "sap/ui/core/ElementMetadata";
51991
52000
 
51992
52001
  /**
51993
- * @since 1.118.0
51994
- * @experimental As of version 1.118.0. The API might change. It is not intended for productive usage yet!
52002
+ * @since 1.138.0
51995
52003
  */
51996
52004
  export default class WebComponentMetadata extends ElementMetadata {
51997
52005
  /**
@@ -53825,7 +53833,7 @@ declare module "sap/ui/model/analytics/AnalyticalBinding" {
53825
53833
  * to OData requests. If a binding count mode is set to `Request` or `Both`, a warning is logged to remind
53826
53834
  * the application that the OData requests generated by the AnalyticalBinding include a $inlinecount.
53827
53835
  *
53828
- * @experimental This module is only for experimental use!
53836
+ * @deprecated As of version 1.138.0. will be replaced by OData V4 data aggregation, see {@link topic:7d914317c0b64c23824bf932cc8a4ae1 Extension for Data Aggregation}
53829
53837
  * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
53830
53838
  */
53831
53839
  export default class AnalyticalBinding extends TreeBinding {
@@ -54421,6 +54429,10 @@ declare module "sap/ui/model/analytics/AnalyticalBinding" {
54421
54429
  }
54422
54430
 
54423
54431
  declare module "sap/ui/model/analytics/AnalyticalTreeBindingAdapter" {
54432
+ /**
54433
+ * @deprecated As of version 1.138.0. will be replaced by OData V4 data aggregation, see {@link topic:7d914317c0b64c23824bf932cc8a4ae1 Extension for Data Aggregation}
54434
+ * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
54435
+ */
54424
54436
  export default class AnalyticalTreeBindingAdapter {
54425
54437
  /**
54426
54438
  * Adapter for TreeBindings to add the ListBinding functionality and use the tree structure in list based
@@ -54569,7 +54581,7 @@ declare module "sap/ui/model/analytics/odata4analytics" {
54569
54581
  *
54570
54582
  * Lazy initialization of attributes will cause unexpected values when you access object attributes directly.
54571
54583
  *
54572
- * @experimental This module is only for experimental use!
54584
+ * @deprecated As of version 1.138.0. will be replaced by OData V4 data aggregation, see {@link topic:7d914317c0b64c23824bf932cc8a4ae1 Extension for Data Aggregation}
54573
54585
  * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
54574
54586
  */
54575
54587
  interface odata4analytics {
@@ -54596,6 +54608,9 @@ declare module "sap/ui/model/analytics/odata4analytics" {
54596
54608
  ): void;
54597
54609
  }
54598
54610
  const odata4analytics: odata4analytics;
54611
+ /**
54612
+ * @deprecated As of version 1.138.0. will be replaced by OData V4 data aggregation, see {@link topic:7d914317c0b64c23824bf932cc8a4ae1 Extension for Data Aggregation}
54613
+ */
54599
54614
  export default odata4analytics;
54600
54615
 
54601
54616
  /**
@@ -61380,7 +61395,7 @@ declare module "sap/ui/model/odata/ODataTreeBindingAdapter" {
61380
61395
  * controls. Only usable with the sap.ui.table.TreeTable control. The functions defined here are only available
61381
61396
  * when you are using a TreeTable and an ODataModel.
61382
61397
  *
61383
- * @experimental This module is only for experimental and internal use!
61398
+ * @deprecated As of version 1.138.0. will be replaced by OData V4 hierarchy functionality, see {@link topic:7d914317c0b64c23824bf932cc8a4ae1/section_RCH Recursive Hierarchy}
61384
61399
  */
61385
61400
  export default function ODataTreeBindingAdapter(): void;
61386
61401
  }
@@ -74275,8 +74290,6 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
74275
74290
 
74276
74291
  /**
74277
74292
  * Parameters of the ODataListBinding#separateReceived event.
74278
- *
74279
- * @experimental As of version 1.131.0.
74280
74293
  */
74281
74294
  export interface ODataListBinding$SeparateReceivedEventParameters {
74282
74295
  /**
@@ -74295,15 +74308,13 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
74295
74308
  length?: number;
74296
74309
 
74297
74310
  /**
74298
- * A UI5 message of type {@link module:sap/ui/core/message/MessageType MessageType.Error}
74311
+ * An array of UI5 messages if the request failed; `undefined` otherwise
74299
74312
  */
74300
- errorMessage?: Message;
74313
+ messagesOnError?: Message[];
74301
74314
  }
74302
74315
 
74303
74316
  /**
74304
74317
  * Event object of the ODataListBinding#separateReceived event.
74305
- *
74306
- * @experimental As of version 1.131.0.
74307
74318
  */
74308
74319
  export type ODataListBinding$SeparateReceivedEvent = Event<
74309
74320
  ODataListBinding$SeparateReceivedEventParameters,
@@ -74904,7 +74915,9 @@ declare module "sap/ui/model/odata/v4/ODataMetaModel" {
74904
74915
  * is not an OData simple identifier, it can be used as a placeholder for one. In this way, "/EMPLOYEES/"
74905
74916
  * addresses the same entity type as "/EMPLOYEES/$Type/". That entity type in turn is a map of all its OData
74906
74917
  * children (that is, structural and navigation properties) and determines the set of possible child names
74907
- * that might be used after the trailing slash.
74918
+ * that might be used after the trailing slash. Since 1.137.0, open (complex or entity) types are supported
74919
+ * as follows: A simple identifier that does not refer to an OData child is valid and treated as a dynamic
74920
+ * property of type "Edm.Untyped".
74908
74921
  *
74909
74922
  * "$" can be used as the last segment to continue a path and thus force scope lookup, but no OData simple
74910
74923
  * identifier preparations. In this way, it serves as a placeholder for a technical property. The path must
@@ -75571,12 +75584,12 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
75571
75584
  */
75572
75585
  $$ownRequest?: boolean;
75573
75586
  /**
75574
- * An array of navigation property names which are omitted from the main list request and loaded in a separate
75575
- * request instead (@experimental as of version 1.129.0). This results in the main list becoming available
75576
- * faster, while the separate properties are merged as soon as the data is received. Note that the separate
75577
- * properties must be single valued and part of the '$expand' system query option, either automatically
75578
- * via the "autoExpandSelect" model parameter (see {@link #constructor}) or manually. The `$$separate` parameter
75579
- * must not be combined with `$$aggregation`.
75587
+ * An array of navigation property names which are omitted from the main list request (since 1.137.0). Instead,
75588
+ * each of them is loaded in a separate request. This results in the main list becoming available faster,
75589
+ * while the separate properties are merged as soon as the data is received. Note that the separate properties
75590
+ * must be single valued and part of the '$expand' system query option, either automatically via the "autoExpandSelect"
75591
+ * model parameter (see {@link #constructor}) or manually. The `$$separate` parameter must not be combined
75592
+ * with `$$aggregation`.
75580
75593
  */
75581
75594
  $$separate?: string[];
75582
75595
  /**
@@ -84526,11 +84539,11 @@ declare module "sap/ui/test/Opa5" {
84526
84539
  * whether a function is used as arrangement or action. Each function typically contains one or multiple
84527
84540
  * `waitFor` statements.
84528
84541
  */
84529
- actions?: Record<string, () => void> | Function;
84542
+ actions?: Record<string, Function> | Function;
84530
84543
  /**
84531
84544
  * A map or a class of functions that can be used as assertions in Opa tests.
84532
84545
  */
84533
- assertions?: Record<string, () => void> | Function;
84546
+ assertions?: Record<string, Function> | Function;
84534
84547
  };
84535
84548
  }
84536
84549
 
@@ -87827,7 +87840,7 @@ declare namespace sap {
87827
87840
  /**
87828
87841
  * If called on an instance of an (v1/v2) ODataModel it will enrich it with analytics capabilities.
87829
87842
  *
87830
- * @experimental This module is only for experimental use!
87843
+ * @deprecated As of version 1.138.0. will be replaced by OData V4 data aggregation, see {@link topic:7d914317c0b64c23824bf932cc8a4ae1 Extension for Data Aggregation}
87831
87844
  * @ui5-protected Do not call from applications (only from related classes in the framework)
87832
87845
  */
87833
87846
  function ODataModelAdapter(): void;
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.136.1
1
+ // For Library Version: 1.138.0
2
2
 
3
3
  declare namespace sap {
4
4
  interface IUI5DefineDependencyNames {