@sapui5/ts-types 1.128.1 → 1.129.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 (67) hide show
  1. package/package.json +1 -1
  2. package/types/sap.apf.d.ts +1 -1
  3. package/types/sap.ca.ui.d.ts +1 -1
  4. package/types/sap.chart.d.ts +1 -1
  5. package/types/sap.collaboration.d.ts +1 -1
  6. package/types/sap.cux.home.d.ts +37 -0
  7. package/types/sap.esh.search.ui.d.ts +1 -1
  8. package/types/sap.f.d.ts +1 -1
  9. package/types/sap.fe.base.d.ts +1 -1
  10. package/types/sap.fe.core.d.ts +10 -10
  11. package/types/sap.fe.ina.d.ts +1 -1
  12. package/types/sap.fe.macros.d.ts +116 -30
  13. package/types/sap.fe.navigation.d.ts +9 -2
  14. package/types/sap.fe.placeholder.d.ts +1 -1
  15. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  16. package/types/sap.fe.templates.d.ts +1 -1
  17. package/types/sap.fe.test.d.ts +1 -1
  18. package/types/sap.fe.tools.d.ts +1 -1
  19. package/types/sap.feedback.ui.d.ts +1 -1
  20. package/types/sap.gantt.d.ts +17 -4
  21. package/types/sap.insights.d.ts +7 -1
  22. package/types/sap.m.d.ts +195 -27
  23. package/types/sap.makit.d.ts +1 -1
  24. package/types/sap.me.d.ts +1 -1
  25. package/types/sap.ndc.d.ts +1 -1
  26. package/types/sap.ovp.d.ts +1 -1
  27. package/types/sap.rules.ui.d.ts +1 -1
  28. package/types/sap.sac.df.d.ts +355 -20
  29. package/types/sap.suite.ui.commons.d.ts +118 -2
  30. package/types/sap.suite.ui.generic.template.d.ts +27 -1
  31. package/types/sap.suite.ui.microchart.d.ts +1 -1
  32. package/types/sap.tnt.d.ts +1 -1
  33. package/types/sap.ui.codeeditor.d.ts +1 -1
  34. package/types/sap.ui.commons.d.ts +1 -1
  35. package/types/sap.ui.comp.d.ts +427 -982
  36. package/types/sap.ui.core.d.ts +59 -65
  37. package/types/sap.ui.dt.d.ts +1 -1
  38. package/types/sap.ui.export.d.ts +7 -1
  39. package/types/sap.ui.fl.d.ts +13 -1
  40. package/types/sap.ui.generic.app.d.ts +1 -1
  41. package/types/sap.ui.generic.template.d.ts +1 -1
  42. package/types/sap.ui.integration.d.ts +37 -1
  43. package/types/sap.ui.layout.d.ts +1 -1
  44. package/types/sap.ui.mdc.d.ts +531 -27
  45. package/types/sap.ui.richtexteditor.d.ts +1 -1
  46. package/types/sap.ui.rta.d.ts +1 -1
  47. package/types/sap.ui.suite.d.ts +1 -1
  48. package/types/sap.ui.support.d.ts +1 -1
  49. package/types/sap.ui.table.d.ts +71 -18
  50. package/types/sap.ui.testrecorder.d.ts +1 -1
  51. package/types/sap.ui.unified.d.ts +103 -1
  52. package/types/sap.ui.ux3.d.ts +1 -1
  53. package/types/sap.ui.vbm.d.ts +1 -1
  54. package/types/sap.ui.vk.d.ts +1 -1
  55. package/types/sap.ui.vtm.d.ts +1 -1
  56. package/types/sap.ui.webc.common.d.ts +1 -1
  57. package/types/sap.ui.webc.fiori.d.ts +1 -1
  58. package/types/sap.ui.webc.main.d.ts +1 -1
  59. package/types/sap.uiext.inbox.d.ts +1 -1
  60. package/types/sap.ushell.d.ts +43 -25
  61. package/types/sap.ushell_abap.d.ts +1 -1
  62. package/types/sap.uxap.d.ts +1 -1
  63. package/types/sap.viz.d.ts +1 -1
  64. package/types/sap.webanalytics.core.d.ts +1 -1
  65. package/types/sap.zen.commons.d.ts +1 -1
  66. package/types/sap.zen.crosstab.d.ts +1 -1
  67. 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.128.0
