@sapui5/ts-types 1.149.0 → 1.150.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 (66) 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.esh.search.ui.d.ts +165 -223
  7. package/types/sap.f.d.ts +57 -5
  8. package/types/sap.fe.ariba.d.ts +1 -1
  9. package/types/sap.fe.base.d.ts +1 -1
  10. package/types/sap.fe.controls.d.ts +1 -1
  11. package/types/sap.fe.core.d.ts +35 -15
  12. package/types/sap.fe.ina.d.ts +1 -1
  13. package/types/sap.fe.macros.d.ts +93 -43
  14. package/types/sap.fe.navigation.d.ts +1 -1
  15. package/types/sap.fe.placeholder.d.ts +1 -1
  16. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  17. package/types/sap.fe.templates.d.ts +1 -1
  18. package/types/sap.fe.test.d.ts +140 -30
  19. package/types/sap.fe.tools.d.ts +1 -1
  20. package/types/sap.feedback.ui.d.ts +1 -1
  21. package/types/sap.gantt.d.ts +141 -137
  22. package/types/sap.insights.d.ts +1 -1
  23. package/types/sap.m.d.ts +251 -27
  24. package/types/sap.makit.d.ts +1 -1
  25. package/types/sap.me.d.ts +1 -1
  26. package/types/sap.ndc.d.ts +1 -1
  27. package/types/sap.ovp.d.ts +1 -1
  28. package/types/sap.rules.ui.d.ts +1 -1
  29. package/types/sap.sac.df.d.ts +1 -1
  30. package/types/sap.suite.ui.commons.d.ts +132 -59
  31. package/types/sap.suite.ui.generic.template.d.ts +1 -1
  32. package/types/sap.suite.ui.microchart.d.ts +4 -3
  33. package/types/sap.tnt.d.ts +1 -1
  34. package/types/sap.ui.codeeditor.d.ts +1 -1
  35. package/types/sap.ui.commons.d.ts +4 -3
  36. package/types/sap.ui.comp.d.ts +37 -25
  37. package/types/sap.ui.core.d.ts +753 -466
  38. package/types/sap.ui.dt.d.ts +1 -1
  39. package/types/sap.ui.export.d.ts +1 -1
  40. package/types/sap.ui.fl.d.ts +1 -1
  41. package/types/sap.ui.generic.app.d.ts +16 -11
  42. package/types/sap.ui.generic.template.d.ts +1 -1
  43. package/types/sap.ui.geomap.d.ts +111 -209
  44. package/types/sap.ui.integration.d.ts +1 -1
  45. package/types/sap.ui.layout.d.ts +7 -5
  46. package/types/sap.ui.mdc.d.ts +78 -9
  47. package/types/sap.ui.richtexteditor.d.ts +1 -1
  48. package/types/sap.ui.rta.d.ts +1 -1
  49. package/types/sap.ui.suite.d.ts +1 -1
  50. package/types/sap.ui.support.d.ts +3 -1
  51. package/types/sap.ui.table.d.ts +10 -7
  52. package/types/sap.ui.testrecorder.d.ts +1 -1
  53. package/types/sap.ui.unified.d.ts +72 -3
  54. package/types/sap.ui.ux3.d.ts +1 -1
  55. package/types/sap.ui.vbm.d.ts +1 -1
  56. package/types/sap.ui.vk.d.ts +1 -1
  57. package/types/sap.ui.vtm.d.ts +1 -1
  58. package/types/sap.uiext.inbox.d.ts +1 -1
  59. package/types/sap.ushell.d.ts +1 -3
  60. package/types/sap.ushell_abap.d.ts +1 -1
  61. package/types/sap.uxap.d.ts +1 -1
  62. package/types/sap.viz.d.ts +58 -39
  63. package/types/sap.webanalytics.core.d.ts +1 -1
  64. package/types/sap.zen.commons.d.ts +39 -25
  65. package/types/sap.zen.crosstab.d.ts +15 -8
  66. package/types/sap.zen.dsh.d.ts +17 -9
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.149.0
1
+ // For Library Version: 1.150.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace fe {
@@ -120,8 +120,8 @@ declare namespace sap {
120
120
  */
121
121
  iCheckContactDialog(
122
122
  /**
123
- * The expected state of dialog elements Example: { controlType: "sap.m.Title", text: "Domestic HK Customer
124
- * 1" }
123
+ * The expected state of dialog elements. Pass `visible: false` to assert no matching element is shown —
124
+ * this also covers controls that are not rendered (e.g. `UI.Hidden`).
125
125
  */
126
126
  mState?: object
127
127
  ): object;
@@ -421,8 +421,9 @@ declare namespace sap {
421
421
  ): object;
422
422
  }
423
423
 
424
- class DialogValueHelpAssertions extends sap.fe.test.api
425
- .DialogAssertions {
424
+ class DialogValueHelpAssertions
425
+ extends sap.fe.test.api.DialogAssertions
426
+ {
426
427
  /**
427
428
  * @ui5-protected Do not call from applications (only from related classes in the framework)
428
429
  */
@@ -848,9 +849,9 @@ declare namespace sap {
848
849
  */
849
850
  iCheckFilterField(
850
851
  /**
851
- * The identifier of the filter field
852
+ * The identifier of the filter field, or its label
852
853
  */
853
- vFieldIdentifier: object | sap.fe.test.api.FilterFieldIdentifier,
854
+ vFieldIdentifier: string | sap.fe.test.api.FilterFieldIdentifier,
854
855
  /**
855
856
  * The expected value(s) of the filter field
856
857
  */
@@ -1139,7 +1140,12 @@ declare namespace sap {
1139
1140
  /**
1140
1141
  * The identifier of the field
1141
1142
  */
1142
- vFieldIdentifier: sap.fe.test.api.FieldIdentifier | string
1143
+ vFieldIdentifier: sap.fe.test.api.FieldIdentifier | string,
1144
+ /**
1145
+ * Whether to wait for a popover to open after clicking. The default value is false. If the link opens a
1146
+ * popover, set this to true.
1147
+ */
1148
+ bWaitForPopover?: boolean
1143
1149
  ): object;
1144
1150
  /**
1145
1151
  * Executes an action assigned to a form in a subsection.
@@ -1309,10 +1315,9 @@ declare namespace sap {
1309
1315
  */
1310
1316
  iClickLink(
1311
1317
  /**
1312
- * The content of the link to be clicked. It currently has to be the link text itself, not the label of
1313
- * the field.
1318
+ * The identifier of the field or the content of the link to be clicked
1314
1319
  */
1315
- vLinkIdentifier: string
1320
+ vLinkIdentifier: sap.fe.test.api.HeaderFieldGroupIdentifier | string
1316
1321
  ): object;
1317
1322
  /**
1318
1323
  * Executes an action in the header toolbar of an object page.
@@ -1470,7 +1475,7 @@ declare namespace sap {
1470
1475
  /**
1471
1476
  * The identifier of the field
1472
1477
  */
1473
- vFieldIdentifier: sap.fe.test.api.FieldIdentifier | string,
1478
+ vFieldIdentifier: sap.fe.test.api.HeaderFieldGroupIdentifier,
1474
1479
  /**
1475
1480
  * The value to check. If it is an array, the first entry is considered as the value and the second as the
1476
1481
  * description. If it is an object it must follow this pattern:
@@ -1504,6 +1509,24 @@ declare namespace sap {
1504
1509
  */
1505
1510
  mState?: object
1506
1511
  ): object;
1512
+ /**
1513
+ * Checks the state of a link located in the Object Page header.
1514
+ *
1515
+ *
1516
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1517
+ */
1518
+ iCheckLink(
1519
+ /**
1520
+ * The identifier of the field or the link text
1521
+ */
1522
+ vLinkIdentifier:
1523
+ | sap.fe.test.api.HeaderFieldGroupIdentifier
1524
+ | string,
1525
+ /**
1526
+ * Defines the expected state of the link
1527
+ */
1528
+ mState?: object
1529
+ ): object;
1507
1530
  /**
1508
1531
  * Checks an action in the popover that is currently open.
1509
1532
  *
@@ -1528,9 +1551,9 @@ declare namespace sap {
1528
1551
  */
1529
1552
  vMicroChartIdentifier: object | string,
1530
1553
  /**
1531
- * UoM label of the MicroChart
1554
+ * UoM label of the MicroChart. When omitted, the UoM label is not asserted.
1532
1555
  */
1533
- sUoMLabel: string
1556
+ sUoMLabel?: string
1534
1557
  ): object;
1535
1558
  /**
1536
1559
  * Checks the paginator down button.
@@ -1646,6 +1669,25 @@ declare namespace sap {
1646
1669
  */
1647
1670
  sDescription?: string
1648
1671
  ): object;
1672
+ /**
1673
+ * Checks the binding path of the title and description of the object page.
1674
+ *
1675
+ * Use this method when the title or description is bound to a model path rather than a static value. If
1676
+ * either path is `undefined`, it is not checked.
1677
+ *
1678
+ *
1679
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1680
+ */
1681
+ iCheckTitlePath(
1682
+ /**
1683
+ * The binding path of the object page header title
1684
+ */
1685
+ sTitlePath?: string,
1686
+ /**
1687
+ * The binding path of the object page header description
1688
+ */
1689
+ sDescriptionPath?: string
1690
+ ): object;
1649
1691
  }
1650
1692
 
1651
1693
  class HeaderAssertionsLR {
@@ -1833,6 +1875,46 @@ declare namespace sap {
1833
1875
  */
1834
1876
  sSortOrder?: sap.ui.core.SortOrder
1835
1877
  ): object;
1878
+ /**
1879
+ * Clicks a Contact Card link within the table using its link text.
1880
+ *
1881
+ *
1882
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1883
+ */
1884
+ iClickContactLink(
1885
+ /**
1886
+ * The text of the contact link to click
1887
+ */
1888
+ linkContent: string
1889
+ ): object;
1890
+ /**
1891
+ * Clicks a link in a table cell.
1892
+ *
1893
+ *
1894
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1895
+ */
1896
+ iClickLink(
1897
+ /**
1898
+ * Specifies the target row by column-value map or 0-based index
1899
+ */
1900
+ mRowValues: object | number,
1901
+ /**
1902
+ * The column name, label, or index
1903
+ */
1904
+ vColumn: string | number
1905
+ ): object;
1906
+ /**
1907
+ * Clicks a link in a table cell.
1908
+ *
1909
+ *
1910
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1911
+ */
1912
+ iClickLink(
1913
+ /**
1914
+ * The column name, label, or index
1915
+ */
1916
+ vColumn: string | number
1917
+ ): object;
1836
1918
  /**
1837
1919
  * Collapses a row corresponding to a visual group.
1838
1920
  *
@@ -2808,13 +2890,19 @@ declare namespace sap {
2808
2890
  */
2809
2891
  type FieldIdentifier = {
2810
2892
  /**
2811
- * The name of the field group containing the field
2893
+ * The name of the field group containing the field. Required when identifying a field inside a header facet
2894
+ * form.
2812
2895
  */
2813
2896
  fieldGroup?: string;
2814
2897
  /**
2815
2898
  * The name of the field
2816
2899
  */
2817
2900
  property: string;
2901
+ /**
2902
+ * The name of the target annotation, such as a Chart or MicroChart annotation term. When set, a DataFieldForAnnotation
2903
+ * is identified instead of a DataField, and the resolved control ID changes accordingly.
2904
+ */
2905
+ targetAnnotation?: string;
2818
2906
  /**
2819
2907
  * The name of the connected field containing the field
2820
2908
  */
@@ -2842,7 +2930,7 @@ declare namespace sap {
2842
2930
  /**
2843
2931
  * The fieldgroup ID
2844
2932
  */
2845
- fieldGroup: string;
2933
+ fieldGroup?: string;
2846
2934
  /**
2847
2935
  * Is it about the editable header facet
2848
2936
  */
@@ -2867,6 +2955,26 @@ declare namespace sap {
2867
2955
  custom?: boolean;
2868
2956
  };
2869
2957
 
2958
+ /**
2959
+ * An identifier for a field within a field group in the Object Page header. Used by {@link sap.fe.test.api.HeaderAssertions#iCheckFieldInFieldGroup},
2960
+ * {@link sap.fe.test.api.HeaderAssertions#iCheckLink}, and {@link sap.fe.test.api.HeaderActions#iClickLink}.
2961
+ */
2962
+ type HeaderFieldGroupIdentifier = {
2963
+ /**
2964
+ * The name of the field group containing the field
2965
+ */
2966
+ fieldGroup: string;
2967
+ /**
2968
+ * The name of the field within the field group
2969
+ */
2970
+ field: string;
2971
+ /**
2972
+ * The target annotation path for DataFieldForAnnotation lookups. When present, a DataFieldForAnnotation
2973
+ * is identified instead of a DataField.
2974
+ */
2975
+ targetAnnotation?: string;
2976
+ };
2977
+
2870
2978
  /**
2871
2979
  * A section identifier
2872
2980
  */
@@ -2966,9 +3074,9 @@ declare namespace sap {
2966
3074
  */
2967
3075
  onTable(
2968
3076
  /**
2969
- * The identifier of the table, or its header title
3077
+ * The identifier of the table, or its header title. When omitted, the page's default table is used.
2970
3078
  */
2971
- vTableIdentifier: string | sap.fe.test.api.TableIdentifier
3079
+ vTableIdentifier?: string | sap.fe.test.api.TableIdentifier
2972
3080
  ): sap.fe.test.api.TableActions;
2973
3081
  }
2974
3082
 
@@ -3029,9 +3137,9 @@ declare namespace sap {
3029
3137
  */
3030
3138
  onTable(
3031
3139
  /**
3032
- * The identifier of the table, or its header title
3140
+ * The identifier of the table, or its header title. When omitted, the page's default table is used.
3033
3141
  */
3034
- vTableIdentifier: string | sap.fe.test.api.TableIdentifier
3142
+ vTableIdentifier?: string | sap.fe.test.api.TableIdentifier
3035
3143
  ): sap.fe.test.api.TableAssertions;
3036
3144
  }
3037
3145
  }
@@ -3128,9 +3236,9 @@ declare namespace sap {
3128
3236
  */
3129
3237
  onTable(
3130
3238
  /**
3131
- * The identifier of the table, or its header title
3239
+ * The identifier of the table, or its header title. When omitted, the page's default table is used.
3132
3240
  */
3133
- vTableIdentifier: string | sap.fe.test.api.TableIdentifier
3241
+ vTableIdentifier?: string | sap.fe.test.api.TableIdentifier
3134
3242
  ): sap.fe.test.api.TableActions;
3135
3243
  }
3136
3244
 
@@ -3139,7 +3247,9 @@ declare namespace sap {
3139
3247
  */
3140
3248
  interface assertions extends sap.fe.test.TemplatePage.assertions {
3141
3249
  /**
3142
- * Checks the expected number of sections in an object page.
3250
+ * Checks the expected number of sections in an object page. Only visible sections are counted. The editable
3251
+ * header section is excluded in display mode. since it is not visible, but is included in edit mode when
3252
+ * it becomes visible.
3143
3253
  *
3144
3254
  *
3145
3255
  * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
@@ -3245,9 +3355,9 @@ declare namespace sap {
3245
3355
  */
3246
3356
  onTable(
3247
3357
  /**
3248
- * The identifier of the table, or its header title
3358
+ * The identifier of the table, or its header title. When omitted, the page's default table is used.
3249
3359
  */
3250
- vTableIdentifier: string | sap.fe.test.api.TableIdentifier
3360
+ vTableIdentifier?: string | sap.fe.test.api.TableIdentifier
3251
3361
  ): sap.fe.test.api.TableAssertions;
3252
3362
  }
3253
3363
  }
@@ -3888,11 +3998,11 @@ declare namespace sap {
3888
3998
  /**
3889
3999
  * The entitySet (optional)(defined in the settings of the corresponding target component within the manifest)
3890
4000
  */
3891
- entitySet: string;
4001
+ entitySet?: string;
3892
4002
  /**
3893
4003
  * The contextPath (optional)(defined in the settings of the corresponding target component within the manifest)
3894
4004
  */
3895
- contextPath: string;
4005
+ contextPath?: string;
3896
4006
  },
3897
4007
  /**
3898
4008
  * Additional custom page functions, provided in an object containing `actions` and `assertions`
@@ -3927,13 +4037,13 @@ declare namespace sap {
3927
4037
  */
3928
4038
  componentId: string;
3929
4039
  /**
3930
- * The entitySet (defined in the settings of the corresponding target component within the manifest)
4040
+ * The entitySet (optional)(defined in the settings of the corresponding target component within the manifest)
3931
4041
  */
3932
- entitySet: string;
4042
+ entitySet?: string;
3933
4043
  /**
3934
4044
  * The contextPath (optional)(defined in the settings of the corresponding target component within the manifest)
3935
4045
  */
3936
- contextPath: string;
4046
+ contextPath?: string;
3937
4047
  },
3938
4048
  /**
3939
4049
  * Additional custom page functions, provided in an object containing `actions` and `assertions`
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.149.0
1
+ // For Library Version: 1.150.0
2
2
 
3
3
  declare namespace sap {}
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.149.0
1
+ // For Library Version: 1.150.0
2
2
 
3
3
  declare namespace sap {}