282
+ // For Library Version: 1.129.0
283
283
 
284
284
  declare module "sap/base/assert" {
285
285
  /**
@@ -59594,51 +59594,12 @@ declare namespace sap {
59594
59594
  * @returns Metadata object describing this class
59595
59595
  */
59596
59596
  static getMetadata(): sap.ui.base.Metadata;
59597
- /**
59598
- * Adds (a) new URL(s) whose content should be parsed as OData annotations, which are then merged into the
59599
- * annotations object which can be retrieved by calling the {@link #getServiceAnnotations}-method. If a
59600
- * `$metadata` URL is passed, the data will also be merged into the metadata object, which can be reached
59601
- * by calling the {@link #getServiceMetadata} method.
59602
- *
59603
- * @ui5-protected Do not call from applications (only from related classes in the framework)
59604
- *
59605
- * @returns The Promise to load the given URL(s), resolved if all URLs have been loaded, rejected if at
59606
- * least one fails to load. If this promise resolves it returns an object with the following properties:
59607
- * `annotations`: The annotation object `entitySets`: An array of EntitySet objects containing the newly
59608
- * merged EntitySets from a `$metadata` requests. The structure is the same as in the metadata object reached
59609
- * by the `getServiceMetadata()` method. For non-`$metadata` requests the array will be empty.
59610
- */
59611
- addAnnotationUrl(
59612
- /**
59613
- * Either one URL as string or an array of URL strings
59614
- */
59615
- vUrl: string | string[]
59616
- ): Promise<any>;
59617
- /**
59618
- * Adds new XML content to be parsed for OData annotations, which are then merged into the annotations object
59619
- * which can be retrieved by calling the {@link #getServiceAnnotations}-method.
59620
- *
59621
- * @ui5-protected Do not call from applications (only from related classes in the framework)
59622
- *
59623
- * @returns The Promise to parse the given XML-String, resolved if parsed without errors, rejected if errors
59624
- * occur
59625
- */
59626
- addAnnotationXML(
59627
- /**
59628
- * The string that should be parsed as annotation XML
59629
- */
59630
- sXMLContent: string,
59631
- /**
59632
- * Whether not to fire annotationsLoaded event on the annotationParser
59633
- */
59634
- bSuppressEvents?: boolean
59635
- ): Promise<any>;
59636
59597
  /**
59637
59598
  * Returns a promise that resolves with an array containing information about the initially loaded annotations.
59638
59599
  *
59639
59600
  * **Important**: This covers the annotations that were given to the model constructor, not the ones that
59640
- * might have been added later on using the protected API method {@link #addAnnotationUrl}. In order to
59641
- * get information about those, the event `annotationsLoaded` can be used.
59601
+ * might have been added later on using the API method {@link sap.ui.model.odata.ODataMetaModel#getODataValueLists}.
59602
+ * In order to get information about those, the event `annotationsLoaded` can be used.
59642
59603
  *
59643
59604
  * @since 1.42
59644
59605
  *
@@ -65504,7 +65465,9 @@ declare namespace sap {
65504
65465
  * Since 1.89.0, the **deprecated** property `"grandTotal like 1.84" : true` can be used to turn on the
65505
65466
  * handling of grand totals like in 1.84.0, using aggregates of aggregates and thus allowing to filter by
65506
65467
  * aggregated properties while grand totals are needed. Beware that methods like "average" or "countdistinct"
65507
- * are not compatible with this approach, and it cannot be combined with group levels.
65468
+ * are not compatible with this approach, and it cannot be combined with group levels. Since 1.129.0, this
65469
+ * property is not needed anymore and filtering by aggregated properties is supported even while grand totals
65470
+ * or subtotals are needed.
65508
65471
  * Since 1.117.0, either a read-only recursive hierarchy or pure data aggregation is supported, but no
65509
65472
  * mix; `hierarchyQualifier` is the leading property that decides between those two use cases. Since 1.125.0,
65510
65473
  * maintenance of a recursive hierarchy is supported.
@@ -65514,17 +65477,17 @@ declare namespace sap {
65514
65477
  * A map from aggregatable property names or aliases to objects containing the following details:
65515
65478
  * `grandTotal`: An optional boolean that tells whether a grand total for this aggregatable property is
65516
65479
  * needed (since 1.59.0); not supported in this case are:
65517
- * filtering by any aggregatable property (since 1.89.0), "$search" (since 1.93.0), the `vGroup`
65518
- * parameter of {@link sap.ui.model.Sorter} (since 1.107.0), shared requests (since 1.108.0).
65519
- * `subtotals`: An optional boolean that tells whether subtotals for this aggregatable property are
65520
- * needed `with`: An optional string that provides the name of the method (for example "sum") used
65521
- * for aggregation of this aggregatable property; see "3.1.2 Keyword with". `name`: An optional string
65522
- * that provides the original aggregatable property name in case a different alias is chosen as the name
65523
- * of the dynamic property used for aggregation of this aggregatable property; see "3.1.1 Keyword as"
65524
- * `unit`: An optional string that provides the name of the custom aggregate for a currency or unit of measure
65525
- * corresponding to this aggregatable property (since 1.86.0). The custom aggregate must return the single
65526
- * value of that unit in case there is only one, or `null` otherwise ("multi-unit situation"). (SQL suggestion:
65527
- * `CASE WHEN MIN(Unit) = MAX(Unit) THEN MIN(Unit) END`)
65480
+ * "$search" (since 1.93.0), the `vGroup` parameter of {@link sap.ui.model.Sorter} (since 1.107.0),
65481
+ * shared requests (since 1.108.0). `subtotals`: An optional boolean that tells whether
65482
+ * subtotals for this aggregatable property are needed `with`: An optional string that provides the
65483
+ * name of the method (for example "sum") used for aggregation of this aggregatable property; see "3.1.2
65484
+ * Keyword with". `name`: An optional string that provides the original aggregatable property name
65485
+ * in case a different alias is chosen as the name of the dynamic property used for aggregation of this
65486
+ * aggregatable property; see "3.1.1 Keyword as" `unit`: An optional string that provides the name
65487
+ * of the custom aggregate for a currency or unit of measure corresponding to this aggregatable property
65488
+ * (since 1.86.0). The custom aggregate must return the single value of that unit in case there is only
65489
+ * one, or `null` otherwise ("multi-unit situation"). (SQL suggestion: `CASE WHEN MIN(Unit) = MAX(Unit)
65490
+ * THEN MIN(Unit) END`)
65528
65491
  */
65529
65492
  aggregate?: object;
65530
65493
  /**
@@ -66935,6 +66898,15 @@ declare namespace sap {
66935
66898
  * Whether the binding always uses an own service request to read its data; only the value `true` is allowed.
66936
66899
  */
66937
66900
  $$ownRequest?: boolean;
66901
+ /**
66902
+ * An array of navigation property names which are omitted from the main list request and loaded in a separate
66903
+ * request instead (@experimental as of version 1.129.0). This results in the main list becoming available
66904
+ * faster, while the separate properties are merged as soon as the data is received. Note that the separate
66905
+ * properties must be part of the '$expand' system query option, either automatically via the "autoExpandSelect"
66906
+ * model parameter (see {@link sap.ui.model.odata.v4.ODataModel#constructor}) or manually. The `$$separate`
66907
+ * parameter must not be combined with `$$aggregation`.
66908
+ */
66909
+ $$separate?: string[];
66938
66910
  /**
66939
66911
  * Whether multiple bindings for the same resource path share the data, so that it is requested only once.
66940
66912
  * This parameter can be inherited from the model's parameter "sharedRequests", see {@link sap.ui.model.odata.v4.ODataModel#constructor}.
@@ -70607,6 +70579,26 @@ declare namespace sap {
70607
70579
  * @returns Metadata object describing this class
70608
70580
  */
70609
70581
  static getMetadata(): sap.ui.base.Metadata;
70582
+ /**
70583
+ * Gets the metadata context for the given function import and parameter name. The result can be used with
70584
+ * {@link sap.ui.model.ODataMetaModel#getODataValueLists} to request the metadata for the value lists for
70585
+ * that function import parameter.
70586
+ *
70587
+ * @since 1.129.0
70588
+ *
70589
+ * @returns The metadata context referencing the given function import parameter
70590
+ */
70591
+ getFunctionImportParameterContext(
70592
+ /**
70593
+ * The function import name, either unqualified or qualified, e.g. "Save" or "MyService.Entities/Save";
70594
+ * if an unqualified name is used, the function import is searched for in the default entity container
70595
+ */
70596
+ sFunctionName: string,
70597
+ /**
70598
+ * The name of the function import parameter
70599
+ */
70600
+ sParameter: string
70601
+ ): sap.ui.model.Context;
70610
70602
  /**
70611
70603
  * Returns the OData meta model context corresponding to the given OData model path.
70612
70604
  *
@@ -70831,11 +70823,11 @@ declare namespace sap {
70831
70823
  | undefined
70832
70824
  | null;
70833
70825
  /**
70834
- * Returns a `Promise` which is resolved with a map representing the `com.sap.vocabularies.Common.v1.ValueList`
70835
- * annotations of the given property or rejected with an error. The key in the map provided on successful
70836
- * resolution is the qualifier of the annotation or the empty string if no qualifier is defined. The value
70837
- * in the map is the JSON object for the annotation. The map is empty if the property has no `com.sap.vocabularies.Common.v1.ValueList`
70838
- * annotations.
70826
+ * Returns a `Promise` which either resolves with a map representing the `com.sap.vocabularies.Common.v1.ValueList`
70827
+ * annotations of the property or function import parameter referenced by the given metamodel context or
70828
+ * rejects with an error. The key in the map provided on successful resolution is the qualifier of the annotation
70829
+ * or the empty string if no qualifier is defined. The value in the map is the JSON object for the annotation.
70830
+ * The map is empty if the property has no `com.sap.vocabularies.Common.v1.ValueList` annotations.
70839
70831
  *
70840
70832
  * @since 1.29.1
70841
70833
  *
@@ -70844,9 +70836,10 @@ declare namespace sap {
70844
70836
  */
70845
70837
  getODataValueLists(
70846
70838
  /**
70847
- * A model context for a structural property of an entity type or a complex type, as returned by {@link #getMetaContext getMetaContext}
70839
+ * A model context for a structural property of an entity type or a complex type, as returned by {@link #getMetaContext getMetaContext},
70840
+ * or (since 1.129.0) a model context for a parameter of a function import, as returned by {@link #getFunctionImportParameterContext}
70848
70841
  */
70849
- oPropertyContext: sap.ui.model.Context
70842
+ oPropertyOrParameterContext: sap.ui.model.Context
70850
70843
  ): Promise<
70851
70844
  Record<string, sap.ui.model.odata.ODataMetaModel.ValueListType>
70852
70845
  >;
@@ -76040,10 +76033,10 @@ declare namespace sap {
76040
76033
  getModelMessages(): sap.ui.core.message.Message[];
76041
76034
  /**
76042
76035
  * Returns whether the data state is dirty in the UI control. A data state is dirty in the UI control if
76043
- * the entered value did not yet pass the type validation.
76036
+ * an entered value did not pass the type validation.
76044
76037
  *
76045
76038
  *
76046
- * @returns Whether the control data state is dirty
76039
+ * @returns Whether this data state or at least one of the aggregated data states is dirty in the UI control
76047
76040
  */
76048
76041
  isControlDirty(): boolean;
76049
76042
  /**
@@ -76554,10 +76547,11 @@ declare namespace sap {
76554
76547
  getValue(): any;
76555
76548
  /**
76556
76549
  * Returns whether the data state is dirty in the UI control. A data state is dirty in the UI control if
76557
- * the entered value did not yet pass the type validation.
76550
+ * an entered value did not pass the type validation. If the data state is used by a composite data state,
76551
+ * it is also checked whether the composite data state is dirty in the UI control.
76558
76552
  *
76559
76553
  *
76560
- * @returns Whether the data state is dirty
76554
+ * @returns Whether the data state is dirty in the UI control
76561
76555
  */
76562
76556
  isControlDirty(): boolean;
76563
76557
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.128.0
1
+ // For Library Version: 1.129.0
2
2
 
3
3
  declare namespace sap {
4
4
  interface IUI5DefineDependencyNames {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.128.0
1
+ // For Library Version: 1.129.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -581,6 +581,7 @@ declare namespace sap {
581
581
  * property are accepted: `[left, right, center, begin, end]`. If not specified, the columns are horizontally
582
582
  * aligned based on the property type.
583
583
  * - `scale` (number) - Number of digits after decimal point for numeric values
584
+ * - `autoScale` (boolean) - Allows automatic scale assignment based on unit of measure
584
585
  * - `delimiter` (boolean) - Set to `true` to display thousands separators in numeric values. The default
585
586
  * value is `false`.
586
587
  * - `unit` (string) - Text to display as the unit of measurement or currency next to the numeric value.
@@ -593,8 +594,13 @@ declare namespace sap {
593
594
  * - `falseValue` (string) - Textual representation of a boolean type that has the value `false`
594
595
  * - `template` (string) - Formatting template that supports indexed placeholders within curly brackets
595
596
  *
597
+ * - `format` (string) - Output format for columns of type Date/DateTime/Time
596
598
  * - `inputFormat` (string) - Formatting template for string formatted dates
597
599
  * - `utc` (boolean) - Defines whether the `DateTime` is displayed as UTC or local time
600
+ * - `timezone` (string) - Defines a fixed IANA time zone
601
+ * - `timezoneProperty` (string) - References an OData property that contains the specific IANA time zone
602
+ *
603
+ * - `displayTimezone` (boolean) - Defines whether the IANA time zone is displayed within a cell
598
604
  * - `valueMap` (string) - Mapping object or Map containing the values that should be mapped to a particular
599
605
  * key
600
606
  * - `wrap` (boolean) - Indicates if wrapping is enabled for this particular column
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.128.0
1
+ // For Library Version: 1.129.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1320,8 +1320,12 @@ declare namespace sap {
1320
1320
  interface IUI5DefineDependencyNames {
1321
1321
  "sap/ui/fl/apply/_internal/changes/descriptor/app/AddAnnotationsToOData": undefined;
1322
1322
 
1323
+ "sap/ui/fl/apply/_internal/changes/descriptor/app/AddNewDataSource": undefined;
1324
+
1323
1325
  "sap/ui/fl/apply/_internal/changes/descriptor/app/AddNewInbound": undefined;
1324
1326
 
1327
+ "sap/ui/fl/apply/_internal/changes/descriptor/app/AddNewOutbound": undefined;
1328
+
1325
1329
  "sap/ui/fl/apply/_internal/changes/descriptor/app/AddTechnicalAttributes": undefined;
1326
1330
 
1327
1331
  "sap/ui/fl/apply/_internal/changes/descriptor/app/ChangeDataSource": undefined;
@@ -1424,6 +1428,8 @@ declare namespace sap {
1424
1428
 
1425
1429
  "sap/ui/fl/apply/_internal/preprocessors/ControllerExtension": undefined;
1426
1430
 
1431
+ "sap/ui/fl/apply/api/AnnotationChangeHandlerAPI": undefined;
1432
+
1427
1433
  "sap/ui/fl/apply/api/ControlVariantApplyAPI": undefined;
1428
1434
 
1429
1435
  "sap/ui/fl/apply/api/DelegateMediatorAPI": undefined;
@@ -1480,8 +1486,12 @@ declare namespace sap {
1480
1486
 
1481
1487
  "sap/ui/fl/registry/Settings": undefined;
1482
1488
 
1489
+ "sap/ui/fl/support/_internal/getAllUIChanges": undefined;
1490
+
1483
1491
  "sap/ui/fl/support/_internal/getChangeDependencies": undefined;
1484
1492
 
1493
+ "sap/ui/fl/support/_internal/getFlexObjectInfos": undefined;
1494
+
1485
1495
  "sap/ui/fl/support/_internal/getFlexSettings": undefined;
1486
1496
 
1487
1497
  "sap/ui/fl/support/api/SupportAPI": undefined;
@@ -1534,6 +1544,8 @@ declare namespace sap {
1534
1544
 
1535
1545
  "sap/ui/fl/write/_internal/fieldExtensibility/SingleTenantABAPExtensibilityVariant": undefined;
1536
1546
 
1547
+ "sap/ui/fl/write/_internal/flexState/changes/UIChangeManager": undefined;
1548
+
1537
1549
  "sap/ui/fl/write/_internal/flexState/compVariants/CompVariantState": undefined;
1538
1550
 
1539
1551
  "sap/ui/fl/write/_internal/flexState/FlexObjectManager": undefined;
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.128.0
1
+ // For Library Version: 1.129.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.128.0
1
+ // For Library Version: 1.129.0
2
2
 
3
3
  declare namespace sap {}
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.128.0
1
+ // For Library Version: 1.129.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -981,9 +981,21 @@ declare namespace sap {
981
981
 
982
982
  /**
983
983
  * The parameters related to the triggered action.
984
+ *
985
+ * **Disclaimer:** Since 1.129 the special parameter `data` for action `Submit` is deprecated and must not
986
+ * be used. Use event parameter `formData` instead.
984
987
  */
985
988
  parameters?: object;
986
989
 
990
+ /**
991
+ * All form data that is filled inside the card. This parameter is available only with action types `Submit`
992
+ * and `Custom`.
993
+ *
994
+ * The format will be the same as in the `form` model available in the card manifest. For more information
995
+ * look at the documentation for each individual form type.
996
+ */
997
+ formData?: object;
998
+
987
999
  /**
988
1000
  * The type of the action.
989
1001
  */
@@ -2525,9 +2537,21 @@ declare namespace sap {
2525
2537
 
2526
2538
  /**
2527
2539
  * The parameters related to the triggered action.
2540
+ *
2541
+ * **Disclaimer:** Since 1.129 the special parameter `data` for action `Submit` is deprecated and must not
2542
+ * be used. Use event parameter `formData` instead.
2528
2543
  */
2529
2544
  parameters?: object;
2530
2545
 
2546
+ /**
2547
+ * All form data that is filled inside the card. This parameter is available only with action types `Submit`
2548
+ * and `Custom`.
2549
+ *
2550
+ * The format will be the same as in the `form` model available in the card manifest. For more information
2551
+ * look at the documentation for each individual form type.
2552
+ */
2553
+ formData?: object;
2554
+
2531
2555
  /**
2532
2556
  * The type of the action.
2533
2557
  */
@@ -2558,9 +2582,21 @@ declare namespace sap {
2558
2582
 
2559
2583
  /**
2560
2584
  * The parameters related to the triggered action.
2585
+ *
2586
+ * **Disclaimer:** Since 1.129 the special parameter `data` for action `Submit` is deprecated and must not
2587
+ * be used. Use event parameter `formData` instead.
2561
2588
  */
2562
2589
  parameters?: object;
2563
2590
 
2591
+ /**
2592
+ * All form data that is filled inside the card. This parameter is available only with action types `Submit`
2593
+ * and `Custom`.
2594
+ *
2595
+ * The format will be the same as in the `form` model available in the card manifest. For more information
2596
+ * look at the documentation for each individual form type.
2597
+ */
2598
+ formData?: object;
2599
+
2564
2600
  /**
2565
2601
  * The type of the action.
2566
2602
  */
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.128.0
1
+ // For Library Version: 1.129.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {